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_Filter_H_
21 #define ModelAPI_Filter_H_
23 #include "ModelAPI_FiltersArgs.h"
24 #include "ModelAPI_ResultBody.h"
26 #include <GeomAPI_Shape.h>
29 /**\class ModelAPI_ViewFilter
31 * \brief A general interface class filters definition
36 virtual ~ModelAPI_Filter() {}
38 /// Returns name of the filter to represent it in GUI
39 virtual const std::string& name() const = 0;
41 /// Returns true if the given shape type is supported
42 virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const = 0;
44 /// This method should contain the filter logic. It returns true if the given shape
45 /// is accepted by the filter.
46 /// \param theShape the given shape
47 /// \param theResult parent result of the shape to be checked
48 /// \param theArgs arguments of the filter
49 virtual bool isOk(const GeomShapePtr& theShape,
50 const ResultPtr& theResult,
51 const ModelAPI_FiltersArgs& theArgs) const = 0;
53 /// Returns True if the filter can be used several times within one filtering
54 virtual bool isMultiple() const { return false; }
56 /// Returns XML string which represents GUI of the filter
57 /// By default it returns nothing (no GUI)
58 virtual std::string xmlRepresentation() const { return ""; }
60 /// Initializes arguments of a filter. If a filter has no arguments, this method may be
62 virtual void initAttributes(ModelAPI_FiltersArgs& /*theArguments*/) {}
64 /// Returns XML string which represents GUI of the filter
65 /// by reading corresponding XML file.
66 MODELAPI_EXPORT virtual std::string xmlFromFile(const std::string& theConfigFile) const;
72 typedef std::shared_ptr<ModelAPI_Filter> FilterPtr;