API Docs for: 0.3
Show:

Grid Class

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

Grid hashmap to store entities indexed by their position.

Constructor

Grid

(
  • near
)

Defined in src\sim\Common\Grid.js:5

Parameters:

  • near Number

    is the cell size for the hashmap. Also the maximum distance to be consider "neighbours"

Methods

_key

(
  • entity
  • x
  • y
)
String

Defined in src\sim\Common\Grid.js:207

Build the key to map coordinates to the hashmap.

Parameters:

  • entity Entity
  • x Number

    coordinate, if null entity.pos[0] is used

  • y Number

    coordinate, if null entity.pos[1] is used

Returns:

String:

key

_keyNeighbours

(
  • x
  • y
)
Array

Defined in src\sim\Common\Grid.js:189

Builds the keys of the neighbours of the position (x,y).

Parameters:

Returns:

Array:

neighbours keys

clear

()

Defined in src\sim\Common\Grid.js:124

Clear the hashmap.

insert

(
  • entities
)

Defined in src\sim\Common\Grid.js:19

Insert entities in the hashmap.

Parameters:

insertOne

(
  • entity
  • x
  • y
)

Defined in src\sim\Common\Grid.js:37

Insert one entity.

Parameters:

  • entity Entity
  • x Number

    coordinate, if null entity.pos[0] is used

  • y Number

    coordinate, if null entity.pos[1] is used

neighbours

(
  • entity
  • x
  • y
)
LazySequence

Defined in src\sim\Common\Grid.js:149

Gets neighbours to (x,y) point or Entity.

Parameters:

  • entity Entity
  • x Number

    coordinate, if null entity.pos[0] is used

  • y Number

    coordinate, if null entity.pos[1] is used

Returns:

LazySequence:

neighbours

neighboursContext

(
  • context
)
LazySequence

Defined in src\sim\Common\Grid.js:169

Gets neighbours to a context by sampling its position with the cell size.

Parameters:

Returns:

LazySequence:

neighbours

remove

(
  • entities
)

Defined in src\sim\Common\Grid.js:133

Remove the given entities.

Parameters:

update

(
  • entities
)

Defined in src\sim\Common\Grid.js:113

Update given entities mapping.

Parameters:

updateAll

(
  • entities
)

Defined in src\sim\Common\Grid.js:102

Clear the hashamp and insert entities.

Parameters:

updateContextsHelper

(
  • contexts
)

Defined in src\sim\Common\Grid.js:54

Helper to update multiple contexts area points by sampling their area with the cell size.

Parameters:

updateWallsHelper

(
  • walls
)

Defined in src\sim\Common\Grid.js:75

Helper to update multiple walls area points by sampling their path with the cell size.

Parameters: