]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Intersection.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Intersection.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_Intersection_H_
21 #define FeaturesPlugin_Intersection_H_
22
23 #include "FeaturesPlugin_VersionedBoolean.h"
24
25 class GeomAlgoAPI_MakeShape;
26
27 /// \class FeaturesPlugin_Intersection
28 /// \ingroup Plugins
29 /// \brief Intersection feature takes a list of shapes as objects and list of shapes as tools.
30 /// The types of objects and tools may be different:
31 /// whole objects, compsoilds, solids, shells, faces or edges.
32 /// The result is less than the minimal dimension from pair of intersection:
33 /// for two solids or two faces it is wire, for the edge and face it is vertex, etc.
34 class FeaturesPlugin_Intersection : public FeaturesPlugin_VersionedBoolean
35 {
36 public:
37   /// Feature kind.
38   inline static const std::string& ID()
39   {
40     static const std::string MY_ID("Intersection");
41     return MY_ID;
42   }
43
44   /// Attribute name of objects.
45   inline static const std::string& OBJECT_LIST_ID()
46   {
47     static const std::string MY_OBJECT_LIST_ID("main_objects");
48     return MY_OBJECT_LIST_ID;
49   }
50
51   /// Attribute name of use fuzzy parameter.
52   inline static const std::string& USE_FUZZY_ID()
53   {
54     static const std::string MY_USE_FUZZY_ID("use_fuzzy");
55     return MY_USE_FUZZY_ID;
56   }
57
58   /// Attribute name of fuzzy parameter.
59   inline static const std::string& FUZZY_PARAM_ID()
60   {
61     static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
62     return MY_FUZZY_PARAM_ID;
63   }
64
65   /// Returns the kind of a feature.
66   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
67   {
68     static std::string MY_KIND = FeaturesPlugin_Intersection::ID();
69     return MY_KIND;
70   }
71
72   /// Executes feature.
73   FEATURESPLUGIN_EXPORT virtual void execute();
74
75   /// Request for initialization of data model of the feature: adding all attributes.
76   FEATURESPLUGIN_EXPORT virtual void initAttributes();
77
78   /// Use plugin manager for features creation.
79   FeaturesPlugin_Intersection();
80 };
81
82 #endif