API Docs for: 0.3
Show:

Joint Class

Extends Entity
Defined in: src\sim\Entities\Helpers\Joint.js:4
Module: Joint
Parent Module: Entities

Joint helper entity children of Wall and Path

Constructor

Joint

(
  • joint
  • texture
)

Defined in src\sim\Entities\Helpers\Joint.js:4

Parameters:

  • joint Joint
  • texture Pixi.Texture

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

createGraphics

(
  • graphics
)

Inherited from Entity but overwritten in src\app\Render\Joint.js:41

Create base graphics.

Parameters:

  • graphics Pixi.Graphics

destroy

(
  • graphics
)

Inherited from Entity but overwritten in src\app\Render\Joint.js:27

Destroy base graphics.

Parameters:

  • graphics Pixi.Graphics

destroy

()

Defined in src\sim\Entities\Helpers\Joint.js:26

Destroy the Joint

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\Joint.js:89

Draggin actino.

Parameters:

  • pos Vec2
  • anchor Vec2

getAnchor

() Vec2

Defined in src\app\Render\Joint.js:79

Get joint anchor for dragging actions.

Returns:

Vec2:

anchor

getJoint

() Joint

Defined in src\app\Render\Joint.js:109

Get joint associated entity.

Returns:

Joint:

joint

getPos

() Vec2

Inherited from Entity but overwritten in src\app\Render\Joint.js:119

Get joint position.

Returns:

Vec2:

position

getRadius

() Number

Defined in src\sim\Entities\Helpers\Joint.js:37

Get radius

Returns:

Number:

radius

in

(
  • pos
)
Boolean

Defined in src\sim\Entities\Helpers\Joint.js:47

Checks if a point is inside a joint.

Parameters:

  • pos Vec2

Returns:

Boolean:

true if inside; false otherwise

incrRadius

(
  • dr
)

Defined in src\sim\Entities\Helpers\Joint.js:71

Increment radius.

Parameters:

removeEntity

(
  • joint
)

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

Description

Parameters:

Returns:

render

()

Inherited from Entity but overwritten in src\app\Render\Joint.js:62

Animate joint, update position and radius.

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\Helpers\Joint.js:59

Set radius.

Parameters:

show

(
  • show
)

Defined in src\app\Render\Joint.js:129

Shows or hides render joint.

Parameters:

updatePos

(
  • x
  • y
)

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

Description

Parameters:

Returns: