ResInsight/ApplicationLibCode/ModelVisualization/RivReservoirViewPartMgr.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 "RivCellSetEnum.h"
#include "RivReservoirPartMgr.h"

#include "cvfArray.h"

#include "cvfTransform.h"

#include "cafPdmObject.h"

#include <array>

class RimEclipseView;
class RigGridBase;
class RimCellFilterCollection;
class RimEclipsePropertyFilterCollection;
class RigActiveCellInfo;
class RimEclipseCellColors;
class RimCellEdgeColors;

namespace cvf
{
class ModelBasicList;
}

class RivReservoirViewPartMgr : public cvf::Object
{
public:
    explicit RivReservoirViewPartMgr( RimEclipseView* resv );

    cvf::Transform* scaleTransform() { return m_scaleTransform.p(); }

    void                   clearGeometryCache();
    void                   scheduleGeometryRegen( RivCellSetEnum geometryType );
    const cvf::UByteArray* cellVisibility( RivCellSetEnum geometryType, size_t gridIndex, size_t frameIndex );

    void appendStaticGeometryPartsToModel( cvf::ModelBasicList*       model,
                                           RivCellSetEnum             geometryType,
                                           const std::vector<size_t>& gridIndices );
    void ensureStaticGeometryPartsCreated( RivCellSetEnum geometryType );

    void appendDynamicGeometryPartsToModel( cvf::ModelBasicList*       model,
                                            RivCellSetEnum             geometryType,
                                            size_t                     frameIndex,
                                            const std::vector<size_t>& gridIndices );
    void ensureDynamicGeometryPartsCreated( RivCellSetEnum geometryType, size_t frameIndex );

    void updateCellColor( RivCellSetEnum geometryType, size_t timeStepIndex, cvf::Color4f color );
    void updateCellResultColor( RivCellSetEnum geometryType, size_t timeStepIndex, RimEclipseCellColors* cellResultColors );
    void updateCellEdgeResultColor( RivCellSetEnum        geometryType,
                                    size_t                timeStepIndex,
                                    RimEclipseCellColors* cellResultColors,
                                    RimCellEdgeColors*    cellEdgeResultColors );

    // Faults
    void appendFaultsStaticGeometryPartsToModel( cvf::ModelBasicList* model, RivCellSetEnum geometryType );
    void appendFaultsDynamicGeometryPartsToModel( cvf::ModelBasicList* model, RivCellSetEnum geometryType, size_t frameIndex );
    void updateFaultColors( RivCellSetEnum geometryType, size_t timeStepIndex, RimEclipseCellColors* cellResultColors );
    void updateFaultCellEdgeResultColor( RivCellSetEnum        geometryType,
                                         size_t                timeStepIndex,
                                         RimEclipseCellColors* cellResultColors,
                                         RimCellEdgeColors*    cellEdgeResultColors );

    // Fault labels
    RivCellSetEnum geometryTypeForFaultLabels( const std::set<RivCellSetEnum>& geometryTypes,
                                               bool                            showFaultsOutsideFilters ) const;
    void appendFaultLabelsStaticGeometryPartsToModel( cvf::ModelBasicList* model, RivCellSetEnum geometryType );
    void appendFaultLabelsDynamicGeometryPartsToModel( cvf::ModelBasicList* model,
                                                       RivCellSetEnum       geometryType,
                                                       size_t               frameIndex );

    // Element Vector Result
    void appendElementVectorResultDynamicGeometryPartsToModel( cvf::ModelBasicList* model,
                                                               RivCellSetEnum       geometryType,
                                                               size_t               frameIndex );

    void forceWatertightGeometryOnForType( RivCellSetEnum geometryType );
    void clearWatertightGeometryFlags();

    static void computePropertyVisibility( cvf::UByteArray*                    cellVisibilities,
                                           const RigGridBase*                  grid,
                                           size_t                              timeStepIndex,
                                           const cvf::UByteArray*              rangeFilterVisibility,
                                           RimEclipsePropertyFilterCollection* propFilterColl );

private:
    void createGeometry( RivCellSetEnum geometryType );
    void computeVisibility( cvf::UByteArray* cellVisibility, RivCellSetEnum geometryType, RigGridBase* grid, size_t gridIdx );

    void createPropertyFilteredNoneWellCellGeometry( size_t frameIndex );
    void createPropertyFilteredWellGeometry( size_t frameIndex );

    void clearGeometryCache( RivCellSetEnum geomType );

    static void computeNativeVisibility( cvf::UByteArray*         cellVisibilities,
                                         const RigGridBase*       grid,
                                         const RigActiveCellInfo* activeCellInfo,
                                         const cvf::UByteArray*   cellIsInWellStatuses,
                                         bool                     invalidCellsIsVisible,
                                         bool                     inactiveCellsIsVisible,
                                         bool                     activeCellsIsVisible );

    void computeFilterVisibility( RivCellSetEnum                 geometryType,
                                  cvf::UByteArray*               cellVisibilities,
                                  const RigGridBase*             grid,
                                  const cvf::UByteArray*         nativeVisibility,
                                  const RimCellFilterCollection* rangeFilterColl );
    void computeOverriddenCellVisibility( cvf::UByteArray* cellVisibility, const RigGridBase* grid );

    static void copyByteArray( cvf::UByteArray* dest, const cvf::UByteArray* source );

    RivReservoirPartMgr* reservoirPartManager( RivCellSetEnum geometryType, size_t timeStepIndex );

private:
    std::array<RivReservoirPartMgr, PROPERTY_FILTERED> m_geometries;
    std::array<bool, PROPERTY_FILTERED>                m_geometriesNeedsRegen;

    cvf::Collection<RivReservoirPartMgr> m_propFilteredGeometryFrames;
    std::vector<uchar>                   m_propFilteredGeometryFramesNeedsRegen;

    cvf::Collection<RivReservoirPartMgr> m_propFilteredWellGeometryFrames;
    std::vector<uchar>                   m_propFilteredWellGeometryFramesNeedsRegen;

    cvf::ref<cvf::Transform>        m_scaleTransform;
    caf::PdmPointer<RimEclipseView> m_reservoirView;
};