SoVRMLPlaneSensor Class Reference
[VRML97 nodes]
Maps pointing device motion onto a plane.
More...
#include <Inventor/VRMLnodes/SoVRMLPlaneSensor.h>
Classes | |
| struct | MTstruct |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLPlaneSensor () | |
| virtual SbBool | affectsState () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static void | enableEvents (SbBool OnOffFlag) |
| static SbBool | isEventsEnabled () |
Public Attributes | |
| SoSFVec2f | minPosition |
| SoSFVec2f | maxPosition |
| SoSFBool | enabled |
| SoSFVec3f | offset |
| SoSFBool | autoOffset |
| SoSFString | description |
| SoSFBool | isActive |
| SoSFBool | isOver |
| SoSFVec3f | trackPoint_changed |
| SoSFVec3f | translation_changed |
Detailed Description
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.
NOTE: 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
- Deprecated:
-
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. - Inventor/VRMLnodes/SoVRMLPlaneSensor.h
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 |
Constructor & Destructor Documentation
| SoVRMLPlaneSensor::SoVRMLPlaneSensor | ( | ) |
Constructor.
Member Function Documentation
| virtual SbBool SoVRMLPlaneSensor::affectsState | ( | ) | const [virtual] |
Returns TRUE if a node has an effect on the state during traversal.
The default method returns TRUE. Node classes (such as SoSeparator) that isolate their effects from the rest of the graph override this method to return FALSE.
Reimplemented from SoNode.
| static void SoVRMLPlaneSensor::enableEvents | ( | SbBool | OnOffFlag | ) | [static] |
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.
| static SoType SoVRMLPlaneSensor::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLNode.
| virtual SoType SoVRMLPlaneSensor::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLNode.
| static SbBool SoVRMLPlaneSensor::isEventsEnabled | ( | ) | [static] |
Queries if events are enabled for all objects of this class.
Member Data Documentation
Specifies whether to set offset to the last rotation angle (TRUE).
String that describes the sensor. NOTE: field available 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.
Enables (TRUE) or disables (FALSE) the sensor.
Output event.
Output event.
Used to clamp translation events to a range of values as measured from the origin of the XY plane.
Used to clamp translation events to a range of values as measured from the origin of the XY plane.
Amount to add to the translation event value.
Output event.
Output event.
The documentation for this class was generated from the following file: