API Docs for: 0.3
Show:

Context Class

Extends Entity
Defined in: src\sim\Entities\Context.js:6
Module: Context
Parent Module: Entities

Context entity

Constructor

Context

(
  • context
)

Defined in src\sim\Entities\Context.js:6

Parameters:

Methods

addEntity

(
  • joint
)

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

Description

Parameters:

Returns:

calcNewId

(
  • id
)

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

Description

Parameters:

Returns:

CallExpression

CreateFromModel

(
  • context
)
Render.Context

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

Create context view from context entity.

Parameters:

Returns:

Render.Context:

CreateFromPoint

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

Defined in src\app\Render\Context.js:36

Create context view and context entity.

Parameters:

Returns:

Render.Context:

createGraphics

(
  • context
)

Inherited from Entity but overwritten in src\app\Render\Context.js:61

Create graphics.

Parameters:

destroy

()

Inherited from Entity but overwritten in src\app\Render\Context.js:51

Destroy Context.

destroy

()

Defined in src\sim\Entities\Context.js:27

Destroy the Context

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\Context.js:88

Drag render context.

Parameters:

  • pos Vec2
  • anchor Vec2

Returns:

getAnchor

() Vec2

Defined in src\app\Render\Context.js:77

Get context center for dragging actions.

Returns:

Vec2:

anchor

getContext

() Context

Defined in src\app\Render\Context.js:148

Get context entity.

Returns:

Context:

context

getHeight

() Number

Defined in src\sim\Entities\Context.js:69

Gets height.

Returns:

Number:

height

getMaxXY

() Vec2

Defined in src\sim\Entities\Context.js:91

Gets the context maximun X,Y coordinate.

Returns:

Vec2:

point

getMinXY

() Vec2

Defined in src\sim\Entities\Context.js:79

Gets the context minimum X,Y coordinate.

Returns:

Vec2:

point

getMobility

() Number

Defined in src\sim\Entities\Context.js:146

Get context mobility factor.

Returns:

Number:

getNearestPoint

(
  • point
  • border
)
Vec2

Defined in src\sim\Entities\Context.js:115

Get the nearest point in the context to another.

Parameters:

  • point Vec2
  • border Number

    margin inside the context

Returns:

Vec2:

nearest point in the context to the given point

getPos

() Vec2

Inherited from Entity but overwritten in src\app\Render\Context.js:158

Get context center.

Returns:

Vec2:

position

getRandomPoint

() Vec2

Defined in src\sim\Entities\Context.js:103

Get a random point in the context.

Returns:

Vec2:

point

getTrigger

() Boolean

Defined in src\sim\Entities\Context.js:156

Get context trigger option.

Returns:

Boolean:

true if contexts stops simulation on empty of agents

getWidth

() Number

Defined in src\sim\Entities\Context.js:59

Gets width.

Returns:

Number:

width

in

(
  • pos
)
Boolean

Defined in src\sim\Entities\Context.js:166

Check if a point is inside the context.

Parameters:

  • pos Vec2

Returns:

Boolean:

true if pos is inside

incrSize

(
  • ds
)

Defined in src\sim\Entities\Context.js:48

Increment the context width and height.

Parameters:

  • ds Number

    increment in width and height

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\Context.js:102

Animate context, update position and size.

Parameters:

setArea

(
  • x
  • y
)

Defined in src\sim\Entities\Context.js:36

Sets the context size.

Parameters:

setArea

(
  • x
  • y
)

Defined in src\app\Render\Context.js:137

Set context area, from its center.

Parameters:

setInteractive

(
  • displayObject
)

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

Set render entity as interactive.

Parameters:

  • displayObject Pixi.DisplayObject

updatePos

(
  • x
  • y
)

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

Description

Parameters:

Returns: