Options
All
  • Public
  • Public/Protected
  • All
Menu

Class b2DistanceJoint

A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

GetAnchorA

  • Get the anchor point on bodyA in world coordinates.

    Returns b2Vec2

    Body A anchor.

GetAnchorB

  • Get the anchor point on bodyB in world coordinates.

    Returns b2Vec2

    Body B anchor.

GetBodyA

  • Get the first body attached to this joint.

    Returns b2Body

    Body A.

GetBodyB

  • Get the second body attached to this joint.

    Returns b2Body

    Body B.

GetDampingRatio

  • GetDampingRatio(): number

  • Gets the damping ratio.

    Returns number

    Damping ratio.

GetFrequency

  • GetFrequency(): number

  • Gets the frequency.

    Returns number

    Frequency.

GetLength

  • GetLength(): number

  • Gets the length of distance between the two bodies.

    Returns number

    Length.

GetNext

  • Get the next joint the world joint list.

    Returns b2Joint

    Next joint.

GetReactionForce

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

GetReactionTorque

  • GetReactionTorque(inv_dt: number): number

  • Get the reaction torque on body 2 in N.

    Parameters

    • inv_dt: number

    Returns number

    Reaction torque in N.

GetType

  • GetType(): number

  • Get the type of the concrete joint.

    Returns number

    Joint type.

GetUserData

  • GetUserData(): any

  • Get the user data pointer.

    Returns any

    User data. Cast to your data type.

IsActive

  • IsActive(): boolean

  • Short-cut function to determine if either body is inactive.

    Returns boolean

    True if active, otherwise false.

SetDampingRatio

  • SetDampingRatio(ratio: number): void

  • Sets the damping ratio.

    Parameters

    • ratio: number

      New damping ratio.

    Returns void

SetFrequency

  • SetFrequency(hz: number): void

  • Sets the frequency.

    Parameters

    • hz: number

      New frequency (hertz).

    Returns void

SetLength

  • SetLength(length: number): void

  • Sets the length of distance between the two bodies.

    Parameters

    • length: number

      New length.

    Returns void

SetUserData

  • SetUserData(data: any): void

  • Set the user data pointer.

    Parameters

    • data: any

      Your custom data.

    Returns void

Generated using TypeDoc