include/opencascade/SelectMgr_CompositionFilter.hxx

0001 // Created on: 1996-01-29
0002 // Created by: Robert COUBLANC
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _SelectMgr_CompositionFilter_HeaderFile
0018 #define _SelectMgr_CompositionFilter_HeaderFile
0019
0020 #include <SelectMgr_Filter.hxx>
0021 #include <NCollection_List.hxx>
0022 #include <TopAbs_ShapeEnum.hxx>
0023
0024 //! A framework to define a compound filter composed of
0025 //! two or more simple filters.
0026 class SelectMgr_CompositionFilter : public SelectMgr_Filter
0027 {
0028
0029 public:
0030   //! Adds the filter afilter to a filter object created by a
0031   //! filter class inheriting this framework.
0032   Standard_EXPORT void Add(const occ::handle<SelectMgr_Filter>& afilter);
0033
0034   //! Removes the filter aFilter from this framework.
0035   Standard_EXPORT void Remove(const occ::handle<SelectMgr_Filter>& aFilter);
0036
0037   //! Returns true if this framework is empty.
0038   Standard_EXPORT bool IsEmpty() const;
0039
0040   //! Returns true if the filter aFilter is in this framework.
0041   Standard_EXPORT bool IsIn(const occ::handle<SelectMgr_Filter>& aFilter) const;
0042
0043   //! Returns the list of stored filters from this framework.
0044   const NCollection_List<occ::handle<SelectMgr_Filter>>& StoredFilters() const { return myFilters; }
0045
0046   //! Clears the filters used in this framework.
0047   Standard_EXPORT void Clear();
0048
0049   Standard_EXPORT bool ActsOn(const TopAbs_ShapeEnum aStandardMode) const override;
0050
0051   DEFINE_STANDARD_RTTIEXT(SelectMgr_CompositionFilter, SelectMgr_Filter)
0052
0053 protected:
0054   NCollection_List<occ::handle<SelectMgr_Filter>> myFilters;
0055 };
0056
0057 #endif // _SelectMgr_CompositionFilter_HeaderFile