vrpn 07.35
Virtual Reality Peripheral Network
 
Loading...
Searching...
No Matches
vrpn_Contour.h
Go to the documentation of this file.
1#pragma once
2
3#include <stddef.h> // for size_t
4
5#include "vrpn_Analog.h" // for vrpn_Analog
6#include "vrpn_BaseClass.h" // for vrpn_BaseClass
7#include "vrpn_Button.h" // for vrpn_Button_Filter
8#include "vrpn_Configure.h" // for VRPN_CALLBACK, VRPN_USE_HID
9#include "vrpn_Connection.h" // for vrpn_CONNECTION_LOW_LATENCY, etc
10#include "vrpn_Dial.h" // for vrpn_Dial
11#include "vrpn_HumanInterface.h" // for vrpn_HidAcceptor (ptr only), etc
12#include "vrpn_Shared.h" // for timeval
13#include "vrpn_Types.h" // for vrpn_uint8, vrpn_uint32
14
15#if defined(VRPN_USE_HID)
16
17// Device drivers for the Contour Design USB line of products
18// Currently supported: ShuttleXpress
19//
20// Exposes three major VRPN device classes: Button, Analog, Dial (as appropriate).
21// All models expose Buttons for the keys on the device.
22//
23
25public:
26 vrpn_Contour(vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c = 0,
27 vrpn_uint16 vendor = 0, vrpn_uint16 product = 0);
28 virtual ~vrpn_Contour(void);
29
30 virtual void mainloop(void) = 0;
31
32protected:
33 // Set up message handlers, etc.
34 void init_hid(void);
35 void on_data_received(size_t bytes, vrpn_uint8 *buffer);
36
37 static int VRPN_CALLBACK on_connect(void *thisPtr, vrpn_HANDLERPARAM p);
38 static int VRPN_CALLBACK on_last_disconnect(void *thisPtr, vrpn_HANDLERPARAM p);
39
40 virtual void decodePacket(size_t bytes, vrpn_uint8 *buffer) = 0;
41 struct timeval _timestamp;
43
44 // No actual types to register, derived classes will be buttons, analogs, and/or dials
45 int register_types(void) { return 0; }
46
47 // Have we gotten a dial response yet? If not, we store the value
48 // rather than reporting it.
50
51 // Previous dial value, used to determine delta to send when it changes.
52 vrpn_uint8 _lastDial;
53};
54
56public:
57 vrpn_Contour_ShuttleXpress(const char *name, vrpn_Connection *c = 0);
59
60 virtual void mainloop(void);
61
62protected:
63 // Send report iff changed
64 void report_changes (vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
65 // Send report whether or not changed
66 void report (vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
67
68 void decodePacket(size_t bytes, vrpn_uint8 *buffer);
69};
70
72public:
73 vrpn_Contour_ShuttlePROv2(const char *name, vrpn_Connection *c = 0);
75
76 virtual void mainloop(void);
77
78protected:
79 // Send report iff changed
80 void report_changes(vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
81 // Send report whether or not changed
82 void report(vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
83
84 void decodePacket(size_t bytes, vrpn_uint8 *buffer);
85
86 // Previous dial value, used to determine delta to send when it changes.
87 vrpn_uint8 _lastDial;
88};
89
90// end of VRPN_USE_HID
91#else
95#endif
vrpn_Analog(const char *name, vrpn_Connection *c=NULL)
Definition vrpn_Analog.C:14
vrpn_BaseClass(const char *name, vrpn_Connection *c=NULL)
Names the device and assigns or opens connection, calls registration methods.
virtual void report_changes(void)
vrpn_Button_Filter(const char *, vrpn_Connection *c=NULL)
Generic connection class not specific to the transport mechanism.
virtual void mainloop(void)
Called once through each main loop iteration to handle updates. Remote object mainloop() should call ...
virtual ~vrpn_Contour_ShuttlePROv2(void)
vrpn_Contour_ShuttlePROv2(const char *name, vrpn_Connection *c=0)
void decodePacket(size_t bytes, vrpn_uint8 *buffer)
vrpn_Contour_ShuttleXpress(const char *name, vrpn_Connection *c=0)
void decodePacket(size_t bytes, vrpn_uint8 *buffer)
virtual ~vrpn_Contour_ShuttleXpress(void)
virtual void mainloop(void)
Called once through each main loop iteration to handle updates. Remote object mainloop() should call ...
virtual void decodePacket(size_t bytes, vrpn_uint8 *buffer)=0
virtual ~vrpn_Contour(void)
void on_data_received(size_t bytes, vrpn_uint8 *buffer)
Derived class reimplements this callback.
static int VRPN_CALLBACK on_last_disconnect(void *thisPtr, vrpn_HANDLERPARAM p)
static int VRPN_CALLBACK on_connect(void *thisPtr, vrpn_HANDLERPARAM p)
vrpn_uint8 _lastDial
int register_types(void)
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
vrpn_Contour(vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c=0, vrpn_uint16 vendor=0, vrpn_uint16 product=0)
struct timeval _timestamp
virtual void mainloop(void)=0
Called once through each main loop iteration to handle updates. Remote object mainloop() should call ...
vrpn_HidAcceptor * _filter
void init_hid(void)
virtual void report(void)
Definition vrpn_Dial.C:82
vrpn_Dial(const char *name, vrpn_Connection *c=NULL)
Definition vrpn_Dial.C:8
vrpn_uint16 product() const
Returns USB product ID of connected device May not contain valid if an already-open device was provid...
vrpn_HidInterface(vrpn_HidAcceptor *acceptor, vrpn_uint16 vendor=0, vrpn_uint16 product=0, hid_device *device=NULL)
Constructor If we already have a HID device from some other source, it can be passed and we'll take o...
vrpn_uint16 vendor() const
Returns USB vendor ID of connected device May not contain valid if an already-open device was provide...
This structure is what is passed to a vrpn_Connection message callback.
All types of client/server/peer objects in VRPN should be derived from the vrpn_BaseClass type descri...
#define VRPN_API
#define VRPN_CALLBACK
const vrpn_uint32 vrpn_CONNECTION_LOW_LATENCY