Class FixedConstraint

Fixed constraint.

Hierarchy (View Summary)

JointConstraint
- FixedConstraint

Index

Accessors

axisX1 axisX2 axisY1 axisY2 entity1 entity2 numPositionStepsOverride numVelocityStepsOverride point1 point2 space

Methods

destroy setEnabled

Accessors

axisX1

get axisX1(): Vec3
Returns Vec3
- X axis 1
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/fixed.mjs:42

axisX2

get axisX2(): Vec3
Returns Vec3
- X axis 2
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/fixed.mjs:50

axisY1

get axisY1(): Vec3
Returns Vec3
- Y axis 1
Default Value
```
Vec3(0, 1, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/fixed.mjs:58

axisY2

get axisY2(): Vec3
Returns Vec3
- Y axis 2
Default Value
```
Vec3(0, 1, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/fixed.mjs:66

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

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

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

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