Class: ConstraintSpace

physics/spaces/constraints.ConstraintSpace

Contains Constraints involving CollisionObjects.

Hierarchy

• Space<Constraint, ConstraintSolver>

  ↳ ConstraintSpace

Constructors

constructor

• new ConstraintSpace()

Inherited from

Space.constructor

Properties

objects

• objects: Constraint[] = []

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	Constraint	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	ConstraintSolver	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(): Constraint[]

Gets all objects in the space.

Returns

Constraint[]

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	Constraint	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/constraints.ts:14