Salome HOME
2d609cbbe0b04b819e4432922efd0d7991a58765
[modules/shaper.git] / src / FiltersPlugin / FiltersPlugin_ContinuousFaces.h
1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef FILTERSPLUGIN_CONTINUOUSFACES_H_
21 #define FILTERSPLUGIN_CONTINUOUSFACES_H_
22
23 #include "FiltersPlugin.h"
24
25 #include <GeomAPI_Shape.h>
26 #include <ModelAPI_Filter.h>
27
28 #include <set>
29
30 typedef std::set<GeomShapePtr, GeomAPI_Shape::Comparator> SetOfShapes;
31
32 /**\class FiltersPlugin_ContinuousFaces
33 * \ingroup DataModel
34 * \brief Filter for face with specific area
35 */
36 class FiltersPlugin_ContinuousFaces : public ModelAPI_Filter
37 {
38 public:
39   FiltersPlugin_ContinuousFaces() : ModelAPI_Filter() {
40     myAngle = 0.0;
41   }
42
43   virtual const std::string& name() const {
44     static const std::string kName("Continuous faces");
45     return kName;
46   }
47
48   /// Returns true for face type
49   virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const override;
50
51   /// This method should contain the filter logic. It returns true if the given shape
52   /// is accepted by the filter.
53   /// \param theShape the given shape
54   /// \param theArgs arguments of the filter
55   virtual bool isOk(const GeomShapePtr& theShape, const ResultPtr&,
56                     const ModelAPI_FiltersArgs& theArgs) const override;
57
58   /// Returns XML string which represents GUI of the filter
59   virtual std::string xmlRepresentation() const override;
60
61   /// Initializes arguments of a filter.
62   virtual void initAttributes(ModelAPI_FiltersArgs& theArguments) override;
63
64   private:
65     /// Original faces selected for filtering
66     SetOfShapes myFaces;
67     /// Shapes applicable for the filter
68     SetOfShapes myCachedShapes;
69     /// Angle tolerance
70     double myAngle;
71 };
72
73 #endif