added support for the 3Dconnexion SpaceMouse Pro -- tested on Linux w/ spacenavd...
[blender.git] / intern / ghost / intern / GHOST_NDOFManager.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s):
19  *   Mike Erwin
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23  
24 #ifndef _GHOST_NDOFMANAGER_H_
25 #define _GHOST_NDOFMANAGER_H_
26
27 #include "GHOST_System.h"
28
29
30 // #define DEBUG_NDOF_MOTION
31 // #define DEBUG_NDOF_BUTTONS
32
33 typedef enum {
34         NDOF_UnknownDevice, // <-- motion will work fine, buttons are ignored
35
36         // current devices
37         NDOF_SpaceNavigator,
38         NDOF_SpaceExplorer,
39         NDOF_SpacePilotPro,
40         NDOF_SpaceMousePro,
41
42         // older devices
43         NDOF_SpacePilot
44
45         } NDOF_DeviceT;
46
47 // NDOF device button event types
48 typedef enum {
49         // used internally, never sent
50         NDOF_BUTTON_NONE,
51         // these two are available from any 3Dconnexion device
52         NDOF_BUTTON_MENU,
53         NDOF_BUTTON_FIT,
54         // standard views
55         NDOF_BUTTON_TOP,
56         NDOF_BUTTON_BOTTOM,
57         NDOF_BUTTON_LEFT,
58         NDOF_BUTTON_RIGHT,
59         NDOF_BUTTON_FRONT,
60         NDOF_BUTTON_BACK,
61         // more views
62         NDOF_BUTTON_ISO1,
63         NDOF_BUTTON_ISO2,
64         // 90 degree rotations
65         // these don't all correspond to physical buttons
66         NDOF_BUTTON_ROLL_CW,
67         NDOF_BUTTON_ROLL_CCW,
68         NDOF_BUTTON_SPIN_CW,
69         NDOF_BUTTON_SPIN_CCW,
70         NDOF_BUTTON_TILT_CW,
71         NDOF_BUTTON_TILT_CCW,
72         // device control
73         NDOF_BUTTON_ROTATE,
74         NDOF_BUTTON_PANZOOM,
75         NDOF_BUTTON_DOMINANT,
76         NDOF_BUTTON_PLUS,
77         NDOF_BUTTON_MINUS,
78         // general-purpose buttons
79         // users can assign functions via keymap editor
80         NDOF_BUTTON_1,
81         NDOF_BUTTON_2,
82         NDOF_BUTTON_3,
83         NDOF_BUTTON_4,
84         NDOF_BUTTON_5,
85         NDOF_BUTTON_6,
86         NDOF_BUTTON_7,
87         NDOF_BUTTON_8,
88         NDOF_BUTTON_9,
89         NDOF_BUTTON_10,
90
91         } NDOF_ButtonT;
92
93 class GHOST_NDOFManager
94 {
95 public:
96         GHOST_NDOFManager(GHOST_System&);
97
98         virtual ~GHOST_NDOFManager() {};
99
100         // whether multi-axis functionality is available (via the OS or driver)
101         // does not imply that a device is plugged in or being used
102         virtual bool available() = 0;
103
104         // each platform's device detection should call this
105         // use standard USB/HID identifiers
106         bool setDevice(unsigned short vendor_id, unsigned short product_id);
107
108         // filter out small/accidental/uncalibrated motions by
109         // setting up a "dead zone" around home position
110         // set to 0 to disable
111         // 0.1 is a safe and reasonable value
112         void setDeadZone(float);
113
114         // the latest raw axis data from the device
115         // NOTE: axis data should be in blender view coordinates
116         //       +X is to the right
117         //       +Y is up
118         //       +Z is out of the screen
119         //       for rotations, look from origin to each +axis
120         //       rotations are + when CCW, - when CW
121         // each platform is responsible for getting axis data into this form
122         // these values should not be scaled (just shuffled or flipped)
123         void updateTranslation(short t[3], GHOST_TUns64 time);
124         void updateRotation(short r[3], GHOST_TUns64 time);
125
126         // the latest raw button data from the device
127         // use HID button encoding (not NDOF_ButtonT)
128         void updateButton(int button_number, bool press, GHOST_TUns64 time);
129         void updateButtons(int button_bits, GHOST_TUns64 time);
130         // NDOFButton events are sent immediately
131
132         // processes and sends most recent raw data as an NDOFMotion event
133         // returns whether an event was sent
134         bool sendMotionEvent();
135
136 protected:
137         GHOST_System& m_system;
138
139 private:
140         void sendButtonEvent(NDOF_ButtonT, bool press, GHOST_TUns64 time, GHOST_IWindow*);
141         void sendKeyEvent(GHOST_TKey, bool press, GHOST_TUns64 time, GHOST_IWindow*);
142
143         NDOF_DeviceT m_deviceType;
144         int m_buttonCount;
145         int m_buttonMask;
146
147         short m_translation[3];
148         short m_rotation[3];
149         int m_buttons; // bit field
150
151         GHOST_TUns64 m_motionTime; // in milliseconds
152         GHOST_TUns64 m_prevMotionTime; // time of most recent Motion event sent
153
154         GHOST_TProgress m_motionState;
155         bool m_motionEventPending;
156         float m_deadZone; // discard motion with each component < this
157 };
158
159 #endif