Class b2Joint

The base joint class. Joints are used to constraint two bodies together in various fashions. Some joints also feature limits and motors.

Hierarchy

Index

Methods

Methods

public GetAnchorA(): b2Vec2

Get the anchor point on bodyA in world coordinates.

Returns

b2Vec2

Anchor A point.

public GetAnchorB(): b2Vec2

Get the anchor point on bodyB in world coordinates.

Returns

b2Vec2

Anchor B point.

public GetBodyA(): b2Body

Get the first body attached to this joint.

Returns

b2Body

Body A.

public GetBodyB(): b2Body

Get the second body attached to this joint.

Returns

b2Body

Body B.

public GetNext(): b2Joint

Get the next joint the world joint list.

Returns

b2Joint

Next joint.

public GetReactionForce(inv_dt: number): b2Vec2

Get the reaction force on body2 at the joint anchor in Newtons.

Parameters

  • inv_dt: number

Returns

b2Vec2

Reaction force (N)

public GetReactionTorque(inv_dt: number): number

Get the reaction torque on body2 in N.

Parameters

  • inv_dt: number

Returns

number

Reaction torque (N).

public GetType(): number

Get the type of the concrete joint.

Returns

number

Joint type.

public GetUserData(): any

Get the user data pointer.

Returns

any

User data. Cast to your data type.

public IsActive(): boolean

Short-cut function to determine if either body is inactive.

Returns

boolean

True if active, otherwise false.

public SetUserData(data: any)

Set the user data pointer.

Parameters

  • data: any

    Your custom data.