Class HingeConstraint

Hinge constraint.

Hierarchy (View Summary)

JointConstraint
- HingeConstraint

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

hingeAxis1

get hingeAxis1(): Vec3
Hinge axis 1.

Returns Vec3
- Vector with hinge axis 1.
Default Value
```
Vec3(0, 1, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:67

hingeAxis2

get hingeAxis2(): Vec3
Hinge axis 1.

Returns Vec3
- Vector with hinge axis 2.
Default Value
```
Vec3(0, 1, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:77

limitsMax

get limitsMax(): number
Upper limit of the hinge angle.

Returns number
- Angle in radians.
Default Value
```
+Math.PI
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:87

limitsMin

get limitsMin(): number
Lower limit of the hinge angle.

Returns number
- Angle in radians.
Default Value
```
-Math.PI
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:97

limitsSpringSettings

get limitsSpringSettings(): null | SpringSettings
Returns null | SpringSettings
- If spring is used, returns current spring settings. Otherwise null.
Default Value
```
null
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:136
set limitsSpringSettings(settings: SpringSettings): void
Modifies the spring properties after the constraint has been created.
Parameters
- settings: SpringSettings
  Object, describing spring settings.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:106

maxFrictionTorque

get maxFrictionTorque(): number
Returns the maximum amount of torque that is applied as friction when the constraint is not powered by a motor.

Returns number
- Max friction force (N m).
Default Value
```
0
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:165
set maxFrictionTorque(torque: number): void
Modifies maximum friction force after the constraint has been created.
Parameters
- torque: number
  Max friction force (N m).
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:145

motorSettings

get motorSettings(): null | MotorSettings
If a motor is used, returns the motor settings that were used when constraint was created. You cannot create a motor after the constraint has been created - you can only modify existing one.

Returns null | MotorSettings
- Returns motor settings or null, if motor is not used.
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:177

normalAxis1

get normalAxis1(): Vec3
Returns Vec3
Normal axis 1.
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:185

normalAxis2

get normalAxis2(): Vec3
Returns Vec3
Normal axis 1.
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:193

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

type

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

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

setLimits

setLimits(min: number, max: number): void
Update the rotation limits of the hinge after the constraint has been created.
Parameters
- min: number
  Lower limit of the hinge angle.
- max: number
  Upper limit of the hinge angle.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:297

setMotorState

setMotorState(state: number): void
Changes the 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/hinge.mjs:237

setTargetAngle

setTargetAngle(angle: number): void
Sets a target angle for the motor to drive to. The motor needs to be operating in position mode. See setMotorState.
Parameters
- angle: number
  Number, radians
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:277

setTargetAngularVelocity

setTargetAngularVelocity(velocity: number): void
Sets motor's target angular velocity. The motor needs to be operating in velocity mode. See setMotorState.
Parameters
- velocity: number
  Number, radians per second
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/hinge.mjs:257

Class HingeConstraint

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

entity1

Returns Entity

entity2

Returns Entity

hingeAxis1

Returns Vec3

Default Value

hingeAxis2

Returns Vec3

Default Value

limitsMax

Returns number

Default Value

limitsMin

Returns number

Default Value

limitsSpringSettings

Returns null | SpringSettings

Default Value

Parameters

Returns void

maxFrictionTorque

Returns number

Default Value

Parameters

Returns void

motorSettings

Returns null | MotorSettings

normalAxis1

Returns Vec3

Default Value

normalAxis2

Returns Vec3

Default Value

numPositionStepsOverride

Returns number

Default Value

numVelocityStepsOverride

Returns number

Default Value

point1

Returns Vec3

Default Value

point2

Returns Vec3

Default Value

space

Returns number

Default Value

type

Returns number

Default Value

Methods

destroy

Returns void

setEnabled

Parameters

Returns void

setLimits

Parameters

Returns void

setMotorState

Parameters

Returns void

setTargetAngle

Parameters

Returns void

setTargetAngularVelocity

Parameters

Returns void

Settings

On This Page