RigidBody3D Class

Extends Component

Module: cc Parent Module: cc

RigidBody is the basic object that make up the physical world, and it can make a node physically affected and react.

Index

Properties
  • allowSleep boolean Whether sleep is allowed.
  • mass number The mass of the rigidbody.
  • linearDamping number Used to reduce the linear rate of rigidbody.
  • angularDamping number Used to reduce the rotation rate of rigidbody.
  • isKinematic boolean If enabled, the developer controls the displacement and rotation of the rigidbody, not the physics engine.
  • useGravity boolean If enabled, the rigidbody is affected by gravity.
  • fixedRotation boolean If enabled, the rigidbody will be fixed without rotation during a collision.
  • linearFactor Vec3 It can affect the linear velocity change of the rigidbody in each axis.
  • angularFactor Vec3 It can affect the rotation speed change of the rigidbody in each axis.
  • isAwake boolean The rigidbody is awake.
  • isSleepy boolean The rigidbody can enter hibernation.
  • isSleeping boolean The rigidbody is sleeping.
  • rigidBody IRigidBody Get the rigidbody object inside the physics engine.
  • __eventTargets Array Register all related EventTargets,...
  • node Node The node this component is attached to.
  • uuid String The uuid for editor.
  • _enabled Boolean
  • enabled Boolean indicates whether this component is enabled or not.
  • enabledInHierarchy Boolean indicates whether this component is enabled and its node is also active in the hierarchy.
  • _isOnLoadCalled Number Returns a value which used to indicate the onLoad get called or not.
  • _name String
  • _objFlags Number
  • name String The name of the object.
  • isValid Boolean Indicates whether the object is not yet destroyed.
Methods
  • applyForce A force is applied to a rigid body at a point in world space.
  • applyLocalForce Apply a force on the rigid body at a point in local space.
  • applyImpulse Apply an impulse to a rigid body at a point in world space.
  • applyLocalImpulse Apply an impulse to the rigid body at a point in local space.
  • applyTorque Apply a torque to the rigid body.
  • applyLocalTorque Apply a local torque to the rigid body.
  • wakeUp Awaken the rigid body.
  • sleep Dormant rigid body.
  • getLinearVelocity Get linear velocity.
  • setLinearVelocity Set linear speed.
  • getAngularVelocity Gets the rotation speed.
  • setAngularVelocity Set rotation speed.
  • update This is a lifecycle method.
  • lateUpdate This is a lifecycle method.
  • __preload __preload is called before every onLoad.
  • onLoad When attaching to an active node or its node first activated.
  • start Called before all scripts' update if the Component is enabled the first time.
  • onEnable This is a lifecycle method.
  • onDisable This is a lifecycle method.
  • onDestroy This is a lifecycle method.
  • onFocusInEditor
  • onLostFocusInEditor
  • resetInEditor Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used.
  • addComponent Adds a component class to the node.
  • getComponent Returns the component of supplied type if the node has one attached, null if it doesn't....
  • getComponents Returns all components of supplied Type in the node.
  • getComponentInChildren Returns the component of supplied type in any of its children using depth first search.
  • getComponentsInChildren Returns the components of supplied type in self or any of its children using depth first search.
  • _getLocalBounds If the component's bounding box is different from the node's, you can implement this method to supply
  • onRestore for undo/redo operation.
  • schedule Schedules a custom selector....
  • scheduleOnce Schedules a callback function that runs only once, with a delay of 0 or larger.
  • unschedule Unschedules a custom callback function.
  • unscheduleAllCallbacks unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function....
  • destroy Actual object destruction will delayed until before rendering.
  • _destruct Clear all references in the instance.
  • _onPreDestroy Called before the object being destroyed.
  • _serialize The customized serialization for this object.
  • _deserialize Init this object from the custom serialized data.

Details

Properties

allowSleep

Whether sleep is allowed.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:59
mass

The mass of the rigidbody.

meta description
Type number
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:77
linearDamping

Used to reduce the linear rate of rigidbody. The larger the value, the slower the rigidbody moves.

meta description
Type number
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:98
angularDamping

Used to reduce the rotation rate of rigidbody. The larger the value, the slower the rigidbody rotates.

meta description
Type number
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:119
isKinematic

If enabled, the developer controls the displacement and rotation of the rigidbody, not the physics engine.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:140
useGravity

If enabled, the rigidbody is affected by gravity.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:161
fixedRotation

If enabled, the rigidbody will be fixed without rotation during a collision.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:182
linearFactor

It can affect the linear velocity change of the rigidbody in each axis. The larger the value, the faster the rigidbody moves.

meta description
Type Vec3
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:203
angularFactor

It can affect the rotation speed change of the rigidbody in each axis. The larger the value, the faster the rigidbody rotates.

meta description
Type Vec3
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:224
isAwake

The rigidbody is awake.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:245
isSleepy

The rigidbody can enter hibernation.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:260
isSleeping

The rigidbody is sleeping.

meta description
Type boolean
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:275
rigidBody

Get the rigidbody object inside the physics engine.

meta description
Type IRigidBody
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:290
__eventTargets

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy.

meta description
Type Array
Defined in cocos2d/core/components/CCComponent.js:63
node

The node this component is attached to. A component is always attached to a node.

meta description
Type Node
Defined in cocos2d/core/components/CCComponent.js:80
Examples
cc.log(comp.node);
uuid

The uuid for editor.

meta description
Type String
Defined in cocos2d/core/components/CCComponent.js:111
Examples
cc.log(comp.uuid);
_enabled
meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:152
enabled

indicates whether this component is enabled or not.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:159
Examples
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

indicates whether this component is enabled and its node is also active in the hierarchy.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:191
Examples
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

Returns a value which used to indicate the onLoad get called or not.

meta description
Type Number
Defined in cocos2d/core/components/CCComponent.js:207
Examples
cc.log(this._isOnLoadCalled > 0);
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:240
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:258
Examples
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

Methods

applyForce

A force is applied to a rigid body at a point in world space.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:374
Parameters
  • force Vec3
  • relativePoint Vec3 The point of action, relative to the center of the rigid body.
applyLocalForce

Apply a force on the rigid body at a point in local space.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:389
Parameters
  • force Vec3
  • localPoint Vec3 Point of application
applyImpulse

Apply an impulse to a rigid body at a point in world space.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:404
Parameters
  • impulse Vec3
  • relativePoint Vec3 The point of action, relative to the center of the rigid body.
applyLocalImpulse

Apply an impulse to the rigid body at a point in local space.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:419
Parameters
  • impulse Vec3
  • localPoint Vec3 Point of application
applyTorque

Apply a torque to the rigid body.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:434
Parameters
applyLocalTorque

Apply a local torque to the rigid body.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:448
Parameters
wakeUp

Awaken the rigid body.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:462
sleep

Dormant rigid body.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:475
getLinearVelocity

Get linear velocity.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:488
Parameters
setLinearVelocity

Set linear speed.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:502
Parameters
getAngularVelocity

Gets the rotation speed.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:516
Parameters
setAngularVelocity

Set rotation speed.

meta description
Defined in cocos2d/core/3d/physics/framework/components/rigid-body-component.ts:530
Parameters
update

Update is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:228
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

LateUpdate is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:239
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
__preload

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

meta description
Defined in cocos2d/core/components/CCComponent.js:250
onLoad

When attaching to an active node or its node first activated. onLoad is always called before any start functions, this allows you to order initialization of scripts.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:261
start

Called before all scripts' update if the Component is enabled the first time. Usually used to initialize some logic which need to be called after all components' onload methods called.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:274
onEnable

Called when this component becomes enabled and its node is active.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:287
onDisable

Called when this component becomes disabled or its node becomes inactive.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:297
onDestroy

Called when this component will be destroyed.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:307
onFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:317
onLostFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:322
resetInEditor

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

meta description
Defined in cocos2d/core/components/CCComponent.js:327
addComponent

Adds a component class to the node. You can also add component to node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:337
Parameters
  • typeOrClassName Function | String the constructor or the class name of the component to add
Examples
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:355
Parameters
Examples
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

Returns all components of supplied Type in the node.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:379
Parameters
Examples
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

Returns the component of supplied type in any of its children using depth first search.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:397
Parameters
Examples
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

Returns the components of supplied type in self or any of its children using depth first search.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:415
Parameters
Examples
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

meta description
Defined in cocos2d/core/components/CCComponent.js:435
Parameters
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

meta description
Defined in cocos2d/core/components/CCComponent.js:448
schedule

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

meta description
Defined in cocos2d/core/components/CCComponent.js:540
Parameters
  • callback function The callback function
  • interval Number Tick interval in seconds. 0 means tick every frame.
  • repeat Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
  • delay Number The amount of time that the first tick will wait before execution. Unit: s
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

Schedules a callback function that runs only once, with a delay of 0 or larger.

meta description
Defined in cocos2d/core/components/CCComponent.js:578
Parameters
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution. Unit: s
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

Unschedules a custom callback function.

meta description
Defined in cocos2d/core/components/CCComponent.js:595
Parameters
  • callback_fn function A function wrapped as a selector
Examples
this.unschedule(_callback);
unscheduleAllCallbacks

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

meta description
Defined in cocos2d/core/components/CCComponent.js:611
Examples
this.unscheduleAllCallbacks();
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object is not usable anymore. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCObject.js:293
Examples
obj.destroy();
_destruct

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example:

_destruct: function () {
    for (var key in this) {
        if (this.hasOwnProperty(key)) {
            switch (typeof this[key]) {
                case 'string':
                    this[key] = '';
                    break;
                case 'object':
                case 'function':
                    this[key] = null;
                    break;
        }
    }
}
meta description
Defined in cocos2d/core/platform/CCObject.js:427
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:484
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:512
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:525
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""