Class PhysicsEngineV2

constructor

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

  Creates a new Physics Engine

  Parameters

  • gravity: Nullable<Vector3>

    defines the gravity vector used by the simulation

  • _physicsPlugin: IPhysicsEnginePluginV2 = ...

    defines the plugin to use (CannonJS by default)

  Returns PhysicsEngineV2

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

addBody

• addBody(physicsBody: PhysicsBody): void

  Add a body as an active component of this engine

  Parameters

  • physicsBody: PhysicsBody

    The body to add

  Returns void

dispose

• dispose(): void

  Release all resources

  Returns void

getBodies

• getBodies(): PhysicsBody[]

  Returns PhysicsBody[]

  an array of bodies added to this engine

getMaxAngularVelocity

• getMaxAngularVelocity(): number

  Returns number

  maximum allowed angular velocity

getMaxLinearVelocity

• getMaxLinearVelocity(): number

  Returns number

  maximum allowed linear velocity

getPhysicsPlugin

• getPhysicsPlugin(): IPhysicsEnginePluginV2

  Gets the current plugin used to run the simulation

  Returns IPhysicsEnginePluginV2

  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

  physics plugin 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, query?: IRaycastQuery): PhysicsRaycastResult

  Does a raycast in the physics world

  Parameters

  • from: Vector3

    when should the ray start?

  • to: Vector3

    when should the ray end?

  • Optionalquery: IRaycastQuery

    raycast query object

  Returns PhysicsRaycastResult

  PhysicsRaycastResult

raycastMulti

• raycastMulti(
      from: Vector3,
      to: Vector3,
      query?: IRaycastQuery,
  ): PhysicsRaycastResult[]

  Does a raycast through multiple objects in the physics world

  Parameters

  • from: Vector3

    when should the ray start?

  • to: Vector3

    when should the ray end?

  • Optionalquery: IRaycastQuery

    raycast query object

  Returns PhysicsRaycastResult[]

  array of PhysicsRaycastResult

raycastToRef

• raycastToRef(
      from: Vector3,
      to: Vector3,
      result: PhysicsRaycastResult | PhysicsRaycastResult[],
      query?: IRaycastQuery,
  ): 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 | PhysicsRaycastResult[]

    resulting PhysicsRaycastResult or array of PhysicsRaycastResults

  • Optionalquery: IRaycastQuery

    raycast query object If result is an empty array, it will be populated with every detected raycast hit. If result is a populated array, it will only fill the PhysicsRaycastResults present in the array.

  Returns void

removeBody

• removeBody(physicsBody: PhysicsBody): void

  Removes a particular body from this engine

  Parameters

  • physicsBody: PhysicsBody

    The body to remove from the simulation

  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 Unit is seconds.

  Parameters

  • newTimeStep: number = ...

    defines the new timestep to apply to this world.

  Returns void

setVelocityLimits

• setVelocityLimits(maxLinearVelocity: number, maxAngularVelocity: number): void

  Set the maximum allowed linear and angular velocities

  Parameters

  • maxLinearVelocity: number

    maximum allowed linear velocity

  • maxAngularVelocity: number

    maximum allowed angular velocity

  Returns void

StaticDefaultPluginFactory

• DefaultPluginFactory(): IPhysicsEnginePluginV2

  Factory used to create the default physics plugin.

  Returns IPhysicsEnginePluginV2

  The default physics plugin