# SPDX-FileCopyrightText: 2020-2023 Blender Authors # # SPDX-License-Identifier: GPL-2.0-or-later # Update Blender version this key-map was written in. # The update runs when loading key-map presets written in older versions of Blender. # Failing to run this means those key-maps may fail to load with an error. # # When the version is `(0, 0, 0)`, the key-map being loaded didn't contain any versioning information. # This will older than `(2, 92, 0)`. __all__ = ( "keyconfig_update", ) def keyconfig_update(keyconfig_data, keyconfig_version): import re from bpy.app import version_file as blender_version if keyconfig_version >= blender_version: return keyconfig_data # Version the key-map. import copy # Only copy once. has_copy = False def get_transform_modal_map(): for km_name, _km_params, km_items_data in keyconfig_data: if km_name == "Transform Modal Map": return km_items_data return None def get_ui_keymap(): for km_name, _km_params, km_items_data in keyconfig_data: if km_name == "User Interface": return km_items_data return None def remove_properties(op_prop_map): nonlocal keyconfig_data nonlocal has_copy changed_items = [] for km_index, (_km_name, _km_parms, km_items_data) in enumerate(keyconfig_data): for kmi_item_index, (item_op, item_event, item_prop) in enumerate(km_items_data["items"]): if item_prop and item_op in op_prop_map: properties = item_prop.get("properties", []) filtered_properties = [ prop for prop in properties if not any( key in prop for key in op_prop_map[item_op]) ] if not filtered_properties: filtered_properties = None if filtered_properties is None or len(filtered_properties) < len(properties): changed_items.append((km_index, kmi_item_index, filtered_properties)) if changed_items: if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True for km_index, kmi_item_index, filtered_properties in changed_items: item_op, item_event, item_prop = keyconfig_data[km_index][2]["items"][kmi_item_index] item_prop["properties"] = filtered_properties keyconfig_data[km_index][2]["items"][kmi_item_index] = (item_op, item_event, item_prop) def rename_keymap(km_name_map): nonlocal keyconfig_data nonlocal has_copy for km_index, (km_name, km_parms, km_items_data) in enumerate(keyconfig_data): km_name_dst = km_name_map.get(km_name) if km_name_dst is None: continue if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True keyconfig_data[km_index] = (km_name_dst, km_parms, km_items_data) # Default repeat to false. if keyconfig_version <= (2, 92, 0): if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True for _km_name, _km_parms, km_items_data in keyconfig_data: for (_item_op, item_event, _item_prop) in km_items_data["items"]: if item_event.get("value") == 'PRESS': # Unfortunately we don't know the `map_type` at this point. # Setting repeat true on other kinds of events is harmless. item_event["repeat"] = True if keyconfig_version <= (3, 2, 5): if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True for _km_name, _km_parms, km_items_data in keyconfig_data: for (_item_op, item_event, _item_prop) in km_items_data["items"]: if ty_new := { 'EVT_TWEAK_L': 'LEFTMOUSE', 'EVT_TWEAK_M': 'MIDDLEMOUSE', 'EVT_TWEAK_R': 'RIGHTMOUSE', }.get(item_event.get("type")): item_event["type"] = ty_new if (value := item_event["value"]) != 'ANY': item_event["direction"] = value item_event["value"] = 'CLICK_DRAG' if keyconfig_version <= (3, 2, 6): if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True for _km_name, _km_parms, km_items_data in keyconfig_data: for (_item_op, item_event, _item_prop) in km_items_data["items"]: if ty_new := { 'NDOF_BUTTON_ESC': 'ESC', 'NDOF_BUTTON_ALT': 'LEFT_ALT', 'NDOF_BUTTON_SHIFT': 'LEFT_SHIFT', 'NDOF_BUTTON_CTRL': 'LEFT_CTRL', }.get(item_event.get("type")): item_event["type"] = ty_new if keyconfig_version <= (3, 6, 0): # The modal keys "Vert/Edge Slide" and "TrackBall" didn't exist until then. # The operator reused the "Move" and "Rotate" respectively. if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True if km_items_data := get_transform_modal_map(): km_items = km_items_data["items"] for (item_modal, item_event, _item_prop) in km_items: if item_modal == 'TRANSLATE': km_items.append(('VERT_EDGE_SLIDE', item_event, None)) elif item_modal == 'ROTATE': km_items.append(('TRACKBALL', item_event, None)) # The modal key for "Rotate Normals" also didn't exist until then. km_items.append(('ROTATE_NORMALS', {"type": 'N', "value": 'PRESS'}, None)) if keyconfig_version <= (4, 0, 3): if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True # "Snap Source Toggle" did not exist until then. if km_items_data := get_transform_modal_map(): km_items_data["items"].append(("EDIT_SNAP_SOURCE_ON", {"type": 'B', "value": 'PRESS'}, None)) km_items_data["items"].append(("EDIT_SNAP_SOURCE_OFF", {"type": 'B', "value": 'PRESS'}, None)) if keyconfig_version <= (4, 1, 5): remove_properties({ "transform.edge_slide": ["alt_navigation"], "transform.resize": ["alt_navigation"], "transform.rotate": ["alt_navigation"], "transform.shrink_fatten": ["alt_navigation"], "transform.transform": ["alt_navigation"], "transform.translate": ["alt_navigation"], "transform.vert_slide": ["alt_navigation"], "view3d.edit_mesh_extrude_move_normal": ["alt_navigation"], "armature.extrude_move": ["TRANSFORM_OT_translate"], "curve.extrude_move": ["TRANSFORM_OT_translate"], "gpencil.extrude_move": ["TRANSFORM_OT_translate"], "mesh.rip_edge_move": ["TRANSFORM_OT_translate"], "mesh.duplicate_move": ["TRANSFORM_OT_translate"], "object.duplicate_move": ["TRANSFORM_OT_translate"], "object.duplicate_move_linked": ["TRANSFORM_OT_translate"], }) if km_items_data := get_transform_modal_map(): def use_alt_navigate(): km_item = next( (i for i in km_items_data["items"] if i[0] == "PROPORTIONAL_SIZE" and i[1]["type"] == 'TRACKPADPAN'), None, ) if km_item: return "alt" not in km_item[1] or km_item[1]["alt"] is False # Fallback. import bpy return getattr( bpy.context.window_manager.keyconfigs.active.preferences, "use_alt_navigation", False) if use_alt_navigate(): if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True km_items_data = get_transform_modal_map() km_items_data["items"].append( ("PASSTHROUGH_NAVIGATE", {"type": 'LEFT_ALT', "value": 'ANY', "any": True}, None)) 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"}) if keyconfig_version < (5, 0, 53): if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True # The `unified_paint_setting` struct was moved from `tool_settings` to be a sub-property of a given individual # paint type. # # The following conversion maps from the old values of # `tool_settings.unified_paint_settings.` # to # `tool_settings..unified_paint_settings.` # where is retrieved from the `data_path_primary` property # # Example: # `tool_settings.unified_paint_settings.size` # and # `tool_settings.unified_paint_settings.use_unified_size` # for an operator with # `tool_settings.sculpt.brush.size` # become # `tool_settings.sculpt.unified_paint_settings.size` # and # `tool_settings.sculpt.unified_paint_settings.use_unified_size` # Match paths of the form 'tool_settings..brush.' re_toolsetting_brush = re.compile(r"^(tool_settings)\.([a-z_]+)\.(brush)\.(.*)") for _km_name, _km_parms, km_items_data in keyconfig_data: for (item_op, _item_event, item_prop) in km_items_data["items"]: if item_op == "wm.radial_control": updated_path_elements = [] secondary_path_index = -1 secondary_path_identifier = "" toggle_path_index = -1 toggle_path_identifier = "" for prop_idx, (prop_id, prop_path) in enumerate(item_prop["properties"]): if prop_id == "data_path_primary": if re_toolsetting_brush.fullmatch(prop_path): # Example: # 'tool_settings.sculpt.brush.size' # results in # ['tool_settings', 'sculpt', 'unified_paint_settings'] updated_path_elements = prop_path.split(".")[0:2] updated_path_elements.append("unified_paint_settings") elif prop_id == "data_path_secondary": if prop_path.startswith("tool_settings.unified_paint_settings."): # Example: # 'tool_settings.unified_paint_settings.size' # results in # 'size' secondary_path_index = prop_idx secondary_path_identifier = prop_path.split(".", 2)[-1] elif prop_id == "use_secondary": if prop_path.startswith("tool_settings.unified_paint_settings."): # Example: # 'tool_settings.unified_paint_settings.use_unified_size' # results in # 'use_unified_size' toggle_path_index = prop_idx toggle_path_identifier = prop_path.split(".", 2)[-1] if updated_path_elements and secondary_path_index != -1 and toggle_path_index != -1: item_prop["properties"][secondary_path_index] = ( "data_path_secondary", ".".join((*updated_path_elements, secondary_path_identifier))) item_prop["properties"][toggle_path_index] = ( "use_secondary", ".".join((*updated_path_elements, toggle_path_identifier))) if keyconfig_version < (5, 1, 6): has_view_select = False has_view_scroll = False if km_ui_items_data := get_ui_keymap(): for (item_op, _item_event, _item_prop) in km_ui_items_data["items"]: if item_op == "ui.view_item_select": has_view_select = True if item_op == "ui.view_scroll": has_view_scroll = True if not has_view_select: if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True km_ui_items_data = get_ui_keymap() select_items = [ ("ui.view_item_select", {"type": 'LEFTMOUSE', "value": 'PRESS'}, None), ("ui.view_item_select", {"type": 'LEFTMOUSE', "value": 'PRESS', "ctrl": True}, {"properties": [("extend", True)]}), ("ui.view_item_select", {"type": 'LEFTMOUSE', "value": 'PRESS', "shift": True}, {"properties": [("range_select", True)]}), ] km_ui_items_data["items"].extend(select_items) if not has_view_scroll: if not has_copy: keyconfig_data = copy.deepcopy(keyconfig_data) has_copy = True km_ui_items_data = get_ui_keymap() scroll_items = [ ("ui.view_scroll", {"type": 'WHEELUPMOUSE', "value": 'ANY'}, None), ("ui.view_scroll", {"type": 'WHEELDOWNMOUSE', "value": 'ANY'}, None), ("ui.view_scroll", {"type": 'TRACKPADPAN', "value": 'ANY'}, None), ] km_ui_items_data["items"].extend(scroll_items) else: print("Error versioning keymap: Missing \"User Interface\" keymap") if keyconfig_version < (5, 1, 11): rename_keymap({"Grease Pencil Paint Mode": "Grease Pencil Draw Mode"}) return keyconfig_data