A node group allows you to create a folder that contains multiple NodeBlock. Once connected all blocks can be selected or deselected all at once. Additionally, a unique color can be specified to visually identify all NodeBlock that belongs to the same group inside the editor.
See Also
Static Variables
Variables
Functions
Name | Description |
AddNodeBlock | Attach a new NodeBlock to the active NodeGroup. |
Declaration bool AddNodeBlock( NodeBlock *nodeblock ) Parameters
Return Value
true if the NodeBlock have been connected successfully; false if the reference is invalid or if it does not belong to the same NodeTree.
|
GetNodeBlockAt | Retrieve a NodeBlock reference from the current NodeGroup using its index as key. |
Declaration NodeBlock *GetNodeBlockAt( unsigned char index ) Parameters
Return Value
A valid NodeBlock reference; else return nil if the index is out of bounds.
|
GetNodeBlockIndex | Get the internal index of a NodeBlock stored in the current NodeGroup. |
Declaration int GetNodeBlockIndex( const NodeBlock *nodeblock ) Parameters
Return Value
-1 if the nodeblock reference cannot be found in the current NodeGroup; else return the internal index of the NodeBlock maintained by the NodeGroup.
|
RemoveNodeBlock | Disconnect a NodeBlock from the current NodeGroup. |
Declaration bool RemoveNodeBlock( NodeBlock *nodeblock ) Parameters
nodeblock : The NodeBlock reference to disconnect.
Return Value
true on sucess; false if the NodeBlock reference is inexistent.
|
ConnectLink | Create a new NodeInput and attach it to the current NodeGroup. |
Declaration bool RemoveNodeBlockAt( int index ) Parameters
index : Internal index of the NodeBlock to disconnect.
Return Value
true on success; return false if the index is invalid.
|
IsSelected | Determine if all NodeBlock associated to the active NodeGroup are selected. |
Declaration Parameters
nodeblock : The NodeBlock reference to disconnect.
Return Value
true if all NodeBlock references are marked as selected; else return false .
|