org.web3d.vrml.renderer.common.nodes.geospatial.BaseGeoViewpoint

All Implemented Interfaces:: VRMLNode, FrameStateListener, VRMLBindableNodeType, VRMLChildNodeType, VRMLNavigationInfoNodeType, VRMLNodeType, VRMLTimeDependentNodeType, VRMLViewpointNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:: NRGeoViewpoint, OGLGeoViewpoint

public abstract class BaseGeoViewpoint extends BaseBindableNode implements VRMLViewpointNodeType, VRMLNavigationInfoNodeType

Common implementation of a GeoViewpoint node.

This implementation implements both the viewpoint and navInfo interfaces so that it can be internally detected by the system as being functional for both parts of the scene graph. The primary type is defined to be the viewpoint, and the secondaries are the bindable and nav info node types. Hopefully this will allow system to work out what is going on here. Note the following paragraph from the X3D spec:

"The GeoViewpoint node may be implemented as if there is an embedded NavigationInfo node that is bound and unbound with the GeoViewpoint node. As such, a X3D browser should internally set the speed, avatarSize, and visibilityLimit fields to an appropriate value for the viewpoint's elevation."

Viewpoints cannot be shared using DEF/USE. They may be named as such for Anchor purposes, but attempting to reuse them will cause an error. This implementation does not provide any protection against USE of this node and attempting to do so will result in throwing exceptions - most probably in the grouping node that includes this node. TODO: CenterOfRotation is missing from regular viewpoint

Version:: $Revision: 1.28 $
Author:: Alan Hudson, Justin Couch

Field Summary

Fields

Modifier and Type

Field

Description

protected javax.vecmath.AxisAngle4f

axis

protected float[]

centerOfRotation

Calculated value based on origin if provided

protected List<NavigationInfoChangeListener>

changeListener

The listener for navigation info changes

protected static final int

FIELD_CENTER_OF_ROTATION

Index of the centerOfRotation field

protected static final int

FIELD_DESCRIPTION

Index of the description field

protected static final int

FIELD_FARDISTANCE

Index of the farDistance field

protected static final int

FIELD_FIELDOFVIEW

Index of the fieldOfView field

protected static final int

FIELD_GEO_ORIGIN

Index of the geoOrigin field

protected static final int

FIELD_GEO_SYSTEM

Index of the geoSystem field

protected static final int

FIELD_HEADLIGHT

Index of the headlight field

protected static final int

FIELD_JUMP

Index of the jump field

protected static final int

FIELD_NAV_TYPE

Index of the nayType field

protected static final int

FIELD_NEARDISTANCE

Index of the nearDistance field

protected static final int

FIELD_ORIENTATION

Index of the orientation field

protected static final int

FIELD_POSITION

Index of the position field

protected static final int

FIELD_RETAIN_USER_OFFSETS

Index of the retainUserOffsets field

protected static final int

FIELD_SET_ORIENTATION

Index of the orientation field

protected static final int

FIELD_SET_POSITION

Index of the position field

protected static final int

FIELD_SPEED_FACTOR

Index of the position field

protected static final int

FIELD_VIEWALL

Index of the viewAll field

protected static final int

LAST_VIEWPOINT_INDEX

The last index of the nodes used by the viewpoint

protected double[]

local_origin

The origin in use

protected double[]

localPosition

The calculated local version of the points taking into account both the projection information and the GeoOrigin setting.

protected static final int

NUM_FIELDS

Number of fields constant

protected OriginManager

originManager

Manager for precision control

protected VRMLProtoInstance

pGeoOrigin

Proto version of the geoOrigin

protected boolean

useOriginManager

Flag indicating that the OriginManager is enabled

protected String

vfDescription

SFString description ""

protected float

vfFarDistance

SFFloat farDistance -1

protected float

vfFieldOfView

SFFloat fieldOfView 0.785398

protected VRMLNodeType

vfGeoOrigin

field SFNode geoOrigin

protected String[]

vfGeoSystem

field MFString geoSystem ["GD","WE"]

protected boolean

vfHeadlight

SFBool headlight TRUE

protected boolean

vfJump

SFBool jump TRUE

protected String[]

vfNavType

MFString navType ["EXAMINE", "ANY"]

protected float

vfNearDistance

SFFloat nearDistance -1

protected float[]

vfOrientation

SFRotation orientation 0 0 1 0

protected double[]

vfPosition

SFVec3f position 0 0 100000

protected boolean

vfRetainUserOffsets

SFBool retainUserOffsets FALSE

protected float

vfSpeedFactor

SFFloat speedFactor 1.0

protected boolean

vfViewAll

SFBool viewAll FALSE

protected List<ViewpointListener>

viewpointListeners

List of those who want to know about role changes, likely 1

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseBindableNode
FIELD_BIND, FIELD_BIND_TIME, FIELD_IS_BOUND, isOnStack, LAST_BINDABLE_INDEX, vfBindTime, vfIsBound

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode
errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Fields inherited from interface org.web3d.vrml.nodes.VRMLNavigationInfoNodeType
NAV_TYPE_ANY, NAV_TYPE_EXAMINE, NAV_TYPE_FLY, NAV_TYPE_LOOKAT, NAV_TYPE_NONE, NAV_TYPE_WALK, TRANSITION_TYPE_ANIMATE, TRANSITION_TYPE_LINEAR, TRANSITION_TYPE_TELEPORT

Fields inherited from interface org.web3d.vrml.nodes.VRMLViewpointNodeType
PROJECTION_ORTHO, PROJECTION_PERSPECTIVE
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

BaseGeoViewpoint()

Construct a default geo viewpoint instance

protected

BaseGeoViewpoint(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node.
Method Summary

Modifier and Type

Method

Description

void

addNavigationChangedListener(NavigationInfoChangeListener listener)

Add a listener for navigation info changes.

void

addViewpointListener(ViewpointListener l)

Add a ViewpointListener.

protected void

convOriToAxisAngle()

Convert specified orientation into an axis angle.

protected void

fireCenterOfRotationChanged(float[] val)

Send a notification to the registered listeners the center of rotation has changed.

protected void

fireFieldOfViewChanged(float[] val)

Send a notification to the registered listeners the field of view has changed.

float[]

getAvatarSize()

Get the dimensions of the avatar in use.

float[]

getCenterOfRotation()

Get the center of rotation defined by this viewpoint.

String

getDescription()

Get the description string associated with this viewpoint.

float

getFarDistance()

Get the farDistance value associated with this viewpoint.

VRMLFieldDeclaration

getFieldDeclaration(int index)

Get the declaration of the field at the given index.

int

getFieldIndex(String fieldName)

Get the index of the given field name.

float[]

getFieldOfView()

Get the field of view used by this viewpoint.

VRMLFieldData

getFieldValue(int index)

Get the value of a field.

boolean

getHeadlight()

Get the status of the headlight that we are operating with.

boolean

getJump()

Get the Jump field value of this viewpoint.

float

getNearDistance()

Get the nearDistance value associated with this viewpoint.

int[]

getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).

int

getNumFields()

Get the number of fields.

int

getNumTypes()

Get the number of valid navigation types in the result from getType().

int

getPrimaryType()

Get the primary type of this node.

int

getProjectionType()

Get the projection type.

boolean

getRetainUserOffsets()

Get the retainUserOffsets field value of this viewpoint.

int[]

getSecondaryType()

Get the secondary type of this node.

float

getSpeed()

Get the speed that we are currently moving at.

String[]

getType()

Get the list of navigation types that are to be used.

boolean

getViewAll()

Get the viewAll field value of this viewpoint.

float

getVisibilityLimit()

Get the visibility limit that we are currently operating at.

void

removeNavigationChangedListener(NavigationInfoChangeListener listener)

Remove the listener for navigation info changes.

void

removeViewpointListener(ViewpointListener l)

Remove a ViewpointListener.

void

sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)

Send a routed value from this node to the given destination node.

void

setAvatarSize(float[] size, int numValid)

Set the dimensions of the avatar in use.

void

setCenterOfRotation(float[] pos)

Set the center of rotation of this viewpoint.

void

setDescription(String desc)

Set the description string of this viewpoint.

void

setFarDistance(float newValue)

Set the farDistance value of this viewpoint

void

setFieldOfView(float fov)

Set the field of view for this viewpoint.

void

setHeadlight(boolean enable)

Set the state of the headlight to the new value.

void

setJump(boolean jump)

Set the jump field value of this viewpoint to the new value

void

setNearDistance(float newValue)

Set the nearDistance value of this viewpoint

protected void

setOrientation(float[] dir)

Convenience method to set the orientation of the viewpoint.

protected void

setPosition(double[] position)

Convenience method to set the position of the viewpoint.

void

setRetainUserOffsets(boolean retainUserOffsets)

Set the retainUserOffsets field value of this viewpoint to the new value

void

setSpeed(float newSpeed)

Set the speed to move at.

void

setType(String[] types, int numValid)

Set the navigation type to the new value(s).

void

setupFinished()

Notification that the construction phase of this node has finished.

void

setValue(int index, boolean value)

Set the value of the field at the given index as an boolean.

void

setValue(int index, double[] value, int numValid)

Set the value of the field at the given index as an array of floats.

void

setValue(int index, float value)

Set the value of the field at the given index as a float.

void

setValue(int index, float[] value, int numValid)

Set the value of the field at the given index as an array of floats.

void

setValue(int index, String value)

Set the value of the field at the given index as a string.

void

setValue(int index, String[] value, int numValid)

Set the value of the field at the given index as an array of strings.

void

setValue(int index, VRMLNodeType child)

Set the value of the field at the given index as a node.

void

setViewAll(boolean viewAll)

Set the viewAll field value of this viewpoint to the new value

void

setVisibilityLimit(float limit)

Set the visibility limie to move at.

void

setWorldLocation(javax.vecmath.Vector3f wcpos)

Sets the current position in world coordinates.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseBindableNode
addBindableNodeListener, copy, fireIsBoundChanged, getBindTime, getIsBound, removeBindableNodeListener, setBind, setOnStack, setVRMLClock

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode
addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener
allEventsComplete

Methods inherited from interface org.web3d.vrml.nodes.VRMLBindableNodeType
addBindableNodeListener, getBindTime, getIsBound, removeBindableNodeListener, setBind, setOnStack

Methods inherited from interface org.web3d.vrml.lang.VRMLNode
getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType
addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details
- FIELD_FIELDOFVIEW
  protected static final int FIELD_FIELDOFVIEW
  
  Index of the fieldOfView field
  
  See Also:
  
  Constant Field Values
- FIELD_JUMP
  protected static final int FIELD_JUMP
  
  Index of the jump field
  
  See Also:
  
  Constant Field Values
- FIELD_SET_ORIENTATION
  protected static final int FIELD_SET_ORIENTATION
  
  Index of the orientation field
  
  See Also:
  
  Constant Field Values
- FIELD_SET_POSITION
  protected static final int FIELD_SET_POSITION
  
  Index of the position field
  
  See Also:
  
  Constant Field Values
- FIELD_HEADLIGHT
  protected static final int FIELD_HEADLIGHT
  
  Index of the headlight field
  
  See Also:
  
  Constant Field Values
- FIELD_NAV_TYPE
  protected static final int FIELD_NAV_TYPE
  
  Index of the nayType field
  
  See Also:
  
  Constant Field Values
- FIELD_DESCRIPTION
  protected static final int FIELD_DESCRIPTION
  
  Index of the description field
  
  See Also:
  
  Constant Field Values
- FIELD_GEO_ORIGIN
  protected static final int FIELD_GEO_ORIGIN
  
  Index of the geoOrigin field
  
  See Also:
  
  Constant Field Values
- FIELD_GEO_SYSTEM
  protected static final int FIELD_GEO_SYSTEM
  
  Index of the geoSystem field
  
  See Also:
  
  Constant Field Values
- FIELD_ORIENTATION
  protected static final int FIELD_ORIENTATION
  
  Index of the orientation field
  
  See Also:
  
  Constant Field Values
- FIELD_POSITION
  protected static final int FIELD_POSITION
  
  Index of the position field
  
  See Also:
  
  Constant Field Values
- FIELD_SPEED_FACTOR
  protected static final int FIELD_SPEED_FACTOR
  
  Index of the position field
  
  See Also:
  
  Constant Field Values
- FIELD_CENTER_OF_ROTATION
  protected static final int FIELD_CENTER_OF_ROTATION
  
  Index of the centerOfRotation field
  
  See Also:
  
  Constant Field Values
- FIELD_RETAIN_USER_OFFSETS
  protected static final int FIELD_RETAIN_USER_OFFSETS
  
  Index of the retainUserOffsets field
  
  See Also:
  
  Constant Field Values
- FIELD_VIEWALL
  protected static final int FIELD_VIEWALL
  
  Index of the viewAll field
  
  See Also:
  
  Constant Field Values
- FIELD_FARDISTANCE
  protected static final int FIELD_FARDISTANCE
  
  Index of the farDistance field
  
  See Also:
  
  Constant Field Values
- FIELD_NEARDISTANCE
  protected static final int FIELD_NEARDISTANCE
  
  Index of the nearDistance field
  
  See Also:
  
  Constant Field Values
- LAST_VIEWPOINT_INDEX
  protected static final int LAST_VIEWPOINT_INDEX
  
  The last index of the nodes used by the viewpoint
  
  See Also:
  
  Constant Field Values
- NUM_FIELDS
  protected static final int NUM_FIELDS
  
  Number of fields constant
  
  See Also:
  
  Constant Field Values
- vfFieldOfView
  
  protected float vfFieldOfView
  
  SFFloat fieldOfView 0.785398
- vfJump
  
  protected boolean vfJump
  
  SFBool jump TRUE
- vfRetainUserOffsets
  
  protected boolean vfRetainUserOffsets
  
  SFBool retainUserOffsets FALSE
- vfViewAll
  
  protected boolean vfViewAll
  
  SFBool viewAll FALSE
- vfHeadlight
  
  protected boolean vfHeadlight
  
  SFBool headlight TRUE
- vfOrientation
  
  protected float[] vfOrientation
  
  SFRotation orientation 0 0 1 0
- vfPosition
  
  protected double[] vfPosition
  
  SFVec3f position 0 0 100000
- vfDescription
  
  protected String vfDescription
  
  SFString description ""
- vfFarDistance
  
  protected float vfFarDistance
  
  SFFloat farDistance -1
- vfNearDistance
  
  protected float vfNearDistance
  
  SFFloat nearDistance -1
- vfNavType
  
  protected String[] vfNavType
  
  MFString navType ["EXAMINE", "ANY"]
- vfGeoSystem
  
  protected String[] vfGeoSystem
  
  field MFString geoSystem ["GD","WE"]
- pGeoOrigin
  
  protected VRMLProtoInstance pGeoOrigin
  
  Proto version of the geoOrigin
- vfGeoOrigin
  
  protected VRMLNodeType vfGeoOrigin
  
  field SFNode geoOrigin
- vfSpeedFactor
  
  protected float vfSpeedFactor
  
  SFFloat speedFactor 1.0
- localPosition
  
  protected double[] localPosition
  
  The calculated local version of the points taking into account both the projection information and the GeoOrigin setting.
- changeListener
  
  protected List<NavigationInfoChangeListener> changeListener
  
  The listener for navigation info changes
- viewpointListeners
  
  protected List<ViewpointListener> viewpointListeners
  
  List of those who want to know about role changes, likely 1
- centerOfRotation
  
  protected float[] centerOfRotation
  
  Calculated value based on origin if provided
- axis
  
  protected javax.vecmath.AxisAngle4f axis
- originManager
  
  protected OriginManager originManager
  
  Manager for precision control
- useOriginManager
  
  protected boolean useOriginManager
  
  Flag indicating that the OriginManager is enabled
- local_origin
  
  protected double[] local_origin
  
  The origin in use
Constructor Details
- BaseGeoViewpoint
  
  protected BaseGeoViewpoint()
  
  Construct a default geo viewpoint instance
- BaseGeoViewpoint
  
  protected BaseGeoViewpoint(VRMLNodeType node)
  
  Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.
  
  Parameters:
  
  node - The node to copy
  
  Throws:
  
  IllegalArgumentException - The node is not the same type
Method Details
- addViewpointListener
  
  public void addViewpointListener(ViewpointListener l)
  
  Add a ViewpointListener.
  
  Specified by:
  
  addViewpointListener in interface VRMLViewpointNodeType
  
  Parameters:
  
  l - The listener. Duplicates and nulls are ignored.
- removeViewpointListener
  
  public void removeViewpointListener(ViewpointListener l)
  
  Remove a ViewpointListener.
  
  Specified by:
  
  removeViewpointListener in interface VRMLViewpointNodeType
  
  Parameters:
  
  l - The listener
- getProjectionType
  
  public int getProjectionType()
  
  Get the projection type.
  
  Specified by:
  
  getProjectionType in interface VRMLViewpointNodeType
  
  Returns:
  
  The type of projection. One of the PROJECTION_ constants.
- getFieldOfView
  
  public float[] getFieldOfView()
  
  Get the field of view used by this viewpoint. The value returned is an angle that is not less than zero and less than or equal to PI. The number of items in the list is dependent on the Viewpoint type.
  
  Specified by:
  
  getFieldOfView in interface VRMLViewpointNodeType
  
  Returns:
  
  The field of view used by this viewpoint
- setFieldOfView
  
  public void setFieldOfView(float fov) throws InvalidFieldValueException
  
  Set the field of view for this viewpoint. The value must be between zero and pie or an exception will be thrown.
  
  Parameters:
  
  fov - The new field of view to use
  
  Throws:
  
  InvalidFieldValueException - The field used is out of range
- getJump
  
  public boolean getJump()
  
  Get the Jump field value of this viewpoint.
  
  Specified by:
  
  getJump in interface VRMLViewpointNodeType
  
  Returns:
  
  true if this viewpoint should jump to new positions
- setJump
  
  public void setJump(boolean jump)
  
  Set the jump field value of this viewpoint to the new value
  
  Specified by:
  
  setJump in interface VRMLViewpointNodeType
  
  Parameters:
  
  jump - True if the viewpoint should jump to ne positions
- getRetainUserOffsets
  
  public boolean getRetainUserOffsets()
  
  Get the retainUserOffsets field value of this viewpoint.
  
  Specified by:
  
  getRetainUserOffsets in interface VRMLViewpointNodeType
  
  Returns:
  
  true if this viewpoint should retainUserOffsets on a bind
- setRetainUserOffsets
  
  public void setRetainUserOffsets(boolean retainUserOffsets)
  
  Set the retainUserOffsets field value of this viewpoint to the new value
  
  Specified by:
  
  setRetainUserOffsets in interface VRMLViewpointNodeType
  
  Parameters:
  
  retainUserOffsets - True if the viewpoint should retainUserOffsets on a bind
- getViewAll
  
  public boolean getViewAll()
  
  Get the viewAll field value of this viewpoint.
  
  Specified by:
  
  getViewAll in interface VRMLViewpointNodeType
  
  Returns:
  
  true if this viewpoint should viewAll geometry
- setViewAll
  
  public void setViewAll(boolean viewAll)
  
  Set the viewAll field value of this viewpoint to the new value
  
  Specified by:
  
  setViewAll in interface VRMLViewpointNodeType
  
  Parameters:
  
  viewAll - True if the viewpoint should viewAll geometry
- getDescription
  
  public String getDescription()
  
  Get the description string associated with this viewpoint. If no description is set, this will return null.
  
  Specified by:
  
  getDescription in interface VRMLViewpointNodeType
  
  Returns:
  
  The description string of this viewpoint
- setDescription
  
  public void setDescription(String desc)
  
  Set the description string of this viewpoint. A zero length string or null will clear the currently set description.
  
  Specified by:
  
  setDescription in interface VRMLViewpointNodeType
  
  Parameters:
  
  desc - The new description to use
- getFarDistance
  
  public float getFarDistance()
  
  Get the farDistance value associated with this viewpoint.
  
  Returns:
  
  The value for this viewpoint
- setFarDistance
  
  public void setFarDistance(float newValue)
  
  Set the farDistance value of this viewpoint
  
  Parameters:
  
  newValue - The new value to use
- getNearDistance
  
  public float getNearDistance()
  
  Get the nearDistance value associated with this viewpoint.
  
  Returns:
  
  The value for this viewpoint
- setNearDistance
  
  public void setNearDistance(float newValue)
  
  Set the nearDistance value of this viewpoint
  
  Parameters:
  
  newValue - The new value to use
- setWorldLocation
  
  public void setWorldLocation(javax.vecmath.Vector3f wcpos)
  
  Sets the current position in world coordinates.
  
  Specified by:
  
  setWorldLocation in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  wcpos - Location of the user in world coordinates(x,y,z)
- getCenterOfRotation
  
  public float[] getCenterOfRotation()
  
  Get the center of rotation defined by this viewpoint. The center of rotation is a point in space relative to the coordinate systems of this node.
  
  Specified by:
  
  getCenterOfRotation in interface VRMLViewpointNodeType
  
  Returns:
  
  The position of the center of rotation
- setCenterOfRotation
  
  public void setCenterOfRotation(float[] pos) throws InvalidFieldValueException
  
  Set the center of rotation of this viewpoint. The center is a position in 3-space.
  
  Specified by:
  
  setCenterOfRotation in interface VRMLViewpointNodeType
  
  Parameters:
  
  pos - The new position to use
  
  Throws:
  
  InvalidFieldValueException - The field used is not 3 values
- getType
  
  public String[] getType()
  
  Get the list of navigation types that are to be used. It may contain some or all of the constants above. The array will always be non-null.
  
  Specified by:
  
  getType in interface VRMLNavigationInfoNodeType
  
  Returns:
  
  The list of navigation types set
- getNumTypes
  
  public int getNumTypes()
  
  Get the number of valid navigation types in the result from getType().
  
  Specified by:
  
  getNumTypes in interface VRMLNavigationInfoNodeType
  
  Returns:
  
  The number of elements in getType().
- addNavigationChangedListener
  
  public void addNavigationChangedListener(NavigationInfoChangeListener listener)
  
  Add a listener for navigation info changes. Duplicate adds are ignored.
  
  Specified by:
  
  addNavigationChangedListener in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  listener - The new navigation info change listener
- removeNavigationChangedListener
  
  public void removeNavigationChangedListener(NavigationInfoChangeListener listener)
  
  Remove the listener for navigation info changes. If not already added, this request is ignored.
  
  Specified by:
  
  removeNavigationChangedListener in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  listener - The new navigation info change listener
- setType
  
  public void setType(String[] types, int numValid) throws InvalidFieldValueException
  
  Set the navigation type to the new value(s). The array must be non-null. If the underlying implementation does not support any of the types requested, it shall default to the type NONE. If the array is empty, it defaults to NONE.
  
  Specified by:
  
  setType in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  types - The list of types to now use in order of preference
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldValueException - The list was null or empty
- getAvatarSize
  
  public float[] getAvatarSize()
  
  Get the dimensions of the avatar in use.
  
  Specified by:
  
  getAvatarSize in interface VRMLNavigationInfoNodeType
  
  Returns:
  
  A list of floats describing the dimension of the avatar.
- setAvatarSize
  
  public void setAvatarSize(float[] size, int numValid) throws InvalidFieldValueException
  
  Set the dimensions of the avatar in use. The array must have at least three values in it as required by the specification.
  
  Specified by:
  
  setAvatarSize in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  size - The new size values to use
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldValueException - The array did not contain 3 values
- getSpeed
  
  public float getSpeed()
  
  Get the speed that we are currently moving at.
  
  Specified by:
  
  getSpeed in interface VRMLNavigationInfoNodeType
  
  Returns:
  
  The current movement speed.
- setSpeed
  
  public void setSpeed(float newSpeed) throws InvalidFieldValueException
  
  Set the speed to move at. The speed value must be non-negative.
  
  Specified by:
  
  setSpeed in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  newSpeed - The new speed value to use
  
  Throws:
  
  InvalidFieldValueException - The speed was negative
- getVisibilityLimit
  
  public float getVisibilityLimit()
  
  Get the visibility limit that we are currently operating at.
  
  Specified by:
  
  getVisibilityLimit in interface VRMLNavigationInfoNodeType
  
  Returns:
  
  The current movement visibility limit.
- setVisibilityLimit
  
  public void setVisibilityLimit(float limit) throws InvalidFieldValueException
  
  Set the visibility limie to move at. The visibility limit value must be non-negative.
  
  Specified by:
  
  setVisibilityLimit in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  limit - The new visibility limit value to use
  
  Throws:
  
  InvalidFieldValueException - The visibility limit was negative
- getHeadlight
  
  public boolean getHeadlight()
  
  Get the status of the headlight that we are operating with. A true value represents the headlight being on.
  
  Specified by:
  
  getHeadlight in interface VRMLNavigationInfoNodeType
  
  Returns:
  
  true if the headlight is to be used
- setHeadlight
  
  public void setHeadlight(boolean enable)
  
  Set the state of the headlight to the new value.
  
  Specified by:
  
  setHeadlight in interface VRMLNavigationInfoNodeType
  
  Parameters:
  
  enable - True if we are to use the headlight
- setupFinished
  
  public void setupFinished()
  
  Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.
  
  Specified by:
  
  setupFinished in interface VRMLNodeType
  
  Overrides:
  
  setupFinished in class AbstractNode
- getFieldIndex
  
  public int getFieldIndex(String fieldName)
  
  Get the index of the given field name. If the name does not exist for this node then return a value of -1.
  
  Specified by:
  
  getFieldIndex in interface VRMLNode
  
  Parameters:
  
  fieldName - The name of the field we want the index from
  
  Returns:
  
  The index of the field name or -1
- getNodeFieldIndices
  
  public int[] getNodeFieldIndices()
  
  Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.
  
  Specified by:
  
  getNodeFieldIndices in interface VRMLNode
  
  Returns:
  
  The list of field indices that correspond to SF/MFnode fields or null if none
- getFieldDeclaration
  
  public VRMLFieldDeclaration getFieldDeclaration(int index)
  
  Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.
  
  Specified by:
  
  getFieldDeclaration in interface VRMLNode
  
  Parameters:
  
  index - The index of the field to get information
  
  Returns:
  
  A representation of this field's information
- getNumFields
  
  public int getNumFields()
  
  Get the number of fields.
  
  Specified by:
  
  getNumFields in interface VRMLNode
  
  Returns:
  
  The number of fields.
- getPrimaryType
  
  public int getPrimaryType()
  
  Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.
  
  Specified by:
  
  getPrimaryType in interface VRMLNode
  
  Returns:
  
  The primary type
- getSecondaryType
  
  public int[] getSecondaryType()
  
  Get the secondary type of this node. Replaces the instanceof mechanism for use in switch statements.
  
  Specified by:
  
  getSecondaryType in interface VRMLNode
  
  Overrides:
  
  getSecondaryType in class BaseBindableNode
  
  Returns:
  
  The secondary type
- getFieldValue
  
  public VRMLFieldData getFieldValue(int index) throws InvalidFieldException
  
  Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.
  
  Specified by:
  
  getFieldValue in interface VRMLNodeType
  
  Overrides:
  
  getFieldValue in class BaseBindableNode
  
  Parameters:
  
  index - The index of the field to change.
  
  Returns:
  
  The class representing the field value
  
  Throws:
  
  InvalidFieldException - The field index is not known
- sendRoute
  
  public void sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)
  
  Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.
  
  Specified by:
  
  sendRoute in interface VRMLNodeType
  
  Overrides:
  
  sendRoute in class BaseBindableNode
  
  Parameters:
  
  time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)
  
  srcIndex - The index of the field in this node that the value should be sent from
  
  destNode - The node reference that we will be sending the value to
  
  destIndex - The index of the field in the destination node that the value should be sent to.
- setValue
  
  public void setValue(int index, boolean value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class BaseBindableNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The index does not relate to one of our fields
  
  InvalidFieldValueException - The value does not contain an in range value or bad numerical type
- setValue
  
  public void setValue(int index, float value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a float. This would be used to set SFFloat field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The index does not relate to one of our fields
  
  InvalidFieldValueException - The value does not contain an in range value or bad numerical type
- setValue
  
  public void setValue(int index, float[] value, int numValid) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldException - The index does not relate to one of our fields
  
  InvalidFieldValueException - The value does not contain an in range value or bad numerical type
- setValue
  
  public void setValue(int index, double[] value, int numValid) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldException - The index does not relate to one of our fields
  
  InvalidFieldValueException - The value does not contain an in range value or bad numerical type
- setValue
  
  public void setValue(int index, String value) throws InvalidFieldException
  
  Set the value of the field at the given index as a string. This would be used to set SFString field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The field index is not know
- setValue
  
  public void setValue(int index, String[] value, int numValid) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an array of strings. This would be used to set the MFString field type "type".
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldException - The field index is not know
  
  InvalidFieldValueException - The value provided is not in range or not appropriate for this field
- setValue
  
  public void setValue(int index, VRMLNodeType child) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a node. This would be used to set SFNode field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  child - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The field index is not known
  
  InvalidFieldValueException - The node does not match the required type.
- setPosition
  
  protected void setPosition(double[] position)
  
  Convenience method to set the position of the viewpoint. Designed to be overridden by derived classes. Make sure you also call this first to set the field values.
  
  Parameters:
  
  position - The position vector to use
- setOrientation
  
  protected void setOrientation(float[] dir)
  
  Convenience method to set the orientation of the viewpoint. Designed to be overridden by derived classes. Make sure you also call this first to set the field values.
  
  Parameters:
  
  dir - The orientation quaternion to use
- convOriToAxisAngle
  
  protected void convOriToAxisAngle()
  
  Convert specified orientation into an axis angle.
- fireCenterOfRotationChanged
  
  protected void fireCenterOfRotationChanged(float[] val)
  
  Send a notification to the registered listeners the center of rotation has changed. If no listeners have been registered, then this does nothing, so always call it regardless.
  
  Parameters:
  
  val - The new center of Rotation
- fireFieldOfViewChanged
  
  protected void fireFieldOfViewChanged(float[] val)
  
  Send a notification to the registered listeners the field of view has changed. If no listeners have been registered, then this does nothing, so always call it regardless.
  
  Parameters:
  
  val - The new center of Rotation

Class BaseGeoViewpoint

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseBindableNode

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

Fields inherited from interface org.web3d.vrml.nodes.VRMLNavigationInfoNodeType

Fields inherited from interface org.web3d.vrml.nodes.VRMLViewpointNodeType

Constructor Summary

Method Summary

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseBindableNode

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

Methods inherited from interface org.web3d.vrml.nodes.VRMLBindableNodeType

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

Field Details

FIELD_FIELDOFVIEW

FIELD_JUMP

FIELD_SET_ORIENTATION

FIELD_SET_POSITION

FIELD_HEADLIGHT

FIELD_NAV_TYPE

FIELD_DESCRIPTION

FIELD_GEO_ORIGIN

FIELD_GEO_SYSTEM

FIELD_ORIENTATION

FIELD_POSITION

FIELD_SPEED_FACTOR

FIELD_CENTER_OF_ROTATION

FIELD_RETAIN_USER_OFFSETS

FIELD_VIEWALL

FIELD_FARDISTANCE

FIELD_NEARDISTANCE

LAST_VIEWPOINT_INDEX

NUM_FIELDS

vfFieldOfView

vfJump

vfRetainUserOffsets

vfViewAll

vfHeadlight

vfOrientation

vfPosition

vfDescription

vfFarDistance

vfNearDistance

vfNavType

vfGeoSystem

pGeoOrigin

vfGeoOrigin

vfSpeedFactor

localPosition

changeListener

viewpointListeners

centerOfRotation

axis

originManager

useOriginManager

local_origin

Constructor Details

BaseGeoViewpoint

BaseGeoViewpoint

Method Details

addViewpointListener

removeViewpointListener

getProjectionType

getFieldOfView

setFieldOfView

getJump

setJump

getRetainUserOffsets

setRetainUserOffsets

getViewAll

setViewAll

getDescription

setDescription

getFarDistance

setFarDistance

getNearDistance

setNearDistance

setWorldLocation