Class Physics6DoFConstraint

A generic constraint, which can be used to build more complex constraints than those specified in PhysicsConstraintType. The axis and pivot options in PhysicsConstraintParameters define the space the constraint operates in. This constraint contains a set of limits, which restrict the relative movement of the bodies in that coordinate system

Hierarchy

PhysicsConstraint
- Physics6DoFConstraint

Constructors

constructor

new Physics6DoFConstraint(constraintParams: PhysicsConstraintParameters, limits: Physics6DoFLimit[], scene: Scene): Physics6DoFConstraint

Overrides PhysicsConstraint.constructor
- Defined in .temp/docdirectory/doc.d.ts:84990
Constructs a new constraint for the physics constraint.

Parameters
- constraintParams: PhysicsConstraintParameters
- limits: Physics6DoFLimit[]
- scene: Scene
Returns Physics6DoFConstraint

Properties

_pluginData Search playground for _pluginData

_pluginData: any

V2 Physics plugin private data for a physics material

limits Search playground for limits

limits: Physics6DoFLimit[]

The collection of limits which this constraint will apply

Accessors

isCollisionsEnabled

get isCollisionsEnabled(): boolean
set isCollisionsEnabled(isEnabled: boolean): void

Inherited from PhysicsConstraint.isCollisionsEnabled
- Defined in .temp/docdirectory/doc.d.ts:84952
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/docdirectory/doc.d.ts:84945
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

get isEnabled(): boolean
set isEnabled(isEnabled: boolean): void

Inherited from PhysicsConstraint.isEnabled
- Defined in .temp/docdirectory/doc.d.ts:84938
Enable/disable the constraint

Returns boolean
true if constraint is enabled
Inherited from PhysicsConstraint.isEnabled
- Defined in .temp/docdirectory/doc.d.ts:84933
Enable/disable the constraint

Parameters
- isEnabled: boolean
  
  value for the constraint
Returns void

options

get options(): PhysicsConstraintParameters

Inherited from PhysicsConstraint.options
- Defined in .temp/docdirectory/doc.d.ts:84928
Retrieves the options of the physics constraint.

Returns PhysicsConstraintParameters
The physics constraint parameters.

type

get type(): PhysicsConstraintType

Inherited from PhysicsConstraint.type
- Defined in .temp/docdirectory/doc.d.ts:84921
Gets the type of the constraint.

Returns PhysicsConstraintType
The type of the constraint.

Methods

dispose Search playground for dispose

dispose(): void

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

getAxisFriction Search playground for getAxisFriction

getAxisFriction(axis: PhysicsConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:85004
Gets the friction of the given axis of the physics engine.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the physics engine.
Returns number
The friction of the given axis.

getAxisMaxLimit Search playground for getAxisMaxLimit

getAxisMaxLimit(axis: PhysicsConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:85054
Gets the maximum limit of the given axis of the physics engine.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the physics engine.
Returns number
The maximum limit of the given axis.

getAxisMinLimit Search playground for getAxisMinLimit

getAxisMinLimit(axis: PhysicsConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:85037
Gets the minimum limit of the given axis of the physics engine.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the physics engine.
Returns number
The minimum limit of the given axis.

getAxisMode Search playground for getAxisMode

getAxisMode(axis: PhysicsConstraintAxis): PhysicsConstraintAxisLimitMode

- Defined in .temp/docdirectory/doc.d.ts:85023
Gets the limit mode of the given axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
Returns PhysicsConstraintAxisLimitMode
The limit mode of the given axis.

getAxisMotorMaxForce Search playground for getAxisMotorMaxForce

getAxisMotorMaxForce(axis: PhysicsConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:85099
Gets the maximum force of the motor of the given axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
Returns number
The maximum force of the motor.

getAxisMotorTarget Search playground for getAxisMotorTarget

getAxisMotorTarget(axis: PhysicsConstraintAxis): number

- Defined in .temp/docdirectory/doc.d.ts:85085
Gets the target velocity of the motor associated to the given constraint axis.

Parameters
- axis: PhysicsConstraintAxis
  
  The constraint axis associated to the motor.
Returns number
The target velocity of the motor.

getAxisMotorType Search playground for getAxisMotorType

getAxisMotorType(axis: PhysicsConstraintAxis): PhysicsConstraintMotorType

- Defined in .temp/docdirectory/doc.d.ts:85070
Gets the motor type of the specified axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
Returns PhysicsConstraintMotorType
The motor type of the specified axis.

setAxisFriction Search playground for setAxisFriction

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

- Defined in .temp/docdirectory/doc.d.ts:84997
Sets the friction of the given axis of the physics engine.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the physics engine to set the friction for.
- friction: number
  
  The friction to set for the given axis.
Returns void

setAxisMaxLimit Search playground for setAxisMaxLimit

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

- Defined in .temp/docdirectory/doc.d.ts:85047
Sets the maximum limit of the given axis for the physics engine.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis to set the limit for.
- limit: number
  
  The maximum limit of the axis.
  
  This method is useful for setting the maximum limit of the given axis for the physics engine, which can be used to control the movement of the physics object. This helps to ensure that the physics object does not move beyond the given limit.
Returns void

setAxisMinLimit Search playground for setAxisMinLimit

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

- Defined in .temp/docdirectory/doc.d.ts:85030
Sets the minimum limit of a given axis of a constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
- minLimit: number
  
  The minimum limit of the axis.
Returns void

setAxisMode Search playground for setAxisMode

setAxisMode(axis: PhysicsConstraintAxis, limitMode: PhysicsConstraintAxisLimitMode): void

- Defined in .temp/docdirectory/doc.d.ts:85015
Sets the limit mode for the given axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis to set the limit mode for.
- limitMode: PhysicsConstraintAxisLimitMode
  
  The limit mode to set.
  
  This method is useful for setting the limit mode for a given axis of the constraint. This is important for controlling the behavior of the physics engine when the constraint is reached. By setting the limit mode, the engine can be configured to either stop the motion of the objects, or to allow them to continue moving beyond the constraint.
Returns void

setAxisMotorMaxForce Search playground for setAxisMotorMaxForce

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

- Defined in .temp/docdirectory/doc.d.ts:85092
Sets the maximum force of the motor of the given axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
- maxForce: number
  
  The maximum force of the motor.
Returns void

setAxisMotorTarget Search playground for setAxisMotorTarget

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

- Defined in .temp/docdirectory/doc.d.ts:85078
Sets the target velocity of the motor associated with the given axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
- target: number
  
  The target velocity of the motor.
  
  This method is useful for setting the target velocity of the motor associated with the given axis of the constraint.
Returns void

setAxisMotorType Search playground for setAxisMotorType

setAxisMotorType(axis: PhysicsConstraintAxis, motorType: PhysicsConstraintMotorType): void

- Defined in .temp/docdirectory/doc.d.ts:85062
Sets the motor type of the given axis of the constraint.

Parameters
- axis: PhysicsConstraintAxis
  
  The axis of the constraint.
- motorType: PhysicsConstraintMotorType
  
  The type of motor to use.
Returns void
void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

constraintParams: PhysicsConstraintParameters

limits: Physics6DoFLimit[]

scene: Scene

Returns Physics6DoFConstraint

Properties

_pluginDataSearch playground for _pluginData

limitsSearch playground for limits

Accessors

isCollisionsEnabled

Returns boolean

Parameters

isEnabled: boolean

Returns void

isEnabled

Returns boolean

Parameters

isEnabled: boolean

Returns void

options

Returns PhysicsConstraintParameters

type

Returns PhysicsConstraintType

Methods

disposeSearch playground for dispose

Returns void

getAxisFrictionSearch playground for getAxisFriction

Parameters

axis: PhysicsConstraintAxis

Returns number

getAxisMaxLimitSearch playground for getAxisMaxLimit

Parameters

axis: PhysicsConstraintAxis

Returns number

getAxisMinLimitSearch playground for getAxisMinLimit

Parameters

axis: PhysicsConstraintAxis

Returns number

getAxisModeSearch playground for getAxisMode

Parameters

axis: PhysicsConstraintAxis

Returns PhysicsConstraintAxisLimitMode

getAxisMotorMaxForceSearch playground for getAxisMotorMaxForce

Parameters

axis: PhysicsConstraintAxis

Returns number

getAxisMotorTargetSearch playground for getAxisMotorTarget

Parameters

axis: PhysicsConstraintAxis

Returns number

getAxisMotorTypeSearch playground for getAxisMotorType

Parameters

axis: PhysicsConstraintAxis

Returns PhysicsConstraintMotorType

setAxisFrictionSearch playground for setAxisFriction

Parameters

axis: PhysicsConstraintAxis

friction: number

Returns void

setAxisMaxLimitSearch playground for setAxisMaxLimit

Parameters

axis: PhysicsConstraintAxis

limit: number

Returns void

setAxisMinLimitSearch playground for setAxisMinLimit

Parameters

axis: PhysicsConstraintAxis

minLimit: number

Returns void

setAxisModeSearch playground for setAxisMode

Parameters

axis: PhysicsConstraintAxis

_pluginData Search playground for _pluginData

limits Search playground for limits

dispose Search playground for dispose

getAxisFriction Search playground for getAxisFriction

getAxisMaxLimit Search playground for getAxisMaxLimit

getAxisMinLimit Search playground for getAxisMinLimit

getAxisMode Search playground for getAxisMode

getAxisMotorMaxForce Search playground for getAxisMotorMaxForce

getAxisMotorTarget Search playground for getAxisMotorTarget

getAxisMotorType Search playground for getAxisMotorType

setAxisFriction Search playground for setAxisFriction

setAxisMaxLimit Search playground for setAxisMaxLimit

setAxisMinLimit Search playground for setAxisMinLimit

setAxisMode Search playground for setAxisMode

setAxisMotorMaxForce Search playground for setAxisMotorMaxForce

setAxisMotorTarget Search playground for setAxisMotorTarget

setAxisMotorType Search playground for setAxisMotorType