vrpn  07.33
Virtual Reality Peripheral Network
vrpn_Griffin.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 Griffin Technology USB line of products
18 // Currently supported: PowerMate Controller
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 // Button 0 is the programming switch; it is set if the switch is in the "red" position.
23 //
24 
25 class vrpn_Griffin: public vrpn_BaseClass, protected vrpn_HidInterface {
26 public:
27  vrpn_Griffin(vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c = 0);
28  virtual ~vrpn_Griffin(void);
29 
30  virtual void mainloop(void) = 0;
31 
32 protected:
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 
49 public:
50  vrpn_Griffin_PowerMate(const char *name, vrpn_Connection *c = 0);
51  virtual ~vrpn_Griffin_PowerMate(void) {};
52 
53  virtual void mainloop(void);
54 
55 protected:
56  // Send report iff changed
57  void report_changes (vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
58  // Send report whether or not changed
59  void report (vrpn_uint32 class_of_service = vrpn_CONNECTION_LOW_LATENCY);
60 
61  void decodePacket(size_t bytes, vrpn_uint8 *buffer);
62 
63  // Previous dial value, used to determine delta to send when it changes.
64  vrpn_uint8 _lastDial;
65 };
66 
67 // end of VRPN_USE_HID
68 #else
71 #endif
vrpn_Griffin::~vrpn_Griffin
virtual ~vrpn_Griffin(void)
Definition: vrpn_Griffin.C:47
vrpn_Dial::report
virtual void report(void)
Definition: vrpn_Dial.C:82
vrpn_Griffin_PowerMate::mainloop
virtual void mainloop(void)
Called once through each main loop iteration to handle updates. Remote object mainloop() should call ...
Definition: vrpn_Griffin.C:93
vrpn_BaseClass.h
vrpn_Griffin::on_connect
static int VRPN_CALLBACK on_connect(void *thisPtr, vrpn_HANDLERPARAM p)
Definition: vrpn_Griffin.C:69
vrpn_Button_Filter::report_changes
virtual void report_changes(void)
Definition: vrpn_Button.C:382
vrpn_Dial.h
vrpn_Types.h
vrpn_HidInterface
Definition: vrpn_HumanInterface.h:68
vrpn_Griffin_PowerMate::_lastDial
vrpn_uint8 _lastDial
Definition: vrpn_Griffin.h:64
vrpn_Griffin::vrpn_Griffin
vrpn_Griffin(vrpn_HidAcceptor *filter, const char *name, vrpn_Connection *c=0)
Definition: vrpn_Griffin.C:39
vrpn_Analog
Definition: vrpn_Analog.h:28
vrpn_Griffin_PowerMate
Definition: vrpn_Griffin.h:48
vrpn_Griffin_PowerMate::vrpn_Griffin_PowerMate
vrpn_Griffin_PowerMate(const char *name, vrpn_Connection *c=0)
Definition: vrpn_Griffin.C:75
vrpn_Griffin::on_last_disconnect
static int VRPN_CALLBACK on_last_disconnect(void *thisPtr, vrpn_HANDLERPARAM p)
Definition: vrpn_Griffin.C:63
vrpn_HidAcceptor
Definition: vrpn_HumanInterface.h:54
vrpn_Griffin_PowerMate::decodePacket
void decodePacket(size_t bytes, vrpn_uint8 *buffer)
Definition: vrpn_Griffin.C:174
vrpn_CONNECTION_LOW_LATENCY
const vrpn_uint32 vrpn_CONNECTION_LOW_LATENCY
Definition: vrpn_Connection.h:122
vrpn_Dial
Definition: vrpn_Dial.h:21
vrpn_HANDLERPARAM
This structure is what is passed to a vrpn_Connection message callback.
Definition: vrpn_Connection.h:44
vrpn_Shared.h
vrpn_Griffin::_filter
vrpn_HidAcceptor * _filter
Definition: vrpn_Griffin.h:42
vrpn_Griffin::on_data_received
void on_data_received(size_t bytes, vrpn_uint8 *buffer)
Derived class reimplements this callback.
Definition: vrpn_Griffin.C:58
vrpn_Griffin::mainloop
virtual void mainloop(void)=0
Called once through each main loop iteration to handle updates. Remote object mainloop() should call ...
vrpn_Button.h
vrpn_Griffin::_timestamp
struct timeval _timestamp
Definition: vrpn_Griffin.h:41
vrpn_Griffin::decodePacket
virtual void decodePacket(size_t bytes, vrpn_uint8 *buffer)=0
vrpn_HumanInterface.h
vrpn_Connection
Generic connection class not specific to the transport mechanism.
Definition: vrpn_Connection.h:510
vrpn_Griffin::init_hid
void init_hid(void)
Definition: vrpn_Griffin.C:52
vrpn_Connection.h
vrpn_Analog.h
VRPN_CALLBACK
#define VRPN_CALLBACK
Definition: vrpn_Configure.h:647
vrpn_Griffin
Definition: vrpn_Griffin.h:25
vrpn_Griffin_PowerMate::~vrpn_Griffin_PowerMate
virtual ~vrpn_Griffin_PowerMate(void)
Definition: vrpn_Griffin.h:51
vrpn_Griffin::register_types
int register_types(void)
Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
Definition: vrpn_Griffin.h:45
vrpn_Configure.h
VRPN_API
#define VRPN_API
Definition: vrpn_Configure.h:646
vrpn_BaseClass
Class from which all user-level (and other) classes that communicate with vrpn_Connections should der...
Definition: vrpn_BaseClass.h:313
vrpn_Button_Filter
All button servers should derive from this class, which provides the ability to turn any of the butto...
Definition: vrpn_Button.h:65