rastersymbollayers.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_RENDER_RASTERSYMBOLLAYERS_H
#define OPENSWMM_RENDER_RASTERSYMBOLLAYERS_H
 
#include "render/colorramp.h"
#include "render/intervalbinner.h"
#include "render/markersymbollayer.h"
#include "render/symbollayer.h"
 
#include <QColor>
#include <QPen>
 
namespace OpenSWMM::Render
{
 
// ╭───────────────────────────────────────────────────────────────────╮
// │  Raster color ramp                                                 │
// ╰───────────────────────────────────────────────────────────────────╯
 
struct RasterColorRampSymbolLayerSpec
{
    RasterColorRamp ramp;
    IntervalBinner  binner;
    qreal           clampMin    = 0.0;
    qreal           clampMax    = 1.0;
    QColor          noDataColor = QColor(0, 0, 0, 0);
    qreal           opacity     = 1.0;
 
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
    [[nodiscard]] static RasterColorRampSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
// ╭───────────────────────────────────────────────────────────────────╮
// │  Hillshade                                                          │
// ╰───────────────────────────────────────────────────────────────────╯
 
struct HillshadeSymbolLayerSpec
{
    qreal   azimuthDeg     = 315.0;
    qreal   altitudeDeg    = 45.0;
    qreal   zExaggeration  = 1.0;
    qreal   shadowFloor    = 0.2;
    QString blendMode      = QStringLiteral("Multiply");
 
    qreal   strength       = 0.5;
 
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
    [[nodiscard]] static HillshadeSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
// ╭───────────────────────────────────────────────────────────────────╮
// │  Contour                                                            │
// ╰───────────────────────────────────────────────────────────────────╯
 
enum class ContourMode : int {
    Lines  = 0,   
    Filled = 1,   
    Both   = 2    
};
 
[[nodiscard]] QString contourModeToString(ContourMode m);
[[nodiscard]] ContourMode contourModeFromString(const QString &s);
 
struct ContourSymbolLayerSpec
{
    ContourMode      mode         = ContourMode::Lines;
    IntervalBinner   binner;
    RasterColorRamp  ramp;
    QColor           lineColor    = QColor(40, 40, 40);
    qreal            lineWidthPx  = 0.75;
    int              labelEveryN  = 0;
    QString          labelFormat  = QStringLiteral("%.1f");
 
    bool             smoothBands  = true;
 
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
    [[nodiscard]] static ContourSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
// ╭───────────────────────────────────────────────────────────────────╮
// │  Mesh edge                                                          │
// ╰───────────────────────────────────────────────────────────────────╯
 
struct MeshEdgeSymbolLayerSpec
{
    QColor       color      = QColor(80, 80, 80);
    qreal        width      = 0.5;
    Qt::PenStyle penStyle   = Qt::SolidLine;
    int          lodMinZoom = 0;
 
    bool         useSlopeDrivenWidth = false;
    qreal        slopeBreak          = 0.5;
    qreal        wideWidthPx         = 1.5;
    QColor       wideColor           = QColor(40, 40, 40);
 
    [[nodiscard]] QPen toQPen() const;
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
    [[nodiscard]] static MeshEdgeSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
// ╭───────────────────────────────────────────────────────────────────╮
// │  Mesh node                                                          │
// ╰───────────────────────────────────────────────────────────────────╯
 
struct MeshNodeSymbolLayerSpec
{
    MarkerSymbolLayerSpec marker;
 
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
    [[nodiscard]] static MeshNodeSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
// ╭───────────────────────────────────────────────────────────────────╮
// │  Velocity vector glyphs (Slice AN.1)                                │
// ╰───────────────────────────────────────────────────────────────────╯
 
struct VelocityVectorSymbolLayerSpec
{
    qreal  glyphLengthScalePxPerMps = 20.0;
    qreal  glyphLengthMinPx         = 4.0;
    qreal  glyphLengthMaxPx         = 40.0;
    qreal  glyphSpacingPx           = 30.0;
    qreal  headSizePx               = 5.0;
    QColor color                    = QColor(20, 20, 20, 220);
    qreal  dryDepthCutoff           = 0.01;
 
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
    [[nodiscard]] static VelocityVectorSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
} // namespace OpenSWMM::Render
 
#endif // OPENSWMM_RENDER_RASTERSYMBOLLAYERS_H