PhysicsManager Class

Module: cc

Physics manager uses box2d as the inner physics system, and hide most box2d implement details(creating rigidbody, synchronize rigidbody info to node). You can visit some common box2d function through physics manager(hit testing, raycast, debug info). Physics manager distributes the collision information to each collision callback when collision is produced. Note: You need first enable the collision listener in the rigidbody.

Index

Properties

• DrawBits DrawBits The draw bits for drawing physics debug information.
• PTM_RATIO Number The ratio transform between physics unit and pixel unit, generally is 32.
• VELOCITY_ITERATIONS Number The velocity iterations for the velocity constraint solver.
• POSITION_ITERATIONS Number The position Iterations for the position constraint solver.
• FIXED_TIME_STEP Number Specify the fixed time step. Need enabledAccumulator to make it work.
• MAX_ACCUMULATOR Number Specify the max accumulator time. Need enabledAccumulator to make it work.
• enabledAccumulator Boolean If enabled accumulator, then will call step function with the fixed time step FIXED_TIME_STEP. And if the update dt is bigger than the time step, then will call step function several times. If disabled accumulator, then will call step function with a time step calculated with the frame rate.
• enabled Boolean Enabled the physics manager?
• debugDrawFlags Number Debug draw flags.
• gravity Vec2 The physics world gravity.

Methods

• testPoint Test which collider contains the given world point
• testAABB Test which colliders intersect the given world rect
• rayCast Raycast the world for all colliders in the path of the ray. The raycast ignores colliders that contain the starting point.
• attachDebugDrawToCamera Attach physics debug draw to camera
• detachDebugDrawFromCamera Detach physics debug draw to camera
• on Register an callback of a specific event type on the EventTarget.
• off Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.
• targetOff Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
• once Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.
• dispatchEvent Dispatches an event into the event flow. The event target is the EventTarget object upon which the dispatchEvent() method is called.
• emit Send an event to this object directly, this method will not propagate the event to any other objects. The event will be created from the supplied message, you can get the "detail" argument from event.detail.

Details

Properties

DrawBits

The draw bits for drawing physics debug information.

Examples

cc.director.getPhysicsManager().debugDrawFlags =
// cc.PhysicsManager.DrawBits.e_aabbBit |
// cc.PhysicsManager.DrawBits.e_pairBit |
// cc.PhysicsManager.DrawBits.e_centerOfMassBit |
cc.PhysicsManager.DrawBits.e_jointBit |
cc.PhysicsManager.DrawBits.e_shapeBit;

PTM_RATIO

The ratio transform between physics unit and pixel unit, generally is 32.

VELOCITY_ITERATIONS

The velocity iterations for the velocity constraint solver.

POSITION_ITERATIONS

The position Iterations for the position constraint solver.

FIXED_TIME_STEP

Specify the fixed time step. Need enabledAccumulator to make it work.

MAX_ACCUMULATOR

Specify the max accumulator time. Need enabledAccumulator to make it work.

enabledAccumulator

If enabled accumulator, then will call step function with the fixed time step FIXED_TIME_STEP. And if the update dt is bigger than the time step, then will call step function several times. If disabled accumulator, then will call step function with a time step calculated with the frame rate.

enabled

Enabled the physics manager?

debugDrawFlags

Debug draw flags.

Examples

// enable all debug draw info
var Bits = cc.PhysicsManager.DrawBits;
cc.director.getPhysicsManager().debugDrawFlags = Bits.e_aabbBit |
Bits.e_pairBit |
Bits.e_centerOfMassBit |
Bits.e_jointBit |
Bits.e_shapeBit;

// disable debug draw info
cc.director.getPhysicsManager().debugDrawFlags = 0;

gravity

The physics world gravity.

Methods

testPoint

Test which collider contains the given world point

Parameters

• point Vec2 the world point

testAABB

Test which colliders intersect the given world rect

Parameters

• rect Rect the world rect

rayCast

Raycast the world for all colliders in the path of the ray. The raycast ignores colliders that contain the starting point.

Parameters

• p1 Vec2 start point of the raycast
• p2 Vec2 end point of the raycast
• type RayCastType optional, default is RayCastType.Closest

attachDebugDrawToCamera

Attach physics debug draw to camera

Parameters

• camera Camera

detachDebugDrawFromCamera

Detach physics debug draw to camera

Parameters

• camera Camera

on

Register an callback of a specific event type on the EventTarget.

Parameters

• type String A string representing the event type to listen for.
• callback Function The callback that will be invoked when the event is dispatched.

                         The callback is ignored if it is a duplicate (the callbacks are unique).
  

  • event Event event
• target Object The target (this object) to invoke the callback, can be null
• useCapture Boolean When set to true, the capture argument prevents callback

                         from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
                         When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
                         Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
  

Examples

node.on(cc.Node.EventType.TOUCH_END, function (event) {
    cc.log("this is callback");
}, node);

off

Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.

Parameters

• type String A string representing the event type being removed.
• callback Function The callback to remove.
• target Object The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
• useCapture Boolean Specifies whether the callback being removed was registered as a capturing callback or not.

                         If not specified, useCapture defaults to false. If a callback was registered twice,
                         one with capture and one without, each must be removed separately. Removal of a capturing callback
                         does not affect a non-capturing version of the same listener, and vice versa.
  

Examples

// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
    cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);

targetOff

Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.

Parameters

• target Object The target to be searched for all related listeners

once

Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.

Parameters

• type String A string representing the event type to listen for.
• callback Function The callback that will be invoked when the event is dispatched.

                         The callback is ignored if it is a duplicate (the callbacks are unique).
  

  • event Event event
• target Object The target (this object) to invoke the callback, can be null
• useCapture Boolean When set to true, the capture argument prevents callback

                         from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
                         When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
                         Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
  

Examples

node.once(cc.Node.EventType.TOUCH_END, function (event) {
    cc.log("this is callback");
}, node);

dispatchEvent

Dispatches an event into the event flow. The event target is the EventTarget object upon which the dispatchEvent() method is called.

Parameters

• event Event The Event object that is dispatched into the event flow

emit

Send an event to this object directly, this method will not propagate the event to any other objects. The event will be created from the supplied message, you can get the "detail" argument from event.detail.

Parameters

• message String the message to send
• detail Any whatever argument the message needs