nape-js API
    Preparing search index...

    Class PivotJoint

    A pivot (pin) joint that constrains two anchor points — one on each body — to remain coincident in world space.

    This is the most common joint type and is used to simulate hinges, pins, and revolute connections between bodies.

    The constraint eliminates 2 translational degrees of freedom but leaves rotation free.

    // Pin body2 to body1's local origin
    const joint = new PivotJoint(
      body1, body2,
      Vec2.weak(0, 0),  // anchor on body1 (local)
      Vec2.weak(0, 0),  // anchor on body2 (local)
    );
    joint.space = space;

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

    Hierarchy (View Summary)

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

    • Parameters

      • body1: Body | null

        First body, or null for a static world anchor.

      • body2: Body | null

        Second body, or null for a static world anchor.

      • anchor1: Vec2

        Anchor point in body1's local space (disposed if weak).

      • anchor2: Vec2

        Anchor point in body2's local space (disposed if weak).

      Returns PivotJoint

    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.

      The clamp only applies to soft constraints (stiff = false): a stiff constraint ignores maxForce unless breakUnderForce is set. MotorJoint and SpringJoint are the exception and always clamp. 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>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods