A node tree is composed of multiple NodeBlock connected together. These connections will then converted internally to actual Lua or GLSL code internally. It is ideal for non-programmers as they can program visually with ease without the hassle of write any code. Using a node tree allow you to virtually create exactly the same type of code that a more savvy programmer will generate manually.

Scripting node trees can also be debugged the same as code (since basically a node tree will generate code). You can set breakpoints, step over, pause etc... while Ldb will display the code path by highlighting active nodes. For more information please refer to the Node View manual.

Static Variables

Name	Description
`asset`	Parent Asset where the NodeTree is defined.
Declaration Asset *asset Note The asset can be a Shader, a Script or an Utility.
`nodeblock_count`	Total amount of NodeBlock connected to the active NodeTree.
Declaration unsigned short nodeblock_count
`group_count`	Current amount of NodeGroup associated with the current NodeTree.
Declaration unsigned char group_count
`comment_count`	Number of Comment blocks maintained by the NodeTree.
Declaration unsigned char comment_count

Variables

Name Description

flags Bit mask generated out of NodeTree flags.

Declaration

unsigned int revision

Note: Manually changing the NodeTree revision force an automatic update of an open NodeTree in the Node Editor.

Functions

Name	Description
`Clear`	Clear the NodeTree and remove all NodeBlock, NodeGroup and Comment.
Declaration void Clear( void )
`AddPlug`	Add a new NodePlug to the current NodeTree.
Declaration NodeBlock AddNodeBlock( const char catalog, const char name ) Parameters* `catalog`: The current catalog the NodeBlock belongs to. `name`: The code identifier to use for the new NodeBlock. Return Value A new NodeBlock reference that is attached to the current NodeTree.
`GetNodeBlockIndex`	Retrieve the current internal index of an existing NodeBlock connected to the active NodeTree.
Declaration int GetNodeBlockIndex( const NodeBlock nodeblock ) Parameters* `nodeblock`: A valid NodeBlock reference. Return Value `-1` if the reference is invalid; else return the index of the NodeBlock.
`SetNodeBlockIndex`	.
Declaration bool SetNodeBlockIndex( NodeBlock nodeblock, const unsigned short index ) Parameters* `nodeblock`: A valid NodeBlock reference. `index`: The new index where the NodeBlock should be placed. Return Value `true` on sucess; `false` if the reference is invalid or if the index is out of bounds (or equal to the current NodeBlock index).
`GetNodeBlockAt`	Retrieve a specific NodeBlock using its index as key.
Declaration NodeBlock GetNodeBlockAt( unsigned short index ) Parameters* `index`: The internal index of the NodeBlock to retrieve. Return Value An existing NodeBlock reference, `nil` if the index is invalid.
`RemoveNodeBlock`	Remove a specific NodeBlock.
Declaration bool RemoveNodeBlock( NodeBlock nodeblock ) Parameters* `nodeblock`: The NodeBlock reference to remove. Return Value `true` if the operation is successfull; `false` if the NodeBlock reference is invalid.
`RemoveNodeBlockAt`	Remove a NodeBlock at a specific index.
Declaration bool RemoveNodeBlockAt( int index ) Parameters `index`: Internal index of the NodeBlock to remove. Return Value `true` on success; return `false` if the index is out of bounds.
`AddNodeGroup`	Create a new NodeGroup and attach it to the active NodeTree.
Declaration NodeGroup AddNodeGroup( const char name ) Parameters `name`: A name to identify the new NodeGroup within the active NodeTree. Return Value A new NodeGroup reference.
`GetNodeGroup`	Retrieve a specific NodeGroup using its name as key.
Declaration NodeGroup GetNodeGroup( const char name ) Parameters `name`: The name of the NodeGroup to retrieve. Return Value The reference of NodeGroup associated to the name received in parameter.
`GetNodeGroupAt`	Retrieve a NodeGroup using its internal index.
Declaration NodeGroup GetNodeGroupAt( unsigned char index ) Parameters* `index`: Index of the NodeGroup to retrieve. Return Value The NodeGroup reference located at the index received in parameter; else return `nil` if the index is innexistent.
`GetNodeGroupIndex`	Get the index of a specific NodeGroup.
Declaration int GetNodeGroupIndex( const NodeGroup group ) Parameters* `group`: Reference to an existing NodeGroup maintained by the NodeTree. Return Value The current index of the NodeGroup; else return `-1` if the reference is invalid.
`RemoveNodeGroup`	Remove an existing NodeGroup from the NodeTree.
Declaration bool RemoveNodeGroup( NodeGroup group ) Parameters* `group`: Reference to the NodeGroup to remove. Return Value `true` on success; `false` if the reference cannot be found within the active NodeTree.
`RemoveNodeGroupAt`	Remove a NodeGroup using its index as key.
Declaration bool RemoveNodeGroupAt( int index ) Parameters `index`: Index of the NodeGroup to remove. Return Value `true` on success; `false` if the index is invalid.
`AddComment`	Add a new Comment to the NodeTree.
Declaration Comment AddComment( const char string, const vec4 bounds ) Parameters `string`: Comment line for the user. `bounds`: The location (`XY`) of the comment as well as its dimension (`Z`=width, `W`=height). Return Value A new Comment reference connected to the active NodeTree. Note This variant of the `AddComment` function will create a white Comment box. To specify a custom color see the next function listed below.
`AddComment`	Add a new Comment to the NodeTree (with custom color).
Declaration Comment AddComment( const char string, const vec4 bounds, const vec4 color ) Parameters `string`: Comment line for the user. `bounds`: The location (`XY`) of the comment as well as its dimension (`Z`=width, `W`=height). `color`: A color to visually identify the Comment within the Node Editor. Return Value A new Comment reference connected to the active NodeTree.
`GetCommentAt`	Retrive an existing Comment by index.
Declaration Comment GetCommentAt( unsigned char index ) Parameters* `index`: Index of the Comment to retrieve. Return Value A valid Comment reference on success; else return `nil` in the event that the index is invalid.
`GetCommentIndex`	Return the index of a Comment reference.
Declaration int GetCommentIndex( const Comment comment ) Parameters* `comment`: Reference to an existing Comment. Return Value `-1` if the reference is invalid; else return the internal list index of the Comment.
`RemoveComment`	Remove an existing Comment from the NodeTree.
Declaration bool RemoveComment( Comment comment ) Parameters* `comment`: The Comment reference to remove. Return Value `false` if the operation fails due to an invalid reference; else return `true` on success.
`RemoveCommentAt`	Remove an existing Comment by index.
Declaration bool RemoveCommentAt( int index ) Parameters `index`: Index of the Comment to remove. Return Value `true` if the Comment have been removed successfully; else return `false`.
`RemoveComment`	Return the index of the next root NodeBlock after the index specified.
Declaration int GetNextRoot( unsigned short index ) Parameters `index`: The starting NodeBlock index position to start the search. Return Value `-1` if no other root NodeBlock exists after the index specified; else return the index of the next root block.
`GetPrevRoot`	Return the index of the previous root NodeBlock before the index specified.
Declaration int GetPrevRoot( unsigned short index ) Parameters `index`: The starting NodeBlock index position to start the search. Return Value `-1` if no other root NodeBlock exists before the index specified; else return the index of the previous root block.