vrpn_Freespace.h

Go to the documentation of this file.

 
#ifndef VRPN_FREESPACE_H
#define VRPN_FREESPACE_H
 
#include "vrpn_Configure.h"   // IWYU pragma: keep
 
#ifdef VRPN_USE_FREESPACE
 
#include <freespace/freespace.h>
 
#include "vrpn_Button.h"
#include "vrpn_Dial.h"
#include "vrpn_Tracker.h"
 
 
class VRPN_API vrpn_Freespace :
    public vrpn_Tracker_Server,   // for the positional data
    public vrpn_Button_Filter,    // for the actual buttons
    public vrpn_Dial              // for the scroll wheel
{
public:
 
    // Freespace devices may report User frames (position and orientation in a quaternion),
    // Body frames (angular velocity and linear acceleration), Mouse reports (delta X, delta Y)
    // or some combination of them.  You will probably want at least body or user frame
    // messages.
    // Another thing to note is that for some devices, enabling multiple reports diminishes 
    // the effective rate of data since the device can only send so many bits per second.
    // This could fairly easily get added as a configuration setting.
 
    static vrpn_Freespace* create(const char *name, 
                                  vrpn_Connection *conn, 
                                  int device_index = 0,
                                  bool send_body_frames = false,
                                  bool send_user_frames = true);
    virtual ~vrpn_Freespace(void);
    virtual void mainloop(void);
 
private:
    static bool _freespace_initialized;
    static void freespaceInit();
    vrpn_Freespace(FreespaceDeviceId freespaceId,
        struct FreespaceDeviceInfo* deviceInfo,
        const char *name, 
        vrpn_Connection *c);
 
    void handleUserFrame(const struct freespace_UserFrame&);
    void handleBodyFrame(const struct freespace_BodyFrame&);
    void handleLinkStatus(const struct freespace_LinkStatus&);
 
    void deviceSetConfiguration(bool send_body_frames, bool send_user_frames);
    void deviceConfigure();
    void deviceUnconfigure();
 
    bool _sendBodyFrames;
    bool _sendUserFrames;
    struct timeval _timestamp;
 
protected:
    FreespaceDeviceId _freespaceDevice;
    FreespaceDeviceInfo _deviceInfo;
    vrpn_float64 _lastBodyFrameTime;
};
#endif //VRPN_USE_FREESPACE
 
#endif // VRPN_FREESPACE_H