Class DistanceConstraint

Distance constraint.

Hierarchy (View Summary)

JointConstraint
- DistanceConstraint

Index

Accessors

entity1 entity2 limitsSpring maxDistance minDistance numPositionStepsOverride numVelocityStepsOverride point1 point2 space type

Methods

destroy setDistance 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

limitsSpring

get limitsSpring(): null | SpringSettings
Returns null | SpringSettings
- Returns limits spring settings or null if spring is not used.
Default Value
```
null
```
- Defined in src/physics/jolt/front/constraint/types/joint/distance.mjs:70
set limitsSpring(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/distance.mjs:40

maxDistance

get maxDistance(): number
Current maximum distance that constraint will try to keep bodies apart. If set to negative number, it uses initial distance between two bodies, when the joint was created. Only works when space is set to CONSTRAINT_SPACE_WORLD.

Returns number
- Maximum distance to keep bodies apart.
Default Value
```
-1
```
- Defined in src/physics/jolt/front/constraint/types/joint/distance.mjs:94

minDistance

get minDistance(): number
Current minimum distance that constraint will try to keep bodies apart. If set to negative number, it uses initial distance between two bodies, when the joint was created. Only works when space is set to CONSTRAINT_SPACE_WORLD.

Returns number
- Minimum distance to keep bodies apart.
Default Value
```
-1
```
- Defined in src/physics/jolt/front/constraint/types/joint/distance.mjs:82

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

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

setDistance

setDistance(min: number, max: number): void
Changes the distance limits for the constraint. In meters.
Parameters
- min: number
  Lower distance limit.
- max: number
  Upper distance limit.
Returns void
- Defined in src/physics/jolt/front/constraint/types/joint/distance.mjs:121

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

Class DistanceConstraint

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

entity1

Returns Entity

entity2

Returns Entity

limitsSpring

Returns null | SpringSettings

Default Value

Parameters

Returns void

maxDistance

Returns number

Default Value

minDistance

Returns number

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

setDistance

Parameters

Returns void

setEnabled

Parameters

Returns void

Settings

On This Page