LockConstraint | Babylon.js API documentation

Class LockConstraint

Creates a LockConstraint, which is a type of PhysicsConstraint.

This code is useful for creating a LockConstraint, which is a type of PhysicsConstraint. It takes in two pivots and two axes in local space, as well as the scene the constraint belongs to, and creates a LockConstraint.

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: scene

The scene the constraint belongs to.

Returns

The created LockConstraint.

Hierarchy (View Summary)

PhysicsConstraint
- LockConstraint

Index

Constructors

constructor

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

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:27371
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:27364

isEnabled

get isEnabled(): boolean
Returns boolean
true if constraint is enabled
Inherited from PhysicsConstraint.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27357
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:27352

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:27347

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:27340

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:27382

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:27376

Class LockConstraint

Param: pivotA

Param: pivotB

Param: axisA

Param: axisB

Param: scene

Returns

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LockConstraint

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