ResInsight/ApplicationCode/UserInterface/RiuQwtPlotCurve.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2015-     Statoil ASA
//  Copyright (C) 2015-     Ceetron Solutions AS
//
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
//
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "qwt_plot_curve.h"
#include "qwt_plot_intervalcurve.h"
#include "qwt_symbol.h"

class RiuErrorBarsQwtPlotCurve;

//==================================================================================================
//
// If infinite data is present in the curve data, Qwt is not able to draw a nice curve.
// This class assumes that inf data is removed, and segments to be draw are indicated by start/stop indices into curve data.
//
// Single values in the curve are drawn using a CrossX symbol
//
//  Here you can see the curve segments visualized. Curve segments are drawn between vector indices.
//
//  0 - 1
//  5 - 7
//  9 -10
//
//                 /                    ^
//                /                   /   \
//  Curve        /                   /     \       -----        X
//
//  Values     1.0|2.0|inf|inf|inf|1.0|2.0|1.0|inf|1.0|1.0|inf|1.0|inf
//  Vec index   0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10| 11| 12| 13
//==================================================================================================
class RiuQwtPlotCurve : public QwtPlotCurve
{
public:
    enum ErrorAxis
    {
        ERROR_ALONG_X_AXIS,
        ERROR_ALONG_Y_AXIS
    };

    enum CurveInterpolationEnum
    {
        INTERPOLATION_POINT_TO_POINT,
        INTERPOLATION_STEP_LEFT,
    };

    enum LineStyleEnum
    {
        STYLE_NONE,
        STYLE_SOLID,
        STYLE_DASH,
        STYLE_DOT,
        STYLE_DASH_DOT
    };

    // Z index. Higher Z is painted in front
    enum ZIndex
    {
        Z_ENSEMBLE_CURVE            = 100,
        Z_ENSEMBLE_STAT_CURVE       = 200,
        Z_SINGLE_CURVE_NON_OBSERVED = 300,
        Z_ERROR_BARS                = 400,
        Z_SINGLE_CURVE_OBSERVED     = 500
    };

public:
    explicit RiuQwtPlotCurve( const QString& title = QString() );
    ~RiuQwtPlotCurve() override;

    void setSamplesFromXValuesAndYValues( const std::vector<double>& xValues,
                                          const std::vector<double>& yValues,
                                          bool                       keepOnlyPositiveValues );

    void setSamplesFromXValuesAndYValues( const std::vector<double>& xValues,
                                          const std::vector<double>& yValues,
                                          const std::vector<double>& errorValues,
                                          bool                       keepOnlyPositiveValues,
                                          ErrorAxis                  errorAxis = ERROR_ALONG_Y_AXIS );

    void setSamplesFromDatesAndYValues( const std::vector<QDateTime>& dateTimes,
                                        const std::vector<double>&    yValues,
                                        bool                          keepOnlyPositiveValues );

    void setSamplesFromTimeTAndYValues( const std::vector<time_t>& dateTimes,
                                        const std::vector<double>& yValues,
                                        bool                       keepOnlyPositiveValues );

    void setSamplesFromTimeTAndYValues( const std::vector<time_t>& dateTimes,
                                        const std::vector<double>& yValues,
                                        const std::vector<double>& yErrorValues,
                                        bool                       keepOnlyPositiveValues );

    void setLineSegmentStartStopIndices( const std::vector<std::pair<size_t, size_t>>& lineSegmentStartStopIndices );

    void setSymbolSkipPixelDistance( float distance );

    void attach( QwtPlot* plot );
    void detach();
    void clearErrorBars();
    void showErrorBars( bool show );
    void setErrorBarsColor( QColor color );
    void setErrorBarsXAxis( int axis );
    void setPerPointLabels( const std::vector<QString>& labels );

    void       setAppearance( LineStyleEnum          lineStyle,
                              CurveInterpolationEnum interpolationType,
                              int                    curveThickness,
                              const QColor&          curveColor );
    void       setBlackAndWhiteLegendIcon( bool blackAndWhite );
    QwtGraphic legendIcon( int index, const QSizeF& size ) const override;

protected:
    void drawCurve( QPainter*          p,
                    int                style,
                    const QwtScaleMap& xMap,
                    const QwtScaleMap& yMap,
                    const QRectF&      canvasRect,
                    int                from,
                    int                to ) const override;

    void drawSymbols( QPainter*          p,
                      const QwtSymbol&   symbol,
                      const QwtScaleMap& xMap,
                      const QwtScaleMap& yMap,
                      const QRectF&      canvasRect,
                      int                from,
                      int                to ) const override;

private:
    static std::vector<double> fromQDateTime( const std::vector<QDateTime>& dateTimes );
    static std::vector<double> fromTime_t( const std::vector<time_t>& timeSteps );

private:
    std::vector<std::pair<size_t, size_t>> m_polyLineStartStopIndices;
    float                                  m_symbolSkipPixelDistance;

    bool                  m_showErrorBars;
    QwtPlotIntervalCurve* m_errorBars;
    QwtPlot*              m_attachedToPlot;
    bool                  m_blackAndWhiteLegendIcon;

    std::vector<QString> m_perPointLabels;
};