ResInsight/ApplicationCode/UserInterface/RiuViewer.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2011-     Statoil ASA
//  Copyright (C) 2013-     Ceetron Solutions AS
//  Copyright (C) 2011-2012 Ceetron 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 "RiuViewerToViewInterface.h"
#include "RiuInterfaceToViewWindow.h"

#include "cafMouseState.h"
#include "cafPdmObject.h"
#include "cafPdmPointer.h"
#include "cafPdmInterfacePointer.h"
#include "cafViewer.h"

#include "cvfStructGrid.h"

#include <memory>

class RicCommandFeature;
class Rim3dView;
class RiuSimpleHistogramWidget;
class RiuViewerCommands;
class RivGridBoxGenerator;
class RivWindowEdgeAxesOverlayItem;

class QLabel;

namespace caf
{
    class OverlayScaleLegend;
    class TitledOverlayFrame;
    class PdmUiSelection3dEditorVisualizer;
    class QStyledProgressBar;
}

namespace cvf
{
    class Color3f;
    class Model;
    class OverlayItem;
    class Part;
    class OverlayAxisCross;
    class BoundingBox;
}

//==================================================================================================
//
// RiuViewer
//
//==================================================================================================
class RiuViewer : public caf::Viewer, public RiuInterfaceToViewWindow
{
    Q_OBJECT

public:
    RiuViewer(const QGLFormat& format, QWidget* parent);
    ~RiuViewer() override;
    void            clearRimView();
    void            setDefaultView();
    cvf::Vec3d      pointOfInterest();
    void            setPointOfInterest(cvf::Vec3d poi);
    void            setOwnerReservoirView(RiuViewerToViewInterface * owner);
    RiuViewerToViewInterface*      ownerReservoirView();
    RimViewWindow*  ownerViewWindow() const override;
    void            setEnableMask(unsigned int mask);

    void            showInfoText(bool enable);
    void            showVersionInfo(bool enable);
    void            setInfoText(QString text);

    void            hideZScaleCheckbox(bool hide);
    void            showZScaleLabel(bool enable);
    void            setZScale(int scale);

    void            showHistogram(bool enable);
    void            setHistogram(double min, double max, const std::vector<size_t>& histogram);
    void            setHistogramPercentiles(double pmin, double pmax, double mean);

    void            showGridBox(bool enable);
    void            updateGridBoxData(double scaleZ, 
                                      const cvf::Vec3d& displayModelOffset,
                                      const cvf::Color3f&  backgroundColor,
                                      const cvf::BoundingBox& domainCoordBoundingBox);
    void            showEdgeTickMarksXY(bool enable, bool showAxisLines = false);
    void            showEdgeTickMarksXZ(bool enable, bool showAxisLines = false);

    void            updateAnnotationItems();

    void            showAnimationProgress(bool enable);
    
    void            removeAllColorLegends();
    void            addColorLegendToBottomLeftCorner(caf::TitledOverlayFrame* legend);

    void            enableNavigationRotation(bool disable); 
    void            updateNavigationPolicy();

    void            navigationPolicyUpdate() override;

    void            setCurrentFrame(int frameIndex);

    void            showAxisCross(bool enable);
    void            setAxisLabels(const cvf::String& xLabel, const cvf::String& yLabel, const cvf::String& zLabel);

    cvf::Vec3d      lastPickPositionInDomainCoords() const;

    cvf::OverlayItem*   pickFixedPositionedLegend(int winPosX, int winPosY);

    void            setCursorPosition(const cvf::Vec3d& domainCoord);

    std::vector<cvf::ref<cvf::Part>> visibleParts();

    void            showScaleLegend(bool show);

    static void     setHoverCursor(const QCursor& cursor);
    static void     clearHoverCursor();

    void            updateFonts();

public slots:
    void            slotSetCurrentFrame(int frameIndex) override;
    void            slotEndAnimation() override;

protected:
    void            optimizeClippingPlanes() override;
    void            resizeGL(int width, int height) override;
    void            mouseMoveEvent(QMouseEvent* e) override;
    void            enterEvent(QEvent* e) override;
    void            leaveEvent(QEvent*) override;

private:
    void            updateLegendLayout();
    void            updateTextAndTickMarkColorForOverlayItems();
    void            updateLegendTextAndTickMarkColor(cvf::OverlayItem* legend);

    cvf::Color3f    computeContrastColor() const;

    void            updateAxisCrossTextColor();
    void            updateOverlayItemsStyle();

    void            paintOverlayItems(QPainter* painter) override;

    void            mouseReleaseEvent(QMouseEvent* event) override;
    void            mousePressEvent(QMouseEvent* event) override;

private:
    QLabel*         m_infoLabel;
    QRect           m_infoLabelOverlayArea;

    QLabel*         m_versionInfoLabel;
    bool            m_showInfoText;
    bool            m_showVersionInfo;

    QLabel*         m_zScaleLabel;
    bool            m_showZScaleLabel;
    bool            m_hideZScaleCheckbox;

    caf::QStyledProgressBar*  m_animationProgress;
    bool            m_showAnimProgress; 
    RiuSimpleHistogramWidget* m_histogramWidget;
    bool            m_showHistogram;

    cvf::ref<cvf::OverlayAxisCross> m_axisCross;
    bool                            m_showAxisCross;
    cvf::Collection<caf::TitledOverlayFrame> m_visibleLegends;

    caf::PdmInterfacePointer<RiuViewerToViewInterface>    m_rimView;
    QPoint                      m_lastMousePressPosition;

    RiuViewerCommands*          m_viewerCommands;

    RivGridBoxGenerator*        m_gridBoxGenerator;
    cvf::ref<RivWindowEdgeAxesOverlayItem> m_windowEdgeAxisOverlay;
    bool                        m_showWindowEdgeAxes;

    caf::PdmUiSelection3dEditorVisualizer* m_selectionVisualizerManager;

    cvf::Vec3d                  m_cursorPositionDomainCoords;
    bool                        m_isNavigationRotationEnabled;

    cvf::ref<caf::OverlayScaleLegend> m_scaleLegend;

    static std::unique_ptr<QCursor>    s_hoverCursor;
};