Class: PolygonRender

Name	Description	Arguments
load	Renderer is fully initialized and ready to use	None
add	PolygonRender is added to the renderer	None
delete	PolygonRender is removed from the renderer	None

Constructor

new PolygonRender(options) → {PolygonRender}

Creates a PolygonRender for rendering rigid bodies

Parameters:

Name	Type	Description
`options`	Object

Source: render/PolygonRender.js, line 17

Returns:

this

Type:: PolygonRender

Extends

Node

Members

(readonly) nodeType

Type of node, ie Node or RigidBody

Overrides: Node#nodeType
Source: node/Node.js, line 28

(readonly) position :vec

Position of the node

Type:

Overrides: Node#position
Source: node/Node.js, line 36
To Do: Implement getPosition method and make this private

(readonly) angle :number

Angle, in radians

Type:

number

Overrides: Node#angle
Source: node/Node.js, line 43
To Do: Implement getAngle method and make this private

(readonly) children :Set

Children of the node To modify, use addChild or removeChild.

Type:

Overrides: Node#children
Source: node/Node.js, line 50

Methods

setLayer(layer)

Sets the render layer (z index)

Parameters:

Name	Type	Description
`layer`	number	Render layer (z index) for the render

Source: render/PolygonRender.js, line 123

setAlpha(alpha)

Sets the render's alpha

Parameters:

Name	Type	Description
`alpha`	number	Opacity, between 0 and 1 inclusive

Source: render/PolygonRender.js, line 132

setVisible(visible)

Changes if the render is visible

Parameters:

Name	Type	Description
`visible`	boolean	If the render is visible

Source: render/PolygonRender.js, line 141

translate(delta)

Shifts the render's position by delta

Parameters:

Name	Type	Description
`delta`	vec	Position render is shifted

Overrides: Node#translate
Source: render/PolygonRender.js, line 150

translateAngle(angle)

Rotates the render relative to current angle

Parameters:

Name	Type	Description
`angle`	number	Amount to rotate render, in radians

Overrides: Node#translateAngle
Source: render/PolygonRender.js, line 162

add()

Adds the render object to the world

Overrides: Node#add
Source: render/PolygonRender.js, line 171

delete()

Removes the render object from the world

Overrides: Node#delete
Source: render/PolygonRender.js, line 179

destroy()

Destroys the render object. Use when you know the render will no longer be used

Source: render/PolygonRender.js, line 188

on(event, callback)

Binds a function to an event

Parameters:

Name	Type	Description
`event`	"load" \| "add" \| "delete"	Name of the event
`callback`	function	Function called when event fires

Overrides: Node#on
Source: render/PolygonRender.js, line 202

off(event, callback)

Unbinds a function from an event

Parameters:

Name	Type	Description
`event`	"load" \| "add" \| "delete"	Name of the event
`callback`	function	Function bound to event

Overrides: Node#off
Source: render/PolygonRender.js, line 215

trigger(event)

Fires an event

Parameters:

Name	Type	Description
`event`	"load" \| "add" \| "delete"	Name of the event

Overrides: Node#trigger
Source: render/PolygonRender.js, line 225

isAdded() → {Boolean}

Gets if the node is added

Overrides: Node#isAdded
Source: node/Node.js, line 101

Returns:

if the node is added

Type:: Boolean

addChild(…children)

Adds all children to this node's children

Parameters:

Name	Type	Attributes	Description
`children`	Node	<repeatable>	Children added

Overrides: Node#addChild
Source: node/Node.js, line 113

Example

let parentNode = new Node();
let childNode = new Node();
node.addChild(childNode);

removeChild(…children)

Removes all children from this node's children

Parameters:

Name	Type	Attributes	Description
`children`	Node	<repeatable>	Children removed

Overrides: Node#removeChild
Source: node/Node.js, line 127

Example

let parentNode = new Node();
let childNode = new Node();
node.addChild(childNode); // node.children: Set {childNode}
node.removeChild(childNode); // node.children: Set {}

setPosition(position)

Sets this node's position to position

Parameters:

Name	Type	Description
`position`	vec	Position the node should be set to

Overrides: Node#setPosition
Source: node/Node.js, line 139

Example

node.setPosition(new vec(100, 100)); // Sets node's position to (100, 100)

setAngle(angle)

Sets the node's angle to angle

Parameters:

Name	Type	Description
`angle`	number	Angle body should be in radians

Overrides: Node#setAngle
Source: node/Node.js, line 162

Example

node.setAngle(Math.PI); // Sets node's angle to Pi radians, or 180 degrees