Class SpringConstraint
Hierarchy
- Physics6DoFConstraint
- SpringConstraint
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Properties
_plugin DataSearch playground for _pluginData
V2 Physics plugin private data for a physics material
limitsSearch playground for limits
The collection of limits which this constraint will apply
Accessors
is Collisions Enabled
Gets whether collisions are enabled for this physics object.
Returns boolean
true
if collisions are enabled,false
otherwise.Enables or disables collisions for the physics engine.
Parameters
isEnabled: boolean
A boolean value indicating whether collisions should be enabled or disabled.
Returns void
is Enabled
Enable/disable the constraint
Returns boolean
true if constraint is enabled
Enable/disable the constraint
Parameters
isEnabled: boolean
value for the constraint
Returns void
options
Retrieves the options of the physics constraint.
Returns PhysicsConstraintParameters
The physics constraint parameters.
type
Gets the type of the constraint.
Returns PhysicsConstraintType
The type of the constraint.
Methods
disposeSearch playground for dispose
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
get Axis FrictionSearch playground for getAxisFriction
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.
get Axis Max LimitSearch playground for getAxisMaxLimit
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.
get Axis Min LimitSearch playground for getAxisMinLimit
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.
get Axis ModeSearch playground for getAxisMode
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.
get Axis Motor Max ForceSearch playground for getAxisMotorMaxForce
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.
get Axis Motor TargetSearch playground for getAxisMotorTarget
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.
get Axis Motor TypeSearch playground for getAxisMotorType
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.
get Bodies Using ConstraintSearch playground for getBodiesUsingConstraint
Gets all bodies that are using this constraint
Returns ConstrainedBodyPair[]
set Axis FrictionSearch playground for setAxisFriction
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
set Axis Max LimitSearch playground for setAxisMaxLimit
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
set Axis Min LimitSearch playground for setAxisMinLimit
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
set Axis ModeSearch playground for setAxisMode
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
set Axis Motor Max ForceSearch playground for setAxisMotorMaxForce
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
set Axis Motor TargetSearch playground for setAxisMotorTarget
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
set Axis Motor TypeSearch playground for setAxisMotorType
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
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)
The first pivot of the constraint in local space.
The second pivot of the constraint in local space.
The first axis of the constraint in local space.
The second axis of the constraint in local space.
The minimum distance between the two pivots.
The maximum distance between the two pivots.
The stiffness of the spring.
The damping of the spring.
The scene the constraint belongs to.
The created SpringConstraint.