Class PhysicsEngine

Class used to control physics engine

see: https://doc.babylonjs.com/how_to/using_the_physics_engine

Hierarchy

PhysicsEngine

Implements

IPhysicsEngine

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PhysicsEngine(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin): PhysicsEngine

- Defined in .temp/docdirectory/doc.d.ts:78095
Creates a new Physics Engine

Parameters
- gravity: Nullable<Vector3>
  
  defines the gravity vector used by the simulation
- Optional _physicsPlugin: IPhysicsEnginePlugin
  
  defines the plugin to use (CannonJS by default)
Returns PhysicsEngine

Properties

gravitySearch playground for gravity

gravity: Vector3

Gets the gravity vector used by the simulation

Static EpsilonSearch playground for Epsilon

Epsilon: number

Global value used to control the smallest number supported by the simulation

Methods

_stepSearch playground for _step

_step(delta: number): void

Implementation of IPhysicsEngine._step
- Defined in .temp/docdirectory/doc.d.ts:78171
Called by the scene. No need to call it.

Parameters
- delta: number
  
  defines the timespan between frames
Returns void

addImpostorSearch playground for addImpostor

addImpostor(impostor: PhysicsImpostor): void

Implementation of IPhysicsEngine.addImpostor
- Defined in .temp/docdirectory/doc.d.ts:78146
Adding a new impostor for the impostor tracking. This will be done by the impostor itself.

Parameters
- impostor: PhysicsImpostor
  
  the impostor to add
Returns void

addJointSearch playground for addJoint

addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void

Implementation of IPhysicsEngine.addJoint
- Defined in .temp/docdirectory/doc.d.ts:78159
Add a joint to the physics engine

Parameters
- mainImpostor: PhysicsImpostor
  
  defines the main impostor to which the joint is added.
- connectedImpostor: PhysicsImpostor
  
  defines the impostor that is connected to the main impostor using this joint
- joint: PhysicsJoint
  
  defines the joint that will connect both impostors.
Returns void

disposeSearch playground for dispose

dispose(): void

Implementation of IPhysicsEngine.dispose
- Defined in .temp/docdirectory/doc.d.ts:78135
Release all resources

Returns void

getImpostorForPhysicsObjectSearch playground for getImpostorForPhysicsObject

getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>

Implementation of IPhysicsEngine.getImpostorForPhysicsObject
- Defined in .temp/docdirectory/doc.d.ts:78187
Gets the impostor for a physics enabled object

Parameters
- object: IPhysicsEnabledObject
  
  defines the object impersonated by the impostor
Returns Nullable<PhysicsImpostor>

the PhysicsImpostor or null if not found

getImpostorWithPhysicsBodySearch playground for getImpostorWithPhysicsBody

getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>

Implementation of IPhysicsEngine.getImpostorWithPhysicsBody
- Defined in .temp/docdirectory/doc.d.ts:78193
Gets the impostor for a physics body object

Parameters
- body: any
  
  defines physics body used by the impostor
Returns Nullable<PhysicsImpostor>

the PhysicsImpostor or null if not found

getImpostorsSearch playground for getImpostors

getImpostors(): Array<PhysicsImpostor>

Implementation of IPhysicsEngine.getImpostors
- Defined in .temp/docdirectory/doc.d.ts:78181
Gets the list of physic impostors

Returns Array<PhysicsImpostor>

an array of PhysicsImpostor

getPhysicsPluginSearch playground for getPhysicsPlugin

getPhysicsPlugin(): IPhysicsEnginePlugin

Implementation of IPhysicsEngine.getPhysicsPlugin
- Defined in .temp/docdirectory/doc.d.ts:78176
Gets the current plugin used to run the simulation

Returns IPhysicsEnginePlugin

current plugin

getPhysicsPluginNameSearch playground for getPhysicsPluginName

getPhysicsPluginName(): string

Implementation of IPhysicsEngine.getPhysicsPluginName
- Defined in .temp/docdirectory/doc.d.ts:78140
Gets the name of the current physics plugin

Returns string

the name of the plugin

getSubTimeStepSearch playground for getSubTimeStep

getSubTimeStep(): number

Implementation of IPhysicsEngine.getSubTimeStep
- Defined in .temp/docdirectory/doc.d.ts:78131
Get the sub time step of the physics engine.

Returns number

the current sub time step

getTimeStepSearch playground for getTimeStep

getTimeStep(): number

Implementation of IPhysicsEngine.getTimeStep
- Defined in .temp/docdirectory/doc.d.ts:78119
Get the time step of the physics engine.

Returns number

the current time step

raycastSearch playground for raycast

raycast(from: Vector3, to: Vector3): PhysicsRaycastResult

Implementation of IPhysicsEngine.raycast
- Defined in .temp/docdirectory/doc.d.ts:78200
Does a raycast in the physics world

Parameters
- from: Vector3
  
  when should the ray start?
- to: Vector3
  
  when should the ray end?
Returns PhysicsRaycastResult

PhysicsRaycastResult

removeImpostorSearch playground for removeImpostor

removeImpostor(impostor: PhysicsImpostor): void

Implementation of IPhysicsEngine.removeImpostor
- Defined in .temp/docdirectory/doc.d.ts:78152
Remove an impostor from the engine. This impostor and its mesh will not longer be updated by the physics engine.

Parameters
- impostor: PhysicsImpostor
  
  the impostor to remove
Returns void

removeJointSearch playground for removeJoint

removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void

Implementation of IPhysicsEngine.removeJoint
- Defined in .temp/docdirectory/doc.d.ts:78166
Removes a joint from the simulation

Parameters
- mainImpostor: PhysicsImpostor
  
  defines the impostor used with the joint
- connectedImpostor: PhysicsImpostor
  
  defines the other impostor connected to the main one by the joint
- joint: PhysicsJoint
  
  defines the joint to remove
Returns void

setGravitySearch playground for setGravity

setGravity(gravity: Vector3): void

Implementation of IPhysicsEngine.setGravity
- Defined in .temp/docdirectory/doc.d.ts:78106
Sets the gravity vector used by the simulation

Parameters
- gravity: Vector3
  
  defines the gravity vector to use
Returns void

setSubTimeStepSearch playground for setSubTimeStep

setSubTimeStep(subTimeStep?: number): void

Implementation of IPhysicsEngine.setSubTimeStep
- Defined in .temp/docdirectory/doc.d.ts:78126
Set the sub time step of the physics engine. Default is 0 meaning there is no sub steps To increase physics resolution precision, set a small value (like 1 ms)

Parameters
- Optional subTimeStep: number
  
  defines the new sub timestep used for physics resolution.
Returns void

setTimeStepSearch playground for setTimeStep

setTimeStep(newTimeStep?: number): void

Implementation of IPhysicsEngine.setTimeStep
- Defined in .temp/docdirectory/doc.d.ts:78114
Set the time step of the physics engine. Default is 1/60. To slow it down, enter 1/600 for example. To speed it up, 1/30

Parameters
- Optional newTimeStep: number
  
  defines the new timestep to apply to this world.
Returns void

Static DefaultPluginFactorySearch playground for DefaultPluginFactory

DefaultPluginFactory(): IPhysicsEnginePlugin

- Defined in .temp/docdirectory/doc.d.ts:78095
Factory used to create the default physics plugin.

Returns IPhysicsEnginePlugin

The default physics plugin

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

gravity: Nullable<Vector3>

Optional _physicsPlugin: IPhysicsEnginePlugin

Returns PhysicsEngine

Properties

gravitySearch playground for gravity

Static EpsilonSearch playground for Epsilon

Methods

_stepSearch playground for _step

Parameters

delta: number

Returns void

addImpostorSearch playground for addImpostor

Parameters

impostor: PhysicsImpostor

Returns void

addJointSearch playground for addJoint

Parameters

mainImpostor: PhysicsImpostor

connectedImpostor: PhysicsImpostor

joint: PhysicsJoint

Returns void

disposeSearch playground for dispose

Returns void

getImpostorForPhysicsObjectSearch playground for getImpostorForPhysicsObject

Parameters

object: IPhysicsEnabledObject

Returns Nullable<PhysicsImpostor>

getImpostorWithPhysicsBodySearch playground for getImpostorWithPhysicsBody

Parameters

body: any

Returns Nullable<PhysicsImpostor>

getImpostorsSearch playground for getImpostors

Returns Array<PhysicsImpostor>

getPhysicsPluginSearch playground for getPhysicsPlugin

Returns IPhysicsEnginePlugin

getPhysicsPluginNameSearch playground for getPhysicsPluginName

Returns string

getSubTimeStepSearch playground for getSubTimeStep

Returns number

getTimeStepSearch playground for getTimeStep

Returns number

raycastSearch playground for raycast

Parameters

from: Vector3

to: Vector3

Returns PhysicsRaycastResult

removeImpostorSearch playground for removeImpostor

Parameters

impostor: PhysicsImpostor

Returns void

removeJointSearch playground for removeJoint

Parameters

mainImpostor: PhysicsImpostor

connectedImpostor: PhysicsImpostor

joint: PhysicsJoint

Returns void

setGravitySearch playground for setGravity

Parameters

gravity: Vector3

Returns void

setSubTimeStepSearch playground for setSubTimeStep

Parameters

Optional subTimeStep: number

Returns void

setTimeStepSearch playground for setTimeStep

Parameters

Optional newTimeStep: number

Returns void

Static DefaultPluginFactorySearch playground for DefaultPluginFactory

Returns IPhysicsEnginePlugin