isublayer.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_RENDER_ISUBLAYER_H
#define OPENSWMM_RENDER_ISUBLAYER_H
 
#include "render/legendsymbolitem.h"
 
#include <QDateTime>
#include <QList>
#include <QMatrix4x4>
#include <QObject>
#include <QRectF>
#include <QString>
 
class QSGNode;
 
namespace OpenSWMM::Render
{
 
class SublayerStyle;
 
struct SublayerContext
{
    QMatrix4x4    viewMatrix;          
    double        pixelsPerSceneUnit = 1.0; 
    double        devicePixelRatio   = 1.0; 
    QRectF        exposedSceneRect;    
    QDateTime     currentTime;         
    int           currentPeriod = -1;  
};
 
class ISublayer : public QObject
{
    Q_OBJECT
 
public:
    enum Kind
    {
        MarkerKind = 0,       
        LineKind,             
        FillKind,             
        ArrowKind,            
        ColorRampFillKind,    
        IsolineKind,          
        ContourBandKind,      
        VectorGlyphKind,      
    };
    Q_ENUM(Kind)
 
    explicit ISublayer(QObject *parent = nullptr) : QObject(parent) {}
    ~ISublayer() override = default;
 
    // ── Identity / taxonomy ────────────────────────────────────────────
    [[nodiscard]] virtual Kind    kind() const        = 0;
    [[nodiscard]] virtual QString id() const          = 0; 
    [[nodiscard]] virtual QString displayName() const = 0; 
    // ── Visibility / opacity ──────────────────────────────────────────
    [[nodiscard]] virtual bool  isVisible() const  = 0;
    virtual void                setVisible(bool)   = 0;
    [[nodiscard]] virtual qreal opacity() const    = 0; 
    virtual void                setOpacity(qreal)  = 0;
 
    // ── Animation integration ─────────────────────────────────────────
    [[nodiscard]] virtual bool isDynamic() const = 0;
 
    // ── Style bag ─────────────────────────────────────────────────────
    [[nodiscard]] virtual SublayerStyle *style() = 0;
 
    // ── Legend contribution (§J.5 + plan §4.3) ────────────────────────
    [[nodiscard]] virtual QList<LegendSymbolItem> legendSymbolItems() const = 0;
 
    // ── QSG paint ─────────────────────────────────────────────────────
    virtual QSGNode *buildOrUpdateNode(QSGNode *existing,
                                       const SublayerContext &ctx) = 0;
 
    Q_INVOKABLE virtual void invalidate() { emit invalidated(); }
 
signals:
    void invalidated();
};
 
} // namespace OpenSWMM::Render
 
#endif // OPENSWMM_RENDER_ISUBLAYER_H