Class BallAndSocketConstraint
Hierarchy (View Summary)
- PhysicsConstraint
- BallAndSocketConstraint
Properties
_
_pluginData: any = undefined
V2 Physics plugin private data for a physics material
Accessors
is
-
get isCollisionsEnabled(): boolean
Gets whether collisions are enabled for this physics object.
Returns boolean
trueif collisions are enabled,falseotherwise. -
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
- isEnabled: boolean
is
-
get isEnabled(): boolean
Returns boolean
true if constraint is enabled
-
set isEnabled(isEnabled: boolean): void
Enable/disable the constraint
Parameters
- isEnabled: boolean
value for the constraint
Returns void
- isEnabled: boolean
options
-
Retrieves the options of the physics constraint.
Returns PhysicsConstraintParameters
The physics constraint parameters.
type
Methods
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
-
Gets all bodies that are using this constraint
Returns ConstrainedBodyPair[]
Represents a Ball and Socket Constraint, used to simulate a joint This class is useful for simulating a joint between two bodies in a physics engine. It allows for the two bodies to move relative to each other in a way that mimics a ball and socket joint, such as a shoulder or hip joint.
Param: pivotA
The first pivot, defined locally in the first body frame
Param: pivotB
The second pivot, defined locally in the second body frame
Param: axisA
The axis of the first body
Param: axisB
The axis of the second body
Param: scene
The scene the constraint is applied to
Returns
The Ball and Socket Constraint