seriesstyleobject.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_PLOT_SERIESSTYLEOBJECT_H
#define OPENSWMMVIS_PLOT_SERIESSTYLEOBJECT_H
 
#include "plot/seriesstyle.h"
 
#include <QColor>
#include <QFont>
#include <QObject>
#include <QString>
 
namespace openswmmvis::plot {
 
class SeriesStyleObject : public QObject
{
    Q_OBJECT
 
    // ---- Identity ----------------------------------------------------------
    Q_PROPERTY(QColor   color        READ color        WRITE setColor        NOTIFY colorChanged)
    Q_PROPERTY(qreal    opacity      READ opacity      WRITE setOpacity      NOTIFY opacityChanged)
    Q_PROPERTY(QString  legendName     READ legendName     WRITE setLegendName     NOTIFY legendNameChanged)
    Q_PROPERTY(QString  legendOverride READ legendOverride WRITE setLegendOverride NOTIFY legendOverrideChanged)
 
    // ---- Line --------------------------------------------------------------
    Q_PROPERTY(bool             showLine  READ showLine  WRITE setShowLine  NOTIFY showLineChanged)
    Q_PROPERTY(qreal            lineWidth READ lineWidth WRITE setLineWidth NOTIFY lineWidthChanged)
    Q_PROPERTY(Qt::PenStyle     dash      READ dash      WRITE setDash      NOTIFY dashChanged)
    Q_PROPERTY(Qt::PenCapStyle  capStyle  READ capStyle  WRITE setCapStyle  NOTIFY capStyleChanged)
    Q_PROPERTY(Qt::PenJoinStyle joinStyle READ joinStyle WRITE setJoinStyle NOTIFY joinStyleChanged)
 
    // ---- Markers -----------------------------------------------------------
    Q_PROPERTY(bool                              showMarkers       READ showMarkers       WRITE setShowMarkers       NOTIFY showMarkersChanged)
    Q_PROPERTY(MarkerShapeQ                      shape             READ shape             WRITE setShape             NOTIFY shapeChanged)
    Q_PROPERTY(qreal                             markerSize        READ markerSize        WRITE setMarkerSize        NOTIFY markerSizeChanged)
    Q_PROPERTY(QColor                            markerFillColor   READ markerFillColor   WRITE setMarkerFillColor   NOTIFY markerFillColorChanged)
    Q_PROPERTY(QColor                            markerBorderColor READ markerBorderColor WRITE setMarkerBorderColor NOTIFY markerBorderColorChanged)
    Q_PROPERTY(qreal                             markerBorderWidth READ markerBorderWidth WRITE setMarkerBorderWidth NOTIFY markerBorderWidthChanged)
 
    // ---- Point labels ------------------------------------------------------
    Q_PROPERTY(bool   showPointLabels     READ showPointLabels     WRITE setShowPointLabels     NOTIFY showPointLabelsChanged)
    Q_PROPERTY(QFont  pointLabelFont      READ pointLabelFont      WRITE setPointLabelFont      NOTIFY pointLabelFontChanged)
    Q_PROPERTY(QColor pointLabelColor     READ pointLabelColor     WRITE setPointLabelColor     NOTIFY pointLabelColorChanged)
    Q_PROPERTY(LabelFormatModeQ pointLabelFormatMode READ pointLabelFormatMode WRITE setPointLabelFormatMode NOTIFY pointLabelFormatModeChanged)
    Q_PROPERTY(int    pointLabelPrecision READ pointLabelPrecision WRITE setPointLabelPrecision NOTIFY pointLabelPrecisionChanged)
    Q_PROPERTY(QString pointLabelFormat   READ pointLabelFormat    WRITE setPointLabelFormat    NOTIFY pointLabelFormatChanged)
 
    // ---- Area fill ---------------------------------------------------------
    Q_PROPERTY(bool   showAreaFill   READ showAreaFill   WRITE setShowAreaFill   NOTIFY showAreaFillChanged)
    Q_PROPERTY(QColor areaFillColor  READ areaFillColor  WRITE setAreaFillColor  NOTIFY areaFillColorChanged)
 
public:
    enum class MarkerShapeQ : int {
        Circle   = static_cast<int>(MarkerShape::Circle),
        Square   = static_cast<int>(MarkerShape::Square),
        Triangle = static_cast<int>(MarkerShape::Triangle),
        Diamond  = static_cast<int>(MarkerShape::Diamond),
        Cross    = static_cast<int>(MarkerShape::Cross),
        Plus     = static_cast<int>(MarkerShape::Plus),
    };
    Q_ENUM(MarkerShapeQ)
 
    
    enum class LabelFormatModeQ : int {
        Decimals           = static_cast<int>(NumberFormatMode::Decimals),
        SignificantFigures = static_cast<int>(NumberFormatMode::SignificantFigures),
    };
    Q_ENUM(LabelFormatModeQ)
 
    explicit SeriesStyleObject(QObject *parent = nullptr);
    explicit SeriesStyleObject(const SeriesStyle& initial, QObject *parent = nullptr);
    ~SeriesStyleObject() override = default;
 
    SeriesStyle style() const noexcept { return m_style; }
 
    void setStyle(const SeriesStyle& s);
 
    QString legendOverride() const { return m_legendOverride; }
 
    Q_INVOKABLE QString displayLabelFor(const QString &propertyName) const;
 
    // ---- Getters -----------------------------------------------------------
    QColor  color()             const noexcept { return m_style.color; }
    qreal   opacity()           const noexcept { return m_style.opacity; }
    QString legendName()        const          { return m_style.legendName; }
 
    bool             showLine()  const noexcept { return m_style.showLine; }
    qreal            lineWidth() const noexcept { return m_style.lineWidth; }
    Qt::PenStyle     dash()      const noexcept { return m_style.dash; }
    Qt::PenCapStyle  capStyle()  const noexcept { return m_style.capStyle; }
    Qt::PenJoinStyle joinStyle() const noexcept { return m_style.joinStyle; }
 
    bool          showMarkers()       const noexcept { return m_style.showMarkers; }
    MarkerShapeQ  shape()             const noexcept { return static_cast<MarkerShapeQ>(m_style.shape); }
    qreal         markerSize()        const noexcept { return m_style.markerSize; }
    QColor        markerFillColor()   const noexcept { return m_style.markerFillColor; }
    QColor        markerBorderColor() const noexcept { return m_style.markerBorderColor; }
    qreal         markerBorderWidth() const noexcept { return m_style.markerBorderWidth; }
 
    bool   showPointLabels()     const noexcept { return m_style.showPointLabels; }
    QFont  pointLabelFont()      const noexcept { return m_style.pointLabelFont; }
    QColor pointLabelColor()     const noexcept { return m_style.pointLabelColor; }
    LabelFormatModeQ pointLabelFormatMode() const noexcept
    { return static_cast<LabelFormatModeQ>(m_style.pointLabelFormatMode); }
    int    pointLabelPrecision() const noexcept { return m_style.pointLabelPrecision; }
    QString pointLabelFormat()   const          { return m_style.pointLabelFormat; }
 
    bool   showAreaFill()  const noexcept { return m_style.showAreaFill; }
    QColor areaFillColor() const noexcept { return m_style.areaFillColor; }
 
public slots:
    void setColor(const QColor& c);
    void setOpacity(qreal v);
    void setLegendName(const QString& s);
    void setLegendOverride(const QString& s);
 
    void setShowLine(bool on);
    void setLineWidth(qreal v);
    void setDash(Qt::PenStyle s);
    void setCapStyle(Qt::PenCapStyle s);
    void setJoinStyle(Qt::PenJoinStyle s);
 
    void setShowMarkers(bool on);
    void setShape(MarkerShapeQ s);
    void setMarkerSize(qreal v);
    void setMarkerFillColor(const QColor& c);
    void setMarkerBorderColor(const QColor& c);
    void setMarkerBorderWidth(qreal v);
 
    void setShowPointLabels(bool on);
    void setPointLabelFont(const QFont& f);
    void setPointLabelColor(const QColor& c);
    void setPointLabelFormatMode(LabelFormatModeQ m);
    void setPointLabelPrecision(int n);
    void setPointLabelFormat(const QString& spec);
 
    void setShowAreaFill(bool on);
    void setAreaFillColor(const QColor& c);
 
signals:
    void colorChanged(const QColor&);
    void opacityChanged(qreal);
    void legendNameChanged(const QString&);
    void legendOverrideChanged(const QString&);
 
    void showLineChanged(bool);
    void lineWidthChanged(qreal);
    void dashChanged(Qt::PenStyle);
    void capStyleChanged(Qt::PenCapStyle);
    void joinStyleChanged(Qt::PenJoinStyle);
 
    void showMarkersChanged(bool);
    void shapeChanged(MarkerShapeQ);
    void markerSizeChanged(qreal);
    void markerFillColorChanged(const QColor&);
    void markerBorderColorChanged(const QColor&);
    void markerBorderWidthChanged(qreal);
 
    void showPointLabelsChanged(bool);
    void pointLabelFontChanged(const QFont&);
    void pointLabelColorChanged(const QColor&);
    void pointLabelFormatModeChanged(LabelFormatModeQ);
    void pointLabelPrecisionChanged(int);
    void pointLabelFormatChanged(const QString&);
 
    void showAreaFillChanged(bool);
    void areaFillColorChanged(const QColor&);
 
    void styleChanged(const openswmmvis::plot::SeriesStyle& s);
 
private:
    void emitAggregate_();
 
    SeriesStyle m_style;
    QString     m_legendOverride;   
};
 
} // namespace openswmmvis::plot
 
Q_DECLARE_METATYPE(openswmmvis::plot::SeriesStyleObject::MarkerShapeQ)
Q_DECLARE_METATYPE(openswmmvis::plot::SeriesStyleObject::LabelFormatModeQ)
 
#endif // OPENSWMMVIS_PLOT_SERIESSTYLEOBJECT_H