com.aspose.threed

Class Node

java.lang.Object

com.aspose.threed.A3DObject

com.aspose.threed.SceneObject

com.aspose.threed.Node

All Implemented Interfaces:

INamedObject

public class Node
extends SceneObject

Represents an element in the scene graph. A scene graph is a tree of Node objects. The tree management services are self contained in this class. Note the Aspose.3D SDK does not test the validity of the constructed scene graph. It is the responsibility of the caller to make sure that it does not generate cyclic graphs in a node hierarchy. Besides the tree management, this class defines all the properties required to describe the position of the object in the scene. This information include the basic Translation, Rotation and Scaling properties and the more advanced options for pivots, limits, and IK joints attributes such the stiffness and dampening. When it is first created, the Node object is "empty" (i.e: it is an object without any graphical representation that only contains the position information). In this state, it can be used to represent parents in the node tree structure but not much more. The normal use of this type of objects is to add them an entity that will specialize the node (see the "Entity"). The entity is an object in itself and is connected to the the Node. This also means that the same entity can be shared among multiple nodes. Camera, Light, Mesh, etc... are all entities and they all derived from the base class Entity.

Field Summary

Fields inherited from class com.aspose.threed.A3DObject

name, properties

Constructor Summary

Constructors

Constructor and Description
Node() Initializes a new instance of the Node class.
Node(java.lang.String name) Initializes a new instance of the Node class.
Node(java.lang.String name, Entity entity) Initializes a new instance of the Node class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(NodeVisitor visitor) Walks through all descendant nodes(including the current node) and call the visitor with the node.
void	addChildNode(Node node) Add a child node to this node
void	addEntity(Entity entity) Add an entity to the node.
Node	createChildNode() Creates a child node
Node	createChildNode(Entity entity) Create a new child node with given entity attached
Node	createChildNode(java.lang.String nodeName) Create a new child node with given node name
Node	createChildNode(java.lang.String nodeName, Entity entity) Create a new child node with given node name
Node	createChildNode(java.lang.String nodeName, Entity entity, Material material) Create a new child node with given node name, and attach specified entity and a material
Matrix4	evaluateGlobalTransform(boolean withGeometricTransform) Evaluate the global transform, include the geometric transform or not.
AssetInfo	getAssetInfo() Per-node asset info
BoundingBox	getBoundingBox() Calculate the bounding box of the node
Node	getChild(int index) Gets the child node at specified index.
Node	getChild(java.lang.String nodeName) Gets the child node with the specified name
java.util.List<Node>	getChildNodes() Gets the children nodes.
java.util.List<Entity>	getEntities() Gets all node entities.
Entity	getEntity() Gets the first entity attached to this node, if sets, will clear other entities.
boolean	getExcluded() Gets whether to exclude this node and all child nodes/entities during exporting.
GlobalTransform	getGlobalTransform() Gets the global transform.
Material	getMaterial() Gets the first material associated with this node, if sets, will clear other materials
java.util.List<Material>	getMaterials() Gets the materials associated with this node.
java.util.List<CustomObject>	getMetaDatas() Gets the meta data defined in this node.
Node	getParentNode() Gets the parent node.
Transform	getTransform() Gets the local transform.
boolean	getVisible() Gets to show the node
void	merge(Node node) Detach everything under the node and attach them to current node.
java.util.ArrayList<java.lang.Object>	selectObjects(java.lang.String path) Select multiple objects under current node using XPath-like query syntax.
java.lang.Object	selectSingleObject(java.lang.String path) Select single object under current node using XPath-like query syntax.
void	setAssetInfo(AssetInfo value) Per-node asset info
void	setEntity(Entity value) Sets the first entity attached to this node, if sets, will clear other entities.
void	setExcluded(boolean value) Sets whether to exclude this node and all child nodes/entities during exporting.
void	setMaterial(Material value) Sets the first material associated with this node, if sets, will clear other materials
void	setParentNode(Node value) Sets the parent node.
void	setVisible(boolean value) Sets to show the node
java.lang.String	toString() Gets the string representation of this node.

Methods inherited from class com.aspose.threed.SceneObject

getScene

Methods inherited from class com.aspose.threed.A3DObject

findProperty, getName, getProperties, getProperty, removeProperty, removeProperty, setName, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Node

public Node()

Initializes a new instance of the Node class.

Node

public Node(java.lang.String name,
            Entity entity)

Initializes a new instance of the Node class.

Parameters:

name - Name.

entity - Default entity.

Node

public Node(java.lang.String name)

Initializes a new instance of the Node class.

Parameters:

name - Name.

Method Detail

getAssetInfo

public AssetInfo getAssetInfo()

Per-node asset info

Returns:

Per-node asset info

setAssetInfo

public void setAssetInfo(AssetInfo value)

Per-node asset info

Parameters:

value - New value

getVisible

public boolean getVisible()

Gets to show the node

Returns:

to show the node Example: The following code shows how to create a invisible node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode("test-node", new Box());
     node.setVisible(false);
     scene.save("output.fbx");
 

setVisible

public void setVisible(boolean value)

Sets to show the node

Parameters:

value - New value Example: The following code shows how to create a invisible node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode("test-node", new Box());
     node.setVisible(false);
     scene.save("output.fbx");
 

getChildNodes

public java.util.List<Node> getChildNodes()

Gets the children nodes.

Returns:

the children nodes. Example: The following code shows how to enumerate child node of root node

     Scene scene = Scene.fromFile("test.fbx");
     for(var child : scene.getRootNode().getChildNodes())
     {
         //do your business
     }
 

createChildNode

public Node createChildNode()

Creates a child node

Returns:

The new child node. Example: The following code shows how to create a new child node under root node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode();
     node.setEntity(new Box());
     scene.save("output.fbx");
 

merge

public void merge(Node node)

Detach everything under the node and attach them to current node. Example: The following code shows how to merge two 3D files into one file

     Scene scene1 = Scene.fromFile("scene1.fbx");
     Scene scene2 = Scene.fromFile("scene2.fbx");
     scene1.getRootNode().merge(scene2.getRootNode());
     scene1.save("merged.fbx");
 

createChildNode

public Node createChildNode(java.lang.String nodeName)

Create a new child node with given node name

Parameters:

nodeName - The new child node's name

Returns:

The new child node. Example: The following code shows how to create a new child node under root node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode("new node");
     node.setEntity(new Box());
     scene.save("output.fbx");
 

createChildNode

public Node createChildNode(Entity entity)

Create a new child node with given entity attached

Parameters:

entity - Default entity attached to the node

Returns:

The new child node. Example: The following code shows how to create a new child node under root node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode(new Box());
     scene.save("output.fbx");
 

createChildNode

public Node createChildNode(java.lang.String nodeName,
                            Entity entity)

Create a new child node with given node name

Parameters:

nodeName - The new child node's name

entity - Default entity attached to the node

Returns:

The new child node.

createChildNode

public Node createChildNode(java.lang.String nodeName,
                            Entity entity,
                            Material material)

Create a new child node with given node name, and attach specified entity and a material

Parameters:

nodeName - The new child node's name

entity - Default entity attached to the node

material - The material attached to the node

Returns:

The new child node.

getEntity

public Entity getEntity()

Gets the first entity attached to this node, if sets, will clear other entities.

Returns:

the first entity attached to this node, if sets, will clear other entities. Example: The following code shows how to create a new child node under root node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode("new node");
     node.setEntity(new Box());
     scene.save("output.fbx");
 

setEntity

public void setEntity(Entity value)

Sets the first entity attached to this node, if sets, will clear other entities.

Parameters:

value - New value Example: The following code shows how to create a new child node under root node

     Scene scene = new Scene();
     Node node = scene.getRootNode().createChildNode("new node");
     node.setEntity(new Box());
     scene.save("output.fbx");
 

getExcluded

public boolean getExcluded()

Gets whether to exclude this node and all child nodes/entities during exporting.

Returns:

whether to exclude this node and all child nodes/entities during exporting. Example: The following code shows how to exclude specified node from exporting

     Scene scene = new Scene();
     scene.getRootNode().createChildNode("excluded", new Box()).setExcluded(true);
     scene.getRootNode().createChildNode("not excluded", new Box());
     scene.save("output.usdz");
 

setExcluded

public void setExcluded(boolean value)

Sets whether to exclude this node and all child nodes/entities during exporting.

Parameters:

value - New value Example: The following code shows how to exclude specified node from exporting

     Scene scene = new Scene();
     scene.getRootNode().createChildNode("excluded", new Box()).setExcluded(true);
     scene.getRootNode().createChildNode("not excluded", new Box());
     scene.save("output.usdz");
 

getEntities

public java.util.List<Entity> getEntities()

Gets all node entities.

Returns:

all node entities.

getMetaDatas

public java.util.List<CustomObject> getMetaDatas()

Gets the meta data defined in this node.

Returns:

the meta data defined in this node.

getMaterials

public java.util.List<Material> getMaterials()

Gets the materials associated with this node.

Returns:

the materials associated with this node.

getMaterial

public Material getMaterial()

Gets the first material associated with this node, if sets, will clear other materials

Returns:

the first material associated with this node, if sets, will clear other materials Example:

     Scene scene = new Scene();
     var node = scene.getRootNode().createChildNode(new Box());
     node.setMaterial(new LambertMaterial());
 

setMaterial

public void setMaterial(Material value)

Sets the first material associated with this node, if sets, will clear other materials

Parameters:

value - New value Example:

     Scene scene = new Scene();
     var node = scene.getRootNode().createChildNode(new Box());
     node.setMaterial(new LambertMaterial());
 

getParentNode

public Node getParentNode()

Gets the parent node.

Returns:

the parent node.

setParentNode

public void setParentNode(Node value)

Sets the parent node.

Parameters:

value - New value

getTransform

public Transform getTransform()

Gets the local transform.

Returns:

the local transform. Example: The following code shows how to change the transform of the node:

     Scene scene = new Scene();
     var boxNode = scene.getRootNode().createChildNode(new Box());
     //place the box at (10, 0, 0)
     boxNode.getTransform().setTranslation(new Vector3(10, 0, 0));
 

evaluateGlobalTransform

public Matrix4 evaluateGlobalTransform(boolean withGeometricTransform)

Evaluate the global transform, include the geometric transform or not.

Parameters:

withGeometricTransform - Whether the geometric transform is needed.

Returns:

The global transform matrix. Example: The following code shows how to read the node's global transform matrix.

     Scene scene = new Scene();
     var boxNode = scene.getRootNode().createChildNode(new Box());
     //place the box at (10, 0, 0)
     boxNode.getTransform().setTranslation(new Vector3(10, 0, 0));
     Matrix4 mat = boxNode.evaluateGlobalTransform(true);
     System.out.printf("The box's global transform matrix is %s", mat);
 

getGlobalTransform

public GlobalTransform getGlobalTransform()

Gets the global transform.

Returns:

the global transform. Example: The following code shows how to read node's global transform

     Scene scene = new Scene();
     var boxNode = scene.getRootNode().createChildNode(new Box());
     //place the box at (10, 0, 0)
     boxNode.getTransform().setTranslation(new Vector3(10, 0, 0));
     var global = boxNode.getGlobalTransform();
     System.out.printf("The box's position in world coordinate is %s", global.getTranslation());
 

getChild

public Node getChild(int index)

Gets the child node at specified index.

Parameters:

index - Index.

Returns:

The child. Example: The following code shows how to get a child node at specified index.

     Scene scene = Scene.fromFile("input.fbx");
     var node = scene.getRootNode().getChild(0);
     System.out.printf("The first node of the file is %s", node.getName());
 

getChild

public Node getChild(java.lang.String nodeName)

Gets the child node with the specified name

Parameters:

nodeName - The child name to find.

Returns:

The child. Example: The following code shows how to get a child node with specified name

     Scene scene = Scene.fromFile("input.fbx");
     var node = scene.getRootNode().getChild("box");
     System.out.printf("The box node's translation is %s", node.getTransform().getTranslation());
 

accept

public boolean accept(NodeVisitor visitor)

Walks through all descendant nodes(including the current node) and call the visitor with the node. Visitor can break the walk-through by returning false

Parameters:

visitor - Visitor callback to visit the node

Returns:

true means visitor has broke the walk through. Example: The following code shows how to get all meshes from a scene

     Scene scene = Scene.fromFile("input.fbx");
     List<Mesh> meshes = new ArrayList<Mesh>();
     scene.getRootNode().accept(new NodeVisitor() {
         @Override
         public boolean call(Node node) {
             if(node.Entity instanceof Mesh)
                 meshes.add(((Mesh)node).getEntity());
             //continue searching
             return true;
         }
     });
 

toString

public java.lang.String toString()

Gets the string representation of this node.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this node for debugging.

getBoundingBox

public BoundingBox getBoundingBox()

Calculate the bounding box of the node

Returns:

The bounding box of current node

addEntity

public void addEntity(Entity entity)

Add an entity to the node.

Parameters:

entity - The entity to be attached to the node

addChildNode

public void addChildNode(Node node)

Add a child node to this node

Parameters:

node - The child node to be attached Example: The following code shows how to get all meshes from a scene

     Scene scene = Scene.fromFile("input.fbx");
     var newNode = new Node();
     //add a new node manually
     scene.getRootNode().addChildNode(newNode);
 

selectSingleObject

public java.lang.Object selectSingleObject(java.lang.String path)
                                    throws ParseException

Select single object under current node using XPath-like query syntax.

Parameters:

path - The XPath-like query

Returns:

Object located by the XPath-like query.

Throws:

ParseException - ParseException will be thrown if the path contains malformed query. Example: Select a single node using XPath-like expression

     //Create a scene for testing
     Scene s = new Scene();
     var a = s.getRootNode().createChildNode("a");
     a.createChildNode("a1");
     a.createChildNode("a2");
     s.getRootNode().createChildNode("b");
     var c = s.getRootNode().createChildNode("c");
     c.createChildNode("c1").addEntity(new Camera("cam"));
     c.createChildNode("c2").addEntity(new Light("light"));
     //Select single camera object under the child nodes of node named 'c' under the root node
     var c1 = s.getRootNode().selectSingleObject("/c/*/<Camera>");
     // Select node named 'a1' under the root node, even if the 'a1' is not a directly child node of the
     var obj = s.getRootNode().selectSingleObject("a1");
     //Select the node itself, since the '/' is selected directly on the root node, so the root node is selected.
     obj = s.getRootNode().selectSingleObject("/");
 

selectObjects

public java.util.ArrayList<java.lang.Object> selectObjects(java.lang.String path)
                                                    throws ParseException

Select multiple objects under current node using XPath-like query syntax.

Parameters:

path - The XPath-like query

Returns:

Multiple object matches the XPath-like query.

Throws:

ParseException - ParseException will be thrown if the path contains malformed query. Example: Select a single node using XPath-like expression

     //Create a scene for testing
     Scene s = new Scene();
     var a = s.getRootNode().createChildNode("a");
     a.createChildNode("a1");
     a.createChildNode("a2");
     s.getRootNode().createChildNode("b");
     var c = s.getRootNode().createChildNode("c");
     c.createChildNode("c1").addEntity(new Camera("cam"));
     c.createChildNode("c2").addEntity(new Light("light"));
     //select objects that has type Camera or name is 'light' whatever it's located.
     var objects = s.getRootNode().selectObjects("//*[(@Type = 'Camera') or (@Name = 'light')]");