1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef FeaturesPlugin_Cut_H_
22 #define FeaturesPlugin_Cut_H_
24 #include "FeaturesPlugin.h"
26 #include <GeomAlgoAPI_MakeShape.h>
28 #include <ModelAPI_Feature.h>
30 /// \class FeaturesPlugin_Boolean
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
46 inline static const std::string& ID()
48 static const std::string MY_ID("Boolean");
52 /// Attribute name of main objects.
53 inline static const std::string& OBJECT_LIST_ID()
55 static const std::string MY_OBJECT_LIST_ID("main_objects");
56 return MY_OBJECT_LIST_ID;
59 /// Attribute name of tool objects.
60 inline static const std::string& TOOL_LIST_ID()
62 static const std::string MY_TOOL_LIST_ID("tool_objects");
63 return MY_TOOL_LIST_ID;
66 /// Attribute name of operation type.
67 inline static const std::string& TYPE_ID()
69 static const std::string MY_TYPE_ID("bool_type");
73 /// \return the kind of a feature.
74 FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
76 static std::string MY_KIND = FeaturesPlugin_Boolean::ID();
80 /// Creates a new part document if needed.
81 FEATURESPLUGIN_EXPORT virtual void execute();
83 /// Request for initialization of data model of the feature: adding all attributes.
84 FEATURESPLUGIN_EXPORT virtual void initAttributes();
86 /// Use plugin manager for features creation.
87 FeaturesPlugin_Boolean();
90 std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
92 /// Load Naming data structure of the feature to the document
93 void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
94 const std::shared_ptr<GeomAPI_Shape> theBaseShape,
95 const ListOfShape& theTools,
96 const std::shared_ptr<GeomAPI_Shape> theResultShape,
97 GeomAlgoAPI_MakeShape& theMakeShape,
98 GeomAPI_DataMapOfShapeShape& theMapOfShapes,
99 const bool theIsStoreAsGenerated = false);