1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
20 #ifndef FeaturesAPI_BooleanFuse_H_
21 #define FeaturesAPI_BooleanFuse_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_BooleanFuse.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
30 class ModelHighAPI_Integer;
31 class ModelHighAPI_Selection;
33 /// \class FeaturesAPI_BooleanFuse
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for Boolean Fuse feature.
36 class FeaturesAPI_BooleanFuse: public ModelHighAPI_Interface
39 /// Constructor without values.
41 explicit FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 /// Constructor with values.
45 FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46 const std::list<ModelHighAPI_Selection>& theMainObjects,
47 const bool theRemoveEdges = false,
48 const int theVersion = 0);
50 /// Constructor with values.
52 FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
53 const std::list<ModelHighAPI_Selection>& theMainObjects,
54 const std::list<ModelHighAPI_Selection>& theToolObjects,
55 const bool theRemoveEdges = false,
56 const int theVersion = 0);
60 virtual ~FeaturesAPI_BooleanFuse();
62 INTERFACE_4(FeaturesPlugin_BooleanFuse::ID(),
63 creationMethod, FeaturesPlugin_BooleanFuse::CREATION_METHOD(),
64 ModelAPI_AttributeString, /** Creation method */,
65 mainObjects, FeaturesPlugin_BooleanFuse::OBJECT_LIST_ID(),
66 ModelAPI_AttributeSelectionList, /** Main objects */,
67 toolObjects, FeaturesPlugin_BooleanFuse::TOOL_LIST_ID(),
68 ModelAPI_AttributeSelectionList, /** Tool objects*/,
69 removeEdges, FeaturesPlugin_BooleanFuse::REMOVE_INTERSECTION_EDGES_ID(),
70 ModelAPI_AttributeBoolean, /** Remove edges */)
74 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
78 void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
82 void setRemoveEdges(const bool theRemoveEdges);
86 void setAdvancedMode(const bool theMode);
88 /// Dump wrapped feature
90 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
93 /// Pointer on Boolean object.
94 typedef std::shared_ptr<FeaturesAPI_BooleanFuse> BooleanFusePtr;
96 /// \ingroup CPPHighAPI
97 /// \brief Create Boolean Fuse feature.
99 BooleanFusePtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
100 const std::list<ModelHighAPI_Selection>& theObjects,
101 const bool theRemoveEdges = false,
102 const int theVersion = 0);
104 /// \ingroup CPPHighAPI
105 /// \brief Create Boolean Fuse feature.
107 BooleanFusePtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
108 const std::list<ModelHighAPI_Selection>& theMainObjects,
109 const std::list<ModelHighAPI_Selection>& theToolObjects,
110 const bool theRemoveEdges = false,
111 const int theVersion = 0);
113 #endif // FeaturesAPI_BooleanFuse_H_