add node graph editable property

Author: ArnoChenFx

NodeGraphQt/base/graph.py

@@ -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')
@@ -747,6 +756,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 +824,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 +863,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()
+        else:
+            self._editable = True
+        self._viewer.scene().set_editable(self._editable)
 
     def get_node_space(self):
         """
@@ -867,6 +884,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 +906,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')
@@ -1082,9 +1103,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 +1151,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():
@@ -1325,6 +1346,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 +1369,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 +1397,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/qgraphics/node_base.py

@@ -301,7 +301,7 @@ def calc_size(self, add_w=0.0, add_h=0.0):
             add_h (float): additional height.
         """
         width = 0
-        height = 0
+        height = self.text_item.boundingRect().height()
 
         if self._widgets:
             wid_width = max([

NodeGraphQt/qgraphics/text_item.py

@@ -1,4 +1,4 @@
-from PySide2 import QtWidgets, QtGui, QtCore
+from .. import QtWidgets, QtGui, QtCore
 
 
 class text_item(QtWidgets.QGraphicsTextItem):
@@ -7,7 +7,7 @@ class text_item(QtWidgets.QGraphicsTextItem):
     def __init__(self, text, parent=None):
         super(text_item, self).__init__(text, parent)
         self.setFlags(QtWidgets.QGraphicsItem.ItemIsFocusable)
-        self.setTextInteractionFlags(QtGui.Qt.NoTextInteraction)
+        self.setTextInteractionFlags(QtCore.Qt.NoTextInteraction)
         self.isEditing = False
 
     def _editingFinished(self):
@@ -17,7 +17,7 @@ def _editingFinished(self):
             self.editingFinished.emit(self.toPlainText())
 
     def mousePressEvent(self, event):
-        self.setTextInteractionFlags(QtGui.Qt.TextEditable)
+        self.setTextInteractionFlags(QtCore.Qt.TextEditable)
         self.isEditing = True
         super(text_item, self).mousePressEvent(event)
 

NodeGraphQt/widgets/scene.py

@@ -16,13 +16,25 @@ def __init__(self, parent=None):
         self.background_color = VIEWER_BG_COLOR
         self.grid_color = VIEWER_GRID_COLOR
         self._grid_mode = VIEWER_GRID_LINES
+        self._editable = True
         self.setBackgroundBrush(self._bg_qcolor)
 
     def __repr__(self):
         return '{}.{}(\'{}\')'.format(self.__module__,
                                       self.__class__.__name__,
                                       self.viewer())
 
+    def set_editable(self, state):
+        self._editable = state
+
+    def _draw_text(self, painter):
+        font = QtGui.QFont()
+        font.setPixelSize(48)
+        painter.setFont(font)
+        parent = self.viewer()
+        pos = QtCore.QPoint(20, parent.height()-20)
+        painter.drawText(parent.mapToScene(pos), 'Not Editable')
+
     def _draw_grid(self, painter, rect, pen, grid_size):
         left = int(rect.left())
         right = int(rect.right())
@@ -54,9 +66,7 @@ def _draw_dots(self, painter, rect, pen, grid_size):
         pen.setWidth(grid_size / 10)
         painter.setPen(pen)
 
-        for x in range(first_left, right, grid_size):
-            for y in range(first_top, bottom, grid_size):
-                painter.drawPoint(int(x), int(y))
+        [painter.drawPoint(int(x), int(y)) for x in range(first_left, right, grid_size) for y in range(first_top, bottom, grid_size)]
 
     def drawBackground(self, painter, rect):
         super(NodeScene, self).drawBackground(painter, rect)
@@ -81,6 +91,8 @@ def drawBackground(self, painter, rect):
             pen = QtGui.QPen(color, 0.65)
             self._draw_grid(painter, rect, pen, VIEWER_GRID_SIZE * 8)
 
+        if not self._editable:
+            self._draw_text(painter)
         painter.restore()
 
     def mousePressEvent(self, event):

example_auto_nodes.py

@@ -66,6 +66,10 @@ def enter_node(graph, node):
     graph.set_node_space(node)
 
 
+def allow_edit(graph, node):
+    node.set_property('published', False)
+
+
 def print_path(graph, node):
     print(node.path())
 
@@ -125,6 +129,7 @@ def show_nodes_list(node):
 
     # setup node menu
     node_menu = graph.context_nodes_menu()
+    node_menu.add_command('Allow Edit', allow_edit, node_class=Publish)
     node_menu.add_command('Enter Node', enter_node, node_class=SubGraphNode)
     node_menu.add_command('Publish Node', publish_node, node_class=SubGraphNode)
     node_menu.add_command('Print Children', print_children, node_class=SubGraphNode)

example_auto_nodes/node_base/subgraph_node.py

@@ -16,6 +16,7 @@ def __init__(self, defaultInputType=None, defaultOutputType=None, dynamic_port=T
         self.sub_graph_input_nodes = []
         self.sub_graph_output_nodes = []
         self.create_property('graph_rect', None)
+        self.create_property('published', False)
         if dynamic_port:
             self.model.dynamic_port = True
             self.add_int_input('input count', 'input count', 0)
@@ -37,6 +38,19 @@ def mark_node_to_be_cooked(self, port):
         if port not in self._marked_ports and port in self.input_ports():
             self._marked_ports.append(port)
 
+    def is_editable(self):
+        """
+        Returns whether the node is allowed edit.
+        """
+
+        parent = self.parent()
+        if parent is None:
+            return not self.get_property('published')
+
+        if not self.get_property('published') and self.parent().is_editable():
+            return True
+        return False
+
     def enter(self):
         """
         Action when enter the sub graph.
@@ -330,6 +344,7 @@ def publish(self, file_path, node_name, node_identifier, node_class_name):
             data['node']['name'] = node_name
             data['node']['class_name'] = node_class_name.replace(" ", "_")
             data['node'].pop('type_')
+            data['node']['custom']['published'] = True
             file_path = file_path.strip()
             with open(file_path, 'w') as file_out:
                 json.dump(data, file_out, indent=2, separators=(',', ':'))

example_auto_nodes/subgraph_nodes.py

@@ -86,7 +86,7 @@ class Publish(SubGraph):
     def __init__(self, defaultInputType=None, defaultOutputType=None):
         super(Publish, self).__init__(defaultInputType, defaultOutputType, dynamic_port=False)
         self.set_property('color', (36, 97, 100, 255))
-        self.create_property('published', True)
+        self.set_property('published', True)
         self.created = False
 
     def set_graph(self, graph):
@@ -100,7 +100,7 @@ def create_from_file(self):
         Update node properties and create sub graph nodes by published node file.
         """
 
-        if self.NODE_FILE is None:
+        if self.NODE_FILE is None or not self.get_property('published'):
             return
         data = read_json(self.NODE_FILE)
         if not data:
@@ -125,7 +125,9 @@ def create_from_file(self):
         [node.set_parent(self) for node in children]
 
     def publish(self, file_path, node_name, node_identifier, node_class_name):
-        return
+        if self.get_property('published'):
+            return
+        super(Publish, self).publish(file_path, node_name, node_identifier, node_class_name)
 
     @staticmethod
     def create_node_class(file_path):