javax.media.j3d
Class ViewPlatformRetained

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.ViewPlatformRetained
All Implemented Interfaces:
java.lang.Cloneable, NnuId

 class ViewPlatformRetained
extends LeafRetained

ViewPlatform object (retained side)


Field Summary
(package private)  Point3d center
           
(package private) static java.lang.Object[] emptyObj
           
(package private) static Transform3D identity
           
(package private)  Locale locale
           
(package private)  BoundingSphere schedSphere
          This is the cached bounding sphere used for the activation volume.
(package private)  BoundingSphere sphere
          Position used for placing this view platform.
(package private) static int TOTAL_INDEXED_UNORDER_SET_TYPES
           
(package private)  int viewAttachPolicy
          This variable specifies the policy Java 3D will use in placing the user's eye point as a function of head position.
private  java.util.ArrayList viewList
          The list of views associated with this view platform.
(package private)  boolean viewListDirty
           
private  View[] views
          Cached list of viewList for synchronization
(package private) static int VP_IN_BS_LIST
           
(package private)  Transform3D vpcToVworld
           
(package private)  int vprDirtyMask
           
(package private)  Transform3D vworldToVpc
          The current cached view platform transform (vworldToVpc) and its inverse (vpcToVworld).
(package private) static Point3d zeroPoint
           
 
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, 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
ViewPlatformRetained()
           
 
Method Summary
(package private)  void clearLive(SetLiveState s)
          This clearLive routine first calls the superclass's method, then it deactivates all canvases that are associated with the attached view.
(package private)  void compile(CompileState compState)
          This is the default compile() method, which just marks the sgo as compiled.
(package private)  void evaluateInitViewPlatformTransform()
           
(package private)  void evaluateInitViewPlatformTransform(NodeRetained node, Transform3D trans)
          Evaluate the view platform transform by traversing *up* the tree from this ViewPlatform node, computing the composite model transform along the way.
(package private)  void evaluateViewPlatformTransform()
           
(package private)  float getActivationRadius()
          Get the ViewPlatform's activation radius
(package private)  int getViewAttachPolicy()
          Returns the current coexistence center in virtual-world policy.
(package private)  View[] getViewList()
          Get a copy of cached view list
(package private)  Transform3D getVpcToVworld()
           
(package private)  Transform3D getVworldToVpc()
           
(package private)  boolean isActiveViewPlatform()
          Use by BehaviorStructure to determine whether current ViewPlatform is active or not.
(package private)  void processSwitchChanged()
           
(package private)  void reEvaluateView()
          Re-evaluate all View active status reference to this view platform.
(package private)  void removeView(View v)
           
(package private)  void repaint()
           
(package private)  void setActivationRadius(float activationRadius)
          Set the ViewPlatform's activation radius
(package private)  void setLive(SetLiveState s)
          This setLive routine first calls the superclass's method, then it evaluates the view platform transform, and then it activates all canvases that are associated with the attached view.
(package private)  void setView(View v)
          This sets the view that is associated with this view platform.
(package private)  void setViewAttachPolicy(int policy)
          Sets the coexistence center in virtual world policy.
(package private)  void updateActivationRadius(float radius)
           
(package private)  void updateTransformRegion()
           
 
Methods inherited from class javax.media.j3d.LeafRetained
clone, getMirrorObjects, updateBoundingLeaf, 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, mergeTransform, 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, 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

VP_IN_BS_LIST

static final int VP_IN_BS_LIST
See Also:
Constant Field Values

TOTAL_INDEXED_UNORDER_SET_TYPES

static final int TOTAL_INDEXED_UNORDER_SET_TYPES
See Also:
Constant Field Values

viewAttachPolicy

int viewAttachPolicy
This variable specifies the policy Java 3D will use in placing the user's eye point as a function of head position. The variable can contain one of NOMINAL_SCREEN, NOMINAL_HEAD, or NOMINAL_FEET.


viewList

private java.util.ArrayList viewList
The list of views associated with this view platform. Use getViewList() to access this variable.


views

private View[] views
Cached list of viewList for synchronization


locale

Locale locale

viewListDirty

boolean viewListDirty

vworldToVpc

Transform3D vworldToVpc
The current cached view platform transform (vworldToVpc) and its inverse (vpcToVworld).


vpcToVworld

Transform3D vpcToVworld

sphere

BoundingSphere sphere
Position used for placing this view platform.


schedSphere

BoundingSphere schedSphere
This is the cached bounding sphere used for the activation volume.


center

Point3d center

zeroPoint

static final Point3d zeroPoint

vprDirtyMask

int vprDirtyMask

emptyObj

static final java.lang.Object[] emptyObj

identity

static final Transform3D identity
Constructor Detail

ViewPlatformRetained

ViewPlatformRetained()
Method Detail

setViewAttachPolicy

void setViewAttachPolicy(int policy)
Sets the coexistence center in virtual world policy. This setting determines how Java 3D places the user's eye point as a function of head position. The variable can contain one of NOMINAL_SCREEN, NOMINAL_HEAD, or NOMINAL_FEET.

Parameters:
policy - the new policy, one of NOMINAL_SCREEN, NOMINAL_HEAD, or NOMINAL_FEET

repaint

void repaint()

getViewAttachPolicy

int getViewAttachPolicy()
Returns the current coexistence center in virtual-world policy.

Returns:
one of: NOMINAL_SCREEN, NOMINAL_HEAD, or NOMINAL_FEET

setActivationRadius

void setActivationRadius(float activationRadius)
Set the ViewPlatform's activation radius


getActivationRadius

float getActivationRadius()
Get the ViewPlatform's activation radius


setView

void setView(View v)
This sets the view that is associated with this view platform.


removeView

void removeView(View v)

getVworldToVpc

Transform3D getVworldToVpc()

getVpcToVworld

Transform3D getVpcToVworld()

evaluateViewPlatformTransform

void evaluateViewPlatformTransform()

evaluateInitViewPlatformTransform

void evaluateInitViewPlatformTransform(NodeRetained node,
                                       Transform3D trans)
Evaluate the view platform transform by traversing *up* the tree from this ViewPlatform node, computing the composite model transform along the way. Because we are traversing bottom to top, we must multiply each TransformGroup's matrix on the left by the composite transform on the right (rather than the other way around as is usually done). Once we have the composite model transform for this ViewPlatform--the vpcToVworld transform--we simply invert it to get the vworldToVpc transform.


evaluateInitViewPlatformTransform

void evaluateInitViewPlatformTransform()

updateActivationRadius

void updateActivationRadius(float radius)

updateTransformRegion

void updateTransformRegion()

setLive

void setLive(SetLiveState s)
This setLive routine first calls the superclass's method, then it evaluates the view platform transform, and then it activates all canvases that are associated with the attached view.

Overrides:
setLive in class NodeRetained

clearLive

void clearLive(SetLiveState s)
This clearLive routine first calls the superclass's method, then it deactivates all canvases that are associated with the attached view.

Overrides:
clearLive in class NodeRetained

reEvaluateView

void reEvaluateView()
Re-evaluate all View active status reference to this view platform. This procedure is called from RenderBin when switch above a view platform changed.


getViewList

View[] getViewList()
Get a copy of cached view list


isActiveViewPlatform

boolean isActiveViewPlatform()
Use by BehaviorStructure to determine whether current ViewPlatform is active or not.


processSwitchChanged

void processSwitchChanged()

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 SceneGraphObjectRetained


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