Interface GeoTouchSensor

All Superinterfaces:
X3DChildNode, X3DNode, X3DPointingDeviceSensorNode, X3DSensorNode, X3DTouchSensorNode
All Known Implementing Classes:
GeoTouchSensorObject

public interface GeoTouchSensor
extends X3DTouchSensorNode
GeoTouchSensor returns geographic coordinates for the object being selected.

X3D node tooltip: [X3DTouchSensorNode] GeoTouchSensor returns geographic coordinates for the object being selected. GeoTouchSensor can contain a GeoOrigin node.
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: GeoTouchSensor, X3D Tooltips: GeoTouchSensor, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    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[] getHitGeoCoord()
    Provide array of 3-tuple double results from outputOnly SFVec3d field named hitGeoCoord_changed.
    float[] getHitNormal()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named hitNormal_changed.
    float[] getHitPoint()
    Provide array of 3-tuple float results from outputOnly SFVec3f field named hitPoint_changed.
    float[] getHitTexCoord()
    Provide array of 2-tuple float results from outputOnly SFVec2f field named hitTexCoord_changed.
    boolean getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    boolean getIsOver()
    Provide boolean value from outputOnly SFBool field named isOver.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    double getTouchTime()
    Provide double value in seconds from outputOnly SFTime field named touchTime.
    GeoTouchSensor setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    GeoTouchSensor setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    GeoTouchSensor setGeoOrigin​(GeoOrigin newValue)
    Accessor method to assign GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
    GeoTouchSensor setGeoSystem​(java.lang.String[] newValue)
    Accessor method to assign String array to initializeOnly MFString field named geoSystem.
    GeoTouchSensor setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  • Method Details

    • 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 X3DPointingDeviceSensorNode
      Specified by:
      getDescription in interface X3DTouchSensorNode
      Returns:
      value of description field
    • setDescription

      GeoTouchSensor setDescription​(java.lang.String newValue)
      Accessor method to 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 X3DPointingDeviceSensorNode
      Specified by:
      setDescription in interface X3DTouchSensorNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      GeoTouchSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface X3DPointingDeviceSensorNode
      Specified by:
      getEnabled in interface X3DSensorNode
      Specified by:
      getEnabled in interface X3DTouchSensorNode
      Returns:
      value of enabled field
    • setEnabled

      GeoTouchSensor setEnabled​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface X3DPointingDeviceSensorNode
      Specified by:
      setEnabled in interface X3DSensorNode
      Specified by:
      setEnabled in interface X3DTouchSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      GeoTouchSensor - 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

      GeoTouchSensor 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:
      GeoTouchSensor - 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 (G D), 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

      GeoTouchSensor setGeoSystem​(java.lang.String[] newValue)
      Accessor method to assign String array to initializeOnly MFString field named geoSystem.

      Tooltip: Identifies spatial reference frame: Geodetic (G D), 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:
      GeoTouchSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getHitGeoCoord

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

      Tooltip: Output event containing 3D point on surface of underlying geometry, given in GeoTouchSensor's local coordinate system.
      • 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 hitGeoCoord_changed field
    • getHitNormal

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

      Tooltip: Output event containing surface normal vector at the hitGeoCoordinate.
      • 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 hitNormal_changed field
    • getHitPoint

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

      Tooltip: Output event containing 3D point on surface of underlying geometry, given in geometry coordinates (not geographic coordinates).
      • 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 hitPoint_changed field
    • getHitTexCoord

      float[] getHitTexCoord()
      Provide array of 2-tuple float results from outputOnly SFVec2f field named hitTexCoord_changed.

      Tooltip: Output event containing texture coordinates of surface at the hitGeoCoordinate.
      • 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 hitTexCoord_changed field
    • getIsActive

      boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: Select geometry by activating the pointing device (e.g. clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (e.g. when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (e.g. when primary mouse button is released).
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsActive in interface X3DPointingDeviceSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      Specified by:
      getIsActive in interface X3DTouchSensorNode
      Returns:
      value of isActive field
    • getIsOver

      boolean getIsOver()
      Provide boolean value from outputOnly SFBool field named isOver.

      Tooltip: Is pointing device over sensor's geometry?.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsOver in interface X3DPointingDeviceSensorNode
      Specified by:
      getIsOver in interface X3DTouchSensorNode
      Returns:
      value of isOver field
    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DPointingDeviceSensorNode
      Specified by:
      getMetadata in interface X3DSensorNode
      Specified by:
      getMetadata in interface X3DTouchSensorNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      GeoTouchSensor setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DPointingDeviceSensorNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Specified by:
      setMetadata in interface X3DTouchSensorNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoTouchSensor - 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
    • getTouchTime

      double getTouchTime()
      Provide double value in seconds from outputOnly SFTime field named touchTime.

      Tooltip: Time event generated when touched.
      • Hint: touchTime event is generated when following three conditions are all met: (a) pointing device was pointing towards geometry when initially activated (isActive=true), (b) pointing device is currently pointing towards the geometry (isOver=true), and (c) pointing device selection is deactivated/deselected by user (isActive=false event is also generated).
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getTouchTime in interface X3DTouchSensorNode
      Returns:
      value of touchTime field