Package org.web3d.x3d.sai.Geospatial
Interface GeoOrigin
- All Superinterfaces:
X3DNode
- All Known Implementing Classes:
GeoOriginObject
public interface GeoOrigin extends X3DNode
GeoOrigin is deprecated and discouraged (but nevertheless allowed) in X3D version 3.3. GeoOrigin is restored in X3D version 4.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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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).
-
Method Summary
Modifier and Type Method 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.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.booleangetRotateYUp()Provide boolean value from initializeOnly SFBool field named rotateYUp.GeoOriginsetGeoCoords(double[] newValue)Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.GeoOriginsetGeoSystem(java.lang.String[] newValue)Accessor method to assign String array to initializeOnly MFString field named geoSystem.GeoOriginsetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.GeoOriginsetRotateYUp(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named rotateYUp.
-
Method Details
-
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
Accessor method to 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 https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://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
Accessor method to 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 https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://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.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
getMetadatain interfaceX3DNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
- Specified by:
setMetadatain interfaceX3DNode- 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
Accessor method to 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).
-