colorramp.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_RENDER_COLORRAMP_H
#define OPENSWMM_RENDER_COLORRAMP_H
 
#include <QColor>
#include <QGradientStops>
#include <QJsonObject>
#include <QMetaType>
#include <QString>
#include <QStringList>
 
enum class RampInterp : int
{
    Rgb       = 0,
    HsvShort  = 1,
    HsvLong   = 2
};
 
struct RasterColorRamp
{
    double          minValue = 0.0;
    double          maxValue = 1.0;
    QGradientStops  stops;        
    bool            clampMin = false; 
    bool            clampMax = false; 
    RampInterp      interp   = RampInterp::Rgb; 
    [[nodiscard]] QColor colorAt(double normalisedPos) const;
 
    [[nodiscard]] QColor colorForValue(double value) const;
 
    [[nodiscard]] QJsonObject toJson() const;
    static RasterColorRamp    fromJson(const QJsonObject &j);
 
    // ── Built-in catalogue ───────────────────────────────────────────────
    //
    // Stops for all built-ins are authored assuming RGB interpolation (the
    // published palettes were tuned that way). The `interp` field defaults
    // to Rgb to honour that.
 
    [[nodiscard]] static RasterColorRamp grayscale(double min = 0.0, double max = 255.0);
    [[nodiscard]] static RasterColorRamp viridis(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp plasma(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp magma(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp inferno(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp cividis(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp turbo(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp rdBu(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp rdYlGn(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp spectral(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp brBG(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp legacySWMM5Interval(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp legacySWMMPollutant(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp terrain(double min = 0.0, double max = 1.0);
 
    // Slice BB-β (2026-05-25) — Plotly's continuous palettes from
    // plotly.colors.sequential / .diverging. Stops authored per Plotly's
    // reference; all RGB-interp by default.
    [[nodiscard]] static RasterColorRamp plotly3(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp iceFire(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp blackbody(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp electric(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp hot(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp jet(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp picnic(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp portland(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp rainbow(double min = 0.0, double max = 1.0);
    [[nodiscard]] static RasterColorRamp bluered(double min = 0.0, double max = 1.0);
 
    [[nodiscard]] static RasterColorRamp waterDepth(double min = 0.0, double max = 1.0);
 
    [[nodiscard]] static RasterColorRamp builtin(const QString &name);
 
    [[nodiscard]] static QStringList builtinNames();
};
 
Q_DECLARE_METATYPE(RasterColorRamp)
 
#endif // OPENSWMM_RENDER_COLORRAMP_H