Node Class
In terms of Unigine, all of the objects added into the scene are called nodes. Nodes can be of different types, determining their visual representation and behavior.
The node is created and stored in the world. All changes are saved into the .world file.
The node can be also saved into an external .node file and then imported into the world when necessary. Also it is possible to create a reference to the exported node.
You can associate any string data (written directly into a *.node or a *.world file) or an arbitrary user variable with a node.
See Also
- How to handle ownership
- How to work with the node's matrix transformations
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.
Notice
Only UnigineScript provides such option. For C++ and C#, see the corresponding version of the article.
For example:
- Create a box mesh by using the Mesh class.
- Use the box mesh 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 a mesh
Mesh mesh = new Mesh();
mesh.addBoxSurface("box_0", vec3(1.0f));
// create an instance of any class inherited from the Node class (e.g. ObjectMeshStatic)
ObjectMeshStatic object_mesh = new ObjectMeshStatic(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.
Notice
The 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, it should be added to UnigineEditor first: you should pass node ownership to the editor by releasing script ownership and call the addNode() method of the Editor 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.
- Release script ownership of the ObjectMeshStatic instance.
- Pass node ownership to the editor by adding it the node to it.
- Edit the node and then save the world by calling the world_save console 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. ObjectMeshStatic)
ObjectMeshStatic object_mesh = new ObjectMeshStatic("unigine_project/meshes/my_mesh.mesh");
// assign a material to the mesh
object_mesh.setMaterial("mesh_base","*");
// release script ownership
node_remove(object_mesh);
// pass node ownership to the editor by adding the node to it
engine.editor.addNode(object_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.
- Release script ownership of the ObjectMeshStatic instance.
- Pass node ownership to the editor by adding it the node to it.
- Export the node to an external .node file.
- Import the prevoiusly exported node and add it to the editor to check the result.
NoticeThe node imported via loadNode() is orphan, so you don't need to release script ownership.
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");
// assign a material to the mesh
object_mesh.setMaterial("mesh_base","*");
// release script ownership
node_remove(object_mesh);
// pass node ownership to the editor by adding the node to it
engine.editor.addNode(object_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");
// add the imported node to the editor
//note: an imported node is orphan so you don't need to release script ownership
engine.editor.addNode(imported_node);
// set a position of the node
imported_node.setPosition(Vec3(4.0f, 0.0f, 1.0f));
return 1;
}Deleting a Node
To delete a node owned by UnigineEditor, pass it to the removeNode() method of the Editor class.
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));
// create an instance of any class inherited from the Node class (e.g. ObjectMeshStatic)
ObjectMeshStatic object_mesh = new ObjectMeshStatic(mesh);
// assign a material to the mesh
object_mesh.setMaterial("mesh_base", "*");
// release script ownership
node_remove(object_mesh);
// pass node ownership to the editor by adding the node to it
engine.editor.addNode(object_mesh);
// do something with the node
// ...
// delete the node from the editor
engine.editor.removeNode(object_mesh);
// clear the mesh
mesh.clear();
return 1;
}Node Class
Members
Node getAncestor(int num)
Returns a node ancestor by its number.Arguments
- int num - Ancestor ID.
Return value
Ancestor node.vec3 getAngularVelocity()
Returns the angular velocity of the node's physical body in the local space.Return value
Angular velocity in the local space.BoundBox getBoundBox()
Returns the bounding box of the node.Notice
The coordinates of the bounding box are in the node's local coordinate system. To get the bounding box in world coordinates, use the getWorldBoundBox() method.
Return value
Bounding box of the node.BoundSphere getBoundSphere()
Returns the bounding sphere of the node.Notice
The coordinates of the bounding sphere are in the node's local coordinate system. To get the bounding sphere in world coordinates, use the getWorldBoundSphere() method.
Return value
Bounding sphere of the node.Node getChild(int num)
Returns a node child by its number.Arguments
- int num - Child ID.
Return value
Child node.int isChild(Node n)
Checks if a given node is a child of the node.Arguments
- Node n - Node to check.
Return value
1 if the given node is a child; otherwise, 0.void setChildIndex(Node n, int index)
Sets the index for a given child node of the node.Arguments
- Node n - Child node.
- int index - Node index.
int getChildIndex(Node n)
Returns the index of a given child node of the node.Arguments
- Node n - Child node.
Return value
Node index.void setClutter(int clutter)
Sets a value indicating if the node represents a clutter object.Arguments
- int clutter - Positive number to mark the node as a clutter object; otherwise, 0.
int isClutter()
Returns a value indicating if the node is a clutter object.Return value
1 if the node is a clutter object; otherwise, 0.void setCollider(int collider)
Updates a value indicating if collision detection is enabled for the node (i.e. the node is a collider object). If it is disabled, the node is removed from the physical scene and does not participate in physical interactions.Notice
Collision detection tests can be performed using getCollisionObjects() methods of the World class.
Arguments
- int collider - Positive number to enable collision detection, 0 to disable.
int isCollider()
Returns a value indicating if collision detection is enabled for the node.Return value
1 if collision detection is enabled for the node; otherwise, 0.void setData(string data)
Updates user data associated with the node.- If the node was loaded from the *.node file, data is saved directly into the data tag of this file.
- If the node is loaded from the *.world file, data is saved into the Node data tag of the *.world file.
- If the node is loaded from the *.world file as a NodeReference, data will be saved to the NodeReference data tag of the *.world file.
Arguments
- string data - New user data. Data can contain an XML formatted string.
string getData()
Returns user string data associated with the node.- If the node was loaded from the *.node file, data from the data tag of this file is returned.
- If the node is loaded from the *.world file, data from the Node data tag of the *.world file is returned.
- If the node is loaded from the *.world file as a NodeReference, data from the NodeReference data tag of the *.world file is returned.
Notice
You can also use setVariable() to associate an arbitrary user variable with a node.
Return value
User string data. Data can contain an XML formatted string.int isDecal()
Returns a value indicating if the node is a decal node (its type is NODE_DECAL_*).Return value
1 if the node is a decal node; otherwise, 0.void setEnabled(int enabled)
Enables or disables the node.Arguments
- int enabled - 1 to enable the node, 0 to disable it.
int isEnabled()
Returns a value indicating if the node and its parent nodes are enabled.Return value
1 if the node and its parent nodes are enabled; otherwise, 0.int isEnabledSelf()
Returns a value indicating if the node is enabled.Return value
1 if the node is enabled; otherwise, 0.int isExtern()
Returns a value indicating if the node is an extern node (its type is one of the following: NODE_EXTERN, OBJECT_EXTERN, WORLD_EXTERN).Return value
1 if the node is an extern node; otherwise, 0.int isField()
Returns a value indicating if the node is a field node (its type is one of the FIELD_*).Return value
1 if the node is a field node; otherwise, 0.void setFolded(int folded)
Shows or minimizes node children in the node tree hierarchy.Arguments
- int folded - Positive number to minimize node children; 0 to expand node hierarchy.
int isFolded()
Returns a value indicating if node children are displayed or minimized in the node tree hierarchy.Return value
Positive number if node children are hidden in the node tree; otherwise, 0.int isGeodetic()
Returns a value indicating if the node is a geodetic-related node.Return value
1 if the node is a geodetic-related node; otherwise, 0.GeodeticPivot getGeodeticPivot()
Returns a pointer to geodetic pivot of the node.Return value
Geodetic pivot smart pointer, or NULL if the node is not a child of a geodetic pivot node.void setHandled(int handled)
Disables or shows the node handle. This option is valid only for invisible nodes, such as light and sound sources, particle systems and world-managing nodes (WorldSector, WorldPortal, WorldOccluder, triggers, expressions, etc.)Arguments
- int handled - Positive value to show the handle, 0 to hide it.
int isHandled()
Returns a 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 (WorldSector, WorldPortal, WorldOccluder, triggers, expressions, etc.)Return value
1 if the handle is shown; otherwise, 0.void deleteHierarchy(Node node)
Deletes the whole hierarchy of the given node.Arguments
- Node node - Node, the hierarchy of which is to be deleted.
void getHierarchy(Vector<Node> & hierarchy)
Retrieves the whole hierarchy of the node and puts it to the hierarchy buffer.Arguments
- Vector<Node> & hierarchy - Hierarchy buffer.
int setID(int id)
Sets a unique ID for the node.Arguments
- int id - Node ID.
Return value
1 if the ID is set successfully; otherwise, 0.int getID()
Returns the ID of the node.Notice
See also engine.world.getNode() function.
Return value
Node ID.Mat4 getIWorldTransform()
Returns the inverse transformation matrix of the node for transformations in the world coordinates.Return value
Inverse transformation matrix.void setLatest(int latest)
Sets a flag that forces a node to be updated the last of all, after states of all other nodes were updated. For example, a post update flag is useful to draw nodes strictly in front of the camera (after a Player has updated its transformations). By default, this flag is set to 0.Arguments
- int latest - Positive value to update a node last of all; otherwise, 0.
int isLatest()
Checks if a node is forced to be updated the last of all, after states of all other nodes were updated. For example, a post update flag is useful to draw nodes strictly in front of the camera (after a Player has updated its transformations). By default, this flag is set to 0.Return value
1 if the node is updated last of all; otherwise, 0int isLight()
Returns a value indicating if the node is a light source (its type is NODE_LIGHT_*).Return value
1 if the node is a light source; otherwise, 0.vec3 getLinearVelocity()
Returns the linear velocity of the node's physical body in the local space.Return value
Linear velocity in the local space.void setName(string name)
Sets a name for the node.Arguments
- string name - New name of the node.
string getName()
Returns the name of the node.Return value
Name of the node.int isNavigation()
Returns a value indicating if a given node is a navigation node.Return value
Returns 1 if the given node is a navigation node; otherwise, 0.int getNumAncestors()
Returns the number of ancestors of the node.Return value
Number of ancestors.int getNumChildren()
Returns the number of children of the node.Return value
Number of child nodes.int isObject()
Returns a value indicating if the node is an object node (its type is NODE_OBJECT_*).Return value
1 if the node is an object node; otherwise, 0.Body getObjectBody()
Returns a physical body assigned to the node if it is an object node.Return value
Body assigned to the object node; otherwise, NULL (0).BodyRigid getObjectBodyRigid()
Returns a rigid body assigned to the node if it is an object node.Return value
Rigid body assigned to the object node; otherwise, NULL (0).int isObstacle()
Returns a value indicating if the node is an obstacle node (its type is NODE_OBSTACLE_*).Return value
Returns 1 if the given node is an obstacle node; otherwise, 0.void setOldWorldTransform(Mat4 transform)
Sets old transformation matrix for the node in the world coordinates.Arguments
- Mat4 transform - Old transformation matrix to be set.
Mat4 getOldWorldTransform()
Returns old transformation matrix for the node in the world coordinates.Return value
Old transformation matrix.void setParent(Node parent)
Sets the new parent for the node. Transformations of the current node will be done in the coordinates of the parent.Arguments
- Node parent - New parent node.
Node getParent()
Returns the parent of the node.Return value
Parent node or NULL (0), if the node has no parent.int isPhysical()
Returns a value indicating if the node is a physical node (its type is NODE_PHYSICAL_*).Return value
1 if the node is a physical node; otherwise, 0.int isPlayer()
Returns a value indicating if the node is a player node (its type is NODE_PLAYER_*).Return value
1 if the node is a player node; otherwise, 0.void setPosition(Vec3 pos)
Sets the node position.Arguments
- Vec3 pos - Node position in the local space
Vec3 getPosition()
Returns the node position.Return value
Node position in the local spaceNode getPossessor()
Returns a possessor of the node. The following nodes can be possessors:- NodeReference
- WorldCluster
- WorldClutter
- WorldLayer
Return value
Node posessor, if it exists; otherwise, NULL.int getNumProperties()
Returns the total number of properties associated with the node.Return value
Total number of properties associated with the node.int setProperty(int num, string name)
Updates the node property with the specified number. A new internal property inherited from the one with the specified name will be set. Such internal properties are saved in a *.world or *.node file.Arguments
- int num - Node property number in the range from 0 to the total number of node properties.
- string name - Name of the property to be set.
Return value
1 if the specified node property is updated successfully; otherwise, 0.void setPropertyEnabled(int num, int enable)
Enables or disables the node property with the specified number.Arguments
- int num - Node property number in the range from 0 to the total number of node properties.
- int enable - 1 to enable the specified node property, 0 to disable it.
int isPropertyEnabled(int num)
Returns a value indicating if the node property with the specified number is enabled.Arguments
- int num - Node property number in the range from 0 to the total number of node properties.
Return value
1 if the specified property is enabled; otherwise, 0.void swapProperty(int from_num, int to_num)
Swaps two properties with specified numbers in the list of properties associated with the node.Notice
The order of properties in the list determines the execution sequence of logic of corresponding components (if any).
Arguments
- int from_num - Number of the first node property to be swapped, in the range from 0 to the total number of node properties.
- int to_num - Number of the second node property to be swapped, in the range from 0 to the total number of node properties.
void clearProperties()
Clears the list of properties associated with the node.Property getProperty(int num)
Returns a node property with the specified number if it exists.Arguments
- int num - Node property number in the range from 0 to the total number of node properties.
Return value
Property defined for the whole node.string getPropertyName(int num)
Returns the name of a node property with the specified number.Arguments
- int num - Node property number in the range from 0 to the total number of node properties.
Return value
Property name, if exists; otherwise, NULL.void setQuery(int query)
Updates a value indicating if occlusion query is used for the node.Arguments
- int query - Positive number to use occlusion query, 0 not to use.
int isQuery()
Returns a value indicating if occlusion query is used for the node. The default is 0 (not used).Return value
1 if occlusion query is used; otherwise, 0.Node getRootNode()
Returns the root node for the node.Return value
Root node the root node for the node.void setRotation(quat rot, int identity = 0)
Sets the node rotation.Arguments
- quat rot - Node rotation in the local space.
- int identity - 1 to enable scaling of the node, 0 to disable it.
quat getRotation()
Returns the node rotation.Return value
Node rotation in the local space.void setScale(vec3 s)
Sets the scale of the node.Arguments
- vec3 s - Node scale in the local space.
vec3 getScale()
Returns the scale of the node.Return value
Node scale in the local space.int isShadow()
Returns a value indicating if the node was a shadow caster in the previous frame and, therefore, is updated.Return value
1 if the node was a shadow caster; otherwise, 0.int isSound()
Returns a value indicating if the node is a sound node (its type is NODE_SOUND_*).Return value
1 if the node is a sound node; otherwise, 0.void setTransform(Mat4 transform)
Updates the transformation matrix of the node.Arguments
- Mat4 transform - New transformation matrix.
Mat4 getTransform()
Returns the transformation matrix of the node.Return value
Transformation matrix.int getType()
Returns the type of the node.Return value
One of the NODE_* pre-defined variables.int getTypeId(string type)
Returns the ID of a node type with a given name.Arguments
- string type - Node type name.
Return value
Node type ID, if such type exists; otherwise, -1.string getTypeName()
Returns a name of the node type.Return value
Node type name.string getTypeName(int type)
Returns the name of a node type with a given ID.Arguments
- int type - Node type ID.
Return value
Node type name.void setVariable(string name, Variable v)
Sets the value of a variable with a given name. If such variable does not exist it will be added with a specified value.Source code (UnigineScript)
NodeDummy container = new NodeDummy();
if(container.hasVariable("key1") == 0) {
container.setVariable("key1",42);
}
int value = container.getVariable("key1");
container.removeVariable("key1");Arguments
- string name - Variable name.
- Variable v - Variable value.
void setVariable(Variable v)
Sets the value of the single unnamed variable parameter of the node. If this variable does not exist it will be created with a specified value.Arguments
- Variable v - Variable value.
Variable getVariable(string name)
Returns the variable with a given name.Source code (UnigineScript)
NodeDummy container = new NodeDummy();
if(container.hasVariable("key1") == 0) {
container.setVariable("key1",42);
}
int value = container.getVariable("key1");
container.removeVariable("key1");Arguments
- string name - Variable name.
Return value
Variable if it exists; otherwise, variable with 0 value.Variable getVariable()
Returns the single unnamed variable parameter of the node.Return value
Variable if it exists; otherwise, variable with 0 value.int isVisible()
Returns a value indicating if the node was shown in the viewport in the previous frame and, therefore, is updated.Return value
1 if the node was visible; otherwise, 0.int isWorld()
Returns a value indicating if the node is a world node (its type is NODE_WORLD_*).Return value
1 if the node is a world node; otherwise, 0.WorldBoundBox getWorldBoundBox()
Returns the bounding box of the node in world's coordinate system.Notice
If the double precision build is used, the function will return an instance of the WorldBoundBox class.
Return value
World bounding box.WorldBoundSphere getWorldBoundSphere()
Returns the bounding sphere of the node in world's coordinate system.Notice
If the double precision build is used, the function will return an instance of the WorldBoundSphere class.
Return value
World bounding sphere.void setWorldParent(Node n)
Sets the new parent of the node. Transformations of the current node will be done in the world coordinates.Arguments
- Node n - New parent node.
void setWorldPosition(Vec3 pos)
Sets the node position in the world coordinates.Arguments
- Vec3 pos
Vec3 getWorldPosition()
Returns the node position in the world coordinates.Return value
Node position in the world space.void setWorldRotation(quat rot, int identity = 0)
Sets the node rotation in the world space.Arguments
- quat rot - Node rotation in the world space.
- int identity - 1 to enable scaling of the node, 0 to disable it.
quat getWorldRotation()
Returns the node rotation in the world space.Return value
Node rotation in the world space.void setWorldScale(vec3 s)
Sets the node scale in the world space.Arguments
- vec3 s - Node scale in the world space.
vec3 getWorldScale()
Returns the node scale in the world space.Return value
Node scale in the world space.WorldSector getWorldSector()
Returns a sector, in which the node is located.Return value
World sector.void setWorldTransform(Mat4 transform)
Sets the transformation matrix for the node in the world coordinates.Arguments
- Mat4 transform - Transformation matrix.
Mat4 getWorldTransform()
Returns the transformation matrix of the node in the world coordinates.Return value
Transformation matrix.vec3 getWorldVelocity(Vec3 point)
Returns linear velocity of a point of the node's physical body in the world space.Arguments
- Vec3 point - Target point.
Return value
Linear velocity in the world space.void addChild(Node n)
Adds a child to the node. Transformations of the new child will be done in the coordinates of the parent.Arguments
- Node n - New child node.
void addWorldChild(Node n)
Adds a child to the node. Transformations of the new child will be done in the world coordinates.Arguments
- Node n - New child node.
Node clone()
Clones the node.Return value
Copy of the node or NULL (0), if an error occurred.int findChild(string name)
Searches for a child node with a given name among the children of the node.Arguments
- string name - Name of the child node.
Return value
Child node number, if it is found; otherwise, -1.Node findNode(string name, int recursive = 0)
Searches for a node with a given name among the children of the node.Arguments
- string name - Name of the child node.
- int recursive - 1 if the search is recursive (i.e. performed for children of child nodes); otherwise, 0.
Return value
Child node, if it is found; otherwise, NULL.int hasVariable(string name)
Returns a value indicating if the node has a variable parameter with a given name.Source code (UnigineScript)
NodeDummy container = new NodeDummy();
if(container.hasVariable("key1") == 0) {
container.setVariable("key1",42);
}
int value = container.getVariable("key1");
container.removeVariable("key1");Arguments
- string name - Variable name.
Return value
1 if the node has a variable parameter with a given name; otherwise, 0.int hasVariable()
Returns a value indicating if the node has a single unnamed variable parameter.Return value
1 if the node has a single unnamed variable parameter; otherwise, 0.int loadWorld(Xml xml)
Loads a node state from the Xml.Arguments
- Xml xml - Xml smart pointer.
Return value
1 if the node state is loaded successfully; otherwise, 0.void removeChild(Node n)
Removes a child node (added by the addChild() method) from the list of children.Arguments
- Node n - Child node to remove.
int removeVariable(string name)
Removes a variable parameter with a given name.Source code (UnigineScript)
NodeDummy container = new NodeDummy();
if(container.hasVariable("key1") == 0) {
container.setVariable("key1",42);
}
int value = container.getVariable("key1");
container.removeVariable("key1");Arguments
- string name - Variable parameter name.
Return value
1 if the variable parameter is removed successfully; otherwise, 0.void removeWorldChild(Node n)
Removes a child node (added by the addWorldChild() method) from the list of children.Arguments
- Node n - Child node to remove.
void renderVisualizer()
Renders a bounding box / sphere of the object.Notice
You should enable the engine visualizer by the show_visualizer 1 console command.
int restoreState(Stream stream)
Restores the state of a given node from a binary stream.- If a node is a parent for other nodes, states of these child nodes need to be restored manually.
- To save the state into a buffer, file or a message from a socket, make sure the stream is opened. If necessary, you can set a position for writing for buffers and files.
Warning
This function is deprecated and will be removed in the next release.
Arguments
- Stream stream - Stream with saved node state data.
Return value
1 if node state is successfully restored; otherwise, 0.void rotate(quat r)
Rotates the node relative to its local coordinate system: the parent node transformation isn't taken into account. Rotation is determined by the specified quaternion.Arguments
- quat r - Rotation quaternion.
int saveState(Stream stream)
Saves the state of a given node into a binary stream.- If a node is a parent for other nodes, states of these child nodes need to be saved manually.
- To save the state from a buffer, file or a message from a socket, make sure the stream is opened. For buffers and files, you also need to set the proper position for reading.
Warning
This function is deprecated and will be removed in the next release.
Arguments
- Stream stream - Stream to save node state data.
Return value
1 if node state is successfully saved; otherwise, 0.int saveWorld(Xml xml)
Saves a node state into the Xml.Arguments
- Xml xml - Xml smart pointer.
Return value
1 if the node state is saved successfully; otherwise, 0.void scale(vec3 s)
Scales the node in its local coordinate system: the parent node scale isn't taken into account.Arguments
- vec3 s - Scale vector.
void swap(Node n)
Swaps the nodes saving the pointers.Arguments
- Node n - Node to swap.
vec3 toLocal(Vec3 p)
Converts a given vector in the world space to the node's local space.Arguments
- Vec3 p - Vector in the world space.
Return value
Vector in the local space.Vec3 toWorld(vec3 p)
Converts a given vector in the local space to the world space.Arguments
- vec3 p - Vector in the local space.
Return value
Vector in the world space.void translate(Vec3 t)
Translates the node relative to its local coordinate system: the parent node transformation isn't taken into account.Arguments
- Vec3 t - Translation vector.
void worldLookAt(Vec3 target, vec3 up)
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. The Y axis will be oriented along the specified up vector.
- Other nodes will "look" at the target point along the Y axis. The Z axis will be oriented along the specified up vector.
Arguments
- Vec3 target - Coordinates of the target point in the world space.
- vec3 up - Up vector of the node in the world space. By default, the up vector is oriented along the Z axis.
void worldLookAt(Vec3 target)
Reorients the node to "look" at the target point. The up vector is oriented along the Z axis.- If the node is a Player-related one, it will "look" at the target point along the negative Z axis. The Y axis will be oriented along the world Z axis.
- Other nodes will "look" at the target point along the Y axis.
Arguments
- Vec3 target - Coordinates of the target point in the world space.
void worldRotate(quat r)
Rotates the node in the world space. Rotation is determined by the specified quaternion.Arguments
- quat r - Rotation quaternion.
void worldScale(vec3 s)
Scales the node in the world space.Arguments
- vec3 s - Scale vector.
void worldTranslate(Vec3 t)
Translates the node in the world space.Arguments
- Vec3 t - Translation vector.
void setDirection(vec3 dir, vec3 up, int axis = AXIS_NZ)
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. For example, after running the code below, you will get the X axis of the node pointed along the Y axis in local coordinates.Source code (UnigineScript)
// get the node
Node node = engine.editor.getNodeByName("material_ball");
// set the X axis to be pointed along the Y axis in local coordinates
node.setDirection(vec3(0.0f,1.0f,0.0f),vec3(0.0f,0.0f,1.0f),AXIS_X);Arguments
- vec3 dir - New direction vector in local coordinates. The direction vector always has unit length.
- vec3 up - New up vector in local coordinates. If you skip this argument, the Z axis (in local coordinates) will be used. Note that the specified up vector is a hint vector only: the node's up vector points in the direction hinted by the specified up vector. The node's up vector matches the specified up vector (up) only if it is perpendicular to the specified direction vector (dir).
- int axis - Axis along which the direction vector should be pointed. The default is the negative Z axis.
vec3 getDirection(int axis = AXIS_NZ)
Returns the normalized direction vector pointing along the given node axis in local coordinates (i.e. relative to the node's parent). By default, the direction vector pointing along the negative Z axis of the node (in local coordinates) is returned. The direction vector always has a unit length.Source code (UnigineScript)
node.getDirection(node.isPlayer() ? AXIS_NZ : AXIS_Y); // forward direction vector
node.getDirection(node.isPlayer() ? AXIS_Z : AXIS_NY); // backward direction vector
node.getDirection(node.isPlayer() ? AXIS_Y : AXIS_Z); // upward direction vector
node.getDirection(node.isPlayer() ? AXIS_NY : AXIS_NZ); // down direction vector
node.getDirection(AXIS_X); // right direction vector
node.getDirection(AXIS_NX); // left direction vectorArguments
- int axis - Axis along which the direction vector points. The default is the negative Z axis.
Return value
Direction vector in local coordinates.void setWorldDirection(vec3 dir, vec3 up, int axis = AXIS_NZ)
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. For example, after running the code below, you will get the X axis of the node pointed along the Y axis in world coordinates:Source code (UnigineScript)
// get the node
Node node = engine.editor.getNodeByName("material_ball");
// set the X axis to be pointed along the Y axis in world coordinates
node.setWorldDirection(vec3(0.0f,1.0f,0.0f),vec3(0.0f,0.0f,1.0f),AXIS_X);Arguments
- vec3 dir - New direction vector in world coordinates. The direction vector always has unit length.
- vec3 up - New up vector in world coordinates. If you skip this argument, the Z axis (in local coordinates) will be used. Note that the specified up vector is a hint vector only: the node's up vector points in the direction hinted by the specified up vector. The node's up vector matches the specified up vector (up) only if it is perpendicular to the specified direction vector (dir).
- int axis - Axis along which the direction vector should be pointed. The default is the negative Z axis.
vec3 getWorldDirection(int axis = AXIS_NZ)
Returns the normalized direction vector pointing along the given node axis in world coordinates. By default, the direction vector pointing along the negative Z axis of the node is returned. The direction vector always has a unit length.Source code (UnigineScript)
node.getWorldDirection(node.isPlayer() ? AXIS_NZ : AXIS_Y); // forward direction vector
node.getWorldDirection(node.isPlayer() ? AXIS_Z : AXIS_NY); // backward direction vector
node.getWorldDirection(node.isPlayer() ? AXIS_Y : AXIS_Z); // upward direction vector
node.getWorldDirection(node.isPlayer() ? AXIS_NY : AXIS_NZ); // down direction vector
node.getWorldDirection(AXIS_X); // right direction vector
node.getWorldDirection(AXIS_NX); // left direction vectorArguments
- int axis - Axis along which the direction vector points. The default is the negative Z axis.
Return value
Direction vector in world coordinates.void setPortalCullingEnabled(int enabled)
Updates a value indicating if sectors and portals are used for node visibility determination.Arguments
- int enabled - 1 to consider sectors and portals; otherwise, 0.
int isPortalCullingEnabled()
Returns a value indicating if sectors and portals are used for node visibility determination.Return value
1 if sectors and portals are considered; otherwise, 0.int NODE_CALLBACK_PROPERTY_NODE_ADD
Description
Node property added callback. This callback is fired when a new property is assigned to the node.int NODE_CALLBACK_PROPERTY_NODE_REMOVE
Description
Node property removed callback. This callback is fired when a property is removed from the list of node's properties.int NODE_CALLBACK_PROPERTY_NODE_SWAP
Description
Node property swapped callback. This callback is fired when two properties swap their positions in the list of node's properties.int NODE_CALLBACK_PROPERTY_SURFACE_ADD
Description
Surface property added callback. This callback is fired when a property is assigned to object's surface.int NODE_CALLBACK_PROPERTY_SURFACE_REMOVE
Description
Surface property removed callback. This callback is fired when a property is removed from object's surface.int NODE_NODE_BEGIN
Description
Begin of the nodes range.int NODE_DECAL_BEGIN
Description
Begin of the decal nodes range.int NODE_DECAL_END
Description
End of the decal nodes range.int NODE_DECAL_MESH
Description
Mesh decal node. See the DecalMesh class.int NODE_DECAL_ORTHO
Description
Orthographic decal node. See the DecalOrtho class.int NODE_DECAL_PROJ
Description
Projected decal node. See the DecalProj class.int NODE_DUMMY
Description
Dummy node. See the NodeDummy class.int NODE_EXTERN
Description
Extern node.int NODE_FIELD_ANIMATION
Description
Field Animation node. See the FieldAnimation class.int NODE_FIELD_BEGIN
Description
Begin of the field nodes range.int NODE_FIELD_END
Description
End of the field nodes range.int NODE_FIELD_HEIGHT
Description
Field Height node. See the FieldHeight class.int NODE_FIELD_SHORELINE
Description
Field Shoreline node. See the FieldShoreline class.int NODE_FIELD_SPACER
Description
Field Spacer node. See the FieldSpacer class.int NODE_FIELD_WEATHER
Description
Field Weather node. See the FieldWeather class.int NODE_GEODETIC_BEGIN
Description
Begin of the geodetic nodes range.int NODE_GEODETIC_END
Description
End of the geodetic nodes range.int NODE_GEODETIC_PIVOT
Description
Geodetic Pivot node. See the GeodeticPivot class.int NODE_LAYER
Description
Node layer containing parent layer and all its child nodes. See the NodeLayer class.int NODE_LIGHT_BEGIN
Description
Begin of the light nodes range.int NODE_LIGHT_END
Description
End of the light nodes range.int NODE_LIGHT_ENVIRONMENT_PROBE
Description
Environment probe. See the LightEnvironmentProbe class.int NODE_LIGHT_VOXEL_PROBE
Description
Voxel probe. See the LightVoxelProbe class.int NODE_LIGHT_OMNI
Description
Omni-directional light source. See the LightOmni class.int NODE_LIGHT_PROJ
Description
Projected light source. See the LightProj class.int NODE_LIGHT_WORLD
Description
World light source. See the LightWorld class.int NODE_NAVIGATION_BEGIN
Description
Begin of the navigation nodes range.int NODE_NAVIGATION_END
Description
End of the navigation nodes range.int NODE_NAVIGATION_MESH
Description
Mesh-based navigation area across which pathfinding is performed. See the NavigationMesh class.int NODE_NAVIGATION_SECTOR
Description
Sector within which pathfinding is performed. See the NavigationSector class.int NODE_NODE_DUMMY
Description
Dummy node. See the NodeDummy class.int NODE_NODE_EXTERN
Description
Extern node. See the NodeExtern class.int NODE_NODE_LAYER
Description
Layer node. See the NodeLayer class.int NODE_NODE_PIVOT
Description
Pivot node. See the NodePivot class.int NODE_NODE_REFERENCE
Description
Node reference. See the NodeReference class.int NODE_NODE_TRIGGER
Description
Node trigger. See the NodeTrigger class.int NODE_NUM_DECALS
Description
Counter of decal node types.int NODE_NUM_FIELDS
Description
Counter of field node types.int NODE_NUM_GEODETICS
Description
Counter of geodetic node types.int NODE_NUM_LIGHTS
Description
Counter of light node types.int NODE_NUM_NAVIGATIONS
Description
Counter of navigation node types.int NODE_NUM_NODES
Description
Counter of node types.int NODE_NUM_OBJECTS
Description
Counter of object node types.int NODE_NUM_OBSTACLES
Description
Counter of obstacle node types.int NODE_NUM_PHYSICALS
Description
Counter of physical node types.int NODE_NUM_PLAYERS
Description
Counter of player node types.int NODE_NUM_SOUNDS
Description
Counter of sound node types.int NODE_NUM_WORLDS
Description
Counter of world node types.int NODE_OBJECT_BEGIN
Description
Begin of the object nodes range.int NODE_OBJECT_BILLBOARDS
Description
Billboards object for rendering a high number of billboards. See the ObjectBillboard class.int NODE_OBJECT_CLOUD_LAYER
Description
Cloud layer object. See the ObjectCloudLayer class.int NODE_OBJECT_DUMMY
Description
Dummy object. See the ObjectDummy class.int NODE_OBJECT_DYNAMIC
Description
Dynamic object. See the ObjectDynamic class.int NODE_OBJECT_END
Description
End of the object nodes range.int NODE_OBJECT_EXTERN
Description
Extern object. See the ObjectExtern class.int NODE_OBJECT_GRASS
Description
Grass. See the ObjectGrass class.int NODE_OBJECT_GUI
Description
GUI object. See the ObjectGui class.int NODE_OBJECT_GUI_MESH
Description
GUI mesh object. See the ObjectGuiMesh class.int NODE_OBJECT_MESH_CLUSTER
Description
Mesh Cluster object. See the ObjectMeshCluster class.int NODE_OBJECT_MESH_CLUTTER
Description
Mesh Clutter object. See the ObjectMeshClutter class.int NODE_OBJECT_MESH_DYNAMIC
Description
Dynamic mesh object. See the ObjectMeshDynamic class.int NODE_OBJECT_MESH_SKINNED
Description
Skinned mesh object. See the ObjectMeshSkinned class.int NODE_OBJECT_MESH_STATIC
Description
Static mesh object. See the ObjectMeshStatic class.int NODE_OBJECT_PARTICLES
Description
Particles object. See the ObjectParticles class.int NODE_OBJECT_SKY
Description
Sky object. See the ObjectSky class.int NODE_OBJECT_TERRAIN
Description
Terrain object. See the ObjectTerrain class.int NODE_OBJECT_TERRAIN_GLOBAL
Description
Terrain global object. See the ObjectTerrainGlobal class.int NODE_OBJECT_TEXT
Description
Text object. See the ObjectText class.int NODE_OBJECT_VOLUME_BOX
Description
Volume box object. See the ObjectVolumeBox class.int NODE_OBJECT_VOLUME_OMNI
Description
Volume omni light object. See the ObjectVolumeOmni class.int NODE_OBJECT_VOLUME_PROJ
Description
Volume projected light object. See the ObjectVolumeProj class.int NODE_OBJECT_VOLUME_SPHERE
Description
Volume sphere object. See the ObjectVolumeSphere class.int NODE_OBJECT_WATER_GLOBAL
Description
Water global object. See the ObjectWaterGlobal class.int NODE_OBJECT_WATER_MESH
Description
Water mesh object. See the ObjectWaterMesh class.int NODE_OBSTACLE_BEGIN
Description
Begin of the obstacle nodes range.int NODE_OBSTACLE_BOX
Description
Obstacle in the shape of a box avoided by pathfinding. See the ObstacleBox class.int NODE_OBSTACLE_CAPSULE
Description
Obstacle in the shape of a capsule avoided by pathfinding. See the ObstacleCapsule class.int NODE_OBSTACLE_END
Description
End of the obstacle nodes range.int NODE_OBSTACLE_SPHERE
Description
Obstacle in the shape of a sphere avoided by pathfinding. See the ObstacleSphere class.int NODE_PHYSICAL_BEGIN
Description
Begin of the physical nodes range.int NODE_PHYSICAL_END
Description
End of the physical nodes range.int NODE_PHYSICAL_FORCE
Description
Physical force node that allows to simulate point forces applied to dynamic objects. See the PhysicalForce class.int NODE_PHYSICAL_NOISE
Description
Physical noise node that allows to simulate force field. See the PhysicalNoise class.int NODE_PHYSICAL_TRIGGER
Description
Physical trigger. See the PhysicalTrigger class.int NODE_PHYSICAL_WATER
Description
Physical water object that has no visual representation. See the PhysicalWater class.int NODE_PHYSICAL_WIND
Description
Physical wind object. See the PhysicalWind class.int NODE_PIVOT
Description
Node that helps to control rotation and transformation of its children. See the NodePivot class.int NODE_PLAYER_ACTOR
Description
Acting player. See the PlayerActor class.int NODE_PLAYER_BEGIN
Description
Begin of the player nodes range.int NODE_PLAYER_DUMMY
Description
Dummy player. See the PlayerDummy class.int NODE_PLAYER_END
Description
End of the player nodes range.int NODE_PLAYER_PERSECUTOR
Description
Persecuting player. See the PlayerPersecutor class.int NODE_PLAYER_SPECTATOR
Description
Observing player. See the PlayerSpectator class.int NODE_REFERENCE
Description
Node that references an external NODE file. See the NodeReference class.int NODE_SOUND_BEGIN
Description
Begin of the sound nodes range.int NODE_SOUND_END
Description
End of the sound nodes range.int NODE_SOUND_REVERB
Description
Sound reverberation zone. See the SoundReverb class.int NODE_SOUND_SOURCE
Description
Sound source. See the SoundSource class.int NODE_TRIGGER
Description
Dummy node that can fire callbacks on its enabling/disabling or repositioning. See the NodeTrigger class.int NODE_WORLD_BEGIN
Description
Begin of the world nodes range.int NODE_WORLD_CLUSTER
Description
Node cluster. See the WorldCluster class.int NODE_WORLD_CLUTTER
Description
World clutter. See the WorldClutter class.int NODE_WORLD_END
Description
End of the world nodes range.int NODE_WORLD_EXPRESSION
Description
Node which allows to execute arbitrary expression. See the WorldExpression class.int NODE_WORLD_EXTERN
Description
External world. See the WorldExtern class.int NODE_WORLD_LAYER
Description
World layer. See the WorldLayer class.int NODE_WORLD_OCCLUDER
Description
World occluder. See the WorldOccluder class.int NODE_WORLD_OCCLUDER_MESH
Description
World mesh occluder. See the WorldOccluderMesh class.int NODE_WORLD_OCCLUDER_TERRAIN
Description
World terrain occluder. See the WorldOccluderMesh class.int NODE_WORLD_PORTAL
Description
World portal. See the WorldPortal class.int NODE_WORLD_SECTOR
Description
World sector. See the WorldSector class.int NODE_WORLD_SPLINE_GRAPH
Description
World spline graph. See the WorldSplineGraph class.int NODE_WORLD_SWITCHER
Description
Node switcher (to switch off parts of the world). See the WorldSwitcher class.int NODE_WORLD_TRANSFORM_BONE
Description
Bone defined transformer. See the WorldTransformBone class.int NODE_WORLD_TRANSFORM_PATH
Description
Path defined transformer. See the WorldTransformPathint NODE_WORLD_TRIGGER
Description
World trigger. See the WorldTrigger class.int NODE_NODE_END
Description
End of the nodes range.Last update: 2018-08-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)