Node Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Creating a Node#

The Node class doesn't provide creating of a node. You can create an instance of any class inherited from the Node class and then operate it as it is an instance of the Node class.

NoticeOnly UnigineScript provides such option. For C++ and C#, see the corresponding version of the article.

For example:

Use a mesh-file to create an instance of the ObjectMeshStatic class. This class is inherited from the Node class.
Operate the ObjectMeshStatic instance as a node.

Source code (UnigineScript)

// unigine_project.cpp

#include <core/unigine.h>

int init() {
	// create an instance of any class inherited from the Node class (e.g. ObjectMeshStatic)
	ObjectMeshStatic object_mesh = new ObjectMeshStatic("core/meshes/box.mesh");

	// operate the ObjectMeshStatic as a node

	return 1;
}

Editing a Node and Saving Changes#

The Node class contains common settings of the node. Also each node has special settings, which vary depending on the type of the node.

NoticeThe special settings of a node can be found in the article on the corresponding class.

Editing the node also includes editing materials and properties assigned to the node.

For the edited node to be saved in the .world file, you should enable the corresponding option via the setSaveToWorldEnabled() method.

NoticeThe node shall be saved to a *.world file only if this option is enabled for all of its ancestors as well.

For example:

Create a box mesh by using the Mesh class.
Save the mesh on the disk. It is required as the node we are going to export need to reference to a mesh stored on the disk.
Use the saved .mesh file to create an instance of the ObjectMeshDynamic class. This class is inherited from the Node class.
Edit the node and then save the world by calling the world_saveconsole command.

Source code (UnigineScript)

// unigine_project.cpp

#include <core/unigine.h>

int init() {

	// create a mesh
	Mesh mesh = new Mesh();
	mesh.addBoxSurface("box_0", vec3(1.0f));
	// save a mesh into a file on the disk
	mesh.save("unigine_project/meshes/my_mesh.mesh");
	// create an instance of any class inherited from the Node class (e.g. ObjectMeshDynamic)
	ObjectMeshDynamic object_mesh = new ObjectMeshDynamic("unigine_project/meshes/my_mesh.mesh");

	// change the node name
	object_mesh.setName("my_node");
	// change node transformation
	object_mesh.setWorldTransform(translate(Vec3(0.0f, 0.0f, 2.0f)));

	// save node changes in the .world file
	engine.console.run("world_save");
	
	return 1;
}

Exporting and Importing a Node#

To export a node stored in the world into the external .node file, you should pass it to the saveNode() method of the World class.

To import the existing node stored in the .node file to the world, you should call the loadNode() method of the World class.

For example:

Create a box mesh by using the Mesh class.
Save the mesh on the disk. It is required as the node we are going to export need to reference to a mesh stored on the disk.
Use the saved .mesh file to create an instance of the ObjectMeshStatic class. This class is inherited from the Node class.
Export the node to an external .node file.
Import the previously exported node and add it to the editor to check the result.

Source code (UnigineScript)

// unigine_project.cpp

#include <core/unigine.h>

int init() {

	// create a mesh
	Mesh mesh = new Mesh();
	mesh.addBoxSurface("box_0", vec3(1.0f));
	// save a mesh into a file on the disk
	mesh.save("unigine_project/meshes/my_mesh.mesh");
	// create an instance of any class inherited from the Node class (e.g. ObjectMeshStatic)
	ObjectMeshStatic object_mesh = new ObjectMeshStatic("unigine_project/meshes/my_mesh.mesh");

	// export the node into a .node file
	engine.world.saveNode("unigine_project/nodes/my_node.node",object_mesh);
	// import the exported node to check the result
	Node imported_node = engine.world.loadNode("unigine_project/nodes/my_node.node");

	// set a position of the node
	imported_node.setPosition(Vec3(4.0f, 0.0f, 1.0f));
	
	return 1;
}

Deleting a Node#

By default each new node's lifetime matches the lifetime of the World (i.e. such node shall be deleted when the world is closed). But you can also choose node's lifetime to be managed:

by the Engine - is this case the node shall be deleted automatically on Engine shutdown.
manually - is this case the node should be deleted manually by the user.

To delete a node you can use the following two methods:

deleteLater() - performs delayed deletion, in this case the object will be deleted during the next swap stage of the main loop (rendering of the object ceases immediately, but it still exists in memory for a while, so you can get it from its parent, for example). This method simplifies object deletion from a secondary thread, so you can call it and forget about the details, letting the Engine take control over the process of deletion, which can be used for future optimizations.
deleteForce() - performs immediate deletion, which might be necessary in some cases. Calling this method for main-loop-dependent objects (e.g., nodes) is safe only when performed from the Main thread.

Source code (UnigineScript)

// unigine_project.cpp

#include <core/unigine.h>

int init() {
	// create an instance of any class inherited from the Node class (e.g. ObjectMeshStatic)
	ObjectMeshStatic object_mesh = new ObjectMeshStatic("core/meshes/box.mesh");

	// do something with the node
	// ...

	// delete the node from the editor
	engine.editor.removeNode(object_mesh);

	return 1;
}

Methods:

Name	Description View: Sort by:
getGeodeticPivot	Returns the current pointer to geodetic pivot of the node.
setVariable	Setter and Getter for value of the single unnamed variable parameter of the node.
getVariable
setWorldScale	Setter and Getter for node scale in the world space.
getWorldScale	Setter and Getter for node scale in the world space.
setWorldPosition	Setter and Getter for node position in the world coordinates.
getWorldPosition
setScale	Setter and Getter for scale of the node.
getScale	Setter and Getter for scale of the node.
setPosition	Setter and Getter for node position.
getPosition	Setter and Getter for node position.
getBodyAngularVelocity	Returns the current angular velocity of the node's physical body in the world space.
getBodyLinearVelocity	Returns the current linear velocity of the node's physical body in the local space.
getObjectBodyRigid	Returns the current rigid body assigned to the node if it is an object node.
getObjectBody	Returns the current physical body assigned to the node if it is an object node.
getWorldBoundSphere	Returns the current bounding sphere of the node in world's coordinate system.
getWorldBoundBox	Returns the current bounding box of the node in world's coordinate system.
getBoundSphere	Returns the current bounding sphere of the node.
getBoundBox	Returns the current bounding box of the node.
setOldWorldTransform	Setter and Getter for old (previous frame) transformation matrix for the node in the world coordinates.
getOldWorldTransform
setWorldTransform	Setter and Getter for transformation matrix of the node in the world coordinates.
getWorldTransform
setTransform	Setter and Getter for transformation matrix of the node in its parent coordinates.
getTransform
getNumProperties	Returns the current total number of properties associated with the node.
getPossessor	Returns the current possessor of the node.
getNumChildren	Returns the current number of children of the node.
getRootNode	Returns the current root node for the node.
setParent	Setter and Getter for parent of the node.
getParent	Setter and Getter for parent of the node.
getNumAncestors	Returns the current number of ancestors of the node.
setName	Setter and Getter for name of the node.
getName	Setter and Getter for name of the node.
setQuery	Setter and Getter for value indicating if occlusion query is used for the node.
isQuery
setClutterInteractionEnabled	Setter and Getter for value indicating if interaction with World Clutters and Mesh Clutters is enabled for the node.
isClutterInteractionEnabled
setGrassInteractionEnabled	Setter and Getter for value indicating if interaction with Grass nodes is enabled for the node.
isGrassInteractionEnabled
setTriggerInteractionEnabled	Setter and Getter for value indicating if interaction with WorldTrigger nodes is enabled for the node.
isTriggerInteractionEnabled
setImmovable	Setter and Getter for value indicating if the node is an immovable (clutter) object, which means it is moved to a separate spatial tree for immovable (static) objects optimizing node management.
isImmovable
setHandled	Setter and Getter for value indicating if the node handle is displayed.
isHandled
setEnabled	Setter and Getter for value indicating if the node and its parent nodes are enabled.
isEnabled
isExtern	Returns the current value indicating if the node is an extern node (its type is one of the following: NODE_EXTERN, OBJECT_EXTERN, WORLD_EXTERN).
isField	Returns the current value indicating if the node is a field node (its type is one of the FIELD_*).
isParticlesField	Returns the current value indicating if the node is a particles field node (its type is one of the PARTICLES_FIELD_*).
isSound	Returns the current value indicating if the node is a sound node (its type is SOUND_*).
isObstacle	Returns the current value indicating if the node is an obstacle node (its type is OBSTACLE_*).
isNavigation	Returns the current value indicating if a given node is a navigation node.
isPhysical	Returns the current value indicating if the node is a physical node (its type is PHYSICAL_*).
isPlayer	Returns the current value indicating if the node is a player node (its type is PLAYER_*).
isObject	Returns the current value indicating if the node is an object node (its type is OBJECT_*).
isDecal	Returns the current value indicating if the node is a decal node (its type is DECAL_*).
isLight	Returns the current value indicating if the node is a light source (its type is LIGHT_*).
isGeodetic	Returns the current value indicating if the node is a geodetic-related node.
isWorld	Returns the current value indicating if the node is a world node (its type is WORLD_*).
isImmovableSupported	Returns the current value indicating if the node can be moved to a separate spatial tree for immovable (static) objects optimizing node management.
isSurfacesCollisionSupported	Returns the current value indicating if collisions with node surfaces are supported.
isSurfacesIntersectionSupported	Returns the current value indicating if intersections with node surfaces are supported.
getTypeName	Returns the current name of the node type.
getType	Returns the current type of the node.
setID	Setter and Getter for ID of the node.
getID	Setter and Getter for ID of the node.
setSaveToWorldEnabled	Setter and Getter for value indicating if saving to *.world file is enabled for the node and all its children (if any).
isSaveToWorldEnabled
isSaveToWorldEnabledSelf	Returns the current value indicating if saving to *.world file is enabled for the node.
setShowInEditorEnabled	Setter and Getter for value indicating if displaying in the World Hierarchy window of the UnigineEditor is enabled for the node.
isShowInEditorEnabled
isShowInEditorEnabledSelf	Returns the current value indicating if displaying in the World Hierarchy window of the UnigineEditor is enabled for the node.
getNumWorldTriggers	Returns the current number of World Triggers inside which the node is located at the moment.
getSpatialBoundSphere	Returns the current bounding sphere with world coordinates that participates in physics calculations, but doesn't take children into account.
getSpatialBoundBox	Returns the current bounding box with world coordinates that participates in physics calculations, but doesn't take children into account.
isLandscapeLayer	Returns the current value indicating if the node is a landscape layer (its type is LANDSCAPE_LAYER_*).
getIWorldTransform	Returns the current inverse transformation matrix of the node for transformations in the world coordinates.
getOldWorldPosition	Returns the current old (previous frame) position of the node in the world coordinates.
setLifetime	Setter and Getter for lifetime management type for the root (either parent or posessor) of the node, or for the node itself (if it is not a child and not possessed by any other node).
getLifetime
getEventNodeSwap	The event triggered when swapping a node via Node.
getEventNodeClone	The event triggered when copying a node via Node.
getEventNodeChangeEnabled	The event triggered when the node's enabled state is changed.
getEventNodeRemove	The event triggered when the node is deleted.
getEventNodeLoad	The event triggered when a node is loaded from a file.
getEventCacheNodeAdd	The event triggered when a node is added to cache.
getEventPropertySurfaceRemove	The event triggered when a property is removed from the object's surface.
getEventPropertySurfaceAdd	The event triggered when a property is assigned to the object's surface.
getEventPropertyNodeSwap	The event triggered when two properties swap their positions in the list of the node's properties.
getEventPropertyChangeEnabled	The event triggered when the node's property enabled state is changed.
getEventPropertyNodeRemove	The event triggered when a property is removed from the list of the node's properties.
getEventPropertyNodeAdd	The event triggered when a new property is assigned to the node.
getEventPropertyNodeSlotsChanged	The event triggered when the number of the node's property slots is changed.
getAncestor	Returns a node ancestor by its number.
getChild	Returns a node child by its number.
isChild	Checks if a given node is a child of the node.
setChildIndex	Sets the index for a given child node of the node.
getChildIndex	Returns the index of a given child node of the node.
setData	Updates user data associated with the node.
getData	Returns user string data associated with the node.
updateEnabled	Updates node's internal state according to the current "enabled" state.
isEnabledSelf	Returns a value indicating if the node is enabled.
getHierarchy	Retrieves the whole hierarchy of the node and puts it to the hierarchy buffer.
setProperty	Updates the node property with the specified number.
setPropertyEnabled	Enables or disables the node property with the specified number.
isPropertyEnabled	Returns a value indicating if the node property with the specified number is enabled.
swapProperty	Swaps two properties with specified numbers in the list of properties associated with the node.
clearProperties	Clears the list of properties associated with the node.
getProperty	Returns a node property with the specified number if it exists.
getPropertyName	Returns the name of a node property with the specified number.
hasQueryForce	Returns a value indicating if the Culled By Occlusion Queryoption is force-enabled for the node by the Engine.
setRotation	Sets the node rotation.
getRotation	Returns the node rotation.
setWorldRotation	Sets the node rotation in the world space.
getWorldRotation	Returns the node rotation in the world space.
setTransformWithoutChildren	Sets the transformation matrix for the node in local coordinates (transformations of all node's children are not affected).
getTypeID	Returns the ID of a node type with a given name.
getTypeName	Returns the name of a node type with a given ID.
setVariable	Sets the value of a variable with a given name. If such variable does not exist it will be added with a specified value.
getVariable	Returns the variable with a given name.
setWorldParent	Sets the new parent of the node.
setWorldTransformWithoutChildren	Sets the transformation matrix for the node in world coordinates (transformations of all node's children are not affected).
getBodyWorldVelocity	Returns linear velocity of a point of the node's physical body in the world space.
addChild	Adds a child to the node.
addWorldChild	Adds a child to the node.
clone	Clones the node.
findChild	Searches for a child node with a given name among the children of the node.
findNode	Searches for a node with a given name among the children of the node.
hasVariable	Returns a value indicating if the node has a variable parameter with a given name.
loadWorld	Loads a node state from the Xml.
removeChild	Removes a child node (added by the addChild() method) from the list of children.
removeVariable	Removes a variable parameter with a given name.
removeWorldChild	Removes a child node (added by the addWorldChild() method) from the list of children.
renderVisualizer	Renders a bounding box / sphere of the object.
saveState	Saves the state of a given node into a binary stream.
restoreState	Restores the state of a given node from a binary stream.
saveWorld	Saves the node into the Xml.
swap	Swaps the nodes saving the pointers.
toLocal	Converts a given vector in the world space to the node's local space.
toWorld	Converts a given vector in the local space to the world space.
translate	Translates the node relative to its local coordinate system: the parent node transformation isn't taken into account.
worldTranslate	Translates the node in the world space using the specified vector.
worldLookAt	Reorients the node to "look" at the target point and sets the given up vector: If the node is a Player-related one, it will "look" at the target point along the negative Z axis.
rotate	Rotates the node relative to its local coordinate system: the parent node transformation isn't taken into account.
worldRotate	Rotates the node in the world space.
setDirection	Updates the direction vector of the node and reorients this node: the specified axis of the node becomes oriented along the specified vector in local coordinates.
getDirection	Returns the normalized direction vector pointing along the given node axis in local coordinates (i.e. relative to the node's parent).
setWorldDirection	Updates the direction vector of the node and reorients this node: the specified axis of the node becomes oriented along the specified vector in world coordinates.
getWorldDirection	Returns the normalized direction vector pointing along the given node axis in world coordinates.
getCloneNode	Returns a node cloned from the specified original node.
getCloneProperty	Returns a node property cloned from the specified original property.
setSaveToWorldEnabledRecursive	Sets a value indicating if saving to *.world file is enabled for the node and all its children (if any).
setShowInEditorEnabledRecursive	Sets a value indicating if displaying in the World Hierarchy window of the UnigineEditor is enabled for the node and all its children (if any).
getLifetimeSelf	Returns the lifetime management type set for the node itself.
getHierarchyBoundBox	Returns a bounding box with local coordinates that takes children into account, but doesn't participate in physics calculations.
getHierarchyBoundSphere	Returns a bounding sphere with local coordinates that takes children into account, but doesn't participate in physics calculations.
getHierarchyWorldBoundBox	Returns a bounding box with world coordinates that takes children into account, but doesn't participate in physics calculations.
getHierarchyWorldBoundSphere	Returns a bounding sphere with world coordinates that takes children into account, but doesn't participate in physics calculations.
getHierarchySpatialBoundBox	Returns a bounding box with world coordinates that takes all children and physics into account.
getHierarchySpatialBoundSphere	Returns a bounding sphere with world coordinates that takes all children and physics into account.
updateSpatialTree	Updates node bounds in the spatial tree in the current frame.
updateSpatialTreeDelayed	Mark node bounds in the spatial tree to be updated in the next frame (all bounds will be 100% accurate in this case unlike for the updateSpatialTree()() method).
getWorldTrigger	Returns one of the World Triggers inside which the node is located at the moment by its number.
getLostNodePropertyGUID	Returns the GUID of a lost property assigned to the node.
renderBounds

Node Class

Members

GeodeticPivot getGeodeticPivot() const#

Returns the current pointer to geodetic pivot of the node.

Return value

Current geodetic pivot, or NULL if the node is not a child of a geodetic pivot node.

void setVariable ( ) #

Sets a new value of the single unnamed variable parameter of the node. If this variable does not exist it will be created with a specified value (on requesting the non-existent value 0 will be returned).

Arguments

variable - The variable value.

getVariable() const#

Returns the current value of the single unnamed variable parameter of the node. If this variable does not exist it will be created with a specified value (on requesting the non-existent value 0 will be returned).

Return value

Current variable value.

void setWorldScale ( vec3 scale ) #

Sets a new node scale in the world space.

NoticeScaling of nodes should be avoided whenever possible as it requires addidional calculations and may lead to error accumulation.

Arguments

vec3 scale - The node scale in the world space.

vec3 getWorldScale() const#

Returns the current node scale in the world space.

NoticeScaling of nodes should be avoided whenever possible as it requires addidional calculations and may lead to error accumulation.

Return value

Current node scale in the world space.

void setWorldPosition ( Vec3 position ) #

Sets a new node position in the world coordinates.

Arguments

Vec3 position - The node position in the world coordinates.

Vec3 getWorldPosition() const#

Returns the current node position in the world coordinates.

Return value

Current node position in the world coordinates.

void setScale ( vec3 scale ) #

Sets a new scale of the node.

NoticeScaling of nodes should be avoided whenever possible as it requires addidional calculations and may lead to error accumulation.

Arguments

vec3 scale - The node scale in the local space.

vec3 getScale() const#

Returns the current scale of the node.

NoticeScaling of nodes should be avoided whenever possible as it requires addidional calculations and may lead to error accumulation.

Return value

Current node scale in the local space.

void setPosition ( Vec3 position ) #

Sets a new node position.

Arguments

Vec3 position - The node position in the local space.

Vec3 getPosition() const#

Returns the current node position.

Return value

Current node position in the local space.

vec3 getBodyAngularVelocity() const#

Returns the current angular velocity of the node's physical body in the world space.

Return value

Current angular velocity of the node's physical body in the world space.

vec3 getBodyLinearVelocity() const#

Returns the current linear velocity of the node's physical body in the local space.

Return value

Current linear velocity of the node's physical body in the local space.

BodyRigid getObjectBodyRigid() const#

Returns the current rigid body assigned to the node if it is an object node.

Return value

Current rigid body assigned to the node if it is an object node; otherwise, NULL (0).

Body getObjectBody() const#

Returns the current physical body assigned to the node if it is an object node.

Return value

Current physical body assigned to the node if it is an object node; otherwise, NULL (0).

WorldBoundSphere getWorldBoundSphere() const#

Returns the current bounding sphere of the node in world's coordinate system.

Return value

Current bounding sphere of the node in world's coordinate system.

WorldBoundBox getWorldBoundBox() const#

Returns the current bounding box of the node in world's coordinate system.

Return value

Current world bounding box.

BoundSphere getBoundSphere() const#

Returns the current

Return value

Current bounding sphere of the node.

BoundBox getBoundBox() const#

Returns the current

Return value

Current bounding box of the node.

void setOldWorldTransform ( Mat4 transform ) #

Sets a new old (previous frame) transformation matrix for the node in the world coordinates.

Arguments

Mat4 transform - The old (previous frame) transformation matrix for the node in the world coordinates.

Mat4 getOldWorldTransform() const#

Returns the current old (previous frame) transformation matrix for the node in the world coordinates.

Return value

Current old (previous frame) transformation matrix for the node in the world coordinates.

void setWorldTransform ( Mat4 transform ) #

Sets a new transformation matrix of the node in the world coordinates.

Arguments

Mat4 transform - The transformation matrix of the node in the world coordinates.

Mat4 getWorldTransform() const#

Returns the current transformation matrix of the node in the world coordinates.

Return value

Current transformation matrix of the node in the world coordinates.

void setTransform ( Mat4 transform ) #

Sets a new transformation matrix of the node in its parent coordinates.

Arguments

Mat4 transform - The transformation matrix of the node in local coordinates.

Mat4 getTransform() const#

Returns the current transformation matrix of the node in its parent coordinates.

Return value

Current transformation matrix of the node in local coordinates.

int getNumProperties() const#

Returns the current total number of properties associated with the node.

Return value

Current total number of properties associated with the node.

Node getPossessor() const#

Returns the current possessor of the node. the following nodes can be possessors:

NodeReference
WorldCluster
WorldClutter
WorldLayer

This function can only be applied to a root node inside a node reference.

Return value

Current node posessor, if it exists; otherwise, NULL.

int getNumChildren() const#

Returns the current number of children of the node.

Return value

Current number of child nodes.

Node getRootNode() const#

Returns the current root node for the node. This method searches for the root node among all node's parents and posessors up the hierarchy. If a node does not have a parent or posessor the node itself will be returned.

Return value

Current root node for the node.

void setParent ( Node parent ) #

Sets a new parent of the node.

Arguments

Node parent - The parent of the node or NULL (0), if the node has no parent.

Node getParent() const#

Returns the current parent of the node.

Return value

Current parent of the node or NULL (0), if the node has no parent.

int getNumAncestors() const#

Returns the current number of ancestors of the node.

Return value

Current number of ancestors of the node.

void setName ( string name ) #

Sets a new name of the node.

Arguments

string name - The name of the node.

string getName() const#

Returns the current name of the node.

Return value

Current name of the node.

void setQuery ( ) #

Sets a new value indicating if occlusion query is used for the node. The default is false (not used).

Arguments

query - The occlusion query is used for the node

isQuery() const#

Returns the current value indicating if occlusion query is used for the node. The default is false (not used).

Return value

Current occlusion query is used for the node

void setClutterInteractionEnabled ( bool enabled ) #

Sets a new value indicating if interaction with World Clutters and Mesh Clutters is enabled for the node.

NoticeIt is recommended to disable this option for better performance, when cutting node out of clutters is not necessary. Especially when the world contains a significant number of such nodes.

Arguments

bool enabled - Set true to enable interaction with World Clutters and Mesh Clutters; false - to disable it.

bool isClutterInteractionEnabled() const#

Returns the current value indicating if interaction with World Clutters and Mesh Clutters is enabled for the node.

NoticeIt is recommended to disable this option for better performance, when cutting node out of clutters is not necessary. Especially when the world contains a significant number of such nodes.

Return value

true if interaction with World Clutters and Mesh Clutters is enabled; otherwise false.

void setGrassInteractionEnabled ( bool enabled ) #

Sets a new value indicating if interaction with Grass nodes is enabled for the node.

NoticeIt is recommended to disable this option for better performance, when cutting node out of grass is not necessary. Especially when the world contains a significant number of such nodes.

Arguments

bool enabled - Set true to enable interaction with Grass nodes; false - to disable it.

bool isGrassInteractionEnabled() const#

Returns the current value indicating if interaction with Grass nodes is enabled for the node.

NoticeIt is recommended to disable this option for better performance, when cutting node out of grass is not necessary. Especially when the world contains a significant number of such nodes.

Return value

true if interaction with Grass nodes is enabled; otherwise false.

void setTriggerInteractionEnabled ( bool enabled ) #

Sets a new value indicating if interaction with WorldTrigger nodes is enabled for the node.

Notice

It is recommended to disable this option for better performance, when node interaction with World Triggers is not necessary. Especially when the world contains a significant number of such nodes.

Arguments

bool enabled - Set true to enable interaction with World Triggers; false - to disable it.

bool isTriggerInteractionEnabled() const#

Returns the current value indicating if interaction with WorldTrigger nodes is enabled for the node.

Notice

It is recommended to disable this option for better performance, when node interaction with World Triggers is not necessary. Especially when the world contains a significant number of such nodes.

Return value

true if interaction with World Triggers is enabled; otherwise false.

void setImmovable ( ) #

Sets a new value indicating if the node is an immovable (clutter) object, which means it is moved to a separate spatial tree for immovable (static) objects optimizing node management. There are several restrictions on nodes considered immovable. Any action affecting the spatial tree is prohibited and causes a warning: you cannot change the node state (enabled/disabled), surfaces, bounds, trasformation, visibility distance, as well as move the node, assign a non-dummy physical body or even disable the Immovable flag as it also leads to rebiulding of the spatial tree.

Notice

You can disable these warnings by using the World::setMovingImmovableNodeMode() method, if necessary.

Arguments

immovable - The the feature of the clutter (immovable) object for the node

isImmovable() const#

Returns the current value indicating if the node is an immovable (clutter) object, which means it is moved to a separate spatial tree for immovable (static) objects optimizing node management. There are several restrictions on nodes considered immovable. Any action affecting the spatial tree is prohibited and causes a warning: you cannot change the node state (enabled/disabled), surfaces, bounds, trasformation, visibility distance, as well as move the node, assign a non-dummy physical body or even disable the Immovable flag as it also leads to rebiulding of the spatial tree.

Notice

You can disable these warnings by using the World::setMovingImmovableNodeMode() method, if necessary.

Return value

Current the feature of the clutter (immovable) object for the node

void setHandled ( bool handled ) #

Sets a new value indicating if the node handle is displayed. This option is valid only for invisible nodes, such as light and sound sources, particle systems and world-managing nodes ( WorldOccluder, triggers, expressions, etc.)

Arguments

bool handled - Set true to enable displaying of the node handle; false - to disable it.

bool isHandled() const#

Returns the current value indicating if the node handle is displayed. This option is valid only for invisible nodes, such as light and sound sources, particle systems and world-managing nodes ( WorldOccluder, triggers, expressions, etc.)

Return value

true if displaying of the node handle is enabled; otherwise false.

void setEnabled ( bool enabled ) #

Sets a new value indicating if the node and its parent nodes are enabled.

Arguments

bool enabled - Set true to enable the node; false - to disable it.

bool isEnabled() const#

Returns the current value indicating if the node and its parent nodes are enabled.

Return value

true if the node is enabled; otherwise false.

bool isExtern() const#

Returns the current value indicating if the node is an extern node (its type is one of the following: NODE_EXTERN, OBJECT_EXTERN, WORLD_EXTERN).

Return value

true if the node is an extern node; otherwise false.

bool isField() const#

Returns the current value indicating if the node is a field node (its type is one of the FIELD_*).

Return value

true if the node is a field node; otherwise false.

bool isParticlesField() const#

Returns the current value indicating if the node is a particles field node (its type is one of the PARTICLES_FIELD_*).

Return value

true if the node is a particles field node; otherwise false.

bool isSound() const#

Returns the current value indicating if the node is a sound node (its type is SOUND_*).

Return value

true if the node is a sound node; otherwise false.

bool isObstacle() const#

Returns the current value indicating if the node is an obstacle node (its type is OBSTACLE_*).

Return value

true if the node is an obstacle node; otherwise false.

bool isNavigation() const#

Returns the current value indicating if a given node is a navigation node.

Return value

true if the node is a navigation node; otherwise false.

bool isPhysical() const#

Returns the current value indicating if the node is a physical node (its type is PHYSICAL_*).

Return value

true if the node is a physical node; otherwise false.

bool isPlayer() const#

Returns the current value indicating if the node is a player node (its type is PLAYER_*).

Return value

true if the node is a player node; otherwise false.

bool isObject() const#

Returns the current value indicating if the node is an object node (its type is OBJECT_*).

Return value

true if the node is an object node; otherwise false.

bool isDecal() const#

Returns the current value indicating if the node is a decal node (its type is DECAL_*).

Return value

true if the node is a decal node; otherwise false.

bool isLight() const#

Returns the current value indicating if the node is a light source (its type is LIGHT_*).

Return value

true if the node is a light source; otherwise false.

bool isGeodetic() const#

Returns the current value indicating if the node is a geodetic-related node.

Return value

true if the node is a geodetic-related node; otherwise false.

bool isWorld() const#

Returns the current value indicating if the node is a world node (its type is WORLD_*).

Return value

true if the node is a world node; otherwise false.

bool isImmovableSupported() const#

Returns the current value indicating if the node can be moved to a separate spatial tree for immovable (static) objects optimizing node management.

Return value

true if the node can be immovable; otherwise false.

bool isSurfacesCollisionSupported() const#

Returns the current value indicating if collisions with node surfaces are supported.

Return value

true if collisions with node surfaces are supported; otherwise false.

bool isSurfacesIntersectionSupported() const#

Returns the current value indicating if intersections with node surfaces are supported.

Return value

true if intersections with node surfaces are supported; otherwise false.

string getTypeName() const#

Returns the current name of the node type.

Return value

Current name of the node type.

getType() const#

Returns the current type of the node.

Return value

Current node type identifier.

void setID ( int id ) #

Sets a new ID of the node.

Notice

See also engine.world.getNodeByID() function.

Arguments

int id - The ID of the node.

int getID() const#

Returns the current ID of the node.

Notice

See also engine.world.getNodeByID() function.

Return value

Current ID of the node.

void setSaveToWorldEnabled ( bool enabled ) #

Sets a new value indicating if saving to *.world file is enabled for the node and all its children (if any).

Arguments

bool enabled - Set true to enable saving to *.world file for the node and all its children (if any); false - to disable it.

bool isSaveToWorldEnabled() const#

Returns the current value indicating if saving to *.world file is enabled for the node and all its children (if any).

Return value

true if saving to *.world file for the node and all its children (if any) is enabled; otherwise false.

bool isSaveToWorldEnabledSelf() const#

Returns the current value indicating if saving to *.world file is enabled for the node.

Return value

true if saving to *.world file for the node is enabled; otherwise false.

void setShowInEditorEnabled ( bool enabled ) #

Sets a new value indicating if displaying in the World Hierarchy window of the UnigineEditor is enabled for the node.

NoticeThe node shall be displayed in the hierarchy only if this option is enabled for all of its ancestors as well.

Arguments

bool enabled - Set true to enable displaying in the World Hierarchy window of the UnigineEditor for the node; false - to disable it.

bool isShowInEditorEnabled() const#

Returns the current value indicating if displaying in the World Hierarchy window of the UnigineEditor is enabled for the node.

NoticeThe node shall be displayed in the hierarchy only if this option is enabled for all of its ancestors as well.

Return value

true if displaying in the World Hierarchy window of the UnigineEditor for the node is enabled; otherwise false.

bool isShowInEditorEnabledSelf() const#

Returns the current value indicating if displaying in the World Hierarchy window of the UnigineEditor is enabled for the node.

Return value

true if displaying in the World Hierarchy window of the UnigineEditor for the node is enabled; otherwise false.

int getNumWorldTriggers() const#

Returns the current number of World Triggers inside which the node is located at the moment.

Return value

Current number of World Triggers inside which the node is located at the moment, or 0 if the node is not currently inside any World Trigger.

WorldBoundSphere getSpatialBoundSphere() const#

Returns the current bounding sphere with world coordinates that participates in physics calculations, but doesn't take children into account. this bounding sphere is used by the spatial tree.

Return value

Current bounding sphere with world coordinates.

WorldBoundBox getSpatialBoundBox() const#

Returns the current bounding box with world coordinates that participates in physics calculations, but doesn't take children into account. this bounding box is used by the spatial tree.

Return value

Current bounding box with world coordinates.

bool isLandscapeLayer() const#

Returns the current

Return value

true if the node is a landscape layer is enabled; otherwise false.

Mat4 getIWorldTransform() const#

Returns the current inverse transformation matrix of the node for transformations in the world coordinates.

Return value

Current inverse transformation matrix.

Vec3 getOldWorldPosition() const#

Returns the current old (previous frame) position of the node in the world coordinates.

Return value

Current old (previous frame) position of the node in the world coordinates.

void setLifetime ( ) #

Sets a new lifetime management type for the root (either parent or posessor) of the node, or for the node itself (if it is not a child and not possessed by any other node).

Notice

Lifetime of each node in the hierarchy is defined by it's root (either parent or posessor). Thus, lifetime management type set for a child node that differs from the one set for the root is ignored.

Arguments

lifetime - The

getLifetime() const#

Returns the current lifetime management type for the root (either parent or posessor) of the node, or for the node itself (if it is not a child and not possessed by any other node).

Notice

Lifetime of each node in the hierarchy is defined by it's root (either parent or posessor). Thus, lifetime management type set for a child node that differs from the one set for the root is ignored.