Adds node nickname functionality (#506)

* improves NodeValidationState struct

* qt6 for linux-gcc

* adds node nickname functionality

* Adjust label layout

* improve caption and nickname dynamic

* add editable nickname label

* add correct caption dynamic, as well as labelEdit max size

* fix alignment issues between nickname and node caption

* solves conflict

* revert workflows change

* fix segfault detected in dataflowgraphmodel tests

* produces optional nickname structure and adds example

* fix typo in spacing method and attribute

* uniformizes icon files attributes

* removes commented code

* improves processing status icon resolution

* solves situations where icons should not appear

* adds docstring to each nodeprocessingstatus

* adds possibility to change the node processing status icon style

* moves all status logic to NodeStyle

* removes unnecessary code

* adds declaration of QPixmap

* solve conflicts

* pull new node_processing_status and solve conflicts

* solve minor errors

* remove unnecessary changes

* remove unnecessary changes

* Revert "remove unnecessary changes"

This reverts commit 9a7740a.

* remove unnecessary changes

* increase safety in reading and serialization

* solve build error

---------

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

Author: 3 people

examples/styles/models.hpp

@@ -36,6 +36,8 @@ class MyDataModel : public NodeDelegateModel
 
     QString name() const override { return QString("MyDataModel"); }
 
+    bool labelEditable() const override { return true; }
+
 public:
     QJsonObject save() const override
     {

include/QtNodes/internal/AbstractNodeGeometry.hpp

@@ -36,8 +36,7 @@ class NODE_EDITOR_PUBLIC AbstractNodeGeometry
     /// Port position in node's coordinate system.
     virtual QPointF portPosition(NodeId const nodeId,
                                  PortType const portType,
-                                 PortIndex const index) const
-        = 0;
+                                 PortIndex const index) const = 0;
 
     /// A convenience function using the `portPosition` and a given transformation.
     virtual QPointF portScenePosition(NodeId const nodeId,
@@ -48,8 +47,7 @@ class NODE_EDITOR_PUBLIC AbstractNodeGeometry
     /// Defines where to draw port label. The point corresponds to a font baseline.
     virtual QPointF portTextPosition(NodeId const nodeId,
                                      PortType const portType,
-                                     PortIndex const portIndex) const
-        = 0;
+                                     PortIndex const portIndex) const = 0;
 
     /**
    * Defines where to start drawing the caption. The point corresponds to a font
@@ -60,6 +58,15 @@ class NODE_EDITOR_PUBLIC AbstractNodeGeometry
     /// Caption rect is needed for estimating the total node size.
     virtual QRectF captionRect(NodeId const nodeId) const = 0;
 
+    /**
+   * Defines where to start drawing the label. The point corresponds to a font
+   * baseline.
+   */
+    virtual QPointF labelPosition(NodeId const nodeId) const = 0;
+
+    /// Caption rect is needed for estimating the total node size.
+    virtual QRectF labelRect(NodeId const nodeId) const = 0;
+
     /// Position for an embedded widget. Return any value if you don't embed.
     virtual QPointF widgetPosition(NodeId const nodeId) const = 0;
 
@@ -69,6 +76,8 @@ class NODE_EDITOR_PUBLIC AbstractNodeGeometry
 
     virtual QRect resizeHandleRect(NodeId const nodeId) const = 0;
 
+    virtual int getPortSpacing() = 0;
+
 protected:
     AbstractGraphModel &_graphModel;
 };

include/QtNodes/internal/DataFlowGraphModel.hpp

@@ -11,6 +11,8 @@
 #include <QJsonObject>
 
 #include <memory>
+#include <unordered_map>
+#include <QString>
 
 namespace QtNodes {
 
@@ -137,6 +139,9 @@ private Q_SLOTS:
     std::unordered_set<ConnectionId> _connectivity;
 
     mutable std::unordered_map<NodeId, NodeGeometryData> _nodeGeometryData;
+
+    std::unordered_map<NodeId, QString> _labels;
+    std::unordered_map<NodeId, bool> _labelsVisible;
 };
 
 } // namespace QtNodes

include/QtNodes/internal/DefaultHorizontalNodeGeometry.hpp

@@ -28,14 +28,21 @@ class NODE_EDITOR_PUBLIC DefaultHorizontalNodeGeometry : public AbstractNodeGeom
     QPointF portTextPosition(NodeId const nodeId,
                              PortType const portType,
                              PortIndex const PortIndex) const override;
+
     QPointF captionPosition(NodeId const nodeId) const override;
 
     QRectF captionRect(NodeId const nodeId) const override;
 
+    QPointF labelPosition(const NodeId nodeId) const override;
+
+    QRectF labelRect(NodeId const nodeId) const override;
+
     QPointF widgetPosition(NodeId const nodeId) const override;
 
     QRect resizeHandleRect(NodeId const nodeId) const override;
 
+    int getPortSpacing() override { return _portSpacing; }
+
 private:
     QRectF portTextRect(NodeId const nodeId,
                         PortType const portType,
@@ -52,7 +59,7 @@ class NODE_EDITOR_PUBLIC DefaultHorizontalNodeGeometry : public AbstractNodeGeom
     // constness of the Node.
 
     mutable unsigned int _portSize;
-    unsigned int _portSpasing;
+    unsigned int _portSpacing;
     mutable QFontMetrics _fontMetrics;
     mutable QFontMetrics _boldFontMetrics;
 };

include/QtNodes/internal/DefaultNodePainter.hpp

@@ -1,10 +1,9 @@
 #pragma once
 
-#include <QIcon>
-#include <QtGui/QPainter>
-
 #include "AbstractNodePainter.hpp"
 #include "Definitions.hpp"
+#include <QIcon>
+#include <QtGui/QPainter>
 
 namespace QtNodes {
 
@@ -28,6 +27,8 @@ class NODE_EDITOR_PUBLIC DefaultNodePainter : public AbstractNodePainter
 
     void drawNodeCaption(QPainter *painter, NodeGraphicsObject &ngo) const;
 
+    void drawNodeLabel(QPainter *painter, NodeGraphicsObject &ngo) const;
+
     void drawEntryLabels(QPainter *painter, NodeGraphicsObject &ngo) const;
 
     void drawResizeRect(QPainter *painter, NodeGraphicsObject &ngo) const;

include/QtNodes/internal/DefaultVerticalNodeGeometry.hpp

@@ -33,10 +33,16 @@ class NODE_EDITOR_PUBLIC DefaultVerticalNodeGeometry : public AbstractNodeGeomet
 
     QRectF captionRect(NodeId const nodeId) const override;
 
+    QPointF labelPosition(const NodeId nodeId) const override;
+
+    QRectF labelRect(NodeId const nodeId) const override;
+
     QPointF widgetPosition(NodeId const nodeId) const override;
 
     QRect resizeHandleRect(NodeId const nodeId) const override;
 
+    int getPortSpacing() override { return _portSpacing; }
+
 private:
     QRectF portTextRect(NodeId const nodeId,
                         PortType const portType,
@@ -54,7 +60,7 @@ class NODE_EDITOR_PUBLIC DefaultVerticalNodeGeometry : public AbstractNodeGeomet
     // constness of the Node.
 
     mutable unsigned int _portSize;
-    unsigned int _portSpasing;
+    unsigned int _portSpacing;
     mutable QFontMetrics _fontMetrics;
     mutable QFontMetrics _boldFontMetrics;
 };

include/QtNodes/internal/Definitions.hpp

@@ -19,21 +19,24 @@ Q_NAMESPACE_EXPORT(NODE_EDITOR_PUBLIC)
 #endif
 
     /**
- * Constants used for fetching QVariant data from GraphModel.
- */
+     * 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
-        ProcessingStatus = 12 ///< Enum NodeProcessingStatus 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
+        LabelVisible = 12,     ///< `bool` for label visibility.
+        ProcessingStatus = 13, ///< Enum NodeProcessingStatus of the node
+        Label = 14,            ///< `QString` for node label.
+        LabelEditable = 15,    ///< `bool` to indicate label editing support.
     };
 Q_ENUM_NS(NodeRole)
 

include/QtNodes/internal/GraphicsView.hpp

@@ -2,8 +2,11 @@
 
 #include <QtWidgets/QGraphicsView>
 
+#include "Definitions.hpp"
 #include "Export.hpp"
 
+class QLineEdit;
+
 namespace QtNodes {
 
 class BasicGraphicsScene;
@@ -98,5 +101,8 @@ public Q_SLOTS:
 
     QPointF _clickPos;
     ScaleRange _scaleRange;
+
+    QLineEdit *_labelEdit = nullptr;
+    NodeId _editingNodeId = InvalidNodeId;
 };
 } // namespace QtNodes

include/QtNodes/internal/NodeDelegateModel.hpp

@@ -1,18 +1,12 @@
 #pragma once
 
-#include <memory>
-
-#include <QMetaType>
-#include <QPixmap>
-#include <QtGui/QColor>
-#include <QtWidgets/QWidget>
-
 #include "Definitions.hpp"
 #include "Export.hpp"
 #include "NodeData.hpp"
 #include "NodeStyle.hpp"
 #include "Serializable.hpp"
 #include <QtGui/QColor>
+#include <QtWidgets/QWidget>
 
 namespace QtNodes {
 
@@ -81,6 +75,15 @@ class NODE_EDITOR_PUBLIC NodeDelegateModel
     /// It is possible to hide port caption in GUI
     virtual bool portCaptionVisible(PortType, PortIndex) const { return false; }
 
+    /// Nicknames can be assigned to nodes and shown in GUI
+    virtual QString label() const { return QString(); }
+
+    /// It is possible to hide the nickname in GUI
+    virtual bool labelVisible() const { return true; }
+
+    /// Controls whether the label can be edited or not
+    virtual bool labelEditable() const { return false; }
+
     /// Validation State will default to Valid, but you can manipulate it by overriding in an inherited class
     virtual NodeValidationState validationState() const { return _nodeValidationState; }
 

include/QtNodes/internal/UndoCommands.hpp

@@ -3,9 +3,9 @@
 #include "Definitions.hpp"
 #include "Export.hpp"
 
+#include <QUndoCommand>
 #include <QtCore/QJsonObject>
 #include <QtCore/QPointF>
-#include <QUndoCommand>
 
 #include <unordered_set>