Unigine.NodeExternBase Class
| Inherits from: | Base |
The base class that is used to implement logic of custom user-defined nodes. The custom node class should be inherited from NodeExternBase.
NodeExternBase Class
Members
int GetClassID ( ) #
Returns a unique class ID.Return value
Unique class ID.Node GetNode ( ) #
Returns the Node instance.Return value
Node.NodeExtern GetNodeExtern ( ) #
Returns the NodeExtern instance that is created on loading the custom node.Return value
NodeExtern.int LoadWorld ( Xml xml ) #
Loads a node state from the Xml.Arguments
- Xml xml - Xml smart pointer.
Return value
Returns 1 if the node state was successfully loaded; otherwise, 0 is returned.void RenderHandler ( ) #
Renders the handler for the custom user-defined node.void RenderVisualizer ( ) #
Renders the visualizer for the custom user-defined node.Notice
You should enable the engine visualizer by the show_visualizer 1 console command.
bool SaveState ( Stream stream ) #
Saves a node state into the stream.Saving into the stream requires creating a blob to save into. To restore the saved state the RestoreState() method is used:
Source code (C#)
// initialize a node and set its state
//...//
// save state
Blob blob_state = new Blob();
node.SaveState(blob_state);
// change the node state
//...//
// restore state
blob_state.SeekSet(0); // returning the carriage to the start of the blob
node.RestoreState(blob_state);Arguments
- Stream stream - Stream smart pointer.
Return value
true on success; otherwise, false.bool RestoreState ( Stream stream ) #
Restores a node state from the stream.Restoring from the stream requires creating a blob to save into and saving the state using the SaveState() method:
Source code (C#)
// initialize a node and set its state
//...//
// save state
Blob blob_state = new Blob();
node.SaveState(blob_state);
// change the node state
//...//
// restore state
blob_state.SeekSet(0); // returning the carriage to the start of the blob
node.RestoreState(blob_state);Arguments
- Stream stream - Stream smart pointer.
Return value
true on success; otherwise, false.int SaveWorld ( Xml xml ) #
Saves a node state into the Xml.Arguments
- Xml xml - Xml smart pointer.
Return value
1 if the node state was successfully saved; otherwise, 0 is returned.void UpdateEnabled ( ) #
Updates enabled.void UpdateTransform ( ) #
Updates transformation matrix of the custom node.Last update:
2023-07-11
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)