preferencesmanager.h

Go to the documentation of this file.

 
#ifndef PREFERENCESMANAGER_H
#define PREFERENCESMANAGER_H
 
#include "render/colorramp.h"
#include "plot/numberformat.h"
 
#include <QBrush>
#include <QColor>
#include <QMap>
#include <QObject>
#include <QPen>
#include <QSettings>
#include <QString>
 
class PreferencesManager : public QObject
{
    Q_OBJECT
 
public:
    static PreferencesManager *instance();
 
    // ── Selection (MapToolSelect) ────────────────────────────────────────
    [[nodiscard]] int  clickTolerancePx() const;
    void setClickTolerancePx(int pixels);
 
    [[nodiscard]] int  dragThresholdPx() const;
    void setDragThresholdPx(int pixels);
 
    [[nodiscard]] bool clearSelectionOnMiss() const;
    void setClearSelectionOnMiss(bool on);
 
    [[nodiscard]] QPen   selectionPen(const QString &className) const;
    void setSelectionPen(const QString &className, const QPen &pen);
 
    [[nodiscard]] QBrush selectionBrush(const QString &className) const;
    void setSelectionBrush(const QString &className, const QBrush &brush);
 
    [[nodiscard]] QColor selectionColor(const QString &className) const;
 
    void resetSelectionStyleToDefault(const QString &className);
 
    // ── Appearance ───────────────────────────────────────────────────────
    [[nodiscard]] QString appearanceMode() const;
    void setAppearanceMode(const QString &mode);
 
    // ── Canvas / Default tool ────────────────────────────────────────────
    [[nodiscard]] QString defaultTool() const;
    void setDefaultTool(const QString &tool);
 
    [[nodiscard]] QString defaultCrsMode() const;
    void setDefaultCrsMode(const QString &mode);
 
    [[nodiscard]] QString defaultCrsAuthority() const;
    [[nodiscard]] int     defaultCrsCode()      const;
    void setDefaultCrsAuthority(const QString &authority);
    void setDefaultCrsCode(int code);
 
    // ── GPU / QSG rendering ──────────────────────────────────────────────
    [[nodiscard]] bool qsgRenderEnabled()  const;
    void setQsgRenderEnabled(bool enabled);
 
    [[nodiscard]] bool qsgMeshRenderEnabled() const;
    void setQsgMeshRenderEnabled(bool enabled);
 
    [[nodiscard]] bool autoBuildRasterOverviews() const;
    void setAutoBuildRasterOverviews(bool enabled);
 
    // ── Snapping ─────────────────────────────────────────────────────────
    [[nodiscard]] bool snapEnabled()     const;
    void setSnapEnabled(bool enabled);
 
    [[nodiscard]] int  snapTolerancePx() const;
    void setSnapTolerancePx(int px);
 
    [[nodiscard]] bool snapToVertices()  const;
    void setSnapToVertices(bool enabled);
 
    // ── Rendering / Map LOD ──────────────────────────────────────────────
    [[nodiscard]] qreal labelLodM11Min() const;
    void setLabelLodM11Min(qreal m11);
 
    [[nodiscard]] QPen   linkPen(const QString &linkType) const;
    void setLinkPen(const QString &linkType, const QPen &pen);
 
    [[nodiscard]] QColor linkColor(const QString &linkType) const;
 
    void resetLinkPenToDefault(const QString &linkType);
 
    [[nodiscard]] QPen   nodePen(const QString &nodeType) const;
    void setNodePen(const QString &nodeType, const QPen &pen);
 
    [[nodiscard]] QBrush nodeBrush(const QString &nodeType) const;
    void setNodeBrush(const QString &nodeType, const QBrush &brush);
 
    [[nodiscard]] double nodeSize(const QString &nodeType) const;
    void setNodeSize(const QString &nodeType, double sizePx);
 
    void resetNodeStyleToDefault(const QString &nodeType);
 
    // ── Rendering / Custom color ramps (Slice BB-α) ──────────────────────
    [[nodiscard]] QMap<QString, RasterColorRamp> customColorRamps() const;
    void saveCustomColorRamp(const QString &name, const RasterColorRamp &ramp);
    void removeCustomColorRamp(const QString &name);
 
    // ── 2D mesh boundary-condition edge styling ──────────────────────────
    [[nodiscard]] bool   meshBcColorByType() const;
    void setMeshBcColorByType(bool on);
 
    [[nodiscard]] QColor meshBcColor(int type) const;
    void setMeshBcColor(int type, const QColor &color);
 
    [[nodiscard]] double meshBcWidthPx(int type) const;
    void setMeshBcWidthPx(int type, double px);
 
    // ── Simulation ───────────────────────────────────────────────────────
    [[nodiscard]] int progressTickMs() const;
    void setProgressTickMs(int ms);
 
    [[nodiscard]] int live2DHistoryCap() const;
    void setLive2DHistoryCap(int frames);
 
    [[nodiscard]] int live2DHistoryMB() const;
    void setLive2DHistoryMB(int megabytes);
 
    [[nodiscard]] bool liveResults1DEnabled() const;
    void setLiveResults1DEnabled(bool on);
 
    [[nodiscard]] double animationSpeed() const;
    void setAnimationSpeed(double speed);
 
    // ── Profile plot path discovery ──────────────────────────────────────
    [[nodiscard]] int  profileMaxPaths() const;
    void setProfileMaxPaths(int n);
 
    [[nodiscard]] int  profileEndpointHaloRadiusPx() const;
    void setProfileEndpointHaloRadiusPx(int px);
 
    [[nodiscard]] QPen profileStartEndpointPen() const;
    void setProfileStartEndpointPen(const QPen &pen);
 
    [[nodiscard]] QPen profileEndEndpointPen() const;
    void setProfileEndEndpointPen(const QPen &pen);
 
    // ── Map Decorations / Scale Bar ──────────────────────────────────────
    [[nodiscard]] QColor  scaleBarPenColor()     const;
    void setScaleBarPenColor(const QColor &color);
 
    [[nodiscard]] int     scaleBarPenWidth()     const;  
    void setScaleBarPenWidth(int width);
 
    [[nodiscard]] int     scaleBarPenStyle()     const;  
    void setScaleBarPenStyle(int style);
 
    [[nodiscard]] QString scaleBarFontFamily()   const;  
    void setScaleBarFontFamily(const QString &family);
 
    [[nodiscard]] int     scaleBarFontSize()     const;  
    void setScaleBarFontSize(int size);
 
    [[nodiscard]] int     scaleBarUnits()        const;  
    void setScaleBarUnits(int units);
 
    [[nodiscard]] int     scaleBarPosition()     const;  
    void setScaleBarPosition(int position);
 
    [[nodiscard]] int     scaleBarMaxBarLength() const;  
    void setScaleBarMaxBarLength(int length);
 
    [[nodiscard]] int  scaleBarLabelDecimals()   const;  
    void setScaleBarLabelDecimals(int decimals);
 
    [[nodiscard]] bool scaleBarCompactNotation() const;  
    void setScaleBarCompactNotation(bool compact);
 
    // ── Map Decorations / Measure Tool ───────────────────────────────────
    [[nodiscard]] QColor  measureLineColor()   const;  
    void setMeasureLineColor(const QColor &color);
 
    [[nodiscard]] QString measureLabelFontFamily() const;  
    void setMeasureLabelFontFamily(const QString &family);
 
    [[nodiscard]] int     measureLabelFontSize()   const;  
    void setMeasureLabelFontSize(int size);
 
    [[nodiscard]] int     measureLabelDecimals()   const;  
    void setMeasureLabelDecimals(int decimals);
 
    [[nodiscard]] QColor  measureFillColor()   const;  
    void setMeasureFillColor(const QColor &color);
 
    [[nodiscard]] int     measureFillOpacity() const;  
    void setMeasureFillOpacity(int opacity);
 
    // ── Plots: default numeric precision ─────────────────────────────────
    [[nodiscard]] int  plotXAxisFormatMode() const;  
    void setPlotXAxisFormatMode(int mode);
    [[nodiscard]] int  plotXAxisPrecision()  const;  
    void setPlotXAxisPrecision(int count);
 
    [[nodiscard]] int  plotYAxisFormatMode() const;  
    void setPlotYAxisFormatMode(int mode);
    [[nodiscard]] int  plotYAxisPrecision()  const;  
    void setPlotYAxisPrecision(int count);
 
    [[nodiscard]] openswmmvis::plot::NumberFormat plotXAxisFormat() const;
    [[nodiscard]] openswmmvis::plot::NumberFormat plotYAxisFormat() const;
 
    // ── Element naming prefixes ──────────────────────────────────────────
    [[nodiscard]] QString elementNamePrefix(const QString &kind) const;
    void setElementNamePrefix(const QString &kind, const QString &prefix);
 
    // ── Terrain editing defaults ─────────────────────────────────────────
    [[nodiscard]] double terrainDefaultNodeOffset() const;
    void setTerrainDefaultNodeOffset(double offset);
 
    [[nodiscard]] double terrainDefaultLinkOffset() const;
    void setTerrainDefaultLinkOffset(double offset);
 
    // ── Application defaults applied on project creation ─────────────────
    [[nodiscard]] bool autoLengthEnabled() const;
    void setAutoLengthEnabled(bool enabled);
 
    [[nodiscard]] QString defaultEngineMode() const;
    void setDefaultEngineMode(const QString &version);
 
    // ── Simulation defaults for new (blank) projects ─────────────────────
    struct SimulationDefaults
    {
        QString flowUnits           = QStringLiteral("CFS");
        QString infiltrationModel   = QStringLiteral("HORTON");
        QString flowRouting         = QStringLiteral("DYNWAVE");
 
        // Legacy-SWMM parity: a new project simulates every process that
        // its model data exercises. IGNORE_ROUTING YES here made every
        // File→New model appear dead (no flows anywhere) unless the user
        // found Simulation Defaults and opted routing back in.
        bool    ignoreRainfall      = false;
        bool    ignoreRdii          = false;
        bool    ignoreSnowmelt      = false;
        bool    ignoreGroundwater   = false;
        bool    ignoreQuality       = false;
        bool    ignoreRouting       = false;
        bool    module2DEnabled     = false;
 
        bool    allowPonding        = false;
        bool    skipSteadyState     = false;
        double  minSlopePct         = 0.0;     
 
        QString sweepStart          = QStringLiteral("01/01");
        QString sweepEnd            = QStringLiteral("12/31");
        double  dryDays             = 0.0;
 
        // Time steps stored as seconds.
        int     reportStepSec       = 60;      
        int     dryStepSec          = 5 * 60;  
        int     wetStepSec          = 60;      
        int     ruleStepSec         = 0;       
        double  routingStepSec      = 5.0;     
 
        int     maxTrials           = 8;
        double  headTolerance       = 0.005;   
        double  sysFlowTolPct       = 5.0;     
        double  latFlowTolPct       = 5.0;     
 
        // Dynamic-wave specific.
        QString inertialDamping     = QStringLiteral("PARTIAL"); 
        QString normalFlowLimited   = QStringLiteral("BOTH");    
        QString forceMainEquation   = QStringLiteral("H-W");
        QString surchargeMethod     = QStringLiteral("EXTRAN");
        bool    variableStepOn      = true;
        double  variableStepFactor  = 0.75;    
        double  minRoutingStepSec   = 0.5;     
        double  lengtheningStepSec  = 0.0;     
 
        // New-engine only. Emitted only when defaultEngineMode is the
        // refactored engine; for legacy engine the keys are suppressed.
        QString nodeContinuity      = QStringLiteral("SEMI_IMPLICIT");
        bool    andersonAccel       = true;
 
        // Mixed-flow options (engine issue #156; GUI issue #10). Applies to
        // dynamic-wave and FV routing; new-engine only like nodeContinuity.
        // The sibling #156 keys deliberately do NOT live here:
        // TPA_CELERITY follows the DPS_* rule (method-specific, engine-side
        // default), FV_PRESSURE_CLOSURE follows the FV_* gap, and
        // REPORT_SIGNED_HEADS follows the RPT_* rule (no report keys here).
        QString unsteadyFriction    = QStringLiteral("NONE");  
        double  ufK3                = 0.015;                   
 
        int     threads             = 0;
    };
 
    [[nodiscard]] SimulationDefaults simulationDefaults() const;
    void setSimulationDefaults(const SimulationDefaults &d);
 
    // ── 2D model defaults for new projects ───────────────────────────────
    struct TwoDDefaults
    {
        // [2D_OPTIONS] solver keys (defaults mirror the engine's).
        double  maxTimestepSec     = 10.0;    
        double  theta              = 0.8;     
        double  cflNumber          = 0.7;     
        int     ltsTiers           = 4;       
        double  hMove              = 0.003;   
        double  froudeMax          = 1.5;     
        bool    advection          = false;   
        double  dryDepth           = 0.001;   
        double  limiterEpsilon     = 1e-6;    
        double  fluxDhEps          = 0.004;   
        QString cellClosure        = QStringLiteral("FLAT");  
        QString faceReconstruction = QStringLiteral("MEAN");  
        double  vfrMinWetFrac      = 0.01;    
        double  couplingCd         = 0.65;    
        double  couplingSync       = 0.0;     
        bool    couplingAreaAuto   = false;   
        QString rainfallMode       = QStringLiteral("NATURAL_NEIGHBOUR"); 
        bool    report2D           = false;   
 
        // Mesh-generation seeds (SI canonical; the dialog unit-scales).
        double  meshMinAngleDeg      = 33.0;
        double  meshMaxArea          = 0.0;   
        int     meshMaxSteiner       = -1;    
        double  meshIdwPower         = 2.0;
        double  meshSimplifyEpsM     = 0.1;
        double  meshSnapEpsM         = 0.01;
        double  meshNodeFlattenRadM  = 5.0;
        // 2026-09-11: nodes pinned as Steiner vertices, at their rim
        // elevation, with the minimum separation demoting close clusters —
        // all on by default (virtual junctions are never pinned).
        bool    meshNodesAsVertices  = true;  
        bool    meshNodesUseRim      = true;  
        bool    meshMinNodeSepOn     = true;
        double  meshMinNodeSepM      = 2.0;
        bool    meshThinningOn       = true;
        double  meshThinningTol      = 0.75;  
        int     meshThinningPasses   = 1;
        bool    meshMinSpacingOn     = true;  
        double  meshMinSpacingM      = 15.0;  
        double  meshBoundaryBufferM  = 0.0;   
        bool    meshMaxBoundaryEdgeOn = false;
        double  meshMaxBoundaryEdgeM = 20.0;
        double  meshManningsN        = 0.035;
        double  meshInitDepth        = 0.0;   
        bool    meshOutputExternal   = true;
    };
 
    [[nodiscard]] TwoDDefaults twoDDefaults() const;
    void setTwoDDefaults(const TwoDDefaults &d);
 
    // ── Object creation defaults ─────────────────────────────────────────
    struct ObjectDefaults
    {
        // Junctions (0 = engine "auto from highest crown" for max depth)
        double  junctionMaxDepth      = 0.0;   
        double  junctionInitDepth     = 0.0;   
        double  junctionSurDepth      = 0.0;   
        double  junctionPondedArea    = 0.0;   
 
        // Outfalls
        QString outfallType           = QStringLiteral("FREE");
        bool    outfallFlapGate       = false;
 
        // Storage (functional area A = coeff*d^expon + constant)
        double  storageMaxDepth       = 15.0;  
        double  storageFuncCoeff      = 0.0;
        double  storageFuncExponent   = 0.0;
        double  storageFuncConstant   = 1000.0; 
        double  storageSeepRate       = 0.0;   
 
        // Dividers
        QString dividerType           = QStringLiteral("OVERFLOW");
 
        // Conduits
        QString conduitShape          = QStringLiteral("CIRCULAR");
        double  conduitGeom1          = 1.0;   
        double  conduitGeom2          = 0.0;
        double  conduitGeom3          = 0.0;
        double  conduitGeom4          = 0.0;
        double  conduitRoughness      = 0.013; 
        double  conduitLength         = 400.0; 
        int     conduitBarrels        = 1;
        double  conduitLossInlet      = 0.0;
        double  conduitLossOutlet     = 0.0;
        bool    conduitFlapGate       = false;
 
        // Pumps (ideal pump: no curve reference to default)
        bool    pumpInitStateOn       = true;
        double  pumpStartupDepth      = 0.0;   
        double  pumpShutoffDepth      = 0.0;   
 
        // Orifices
        QString orificeType           = QStringLiteral("SIDE");
        double  orificeGeom1          = 1.0;   
        double  orificeCd             = 0.65;
        bool    orificeFlapGate       = false;
        double  orificeOpenCloseRate  = 0.0;   
 
        // Weirs
        QString weirType              = QStringLiteral("TRANSVERSE");
        double  weirGeom1             = 3.0;   
        double  weirGeom2             = 3.0;   
        double  weirCd                = 3.33;  
        int     weirEndContractions   = 0;
        bool    weirFlapGate          = false;
 
        // Outlets (rating Q = C*h^n)
        QString outletRatingType      = QStringLiteral("FUNCTIONAL_DEPTH");
        double  outletCoeff           = 10.0;  
        double  outletExponent        = 0.5;
        bool    outletFlapGate        = false;
 
        // Subcatchments
        double  subcatchArea          = 5.0;   
        double  subcatchWidth         = 500.0; 
        double  subcatchSlopePct      = 0.5;
        double  subcatchImpervPct     = 25.0;
        double  subcatchNImperv       = 0.012;
        double  subcatchNPerv         = 0.15;
        double  subcatchDsImperv      = 0.06;  
        double  subcatchDsPerv        = 0.15;  
        double  subcatchPctZeroImperv = 25.0;
        double  hortonMaxRate         = 3.0;   
        double  hortonMinRate         = 0.5;   
        double  hortonDecay           = 4.0;   
        double  hortonDryTime         = 7.0;   
        double  gaSuction             = 3.5;   
        double  gaKsat                = 0.5;   
        double  gaImd                 = 0.26;
        double  cnCurveNumber         = 80.0;
        double  cnDryTime             = 7.0;   
 
        // Rain gages
        QString gageRainFormat        = QStringLiteral("INTENSITY");
        int     gageIntervalMin       = 15;    
        double  gageSnowCatch         = 1.0;
 
        [[nodiscard]] static ObjectDefaults usSeed();
        [[nodiscard]] static ObjectDefaults siSeed();
    };
 
    [[nodiscard]] ObjectDefaults objectDefaults(bool si) const;
    void setObjectDefaults(const ObjectDefaults &d, bool si);
 
signals:
    void preferenceChanged(const QString &group, const QString &key);
 
private:
    explicit PreferencesManager(QObject *parent = nullptr);
 
    QSettings m_settings;
};
 
#endif // PREFERENCESMANAGER_H