Class b2GearJoint

A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length.

warning

The revolute and prismatic joints must be attached to fixed bodies (which must be body1 on those joints).

Hierarchy

Index

Methods

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 GetNext(): b2Joint

Get the next joint the world joint list.

Returns

b2Joint

Next joint.

public GetRatio(): number

Get the gear ratio.

Returns

number

Gear ratio.

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

Set the gear ratio.

Parameters

  • ratio: number

public SetUserData(data: any)

Set the user data pointer.

Parameters

  • data: any

    Your custom data.