Class PhysicsEngine
Hierarchy
- PhysicsEngine
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
-
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
Gets the gravity vector used by the simulation
Static EpsilonSearch playground for Epsilon
Global value used to control the smallest number supported by the simulation
Methods
_stepSearch playground for _step
-
Called by the scene. No need to call it.
Parameters
-
delta: number
defines the timespam between frames
Returns void
-
add ImpostorSearch playground for addImpostor
-
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
-
add JointSearch playground for addJoint
-
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
-
Release all resources
Returns void
get Impostor For Physics ObjectSearch playground for getImpostorForPhysicsObject
-
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
-
get Impostor With Physics BodySearch playground for getImpostorWithPhysicsBody
-
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
-
get ImpostorsSearch playground for getImpostors
-
Gets the list of physic impostors
Returns Array<PhysicsImpostor>
an array of PhysicsImpostor
get Physics PluginSearch playground for getPhysicsPlugin
-
Gets the current plugin used to run the simulation
Returns IPhysicsEnginePlugin
current plugin
get Physics Plugin NameSearch playground for getPhysicsPluginName
-
Gets the name of the current physics plugin
Returns string
the name of the plugin
get Sub Time StepSearch playground for getSubTimeStep
-
Get the sub time step of the physics engine.
Returns number
the current sub time step
get Time StepSearch playground for getTimeStep
-
Get the time step of the physics engine.
Returns number
the current time step
raycastSearch playground for raycast
-
Does a raycast in the physics world
Parameters
Returns PhysicsRaycastResult
PhysicsRaycastResult
remove ImpostorSearch playground for removeImpostor
-
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
-
remove JointSearch playground for removeJoint
-
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
-
set GravitySearch playground for setGravity
-
Sets the gravity vector used by the simulation
Parameters
-
gravity: Vector3
defines the gravity vector to use
Returns void
-
set Sub Time StepSearch playground for setSubTimeStep
-
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
-
set Time StepSearch playground for setTimeStep
-
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 Default Plugin FactorySearch playground for DefaultPluginFactory
-
Factory used to create the default physics plugin.
Returns IPhysicsEnginePlugin
The default physics plugin
Class used to control physics engine
https://doc.babylonjs.com/how_to/using_the_physics_engine