SoVRMLCylinderSensor Class Reference
[VRML97 nodes]
Maps pointing device motion onto a cylinder.
Action not implemented for this node.
More...
#include <Inventor/VRMLnodes/SoVRMLCylinderSensor.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLCylinderSensor () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static void | enableEvents (SbBool OnOffFlag) |
| static SbBool | isEventsEnabled () |
Public Attributes | |
| SoSFFloat | diskAngle |
| SoSFBool | enabled |
| SoSFFloat | maxAngle |
| SoSFFloat | minAngle |
| SoSFFloat | offset |
| SoSFBool | autoOffset |
| SoSFString | description |
Detailed Description
Maps pointing device motion onto a cylinder. Action not implemented for this node.
The SoVRMLCylinderSensor maps pointing device (e.g. mouse or wand) motion into a rotation on an invisible cylinder that is aligned with the Y axis of its local space.
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 SoVRMLCylinderSensor maps pointing device (e.g. mouse or wand) motion into a rotation on an invisible cylinder that is aligned with the Y axis of its local space.
The enabled exposed field enables and disables the SoVRMLCylinderSensor - 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 SoVRMLCylinderSensor 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' geometries 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. The angle between the bearing vector and the local Y axis of the SoVRMLCylinderSensor determines whether the sides of the invisible cylinder or the caps (disks) are used for manipulation. If the angle is less than the diskAngle, then the geometry is treated as an infinitely large disk and dragging motion is mapped into a rotation around the local Y axis of the sensor's coordinate system. The feel of the rotation is as if you were rotating a dial or crank. Using the right-hand rule, the X axis of the sensor's local coordinate system, (defined by parents), represents the zero rotation value around the sensor's local Y axis. For each subsequent position of the bearing, a rotation_changed event is output which corresponds to the angle between the local X axis and the vector defined by the intersection point and the nearest point on the local Y axis, plus the offset value. trackPoint_changed events reflect the unclamped drag position on the surface of this disk. When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation angle and an offset_changed event is generated. See "Concepts - Drag Sensors" for more details on autoOffset and offset_changed .
If the angle between the bearing vector and the local Y axis of the SoVRMLCylinderSensor is greater than or equal to diskAngle, then the sensor behaves like a cylinder or rolling pin. The shortest distance between the point of intersection (between the bearing and the sensor's geometry) and the Y axis of the parent group's local coordinate system determines the radius of an invisible cylinder used to map pointing device motion, and mark the zero rotation value. For each subsequent position of the bearing, a rotation_changed event is output which corresponds to a relative rotation from the original intersection, plus the offset value. trackPoint_changed events reflect the unclamped drag position on the surface of this cylinder. When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation angle 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.
While the pointing device is activated, trackPoint_changed and rotation_changed events are output and are interpreted from pointing device motion based on the sensor's local coordinate system at the time of activation. trackPoint_changed events represent the unclamped intersection points on the surface of the invisible cylinder or disk. If the initial angle results in cylinder rotation (as opposed to disk behavior) and if the pointing device is dragged off the cylinder while activated, browsers may interpret this in several ways (e.g. clamp all values to the cylinder, continue to rotate as the point is dragged away from the cylinder, etc.). Each movement of the pointing device, while isActive is TRUE, generates trackPoint_changed and rotation_changed events.
minAngle and maxAngle may be set to clamp rotation_changed events to a range of values (measured in radians about the local Z and Y axis as appropriate). If minAngle is greater than maxAngle, rotation_changed events are not clamped.
See "Concepts - Pointing Device Sensors and Drag Sensors" for more details.
FILE FORMAT/DEFAULT
- VRMLCylinderSensor {
| autoOffset | TRUE |
| diskAngle | 0.262 |
| enabled | TRUE |
| maxAngle | -1 |
| minAngle | 0 |
| offset | 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/SoVRMLCylinderSensor.h
eventIn
| SoSFBool | set_autoOffset |
| SoSFFloat | set_diskAngle |
| SoSFBool | set_enabled |
| SoSFFloat | set_maxAngle |
| SoSFFloat | set_minAngle |
| SoSFFloat | set_offset |
| SoSFString | set_description |
| SoSFNode | set_metadata |
eventOut
| SoSFBool | isActive |
| SoSFBool | isOver |
| SoSFRotation | rotation_changed |
| SoSFVec3f | trackPoint_changed |
| SoSFBool | autoOffset_changed |
| SoSFFloat | diskAngle_changed |
| SoSFBool | enabled_changed |
| SoSFFloat | maxAngle_changed |
| SoSFFloat | minAngle_changed |
| SoSFFloat | offset_changed |
| SoSFString | description_changed |
| SoSFNode | metadata_changed |
Constructor & Destructor Documentation
| SoVRMLCylinderSensor::SoVRMLCylinderSensor | ( | ) |
Constructor.
Member Function Documentation
| static void SoVRMLCylinderSensor::enableEvents | ( | SbBool | OnOffFlag | ) | [static] |
Enables/disables eventIn and eventOut events for all SoVRMLCylinderSensor objects.
If you have created several objects of this class, you can disable/enable these events for all of them with a single call to this method.
| static SoType SoVRMLCylinderSensor::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLNode.
| virtual SoType SoVRMLCylinderSensor::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLNode.
| static SbBool SoVRMLCylinderSensor::isEventsEnabled | ( | ) | [static] |
Queries if eventIn and eventOut 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.
Used to determine the mapping of the dragging motion.
Enables (TRUE) or disables (FALSE) the sensor.
Used to clamp rotation_changed events to a range of values.
Used to clamp rotation_changed events to a range of values.
Amount to add to the rotation event value.
The documentation for this class was generated from the following file: