]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Intersection.h
Salome HOME
Reverted some changes in salome build/run scripts.
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Intersection.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef FeaturesPlugin_Intersection_H_
22 #define FeaturesPlugin_Intersection_H_
23
24 #include "FeaturesPlugin.h"
25
26 #include <ModelAPI_Feature.h>
27
28 #include <GeomAPI_Shape.h>
29
30 class GeomAlgoAPI_MakeShape;
31
32 /// \class FeaturesPlugin_Intersection
33 /// \ingroup Plugins
34 /// \brief Intersection feature takes a list of shapes as objects and list of shapes as tools.
35 /// The types of objects and tools may be different:
36 /// whole objects, compsoilds, solids, shells, faces or edges.
37 /// The result is less than the minimal dimension from pair of intersection:
38 /// for two solids or two faces it is wire, for the edge and face it is vertex, etc.
39 class FeaturesPlugin_Intersection : public ModelAPI_Feature
40 {
41 public:
42   /// Feature kind.
43   inline static const std::string& ID()
44   {
45     static const std::string MY_ID("Intersection");
46     return MY_ID;
47   }
48
49   /// Attribute name of objects.
50   inline static const std::string& OBJECT_LIST_ID()
51   {
52     static const std::string MY_OBJECT_LIST_ID("main_objects");
53     return MY_OBJECT_LIST_ID;
54   }
55
56   /// Returns the kind of a feature.
57   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
58   {
59     static std::string MY_KIND = FeaturesPlugin_Intersection::ID();
60     return MY_KIND;
61   }
62
63   /// Executes feature.
64   FEATURESPLUGIN_EXPORT virtual void execute();
65
66   /// Request for initialization of data model of the feature: adding all attributes.
67   FEATURESPLUGIN_EXPORT virtual void initAttributes();
68
69   /// Use plugin manager for features creation.
70   FeaturesPlugin_Intersection();
71
72 private:
73   /// Load Naming data structure of the feature to the document.
74   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
75                     const ListOfShape& theObjects,
76                     GeomAlgoAPI_MakeShape& theMakeShape);
77 };
78
79 #endif