All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.Node

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.Node

public abstract class Node
extends SceneGraphObject

The Node class provides an abstract class for all Group and Leaf Nodes. It provides a common framework for constructing a Java 3D scene graph, specifically bounding volumes.

ALLOW_BOUNDS_READ: Specifies that this Node allows access to its object's bounds information.
ALLOW_BOUNDS_WRITE: Specifies that this Node allows writing to its object's bounds information.
ALLOW_PICK: Specifies that this Node is pickable.

Node(): Constructs and initializes a Node object.

cloneNode(boolean): Used to create a new instance of the node.
cloneTree(): Duplicates all the nodes of the specified sub-graph.
cloneTree(boolean): Duplicates all the nodes of the specified sub-graph.
cloneTree(boolean, boolean): Duplicates all the nodes of the specified sub-graph.
duplicateNode(Node, boolean): Copies all node information from originalNode into the current node.
getBounds(): Returns the bounding object of a node.
setBounds(Bounds): Sets the geometric bounds of a node.

ALLOW_PICK

 public static final int ALLOW_PICK

Specifies that this Node is pickable.

ALLOW_BOUNDS_READ

 public static final int ALLOW_BOUNDS_READ

Specifies that this Node allows access to its object's bounds information.

ALLOW_BOUNDS_WRITE

 public static final int ALLOW_BOUNDS_WRITE

Specifies that this Node allows writing to its object's bounds information.

Node

 public Node()

Constructs and initializes a Node object.

setBounds

 public final void setBounds(Bounds bounds)

Sets the geometric bounds of a node.

Parameters:: bounds - the bounding object for a node
Throws: CapabilityNotSetException: if appropriate capability is not set and this object is part of live or compiled scene graph

getBounds

 public final Bounds getBounds()

Returns the bounding object of a node.

Returns:: the node's bounding object
Throws: CapabilityNotSetException: if appropriate capability is not set and this object is part of live or compiled scene graph

cloneTree

 public Node cloneTree()

Duplicates all the nodes of the specified sub-graph. For Group Nodes the group node is duplicated via a call to cloneNode and then cloneTree is called for each child node. For Leaf Nodes, component data can either be duplicated or be made a reference to the original data. Leaf Node cloneTree behavior is determined by the duplicateOnCloneTree flag found in every Leaf Node's component data class and by the forceDuplicate paramter.

Returns:: a reference to the cloned sub-graph.
Throws: DanglingReferenceException: When a dangling reference is discovered during the cloneTree operation.
See Also:: setDuplicateOnCloneTree

cloneTree

 public Node cloneTree(boolean forceDuplicate)

Parameters:: forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree determines whether data is duplicated or copied.
Returns:: a reference to the cloned scene graph.
Throws: DanglingReferenceException: When a dangling reference is discovered during the cloneTree operation.
See Also:: setDuplicateOnCloneTree

cloneTree

 public Node cloneTree(boolean forceDuplicate,
                       boolean allowDanglingReference)

Parameters:: forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree determines whether data is duplicated or copied.; allowDanglingReferences - when set to true allows the cloneTree method to complete even whan a dangling reference is discovered. When this parameter is false a DanglingReferenceException is generated as soon as cloneTree detects this situation.
Returns:: a reference to the cloned scene graph.
Throws: DanglingReferenceException: When a dangling reference is discovered during the cloneTree operation and the allowDanglingReference parameter is false.
See Also:: setDuplicateOnCloneTree

cloneNode

 public Node cloneNode(boolean forceDuplicate)

Used to create a new instance of the node. This routine is called by cloneTree to duplicate the current node. cloneNode should be overridden by any user subclassed objects. All subclasses must have their cloneNode method consist of the following lines:

     public Node cloneNode(boolean forceDuplicate) {
         UserSubClass usc = new UserSubClass();
         usc.duplicateNode(this, forceDuplicate);
         return usc;
     }

Parameters:: forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.
See Also:: cloneTree, duplicateNode, setDuplicateOnCloneTree

duplicateNode

 public void duplicateNode(Node originalNode,
                           boolean forceDuplicate)

Copies all node information from originalNode into the current node. This method is called from the cloneNode method which is, in turn, called by the cloneTree method.

For any NodeComponent objects contained by the object being duplicated, each NodeComponent object's duplicateOnCloneTree value is used to determine whether the NodeComponent should be duplicated in the new node or if just a reference to the current node should be placed in the new node. This flag can be overridden by setting the forceDuplicate parameter in the cloneTree method to true.

Parameters:: originalNode - the original node to duplicate.; forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.
See Also:: cloneTree, cloneNode, setDuplicateOnCloneTree

All Packages  Class Hierarchy  This Package  Previous  Next  Index