Package org.web3d.x3d.sai.Geospatial

Interface GeoPositionInterpolator

All Superinterfaces:
X3DChildNode, X3DInterpolatorNode, X3DNode
All Known Implementing Classes:
GeoPositionInterpolator
public interface GeoPositionInterpolator extends X3DInterpolatorNode
GeoPositionInterpolator animates objects within a geographic coordinate system.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. X3D node tooltip: [X3DInterpolatorNode] GeoPositionInterpolator animates objects within a geographic coordinate system. GeoPositionInterpolator can contain a GeoOrigin node. Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute. Hint: X3D for Advanced Modeling (X3D4AM) slideset <a href="https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf" target="_blank">https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf</a> Warning: requires X3D profile='Full' or else include &lt;component name='Geospatial' level='1'/&gt; *


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    GeoOrigin
    getGeoOrigin()
    Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
    String[]
    getGeoSystem()
    Provide array of String results from initializeOnly MFString field named geoSystem.
    double[]
    getGeovalue()
    Provide array of 3-tuple double results from outputOnly SFVec3d field named geovalue_changed.
    float[]
    getKey()
    Provide array of float results from inputOutput MFFloat field named key.
    double[]
    getKeyValue()
    Provide array of 3-tuple double results from inputOutput MFVec3d field named keyValue.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[]
    getValue()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.
    GeoPositionInterpolator
    setGeoOrigin(GeoOrigin newValue)
    Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
    GeoPositionInterpolator
    setGeoSystem(String[] newValue)
    Accessor method to assign String array to initializeOnly MFString field named geoSystem.
    GeoPositionInterpolator
    setKey(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named key.
    GeoPositionInterpolator
    setKeyValue(double[] newValue)
    Accessor method to assign 3-tuple double array to inputOutput MFVec3d field named keyValue.
    GeoPositionInterpolator
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getGeoOrigin

      GeoOrigin getGeoOrigin()
      Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.

      Tooltip: [GeoOrigin] Single contained GeoOrigin node that can specify a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#high-precisioncoords" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#high-precisioncoords</a> Warning: XML validation requires placement as first child node following contained metadata nodes (if any). *
      Returns:
      value of geoOrigin field

    • setGeoOrigin

      GeoPositionInterpolator setGeoOrigin(GeoOrigin newValue)
      Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.

      Tooltip: [GeoOrigin] Single contained GeoOrigin node that can specify a local coordinate frame for extended precision. Hint: X3D Architecture 25.2.5 Dealing with high-precision coordinates <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#high-precisioncoords" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#high-precisioncoords</a> Warning: XML validation requires placement as first child node following contained metadata nodes (if any). *
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGeoSystem

      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes</a> Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Specifyinggeospatialcoords" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Specifyinggeospatialcoords</a> Hint: UTM is Universal Transverse Mercator coordinate system <a href="https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system" target="_blank">https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system</a> Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). *
      Returns:
      value of geoSystem field

    • setGeoSystem

      GeoPositionInterpolator setGeoSystem(String[] newValue)
      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes</a> Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Specifyinggeospatialcoords" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Specifyinggeospatialcoords</a> Hint: UTM is Universal Transverse Mercator coordinate system <a href="https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system" target="_blank">https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system</a> Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). *
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGeovalue

      double[] getGeovalue()
      Provide array of 3-tuple double results from outputOnly SFVec3d field named geovalue_changed.

      Tooltip: interpolated coordinate in the geographic coordinate system specified by geoSystem Hint: X3D for Advanced Modeling (X3D4AM) slideset <a href="https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf" target="_blank">https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf</a> Warning: requires X3D profile='Full' or else include &lt;component name='Geospatial' level='1'/&gt; Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events. *
      Returns:
      value of geovalue_changed field

    • getKey

      float[] getKey()
      Provide array of float results from inputOutput MFFloat field named key.

      Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Warning: number of keys must match number of keyValues! Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value. Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds. *
      Specified by:
      getKey in interface X3DInterpolatorNode
      Returns:
      value of key field

    • setKey

      GeoPositionInterpolator setKey(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named key.

      Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Warning: number of keys must match number of keyValues! Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value. Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds. *
      Specified by:
      setKey in interface X3DInterpolatorNode
      Parameters:
      newValue - is new value for the key field.
      Returns:
      GeoPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getKeyValue

      double[] getKeyValue()
      Provide array of 3-tuple double results from inputOutput MFVec3d field named keyValue.

      Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array. Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. <a href="https://en.wikipedia.org/wiki/Step_function" target="_blank">https://en.wikipedia.org/wiki/Step_function</a> Warning: number of keys must match number of keyValues! *
      Returns:
      value of keyValue field

    • setKeyValue

      GeoPositionInterpolator setKeyValue(double[] newValue)
      Accessor method to assign 3-tuple double array to inputOutput MFVec3d field named keyValue.

      Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array. Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. <a href="https://en.wikipedia.org/wiki/Step_function" target="_blank">https://en.wikipedia.org/wiki/Step_function</a> Warning: number of keys must match number of keyValues! *
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      GeoPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DInterpolatorNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      GeoPositionInterpolator setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DInterpolatorNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoPositionInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getValue

      float[] getValue()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named value_changed.

      Tooltip: Linearly interpolated output value determined by current key time and corresponding keyValue pair. Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect. Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events. *
      Returns:
      value of value_changed field