Class PhysicsImpostor

constructor

• new PhysicsImpostor(
      object: IPhysicsEnabledObject,
      type: number,
      _options?: PhysicsImpostorParameters,
      _scene?: Scene,
  ): PhysicsImpostor

  Initializes the physics imposter

  Parameters

  • object: IPhysicsEnabledObject

    The physics-enabled object used as the physics imposter

  • type: number

    The type of the physics imposter. Types are available as static members of this class.

  • _options: PhysicsImpostorParameters = ...

    The options for the physics imposter

  • Optional_scene: Scene

    The Babylon scene

  Returns PhysicsImpostor

object

onCollideEvent

type

uniqueId

StaticBoxImpostor

StaticCapsuleImpostor

StaticClothImpostor

StaticConvexHullImpostor

StaticCustomImpostor

StaticCylinderImpostor

StaticDEFAULT_OBJECT_SIZE

StaticHeightmapImpostor

StaticIDENTITY_QUATERNION

StaticMeshImpostor

StaticNoImpostor

StaticParticleImpostor

StaticPlaneImpostor

StaticRopeImpostor

StaticSoftbodyImpostor

StaticSphereImpostor

friction

• get friction(): number

  Gets the coefficient of friction

  Returns number

• set friction(value: number): void

  Sets the coefficient of friction

  Parameters

  • value: number

  Returns void

isDisposed

• get isDisposed(): boolean

  Specifies if the physics imposter is disposed

  Returns boolean

mass

• get mass(): number

  Gets the mass of the physics imposter

  Returns number

• set mass(value: number): void

  Parameters

  • value: number

  Returns void

parent

• get parent(): Nullable<PhysicsImpostor>

  Get the parent of the physics imposter

  Returns Nullable<PhysicsImpostor>

  Physics imposter or null

• set parent(value: Nullable<PhysicsImpostor>): void

  Sets the parent of the physics imposter

  Parameters

  • value: Nullable<PhysicsImpostor>

  Returns void

physicsBody

• get physicsBody(): any

  Gets the body that holds this impostor. Either its own, or its parent.

  Returns any

• set physicsBody(physicsBody: any): void

  Set the physics body. Used mainly by the physics engine/plugin

  Parameters

  • physicsBody: any

  Returns void

positionIterations

• get positionIterations(): number

  Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin

  Returns number

• set positionIterations(value: number): void

  Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin

  Parameters

  • value: number

  Returns void

pressure

• get pressure(): number

  Gets the pressure of a soft body; only supported by the AmmoJSPlugin

  Returns number

• set pressure(value: number): void

  Sets the pressure of a soft body; only supported by the AmmoJSPlugin

  Parameters

  • value: number

  Returns void

restitution

• get restitution(): number

  Gets the coefficient of restitution

  Returns number

• set restitution(value: number): void

  Sets the coefficient of restitution

  Parameters

  • value: number

  Returns void

stiffness

• get stiffness(): number

  Gets the stiffness of a soft body; only supported by the AmmoJSPlugin

  Returns number

• set stiffness(value: number): void

  Sets the stiffness of a soft body; only supported by the AmmoJSPlugin

  Parameters

  • value: number

  Returns void

velocityIterations

• get velocityIterations(): number

  Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin

  Returns number

• set velocityIterations(value: number): void

  Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin

  Parameters

  • value: number

  Returns void

addAnchor

• addAnchor(
      otherImpostor: PhysicsImpostor,
      width: number,
      height: number,
      influence: number,
      noCollisionBetweenLinkedBodies: boolean,
  ): PhysicsImpostor

  Add an anchor to a cloth impostor

  Parameters

  • otherImpostor: PhysicsImpostor

    rigid impostor to anchor to

  • width: number

    ratio across width from 0 to 1

  • height: number

    ratio up height from 0 to 1

  • influence: number

    the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little stretch

  • noCollisionBetweenLinkedBodies: boolean

    when true collisions between cloth impostor and anchor are ignored; default false

  Returns PhysicsImpostor

  impostor the soft imposter

addHook

• addHook(
      otherImpostor: PhysicsImpostor,
      length: number,
      influence: number,
      noCollisionBetweenLinkedBodies: boolean,
  ): PhysicsImpostor

  Add a hook to a rope impostor

  Parameters

  • otherImpostor: PhysicsImpostor

    rigid impostor to anchor to

  • length: number

    ratio across rope from 0 to 1

  • influence: number

    the elasticity between rope impostor and anchor from 0, very stretchy to 1, little stretch

  • noCollisionBetweenLinkedBodies: boolean

    when true collisions between soft impostor and anchor are ignored; default false

  Returns PhysicsImpostor

  impostor the rope imposter

addJoint

• addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor

  Add a joint to this impostor with a different impostor

  Parameters

  • otherImpostor: PhysicsImpostor

    A physics imposter used to add a joint

  • joint: PhysicsJoint

    The joint to add

  Returns PhysicsImpostor

  The physics imposter

afterStep

• afterStep(): void

  this function is executed by the physics engine

  Returns void

applyForce

• applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor

  Apply a force

  Parameters

  • force: Vector3

    The force to apply

  • contactPoint: Vector3

    The contact point for the force

  Returns PhysicsImpostor

  The physics imposter

applyImpulse

• applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor

  Apply an impulse

  Parameters

  • force: Vector3

    The impulse force

  • contactPoint: Vector3

    The contact point for the impulse force

  Returns PhysicsImpostor

  The physics imposter

beforeStep

• beforeStep(): void

  this function is executed by the physics engine.

  Returns void

clone

• clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>

  Clones the physics imposter

  Parameters

  • newObject: IPhysicsEnabledObject

    The physics imposter clones to this physics-enabled object

  Returns Nullable<PhysicsImpostor>

  A nullable physics imposter

createJoint

• createJoint(
      otherImpostor: PhysicsImpostor,
      jointType: number,
      jointData: PhysicsJointData,
  ): PhysicsImpostor

  A help function to create a joint

  Parameters

  • otherImpostor: PhysicsImpostor

    A physics imposter used to create a joint

  • jointType: number

    The type of joint

  • jointData: PhysicsJointData

    The data for the joint

  Returns PhysicsImpostor

  The physics imposter

dispose

• dispose(): void

  Disposes the physics imposter

  Returns void

executeNativeFunction

• executeNativeFunction(func: (world: any, physicsBody: any) => void): void

  Execute a function with the physics plugin native code Provide a function the will have two variables - the world object and the physics body object

  Parameters

  • func: (world: any, physicsBody: any) => void

    The function to execute with the physics plugin native code

  Returns void

forceUpdate

• forceUpdate(): void

  Force a regeneration of this or the parent's impostor's body. Use with caution - This will remove all previously-instantiated joints.

  Returns void

getAngularVelocity

• getAngularVelocity(): Nullable<Vector3>

  Gets the angular velocity

  Returns Nullable<Vector3>

  angular velocity or null

getBoxSizeToRef

• getBoxSizeToRef(result: Vector3): PhysicsImpostor

  Gets the box size of the physics imposter and stores the result in the input parameter

  Parameters

  • result: Vector3

    Stores the box size

  Returns PhysicsImpostor

  The physics imposter

getLinearVelocity

• getLinearVelocity(): Nullable<Vector3>

  Gets the linear velocity

  Returns Nullable<Vector3>

  linear velocity or null

getObjectCenter

• getObjectCenter(): Vector3

  Gets the object center

  Returns Vector3

  The object center

getObjectExtents

• getObjectExtents(): Vector3

  Gets the object extents

  Returns Vector3

  the object extents

getParam

• getParam(paramName: string): any

  Get a specific parameter from the options parameters

  Parameters

  • paramName: string

    The object parameter name

  Returns any

  The object parameter

getParentsRotation

• getParentsRotation(): Quaternion

  Get the parent rotation

  Returns Quaternion

  The parent rotation

getRadius

• getRadius(): number

  Gets the radius of the physics imposter

  Returns number

  Radius of the physics imposter

isBodyInitRequired

• isBodyInitRequired(): boolean

  Should a new body be generated.

  Returns boolean

  boolean specifying if body initialization is required

onCollide

• onCollide(
      e: {
          body: any;
          distance: number;
          impulse: number;
          normal: Nullable<Vector3>;
          point: Nullable<Vector3>;
      },
  ): void

  define an onCollide function to call when this impostor collides against a different body

  Parameters

  • e: {
        body: any;
        distance: number;
        impulse: number;
        normal: Nullable<Vector3>;
        point: Nullable<Vector3>;
    }

    collide event data

  Returns void

registerAfterPhysicsStep

• registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void

  Register a function that will be executed after the physics step

  Parameters

  • func: (impostor: PhysicsImpostor) => void

    The function to execute after physics step

  Returns void

registerBeforePhysicsStep

• registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void

  Register a function that will be executed before the physics world is stepping forward

  Parameters

  • func: (impostor: PhysicsImpostor) => void

    The function to execute before the physics world is stepped forward

  Returns void

registerOnPhysicsCollide

• registerOnPhysicsCollide(
      collideAgainst: PhysicsImpostor | PhysicsImpostor[],
      func: (
          collider: PhysicsImpostor,
          collidedAgainst: PhysicsImpostor,
          point: Nullable<Vector3>,
      ) => void,
  ): void

  register a function that will be executed when this impostor collides against a different body

  Parameters

  • collideAgainst: PhysicsImpostor | PhysicsImpostor[]

    Physics imposter, or array of physics imposters to collide against

  • func: (
        collider: PhysicsImpostor,
        collidedAgainst: PhysicsImpostor,
        point: Nullable<Vector3>,
    ) => void

    Callback that is executed on collision

  Returns void

resetUpdateFlags

• resetUpdateFlags(): void

  Resets the update flags

  Returns void

setAngularVelocity

• setAngularVelocity(velocity: Nullable<Vector3>): void

  Sets the angular velocity

  Parameters

  • velocity: Nullable<Vector3>

    The velocity or null

  Returns void

setDeltaPosition

• setDeltaPosition(position: Vector3): void

  Sets the delta position

  Parameters

  • position: Vector3

    The delta position amount

  Returns void

setDeltaRotation

• setDeltaRotation(rotation: Quaternion): void

  Sets the delta rotation

  Parameters

  • rotation: Quaternion

    The delta rotation amount

  Returns void

setLinearVelocity

• setLinearVelocity(velocity: Nullable<Vector3>): void

  Sets the linear velocity

  Parameters

  • velocity: Nullable<Vector3>

    linear velocity or null

  Returns void

setMass

• setMass(mass: number): void

  Specifically change the body's mass. Won't recreate the physics body object

  Parameters

  • mass: number

    The mass of the physics imposter

  Returns void

setParam

• setParam(paramName: string, value: number): void

  Sets a specific parameter in the options given to the physics plugin

  Parameters

  • paramName: string

    The parameter name

  • value: number

    The value of the parameter

  Returns void

setScalingUpdated

• setScalingUpdated(): void

  Sets the updated scaling

  Returns void

sleep

• sleep(): PhysicsImpostor

  Will keep this body still, in a sleep mode.

  Returns PhysicsImpostor

  the physics imposter

syncBoneWithImpostor

• syncBoneWithImpostor(
      bone: Bone,
      boneMesh: AbstractMesh,
      jointPivot: Vector3,
      distToJoint?: number,
      adjustRotation?: Quaternion,
  ): void

  Sync a bone with this impostor

  Parameters

  • bone: Bone

    The bone to sync to the impostor.

  • boneMesh: AbstractMesh

    The mesh that the bone is influencing.

  • jointPivot: Vector3

    The pivot of the joint / bone in local space.

  • OptionaldistToJoint: number

    Optional distance from the impostor to the joint.

  • OptionaladjustRotation: Quaternion

    Optional quaternion for adjusting the local rotation of the bone.

  Returns void

syncImpostorWithBone

• syncImpostorWithBone(
      bone: Bone,
      boneMesh: AbstractMesh,
      jointPivot: Vector3,
      distToJoint?: number,
      adjustRotation?: Quaternion,
      boneAxis?: Vector3,
  ): void

  Sync impostor to a bone

  Parameters

  • bone: Bone

    The bone that the impostor will be synced to.

  • boneMesh: AbstractMesh

    The mesh that the bone is influencing.

  • jointPivot: Vector3

    The pivot of the joint / bone in local space.

  • OptionaldistToJoint: number

    Optional distance from the impostor to the joint.

  • OptionaladjustRotation: Quaternion

    Optional quaternion for adjusting the local rotation of the bone.

  • OptionalboneAxis: Vector3

    Optional vector3 axis the bone is aligned with

  Returns void

unregisterAfterPhysicsStep

• unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void

  Unregisters a function that will be executed after the physics step

  Parameters

  • func: (impostor: PhysicsImpostor) => void

    The function to execute after physics step

  Returns void

unregisterBeforePhysicsStep

• unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void

  Unregister a function that will be executed before the physics world is stepping forward

  Parameters

  • func: (impostor: PhysicsImpostor) => void

    The function to execute before the physics world is stepped forward

  Returns void

unregisterOnPhysicsCollide

• unregisterOnPhysicsCollide(
      collideAgainst: PhysicsImpostor | PhysicsImpostor[],
      func: (
          collider: PhysicsImpostor,
          collidedAgainst: PhysicsImpostor | PhysicsImpostor[],
          point: Nullable<Vector3>,
      ) => void,
  ): void

  Unregisters the physics imposter's collision callback

  Parameters

  • collideAgainst: PhysicsImpostor | PhysicsImpostor[]

    The physics object to collide against

  • func: (
        collider: PhysicsImpostor,
        collidedAgainst: PhysicsImpostor | PhysicsImpostor[],
        point: Nullable<Vector3>,
    ) => void

    Callback to execute on collision

  Returns void

wakeUp

• wakeUp(): PhysicsImpostor

  Wake the body up.

  Returns PhysicsImpostor

  The physics imposter