Class PhysicsConstraint
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new constraint for the physics constraint.
Parameters
type: PhysicsConstraintType
The type of constraint to create.
options: PhysicsConstraintParameters
The options for the constraint.
scene: Scene
The scene the constraint belongs to.
This code is useful for creating a new constraint for the physics engine. It checks if the scene has a physics engine, and if the plugin version is correct. If all checks pass, it initializes the constraint with the given type and options.
Returns PhysicsConstraint
Properties
_plugin
V2 Physics plugin private data for a physics material
Accessors
is
Gets whether collisions are enabled for this physics object.
Returns boolean
trueif collisions are enabled,falseotherwise.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
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
Gets all bodies that are using this constraint
Returns ConstrainedBodyPair[]
This is a holder class for the physics constraint created by the physics plugin It holds a set of functions to control the underlying constraint
https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine