ResInsight/ApplicationLibCode/UserInterface/RiuQwtPlotTools.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2019-     Equinor 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 "RiaDateTimeDefines.h"
#include "RiaPlotDefines.h"

#include <qwt_axis_id.h>
#include <qwt_date.h>
#include <qwt_plot.h>
#include <qwt_plot_shapeitem.h>

class RiuQwtPlotLegend;
class RimPlotCurve;

class RiuPlotAxis;

class RiuQwtPlotTools
{
public:
    static void setCommonPlotBehaviour( QwtPlot* plot );
    static void setDefaultAxes( QwtPlot* plot );
    static void enableDateBasedBottomXAxis(
        QwtPlot*                         plot,
        const QString&                   dateFormat,
        const QString&                   timeFormat,
        RiaDefines::DateFormatComponents dateComponents = RiaDefines::DateFormatComponents::DATE_FORMAT_UNSPECIFIED,
        RiaDefines::TimeFormatComponents timeComponents = RiaDefines::TimeFormatComponents::TIME_FORMAT_UNSPECIFIED );

    static QString dateTimeFormatForInterval( QwtDate::IntervalType            interval,
                                              const QString&                   dateFormat,
                                              const QString&                   timeFormat,
                                              RiaDefines::DateFormatComponents dateComponents,
                                              RiaDefines::TimeFormatComponents timeComponents );

    static QwtPlotShapeItem* createBoxShape( const QString& label,
                                             double         startX,
                                             double         endX,
                                             double         startY,
                                             double         endY,
                                             QColor         color,
                                             Qt::BrushStyle brushStyle = Qt::SolidPattern );

    template <typename PlotShapeItemType>
    static PlotShapeItemType* createBoxShapeT( const QString& label,
                                               double         startX,
                                               double         endX,
                                               double         startY,
                                               double         endY,
                                               QColor         color,
                                               Qt::BrushStyle brushStyle = Qt::SolidPattern );

    static void                 updateLegendData( RiuQwtPlotLegend* legend, const std::vector<RimPlotCurve*>& curves );
    static QList<QwtLegendData> createLegendData( const std::vector<RimPlotCurve*>& curves );
    static QwtAxis::Position    toQwtPlotAxisEnum( RiaDefines::PlotAxis riaPlotAxis );

    static RiaDefines::PlotAxis fromQwtPlotAxis( QwtAxis::Position );
};

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
template <typename PlotShapeItemType>
PlotShapeItemType* RiuQwtPlotTools::createBoxShapeT( const QString& label,
                                                     double         startX,
                                                     double         endX,
                                                     double         startY,
                                                     double         endY,
                                                     QColor         color,
                                                     Qt::BrushStyle brushStyle /*= Qt::SolidPattern */ )
{
    PlotShapeItemType* columnShape = new PlotShapeItemType( label );
    QPolygonF          polygon;

    polygon.push_back( QPointF( startX, startY ) );
    polygon.push_back( QPointF( endX, startY ) );
    polygon.push_back( QPointF( endX, endY ) );
    polygon.push_back( QPointF( startX, endY ) );
    polygon.push_back( QPointF( startX, startY ) );
    columnShape->setPolygon( polygon );
    columnShape->setXAxis( QwtAxis::XBottom );
    columnShape->setBrush( QBrush( color, brushStyle ) );
    columnShape->setLegendMode( QwtPlotShapeItem::LegendShape );
    columnShape->setLegendIconSize( QSize( 16, 16 ) );
    return columnShape;
}