node tree widget clean up and doc strings.

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -42,8 +42,8 @@
 
 __all__ = [
     'BackdropNode', 'BaseNode', 'Menu', 'MenuCommand', 'NodeGraph',
-    'NodeObject', 'Port', 'PropertiesBinWidget', 'constants',
-    'setup_context_menu'
+    'NodeObject', 'NodeTreeWidget', 'Port', 'PropertiesBinWidget',
+    'constants', 'setup_context_menu'
 ]
 
 try:
@@ -63,4 +63,5 @@
 from .base.actions import setup_context_menu
 
 # widgets
+from .widgets.node_tree import NodeTreeWidget
 from .widgets.properties_bin import PropertiesBinWidget

NodeGraphQt/base/graph.py

@@ -15,7 +15,6 @@
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
 from NodeGraphQt.constants import DRAG_DROP_ID
-from NodeGraphQt.widgets.node_tree import NodeTreeWidget
 from NodeGraphQt.widgets.viewer import NodeViewer
 
 
@@ -45,8 +44,6 @@ def __init__(self, parent=None):
         self._node_factory = NodeFactory()
         self._undo_stack = QtWidgets.QUndoStack(self)
 
-        self._nodes_tree = None
-
         tab = QtWidgets.QAction('Search Nodes', self)
         tab.setShortcut('tab')
         tab.triggered.connect(self._toggle_tab_search)
@@ -231,26 +228,63 @@ def scene(self):
         """
         return self._viewer.scene()
 
-    def add_properties_bin(self, prop_bin):
+    def background_color(self):
         """
-        Wire up a properties bin widget to the node graph.
+        Return the node graph background color.
+
+        Returns:
+            tuple: r, g ,b
+        """
+        return self.scene().background_color
+
+    def set_background_color(self, r, g, b):
+        """
+        Set node graph background color.
 
         Args:
-            prop_bin (NodeGraphQt.PropertiesBinWidget): properties widget.
+            r (int): red value.
+            g (int): green value.
+            b (int): blue value.
         """
-        prop_bin.property_changed.connect(self._on_property_bin_changed)
+        self.scene().background_color = (r, g, b)
 
-    def nodes_tree(self):
+    def grid_color(self):
         """
-        Initializes the nodes list widget when first called.
+        Return the node graph grid color.
 
         Returns:
-            NodeTreeWidget: the initialized widget.
+            tuple: r, g ,b
+        """
+        return self.scene().grid_color
+
+    def set_grid_color(self, r, g, b):
+        """
+        Set node graph grid color.
+
+        Args:
+            r (int): red value.
+            g (int): green value.
+            b (int): blue value.
         """
-        if self._nodes_tree is None:
-            self._nodes_tree = NodeTreeWidget()
-            self._nodes_tree.set_node_factory(self._node_factory)
-        return self._nodes_tree
+        self.scene().grid_color = (r, g, b)
+
+    def display_grid(self, display=True):
+        """
+        Display node graph background grid.
+
+        Args:
+            display: False to not draw the background grid.
+        """
+        self.scene().grid = display
+
+    def add_properties_bin(self, prop_bin):
+        """
+        Wire up a properties bin widget to the node graph.
+
+        Args:
+            prop_bin (NodeGraphQt.PropertiesBinWidget): properties widget.
+        """
+        prop_bin.property_changed.connect(self._on_property_bin_changed)
 
     def undo_stack(self):
         """
@@ -303,12 +337,12 @@ def acyclic(self):
         """
         return self._model.acyclic
 
-    def set_acyclic(self, mode=True):
+    def set_acyclic(self, mode=False):
         """
-        Set the node graph to be acyclic or not. (default=True)
+        Enable the node graph to be a acyclic graph. (default=False)
 
         Args:
-            mode (bool): false to disable acyclic.
+            mode (bool): true to enable acyclic.
         """
         self._model.acyclic = mode
         self._viewer.acyclic = mode

NodeGraphQt/base/node.py

@@ -91,16 +91,16 @@ def view(self):
         Returns the :class:`QtWidgets.QGraphicsItem` used in the scene.
 
         Returns:
-            AbstractNodeItem: node item.
+            NodeGraphQt.qgraphics.node_abstract.AbstractNodeItem: node item.
         """
         return self._view
 
     def set_view(self, item):
         """
-        Sets the graphic item to use for the scene.
+        Sets the qgraphics item to use for the scene.
 
         Args:
-            item (AbstractNodeItem): node view item.
+            item (NodeGraphQt.qgraphics.node_abstract.AbstractNodeItem): node item.
         """
         self._view = item
         self._view.id = self.model.id
@@ -109,14 +109,20 @@ def set_view(self, item):
     @property
     def model(self):
         """
-        Returns the node model.
+        Return the node model.
 
         Returns:
-            NodeModel: node model object.
+            NodeGraphQt.base.model.NodeModel: node model object.
         """
         return self._model
 
     def set_model(self, model):
+        """
+        Set the node model.
+
+        Args:
+            model (NodeGraphQt.base.model.NodeModel): node model object.
+        """
         self._model = model
         self._model.type_ = self.type_
         self._model.id = self.view.id

NodeGraphQt/base/port.py

@@ -28,7 +28,7 @@ def view(self):
         returns the :class:`QtWidgets.QGraphicsItem` used in the scene.
 
         Returns:
-            PortItem: port item.
+            NodeGraphQt.qgraphics.port.PortItem: port item.
         """
         return self.__view
 
@@ -38,7 +38,7 @@ def model(self):
         returns the port model.
 
         Returns:
-            PortModel: port model.
+            NodeGraphQt.base.model.PortModel: port model.
         """
         return self.__model
 

NodeGraphQt/constants.py

@@ -60,7 +60,6 @@
 
 # === NODE VIEWER ===
 
-#: Node graph background color.
 VIEWER_BG_COLOR = (35, 35, 35)
 VIEWER_GRID_COLOR = (45, 45, 45)
 VIEWER_GRID_OVERLAY = True

NodeGraphQt/widgets/node_tree.py

@@ -15,13 +15,21 @@ def __eq__(self, other):
 
 
 class NodeTreeWidget(QtWidgets.QTreeWidget):
+    """
+    Node tree for displaying node types.
 
-    def __init__(self, parent=None):
+    Args:
+        parent (QtWidgets.QWidget): parent of the new widget.
+        node_graph (NodeGraphQt.NodeGraph): node graph.
+    """
+
+    def __init__(self, parent=None, node_graph=None):
         super(NodeTreeWidget, self).__init__(parent)
         self.setDragDropMode(QtWidgets.QAbstractItemView.DragOnly)
         self.setHeaderHidden(True)
         self._factory = None
         self._custom_labels = {}
+        self._set_node_factory(node_graph._node_factory)
 
     def __repr__(self):
         return '<{} object at {}>'.format(self.__class__.__name__, hex(id(self)))
@@ -66,7 +74,7 @@ def _build_tree(self):
 
             category_item.addChild(item)
 
-    def set_node_factory(self, factory):
+    def _set_node_factory(self, factory):
         """
         Set current node factory.
 
@@ -87,6 +95,6 @@ def set_category_label(self, category, label):
 
     def update(self):
         """
-        Update and refresh the node list widget.
+        Update and refresh the node tree widget.
         """
         self._build_tree()

NodeGraphQt/widgets/properties_bin.py

@@ -54,7 +54,7 @@ class PropertiesBinWidget(QtWidgets.QWidget):
     Node properties bin for displaying properties.
 
     Args:
-        parent (QtWidgets.QWidget): parent object.
+        parent (QtWidgets.QWidget): parent of the new widget.
         node_graph (NodeGraphQt.NodeGraph): node graph.
     """
 

docs/classes.rst

@@ -10,4 +10,5 @@ Classes
 
     graph
     nodes
-    connections
+    connections
+    menu

docs/index.rst

@@ -17,6 +17,3 @@ Contents
     constants
     classes
     widgets
-    menu
-
-

docs/widgets.rst

@@ -13,6 +13,7 @@ PropertiesBinWidget
 
     from NodeGraphQt import NodeGraph, PropertiesBinWidget
 
+    # create node graph.
     graph = NodeGraph()
 
     # create properties bin widget.
@@ -34,12 +35,13 @@ NodeTreeWidget
 .. code-block:: python
     :linenos:
 
-    from NodeGraphQt import NodeGraph
+    from NodeGraphQt import NodeGraph, NodeTreeWidget
 
+    # create node graph.
     graph = NodeGraph()
 
     # create node tree widget.
-    nodes_tree = graph.nodes_tree()
+    nodes_tree = NodeTreeWidget(node_graph=graph)
     nodes_tree.show()
 
 ----