Connection.h

Go to the documentation of this file.

// Copyright (c) 2012, STANISLAW ADASZEWSKI
// SPDX-License-Identifier: BSD-3-Clause
//
// Portions Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later
//
// Originally derived from Stanislaw Adaszewski's Qt Node Editor (qneblock); since
// re-authored for wiRedPanda. The BSD attribution above is retained as a license
// obligation for the derived design.

 
#pragma once
 
#include <QGraphicsPathItem>
#include <QPen>
 
#include "App/Core/Enums.h"
#include "App/Core/ItemWithId.h"
 
struct SerializationContext;
class InputPort;
class OutputPort;
class Port;

class Connection : public QGraphicsPathItem, public ItemWithId
{
public:
    enum { Type = QGraphicsItem::UserType + 2 }; 
    int type() const override { return Type; }

    explicit Connection(QGraphicsItem *parent = nullptr);
    ~Connection() override;
 
    // --- Port / Endpoint Access ---

    OutputPort *startPort() const;
    InputPort *endPort() const;
    Port *otherPort(const Port *port) const;
 
    // --- Port Configuration ---

    void setStartPort(OutputPort *port);
    void setEndPort(InputPort *port);
    void setStartPos(const QPointF point);
    void setEndPos(const QPointF point);
 
    // --- Status & Visualization ---

    Status status() const;
    void setStatus(const Status status);
    bool highLight();
    void setHighLight(const bool highLight);
    QPen statusPen() const { return m_statusPen; }
 
    // --- Geometric properties ---

    QRectF boundingRect() const override;
    QPainterPath shape() const override;
    double angle();
    void updatePath();

    void updatePosFromPorts();
 
    // --- Visual rendering ---

    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) override;

    void updateTheme();
 
    // --- Serialization ---

    void load(QDataStream &stream, SerializationContext &context);
    void save(QDataStream &stream) const;
 
protected:
    // --- Qt event overrides ---

    QVariant itemChange(GraphicsItemChange change, const QVariant &value) override;
    bool sceneEvent(QEvent *event) override;
 
private:
    friend class TestConnection;
 
    Q_DISABLE_COPY_MOVE(Connection)
 
    
    void changePortAttachment(Port *oldPort, Port *newPort);

    void applyStatusPen();
 
    // --- Members: Theme colors ---
 
    QColor m_activeColor;
    QColor m_inactiveColor;
    QColor m_unknownColor;
    QColor m_errorColor;
    QColor m_selectedColor;
 
    // --- Members: Ports & positions ---
 
    OutputPort *m_startPort = nullptr;
    InputPort *m_endPort = nullptr;
    QPointF m_startPos;
    QPointF m_endPos;
 
    // --- Members: State ---
 
    Status m_status = Status::Unknown;
    bool m_highLight = false;

    QPen m_statusPen;

    mutable QPainterPath m_cachedShape;
    mutable bool m_shapeDirty = true;
};