HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UI_DeviceEvent.h
Go to the documentation of this file.
1 #ifndef __UI_DeviceEvent__
2 #define __UI_DeviceEvent__
3 
4 #include "UI_API.h"
5 
6 #include <RE/RE_IDType.h>
7 #include <SYS/SYS_Types.h>
8 #include <UT/UT_Array.h>
9 #include <UT/UT_StringHolder.h>
10 
11 #include "UI_EventType.h"
12 
13 /*
14  * The UI_DeviceEvent is a generic event structure which
15  * various input device drivers will generate as sub-classes
16  * of UI_EventGenerator.
17  */
18 
19 /*
20  * Note: these are flag bits since more than one button can be down:
21  */
22 #define UI_NO_BUTTON 0x0
23 #define UI_LEFT_BUTTON 0x01
24 #define UI_MIDDLE_BUTTON 0x02
25 #define UI_RIGHT_BUTTON 0x04
26 
27 #define UI_ALT_KEY 0x001 //
28 #define UI_SHIFT_KEY 0x002 //
29 #define UI_CTRL_KEY 0x004 //
30 #define UI_COMMAND_KEY 0x008 // Windows key on Win/Linux
31 #define UI_META_KEYS (UI_ALT_KEY| \
32  UI_SHIFT_KEY| \
33  UI_CTRL_KEY| \
34  UI_COMMAND_KEY)
35 #define UI_ALPHASHIFT_KEY 0x010 // Caps-lock
36 #define UI_AUTOREPEAT 0x020 // Auto-repeat is on for the key
37 #define UI_IME_PREEDIT 0x040 // Key is IME pre-edit string
38 #define UI_IME_COMMIT 0x080 // Key is IME commit string
39 #define UI_KEYPAD_KEY 0x100 // The key came from the keypad
40 #define UI_TABLET_MOTION 0x200 // Motion event triggered from tablet.
41 
42 // Conversion from our Z value to 0..1
43 #define UI_PRESSURE_SCALE 16384.0F
44 // Conversion of T/U/V values to degrees.
45 #define UI_ANGLE_SCALE 100.0F
46 
48 {
53 };
54 
59  W = 3,
60  X = 4,
61  Y = 5,
62  Z = 6
63 };
64 
65 #define DIMENSIONS 7
66 
67 
69 {
70 public:
71  UI_DeviceEvent(int event_id = 0);
72 
73  /// Returns an array of Unicode code points corresponding to typed in
74  /// characters from a keyboard event.
75  bool getTypedCharacters(UT_Array<utf32> &cps) const;
76 
78  RE_IDType context; // Device specific context
79  double time; // Time in seconds.
80 
81  exint data; // Event data (at least pointer sized)
82  int values[DIMENSIONS]; // Usually valuator values
83  short altFlags; // Event flags
84  short id; // Event identifier
85 
86  int qt_key;
87  UT_StringHolder key; // Key input for UI_EVENT_KEYBOARD
88 };
89 
90 inline
92 {
93  id = event_id;
94 
96 
97  context = 0;
98  data = 0;
99  altFlags = 0;
100  values[DEVICE_DIM_T] = 0;
101  values[DEVICE_DIM_U] = 0;
102  values[DEVICE_DIM_V] = 0;
103  values[W] = 0;
104  values[X] = 0;
105  values[Y] = 0;
106  values[Z] = 0;
107 
108  time = -1.0;
109  qt_key = 0;
110 }
111 
112 #endif
void * RE_IDType
Definition: RE_IDType.h:20
UI_DeviceEvent(int event_id=0)
UT_StringHolder key
UI_EventType type
UI_ArrowKeys
RE_IDType context
int64 exint
Definition: SYS_Types.h:109
UI_Dimension
UI_EventType
Definition: UI_EventType.h:20
GLenum GLsizei GLsizei GLint * values
Definition: glcorearb.h:1601
GLboolean * data
Definition: glcorearb.h:130
#define UI_API
Definition: UI_API.h:10
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
#define DIMENSIONS