PhysicsBackend
Defined in: packages/threeplay/src/plugins/physics/types.ts:169
A physics engine adapter. The physics plugin drives it; Rapier is the built-in implementation. Body/collider handles are opaque to the engine. This interface may grow while the plugin matures (it is marked unstable).
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/threeplay/src/plugins/physics/types.ts:183
Returns
Section titled “Returns”void
getGravity()
Section titled “getGravity()”getGravity():
Vector3
Defined in: packages/threeplay/src/plugins/physics/types.ts:180
Current gravity vector (a copy).
Returns
Section titled “Returns”Vector3
init()
Section titled “init()”init():
Promise<void>
Defined in: packages/threeplay/src/plugins/physics/types.ts:177
Returns
Section titled “Returns”Promise<void>
setGravity()
Section titled “setGravity()”setGravity(
g):void
Defined in: packages/threeplay/src/plugins/physics/types.ts:178
Parameters
Section titled “Parameters”Vector3
Returns
Section titled “Returns”void
step()
Section titled “step()”step(
dt):void
Defined in: packages/threeplay/src/plugins/physics/types.ts:182
Advances the simulation by dt seconds.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Properties
Section titled “Properties”
readonlyname:string
Defined in: packages/threeplay/src/plugins/physics/types.ts:170
native
Section titled “native”
readonlynative:unknown
Defined in: packages/threeplay/src/plugins/physics/types.ts:176
The native module (e.g. RAPIER).
readonlyready:boolean
Defined in: packages/threeplay/src/plugins/physics/types.ts:172
true once the engine finished loading and bodies can be created.
readonlyworld:unknown
Defined in: packages/threeplay/src/plugins/physics/types.ts:174
The native world (escape hatch, e.g. a RAPIER.World).