fix undesired changes

Author: g-abilio

external/CMakeLists.txt

@@ -1,5 +1,5 @@
 if(BUILD_TESTING)
-  find_package(Catch2 2.13.7 QUIET)
+  find_package(Catch2 QUIET)
 
   if(NOT Catch2_FOUND)
     add_subdirectory(Catch2)

include/QtNodes/internal/ConnectionGraphicsObject.hpp

@@ -2,6 +2,7 @@
 
 #include <utility>
 
+#include <QtCore/QUuid>
 #include <QtWidgets/QGraphicsObject>
 
 #include "ConnectionState.hpp"

include/QtNodes/internal/ConnectionState.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+#include <QtCore/QUuid>
+
 #include "Export.hpp"
 
 #include "Definitions.hpp"

include/QtNodes/internal/DefaultNodePainter.hpp

@@ -32,6 +32,8 @@ class NODE_EDITOR_PUBLIC DefaultNodePainter : public AbstractNodePainter
 
     void drawResizeRect(QPainter *painter, NodeGraphicsObject &ngo) const;
 
+    void drawProcessingIndicator(QPainter *painter, NodeGraphicsObject &ngo) const;
+
     void drawValidationIcon(QPainter *painter, NodeGraphicsObject &ngo) const;
 
 private:

include/QtNodes/internal/Definitions.hpp

@@ -22,17 +22,18 @@ Q_NAMESPACE_EXPORT(NODE_EDITOR_PUBLIC)
  * Constants used for fetching QVariant data from GraphModel.
  */
     enum class NodeRole {
-        Type = 0,            ///< Type of the current node, usually a string.
-        Position = 1,        ///< `QPointF` positon of the node on the scene.
-        Size = 2,            ///< `QSize` for resizable nodes.
-        CaptionVisible = 3,  ///< `bool` for caption visibility.
-        Caption = 4,         ///< `QString` for node caption.
-        Style = 5,           ///< Custom NodeStyle as QJsonDocument
-        InternalData = 6,    ///< Node-stecific user data as QJsonObject
-        InPortCount = 7,     ///< `unsigned int`
-        OutPortCount = 9,    ///< `unsigned int`
-        Widget = 10,         ///< Optional `QWidget*` or `nullptr`
-        ValidationState = 11 ///< Enum NodeValidationState of the node
+        Type = 0,             ///< Type of the current node, usually a string.
+        Position = 1,         ///< `QPointF` positon of the node on the scene.
+        Size = 2,             ///< `QSize` for resizable nodes.
+        CaptionVisible = 3,   ///< `bool` for caption visibility.
+        Caption = 4,          ///< `QString` for node caption.
+        Style = 5,            ///< Custom NodeStyle as QJsonDocument
+        InternalData = 6,     ///< Node-stecific user data as QJsonObject
+        InPortCount = 7,      ///< `unsigned int`
+        OutPortCount = 9,     ///< `unsigned int`
+        Widget = 10,          ///< Optional `QWidget*` or `nullptr`
+        ValidationState = 11, ///< Enum NodeValidationState of the node
+        ProcessingStatus = 12 ///< Enum NodeProcessingStatus of the node
     };
 Q_ENUM_NS(NodeRole)
 

include/QtNodes/internal/NodeDelegateModel.hpp

@@ -3,6 +3,8 @@
 #include <memory>
 
 #include <QMetaType>
+#include <QPixmap>
+#include <QtGui/QColor>
 #include <QtWidgets/QWidget>
 
 #include "Definitions.hpp"
@@ -31,6 +33,19 @@ struct NodeValidationState
     QString _stateMessage{""};
 };
 
+/**
+* Describes the node status, depending on its current situation
+*/
+enum class NodeProcessingStatus : int {
+    NoStatus = 0,   ///< No processing status is shown in the Node UI.
+    Updated = 1,    ///< Node is up to date; its outputs reflect the current inputs and parameters.
+    Processing = 2, ///< Node is currently running a computation.
+    Pending = 3,    ///< Node is out of date and waiting to be recomputed (e.g. manual/queued run).
+    Empty = 4,      ///< Node has no valid input data; nothing to compute.
+    Failed = 5,     ///< The last computation ended with an error.
+    Partial = 6,    ///< Computation finished incompletely; only partial results are available.
+};
+
 class StyleCollection;
 
 /**
@@ -68,11 +83,16 @@ class NODE_EDITOR_PUBLIC NodeDelegateModel
     /// Validation State will default to Valid, but you can manipulate it by overriding in an inherited class
     virtual NodeValidationState validationState() const { return _nodeValidationState; }
 
+    /// Returns the curent processing status
+    virtual NodeProcessingStatus processingStatus() const { return _processingStatus; }
+
     QJsonObject save() const override;
 
     void load(QJsonObject const &) override;
 
-    void setValidatonState(const NodeValidationState &validationState);
+    void setNodeProcessingStatus(NodeProcessingStatus status);
+
+    void setValidationState(const NodeValidationState &validationState);
 
 public:
     virtual unsigned int nPorts(PortType portType) const = 0;
@@ -85,6 +105,16 @@ class NODE_EDITOR_PUBLIC NodeDelegateModel
 
     void setNodeStyle(NodeStyle const &style);
 
+    /// Convenience helper to change the node background color.
+    void setBackgroundColor(QColor const &color);
+
+    QPixmap processingStatusIcon() const;
+
+    void setStatusIcon(NodeProcessingStatus status, const QPixmap &pixmap);
+
+    void setStatusIconStyle(ProcessingIconStyle const &style);
+
+public:
     virtual void setInData(std::shared_ptr<NodeData> nodeData, PortIndex const portIndex) = 0;
 
     virtual std::shared_ptr<NodeData> outData(PortIndex const port) = 0;
@@ -121,6 +151,16 @@ public Q_SLOTS:
 
     void embeddedWidgetSizeUpdated();
 
+    /// Request an update of the node's UI.
+    /**
+     * Emit this signal whenever some internal state change requires
+     * the node to be repainted. The containing graph model will
+     * propagate the update to the scene.
+     */
+    void requestNodeUpdate();
+
+    /// Call this function before deleting the data associated with ports.
+
     /**
      * @brief Call this function before deleting the data associated with ports.
      * The function notifies the Graph Model and makes it remove and recompute the
@@ -147,8 +187,11 @@ public Q_SLOTS:
     NodeStyle _nodeStyle;
 
     NodeValidationState _nodeValidationState;
+
+    NodeProcessingStatus _processingStatus{NodeProcessingStatus::NoStatus};
 };
 
 } // namespace QtNodes
 
 Q_DECLARE_METATYPE(QtNodes::NodeValidationState)
+Q_DECLARE_METATYPE(QtNodes::NodeProcessingStatus)

include/QtNodes/internal/NodeGraphicsObject.hpp

@@ -8,6 +8,8 @@
 #include <QtCore/QUuid>
 #include <QtWidgets/QGraphicsObject>
 
+#include "NodeState.hpp"
+
 class QGraphicsProxyWidget;
 
 namespace QtNodes {

include/QtNodes/internal/NodeState.hpp

@@ -5,6 +5,7 @@
 
 #include <QtCore/QPointF>
 #include <QtCore/QPointer>
+#include <QtCore/QUuid>
 
 #include "Definitions.hpp"
 #include "Export.hpp"

include/QtNodes/internal/NodeStyle.hpp

@@ -1,12 +1,32 @@
 #pragma once
 
+#include <QIcon>
 #include <QtGui/QColor>
 
 #include "Export.hpp"
 #include "Style.hpp"
 
 namespace QtNodes {
 
+/**
+    * Describes the position of the processing icon on the node ui
+     */
+enum class ProcessingIconPos {
+    BottomLeft = 0,  /// icon on the bottom left position
+    BottomRight = 1, /// icon on the bottom right position
+};
+
+/**
+ * Defines the processing icon style;
+ */
+struct ProcessingIconStyle
+{
+    ProcessingIconPos _pos{ProcessingIconPos::BottomRight};
+    double _size{20.0};
+    double _margin{8.0};
+    int _resolution{64};
+};
+
 class NODE_EDITOR_PUBLIC NodeStyle : public Style
 {
 public:
@@ -26,6 +46,12 @@ class NODE_EDITOR_PUBLIC NodeStyle : public Style
 
     QJsonObject toJson() const override;
 
+    /// Set uniform background color for the node.
+    void setBackgroundColor(QColor const &color);
+
+    /// Current uniform background color.
+    QColor backgroundColor() const;
+
 public:
     QColor NormalBoundaryColor;
     QColor SelectedBoundaryColor;
@@ -51,5 +77,14 @@ class NODE_EDITOR_PUBLIC NodeStyle : public Style
     float ConnectionPointDiameter;
 
     float Opacity;
+
+    QIcon statusUpdated{QStringLiteral("://status_icons/updated.svg")};
+    QIcon statusProcessing{QStringLiteral("://status_icons/processing.svg")};
+    QIcon statusPending{QStringLiteral("://status_icons/pending.svg")};
+    QIcon statusInvalid{QStringLiteral("://status_icons/failed.svg")};
+    QIcon statusEmpty{QStringLiteral("://status_icons/empty.svg")};
+    QIcon statusPartial{QStringLiteral("://status_icons/partial.svg")};
+
+    ProcessingIconStyle processingIconStyle{};
 };
 } // namespace QtNodes

resources/resources.qrc

@@ -2,6 +2,12 @@
     <qresource prefix="/">
         <file>DefaultStyle.json</file>
         <file>info-tooltip.svg</file>
+        <file>status_icons/empty.svg</file>
+        <file>status_icons/failed.svg</file>
+        <file>status_icons/partial.svg</file>
+        <file>status_icons/pending.svg</file>
+        <file>status_icons/processing.svg</file>
+        <file>status_icons/updated.svg</file>
         <file>padlock-lock.png</file>
         <file>padlock-unlock.png</file>
     </qresource>