d259967daa91638912db5c7444681b1aebcaf195
[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         NDOF_SpaceNavigator,
36         NDOF_SpaceExplorer,
37         NDOF_SpacePilotPro
38         } NDOF_DeviceT;
39
40 // NDOF device button event types
41 typedef enum {
42         // used internally, never sent
43         NDOF_BUTTON_NONE,
44         // these two are available from any 3Dconnexion device
45         NDOF_BUTTON_MENU,
46         NDOF_BUTTON_FIT,
47         // standard views
48         NDOF_BUTTON_TOP,
49         NDOF_BUTTON_BOTTOM,
50         NDOF_BUTTON_LEFT,
51         NDOF_BUTTON_RIGHT,
52         NDOF_BUTTON_FRONT,
53         NDOF_BUTTON_BACK,
54         // more views
55         NDOF_BUTTON_ISO1,
56         NDOF_BUTTON_ISO2,
57         // 90 degree rotations
58         // these don't all correspond to physical buttons
59         NDOF_BUTTON_ROLL_CW,
60         NDOF_BUTTON_ROLL_CCW,
61         NDOF_BUTTON_SPIN_CW,
62         NDOF_BUTTON_SPIN_CCW,
63         NDOF_BUTTON_TILT_CW,
64         NDOF_BUTTON_TILT_CCW,
65         // device control
66         NDOF_BUTTON_ROTATE,
67         NDOF_BUTTON_PANZOOM,
68         NDOF_BUTTON_DOMINANT,
69         NDOF_BUTTON_PLUS,
70         NDOF_BUTTON_MINUS,
71         // general-purpose buttons
72         // TODO: expose these to keymap editor so users can assign functions
73         NDOF_BUTTON_1,
74         NDOF_BUTTON_2,
75         NDOF_BUTTON_3,
76         NDOF_BUTTON_4,
77         NDOF_BUTTON_5,
78         NDOF_BUTTON_6,
79         NDOF_BUTTON_7,
80         NDOF_BUTTON_8,
81         NDOF_BUTTON_9,
82         NDOF_BUTTON_10,
83         } NDOF_ButtonT;
84
85 class GHOST_NDOFManager
86 {
87 public:
88         GHOST_NDOFManager(GHOST_System&);
89
90         virtual ~GHOST_NDOFManager() {};
91
92         // whether multi-axis functionality is available (via the OS or driver)
93         // does not imply that a device is plugged in or being used
94         virtual bool available() = 0;
95
96         // each platform's device detection should call this
97         // use standard USB/HID identifiers
98         bool setDevice(unsigned short vendor_id, unsigned short product_id);
99
100         // filter out small/accidental/uncalibrated motions by
101         // setting up a "dead zone" around home position
102         // set to 0 to disable
103         // 0.1 is a safe and reasonable value
104         void setDeadZone(float);
105
106         // the latest raw axis data from the device
107         // NOTE: axis data should be in blender view coordinates
108         //       +X is to the right
109         //       +Y is up
110         //       +Z is out of the screen
111         //       for rotations, look from origin to each +axis
112         //       rotations are + when CCW, - when CW
113         // each platform is responsible for getting axis data into this form
114         // these values should not be scaled (just shuffled or flipped)
115         void updateTranslation(short t[3], GHOST_TUns64 time);
116         void updateRotation(short r[3], GHOST_TUns64 time);
117
118         // the latest raw button data from the device
119         // use HID button encoding (not NDOF_ButtonT)
120         void updateButton(int button_number, bool press, GHOST_TUns64 time);
121         void updateButtons(int button_bits, GHOST_TUns64 time);
122         // NDOFButton events are sent immediately
123
124         // processes and sends most recent raw data as an NDOFMotion event
125         // returns whether an event was sent
126         bool sendMotionEvent();
127
128 protected:
129         GHOST_System& m_system;
130
131 private:
132         void sendButtonEvent(NDOF_ButtonT, bool press, GHOST_TUns64 time, GHOST_IWindow*);
133         void sendKeyEvent(GHOST_TKey, bool press, GHOST_TUns64 time, GHOST_IWindow*);
134
135         NDOF_DeviceT m_deviceType;
136         int m_buttonCount;
137         int m_buttonMask;
138
139         short m_translation[3];
140         short m_rotation[3];
141         int m_buttons; // bit field
142
143         GHOST_TUns64 m_motionTime; // in milliseconds
144         GHOST_TUns64 m_prevMotionTime; // time of most recent Motion event sent
145
146         GHOST_TProgress m_motionState;
147         bool m_motionEventPending;
148         float m_deadZone; // discard motion with each component < this
149 };
150
151 #endif