]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Union.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Union.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_Union_H_
21 #define FeaturesPlugin_Union_H_
22
23 #include "FeaturesPlugin_VersionedBoolean.h"
24
25 /// \class FeaturesPlugin_Union
26 /// \ingroup Plugins
27 /// \brief Feature for applying of Union operations on Shapes. Union removes shared shapes from
28 ///        several shapes and combines them into one.
29 class FeaturesPlugin_Union : public FeaturesPlugin_VersionedBoolean
30 {
31 public:
32   /// Feature kind.
33   inline static const std::string& ID()
34   {
35     static const std::string MY_ID("Union");
36     return MY_ID;
37   }
38
39   /// Attribute name of base objects.
40   inline static const std::string& BASE_OBJECTS_ID()
41   {
42     static const std::string MY_BASE_OBJECTS_ID("base_objects");
43     return MY_BASE_OBJECTS_ID;
44   }
45
46   /// Attribute name of use fuzzy parameter.
47   inline static const std::string& USE_FUZZY_ID()
48   {
49     static const std::string MY_USE_FUZZY_ID("use_fuzzy");
50     return MY_USE_FUZZY_ID;
51   }
52
53   /// Attribute name of fuzzy parameter.
54   inline static const std::string& FUZZY_PARAM_ID()
55   {
56     static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
57     return MY_FUZZY_PARAM_ID;
58   }
59
60   /// \return the kind of a feature.
61   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
62   {
63     static std::string MY_KIND = FeaturesPlugin_Union::ID();
64     return MY_KIND;
65   }
66
67   /// Performs the algorithm and stores results it in the data structure.
68   FEATURESPLUGIN_EXPORT virtual void execute();
69
70   /// Request for initialization of data model of the feature: adding all attributes
71   FEATURESPLUGIN_EXPORT virtual void initAttributes();
72
73   /// Use plugin manager for features creation
74   FeaturesPlugin_Union();
75 };
76
77 #endif