javax.media.j3d
Class BranchGroupRetained

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.GroupRetained
                  extended by javax.media.j3d.BranchGroupRetained
All Implemented Interfaces:
java.lang.Cloneable, BHLeafInterface, NnuId

 class BranchGroupRetained
extends GroupRetained

The BranchGroup node provides the ability to insert a branch of a scene graph into the virtual world.


Field Summary
(package private)  boolean attachedToLocale
          True, if this branchGroup is directly attached to the locale
(package private)  boolean isDirty
           
(package private)  boolean isNew
           
 
Fields inherited from class javax.media.j3d.GroupRetained
allocatedAltApps, allocatedFogs, allocatedLights, allocatedMclips, altAppearances, bhLeafNode, children, childrenSwitchLinks, collisionBound, collisionTarget, collisionVwcBounds, compiledChildrenList, fogs, inViewSpecificGroup, isInClearLive, isRoot, key, lights, locale, mirrorGroup, modelClips, orderedPaths, parentSwitchLinkChildIndex, scopingRefCount, sourceNode, viewLists
 
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, 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
BranchGroupRetained()
           
 
Method Summary
(package private)  void compile()
           
(package private)  void compile(CompileState compState)
          This is the default compile() method, which just marks the sgo as compiled.
(package private)  void detach()
          Detaches this BranchGroup from its parent.
(package private)  void do_detach()
           
(package private)  Locale getLocale()
          This gets the current locale
(package private)  PickInfo[] pickAll(int mode, int flags, PickShape pickShape)
           
(package private)  SceneGraphPath[] pickAll(PickShape pickShape)
           
(package private)  PickInfo[] pickAllSorted(int mode, int flags, PickShape pickShape)
           
(package private)  SceneGraphPath[] pickAllSorted(PickShape pickShape)
           
(package private)  PickInfo pickAny(int mode, int flags, PickShape pickShape)
           
(package private)  SceneGraphPath pickAny(PickShape pickShape)
           
(package private)  PickInfo pickClosest(int mode, int flags, PickShape pickShape)
           
(package private)  SceneGraphPath pickClosest(PickShape pickShape)
           
(package private)  void removeNodeData(SetLiveState s)
          remove the localToVworld transform for this node.
(package private)  void setAuxData(SetLiveState s, int index, int hkIndex)
           
(package private)  void setLive(SetLiveState s)
           
(package private)  void setLocale(Locale loc)
          This sets the current locale.
(package private)  void setNodeData(SetLiveState s)
           
 
Methods inherited from class javax.media.j3d.GroupRetained
addAllNodesForScopedAltApp, addAllNodesForScopedFog, addAllNodesForScopedLight, addAllNodesForScopedModelClip, addAltApp, addChild, addFog, addLight, addModelClip, appendChildrenData, checkClearLive, checkClearLive, checkSetLive, checkSetLive, checkValidChild, childCheckSetLive, childDoSetLive, clearLive, computeBoundingHull, computeCombineBounds, createMirrorGroup, doAddChild, doInsertChild, doMoveTo, doRemoveChild, doSetChild, doSetLive, findSwitchInfo, gatherBlUsers, getAllChildren, getAlternateCollisionTarget, getBounds, getChild, getClosestTargetsInterface, getCollisionBounds, getEffectiveBounds, getLocale2, indexOfChild, initSwitchStates, initTransformStates, insertChild, insertChildrenData, isEnable, isEnable, isNodeSwitchOn, isStatic, isStaticChildren, merge, moveTo, numChildren, processAddNodesForScopedAltApp, processAddNodesForScopedFog, processAddNodesForScopedModelClip, processAllNodesForScopedLight, processCollisionTarget, processRemoveAllNodesForScopedFog, processRemoveAllNodesForScopedLight, processRemoveAllNodesForScopedModelClip, processRemoveNodesForScopedAltApp, processViewSpecificInfo, removeAllChildren, removeAllNodesForScopedAltApp, removeAllNodesForScopedFog, removeAllNodesForScopedLight, removeAllNodesForScopedModelClip, removeAltApp, removeAltAppScope, removeChild, removeChild, removeChildrenData, removeFog, removeFogScope, removeLight, removeLightScope, removeMclipScope, removeModelClip, searchGeometryAtoms, setAltAppScope, setAlternateCollisionTarget, setBounds, setBoundsAutoCompute, setChild, setCollisionBounds, setCompiled, setFogScope, setLightScope, setMclipScope, setScopingInfo, traverse, updateCollidable, updateLocalToVworld, updatePickable, updateSwitchStates, updateTransformStates, usedInScoping, validSwitchChild
 
Methods inherited from class javax.media.j3d.NodeRetained
computeNonLiveLocalToVworld, dirtyBoundsCache, equal, findCollidableFlags, findPickableFlags, findTransformLevels, getBoundsAutoCompute, getCollidable, getCurrentLocalToVworld, getCurrentLocalToVworld, getCurrentLocalToVworld, getId, getLastLocalToVworld, getLastLocalToVworld, getLastLocalToVworld, getLocalBounds, getLocalToVworld, getLocalToVworld, getLocalToVworld, getParent, getPickable, getVirtualUniverse, mergeTransform, notifySceneGraphChanged, recombineAbove, setCollidable, setParent, setPickable, transformBounds
 
Methods inherited from class javax.media.j3d.SceneGraphObjectRetained
clearLive, clearLive, clone, doSetLive, getSource, handleFrequencyChange, isInSetLive, markAsLive, setLive, setSource
 
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

isDirty

boolean isDirty

isNew

boolean isNew

attachedToLocale

boolean attachedToLocale
True, if this branchGroup is directly attached to the locale

Constructor Detail

BranchGroupRetained

BranchGroupRetained()
Method Detail

setLocale

void setLocale(Locale loc)
This sets the current locale.


getLocale

Locale getLocale()
This gets the current locale

Overrides:
getLocale in class NodeRetained

detach

void detach()
Detaches this BranchGroup from its parent.


do_detach

void do_detach()

setNodeData

void setNodeData(SetLiveState s)
Overrides:
setNodeData in class GroupRetained

setAuxData

void setAuxData(SetLiveState s,
                int index,
                int hkIndex)
Overrides:
setAuxData in class NodeRetained

removeNodeData

void removeNodeData(SetLiveState s)
remove the localToVworld transform for this node.

Overrides:
removeNodeData in class GroupRetained

setLive

void setLive(SetLiveState s)
Overrides:
setLive in class GroupRetained

compile

void compile()

compile

void compile(CompileState compState)
Description copied from class: SceneGraphObjectRetained
This is the default compile() method, which just marks the sgo as compiled.

Overrides:
compile in class GroupRetained

pickAll

SceneGraphPath[] pickAll(PickShape pickShape)

pickAll

PickInfo[] pickAll(int mode,
                   int flags,
                   PickShape pickShape)

pickAllSorted

SceneGraphPath[] pickAllSorted(PickShape pickShape)

pickAllSorted

PickInfo[] pickAllSorted(int mode,
                         int flags,
                         PickShape pickShape)

pickClosest

SceneGraphPath pickClosest(PickShape pickShape)

pickClosest

PickInfo pickClosest(int mode,
                     int flags,
                     PickShape pickShape)

pickAny

SceneGraphPath pickAny(PickShape pickShape)

pickAny

PickInfo pickAny(int mode,
                 int flags,
                 PickShape pickShape)


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