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 (View Summary)

Constructors

constructor

Methods

EnableLimit EnableMotor GetAnchorA GetAnchorB GetBodyA GetBodyB GetJointSpeed GetJointTranslation GetLowerLimit GetMotorForce GetMotorSpeed GetNext GetReactionForce GetReactionTorque GetType GetUpperLimit GetUserData IsActive IsLimitEnabled IsMotorEnabled SetLimits SetMaxMotorForce SetMotorSpeed SetUserData

Constructors

constructor

Methods

EnableLimit

  • EnableLimit(flag: boolean): void

  • Enable/disable the joint limit.

    Parameters

    • flag: boolean

      True to enable, false to disable.

    Returns void

EnableMotor

  • EnableMotor(flag: boolean): void

  • Enable/disable the joint motor.

    Parameters

    • flag: boolean

      True to enable, false to disable.

    Returns void

GetAnchorA

GetAnchorB

GetBodyA

GetBodyB

GetJointSpeed

  • GetJointSpeed(): number

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

    Returns number

    Joint speed.

GetJointTranslation

  • GetJointTranslation(): number

  • Get the current joint translation, usually in meters.

    Returns number

    Joint translation.

GetLowerLimit

  • GetLowerLimit(): number

  • Get the lower joint limit, usually in meters.

    Returns number

    Lower limit.

GetMotorForce

  • GetMotorForce(): number

  • Get the current motor force, usually in N.

    Returns number

    Motor force.

GetMotorSpeed

  • GetMotorSpeed(): number

  • Get the motor speed, usually in meters per second.

    Returns number

    Motor speed.

GetNext

GetReactionForce

GetReactionTorque

GetType

GetUpperLimit

  • GetUpperLimit(): number

  • Get the upper joint limit, usually in meters.

    Returns number

    Upper limit.

GetUserData

IsActive

IsLimitEnabled

  • IsLimitEnabled(): boolean

  • Is the joint limit enabled?

    Returns boolean

    True if enabled otherwise false.

IsMotorEnabled

  • IsMotorEnabled(): boolean

  • Is the joint motor enabled?

    Returns boolean

    True if enabled, otherwise false.

SetLimits

  • SetLimits(lower: number, upper: number): void

  • Set the joint limits, usually in meters.

    Parameters

    • lower: number

      Lower limit.

    • upper: number

      Upper limit.

    Returns void

SetMaxMotorForce

  • SetMaxMotorForce(force: number): void

  • Set the maximum motor force, usually in N.

    Parameters

    • force: number

      New max force.

    Returns void

SetMotorSpeed

  • SetMotorSpeed(speed: number): void

  • Set the motor speed, usually in meters per second.

    Parameters

    • speed: number

      New motor speed.

    Returns void

SetUserData

Settings

Member Visibility

On This Page

Constructors
Methods