sectiondiagram.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_SECTIONVIEW_SECTIONDIAGRAM_H
#define OPENSWMMVIS_SECTIONVIEW_SECTIONDIAGRAM_H
 
#include <QPalette>
#include <QtGlobal>
#include <QPointF>
#include <QPolygonF>
#include <QRectF>
#include <QString>
#include <QVector>
 
class QPainter;
 
namespace openswmmvis::sectionview {
 
enum class DiagramRole {
    Conduit,     
    Structure,   
    Storage,     
    Soil,        
    Media,       
    Gravel,      
    Vegetation,  
    Water,       
    Muted,       
    Accent       
};
 
enum class DiagramTexture {
    None,
    Stipple,     
    Gravel,      
    Aggregate,   
    Sand,        
    Hatch,       
    Lattice,     
    Brick        
};
 
struct DiagramPoly
{
    QPolygonF   pts;
    DiagramRole role = DiagramRole::Conduit;
    DiagramTexture texture = DiagramTexture::None;
    bool        openTop = false;
    bool        unknown = false;
    QString     insetLabel;
};
 
struct DiagramPolyline
{
    QPolygonF   pts;
    DiagramRole role   = DiagramRole::Muted;
    bool        dashed = false;
    QString     label;      
    bool        wavy   = false;
};
 
struct DiagramGround
{
    double x0 = 0.0;
    double x1 = 0.0;
    double y  = 0.0;
};
 
struct DiagramDim
{
    QPointF from;
    QPointF to;
    QString text;
    double  pixelOffset = 28.0;
    bool    accent      = false;   
};
 
struct DiagramLeader
{
    QPointF anchor;
    QString text;
    QPointF pixelOffset { 60.0, -28.0 };
};
 
struct DiagramVegetation
{
    double x0 = 0.0;
    double x1 = 0.0;
    double y  = 0.0;
    double height = 0.0;
    int    count = 8;
    bool   grass = false;
};
 
struct DiagramCircle
{
    QPointF     centre;
    double      radius = 0.0;
    DiagramRole role   = DiagramRole::Conduit;
    bool        perforated = false;
};
 
struct DiagramArrow
{
    QPointF from;
    QPointF to;
    QString label;
    DiagramRole role = DiagramRole::Accent;
};
 
enum class DiagramSymbolKind {
    Pump,          
    FlapGate,      
    ManholeCover,  
    RatingBox      
};
 
struct DiagramSymbol
{
    QPointF           anchor;
    DiagramSymbolKind kind = DiagramSymbolKind::Pump;
    double            pixelSize = 20.0;
    bool              mirrored = false;
    DiagramRole       role = DiagramRole::Accent;
};
 
struct PlanSpoke
{
    double  angleDeg = 0.0;
    QString label;
    bool    inbound  = true;
};
 
struct PlanInset
{
    enum class Side { Left, Right };
 
    QVector<PlanSpoke> spokes;
    QString            title;
    Side               side = Side::Right;
};
 
struct DiagramViewport
{
    double  zoom = 1.0;   
    QPointF panPx;        
 
    [[nodiscard]] bool isIdentity() const
    { return qFuzzyCompare(zoom, 1.0) && panPx.isNull(); }
};
 
struct SectionDiagramModel
{
    QString title;      
    QString subtitle;   
    QString footer;     
    QString emptyText;
 
    QRectF bounds;
 
    bool uniformScale = true;
 
    double verticalExaggeration = 0.0;
 
    double maxVerticalExaggeration = 0.0;
 
    double targetDrawnAspect = 0.0;
 
    bool annotateExaggeration = false;
 
    QVector<DiagramPoly>       polys;
    QVector<DiagramPolyline>   polylines;
    QVector<DiagramGround>     grounds;
    QVector<DiagramVegetation> vegetation;
    QVector<DiagramCircle>     circles;
    QVector<DiagramArrow>      arrows;
    QVector<DiagramSymbol>     symbols;
    QVector<DiagramDim>      dims;
    QVector<DiagramLeader>   leaders;
    QVector<PlanInset>       planInsets;
 
    [[nodiscard]] bool isEmpty() const
    {
        // Vegetation, circles, arrows and symbols are ornaments on something
        // else, so they deliberately do not count as content on their own.
        return polys.isEmpty() && polylines.isEmpty() && grounds.isEmpty();
    }
 
    [[nodiscard]] QRectF computeBounds() const;
};
 
void paintSectionDiagram(QPainter &painter, const QRectF &target,
                         const SectionDiagramModel &model,
                         const QPalette &palette,
                         const DiagramViewport &viewport = {},
                         QRectF *fitRectOut = nullptr,
                         double *achievedExaggerationOut = nullptr);
 
[[nodiscard]] QColor diagramFillColor(DiagramRole role, const QPalette &palette);
 
[[nodiscard]] QColor diagramStrokeColor(DiagramRole role, const QPalette &palette);
 
} // namespace openswmmvis::sectionview
 
#endif // OPENSWMMVIS_SECTIONVIEW_SECTIONDIAGRAM_H