API Docs for: 0.7.1
Show:

IslandManager Class

Extends Solver
Defined in: src/world/IslandManager.js:10

Splits the system of bodies and equations into independent islands

Constructor

IslandManager

(
  • [options]
)

Defined in src/world/IslandManager.js:10

Parameters:

  • [options] Object optional

Methods

addEquation

(
  • eq
)

Inherited from Solver: src/solver/Solver.js:82

Add an equation to be solved.

Parameters:

addEquations

(
  • eqs
)

Inherited from Solver: src/solver/Solver.js:94

Add equations. Same as .addEquation, but this time the argument is an array of Equations

Parameters:

  • eqs Array

bfs

(
  • root
  • bds
  • eqs
)

Defined in src/world/IslandManager.js:94

Runs the search algorithm, starting at a root node. The resulting bodies and equations will be stored in the provided arrays.

Parameters:

  • root IslandNode

    The node to start from

  • bds Array

    An array to append resulting Bodies to.

  • eqs Array

    An array to append resulting Equations to.

emit

(
  • event
)
EventEmitter

Inherited from EventEmitter: src/events/EventEmitter.js:79

Emit an event.

Parameters:

  • event Object
    • type String

Returns:

EventEmitter:

The self object, for chainability.

getUnvisitedNode

(
  • nodes
)
IslandNode | Boolean static

Defined in src/world/IslandManager.js:58

Get an unvisited node from a list of nodes.

Parameters:

  • nodes Array

Returns:

IslandNode | Boolean:

The node if found, else false.

has

(
  • type
  • listener
)
Boolean

Inherited from EventEmitter: src/events/EventEmitter.js:35

Check if an event listener is added

Parameters:

  • type String
  • listener Function

Returns:

Boolean:

off

(
  • type
  • listener
)
EventEmitter

Inherited from EventEmitter: src/events/EventEmitter.js:60

Remove an event listener

Parameters:

  • type String
  • listener Function

Returns:

EventEmitter:

The self object, for chainability.

on

(
  • type
  • listener
)
EventEmitter

Inherited from EventEmitter: src/events/EventEmitter.js:13

Add an event listener

Parameters:

  • type String
  • listener Function

Returns:

EventEmitter:

The self object, for chainability.

removeAllEquations

()

Inherited from Solver: src/solver/Solver.js:123

Remove all currently added equations.

removeEquation

(
  • eq
)

Inherited from Solver: src/solver/Solver.js:110

Remove an equation.

Parameters:

solve

(
  • dt
  • world
)

Inherited from Solver: src/solver/Solver.js:37

Method to be implemented in each subclass

Parameters:

solveIsland

(
  • dt
  • island
)

Inherited from Solver: src/solver/Solver.js:49

Solves all constraints in an island.

Parameters:

sortEquations

()

Inherited from Solver: src/solver/Solver.js:72

Sort all equations using the .equationSortFunction. Should be called by subclasses before solving.

split

(
  • world
)
Array

Defined in src/world/IslandManager.js:132

Split the world into independent islands. The result is stored in .islands.

Parameters:

Returns:

Array:

The generated islands

visit

(
  • node
  • bds
  • eqs
)

Defined in src/world/IslandManager.js:76

Visit a node.

Parameters:

Properties

equations

Array

Inherited from Solver but overwritten in src/world/IslandManager.js:32

The equations to split. Manually fill this array before running .split().

equationSortFunction

Function | Boolean

Inherited from Solver: src/solver/Solver.js:27

Function that is used to sort all equations before each solve.

islandPool

IslandPool

Defined in src/world/IslandManager.js:26

islands

Array

Defined in src/world/IslandManager.js:38

The resulting Islands.

nodePool

IslandNodePool

Defined in src/world/IslandManager.js:20

nodes

Array

Defined in src/world/IslandManager.js:44

The resulting graph nodes.

queue

Array private

Defined in src/world/IslandManager.js:50

The node queue, used when traversing the graph of nodes.