ResInsight/ApplicationCode/ProjectDataModel/RimCellRangeFilterCollection.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  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.
//
/////////////////////////////////////////////////////////////////////////////////

#include "RimCellRangeFilterCollection.h"

#include "Rim3dView.h"
#include "RimCellRangeFilter.h"
#include "RimViewController.h"
#include "RimViewLinker.h"

#include "cafPdmUiEditorHandle.h"

#include "cvfStructGridGeometryGenerator.h"

CAF_PDM_SOURCE_INIT( RimCellRangeFilterCollection, "CellRangeFilterCollection" );

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimCellRangeFilterCollection::RimCellRangeFilterCollection()
{
    CAF_PDM_InitObject( "Range Filters", ":/CellFilter_Range.png", "", "" );

    CAF_PDM_InitFieldNoDefault( &rangeFilters, "RangeFilters", "Range Filters", "", "", "" );
    rangeFilters.uiCapability()->setUiHidden( true );

    CAF_PDM_InitField( &isActive, "Active", true, "Active", "", "", "" );
    isActive.uiCapability()->setUiHidden( true );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimCellRangeFilterCollection::~RimCellRangeFilterCollection()
{
    rangeFilters.deleteAllChildObjects();
}

//--------------------------------------------------------------------------------------------------
/// RimCellRangeFilter is using Eclipse 1-based indexing, adjust filter values before
//  populating cvf::CellRangeFilter (which is 0-based)
//--------------------------------------------------------------------------------------------------
void RimCellRangeFilterCollection::compoundCellRangeFilter( cvf::CellRangeFilter* cellRangeFilter, size_t gridIndex ) const
{
    CVF_ASSERT( cellRangeFilter );

    for ( size_t i = 0; i < rangeFilters.size(); i++ )
    {
        RimCellRangeFilter* rangeFilter = rangeFilters[i];

        if ( rangeFilter && rangeFilter->isActive() && static_cast<size_t>( rangeFilter->gridIndex() ) == gridIndex )
        {
            if ( rangeFilter->filterMode == RimCellFilter::INCLUDE )
            {
                if ( rangeFilter->useIndividualCellIndices() )
                {
                    for ( const auto& cellIndex : rangeFilter->individualCellIndices() )
                    {
                        cellRangeFilter->addCellInclude( cellIndex.x() - 1,
                                                         cellIndex.y() - 1,
                                                         cellIndex.z() - 1,
                                                         rangeFilter->propagateToSubGrids() );
                    }
                }
                else
                {
                    cellRangeFilter->addCellIncludeRange( rangeFilter->startIndexI - 1,
                                                          rangeFilter->startIndexJ - 1,
                                                          rangeFilter->startIndexK - 1,
                                                          rangeFilter->startIndexI - 1 + rangeFilter->cellCountI,
                                                          rangeFilter->startIndexJ - 1 + rangeFilter->cellCountJ,
                                                          rangeFilter->startIndexK - 1 + rangeFilter->cellCountK,
                                                          rangeFilter->propagateToSubGrids() );
                }
            }
            else
            {
                if ( rangeFilter->useIndividualCellIndices() )
                {
                    for ( const auto& cellIndex : rangeFilter->individualCellIndices() )
                    {
                        cellRangeFilter->addCellExclude( cellIndex.x() - 1,
                                                         cellIndex.y() - 1,
                                                         cellIndex.z() - 1,
                                                         rangeFilter->propagateToSubGrids() );
                    }
                }
                else
                {
                    cellRangeFilter->addCellExcludeRange( rangeFilter->startIndexI - 1,
                                                          rangeFilter->startIndexJ - 1,
                                                          rangeFilter->startIndexK - 1,
                                                          rangeFilter->startIndexI - 1 + rangeFilter->cellCountI,
                                                          rangeFilter->startIndexJ - 1 + rangeFilter->cellCountJ,
                                                          rangeFilter->startIndexK - 1 + rangeFilter->cellCountK,
                                                          rangeFilter->propagateToSubGrids() );
                }
            }
        }
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCellRangeFilterCollection::fieldChangedByUi( const caf::PdmFieldHandle* changedField,
                                                     const QVariant&            oldValue,
                                                     const QVariant&            newValue )
{
    updateIconState();
    uiCapability()->updateConnectedEditors();

    updateDisplayModeNotifyManagedViews( nullptr );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCellRangeFilterCollection::onChildDeleted( caf::PdmChildArrayFieldHandle*      childArray,
                                                   std::vector<caf::PdmObjectHandle*>& referringObjects )
{
    updateDisplayModeNotifyManagedViews( nullptr );
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCellRangeFilterCollection::updateDisplayModeNotifyManagedViews( RimCellRangeFilter* changedRangeFilter )
{
    Rim3dView* view = nullptr;
    firstAncestorOrThisOfType( view );
    if ( !view ) return;

    if ( view->isMasterView() )
    {
        RimViewLinker* viewLinker = view->assosiatedViewLinker();
        if ( viewLinker )
        {
            // Update data for range filter
            // Update of display model is handled by view->scheduleGeometryRegen, also for managed views
            viewLinker->updateRangeFilters( changedRangeFilter );
        }
    }

    view->scheduleGeometryRegen( VISIBLE_WELL_CELLS );
    view->scheduleGeometryRegen( RANGE_FILTERED );
    view->scheduleGeometryRegen( RANGE_FILTERED_INACTIVE );

    view->scheduleCreateDisplayModelAndRedraw();
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimCellRangeFilterCollection::hasActiveFilters() const
{
    if ( !isActive() ) return false;

    for ( size_t i = 0; i < rangeFilters.size(); i++ )
    {
        if ( rangeFilters[i]->isActive() ) return true;
    }

    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimCellRangeFilterCollection::objectToggleField()
{
    return &isActive;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimCellRangeFilterCollection::hasActiveIncludeFilters() const
{
    if ( !isActive ) return false;

    for ( size_t i = 0; i < rangeFilters.size(); i++ )
    {
        if ( rangeFilters[i]->isActive() && rangeFilters[i]->filterMode() == RimCellFilter::INCLUDE ) return true;
    }

    return false;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
Rim3dView* RimCellRangeFilterCollection::baseView() const
{
    Rim3dView* rimView = nullptr;
    firstAncestorOrThisOfType( rimView );

    return rimView;
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCellRangeFilterCollection::updateIconState()
{
    bool activeIcon = true;

    RimViewController* viewController = baseView()->viewController();
    if ( viewController && ( viewController->isRangeFiltersControlled() || viewController->isVisibleCellsOveridden() ) )
    {
        activeIcon = false;
    }

    if ( !isActive )
    {
        activeIcon = false;
    }

    updateUiIconFromState( activeIcon );

    for ( size_t i = 0; i < rangeFilters.size(); i++ )
    {
        RimCellRangeFilter* rangeFilter = rangeFilters[i];
        rangeFilter->updateActiveState();
        rangeFilter->updateIconState();
    }
}

//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimCellRangeFilterCollection::defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName )
{
    PdmObject::defineUiTreeOrdering( uiTreeOrdering, uiConfigName );

    RimViewController* viewController = baseView()->viewController();
    if ( viewController && viewController->isRangeFiltersControlled() )
    {
        isActive.uiCapability()->setUiReadOnly( true );
    }
    else
    {
        isActive.uiCapability()->setUiReadOnly( false );
    }

    updateIconState();
}