docs cleanup & func cleanup

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -42,6 +42,7 @@
 __module_name__ = 'NodeGraphQt'
 __url__ = 'https://github.com/jchanvfx/NodeGraphQt'
 
+from .base.actions import setup_context_menu
 from .base.graph import NodeGraph
 from .base.node import NodeObject, Node, Backdrop
 from .base.port import Port

NodeGraphQt/base/actions.py

@@ -6,35 +6,36 @@
 
 def setup_context_menu(graph):
     """
-    build the default node graph context menu.
+    convenience function that populates the node graphs context menu
+    with some default menus and commands.
 
     Args:
-        graph (NodeGraphQt.NodeGraph): node graph controller.
+        graph (NodeGraphQt.NodeGraph): node graph controller class.
     """
     root_menu = graph.context_menu()
 
     file_menu = root_menu.add_menu('&File')
     edit_menu = root_menu.add_menu('&Edit')
 
-    # File menu.
+    # create "File" menu.
     file_menu.add_command('Open...',
-                          lambda: open_session(graph),
+                          lambda: _open_session(graph),
                           QtGui.QKeySequence.Open)
     file_menu.add_command('Save...',
-                          lambda: save_session(graph),
+                          lambda: _save_session(graph),
                           QtGui.QKeySequence.Save)
     file_menu.add_command('Save As...',
-                          lambda: save_session_as(graph),
+                          lambda: _save_session_as(graph),
                           'Ctrl+Shift+s')
-    file_menu.add_command('Clear', lambda: clear_session(graph))
+    file_menu.add_command('Clear', lambda: _clear_session(graph))
 
     file_menu.add_separator()
 
-    file_menu.add_command('Zoom In', lambda: zoom_in(graph), '=')
-    file_menu.add_command('Zoom Out', lambda: zoom_out(graph), '-')
+    file_menu.add_command('Zoom In', lambda: _zoom_in(graph), '=')
+    file_menu.add_command('Zoom Out', lambda: _zoom_out(graph), '-')
     file_menu.add_command('Reset Zoom', graph.reset_zoom, 'h')
 
-    # Edit menu.
+    # create "Edit" menu.
     undo_actn = graph.undo_stack().createUndoAction(graph.viewer(), '&Undo')
     if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):
         undo_actn.setShortcutVisibleInContextMenu(True)
@@ -48,7 +49,7 @@ def setup_context_menu(graph):
     edit_menu.qmenu.addAction(redo_actn)
 
     edit_menu.add_separator()
-    edit_menu.add_command('Clear Undo History', lambda: clear_undo(graph))
+    edit_menu.add_command('Clear Undo History', lambda: _clear_undo(graph))
     edit_menu.add_separator()
 
     edit_menu.add_command('Copy', graph.copy_nodes, QtGui.QKeySequence.Copy)
@@ -78,7 +79,7 @@ def setup_context_menu(graph):
 # --- menu command functions. ---
 
 
-def zoom_in(graph):
+def _zoom_in(graph):
     """
     Set the node graph to zoom in by 0.1
 
@@ -89,7 +90,7 @@ def zoom_in(graph):
     graph.set_zoom(zoom)
 
 
-def zoom_out(graph):
+def _zoom_out(graph):
     """
     Set the node graph to zoom in by 0.1
 
@@ -100,7 +101,7 @@ def zoom_out(graph):
     graph.set_zoom(zoom)
 
 
-def open_session(graph):
+def _open_session(graph):
     """
     Prompts a file open dialog to load a session.
 
@@ -114,7 +115,7 @@ def open_session(graph):
         graph.load_session(file_path)
 
 
-def save_session(graph):
+def _save_session(graph):
     """
     Prompts a file save dialog to serialize a session if required.
 
@@ -128,10 +129,10 @@ def save_session(graph):
         viewer = graph.viewer()
         viewer.message_dialog(msg, title='Session Saved')
     else:
-        save_session_as(graph)
+        _save_session_as(graph)
 
 
-def save_session_as(graph):
+def _save_session_as(graph):
     """
     Prompts a file save dialog to serialize a session.
 
@@ -145,7 +146,7 @@ def save_session_as(graph):
         graph.save_session(file_path)
 
 
-def clear_session(graph):
+def _clear_session(graph):
     """
     Prompts a warning dialog to clear the node graph session.
 
@@ -157,7 +158,7 @@ def clear_session(graph):
         graph.clear_session()
 
 
-def clear_undo(graph):
+def _clear_undo(graph):
     """
     Prompts a warning dialog to clear undo.
 

NodeGraphQt/base/graph.py

@@ -24,7 +24,7 @@ class NodeGraph(QtCore.QObject):
     base node graph controller.
 
     Args:
-        default_actions(bool): true to initialize with default context menu actions.
+        tab_search_key(str): hotkey for the tab search widget (default: "tab").
     """
 
     #: signal for when a node has been created in the node graph.
@@ -36,14 +36,19 @@ class NodeGraph(QtCore.QObject):
     #: signal for when drop data has been added to the graph.
     data_dropped = QtCore.Signal(QtCore.QMimeData, QtCore.QPoint)
 
-    def __init__(self, parent=None, default_actions=True):
+    def __init__(self, parent=None, tab_search_key='tab'):
         super(NodeGraph, self).__init__(parent)
         self.setObjectName('NodeGraphQt')
         self._model = NodeGraphModel()
         self._viewer = NodeViewer()
         self._vendor = NodeVendor()
         self._undo_stack = QUndoStack(self)
-        self._init_actions(default_actions)
+
+        tab = QAction('Search Nodes', self)
+        tab.setShortcut(tab_search_key)
+        tab.triggered.connect(self._toggle_tab_search)
+        self._viewer.addAction(tab)
+
         self._wire_signals()
 
     def _wire_signals(self):
@@ -56,17 +61,6 @@ def _wire_signals(self):
         self._viewer.node_selected.connect(self._on_node_selected)
         self._viewer.data_dropped.connect(self._on_node_data_dropped)
 
-    def _init_actions(self, default_actions=False):
-        # setup tab search shortcut.
-        tab = QAction('Search Nodes', self)
-        tab.setShortcut('tab')
-        tab.triggered.connect(self._toggle_tab_search)
-        self._viewer.addAction(tab)
-
-        # setup default context menu.
-        if default_actions:
-            setup_context_menu(self)
-
     def _toggle_tab_search(self):
         """
         toggle the tab search widget.
@@ -88,11 +82,10 @@ def _on_node_selected(self, node_id):
     def _on_node_data_dropped(self, data, pos):
         """
         called when data has been dropped on the viewer.
-        (emits the node type and the x,y position where the data was dropped)
 
         Args:
             data (QtCore.QMimeData): mime data.
-            pos (QtCore.QPoint): x, y scene position relative to the cursor.
+            pos (QtCore.QPoint): scene position relative to the drop.
         """
         self.data_dropped.emit(data, pos)
 
@@ -204,7 +197,7 @@ def undo_stack(self):
     def clear_undo_stack(self):
         """
         Clears the undo stack.
-        (convenience function to :meth:`NodeGraph.undo_stact().clear`)
+        (convenience function to :meth:`NodeGraph.undo_stack().clear`)
         """
         self._undo_stack.clear()
 

NodeGraphQt/base/menu.py

@@ -104,7 +104,7 @@ def add_command(self, name, func=None, shortcut=None):
             shortcut (str): shotcut key.
 
         Returns:
-
+            NodeGraphQt.ContextMenuCommand: the appended command.
         """
         action = QtWidgets.QAction(name, self.__viewer)
         if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):

NodeGraphQt/constants.py

@@ -44,7 +44,7 @@
 #: The draw border color for selected nodes.
 NODE_SEL_BORDER_COLOR = (254, 207, 42, 255)
 
-# === NODE PROPERTY WIDGET TYPES ===
+# === NODE PROPERTY TYPES ===
 
 #: Property type will hidden in the properties bin (default).
 NODE_PROP = 0
@@ -63,15 +63,15 @@
 #: Property type represented with a Slider widget in the properties bin.
 NODE_PROP_SLIDER = 7
 
-# === NODE GRAPH VIEWER DEFAULTS ===
+# === NODE VIEWER DEFAULTS ===
 
 #: Node graph background color.
 VIEWER_BG_COLOR = (35, 35, 35)
-#: Node graph grid color.
 VIEWER_GRID_COLOR = (45, 45, 45)
-#: Node graph grid enabled.
 VIEWER_GRID_OVERLAY = True
 
+SCENE_AREA = 8000.0
+
 # === GRAPH PATHS ===
 
 BASE_PATH = os.path.dirname(os.path.abspath(__file__))