| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.BoundingLeaf
| BoundingLeaf | | public class BoundingLeaf extends Leaf (Code) | | The BoundingLeaf node defines a bounding region object that can be
referenced by other nodes to define a region of influence
(Fog and Light nodes), an application region (Background, Clip,
and Soundscape nodes), or a scheduling region (Sound and
Behavior nodes). The bounding region is defined in the local
coordinate system of the BoundingLeaf node. A reference to a
BoundingLeaf node can be used in place
of a locally defined bounds object for any of the aforementioned regions.
This allows an application to specify a bounding region in one coordinate system
(the local coordinate system of the BoundingLeaf node) other than the local
coordinate system of the node that references the bounds. For an example of how
this might be used, consider a closed room with a number of track lights. Each
light can move independent of the other lights and, as such, needs its own local
coordinate system. However, the bounding volume is used by all the lights in the
boundary of the room, which doesn't move when the lights move. In this example,
the BoundingLeaf node allows the bounding region to be defined in the local
coordinate system of the room, rather than in the local coordinate system of a
particular light. All lights can then share this single bounding volume.
|
| Field Summary | |
| final public static int | ALLOW_REGION_READ
Specifies that this BoundingLeaf node allows read access to its
bounding region object. | | final public static int | ALLOW_REGION_WRITE
Specifies that this BoundingLeaf node allows write access to its
bounding region object. |
| Constructor Summary | |
| public | BoundingLeaf()
Constructs a BoundingLeaf node with a null (empty) bounding region. | | public | BoundingLeaf(Bounds region)
Constructs a BoundingLeaf node with the specified bounding region. |
| Method Summary | |
| public Node | cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. | | void | createRetained()
Creates the BoundingLeafRetained object that this
BoundingLeaf object will point to. | | void | duplicateAttributes(Node originalNode, boolean forceDuplicate)
Copies all BoundingLeaf information from
originalNode into
the current node. | | public Bounds | getRegion()
Retrieves this BoundingLeaf's bounding region. | | public void | setRegion(Bounds region)
Sets this BoundingLeaf node's bounding region. |
| ALLOW_REGION_READ | | final public static int ALLOW_REGION_READ(Code) | | Specifies that this BoundingLeaf node allows read access to its
bounding region object.
|
| ALLOW_REGION_WRITE | | final public static int ALLOW_REGION_WRITE(Code) | | Specifies that this BoundingLeaf node allows write access to its
bounding region object.
|
| BoundingLeaf | | public BoundingLeaf()(Code) | | Constructs a BoundingLeaf node with a null (empty) bounding region.
|
| BoundingLeaf | | public BoundingLeaf(Bounds region)(Code) | | Constructs a BoundingLeaf node with the specified bounding region.
Parameters:
region - the bounding region of this leaf node |
| cloneNode | | public Node cloneNode(boolean forceDuplicate)(Code) | | Used to create a new instance of the node. This routine is called
by cloneTree to duplicate the current node.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: Node.cloneNode
See Also: Node.duplicateNode
See Also: NodeComponent.setDuplicateOnCloneTree |
| createRetained | | void createRetained()(Code) | | Creates the BoundingLeafRetained object that this
BoundingLeaf object will point to.
|
| duplicateAttributes | | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all BoundingLeaf information from
originalNode into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree method.
Parameters:
originalNode - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
exception:
RestrictedAccessException - if this object is part of a liveor compiled scenegraph.
See Also: Node.duplicateNode
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getRegion | | public Bounds getRegion()(Code) | | Retrieves this BoundingLeaf's bounding region.
the bounding region of this leaf node
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setRegion | | public void setRegion(Bounds region)(Code) | | Sets this BoundingLeaf node's bounding region.
Parameters:
region - the bounding region of this leaf node
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
|
|