@babylonjs/core|

Class PhysicsHelper

A helper for physics simulations

See

https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine#further-functionality-of-the-impostor-class

Index

Constructors

Methods

applyRadialExplosionForce applyRadialExplosionImpulse gravitationalField updraft vortex

Constructors

constructor

new PhysicsHelper(scene: Scene): PhysicsHelper
Initializes the Physics helper
Parameters
- scene: Scene
  Babylon.js scene
Returns PhysicsHelper
- Defined in packages/dev/core/src/Physics/physicsHelper.ts:82

Methods

applyRadialExplosionForce

applyRadialExplosionForce(
    origin: Vector3,
    radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions,
    strength?: number,
    falloff?: PhysicsRadialImpulseFalloff,
): Nullable<PhysicsRadialExplosionEvent>
Applies a radial explosion force
Parameters
- origin: Vector3
  the origin of the explosion
- radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions
  the radius or the options of radial explosion
- Optionalstrength: number
  the explosion strength
- Optionalfalloff: PhysicsRadialImpulseFalloff
  possible options: Constant & Linear. Defaults to Constant
Returns Nullable<PhysicsRadialExplosionEvent>
A physics radial explosion event, or null
- Defined in packages/dev/core/src/Physics/physicsHelper.ts:171

applyRadialExplosionImpulse

applyRadialExplosionImpulse(
    origin: Vector3,
    radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions,
    strength?: number,
    falloff?: PhysicsRadialImpulseFalloff,
): Nullable<PhysicsRadialExplosionEvent>
Applies a radial explosion impulse
Parameters
- origin: Vector3
  the origin of the explosion
- radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions
  the radius or the options of radial explosion
- Optionalstrength: number
  the explosion strength
- Optionalfalloff: PhysicsRadialImpulseFalloff
  possible options: Constant & Linear. Defaults to Constant
Returns Nullable<PhysicsRadialExplosionEvent>
A physics radial explosion event, or null
- Defined in packages/dev/core/src/Physics/physicsHelper.ts:100

gravitationalField

gravitationalField(
    origin: Vector3,
    radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions,
    strength?: number,
    falloff?: PhysicsRadialImpulseFalloff,
): Nullable<PhysicsGravitationalFieldEvent>
Creates a gravitational field
Parameters
- origin: Vector3
  the origin of the gravitational field
- radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions
  the radius or the options of radial gravitational field
- Optionalstrength: number
  the gravitational field strength
- Optionalfalloff: PhysicsRadialImpulseFalloff
  possible options: Constant & Linear. Defaults to Constant
Returns Nullable<PhysicsGravitationalFieldEvent>
A physics gravitational field event, or null
- Defined in packages/dev/core/src/Physics/physicsHelper.ts:270

updraft

updraft(
    origin: Vector3,
    radiusOrEventOptions: number | PhysicsUpdraftEventOptions,
    strength?: number,
    height?: number,
    updraftMode?: PhysicsUpdraftMode,
): Nullable<PhysicsUpdraftEvent>
Creates a physics updraft event
Parameters
- origin: Vector3
  the origin of the updraft
- radiusOrEventOptions: number | PhysicsUpdraftEventOptions
  the radius or the options of the updraft
- Optionalstrength: number
  the strength of the updraft
- Optionalheight: number
  the height of the updraft
- OptionalupdraftMode: PhysicsUpdraftMode
  possible options: Center & Perpendicular. Defaults to Center
Returns Nullable<PhysicsUpdraftEvent>
A physics updraft event, or null
- Defined in packages/dev/core/src/Physics/physicsHelper.ts:313

vortex

vortex(
    origin: Vector3,
    radiusOrEventOptions: number | PhysicsVortexEventOptions,
    strength?: number,
    height?: number,
): Nullable<PhysicsVortexEvent>
Creates a physics vortex event
Parameters
- origin: Vector3
  the of the vortex
- radiusOrEventOptions: number | PhysicsVortexEventOptions
  the radius or the options of the vortex
- Optionalstrength: number
  the strength of the vortex
- Optionalheight: number
  the height of the vortex
Returns Nullable<PhysicsVortexEvent>
a Physics vortex event, or null A physics vortex event or null
- Defined in packages/dev/core/src/Physics/physicsHelper.ts:358