ResInsight/ApplicationLibCode/UserInterface/RiuPlotAnnotationTool.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017-     Statoil ASA
//
//  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 "cafColorTable.h"

#include "qwt_plot_marker.h"

#include <memory>
#include <vector>

#include <QPointer>

class QString;
class QwtPlot;

class RiuPlotAnnotationTool
{
public:
    enum class RegionAnnotationType
    {
        NO_ANNOTATIONS        = 0,
        FORMATION_ANNOTATIONS = 1,
        // Used to have Wbs-parameter coding as 2
        RESULT_PROPERTY_ANNOTATIONS = 3
    };
    enum RegionDisplay
    {
        DARK_LINES              = 0x01,
        COLORED_LINES           = 0x02,
        COLOR_SHADING           = 0x04,
        COLOR_SHADING_AND_LINES = 0x05,
        LIGHT_LINES             = 0x08,
    };
    enum class TrackSpan
    {
        FULL_WIDTH,
        LEFT_COLUMN,
        CENTRE_COLUMN,
        RIGHT_COLUMN
    };
    enum class Orientation
    {
        HORIZONTAL = 0,
        VERTICAL
    };

public:
    RiuPlotAnnotationTool(){};
    ~RiuPlotAnnotationTool();

    void attachNamedRegions( QwtPlot*                                      plot,
                             const std::vector<QString>&                   names,
                             const std::pair<double, double>               xRange,
                             const std::vector<std::pair<double, double>>& yPositions,
                             RegionDisplay                                 regionDisplay,
                             const caf::ColorTable&                        colorTable,
                             int                                           shadingAlphaByte,
                             bool                                          showNames   = true,
                             TrackSpan                                     trackSpan   = TrackSpan::FULL_WIDTH,
                             const std::vector<Qt::BrushStyle>&            brushStyles = {},
                             int                                           fontSize    = 0 );
    void attachWellPicks( QwtPlot* plot, const std::vector<QString>& names, const std::vector<double>& yPositions );

    void attachAnnotationLine( QwtPlot*       plot,
                               const QColor&  color,
                               const QString& annotationText,
                               const double   position,
                               Orientation    orientation );

    void attachAnnotationRange( QwtPlot*       plot,
                                const QColor&  color,
                                const QString& annotationText,
                                const double   rangeStart,
                                const double   rangeEnd,
                                Orientation    orientation );

    void horizontalRange( const QString&                  name,
                          const std::pair<double, double> yRange,
                          const QColor&                   color               = QColor( 0, 0, 100 ),
                          const QColor&                   textColor           = QColor( 0, 0, 100 ),
                          Qt::Alignment                   horizontalAlignment = Qt::AlignRight );

    void verticalRange( const QString&                  name,
                        const std::pair<double, double> xRange,
                        const QColor&                   color               = QColor( 0, 0, 100 ),
                        const QColor&                   textColor           = QColor( 0, 0, 100 ),
                        Qt::Alignment                   horizontalAlignment = Qt::AlignRight );

    void detachAllAnnotations();
    void detachAllAnnotations( Orientation orientation );

private:
    static Qt::Alignment trackTextAlignment( TrackSpan trackSpan );
    static void          horizontalDashedLine( QwtPlotMarker* line,
                                               const QString& name,
                                               double         yValue,
                                               const QColor&  color               = QColor( 0, 0, 100 ),
                                               const QColor&  textColor           = QColor( 0, 0, 100 ),
                                               Qt::Alignment  horizontalAlignment = Qt::AlignRight,
                                               int            fontSize            = 0 );

    void verticalLine( QwtPlotMarker* line,
                       const QString& name,
                       double         xValue,
                       const QColor&  color               = QColor( 0, 0, 100 ),
                       const QColor&  textColor           = QColor( 0, 0, 100 ),
                       Qt::PenStyle   lineStyle           = Qt::DashLine,
                       Qt::Alignment  horizontalAlignment = Qt::AlignRight | Qt::AlignBottom );

private:
    QPointer<QwtPlot>         m_plot;
    std::vector<QwtPlotItem*> m_horizontalMarkers;
    std::vector<QwtPlotItem*> m_verticalMarkers;
};