On this page

RenderNode

Render node is a logical part of a render mechanism. Represents scene rendering. For example one scene node for rendering the Earth, another one for rendering the Moon, another node for rendering stars etc. Each render node has own model view space defined with matrices(scale, rotation, translation, transformation). There are collections of light sources, entities and so on in the node. Access to the node is renderer.renderNodes["Earth"]

Constructor

new RenderNode(name)

Parameters:

Name	Type	Description
`name`	string	Node name.

Source: scene/RenderNode.ts, line 6

Extends

BaseNode

Methods

(protected) _clear()

Clear current node.

Overrides: BaseNode#_clear
Source: scene/BaseNode.ts, line 100

addEntityCollection(entityCollection, isHiddenopt) → {RenderNode}

Adds entity collection.

Parameters:

Name	Type	Attributes	Description
`entityCollection`	EntityCollection		Entity collection.
`isHidden`	boolean	<optional>	If it's true that this collection has specific rendering.

Source: scene/RenderNode.ts, line 152

Returns:

Type:: RenderNode

addLight(light) → {RenderNode}

Adds point light source.

Parameters:

Name	Type	Description
`light`	LightSource	Light source.

Source: scene/RenderNode.ts, line 173

Returns:

Type:: RenderNode

addNode()

Adds node to the current hierarchy.

Overrides: BaseNode#addNode
Source: scene/RenderNode.ts, line 90

assign(renderer)

Assign render node with renderer.

Parameters:

Name	Type	Description
`renderer`	Renderer	Render node's renderer.

Source: scene/RenderNode.ts, line 100

destroy()

Destroy node.

Overrides: BaseNode#destroy
Source: scene/BaseNode.ts, line 79

drawNode()

Calls render frame node's callback. Used in renderer.

Source: scene/RenderNode.ts, line 213

drawPickingEntityCollections(ec)

Draw entity collections picking frame.

Parameters:

Name	Type	Description
`ec`	Array.<EntityCollection>	Entity collection array.

Source: scene/RenderNode.ts, line 349

getLightByName(name) → {LightSource}

Gets light object by its name.

Parameters:

Name	Type	Description
`name`	string	Point light name.

Source: scene/RenderNode.ts, line 184

Returns:

Type:: LightSource

getNodeByName(name) → {RenderNode}

Gets node by name in the current.

Parameters:

Name	Type	Description
`name`	string	Node name.

Overrides: BaseNode#getNodeByName
Source: scene/BaseNode.ts, line 90

Returns:

Node object in the current node.

Type:: RenderNode

isActive() → {Boolean}

Gets render node activity.

Source: scene/RenderNode.ts, line 221

Returns:

Type:: Boolean

preDrawNode()

Calls render frame node's callback. Used in renderer.

Source: scene/RenderNode.ts, line 213

removeEntityCollection(entityCollection)

Removes entity collection.

Parameters:

Name	Type	Description
`entityCollection`	EntityCollection	Entity collection for remove.

Source: scene/RenderNode.ts, line 164

removeLight(light)

Removes light source.

Parameters:

Name	Type	Description
`light`	LightSource	Light source object.

Source: scene/RenderNode.ts, line 195

setActive(isActive)

Rendering activation.

Parameters:

Name	Type	Description
`isActive`	boolean	Activation flag.

Source: scene/RenderNode.ts, line 230

setDrawMode(mode)

Sets draw mode

Parameters:

Name	Type	Description
`mode`	Number	Draw mode, such as gl.TRIANGLES, gl.TRIANGLE_STRIP, gl.LINES etc.

Source: scene/RenderNode.ts, line 257

transformLights()

IMPORTANT: This function have to be called manually in each render node frame callback, before drawing scene geometry.

Source: scene/RenderNode.ts, line 269