API Docs for: 0.3
Show:

Group Class

Extends Entity
Defined in: src\sim\Entities\Group.js:11
Module: Group
Parent Module: Entities

Group Entity where agents belong.

Constructor

Group

(
  • group
)

Defined in src\sim\Entities\Group.js:11

Parameters:

Methods

addAgent

(
  • agent
)

Defined in src\sim\Entities\Group.js:350

Adds a single agent to the group.

Parameters:

addAgents

(
  • agentsCount
)

Defined in src\sim\Entities\Group.js:303

Add agents to the group.

Parameters:

  • agentsCount Number

    the number of agents

addEntity

(
  • joint
)

Inherited from Entity: src\sim\Entities\Entity.js:70

Description

Parameters:

Returns:

assignBehavior

(
  • behavior
)

Defined in src\sim\Entities\Group.js:222

Assign a behavior model to the group.

Parameters:

assignEndContext

(
  • context
)

Defined in src\sim\Entities\Group.js:121

Sets the end context where agents are destroyed.

Parameters:

assignPath

(
  • path
  • idx
)

Defined in src\sim\Entities\Group.js:147

Assign a path to the group and its agents.

Parameters:

assignStartContext

(
  • context
)

Defined in src\sim\Entities\Group.js:95

Sets the start context where agents are created

Parameters:

calcNewId

(
  • id
)

Inherited from Entity: src\sim\Entities\Entity.js:35

Description

Parameters:

Returns:

CallExpression

CreateFromModel

(
  • group
)
Render.Group

Defined in src\app\Render\Group.js:25

Create a group render view from a group entity.

Parameters:

Returns:

Render.Group:

CreateFromPoint

(
  • x
  • y
  • parent
  • options
)
Render.Group

Defined in src\app\Render\Group.js:35

Create a group render and entity in a point.

Parameters:

Returns:

Render.Group:

createGraphics

(
  • group
)

Inherited from Entity but overwritten in src\app\Render\Group.js:60

Create base graphics for group.

Parameters:

destroy

()

Inherited from Entity but overwritten in src\app\Render\Group.js:50

Destroy render group.

destroy

()

Defined in src\sim\Entities\Group.js:38

Destroy the Group

destroyGraphics

(
  • container
  • graphics
)

Inherited from Entity: src\app\Render\Entity.js:55

Destroy base graphics.

Parameters:

  • container Pixi.Container
  • graphics Pixi.Graphics

dragTo

(
  • pos
  • anchor
)

Defined in src\app\Render\Group.js:141

Drag action in groups.

Parameters:

  • pos Vec2
  • anchor Vec2

emptyAgents

()

Defined in src\sim\Entities\Group.js:315

Removes all agents from the group.

generateAgents

(
  • agentsCount
  • startContext
)

Defined in src\sim\Entities\Group.js:232

Generate a number of agents in a context. Used internally by the group.

Parameters:

Returns:

newAgents

getAnchor

() Vec2

Defined in src\app\Render\Group.js:130

Get render group anchor.

Returns:

Vec2:

anchor

getArea

() Array

Defined in src\sim\Entities\Group.js:360

Gets the smaller rectangle area that contains the group agents

Returns:

Array:

array of two {Vec2} [[Xmin,Xmax][Ymin,YMax]]

getEndContext

() Context

Defined in src\sim\Entities\Group.js:111

Gets the start context where agents are created

Returns:

Context:

end context

getGroup

() Group

Defined in src\app\Render\Group.js:164

Get associated group entity.

Returns:

Group:

getPath

() Array

Defined in src\sim\Entities\Group.js:137

Gets the path asigned to the group that agents will follow.

Returns:

Array:

paths

getPathStartIdx

() Number

Defined in src\sim\Entities\Group.js:188

Gets the start index of the agents in the group path.

Returns:

Number:

start index

getPos

() Vec2

Inherited from Entity but overwritten in src\app\Render\Group.js:154

Get group position.

Returns:

Vec2:

position

getRadius

() Number

Defined in src\sim\Entities\Group.js:55

Get radius

Returns:

Number:

radius

getStartContext

() Context

Defined in src\sim\Entities\Group.js:85

Gets the end context where agents are destoyed optionally.

Returns:

Context:

end context

in

(
  • pos
)
Boolean

Defined in src\sim\Entities\Group.js:339

Check if am agent is within a group area.

Parameters:

  • pos Vec2

Returns:

Boolean:

true if inside; false otherwise

incrRadius

(
  • dr
)

Defined in src\sim\Entities\Group.js:75

Increment radius by dr.

Parameters:

isPathCircular

() Boolean

Defined in src\sim\Entities\Group.js:178

Gets the flag pathCircular from options.

Returns:

Boolean:

true if path is circular

isPathReverse

() Boolean

Defined in src\sim\Entities\Group.js:168

Gets the flag pathReverse from options.

Returns:

Boolean:

true if path is reversed

myContextPos

() Vec2

Defined in src\sim\Entities\Group.js:264

Generates a position within the group start context.

Returns:

Vec2:

point

myInitPos

(
  • pos
)
Vec2

Defined in src\sim\Entities\Group.js:251

Generates a random init position in the group radius centered at pos.

Parameters:

  • pos Vec2

    center position

Returns:

Vec2:

point

removeAgents

(
  • agents
)

Defined in src\sim\Entities\Group.js:325

Remove the given agents from the group.

Parameters:

removeEntity

(
  • joint
)

Inherited from Entity: src\sim\Entities\Entity.js:79

Description

Parameters:

Returns:

render

(
  • options
)

Inherited from Entity but overwritten in src\app\Render\Group.js:76

Animate group, update position and radius.

Parameters:

Returns:

setInteractive

(
  • displayObject
)

Inherited from Entity: src\app\Render\Entity.js:71

Set render entity as interactive.

Parameters:

  • displayObject Pixi.DisplayObject

setRadius

(
  • radius
)

Defined in src\sim\Entities\Group.js:65

Set radius

Parameters:

step

()

Defined in src\sim\Entities\Group.js:379

Advances the simulation of the group by creating/destroying agents in its contexts.

unAssign

(
  • entity
)

Defined in src\sim\Entities\Group.js:198

Unassing a start, end contexts or a path from the group.

Parameters:

  • entity Entity

    , context or path.

updatePos

(
  • x
  • y
)

Inherited from Entity: src\sim\Entities\Entity.js:57

Description

Parameters:

Returns: