]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Boolean.h
Salome HOME
Reverted some changes in salome build/run scripts.
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Boolean.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_Boolean_H_
22 #define FeaturesPlugin_Boolean_H_
23
24 #include "FeaturesPlugin.h"
25
26 #include <GeomAlgoAPI_MakeShape.h>
27
28 #include <ModelAPI_Feature.h>
29
30 /// \class FeaturesPlugin_Boolean
31 /// \ingroup Plugins
32 /// \brief Feature for applying of Boolean operations on Solids.
33 /// Supports four kinds of Boolean operations: Cut, Fuse, Common and Smash.
34 class FeaturesPlugin_Boolean : public ModelAPI_Feature
35 {
36 public:
37   enum OperationType {
38     BOOL_CUT,
39     BOOL_FUSE,
40     BOOL_COMMON,
41     BOOL_FILL,
42     BOOL_SMASH
43   };
44
45   /// Attribute name of main objects.
46   inline static const std::string& OBJECT_LIST_ID()
47   {
48     static const std::string MY_OBJECT_LIST_ID("main_objects");
49     return MY_OBJECT_LIST_ID;
50   }
51
52   /// Attribute name of tool objects.
53   inline static const std::string& TOOL_LIST_ID()
54   {
55     static const std::string MY_TOOL_LIST_ID("tool_objects");
56     return MY_TOOL_LIST_ID;
57   }
58
59   /// \return boolean operation type.
60   FEATURESPLUGIN_EXPORT OperationType operationType();
61
62   /// Creates a new part document if needed.
63   FEATURESPLUGIN_EXPORT virtual void execute();
64
65   /// Request for initialization of data model of the feature: adding all attributes.
66   FEATURESPLUGIN_EXPORT virtual void initAttributes();
67
68 protected:
69
70   /// Use plugin manager for features creation.
71   FeaturesPlugin_Boolean(const OperationType theOperationType);
72
73 private:
74   std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
75
76   /// Load Naming data structure of the feature to the document
77   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
78                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
79                     const ListOfShape& theTools,
80                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
81                     GeomAlgoAPI_MakeShape& theMakeShape,
82                     GeomAPI_DataMapOfShapeShape& theMapOfShapes,
83                     const bool theIsStoreAsGenerated = false);
84
85 private:
86   OperationType myOperationType;
87 };
88
89 #endif