Unigine.NodeExternBase Class

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 isOwner()

Returns the owner flag of the pointer. If the pointer is owner, on its deletion the object also will be deleted.

Return value

The owner flag.

void grab()

Sets the owner flag to 1 for the node pointer. The node should not be handled by the class after this function is called.

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 release()

Sets the owner flag to 0 for the node pointer. The node should be handled by the class after this function is called.

void renderHandler()

Renders the handler for the custom user-defined node.

void renderVisualizer()

Renders the visualizer for the custom user-defined node.

int restoreState(Stream stream)

Restores a node state from the stream.

Arguments

• Stream stream - Stream smart pointer.

Return value

Returns 1 if the node state was successfully restored; otherwise, 0 is returned.

int saveState(Stream stream)

Saves a node state into the stream.

Arguments

• Stream stream - Stream smart pointer.

Return value

Returns 1 if the node state was successfully saved; otherwise, 0 is returned.

int saveWorld(Xml xml)

Saves a node state into the Xml.

Arguments

• Xml xml - Xml smart pointer.

Return value

Returns 1 if the node state was successfully saved; otherwise, 0 is returned.

void updateEnabled()

Updates enabled.

void updatePosition()

Updates a position of the custom node.

void updateTransform()

Updates transformation matrix of the custom node.