Class PhysicsEngine

constructor

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

  Creates a new Physics Engine

  Parameters

  • gravity: Nullable<Vector3>

    defines the gravity vector used by the simulation

  • _physicsPlugin: IPhysicsEnginePlugin = ...

    defines the plugin to use (CannonJS by default)

  Returns PhysicsEngine

gravity

_step

• _step(delta: number): void

  Called by the scene. No need to call it.

  Parameters

  • delta: number

    defines the timespan between frames

  Returns void

addImpostor

• addImpostor(impostor: PhysicsImpostor): void

  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

addJoint

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

  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

dispose

• dispose(): void

  Release all resources

  Returns void

getImpostorForPhysicsObject

• getImpostorForPhysicsObject(
      object: IPhysicsEnabledObject,
  ): Nullable<PhysicsImpostor>

  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

getImpostors

• getImpostors(): PhysicsImpostor[]

  Gets the list of physic impostors

  Returns PhysicsImpostor[]

  an array of PhysicsImpostor

getImpostorWithPhysicsBody

• getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>

  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

getPhysicsPlugin

• getPhysicsPlugin(): IPhysicsEnginePlugin

  Gets the current plugin used to run the simulation

  Returns IPhysicsEnginePlugin

  current plugin

getPhysicsPluginName

• getPhysicsPluginName(): string

  Gets the name of the current physics plugin

  Returns string

  the name of the plugin

getPluginVersion

• getPluginVersion(): number

  Returns number

  version

getSubTimeStep

• getSubTimeStep(): number

  Get the sub time step of the physics engine.

  Returns number

  the current sub time step

getTimeStep

• getTimeStep(): number

  Get the time step of the physics engine.

  Returns number

  the current time step

raycast

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

  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

raycastToRef

• raycastToRef(from: Vector3, to: Vector3, result: PhysicsRaycastResult): void

  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

  Returns void

  true if the ray hits an impostor, else false

removeImpostor

• removeImpostor(impostor: PhysicsImpostor): void

  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

removeJoint

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

  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

setGravity

• setGravity(gravity: Vector3): void

  Sets the gravity vector used by the simulation

  Parameters

  • gravity: Vector3

    defines the gravity vector to use

  Returns void

setSubTimeStep

• setSubTimeStep(subTimeStep?: number): void

  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

  • subTimeStep: number = 0

    defines the new sub timestep used for physics resolution.

  Returns void

setTimeStep

• setTimeStep(newTimeStep?: number): void

  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

  • newTimeStep: number = ...

    defines the new timestep to apply to this world.

  Returns void

StaticDefaultPluginFactory

• DefaultPluginFactory(): IPhysicsEnginePlugin

  Factory used to create the default physics plugin.

  Returns IPhysicsEnginePlugin

  The default physics plugin