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