Babylon.js API documentation|

PhysicsConstraint

Class PhysicsConstraint

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

see: https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine

Hierarchy

PhysicsConstraint

Constructors

constructor

new PhysicsConstraint(type: ConstraintType, options: PhysicsConstraintParameters, scene: Scene): PhysicsConstraint

- Defined in .temp/docdirectory/doc.d.ts:83665
Constructs a new constraint for the physics constraint.

Parameters
- type: ConstraintType
  
  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

_pluginData Search playground for _pluginData

_pluginData: any

V2 Physics plugin private data for a physics material

Methods

dispose Search playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:83798
Returns void

getAxisFriction Search playground for getAxisFriction

getAxisFriction(axis: ConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:83743
Parameters
- axis: ConstraintAxis
Returns number

getAxisMaxLimit Search playground for getAxisMaxLimit

getAxisMaxLimit(axis: ConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:83770
Parameters
- axis: ConstraintAxis
Returns number

getAxisMinLimit Search playground for getAxisMinLimit

getAxisMinLimit(axis: ConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:83762
Parameters
- axis: ConstraintAxis
Returns number

getAxisMode Search playground for getAxisMode

getAxisMode(axis: ConstraintAxis): ConstraintAxisLimitMode

- Defined in .temp/docdirectory/doc.d.ts:83754
Parameters
- axis: ConstraintAxis
Returns ConstraintAxisLimitMode

getAxisMotorMaxForce Search playground for getAxisMotorMaxForce

getAxisMotorMaxForce(axis: ConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:83794
Parameters
- axis: ConstraintAxis
Returns number

getAxisMotorTarget Search playground for getAxisMotorTarget

getAxisMotorTarget(axis: ConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:83786
Parameters
- axis: ConstraintAxis
Returns number

getAxisMotorType Search playground for getAxisMotorType

getAxisMotorType(axis: ConstraintAxis): ConstraintMotorType

- Defined in .temp/docdirectory/doc.d.ts:83778
Parameters
- axis: ConstraintAxis
Returns ConstraintMotorType

getChildBody Search playground for getChildBody

getChildBody(): undefined | PhysicsBody

- Defined in .temp/docdirectory/doc.d.ts:83697
Retrieves the child body of the current physics constraint.

Returns undefined | PhysicsBody
The child body of the current physics constraint, or undefined if no child body is present.

getCollisionsEnabled Search playground for getCollisionsEnabled

getCollisionsEnabled(): boolean

- Defined in .temp/docdirectory/doc.d.ts:83731
Returns boolean

getEnabled Search playground for getEnabled

getEnabled(): boolean

- Defined in .temp/docdirectory/doc.d.ts:83721
Returns boolean

getParentBody Search playground for getParentBody

getParentBody(): undefined | PhysicsBody

- Defined in .temp/docdirectory/doc.d.ts:83681
Retrieves the parent body of the current physics constraint.

Returns undefined | PhysicsBody
The parent body of the current physics constraint, or undefined if the current constraint does not have a parent body.

setAnchorInChild Search playground for setAnchorInChild

setAnchorInChild(pivot: Vector3, axisX: Vector3, axisY: Vector3): void

- Defined in .temp/docdirectory/doc.d.ts:83711
Parameters
- pivot: Vector3
- axisX: Vector3
- axisY: Vector3
Returns void

setAnchorInParent Search playground for setAnchorInParent

setAnchorInParent(pivot: Vector3, axisX: Vector3, axisY: Vector3): void

- Defined in .temp/docdirectory/doc.d.ts:83704
Parameters
- pivot: Vector3
- axisX: Vector3
- axisY: Vector3
Returns void

setAxisFriction Search playground for setAxisFriction

setAxisFriction(axis: ConstraintAxis, friction: number): void

- Defined in .temp/docdirectory/doc.d.ts:83737
Parameters
- axis: ConstraintAxis
- friction: number
Returns void

setAxisMaxLimit Search playground for setAxisMaxLimit

setAxisMaxLimit(axis: ConstraintAxis, limit: number): void

- Defined in .temp/docdirectory/doc.d.ts:83766
Parameters
- axis: ConstraintAxis
- limit: number
Returns void

setAxisMinLimit Search playground for setAxisMinLimit

setAxisMinLimit(axis: ConstraintAxis, minLimit: number): void

- Defined in .temp/docdirectory/doc.d.ts:83758
Parameters
- axis: ConstraintAxis
- minLimit: number
Returns void

setAxisMode Search playground for setAxisMode

setAxisMode(axis: ConstraintAxis, limitMode: ConstraintAxisLimitMode): void

- Defined in .temp/docdirectory/doc.d.ts:83749
Parameters
- axis: ConstraintAxis
- limitMode: ConstraintAxisLimitMode
Returns void

setAxisMotorMaxForce Search playground for setAxisMotorMaxForce

setAxisMotorMaxForce(axis: ConstraintAxis, maxForce: number): void

- Defined in .temp/docdirectory/doc.d.ts:83790
Parameters
- axis: ConstraintAxis
- maxForce: number
Returns void

setAxisMotorTarget Search playground for setAxisMotorTarget

setAxisMotorTarget(axis: ConstraintAxis, target: number): void

- Defined in .temp/docdirectory/doc.d.ts:83782
Parameters
- axis: ConstraintAxis
- target: number
Returns void

setAxisMotorType Search playground for setAxisMotorType

setAxisMotorType(axis: ConstraintAxis, motorType: ConstraintMotorType): void

- Defined in .temp/docdirectory/doc.d.ts:83774
Parameters
- axis: ConstraintAxis
- motorType: ConstraintMotorType
Returns void

setChildBody Search playground for setChildBody

setChildBody(body: PhysicsBody): void

- Defined in .temp/docdirectory/doc.d.ts:83690
Sets the child body of the current body.

Parameters
- body: PhysicsBody
  
  The child body to set.
  
  This method is useful for setting the child body of the current body in a physics engine. This allows for the creation of complex structures of bodies that interact with each other in a realistic way.
Returns void

setCollisionsEnabled Search playground for setCollisionsEnabled

setCollisionsEnabled(isEnabled: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:83726
Parameters
- isEnabled: boolean
Returns void

setEnabled Search playground for setEnabled

setEnabled(isEnabled: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:83716
Parameters
- isEnabled: boolean
Returns void

setParentBody Search playground for setParentBody

setParentBody(body: PhysicsBody): void

- Defined in .temp/docdirectory/doc.d.ts:83674
Sets the parent body of this body.

Parameters
- body: PhysicsBody
  
  The parent body to set.
  
  This method is useful for setting the parent body of a physics body in a physics engine. This allows the engine to accurately simulate the motion of the body in relation to its parent body. For example, if the parent body is a planet, the engine can accurately simulate the motion of the body in relation to the planet's gravity.
Returns void