Class: DynamicsSpace

physics/spaces/dynamics.DynamicsSpace

Represents an infinite space containing RigidBodys.

Can be used to update objects dynamics.

Hierarchy

• Space<RigidBody, DynamicsSolver>

  ↳ DynamicsSpace

Constructors

constructor

• new DynamicsSpace(gravity)

Creates a DynamicsSpace instance.

Parameters

Name	Type
gravity	vec2

Overrides

Space.constructor

Defined in

src/physics/spaces/dynamics.ts:17

Properties

gravity

• gravity: vec2

Defined in

src/physics/spaces/dynamics.ts:12

---

objects

• objects: RigidBody[] = []

Inherited from

Space.objects

Defined in

src/physics/spaces/space.ts:8

---

solvers

• solvers: Object = {}

Index signature

▪ [index: string]: { cb: S ; iterations: number }

Inherited from

Space.solvers

Defined in

src/physics/spaces/space.ts:9

Methods

addObject

▸ addObject(obj): void

Adds an object to the space.

Parameters

Name	Type	Description
obj	RigidBody	The object to add

Returns

void

Inherited from

Space.addObject

Defined in

src/physics/spaces/space.ts:50

---

addSolver

▸ addSolver(id, cb, iterations): void

Adds a solver to the space.

Parameters

Name	Type	Description
id	string	The solver's identifier
cb	DynamicsSolver	The solver to add
iterations	number	The number of times to run the solver, per time step

Returns

void

Inherited from

Space.addSolver

Defined in

src/physics/spaces/space.ts:91

---

clearObjects

▸ clearObjects(): void

Removes all objects from the space.

Returns

void

Inherited from

Space.clearObjects

Defined in

src/physics/spaces/space.ts:41

---

clearSolvers

▸ clearSolvers(): void

Removes all solvers from the space.

Returns

void

Inherited from

Space.clearSolvers

Defined in

src/physics/spaces/space.ts:80

---

getObjects

▸ getObjects(): RigidBody[]

Gets all objects in the space.

Returns

RigidBody[]

All objects in the space

Inherited from

Space.getObjects

Defined in

src/physics/spaces/space.ts:34

---

getSolvers

▸ getSolvers(): Object

Gets all solvers in the space.

Returns

Object

All solvers in the space

Inherited from

Space.getSolvers

Defined in

src/physics/spaces/space.ts:73

---

removeObject

▸ removeObject(obj): boolean

Removes an object from the space.

Parameters

Name	Type	Description
obj	RigidBody	The object to remove

Returns

boolean

Wether or not the object was removed

Inherited from

Space.removeObject

Defined in

src/physics/spaces/space.ts:60

---

removeSolver

▸ removeSolver(id): boolean

Removes a solver from the space.

Parameters

Name	Type	Description
id	string	The id of the solver to remove

Returns

boolean

Wether or not the solver was removed

Inherited from

Space.removeSolver

Defined in

src/physics/spaces/space.ts:101

---

setSolverIterations

▸ setSolverIterations(id, iterations): void

Sets the number of iterations a solver should run.

Parameters

Name	Type	Description
id	string	The id of the solver to update
iterations	number	The new number of iterations

Returns

void

Inherited from

Space.setSolverIterations

Defined in

src/physics/spaces/space.ts:112

---

solve

▸ solve(id, delta): void

Executes a solver on every object in the space.

Parameters

Name	Type	Description
id	string	The id of the solver to execute
delta	number	-

Returns

void

Overrides

Space.solve

Defined in

src/physics/spaces/dynamics.ts:28