1 // Copyright (C) 2014-2022 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef ModelAPI_FiltersFactory_H_
21 #define ModelAPI_FiltersFactory_H_
23 #include "ModelAPI_Feature.h"
24 #include "ModelAPI_Filter.h"
25 #include "ModelAPI_ResultBody.h"
27 #include <GeomAPI_Shape.h>
30 /**\class ModelAPI_FiltersFactory
32 * \brief Manages registering of filters
34 class ModelAPI_FiltersFactory
37 virtual ~ModelAPI_FiltersFactory() {}
39 /// Register an instance of a filter
40 /// \param theID unique identifier of the filter, not necessary equal to the name of filter
41 /// \param theFilter the filter's instance
42 virtual void registerFilter(const std::string& theID, ModelAPI_Filter* theFilter) = 0;
44 /// Returns true if all filters of the Filters feature are ok for the Shape (taking into account
45 /// the Reversed states).
46 /// \param theFiltersFeature feature that contains all information about the filters
47 /// \param theResult parent result of the shape to check
48 /// \param theShape the checked shape
49 virtual bool isValid(FeaturePtr theFiltersFeature,
51 GeomShapePtr theShape) = 0;
53 /// Returns list of all shapes and subshapes in the study, satisfying
54 /// criteria of all filters of \a theFilterFeature.
55 /// \param theFiltersFeature feature that contains all information about the filters
56 /// \param theShapeType the type of sub-shapes to find
57 virtual std::list< std::pair<ResultPtr, GeomShapePtr> > select
58 (const FiltersFeaturePtr& theFilterFeature,
59 const GeomAPI_Shape::ShapeType theShapeType) = 0;
61 /// Returns the filters that support the given shape type
62 virtual std::list<FilterPtr> filters(GeomAPI_Shape::ShapeType theType) = 0;
64 /// Returns a filter by ID
65 virtual FilterPtr filter(std::string theID) = 0;
67 /// Returns a filter ID by the filter pointer
68 virtual std::string id(FilterPtr theFilter) = 0;
71 /// Get instance from Session
72 ModelAPI_FiltersFactory() {}