GeoOrigin (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode

All Known Implementing Classes:

GeoOriginObject
```
public interface GeoOrigin
extends X3DNode
```
GeoOrigin is deprecated and discouraged (but nevertheless allowed) in X3D v3.3. GeoOrigin is likely to be restored in X3D v4.0 for special use on devices with limited floating-point resolution.

X3D node tooltip: [X3DNode] GeoOrigin specifies local geospatial coordinate system for parent node, enabling increased geographic precision during scene rendering (by mitigating potential floating-point roundoff errors). GeoOrigin can be contained by other Geospatial component nodes, typically via DEF/USE to ensure consistency.
- Hint: only one geospatial coordinate system is allowed per scene, thus DEF-ing and later USE-ing only one GeoOrigin node per scene is recommended.
- Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Warning: GeoOrigin is deprecated, discouraged and not legal in X3D v3.3. GeoOrigin can be ignored in X3D v3.2 and below.
- Hint: GeoOrigin is likely to be restored in X3D v4.0 for special use on devices with limited floating-point resolution.
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: GeoOrigin, X3D Tooltips: GeoOrigin, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double[]`	`getGeoCoords()` Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.
`java.lang.String[]`	`getGeoSystem()` Provide array of String results from initializeOnly MFString field named geoSystem.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`boolean`	`getRotateYUp()` Provide boolean value from initializeOnly SFBool field named rotateYUp.
`GeoOrigin`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`GeoOrigin`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`GeoOrigin`	`setGeoCoords(double[] newValue)` Assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
`GeoOrigin`	`setGeoSystem(java.lang.String[] newValue)` Assign String array to initializeOnly MFString field named geoSystem.
`GeoOrigin`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`GeoOrigin`	`setRotateYUp(boolean newValue)` Assign boolean value to initializeOnly SFBool field named rotateYUp.
`GeoOrigin`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getGeoCoords
```
double[] getGeoCoords()
```
    Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.
    
    Tooltip: Defines absolute geographic location (and implicit local coordinate frame).
    - Hint: X3D for Advanced Modeling (X3D4AM) slideset
      http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
    - Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
    Returns:
    
    value of geoCoords field
  - setGeoCoords
```
GeoOrigin setGeoCoords(double[] newValue)
```
    Assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
    
    Tooltip: Defines absolute geographic location (and implicit local coordinate frame). Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
    
    Parameters:
    
    newValue - is new value for the geoCoords field.
    
    Returns:
    
    GeoOrigin - 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
```
GeoOrigin 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:
    
    GeoOrigin - 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 X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
GeoOrigin setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    GeoOrigin - 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
  - getRotateYUp
```
boolean getRotateYUp()
```
    Provide boolean value from initializeOnly SFBool field named rotateYUp.
    
    Tooltip: Whether to rotate coordinates of nodes using this GeoOrigin so that local-up direction aligns with VRML Y axis rotateYUp false means local up-direction is relative to planet surface rotateYUp true allows proper operation of NavigationInfo modes FLY, WALK. *
    
    Returns:
    
    value of rotateYUp field
  - setRotateYUp
```
GeoOrigin setRotateYUp(boolean newValue)
```
    Assign boolean value to initializeOnly SFBool field named rotateYUp.
    
    Tooltip: Whether to rotate coordinates of nodes using this GeoOrigin so that local-up direction aligns with VRML Y axis rotateYUp false means local up-direction is relative to planet surface rotateYUp true allows proper operation of NavigationInfo modes FLY, WALK.
    
    Parameters:
    
    newValue - is new value for the rotateYUp field.
    
    Returns:
    
    GeoOrigin - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
GeoOrigin 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    GeoOrigin - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
GeoOrigin 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    GeoOrigin - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
GeoOrigin 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    GeoOrigin - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface GeoOrigin

Method Summary

Method Detail

getGeoCoords

setGeoCoords

getGeoSystem

setGeoSystem

getMetadata

setMetadata

getRotateYUp

setRotateYUp

setDEF

setUSE

setCssClass