javax.media.j3d
Class ClipRetained

java.lang.Object
  extended by javax.media.j3d.IndexedObject
      extended by javax.media.j3d.SceneGraphObjectRetained
          extended by javax.media.j3d.NodeRetained
              extended by javax.media.j3d.LeafRetained
                  extended by javax.media.j3d.ClipRetained
All Implemented Interfaces:
java.lang.Cloneable, NnuId

 class ClipRetained
extends LeafRetained

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

Field Summary
(package private)  Bounds applicationRegion
          The Boundary object defining the application region.
(package private)  double backDistance
          Clip's back distance
(package private) static int BACKDISTANCE_CHANGED
           
(package private)  double backDistanceInVworld
          back distance scaled to vworld
(package private)  BoundingLeafRetained boundingLeaf
          The bounding leaf reference
(package private) static int BOUNDINGLEAF_CHANGED
           
(package private) static int BOUNDS_CHANGED
           
(package private)  boolean inImmCtx
           
(package private)  boolean isViewScoped
           
(package private) static int targetThreads
           
(package private)  Bounds transformedRegion
          The transformed value of the applicationRegion.
 
Fields inherited from class javax.media.j3d.LeafRetained
boundsDirty, switchState
 
Fields inherited from class javax.media.j3d.NodeRetained
ALTERNATEAPPEARANCE, AMBIENTLIGHT, apiBounds, BACKGROUND, BACKGROUNDSOUND, BEHAVIOR, BOUNDINGLEAF, boundsAutoCompute, BRANCHGROUP, branchGroupPaths, cachedBounds, childIndex, CLIP, collidable, CONESOUND, CONTAINS_VIEWPLATFORM, CURRENT_LOCAL_TO_VWORLD, DECALGROUP, DIRECTIONALLIGHT, EXPONENTIALFOG, geometryBackground, GROUP, inSharedGroup, LAST_LOCAL_TO_VWORLD, LINEARFOG, LINK, localBounds, locale, localToVworld, localToVworldIndex, localToVworldKeys, MODELCLIP, MORPH, nnuId, nodeId, nodeType, NUMNODES, ORDEREDGROUP, orderedId, ORIENTEDSHAPE3D, parent, parentSwitchLink, parentTransformLink, pickable, POINTLIGHT, POINTSOUND, refCount, SHAPE, SHAREDGROUP, SOUNDSCAPE, SPOTLIGHT, staticTransform, SWITCH, TRANSFORMGROUP, universe, validCachedBounds, VIEWPLATFORM, VIEWSPECIFICGROUP
 
Fields inherited from class javax.media.j3d.SceneGraphObjectRetained
DONT_MERGE, inBackgroundGroup, inSetLive, MERGE, MERGE_DONE, mergeFlag, onUpdateList, source
 
Fields inherited from class javax.media.j3d.IndexedObject
listIdx
 
Constructor Summary
ClipRetained()
          Constructs a Clip node with a default color (black).
 
Method Summary
(package private)  void clearLive(SetLiveState s)
          This clearLive routine first calls the superclass's method, then it removes itself to the list of lights
(package private)  BoundingLeaf getApplicationBoundingLeaf()
          Get the Clip's application region
(package private)  Bounds getApplicationBounds()
          Get the Backgound's application region.
(package private)  double getBackDistance()
          Retrieves the clip's back distance.
(package private)  boolean getInImmCtx()
          This gets the immedate mode context flag
(package private)  void getMirrorObjects(java.util.ArrayList leafList, HashKey key)
           
(package private)  void initApplicationBoundingLeaf(BoundingLeaf region)
          Initializes the Clip's application region to the specified Leaf node.
(package private)  void initApplicationBounds(Bounds region)
          Initializes the Clip's application region.
(package private)  void initBackDistance(double backDistance)
          initializes the clip's back distance to the specified value.
(package private)  void initMirrorObject()
           
(package private)  void mergeTransform(TransformGroupRetained xform)
           
(package private)  void sendMessage(int attrMask, java.lang.Object attr, java.lang.Object attr2)
           
(package private)  void setApplicationBoundingLeaf(BoundingLeaf region)
          Set the Clip's application region to the specified Leaf node.
(package private)  void setApplicationBounds(Bounds region)
          Set the Clip's application region.
(package private)  void setBackDistance(double backDistance)
          Sets the clip's back distance to the specified value.
(package private)  void setInImmCtx(boolean inCtx)
          This sets the immedate mode context flag
(package private)  void setLive(SetLiveState s)
          This setLive routine first calls the superclass's method, then it adds itself to the list of lights
(package private)  void updateBoundingLeaf()
          Note: This routine will only be called on the mirror object - will update the object's cached region and transformed region
(package private)  void updateImmediateMirrorObject(java.lang.Object[] objs)
           
(package private)  void updateImmediateTransformChange()
           
 
Methods inherited from class javax.media.j3d.LeafRetained
clone, updateBounds, updateMirrorObject, updateTransformChange
 
Methods inherited from class javax.media.j3d.NodeRetained
computeCombineBounds, computeNonLiveLocalToVworld, dirtyBoundsCache, doSetLive, equal, findCollidableFlags, findPickableFlags, findTransformLevels, getBounds, getBoundsAutoCompute, getCollidable, getCurrentLocalToVworld, getCurrentLocalToVworld, getCurrentLocalToVworld, getEffectiveBounds, getId, getLastLocalToVworld, getLastLocalToVworld, getLastLocalToVworld, getLocalBounds, getLocale, getLocalToVworld, getLocalToVworld, getLocalToVworld, getParent, getPickable, getVirtualUniverse, isStatic, merge, notifySceneGraphChanged, processViewSpecificInfo, recombineAbove, removeNodeData, searchGeometryAtoms, setAuxData, setBounds, setBoundsAutoCompute, setCollidable, setNodeData, setParent, setPickable, transformBounds, updateCollidable, updateLocalToVworld, updatePickable
 
Methods inherited from class javax.media.j3d.SceneGraphObjectRetained
clearLive, clearLive, clone, compile, doSetLive, getSource, handleFrequencyChange, isInSetLive, markAsLive, setCompiled, setLive, setSource, traverse
 
Methods inherited from class javax.media.j3d.IndexedObject
getIdxUsed, incIdxUsed
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BOUNDS_CHANGED

static final int BOUNDS_CHANGED
See Also:
Constant Field Values

BOUNDINGLEAF_CHANGED

static final int BOUNDINGLEAF_CHANGED
See Also:
Constant Field Values

BACKDISTANCE_CHANGED

static final int BACKDISTANCE_CHANGED
See Also:
Constant Field Values

backDistance

double backDistance
Clip's back distance


backDistanceInVworld

double backDistanceInVworld
back distance scaled to vworld


applicationRegion

Bounds applicationRegion
The Boundary object defining the application region.


boundingLeaf

BoundingLeafRetained boundingLeaf
The bounding leaf reference


transformedRegion

Bounds transformedRegion
The transformed value of the applicationRegion.


inImmCtx

boolean inImmCtx

targetThreads

static final int targetThreads
See Also:
Constant Field Values

isViewScoped

boolean isViewScoped
Constructor Detail

ClipRetained

ClipRetained()
Constructs a Clip node with a default color (black).

Method Detail

initBackDistance

final void initBackDistance(double backDistance)
initializes the clip's back distance to the specified value.

Parameters:
backDistance - the new back clipping distance

setBackDistance

final void setBackDistance(double backDistance)
Sets the clip's back distance to the specified value.

Parameters:
backDistance - the new back clipping distance

getBackDistance

final double getBackDistance()
Retrieves the clip's back distance.

Returns:
the current back clipping distance

initApplicationBounds

final void initApplicationBounds(Bounds region)
Initializes the Clip's application region.

Parameters:
region - a region that contains the Backgound's new application bounds

setApplicationBounds

final void setApplicationBounds(Bounds region)
Set the Clip's application region.

Parameters:
region - a region that contains the Clip's new application bounds

getApplicationBounds

final Bounds getApplicationBounds()
Get the Backgound's application region.

Returns:
this Clip's application bounds information

initApplicationBoundingLeaf

void initApplicationBoundingLeaf(BoundingLeaf region)
Initializes the Clip's application region to the specified Leaf node.


setApplicationBoundingLeaf

void setApplicationBoundingLeaf(BoundingLeaf region)
Set the Clip's application region to the specified Leaf node.


getApplicationBoundingLeaf

BoundingLeaf getApplicationBoundingLeaf()
Get the Clip's application region


setInImmCtx

void setInImmCtx(boolean inCtx)
This sets the immedate mode context flag


getInImmCtx

boolean getInImmCtx()
This gets the immedate mode context flag


setLive

void setLive(SetLiveState s)
This setLive routine first calls the superclass's method, then it adds itself to the list of lights

Overrides:
setLive in class NodeRetained

clearLive

void clearLive(SetLiveState s)
This clearLive routine first calls the superclass's method, then it removes itself to the list of lights

Overrides:
clearLive in class NodeRetained

initMirrorObject

void initMirrorObject()

updateImmediateMirrorObject

void updateImmediateMirrorObject(java.lang.Object[] objs)

updateBoundingLeaf

void updateBoundingLeaf()
Note: This routine will only be called on the mirror object - will update the object's cached region and transformed region

Overrides:
updateBoundingLeaf in class LeafRetained

updateImmediateTransformChange

void updateImmediateTransformChange()

sendMessage

final void sendMessage(int attrMask,
                       java.lang.Object attr,
                       java.lang.Object attr2)

mergeTransform

void mergeTransform(TransformGroupRetained xform)
Overrides:
mergeTransform in class NodeRetained

getMirrorObjects

void getMirrorObjects(java.util.ArrayList leafList,
                      HashKey key)
Overrides:
getMirrorObjects in class LeafRetained


Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.