]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Sewing.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Sewing.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 FEATURESPLUGIN_SEWING_H_
21 #define FEATURESPLUGIN_SEWING_H_
22
23 #include <FeaturesPlugin.h>
24
25 #include <ModelAPI_Feature.h>
26 #include <GeomAPI_Shape.h>
27
28
29 /** \class FeaturesPlugin_Sewing
30  *  \ingroup Plugins
31  *  \brief Feature to perform sewing operation on objects.
32  */
33 class FeaturesPlugin_Sewing : public ModelAPI_Feature
34 {
35  public:
36   /// Sewing kind.
37   inline static const std::string& ID()
38   {
39     static const std::string MY_SEWING_ID("Sewing");
40     return MY_SEWING_ID;
41   }
42
43   /// \return the kind of a feature.
44   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
45   {
46     static std::string MY_KIND = FeaturesPlugin_Sewing::ID();
47     return MY_KIND;
48   }
49
50   /// Attribute name of referenced objects.
51   inline static const std::string& OBJECTS_LIST_ID()
52   {
53     static const std::string MY_OBJECTS_LIST_ID("main_objects");
54     return MY_OBJECTS_LIST_ID;
55   }
56
57   /// Attribute name for non-manifold state.
58   inline static const std::string& ALLOW_NON_MANIFOLD_ID()
59   {
60     static const std::string MY_ALLOW_NON_MANIFOLD_ID("allow_non_manifold");
61     return MY_ALLOW_NON_MANIFOLD_ID;
62   }
63
64   /// Attribute name for tolerance.
65   inline static const std::string& TOLERANCE_ID()
66   {
67     static const std::string MY_TOLERANCE_ID("tolerance");
68     return MY_TOLERANCE_ID;
69   }
70
71   /// Attribute name for result creation state.
72   inline static const std::string& ALWAYS_CREATE_RESULT_ID()
73   {
74     static const std::string MY_ALWAYS_CREATE_RESULT_ID("always_create_result");
75     return MY_ALWAYS_CREATE_RESULT_ID;
76   }
77
78   /// Request for initialization of data model of the feature: adding all attributes.
79   FEATURESPLUGIN_EXPORT virtual void initAttributes();
80
81   /// Performs the algorithm and stores results in the data structure.
82   FEATURESPLUGIN_EXPORT virtual void execute();
83
84 public:
85   /// Use plugin manager for features creation.
86   FeaturesPlugin_Sewing();
87
88 private:
89   /// Retrieve all shapes from the selection list
90   void getOriginalShapes(const std::string& theAttributeName,
91                          ListOfShape&       theShapes);
92
93   /// Check, whether the result is sewn or not
94   bool isSewn(const ListOfShape& theInputs,
95               const GeomShapePtr theResult);
96 };
97
98 #endif // FEATURESPLUGIN_SEWING_H_