ResInsight/ApplicationCode/ProjectDataModel/GridCrossPlots/RimGridCrossPlotCurve.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  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.
//
/////////////////////////////////////////////////////////////////////////////////
#include "RimGridCrossPlotCurve.h"

#include "RiaColorTables.h"

#include "RigCaseCellResultCalculator.h"
#include "RiuQwtSymbol.h"

#include "RimCase.h"
#include "RimEclipseCase.h"
#include "RimEclipseResultDefinition.h"
#include "RimGridCrossPlot.h"
#include "RimTools.h"

#include "cafPdmUiComboBoxEditor.h"

#include <QDebug>
#include <QPointF>
#include <QVector>

#include "qwt_plot.h"
#include "qwt_plot_curve.h"
#include "qwt_graphic.h"

#include <random>

CAF_PDM_SOURCE_INIT(RimGridCrossPlotCurve, "GridCrossPlotCurve");

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimGridCrossPlotCurve::RimGridCrossPlotCurve()
    : m_curveSetIndex(0)
    , m_categoryIndex(0)
    , m_categoryCount(0)
{
    CAF_PDM_InitObject("Cross Plot Points", ":/WellLogCurve16x16.png", "", "");
   
    setLineStyle(RiuQwtPlotCurve::STYLE_NONE);
    setSymbol(RiuQwtSymbol::SYMBOL_NONE);
    setSymbolSize(6);
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::setCategoryInformation(int curveSetIndex, int categoryIndex, int categoryCount)
{
    m_curveSetIndex = curveSetIndex;
    m_categoryIndex = categoryIndex;
    m_categoryCount = categoryCount;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::setUseContrastColors(bool useContrastColors)
{
    m_useContrastColors = useContrastColors;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::setSamples(const std::vector<double>& xValues, const std::vector<double>& yValues)
{
    CVF_ASSERT(xValues.size() == yValues.size());

    m_qwtPlotCurve->setSamples(&xValues[0], &yValues[0], static_cast<int>(xValues.size()));
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::updateCurveAppearance()
{
    determineColorAndSymbol();
    RimPlotCurve::updateCurveAppearance();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
int RimGridCrossPlotCurve::categoryIndex() const
{
    return m_categoryIndex;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::determineColorAndSymbol()
{
    if (m_useContrastColors)
    {
        const caf::ColorTable& colors     = RiaColorTables::categoryPaletteColors();
        int                    colorIndex = m_categoryIndex + m_curveSetIndex; // Offset cycle for each curve set
        setColor(colors.cycledColor3f(colorIndex));
        int numColors = (int)colors.size();

        // Retain same symbol until we've gone full cycle in colors
        int symbolIndex = m_categoryIndex / numColors;

        RiuQwtSymbol::PointSymbolEnum symbol = RiuQwtSymbol::cycledSymbolStyle(m_curveSetIndex, symbolIndex);
        setSymbol(symbol);
    }
    else
    {
        const caf::ColorTable& colors           = RiaColorTables::contrastCategoryPaletteColors();
        cvf::Color3ub          cycledBaseColor  = colors.cycledColor3ub(m_curveSetIndex);
        caf::ColorTable        hueConstColTable = RiaColorTables::createBrightnessBasedColorTable(cycledBaseColor, m_categoryCount);
        setColor(hueConstColTable.cycledColor3f(m_categoryIndex));
        RiuQwtSymbol::PointSymbolEnum symbol = RiuQwtSymbol::cycledFilledSymbolStyle(m_curveSetIndex);
        setSymbol(symbol);
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::updateZoomInParentPlot()
{
    RimGridCrossPlot* plot;
    this->firstAncestorOrThisOfTypeAsserted(plot);
    plot->calculateZoomRangeAndUpdateQwt();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::updateLegendsInPlot() 
{
    RimGridCrossPlot* plot = nullptr;
    this->firstAncestorOrThisOfType(plot);
    if (plot)
    {
        plot->reattachCurvesToQwtAndReplot();
    }
    RimPlotCurve::updateLegendsInPlot();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimGridCrossPlotCurve::createCurveAutoName()
{
    return m_customCurveName;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::onLoadDataAndUpdate(bool updateParentPlot)
{
    if (updateParentPlot)
    {
        RimGridCrossPlot* crossPlot;
        firstAncestorOrThisOfTypeAsserted(crossPlot);
        crossPlot->reattachCurvesToQwtAndReplot();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimGridCrossPlotCurve::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
{
    caf::PdmUiGroup* appearanceGroup = uiOrdering.addNewGroup("Appearance");
    RimPlotCurve::appearanceUiOrdering(*appearanceGroup);
    caf::PdmUiGroup* nameGroup = uiOrdering.addNewGroup("Curve Name");
    nameGroup->add(&m_curveName);
    nameGroup->add(&m_showLegend);
    uiOrdering.skipRemainingFields(true);
}