The CylinderSensor node maps pointer motion (e.g., a mouse or wand) into a rotation on an invisible cylinder that is aligned with the Y-axis of the local sensor coordinate system. More...
#include <H3D/CylinderSensor.h>
Classes | |
| class | CheckAngleLimits |
| The CheckAngleLimits field checks that the float is in the correct range. More... | |
Public Member Functions | |
| CylinderSensor (Inst< SFBool > _autoOffset=0, Inst< SFString > _description=0, Inst< SFFloat > _diskAngle=0, Inst< SFBool > _enabled=0, Inst< CheckAngleLimits > _maxAngle=0, Inst< SFNode > _metadata=0, Inst< CheckAngleLimits > _minAngle=0, Inst< SFFloat > _offset=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0, Inst< SFRotation > _rotation_changed=0, Inst< SFVec3f > _trackPoint_changed=0, Inst< SFRotation > _axisRotation=0) | |
| Constructor. | |
 Public Member Functions inherited from H3D::X3DDragSensorNode | |
| X3DDragSensorNode (Inst< SFBool > _autoOffset=0, Inst< SFString > _description=0, Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0, Inst< SFVec3f > _trackPoint_changed=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DPointingDeviceSensorNode | |
| X3DPointingDeviceSensorNode (Inst< SFString > _description=0, Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DSensorNode | |
| X3DSensorNode (Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DChildNode | |
| X3DChildNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DNode | |
| X3DNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| X3DMetadataObject * | getMetadataByName (const string &_name) |
| Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More... | |
| Public Member Functions inherited from H3D::Node | |
| Node () | |
| Constructor. | |
| virtual Node * | clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL) |
| Returns a new instance of this node type with the same state as this one. More... | |
| virtual | ~Node () |
| Destructor. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More... | |
| void | setProtoInstanceParent (X3DPrototypeInstance *p) |
| Set the X3DPrototypeInstance this node is the the root node if applicaple. | |
| virtual void | render () |
| the render() function is used for the depth-first rendering traversal of the scene-graph. More... | |
| virtual void | traverseSG (TraverseInfo &ti) |
| traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More... | |
| virtual bool | lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result) |
| Detect intersection between a line segment and the Node. More... | |
| virtual void | closestPoint (const Vec3f &p, NodeIntersectResult &result) |
| Find closest point on Node to p. More... | |
| virtual bool | movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result) |
| Detect collision between a moving sphere and the Node. More... | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual Field * | getField (const string &_name) const |
| return a pointer to the field specified by name within this instance | |
| int | addDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| int | removeDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
Public Attributes | |
| H3DUniquePtr< SFFloat > | diskAngle |
| Used when determining whether the sides of the invisible cylinder or the caps (disks) are used for manipulation. More... | |
| H3DUniquePtr< CheckAngleLimits > | maxAngle |
| Used to clamp rotation values. More... | |
| H3DUniquePtr< CheckAngleLimits > | minAngle |
| Used to clamp rotation values. More... | |
| H3DUniquePtr< SFFloat > | offset |
| When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation angle. More... | |
| H3DUniquePtr< SFRotation > | rotation_changed |
| For each position of the bearing when isActive is true, a rotation_changed event is sent which corresponds to the sum of the relative rotation from the original intersection point plus the offset value. More... | |
| H3DUniquePtr< SFRotation > | axisRotation |
| The local sensor coordinate system is created by applying the axisRotation field value to the local coordinate system. More... | |
| Public Attributes inherited from H3D::X3DDragSensorNode | |
| H3DUniquePtr< SFBool > | autoOffset |
| If autoOffset is TRUE when the pointing-device is deactivated, the offset field is set to the sensor's last _changed value and offset sends an offset_changed output event. More... | |
| H3DUniquePtr< SFVec3f > | trackPoint_changed |
| The trackPoint_changed outputOnly field sends the intersection point of the bearing with the drag sensor's virtual geometry. More... | |
| Public Attributes inherited from H3D::X3DPointingDeviceSensorNode | |
| H3DUniquePtr< SFString > | description |
| The description field in a X3DPointingDeviceSensorNode node specifies a textual description of the X3DPointingDeviceSensorNode node. More... | |
| H3DUniquePtr< SFBool > | isOver |
| The isOver field reflects the state of the pointing device with regard to whether it is pointing towards the X3DPointingDeviceSensorNode node's geometry or not. More... | |
| Public Attributes inherited from H3D::X3DSensorNode | |
| H3DUniquePtr< SFBool > | enabled |
| If enabled is true the sensor node is enabled otherwise it is disabled and will not generate any output. More... | |
| H3DUniquePtr< SFBool > | isActive |
| A sensor is active when some special conditions are fulfilled and it will then generate extra output. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DDragSensorNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DPointingDeviceSensorNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DSensorNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
Additional Inherited Members | |
| Public Types inherited from H3D::Node | |
| typedef std::map< Node *, Node * > | DeepCopyMap |
| A map type used during a deep copy clone() to map from original nodes to cloned nodes. | |
| Static Public Member Functions inherited from H3D::X3DPointingDeviceSensorNode | |
| static void | updateX3DPointingDeviceSensors (Node *n, const Vec3f &from, const Vec3f &to) |
| Called to detect and set properties of X3DPointingDeviceSensors. More... | |
| static void | updateButtonDependentFields (bool primary_button) |
| Update fields that depends on the status of the primary pointing device button. More... | |
| static bool | anyIsOver () |
| Called to query, whether any X3DPointingDeviceSensors is in isOver state. | |
| static bool | anyIsActive () |
| Called to query, whether any X3DPointingDeviceSensors is in isActive state. | |
| static bool | instancesExists () |
| Returns true if there are any X3DPointingDeviceSensors in the scene. | |
| Static Public Member Functions inherited from H3D::Node | |
| static unsigned int | nrNodesAlive () |
| Returns the nr of nodes currently alive, i.e. nodes created but not destructed. | |
| static int | nrNodesCreated () |
| Returns the number of nodes created in total since the start of the program. | |
| Protected Member Functions inherited from H3D::X3DPointingDeviceSensorNode | |
| void | setIsEnabled (bool primary_button) |
| Handles the enabled logic. | |
| void | setIsActive (bool primary_button) |
| Handles the isActive logic. | |
| Protected Member Functions inherited from H3D::Node | |
| void | cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for the clone() method. More... | |
| Static Protected Member Functions inherited from H3D::Node | |
| static Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
| Protected Attributes inherited from H3D::X3DPointingDeviceSensorNode | |
| H3DUniquePtr< SetIsEnabled > | setIsEnabledField |
| Used to call setIsEnabled function when the enabled field is changed. | |
Detailed Description
The CylinderSensor node maps pointer motion (e.g., a mouse or wand) into a rotation on an invisible cylinder that is aligned with the Y-axis of the local sensor coordinate system.
The local sensor coordinate system is created by applying the axisRotation field value to the local coordinate system. The CylinderSensor uses the descendent geometry of its parent node to determine whether it is liable to generate events.
The description field in the CylinderSensor node specifies a textual description of the CylinderSensor node. This may be used by browser-specific user interfaces that wish to present users with more detailed information about the CylinderSensor.
The enabled field enables and disables the CylinderSensor node. If TRUE, the sensor reacts appropriately to user events. If FALSE, the sensor does not track user input or send 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.
A CylinderSensor node generates events when the pointing device is activated while the pointer is indicating any descendent geometry nodes of the sensor's parent group. Activating and manipulating pointing device sensors, for more details on using the pointing device to activate the CylinderSensor.
Upon activation of the pointing device while indicating the sensor's geometry, an isActive TRUE event is sent. The initial acute angle between the bearing vector and the local sensor coordinate system Y-axis of the CylinderSensor node determines whether the sides of the invisible cylinder or the caps (disks) are used for manipulation. If the initial angle is less than the diskAngle, the geometry is treated as an infinitely large disk lying in Y=0 plane of the local sensor coordinate system and coincident with the initial intersection point. Dragging motion is mapped into a rotation around the +Y-axis vector of the local sensor coordinate system. The perpendicular vector from the initial intersection point to the Y-axis defines zero rotation about the Y-axis of the local sensor coordinate system. For each subsequent position of the bearing, a rotation_changed event is sent that equals the sum of the rotation about the +Y-axis vector of the local sensor coordinate system (from the initial intersection to the new intersection) 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 value of rotation_changed and an offset_changed event is generated.
If the initial acute angle between the bearing vector and the local sensor coordinate system Y-axis of the CylinderSensor node is greater than or equal to diskAngle, then the sensor behaves like a cylinder. 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 marks the zero rotation value. For each subsequent position of the bearing, a rotation_changed event is sent that equals the sum of the right-handed rotation from the original intersection about the +Y-axis vector plus the offset value. trackPoint_changed events reflect the unclamped drag position on the surface of the invisible 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.
When the sensor generates an isActive TRUE event, it grabs all further motion events from the pointing device until it is released and generates an isActive FALSE event (other pointing-device sensors shall not generate events during this time). Motion of the pointing device while isActive is TRUE is referred to as a "drag" operation. 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 it is released). If a 3D pointing device (e.g., a 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 behaviour) and if the pointing device is dragged off the cylinder while activated, browsers may interpret this in a variety of ways (e.g., clamp all values to the cylinder and continuing to rotate as the point is dragged away from the cylinder). Each movement of the pointing device while isActive is TRUE generates trackPoint_changed and rotation_changed events.
The minAngle and maxAngle fields clamp rotation_changed events to a range of values. If minAngle is greater than maxAngle, rotation_changed events are not clamped. The minAngle and maxAngle fields are restricted to the range [-2pi, 2pi].
Examples:
- Internal routes:
Member Data Documentation
◆ axisRotation
| H3DUniquePtr< SFRotation > H3D::CylinderSensor::axisRotation |
The local sensor coordinate system is created by applying the axisRotation field value to the local coordinate system.
Access type: inputOutput
Default value: 0 0 1 0
Referenced by CylinderSensor().
◆ diskAngle
| H3DUniquePtr< SFFloat > H3D::CylinderSensor::diskAngle |
Used when determining whether the sides of the invisible cylinder or the caps (disks) are used for manipulation.
Access type: inputOutput
Default value: pi/12
Valid range: [0-pi/2]
Referenced by CylinderSensor().
◆ maxAngle
| H3DUniquePtr< CheckAngleLimits > H3D::CylinderSensor::maxAngle |
Used to clamp rotation values.
If maxAngle > minAngle no clamping is done.
Access type: inputOutput
Valid range: [-2pi-2pi]
Default value: -1
Referenced by CylinderSensor().
◆ minAngle
| H3DUniquePtr< CheckAngleLimits > H3D::CylinderSensor::minAngle |
Used to clamp rotation values.
If minAngle < maxAngle no clamping is done.
Access type: inputOutput
Valid range: [-2pi-2pi]
Default value: 0
Referenced by CylinderSensor().
◆ offset
| H3DUniquePtr< SFFloat > H3D::CylinderSensor::offset |
When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation angle.
Access type: inputOutput
Default value: 0
Referenced by CylinderSensor().
◆ rotation_changed
| H3DUniquePtr< SFRotation > H3D::CylinderSensor::rotation_changed |
For each position of the bearing when isActive is true, a rotation_changed event is sent which corresponds to the sum of the relative rotation from the original intersection point plus the offset value.
Access type: outputOnly
The documentation for this class was generated from the following files:
