Options
All
  • Public
  • Public/Protected
  • All
Menu

A line joint. This joint provides one degree of freedom: translation along an axis fixed in body1. 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

Constructors

Methods

  • EnableLimit(flag: boolean): void
  • Enable/disable the joint limit.

    Parameters

    • flag: boolean

      True to enable, false to disable limits

    Returns void

  • EnableMotor(flag: boolean): void
  • Enable/disable the joint motor.

    Parameters

    • flag: boolean

      True to enable, false to disable the motor.

    Returns void

  • GetJointSpeed(): number
  • Get the current joint translation speed, usually in meters per second.

    Returns number

    Joint speed.

  • GetJointTranslation(): number
  • GetLowerLimit(): number
  • GetMaxMotorForce(): number
  • GetMotorForce(): number
  • GetMotorSpeed(): number
  • GetReactionForce(inv_dt: number): b2Vec2
  • GetReactionTorque(inv_dt: number): number
  • GetType(): number
  • GetUpperLimit(): number
  • GetUserData(): any
  • IsActive(): boolean
  • IsLimitEnabled(): boolean
  • IsMotorEnabled(): boolean
  • 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(force: number): void
  • Set the maximum motor force, usually in N.

    Parameters

    • force: number

      New max motor force.

    Returns void

  • SetMotorSpeed(speed: number): void
  • Set the motor speed, usually in meters per second.

    Parameters

    • speed: number

      New motor speed.

    Returns void

  • SetUserData(data: any): void

Generated using TypeDoc