GeoViewpoint (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBindableNode, X3DChildNode, X3DNode, X3DViewpointNode

All Known Implementing Classes:

GeoViewpointObject
```
public interface GeoViewpoint
extends X3DViewpointNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DViewpointNode] GeoViewpoint specifies viewpoints using geographic coordinates. GeoViewpoint can contain a GeoOrigin node. Since GeoViewpoint must navigate smoothly inside a curved geographic coordinate system, it includes both Viewpoint and NavigationInfo attributes.
- Hint: alternatively can use GeoLocation or GeoTransform as parent of a Viewpoint node to orient geospatial views.
- Hint: include <component name='Geospatial' level='1'/>
- Hint: when a GeoViewpoint node is bound, it also overrides the currently bound NavigationInfo node in the scene and controls user navigation for smoother geospatial interaction.
- Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
- Hint: GeoViewpoint OrthoViewpoint and Viewpoint share the same binding stack, so no more than one of these nodes can be bound and active at a given time.
- Warning: do not include GeoViewpoint OrthoViewpoint or Viewpoint as a child of LOD or Switch, instead use ViewpointGroup as parent to constrain location proximity where the viewpoint is available to user.
- Warning: GeoViewpoint navType and headlight fields were removed as part of X3D version 3.3, authors can instead use a NavigationInfo node for those fields in prior X3D versions 3.0, 3.1 or 3.2. Upgrading such legacy scenes to version 3.3 or greater is preferred and recommended.
- Hint: Regardless of viewpoint jump value at bind time, the relative viewing transformation between user's view and defined position/orientation is stored for later use when un-jumping (returning to the viewpoint when subsequent viewpoint is unbound).
- Hint: customizable design pattern for dedicated Viewpoint/NavigationInfo pair: <Viewpoint DEF='SpecialView'/> <NavigationInfo DEF='SpecialNav'/> <ROUTE fromNode='SpecialView' fromField='isBound' toNode='SpecialNav' toField='set_bind'/>
- Warning: avoid having GeoLocation or GeoTransform as a parent or ancestor node of GeoViewpoint, since multiple geospatial transformations then occur with unpredictable results.
- Hint: X3D Scene Authoring Hints, Viewpoints
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Viewpoints
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: GeoViewpoint, X3D Tooltips: GeoViewpoint, X3D Scene Authoring Hints: Viewpoints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getBindTime()` Provide double value in seconds from outputOnly SFTime field named bindTime.
`double[]`	`getCenterOfRotation()` Provide array of 3-tuple double results unit axis, angle (in radians) from inputOutput SFVec3d field named centerOfRotation.
`java.lang.String`	`getDescription()` Provide String value from inputOutput SFString field named description.
`float`	`getFieldOfView()` Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.
`GeoOrigin`	`getGeoOrigin()` Provide GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
`java.lang.String[]`	`getGeoSystem()` Provide array of String results from initializeOnly MFString field named geoSystem.
`boolean`	`getIsBound()` Provide boolean value from outputOnly SFBool field named isBound.
`boolean`	`getJump()` Provide boolean value from inputOutput SFBool field named jump.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getOrientation()` Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
`double[]`	`getPosition()` Provide array of 3-tuple double results from inputOutput SFVec3d field named position.
`boolean`	`getRetainUserOffsets()` Provide boolean value from inputOutput SFBool field named retainUserOffsets.
`float`	`getSpeedFactor()` Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.
`GeoViewpoint`	`setCenterOfRotation(double[] newValue)` Assign 3-tuple double array unit axis, angle (in radians) to inputOutput SFVec3d field named centerOfRotation.
`GeoViewpoint`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`GeoViewpoint`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`GeoViewpoint`	`setDescription(java.lang.String newValue)` Assign String value to inputOutput SFString field named description.
`GeoViewpoint`	`setFieldOfView(float newValue)` Assign float value within allowed range of (0,3.1416) to inputOutput SFFloat field named fieldOfView.
`GeoViewpoint`	`setGeoOrigin(GeoOrigin newValue)` Assign GeoOrigin instance (using a properly typed node) (deprecated node, optional) to initializeOnly SFNode field geoOrigin.
`GeoViewpoint`	`setGeoSystem(java.lang.String[] newValue)` Assign String array to initializeOnly MFString field named geoSystem.
`GeoViewpoint`	`setJump(boolean newValue)` Assign boolean value to inputOutput SFBool field named jump.
`GeoViewpoint`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`GeoViewpoint`	`setOrientation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
`GeoViewpoint`	`setPosition(double[] newValue)` Assign 3-tuple double array to inputOutput SFVec3d field named position.
`GeoViewpoint`	`setRetainUserOffsets(boolean newValue)` Assign boolean value to inputOutput SFBool field named retainUserOffsets.
`GeoViewpoint`	`setSpeedFactor(float newValue)` Assign float value within allowed range of [0,infinity) to initializeOnly SFFloat field named speedFactor.
`GeoViewpoint`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getBindTime
```
double getBindTime()
```
    Provide double value in seconds from outputOnly SFTime field named bindTime.
    
    Tooltip: Event sent reporting timestamp when node becomes active/inactive.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getBindTime in interface X3DBindableNode
    
    Specified by:
    
    getBindTime in interface X3DViewpointNode
    
    Returns:
    
    value of bindTime field
  - getCenterOfRotation
```
double[] getCenterOfRotation()
```
    Provide array of 3-tuple double results unit axis, angle (in radians) from inputOutput SFVec3d field named centerOfRotation.
    
    Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode. *
    
    Returns:
    
    value of centerOfRotation field
  - setCenterOfRotation
```
GeoViewpoint setCenterOfRotation(double[] newValue)
```
    Assign 3-tuple double array unit axis, angle (in radians) to inputOutput SFVec3d field named centerOfRotation.
    
    Tooltip: centerOfRotation specifies center point about which to rotate user's eyepoint when in EXAMINE or LOOKAT mode.
    
    Parameters:
    
    newValue - is new value for the centerOfRotation field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDescription
```
java.lang.String getDescription()
```
    Provide String value from inputOutput SFString field named description.
    
    Tooltip: Author-provided text tooltip that tells users the expected action of this node.
    - Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
    - Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
    Specified by:
    
    getDescription in interface X3DViewpointNode
    
    Returns:
    
    value of description field
  - setDescription
```
GeoViewpoint setDescription(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named description.
    
    Tooltip: Author-provided text tooltip that tells users the expected action of this node. Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
    
    Specified by:
    
    setDescription in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getFieldOfView
```
float getFieldOfView()
```
    Provide float value within allowed range of (0,3.1416) from inputOutput SFFloat field named fieldOfView.
    
    Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens. *
    
    Returns:
    
    value of fieldOfView field
  - setFieldOfView
```
GeoViewpoint setFieldOfView(float newValue)
```
    Assign float value within allowed range of (0,3.1416) to inputOutput SFFloat field named fieldOfView.
    
    Tooltip: Preferred minimum viewing angle from this viewpoint in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
    
    Parameters:
    
    newValue - is new value for the fieldOfView field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getGeoOrigin
```
GeoOrigin getGeoOrigin()
```
    Provide GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
    
    Returns:
    
    value of geoOrigin field
  - setGeoOrigin
```
GeoViewpoint setGeoOrigin(GeoOrigin newValue)
```
    Assign GeoOrigin instance (using a properly typed node) (deprecated node, optional) to initializeOnly SFNode field geoOrigin.
    
    Parameters:
    
    newValue - is new value for the geoOrigin field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getGeoSystem
```
java.lang.String[] getGeoSystem()
```
    Provide array of String results from initializeOnly MFString field named geoSystem.
    
    Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.
    - Hint: X3D Architecture 25.2.2 Spatial reference frames
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
    - Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Specifyinggeospatialcoords
    - Hint: UTM is Universal Transverse Mercator coordinate system
      https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
    - Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).
    Returns:
    
    value of geoSystem field
  - setGeoSystem
```
GeoViewpoint setGeoSystem(java.lang.String[] newValue)
```
    Assign String array to initializeOnly MFString field named geoSystem.
    
    Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type. Hint: X3D Architecture 25.2.2 Spatial reference frames http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Specifyinggeospatialcoords Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).
    
    Parameters:
    
    newValue - is new value for the geoSystem field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsBound
```
boolean getIsBound()
```
    Provide boolean value from outputOnly SFBool field named isBound.
    
    Tooltip: Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsBound in interface X3DBindableNode
    
    Specified by:
    
    getIsBound in interface X3DViewpointNode
    
    Returns:
    
    value of isBound field
  - getJump
```
boolean getJump()
```
    Provide boolean value from inputOutput SFBool field named jump.
    
    Tooltip: Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint. *
    
    Specified by:
    
    getJump in interface X3DViewpointNode
    
    Returns:
    
    value of jump field
  - setJump
```
GeoViewpoint setJump(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named jump.
    
    Tooltip: Whether to transition instantly by jumping, or else smoothly animate to this Viewpoint.
    
    Specified by:
    
    setJump in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the jump field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DBindableNode
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DViewpointNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
GeoViewpoint setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DBindableNode
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getOrientation
```
float[] getOrientation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
    
    Tooltip: Rotation of Viewpoint, relative to default -Z axis direction in local coordinate system.
    - Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
    - Hint: this is orientation _change_ from default direction (0 0 -1) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
    Specified by:
    
    getOrientation in interface X3DViewpointNode
    
    Returns:
    
    value of orientation field
  - setOrientation
```
GeoViewpoint setOrientation(float[] newValue)
```
    Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
    
    Tooltip: Rotation of Viewpoint, relative to default -Z axis direction in local coordinate system. Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness. Hint: this is orientation _change_ from default direction (0 0 -1) +Y axis is the up vector for the local area (the normal to the tangent plane on the ellipsoid), -Z points towards the north pole, and +X is east 1 0 0 -1.570796 always looks down.
    
    Specified by:
    
    setOrientation in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the orientation field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getPosition
```
double[] getPosition()
```
    Provide array of 3-tuple double results from inputOutput SFVec3d field named position.
    
    Tooltip: position relative to local georeferenced coordinate system, in proper format. *
    
    Returns:
    
    value of position field
  - setPosition
```
GeoViewpoint setPosition(double[] newValue)
```
    Assign 3-tuple double array to inputOutput SFVec3d field named position.
    
    Tooltip: position relative to local georeferenced coordinate system, in proper format.
    
    Parameters:
    
    newValue - is new value for the position field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getRetainUserOffsets
```
boolean getRetainUserOffsets()
```
    Provide boolean value from inputOutput SFBool field named retainUserOffsets.
    
    Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *
    
    Specified by:
    
    getRetainUserOffsets in interface X3DViewpointNode
    
    Returns:
    
    value of retainUserOffsets field
  - setRetainUserOffsets
```
GeoViewpoint setRetainUserOffsets(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named retainUserOffsets.
    
    Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation.
    
    Specified by:
    
    setRetainUserOffsets in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the retainUserOffsets field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSpeedFactor
```
float getSpeedFactor()
```
    Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named speedFactor.
    
    Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser.
    - Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
    Returns:
    
    value of speedFactor field
  - setSpeedFactor
```
GeoViewpoint setSpeedFactor(float newValue)
```
    Assign float value within allowed range of [0,infinity) to initializeOnly SFFloat field named speedFactor.
    
    Tooltip: [0,+infinity) speedFactor is a multiplier to modify the original elevation-based speed that is set automatically by the browser. Hint: speedFactor is a relative value and not an absolute speed as defined by NavigationInfo.
    
    Parameters:
    
    newValue - is new value for the speedFactor field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
GeoViewpoint setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DBindableNode
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
GeoViewpoint setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DBindableNode
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
GeoViewpoint setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DBindableNode
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DViewpointNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    GeoViewpoint - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface GeoViewpoint

Method Summary

Method Detail

getBindTime

getCenterOfRotation

setCenterOfRotation

getDescription

setDescription

getFieldOfView

setFieldOfView

getGeoOrigin

setGeoOrigin

getGeoSystem

setGeoSystem

getIsBound

getJump

setJump

getMetadata

setMetadata

getOrientation

setOrientation

getPosition

setPosition

getRetainUserOffsets

setRetainUserOffsets

getSpeedFactor

setSpeedFactor

setDEF

setUSE

setCssClass