minor bug fix and doc clean up

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -25,28 +25,29 @@ class NodeGraph(QtCore.QObject):
     base node graph controller.
     """
 
-    #: signal emits the node object when a node is created in the node graph.
+    #: (signal) emits the node object when a node is created in the node graph.
     node_created = QtCore.Signal(NodeObject)
-    #: signal emits a list of node ids from the deleted nodes.
+    #: (signal) emits a list of node ids from the deleted nodes.
     nodes_deleted = QtCore.Signal(list)
-    #: signal emits the node object when selected in the node graph.
+    #: (signal) emits the node object when selected in the node graph.
     node_selected = QtCore.Signal(NodeObject)
-    #: signal triggered when a node is double clicked and emits the node.
+    #: (signal) triggered when a node is double clicked and emits the node.
     node_double_clicked = QtCore.Signal(NodeObject)
-    #: signal for when a node has been connected emits (source port, target port).
+    #: (signal) for when a node has been connected emits (source port, target port).
     port_connected = QtCore.Signal(Port, Port)
-    #: signal for when a node has been disconnected emits (source port, target port).
+    #: (signal) for when a node has been disconnected emits (source port, target port).
     port_disconnected = QtCore.Signal(Port, Port)
-    #: signal for when a node property has changed emits (node, property name, property value).
+    #: (signal) for when a node property has changed emits (node, property name, property value).
     property_changed = QtCore.Signal(NodeObject, str, object)
-    #: signal for when drop data has been added to the graph.
+    #: (signal) for when drop data has been added to the graph.
     data_dropped = QtCore.Signal(QtCore.QMimeData, QtCore.QPoint)
 
     def __init__(self, parent=None):
         super(NodeGraph, self).__init__(parent)
         self.setObjectName('NodeGraphQt')
+        self._widget = None
         self._model = NodeGraphModel()
-        self._viewer = NodeViewer(parent)
+        self._viewer = NodeViewer()
         self._node_factory = NodeFactory()
         self._undo_stack = QtWidgets.QUndoStack(self)
 
@@ -223,23 +224,42 @@ def model(self):
         """
         return self._model
 
+    @property
+    def widget(self):
+        """
+        Return the node graph widget.
+
+        Returns:
+            QtWidgets.QWidget: node graph widget.
+        """
+        if self._widget is None:
+            self._widget = QtWidgets.QWidget()
+            layout = QtWidgets.QVBoxLayout(self._widget)
+            layout.setContentsMargins(0, 0, 0, 0)
+            layout.addWidget(self._viewer)
+        return self._widget
+
     def show(self):
         """
-        Show node graph viewer widget this is just a convenience
-        function to :meth:`NodeGraph.viewer().show()`.
+        Show node graph widget this is just a convenience
+        function to :meth:`NodeGraph.widget.show()`.
         """
-        self._viewer.show()
+        self._widget.show()
 
     def close(self):
         """
         Close node graph NodeViewer widget this is just a convenience
-        function to :meth:`NodeGraph.viewer().close()`.
+        function to :meth:`NodeGraph.widget.close()`.
         """
-        self._viewer.close()
+        self._widget.close()
 
     def viewer(self):
         """
-        Return the node graph viewer widget.
+        Returns the view interface used by the node graph.
+
+        Note:
+            All functions in the `NodeViewer` should only be used internally
+            by the `NodeGraph` class.
 
         Returns:
             NodeGraphQt.widgets.viewer.NodeViewer: viewer widget.

NodeGraphQt/widgets/viewer.py

@@ -22,9 +22,9 @@
 
 class NodeViewer(QtWidgets.QGraphicsView):
     """
-    node viewer is the widget used for displaying the scene and nodes
+    The widget interface used for displaying the scene and nodes.
 
-    functions in this class is used internally by the
+    functions in this class are called by the
     class:`NodeGraphQt.NodeGraph` class.
     """
 
@@ -40,8 +40,6 @@ class NodeViewer(QtWidgets.QGraphicsView):
 
     def __init__(self, parent=None):
         super(NodeViewer, self).__init__(parent)
-        if parent is not None:
-            self.setWindowFlags(QtCore.Qt.Window)
 
         scene_pos = (SCENE_AREA / 2) * -1
         self.setScene(NodeScene(self))
@@ -51,7 +49,7 @@ def __init__(self, parent=None):
         self.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff)
         self.setViewportUpdateMode(QtWidgets.QGraphicsView.FullViewportUpdate)
         self.setAcceptDrops(True)
-        self.resize(1000, 800)
+        self.resize(850, 800)
 
         self._pipe_layout = PIPE_LAYOUT_CURVED
         self._detached_port = None

README.md

@@ -82,9 +82,9 @@ if __name__ == '__main__':
     # connect node a input to node b output.
     node_a.set_input(0, node_b.output(0))    
 
-    # show widget.
-    viewer = graph.viewer()
-    viewer.show()
+    # get the widget and show.
+    graph_widget = graph.widget
+    graph_widget.show()
 
     app.exec_()
 ```

docs/graph.rst

@@ -8,8 +8,18 @@ The ``NodeGraph`` class is the main controller for managing all nodes.
 .. image:: _images/graph.png
     :width: 60%
 
-----
+NodeGraph
+=========
+
+NodeGraph Attributes
+--------------------
+
+.. autoattribute:: NodeGraphQt.NodeGraph.widget
+.. autoattribute:: NodeGraphQt.NodeGraph.model
+
+NodeGraph Class
+---------------
 
 .. autoclass:: NodeGraphQt.NodeGraph
     :members:
-    :exclude-members: model
+    :exclude-members: model, widget

docs/nodes.rst

@@ -9,16 +9,24 @@ NodeObject
 
 The ``NodeGraphQt.NodeObject`` class is the main base class that all nodes inherit from.
 
-----
 
-.. autoclass:: NodeGraphQt.NodeObject
-    :members:
-    :exclude-members: model, NODE_NAME
-
-Attributes
+NodeObject Attributes
+---------------------
 
 .. autoattribute:: NodeGraphQt.NodeObject.__identifier__
 .. autoattribute:: NodeGraphQt.NodeObject.NODE_NAME
+.. autoattribute:: NodeGraphQt.NodeObject.graph
+.. autoattribute:: NodeGraphQt.NodeObject.id
+.. autoattribute:: NodeGraphQt.NodeObject.model
+.. autoattribute:: NodeGraphQt.NodeObject.view
+
+
+NodeObject Class
+----------------
+
+.. autoclass:: NodeGraphQt.NodeObject
+    :members:
+    :exclude-members: NODE_NAME, graph, id, model, view
 
 
 BaseNode
@@ -55,7 +63,8 @@ code snippet.
             # create an output port.
             self.add_output('out')
 
-----
+Base Class
+----------
 
 .. autoclass:: NodeGraphQt.BaseNode
     :members:
@@ -72,7 +81,8 @@ The ``NodeGraphQt.BackdropNode`` class allows other node object to be nested ins
 .. image:: _images/backdrop.png
     :width: 250px
 
-----
+BackdropNode Class
+------------------
 
 .. autoclass:: NodeGraphQt.BackdropNode
     :members:

docs/overview.rst

@@ -97,8 +97,8 @@ example code:
         graph.register_node(FooNode)
 
         # show the node graph widget.
-        viewer = graph.viewer()
-        viewer.show()
+        graph_widget = graph.widget
+        graph_widget.show()
 
         # create two nodes.
         node_a = graph.create_node('com.chantasticvfx.FooNode', name='node A')

example.py

@@ -42,10 +42,10 @@ def __init__(self):
     # set up default menu and commands.
     setup_context_menu(graph)
 
-    # viewer widget used for the node graph.
-    viewer = graph.viewer()
-    viewer.resize(1100, 800)
-    viewer.show()
+    # widget used for the node graph.
+    graph_widget = graph.widget
+    graph_widget.resize(1100, 800)
+    graph_widget.show()
 
 
     # show the properties bin when a node is "double clicked" in the graph.
@@ -117,5 +117,4 @@ def show_nodes_list(node):
     menu_node.set_input(0, bar_node.output(1))
     bar_node.set_input(0, text_node.output(0))
 
-
     app.exec_()