Files
ResInsight/ApplicationLibCode/ProjectDataModel/Polygons/RimPolygonCollection.h
T
Magne Sjaastad dc20a016f7 #13987 PDM: Migrate Surface and Polygon collections to PdmNestedCollection
Port RimSurfaceCollection, RimPolygonCollection and the polygon-in-view
side onto the new caf::PdmNestedCollection framework, replacing the
per-class folder plumbing (m_subCollections field, topmost-folder flag,
add/remove/find sub-collection, factory, "new folder" command) with the
shared base.

- RimSurfaceCollection and RimPolygonCollection now derive from
  caf::PdmNestedCollection. Each constructor uses the generic folder
  icon and exposes a static createTopmost() that marks the top instance
  and applies the branded domain icon; RimOilField calls the factory.
- RimPolygonInViewCollection uses the new RimNestedMirrorCollectionInView
  helper, and a new RimPolygonContainer carries the source-side polygon
  link.
- RicNewSurfaceCollectionFeature is removed; the generic
  RicNewNestedCollectionFeature drives the "Add Folder" action against
  both collections.
- Update callers (RimAnnotationCollection, RimEnsembleSurface, polygon
  command features) and the scripting wrapper (RimcSurfaceCollection),
  plus the Python add-folder binding and polygon test.
2026-05-13 14:53:00 +02:00

85 lines
3.3 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2024 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 "RimPolygonContainer.h"
class RimPolygon;
class RimPolygonFile;
//==================================================================================================
///
///
//==================================================================================================
class RimPolygonCollection : public RimPolygonContainer
{
CAF_PDM_HEADER_INIT;
public:
RimPolygonCollection();
// Construct the single top-level polygon collection. Marks the instance as the topmost folder
// and applies the branded polygon icon. Sub-folders use the default folder icon from the
// constructor.
static RimPolygonCollection* createTopmost();
void loadData();
RimPolygon* createUserDefinedPolygon();
RimPolygon* appendUserDefinedPolygon();
void addUserDefinedPolygon( RimPolygon* polygon );
void deleteUserDefinedPolygons();
void deleteAllPolygons();
std::vector<RimPolygon*> allPolygons() const;
// Adds a polygon file as a sub-collection and wires the runtime side-effects
// (file-changed signal, view-tree refresh, redraw). Use this when introducing a
// file at runtime; addSubCollection() alone is fine when the side-effects will
// be triggered another way (e.g., during initAfterRead).
void addPolygonFile( RimPolygonFile* polygonFile );
static void appendPolygonMenuItems( caf::CmdFeatureMenuBuilder& menuBuilder );
private:
void onChildDeleted( caf::PdmChildArrayFieldHandle* childArray, std::vector<caf::PdmObjectHandle*>& referringObjects ) override;
void childFieldChangedByUi( const caf::PdmFieldHandle* changedChildField ) override;
void appendMenuItems( caf::CmdFeatureMenuBuilder& menuBuilder ) const override;
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
void updateViewTreeItems();
void scheduleRedrawViews();
void connectPolygonSignals( RimPolygon* polygon );
void connectPolygonFileSignals( RimPolygonFile* polygonFile );
void onPolygonChanged( const caf::SignalEmitter* emitter );
void onPolygonFileChanged( const caf::SignalEmitter* emitter );
void connectSignalsRecursively();
void connectSignalsForContainer( RimPolygonContainer* container );
private:
// Legacy field. Polygon files are now stored polymorphically inside m_subCollections
// (inherited from RimPolygonContainer). Kept declared so old projects load; migrated
// into m_subCollections in initAfterRead.
caf::PdmChildArrayField<RimPolygonFile*> m_polygonFiles_OBSOLETE;
protected:
void initAfterRead() override;
};