HandTrackingClient::WelcomeMessage Class Reference

#include <HandTrackingMessage.h>

Inheritance diagram for HandTrackingClient::WelcomeMessage:

Public Member Functions
	WelcomeMessage (const std::string &serverVersion, const std::string &protocolVersion, const std::vector< OpenCVCamera > &cameras)
	Constructs a WelcomeMessage. Should not generally be called by users of the API.
MessageType	getType () const
const std::string	getServerVersion () const
	Current version of the hand tracking server.
const std::string	getProtocolVersion () const
std::string	serialize () const
	Serializes the message to send over the network. More...
const std::vector< OpenCVCamera > &	getCameras () const

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 HandTrackingMessage *	deserialize (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

A message sent upon connecting to the server, indicating the server and protocol version.

Member Function Documentation

const std::vector<OpenCVCamera>& HandTrackingClient::WelcomeMessage::getCameras ( ) const

inline

Returns the parameters for the cameras that are being used. In most cases, you should expect to see only one camera; two camera support has been deprecated.

const std::string HandTrackingClient::WelcomeMessage::getProtocolVersion ( ) const

inline

Current version of the protocol (should change infrequently), could be used to detect incompatibility.

MessageType HandTrackingClient::WelcomeMessage::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::WelcomeMessage::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:

• HandTrackingMessage.h
• HandTrackingMessage.cpp