ResInsight/ApplicationLibCode/ProjectDataModel/RimRefinementRegionCollection.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2026   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.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "cafPdmField.h"
#include "cafPdmObjectCollection.h"
#include "cafVecIjk.h"

#include <expected>
#include <memory>
#include <utility>
#include <vector>

#include <QString>

class RigRefinement;
class RimEclipseCase;
class RimRefinementRegion;

//==================================================================================================
///
/// Collection of RimRefinementRegion objects attached to a RimEclipseView. Combines selected
/// regions into a single RigRefinement for use in sector-model export.
///
//==================================================================================================
class RimRefinementRegionCollection : public caf::PdmObjectCollection<RimRefinementRegion>
{
    CAF_PDM_HEADER_INIT;

public:
    RimRefinementRegionCollection();

    bool isActive() const;

    // Hide the collection node in the project tree while it has no regions, to keep the tree tidy.
    bool shouldBeVisibleInTree() const;

    std::vector<RimRefinementRegion*> regions() const;
    std::vector<RimRefinementRegion*> activeRegions() const;

    RimRefinementRegion* addNewRegion( RimEclipseCase* eclipseCase );
    void                 addRegion( RimRefinementRegion* region );
    void                 removeRegion( RimRefinementRegion* region );

    // Combine the given regions into a single RigRefinement sized to the supplied sector
    // bounds (0-based, inclusive). Regions with disagreeing per-axis refinement on a shared
    // cell-index return a user-readable error message in the unexpected state.
    static std::expected<std::unique_ptr<RigRefinement>, QString>
        combineRefinements( const caf::VecIjk0& sectorMin, const caf::VecIjk0& sectorMax, const std::vector<RimRefinementRegion*>& regions );

    caf::PdmFieldHandle* objectToggleField() override;

protected:
    void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
    void onChildDeleted( caf::PdmChildArrayFieldHandle* childArray, std::vector<caf::PdmObjectHandle*>& referringObjects ) override;

private:
    caf::PdmField<bool> m_isActive;
};