ResInsight/ApplicationCode/ProjectDataModel/RimViewLinker.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 "RivCellSetEnum.h"

#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmPtrField.h"

#include "cvfVector3.h"

namespace caf
{
class IconProvider;
}

namespace cvf
{
class BoundingBox;
}

class RimViewController;
class RiuViewer;
class RimGridView;
class RimCellRangeFilter;
class RimPropertyFilter;

//==================================================================================================
///
///
//==================================================================================================
class RimViewLinker : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    RimViewLinker();
    ~RimViewLinker() override;

    bool isActive() const;

    void         setMasterView( RimGridView* view );
    RimGridView* masterView() const;
    void         addDependentView( RimGridView* view );
    bool         isFirstViewDependentOnSecondView( const RimGridView* firstView, const RimGridView* secondView ) const;
    void         updateDependentViews();
    void         removeViewController( RimViewController* viewController );
    RimGridView* firstControlledView();

    void updateOverrides();

    void updateCamera( RimGridView* sourceView );
    void updateTimeStep( RimGridView* sourceView, int timeStep );
    void updateScaleZ( RimGridView* sourceView, double scaleZ );

    void updateCellResult();

    void updateRangeFilters( RimCellRangeFilter* changedRangeFilter );
    void applyRangeFilterCollectionByUserChoice();

    void updatePropertyFilters( RimPropertyFilter* changedPropertyFilter );

    void scheduleGeometryRegenForDepViews( RivCellSetEnum geometryType );
    void scheduleCreateDisplayModelAndRedrawForDependentViews();

    void allViews( std::vector<RimGridView*>& views ) const;

    void updateUiNameAndIcon();

    void addViewControllers( caf::PdmUiTreeOrdering& uiTreeOrdering ) const;

    static void findNameAndIconFromView( QString* name, caf::IconProvider* icon, RimGridView* view );

    void updateCursorPosition( const RimGridView* sourceView, const cvf::Vec3d& domainCoord );

    void notifyManagedViewChange( RimGridView* oldManagedView, RimGridView* newManagedView );

protected:
    caf::PdmFieldHandle* userDescriptionField() override { return &m_name; }

    void initAfterRead() override;
    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;

    QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions,
                                                         bool*                      useOptionsOnly ) override;

    virtual void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;

private:
    static QString displayNameForView( RimGridView* view );

    void allViewsForCameraSync( const RimGridView* source, std::vector<RimGridView*>& views ) const;

    void removeOverrides();

private:
    caf::PdmChildArrayField<RimViewController*> m_viewControllers;
    caf::PdmPtrField<RimGridView*>              m_masterView;
    caf::PdmField<QString>                      m_name;
    caf::PdmPtrField<RimGridView*>              m_comparisonView;
};