m4m.framework.IPhysicsEnginePlugin

@meta4d/engine / Exports / m4m / framework / IPhysicsEnginePlugin

Interface: IPhysicsEnginePlugin

m4m.framework.IPhysicsEnginePlugin

Implemented by

• CannonJSPlugin

• OimoJSPlugin

Table of contents

Methods

• applyForce

• applyImpulse

• dispose

• executeStep

• generateJoint

• generatePhysicsBody

• getAngularVelocity

• getBodyFriction

• getBodyMass

• getBodyRestitution

• getBoxSizeToRef

• getLinearVelocity

• getRadius

• getTimeStep

• isSleeping

• isSupported

• removeJoint

• removePhysicsBody

• setAngularVelocity

• setBodyFriction

• setBodyMass

• setBodyRestitution

• setGravity

• setLimit

• setLinearVelocity

• setMotor

• setPhysicsBodyTransformation

• setTimeStep

• setTransformationFromPhysicsBody

• sleepBody

• updateDistanceJoint

• wakeUpBody

Properties

• name
• world

Methods

applyForce

▸ applyForce(impostor, force, contactPoint): void

Parameters

Name	Type
impostor	PhysicsImpostor
force	vector3
contactPoint	vector3

Returns

void

Defined in

framework/physics3d/physicEngine.ts:229

---

applyImpulse

▸ applyImpulse(impostor, force, contactPoint): void

Parameters

Name	Type
impostor	PhysicsImpostor
force	vector3
contactPoint	vector3

Returns

void

Defined in

framework/physics3d/physicEngine.ts:228

---

dispose

▸ dispose(): void

Returns

void

Defined in

framework/physics3d/physicEngine.ts:257

---

executeStep

▸ executeStep(delta, impostors): void

Parameters

Name	Type
delta	number
impostors	PhysicsImpostor[]

Returns

void

Defined in

framework/physics3d/physicEngine.ts:227

---

generateJoint

▸ generateJoint(joint): void

Parameters

Name	Type
joint	PhysicsImpostorJoint

Returns

void

Defined in

framework/physics3d/physicEngine.ts:232

---

generatePhysicsBody

▸ generatePhysicsBody(impostor): void

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

void

Defined in

framework/physics3d/physicEngine.ts:230

---

getAngularVelocity

▸ getAngularVelocity(impostor): vector3

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

vector3

Defined in

framework/physics3d/physicEngine.ts:240

---

getBodyFriction

▸ getBodyFriction(impostor): number

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

number

Defined in

framework/physics3d/physicEngine.ts:243

---

getBodyMass

▸ getBodyMass(impostor): number

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

number

Defined in

framework/physics3d/physicEngine.ts:242

---

getBodyRestitution

▸ getBodyRestitution(impostor): number

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

number

Defined in

framework/physics3d/physicEngine.ts:245

---

getBoxSizeToRef

▸ getBoxSizeToRef(impostor, result): void

Parameters

Name	Type
impostor	PhysicsImpostor
result	vector3

Returns

void

Defined in

framework/physics3d/physicEngine.ts:255

---

getLinearVelocity

▸ getLinearVelocity(impostor): vector3

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

vector3

Defined in

framework/physics3d/physicEngine.ts:239

---

getRadius

▸ getRadius(impostor): number

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

number

Defined in

framework/physics3d/physicEngine.ts:254

---

getTimeStep

▸ getTimeStep(): number

Returns

number

Defined in

framework/physics3d/physicEngine.ts:226

---

isSleeping

▸ isSleeping(impostor): boolean

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

boolean

Defined in

framework/physics3d/physicEngine.ts:248

---

isSupported

▸ isSupported(): boolean

Returns

boolean

Defined in

framework/physics3d/physicEngine.ts:234

---

removeJoint

▸ removeJoint(joint): void

Parameters

Name	Type
joint	PhysicsImpostorJoint

Returns

void

Defined in

framework/physics3d/physicEngine.ts:233

---

removePhysicsBody

▸ removePhysicsBody(impostor): void

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

void

Defined in

framework/physics3d/physicEngine.ts:231

---

setAngularVelocity

▸ setAngularVelocity(impostor, velocity): void

Parameters

Name	Type
impostor	PhysicsImpostor
velocity	vector3

Returns

void

Defined in

framework/physics3d/physicEngine.ts:238

---

setBodyFriction

▸ setBodyFriction(impostor, friction): void

Parameters

Name	Type
impostor	PhysicsImpostor
friction	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:244

---

setBodyMass

▸ setBodyMass(impostor, mass): void

Parameters

Name	Type
impostor	PhysicsImpostor
mass	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:241

---

setBodyRestitution

▸ setBodyRestitution(impostor, restitution): void

Parameters

Name	Type
impostor	PhysicsImpostor
restitution	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:246

---

setGravity

▸ setGravity(gravity): void

Parameters

Name	Type
gravity	vector3

Returns

void

Defined in

framework/physics3d/physicEngine.ts:224

---

setLimit

▸ setLimit(joint, upperLimit, lowerLimit?, motorIndex?): void

Parameters

Name	Type
joint	IMotorEnabledJoint
upperLimit	number
lowerLimit?	number
motorIndex?	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:253

---

setLinearVelocity

▸ setLinearVelocity(impostor, velocity): void

Parameters

Name	Type
impostor	PhysicsImpostor
velocity	vector3

Returns

void

Defined in

framework/physics3d/physicEngine.ts:237

---

setMotor

▸ setMotor(joint, speed, maxForce?, motorIndex?): void

Parameters

Name	Type
joint	IMotorEnabledJoint
speed	number
maxForce?	number
motorIndex?	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:252

---

setPhysicsBodyTransformation

▸ setPhysicsBodyTransformation(impostor, newPosition, newRotation): void

Parameters

Name	Type
impostor	PhysicsImpostor
newPosition	vector3
newRotation	quaternion

Returns

void

Defined in

framework/physics3d/physicEngine.ts:236

---

setTimeStep

▸ setTimeStep(timeStep): void

Parameters

Name	Type
timeStep	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:225

---

setTransformationFromPhysicsBody

▸ setTransformationFromPhysicsBody(impostor): void

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

void

Defined in

framework/physics3d/physicEngine.ts:235

---

sleepBody

▸ sleepBody(impostor): void

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

void

Defined in

framework/physics3d/physicEngine.ts:247

---

updateDistanceJoint

▸ updateDistanceJoint(joint, maxDistance, minDistance?): void

Parameters

Name	Type
joint	PhysicsJoint
maxDistance	number
minDistance?	number

Returns

void

Defined in

framework/physics3d/physicEngine.ts:251

---

wakeUpBody

▸ wakeUpBody(impostor): void

Parameters

Name	Type
impostor	PhysicsImpostor

Returns

void

Defined in

framework/physics3d/physicEngine.ts:249

Properties

name

• name: string

Defined in

framework/physics3d/physicEngine.ts:223

---

world

• world: any

Defined in

framework/physics3d/physicEngine.ts:222