Class b2PrismaticJoint

A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in body1. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction.

Hierarchy

Index

Methods

Methods

public EnableLimit(flag: boolean)

Enable/disable the joint limit.

Parameters

  • flag: boolean

    True to enable, false to disable.

public EnableMotor(flag: boolean)

Enable/disable the joint motor.

Parameters

  • flag: boolean

    True to enable, false to disable.

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

Get the current joint translation speed, usually in meters per second.

Returns

number

Joint speed.

public GetJointTranslation(): number

Get the current joint translation, usually in meters.

Returns

number

Joint translation.

public GetLowerLimit(): number

Get the lower joint limit, usually in meters.

Returns

number

Lower limit.

public GetMotorForce(): number

Get the current motor force, usually in N.

Returns

number

Motor force.

public GetMotorSpeed(): number

Get the motor speed, usually in meters per second.

Returns

number

Motor speed.

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

Get the upper joint limit, usually in meters.

Returns

number

Upper limit.

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 IsLimitEnabled(): boolean

Is the joint limit enabled?

Returns

boolean

True if enabled otherwise false.

public IsMotorEnabled(): boolean

Is the joint motor enabled?

Returns

boolean

True if enabled, otherwise false.

public SetLimits(lower: number, upper: number)

Set the joint limits, usually in meters.

Parameters

  • lower: number

    Lower limit.

  • upper: number

    Upper limit.

public SetMaxMotorForce(force: number)

Set the maximum motor force, usually in N.

Parameters

  • force: number

    New max force.

public SetMotorSpeed(speed: number)

Set the motor speed, usually in meters per second.

Parameters

  • speed: number

    New motor speed.

public SetUserData(data: any)

Set the user data pointer.

Parameters

  • data: any

    Your custom data.