Cam Lock UI Button, Keymap fixes

Author: SpectralVectors

__init__.py

@@ -1,24 +1,47 @@
-from .Preferences import RightMouseNavigationPreferences
-from .RightMouseNavigation import RMN_OT_right_mouse_navigation
 import bpy
 
+from .operators import (
+    RMN_OT_right_mouse_navigation,
+    RMN_OT_toggle_cam_navigation,
+)
+from .preferences import RightMouseNavigationPreferences
+
 addon_keymaps = []
+classes = [
+    RightMouseNavigationPreferences,
+    RMN_OT_right_mouse_navigation,
+    RMN_OT_toggle_cam_navigation,
+]
 
 
 def register():
     if not bpy.app.background:
-        bpy.utils.register_class(RightMouseNavigationPreferences)
-        bpy.utils.register_class(RMN_OT_right_mouse_navigation)
+        for cls in classes:
+            bpy.utils.register_class(cls)
 
         wm = bpy.context.window_manager
         addon_kc = wm.keyconfigs.addon
 
-        km = addon_kc.keymaps.new(name="3D View", space_type="VIEW_3D")
-        kmi = km.keymap_items.new("rmn.right_mouse_navigation", "RIGHTMOUSE", "PRESS")
+        km = addon_kc.keymaps.new(
+            name="3D View",
+            space_type="VIEW_3D",
+        )
+        kmi = km.keymap_items.new(
+            "rmn.right_mouse_navigation",
+            "RIGHTMOUSE",
+            "PRESS",
+        )
         kmi.active = True
 
-        km2 = addon_kc.keymaps.new(name="Node Editor", space_type="NODE_EDITOR")
-        kmi2 = km2.keymap_items.new("rmn.right_mouse_navigation", "RIGHTMOUSE", "PRESS")
+        km2 = addon_kc.keymaps.new(
+            name="Node Editor",
+            space_type="NODE_EDITOR",
+        )
+        kmi2 = km2.keymap_items.new(
+            "rmn.right_mouse_navigation",
+            "RIGHTMOUSE",
+            "PRESS",
+        )
         kmi2.active = False
 
         addon_keymaps.append((km, kmi))
@@ -36,7 +59,12 @@ def register():
             "Font",
             "Pose",
         ]
-        panelmodes = ["Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"]
+        panelmodes = [
+            "Vertex Paint",
+            "Weight Paint",
+            "Image Paint",
+            "Sculpt",
+        ]
 
         # These Modes all call standard menus
         # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
@@ -54,11 +82,7 @@ def register():
         # "Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"
         for i in panelmodes:
             for key in active_kc.keymaps[i].keymap_items:
-                if (
-                    key.idname == "wm.call_panel"
-                    and key.type == "RIGHTMOUSE"
-                    and key.active
-                ):
+                if key.idname == "wm.call_panel" and key.type == "RIGHTMOUSE" and key.active:
                     key.active = False
 
         # Changing the Walk Modal Map
@@ -73,8 +97,8 @@ def register():
 
 def unregister():
     if not bpy.app.background:
-        bpy.utils.unregister_class(RMN_OT_right_mouse_navigation)
-        bpy.utils.unregister_class(RightMouseNavigationPreferences)
+        for cls in classes:
+            bpy.utils.unregister_class(cls)
 
         wm = bpy.context.window_manager
         active_kc = wm.keyconfigs.active
@@ -91,7 +115,12 @@ def unregister():
             "Pose",
             "Node Editor",
         ]
-        panelmodes = ["Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"]
+        panelmodes = [
+            "Vertex Paint",
+            "Weight Paint",
+            "Image Paint",
+            "Sculpt",
+        ]
 
         # Reactivating menus
         # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",

blender_manifest.toml

@@ -1,7 +1,7 @@
 schema_version = "1.0.0"
 
 id = "right_mouse_navigation"
-version = "2.5.2"
+version = "2.6.0"
 name = "Right Mouse Navigation"
 tagline = "Game Engine Movement and Menus"
 maintainer = "Spectral Vectors and Contributors"

RightMouseNavigation.py operators.pyRightMouseNavigation.py renamed to operators.py

@@ -102,15 +102,10 @@ def callMenu(self, context):
             if space_type == "NODE_EDITOR":
                 node_tree = context.space_data.node_tree
                 if node_tree:
-                    if (
-                        node_tree.nodes.active is not None
-                        and node_tree.nodes.active.select
-                    ):
+                    if node_tree.nodes.active is not None and node_tree.nodes.active.select:
                         bpy.ops.wm.call_menu(name="NODE_MT_context_menu")
                     else:
-                        bpy.ops.wm.search_single_menu(
-                            "INVOKE_DEFAULT", menu_idname="NODE_MT_add"
-                        )
+                        bpy.ops.wm.search_single_menu("INVOKE_DEFAULT", menu_idname="NODE_MT_add")
             else:
                 try:
                     bpy.ops.wm.call_menu(name=self.menu_by_mode[context.mode])
@@ -133,11 +128,11 @@ def execute(self, context):
         disable_camera = addon_prefs.disable_camera_navigation
 
         space_type = context.space_data.type
-        view = context.space_data.region_3d.view_perspective
 
         # Execute is the first thing called in our operator, so we start by
         # calling Blender's built-in Walk Navigation
         if space_type == "VIEW_3D":
+            view = context.space_data.region_3d.view_perspective
             if not (view == "CAMERA" and disable_camera):
                 try:
                     bpy.ops.view3d.walk("INVOKE_DEFAULT")
@@ -167,3 +162,17 @@ def execute(self, context):
     def cancel(self, context):
         wm = context.window_manager
         wm.event_timer_remove(self._timer)
+
+
+class RMN_OT_toggle_cam_navigation(Operator):
+    """Turn Mouse Navigation of Camera On and Off"""
+
+    bl_idname = "rmn.toggle_cam_navigation"
+    bl_label = "Toggle Mouse Camera Navigation"
+    bl_options = {"REGISTER", "UNDO"}
+
+    def execute(self, context):
+        context.preferences.addons[__package__].preferences.disable_camera_navigation = (
+            not context.preferences.addons[__package__].preferences.disable_camera_navigation
+        )
+        return {"FINISHED"}

Preferences.py preferences.pyPreferences.py renamed to preferences.py

@@ -6,6 +6,35 @@
 from bpy.types import AddonPreferences
 
 
+def draw_cam_lock(self, context):
+    preferences = context.preferences
+    addon_prefs = preferences.addons[__package__].preferences
+    cam_nav = addon_prefs.disable_camera_navigation
+
+    layout = self.layout
+
+    row = layout.row(align=True)
+    row.alert = cam_nav
+    col = row.column()
+    col.scale_x = 1.3
+    icon = "VIEW_UNLOCKED" if cam_nav else "VIEW_LOCKED"
+    row.operator(text="", operator="rmn.toggle_cam_navigation", icon=icon)
+
+    row = row.row(align=True)
+    row.label(text="", icon="CAMERA_DATA")
+    row.label(text="", icon="MOUSE_MOVE")
+
+
+def cam_lock_update(self, context):
+    preferences = context.preferences
+    addon_prefs = preferences.addons[__package__].preferences
+
+    if addon_prefs.show_cam_lock_ui:
+        bpy.types.VIEW3D_HT_tool_header.prepend(draw_cam_lock)
+    else:
+        bpy.types.VIEW3D_HT_tool_header.remove(draw_cam_lock)
+
+
 def update_node_keymap(self, context):
     wm = context.window_manager
     active_kc = wm.keyconfigs.active
@@ -57,6 +86,13 @@ class RightMouseNavigationPreferences(AddonPreferences):
         default=False,
     )
 
+    show_cam_lock_ui: BoolProperty(
+        name="Show Camera Navigation Lock button",
+        description="Displays the Camera Navigation Lock button in the 3D Viewport",
+        default=False,
+        update=cam_lock_update,
+    )
+
     def draw(self, context):
         layout = self.layout
 
@@ -80,6 +116,7 @@ def draw(self, context):
         box = row.box()
         box.label(text="Camera", icon="CAMERA_DATA")
         box.prop(self, "disable_camera_navigation")
+        box.prop(self, "show_cam_lock_ui")
 
         # Keymap Customization
         import rna_keymap_ui