three.js/docs/pages/ContextNode.html.md

Inheritance: EventDispatcher → Node →

ContextNode

This node can be used as a context management component for another node. NodeBuilder performs its node building process in a specific context and this node allows the modify the context. A typical use case is to overwrite getUV() e.g.:

Code Example

node.context( { getUV: () => customCoord } );
\// or
material.contextNode = context( { getUV: () => customCoord } );
\// or
renderer.contextNode = context( { getUV: () => customCoord } );
\// or
scenePass.contextNode = context( { getUV: () => customCoord } );

Constructor

new ContextNode( node : Node, value : Object )

Constructs a new context node.

node

The node whose context should be modified.

Default is null.

value

The modified context data.

Default is {}.

Properties

.isContextNode : boolean (readonly)

This flag can be used for type testing.

Default is true.

.node : Node

The node whose context should be modified.

.value : Object

The modified context data.

Default is {}.

Methods

.getFlowContextData() : Object

Gathers the context data from all parent context nodes.

Returns: The gathered context data.

.getMemberType( builder : NodeBuilder, name : string ) : string

This method is overwritten to ensure it returns the member type of ContextNode#node.

builder

The current node builder.

name

The member name.

Overrides: Node#getMemberType

Returns: The member type.

.getNodeType( builder : NodeBuilder ) : string

This method is overwritten to ensure it returns the type of ContextNode#node.

builder

The current node builder.

Overrides: Node#getNodeType

Returns: The node type.

.getScope() : Node

This method is overwritten to ensure it returns the reference to ContextNode#node.

Overrides: Node#getScope

Returns: A reference to ContextNode#node.

Source

src/nodes/core/ContextNode.js