org.xith3d.scenegraph
Class Clip

java.lang.Object
  extended by org.xith3d.scenegraph.SceneGraphObject
      extended by org.xith3d.scenegraph.Node
          extended by org.xith3d.scenegraph.Leaf
              extended by org.xith3d.scenegraph.Clip
All Implemented Interfaces:
org.jagatoo.datatypes.NamableObject, org.jagatoo.datatypes.NamedObject, org.openmali.spatial.SpatialNode

public class Clip
extends Leaf

Clip defines the far clipping plane used to clip objects.


Field Summary
 
Fields inherited from class org.xith3d.scenegraph.Node
bounds, boundsAutoCompute, boundsDirty, globalIgnoreBounds, instanceBoundsTypeHint, transformGroup, untransformedBounds
 
Fields inherited from class org.xith3d.scenegraph.SceneGraphObject
XITH3D_USERDATAKEY_OLDUSERDATA
 
Constructor Summary
Clip()
          Constructs a new Clip object.
Clip(float backDistance)
          Constructs a new Clip object with the specified back distance.
 
Method Summary
 void freeOpenGLResources(CanvasPeer canvasPeer)
          This method frees OpenGL resources (names) for all Nodes in the traversal of this Node(-Group).
 BoundingLeaf getApplicationBoundingLeaf()
          Sets the application bounding leaf for this object.
 org.openmali.spatial.bounds.Bounds getApplicationBounds()
          Gets the application bounding region for this object.
 float getBackDistance()
          Gets the back distance for this object.
 void setApplicationBoundingLeaf(BoundingLeaf boundingLeaf)
          Sets the application bounding leaf for this object.
 void setApplicationBounds(org.openmali.spatial.bounds.Bounds region)
          Sets the application bounding region for this object.
 void setBackDistance(float backDistance)
          Sets the back distance for this object.
 boolean traverse(DetailedTraversalCallback callback)
          Traverses the scenegraph from this node on.
 
Methods inherited from class org.xith3d.scenegraph.Leaf
dump, getPickHost, setPickHost
 
Methods inherited from class org.xith3d.scenegraph.Node
absorbDetails, cloneNode, detach, duplicateNode, freeOpenGLResources, getBounds, getBoundsAutoCompute, getBoundsType, getBoundsTypeHint, getDefaultPickable, getIndentString, getInheritedNodeAttributes, getModListener, getOrderedChild, getOrderedState, getParent, getRoot, getShadowAttachment, getShowBounds, getTransformGroup, getTreeCell, getWorldBounds, getWorldTransform, getWorldTransform, isBillboard, isIgnoreBounds, isOccluder, isPickable, isRenderable, isUpdatableNode, mergeInheritedClipper, mergeInheritedNodes, mergeInheritedScissorRect, popGlobalIgnoreBounds, printBounds, pushGlobalIgnoreBounds, setBounds, setBoundsAutoCompute, setBoundsDirty, setBoundsDirtyUpward, setBoundsTypeHint, setDefaultPickable, setGlobalIgnoreBounds, setIgnoreBounds, setIsOccluder, setModListener, setOrderedChild, setParent, setPickable, setPickableRecursive, setPickableRecursive, setRenderable, setShadowAttachment, setShowBounds, setTransformGroup, setTreeCell, sharedCopy, sharedCopy, traverse, unmergeInheritedFog, unmergeInheritedLight, unmergeInheritedNodes, updateBounds, updateBoundsCheap, updateOrderedChild, updateTransformGroup, updateWorldTransform
 
Methods inherited from class org.xith3d.scenegraph.SceneGraphObject
getName, getUserData, getUserData, getUserDataMap, isLive, setLive, setName, setUserData, setUserData, setUserDataRecursive, setUserDataRecursive, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Clip

public Clip()
Constructs a new Clip object.


Clip

public Clip(float backDistance)
Constructs a new Clip object with the specified back distance.

Method Detail

setBackDistance

public final void setBackDistance(float backDistance)
Sets the back distance for this object.


getBackDistance

public final float getBackDistance()
Gets the back distance for this object.


setApplicationBounds

public final void setApplicationBounds(org.openmali.spatial.bounds.Bounds region)
Sets the application bounding region for this object.


getApplicationBounds

public final org.openmali.spatial.bounds.Bounds getApplicationBounds()
Gets the application bounding region for this object.


setApplicationBoundingLeaf

public final void setApplicationBoundingLeaf(BoundingLeaf boundingLeaf)
Sets the application bounding leaf for this object.


getApplicationBoundingLeaf

public final BoundingLeaf getApplicationBoundingLeaf()
Sets the application bounding leaf for this object.


freeOpenGLResources

public void freeOpenGLResources(CanvasPeer canvasPeer)
This method frees OpenGL resources (names) for all Nodes in the traversal of this Node(-Group).

Specified by:
freeOpenGLResources in class Node

traverse

public boolean traverse(DetailedTraversalCallback callback)
Traverses the scenegraph from this node on. If this Node is a Group it will recusively run through each child.

Overrides:
traverse in class Leaf
Parameters:
callback - the listener is notified of any traversed Node on the way
Returns:
if false, the whole traversal will stop