All Superinterfaces:: X3DChildNode, X3DEnvironmentalSensorNode, X3DNode, X3DSensorNode

All Known Implementing Classes:: GeoProximitySensor

public interface GeoProximitySensor extends X3DEnvironmentalSensorNode

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

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

double[]

getCenter()

Provide array of 3-tuple double results from inputOutput SFVec3d field named center.

float[]

getCenterOfRotation()

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

String

getDescription()

Provide String value from inputOutput SFString field named description.

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

double

getEnterTime()

Provide double value in seconds from outputOnly SFTime field named enterTime.

double

getExitTime()

Provide double value in seconds from outputOnly SFTime field named exitTime.

double[]

getGeoCenter()

Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCenter.

double[]

getGeoCoord()

Provide array of 3-tuple double results from outputOnly SFVec3d field named geoCoord_changed.

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.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

float[]

getOrientation()

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

float[]

getPosition()

Provide array of 3-tuple float results from outputOnly SFVec3f field named position_changed.

float[]

getSize()

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

GeoProximitySensor

setCenter(double[] newValue)

Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named center.

GeoProximitySensor

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

GeoProximitySensor

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

GeoProximitySensor

setGeoCenter(double[] newValue)

Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCenter.

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.

GeoProximitySensor

setGeoSystem(String[] newValue)

Accessor method to assign String array to initializeOnly MFString field named geoSystem.

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.

GeoProximitySensor

setSize(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named size.

Method Details
- getCenter
  
  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. *
  
  Returns:
  
  value of center field
- setCenter
  
  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. *
  
  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).
- getCenterOfRotation
  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.
  
  Returns:
  
  value of centerOfRotation_changed field
- getDescription
  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 & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  getDescription in interface X3DEnvironmentalSensorNode
  
  Specified by:
  
  getDescription in interface X3DSensorNode
  
  Returns:
  
  value of description field
- setDescription
  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 & for & ampersand character, or " for " quotation-mark character).
  
  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).
- getEnabled
  
  boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface X3DEnvironmentalSensorNode
  
  Specified by:
  
  getEnabled in interface X3DSensorNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  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 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).
- getEnterTime
  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.
  
  Returns:
  
  value of enterTime field
- getExitTime
  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.
  
  Returns:
  
  value of exitTime field
- getGeoCenter
  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 https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
  
  Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
  
  Returns:
  
  value of geoCenter field
- setGeoCenter
  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 https://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 geoCenter field.
  
  Returns:
  
  GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getGeoCoord
  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 https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
  
  Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
  
  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 geoCoord_changed field
- 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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#high-precisioncoords
  
  Warning: XML validation requires placement as first child node following contained metadata nodes (if any).
  
  Returns:
  
  value of geoOrigin field
- setGeoOrigin
  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.
  
  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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#high-precisioncoords
  
  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:
  
  GeoProximitySensor - 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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Spatialreferenceframes
  
  Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.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
  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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.html#Spatialreferenceframes
  
  Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/geospatial.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:
  
  GeoProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIsActive
  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 X3DEnvironmentalSensorNode
  
  Specified by:
  
  getIsActive in interface X3DSensorNode
  
  Returns:
  
  value of isActive field
- 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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  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:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  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.
  
  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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DEnvironmentalSensorNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSensorNode
  
  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:
  
  X3D Scene Authoring Hints: Metadata Nodes
- getOrientation
  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.
  
  Returns:
  
  value of orientation_changed field
- getPosition
  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.
  
  Returns:
  
  value of position_changed field
- getSize
  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 X3DEnvironmentalSensorNode
  
  Returns:
  
  value of size field
- setSize
  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 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).

Interface GeoProximitySensor

Method Summary

Method Details

getCenter

setCenter

getCenterOfRotation

getDescription

setDescription

getEnabled

setEnabled

getEnterTime

getExitTime

getGeoCenter

setGeoCenter

getGeoCoord

getGeoOrigin

setGeoOrigin

getGeoSystem

setGeoSystem

getIsActive

getMetadata

setMetadata

getOrientation

getPosition

getSize

setSize