Class SliderConstraint

Slider constraint.

Hierarchy (View Summary)

JointConstraint
- SliderConstraint

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

limitsMax

get limitsMax(): number
Get lower limit of the slider constraint. In meters.

Returns number
- Lower limit of the constraint.
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:66

limitsMin

get limitsMin(): number
Get upper limit of the slider constraint. In meters.

Returns number
- Upper limit of the constraint.
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:75

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/slider.mjs:114
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/slider.mjs:84

maxFrictionForce

get maxFrictionForce(): number
Maximum amount of friction force to apply when not driven by a motor.

Returns number
- Friction value.
Default Value
```
0 (newtons)
```
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:150
set maxFrictionForce(force: number): void
Sets max friction force on the constraint after it was created.
Parameters
- force: number
  Friction force (newtons).
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:124

motorSettings

get motorSettings(): MotorSettings
If motor is used, returns Motor Settings. Otherwise null.

Returns MotorSettings
Default Value
```
null
```
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:160

normalAxis1

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

normalAxis2

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

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

sliderAxis1

get sliderAxis1(): Vec3
Returns Vec3
- Slider axis 1.
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:184

sliderAxis2

get sliderAxis2(): Vec3
Returns Vec3
- Slider axis 2.
Default Value
```
Vec3(1, 0, 0)
```
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:192

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_SLIDER
```
Overrides JointConstraint.type
- Defined in src/physics/jolt/front/constraint/types/joint/slider.mjs:200

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 translational limits of the slider 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/slider.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/slider.mjs:237

setTargetPosition

setTargetPosition(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/slider.mjs:277

setTargetVelocity

setTargetVelocity(velocity: number): void
Sets motor's target 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/slider.mjs:257

Class SliderConstraint

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

entity1

Returns Entity

entity2

Returns Entity

limitsMax

Returns number

limitsMin

Returns number

limitsSpringSettings

Returns null | SpringSettings

Default Value

Parameters

Returns void

maxFrictionForce

Returns number

Default Value

Parameters

Returns void

motorSettings

Returns MotorSettings

Default Value

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

sliderAxis1

Returns Vec3

Default Value

sliderAxis2

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

setTargetPosition

Parameters

Returns void

setTargetVelocity

Parameters

Returns void

Settings

On This Page