Adds freeze and unfreeze functionality (#507)

* include freeze and unfreeze tools to nodeeditor

* add frozen dynamic to node delegate model

* create freeze and unfreeze menu

* add freeze and unfreeze logic to freeze menu

* structure to sync delegatemodel and connectionstate

* sync delegatemodel and connectionstate, as well as freeze example creation

* refactor freeze code and remove comments

* fix build errors in mac-os

* fix build errors in mac-os

* fix cross os build error

* add frozen menu flag

* remove example implementation code

* remove unnecessary changes

---------

Co-authored-by: Taiguara Tupinambás <tatatupi@gmail.com>
Co-authored-by: Gabrielnmds <gabrielnmds21@gmail.com>

Author: 3 people

examples/calculator/MathOperationDataModel.cpp

@@ -1,5 +1,4 @@
 #include "MathOperationDataModel.hpp"
-
 #include "DecimalData.hpp"
 
 unsigned int MathOperationDataModel::nPorts(PortType portType) const

include/QtNodes/internal/BasicGraphicsScene.hpp

@@ -7,9 +7,10 @@
 #include "Export.hpp"
 #include "GroupGraphicsObject.hpp"
 #include "NodeGroup.hpp"
+#include "QUuidStdHash.hpp"
 #include "UndoCommands.hpp"
-
 #include <QtCore/QJsonObject>
+#include <QtCore/QUuid>
 #include <QtWidgets/QGraphicsScene>
 #include <QtWidgets/QMenu>
 
@@ -34,7 +35,7 @@ class NodeGroup;
 class GroupGraphicsObject;
 struct ConnectionId;
 
-/// An instance of QGraphicsScene, holds connections and nodes.
+/// An instance of QGraphicsScene , holds connections and nodes.
 class NODE_EDITOR_PUBLIC BasicGraphicsScene : public QGraphicsScene
 {
     Q_OBJECT
@@ -205,6 +206,12 @@ class NODE_EDITOR_PUBLIC BasicGraphicsScene : public QGraphicsScene
      */
     virtual QMenu *createSceneMenu(QPointF const scenePos);
 
+    /**
+     * @brief Freezes and unfreezes the model and connections of the selected nodes.
+     * @param isFreeze reference for freezing or unfreezing the model and connections of the selected nodes.
+     */
+    void freezeModelAndConnections(bool isFreeze);
+
     /**
      * @brief Creates the default menu when a node is selected.
      */

include/QtNodes/internal/ConnectionState.hpp

@@ -25,6 +25,7 @@ class NODE_EDITOR_PUBLIC ConnectionState
     ConnectionState(ConnectionGraphicsObject &cgo)
         : _cgo(cgo)
         , _hovered(false)
+        , _frozen(false)
     {}
 
     ConnectionState(ConnectionState const &) = delete;
@@ -42,6 +43,9 @@ class NODE_EDITOR_PUBLIC ConnectionState
     bool hovered() const;
     void setHovered(bool hovered);
 
+    bool frozen() const { return _frozen; }
+    void setFrozen(bool frozen) { _frozen = frozen; }
+
 public:
     /// Caches NodeId for further interaction.
     void setLastHoveredNode(NodeId const nodeId);
@@ -56,5 +60,7 @@ class NODE_EDITOR_PUBLIC ConnectionState
     bool _hovered;
 
     NodeId _lastHoveredNode{InvalidNodeId};
+
+    bool _frozen;
 };
 } // namespace QtNodes

include/QtNodes/internal/DataFlowGraphicsScene.hpp

@@ -1,8 +1,10 @@
 #pragma once
 
 #include "BasicGraphicsScene.hpp"
+#include "ConnectionGraphicsObject.hpp"
 #include "DataFlowGraphModel.hpp"
 #include "Export.hpp"
+#include "NodeConnectionInteraction.hpp"
 
 namespace QtNodes {
 
@@ -22,6 +24,7 @@ class NODE_EDITOR_PUBLIC DataFlowGraphicsScene : public BasicGraphicsScene
 public:
     std::vector<NodeId> selectedNodes() const;
     QMenu *createSceneMenu(QPointF const scenePos) override;
+    void updateConnectionGraphics(const std::unordered_set<ConnectionId> &connections, bool state);
 
 public Q_SLOTS:
     bool save() const;

include/QtNodes/internal/NodeDelegateModel.hpp

@@ -12,6 +12,7 @@
 #include "NodeData.hpp"
 #include "NodeStyle.hpp"
 #include "Serializable.hpp"
+#include <QtGui/QColor>
 
 namespace QtNodes {
 
@@ -133,6 +134,10 @@ class NODE_EDITOR_PUBLIC NodeDelegateModel
 
     virtual bool resizable() const { return false; }
 
+    bool frozen() const { return _frozen; }
+
+    void setFrozenState(bool state) { _frozen = state; }
+
 public Q_SLOTS:
     virtual void inputConnectionCreated(ConnectionId const &) {}
     virtual void inputConnectionDeleted(ConnectionId const &) {}
@@ -186,6 +191,8 @@ public Q_SLOTS:
 private:
     NodeStyle _nodeStyle;
 
+    bool _frozen{false};
+
     NodeValidationState _nodeValidationState;
 
     NodeProcessingStatus _processingStatus{NodeProcessingStatus::NoStatus};

src/BasicGraphicsScene.cpp

@@ -3,11 +3,13 @@
 #include "AbstractNodeGeometry.hpp"
 #include "ConnectionGraphicsObject.hpp"
 #include "ConnectionIdUtils.hpp"
+#include "DataFlowGraphModel.hpp"
 #include "DefaultConnectionPainter.hpp"
 #include "DefaultHorizontalNodeGeometry.hpp"
 #include "DefaultNodePainter.hpp"
 #include "DefaultVerticalNodeGeometry.hpp"
 #include "GraphicsView.hpp"
+#include "NodeDelegateModel.hpp"
 #include "NodeGraphicsObject.hpp"
 
 #include <QUndoStack>
@@ -425,6 +427,33 @@ void BasicGraphicsScene::onModelReset()
     traverseGraphAndPopulateGraphicsObjects();
 }
 
+void BasicGraphicsScene::freezeModelAndConnections(bool isFreeze)
+{
+    for (QGraphicsItem *item : selectedItems()) {
+        if (auto n = qgraphicsitem_cast<NodeGraphicsObject *>(item)) {
+            int portCount = graphModel().nodeData(n->nodeId(), NodeRole::OutPortCount).toInt();
+            for (int i = 0; i < portCount; i++) {
+                auto graphConnections = graphModel().connections(n->nodeId(),
+                                                                 QtNodes::PortType::Out,
+                                                                 QtNodes::PortIndex(i));
+
+                for (auto const &c : graphConnections) {
+                    if (auto *cgo = connectionGraphicsObject(c)) {
+                        cgo->connectionState().setFrozen(isFreeze);
+                        cgo->update();
+                    }
+                }
+            }
+
+            if (auto *dfModel = dynamic_cast<DataFlowGraphModel *>(&graphModel())) {
+                if (auto *delegate = dfModel->delegateModel<NodeDelegateModel>(n->nodeId())) {
+                    delegate->setFrozenState(isFreeze);
+                }
+            }
+        }
+    }
+}
+
 std::weak_ptr<NodeGroup> BasicGraphicsScene::createGroup(std::vector<NodeGraphicsObject *> &nodes,
                                                          QString groupName,
                                                          GroupId groupId)

src/DataFlowGraphModel.cpp

@@ -444,6 +444,9 @@ bool DataFlowGraphModel::setPortData(
     switch (role) {
     case PortRole::Data:
         if (portType == PortType::In) {
+            if (model->frozen())
+                return false;
+
             model->setInData(value.value<std::shared_ptr<NodeData>>(), portIndex);
 
             // Triggers repainting on the scene.

src/DataFlowGraphicsScene.cpp

@@ -294,4 +294,15 @@ bool DataFlowGraphicsScene::load()
     return true;
 }
 
+void DataFlowGraphicsScene::updateConnectionGraphics(
+    const std::unordered_set<ConnectionId> &connections, bool state)
+{
+    for (auto const &c : connections) {
+        if (auto *cgo = connectionGraphicsObject(c)) {
+            cgo->connectionState().setFrozen(state);
+            cgo->update();
+        }
+    }
+}
+
 } // namespace QtNodes

src/DefaultConnectionPainter.cpp

@@ -9,7 +9,6 @@
 
 #include <QtGui/QIcon>
 
-
 namespace QtNodes {
 
 QPainterPath DefaultConnectionPainter::cubicPath(ConnectionGraphicsObject const &connection) const
@@ -27,11 +26,12 @@ QPainterPath DefaultConnectionPainter::cubicPath(ConnectionGraphicsObject const
     return cubic;
 }
 
-void DefaultConnectionPainter::drawSketchLine(QPainter *painter, ConnectionGraphicsObject const &cgo) const
+void DefaultConnectionPainter::drawSketchLine(QPainter *painter,
+                                              ConnectionGraphicsObject const &cgo) const
 {
     ConnectionState const &state = cgo.connectionState();
 
-    if (state.requiresPort()) {
+    if (state.requiresPort() || state.frozen()) {
         auto const &connectionStyle = QtNodes::StyleCollection::connectionStyle();
 
         QPen pen;
@@ -49,7 +49,8 @@ void DefaultConnectionPainter::drawSketchLine(QPainter *painter, ConnectionGraph
     }
 }
 
-void DefaultConnectionPainter::drawHoveredOrSelected(QPainter *painter, ConnectionGraphicsObject const &cgo) const
+void DefaultConnectionPainter::drawHoveredOrSelected(QPainter *painter,
+                                                     ConnectionGraphicsObject const &cgo) const
 {
     bool const hovered = cgo.connectionState().hovered();
     bool const selected = cgo.isSelected();
@@ -74,11 +75,12 @@ void DefaultConnectionPainter::drawHoveredOrSelected(QPainter *painter, Connecti
     }
 }
 
-void DefaultConnectionPainter::drawNormalLine(QPainter *painter, ConnectionGraphicsObject const &cgo) const
+void DefaultConnectionPainter::drawNormalLine(QPainter *painter,
+                                              ConnectionGraphicsObject const &cgo) const
 {
     ConnectionState const &state = cgo.connectionState();
 
-    if (state.requiresPort())
+    if (state.requiresPort() || state.frozen())
         return;
 
     // colors
@@ -132,6 +134,7 @@ void DefaultConnectionPainter::drawNormalLine(QPainter *painter, ConnectionGraph
         painter->setBrush(Qt::NoBrush);
 
         QColor cOut = normalColorOut;
+
         if (selected)
             cOut = cOut.darker(200);
         p.setColor(cOut);
@@ -200,7 +203,8 @@ void DefaultConnectionPainter::paint(QPainter *painter, ConnectionGraphicsObject
     painter->drawEllipse(cgo.in(), pointRadius, pointRadius);
 }
 
-QPainterPath DefaultConnectionPainter::getPainterStroke(ConnectionGraphicsObject const &connection) const
+QPainterPath DefaultConnectionPainter::getPainterStroke(
+    ConnectionGraphicsObject const &connection) const
 {
     auto cubic = cubicPath(connection);
 

src/GraphicsView.cpp

@@ -5,6 +5,7 @@
 #include "DataFlowGraphModel.hpp"
 #include "Definitions.hpp"
 #include "GroupGraphicsObject.hpp"
+#include "NodeDelegateModel.hpp"
 #include "NodeGraphicsObject.hpp"
 #include "StyleCollection.hpp"
 #include "UndoCommands.hpp"
@@ -28,6 +29,7 @@
 using QtNodes::BasicGraphicsScene;
 using QtNodes::DataFlowGraphModel;
 using QtNodes::GraphicsView;
+using QtNodes::NodeDelegateModel;
 using QtNodes::NodeGraphicsObject;
 
 GraphicsView::GraphicsView(QWidget *parent)