diff options
Diffstat (limited to 'source/blender/windowmanager/wm_event_types.h')
| -rw-r--r-- | source/blender/windowmanager/wm_event_types.h | 177 |
1 files changed, 105 insertions, 72 deletions
diff --git a/source/blender/windowmanager/wm_event_types.h b/source/blender/windowmanager/wm_event_types.h index 905c57d901a..a6685e97c4f 100644 --- a/source/blender/windowmanager/wm_event_types.h +++ b/source/blender/windowmanager/wm_event_types.h @@ -29,14 +29,19 @@ extern "C" { #endif -/* customdata type */ +/** #wmEvent.customdata type */ enum { EVT_DATA_TIMER = 2, EVT_DATA_DRAGDROP = 3, EVT_DATA_NDOF_MOTION = 4, + EVT_DATA_XR = 5, }; -/* tablet active, matches GHOST_TTabletMode */ +/** + * #wmTabletData.active tablet active, matches #GHOST_TTabletMode. + * + * Typically access via `event->tablet.active`. + */ enum { EVT_TABLET_NONE = 0, EVT_TABLET_STYLUS = 1, @@ -94,10 +99,14 @@ enum { TABLET_STYLUS = 0x001a, TABLET_ERASER = 0x001b, - /* *** Start of keyboard codes. *** */ +/* *** Start of keyboard codes. *** */ + +/* Minimum keyboard value (inclusive). */ +#define _EVT_KEYBOARD_MIN 0x0020 /* Standard keyboard. - * From 0x0020 to 0x00ff, and 0x012c to 0x0143 for function keys! */ + * - 0x0020 to 0x00ff [#_EVT_KEYBOARD_MIN to #_EVT_KEYBOARD_MAX] inclusive - for keys. + * - 0x012c to 0x0143 [#EVT_F1KEY to #EVT_F24KEY] inclusive - for function keys. */ EVT_ZEROKEY = 0x0030, /* '0' (48). */ EVT_ONEKEY = 0x0031, /* '1' (49). */ @@ -209,6 +218,12 @@ enum { EVT_LEFTBRACKETKEY = 0x00eb, /* 235 */ EVT_RIGHTBRACKETKEY = 0x00ec, /* 236 */ +/* Maximum keyboard value (inclusive). */ +#define _EVT_KEYBOARD_MAX 0x00ff /* 255 */ + + /* WARNING: 0x010x are used for internal events + * (but are still stored in the key-map). */ + EVT_F1KEY = 0x012c, /* 300 */ EVT_F2KEY = 0x012d, /* 301 */ EVT_F3KEY = 0x012e, /* 302 */ @@ -236,60 +251,65 @@ enum { /* *** End of keyboard codes. *** */ - /* NDOF (from SpaceNavigator & friends) - * These should be kept in sync with GHOST_NDOFManager.h + /* NDOF (from "Space Navigator" & friends) + * These must be kept in sync with `GHOST_NDOFManager.h`. * Ordering matters, exact values do not. */ + NDOF_MOTION = 0x0190, /* 400 */ + +#define _NDOF_MIN NDOF_MOTION + /* used internally, never sent */ NDOF_BUTTON_NONE = NDOF_MOTION, /* these two are available from any 3Dconnexion device */ - NDOF_BUTTON_MENU, - NDOF_BUTTON_FIT, + + NDOF_BUTTON_MENU = 0x0191, /* 401 */ + NDOF_BUTTON_FIT = 0x0192, /* 402 */ /* standard views */ - NDOF_BUTTON_TOP, - NDOF_BUTTON_BOTTOM, - NDOF_BUTTON_LEFT, - NDOF_BUTTON_RIGHT, - NDOF_BUTTON_FRONT, - NDOF_BUTTON_BACK, + NDOF_BUTTON_TOP = 0x0193, /* 403 */ + NDOF_BUTTON_BOTTOM = 0x0194, /* 404 */ + NDOF_BUTTON_LEFT = 0x0195, /* 405 */ + NDOF_BUTTON_RIGHT = 0x0196, /* 406 */ + NDOF_BUTTON_FRONT = 0x0197, /* 407 */ + NDOF_BUTTON_BACK = 0x0198, /* 408 */ /* more views */ - NDOF_BUTTON_ISO1, - NDOF_BUTTON_ISO2, + NDOF_BUTTON_ISO1 = 0x0199, /* 409 */ + NDOF_BUTTON_ISO2 = 0x019a, /* 410 */ /* 90 degree rotations */ - NDOF_BUTTON_ROLL_CW, - NDOF_BUTTON_ROLL_CCW, - NDOF_BUTTON_SPIN_CW, - NDOF_BUTTON_SPIN_CCW, - NDOF_BUTTON_TILT_CW, - NDOF_BUTTON_TILT_CCW, + NDOF_BUTTON_ROLL_CW = 0x019b, /* 411 */ + NDOF_BUTTON_ROLL_CCW = 0x019c, /* 412 */ + NDOF_BUTTON_SPIN_CW = 0x019d, /* 413 */ + NDOF_BUTTON_SPIN_CCW = 0x019e, /* 414 */ + NDOF_BUTTON_TILT_CW = 0x019f, /* 415 */ + NDOF_BUTTON_TILT_CCW = 0x01a0, /* 416 */ /* device control */ - NDOF_BUTTON_ROTATE, - NDOF_BUTTON_PANZOOM, - NDOF_BUTTON_DOMINANT, - NDOF_BUTTON_PLUS, - NDOF_BUTTON_MINUS, + NDOF_BUTTON_ROTATE = 0x01a1, /* 417 */ + NDOF_BUTTON_PANZOOM = 0x01a2, /* 418 */ + NDOF_BUTTON_DOMINANT = 0x01a3, /* 419 */ + NDOF_BUTTON_PLUS = 0x01a4, /* 420 */ + NDOF_BUTTON_MINUS = 0x01a5, /* 421 */ /* keyboard emulation */ - NDOF_BUTTON_ESC, - NDOF_BUTTON_ALT, - NDOF_BUTTON_SHIFT, - NDOF_BUTTON_CTRL, + NDOF_BUTTON_ESC = 0x01a6, /* 422 */ + NDOF_BUTTON_ALT = 0x01a7, /* 423 */ + NDOF_BUTTON_SHIFT = 0x01a8, /* 424 */ + NDOF_BUTTON_CTRL = 0x01a9, /* 425 */ /* general-purpose buttons */ - NDOF_BUTTON_1, - NDOF_BUTTON_2, - NDOF_BUTTON_3, - NDOF_BUTTON_4, - NDOF_BUTTON_5, - NDOF_BUTTON_6, - NDOF_BUTTON_7, - NDOF_BUTTON_8, - NDOF_BUTTON_9, - NDOF_BUTTON_10, + NDOF_BUTTON_1 = 0x01aa, /* 426 */ + NDOF_BUTTON_2 = 0x01ab, /* 427 */ + NDOF_BUTTON_3 = 0x01ac, /* 428 */ + NDOF_BUTTON_4 = 0x01ad, /* 429 */ + NDOF_BUTTON_5 = 0x01ae, /* 430 */ + NDOF_BUTTON_6 = 0x01af, /* 431 */ + NDOF_BUTTON_7 = 0x01b0, /* 432 */ + NDOF_BUTTON_8 = 0x01b1, /* 433 */ + NDOF_BUTTON_9 = 0x01b2, /* 434 */ + NDOF_BUTTON_10 = 0x01b3, /* 435 */ /* more general-purpose buttons */ - NDOF_BUTTON_A, - NDOF_BUTTON_B, - NDOF_BUTTON_C, - /* the end */ - NDOF_LAST, + NDOF_BUTTON_A = 0x01b4, /* 436 */ + NDOF_BUTTON_B = 0x01b5, /* 437 */ + NDOF_BUTTON_C = 0x01b6, /* 438 */ + +#define _NDOF_MAX NDOF_BUTTON_C /* ********** End of Input devices. ********** */ @@ -317,13 +337,13 @@ enum { EVT_ACTIONZONE_REGION = 0x5001, /* 20481 */ EVT_ACTIONZONE_FULLSCREEN = 0x5011, /* 20497 */ - /* NOTE: these values are saved in keymap files, do not change them but just add new ones */ + /* NOTE: these values are saved in key-map files, do not change them but just add new ones. */ /* Tweak events: * Sent as additional event with the mouse coordinates * from where the initial click was placed. */ - /* tweak events for L M R mousebuttons */ + /* Tweak events for L M R mouse-buttons. */ EVT_TWEAK_L = 0x5002, /* 20482 */ EVT_TWEAK_M = 0x5003, /* 20483 */ EVT_TWEAK_R = 0x5004, /* 20484 */ @@ -341,12 +361,17 @@ enum { /* could become gizmo callback */ EVT_GIZMO_UPDATE = 0x5025, /* 20517 */ + + /* XR events: 0x503x */ + EVT_XR_ACTION = 0x5030, /* 20528 */ /* ********** End of Blender internal events. ********** */ }; -/* *********** wmEvent.type helpers. ********** */ +/* -------------------------------------------------------------------- */ +/** \name #wmEvent.type Helpers + * \{ */ -/* test whether the event is timer event */ +/** Test whether the event is timer event. */ #define ISTIMER(event_type) ((event_type) >= TIMER && (event_type) <= TIMERF) /* for event checks */ @@ -355,22 +380,24 @@ enum { // #define ISTEXTINPUT(event_type) ((event_type) >= ' ' && (event_type) <= 255) /* NOTE: an alternative could be to check `event->utf8_buf`. */ -/* test whether the event is a key on the keyboard */ +/** Test whether the event is a key on the keyboard (including modifier keys). */ #define ISKEYBOARD(event_type) \ - (((event_type) >= 0x0020 && (event_type) <= 0x00ff) || \ - ((event_type) >= 0x012c && (event_type) <= 0x0143)) + (((event_type) >= _EVT_KEYBOARD_MIN && (event_type) <= _EVT_KEYBOARD_MAX) || \ + ((event_type) >= EVT_F1KEY && (event_type) <= EVT_F24KEY)) -/* test whether the event is a modifier key */ +/** Test whether the event is a modifier key. */ #define ISKEYMODIFIER(event_type) \ (((event_type) >= EVT_LEFTCTRLKEY && (event_type) <= EVT_LEFTSHIFTKEY) || \ (event_type) == EVT_OSKEY) -/* test whether the event is a mouse button */ +/** Test whether the event is a mouse button. */ #define ISMOUSE(event_type) \ (((event_type) >= LEFTMOUSE && (event_type) <= BUTTON7MOUSE) || (event_type) == MOUSESMARTZOOM) - +/** Test whether the event is a mouse wheel. */ #define ISMOUSE_WHEEL(event_type) ((event_type) >= WHEELUPMOUSE && (event_type) <= WHEELOUTMOUSE) +/** Test whether the event is a mouse (track-pad) gesture. */ #define ISMOUSE_GESTURE(event_type) ((event_type) >= MOUSEPAN && (event_type) <= MOUSEROTATE) +/** Test whether the event is a mouse button (excluding mouse-wheel). */ #define ISMOUSE_BUTTON(event_type) \ (ELEM(event_type, \ LEFTMOUSE, \ @@ -381,16 +408,16 @@ enum { BUTTON6MOUSE, \ BUTTON7MOUSE)) -/* test whether the event is tweak event */ +/** Test whether the event is tweak event. */ #define ISTWEAK(event_type) ((event_type) >= EVT_TWEAK_L && (event_type) <= EVT_TWEAK_R) -/* test whether the event is a NDOF event */ -#define ISNDOF(event_type) ((event_type) >= NDOF_MOTION && (event_type) < NDOF_LAST) +/** Test whether the event is a NDOF event. */ +#define ISNDOF(event_type) ((event_type) >= _NDOF_MIN && (event_type) <= _NDOF_MAX) #define IS_EVENT_ACTIONZONE(event_type) \ ELEM(event_type, EVT_ACTIONZONE_AREA, EVT_ACTIONZONE_REGION, EVT_ACTIONZONE_FULLSCREEN) -/* test whether event type is acceptable as hotkey, excluding modifiers */ +/** Test whether event type is acceptable as hotkey (excluding modifiers). */ #define ISHOTKEY(event_type) \ ((ISKEYBOARD(event_type) || ISMOUSE(event_type) || ISNDOF(event_type)) && \ (ISKEYMODIFIER(event_type) == false)) @@ -401,27 +428,27 @@ enum { #define _VA_IS_EVENT_MOD4(v, a, b, c) (_VA_IS_EVENT_MOD3(v, a, b) || ((v)->c)) #define _VA_IS_EVENT_MOD5(v, a, b, c, d) (_VA_IS_EVENT_MOD4(v, a, b, c) || ((v)->d)) -/* reusable IS_EVENT_MOD(event, shift, ctrl, alt, oskey), macro */ +/** Reusable `IS_EVENT_MOD(event, shift, ctrl, alt, oskey)` macro. */ #define IS_EVENT_MOD(...) VA_NARGS_CALL_OVERLOAD(_VA_IS_EVENT_MOD, __VA_ARGS__) enum eEventType_Mask { - /* ISKEYMODIFIER */ + /** #ISKEYMODIFIER */ EVT_TYPE_MASK_KEYBOARD_MODIFIER = (1 << 0), - /* ISKEYBOARD */ + /** #ISKEYBOARD */ EVT_TYPE_MASK_KEYBOARD = (1 << 1), - /* ISMOUSE_WHEEL */ + /** #ISMOUSE_WHEEL */ EVT_TYPE_MASK_MOUSE_WHEEL = (1 << 2), - /* ISMOUSE_BUTTON */ + /** #ISMOUSE_BUTTON */ EVT_TYPE_MASK_MOUSE_GESTURE = (1 << 3), - /* ISMOUSE_GESTURE */ + /** #ISMOUSE_GESTURE */ EVT_TYPE_MASK_MOUSE_BUTTON = (1 << 4), - /* ISMOUSE */ + /** #ISMOUSE */ EVT_TYPE_MASK_MOUSE = (1 << 5), - /* ISNDOF */ + /** #ISNDOF */ EVT_TYPE_MASK_NDOF = (1 << 6), - /* ISTWEAK */ + /** #ISTWEAK */ EVT_TYPE_MASK_TWEAK = (1 << 7), - /* IS_EVENT_ACTIONZONE */ + /** #IS_EVENT_ACTIONZONE */ EVT_TYPE_MASK_ACTIONZONE = (1 << 8), }; #define EVT_TYPE_MASK_ALL \ @@ -432,9 +459,13 @@ enum eEventType_Mask { (EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF) #define EVT_TYPE_MASK_HOTKEY_EXCLUDE EVT_TYPE_MASK_KEYBOARD_MODIFIER -bool WM_event_type_mask_test(const int event_type, const enum eEventType_Mask mask); +bool WM_event_type_mask_test(int event_type, enum eEventType_Mask mask); + +/** \} */ -/* ********** wmEvent.val ********** */ +/* -------------------------------------------------------------------- */ +/** \name #wmEvent.val Values + * \{ */ /* Gestures */ /* NOTE: these values are saved in keymap files, do not change them but just add new ones */ @@ -501,6 +532,8 @@ enum { GESTURE_MODAL_FLIP = 14, }; +/** \} */ + #ifdef __cplusplus } #endif |