Class: Space<O, S>
physics/spaces/space.Space
Represents an infinite space filled with objects.
Type parameters
| Name |
|---|
O |
S |
Hierarchy
Space
Constructors
constructor
• new Space<O, S>()
Type parameters
| Name |
|---|
O |
S |
Properties
objects
• objects: O[] = []
Defined in
src/physics/spaces/space.ts:8
solvers
• solvers: Object = {}
Index signature
▪ [index: string]: { cb: S ; iterations: number }
Defined in
src/physics/spaces/space.ts:9
Methods
addObject
▸ addObject(obj): void
Adds an object to the space.
Parameters
| Name | Type | Description |
|---|---|---|
obj | O | The object to add |
Returns
void
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 | S | The solver to add |
iterations | number | The number of times to run the solver, per time step |
Returns
void
Defined in
src/physics/spaces/space.ts:91
clearObjects
▸ clearObjects(): void
Removes all objects from the space.
Returns
void
Defined in
src/physics/spaces/space.ts:41
clearSolvers
▸ clearSolvers(): void
Removes all solvers from the space.
Returns
void
Defined in
src/physics/spaces/space.ts:80
getObjects
▸ getObjects(): O[]
Gets all objects in the space.
Returns
O[]
All objects in the space
Defined in
src/physics/spaces/space.ts:34
getSolvers
▸ getSolvers(): Object
Gets all solvers in the space.
Returns
Object
All solvers in the space
Defined in
src/physics/spaces/space.ts:73
removeObject
▸ removeObject(obj): boolean
Removes an object from the space.
Parameters
| Name | Type | Description |
|---|---|---|
obj | O | The object to remove |
Returns
boolean
Wether or not the object was removed
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
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
Defined in
src/physics/spaces/space.ts:112
solve
▸ Abstract solve(id, ...args): void
Executes a solver on every object in the space.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The id of the solver to execute |
...args | any | - |
Returns
void
Defined in
src/physics/spaces/space.ts:20