nape-js API
    Preparing search index...

    Class AngleJoint

    Constrains the relative angle between two bodies within a range.

    The constraint enforces: jointMin ≤ body2.rotation - ratio * body1.rotation ≤ jointMax

    When jointMin === jointMax the relative angle is fixed exactly. When jointMin < jointMax the joint acts as a rotational limit.

    // Limit the angle between two bodies to ±45 degrees
    const joint = new AngleJoint(
      body1, body2,
      -Math.PI / 4,  // jointMin
      Math.PI / 4,   // jointMax
    );
    joint.space = space;

    Fully modernized — uses ZPP_AngleJoint directly (extracted to TypeScript).

    Hierarchy (View Summary)

    Index
    constructor
    debugDraw
    active body1 body2 breakUnderError breakUnderForce cbTypes compound damping frequency ignore isSleeping jointMax jointMin maxError maxForce ratio removeOnBreak space stiff userData
    bodyImpulse copy impulse isSlack toString visitBodies

    • Parameters

      • body1: Body | null

        First body, or null for a static anchor.

      • body2: Body | null

        Second body, or null for a static anchor.

      • jointMin: number

        Minimum allowed relative angle (radians).

      • jointMax: number

        Maximum allowed relative angle (radians).

      • ratio: number = 1.0

        Gear ratio applied to body1's rotation. Default 1.0.

      Returns AngleJoint

    debugDraw: boolean = true
    • get damping(): number

      Damping ratio for soft constraints (stiff = false).

      0 = undamped (oscillates freely), 1 = critically damped. Values > 1 are overdamped. Must be >= 0. Ignored when stiff is true.

      Returns number

      1

    • set damping(value: number): void

      Parameters

      • value: number

      Returns void

    • get frequency(): number

      Spring frequency in Hz for soft constraints (stiff = false).

      Higher values make the spring stiffer; lower values make it bouncier. Must be > 0. Ignored when stiff is true.

      Returns number

      10

    • set frequency(value: number): void

      Parameters

      • value: number

      Returns void

    • get isSleeping(): boolean

      Whether the constraint's simulation component is currently sleeping.

      Only valid when the constraint is active and in a space — throws otherwise.

      Returns boolean

    • get maxForce(): number

      Maximum force (in Newtons) the constraint may apply per step.

      When the required force exceeds this value the constraint becomes slack. If breakUnderForce is true the constraint breaks instead. Must be >= 0. Infinity disables the limit.

      Returns number

      Infinity

    • set maxForce(value: number): void

      Parameters

      • value: number

      Returns void

    • get userData(): Record<string, unknown>

      Arbitrary user data attached to this constraint. Lazily initialized to {} on first access.

      Returns Record<string, unknown>

    • Returns true when the current relative angle is within [jointMin, jointMax] and no corrective impulse was applied last step.

      Returns boolean

      if either body is null.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods