Babylon.js API documentation|

PhysicsEngineV2

Class PhysicsEngineV2

Class used to control physics engine

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

Hierarchy

PhysicsEngineV2

Implements

IPhysicsEngine

Index

Constructors

constructor

Properties

gravity

Methods

Constructors

constructor

new PhysicsEngineV2(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePluginV2): PhysicsEngineV2

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

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

Properties

gravity Search playground for gravity

gravity: Vector3

Gets the gravity vector used by the simulation

Methods

_step Search playground for _step

_step(delta: number): void

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

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

addBody Search playground for addBody

addBody(physicsBody: PhysicsBody): void

- Defined in .temp/docdirectory/doc.d.ts:93407
Add a body as an active component of this engine

Parameters
- physicsBody: PhysicsBody
Returns void

dispose Search playground for dispose

dispose(): void

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

Returns void

getBodies Search playground for getBodies

getBodies(): PhysicsBody[]

- Defined in .temp/docdirectory/doc.d.ts:93415
Returns an array of bodies added to this engine

Returns PhysicsBody[]

getPhysicsPlugin Search playground for getPhysicsPlugin

getPhysicsPlugin(): IPhysicsEnginePluginV2

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

Returns IPhysicsEnginePluginV2
current plugin

getPhysicsPluginName Search playground for getPhysicsPluginName

getPhysicsPluginName(): string

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

Returns string
the name of the plugin

getPluginVersion Search playground for getPluginVersion

getPluginVersion(): number

Implementation of IPhysicsEngine.getPluginVersion
- Defined in .temp/docdirectory/doc.d.ts:93342
Returns number
physics plugin version

getSubTimeStep Search playground for getSubTimeStep

getSubTimeStep(): number

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

Returns number
the current sub time step

getTimeStep Search playground for getTimeStep

getTimeStep(): number

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

Returns number
the current time step

raycast Search playground for raycast

raycast(from: Vector3, to: Vector3, query?: IRaycastQuery): PhysicsRaycastResult

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

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

raycastToRef Search playground for raycastToRef

raycastToRef(from: Vector3, to: Vector3, result: PhysicsRaycastResult, query?: IRaycastQuery): void

- Defined in .temp/docdirectory/doc.d.ts:93427
Does a raycast in the physics world

Parameters
- from: Vector3
  
  when should the ray start?
- to: Vector3
  
  when should the ray end?
- result: PhysicsRaycastResult
  
  resulting PhysicsRaycastResult
- Optional query: IRaycastQuery
Returns void

removeBody Search playground for removeBody

removeBody(physicsBody: PhysicsBody): void

- Defined in .temp/docdirectory/doc.d.ts:93411
Removes a particular body from this engine

Parameters
- physicsBody: PhysicsBody
Returns void

setGravity Search playground for setGravity

setGravity(gravity: Vector3): void

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

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

setSubTimeStep Search playground for setSubTimeStep

setSubTimeStep(subTimeStep?: number): void

Implementation of IPhysicsEngine.setSubTimeStep
- Defined in .temp/docdirectory/doc.d.ts:93378
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

setTimeStep Search playground for setTimeStep

setTimeStep(newTimeStep?: number): void

Implementation of IPhysicsEngine.setTimeStep
- Defined in .temp/docdirectory/doc.d.ts:93366
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 DefaultPluginFactory Search playground for DefaultPluginFactory

DefaultPluginFactory(): IPhysicsEnginePluginV2

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

Returns IPhysicsEnginePluginV2
The default physics plugin