com.openinventor.inventor.geo

Class SoVRMLGeoTouchSensor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLTouchSensor

com.openinventor.inventor.geo.SoVRMLGeoTouchSensor

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLGeoTouchSensor
extends SoVRMLTouchSensor

Detects when the user has pointed at a specific piece of geometry. The SoVRMLGeoTouchSensor node tracks the location and state of a pointing device and detects when the user points at geometry contained by the parent group of the GeoTouchSensor. This node provides the same functionality as a TouchSensor but also provides the ability to return the geographic coordinate under the pointing device.

VRML X3D SPECIFICATION

This section describes the expected behavior of the node in a conforming X3D / VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the X3D specification that are not present in this help file. The complete X3D spec is available at http://www.web3d.org.

The SoVRMLGeoTouchSensor node tracks the location and state of a pointing device and detects when the user points at geometry contained by the parent group of the GeoTouchSensor. This node provides the same functionality as a TouchSensor but also provides the ability to return the geographic coordinate under the pointing device. The description field in the GeoTouchSensor node specifies a textual description of the GeoTouchSensor node. This may be used by browser-specific user interfaces that wish to present users with more detailed information about the GeoTouchSensor. A SoVRMLGeoTouchSensor can be enabled or disabled by sending an event of value true or false to the enabled field. A disabled GeoTouchSensor does not track user input or send events. The geoOrigin field is used to specify a local coordinate frame for extended precision as described in 25.2.5 Dealing with high-precision coordinates. The geoSystem field is used to define the spatial reference frame and is described in 25.2.3 Specifying a spatial reference frame. The fields hitNormal_changed, hitPoint_changed, hitTexCoord_changed, isActive, isOver, and touchTime all have the same meaning as in the TouchSensor node. The hitGeoCoord_changed field is generated while the pointing device is pointing towards the SoVRMLGeoTouchSensor's geometry (i.e., when isOver is true). It is a field containing the geospatial coordinate for the point of intersection between the pointing device's location and the underlying geometry. The value of the geoSystem string defines the spatial reference frame of the geospatial coordinate. For example, given the default geoSystem value of "GD", the hitGeoCoord_changed field will be in the format

 <latitude> <longitude> <elevation>

(see 25.2.4 Specifying geospatial coordinates). The hitGeoCoordString_changed is the MFString equivalent of hitGeoCoord_changed.

File format/default:

VRMLGeoTouchSensor {

enabled	true
description	""
metadata	NULL
geoOrigin	NULL
geoSystem	["GD","WE"]

}

EVENTS

eventIn

SoSFBool	set_enabled
SoSFBool	set_description
SoSFNode	set_metadata

eventOut

SoSFString	description_changed
SoSFBool	enabled_changed
SoSFVec3f	hitNormal_changed
SoSFVec3f	hitPoint_changed
SoSFVec2f	hitTexCoord_changed
SoSFVec2f	hitGeoCoord_changed
SoMFString	hitGeoCoordString_changed
SoSFBool	isActive
SoSFBool	isOver (Note: Not implemented)
SoSFTime	touchTime
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFNode	geoOrigin Deprecated. An SoVRMLGeoOrigin node specifying the origin of the local coordinate system.
SoMFString	geoSystem Deprecated. Defines the spatial reference frame.
SoSFVec3f	hitGeoCoord_changed Deprecated. Output event sent when cursor on shape.
SoMFString	hitGeoCoordString_changed Deprecated. Output event sent when cursor on shape.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLTouchSensor

description, enabled, hitNormal_changed, hitPoint_changed, hitTexCoord_changed, isActive, isOver, touchTime

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLGeoTouchSensor() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLTouchSensor

enableEvents, isEventsEnabled

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

geoOrigin

public final SoSFNode geoOrigin

Deprecated.

An SoVRMLGeoOrigin node specifying the origin of the local coordinate system.

geoSystem

public final SoMFString geoSystem

Deprecated.

Defines the spatial reference frame.
Valid values are:

• GC: Earth-fixed Geocentric with respect to the WGS84 ellipsoid.
• GD: Geodetic spatial reference frame.
  An optional second string may be used to specify the ellipsoid using one of the ellipsoid codes that are defined in X3D. If no ellipsoid is specified, then "WE" is assumed (the WGS84 ellipsoid).
• UTM: Universal Transverse Mercator
  One further required argument must be supplied for UTM in order to specify the zone number (1..60). This is given in the form "Z<n>", where "<n>" is the zone number. An optional argument of "S" may be supplied in order to specify that the coordinates are in the southern hemisphere (otherwise, northern hemisphere will be assumed).

hitGeoCoord_changed

public final SoSFVec3f hitGeoCoord_changed

Deprecated.

Output event sent when cursor on shape.

hitGeoCoordString_changed

public final SoMFString hitGeoCoordString_changed

Deprecated.

Output event sent when cursor on shape.

Constructor Detail

SoVRMLGeoTouchSensor

public SoVRMLGeoTouchSensor()

Deprecated.

Constructor.