| java.lang.Object javax.media.j3d.SceneGraphObject javax.media.j3d.Node javax.media.j3d.Leaf javax.media.j3d.ViewPlatform
ViewPlatform | public class ViewPlatform extends Leaf (Code) | | The ViewPlatform leaf node object controls the position, orientation
and scale of the viewer. It is the node in the scene graph that a
View object connects to. A viewer navigates through the virtual
universe by changing the transform in the scene graph hierarchy above
the ViewPlatform.
The View Attach Policy
The actual view that Java 3D's renderer draws depends on the view
attach policy specified within the currently attached ViewPlatform.
The view attach policy, set by the setViewAttachPolicy
method, is one of the following:
- View.NOMINAL_HEAD - ensures that the end-user's nominal eye
position in the physical world corresponds to the virtual eye's
nominal eye position in the virtual world (the ViewPlatform's origin).
In essence, this policy tells Java 3D to position the virtual eyepoint
relative to the ViewPlatform origin in the same way as the physical
eyepoint is positioned relative to its nominal physical-world
origin. Deviations in the physical eye's position and orientation from
nominal in the physical world generate corresponding deviations of the
virtual eye's position and orientation in the virtual world. This
is the default view attach policy.
- View.NOMINAL_FEET - ensures that the end-user's virtual feet
always touch the virtual ground. This policy tells Java 3D to compute
the physical-to-virtual-world correspondence in a way that enforces
this constraint. Java 3D does so by appropriately offsetting the
physical eye's position by the end-user's physical height. Java 3D
uses the nominalEyeHeightFromGround parameter found in the
PhysicalBody object to perform this computation.
- View.NOMINAL_SCREEN - allows an application to always have
the virtual eyepoint appear at some "viewable" distance from a point
of interest. This policy tells Java 3D to compute the
physical-to-virtual-world correspondence in a way
that ensures that the renderer moves the nominal virtual eyepoint
away from the point of interest by the amount specified by the
nominalEyeOffsetFromNominalScreen parameter found in the
PhysicalBody object.
Activation Radius
The ViewPlatform's activation radius defines an activation
volume surrounding the center of the ViewPlatform. This activation
volume is a spherical region that intersects with the scheduling regions
and application regions
of other leaf node objects to determine which of those objects may
affect rendering. Only active view platforms--that is, view platforms
attached to a View--will be used to schedule or select other leaf nodes.
Different leaf objects interact with the ViewPlatform's activation
volume differently. The Background, Clip, and Soundscape leaf objects
each define a set of attributes and an application region in which
those attributes are applied. If more than one node of a given type
(Background, Clip, or Soundscape) intersects an active ViewPlatform's
activation volume, the "most appropriate" node is selected for that View.
Sound leaf objects and Behavior objects become active when
their scheduling region intersects an active ViewPlatform's activation
volume.
The activation radius is in view platform coordinates. For the
default screen scale policy of SCALE_SCREEN_SIZE, the
activationRadius parameter value is multiplied by half the
monitor screen size to derive the actual activation radius. For example,
for the default screen size of 0.35 meters, and the default activation
radius value of 62, the actual activation radius would be 10.85
meters.
See Also: View |
Field Summary | |
final public static int | ALLOW_POLICY_READ Specifies that the ViewPlatform allows read access to its view
attach policy information at runtime. | final public static int | ALLOW_POLICY_WRITE Specifies that the ViewPlatform allows write access to its view
attach policy information at runtime. |
Constructor Summary | |
public | ViewPlatform() Constructs a ViewPlatform object with default parameters. |
Method Summary | |
public Node | cloneNode(boolean forceDuplicate) Used to create a new instance of the node. | void | createRetained() Creates the retained mode ViewPlatformRetained object that this
ViewPlatform component object will point to. | void | duplicateAttributes(Node originalNode, boolean forceDuplicate) Copies all ViewPlatform information from originalNode into
the current node. | public float | getActivationRadius() Get the ViewPlatform's activation radius. | public int | getViewAttachPolicy() Returns the current coexistence center in virtual-world policy. | public void | setActivationRadius(float activationRadius) Set the ViewPlatform's activation radius which defines an activation
volume around the view platform. | public void | setViewAttachPolicy(int policy) Sets the view attach policy that determines the coexistence center
in the virtual world. |
ALLOW_POLICY_READ | final public static int ALLOW_POLICY_READ(Code) | | Specifies that the ViewPlatform allows read access to its view
attach policy information at runtime.
|
ALLOW_POLICY_WRITE | final public static int ALLOW_POLICY_WRITE(Code) | | Specifies that the ViewPlatform allows write access to its view
attach policy information at runtime.
|
ViewPlatform | public ViewPlatform()(Code) | | Constructs a ViewPlatform object with default parameters.
The default values are as follows:
view attach policy : View.NOMINAL_HEAD
activation radius : 62
|
cloneNode | public Node cloneNode(boolean forceDuplicate)(Code) | | Used to create a new instance of the node. This routine is called
by cloneTree to duplicate the current node.
cloneNode should be overridden by any user subclassed
objects. All subclasses must have their cloneNode
method consist of the following lines:
public Node cloneNode(boolean forceDuplicate) {
UserSubClass usc = new UserSubClass();
usc.duplicateNode(this, forceDuplicate);
return usc;
}
Parameters: forceDuplicate - when set to true , causes theduplicateOnCloneTree flag to be ignored. Whenfalse , the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied. See Also: Node.cloneTree See Also: Node.duplicateNode See Also: NodeComponent.setDuplicateOnCloneTree |
createRetained | void createRetained()(Code) | | Creates the retained mode ViewPlatformRetained object that this
ViewPlatform component object will point to.
|
duplicateAttributes | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all ViewPlatform information from originalNode into
the current node. This method is called from the
duplicateNode method. This routine does
the actual duplication of all "local data" (any data defined in
this object). It then will duplicate the retained side of the
tree if this method was called from its own 2 parameter
duplicateNode method. This is designate by setting the
duplicateRetained flag to true .
Without this flag a duplicateNode method would not
whether or not to duplicate the retained side of the object.
Parameters: originalNode - the original node to duplicate. Parameters: forceDuplicate - when set to true , causes theduplicateOnCloneTree flag to be ignored. Whenfalse , the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied. Parameters: duplicateRetained - set to true when thismethod is should initiate the duplicateRetained call. Thiscall walks up a nodes superclasses so it should only be calledonce from the class of the original node. See Also: Node.duplicateNode See Also: Node.cloneTree See Also: NodeComponent.setDuplicateOnCloneTree |
getActivationRadius | public float getActivationRadius()(Code) | | Get the ViewPlatform's activation radius.
the ViewPlatform activation radius |
getViewAttachPolicy | public int getViewAttachPolicy()(Code) | | Returns the current coexistence center in virtual-world policy.
one of: View.NOMINAL_SCREEN, View.NOMINAL_HEAD, orView.NOMINAL_FEET exception: CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
setActivationRadius | public void setActivationRadius(float activationRadius)(Code) | | Set the ViewPlatform's activation radius which defines an activation
volume around the view platform.
Parameters: activationRadius - the new activation radius |
setViewAttachPolicy | public void setViewAttachPolicy(int policy)(Code) | | Sets the view attach policy that determines the coexistence center
in the virtual world. This policy determines how Java 3D places the
view platform relative to the position of the user's head, one of
View.NOMINAL_SCREEN, View.NOMINAL_HEAD, or View.NOMINAL_FEET.
The default policy is View.NOMINAL_HEAD.
Parameters: policy - the new policy exception: CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph See Also: View.NOMINAL_SCREEN See Also: View.NOMINAL_HEAD See Also: View.NOMINAL_FEET |
|
|