linesymbollayer.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_RENDER_LINESYMBOLLAYER_H
#define OPENSWMM_RENDER_LINESYMBOLLAYER_H
 
#include "render/symbollayer.h"
 
#include <QColor>
#include <QFont>
#include <QPen>
#include <QPolygonF>
#include <QVector>
 
class QPainter;
 
namespace OpenSWMM::Render
{
 
enum class ArrowPlacement : int {
    End              = 0,   
    Both             = 1,   
    Centered         = 2,   
    RepeatEveryNPx   = 3,   
    AtVertices       = 4    
};
 
[[nodiscard]] QString arrowPlacementToString(ArrowPlacement p);
[[nodiscard]] ArrowPlacement arrowPlacementFromString(const QString &s);
 
struct LineArrowSpec
{
    QColor          color      = QColor(40, 40, 40);
    qreal           lengthPx   = 8.0;
    qreal           widthPx    = 6.0;
    ArrowPlacement  placement  = ArrowPlacement::End;
    qreal           spacingPx  = 40.0;   
    bool            reverse    = false;
};
 
struct LineSymbolLayerSpec
{
    QColor           color      = QColor(60, 120, 200);
    qreal            width      = 1.0;
    Qt::PenStyle     penStyle   = Qt::SolidLine;
    Qt::PenCapStyle  capStyle   = Qt::FlatCap;
    Qt::PenJoinStyle joinStyle  = Qt::BevelJoin;
    QVector<qreal>   customDash;
    qreal            offsetPx   = 0.0;
 
    bool             drawArrows = false;
    LineArrowSpec    arrows;
 
    // Slice SS.3 — SWMM-specific arrow gate. When true, the painter
    // (SWMMLayerItem / FeatureSublayer) suppresses the arrow head
    // unless the link's current flow value is positive. Mirrors the
    // legacy SWMMElementSymbol::arrowOnlyWhenFlowPos field.
    bool             arrowOnlyWhenFlowPos = false;
 
    // Slice SS.3 — label fields parallel to SWMMElementSymbol so the
    // Single Symbol panel's label group round-trips through the
    // SymbolLayer prop bag for line categories. The painter still
    // reads labels from the legacy fields; back-propagation (SS.4 /
    // SS.5) copies these onto those legacy fields on rule edit.
    bool             showLabel  = false;
    QFont            labelFont  = QFont();
    QColor           labelColor = QColor(0, 0, 0);
 
    [[nodiscard]] QPen toQPen() const;
 
    [[nodiscard]] SymbolLayer toSymbolLayer() const;
 
    [[nodiscard]] static LineSymbolLayerSpec fromSymbolLayer(const SymbolLayer &layer);
 
    void writeToSymbolLayer(SymbolLayer &layer) const;
};
 
void drawArrowsAlongPolyline(QPainter *painter,
                              const QPolygonF &polyline,
                              const LineArrowSpec &spec);
 
} // namespace OpenSWMM::Render
 
#endif // OPENSWMM_RENDER_LINESYMBOLLAYER_H