3Gear Systems SDK  v0.9.34
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Public Member Functions | List of all members
HandTrackingClient::PointMessage Class Reference

#include <HandTrackingMessage.h>

Inheritance diagram for HandTrackingClient::PointMessage:
HandTrackingClient::HandTrackingMessage

Public Member Functions

 PointMessage (const Hand hand, const Vector3f &pointStart, const Vector3f &pointEnd, const float confidence)
 Constructs a PointMessage. Should not generally be called by users of the API.
 
const Hand getHand () const
 
std::string serialize () const
 Serializes the message to send over the network. More...
 
virtual MessageType getType () const
 
Vector3f getPointStart () const
 This is our estimate of the start of the index finger at the first knuckle.
 
Vector3f getPointEnd () const
 This is our estimate of the end (tip) of the index finger.
 
Vector3f getPointDir () const
 This is the direction of the index finger.
 
float getConfidence () const
 This is the confidence (between 0 and 1) that the user is actually pointing at something.
 

Additional Inherited Members

- Public Types inherited from HandTrackingClient::HandTrackingMessage
enum  MessageType {
  WELCOME = 0, USER = 100, CALIBRATION = 101, POSE = 200,
  PRESSED = 300, DRAGGED = 301, RELEASED = 302, MOVED = 303,
  SIMULTANEOUSLY_PRESSED = 400, INDIVIDUALLY_PRESSED = 401, SIMULTANEOUSLY_RELEASED = 402, INDIVIDUALLY_RELEASED = 403,
  DRAGGED_BIMANUAL = 404, POINT = 500, INVALID_DATA = 10000
}
 
- Static Public Member Functions inherited from HandTrackingClient::HandTrackingMessage
static const char * messageTypeToString (MessageType m)
 Convert from a MessageType to its string representation; used for serialization.
 
static MessageType stringToMessageType (const std::string &str)
 Convert from a string to a MessageType; used in deserialization.
 
static HandTrackingMessagedeserialize (const std::string &data)
 Given a line of text sent over the network connection, converts it to a valid hand message. More...
 
- Protected Member Functions inherited from HandTrackingClient::HandTrackingMessage
 HandTrackingMessage ()
 

Detailed Description

Messages relating to pointing

Member Function Documentation

const Hand HandTrackingClient::PointMessage::getHand ( ) const
inline
Returns
which hand this message applies to (can only LEFT or RIGHT, never BOTH).
virtual MessageType HandTrackingClient::PointMessage::getType ( ) const
inlinevirtual

Returns the message type (e.g. PRESSED or DRAGGED). The message type is useful for distinguishing between similar messages, e.g., between PRESSED and RELEASED, which are both PinchMessages.

Implements HandTrackingClient::HandTrackingMessage.

std::string HandTrackingClient::PointMessage::serialize ( ) const
virtual

Serializes the message to send over the network.

Developers should not need to worry about this function unless they write their own networking code.

Implements HandTrackingClient::HandTrackingMessage.


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