All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.Clip 

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.Node
                   |
                   +----java.media.j3d.Leaf
                           |
                           +----java.media.j3d.Clip
public class Clip
extends Leaf
The Clip leaf node defines the back, or far, clipping distance in the virtual universe. The front clipping plane is defined in the View object. If no clip node is in scope of the view platform associated with the current view, then the back clipping plane is also defined by the View.

See Also:
View

Constructor Index

o Clip(float)
Constructs a Clip node with the specified back clipping distance.

Method Index

o getApplicationBoundingLeaf()
Retrieves the Clip node's application bounding leaf.
o getApplicationBounds()
Retrieves the Clip node's application bounds.
o getBackDistance()
Retrieves the back clipping distance.
o setApplicationBoundingLeaf(BoundingLeaf)
Set the Clip's application region to the specified bounding leaf.
o setApplicationBounds(Bounds)
Set the Clip's application region to the specified bounds.
o setBackDistance(float)
Sets the back clipping distance to the specified value.

Constructors

o Clip 
 public Clip(float backDistance)
Constructs a Clip node with the specified back clipping distance.

Methods

o setBackDistance 
 public final void setBackDistance(float backDistance)
Sets the back clipping distance to the specified value.

Parameters:
backDistance - the new back clipping distance
See Also:
setFrontClipDistance, setBackClipDistance
o getBackDistance 
 public final float getBackDistance()
Retrieves the back clipping distance.

Returns:
the current back clipping distance
o setApplicationBounds 
 public final void setApplicationBounds(Bounds region)
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 application region.
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getApplicationBounds 
 public final Bounds getApplicationBounds()
Retrieves the Clip node's application bounds.

Returns:
this Clip's application bounds information
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setApplicationBoundingLeaf 
 public final void setApplicationBoundingLeaf(BoundingLeaf region)
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 Clip node's new application region.
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getApplicationBoundingLeaf 
 public final BoundingLeaf getApplicationBoundingLeaf()
Retrieves the Clip node's application bounding leaf.

Returns:
this Clip's application bounding leaf information
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph 
All Packages  Class Hierarchy  This Package  Previous  Next  Index