Blender V5.3
wm_keymap_utils.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#include <cstring>
12
13#include "DNA_space_types.h"
15
16#include "BLI_listbase.hh"
17#include "BLI_utildefines.hh"
18
19#include "BKE_context.hh"
20
21#include "RNA_access.hh"
22
23#include "WM_api.hh"
24#include "WM_keymap.hh"
25#include "WM_types.hh"
26
27namespace blender {
28
29/* Menu wrapper for #WM_keymap_add_item. */
30
31/* -------------------------------------------------------------------- */
34
36 const char *idname,
37 const KeyMapItem_Params *params)
38{
39 wmKeyMapItem *kmi = WM_keymap_add_item(keymap, "WM_OT_call_menu", params);
40 RNA_string_set(kmi->ptr, "name", idname);
41 return kmi;
42}
43
45 const char *idname,
46 const KeyMapItem_Params *params)
47{
48 wmKeyMapItem *kmi = WM_keymap_add_item(keymap, "WM_OT_call_menu_pie", params);
49 RNA_string_set(kmi->ptr, "name", idname);
50 return kmi;
51}
52
54 const char *idname,
55 const KeyMapItem_Params *params)
56{
57 wmKeyMapItem *kmi = WM_keymap_add_item(keymap, "WM_OT_call_panel", params);
58 RNA_string_set(kmi->ptr, "name", idname);
59 /* TODO: we might want to disable this. */
60 RNA_boolean_set(kmi->ptr, "keep_open", false);
61 return kmi;
62}
63
65 const char *idname,
66 const KeyMapItem_Params *params)
67{
68 wmKeyMapItem *kmi = WM_keymap_add_item(keymap, "WM_OT_tool_set_by_id", params);
69 RNA_string_set(kmi->ptr, "name", idname);
70 return kmi;
71}
72
74
75/* -------------------------------------------------------------------- */
78
80{
81 eSpace_Type space_type = SPACE_EMPTY;
82 eRegion_Type region_type = RGN_TYPE_WINDOW;
84
85 /* Tool property tab is a special case where 3d tool properties are shown in the properties
86 * editor. This would allow assigning tool shortcut keys from properties editor. */
87 bool allow_properties_keymap = false;
88 if (sl->spacetype == SPACE_PROPERTIES) {
89 SpaceProperties *sp = reinterpret_cast<SpaceProperties *>(sl);
90 if (sp->mainb == BCONTEXT_TOOL) {
91 allow_properties_keymap = true;
92 }
93 }
94
95 const char *km_id = nullptr;
96 if (sl->spacetype == SPACE_VIEW3D || allow_properties_keymap) {
97 const enum eContextObjectMode mode = CTX_data_mode_enum(C);
98 switch (mode) {
100 km_id = "Mesh";
101 break;
103 km_id = "Curve";
104 break;
106 km_id = "Curves";
107 break;
109 km_id = "Curve";
110 break;
112 km_id = "Font";
113 break;
115 km_id = "Armature";
116 break;
118 km_id = "Metaball";
119 break;
121 km_id = "Lattice";
122 break;
124 km_id = "Grease Pencil Edit Mode";
125 break;
127 km_id = "Point Cloud";
128 break;
129 case CTX_MODE_POSE:
130 km_id = "Pose";
131 break;
132 case CTX_MODE_SCULPT:
133 km_id = "Sculpt";
134 break;
136 km_id = "Weight Paint";
137 break;
139 km_id = "Vertex Paint";
140 break;
142 km_id = "Image Paint";
143 break;
145 km_id = "Particle";
146 break;
147 case CTX_MODE_OBJECT:
148 km_id = "Object Mode";
149 break;
151 km_id = "Grease Pencil Stroke Paint Mode";
152 break;
154 km_id = "Grease Pencil Stroke Edit Mode";
155 break;
157 km_id = "Grease Pencil Stroke Sculpt Mode";
158 break;
160 km_id = "Grease Pencil Stroke Weight Mode";
161 break;
163 km_id = "Grease Pencil Stroke Vertex Mode";
164 break;
166 km_id = "Sculpt Curves";
167 break;
169 km_id = "Grease Pencil Draw Mode";
170 break;
172 km_id = "Grease Pencil Sculpt Mode";
173 break;
175 km_id = "Grease Pencil Weight Mode";
176 break;
178 km_id = "Grease Pencil Vertex Mode";
179 break;
180 }
181 }
182 else if (sl->spacetype == SPACE_IMAGE) {
183 const SpaceImage *sima = reinterpret_cast<SpaceImage *>(sl);
184 const eSpaceImage_Mode mode = eSpaceImage_Mode(sima->mode);
185 switch (mode) {
186 case SI_MODE_VIEW:
187 km_id = "Image";
188 break;
189 case SI_MODE_PAINT:
190 km_id = "Image Paint";
191 break;
192 case SI_MODE_MASK:
193 km_id = "Mask Editing";
194 break;
195 case SI_MODE_UV:
196 km_id = "UV Editor";
197 break;
198 }
199 }
200 else if (sl->spacetype == SPACE_SEQ) {
201 const SpaceSeq *sseq = reinterpret_cast<SpaceSeq *>(sl);
202 const enum eSpaceSeq_Displays view = eSpaceSeq_Displays(sseq->view);
203 space_type = SPACE_SEQ;
204 switch (view) {
206 km_id = "Sequencer";
207 break;
208 case SEQ_VIEW_PREVIEW:
209 km_id = "Preview";
210 break;
212 km_id = "Video Sequence Editor";
213 break;
214 }
215 }
216 else {
217 return nullptr;
218 }
219
220 wmKeyMap *km = WM_keymap_find_all(CTX_wm_manager(C), km_id, space_type, region_type);
221 BLI_assert(km);
222 return km;
223}
224
225wmKeyMap *WM_keymap_guess_opname(const bContext *C, const char *opname)
226{
227 /* Op types purposely skipped for now:
228 * BOID_OT
229 * BUTTONS_OT
230 * CONSTRAINT_OT
231 * ED_OT
232 * FLUID_OT
233 * TEXTURE_OT
234 * WORLD_OT
235 */
236
237 wmKeyMap *km = nullptr;
240
241 /* Window. */
242 if (STRPREFIX(opname, "WM_OT") || STRPREFIX(opname, "ED_OT_undo")) {
243 if (STREQ(opname, "WM_OT_tool_set_by_id") || STREQ(opname, "WM_OT_call_asset_shelf_popover")) {
245 }
246
247 if (km == nullptr) {
249 }
250 }
251 /* Screen & Render. */
252 else if (STRPREFIX(opname, "SCREEN_OT") || STRPREFIX(opname, "RENDER_OT") ||
253 STRPREFIX(opname, "SOUND_OT") || STRPREFIX(opname, "SCENE_OT"))
254 {
256 }
257 /* Grease Pencil. */
258 else if (STRPREFIX(opname, "GPENCIL_OT")) {
259 km = WM_keymap_find_all(wm, "Grease Pencil", SPACE_EMPTY, RGN_TYPE_WINDOW);
260 }
261 else if (STRPREFIX(opname, "GREASE_PENCIL_OT")) {
262 km = WM_keymap_find_all(wm, "Grease Pencil", SPACE_EMPTY, RGN_TYPE_WINDOW);
263 }
264 /* Markers. */
265 else if (STRPREFIX(opname, "MARKER_OT")) {
267 }
268 /* Import/Export. */
269 else if (STRPREFIX(opname, "IMPORT_") || STRPREFIX(opname, "EXPORT_")) {
271 }
272
273 /* 3D View. */
274 else if (STRPREFIX(opname, "VIEW3D_OT")) {
275 km = WM_keymap_find_all(wm, "3D View", sl->spacetype, RGN_TYPE_WINDOW);
276 }
277 else if (STRPREFIX(opname, "OBJECT_OT")) {
278 /* Exception, this needs to work outside object mode too. */
279 if (STRPREFIX(opname, "OBJECT_OT_mode_set") || STRPREFIX(opname, "OBJECT_OT_transfer_mode")) {
280 km = WM_keymap_find_all(wm, "Object Non-modal", SPACE_EMPTY, RGN_TYPE_WINDOW);
281 }
282 else {
284 }
285
286 if (km == nullptr) {
287 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
288 }
289 }
290 /* Object mode related. */
291 else if (STRPREFIX(opname, "GROUP_OT") || STRPREFIX(opname, "MATERIAL_OT") ||
292 STRPREFIX(opname, "PTCACHE_OT") || STRPREFIX(opname, "RIGIDBODY_OT"))
293 {
294 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
295 }
296
297 /* Editing Modes. */
298 else if (STRPREFIX(opname, "MESH_OT")) {
300
301 /* Some mesh operators are active in object mode too, like add-prim. */
302 if (km && !WM_keymap_poll(const_cast<bContext *>(C), km)) {
303 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
304 }
305 }
306 else if (STRPREFIX(opname, "CURVE_OT") || STRPREFIX(opname, "SURFACE_OT")) {
308
309 /* Some curve operators are active in object mode too, like add-prim. */
310 if (km && !WM_keymap_poll(const_cast<bContext *>(C), km)) {
311 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
312 }
313 }
314 else if (STRPREFIX(opname, "ARMATURE_OT") || STRPREFIX(opname, "SKETCH_OT")) {
316 }
317 else if (STRPREFIX(opname, "POSE_OT") || STRPREFIX(opname, "POSELIB_OT")) {
318 switch (CTX_data_mode_enum(C)) {
319 case CTX_MODE_OBJECT:
320 /* Some POSE operators are now working in object mode. See #159734. */
321 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
322 break;
323 default:
325 break;
326 }
327 }
328 else if (STRPREFIX(opname, "SCULPT_OT")) {
329 switch (CTX_data_mode_enum(C)) {
330 case CTX_MODE_SCULPT:
332 break;
333 default:
334 break;
335 }
336 }
337 else if (STRPREFIX(opname, "CURVES_OT")) {
339 }
340 else if (STRPREFIX(opname, "SCULPT_CURVES_OT")) {
341 km = WM_keymap_find_all(wm, "Sculpt Curves", SPACE_EMPTY, RGN_TYPE_WINDOW);
342 }
343 else if (STRPREFIX(opname, "MBALL_OT")) {
345
346 /* Some meta-ball operators are active in object mode too, like add-primitive. */
347 if (km && !WM_keymap_poll(const_cast<bContext *>(C), km)) {
348 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
349 }
350 }
351 else if (STRPREFIX(opname, "LATTICE_OT")) {
353 }
354 else if (STRPREFIX(opname, "PARTICLE_OT")) {
356 }
357 else if (STRPREFIX(opname, "POINTCLOUD_OT")) {
358 km = WM_keymap_find_all(wm, "Point Cloud", SPACE_EMPTY, RGN_TYPE_WINDOW);
359 }
360 else if (STRPREFIX(opname, "FONT_OT")) {
362 }
363 /* Paint Face Mask. */
364 else if (STRPREFIX(opname, "PAINT_OT_face_select")) {
366 wm, "Paint Face Mask (Weight, Vertex, Texture)", SPACE_EMPTY, RGN_TYPE_WINDOW);
367 }
368 else if (STRPREFIX(opname, "PAINT_OT") || STRPREFIX(opname, "BRUSH_OT")) {
369 /* Check for relevant mode. */
371 }
372 /* General 2D View, not bound to a specific spacetype. */
373 else if (STRPREFIX(opname, "VIEW2D_OT")) {
375 }
376 /* Image Editor. */
377 else if (STRPREFIX(opname, "IMAGE_OT")) {
378 km = WM_keymap_find_all(wm, "Image", sl->spacetype, RGN_TYPE_WINDOW);
379 }
380 /* Clip Editor. */
381 else if (STRPREFIX(opname, "CLIP_OT")) {
383 }
384 else if (STRPREFIX(opname, "MASK_OT")) {
385 km = WM_keymap_find_all(wm, "Mask Editing", SPACE_EMPTY, RGN_TYPE_WINDOW);
386 }
387 /* UV Editor. */
388 else if (STRPREFIX(opname, "UV_OT")) {
389 /* Hack to allow using UV unwrapping ops from 3DView/editmode.
390 * Mesh keymap is probably not ideal, but best place I could find to put those. */
391 if (sl->spacetype == SPACE_VIEW3D) {
393 if (km && !WM_keymap_poll(const_cast<bContext *>(C), km)) {
394 km = nullptr;
395 }
396 }
397 if (!km) {
399 }
400 }
401 /* Node Editor. */
402 else if (STRPREFIX(opname, "NODE_OT")) {
403 km = WM_keymap_find_all(wm, "Node Editor", sl->spacetype, RGN_TYPE_WINDOW);
404 }
405 /* Animation Editor Channels. */
406 else if (STRPREFIX(opname, "ANIM_OT_channels")) {
407 km = WM_keymap_find_all(wm, "Animation Channels", SPACE_EMPTY, RGN_TYPE_WINDOW);
408 }
409 /* Animation Generic - after channels. */
410 else if (STRPREFIX(opname, "ANIM_OT")) {
411 if (sl->spacetype == SPACE_VIEW3D) {
412 switch (CTX_data_mode_enum(C)) {
413 case CTX_MODE_OBJECT:
414 km = WM_keymap_find_all(wm, "Object Mode", SPACE_EMPTY, RGN_TYPE_WINDOW);
415 break;
416 case CTX_MODE_POSE:
418 break;
419 default:
420 break;
421 }
422
423 if (ARegion *region = CTX_wm_region(C)) {
424 /* When property is in side panel, add shortcut key to User interface Keymap, see: #136998.
425 */
426 if (region->regiontype == RGN_TYPE_UI) {
427 km = WM_keymap_find_all(wm, "User Interface", SPACE_EMPTY, RGN_TYPE_WINDOW);
428 }
429 }
430 if (km && !WM_keymap_poll(const_cast<bContext *>(C), km)) {
431 km = nullptr;
432 }
433 }
434 else if (sl->spacetype == SPACE_PROPERTIES) {
435 km = WM_keymap_find_all(wm, "User Interface", SPACE_EMPTY, RGN_TYPE_WINDOW);
436 }
437
438 if (!km) {
440 }
441 }
442 /* Graph Editor. */
443 else if (STRPREFIX(opname, "GRAPH_OT")) {
444 km = WM_keymap_find_all(wm, "Graph Editor", sl->spacetype, RGN_TYPE_WINDOW);
445 }
446 /* Dopesheet Editor. */
447 else if (STRPREFIX(opname, "ACTION_OT")) {
448 km = WM_keymap_find_all(wm, "Dopesheet", sl->spacetype, RGN_TYPE_WINDOW);
449 }
450 /* NLA Editor. */
451 else if (STRPREFIX(opname, "NLA_OT")) {
452 km = WM_keymap_find_all(wm, "NLA Editor", sl->spacetype, RGN_TYPE_WINDOW);
453 }
454 /* Script. */
455 else if (STRPREFIX(opname, "SCRIPT_OT")) {
456 km = WM_keymap_find_all(wm, "Script", sl->spacetype, RGN_TYPE_WINDOW);
457 }
458 /* Text. */
459 else if (STRPREFIX(opname, "TEXT_OT")) {
461 }
462 /* Sequencer. */
463 else if (STRPREFIX(opname, "SEQUENCER_OT")) {
464 km = WM_keymap_find_all(wm, "Sequencer", sl->spacetype, RGN_TYPE_WINDOW);
465 }
466 /* Console. */
467 else if (STRPREFIX(opname, "CONSOLE_OT")) {
468 km = WM_keymap_find_all(wm, "Console", sl->spacetype, RGN_TYPE_WINDOW);
469 }
470 /* Console. */
471 else if (STRPREFIX(opname, "INFO_OT")) {
473 }
474 /* File browser. */
475 else if (STRPREFIX(opname, "FILE_OT")) {
476 km = WM_keymap_find_all(wm, "File Browser", sl->spacetype, RGN_TYPE_WINDOW);
477 }
478 /* Logic Editor. */
479 else if (STRPREFIX(opname, "LOGIC_OT")) {
480 km = WM_keymap_find_all(wm, "Logic Editor", sl->spacetype, RGN_TYPE_WINDOW);
481 }
482 /* Outliner. */
483 else if (STRPREFIX(opname, "OUTLINER_OT")) {
484 km = WM_keymap_find_all(wm, "Outliner", sl->spacetype, RGN_TYPE_WINDOW);
485 }
486 /* Transform. */
487 else if (STRPREFIX(opname, "TRANSFORM_OT")) {
488 /* Check for relevant editor. */
489 switch (sl->spacetype) {
490 case SPACE_VIEW3D:
491 km = WM_keymap_find_all(wm, "3D View", sl->spacetype, RGN_TYPE_WINDOW);
492 break;
493 case SPACE_GRAPH:
494 km = WM_keymap_find_all(wm, "Graph Editor", sl->spacetype, RGN_TYPE_WINDOW);
495 break;
496 case SPACE_ACTION:
497 km = WM_keymap_find_all(wm, "Dopesheet", sl->spacetype, RGN_TYPE_WINDOW);
498 break;
499 case SPACE_NLA:
500 km = WM_keymap_find_all(wm, "NLA Editor", sl->spacetype, RGN_TYPE_WINDOW);
501 break;
502 case SPACE_IMAGE:
504 break;
505 case SPACE_NODE:
506 km = WM_keymap_find_all(wm, "Node Editor", sl->spacetype, RGN_TYPE_WINDOW);
507 break;
508 case SPACE_SEQ:
509 km = WM_keymap_find_all(wm, "Sequencer", sl->spacetype, RGN_TYPE_WINDOW);
510 break;
511 }
512 }
513 /* User Interface. */
514 else if (STRPREFIX(opname, "UI_OT")) {
515 km = WM_keymap_find_all(wm, "User Interface", SPACE_EMPTY, RGN_TYPE_WINDOW);
516 }
517 /* Geometry. */
518 else if (STRPREFIX(opname, "GEOMETRY_OT")) {
519 switch (sl->spacetype) {
520 case SPACE_VIEW3D:
521 switch (CTX_data_mode_enum(C)) {
524 break;
527 break;
529 km = WM_keymap_find_all(wm, "Point Cloud", SPACE_EMPTY, RGN_TYPE_WINDOW);
530 break;
531 case CTX_MODE_SCULPT:
533 break;
535 km = WM_keymap_find_all(wm, "Sculpt Curves", SPACE_EMPTY, RGN_TYPE_WINDOW);
536 break;
537 default:
538 break;
539 }
540 break;
541 }
542 }
543
544 return km;
545}
546
547static bool wm_keymap_item_uses_modifier(const wmKeyMapItem *kmi, const int event_modifier)
548{
549 if (kmi->ctrl != KM_ANY) {
550 if ((kmi->ctrl == KM_NOTHING) != ((event_modifier & KM_CTRL) == 0)) {
551 return false;
552 }
553 }
554
555 if (kmi->alt != KM_ANY) {
556 if ((kmi->alt == KM_NOTHING) != ((event_modifier & KM_ALT) == 0)) {
557 return false;
558 }
559 }
560
561 if (kmi->shift != KM_ANY) {
562 if ((kmi->shift == KM_NOTHING) != ((event_modifier & KM_SHIFT) == 0)) {
563 return false;
564 }
565 }
566
567 if (kmi->oskey != KM_ANY) {
568 if ((kmi->oskey == KM_NOTHING) != ((event_modifier & KM_OSKEY) == 0)) {
569 return false;
570 }
571 }
572 if (kmi->hyper != KM_ANY) {
573 if ((kmi->hyper == KM_NOTHING) != ((event_modifier & KM_HYPER) == 0)) {
574 return false;
575 }
576 }
577
578 return true;
579}
580
581bool WM_keymap_uses_event_modifier(const wmKeyMap *keymap, const int event_modifier)
582{
583 for (const wmKeyMapItem &kmi : keymap->items) {
584 if ((kmi.flag & KMI_INACTIVE) == 0) {
585 if (wm_keymap_item_uses_modifier(&kmi, event_modifier)) {
586 return true;
587 }
588 }
589 }
590 return false;
591}
592
594
596
597} // namespace blender
#define C
Definition RandGen.cpp:29
#define STRPREFIX(a, b)
#define STREQ(a, b)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
wmKeyMap * WM_keymap_find_all(wmWindowManager *wm, const char *idname, int spaceid, int regionid)
Definition wm_keymap.cc:949
bool WM_keymap_poll(bContext *C, wmKeyMap *keymap)
Definition wm_keymap.cc:485
wmKeyMapItem * WM_keymap_add_tool(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
void WM_keymap_fix_linking()
wmKeyMap * WM_keymap_guess_opname(const bContext *C, const char *opname)
enum eContextObjectMode CTX_data_mode_enum(const bContext *C)
@ SEQ_VIEW_SEQUENCE_PREVIEW
wmKeyMapItem * WM_keymap_add_item(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
Definition wm_keymap.cc:563
@ CTX_MODE_VERTEX_GREASE_PENCIL
@ CTX_MODE_PARTICLE
@ CTX_MODE_EDIT_TEXT
@ CTX_MODE_EDIT_SURFACE
@ CTX_MODE_PAINT_VERTEX
@ CTX_MODE_EDIT_GPENCIL_LEGACY
@ CTX_MODE_VERTEX_GPENCIL_LEGACY
@ CTX_MODE_WEIGHT_GPENCIL_LEGACY
@ CTX_MODE_SCULPT_CURVES
@ CTX_MODE_EDIT_ARMATURE
@ CTX_MODE_SCULPT
@ CTX_MODE_EDIT_CURVES
@ CTX_MODE_EDIT_LATTICE
@ CTX_MODE_PAINT_GREASE_PENCIL
@ CTX_MODE_PAINT_GPENCIL_LEGACY
@ CTX_MODE_SCULPT_GREASE_PENCIL
@ CTX_MODE_EDIT_POINTCLOUD
@ CTX_MODE_EDIT_MESH
@ CTX_MODE_PAINT_TEXTURE
@ CTX_MODE_SCULPT_GPENCIL_LEGACY
@ CTX_MODE_EDIT_METABALL
@ CTX_MODE_OBJECT
@ CTX_MODE_EDIT_GREASE_PENCIL
@ CTX_MODE_WEIGHT_GREASE_PENCIL
@ CTX_MODE_EDIT_CURVE
@ CTX_MODE_PAINT_WEIGHT
wmKeyMapItem * WM_keymap_add_menu(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
wmWindowManager * CTX_wm_manager(const bContext *C)
void RNA_boolean_set(PointerRNA *ptr, const char *name, bool value)
static bool wm_keymap_item_uses_modifier(const wmKeyMapItem *kmi, const int event_modifier)
SpaceLink * CTX_wm_space_data(const bContext *C)
wmKeyMapItem * WM_keymap_add_panel(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
@ KM_NOTHING
Definition WM_types.hh:323
bool WM_keymap_uses_event_modifier(const wmKeyMap *keymap, const int event_modifier)
wmKeyMapItem * WM_keymap_add_menu_pie(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
ARegion * CTX_wm_region(const bContext *C)
wmKeyMap * WM_keymap_guess_from_context(const bContext *C)
eSpaceImage_Mode mode
eSpaceButtons_Context mainb
eSpaceSeq_Displays view
ListBaseT< wmKeyMapItem > items