A TouchSensor node tracks the location and state of the pointing device and detects when the user points at geometry contained by the TouchSensor node's parent group. More...
#include <H3D/TouchSensor.h>
Inheritance diagram for H3D::TouchSensor:
Public Member Functions | |
| TouchSensor (Inst< SFString > _description=0, Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFVec3f > _hitNormal_changed=0, Inst< SFVec3f > _hitPoint_changed=0, Inst< SFVec2f > _hitTexCoord_changed=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0, Inst< SFTime > _touchTime=0, Inst< SFString > _hitObject_changed=0) | |
| Constructor. | |
 Public Member Functions inherited from H3D::X3DTouchSensorNode | |
| X3DTouchSensorNode (Inst< SFString > _description=0, Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0, Inst< SFTime > _touchTime=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< SFVec3f > | hitNormal_changed |
| hitNormal_changed events contain the surface normal vector at the hitPoint. More... | |
| H3DUniquePtr< SFVec3f > | hitPoint_changed |
| hitPoint_changed events contain the 3D point on the surface of the underlying geometry, given in the TouchSensor node's coordinate system. More... | |
| H3DUniquePtr< SFVec2f > | hitTexCoord_changed |
| hitTexCoord_changed events contain the texture coordinates of that surface at the hitPoint. More... | |
| H3DUniquePtr< SFString > | hitObject_changed |
| hitObject_changed events contain the name of the object at the hitPoint. More... | |
| Public Attributes inherited from H3D::X3DTouchSensorNode | |
| H3DUniquePtr< SFTime > | touchTime |
| The field touchTime is generated when all three of the following conditions are true: 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::X3DTouchSensorNode | |
| 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::X3DTouchSensorNode | |
| H3DUniquePtr< SetTouchTime > | setTouchTime |
| instance of specialized field used to set the touchTime field. | |
| Protected Attributes inherited from H3D::X3DPointingDeviceSensorNode | |
| H3DUniquePtr< SetIsEnabled > | setIsEnabledField |
| Used to call setIsEnabled function when the enabled field is changed. | |
Detailed Description
A TouchSensor node tracks the location and state of the pointing device and detects when the user points at geometry contained by the TouchSensor node's parent group.
As the user moves the bearing over the TouchSensor node's geometry, the point of intersection (if any) between the bearing and the geometry is determined. Each movement of the pointing device, while isOver is TRUE, generates hitPoint_changed, hitNormal_changed and hitTexCoord_changed events. hitPoint_changed events contain the 3D point on the surface of the underlying geometry, given in the TouchSensor node's coordinate system. hitNormal_changed events contain the surface normal vector at the hitPoint. hitTexCoord_changed events contain the texture coordinates of that surface at the hitPoint. The values of hitTexCoord_changed and hitNormal_changed events are computed as appropriate for the associated shape.
Examples:
- TouchSensor.x3d ( Source )
- TouchSensor1.x3d ( Source )
- TouchSensor2.x3d ( Source )
Member Data Documentation
◆ hitNormal_changed
| H3DUniquePtr< SFVec3f > H3D::TouchSensor::hitNormal_changed |
hitNormal_changed events contain the surface normal vector at the hitPoint.
( Given in TouchSensors local coordinates )
Access type: outputOnly
◆ hitObject_changed
| H3DUniquePtr< SFString > H3D::TouchSensor::hitObject_changed |
hitObject_changed events contain the name of the object at the hitPoint.
Access type: outputOnly
◆ hitPoint_changed
| H3DUniquePtr< SFVec3f > H3D::TouchSensor::hitPoint_changed |
hitPoint_changed events contain the 3D point on the surface of the underlying geometry, given in the TouchSensor node's coordinate system.
Access type: outputOnly
◆ hitTexCoord_changed
| H3DUniquePtr< SFVec2f > H3D::TouchSensor::hitTexCoord_changed |
hitTexCoord_changed events contain the texture coordinates of that surface at the hitPoint.
Access type: outputOnly
The documentation for this class was generated from the following files:
