classificationscheme.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_RENDER_CLASSIFICATIONSCHEME_H
#define OPENSWMM_RENDER_CLASSIFICATIONSCHEME_H
 
#include "render/attributesource.h"
#include "render/colorramp.h"
#include "render/intervalbinner.h"
#include "render/legendsymbolitem.h"
 
#include <QColor>
#include <QHash>
#include <QJsonObject>
#include <QList>
#include <QMetaType>
#include <QPair>
#include <QString>
#include <QVector>
 
namespace OpenSWMM::Render
{
 
class ClassificationScheme
{
public:
    enum class ClassMode : int
    {
        Continuous = 0,
        Classified = 1,
    };
 
    enum class LabelFormat : int
    {
        Decimals          = 0,   
        SignificantFigures = 1,  
    };
 
    ClassificationScheme();
 
    // ── Mode ───────────────────────────────────────────────────────────
    [[nodiscard]] ClassMode mode() const { return m_mode; }
    void setMode(ClassMode m);
 
    // ── Classification (embedded binner) ───────────────────────────────
    [[nodiscard]] const IntervalBinner &binner() const { return m_binner; }
    void setBinner(const IntervalBinner &b);
 
    [[nodiscard]] BinMethod method() const { return m_binner.method(); }
    void setMethod(BinMethod m);
 
    [[nodiscard]] int classCount() const { return m_binner.binCount(); }
    void setClassCount(int n);
 
    [[nodiscard]] const QVector<double> &manualBreaks() const { return m_binner.manualBreaks(); }
    void setManualBreaks(QVector<double> breaks);
 
    // ── Colour source ──────────────────────────────────────────────────
    [[nodiscard]] QString rampName() const { return m_rampName; }
    void setRampName(const QString &name);
 
    [[nodiscard]] bool invertRamp() const { return m_invertRamp; }
    void setInvertRamp(bool on);
 
    [[nodiscard]] QColor lowColor() const { return m_lowColor; }
    void setLowColor(const QColor &c);
    [[nodiscard]] QColor highColor() const { return m_highColor; }
    void setHighColor(const QColor &c);
 
    [[nodiscard]] bool hasCustomRamp() const { return m_hasCustomRamp; }
    [[nodiscard]] const RasterColorRamp &customRamp() const { return m_customRamp; }
    void setCustomRamp(const RasterColorRamp &ramp, const QString &name);
    void clearCustomRamp();
 
    [[nodiscard]] RasterColorRamp resolvedRamp() const;
 
    // ── Range ──────────────────────────────────────────────────────────
    [[nodiscard]] bool useCustomRange() const { return m_useCustomRange; }
    void setUseCustomRange(bool on);
    [[nodiscard]] double rangeMin() const { return m_rangeMin; }
    void setRangeMin(double v);
    [[nodiscard]] double rangeMax() const { return m_rangeMax; }
    void setRangeMax(double v);
 
    [[nodiscard]] RangeMode rangeMode() const { return m_rangeMode; }
    void setRangeMode(RangeMode m);
 
    // ── Label number format (Decimals vs significant figures) ──────────
    [[nodiscard]] LabelFormat labelFormat() const { return m_labelFormat; }
    void setLabelFormat(LabelFormat f);
    [[nodiscard]] int labelPrecision() const { return m_labelPrecision; }
    void setLabelPrecision(int digits);
 
    [[nodiscard]] QString formatValue(double v) const;
 
    [[nodiscard]] QPair<double, double> effectiveRange(double dataMin, double dataMax) const;
 
    // ── Per-class overrides ────────────────────────────────────────────
    [[nodiscard]] QColor colorOverride(int classIndex) const;          
    void setColorOverride(int classIndex, const QColor &c);
    void clearColorOverride(int classIndex);
    [[nodiscard]] QString labelOverride(int classIndex) const;         
    void setLabelOverride(int classIndex, const QString &label);
    void clearLabelOverride(int classIndex);
    void clearOverrides();
    [[nodiscard]] const QHash<int, QColor>  &colorOverrides() const { return m_colorOverrides; }
    [[nodiscard]] const QHash<int, QString> &labelOverrides() const { return m_labelOverrides; }
 
    // ── Computation ────────────────────────────────────────────────────
    [[nodiscard]] QVector<double> levelEdges(double dataMin, double dataMax,
                                             const QVector<double> &samples = {}) const;
 
    [[nodiscard]] QVector<double> interiorLevels(double dataMin, double dataMax,
                                                 const QVector<double> &samples = {}) const;
 
    [[nodiscard]] static int classIndexFor(double value, const QVector<double> &edges);
 
    [[nodiscard]] QColor colorAtF(double f) const;
 
    [[nodiscard]] QColor colorForClass(int classIndex) const;
    [[nodiscard]] QColor colorForClass(int classIndex, int count) const;
 
    [[nodiscard]] QColor colorForValue(double value, double dataMin, double dataMax) const;
 
    [[nodiscard]] QList<LegendSymbolItem> legendItems(double dataMin, double dataMax,
                                                      const QVector<double> &samples = {}) const;
 
    // ── Change tracking ────────────────────────────────────────────────
    [[nodiscard]] quint64 revision() const { return m_revision; }
 
    // ── Persistence ────────────────────────────────────────────────────
    [[nodiscard]] QJsonObject toJson() const;
    static ClassificationScheme fromJson(const QJsonObject &j);
 
    [[nodiscard]] bool operator==(const ClassificationScheme &o) const;
    [[nodiscard]] bool operator!=(const ClassificationScheme &o) const { return !(*this == o); }
 
private:
    void bump();
 
    ClassMode        m_mode = ClassMode::Classified;
    IntervalBinner   m_binner;                       // EqualInterval, 5 bins
    QString          m_rampName = QStringLiteral("viridis");
    RasterColorRamp  m_customRamp;                   // valid only when m_hasCustomRamp
    bool             m_hasCustomRamp = false;
    bool             m_invertRamp = false;
    QColor           m_lowColor  = QColor(Qt::white);
    QColor           m_highColor = QColor(Qt::black);
    bool             m_useCustomRange = false;
    double           m_rangeMin = 0.0;
    double           m_rangeMax = 1.0;
    RangeMode        m_rangeMode = RangeMode::FixedOverRun;
    // Default reproduces the historic legend formatting (`'g', 3`).
    LabelFormat      m_labelFormat    = LabelFormat::SignificantFigures;
    int              m_labelPrecision = 3;
    QHash<int, QColor>  m_colorOverrides;
    QHash<int, QString> m_labelOverrides;
    quint64          m_revision = 0;
};
 
} // namespace OpenSWMM::Render
 
Q_DECLARE_METATYPE(OpenSWMM::Render::ClassificationScheme)
 
#endif // OPENSWMM_RENDER_CLASSIFICATIONSCHEME_H