Class b2World

constructor

• new b2World(gravity: b2Vec2, doSleep: boolean): b2World

• Creates a new world.

  Parameters

  • gravity: b2Vec2

    The world gravity vector.
  • doSleep: boolean

    Improvie performance by not simulating inactive bodies.

  Returns b2World

Statice_locked

Statice_newFixture

AddController

• AddController(c: b2Controller): b2Controller

• Add a controller to the world list.

  Parameters

  • c: b2Controller

    Controller to add.

  Returns b2Controller

  Controller that was added to the world.

ClearForces

• ClearForces(): void

• Call this after you are done with time steps to clear the forces. You normally call this after each call to Step, unless you are performing sub-steps.

  Returns void

CreateBody

• CreateBody(def: b2BodyDef): b2Body

• Create a rigid body given a definition. No reference to the definition is retained.

  Parameters

  • def: b2BodyDef

    Body's definition.

  Returns b2Body

  Created rigid body.

CreateController

• CreateController(controller: b2Controller): b2Controller

• Creates a new controller.

  Parameters

  • controller: b2Controller

    New controller.

  Returns b2Controller

  New controller.

CreateJoint

• CreateJoint(def: b2JointDef): b2Joint

• Create a joint to constrain bodies together. No reference to the definition is retained. This may cause the connected bodies to cease colliding.

  Parameters

  • def: b2JointDef

    Joint definition.

  Returns b2Joint

  New created joint.

  Warning

  This function is locked during callbacks.

DestroyBody

• DestroyBody(b: b2Body): void

• Destroy a rigid body given a definition. No reference to the definition is retained. This function is locked during callbacks.

  Parameters

  • b: b2Body

    Body to destroy.

  Returns void

  Warning

  This function is locked during callbacks.

DestroyController

• DestroyController(controller: b2Controller): void

• Destroy a controller given the controller instance.

  Parameters

  • controller: b2Controller

    Controller to destroy.

  Returns void

  Warning

  This function is locked during callbacks.

DestroyJoint

• DestroyJoint(j: b2Joint): void

• Destroy a joint. This may cause the connected bodies to begin colliding.

  Parameters

  • j: b2Joint

    Joint to destroy.

  Returns void

DrawDebugData

• DrawDebugData(): void

• Call this to draw shapes and other debug draw data.

  Returns void

GetBodyCount

• GetBodyCount(): number

• Get the number of bodies.

  Returns number

  Number of bodies in this world.

GetBodyList

• GetBodyList(): b2Body

• Get the world body list. With the returned body, use b2Body::GetNext to get the next body in the world list. A NULL body indicates the end of the list.

  Returns b2Body

  The head of the world body list.

GetContactCount

• GetContactCount(): number

• Get the number of contacts (each may have 0 or more contact points).

  Returns number

  Number of contacts.

GetContactList

• GetContactList(): b2Contact

• Get the world contact list. With the returned contact, use b2Contact::GetNext to get the next contact in the world list. A NULL contact indicates the end of the list.

  Returns b2Contact

  The head of the world contact list.

GetGravity

• GetGravity(): b2Vec2

• Get the global gravity vector.

  Returns b2Vec2

  Global gravity vector.

GetGroundBody

• GetGroundBody(): b2Body

• The world provides a single static ground body with no collision shapes. You can use this to simplify the creation of joints and static shapes.

  Returns b2Body

  The ground body.

GetJointCount

• GetJointCount(): number

• Get the number of joints.

  Returns number

  The number of joints in the world.

GetJointList

• GetJointList(): b2Joint

• Get the world joint list. With the returned joint, use b2Joint::GetNext to get the next joint in the world list. A NULL joint indicates the end of the list.

  Returns b2Joint

  The head of the world joint list.

GetProxyCount

• GetProxyCount(): number

• Get the number of broad-phase proxies.

  Returns number

  Number of borad-phase proxies.

IsLocked

• IsLocked(): boolean

• Is the world locked (in the middle of a time step).

  Returns boolean

  True if the world is locked and in the middle of a time step, otherwise false.

QueryAABB

• QueryAABB(callback: (fixutre: b2Fixture) => boolean, aabb: b2AABB): void

• Query the world for all fixtures that potentially overlap the provided AABB.

  Parameters

  • callback: (fixutre: b2Fixture) => boolean

    A user implemented callback class. It should match signature function Callback(fixture:b2Fixture):Boolean. Return true to continue to the next fixture.
  • aabb: b2AABB

    The query bounding box.

  Returns void

QueryPoint

• QueryPoint(callback: (fixture: b2Fixture) => boolean, p: b2Vec2): void

• Query the world for all fixtures that contain a point.

  Parameters

  • callback: (fixture: b2Fixture) => boolean

    A user implemented callback class. It should match signature function Callback(fixture:b2Fixture):Boolean. Return true to continue to the next fixture.
  • p: b2Vec2

    The query point.

  Returns void

  Note

  This provides a feature specific to this port.

QueryShape

• QueryShape(
      callback: (fixture: b2Fixture) => boolean,
      shape: b2Shape,
      transform?: b2Transform,
  ): void

• Query the world for all fixtures that precisely overlap the provided transformed shape.

  Parameters

  • callback: (fixture: b2Fixture) => boolean

    A user implemented callback class. It should match signature function Callback(fixture:b2Fixture):Boolean. Return true to continue to the next fixture.
  • shape: b2Shape

    The query shape.
  • Optionaltransform: b2Transform

    Optional transform, default = null.

  Returns void

  Note

  This provides a feature specific to this port.

RayCast

• RayCast(
      callback: (
          fixture: b2Fixture,
          point: b2Vec2,
          normal: b2Vec2,
          fraction: number,
      ) => number,
      point1: b2Vec2,
      point2: b2Vec2,
  ): void

• Ray-cast the world for all fixtures in the path of the ray. Your callback Controls whether you get the closest point, any point, or n-points The ray-cast ignores shapes that contain the starting point.

  Parameters

  • callback: (fixture: b2Fixture, point: b2Vec2, normal: b2Vec2, fraction: number) => number

    A callback function which must be of signature: function Callback( fixture:b2Fixture, // The fixture hit by the ray point:b2Vec2, // The point of initial intersection normal:b2Vec2, // The normal vector at the point of intersection fraction:Number // The fractional length along the ray of the intersection ):Number Callback should return the new length of the ray as a fraction of the original length. By returning 0, you immediately terminate. By returning 1, you continue wiht the original ray. By returning the current fraction, you proceed to find the closest point.
  • point1: b2Vec2

    The ray starting point.
  • point2: b2Vec2

    The ray ending point.

  Returns void

RayCastAll

• RayCastAll(point1: b2Vec2, point2: b2Vec2): b2Fixture[]

• Ray-cast the world for all fixture in the path of the ray.

  Parameters

  • point1: b2Vec2

    The ray starting point.
  • point2: b2Vec2

    The ray ending point.

  Returns b2Fixture[]

  Array of all the fixtures intersected by the ray.

RayCastOne

• RayCastOne(point1: b2Vec2, point2: b2Vec2): b2Fixture

• Ray-cast the world for the first fixture in the path of the ray.

  Parameters

  • point1: b2Vec2

    The ray starting point.
  • point2: b2Vec2

    The ray ending point.

  Returns b2Fixture

  First fixture intersected by the ray.

RemoveController

• RemoveController(c: b2Controller): void

• Removes the controller from the world.

  Parameters

  • c: b2Controller

    Controller to remove.

  Returns void

SetBroadPhase

• SetBroadPhase(broadPhase: IBroadPhase): void

• Use the given object as a broadphase. The old broadphase will not be cleanly emptied.

  Parameters

  • broadPhase: IBroadPhase

  Returns void

  Warning

  This function is locked during callbacks.

SetContactFilter

• SetContactFilter(filter: b2ContactFilter): void

• Register a contact filter to provide specific control over collision. Otherwise the default filter is used (b2_defaultFilter).

  Parameters

  • filter: b2ContactFilter

    Contact filter'er.

  Returns void

SetContactListener

• SetContactListener(listener: b2ContactListener): void

• Register a contact event listener.

  Parameters

  • listener: b2ContactListener

    Contact event listener.

  Returns void

SetContinuousPhysics

• SetContinuousPhysics(flag: boolean): void

• Enable/disable continuous physics. For testing.

  Parameters

  • flag: boolean

    True for continuous physics, otherwise false.

  Returns void

SetDebugDraw

• SetDebugDraw(debugDraw: b2DebugDraw): void

• Register a routine for debug drawing. The debug draw functions are called inside the b2World::Step method, so make sure your renderer is ready to consume draw commands when you call Step().

  Parameters

  • debugDraw: b2DebugDraw

    Debug drawing instance.

  Returns void

SetDestructionListener

• SetDestructionListener(listener: b2DestructionListener): void

• Destruct the world. All physics entities are destroyed and all heap memory is released.

  Parameters

  • listener: b2DestructionListener

    Destruction listener instance.

  Returns void

SetGravity

• SetGravity(gravity: b2Vec2): void

• Change the global gravity vector.

  Parameters

  • gravity: b2Vec2

    New global gravity vector.

  Returns void

SetWarmStarting

• SetWarmStarting(flag: boolean): void

• Enable/disable warm starting. For testing.

  Parameters

  • flag: boolean

    True for warm starting, otherwise false.

  Returns void

Step

• Step(dt: number, velocityIterations: number, positionIterations: number): void

• Take a time step. This performs collision detection, integration, and constraint solution.

  Parameters

  • dt: number

    The amout of time to simulate, this should not vary.
  • velocityIterations: number

    For the velocity constraint solver.
  • positionIterations: number

    For the position constraint solver.

  Returns void

Validate

• Validate(): void

• Perform validation of internal data structures.

  Returns void