H3D API  2.4.1
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
H3D::VirtualHandGloveSensor Class Referenceabstract

This is the base class for all sensors that handles connection to the vhtGlove class in Virtual Hand SDK. More...

#include <H3D/VirtualHandGloveSensor.h>

Inheritance diagram for H3D::VirtualHandGloveSensor:
Inheritance graph

Public Member Functions

 VirtualHandGloveSensor (Inst< OnEnable > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0, Inst< SFString > _host=0, Inst< SFString > _port=0)
 Constructor.
 
 ~VirtualHandGloveSensor ()
 Destructor.
 
virtual void initialize ()
 Connect to the device if enabled is true on first reference of the node. More...
 
vhtGlove * getGlove ()
 Return reference to the contained vhtGlove.
 
void resetGlove ()
 Reset glove to 0, needed in cleanup phase to not accidently try to delete instance of vhtGlove twice.
 
- 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.
 
X3DMetadataObjectgetMetadataByName (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 Nodeclone (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.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 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 FieldgetField (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< SFStringhost
 Adress of the host running the VTIDM daemon process. More...
 
H3DUniquePtr< SFStringport
 The port number specified in the the Device Manager of Virtual Hand SDK. More...
 
- Public Attributes inherited from H3D::X3DSensorNode
H3DUniquePtr< SFBoolenabled
 If enabled is true the sensor node is enabled otherwise it is disabled and will not generate any output. More...
 
H3DUniquePtr< SFBoolisActive
 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< SFNodemetadata
 Meta data about the node. More...
 

Static Public Attributes

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.
 

Protected Member Functions

virtual void updateValues ()=0
 Virtual function used to update field values in subclasses.
 
virtual bool connect ()=0
 Virtual function that connects the vhtGlove.
 
virtual void disconnect ()=0
 Virtual function that disconnects the vhtGlove.
 
- 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...
 

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::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.
 
- Static Protected Member Functions inherited from H3D::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

This is the base class for all sensors that handles connection to the vhtGlove class in Virtual Hand SDK.

Member Function Documentation

◆ initialize()

void VirtualHandGloveSensor::initialize ( )
virtual

Connect to the device if enabled is true on first reference of the node.

Used in order to not accidently connect before the user has' decided the value of enabled.

Reimplemented from H3DUtil::RefCountedClass.

References connect(), H3D::X3DSensorNode::enabled, H3DUtil::RefCountedClass::initialize(), and H3D::X3DSensorNode::isActive.

Member Data Documentation

◆ host

H3DUniquePtr< SFString> H3D::VirtualHandGloveSensor::host

Adress of the host running the VTIDM daemon process.

Host should be a resolvable internet name or address. Only used when the sensor is enabled.

Access type: inputOutput
Default Value: "localhost"

Referenced by VirtualHandGloveSensor().

◆ port

H3DUniquePtr< SFString> H3D::VirtualHandGloveSensor::port

The port number specified in the the Device Manager of Virtual Hand SDK.

Only used when the sensor is enabled.

Access type: inputOutput
Default Value: "12345"

Referenced by VirtualHandGloveSensor().


The documentation for this class was generated from the following files: