vrpn_Contour.h

#pragma once
 
#include <stddef.h> // for size_t
 
#include "vrpn_Analog.h" // for vrpn_Analog
#include "vrpn_BaseClass.h" // for vrpn_BaseClass
#include "vrpn_Button.h" // for vrpn_Button_Filter
#include "vrpn_Configure.h" // for VRPN_CALLBACK, VRPN_USE_HID
#include "vrpn_Connection.h" // for vrpn_CONNECTION_LOW_LATENCY, etc
#include "vrpn_Dial.h" // for vrpn_Dial
#include "vrpn_HumanInterface.h" // for vrpn_HidAcceptor (ptr only), etc
#include "vrpn_Shared.h" // for timeval
#include "vrpn_Types.h" // for vrpn_uint8, vrpn_uint32
 
#if defined(VRPN_USE_HID)
 
// Device drivers for the Contour Design USB line of products
// Currently supported: ShuttleXpress
//
// Exposes three major VRPN device classes: Button, Analog, Dial (as appropriate).
// All models expose Buttons for the keys on the device.
//
 
class vrpn_Contour: public vrpn_BaseClass, protected vrpn_HidInterface {
public:
  vrpn_Contour(vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c = 0,
      vrpn_uint16 vendor = 0, vrpn_uint16 product = 0);
 virtual ~vrpn_Contour(void);
 
 virtual void mainloop(void) = 0;
 
protected:
 // Set up message handlers, etc.
 void init_hid(void);
 void on_data_received(size_t bytes, vrpn_uint8 *buffer);
 
 static int VRPN_CALLBACK on_connect(void *thisPtr, vrpn_HANDLERPARAM p);
 static int VRPN_CALLBACK on_last_disconnect(void *thisPtr, vrpn_HANDLERPARAM p);
 
 virtual void decodePacket(size_t bytes, vrpn_uint8 *buffer) = 0;  
 struct timeval _timestamp;
 vrpn_HidAcceptor *_filter;
 
 // No actual types to register, derived classes will be buttons, analogs, and/or dials
 int register_types(void) { return 0; }
 
 // Have we gotten a dial response yet?  If not, we store the value
 // rather than reporting it.
 bool _gotDial;
 
 // Previous dial value, used to determine delta to send when it changes.
  vrpn_uint8 _lastDial;
};
 
class vrpn_Contour_ShuttleXpress: protected vrpn_Contour, public vrpn_Analog, public vrpn_Button_Filter, public vrpn_Dial {
public:
  vrpn_Contour_ShuttleXpress(const char *name, vrpn_Connection *c = 0);
 virtual ~vrpn_Contour_ShuttleXpress(void) {};
 
 virtual void mainloop(void);
 
protected:
 // Send report iff changed
 void report_changes (vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
 // Send report whether or not changed
 void report (vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
 
 void decodePacket(size_t bytes, vrpn_uint8 *buffer);
};
 
class vrpn_Contour_ShuttlePROv2 : protected vrpn_Contour, public vrpn_Analog, public vrpn_Button_Filter, public vrpn_Dial {
public:
    vrpn_Contour_ShuttlePROv2(const char *name, vrpn_Connection *c = 0);
 virtual ~vrpn_Contour_ShuttlePROv2(void) {};
 
 virtual void mainloop(void);
 
protected:
 // Send report iff changed
 void report_changes(vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
 // Send report whether or not changed
 void report(vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
 
 void decodePacket(size_t bytes, vrpn_uint8 *buffer);
 
 // Previous dial value, used to determine delta to send when it changes.
    vrpn_uint8 _lastDial;
};
 
// end of VRPN_USE_HID
#else
class VRPN_API vrpn_Contour;
class VRPN_API vrpn_Contour_ShuttleXpress;
class VRPN_API vrpn_Contour_ShuttlePROv2;
#endif