javax.media.j3d
Class BoundingLeaf
java.lang.Object
|
+--javax.media.j3d.SceneGraphObject
|
+--javax.media.j3d.Node
|
+--javax.media.j3d.Leaf
|
+--javax.media.j3d.BoundingLeaf
- public class BoundingLeaf
- extends Leaf
The BoundingLeaf node defines a bounding region object that can be
referenced by other nodes to define a region of influence, an
activation region, or a scheduling region.
Field Summary |
static int |
ALLOW_REGION_READ
Specifies that this BoundingLeaf node allows read access to its
bounding region object. |
static int |
ALLOW_REGION_WRITE
Specifies that this BoundingLeaf node allows write access to its
bounding region object. |
Fields inherited from class javax.media.j3d.Node |
ALLOW_AUTO_COMPUTE_BOUNDS_READ,
ALLOW_AUTO_COMPUTE_BOUNDS_WRITE,
ALLOW_BOUNDS_READ,
ALLOW_BOUNDS_WRITE,
ALLOW_COLLIDABLE_READ,
ALLOW_COLLIDABLE_WRITE,
ALLOW_LOCAL_TO_VWORLD_READ,
ALLOW_PICK,
ALLOW_PICKABLE_READ,
ALLOW_PICKABLE_WRITE,
ENABLE_COLLISION_REPORTING,
ENABLE_PICK_REPORTING |
Constructor Summary |
BoundingLeaf()
Constructs a BoundingLeaf node with a null (empty) bounding region. |
BoundingLeaf(Bounds region)
Constructs a BoundingLeaf node with the specified bounding region. |
Method Summary |
Node |
cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. |
void |
duplicateNode(Node originalNode,
boolean forceDuplicate)
Copies all node information from originalNode into
the current node. |
Bounds |
getRegion()
Retrieves this BoundingLeaf's bounding region |
void |
setRegion(Bounds region)
Sets this BoundingLeaf node's bounding region. |
Methods inherited from class javax.media.j3d.Node |
cloneTree,
cloneTree,
cloneTree,
getBounds,
getBoundsAutoCompute,
getCollidable,
getLocalToVworld,
getLocalToVworld,
getParent,
getPickable,
setBounds,
setBoundsAutoCompute,
setCollidable,
setPickable |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
ALLOW_REGION_READ
public static final int ALLOW_REGION_READ
- Specifies that this BoundingLeaf node allows read access to its
bounding region object.
ALLOW_REGION_WRITE
public static final int ALLOW_REGION_WRITE
- Specifies that this BoundingLeaf node allows write access to its
bounding region object.
BoundingLeaf
public BoundingLeaf()
- Constructs a BoundingLeaf node with a null (empty) bounding region.
BoundingLeaf
public BoundingLeaf(Bounds region)
- Constructs a BoundingLeaf node with the specified bounding region.
- Parameters:
region
- the bounding region of this leaf node
setRegion
public final void setRegion(Bounds region)
- Sets this BoundingLeaf node's bounding region.
- Parameters:
region
- the bounding region of this leaf node- Throws:
- CapabilityNotSetException - if appropriate capability is
not set and this object is part of live or compiled scene graph
getRegion
public final Bounds getRegion()
- Retrieves this BoundingLeaf's bounding region
- Returns:
- the bounding region of this leaf node
- Throws:
- CapabilityNotSetException - if appropriate capability is
not set and this object is part of live or compiled scene graph
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.
- Overrides:
- cloneNode in class Node
- 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:
Node.cloneTree()
,
Node.cloneNode(boolean)
,
Node.duplicateNode(javax.media.j3d.Node, boolean)
,
NodeComponent.setDuplicateOnCloneTree(boolean)
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
.
- Overrides:
- duplicateNode in class Node
- 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:
Node.cloneTree()
,
Node.cloneNode(boolean)
,
NodeComponent.setDuplicateOnCloneTree(boolean)