Merge pull request #16 from NathanC/cursor-reset-change

Adds a preference for cusor reset behavior

Author: SpectralVectors

Preferences.py

@@ -19,8 +19,18 @@ class RightMouseNavigationPreferences(bpy.types.AddonPreferences):
         max=200
     )
 
+    reset_cursor_on_exit: bpy.props.BoolProperty(
+        name="Reset Cursor on Exit",
+        description="After exiting navigation, this determines if the cursor resets to where RMB was clicked (if checked) or stays in the center (if unchecked)",
+        default=True
+    )
+
     def draw(self, context):
         layout = self.layout
-        row = layout.row()
-        row.prop(self, 'timepreference')
-        row.prop(self, 'distancepreference')
+
+        layout.label(text="Menu Trigger Preferences")
+        layout.prop(self, 'timepreference')
+        layout.prop(self, 'distancepreference')
+
+        layout.label(text="Cursor Preferences")
+        layout.prop(self, 'reset_cursor_on_exit')

README.md

@@ -18,6 +18,8 @@ Mouse Wheel to adjust Viewport Move Speed (while Right Mouse is held)
 
 You can adjust the threshold for when you navigate/open menus by adjusting the time the mouse button is held, or distance the cursor travels in __Edit__ > __Preferences__ > __Addons__ > __View 3D: Right Mouse Navigation__ by clicking the dropdown arrow and tweaking the values there.
 
+Additionally, in the settings, you can change the cursor resetting behavior. By default, the cursor will snap back to the location where you initally clicked Right Mouse Button, after navigation exits. If you would rather the cursor stay in the center (where the navigation crosshair is) after navigation, you can disable the setting.
+
 ## Acknowledgements and Thanks
 
 Big thanks to __Biaru__ for fixing the context menu/cursor location bug, and adding a 'mouse movement' threshold, in addition to the time threshold for fine-tuning when you navigate vs open the context menu!

RightMouseNavigation.py

@@ -29,13 +29,23 @@ def modal(self, context, event):
 
         # The _finished Boolean acts as a flag to exit the modal loop, 
         # it is not made True until after the cancel function is called
-        if self._finished == True:
-            # Reset blender window cursor to previous position
-            context.window.cursor_warp(self.view_x, self.view_y)
-            # Reset Windows OS cursor to previous position
-            ctypes.windll.user32.SetCursorPos(self.mouse_x, self.mouse_y)
-            if self._callMenu == True:
+        if self._finished:
+
+            def reset_cursor():
+                # Reset blender window cursor to previous position
+                context.window.cursor_warp(self.view_x, self.view_y)
+                # Reset Windows OS cursor to previous position
+                ctypes.windll.user32.SetCursorPos(self.mouse_x, self.mouse_y)
+
+            if self._callMenu:
+                # Always reset the cursor if menu is called, as that implies a canceled navigation
+                reset_cursor()
                 self.callMenu(context)
+            else:
+                # Exit of a full navigation. Only reset the cursor if the preference (default False) is enabled
+                if addon_prefs.reset_cursor_on_exit:
+                    reset_cursor()
+                
             return {'CANCELLED'}
 
         if context.space_data.type == 'VIEW_3D':

__init__.py

@@ -2,7 +2,7 @@
     'name': 'Right Mouse Navigation',
     'category': 'View 3D',
     'author': 'Spectral Vectors',
-    'version': (0, 1, 8),
+    'version': (0, 1, 9),
     'blender': (2, 90, 0),
     'location': '3D Viewport',
     "description": "Enables Right Mouse Viewport Navigation"