Class GeoProximitySensor

All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, X3DEnvironmentalSensorNode, GeoProximitySensor

public class GeoProximitySensor extends X3DConcreteNode implements GeoProximitySensor
GeoProximitySensor generates events when the viewer enters, exits and moves within a region of space (defined by a box).

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: (X3D version 3.2 or later) [X3DEnvironmentalSensorNode] GeoProximitySensor generates events when the viewer enters, exits and moves within a region of space (defined by a box). Hint: multiple USEd instances are cumulative, but avoid overlaps. Hint: can first use GeoTransform to relocate/reorient box. Hint: surround entire world to start behaviors once scene is loaded. 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='2'/&gt; *


Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: GeoProximitySensor.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the GeoProximitySensor element: Geospatial
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Geospatial component level for this element: 2
      See Also:
    • CENTER_DEFAULT_VALUE

      public static final double[] CENTER_DEFAULT_VALUE
      SFVec3d field named center has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:
    • ENABLED_DEFAULT_VALUE

      public static final boolean ENABLED_DEFAULT_VALUE
      SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
      See Also:
    • GEOCENTER_DEFAULT_VALUE

      public static final double[] GEOCENTER_DEFAULT_VALUE
      SFVec3d field named geoCenter has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
    • GEOORIGIN_DEFAULT_VALUE

      public static final GeoOrigin GEOORIGIN_DEFAULT_VALUE
      SFNode field named geoOrigin has default value null (Java syntax) or NULL (XML syntax).
    • GEOSYSTEM_DEFAULT_VALUE

      public static final ArrayList<String> GEOSYSTEM_DEFAULT_VALUE
      MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • SIZE_DEFAULT_VALUE

      public static final float[] SIZE_DEFAULT_VALUE
      SFVec3f field named size has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
    • fromField_CENTER

      public static final String fromField_CENTER
      fromField ROUTE name for SFVec3d field named center.
      See Also:
    • toField_CENTER

      public static final String toField_CENTER
      toField ROUTE name for SFVec3d field named center.
      See Also:
    • fromField_CENTEROFROTATION_CHANGED

      public static final String fromField_CENTEROFROTATION_CHANGED
      fromField ROUTE name for SFVec3f field named centerOfRotation_changed.
      See Also:
    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:
    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:
    • fromField_ENTERTIME

      public static final String fromField_ENTERTIME
      fromField ROUTE name for SFTime field named enterTime.
      See Also:
    • fromField_EXITTIME

      public static final String fromField_EXITTIME
      fromField ROUTE name for SFTime field named exitTime.
      See Also:
    • fromField_GEOCENTER

      public static final String fromField_GEOCENTER
      fromField ROUTE name for SFVec3d field named geoCenter.
      See Also:
    • toField_GEOCENTER

      public static final String toField_GEOCENTER
      toField ROUTE name for SFVec3d field named geoCenter.
      See Also:
    • fromField_GEOCOORD_CHANGED

      public static final String fromField_GEOCOORD_CHANGED
      fromField ROUTE name for SFVec3d field named geoCoord_changed.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
    • fromField_ORIENTATION_CHANGED

      public static final String fromField_ORIENTATION_CHANGED
      fromField ROUTE name for SFRotation field named orientation_changed.
      See Also:
    • fromField_POSITION_CHANGED

      public static final String fromField_POSITION_CHANGED
      fromField ROUTE name for SFVec3f field named position_changed.
      See Also:
    • fromField_SIZE

      public static final String fromField_SIZE
      fromField ROUTE name for SFVec3f field named size.
      See Also:
    • toField_SIZE

      public static final String toField_SIZE
      toField ROUTE name for SFVec3f field named size.
      See Also:
  • Constructor Details

    • GeoProximitySensor

      public GeoProximitySensor()
      Constructor for GeoProximitySensor to initialize member variables with default values.
    • GeoProximitySensor

      public GeoProximitySensor(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: GeoProximitySensor
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final String getComponent()
      Defines X3D component for the GeoProximitySensor element: Geospatial
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getCenter

      public double[] getCenter()
      Provide array of 3-tuple double results from inputOutput SFVec3d field named center.

      Tooltip: (starting with v3.3) Position offset from origin of local coordinate system. *
      Specified by:
      getCenter in interface GeoProximitySensor
      Returns:
      value of center field
    • setCenter

      public GeoProximitySensor setCenter(double[] newValue)
      Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named center.

      Tooltip: (starting with v3.3) Position offset from origin of local coordinate system. *
      Specified by:
      setCenter in interface GeoProximitySensor
      Parameters:
      newValue - is new value for the center field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public GeoProximitySensor setCenter(SFVec3d newValue)
      Assign typed object value to SFVec3d center field, similar to setCenter(double[]). // #0.e
      Parameters:
      newValue - is new value for the center field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public GeoProximitySensor setCenter(double x, double y, double z)
      Assign values to SFVec3d center field, similar to setCenter(double[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCenterOfRotation

      public float[] getCenterOfRotation()
      Provide array of 3-tuple float results unit axis, angle (in radians) from outputOnly SFVec3f field named centerOfRotation_changed.

      Tooltip: Sends changed centerOfRotation values, likely caused by user interaction. 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:
      getCenterOfRotation in interface GeoProximitySensor
      Returns:
      value of centerOfRotation_changed field
    • getDescription

      public String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the node. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      getDescription in interface GeoProximitySensor
      Specified by:
      getDescription in interface X3DEnvironmentalSensorNode
      Specified by:
      getDescription in interface X3DSensorNode
      Returns:
      value of description field
    • setDescription

      public GeoProximitySensor setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the node. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      setDescription in interface GeoProximitySensor
      Specified by:
      setDescription in interface X3DEnvironmentalSensorNode
      Specified by:
      setDescription in interface X3DSensorNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

      public GeoProximitySensor setDescription(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String). // #0.e
      Parameters:
      newValue - is new value for the description field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnabled

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

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

      public GeoProximitySensor 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 GeoProximitySensor
      Specified by:
      setEnabled in interface X3DEnvironmentalSensorNode
      Specified by:
      setEnabled in interface X3DSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

      public GeoProximitySensor setEnabled(SFBool newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean). // #0.e
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnterTime

      public double getEnterTime()
      Provide double value in seconds from outputOnly SFTime field named enterTime.

      Tooltip: Time event generated when user's camera enters the box. 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:
      getEnterTime in interface GeoProximitySensor
      Returns:
      value of enterTime field
    • getExitTime

      public double getExitTime()
      Provide double value in seconds from outputOnly SFTime field named exitTime.

      Tooltip: Time event generated when user's camera exits the box. 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:
      getExitTime in interface GeoProximitySensor
      Returns:
      value of exitTime field
    • getGeoCenter

      public double[] getGeoCenter()
      Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCenter.

      Tooltip: (deprecated as of v3.3) Position offset from origin of local coordinate system. 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; *
      Specified by:
      getGeoCenter in interface GeoProximitySensor
      Returns:
      value of geoCenter field
    • setGeoCenter

      public GeoProximitySensor setGeoCenter(double[] newValue)
      Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCenter.

      Tooltip: (deprecated as of v3.3) Position offset from origin of local coordinate system. 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; *
      Specified by:
      setGeoCenter in interface GeoProximitySensor
      Parameters:
      newValue - is new value for the geoCenter field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoCenter

      public GeoProximitySensor setGeoCenter(SFVec3d newValue)
      Assign typed object value to SFVec3d geoCenter field, similar to setGeoCenter(double[]). // #0.e
      Parameters:
      newValue - is new value for the geoCenter field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoCenter

      public GeoProximitySensor setGeoCenter(double x, double y, double z)
      Assign values to SFVec3d geoCenter field, similar to setGeoCenter(double[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoCoord

      public double[] getGeoCoord()
      Provide array of 3-tuple double results from outputOnly SFVec3d field named geoCoord_changed.

      Tooltip: Sends geospatial coordinates of viewer's position corresponding to world position returned by position_changed. 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. *
      Specified by:
      getGeoCoord in interface GeoProximitySensor
      Returns:
      value of geoCoord_changed field
    • getGeoOrigin

      public GeoOrigin getGeoOrigin()
      Provide org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) (deprecated node, optional) from initializeOnly SFNode field geoOrigin.
      Specified by:
      getGeoOrigin in interface GeoProximitySensor
      Returns:
      value of geoOrigin field
      See Also:


      • 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). *
    • setGeoOrigin

      public GeoProximitySensor setGeoOrigin(GeoOrigin newValue)
      Accessor method to assign org.web3d.x3d.sai.Geospatial.GeoOrigin instance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Specified by:
      setGeoOrigin in interface GeoProximitySensor
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearGeoOrigin

      public GeoProximitySensor clearGeoOrigin()
      Utility method to clear SFNode value of geoOrigin field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setGeoOrigin

      public GeoProximitySensor setGeoOrigin(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field geoOrigin.
      Parameters:
      newValue - is new value for the geoOrigin field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • hasGeoOrigin

      public boolean hasGeoOrigin()
      Indicate whether an object is available for initializeOnly SFNode field geoOrigin.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
    • getGeoSystem

      public 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). *
      Specified by:
      getGeoSystem in interface GeoProximitySensor
      Returns:
      value of geoSystem field
    • getGeoSystemList

      public ArrayList<String> getGeoSystemList()
      Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • getGeoSystemString

      public String getGeoSystemString()
      Utility method to get String value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • setGeoSystem

      public GeoProximitySensor 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). *
      Specified by:
      setGeoSystem in interface GeoProximitySensor
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public GeoProximitySensor setGeoSystem(MFString newValue)
      Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]). // #0.e
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public GeoProximitySensor setGeoSystem(SFString newValue)
      Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public GeoProximitySensor setGeoSystem(String newValue)
      Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public GeoProximitySensor setGeoSystem(ArrayList<String> newValue)
      Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearGeoSystem

      public GeoProximitySensor clearGeoSystem()
      Utility method to clear MFString value of geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addGeoSystem

      public GeoProximitySensor addGeoSystem(String newValue)
      Add singleton String value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • addGeoSystem

      public GeoProximitySensor addGeoSystem(SFString newValue)
      Add singleton SFString value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
    • setIS

      public GeoProximitySensor setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearIS

      public GeoProximitySensor clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
    • getIsActive

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

      Tooltip: isActive true/false events are sent as viewer enters/exits Proximity box. isActive=true when viewer enters Proximity box, isActive=false when viewer exits Proximity box. 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 GeoProximitySensor
      Specified by:
      getIsActive in interface X3DEnvironmentalSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      Returns:
      value of isActive field
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface GeoProximitySensor
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DEnvironmentalSensorNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSensorNode
      Returns:
      value of metadata field
      See Also:


      • 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> *
      • X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public GeoProximitySensor setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface GeoProximitySensor
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DEnvironmentalSensorNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearMetadata

      public GeoProximitySensor clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public GeoProximitySensor setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
    • getOrientation

      public float[] getOrientation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from outputOnly SFRotation field named orientation_changed.

      Tooltip: Sends rotation event relative to center. 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:
      getOrientation in interface GeoProximitySensor
      Returns:
      value of orientation_changed field
    • getPosition

      public float[] getPosition()
      Provide array of 3-tuple float results from outputOnly SFVec3f field named position_changed.

      Tooltip: Sends translation event relative to center. 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:
      getPosition in interface GeoProximitySensor
      Returns:
      value of position_changed field
    • getSize

      public float[] getSize()
      Provide array of 3-tuple float results within allowed range of [0,infinity) from inputOutput SFVec3f field named size.

      Tooltip: [0,+infinity) size of Proximity box around center location, oriented within local transformation frame. Hint: size 0 0 0 is same as enabled false. *
      Specified by:
      getSize in interface GeoProximitySensor
      Specified by:
      getSize in interface X3DEnvironmentalSensorNode
      Returns:
      value of size field
    • setSize

      public GeoProximitySensor setSize(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named size.

      Tooltip: [0,+infinity) size of Proximity box around center location, oriented within local transformation frame. Hint: size 0 0 0 is same as enabled false. *
      Specified by:
      setSize in interface GeoProximitySensor
      Specified by:
      setSize in interface X3DEnvironmentalSensorNode
      Parameters:
      newValue - is new value for the size field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public GeoProximitySensor setSize(SFVec3f newValue)
      Assign typed object value to SFVec3f size field, similar to setSize(float[]). // #0.e
      Parameters:
      newValue - is new value for the size field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public GeoProximitySensor setSize(float x, float y, float z)
      Assign values to SFVec3f size field, similar to setSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public GeoProximitySensor setSize(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public GeoProximitySensor setSize(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public String getDEF()
      Provide String value from 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
    • setDEF

      public final GeoProximitySensor setDEF(String newValue)
      Accessor method to 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 <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *


      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public GeoProximitySensor setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public String getUSE()
      Provide String value from 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. *
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
    • setUSE

      public final GeoProximitySensor setUSE(String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public GeoProximitySensor setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:
    • setCssClass

      public final GeoProximitySensor setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssClass

      public GeoProximitySensor setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
      Parameters:
      newValue - is new value for the class field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:
    • setHtmlID

      public final GeoProximitySensor setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setHtmlID

      public GeoProximitySensor setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:
    • setCssStyle

      public final GeoProximitySensor setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • setCssStyle

      public GeoProximitySensor setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
      Parameters:
      newValue - is new value for the style field.
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public GeoProximitySensor setUSE(GeoProximitySensor DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that 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.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public GeoProximitySensor addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • addComments

      public GeoProximitySensor addComments(String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public GeoProximitySensor addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)