Support both AND and OR operations when combining range and index filters (#11275)

Support both AND and OR operations when combining range and index filters

ApplicationLibCode/ProjectDataModel/CellFilters/RimCellFilterCollection.cpp

@@ -24,6 +24,7 @@
 #include "RimCellIndexFilter.h"
 #include "RimCellRangeFilter.h"
 #include "RimPolygonFilter.h"
+#include "RimProject.h"
 #include "RimUserDefinedFilter.h"
 #include "RimUserDefinedIndexFilter.h"
 #include "RimViewController.h"
@@ -32,8 +33,21 @@
 #include "cafPdmFieldReorderCapability.h"
 #include "cafPdmFieldScriptingCapability.h"
 #include "cafPdmObjectScriptingCapability.h"
+#include "cafPdmUiLabelEditor.h"
+
 #include "cvfStructGridGeometryGenerator.h"
 
+namespace caf
+{
+template <>
+void caf::AppEnum<RimCellFilterCollection::CombineFilterModeType>::setUp()
+{
+    addItem( RimCellFilterCollection::AND, "AND", "AND" );
+    addItem( RimCellFilterCollection::OR, "OR", "OR" );
+    setDefault( RimCellFilterCollection::AND );
+}
+} // namespace caf
+
 CAF_PDM_SOURCE_INIT( RimCellFilterCollection, "CellFilterCollection", "RimCellFilterCollection", "CellRangeFilterCollection" );
 
 //--------------------------------------------------------------------------------------------------
@@ -47,6 +61,12 @@ RimCellFilterCollection::RimCellFilterCollection()
     CAF_PDM_InitScriptableField( &m_isActive, "Active", true, "Active" );
     m_isActive.uiCapability()->setUiHidden( true );
 
+    CAF_PDM_InitFieldNoDefault( &m_combineFilterMode, "CombineFilterMode", "" );
+
+    CAF_PDM_InitField( &m_combineModeLabel, "CombineModeLabel", QString( "" ), "Combine Polygon and Range Filters Using Operation" );
+    m_combineModeLabel.uiCapability()->setUiEditorTypeName( caf::PdmUiLabelEditor::uiEditorTypeName() );
+    m_combineModeLabel.xmlCapability()->disableIO();
+
     CAF_PDM_InitFieldNoDefault( &m_cellFilters, "CellFilters", "Filters" );
     caf::PdmFieldReorderCapability::addToField( &m_cellFilters );
 
@@ -87,6 +107,14 @@ void RimCellFilterCollection::setActive( bool bActive )
     updateIconState();
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RimCellFilterCollection::useAndOperation() const
+{
+    return m_combineFilterMode() == RimCellFilterCollection::AND;
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -124,6 +152,12 @@ void RimCellFilterCollection::initAfterRead()
         m_cellFilters.push_back( filter );
     }
 
+    // fallback to OR mode for older projects made without AND support
+    if ( RimProject::current()->isProjectFileVersionEqualOrOlderThan( "2023.12.0" ) )
+    {
+        m_combineFilterMode = RimCellFilterCollection::OR;
+    }
+
     // Copy by xml serialization does not give a RimCase parent the first time initAfterRead is called here when creating a new a contour
     // view from a 3d view. The second time we get called it is ok, so just skip setting up the filter connections if we have no case.
     auto rimCase = firstAncestorOrThisOfType<RimCase>();
@@ -161,6 +195,17 @@ caf::PdmFieldHandle* RimCellFilterCollection::objectToggleField()
     return &m_isActive;
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimCellFilterCollection::defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering )
+{
+    uiOrdering.add( &m_combineModeLabel );
+    uiOrdering.add( &m_combineFilterMode );
+
+    uiOrdering.skipRemainingFields();
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -182,6 +227,18 @@ void RimCellFilterCollection::defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTr
     updateIconState();
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimCellFilterCollection::defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute )
+{
+    caf::PdmUiLabelEditorAttribute* myAttr = dynamic_cast<caf::PdmUiLabelEditorAttribute*>( attribute );
+    if ( myAttr )
+    {
+        myAttr->m_useSingleWidgetInsteadOfLabelAndEditorWidget = true;
+    }
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------

ApplicationLibCode/ProjectDataModel/CellFilters/RimCellFilterCollection.h

@@ -49,6 +49,12 @@ class RimCellFilterCollection : public caf::PdmObject
     CAF_PDM_HEADER_INIT;
 
 public:
+    enum CombineFilterModeType
+    {
+        OR,
+        AND
+    };
+
     RimCellFilterCollection();
     ~RimCellFilterCollection() override;
 
@@ -68,6 +74,8 @@ public:
     bool isActive() const;
     void setActive( bool bActive );
 
+    bool useAndOperation() const;
+
     void compoundCellRangeFilter( cvf::CellRangeFilter* cellRangeFilter, size_t gridIndex ) const;
     void updateCellVisibilityByIndex( cvf::UByteArray* cellsIncluded, cvf::UByteArray* cellsExcluded, size_t gridIndex ) const;
 
@@ -87,7 +95,10 @@ public:
 
 protected:
     void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
+    void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
     void defineUiTreeOrdering( caf::PdmUiTreeOrdering& uiTreeOrdering, QString uiConfigName ) override;
+    void defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;
+
     caf::PdmFieldHandle* objectToggleField() override;
     void                 initAfterRead() override;
 
@@ -97,8 +108,10 @@ private:
     void setAutoName( RimCellFilter* pFilter );
     void addFilter( RimCellFilter* pFilter );
 
-    caf::PdmChildArrayField<RimCellFilter*> m_cellFilters;
-    caf::PdmField<bool>                     m_isActive;
+    caf::PdmChildArrayField<RimCellFilter*>            m_cellFilters;
+    caf::PdmField<bool>                                m_isActive;
+    caf::PdmField<QString>                             m_combineModeLabel;
+    caf::PdmField<caf::AppEnum<CombineFilterModeType>> m_combineFilterMode;
 
     caf::PdmChildArrayField<RimCellRangeFilter*> m_rangeFilters_OBSOLETE;
 };