emit port connection signals from undo #373

Author: jchanvfx

NodeGraphQt/base/commands.py

@@ -276,12 +276,14 @@ class PortConnectedCmd(QtWidgets.QUndoCommand):
     Args:
         src_port (NodeGraphQt.Port): source port.
         trg_port (NodeGraphQt.Port): target port.
+        emit_signal (bool): emit port connection signals.
     """
 
-    def __init__(self, src_port, trg_port):
+    def __init__(self, src_port, trg_port, emit_signal):
         QtWidgets.QUndoCommand.__init__(self)
         self.source = src_port
         self.target = trg_port
+        self.emit_signal = emit_signal
 
     def undo(self):
         src_model = self.source.model
@@ -303,6 +305,13 @@ def undo(self):
 
         self.source.view.disconnect_from(self.target.view)
 
+        # emit "port_disconnected" signal from the parent graph.
+        if self.emit_signal:
+            ports = {p.type_(): p for p in [self.source, self.target]}
+            graph = self.source.node().graph
+            graph.port_disconnected.emit(ports[PortTypeEnum.IN.value],
+                                         ports[PortTypeEnum.OUT.value])
+
     def redo(self):
         src_model = self.source.model
         trg_model = self.target.model
@@ -314,6 +323,13 @@ def redo(self):
 
         self.source.view.connect_to(self.target.view)
 
+        # emit "port_connected" signal from the parent graph.
+        if self.emit_signal:
+            ports = {p.type_(): p for p in [self.source, self.target]}
+            graph = self.source.node().graph
+            graph.port_connected.emit(ports[PortTypeEnum.IN.value],
+                                      ports[PortTypeEnum.OUT.value])
+
 
 class PortDisconnectedCmd(QtWidgets.QUndoCommand):
     """
@@ -322,12 +338,14 @@ class PortDisconnectedCmd(QtWidgets.QUndoCommand):
     Args:
         src_port (NodeGraphQt.Port): source port.
         trg_port (NodeGraphQt.Port): target port.
+        emit_signal (bool): emit port connection signals.
     """
 
-    def __init__(self, src_port, trg_port):
+    def __init__(self, src_port, trg_port, emit_signal):
         QtWidgets.QUndoCommand.__init__(self)
         self.source = src_port
         self.target = trg_port
+        self.emit_signal = emit_signal
 
     def undo(self):
         src_model = self.source.model
@@ -340,6 +358,13 @@ def undo(self):
 
         self.source.view.connect_to(self.target.view)
 
+        # emit "port_connected" signal from the parent graph.
+        if self.emit_signal:
+            ports = {p.type_(): p for p in [self.source, self.target]}
+            graph = self.source.node().graph
+            graph.port_connected.emit(ports[PortTypeEnum.IN.value],
+                                      ports[PortTypeEnum.OUT.value])
+
     def redo(self):
         src_model = self.source.model
         trg_model = self.target.model
@@ -360,6 +385,13 @@ def redo(self):
 
         self.source.view.disconnect_from(self.target.view)
 
+        # emit "port_disconnected" signal from the parent graph.
+        if self.emit_signal:
+            ports = {p.type_(): p for p in [self.source, self.target]}
+            graph = self.source.node().graph
+            graph.port_disconnected.emit(ports[PortTypeEnum.IN.value],
+                                         ports[PortTypeEnum.OUT.value])
+
 
 class PortLockedCmd(QtWidgets.QUndoCommand):
     """

NodeGraphQt/base/port.py

@@ -210,14 +210,15 @@ def connected_ports(self):
                     ports.append(node.inputs()[port_name])
         return ports
 
-    def connect_to(self, port=None, push_undo=True):
+    def connect_to(self, port=None, push_undo=True, emit_signal=True):
         """
         Create connection to the specified port and emits the
         :attr:`NodeGraph.port_connected` signal from the parent node graph.
 
         Args:
             port (NodeGraphQt.Port): port object.
             push_undo (bool): register the command to the undo stack. (default: True)
+            emit_signal (bool): emit the port connection signals. (default: True)
         """
         if not port:
             return
@@ -274,64 +275,69 @@ def connect_to(self, port=None, push_undo=True):
         if not port:
             if pre_conn_port:
                 if push_undo:
-                    undo_stack.push(PortDisconnectedCmd(self, port))
+                    undo_stack.push(
+                        PortDisconnectedCmd(self, port, emit_signal)
+                    )
                     undo_stack.push(NodeInputDisconnectedCmd(self, port))
                     undo_stack.endMacro()
                 else:
-                    PortDisconnectedCmd(self, port).redo()
+                    PortDisconnectedCmd(self, port, emit_signal).redo()
                     NodeInputDisconnectedCmd(self, port).redo()
             return
 
         if graph.acyclic() and viewer.acyclic_check(self.view, port.view):
             if pre_conn_port:
                 if push_undo:
-                    undo_stack.push(PortDisconnectedCmd(self, pre_conn_port))
+                    undo_stack.push(
+                        PortDisconnectedCmd(self, pre_conn_port, emit_signal)
+                    )
                     undo_stack.push(NodeInputDisconnectedCmd(
-                        self, pre_conn_port))
+                        self, pre_conn_port)
+                    )
                     undo_stack.endMacro()
                 else:
-                    PortDisconnectedCmd(self, pre_conn_port).redo()
+                    PortDisconnectedCmd(self, pre_conn_port, emit_signal).redo()
                     NodeInputDisconnectedCmd(self, pre_conn_port).redo()
                 return
 
         trg_conn_ports = port.connected_ports()
         if not port.multi_connection() and trg_conn_ports:
             dettached_port = trg_conn_ports[0]
             if push_undo:
-                undo_stack.push(PortDisconnectedCmd(port, dettached_port))
+                undo_stack.push(
+                    PortDisconnectedCmd(port, dettached_port, emit_signal)
+                )
                 undo_stack.push(NodeInputDisconnectedCmd(port, dettached_port))
             else:
-                PortDisconnectedCmd(port, dettached_port).redo()
+                PortDisconnectedCmd(port, dettached_port, emit_signal).redo()
                 NodeInputDisconnectedCmd(port, dettached_port).redo()
         if pre_conn_port:
             if push_undo:
-                undo_stack.push(PortDisconnectedCmd(self, pre_conn_port))
+                undo_stack.push(
+                    PortDisconnectedCmd(self, pre_conn_port, emit_signal)
+                )
                 undo_stack.push(NodeInputDisconnectedCmd(self, pre_conn_port))
             else:
-                PortDisconnectedCmd(self, pre_conn_port).redo()
+                PortDisconnectedCmd(self, pre_conn_port, emit_signal).redo()
                 NodeInputDisconnectedCmd(self, pre_conn_port).redo()
 
         if push_undo:
-            undo_stack.push(PortConnectedCmd(self, port))
+            undo_stack.push(PortConnectedCmd(self, port, emit_signal))
             undo_stack.push(NodeInputConnectedCmd(self, port))
             undo_stack.endMacro()
         else:
-            PortConnectedCmd(self, port).redo()
+            PortConnectedCmd(self, port, emit_signal).redo()
             NodeInputConnectedCmd(self, port).redo()
 
-        # emit "port_connected" signal from the parent graph.
-        ports = {p.type_(): p for p in [self, port]}
-        graph.port_connected.emit(ports[PortTypeEnum.IN.value],
-                                  ports[PortTypeEnum.OUT.value])
-
-    def disconnect_from(self, port=None, push_undo=True):
+    def disconnect_from(self, port=None, push_undo=True, emit_signal=True):
         """
         Disconnect from the specified port and emits the
         :attr:`NodeGraph.port_disconnected` signal from the parent node graph.
 
         Args:
             port (NodeGraphQt.Port): port object.
             push_undo (bool): register the command to the undo stack. (default: True)
+            emit_signal (bool): emit the port connection signals. (default: True)
         """
         if not port:
             return
@@ -344,19 +350,14 @@ def disconnect_from(self, port=None, push_undo=True):
         graph = self.node().graph
         if push_undo:
             graph.undo_stack().beginMacro('disconnect port')
-            graph.undo_stack().push(PortDisconnectedCmd(self, port))
+            graph.undo_stack().push(PortDisconnectedCmd(self, port, emit_signal))
             graph.undo_stack().push(NodeInputDisconnectedCmd(self, port))
             graph.undo_stack().endMacro()
         else:
-            PortDisconnectedCmd(self, port).redo()
+            PortDisconnectedCmd(self, port, emit_signal).redo()
             NodeInputDisconnectedCmd(self, port).redo()
 
-        # emit "port_disconnected" signal from the parent graph.
-        ports = {p.type_(): p for p in [self, port]}
-        graph.port_disconnected.emit(ports[PortTypeEnum.IN.value],
-                                     ports[PortTypeEnum.OUT.value])
-
-    def clear_connections(self, push_undo=True):
+    def clear_connections(self, push_undo=True, emit_signal=True):
         """
         Disconnect from all port connections and emit the
         :attr:`NodeGraph.port_disconnected` signals from the node graph.
@@ -368,6 +369,7 @@ def clear_connections(self, push_undo=True):
 
         Args:
             push_undo (bool): register the command to the undo stack. (default: True)
+            emit_signal (bool): emit the port connection signals. (default: True)
         """
         if self.locked():
             err = 'Can\'t clear connections because port "{}" is locked.'
@@ -381,17 +383,20 @@ def clear_connections(self, push_undo=True):
             undo_stack = graph.undo_stack()
             undo_stack.beginMacro('"{}" clear connections')
             for cp in self.connected_ports():
-                self.disconnect_from(cp)
+                self.disconnect_from(cp, emit_signal=emit_signal)
             undo_stack.endMacro()
-        else:
-            for cp in self.connected_ports():
-                self.disconnect_from(cp, push_undo=False)
+            return
+
+        for cp in self.connected_ports():
+            self.disconnect_from(
+                cp, push_undo=False, emit_signal=emit_signal
+            )
 
     def add_accept_port_type(self, port_name, port_type, node_type):
         """
-        Add a constrain to "accept" a pipe connection.
+        Add a constraint to "accept" a pipe connection.
 
-        Once a constrain has been added only ports of that type specified will
+        Once a constraint has been added only ports of that type specified will
         be allowed a pipe connection.
 
         `Implemented in` ``v0.6.0``
@@ -406,7 +411,7 @@ def add_accept_port_type(self, port_name, port_type, node_type):
             node_type (str): port node type.
         """
         # storing the connection constrain at the graph level instead of the
-        # port level so we don't serialize the same data for every port
+        # port level, so we don't serialize the same data for every port
         # instance.
         self.node().add_accept_port_type(
             port=self,
@@ -432,9 +437,9 @@ def accepted_port_types(self):
 
     def add_reject_port_type(self, port_name, port_type, node_type):
         """
-        Add a constrain to "reject" a pipe connection.
+        Add a constraint to "reject" a pipe connection.
 
-        Once a constrain has been added only ports of that type specified will
+        Once a constraint has been added only ports of that type specified will
         be rejected a pipe connection.
 
         `Implemented in` ``v0.6.0``