ifeaturerenderer.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_RENDER_IFEATURERENDERER_H
#define OPENSWMM_RENDER_IFEATURERENDERER_H
 
#include "render/featureref.h"
#include "render/legendsymbolitem.h"
#include "render/symbolstyle.h"
 
#include <QColor>
#include <QJsonObject>
#include <QList>
#include <QString>
#include <QVariantMap>
 
#include <memory>
 
namespace OpenSWMM::Render
{
 
enum class ClassEditKind {
    Color,   
    Size,    
    Width,   
    Symbol   
};
 
class IFeatureRenderer
{
public:
    virtual ~IFeatureRenderer() = default;
 
    [[nodiscard]] virtual QString rendererId() const = 0;
 
    [[nodiscard]] virtual SymbolStyle symbolFor(const FeatureRef &f,
                                                const QVariantMap &attrs) const = 0;
 
    [[nodiscard]] virtual QList<LegendSymbolItem> legendSymbolItems() const = 0;
 
    [[nodiscard]] virtual QJsonObject toJson() const = 0;
 
    virtual void fromJson(const QJsonObject &j) = 0;
 
    [[nodiscard]] virtual std::unique_ptr<IFeatureRenderer> clone() const = 0;
 
    // ── Per-class editing (Slice BB Phase 8.6.16) ──────────────────────
    //
    // Lets the legend's right-click "Change color…/size…/symbol…" entries
    // and the LegendPropertiesDialog Layers tab mutate a specific legend
    // row in place. The classKey identifies which row to edit; its format
    // is renderer-specific (per-renderer doc on the overrides):
    //   - GraduatedRenderer:  stringified bin index ("0", "1", …)
    //   - CategorizedRenderer: stringified category index ("0", "1", …)
    //   - SingleSymbolRenderer: "single" (only one class)
    //
    // Default implementations are no-ops returning false / doing nothing
    // so a renderer that supports nothing (e.g. RuleBasedRenderer today)
    // doesn't need to override anything. Callers MUST query
    // supportsClassEdit(kind) before invoking the matching setter.
 
    [[nodiscard]] virtual bool supportsClassEdit(ClassEditKind /*kind*/) const { return false; }
 
    [[nodiscard]] virtual QColor colorForClass(const QString & /*classKey*/) const
    { return {}; }
 
    [[nodiscard]] virtual qreal sizeForClass(const QString & /*classKey*/) const
    { return -1.0; }
 
    virtual void setColorForClass(const QString & /*classKey*/, const QColor & /*color*/) {}
 
    virtual void setSizeForClass(const QString & /*classKey*/, qreal /*size*/) {}
 
    virtual void setWidthForClass(const QString & /*classKey*/, qreal /*width*/) {}
 
    virtual void setSymbolForClass(const QString & /*classKey*/,
                                   const SymbolStyle & /*style*/) {}
 
    virtual void clearClassEditOverrides() {}
 
protected:
    IFeatureRenderer() = default;
    IFeatureRenderer(const IFeatureRenderer &) = default;
    IFeatureRenderer &operator=(const IFeatureRenderer &) = default;
    IFeatureRenderer(IFeatureRenderer &&) = default;
    IFeatureRenderer &operator=(IFeatureRenderer &&) = default;
};
 
} // namespace OpenSWMM::Render
 
#endif // OPENSWMM_RENDER_IFEATURERENDERER_H