The PlaneSensor node maps pointing device motion into two-dimensional translation in a plane parallel to the Z=0 plane of the local sensor coordinate system. More...
#include <H3D/PlaneSensor.h>
Classes | |
| class | SFOffset |
| Class used to store some information about axisRotation when offset is set, in order to set the correct offset value when mouse is clicked. More... | |
Public Member Functions | |
| PlaneSensor (Inst< SFBool > _autoOffset=0, Inst< SFString > _description=0, Inst< SFBool > _enabled=0, Inst< SFVec2f > _maxPosition=0, Inst< SFNode > _metadata=0, Inst< SFVec2f > _minPosition=0, Inst< SFOffset > _offset=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0, Inst< SFVec3f > _trackPoint_changed=0, Inst< SFVec3f > _translation_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< SFVec2f > | maxPosition |
| maxPosition can be used to clamp translation_changed events. More... | |
| H3DUniquePtr< SFVec2f > | minPosition |
| minPosition can be used to clamp translation_changed events More... | |
| H3DUniquePtr< SFOffset > | offset |
| Stores the last translation_changed value at deactivation if autoOffset is true. More... | |
| H3DUniquePtr< SFVec3f > | translation_changed |
| For each subsequent movement of the bearing, a translation_changed event is output which corresponds to the sum of the relative translation from the original intersection point to the intersection point of the new bearing in the plane 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 PlaneSensor node maps pointing device motion into two-dimensional translation in a plane parallel to the Z=0 plane 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 PlaneSensor node uses the descendent geometry of its parent node to determine whether it is liable to generate events.
The description field in the PlaneSensor node specifies a textual description of the PlaneSensor node. This may be used by browser-specific user interfaces that wish to present users with more detailed information about the PlaneSensor.
The enabled field enables and disables the PlaneSensor. If enabled is TRUE, the sensor reacts appropriately to user events. If enabled is 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 made ready for user activation.
The PlaneSensor node generates events when the pointing device is activated while the pointer is indicating any descendent geometry nodes of the sensor's parent group.
Upon activation of the pointing device (e.g., mouse button down) while indicating the sensor's geometry, an isActive TRUE event is sent. Pointer motion is mapped into relative translation in the tracking plane, (a plane parallel to the sensor's local sensor coordinate system Z=0 plane and coincident with the initial point of intersection). For each subsequent movement of the bearing, a translation_changed event is output which corresponds to the sum of the relative translation from the original intersection point to the intersection point of the new bearing in the plane plus the offset value. The sign of the translation is defined by the Z=0 plane of the local sensor 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_changed value and an offset_changed event is generated.
minPosition and maxPosition may be set to clamp translation_changed events to a range of values as measured from the origin of the Z=0 plane of the local sensor coordinate system. 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 and moved, trackPoint_changed and translation_changed events are sent. trackPoint_changed events represent the unclamped intersection points on the surface of the tracking plane. If the pointing device is dragged off of the tracking plane while activated (e.g., above horizon line), browsers may interpret this in a variety ways (e.g., clamp all values to the horizon. H3DAPI resend the last event and write an error message ). Each movement of the pointing device, while isActive is TRUE, generates trackPoint_changed and translation_changed events.
Examples:
- Internal routes:
Member Data Documentation
◆ axisRotation
| H3DUniquePtr< SFRotation > H3D::PlaneSensor::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 PlaneSensor().
◆ maxPosition
| H3DUniquePtr< SFVec2f > H3D::PlaneSensor::maxPosition |
maxPosition can be used to clamp translation_changed events.
Access type: inputOutput
Default value: -1 -1
Referenced by PlaneSensor().
◆ minPosition
| H3DUniquePtr< SFVec2f > H3D::PlaneSensor::minPosition |
minPosition can be used to clamp translation_changed events
Access type: inputOutput
Default value: 0 0
Referenced by PlaneSensor().
◆ offset
| H3DUniquePtr< SFOffset > H3D::PlaneSensor::offset |
Stores the last translation_changed value at deactivation if autoOffset is true.
Access type: inputOutput
Default value: 0 0 0
Referenced by PlaneSensor().
◆ translation_changed
| H3DUniquePtr< SFVec3f > H3D::PlaneSensor::translation_changed |
For each subsequent movement of the bearing, a translation_changed event is output which corresponds to the sum of the relative translation from the original intersection point to the intersection point of the new bearing in the plane plus the offset value.
Access type: outputOnly
The documentation for this class was generated from the following files:
