This repository has been archived by the owner on Jan 18, 2024. It is now read-only.
forked from rpbpolis/spic-prj-api
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Input.hpp
374 lines (351 loc) · 10.9 KB
/
Input.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
#ifndef INPUT_H_
#define INPUT_H_
#include "Point.hpp"
#include "IKeyListener.hpp"
#include "IMouseListener.hpp"
#include <string>
#if __has_include("Input_includes.hpp")
#include "Input_includes.hpp"
#endif
namespace spic {
/**
* @brief Some convenient input functions.
* @spicapi
*/
namespace Input {
/**
* @brief An enumeration describing the different keyboard keycodes.
*
* These keycodes are taken from the usb.org HID specification.
* See: https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf page 53
*
* Incidentally, SDL also adheres to these values, which means you can cast the scancode
* from SDL to one of these values.
* @spicapi
*/
enum class KeyCode {
ERROR_ROLLOVER = 0x01,
POST_FAIL = 0x02,
ERROR_UNDEFINED = 0x03,
A = 0x04,
B = 0x05,
C = 0x06,
D = 0x07,
E = 0x08,
F = 0x09,
G = 0x0A,
H = 0x0B,
I = 0x0C,
J = 0x0D,
K = 0x0E,
L = 0x0F,
M = 0x10,
N = 0x11,
O = 0x12,
P = 0x13,
Q = 0x14,
R = 0x15,
S = 0x16,
T = 0x17,
U = 0x18,
V = 0x19,
W = 0x1A,
X = 0x1B,
Y = 0x1C,
Z = 0x1D,
NUMBER_1_AND_EXCLAMATION = 0x1E,
NUMBER_2_AND_AT = 0x1F,
NUMBER_3_AND_HASHMARK = 0x20,
NUMBER_4_AND_DOLLAR = 0x21,
NUMBER_5_AND_PERCENTAGE = 0x22,
NUMBER_6_AND_CARET = 0x23,
NUMBER_7_AND_AMPERSAND = 0x24,
NUMBER_8_AND_ASTERISK = 0x25,
NUMBER_9_AND_OPENING_PARENTHESIS = 0x26,
NUMBER_0_AND_CLOSING_PARENTHESIS = 0x27,
ENTER = 0x28,
ESCAPE = 0x29,
BACKSPACE = 0x2A,
TAB = 0x2B,
SPACE = 0x2C,
MINUS_AND_UNDERSCORE = 0x2D,
EQUAL_AND_PLUS = 0x2E,
OPENING_BRACKET_AND_OPENING_BRACE = 0x2F,
CLOSING_BRACKET_AND_CLOSING_BRACE = 0x30,
BACKSLASH_AND_PIPE = 0x31,
NON_US_HASHMARK_AND_TILDE = 0x32,
SEMICOLON_AND_COLON = 0x33,
APOSTROPHE_AND_QUOTE = 0x34,
GRAVE_ACCENT_AND_TILDE = 0x35,
COMMA_AND_LESS_THAN_SIGN = 0x36,
DOT_AND_GREATER_THAN_SIGN = 0x37,
SLASH_AND_QUESTION_MARK = 0x38,
CAPS_LOCK = 0x39,
F1 = 0x3A,
F2 = 0x3B,
F3 = 0x3C,
F4 = 0x3D,
F5 = 0x3E,
F6 = 0x3F,
F7 = 0x40,
F8 = 0x41,
F9 = 0x42,
F10 = 0x43,
F11 = 0x44,
F12 = 0x45,
PRINT_SCREEN = 0x46,
SCROLL_LOCK = 0x47,
PAUSE = 0x48,
INSERT = 0x49,
HOME = 0x4A,
PAGE_UP = 0x4B,
DELETE = 0x4C,
END = 0x4D,
PAGE_DOWN = 0x4E,
RIGHT_ARROW = 0x4F,
LEFT_ARROW = 0x50,
DOWN_ARROW = 0x51,
UP_ARROW = 0x52,
NUM_LOCK = 0x53,
KEYPAD_SLASH = 0x54,
KEYPAD_ASTERISK = 0x55,
KEYPAD_MINUS = 0x56,
KEYPAD_PLUS = 0x57,
KEYPAD_ENTER = 0x58,
KEYPAD_1_AND_END = 0x59,
KEYPAD_2_AND_DOWN_ARROW = 0x5A,
KEYPAD_3_AND_PAGE_DOWN = 0x5B,
KEYPAD_4_AND_LEFT_ARROW = 0x5C,
KEYPAD_5 = 0x5D,
KEYPAD_6_AND_RIGHT_ARROW = 0x5E,
KEYPAD_7_AND_HOME = 0x5F,
KEYPAD_8_AND_UP_ARROW = 0x60,
KEYPAD_9_AND_PAGE_UP = 0x61,
KEYPAD_0_AND_INSERT = 0x62,
KEYPAD_DOT_AND_DELETE = 0x63,
NON_US_BACKSLASH_AND_PIPE = 0x64,
APPLICATION = 0x65,
POWER = 0x66,
KEYPAD_EQUAL_SIGN = 0x67,
F13 = 0x68,
F14 = 0x69,
F15 = 0x6A,
F16 = 0x6B,
F17 = 0x6C,
F18 = 0x6D,
F19 = 0x6E,
F20 = 0x6F,
F21 = 0x70,
F22 = 0x71,
F23 = 0x72,
F24 = 0x73,
EXECUTE = 0x74,
HELP = 0x75,
MENU = 0x76,
SELECT = 0x77,
STOP = 0x78,
AGAIN = 0x79,
UNDO = 0x7A,
CUT = 0x7B,
COPY = 0x7C,
PASTE = 0x7D,
FIND = 0x7E,
MUTE = 0x7F,
VOLUME_UP = 0x80,
VOLUME_DOWN = 0x81,
LOCKING_CAPS_LOCK = 0x82,
LOCKING_NUM_LOCK = 0x83,
LOCKING_SCROLL_LOCK = 0x84,
KEYPAD_COMMA = 0x85,
KEYPAD_EQUAL_SIGN_AS400 = 0x86,
INTERNATIONAL1 = 0x87,
INTERNATIONAL2 = 0x88,
INTERNATIONAL3 = 0x89,
INTERNATIONAL4 = 0x8A,
INTERNATIONAL5 = 0x8B,
INTERNATIONAL6 = 0x8C,
INTERNATIONAL7 = 0x8D,
INTERNATIONAL8 = 0x8E,
INTERNATIONAL9 = 0x8F,
LANG1 = 0x90,
LANG2 = 0x91,
LANG3 = 0x92,
LANG4 = 0x93,
LANG5 = 0x94,
LANG6 = 0x95,
LANG7 = 0x96,
LANG8 = 0x97,
LANG9 = 0x98,
ALTERNATE_ERASE = 0x99,
SYSREQ = 0x9A,
CANCEL = 0x9B,
CLEAR = 0x9C,
PRIOR = 0x9D,
RETURN = 0x9E,
SEPARATOR = 0x9F,
OUT = 0xA0,
OPER = 0xA1,
CLEAR_AND_AGAIN = 0xA2,
CRSEL_AND_PROPS = 0xA3,
EXSEL = 0xA4,
KEYPAD_00 = 0xB0,
KEYPAD_000 = 0xB1,
THOUSANDS_SEPARATOR = 0xB2,
DECIMAL_SEPARATOR = 0xB3,
CURRENCY_UNIT = 0xB4,
CURRENCY_SUB_UNIT = 0xB5,
KEYPAD_OPENING_PARENTHESIS = 0xB6,
KEYPAD_CLOSING_PARENTHESIS = 0xB7,
KEYPAD_OPENING_BRACE = 0xB8,
KEYPAD_CLOSING_BRACE = 0xB9,
KEYPAD_TAB = 0xBA,
KEYPAD_BACKSPACE = 0xBB,
KEYPAD_A = 0xBC,
KEYPAD_B = 0xBD,
KEYPAD_C = 0xBE,
KEYPAD_D = 0xBF,
KEYPAD_E = 0xC0,
KEYPAD_F = 0xC1,
KEYPAD_XOR = 0xC2,
KEYPAD_CARET = 0xC3,
KEYPAD_PERCENTAGE = 0xC4,
KEYPAD_LESS_THAN_SIGN = 0xC5,
KEYPAD_GREATER_THAN_SIGN = 0xC6,
KEYPAD_AMP = 0xC7,
KEYPAD_AMP_AMP = 0xC8,
KEYPAD_PIPE = 0xC9,
KEYPAD_PIPE_PIPE = 0xCA,
KEYPAD_COLON = 0xCB,
KEYPAD_HASHMARK = 0xCC,
KEYPAD_SPACE = 0xCD,
KEYPAD_AT = 0xCE,
KEYPAD_EXCLAMATION_SIGN = 0xCF,
KEYPAD_MEMORY_STORE = 0xD0,
KEYPAD_MEMORY_RECALL = 0xD1,
KEYPAD_MEMORY_CLEAR = 0xD2,
KEYPAD_MEMORY_ADD = 0xD3,
KEYPAD_MEMORY_SUBTRACT = 0xD4,
KEYPAD_MEMORY_MULTIPLY = 0xD5,
KEYPAD_MEMORY_DIVIDE = 0xD6,
KEYPAD_PLUS_AND_MINUS = 0xD7,
KEYPAD_CLEAR = 0xD8,
KEYPAD_CLEAR_ENTRY = 0xD9,
KEYPAD_BINARY = 0xDA,
KEYPAD_OCTAL = 0xDB,
KEYPAD_DECIMAL = 0xDC,
KEYPAD_HEXADECIMAL = 0xDD,
LEFT_CONTROL = 0xE0,
LEFT_SHIFT = 0xE1,
LEFT_ALT = 0xE2,
LEFT_GUI = 0xE3,
RIGHT_CONTROL = 0xE4,
RIGHT_SHIFT = 0xE5,
RIGHT_ALT = 0xE6,
RIGHT_GUI = 0xE7,
MEDIA_PLAY = 0xE8,
MEDIA_STOP = 0xE9,
MEDIA_PREVIOUS_TRACK = 0xEA,
MEDIA_NEXT_TRACK = 0xEB,
MEDIA_EJECT = 0xEC,
MEDIA_VOLUME_UP = 0xED,
MEDIA_VOLUME_DOWN = 0xEE,
MEDIA_MUTE = 0xEF,
MEDIA_WWW = 0xF0,
MEDIA_BACKWARD = 0xF1,
MEDIA_FORWARD = 0xF2,
MEDIA_CANCEL = 0xF3,
MEDIA_SEARCH = 0xF4,
MEDIA_SLEEP = 0xF8,
MEDIA_LOCK = 0xF9,
MEDIA_RELOAD = 0xFA,
MEDIA_CALCULATOR = 0xFB
};
/**
* @brief Enumeration for different mouse buttons.
* @spicapi
*/
enum class MouseButton {
LEFT = 1,
MIDDLE = 2,
RIGHT = 3
};
/**
* @brief Is any key or mouse button currently held down? (Read Only)
* @spicapi
*/
bool AnyKey();
/**
* @brief Returns true the first frame the user hits any key or mouse button. (Read Only)
* @spicapi
*/
bool AnyKeyDown();
/**
* @brief The current mouse position in pixel coordinates. (Read Only)
* @spicapi
*/
const Point MousePosition();
/**
* @brief Returns the value of the virtual axis identified by axisName.
* @spicapi
*/
double GetAxis();
/**
* @brief Returns true while the user holds down the key identified by keycode.
* @spicapi
*/
bool GetKey(KeyCode key);
/**
* @brief Returns true during the frame the user starts pressing down the key identified by keycode.
* @spicapi
*/
bool GetKeyDown(KeyCode key);
/**
* @brief Returns true during the frame the user releases the key identified by keycode.
* @spicapi
*/
bool GetKeyUp(KeyCode key);
/**
* @brief Returns whether the given mouse button is held down.
* @spicapi
*/
bool GetMouseButton(MouseButton which);
/**
* @brief Returns true during the frame the user pressed the given mouse button.
* @spicapi
*/
bool GetMouseButtonDown(MouseButton which);
/**
* @brief Returns true during the frame the user releases the given mouse button.
* @spicapi
*/
bool GetMouseButtonUp(MouseButton which);
/**
* Register a new key listener
* @param listener A reference to a key listener
* @sharedapi
*/
void RegisterKeyListener(IKeyListener& listener);
/**
* Unregister a key listener
* @param listener A reference to a key listener
* @sharedapi
*/
void UnregisterKeyListener(IKeyListener& listener);
/**
* Register a new mouse listener
* @param listener A reference to a mouse listener
* @sharedapi
*/
void RegisterMouseListener(IMouseListener& listener);
/**
* Unregister a mouse listener
* @param listener A reference to a mouse listener
* @sharedapi
*/
void UnregisterMouseListener(IMouseListener& listener);
#if __has_include("Input_public.hpp")
#include "Input_public.hpp"
#endif
}
}
#endif // INPUT_H_