minior updates.

Author: jchanvfx

NodeGraphQt/base/menu_setup.py renamed to NodeGraphQt/base/actions.py

@@ -79,16 +79,34 @@ def setup_context_menu(graph):
 
 
 def zoom_in(graph):
+    """
+    Set the node graph to zoom in by 0.1
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     zoom = graph.get_zoom() + 0.1
     graph.set_zoom(zoom)
 
 
 def zoom_out(graph):
+    """
+    Set the node graph to zoom in by 0.1
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     zoom = graph.get_zoom() - 0.2
     graph.set_zoom(zoom)
 
 
 def open_session(graph):
+    """
+    Prompts a file open dialog to load a session.
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     current = graph.current_session()
     viewer = graph.viewer()
     file_path = viewer.load_dialog(current)
@@ -97,6 +115,12 @@ def open_session(graph):
 
 
 def save_session(graph):
+    """
+    Prompts a file save dialog to serialize a session if required.
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     current = graph.current_session()
     if current:
         graph.save_session(current)
@@ -108,6 +132,12 @@ def save_session(graph):
 
 
 def save_session_as(graph):
+    """
+    Prompts a file save dialog to serialize a session.
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     current = graph.current_session()
     viewer = graph.viewer()
     file_path = viewer.save_dialog(current)
@@ -116,12 +146,24 @@ def save_session_as(graph):
 
 
 def clear_session(graph):
+    """
+    Prompts a warning dialog to clear the node graph session.
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     viewer = graph.viewer()
     if viewer.question_dialog('Clear Current Session?', 'Clear Session'):
         graph.clear_session()
 
 
 def clear_undo(graph):
+    """
+    Prompts a warning dialog to clear undo.
+
+    Args:
+        graph (NodeGraphQt.NodeGraph): node graph.
+    """
     viewer = graph.viewer()
     msg = 'Clear all undo history, Are you sure?'
     if viewer.question_dialog('Clear Undo History', msg):

NodeGraphQt/base/graph.py

@@ -6,12 +6,12 @@
 from PySide2 import QtCore
 from PySide2.QtWidgets import QUndoStack, QAction, QApplication
 
+from NodeGraphQt.base.actions import setup_context_menu
 from NodeGraphQt.base.commands import (NodeAddedCmd,
                                        NodeRemovedCmd,
                                        NodeMovedCmd,
                                        PortConnectedCmd)
 from NodeGraphQt.base.menu import ContextMenu
-from NodeGraphQt.base.menu_setup import setup_context_menu
 from NodeGraphQt.base.model import NodeGraphModel
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
@@ -22,6 +22,9 @@
 class NodeGraph(QtCore.QObject):
     """
     base node graph controller.
+
+    Args:
+        default_actions(bool): true to initialize with default context menu actions.
     """
 
     #: signal for when a node has been created in the node graph.
@@ -33,14 +36,14 @@ class NodeGraph(QtCore.QObject):
     #: signal for when drop data has been added to the graph.
     data_dropped = QtCore.Signal(str, tuple)
 
-    def __init__(self, parent=None):
+    def __init__(self, parent=None, default_actions=True):
         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()
+        self._init_actions(default_actions)
         self._wire_signals()
 
     def _wire_signals(self):
@@ -53,15 +56,16 @@ 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):
+    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.
-        setup_context_menu(self)
+        if default_actions:
+            setup_context_menu(self)
 
     def _toggle_tab_search(self):
         """
@@ -197,6 +201,13 @@ def undo_stack(self):
         """
         return self._undo_stack
 
+    def clear_undo_stack(self):
+        """
+        Clears the undo stack.
+        (convenience function to :meth:`NodeGraph.undo_stact().clear`)
+        """
+        self._undo_stack.clear()
+
     def begin_undo(self, name='undo'):
         """
         Start of an undo block followed by a

docs/nodes.rst

@@ -7,12 +7,15 @@ NodeGraphQt.NodeObject
 
 **Inherited by:** :ref:`NodeGraphQt.Node`, :ref:`NodeGraphQt.Backdrop`
 
+----
+
+
+Attributes
 .. autoattribute:: NodeGraphQt.NodeObject.__identifier__
 .. autoattribute:: NodeGraphQt.NodeObject.NODE_NAME
 
-----
-
 
+Class
 .. autoclass:: NodeGraphQt.NodeObject
     :members:
     :exclude-members: model, NODE_NAME

docs/overview.rst

@@ -6,8 +6,8 @@ NodeGraphQt is a node graph framework that can be implemented and repurposed int
 .. image:: _images/overview.png
     :width: 60%
 
-Navigation
-==========
+Nav Controls
+============
 
 +---------------+----------------------------------------------+
 | action        | controls                                     |
@@ -17,24 +17,26 @@ Navigation
 | Pan           | *Alt + LMB + Drag* or *MMB + Drag*           |
 +---------------+----------------------------------------------+
 
-Node Search
-===========
+Tab Search
+==========
 
 .. image:: _images/node_search.png
     :width: 269px
 
-Node can be created with the tab node search popup menu similar to Nuke.
+Node can be created with the tab node search widget.
 
 +-------------+--------+
 | action      | hotkey |
 +=============+========+
 | Show Search | *Tab*  |
 +-------------+--------+
 
-Hotkeys
-=======
+Context Menu
+============
+
+By default the NodeGraph is has a default context menu with some actions.
+
 
-The node graph comes built with some default action with assigned hotkeys.
 
 see: :ref:`Menus`