|
| |
|
| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Clip
| Clip | | public class Clip extends Leaf (Code) | | The Clip leaf node defines the back, or far, clip distance in
the virtual universe.
The distance is specified in the local coordinate system of this node.
This node also specifies an application
region in which this clip node is active.
A Clip node is active when its application region intersects
the ViewPlatform's activation volume. If multiple Clip nodes
are active, the Clip node that is "closest" to the eye will be
used.
If no clip node is in scope of the view platform
associated with the current view, then the back clip distance is
defined by the View object.
The front clip distance is always defined by the
View object.
See Also: View |
| Field Summary | |
| final public static int | ALLOW_APPLICATION_BOUNDS_READ
Specifies that the Clip allows read access to its application
bounds and bounding leaf at runtime. | | final public static int | ALLOW_APPLICATION_BOUNDS_WRITE
Specifies that the Clip allows write access to its application
bounds and bounding leaf at runtime. | | final public static int | ALLOW_BACK_DISTANCE_READ
Specifies that the Clip allows read access to its back distance
at runtime. | | final public static int | ALLOW_BACK_DISTANCE_WRITE
Specifies that the Clip allows write access to its back distance
at runtime. |
| Constructor Summary | |
| public | Clip()
Constructs a Clip node with default parameters. | | public | Clip(double backDistance)
Constructs a Clip node with the specified back clip distance. |
| Method Summary | |
| public Node | cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. | | void | createRetained()
Creates the retained mode ClipRetained object that this
Clip component object will point to. | | void | duplicateAttributes(Node originalNode, boolean forceDuplicate)
Copies all Clip information from
originalNode into
the current node. | | public BoundingLeaf | getApplicationBoundingLeaf()
Retrieves the Clip node's application bounding leaf. | | public Bounds | getApplicationBounds()
Retrieves the Clip node's application bounds. | | public double | getBackDistance()
Retrieves the back clip distance. | | public void | setApplicationBoundingLeaf(BoundingLeaf region)
Set the Clip's application region to the specified bounding leaf. | | public void | setApplicationBounds(Bounds region)
Set the Clip's application region to the specified bounds. | | public void | setBackDistance(double backDistance)
Sets the back clip distance to the specified value.
There are several considerations that need to be taken into
account when choosing values for the front and back clip
distances. | | public void | updateNodeReferences(NodeReferenceTable referenceTable)
Callback used to allow a node to check if any scene graph objects
referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. |
| ALLOW_APPLICATION_BOUNDS_READ | | final public static int ALLOW_APPLICATION_BOUNDS_READ(Code) | | Specifies that the Clip allows read access to its application
bounds and bounding leaf at runtime.
|
| ALLOW_APPLICATION_BOUNDS_WRITE | | final public static int ALLOW_APPLICATION_BOUNDS_WRITE(Code) | | Specifies that the Clip allows write access to its application
bounds and bounding leaf at runtime.
|
| ALLOW_BACK_DISTANCE_READ | | final public static int ALLOW_BACK_DISTANCE_READ(Code) | | Specifies that the Clip allows read access to its back distance
at runtime.
|
| ALLOW_BACK_DISTANCE_WRITE | | final public static int ALLOW_BACK_DISTANCE_WRITE(Code) | | Specifies that the Clip allows write access to its back distance
at runtime.
|
| Clip | | public Clip()(Code) | | Constructs a Clip node with default parameters. The default
values are as follows:
back clip distance : 100 meters
application bounds : null
application bounding leaf : null
|
| Clip | | public Clip(double backDistance)(Code) | | Constructs a Clip node with the specified back clip distance.
|
| 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 retained mode ClipRetained object that this
Clip component object will point to.
|
| duplicateAttributes | | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all Clip 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 |
| getApplicationBoundingLeaf | | public BoundingLeaf getApplicationBoundingLeaf()(Code) | | Retrieves the Clip node's application bounding leaf.
this Clip's application bounding leaf information
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getApplicationBounds | | public Bounds getApplicationBounds()(Code) | | Retrieves the Clip node's application bounds.
this Clip's application bounds information
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getBackDistance | | public double getBackDistance()(Code) | | Retrieves the back clip distance.
the current back clip distance, in meters |
| setApplicationBoundingLeaf | | public void setApplicationBoundingLeaf(BoundingLeaf region)(Code) | | Set the Clip's application region to the specified bounding leaf.
When set to a value other than null, this overrides the application
bounds object.
Parameters:
region - the bounding leaf node used to specify the Clipnode's new application region.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setApplicationBounds | | public void setApplicationBounds(Bounds region)(Code) | | Set the Clip's application region to the specified bounds.
This is used when the application bounding leaf is set to null.
Parameters:
region - the bounds that contains the Clip's new applicationregion.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setBackDistance | | public void setBackDistance(double backDistance)(Code) | | Sets the back clip distance to the specified value.
There are several considerations that need to be taken into
account when choosing values for the front and back clip
distances. These are enumerated in the description of
View.setFrontClipDistance.
Parameters:
backDistance - the new back clip distance in meters
See Also: View.setFrontClipDistance
See Also: View.setBackClipDistance |
| updateNodeReferences | | public void updateNodeReferences(NodeReferenceTable referenceTable)(Code) | | Callback used to allow a node to check if any scene graph objects
referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. The cloned Leaf node's method
will be called and the Leaf node can then look up any object references
by using the getNewObjectReference method found in the
NodeReferenceTable object. If a match is found, a
reference to the corresponding object in the newly cloned sub-graph
is returned. If no corresponding reference is found, either a
DanglingReferenceException is thrown or a reference to the original
object is returned depending on the value of the
allowDanglingReferences parameter passed in the
cloneTree call.
NOTE: Applications should not call this method directly.
It should only be called by the cloneTree method.
Parameters:
referenceTable - a NodeReferenceTableObject that contains thegetNewObjectReference method needed to search fornew object instances.
See Also: NodeReferenceTable
See Also: Node.cloneTree
See Also: DanglingReferenceException |
|
|
|