Class PulleyJoint

Pulley joint — constrains the weighted sum of two distances to remain within [jointMin, jointMax]:

jointMin ≤ distance(anchor1, anchor2) + ratio * distance(anchor3, anchor4) ≤ jointMax

This models a rope-and-pulley system where lifting one side lowers the other. All four anchors are in the local space of their respective bodies.

Example

// Classic pulley: as body2 moves away from anchor1, body4 moves toward anchor3
const joint = new PulleyJoint(
  body1, body2, body3, body4,
  Vec2.weak(0,0), Vec2.weak(0,0),
  Vec2.weak(0,0), Vec2.weak(0,0),
  0, 200, // total rope length
);
joint.space = space;

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

Hierarchy (View Summary)

Constraint
- PulleyJoint

Index

Constructors

constructor

new PulleyJoint(
    body1: Body | null,
    body2: Body | null,
    body3: Body | null,
    body4: Body | null,
    anchor1: Vec2,
    anchor2: Vec2,
    anchor3: Vec2,
    anchor4: Vec2,
    jointMin: number,
    jointMax: number,
    ratio?: number,
): PulleyJoint
Parameters
- body1: Body | null
  First body (pulley side 1), or null for a static anchor.
- body2: Body | null
  Second body (pulley side 1), or null for a static anchor.
- body3: Body | null
  Third body (pulley side 2), or null for a static anchor.
- body4: Body | null
  Fourth body (pulley side 2), or null for a static anchor.
- anchor1: Vec2
  Anchor on body1 in local space (disposed if weak).
- anchor2: Vec2
  Anchor on body2 in local space (disposed if weak).
- anchor3: Vec2
  Anchor on body3 in local space (disposed if weak).
- anchor4: Vec2
  Anchor on body4 in local space (disposed if weak).
- jointMin: number
  Minimum allowed total rope length (must be >= 0).
- jointMax: number
  Maximum allowed total rope length (must be >= jointMin).
- ratio: number = 1.0
  Weight of the second distance segment. Default 1.0.
Returns PulleyJoint
Overrides Constraint.constructor
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:76

Properties

debugDraw

debugDraw: boolean = true

Accessors

active

get active(): boolean
Whether the constraint is currently active (enforced by the solver).

Deactivating a constraint suspends it without removing it from the space.

Returns boolean
Default Value
true
Inherited from Constraint.active
- Defined in packages/nape-js/src/constraint/Constraint.ts:149
set active(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Constraint.active
- Defined in packages/nape-js/src/constraint/Constraint.ts:152

anchor1

get anchor1(): Vec2
Anchor on body1 in local coordinates.

Returns Vec2
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:380
set anchor1(value: Vec2): void
Parameters
- value: Vec2
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:384

anchor2

get anchor2(): Vec2
Anchor on body2 in local coordinates.

Returns Vec2
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:399
set anchor2(value: Vec2): void
Parameters
- value: Vec2
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:403

anchor3

get anchor3(): Vec2
Anchor on body3 in local coordinates.

Returns Vec2
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:418
set anchor3(value: Vec2): void
Parameters
- value: Vec2
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:422

anchor4

get anchor4(): Vec2
Anchor on body4 in local coordinates.

Returns Vec2
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:437
set anchor4(value: Vec2): void
Parameters
- value: Vec2
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:441

body1

get body1(): Body
First body of the first rope segment. null = static world point.

Returns Body
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:200
set body1(value: Body | null): void
Parameters
- value: Body | null
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:204

body2

get body2(): Body
Second body of the first rope segment. null = static world point.

Returns Body
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:209
set body2(value: Body | null): void
Parameters
- value: Body | null
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:213

body3

get body3(): Body
First body of the second rope segment. null = static world point.

Returns Body
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:218
set body3(value: Body | null): void
Parameters
- value: Body | null
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:222

body4

get body4(): Body
Second body of the second rope segment. null = static world point.

Returns Body
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:227
set body4(value: Body | null): void
Parameters
- value: Body | null
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:231

breakUnderError

get breakUnderError(): boolean
When true, the constraint breaks if the positional error exceeds maxError.

Returns boolean
Default Value
false
Inherited from Constraint.breakUnderError
- Defined in packages/nape-js/src/constraint/Constraint.ts:325
set breakUnderError(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Constraint.breakUnderError
- Defined in packages/nape-js/src/constraint/Constraint.ts:328

breakUnderForce

get breakUnderForce(): boolean
When true, the constraint breaks (fires a BREAK event) if the applied force exceeds maxForce in a single step.

Returns boolean
Default Value
false
Inherited from Constraint.breakUnderForce
- Defined in packages/nape-js/src/constraint/Constraint.ts:311
set breakUnderForce(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Constraint.breakUnderForce
- Defined in packages/nape-js/src/constraint/Constraint.ts:314

cbTypes

get cbTypes(): object
The set of CbTypes assigned to this constraint. Used to filter which listeners respond to this constraint's events.

Returns object
Inherited from Constraint.cbTypes
- Defined in packages/nape-js/src/constraint/Constraint.ts:376

compound

get compound(): Compound | null
The compound this constraint belongs to, or null. When set, the constraint's space is managed by the compound.

Returns Compound | null
Inherited from Constraint.compound
- Defined in packages/nape-js/src/constraint/Constraint.ts:121
set compound(value: Compound | null): void
Parameters
- value: Compound | null
Returns void
Inherited from Constraint.compound
- Defined in packages/nape-js/src/constraint/Constraint.ts:125

damping

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
Default Value
1
Inherited from Constraint.damping
- Defined in packages/nape-js/src/constraint/Constraint.ts:241
set damping(value: number): void
Parameters
- value: number
Returns void
Inherited from Constraint.damping
- Defined in packages/nape-js/src/constraint/Constraint.ts:244

frequency

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
Default Value
10
Inherited from Constraint.frequency
- Defined in packages/nape-js/src/constraint/Constraint.ts:216
set frequency(value: number): void
Parameters
- value: number
Returns void
Inherited from Constraint.frequency
- Defined in packages/nape-js/src/constraint/Constraint.ts:219

ignore

get ignore(): boolean
When true the constraint is completely ignored by the engine — bodies are not woken, no impulse is applied, and no callbacks fire.

Returns boolean
Default Value
false
Inherited from Constraint.ignore
- Defined in packages/nape-js/src/constraint/Constraint.ts:183
set ignore(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Constraint.ignore
- Defined in packages/nape-js/src/constraint/Constraint.ts:186

isSleeping

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
Inherited from Constraint.isSleeping
- Defined in packages/nape-js/src/constraint/Constraint.ts:352

jointMax

get jointMax(): number
Maximum allowed total rope length (must be >= jointMin).

Returns number
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:478
set jointMax(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:481

jointMin

get jointMin(): number
Minimum allowed total rope length (must be >= 0).

Returns number
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:460
set jointMin(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:463

maxError

get maxError(): number
Maximum positional error (in pixels) allowed before breaking.

Only meaningful when breakUnderError is true. Must be >= 0. Infinity disables the limit.

Returns number
Default Value
Infinity
Inherited from Constraint.maxError
- Defined in packages/nape-js/src/constraint/Constraint.ts:290
set maxError(value: number): void
Parameters
- value: number
Returns void
Inherited from Constraint.maxError
- Defined in packages/nape-js/src/constraint/Constraint.ts:293

maxForce

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
Default Value
Infinity
Inherited from Constraint.maxForce
- Defined in packages/nape-js/src/constraint/Constraint.ts:267
set maxForce(value: number): void
Parameters
- value: number
Returns void
Inherited from Constraint.maxForce
- Defined in packages/nape-js/src/constraint/Constraint.ts:270

ratio

get ratio(): number
Weight of the second rope segment in the total length sum.

The constraint enforces: distance(a1,a2) + ratio * distance(a3,a4) within bounds.

Returns number
Default Value
1.0
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:501
set ratio(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:504

removeOnBreak

get removeOnBreak(): boolean
When true (default), the constraint is automatically removed from its space when it breaks. Set to false to keep it in the space after breaking.

Returns boolean
Default Value
true
Inherited from Constraint.removeOnBreak
- Defined in packages/nape-js/src/constraint/Constraint.ts:340
set removeOnBreak(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Constraint.removeOnBreak
- Defined in packages/nape-js/src/constraint/Constraint.ts:343

space

get space(): Space | null
The space this constraint belongs to, or null if not in a space.

Assign to add/remove the constraint from a space:
```
joint.space = mySpace;  // adds to space
joint.space = null;     // removes from space
```
Cannot be set if the constraint belongs to a Compound.
Returns Space | null
Inherited from Constraint.space
- Defined in packages/nape-js/src/constraint/Constraint.ts:82
set space(value: Space | null): void
Parameters
- value: Space | null
Returns void
Inherited from Constraint.space
- Defined in packages/nape-js/src/constraint/Constraint.ts:86

stiff

get stiff(): boolean
When true (default) the constraint is stiff/rigid. When false the constraint uses a soft spring model driven by frequency and damping.

Returns boolean
Default Value
true
Inherited from Constraint.stiff
- Defined in packages/nape-js/src/constraint/Constraint.ts:199
set stiff(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Constraint.stiff
- Defined in packages/nape-js/src/constraint/Constraint.ts:202

userData

get userData(): Record<string, unknown>
Arbitrary user data attached to this constraint. Lazily initialized to {} on first access.

Returns Record<string, unknown>
Inherited from Constraint.userData
- Defined in packages/nape-js/src/constraint/Constraint.ts:365

Methods

bodyImpulse

bodyImpulse(body: Body): Vec3
The impulse applied to body by this constraint in the last simulation step, expressed as a Vec3 (fx, fy, torque).
Parameters
- body: Body
Returns Vec3
Overrides Constraint.bodyImpulse
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:546

copy

copy(): Constraint
Creates and returns a copy of this constraint with the same parameters. The copy is not automatically added to a space.

Returns Constraint
Inherited from Constraint.copy
- Defined in packages/nape-js/src/constraint/Constraint.ts:419

impulse

impulse(): MatMN
The impulse applied by this constraint in the last simulation step.

The shape of the returned MatMN depends on the constraint's degrees of freedom (e.g., 1×1 for AngleJoint/MotorJoint, 2×1 for PivotJoint/LineJoint, 3×1 for WeldJoint).

Returns MatMN
Overrides Constraint.impulse
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:537

isSlack

isSlack(): boolean
Returns true when the total rope length is within bounds and no corrective impulse was applied last step.

Returns boolean
Throws
if any of the four bodies is null.
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:525

toString

toString(): string
Returns string
Inherited from Constraint.toString
- Defined in packages/nape-js/src/constraint/Constraint.ts:423

visitBodies

visitBodies(lambda: (body: Body) => void): void
Invokes fn once for each distinct body linked to this constraint.
Parameters
- lambda: (body: Body) => void
Returns void
Overrides Constraint.visitBodies
- Defined in packages/nape-js/src/constraint/PulleyJoint.ts:564

Class PulleyJoint

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PulleyJoint

Properties

debugDraw

Accessors

active

Returns boolean

Default Value

Parameters

Returns void

anchor1

Returns Vec2

Parameters

Returns void

anchor2

Returns Vec2

Parameters

Returns void

anchor3

Returns Vec2

Parameters

Returns void

anchor4

Returns Vec2

Parameters

Returns void

body1

Returns Body

Parameters

Returns void

body2

Returns Body

Parameters

Returns void

body3

Returns Body

Parameters

Returns void

body4

Returns Body

Parameters

Returns void

breakUnderError

Returns boolean

Default Value

Parameters

Returns void

breakUnderForce

Returns boolean

Default Value

Parameters

Returns void

cbTypes

Returns object

compound

Returns Compound | null

Parameters

Returns void

damping

Returns number

Default Value

Parameters

Returns void

frequency

Returns number

Default Value

Parameters

Returns void

ignore

Returns boolean