API Docs for: 0.3
Show:

CrowdSimApp Class

Defined in: src\app\CrowdSimApp.js:7
Module: CrowdSimApp

Methods

addEntity

(
  • entity
)

Defined in src\app\CrowdSimApp.js:485

Add a existing entity.

Parameters:

clear

()

Defined in src\app\CrowdSimApp.js:330

Clear current world.

createEntityEnd

() Object

Defined in src\app\CrowdSimApp.js:441

Request to end the creation of the current entity.

Returns:

Object:

null

createEntityStart

(
  • entityType
  • pos
)
Render.Entity

Defined in src\app\CrowdSimApp.js:417

Request to create an entity at a give pos.

Parameters:

  • entityType EntityTypes
  • pos Vec2

Returns:

Render.Entity:

cycleDetail

(
  • entityType
)

Defined in src\app\CrowdSimApp.js:275

Cycle an entity detail level.

Parameters:

  • entityType EntityTypes

destroyEntity

(
  • entity
)

Defined in src\app\CrowdSimApp.js:453

Destroy an entity.

Parameters:

  • entity Render.Entity

editEntity

(
  • entity
)

Defined in src\app\CrowdSimApp.js:466

Edit an entity starting is creation mode.

Parameters:

  • entity Render.Entity

entityClick

(
  • pos
  • newEntity
  • selected
)

Defined in src\app\CrowdSimApp.js:572

Stage entity click event, creation of new entities.

Parameters:

  • pos Vec2
  • newEntity Render.Entity
  • selected Render.Entity

getCreatingEntity

() Render.Entity

Defined in src\app\CrowdSimApp.js:431

Request current entity creation of null if finished

Returns:

Render.Entity:

getEngineSettings

() Object

Defined in src\app\CrowdSimApp.js:285

Get simulation engine time settings.

Returns:

Object:

[engine.options]

getSelectedEntity

() Render.Entity

Defined in src\app\CrowdSimApp.js:520

Gets the current selected entity.

Returns:

Render.Entity:

getStats

() Object

Defined in src\app\CrowdSimApp.js:255

Get simulation statistics.

Returns:

Object:

stats

init

(
  • canvas
  • options
)

Defined in src\app\CrowdSimApp.js:78

Inicialization of application.

Parameters:

  • canvas Canvas

    to render scene.

  • options Object

isRunning

() Boolean

Defined in src\app\CrowdSimApp.js:205

Gets engine running state.

Returns:

Boolean:

true if running; false otherwise

listExamples

() Array

Defined in src\app\CrowdSimApp.js:320

Get a list of example worlds.

Returns:

Array:

world names

load

(
  • loader
  • loadDefault
)

Defined in src\app\CrowdSimApp.js:344

Load a world.

Parameters:

  • loader String

    JSON structure

  • loadDefault Boolean

    true to load last snapshoot

loadExample

(
  • name
)

Defined in src\app\CrowdSimApp.js:308

Load an example world by its name.

Parameters:

mousedown

(
  • event
)

Defined in src\app\CrowdSimApp.js:620

Stage mouse down event, creation of entities steps

Parameters:

mousedown

(
  • event
)
Boolean

Defined in src\app\CrowdSimApp.js:546

Entity mouse down event.

Parameters:

Returns:

Boolean:

mousemove

(
  • event
)

Defined in src\app\CrowdSimApp.js:648

Entity mouse move event

Parameters:

mousemove

(
  • event
)

Defined in src\app\CrowdSimApp.js:671

Stage mouse move event, helper lines.

Parameters:

mouseout

(
  • event
)

Defined in src\app\CrowdSimApp.js:749

Entity mouse out event.

Parameters:

mouseover

(
  • event
)

Defined in src\app\CrowdSimApp.js:766

Entity mouse over event.

Parameters:

mouseup

(
  • event
)
Boolean

Defined in src\app\CrowdSimApp.js:712

Entity mouse up evenp.

Parameters:

Returns:

Boolean:

mouseup

(
  • event
)

Defined in src\app\CrowdSimApp.js:735

Stage mouse up event.

Parameters:

mousewheel

(
  • event
)

Defined in src\app\CrowdSimApp.js:687

Stage mouse wheel event, zoom and radius change.

Parameters:

onCreateAgents

(
  • agents
)

Defined in src\app\CrowdSimApp.js:366

Callback on create agents.

Parameters:

onCreateEntity

(
  • entity
)

Defined in src\app\CrowdSimApp.js:390

Callback on create entity.

Parameters:

onDestroyAgents

(
  • agents
)

Defined in src\app\CrowdSimApp.js:378

Callback on destroy agents.

Parameters:

onDestroyEntity

(
  • entity
)

Defined in src\app\CrowdSimApp.js:402

Callback on destroy entity.

Parameters:

onStop

(
  • entity
)

Defined in src\app\CrowdSimApp.js:34

Callback on simulation stop.

Parameters:

  • entity Entity

    that triggered the stop

pan

(
  • dx
  • dy
)

Defined in src\app\CrowdSimApp.js:157

Displace scene view.

Parameters:

reset

() Boolean

Defined in src\app\CrowdSimApp.js:245

Resert simulation.

Returns:

Boolean:

true if running; false otherwise

resize

(
  • window
  • width
  • height
)

Defined in src\app\CrowdSimApp.js:128

Resizes the scene.

Parameters:

run

() Boolean

Defined in src\app\CrowdSimApp.js:215

Start simulation.

Returns:

Boolean:

true if running; false otherwise

save

(
  • save
)
String

Defined in src\app\CrowdSimApp.js:295

Save current world.

Parameters:

  • save Boolean

    true to save; false to return String

Returns:

String:

raw

screenToWorld

(
  • x
  • y
)
Vec2

Defined in src\app\CrowdSimApp.js:168

Convert screen to world coordinates.

Parameters:

Returns:

Vec2:

world coordinates

selectEntity

(
  • entity
)

Defined in src\app\CrowdSimApp.js:496

Sets the current selected entitiy.

Parameters:

  • entity Render.Entity

selectEntityById

(
  • id
)

Defined in src\app\CrowdSimApp.js:530

Set the current selected entity by its id

Parameters:

step

() Boolean

Defined in src\app\CrowdSimApp.js:235

Step and stop simulation.

Returns:

Boolean:

true if running; false otherwise

stop

() Boolean

Defined in src\app\CrowdSimApp.js:225

Stop simulation.

Returns:

Boolean:

true if running; false otherwise

toggleRun

() Boolean

Defined in src\app\CrowdSimApp.js:191

Start/stop simulation.

Returns:

Boolean:

true if running; false otherwise

worldToScreen

(
  • x
  • y
)
Vec2

Defined in src\app\CrowdSimApp.js:179

Convert world toscreen coordinates.

Parameters:

Returns:

Vec2:

screen coordinates

zoom

(
  • scale
  • x
  • y
)

Defined in src\app\CrowdSimApp.js:145

Zoom in a position.

Parameters: