Class b2FrictionJoint

Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction.

Hierarchy

Index

Properties

Methods

Properties

public m_angularMass: number

Angular mass.

public m_linearMass: b2Mat22

Linear mass.

Methods

public GetAnchorA(): b2Vec2

Get the anchor point on bodyA in world coordinates.

Returns

b2Vec2

Body A anchor.

public GetAnchorB(): b2Vec2

Get the anchor point on bodyB in world coordinates.

Returns

b2Vec2

Body B anchor.

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 GetMaxForce(): number

Gets the max force.

Returns

number

Max force.

public GetMaxTorque(): number

Gets the max torque.

Returns

number

Max torque.

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 N.

Parameters

  • inv_dt: number

Returns

b2Vec2

Reaction force in N.

public GetReactionTorque(inv_dt: number): number

Get the reaction torque on body 2 in N.

Parameters

  • inv_dt: number

Returns

number

Reaction torque in 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 SetMaxForce(force: number)

Sets the max force.

Parameters

  • force: number

    New max force.

public SetMaxTorque(torque: number)

Sets the max torque.

Parameters

  • torque: number

    New max torque.

public SetUserData(data: any)

Set the user data pointer.

Parameters

  • data: any

    Your custom data.