GeoProximitySensor (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DEnvironmentalSensorNode, X3DNode, X3DSensorNode

All Known Implementing Classes:

GeoProximitySensorObject
```
public interface GeoProximitySensor
extends X3DEnvironmentalSensorNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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
  http://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:

SAI Java Specification: TODO, X3D Abstract Specification: GeoProximitySensor, X3D Tooltips: GeoProximitySensor, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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.
`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 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.
`boolean`	`getIsActive()` Provide boolean value from outputOnly SFBool field named isActive.
`X3DMetadataObject`	`getMetadata()` Provide 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 initializeOnly SFVec3f field named size.
`GeoProximitySensor`	`setCenter(double[] newValue)` Assign 3-tuple double array to inputOutput SFVec3d field named center.
`GeoProximitySensor`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`GeoProximitySensor`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`GeoProximitySensor`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`GeoProximitySensor`	`setGeoCenter(double[] newValue)` Assign 3-tuple double array to inputOutput SFVec3d field named geoCenter.
`GeoProximitySensor`	`setGeoOrigin(GeoOrigin newValue)` Assign GeoOrigin instance (using a properly typed node) (deprecated node, optional) to initializeOnly SFNode field geoOrigin.
`GeoProximitySensor`	`setGeoSystem(java.lang.String[] newValue)` Assign String array to initializeOnly MFString field named geoSystem.
`GeoProximitySensor`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`GeoProximitySensor`	`setSize(float[] newValue)` Assign 3-tuple float array within allowed range of [0,infinity) to initializeOnly SFVec3f field named size.
`GeoProximitySensor`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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.
    Returns:
    
    value of centerOfRotation_changed field
  - 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)
```
    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.
    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.
    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
      http://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)
```
    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 http://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
      http://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.
    Returns:
    
    value of geoCoord_changed field
  - 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
```
GeoProximitySensor setGeoOrigin(GeoOrigin newValue)
```
    Assign GeoOrigin instance (using a properly typed node) (deprecated node, optional) 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).
  - 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.
    - Hint: X3D Architecture 25.2.2 Spatial reference frames
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
    - Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.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(java.lang.String[] newValue)
```
    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 http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.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.
    Specified by:
    
    getIsActive in interface X3DEnvironmentalSensorNode
    
    Specified by:
    
    getIsActive in interface X3DSensorNode
    
    Returns:
    
    value of isActive 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 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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field 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.
    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.
    Returns:
    
    value of position_changed field
  - getSize
```
float[] getSize()
```
    Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.
    
    Tooltip: [0,+infinity) size of Proximity box.
    - 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)
```
    Assign 3-tuple float array within allowed range of [0,infinity) to initializeOnly SFVec3f field named size.
    
    Tooltip: [0,+infinity) size of Proximity box. 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).
  - setDEF
```
GeoProximitySensor setDEF(java.lang.String newValue)
```
    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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DEnvironmentalSensorNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DSensorNode
    
    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).
  - setUSE
```
GeoProximitySensor setUSE(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DEnvironmentalSensorNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DSensorNode
    
    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).
  - setCssClass
```
GeoProximitySensor setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DEnvironmentalSensorNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DSensorNode
    
    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).

Interface GeoProximitySensor

Method Summary

Method Detail

getCenter

setCenter

getCenterOfRotation

getEnabled

setEnabled

getEnterTime

getExitTime

getGeoCenter

setGeoCenter

getGeoCoord

getGeoOrigin

setGeoOrigin

getGeoSystem

setGeoSystem

getIsActive

getMetadata

setMetadata

getOrientation

getPosition

getSize

setSize

setDEF

setUSE

setCssClass