Click or drag to resize
SoVRMLGeoTouchSensor Class

Note: This API is now obsolete.

Detects when the user has pointed at a specific piece of geometry.

Inheritance Hierarchy

Namespace: OIV.Inventor.Geo
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoVRMLGeoTouchSensor : SoVRMLTouchSensor

The SoVRMLGeoTouchSensor type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLGeoTouchSensor

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoVRMLTouchSensor.)
Public methodCallback
(Inherited from SoNode.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoVRMLNode.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertydescription

String that describes the sensor.

(Inherited from SoVRMLTouchSensor.)
Public propertyenabled

Enables (true) or disables (false) the sensor.

(Inherited from SoVRMLTouchSensor.)
Public propertygeoOrigin

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

Public propertygeoSystem

Defines the spatial reference frame.

Public propertyhitGeoCoord_changed

Output event sent when cursor on shape.

Public propertyhitGeoCoordString_changed

Output event sent when cursor on shape.

Public propertyhitNormal_changed

Output event sent when cursor is on shape.

(Inherited from SoVRMLTouchSensor.)
Public propertyhitPoint_changed

Output event sent when cursor on shape.

(Inherited from SoVRMLTouchSensor.)
Public propertyhitTexCoord_changed

Output event sent when cursor on shape.

(Inherited from SoVRMLTouchSensor.)
Public propertyisActive

Output event sent on button press/release.

(Inherited from SoVRMLTouchSensor.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyisOver

Output event sent when cursor on shape.

(Inherited from SoVRMLTouchSensor.)
Public propertymetadata

Specifies the metadata node.

(Inherited from SoVRMLNode.)
Public propertytouchTime

Output events sent on button release.

(Inherited from SoVRMLTouchSensor.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

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

SoSFBoolset_enabled
SoSFBoolset_description
SoSFNodeset_metadata

eventOut

SoSFStringdescription_changed
SoSFBoolenabled_changed
SoSFVec3fhitNormal_changed
SoSFVec3fhitPoint_changed
SoSFVec2fhitTexCoord_changed
SoSFVec2fhitGeoCoord_changed
SoMFStringhitGeoCoordString_changed
SoSFBoolisActive
SoSFBoolisOver (Note: Not implemented)
SoSFTimetouchTime
SoSFNodemetadata_changed
Obsoletesince 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.

See Also