Package org.web3d.x3d.sai.Geospatial

Interface GeoPositionInterpolator

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

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 http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
  • Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

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: GeoPositionInterpolator, X3D Tooltips: GeoPositionInterpolator, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    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.
    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 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 GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
    GeoPositionInterpolator setGeoSystem​(java.lang.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 X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • 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

      GeoPositionInterpolator setGeoOrigin​(GeoOrigin newValue)
      Accessor method to assign GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      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

      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.
      Returns:
      value of geoSystem field

    • setGeoSystem

      GeoPositionInterpolator setGeoSystem​(java.lang.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.
      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
      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.
      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.
      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 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.
      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:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      GeoPositionInterpolator setMetadata​(X3DMetadataObject newValue)
      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.
      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:
      X3D Scene Authoring Hints: Metadata Nodes

    • 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