API Docs for: 0.3
Show:

Engine Class

Defined in: src\sim\Engine.js:5
Module: Engine
Parent Module: CrowdSim

The simulation engine. Manages the state running of the simulation

Constructor

Engine

(
  • world
  • options
)

Defined in src\sim\Engine.js:5

Parameters:

Methods

_step

()

Defined in src\sim\Engine.js:89

Internal step of the simulation engine. Periodically called.

getSettings

() Object

Defined in src\sim\Engine.js:25

Get the engine settings, configured in constructor [options]

Returns:

Object:

options

getWorld

() World

Defined in src\sim\Engine.js:45

Gets the simulation world

Returns:

World:

reset

() Boolean

Defined in src\sim\Engine.js:140

Resets=Restarts the state of the simulation.

Returns:

Boolean:

true if running; false otherwise

run

(
  • entity
)
Boolean

Defined in src\sim\Engine.js:55

Starts the simulation

Parameters:

  • entity Entity

    to report in the onStart callback as trigger

Returns:

Boolean:

true if running; false otherwise

setWorld

(
  • world
)

Defined in src\sim\Engine.js:35

Sets the simulation world

Parameters:

step

() Boolean

Defined in src\sim\Engine.js:75

Advance one step the simulation and stops.

Returns:

Boolean:

true if running; false otherwise

stop

(
  • entity
)
Boolean

Defined in src\sim\Engine.js:121

Stops the simulation

Parameters:

  • entity Entity

    to report in the onStart callback as trigger

Returns:

Boolean:

true if running; false otherwise