API Docs for: 0.7.1
Show:

Solver Class

Extends EventEmitter
Defined in: src/solver/Solver.js:6

Base class for constraint solvers.

Constructor

Solver

()

Defined in src/solver/Solver.js:6

Methods

addEquation

(
  • eq
)

Defined in src/solver/Solver.js:82

Add an equation to be solved.

Parameters:

addEquations

(
  • eqs
)

Defined in src/solver/Solver.js:94

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

Parameters:

  • eqs Array

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.

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

()

Defined in src/solver/Solver.js:123

Remove all currently added equations.

removeEquation

(
  • eq
)

Defined in src/solver/Solver.js:110

Remove an equation.

Parameters:

solve

(
  • dt
  • world
)

Defined in src/solver/Solver.js:37

Method to be implemented in each subclass

Parameters:

solveIsland

(
  • dt
  • island
)

Defined in src/solver/Solver.js:49

Solves all constraints in an island.

Parameters:

sortEquations

()

Defined in src/solver/Solver.js:72

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

Properties

equations

Array

Defined in src/solver/Solver.js:19

Current equations in the solver.

equationSortFunction

Function | Boolean

Defined in src/solver/Solver.js:27

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