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_ListOfFilter.hxx>
0021 #include <SelectMgr_Filter.hxx>
0022 #include <TopAbs_ShapeEnum.hxx>
0023
0024 DEFINE_STANDARD_HANDLE(SelectMgr_CompositionFilter, SelectMgr_Filter)
0025
0026 //! A framework to define a compound filter composed of
0027 //! two or more simple filters.
0028 class SelectMgr_CompositionFilter : public SelectMgr_Filter
0029 {
0030
0031 public:
0032
0033   //! Adds the filter afilter to a filter object created by a
0034   //! filter class inheriting this framework.
0035   Standard_EXPORT void Add (const Handle(SelectMgr_Filter)& afilter);
0036
0037   //! Removes the filter aFilter from this framework.
0038   Standard_EXPORT void Remove (const Handle(SelectMgr_Filter)& aFilter);
0039
0040   //! Returns true if this framework is empty.
0041   Standard_EXPORT Standard_Boolean IsEmpty() const;
0042
0043   //! Returns true if the filter aFilter is in this framework.
0044   Standard_EXPORT Standard_Boolean IsIn (const Handle(SelectMgr_Filter)& aFilter) const;
0045
0046   //! Returns the list of stored filters from this framework.
0047   const SelectMgr_ListOfFilter& StoredFilters() const { return myFilters; }
0048
0049   //! Clears the filters used in this framework.
0050   Standard_EXPORT void Clear();
0051
0052   Standard_EXPORT virtual Standard_Boolean ActsOn (const TopAbs_ShapeEnum aStandardMode) const Standard_OVERRIDE;
0053
0054   DEFINE_STANDARD_RTTIEXT(SelectMgr_CompositionFilter,SelectMgr_Filter)
0055
0056 protected:
0057
0058   SelectMgr_ListOfFilter myFilters;
0059
0060 };
0061
0062 #endif // _SelectMgr_CompositionFilter_HeaderFile