Cleanup: VSE: Rename Keymaps

Rename to be more consistent with other Blender keymaps, as well as the
naming convention used in "View Type."

- "SequencerCommon" -> "Video Sequence Editor"
- "SequencerPreview" -> "Preview"
- "Sequencer Timeline Tool" -> "Sequencer Tool"
- "Sequencer Preview Tool" -> "Preview Tool"

There is versioning in place to make sure custom keyconfigs keep working.

Once #131102 goes through, if we would like to rename the "Sequencer"
view type to "Timeline" or "Sequencer Timeline," then we can make the
necessary changes here too.

Pull Request: https://projects.blender.org/blender/blender/pulls/136217
This commit is contained in:
John Kiril Swenson
2025-03-25 23:46:15 +01:00
committed by John Kiril Swenson
parent 196d07a5aa
commit b729928897
10 changed files with 110 additions and 64 deletions

View File

@@ -174,11 +174,11 @@ _km_hierarchy = [
('Node Tool: Select Circle', 'NODE_EDITOR', 'WINDOW', []),
('Node Tool: Select Circle (fallback)', 'NODE_EDITOR', 'WINDOW', []),
]),
('SequencerCommon', 'SEQUENCE_EDITOR', 'WINDOW', [
('Video Sequence Editor', 'SEQUENCE_EDITOR', 'WINDOW', [
('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', [
_km_expand_from_toolsystem('SEQUENCE_EDITOR', 'SEQUENCER'),
]),
('SequencerPreview', 'SEQUENCE_EDITOR', 'WINDOW', [
('Preview', 'SEQUENCE_EDITOR', 'WINDOW', [
_km_expand_from_toolsystem('SEQUENCE_EDITOR', 'PREVIEW'),
]),
]),

View File

@@ -189,4 +189,21 @@ def keyconfig_update(keyconfig_data, keyconfig_version):
if keyconfig_version <= (4, 1, 21):
rename_keymap({"NLA Channels": "NLA Tracks"})
if keyconfig_version <= (4, 5, 10):
rename_keymap({"SequencerCommon": "Video Sequence Editor"})
rename_keymap({"SequencerPreview": "Preview"})
mappings = [
("Sequencer Timeline Tool: Select Box", "Sequencer Tool: Select Box"),
("Sequencer Preview Tool: Tweak", "Preview Tool: Tweak"),
("Sequencer Preview Tool: Select Box", "Preview Tool: Select Box"),
]
for old, new in mappings:
rename_keymap({old: new})
rename_keymap({f"{old} (fallback)": f"{new} (fallback)"})
rename_keymap({"Sequencer Tool: Cursor": "Preview Tool: Cursor"})
rename_keymap({"Sequencer Tool: Sample": "Preview Tool: Sample"})
rename_keymap({"Sequencer Tool: Move": "Preview Tool: Move"})
rename_keymap({"Sequencer Tool: Rotate": "Preview Tool: Rotate"})
rename_keymap({"Sequencer Tool: Scale": "Preview Tool: Scale"})
return keyconfig_data

View File

@@ -2944,10 +2944,10 @@ def km_text(params):
# Editor (Sequencer)
def km_sequencercommon(params):
def km_sequencer_generic(params):
items = []
keymap = (
"SequencerCommon",
"Video Sequence Editor",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": items},
)
@@ -3150,10 +3150,10 @@ def _seq_preview_text_edit_cursor_move():
return items
def km_sequencerpreview(params):
def km_sequencer_preview(params):
items = []
keymap = (
"SequencerPreview",
"Preview",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": items},
)
@@ -8129,7 +8129,7 @@ def km_3d_view_tool_edit_grease_pencil_texture_gradient(params):
# ------------------------------------------------------------------------------
# Tool System (Sequencer, Generic)
def km_sequencer_editor_tool_generic_select_timeline_rcs(params):
def km_sequencer_tool_generic_select_rcs(params):
return [
("sequencer.select_handle", {"type": 'LEFTMOUSE', "value": 'PRESS'}, None),
("sequencer.select_handle", {"type": 'LEFTMOUSE', "value": 'PRESS',
@@ -8144,7 +8144,7 @@ def km_sequencer_editor_tool_generic_select_timeline_rcs(params):
]
def km_sequencer_editor_tool_generic_select_timeline_lcs(params):
def km_sequencer_tool_generic_select_lcs(params):
return [
("sequencer.select", {"type": 'LEFTMOUSE', "value": 'PRESS'}, None),
("sequencer.select", {"type": 'LEFTMOUSE', "value": 'PRESS',
@@ -8154,16 +8154,16 @@ def km_sequencer_editor_tool_generic_select_timeline_lcs(params):
]
def km_sequencer_editor_tool_generic_select_box_timeline(params, *, fallback):
def km_sequencer_tool_generic_select_box(params, *, fallback):
return (
_fallback_id("Sequencer Timeline Tool: Select Box", fallback),
_fallback_id("Sequencer Tool: Select Box", fallback),
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
# Combine the tweak functionality into the select box tool.
# This gives one standard tool for all selection and transform behavior.
*(km_sequencer_editor_tool_generic_select_timeline_rcs(params)
*(km_sequencer_tool_generic_select_rcs(params)
if (params.select_mouse == 'RIGHTMOUSE') else
km_sequencer_editor_tool_generic_select_timeline_lcs(params)),
km_sequencer_tool_generic_select_lcs(params)),
# Don't use `tool_maybe_tweak_event`, see comment for this slot.
*([] if (fallback and not params.use_fallback_tool) else _template_items_tool_select_actions_simple(
"sequencer.select_box",
@@ -8174,9 +8174,9 @@ def km_sequencer_editor_tool_generic_select_box_timeline(params, *, fallback):
)
def km_sequencer_editor_tool_generic_select_preview(params, *, fallback):
def km_sequencer_preview_tool_generic_select(params, *, fallback):
return (
_fallback_id("Sequencer Preview Tool: Tweak", fallback),
_fallback_id("Preview Tool: Tweak", fallback),
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("sequencer.text_cursor_set", {"type": 'LEFTMOUSE', "value": 'PRESS'}, None),
@@ -8191,9 +8191,9 @@ def km_sequencer_editor_tool_generic_select_preview(params, *, fallback):
)
def km_sequencer_editor_tool_generic_select_box_preview(params, *, fallback):
def km_sequencer_preview_tool_generic_select_box(params, *, fallback):
return (
_fallback_id("Sequencer Preview Tool: Select Box", fallback),
_fallback_id("Preview Tool: Select Box", fallback),
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("sequencer.text_cursor_set", {"type": 'LEFTMOUSE', "value": 'PRESS'}, None),
@@ -8207,9 +8207,9 @@ def km_sequencer_editor_tool_generic_select_box_preview(params, *, fallback):
)
def km_sequencer_editor_tool_generic_cursor(params):
def km_sequencer_preview_tool_generic_cursor(params):
return (
"Sequencer Tool: Cursor",
"Preview Tool: Cursor",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("sequencer.cursor_set", {"type": params.tool_mouse, "value": 'PRESS'}, None),
@@ -8223,7 +8223,7 @@ def km_sequencer_editor_tool_generic_cursor(params):
# ------------------------------------------------------------------------------
# Tool System (Sequencer, Timeline)
def km_sequencer_editor_tool_blade(_params):
def km_sequencer_tool_blade(_params):
return (
"Sequencer Tool: Blade",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
@@ -8242,9 +8242,9 @@ def km_sequencer_editor_tool_blade(_params):
# ------------------------------------------------------------------------------
# Tool System (Sequencer, Preview)
def km_sequencer_editor_tool_sample(params):
def km_sequencer_preview_tool_sample(params):
return (
"Sequencer Tool: Sample",
"Preview Tool: Sample",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("sequencer.sample", {"type": params.tool_mouse, "value": 'PRESS'}, None),
@@ -8252,9 +8252,9 @@ def km_sequencer_editor_tool_sample(params):
)
def km_sequencer_editor_tool_move(params):
def km_sequencer_preview_tool_move(params):
return (
"Sequencer Tool: Move",
"Preview Tool: Move",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("transform.translate", {**params.tool_maybe_tweak_event, **params.tool_modifier},
@@ -8263,9 +8263,9 @@ def km_sequencer_editor_tool_move(params):
)
def km_sequencer_editor_tool_rotate(params):
def km_sequencer_preview_tool_rotate(params):
return (
"Sequencer Tool: Rotate",
"Preview Tool: Rotate",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("transform.rotate", {**params.tool_maybe_tweak_event, **params.tool_modifier},
@@ -8274,9 +8274,9 @@ def km_sequencer_editor_tool_rotate(params):
)
def km_sequencer_editor_tool_scale(params):
def km_sequencer_preview_tool_scale(params):
return (
"Sequencer Tool: Scale",
"Preview Tool: Scale",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": [
("transform.resize", {**params.tool_maybe_tweak_event, **params.tool_modifier},
@@ -8351,9 +8351,9 @@ def generate_keymaps(params=None):
km_nla_editor(params),
km_text_generic(params),
km_text(params),
km_sequencercommon(params),
km_sequencer_generic(params),
km_sequencer(params),
km_sequencerpreview(params),
km_sequencer_preview(params),
km_sequencer_channels(params),
km_console(params),
km_clip(params),
@@ -8553,20 +8553,20 @@ def generate_keymaps(params=None):
km_3d_view_tool_paint_grease_pencil_primitive_circle(params),
km_3d_view_tool_paint_grease_pencil_primitive_arc(params),
km_3d_view_tool_paint_grease_pencil_primitive_curve(params),
*(km_sequencer_editor_tool_generic_select_box_timeline(params, fallback=fallback)
*(km_sequencer_tool_generic_select_box(params, fallback=fallback)
for fallback in (False, True)),
*(km_sequencer_editor_tool_generic_select_preview(params, fallback=fallback)
*(km_sequencer_preview_tool_generic_select(params, fallback=fallback)
for fallback in (False, True)),
*(km_sequencer_editor_tool_generic_select_box_preview(params, fallback=fallback)
*(km_sequencer_preview_tool_generic_select_box(params, fallback=fallback)
for fallback in (False, True)),
km_3d_view_tool_paint_grease_pencil_trim(params),
km_3d_view_tool_edit_grease_pencil_texture_gradient(params),
km_sequencer_editor_tool_generic_cursor(params),
km_sequencer_editor_tool_blade(params),
km_sequencer_editor_tool_sample(params),
km_sequencer_editor_tool_move(params),
km_sequencer_editor_tool_rotate(params),
km_sequencer_editor_tool_scale(params),
km_sequencer_tool_blade(params),
km_sequencer_preview_tool_generic_cursor(params),
km_sequencer_preview_tool_sample(params),
km_sequencer_preview_tool_move(params),
km_sequencer_preview_tool_rotate(params),
km_sequencer_preview_tool_scale(params),
km_3d_view_tool_edit_grease_pencil_interpolate(params),
km_3d_view_tool_paint_grease_pencil_interpolate(params),
km_3d_view_tool_paint_grease_pencil_eyedropper(params),

View File

@@ -1752,10 +1752,10 @@ def km_text(params):
return keymap
def km_sequencercommon(_params):
def km_sequencer_generic(_params):
items = []
keymap = (
"SequencerCommon",
"Video Sequence Editor",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": items},
)
@@ -1887,10 +1887,10 @@ def km_sequencer(params):
return keymap
def km_sequencerpreview(params):
def km_sequencer_preview(params):
items = []
keymap = (
"SequencerPreview",
"Preview",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": items},
)
@@ -3635,7 +3635,7 @@ def km_image_editor_tool_uv_select(params):
def km_sequencer_editor_tool_select_preview(params):
return (
"Sequencer Preview Tool: Select Box",
"Preview Tool: Select Box",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": _template_items_tool_select(params, "sequencer.select", extend="toggle")}
)
@@ -3643,7 +3643,7 @@ def km_sequencer_editor_tool_select_preview(params):
def km_sequencer_editor_tool_select_timeline(params):
return (
"Sequencer Timeline Tool: Select Box",
"Sequencer Tool: Select Box",
{"space_type": 'SEQUENCE_EDITOR', "region_type": 'WINDOW'},
{"items": _template_items_tool_select(params, "sequencer.select", extend="toggle")}
)
@@ -3759,9 +3759,9 @@ def generate_keymaps_impl(params=None):
km_nla_editor(params),
km_text_generic(params),
km_text(params),
km_sequencercommon(params),
km_sequencer_generic(params),
km_sequencer(params),
km_sequencerpreview(params),
km_sequencer_preview(params),
km_sequencer_channels(params),
km_console(params),
km_clip(params),

View File

@@ -2940,7 +2940,7 @@ class _defs_sequencer_generic:
"Set the cursor location, drag to transform"
),
icon="ops.generic.cursor",
keymap="Sequencer Tool: Cursor",
keymap="Preview Tool: Cursor",
)
@ToolDef.from_fn
@@ -2969,7 +2969,7 @@ class _defs_sequencer_generic:
"Sample pixel values under the cursor"
),
icon="ops.paint.weight_sample", # XXX, needs own icon.
keymap="Sequencer Tool: Sample",
keymap="Preview Tool: Sample",
)
@ToolDef.from_fn
@@ -2980,7 +2980,7 @@ class _defs_sequencer_generic:
icon="ops.transform.translate",
widget="SEQUENCER_GGT_gizmo2d_translate",
operator="transform.translate",
keymap="Sequencer Tool: Move",
keymap="Preview Tool: Move",
)
@ToolDef.from_fn
@@ -2991,7 +2991,7 @@ class _defs_sequencer_generic:
icon="ops.transform.rotate",
widget="SEQUENCER_GGT_gizmo2d_rotate",
operator="transform.rotate",
keymap="Sequencer Tool: Rotate",
keymap="Preview Tool: Rotate",
)
@ToolDef.from_fn
@@ -3002,7 +3002,7 @@ class _defs_sequencer_generic:
icon="ops.transform.resize",
widget="SEQUENCER_GGT_gizmo2d_resize",
operator="transform.resize",
keymap="Sequencer Tool: Scale",
keymap="Preview Tool: Scale",
)
@ToolDef.from_fn
@@ -3027,7 +3027,7 @@ class _defs_sequencer_select:
label="Tweak",
icon="ops.generic.select",
widget=None,
keymap="Sequencer Preview Tool: Tweak",
keymap="Preview Tool: Tweak",
)
@ToolDef.from_fn
@@ -3042,7 +3042,7 @@ class _defs_sequencer_select:
label="Select Box",
icon="ops.generic.select_box",
widget=None,
keymap="Sequencer Timeline Tool: Select Box",
keymap="Sequencer Tool: Select Box",
draw_settings=draw_settings,
)
@@ -3058,7 +3058,7 @@ class _defs_sequencer_select:
label="Select Box",
icon="ops.generic.select_box",
widget=None,
keymap="Sequencer Preview Tool: Select Box",
keymap="Preview Tool: Select Box",
draw_settings=draw_settings,
)

View File

@@ -27,7 +27,7 @@
/* Blender file format version. */
#define BLENDER_FILE_VERSION BLENDER_VERSION
#define BLENDER_FILE_SUBVERSION 9
#define BLENDER_FILE_SUBVERSION 10
/* Minimum Blender version that supports reading file written with the current
* version. Older Blender versions will test this and cancel loading the file, showing a warning to

View File

@@ -1413,6 +1413,35 @@ void blo_do_versions_userdef(UserDef *userdef)
userdef->ndof_flag |= NDOF_SHOW_GUIDE_ORBIT_CENTER | NDOF_ORBIT_CENTER_AUTO;
}
if (!USER_VERSION_ATLEAST(405, 10)) {
static const blender::Map<std::string, std::string> keymap_renames = {
{"SequencerCommon", "Video Sequence Editor"},
{"SequencerPreview", "Preview"},
{"Sequencer Tool: Cursor", "Preview Tool: Cursor"},
{"Sequencer Tool: Sample", "Preview Tool: Sample"},
{"Sequencer Tool: Move", "Preview Tool: Move"},
{"Sequencer Tool: Rotate", "Preview Tool: Rotate"},
{"Sequencer Tool: Scale", "Preview Tool: Scale"},
{"Sequencer Timeline Tool: Select Box", "Sequencer Tool: Select Box"},
{"Sequencer Timeline Tool: Select Box (fallback)",
"Sequencer Tool: Select Box (fallback)"},
{"Sequencer Preview Tool: Tweak", "Preview Tool: Tweak"},
{"Sequencer Preview Tool: Tweak (fallback)", "Preview Tool: Tweak (fallback)"},
{"Sequencer Preview Tool: Select Box", "Preview Tool: Select Box"},
{"Sequencer Preview Tool: Select Box (fallback)", "Preview Tool: Select Box (fallback)"},
};
LISTBASE_FOREACH (wmKeyMap *, keymap, &userdef->user_keymaps) {
std::string old_name(keymap->idname);
if (const std::string *new_name = keymap_renames.lookup_ptr(old_name)) {
STRNCPY(keymap->idname, new_name->c_str());
}
}
}
/**
* Always bump subversion in BKE_blender_version.h when adding versioning
* code here, and wrap it inside a USER_VERSION_ATLEAST check.

View File

@@ -141,13 +141,13 @@ void sequencer_operatortypes()
void sequencer_keymap(wmKeyConfig *keyconf)
{
/* Common items ------------------------------------------------------------------ */
WM_keymap_ensure(keyconf, "SequencerCommon", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_keymap_ensure(keyconf, "Video Sequence Editor", SPACE_SEQ, RGN_TYPE_WINDOW);
/* Strips Region --------------------------------------------------------------- */
WM_keymap_ensure(keyconf, "Sequencer", SPACE_SEQ, RGN_TYPE_WINDOW);
/* Preview Region ----------------------------------------------------------- */
WM_keymap_ensure(keyconf, "SequencerPreview", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_keymap_ensure(keyconf, "Preview", SPACE_SEQ, RGN_TYPE_WINDOW);
/* Channels Region ----------------------------------------------------------- */
WM_keymap_ensure(keyconf, "Sequencer Channels", SPACE_SEQ, RGN_TYPE_WINDOW);

View File

@@ -441,7 +441,7 @@ static void sequencer_main_region_init(wmWindowManager *wm, ARegion *region)
WM_event_add_keymap_handler_v2d_mask(&region->runtime->handlers, keymap);
#endif
keymap = WM_keymap_ensure(wm->defaultconf, "SequencerCommon", SPACE_SEQ, RGN_TYPE_WINDOW);
keymap = WM_keymap_ensure(wm->defaultconf, "Video Sequence Editor", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_event_add_keymap_handler_v2d_mask(&region->runtime->handlers, keymap);
/* Own keymap. */
@@ -750,7 +750,7 @@ static void sequencer_tools_region_init(wmWindowManager *wm, ARegion *region)
region->v2d.scroll = V2D_SCROLL_RIGHT | V2D_SCROLL_VERTICAL_HIDE;
ED_region_panels_init(wm, region);
keymap = WM_keymap_ensure(wm->defaultconf, "SequencerCommon", SPACE_SEQ, RGN_TYPE_WINDOW);
keymap = WM_keymap_ensure(wm->defaultconf, "Video Sequence Editor", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_event_add_keymap_handler_v2d_mask(&region->runtime->handlers, keymap);
}
@@ -792,10 +792,10 @@ static void sequencer_preview_region_init(wmWindowManager *wm, ARegion *region)
#endif
/* Own keymap. */
keymap = WM_keymap_ensure(wm->defaultconf, "SequencerPreview", SPACE_SEQ, RGN_TYPE_WINDOW);
keymap = WM_keymap_ensure(wm->defaultconf, "Preview", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_event_add_keymap_handler_v2d_mask(&region->runtime->handlers, keymap);
keymap = WM_keymap_ensure(wm->defaultconf, "SequencerCommon", SPACE_SEQ, RGN_TYPE_WINDOW);
keymap = WM_keymap_ensure(wm->defaultconf, "Video Sequence Editor", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_event_add_keymap_handler_v2d_mask(&region->runtime->handlers, keymap);
/* Do this instead of adding V2D and frames `ED_KEYMAP_*` flags to `art->keymapflag`, since text
@@ -1052,7 +1052,7 @@ static void sequencer_buttons_region_init(wmWindowManager *wm, ARegion *region)
{
wmKeyMap *keymap;
keymap = WM_keymap_ensure(wm->defaultconf, "SequencerCommon", SPACE_SEQ, RGN_TYPE_WINDOW);
keymap = WM_keymap_ensure(wm->defaultconf, "Video Sequence Editor", SPACE_SEQ, RGN_TYPE_WINDOW);
WM_event_add_keymap_handler_v2d_mask(&region->runtime->handlers, keymap);
UI_panel_category_active_set_default(region, "Strip");

View File

@@ -205,10 +205,10 @@ wmKeyMap *WM_keymap_guess_from_context(const bContext *C)
km_id = "Sequencer";
break;
case SEQ_VIEW_PREVIEW:
km_id = "SequencerPreview";
km_id = "Preview";
break;
case SEQ_VIEW_SEQUENCE_PREVIEW:
km_id = "SequencerCommon";
km_id = "Video Sequence Editor";
break;
}
}