Cross Platform Support, Big Refactor, Node Editors

I removed as much of the Ctypes code that relied upon the windll as I could, replacing it with Blender native functions.
The only place it couldn't be removed was from the fake Right Mouse Release, which is only required on Windows anyway, so it worked itself out. (Still not sure why Windows needs it but Linux does not).
Haven't tested on Mac yet, but theoretically it should work. (famous last words)

Moved all the menu logic into a single dict that maps the context mode to the menu that the mode should call.
This means that there is no string formatting happening when attempting to call a menu, which gave inconsistent performance and added needless overhead.

You can now enable it for use in Node Editors - you can pan the view and open the Add/Search menu with RIght Mouse.

Also cleaned up the Preferences panel, as well as renaming variables, removing whitespace and other small changes.

Author: SpectralVectors

Preferences.py

@@ -1,17 +1,35 @@
 import bpy
 
+
+def update_node_keymap(self, context):
+    wm = context.window_manager
+    kc = wm.keyconfigs.user
+    for key in kc.keymaps['Node Editor'].keymap_items:
+        if (
+            key.idname == "wm.call_menu"
+            and key.type == "RIGHTMOUSE"
+        ):
+            key.active = not key.active
+
+        if (
+            key.idname == "blui.right_mouse_navigation"
+            and key.type == "RIGHTMOUSE"
+        ):
+            key.active = not key.active
+
+
 class RightMouseNavigationPreferences(bpy.types.AddonPreferences):
     bl_idname = __package__
 
-    timepreference: bpy.props.FloatProperty(
+    time: bpy.props.FloatProperty(
         name="Time Threshold",
         description="How long you have hold right mouse to open menu",
         default=0.3,
         min=0.1,
         max=2
     )
 
-    distancepreference: bpy.props.FloatProperty(
+    distance: bpy.props.FloatProperty(
         name="Distance Threshold",
         description="How far you have to move the mouse to trigger navigation",
         default=20,
@@ -25,12 +43,26 @@ class RightMouseNavigationPreferences(bpy.types.AddonPreferences):
         default=True
     )
 
+    enable_for_node_editors: bpy.props.BoolProperty(
+        name="Enable for Node Editors",
+        description="Right Mouse will pan the view / open the Node Add/Search Menu",
+        default=False,
+        update=update_node_keymap,
+    )
+
     def draw(self, context):
         layout = self.layout
 
-        layout.label(text="Menu Trigger Preferences")
-        layout.prop(self, 'timepreference')
-        layout.prop(self, 'distancepreference')
+        box = layout.box()
+        box.label(text="Menu / Movement", icon='DRIVER_DISTANCE')
+        row = box.row()
+        row.prop(self, 'time')
+        row.prop(self, 'distance')
 
-        layout.label(text="Cursor Preferences")
-        layout.prop(self, 'reset_cursor_on_exit')
+        row = layout.row()
+        box = row.box()
+        box.label(text="Cursor", icon='ORIENTATION_CURSOR')
+        box.prop(self, 'reset_cursor_on_exit')
+        box = row.box()
+        box.label(text='Node Editor', icon='NODETREE')
+        box.prop(self, 'enable_for_node_editors')

RightMouseNavigation.py

@@ -1,7 +1,4 @@
-import bpy, ctypes, math
-
-class POINT(ctypes.Structure):
-    _fields_ = [("x", ctypes.c_long), ("y", ctypes.c_long)]
+import bpy, ctypes, math, sys
 
 class BLUI_OT_right_mouse_navigation(bpy.types.Operator):
     """Timer that decides whether to display a menu after Right Click"""
@@ -13,19 +10,36 @@ class BLUI_OT_right_mouse_navigation(bpy.types.Operator):
     _count = 0
     _move_distance = 0
     MOUSE_RIGHTUP = 0x0010
-    MOUSE_MOVE = 0x0001
     _finished = False
     _callMenu = False
     _ortho = False
+    _back_to_ortho = False
+    menu_by_mode = {
+        'OBJECT': 'VIEW3D_MT_object_context_menu',
+        'EDIT_MESH': 'VIEW3D_MT_edit_mesh_context_menu',
+        'EDIT_SURFACE': 'VIEW3D_MT_edit_surface',
+        'EDIT_TEXT': 'VIEW3D_MT_edit_font_context_menu',
+        'EDIT_ARMATURE': 'VIEW3D_MT_edit_armature',
+        'EDIT_CURVE': 'VIEW3D_MT_edit_curve_context_menu',
+        'EDIT_METABALL': 'VIEW3D_MT_edit_metaball_context_menu',
+        'EDIT_LATTICE': 'VIEW3D_MT_edit_lattice_context_menu',
+        'POSE': 'VIEW3D_MT_pose_context_menu',
+        'PAINT_VERTEX': 'VIEW3D_PT_paint_vertex_context_menu',
+        'PAINT_WEIGHT': 'VIEW3D_PT_paint_weight_context_menu',
+        'PAINT_TEXTURE': 'VIEW3D_PT_paint_texture_context_menu',
+        'SCULPT': 'VIEW3D_PT_sculpt_context_menu'}
 
     def modal(self, context, event):
-        
+
         preferences = context.preferences
         addon_prefs = preferences.addons[__package__].preferences
 
-        # Check if the Viewport is Perspective or Orthographic
-        if bpy.context.region_data.is_perspective:
-            self._ortho = False
+        if context.space_data.type == 'VIEW_3D':
+            # Check if the Viewport is Perspective or Orthographic
+            if bpy.context.region_data.is_perspective:
+                self._ortho = False
+            else:
+                self._back_to_ortho = True
 
         # The _finished Boolean acts as a flag to exit the modal loop, 
         # it is not made True until after the cancel function is called
@@ -34,8 +48,6 @@ def modal(self, context, event):
             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
@@ -45,98 +57,83 @@ def reset_cursor():
                 # 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()
-                
+
+            if self._back_to_ortho:
+                bpy.ops.view3d.view_persportho()
+
             return {'CANCELLED'}
-            
-        if context.space_data.type == 'VIEW_3D':
+
+        if context.space_data.type == 'VIEW_3D' or addon_prefs.enable_for_node_editors and context.space_data.type == 'NODE_EDITOR':
             # Calculate mousemove distance before it reaches threshold
-            if event.type == "MOUSEMOVE" and self._move_distance < addon_prefs.distancepreference:
+            if event.type == "MOUSEMOVE" and self._move_distance < addon_prefs.distance:
                 xDelta = event.mouse_x - event.mouse_prev_x
                 yDelta = event.mouse_y - event.mouse_prev_y
                 deltaDistance = math.sqrt(xDelta*xDelta + yDelta*yDelta)
                 self._move_distance += deltaDistance
 
             if event.type in {'RIGHTMOUSE'}:
                 if event.value in {'RELEASE'}:
-                    # This fakes a Right Mouse Up event using Ctypes
-                    ctypes.windll.user32.mouse_event(self.MOUSE_RIGHTUP)
+                    if sys.platform == 'win32':
+                        # This fakes a Right Mouse Up event using Ctypes
+                        ctypes.windll.user32.mouse_event(self.MOUSE_RIGHTUP)
                     # This brings back our mouse cursor to use with the menu
                     context.window.cursor_modal_restore()
                     # If the length of time you've been holding down 
                     # Right Mouse and Mouse move distance is longer than the threshold value, 
                     # then set flag to call a context menu
-                    if self._move_distance < addon_prefs.distancepreference and self._count < addon_prefs.timepreference:
-                        # context.window.cursor_warp(self.view_x, self.view_y)
+                    if self._move_distance < addon_prefs.distance and self._count < addon_prefs.time:
                         self._callMenu = True
                     self.cancel(context)
                     # We now set the flag to true to exit the modal operator on the next loop through
                     self._finished = True
                     return {'PASS_THROUGH'}
 
             if event.type == 'TIMER':
-                if self._count <= addon_prefs.timepreference:
+                if self._count <= addon_prefs.time:
                     self._count += 0.01
             return {'PASS_THROUGH'}
 
     def callMenu(self, context):
-        # try to call a context menu, and if that fails, call a context panel.
-        # Most of Blender's context menus can be called with the code in the 
-        # 'try: except:' section, but there are a few modes that don't follow 
-        # the same conventions, these are accounted for here
-        if context.mode == 'EDIT_ARMATURE':
-            bpy.ops.wm.call_menu(
-                name="VIEW3D_MT_" + context.mode.lower()[5:].strip() + "_context_menu"
-                )
-            return{'PASS_THROUGH'}
-        if context.mode == 'EDIT_SURFACE':
-            bpy.ops.wm.call_menu(
-                name="VIEW3D_MT_" + context.mode.lower()
-                )
-            return{'PASS_THROUGH'}
-        if context.mode == 'EDIT_TEXT':
-            bpy.ops.wm.call_menu(
-                name="VIEW3D_MT_edit_font_context_menu"
-                )
-            return{'PASS_THROUGH'}
+        if context.space_data.type == 'NODE_EDITOR':
+            if context.space_data.node_tree:
+                bpy.ops.node.add_search('INVOKE_DEFAULT')
         else:
             try:
-                bpy.ops.wm.call_menu(
-                    name="VIEW3D_MT_" + context.mode.lower() + "_context_menu"
-                    )
+                bpy.ops.wm.call_menu(name=self.menu_by_mode[context.mode])
             except:
-                bpy.ops.wm.call_panel(
-                    name="VIEW3D_PT_" + context.mode.lower() + "_context_menu"
-                    )
+                bpy.ops.wm.call_panel(name=self.menu_by_mode[context.mode])
 
     def invoke(self, context, event):
-        # Store Windows OS cursor position
-        cursor = POINT()
-        ctypes.windll.user32.GetCursorPos(ctypes.byref(cursor))
-        self.mouse_x = cursor.x
-        self.mouse_y = cursor.y
         # Store Blender cursor position
         self.view_x = event.mouse_x
         self.view_y = event.mouse_y
         return self.execute(context)
 
     def execute(self, context):
+        preferences = context.preferences
+        addon_prefs = preferences.addons[__package__].preferences
+
         # Execute is the first thing called in our operator, so we start by
         # calling Blender's built-in Walk Navigation
         if context.space_data.type == 'VIEW_3D':
             bpy.ops.view3d.walk('INVOKE_DEFAULT')
-            
-            if self._ortho:
-                bpy.ops.view3d.view_persportho()
+            # Adding the timer and starting the loop
+            wm = context.window_manager
+            self._timer = wm.event_timer_add(0.1, window=context.window)
+            wm.modal_handler_add(self)
+            return {'RUNNING_MODAL'}
+
+        elif addon_prefs.enable_for_node_editors and context.space_data.type == 'NODE_EDITOR':
+            bpy.ops.view2d.pan('INVOKE_DEFAULT')
 
             wm = context.window_manager
             # Adding the timer and starting the loop
             self._timer = wm.event_timer_add(0.1, window=context.window)
             wm.modal_handler_add(self)
             return {'RUNNING_MODAL'}
+        
         elif context.space_data.type == 'IMAGE_EDITOR':
-            bpy.ops.wm.call_panel(
-                name="VIEW3D_PT_" + context.mode.lower() + "_context_menu"
-                )
+            bpy.ops.wm.call_panel(name="VIEW3D_PT_paint_texture_context_menu")
             return {'FINISHED'}
 
     def cancel(self, context):

__init__.py

@@ -1,10 +1,10 @@
 bl_info = {
     'name': 'Right Mouse Navigation',
-    'category': 'View 3D',
+    'category': '3D View',
     'author': 'Spectral Vectors',
-    'version': (0, 1, 9),
+    'version': (2, 0, 0),
     'blender': (2, 90, 0),
-    'location': '3D Viewport',
+    'location': '3D Viewport, Node Editor',
     "description": "Enables Right Mouse Viewport Navigation"
     }
 
@@ -24,18 +24,19 @@ def register():
 
         register_keymaps()    
 
+
 def register_keymaps():
     keyconfig = bpy.context.window_manager.keyconfigs
-    areas = 'Window', 'Text', 'Object Mode', '3D View'
+    areas = 'Window', 'Text', 'Object Mode', '3D View', 'Image', 'Node Editor'
 
     if not all(i in keyconfig.active.keymaps for i in areas):
         bpy.app.timers.register(register_keymaps, first_interval=0.1)
 
     else:
-        
+
         wm = bpy.context.window_manager
         kc = wm.keyconfigs.user
-        
+
         km = kc.keymaps.new(
             name="3D View",
             space_type='VIEW_3D',
@@ -45,13 +46,26 @@ def register_keymaps():
             "blui.right_mouse_navigation",
             'RIGHTMOUSE',
             'PRESS'
-            )                          
+            )
         kmi.active = True
-        addon_keymaps.append((km, kmi))
+
+        km2 = kc.keymaps.new(
+            name="Node Editor",
+            space_type='NODE_EDITOR',
+            region_type='WINDOW'
+            )
+        kmi2 = km2.keymap_items.new(
+            "blui.right_mouse_navigation",
+            'RIGHTMOUSE',
+            'PRESS'
+            )
+        kmi2.active = False
+
+        addon_keymaps.append((km, kmi, km2, kmi2))
 
         menumodes = ["Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice", "Font", "Pose"]
         panelmodes = ["Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"]
-        
+
         # These Modes all call standard menus
         # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
         # "Font", "Pose"
@@ -102,11 +116,15 @@ def unregister():
         wm = bpy.context.window_manager
         kc = wm.keyconfigs.user
 
+        for key in kc.keymaps['Node Editor'].keymap_items:
+            if (key.idname == 'blui.right_mouse_navigation'):
+                kc.keymaps['Node Editor'].keymap_items.remove(key)
+
         addon_keymaps.clear()
 
-        menumodes = ["Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice", "Font", "Pose"]
+        menumodes = ["Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice", "Font", "Pose", "Node Editor"]
         panelmodes = ["Vertex Paint", "Weight Paint", "Image Paint", "Sculpt"]
-        
+
         # Reactivating menus
         # "Object Mode", "Mesh", "Curve", "Armature", "Metaball", "Lattice",
         # "Font", "Pose"