Convenient method for defining Node#update.

Convenient method for defining Node#update. Similar to Node#onUpdate, but this method automatically sets the update type to FRAME.

Convenient method for defining Node#update. Similar to Node#onUpdate, but this method automatically sets the update type to RENDER.

Convenient method for defining Node#update. Similar to Node#onUpdate, but this method automatically sets the update type to OBJECT.

Convenient method for defining Node#updateReference.

Nodes might refer to other objects like materials. This method allows to dynamically update the reference to such objects based on a given state (e.g. the current node frame or builder).

By default this method returns the value of the Node#global flag. This method can be overwritten in derived classes if an analytical way is required to determine the global cache referring to the current shader-stage.

Generator function that can be used to iterate over the child nodes.

Calling this method dispatches the dispose event. This event can be used to register event listeners for clean up tasks.

Callback for Node#traverse.

Can be used to traverse through the node’s hierarchy.

Returns the child nodes of this node.

Returns the cache key for this node.

Generate a custom cache key for this node.

Returns the references to this node which is by default this.

Returns the hash of the node which is used to identify the node. By default it’s the Node#uuid however derived node classes might have to overwrite this method depending on their implementation.

Returns the update type of Node#update.

Returns the update type of Node#updateBefore.

Returns the update type of Node#updateAfter.

Certain types are composed of multiple elements. For example a vec3 is composed of three float values. This method returns the type of these elements.

Returns the node member type for the given name.

Returns the node’s type.

Returns the node’s type.

This method is used during the build process of a node and ensures equal nodes are not built multiple times but just once. For example if attribute( 'uv' ) is used multiple times by the user, the build process makes sure to process just the first node. It also handles node overrides if an override context is set.

Returns the number of elements in the node array.

Represents the setup stage which is the first step of the build process, see Node#build method. This method is often overwritten in derived modules to prepare the node which is used as a node’s output/result. If an output node is prepared, then it must be returned in the return statement of the derived module’s setup function.

Represents the analyze stage which is the second step of the build process, see Node#build method. This stage analyzes the node hierarchy and ensures descendent nodes are built.

Represents the generate stage which is the third step of the build process, see Node#build method. This state builds the output node and returns the resulting shader string.

The method can be implemented to update the node’s internal state before it is used to render an object. The Node#updateBeforeType property defines how often the update is executed.

The method can be implemented to update the node’s internal state after it was used to render an object. The Node#updateAfterType property defines how often the update is executed.

The method can be implemented to update the node’s internal state when it is used to render an object. The Node#updateType property defines how often the update is executed.

This method performs the build of a node. The behavior and return value depend on the current build stage:

• setup : Prepares the node and its children for the build process. This process can also create new nodes. Returns the node itself or a variant.
• analyze : Analyzes the node hierarchy for optimizations in the code generation stage. Returns null .
• generate : Generates the shader code for the node. Returns the generated shader string.

Returns the child nodes as a JSON object.

Serializes the node to JSON.

Deserializes the node from the given JSON.

Serializes the node into the three.js JSON Object/Scene format.