BallAndSocketConstraint | Babylon.js API documentation

Class BallAndSocketConstraint

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

Hierarchy (View Summary)

PhysicsConstraint
- BallAndSocketConstraint

Index

Constructors

constructor

new BallAndSocketConstraint(
    pivotA: Vector3,
    pivotB: Vector3,
    axisA: Vector3,
    axisB: Vector3,
    scene: Scene,
): BallAndSocketConstraint
Parameters
- pivotA: Vector3
- pivotB: Vector3
- axisA: Vector3
- axisB: Vector3
- scene: Scene
Returns BallAndSocketConstraint
Overrides PhysicsConstraint.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27645

Properties

_pluginData

_pluginData: any

V2 Physics plugin private data for a physics material

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 PhysicsConstraint.isCollisionsEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27473
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 PhysicsConstraint.isCollisionsEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27466

isEnabled

get isEnabled(): boolean
Returns boolean
true if constraint is enabled
Inherited from PhysicsConstraint.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27459
set isEnabled(isEnabled: boolean): void
Enable/disable the constraint
Parameters
- isEnabled: boolean
  value for the constraint
Returns void
Inherited from PhysicsConstraint.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27454

options

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

Returns PhysicsConstraintParameters
The physics constraint parameters.
Inherited from PhysicsConstraint.options
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27449

type

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

Returns PhysicsConstraintType
The type of the constraint.
Inherited from PhysicsConstraint.type
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27442

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 PhysicsConstraint.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27484

getBodiesUsingConstraint

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

Returns ConstrainedBodyPair[]
Inherited from PhysicsConstraint.getBodiesUsingConstraint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27478

Class BallAndSocketConstraint

Param: pivotA

Param: pivotB

Param: axisA

Param: axisB

Param: scene

Returns

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BallAndSocketConstraint

Properties

_pluginData

Accessors

isCollisionsEnabled

Returns boolean

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

options

Returns PhysicsConstraintParameters

type

Returns PhysicsConstraintType

Methods

dispose

Returns void

getBodiesUsingConstraint

Returns ConstrainedBodyPair[]

Settings

On This Page