Class SpringConstraint

Creates a SpringConstraint, which is a type of Physics6DoFConstraint. This constraint applies a force at the ends which is proportional to the distance between ends, and a stiffness and damping factor. The force is calculated as (stiffness * positionError) - (damping * velocity)

Param: pivotA

The first pivot of the constraint in local space.

Param: pivotB

The second pivot of the constraint in local space.

Param: axisA

The first axis of the constraint in local space.

Param: axisB

The second axis of the constraint in local space.

Param: minDistance

The minimum distance between the two pivots.

Param: maxDistance

The maximum distance between the two pivots.

Param: stiffness

The stiffness of the spring.

Param: damping

The damping of the spring.

Param: scene

The scene the constraint belongs to.

Returns

The created SpringConstraint.

Hierarchy (View Summary)

Physics6DoFConstraint
- SpringConstraint

Constructors

constructor

new SpringConstraint(
    pivotA: Vector3,
    pivotB: Vector3,
    axisA: Vector3,
    axisB: Vector3,
    minDistance: number,
    maxDistance: number,
    stiffness: number,
    damping: number,
    scene: Scene,
): SpringConstraint
Parameters
- pivotA: Vector3
- pivotB: Vector3
- axisA: Vector3
- axisB: Vector3
- minDistance: number
- maxDistance: number
- stiffness: number
- damping: number
- scene: Scene
Returns SpringConstraint
Overrides Physics6DoFConstraint.constructor
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:455

Properties

_pluginData

_pluginData: any = undefined

V2 Physics plugin private data for a physics material

limits

limits: Physics6DoFLimit[]

The collection of limits which this constraint will apply

Accessors

isCollisionsEnabled

get isCollisionsEnabled(): boolean
Gets whether collisions are enabled for this physics object.

Returns boolean
true if collisions are enabled, false otherwise.
Inherited from Physics6DoFConstraint.isCollisionsEnabled
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:118
set isCollisionsEnabled(isEnabled: boolean): void
Enables or disables collisions for the physics engine.
Parameters
- isEnabled: boolean
  A boolean value indicating whether collisions should be enabled or disabled.
Returns void
Inherited from Physics6DoFConstraint.isCollisionsEnabled
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:108

isEnabled

get isEnabled(): boolean
Returns boolean
true if constraint is enabled
Inherited from Physics6DoFConstraint.isEnabled
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:98
set isEnabled(isEnabled: boolean): void
Enable/disable the constraint
Parameters
- isEnabled: boolean
  value for the constraint
Returns void
Inherited from Physics6DoFConstraint.isEnabled
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:90

options

get options(): PhysicsConstraintParameters
Retrieves the options of the physics constraint.

Returns PhysicsConstraintParameters
The physics constraint parameters.
Inherited from Physics6DoFConstraint.options
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:82

type

get type(): PhysicsConstraintType
Gets the type of the constraint.

Returns PhysicsConstraintType
The type of the constraint.
Inherited from Physics6DoFConstraint.type
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:72

Methods

dispose

dispose(): void
Disposes the constraint from the physics engine.

This method is useful for cleaning up the physics engine when a body is no longer needed. Disposing the body will free up resources and prevent memory leaks.

Returns void
Inherited from Physics6DoFConstraint.dispose
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:135

getAxisFriction

getAxisFriction(axis: PhysicsConstraintAxis): Nullable<number>
Gets the friction of the given axis of the physics engine.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the physics engine.
Returns Nullable<number>
The friction of the given axis, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisFriction
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:201

getAxisMaxLimit

getAxisMaxLimit(axis: PhysicsConstraintAxis): Nullable<number>
Gets the maximum limit of the given axis of the physics engine.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the physics engine.
Returns Nullable<number>
The maximum limit of the given axis, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisMaxLimit
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:269

getAxisMinLimit

getAxisMinLimit(axis: PhysicsConstraintAxis): Nullable<number>
Gets the minimum limit of the given axis of the physics engine.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the physics engine.
Returns Nullable<number>
The minimum limit of the given axis, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisMinLimit
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:246

getAxisMode

getAxisMode(
axis: PhysicsConstraintAxis,
): Nullable<PhysicsConstraintAxisLimitMode>
Gets the limit mode of the given axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
Returns Nullable<PhysicsConstraintAxisLimitMode>
The limit mode of the given axis, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisMode
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:226

getAxisMotorMaxForce

getAxisMotorMaxForce(axis: PhysicsConstraintAxis): Nullable<number>
Gets the maximum force of the motor of the given axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
Returns Nullable<number>
The maximum force of the motor, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisMotorMaxForce
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:330

getAxisMotorTarget

getAxisMotorTarget(axis: PhysicsConstraintAxis): Nullable<number>
Gets the target velocity of the motor associated to the given constraint axis.
Parameters
- axis: PhysicsConstraintAxis
  The constraint axis associated to the motor.
Returns Nullable<number>
The target velocity of the motor, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisMotorTarget
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:310

getAxisMotorType

getAxisMotorType(
axis: PhysicsConstraintAxis,
): Nullable<PhysicsConstraintMotorType>
Gets the motor type of the specified axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
Returns Nullable<PhysicsConstraintMotorType>
The motor type of the specified axis, or null if the constraint hasn't been initialized yet.
Inherited from Physics6DoFConstraint.getAxisMotorType
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:289

getBodiesUsingConstraint

getBodiesUsingConstraint(): ConstrainedBodyPair[]
Gets all bodies that are using this constraint

Returns ConstrainedBodyPair[]
Inherited from Physics6DoFConstraint.getBodiesUsingConstraint
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:126

setAxisFriction

setAxisFriction(axis: PhysicsConstraintAxis, friction: number): void
Sets the friction of the given axis of the physics engine.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the physics engine to set the friction for.
- friction: number
  The friction to set for the given axis.
Returns void
Inherited from Physics6DoFConstraint.setAxisFriction
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:191

setAxisMaxLimit

setAxisMaxLimit(axis: PhysicsConstraintAxis, limit: number): void
Sets the maximum limit of the given axis for the physics engine.
Parameters
- axis: PhysicsConstraintAxis
  The axis to set the limit for.
- limit: number
  The maximum limit of the axis.
  
  This method is useful for setting the maximum limit of the given axis for the physics engine, which can be used to control the movement of the physics object. This helps to ensure that the physics object does not move beyond the given limit.
Returns void
Inherited from Physics6DoFConstraint.setAxisMaxLimit
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:259

setAxisMinLimit

setAxisMinLimit(axis: PhysicsConstraintAxis, minLimit: number): void
Sets the minimum limit of a given axis of a constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
- minLimit: number
  The minimum limit of the axis.
Returns void
Inherited from Physics6DoFConstraint.setAxisMinLimit
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:236

setAxisMode

setAxisMode(
axis: PhysicsConstraintAxis,
limitMode: PhysicsConstraintAxisLimitMode,
): void
Sets the limit mode for the given axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis to set the limit mode for.
- limitMode: PhysicsConstraintAxisLimitMode
  The limit mode to set.
  
  This method is useful for setting the limit mode for a given axis of the constraint. This is important for controlling the behavior of the physics engine when the constraint is reached. By setting the limit mode, the engine can be configured to either stop the motion of the objects, or to allow them to continue moving beyond the constraint.
Returns void
Inherited from Physics6DoFConstraint.setAxisMode
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:215

setAxisMotorMaxForce

setAxisMotorMaxForce(axis: PhysicsConstraintAxis, maxForce: number): void
Sets the maximum force of the motor of the given axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
- maxForce: number
  The maximum force of the motor.
Returns void
Inherited from Physics6DoFConstraint.setAxisMotorMaxForce
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:320

setAxisMotorTarget

setAxisMotorTarget(axis: PhysicsConstraintAxis, target: number): void
Sets the target velocity of the motor associated with the given axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
- target: number
  The target velocity of the motor.
  
  This method is useful for setting the target velocity of the motor associated with the given axis of the constraint.
Returns void
Inherited from Physics6DoFConstraint.setAxisMotorTarget
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:300

setAxisMotorType

setAxisMotorType(
axis: PhysicsConstraintAxis,
motorType: PhysicsConstraintMotorType,
): void
Sets the motor type of the given axis of the constraint.
Parameters
- axis: PhysicsConstraintAxis
  The axis of the constraint.
- motorType: PhysicsConstraintMotorType
  The type of motor to use.
Returns void
Inherited from Physics6DoFConstraint.setAxisMotorType
- Defined in packages/dev/core/src/Physics/v2/physicsConstraint.ts:278

Class SpringConstraint

Param: pivotA

Param: pivotB

Param: axisA

Param: axisB

Param: minDistance

Param: maxDistance

Param: stiffness

Param: damping

Param: scene

Returns

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SpringConstraint

Properties

_pluginData

limits

Accessors

isCollisionsEnabled

Returns boolean

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

options

Returns PhysicsConstraintParameters

type

Returns PhysicsConstraintType

Methods

dispose

Returns void

getAxisFriction

Parameters

Returns Nullable<number>

getAxisMaxLimit

Parameters

Returns Nullable<number>

getAxisMinLimit

Parameters

Returns Nullable<number>

getAxisMode

Parameters

Returns Nullable<PhysicsConstraintAxisLimitMode>

getAxisMotorMaxForce

Parameters

Returns Nullable<number>

getAxisMotorTarget

Parameters

Returns Nullable<number>

getAxisMotorType

Parameters

Returns Nullable<PhysicsConstraintMotorType>

getBodiesUsingConstraint

Returns ConstrainedBodyPair[]

setAxisFriction

Parameters

Returns void

setAxisMaxLimit

Parameters

Returns void

setAxisMinLimit

Parameters

Returns void

setAxisMode

Parameters

Returns void

setAxisMotorMaxForce

Parameters

Returns void

setAxisMotorTarget

Parameters