Class SwingTwistConstraint

Swing-twist constraint.

Hierarchy (View Summary)

JointConstraint
- SwingTwistConstraint

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

maxFrictionTorque

get maxFrictionTorque(): number
Returns number
- Max friction torque value.
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:100
set maxFrictionTorque(torque: number): void
Sets max friction torque.
Parameters
- torque: number
  Friction torque value.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:76

normalHalfConeAngle

get normalHalfConeAngle(): number
Returns number
- Normal half cone angle.
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:142
set normalHalfConeAngle(angle: number): void
Sets normal half cone angle. In radians.
Parameters
- angle: number
  Normal half cone angle (rads).
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:118

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

planeHalfConeAngle

get planeHalfConeAngle(): number
Returns number
- Plane half cone angle.
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:175
set planeHalfConeAngle(angle: number): void
Sets plane half cone angle. In radians.
Parameters
- angle: number
  Plane half cone angle (rads).
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:151

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

swingMotorSettings

get swingMotorSettings(): null | SpringSettings
Returns null | SpringSettings
- Returns Spring Settings or null, if spring is not used.
Default Value
```
null
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:109

twistAxis1

get twistAxis1(): Vec3
Returns Vec3
- Twist axis 1.
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:183

twistAxis2

get twistAxis2(): Vec3
Returns Vec3
- Twist axis 2.
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:191

twistMaxAngle

get twistMaxAngle(): number
Returns number
- Max twist angle angle.
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:223
set twistMaxAngle(angle: number): void
Sets twist maximum angle. In radians.
Parameters
- angle: number
  Max twist angle in radians.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:200

twistMinAngle

get twistMinAngle(): number
Returns number
- Min twist angle.
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:256
set twistMinAngle(angle: number): void
Sets minimum twist angle. In radians.
Parameters
- angle: number
  Min twist angle in radians.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:232

twistMotorSettings

get twistMotorSettings(): null | MotorSettings
Returns null | MotorSettings
- Returns Motor Settings or null, if a motor is not used.
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:264

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

setSwingMotorState

setSwingMotorState(state: number): void
Changes the swing motor state, e.g. turn it on/off. Following aliases available:
```
MOTOR_STATE_OFF
```
```
MOTOR_STATE_VELOCITY
```
```
MOTOR_STATE_POSITION
```
- MOTOR_STATE_POSITION: Motor will drive to target position.
- MOTOR_STATE_VELOCITY: Motor will drive to target velocity.
Parameters
- state: number
  Constant number, representing the state.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:321

setTargetAngularVelocityCS

setTargetAngularVelocityCS(velocity: Vec3): void
Set the target angular velocity of body 2 in constraint space of body 2.
Parameters
- velocity: Vec3
  Target angular velocity.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:297

setTargetOrientationBS

setTargetOrientationBS(rotation: Quat): void
Set the target orientation in body space. Refer to Jolt documentation for details.
Parameters
- rotation: Quat
  Target orientation.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:285

setTargetOrientationCS

setTargetOrientationCS(rotation: Quat): void
Set the target orientation in constraint space.
Parameters
- rotation: Quat
  Target orientation.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:273

setTwistMotorState

setTwistMotorState(state: number): void
Sets twist motor state. See setSwingMotorState for description.
Parameters
- state: number
  Constant number, representing the state.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/swing-twist.mjs:339

Class SwingTwistConstraint

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

entity1

Returns Entity

entity2

Returns Entity

maxFrictionTorque

Returns number

Default Value

Parameters

Returns void

normalHalfConeAngle

Returns number

Default Value

Parameters

Returns void

numPositionStepsOverride

Returns number

Default Value

numVelocityStepsOverride

Returns number

Default Value

planeHalfConeAngle

Returns number

Default Value

Parameters

Returns void

point1

Returns Vec3

Default Value

point2

Returns Vec3

Default Value

space

Returns number

Default Value

swingMotorSettings

Returns null | SpringSettings

Default Value

twistAxis1

Returns Vec3

Default Value

twistAxis2

Returns Vec3

Default Value

twistMaxAngle

Returns number

Parameters

Returns void

twistMinAngle

Returns number

Default Value

Parameters

Returns void

twistMotorSettings

Returns null | MotorSettings

Methods

destroy

Returns void

setEnabled

Parameters

Returns void

setSwingMotorState

Parameters

Returns void

setTargetAngularVelocityCS

Parameters

Returns void

setTargetOrientationBS

Parameters

Returns void

setTargetOrientationCS

Parameters

Returns void

setTwistMotorState

Parameters