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

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

Overrides Physics6DoFConstraint.constructor
- Defined in .temp/docdirectory/doc.d.ts:93321
Constructs a new constraint for the physics constraint.

Parameters
- pivotA: Vector3
- pivotB: Vector3
- axisA: Vector3
- axisB: Vector3
- minDistance: number
- maxDistance: number
- stiffness: number
- damping: number
- scene: Scene
Returns SpringConstraint

Properties

_pluginData Search playground for _pluginData

_pluginData: any

V2 Physics plugin private data for a physics material

limits Search playground for limits

limits: Physics6DoFLimit[]

The collection of limits which this constraint will apply

Accessors

isCollisionsEnabled

get isCollisionsEnabled(): boolean
set isCollisionsEnabled(isEnabled: boolean): void

Inherited from Physics6DoFConstraint.isCollisionsEnabled
- Defined in .temp/docdirectory/doc.d.ts:93051
Gets whether collisions are enabled for this physics object.

Returns boolean
true if collisions are enabled, false otherwise.
Inherited from Physics6DoFConstraint.isCollisionsEnabled
- Defined in .temp/docdirectory/doc.d.ts:93044
Enables or disables collisions for the physics engine.

Parameters
- isEnabled: boolean
  
  A boolean value indicating whether collisions should be enabled or disabled.
Returns void

isEnabled

get isEnabled(): boolean
set isEnabled(isEnabled: boolean): void

Inherited from Physics6DoFConstraint.isEnabled
- Defined in .temp/docdirectory/doc.d.ts:93037
Enable/disable the constraint

Returns boolean
true if constraint is enabled
Inherited from Physics6DoFConstraint.isEnabled
- Defined in .temp/docdirectory/doc.d.ts:93032
Enable/disable the constraint

Parameters
- isEnabled: boolean
  
  value for the constraint
Returns void

options

get options(): PhysicsConstraintParameters

Inherited from Physics6DoFConstraint.options
- Defined in .temp/docdirectory/doc.d.ts:93027
Retrieves the options of the physics constraint.

Returns PhysicsConstraintParameters
The physics constraint parameters.

type

get type(): PhysicsConstraintType

Inherited from Physics6DoFConstraint.type
- Defined in .temp/docdirectory/doc.d.ts:93020
Gets the type of the constraint.

Returns PhysicsConstraintType
The type of the constraint.

Methods

dispose Search playground for dispose

dispose(): void

Inherited from Physics6DoFConstraint.dispose
- Defined in .temp/docdirectory/doc.d.ts:93062
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

getAxisFriction Search playground for getAxisFriction

getAxisFriction(axis: PhysicsConstraintAxis): Nullable<number>

Inherited from Physics6DoFConstraint.getAxisFriction
- Defined in .temp/docdirectory/doc.d.ts:93116
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.

getAxisMaxLimit Search playground for getAxisMaxLimit

getAxisMaxLimit(axis: PhysicsConstraintAxis): Nullable<number>

Inherited from Physics6DoFConstraint.getAxisMaxLimit
- Defined in .temp/docdirectory/doc.d.ts:93166
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.

getAxisMinLimit Search playground for getAxisMinLimit

getAxisMinLimit(axis: PhysicsConstraintAxis): Nullable<number>

Inherited from Physics6DoFConstraint.getAxisMinLimit
- Defined in .temp/docdirectory/doc.d.ts:93149
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.

getAxisMode Search playground for getAxisMode

getAxisMode(axis: PhysicsConstraintAxis): Nullable<PhysicsConstraintAxisLimitMode>

Inherited from Physics6DoFConstraint.getAxisMode
- Defined in .temp/docdirectory/doc.d.ts:93135
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.

getAxisMotorMaxForce Search playground for getAxisMotorMaxForce

getAxisMotorMaxForce(axis: PhysicsConstraintAxis): Nullable<number>

Inherited from Physics6DoFConstraint.getAxisMotorMaxForce
- Defined in .temp/docdirectory/doc.d.ts:93211
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.

getAxisMotorTarget Search playground for getAxisMotorTarget

getAxisMotorTarget(axis: PhysicsConstraintAxis): Nullable<number>

Inherited from Physics6DoFConstraint.getAxisMotorTarget
- Defined in .temp/docdirectory/doc.d.ts:93197
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.

getAxisMotorType Search playground for getAxisMotorType

getAxisMotorType(axis: PhysicsConstraintAxis): Nullable<PhysicsConstraintMotorType>

Inherited from Physics6DoFConstraint.getAxisMotorType
- Defined in .temp/docdirectory/doc.d.ts:93182
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.

getBodiesUsingConstraint Search playground for getBodiesUsingConstraint

getBodiesUsingConstraint(): ConstrainedBodyPair[]

Inherited from Physics6DoFConstraint.getBodiesUsingConstraint
- Defined in .temp/docdirectory/doc.d.ts:93056
Gets all bodies that are using this constraint

Returns ConstrainedBodyPair[]

setAxisFriction Search playground for setAxisFriction

setAxisFriction(axis: PhysicsConstraintAxis, friction: number): void

Inherited from Physics6DoFConstraint.setAxisFriction
- Defined in .temp/docdirectory/doc.d.ts:93109
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

setAxisMaxLimit Search playground for setAxisMaxLimit

setAxisMaxLimit(axis: PhysicsConstraintAxis, limit: number): void

Inherited from Physics6DoFConstraint.setAxisMaxLimit
- Defined in .temp/docdirectory/doc.d.ts:93159
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

setAxisMinLimit Search playground for setAxisMinLimit

setAxisMinLimit(axis: PhysicsConstraintAxis, minLimit: number): void

Inherited from Physics6DoFConstraint.setAxisMinLimit
- Defined in .temp/docdirectory/doc.d.ts:93142
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

setAxisMode Search playground for setAxisMode

setAxisMode(axis: PhysicsConstraintAxis, limitMode: PhysicsConstraintAxisLimitMode): void

Inherited from Physics6DoFConstraint.setAxisMode
- Defined in .temp/docdirectory/doc.d.ts:93127
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

setAxisMotorMaxForce Search playground for setAxisMotorMaxForce

setAxisMotorMaxForce(axis: PhysicsConstraintAxis, maxForce: number): void

Inherited from Physics6DoFConstraint.setAxisMotorMaxForce
- Defined in .temp/docdirectory/doc.d.ts:93204
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

setAxisMotorTarget Search playground for setAxisMotorTarget

setAxisMotorTarget(axis: PhysicsConstraintAxis, target: number): void

Inherited from Physics6DoFConstraint.setAxisMotorTarget
- Defined in .temp/docdirectory/doc.d.ts:93190
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

setAxisMotorType Search playground for setAxisMotorType

setAxisMotorType(axis: PhysicsConstraintAxis, motorType: PhysicsConstraintMotorType): void

Inherited from Physics6DoFConstraint.setAxisMotorType
- Defined in .temp/docdirectory/doc.d.ts:93174
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
void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

pivotA: Vector3

pivotB: Vector3

axisA: Vector3

axisB: Vector3

minDistance: number

maxDistance: number

stiffness: number

damping: number

scene: Scene

Returns SpringConstraint

Properties

_pluginDataSearch playground for _pluginData

limitsSearch playground for limits

Accessors

isCollisionsEnabled

Returns boolean

Parameters

isEnabled: boolean

Returns void

isEnabled

Returns boolean

Parameters

isEnabled: boolean

Returns void

options

Returns PhysicsConstraintParameters

type

Returns PhysicsConstraintType

Methods

disposeSearch playground for dispose

Returns void

getAxisFrictionSearch playground for getAxisFriction

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<number>

getAxisMaxLimitSearch playground for getAxisMaxLimit

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<number>

getAxisMinLimitSearch playground for getAxisMinLimit

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<number>

getAxisModeSearch playground for getAxisMode

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<PhysicsConstraintAxisLimitMode>

getAxisMotorMaxForceSearch playground for getAxisMotorMaxForce

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<number>

getAxisMotorTargetSearch playground for getAxisMotorTarget

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<number>

getAxisMotorTypeSearch playground for getAxisMotorType

Parameters

axis: PhysicsConstraintAxis

Returns Nullable<PhysicsConstraintMotorType>

getBodiesUsingConstraintSearch playground for getBodiesUsingConstraint

Returns ConstrainedBodyPair[]

setAxisFrictionSearch playground for setAxisFriction

Parameters

axis: PhysicsConstraintAxis

friction: number

Returns void

setAxisMaxLimitSearch playground for setAxisMaxLimit

Parameters

axis: PhysicsConstraintAxis

limit: number

Returns void

_pluginData Search playground for _pluginData

limits Search playground for limits

dispose Search playground for dispose

getAxisFriction Search playground for getAxisFriction

getAxisMaxLimit Search playground for getAxisMaxLimit

getAxisMinLimit Search playground for getAxisMinLimit

getAxisMode Search playground for getAxisMode

getAxisMotorMaxForce Search playground for getAxisMotorMaxForce

getAxisMotorTarget Search playground for getAxisMotorTarget

getAxisMotorType Search playground for getAxisMotorType

getBodiesUsingConstraint Search playground for getBodiesUsingConstraint

setAxisFriction Search playground for setAxisFriction

setAxisMaxLimit Search playground for setAxisMaxLimit

setAxisMinLimit Search playground for setAxisMinLimit

setAxisMode Search playground for setAxisMode

setAxisMotorMaxForce Search playground for setAxisMotorMaxForce

setAxisMotorTarget Search playground for setAxisMotorTarget

setAxisMotorType Search playground for setAxisMotorType