HavokPlugin | Babylon.js API documentation

Class HavokPlugin

The Havok Physics plugin

Implements

IPhysicsEnginePluginV2

Index

Constructors

constructor

new HavokPlugin(_useDeltaForWorldStep?: boolean, hpInjection?: any): HavokPlugin
Parameters
- Optional_useDeltaForWorldStep: boolean
- OptionalhpInjection: any
Returns HavokPlugin
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29052

Properties

_hknp

_hknp: any

Reference to the WASM library

name

name: string

Name of the plugin

onCollisionEndedObservable

onCollisionEndedObservable: Observable<IBasePhysicsCollisionEvent>

Observable for collision ended events

onCollisionObservable

onCollisionObservable: Observable<IPhysicsCollisionEvent>

Observable for collision started and collision continued events

onTriggerCollisionObservable

onTriggerCollisionObservable: Observable<IBasePhysicsCollisionEvent>

Observable for trigger entered and trigger exited events

world

world: any

Created Havok world which physics bodies are added to

Accessors

numBodies

get numBodies(): any
Gets the number of bodies in the world

Returns any
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29831

Methods

_internalSetMotionType

_internalSetMotionType(
pluginData: BodyPluginData,
motionType: PhysicsMotionType,
): void
Parameters
- pluginData: BodyPluginData
- motionType: PhysicsMotionType
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29228

addChild

addChild(
    shape: PhysicsShape,
    newChild: PhysicsShape,
    translation?: Vector3,
    rotation?: Quaternion,
    scale?: Vector3,
): void
Adds a child shape to the given shape.
Parameters
- shape: PhysicsShape
  The parent shape.
- newChild: PhysicsShape
  The child shape to add.
- Optionaltranslation: Vector3
  The relative translation of the child from the parent shape
- Optionalrotation: Quaternion
  The relative rotation of the child from the parent shape
- Optionalscale: Vector3
  The relative scale scale of the child from the parent shaep
Returns void
Implementation of IPhysicsEnginePluginV2.addChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29520

addConstraint

addConstraint(
    body: PhysicsBody,
    childBody: PhysicsBody,
    constraint: PhysicsConstraint,
    instanceIndex?: number,
    childInstanceIndex?: number,
): void
Adds a constraint to the physics engine.
Parameters
- body: PhysicsBody
  The main body to which the constraint is applied.
- childBody: PhysicsBody
  The body to which the constraint is applied.
- constraint: PhysicsConstraint
  The constraint to be applied.
- OptionalinstanceIndex: number
  If this body is instanced, the index of the instance to which the constraint will be applied. If not specified, no constraint will be applied.
- OptionalchildInstanceIndex: number
  If the child body is instanced, the index of the instance to which the constraint will be applied. If not specified, no constraint will be applied.
Returns void
Implementation of IPhysicsEnginePluginV2.addConstraint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29609

applyAngularImpulse

applyAngularImpulse(
    body: PhysicsBody,
    angularImpulse: Vector3,
    instanceIndex?: number,
): void
Applies an angular impulse(torque) to a physics body
Parameters
- body: PhysicsBody
  The physics body to apply the impulse to.
- angularImpulse: Vector3
  The torque value
- OptionalinstanceIndex: number
  The index of the instance to apply the impulse to. If not specified, the impulse will be applied to all instances.
Returns void
Implementation of IPhysicsEnginePluginV2.applyAngularImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29358

applyForce

applyForce(
    body: PhysicsBody,
    force: Vector3,
    location: Vector3,
    instanceIndex?: number,
): void
Applies a force to a physics body at a given location.
Parameters
- body: PhysicsBody
  The physics body to apply the impulse to.
- force: Vector3
  The force vector to apply.
- location: Vector3
  The location in world space to apply the impulse.
- OptionalinstanceIndex: number
  The index of the instance to apply the force to. If not specified, the force will be applied to all instances.
  
  This method is useful for applying a force to a physics body at a given location. This can be used to simulate physical forces such as explosions, collisions, and gravity.
Returns void
Implementation of IPhysicsEnginePluginV2.applyForce
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29369

applyImpulse

applyImpulse(
    body: PhysicsBody,
    impulse: Vector3,
    location: Vector3,
    instanceIndex?: number,
): void
Applies an impulse to a physics body at a given location.
Parameters
- body: PhysicsBody
  The physics body to apply the impulse to.
- impulse: Vector3
  The impulse vector to apply.
- location: Vector3
  The location in world space to apply the impulse.
- OptionalinstanceIndex: number
  The index of the instance to apply the impulse to. If not specified, the impulse will be applied to all instances.
  
  This method is useful for applying an impulse to a physics body at a given location. This can be used to simulate physical forces such as explosions, collisions, and gravity.
Returns void
Implementation of IPhysicsEnginePluginV2.applyImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29351

computeMassProperties

computeMassProperties(
body: PhysicsBody,
instanceIndex?: number,
): PhysicsMassProperties
Computes the mass properties of a physics body, from it's shape
Parameters
- body: PhysicsBody
  The physics body to copmute the mass properties of
- OptionalinstanceIndex: number
  The index of the instance to compute the mass properties of.
Returns PhysicsMassProperties
The mass properties of the physics body.
Implementation of IPhysicsEnginePluginV2.computeMassProperties
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29257

dispose

dispose(): void
Dispose the world and free resources

Returns void
Implementation of IPhysicsEnginePluginV2.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29835

disposeBody

disposeBody(body: PhysicsBody): void
Disposes a physics body.
Parameters
- body: PhysicsBody
  The physics body to dispose.
  
  This method is useful for releasing the resources associated with a physics body when it is no longer needed. This is important for avoiding memory leaks in the physics engine.
Returns void
Implementation of IPhysicsEnginePluginV2.disposeBody
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29436

disposeConstraint

disposeConstraint(constraint: PhysicsConstraint): void
Disposes a physics constraint.
Parameters
- constraint: PhysicsConstraint
  The physics constraint to dispose.
  
  This method is useful for releasing the resources associated with a physics constraint, such as the Havok constraint, when it is no longer needed. This is important for avoiding memory leaks.
Returns void
Implementation of IPhysicsEnginePluginV2.disposeConstraint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29764

disposeShape

disposeShape(shape: PhysicsShape): void
Releases a physics shape from the physics engine.
Parameters
- shape: PhysicsShape
  The physics shape to be released.
  
  This method is useful for releasing a physics shape from the physics engine, freeing up resources and preventing memory leaks.
Returns void
Implementation of IPhysicsEnginePluginV2.disposeShape
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29581

executeStep

executeStep(delta: number, physicsBodies: PhysicsBody[]): void
Executes a single step of the physics engine.
Parameters
- delta: number
  The time delta in seconds since the last step.
- physicsBodies: PhysicsBody[]
  An array of physics bodies to be simulated.
  
  This method is useful for simulating the physics engine. It sets the physics body transformation, steps the world, syncs the physics body, and notifies collisions. This allows for the physics engine to accurately simulate the physics bodies in the world.
Returns void
Implementation of IPhysicsEnginePluginV2.executeStep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29089

getAngularDamping

getAngularDamping(body: PhysicsBody, instanceIndex?: number): number
Gets the angular damping of a physics body.
Parameters
- body: PhysicsBody
  The physics body to get the angular damping from.
- OptionalinstanceIndex: number
  The index of the instance to get the angular damping from. If not specified, the angular damping of the first instance will be returned.
Returns number
The angular damping of the body.

This function is useful for retrieving the angular damping of a physics body, which is used to control the rotational motion of the body. The angular damping is a value between 0 and 1, where 0 is no damping and 1 is full damping.
Implementation of IPhysicsEnginePluginV2.getAngularDamping
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29318

getAngularVelocityToRef

getAngularVelocityToRef(
    body: PhysicsBody,
    angVel: Vector3,
    instanceIndex?: number,
): void
Gets the angular velocity of a body.
Parameters
- body: PhysicsBody
  The body to get the angular velocity from.
- angVel: Vector3
  The vector3 to store the angular velocity.
- OptionalinstanceIndex: number
  The index of the instance to get the angular velocity from. If not specified, the angular velocity of the first instance will be returned.
  
  This method is useful for getting the angular velocity of a body in a physics engine. It takes the body and a vector3 as parameters and stores the angular velocity of the body in the vector3. This is useful for getting the angular velocity of a body in order to calculate the motion of the body in the physics engine.
Returns void
Implementation of IPhysicsEnginePluginV2.getAngularVelocityToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29392

getAxisFriction

getAxisFriction(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<number>
Gets the friction value of the specified axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the axis friction from.
- axis: PhysicsConstraintAxis
  The axis to get the friction from.
Returns Nullable<number>
The friction value of the specified axis.
Implementation of IPhysicsEnginePluginV2.getAxisFriction
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29655

getAxisMaxLimit

getAxisMaxLimit(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<number>
Gets the maximum limit of the given axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the maximum limit from.
- axis: PhysicsConstraintAxis
  The axis to get the maximum limit from.
Returns Nullable<number>
The maximum limit of the given axis of the given constraint.
Implementation of IPhysicsEnginePluginV2.getAxisMaxLimit
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29704

getAxisMinLimit

getAxisMinLimit(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<number>
Gets the minimum limit of the specified axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the minimum limit from.
- axis: PhysicsConstraintAxis
  The axis to get the minimum limit from.
Returns Nullable<number>
The minimum limit of the specified axis of the given constraint.
Implementation of IPhysicsEnginePluginV2.getAxisMinLimit
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29687

getAxisMode

getAxisMode(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<PhysicsConstraintAxisLimitMode>
Gets the axis limit mode of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the axis limit mode from.
- axis: PhysicsConstraintAxis
  The axis to get the limit mode from.
Returns Nullable<PhysicsConstraintAxisLimitMode>
The axis limit mode of the given constraint.
Implementation of IPhysicsEnginePluginV2.getAxisMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29671

getAxisMotorMaxForce

getAxisMotorMaxForce(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<number>
Gets the maximum force of the motor of the given constraint axis.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the motor maximum force from.
- axis: PhysicsConstraintAxis
  The axis of the constraint to get the motor maximum force from.
Returns Nullable<number>
The maximum force of the motor of the given constraint axis.
Implementation of IPhysicsEnginePluginV2.getAxisMotorMaxForce
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29755

getAxisMotorTarget

getAxisMotorTarget(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<number>
Gets the target of the motor of the given axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the motor target from.
- axis: PhysicsConstraintAxis
  The axis of the constraint to get the motor target from.
Returns Nullable<number>
The target of the motor of the given axis of the given constraint.
Implementation of IPhysicsEnginePluginV2.getAxisMotorTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29738

getAxisMotorType

getAxisMotorType(
constraint: PhysicsConstraint,
axis: PhysicsConstraintAxis,
): Nullable<PhysicsConstraintMotorType>
Gets the motor type of the specified axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the motor type from.
- axis: PhysicsConstraintAxis
  The axis of the constraint to get the motor type from.
Returns Nullable<PhysicsConstraintMotorType>
The motor type of the specified axis of the given constraint.
Implementation of IPhysicsEnginePluginV2.getAxisMotorType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29720

getBodiesUsingConstraint

getBodiesUsingConstraint(constraint: PhysicsConstraint): ConstrainedBodyPair[]
Get a list of all the pairs of bodies that are connected by this constraint.
Parameters
- constraint: PhysicsConstraint
  the constraint to search from
Returns ConstrainedBodyPair[]
a list of parent, child pairs
Implementation of IPhysicsEnginePluginV2.getBodiesUsingConstraint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29599

getBodyBoundingBox

getBodyBoundingBox(body: PhysicsBody): BoundingBox
Calculates the world bounding box of a given physics body.
Parameters
- body: PhysicsBody
  The physics body to calculate the bounding box for.
Returns BoundingBox
The calculated bounding box.

This method is useful for physics engines as it allows to calculate the boundaries of a given body.
Implementation of IPhysicsEnginePluginV2.getBodyBoundingBox
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29562

getBodyGeometry

getBodyGeometry(
body: PhysicsBody,
): { indices: number[] | Uint32Array; positions: number[] | Float32Array }
Gets the geometry of a physics body.
Parameters
- body: PhysicsBody
  The physics body.
Returns { indices: number[] | Uint32Array; positions: number[] | Float32Array }
An object containing the positions and indices of the body's geometry.
Implementation of IPhysicsEnginePluginV2.getBodyGeometry
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29570

getBoundingBox

getBoundingBox(_shape: PhysicsShape): BoundingBox
Calculates the bounding box of a given physics shape.
Parameters
- _shape: PhysicsShape
  The physics shape to calculate the bounding box for.
Returns BoundingBox
The calculated bounding box.

This method is useful for physics engines as it allows to calculate the boundaries of a given shape. Knowing the boundaries of a shape is important for collision detection and other physics calculations.
Implementation of IPhysicsEnginePluginV2.getBoundingBox
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29552

getCollisionEndedObservable

getCollisionEndedObservable(
body: PhysicsBody,
): Observable<IBasePhysicsCollisionEvent>
Return the collision ended observable for a particular physics body.
Parameters
- body: PhysicsBody
  the physics body
Returns Observable<IBasePhysicsCollisionEvent>
Implementation of IPhysicsEnginePluginV2.getCollisionEndedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29810

getCollisionObservable

getCollisionObservable(body: PhysicsBody): Observable<IPhysicsCollisionEvent>
Return the collision observable for a particular physics body.
Parameters
- body: PhysicsBody
  the physics body
Returns Observable<IPhysicsCollisionEvent>
the collision observable for the body
Implementation of IPhysicsEnginePluginV2.getCollisionObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29804

getCollisionsEnabled

getCollisionsEnabled(constraint: PhysicsConstraint): boolean
Gets whether collisions are enabled for the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get collisions enabled for.
Returns boolean
Whether collisions are enabled for the given constraint.
Implementation of IPhysicsEnginePluginV2.getCollisionsEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29637

getDensity

getDensity(shape: PhysicsShape): number
Calculates the density of a given physics shape.
Parameters
- shape: PhysicsShape
  The physics shape to calculate the density of.
Returns number
The density of the given physics shape.
Implementation of IPhysicsEnginePluginV2.getDensity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29501

getEnabled

getEnabled(constraint: PhysicsConstraint): boolean
Gets the enabled state of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to get the enabled state from.
Returns boolean
The enabled state of the given constraint.
Implementation of IPhysicsEnginePluginV2.getEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29623

getEventMask

getEventMask(body: PhysicsBody, instanceIndex?: number): number
Retrieves the event mask of a physics body.
Parameters
- body: PhysicsBody
  The physics body to retrieve the event mask from.
- OptionalinstanceIndex: number
  The index of the instance to retrieve the event mask from.
Returns number
The event mask of the physics body.
Implementation of IPhysicsEnginePluginV2.getEventMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29225

getGravityFactor

getGravityFactor(body: PhysicsBody, instanceIndex?: number): number
Get the gravity factor of a body
Parameters
- body: PhysicsBody
  the physics body to get the gravity factor from
- OptionalinstanceIndex: number
  the index of the instance in an instanced body. If not specified, the gravity factor of the first instance will be returned.
Returns number
the gravity factor
Implementation of IPhysicsEnginePluginV2.getGravityFactor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29427

getLinearDamping

getLinearDamping(body: PhysicsBody, instanceIndex?: number): number
Gets the linear damping of the given body.
Parameters
- body: PhysicsBody
  The body to get the linear damping from.
- OptionalinstanceIndex: number
  The index of the instance to get the linear damping from. If not specified, the linear damping of the first instance will be returned.
Returns number
The linear damping of the given body.

This method is useful for getting the linear damping of a body in a physics engine. Linear damping is a force that opposes the motion of the body and is proportional to the velocity of the body. It is used to simulate the effects of air resistance and other forms of friction.
Implementation of IPhysicsEnginePluginV2.getLinearDamping
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29298

getLinearVelocityToRef

getLinearVelocityToRef(
    body: PhysicsBody,
    linVel: Vector3,
    instanceIndex?: number,
): void
Gets the linear velocity of a physics body and stores it in a given vector.
Parameters
- body: PhysicsBody
  The physics body to get the linear velocity from.
- linVel: Vector3
  The vector to store the linear velocity in.
- OptionalinstanceIndex: number
  The index of the instance to get the linear velocity from. If not specified, the linear velocity of the first instance will be returned.
  
  This function is useful for retrieving the linear velocity of a physics body, which can be used to determine the speed and direction of the body. This information can be used to simulate realistic physics behavior in a game.
Returns void
Implementation of IPhysicsEnginePluginV2.getLinearVelocityToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29339

getMassProperties

getMassProperties(
body: PhysicsBody,
instanceIndex?: number,
): PhysicsMassProperties
Gets the mass properties of a physics body.
Parameters
- body: PhysicsBody
  The physics body to get the mass properties from.
- OptionalinstanceIndex: number
  The index of the instance to get the mass properties from. If not specified, the mass properties of the first instance will be returned.
Returns PhysicsMassProperties
The mass properties of the physics body.
Implementation of IPhysicsEnginePluginV2.getMassProperties
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29276

getMaterial

getMaterial(shape: PhysicsShape): PhysicsMaterial
Gets the material associated with a physics shape.
Parameters
- shape: PhysicsShape
  The shape to get the material from.
Returns PhysicsMaterial
The material associated with the shape.
Implementation of IPhysicsEnginePluginV2.getMaterial
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29486

getMaxAngularVelocity

getMaxAngularVelocity(): number
Returns number
maximum allowed angular velocity
Implementation of IPhysicsEnginePluginV2.getMaxAngularVelocity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29111

getMaxLinearVelocity

getMaxLinearVelocity(): number
Returns number
maximum allowed linear velocity
Implementation of IPhysicsEnginePluginV2.getMaxLinearVelocity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29107

getMotionType

getMotionType(body: PhysicsBody, instanceIndex?: number): PhysicsMotionType
Gets the motion type of a physics body.
Parameters
- body: PhysicsBody
  The physics body to get the motion type from.
- OptionalinstanceIndex: number
  The index of the instance to get the motion type from. If not specified, the motion type of the first instance will be returned.
Returns PhysicsMotionType
The motion type of the physics body.
Implementation of IPhysicsEnginePluginV2.getMotionType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29242

getNumChildren

getNumChildren(shape: PhysicsShape): number
Returns the number of children of the given shape.
Parameters
- shape: PhysicsShape
  The shape to get the number of children from.
Returns number
The number of children of the given shape.
Implementation of IPhysicsEnginePluginV2.getNumChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29535

getPluginVersion

getPluginVersion(): number
Returns the version of the physics engine plugin.

Returns number
The version of the physics engine plugin.

This method is useful for determining the version of the physics engine plugin that is currently running.
Implementation of IPhysicsEnginePluginV2.getPluginVersion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29097

getShape

getShape(body: PhysicsBody): Nullable<PhysicsShape>
Gets the shape of a physics body. This will create a new shape object
Parameters
- body: PhysicsBody
  The physics body.
Returns Nullable<PhysicsShape>
The shape of the physics body.
Implementation of IPhysicsEnginePluginV2.getShape
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29200

getShapeFilterCollideMask

getShapeFilterCollideMask(shape: PhysicsShape): number
Gets the shape filter collide mask of a body
Parameters
- shape: PhysicsShape
  The physics body to get the shape filter collide mask from.
Returns number
The shape filter collide mask of the given body.
Implementation of IPhysicsEnginePluginV2.getShapeFilterCollideMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29473

getShapeFilterMembershipMask

getShapeFilterMembershipMask(shape: PhysicsShape): number
Gets the shape filter membership mask of a body
Parameters
- shape: PhysicsShape
  The physics body to get the shape filter membership mask from.
Returns number
The shape filter membership mask of the given body.
Implementation of IPhysicsEnginePluginV2.getShapeFilterMembershipMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29461

getShapeType

getShapeType(shape: PhysicsShape): PhysicsShapeType
Gets the type of a physics shape.
Parameters
- shape: PhysicsShape
  The physics shape to get the type for.
Returns PhysicsShapeType
The type of the physics shape.
Implementation of IPhysicsEnginePluginV2.getShapeType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29207

getTimeStep

getTimeStep(): number
Gets the fixed time step used by the physics engine.

Returns number
The fixed time step used by the physics engine.
Implementation of IPhysicsEnginePluginV2.getTimeStep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29078

initBody

initBody(
    body: PhysicsBody,
    motionType: PhysicsMotionType,
    position: Vector3,
    orientation: Quaternion,
): void
Initializes a physics body with the given position and orientation.
Parameters
- body: PhysicsBody
  The physics body to initialize.
- motionType: PhysicsMotionType
  The motion type of the body.
- position: Vector3
  The position of the body.
- orientation: Quaternion
  The orientation of the body. This code is useful for initializing a physics body with the given position and orientation. It creates a plugin data for the body and adds it to the world. It then converts the position and orientation to a transform and sets the body's transform to the given values.
Returns void
Implementation of IPhysicsEnginePluginV2.initBody
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29123

initBodyInstances

initBodyInstances(
    body: PhysicsBody,
    motionType: PhysicsMotionType,
    mesh: Mesh,
): void
Initializes the body instances for a given physics body and mesh.
Parameters
- body: PhysicsBody
  The physics body to initialize.
- motionType: PhysicsMotionType
  How the body will be handled by the engine
- mesh: Mesh
  The mesh to initialize.
  
  This code is useful for creating a physics body from a mesh. It creates a body instance for each instance of the mesh and adds it to the world. It also sets the position of the body instance to the position of the mesh instance. This allows for the physics engine to accurately simulate the mesh in the world.
Returns void
Implementation of IPhysicsEnginePluginV2.initBodyInstances
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29143

initConstraint

initConstraint(
    constraint: PhysicsConstraint,
    body: PhysicsBody,
    childBody: PhysicsBody,
    instanceIndex?: number,
    childInstanceIndex?: number,
): void
Initializes a physics constraint with the given parameters.
Parameters
- constraint: PhysicsConstraint
  The physics constraint to be initialized.
- body: PhysicsBody
  The main body
- childBody: PhysicsBody
  The child body.
- OptionalinstanceIndex: number
  If this body is instanced, the index of the instance to which the constraint will be applied. If not specified, no constraint will be applied.
- OptionalchildInstanceIndex: number
  If the child body is instanced, the index of the instance to which the constraint will be applied. If not specified, no constraint will be applied.
  
  This function is useful for setting up a physics constraint in a physics engine.
Returns void
Implementation of IPhysicsEnginePluginV2.initConstraint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29593

initShape

initShape(
    shape: PhysicsShape,
    type: PhysicsShapeType,
    options: PhysicsShapeParameters,
): void
Initializes a physics shape with the given type and parameters.
Parameters
- shape: PhysicsShape
  The physics shape to initialize.
- type: PhysicsShapeType
  The type of shape to initialize.
- options: PhysicsShapeParameters
  The parameters for the shape.
  
  This code is useful for initializing a physics shape with the given type and parameters. It allows for the creation of a sphere, box, capsule, container, cylinder, mesh, and heightfield. Depending on the type of shape, different parameters are required. For example, a sphere requires a radius, while a box requires extents and a rotation.
Returns void
Implementation of IPhysicsEnginePluginV2.initShape
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29449

isSupported

isSupported(): boolean
If this plugin is supported

Returns boolean
true if its supported
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29057

pointProximity

pointProximity(
query: IPhysicsPointProximityQuery,
result: ProximityCastResult,
): void
Given a point, returns the closest physics body to that point.
Parameters
- query: IPhysicsPointProximityQuery
  the query to perform.
- result: ProximityCastResult
  contact point on the hit shape, in world space
Returns void
See
IPhysicsPointProximityQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29784

raycast

raycast(
    from: Vector3,
    to: Vector3,
    result: PhysicsRaycastResult,
    query?: IRaycastQuery,
): void
Performs a raycast from a given start point to a given end point and stores the result in a given PhysicsRaycastResult object.
Parameters
- from: Vector3
  The start point of the raycast.
- to: Vector3
  The end point of the raycast.
- result: PhysicsRaycastResult
  The PhysicsRaycastResult object to store the result of the raycast.
- Optionalquery: IRaycastQuery
  The raycast query options. See [[IRaycastQuery]] for more information.
  
  Performs a raycast. It takes in two points, from and to, and a PhysicsRaycastResult object to store the result of the raycast. It then performs the raycast and stores the hit data in the PhysicsRaycastResult object.
Returns void
Implementation of IPhysicsEnginePluginV2.raycast
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29777

removeBody

removeBody(body: PhysicsBody): void
Removes a body from the world. To dispose of a body, it is necessary to remove it from the world first.
Parameters
- body: PhysicsBody
  The body to remove.
Returns void
Implementation of IPhysicsEnginePluginV2.removeBody
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29129

removeChild

removeChild(shape: PhysicsShape, childIndex: number): void
Removes a child shape from a parent shape.
Parameters
- shape: PhysicsShape
  The parent shape.
- childIndex: number
  The index of the child shape to remove.
Returns void
Implementation of IPhysicsEnginePluginV2.removeChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29527

setActivationControl

setActivationControl(
body: PhysicsBody,
controlMode: PhysicsActivationControl,
): void
sets the activation control mode of a physics body, for instance if you need the body to never sleep.
Parameters
- body: PhysicsBody
  The physics body to set the activation control mode.
- controlMode: PhysicsActivationControl
  The activation control mode.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29248

setAngularDamping

setAngularDamping(
    body: PhysicsBody,
    damping: number,
    instanceIndex?: number,
): void
Sets the angular damping of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the angular damping for.
- damping: number
  The angular damping value to set.
- OptionalinstanceIndex: number
  The index of the instance to set the angular damping for. If not specified, the angular damping of the first instance will be set.
  
  This function is useful for controlling the angular velocity of a physics body. By setting the angular damping, the body's angular velocity will be reduced over time, allowing for more realistic physics simulations.
Returns void
Implementation of IPhysicsEnginePluginV2.setAngularDamping
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29308

setAngularVelocity

setAngularVelocity(
    body: PhysicsBody,
    angVel: Vector3,
    instanceIndex?: number,
): void
Sets the angular velocity of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the angular velocity of.
- angVel: Vector3
  The angular velocity to set.
- OptionalinstanceIndex: number
  The index of the instance to set the angular velocity of. If not specified, the angular velocity of the first instance will be set.
  
  This function is useful for setting the angular velocity of a physics body in a physics engine. This allows for more realistic simulations of physical objects, as they can be given a rotational velocity.
Returns void
Implementation of IPhysicsEnginePluginV2.setAngularVelocity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29380

setAxisFriction

setAxisFriction(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    friction: number,
): void
Sets the friction of the given axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the friction of.
- axis: PhysicsConstraintAxis
  The axis of the constraint to set the friction of.
- friction: number
  The friction to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisFriction
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29646

setAxisMaxLimit

setAxisMaxLimit(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    limit: number,
): void
Sets the maximum limit of the given axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the maximum limit of the given axis.
- axis: PhysicsConstraintAxis
  The axis to set the maximum limit of.
- limit: number
  The maximum limit to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisMaxLimit
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29695

setAxisMinLimit

setAxisMinLimit(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    limit: number,
): void
Sets the minimum limit of the given axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the minimum limit of.
- axis: PhysicsConstraintAxis
  The axis to set the minimum limit of.
- limit: number
  The minimum limit to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisMinLimit
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29679

setAxisMode

setAxisMode(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    limitMode: PhysicsConstraintAxisLimitMode,
): void
Sets the limit mode of the specified axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the axis mode of.
- axis: PhysicsConstraintAxis
  The axis to set the limit mode of.
- limitMode: PhysicsConstraintAxisLimitMode
  The limit mode to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29662

setAxisMotorMaxForce

setAxisMotorMaxForce(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    maxForce: number,
): void
Sets the maximum force that can be applied by the motor of the given constraint axis.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the motor max force for.
- axis: PhysicsConstraintAxis
  The axis of the constraint to set the motor max force for.
- maxForce: number
  The maximum force that can be applied by the motor.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisMotorMaxForce
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29746

setAxisMotorTarget

setAxisMotorTarget(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    target: number,
): void
Sets the target of an axis motor of a constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the axis motor target of.
- axis: PhysicsConstraintAxis
  The axis of the constraint to set the motor target of.
- target: number
  The target of the axis motor.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisMotorTarget
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29729

setAxisMotorType

setAxisMotorType(
    constraint: PhysicsConstraint,
    axis: PhysicsConstraintAxis,
    motorType: PhysicsConstraintMotorType,
): void
Sets the motor type of the given axis of the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to set the motor type of.
- axis: PhysicsConstraintAxis
  The axis of the constraint to set the motor type of.
- motorType: PhysicsConstraintMotorType
  The motor type to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setAxisMotorType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29712

setCollisionCallbackEnabled

setCollisionCallbackEnabled(body: PhysicsBody, enabled: boolean): void
Enable collision to be reported for a body when a callback is setup on the world
Parameters
- body: PhysicsBody
  the physics body
- enabled: boolean
  whether to enable or disable collision events
Returns void
Implementation of IPhysicsEnginePluginV2.setCollisionCallbackEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29816

setCollisionEndedCallbackEnabled

setCollisionEndedCallbackEnabled(body: PhysicsBody, enabled: boolean): void
Enable collision ended to be reported for a body when a callback is setup on the world
Parameters
- body: PhysicsBody
  the physics body
- enabled: boolean
  whether to enable or disable collision ended events
Returns void
Implementation of IPhysicsEnginePluginV2.setCollisionEndedCallbackEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29822

setCollisionsEnabled

setCollisionsEnabled(constraint: PhysicsConstraint, isEnabled: boolean): void
Enables or disables collisions for the given constraint.
Parameters
- constraint: PhysicsConstraint
  The constraint to enable or disable collisions for.
- isEnabled: boolean
  Whether collisions should be enabled or disabled.
Returns void
Implementation of IPhysicsEnginePluginV2.setCollisionsEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29630

setDensity

setDensity(shape: PhysicsShape, density: number): void
Sets the density of a physics shape.
Parameters
- shape: PhysicsShape
  The physics shape to set the density of.
- density: number
  The density to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setDensity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29493

setEnabled

setEnabled(constraint: PhysicsConstraint, isEnabled: boolean): void
Enables or disables a constraint in the physics engine.
Parameters
- constraint: PhysicsConstraint
  The constraint to enable or disable.
- isEnabled: boolean
  Whether the constraint should be enabled or disabled.
Returns void
Implementation of IPhysicsEnginePluginV2.setEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29616

setEventMask

setEventMask(body: PhysicsBody, eventMask: number, instanceIndex?: number): void
Sets the event mask of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the event mask for.
- eventMask: number
  The event mask to set.
- OptionalinstanceIndex: number
  The index of the instance to set the event mask for
  
  This function is useful for setting the event mask of a physics body, which is used to determine which events the body will respond to. This is important for ensuring that the physics engine is able to accurately simulate the behavior of the body in the game world.
Returns void
Implementation of IPhysicsEnginePluginV2.setEventMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29216

setGravity

setGravity(gravity: Vector3): void
Sets the gravity of the physics world.
Parameters
- gravity: Vector3
  The gravity vector to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setGravity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29064

setGravityFactor

setGravityFactor(
    body: PhysicsBody,
    factor: number,
    instanceIndex?: number,
): void
Sets the gravity factor of a body
Parameters
- body: PhysicsBody
  the physics body to set the gravity factor for
- factor: number
  the gravity factor
- OptionalinstanceIndex: number
  the index of the instance in an instanced body
Returns void
Implementation of IPhysicsEnginePluginV2.setGravityFactor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29420

setLinearDamping

setLinearDamping(
    body: PhysicsBody,
    damping: number,
    instanceIndex?: number,
): void
Sets the linear damping of the given body.
Parameters
- body: PhysicsBody
  The body to set the linear damping for.
- damping: number
  The linear damping to set.
- OptionalinstanceIndex: number
  The index of the instance to set the linear damping for. If not specified, the linear damping of the first instance will be set.
  
  This method is useful for controlling the linear damping of a body in a physics engine. Linear damping is a force that opposes the motion of the body, and is proportional to the velocity of the body. This method allows the user to set the linear damping of a body, which can be used to control the motion of the body.
Returns void
Implementation of IPhysicsEnginePluginV2.setLinearDamping
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29287

setLinearVelocity

setLinearVelocity(
    body: PhysicsBody,
    linVel: Vector3,
    instanceIndex?: number,
): void
Sets the linear velocity of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the linear velocity of.
- linVel: Vector3
  The linear velocity to set.
- OptionalinstanceIndex: number
  The index of the instance to set the linear velocity of. If not specified, the linear velocity of the first instance will be set.
  
  This function is useful for setting the linear velocity of a physics body, which is necessary for simulating motion in a physics engine. The linear velocity is the speed and direction of the body's movement.
Returns void
Implementation of IPhysicsEnginePluginV2.setLinearVelocity
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29328

setMassProperties

setMassProperties(
    body: PhysicsBody,
    massProps: PhysicsMassProperties,
    instanceIndex?: number,
): void
Sets the mass properties of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the mass properties of.
- massProps: PhysicsMassProperties
  The mass properties to set.
- OptionalinstanceIndex: number
  The index of the instance to set the mass properties of. If undefined, the mass properties of all the bodies will be set. This function is useful for setting the mass properties of a physics body, such as its mass, inertia, and center of mass. This is important for accurately simulating the physics of the body in the physics engine.
Returns void
Implementation of IPhysicsEnginePluginV2.setMassProperties
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29269

setMaterial

setMaterial(shape: PhysicsShape, material: PhysicsMaterial): void
Sets the material of a physics shape.
Parameters
- shape: PhysicsShape
  The physics shape to set the material of.
- material: PhysicsMaterial
  The material to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setMaterial
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29480

setMotionType

setMotionType(
    body: PhysicsBody,
    motionType: PhysicsMotionType,
    instanceIndex?: number,
): void
sets the motion type of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the motion type for.
- motionType: PhysicsMotionType
  The motion type to set.
- OptionalinstanceIndex: number
  The index of the instance to set the motion type for. If undefined, the motion type of all the bodies will be set.
Returns void
Implementation of IPhysicsEnginePluginV2.setMotionType
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29235

setPhysicsBodyTransformation

setPhysicsBodyTransformation(body: PhysicsBody, node: TransformNode): void
Sets the transformation of the given physics body to the given transform node.
Parameters
- body: PhysicsBody
  The physics body to set the transformation for.
- node: TransformNode
  The transform node to set the transformation from. Sets the transformation of the given physics body to the given transform node.
  
  This function is useful for setting the transformation of a physics body to a transform node, which is necessary for the physics engine to accurately simulate the motion of the body. It also takes into account instances of the transform node, which is necessary for accurate simulation of multiple bodies with the same transformation.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29405

setShape

setShape(body: PhysicsBody, shape: Nullable<PhysicsShape>): void
Sets the shape of a physics body.
Parameters
- body: PhysicsBody
  The physics body to set the shape for.
- shape: Nullable<PhysicsShape>
  The physics shape to set.
  
  This function is used to set the shape of a physics body. It is useful for creating a physics body with a specific shape, such as a box or a sphere, which can then be used to simulate physical interactions in a physics engine. This function is especially useful for meshes with multiple instances, as it will set the shape for each instance of the mesh.
Returns void
Implementation of IPhysicsEnginePluginV2.setShape
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29185

setShapeFilterCollideMask

setShapeFilterCollideMask(shape: PhysicsShape, collideMask: number): void
Sets the shape filter collide mask of a body
Parameters
- shape: PhysicsShape
  The physics body to set the shape filter collide mask for.
- collideMask: number
  The shape filter collide mask to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setShapeFilterCollideMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29467

setShapeFilterMembershipMask

setShapeFilterMembershipMask(shape: PhysicsShape, membershipMask: number): void
Sets the shape filter membership mask of a body
Parameters
- shape: PhysicsShape
  The physics body to set the shape filter membership mask for.
- membershipMask: number
  The shape filter membership mask to set.
Returns void
Implementation of IPhysicsEnginePluginV2.setShapeFilterMembershipMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29455

setTargetTransform

setTargetTransform(
    body: PhysicsBody,
    position: Vector3,
    rotation: Quaternion,
    instanceIndex?: number,
): void
Set the target transformation (position and rotation) of the body, such that the body will set its velocity to reach that target
Parameters
- body: PhysicsBody
  The physics body to set the target transformation for.
- position: Vector3
  The target position
- rotation: Quaternion
  The target rotation
- OptionalinstanceIndex: number
  The index of the instance in an instanced body
Returns void
Implementation of IPhysicsEnginePluginV2.setTargetTransform
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29413

setTimeStep

setTimeStep(timeStep: number): void
Sets the fixed time step for the physics engine.
Parameters
- timeStep: number
  The fixed time step to use for the physics engine.
Returns void
Implementation of IPhysicsEnginePluginV2.setTimeStep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29071

setTrigger

setTrigger(shape: PhysicsShape, isTrigger: boolean): void
Marks the shape as a trigger
Parameters
- shape: PhysicsShape
  the shape to mark as a trigger
- isTrigger: boolean
  if the shape is a trigger
Returns void
Implementation of IPhysicsEnginePluginV2.setTrigger
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29541

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
Implementation of IPhysicsEnginePluginV2.setVelocityLimits
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29103

shapeCast

shapeCast(
    query: IPhysicsShapeCastQuery,
    inputShapeResult: ShapeCastResult,
    hitShapeResult: ShapeCastResult,
): void
Given a shape in a specific orientation, cast it from the start to end position specified by the query, and return the first hit.
Parameters
- query: IPhysicsShapeCastQuery
  the query to perform.
- inputShapeResult: ShapeCastResult
  contact point on input shape, in input shape space
- hitShapeResult: ShapeCastResult
  contact point on hit shape, in world space
Returns void
See
IPhysicsShapeCastQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29798

shapeProximity

shapeProximity(
    query: IPhysicsShapeProximityCastQuery,
    inputShapeResult: ProximityCastResult,
    hitShapeResult: ProximityCastResult,
): void
Given a shape in a specific position and orientation, returns the closest point to that shape.
Parameters
- query: IPhysicsShapeProximityCastQuery
  the query to perform.
- inputShapeResult: ProximityCastResult
  contact point on input shape, in input shape space
- hitShapeResult: ProximityCastResult
  contact point on hit shape, in world space
Returns void
See
IPhysicsShapeProximityCastQuery
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29791

sync

sync(body: PhysicsBody): void
Synchronizes the transform of a physics body with its transform node.
Parameters
- body: PhysicsBody
  The physics body to synchronize.
  
  This function is useful for keeping the physics body's transform in sync with its transform node. This is important for ensuring that the physics body is accurately represented in the physics engine.
Returns void
Implementation of IPhysicsEnginePluginV2.sync
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29158

syncTransform

syncTransform(body: PhysicsBody, transformNode: TransformNode): void
Synchronizes the transform of a physics body with the transform of its corresponding transform node.
Parameters
- body: PhysicsBody
  The physics body to synchronize.
- transformNode: TransformNode
  The destination Transform Node.
  
  This code is useful for synchronizing the position and orientation of a physics body with the position and orientation of its corresponding transform node. This is important for ensuring that the physics body and the transform node are in the same position and orientation in the scene. This is necessary for the physics engine to accurately simulate the physical behavior of the body.
Returns void
Implementation of IPhysicsEnginePluginV2.syncTransform
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29173

updateBodyInstances

updateBodyInstances(body: PhysicsBody, mesh: Mesh): void
Update the internal body instances for a given physics body to match the instances in a mesh.
Parameters
- body: PhysicsBody
  the body that will be updated
- mesh: Mesh
  the mesh with reference instances
Returns void
Implementation of IPhysicsEnginePluginV2.updateBodyInstances
- Defined in .temp/typedoc/docdirectory/doc.d.ts:29150

Class HavokPlugin

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns HavokPlugin

Properties

_hknp

name

onCollisionEndedObservable

onCollisionObservable

onTriggerCollisionObservable

world

Accessors

numBodies

Returns any

Methods

_internalSetMotionType

Parameters

Returns void

addChild

Parameters

Returns void

addConstraint

Parameters

Returns void

applyAngularImpulse

Parameters

Returns void

applyForce

Parameters

Returns void

applyImpulse

Parameters

Returns void

computeMassProperties

Parameters

Returns PhysicsMassProperties

dispose

Returns void

disposeBody

Parameters

Returns void

disposeConstraint

Parameters

Returns void

disposeShape

Parameters

Returns void

executeStep

Parameters

Returns void

getAngularDamping

Parameters

Returns number

getAngularVelocityToRef

Parameters

Returns void

getAxisFriction

Parameters

Returns Nullable<number>

getAxisMaxLimit

Parameters

Returns Nullable<number>

getAxisMinLimit

Parameters

Returns Nullable<number>

getAxisMode

Parameters

Returns Nullable<PhysicsConstraintAxisLimitMode>

getAxisMotorMaxForce

Parameters

Returns Nullable<number>

getAxisMotorTarget

Parameters