Class PulleyConstraint

Pulley constraint.

Hierarchy (View Summary)

JointConstraint
- PulleyConstraint

Index

Accessors

entity1 entity2 fixedPoint1 fixedPoint2 maxLength minLength numPositionStepsOverride numVelocityStepsOverride point1 point2 ratio space type

Methods

destroy setEnabled

Accessors

entity1

get entity1(): Entity
First entity this joint is connected to.

Returns Entity
- First entity the joint is connected to.
Inherited from JointConstraint.entity1
- Defined in src/physics/jolt/front/constraint/types/joint/joint-constraint.mjs:59

entity2

get entity2(): Entity
Second entity this joint is connected to.

Returns Entity
- Second entity the joint is connected to.
Inherited from JointConstraint.entity2
- Defined in src/physics/jolt/front/constraint/types/joint/joint-constraint.mjs:68

fixedPoint1

get fixedPoint1(): Vec3
Fixed world point to which body 1 is connected (always in world space).

Returns Vec3
- World position of a point.
Default Value
```
Vec3(0, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/pulley.mjs:42

fixedPoint2

get fixedPoint2(): Vec3
Fixed world point to which body 2 is connected (always in world space).

Returns Vec3
- World position of a point.
Default Value
```
Vec3(0, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/pulley.mjs:52

maxLength

get maxLength(): number
The maximum length of the line segments. Use -1 to calculate the length based on the positions of the objects when the constraint is created.

Returns number
- Length of line segments (meters).
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/pulley.mjs:87

minLength

get minLength(): number
The minimum length of the line segments. Use -1 to calculate the length based on the positions of the objects when the constraint is created.

Returns number
- Length of line segments (meters).
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/pulley.mjs:76

numPositionStepsOverride

get numPositionStepsOverride(): number
Override for the number of solver position iterations to run. If set to 0, the constraint will use global default set by Physics initialization setting JoltInitSettings.numPositionSteps.

Returns number
- Positions steps override.
Default Value
```
0
```
Inherited from JointConstraint.numPositionStepsOverride
- Defined in src/physics/jolt/front/constraint/types/constraint.mjs:165

numVelocityStepsOverride

get numVelocityStepsOverride(): number
Override for the number of solver velocity iterations to run. If set to 0, the constraint will use global default set by Physics initialization setting JoltInitSettings.numVelocitySteps.

Returns number
- Velocity steps override.
Default Value
```
0
```
Inherited from JointConstraint.numVelocityStepsOverride
- Defined in src/physics/jolt/front/constraint/types/constraint.mjs:153

point1

get point1(): Vec3
First body position in constraint reference frame. Space is determined by space property.

Returns Vec3
Default Value
```
Vec3(0, 0, 0)
```
Inherited from JointConstraint.point1
- Defined in src/physics/jolt/front/constraint/types/joint/joint-constraint.mjs:39

point2

get point2(): Vec3
Second body position in constraint reference frame. Space is determined by space property.

Returns Vec3
Default Value
```
Vec3(0, 0, 0)
```
Inherited from JointConstraint.point2
- Defined in src/physics/jolt/front/constraint/types/joint/joint-constraint.mjs:50

ratio

get ratio(): number
Ratio between the two line segments:
```
MinDistance <= Length1 + Ratio * Length2 <= MaxDistance
```
Returns number
- Ratio between line segments.
Default Value
```
1
```
- Defined in src/physics/jolt/front/constraint/types/joint/pulley.mjs:65

space

get space(): number
Reference frame space that point1 and point2 use.

Returns number
- Number, representing reference space.
Default Value
```
CONSTRAINT_SPACE_WORLD
```
Inherited from JointConstraint.space
- Defined in src/physics/jolt/front/constraint/types/joint/joint-constraint.mjs:78

type

get type(): number
Returns number
- Constraint type alias number.
Default Value
```
CONSTRAINT_TYPE_PULLEY
```
Overrides JointConstraint.type
- Defined in src/physics/jolt/front/constraint/types/joint/pulley.mjs:95

Methods

destroy

destroy(): void
Destroy this constraint. The connected bodies will be activated.

Returns void
Inherited from JointConstraint.destroy
- Defined in src/physics/jolt/front/constraint/types/constraint.mjs:188

setEnabled

setEnabled(enabled: boolean, activate?: boolean): void
Allows to enable/disable a constraint without destroying it.
Parameters
- enabled: boolean
  true - enable constraint, false - disable.
- Optionalactivate: boolean = true
  If true, activate connected bodies after changing the state.
Returns void
Inherited from JointConstraint.setEnabled
- Defined in src/physics/jolt/front/constraint/types/constraint.mjs:213