Merge pull request #164 from ArnoChenFx/master

Node text item editable && nodegraph eidtable feature && garbage collect && Vertical Layout

Author: jchanvfx

NodeGraphQt/base/commands.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 from .. import QtWidgets
-
 from ..constants import IN_PORT, OUT_PORT
+from .utils import minimize_node_ref_count
 
 
 class PropertyChangedCmd(QtWidgets.QUndoCommand):
@@ -158,10 +158,10 @@ def __init__(self, graph, node):
         self.node_parent = node.parent()
 
         if hasattr(self.node, 'inputs'):
-            input_ports = self.node.inputs().values()
+            input_ports = self.node.input_ports()
             self.inputs = [(p, p.connected_ports()) for p in input_ports]
         if hasattr(self.node, 'outputs'):
-            output_ports = self.node.outputs().values()
+            output_ports = self.node.output_ports()
             self.outputs = [(p, p.connected_ports()) for p in output_ports]
 
     def undo(self):
@@ -177,6 +177,9 @@ def redo(self):
         self.model.nodes.pop(self.node.id)
         self.node.delete()
 
+    def __del__(self):
+        minimize_node_ref_count(self.node)
+
 
 class NodeInputConnectedCmd(QtWidgets.QUndoCommand):
     """

NodeGraphQt/base/graph.py

@@ -4,7 +4,7 @@
 import os
 import re
 import copy
-
+import gc
 from .. import QtCore, QtWidgets, QtGui
 from .commands import (NodeAddedCmd,
                        NodeRemovedCmd,
@@ -142,6 +142,7 @@ def __init__(self, parent=None):
         self._node_factory = NodeFactory()
         self._undo_stack = QtWidgets.QUndoStack(self)
         self._current_node_space = None
+        self._editable = True
 
         tab = QtWidgets.QShortcut(QtGui.QKeySequence(QtCore.Qt.Key_Tab), self._viewer)
         tab.activated.connect(self._toggle_tab_search)
@@ -176,6 +177,8 @@ def _insert_node(self, pipe, node_id, prev_node_pos):
             node_id (str): selected node id to insert.
             prev_node_pos (dict): previous node position. {NodeItem: [prev_x, prev_y]}
         """
+        if not self._editable:
+            return
         node = self.get_node_by_id(node_id)
 
         # exclude the BackdropNode
@@ -203,6 +206,8 @@ def _toggle_tab_search(self):
         """
         toggle the tab search widget.
         """
+        if not self._editable:
+            return
         if self._viewer.underMouse():
             self._viewer.tab_search_set_nodes(self._node_factory.names)
             self._viewer.tab_search_toggle()
@@ -217,6 +222,8 @@ def _on_property_bin_changed(self, node_id, prop_name, prop_value):
             prop_name (str): node property name.
             prop_value (object): python object.
         """
+        if not self._editable:
+            return
         node = self.get_node_by_id(node_id)
 
         # prevent signals from causing a infinite loop.
@@ -307,6 +314,8 @@ def _on_connection_changed(self, disconnected, connected):
             connected (list[list[widgets.port.PortItem]]):
                 pair list of port view items.
         """
+        if not self._editable:
+            return
         if not (disconnected or connected):
             return
 
@@ -336,7 +345,7 @@ def _on_connection_sliced(self, ports):
             ports (list[list[widgets.port.PortItem]]):
                 pair list of port connections (in port, out port)
         """
-        if not ports:
+        if not ports or not self._editable:
             return
         ptypes = {IN_PORT: 'inputs', OUT_PORT: 'outputs'}
         self._undo_stack.beginMacro('slice connections')
@@ -385,6 +394,25 @@ def auto_update(self):
         """
         return self._auto_update
 
+    @property
+    def editable(self):
+        """
+        Returns whether the graph is editable.
+        """
+        return self._editable
+
+    @editable.setter
+    def editable(self, state):
+        """
+        Set whether the graph is editable.
+
+        Args:
+            state(bool).
+        """
+        self._editable = state
+        self._viewer.editable = state
+        self._viewer.scene().editable = state
+
     def show(self):
         """
         Show node graph widget this is just a convenience
@@ -513,6 +541,7 @@ def clear_undo_stack(self):
             :meth:`NodeGraph.undo_stack()`
         """
         self._undo_stack.clear()
+        gc.collect()
 
     def begin_undo(self, name):
         """
@@ -747,6 +776,8 @@ def create_node(self, node_type, name=None, selected=True, color=None,
         Returns:
             NodeGraphQt.BaseNode: the created instance of the node.
         """
+        if not self._editable:
+            return
         NodeCls = self._node_factory.create_node_instance(node_type)
         if NodeCls:
             node = NodeCls()
@@ -813,6 +844,8 @@ def add_node(self, node, pos=None, unique_name=True):
             pos (list[float]): node x,y position. (optional)
             unique_name (bool): make node name unique
         """
+        if not self._editable:
+            return
         assert isinstance(node, NodeObject), 'node must be a Node instance.'
 
         wid_types = node.model.__dict__.pop('_TEMP_property_widget_types')
@@ -850,6 +883,10 @@ def set_node_space(self, node):
         if node is not None:
             node.enter()
             self._node_space_bar.set_node(node)
+            self.editable = node.is_editable()
+            [n.set_editable(self.editable) for n in node.children() if isinstance(n, BaseNode)]
+        else:
+            self.editable = True
 
     def get_node_space(self):
         """
@@ -867,6 +904,8 @@ def delete_node(self, node):
         Args:
             node (NodeGraphQt.BaseNode): node object.
         """
+        if not self._editable:
+            return
         assert isinstance(node, NodeObject), \
             'node must be a instance of a NodeObject.'
         if node is self.root_node():
@@ -887,6 +926,8 @@ def delete_nodes(self, nodes):
         Args:
             nodes (list[NodeGraphQt.BaseNode]): list of node instances.
         """
+        if not self._editable:
+            return
         root_node = self.root_node()
         self.nodes_deleted.emit([n.id for n in nodes])
         self._undo_stack.beginMacro('delete nodes')
@@ -1056,7 +1097,7 @@ def clear_session(self):
                 continue
             self._undo_stack.push(NodeRemovedCmd(self, n))
         self.set_node_space(root_node)
-        self._undo_stack.clear()
+        self.clear_undo_stack()
         self._model.session = None
         self.session_changed.emit("")
 
@@ -1082,9 +1123,7 @@ def _serialize(self, nodes):
             node_dict = n.model.to_dict
 
             if isinstance(n, SubGraph):
-                published = n.has_property('published')
-                if published:
-                    published = n.get_property('published')
+                published = n.get_property('published')
                 if not published:
                     children = n.children()
                     if children:
@@ -1132,6 +1171,8 @@ def _deserialize(self, data, relative_pos=False, pos=None, set_parent=True):
         Returns:
             list[NodeGraphQt.Nodes]: list of node instances.
         """
+        if not self._editable:
+            return
         nodes = {}
         # build the nodes.
         for n_id, n_data in data.get('nodes', {}).items():
@@ -1148,18 +1189,18 @@ def _deserialize(self, data, relative_pos=False, pos=None, set_parent=True):
                 for prop, val in n_data.get('custom', {}).items():
                     node.model.set_property(prop, val)
                 nodes[n_id] = node
-                self.add_node(node, n_data.get('pos'), unique_name=set_parent)
-                node.set_disabled(n_data.get('disabled', False))
+
                 if isinstance(node, SubGraph):
-                    if n_data.get('custom', None):
-                        published = n_data['custom'].get('published', False)
-                    else:
-                        published = False
+                    node.create_by_deserialize = True
+                    self.add_node(node, n_data.get('pos'), unique_name=set_parent)
+                    published = n_data['custom'].get('published', False)
                     if not published:
                         sub_graph = n_data.get('sub_graph', None)
                         if sub_graph:
                             children = self._deserialize(sub_graph, relative_pos, pos, False)
                             [child.set_parent(node) for child in children]
+                else:
+                    self.add_node(node, n_data.get('pos'), unique_name=set_parent)
 
                 if n_data.get('dynamic_port', None):
                     node.set_ports({'input_ports': n_data['input_ports'], 'output_ports': n_data['output_ports']})
@@ -1212,7 +1253,7 @@ def deserialize_session(self, layout_data):
         """
         self.clear_session()
         self._deserialize(layout_data)
-        self._undo_stack.clear()
+        self.clear_undo_stack()
 
     def save_session(self, file_path):
         """
@@ -1287,7 +1328,7 @@ def import_session(self, file_path):
             self.set_grid_mode(layout_data['graph'].get('grid_mode', VIEWER_GRID_LINES))
 
         self.set_node_space(self.root_node())
-        self._undo_stack.clear()
+        self.clear_undo_stack()
         self._model.session = file_path
         self.session_changed.emit(file_path)
         self._auto_update = _temp_auto_update
@@ -1325,6 +1366,8 @@ def paste_nodes(self):
         """
         Pastes nodes copied from the clipboard.
         """
+        if not self._editable:
+            return
         clipboard = QtWidgets.QApplication.clipboard()
         cb_text = clipboard.text()
         if not cb_text:
@@ -1346,7 +1389,7 @@ def duplicate_nodes(self, nodes):
         Returns:
             list[NodeGraphQt.BaseNode]: list of duplicated node instances.
         """
-        if not nodes:
+        if not nodes or not self._editable:
             return
 
         self._undo_stack.beginMacro('duplicate nodes')
@@ -1374,7 +1417,7 @@ def disable_nodes(self, nodes, mode=None):
             nodes (list[NodeGraphQt.BaseNode]): list of node instances.
             mode (bool): (optional) disable state of the nodes.
         """
-        if not nodes:
+        if not nodes or not self._editable:
             return
         if mode is None:
             mode = not nodes[0].disabled()

NodeGraphQt/base/node.py

@@ -10,10 +10,13 @@
                          NODE_PROP_FILE,
                          NODE_PROP_FLOAT,
                          NODE_PROP_INT,
-                         IN_PORT, OUT_PORT)
+                         IN_PORT, OUT_PORT,
+                         NODE_LAYOUT_VERTICAL,
+                         NODE_LAYOUT_HORIZONTAL,
+                         NODE_LAYOUT_DIRECTION)
 from ..errors import PortRegistrationError
 from ..qgraphics.node_backdrop import BackdropNodeItem
-from ..qgraphics.node_base import NodeItem
+from ..qgraphics.node_base import NodeItem, NodeItemVertical
 from ..widgets.node_widgets import (NodeComboBox,
                                     NodeLineEdit,
                                     NodeFloatEdit,
@@ -325,6 +328,8 @@ def set_property(self, name, value):
             pass
 
         if self.graph and name == 'name':
+            if len(value) == 0:
+                value = '_'
             value = self.graph.get_unique_name(value)
             self.NODE_NAME = value
 
@@ -457,7 +462,7 @@ def delete(self):
         self._view.delete()
         if self._parent is not None:
             self._parent.remove_child(self)
-        # self.set_parent(None)
+            self._parent = None
 
     def hide(self):
         """
@@ -512,10 +517,16 @@ def __init__(self):
     NODE_NAME = 'Base Node'
 
     def __init__(self):
-        super(BaseNode, self).__init__(NodeItem())
+        view = None
+        if NODE_LAYOUT_DIRECTION is NODE_LAYOUT_VERTICAL:
+            view = NodeItemVertical()
+        elif NODE_LAYOUT_DIRECTION is NODE_LAYOUT_HORIZONTAL:
+            view = NodeItem()
+        super(BaseNode, self).__init__(view)
         self._inputs = []
         self._outputs = []
         self._has_draw = False
+        self._view.text_item.editingFinished.connect(self.set_name)
 
     def draw(self, force=True):
         if force:
@@ -878,7 +889,7 @@ def delete_input(self, port):
         self._inputs.remove(port)
         self._model.inputs.pop(port.name())
         self._view.delete_input(port.view)
-        del port
+        port.model.node = None
         self.draw()
 
     def delete_output(self, port):
@@ -895,7 +906,7 @@ def delete_output(self, port):
         self._outputs.remove(port)
         self._model.outputs.pop(port.name())
         self._view.delete_output(port.view)
-        del port
+        port.model.node = None
         self.draw()
 
     def set_ports(self, port_data):
@@ -906,8 +917,12 @@ def set_ports(self, port_data):
             port_data(dict): {'input_ports':[{'name':...,'multi_connection':...,'display_name':...,'data_type':...}, ...],
             "                 'output_ports':[{'name':...,'multi_connection':...,'display_name':...,'data_type':...}, ...]}
         """
-        [self._view.delete_input(port.view) for port in self._inputs]
-        [self._view.delete_output(port.view) for port in self._outputs]
+        for port in self._inputs:
+            self._view.delete_input(port.view)
+            port.model.node = None
+        for port in self._outputs:
+            self._view.delete_output(port.view)
+            port.model.node = None
         self._inputs = []
         self._outputs = []
         self._model.outputs = {}
@@ -1079,6 +1094,16 @@ def when_disabled(self):
         """
         return
 
+    def set_editable(self, state):
+        """
+        Returns whether the node view widgets is editable.
+
+        Args:
+            state(bool).
+        """
+        [wid.setEnabled(state) for wid in self.view._widgets.values()]
+        self.view.text_item.setEnabled(state)
+
 
 class BackdropNode(NodeObject):
     """