com.openinventor.inventor.vrmlnodes

Class SoVRMLPlaneSensor

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.SoVRMLPlaneSensor

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLPlaneSensor
extends SoVRMLNode

Maps pointing device motion onto a plane. The SoVRMLPlaneSensor maps pointing device (e.g. mouse or wand) motion into translation in two dimensions, in the XY plane of its local space. SoVRMLPlaneSensor uses the descendant geometry of its parent node to determine if a hit occurs.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming 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 VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLPlaneSensor maps pointing device (e.g. mouse or wand) motion into translation in two dimensions, in the XY plane of its local space. SoVRMLPlaneSensor uses the descendant geometry of its parent node to determine if a hit occurs.

The enabled exposed field enables and disables the SoVRMLPlaneSensor - if true, the sensor reacts appropriately to user events, if false, the sensor does not track user input or send output events. If enabled receives a false event and isActive is true, the sensor becomes disabled and deactivated, and outputs an isActive false event. If enabled receives a true, event the sensor is enabled and ready for user activation.

The SoVRMLPlaneSensor generates events if the pointing device is activated while over any descendant geometry nodes of its parent group and then moved while activated. Typically, the pointing device is a 2D device such as a mouse. The pointing device is considered to be moving within a plane at a fixed distance from the viewer and perpendicular to the line of sight; this establishes a set of 3D coordinates for the pointer. If a 3D pointer is in use, then the sensor generates events only when the pointer is within the user's field of view. In either case, the pointing device is considered to "pass over" geometry when that geometry is intersected by a line extending from the viewer and passing through the pointer's 3D coordinates. If multiple sensors' geometry intersect this line (hereafter called the bearing), only the nearest will be eligible to generate events.

Upon activation of the pointing device (e.g. mouse button down) over the sensor's geometry, an isActive true event is sent. Dragging motion is mapped into a relative translation in the XY plane of the sensor's local coordinate system as it was defined at the time of activation. For each subsequent position of the bearing, a translation_changed event is output which corresponds to a relative translation from the original intersection point projected onto the XY plane, plus the offset value. The sign of the translation is defined by the XY plane of the sensor's coordinate system. trackPoint_changed events reflect the unclamped drag position on the surface of this plane. When the pointing device is deactivated and autoOffset is true, offset is set to the last translation value and an offset_changed event is generated. See "Concepts - Drag Sensors" for more details.

When the sensor generates an isActive true event, it grabs all further motion events from the pointing device until it releases and generates an isActive false event (other pointing device sensors cannot generate events during this time). Motion of the pointing device while isActive is true is referred to as a "drag". If a 2D pointing device is in use, isActive events will typically reflect the state of the primary button associated with the device (i.e., isActive is true when the primary button is pressed, and false when not released). If a 3D pointing device (e.g. wand) is in use, isActive events will typically reflect whether the pointer is within or in contact with the sensor's geometry.

minPosition and maxPosition may be set to clamp translation events to a range of values as measured from the origin of the XY plane. If the X or Y component of minPosition is greater than the corresponding component of maxPosition, translation_changed events are not clamped in that dimension. If the X or Y component of minPosition is equal to the corresponding component of maxPosition, that component is constrained to the given value; this technique provides a way to implement a line sensor that maps dragging motion into a translation in one dimension.

While the pointing device is activated, trackPoint_changed and translation_changed events are output. trackPoint_changed events represent the unclamped intersection points on the surface of the local XY plane. If the pointing device is dragged off of the XY plane while activated (e.g. above horizon line), browsers may interpret this in several ways (e.g. clamp all values to the horizon). Each movement of the pointing device, while isActive is true, generates trackPoint_changed and translation_changed events.

See "Concepts - Pointing Device Sensors and Drag Sensors" for more details.

File format/default:

VRMLPlaneSensor {

autoOffset	true
enabled	true
maxPosition	-1 -1
minPosition	0 0
offset	0 0 0
description	""
metadata	NULL

}

EVENTS

eventIn

SoSFBool	set_autoOffset
SoSFBool	set_enabled
SoSFVec2f	set_maxPosition
SoSFVec2f	set_minPosition
SoSFVec3f	set_offset
SoSFString	set_description
SoSFNode	set_metadata

eventOut

SoSFBool	isActive
SoSFBool	isOver (Note: Not implemented)
SoSFVec3f	trackPoint_changed
SoSFVec3f	translation_changed
SoSFBool	autoOffset_changed
SoSFBool	enabled_changed
SoSFVec2f	maxPosition_changed
SoSFVec2f	minPosition_changed
SoSFVec3f	offset_changed
SoSFString	description_changed
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
SoSFBool	autoOffset Deprecated. Specifies whether to set offset to the last rotation angle (true).
SoSFString	description Deprecated. String that describes the sensor.
SoSFBool	enabled Deprecated. Enables (true) or disables (false) the sensor.
SoSFBool	isActive Deprecated. Output event.
SoSFBool	isOver Deprecated. Output event.
SoSFVec2f	maxPosition Deprecated. Used to clamp translation events to a range of values as measured from the origin of the XY plane.
SoSFVec2f	minPosition Deprecated. Used to clamp translation events to a range of values as measured from the origin of the XY plane.
SoSFVec3f	offset Deprecated. Amount to add to the translation event value.
SoSFVec3f	trackPoint_changed Deprecated. Output event.
SoSFVec3f	translation_changed Deprecated. Output event.

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
SoVRMLPlaneSensor() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
static void	enableEvents(boolean OnOffFlag) Deprecated. Enables/disables events for all SoVRMLPlaneSensor objects.
static boolean	isEventsEnabled() Deprecated. Queries if events are enabled for all objects of this class.

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

minPosition

public final SoSFVec2f minPosition

Deprecated.

Used to clamp translation events to a range of values as measured from the origin of the XY plane.

maxPosition

public final SoSFVec2f maxPosition

Deprecated.

Used to clamp translation events to a range of values as measured from the origin of the XY plane.

enabled

public final SoSFBool enabled

Deprecated.

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

offset

public final SoSFVec3f offset

Deprecated.

Amount to add to the translation event value.

autoOffset

public final SoSFBool autoOffset

Deprecated.

Specifies whether to set offset to the last rotation angle (true).

description

public final SoSFString description

Deprecated.

String that describes the sensor.

Since:

Open Inventor 5.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

isActive

public final SoSFBool isActive

Deprecated.

Output event.

isOver

public final SoSFBool isOver

Deprecated.

Output event.

trackPoint_changed

public final SoSFVec3f trackPoint_changed

Deprecated.

Output event.

translation_changed

public final SoSFVec3f translation_changed

Deprecated.

Output event.

Constructor Detail

SoVRMLPlaneSensor

public SoVRMLPlaneSensor()

Deprecated.

Constructor.

Method Detail

isEventsEnabled

public static boolean isEventsEnabled()

Deprecated.

Queries if events are enabled for all objects of this class.

enableEvents

public static void enableEvents(boolean OnOffFlag)

Deprecated.

Enables/disables events for all SoVRMLPlaneSensor objects. If you have created several objects of this class, you can disable/enable events for all of them with a single call to this method.