SHAPER  9.12.0
FeaturesAPI_BooleanFuse.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 FeaturesAPI_BooleanFuse_H_
21 #define FeaturesAPI_BooleanFuse_H_
22 
23 #include "FeaturesAPI.h"
24 
25 #include <FeaturesPlugin_BooleanFuse.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 #include <ModelHighAPI_Double.h>
30 
33 
38 {
39 public:
41  FEATURESAPI_EXPORT
42  explicit FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 
45  FEATURESAPI_EXPORT
46  FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47  const std::list<ModelHighAPI_Selection>& theMainObjects,
48  const bool theRemoveEdges = false,
49  const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
50 
52  FEATURESAPI_EXPORT
53  FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
54  const std::list<ModelHighAPI_Selection>& theMainObjects,
55  const std::list<ModelHighAPI_Selection>& theToolObjects,
56  const bool theRemoveEdges = false,
57  const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
58 
60  FEATURESAPI_EXPORT
61  virtual ~FeaturesAPI_BooleanFuse();
62 
63  INTERFACE_6(FeaturesPlugin_BooleanFuse::ID(),
76 
77 
78  FEATURESAPI_EXPORT
79  void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
80 
82  FEATURESAPI_EXPORT
83  void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
84 
86  FEATURESAPI_EXPORT
87  void setRemoveEdges(const bool theRemoveEdges);
88 
90  FEATURESAPI_EXPORT
91  void setUseFuzzy(bool theUseFuzzy);
92 
94  FEATURESAPI_EXPORT
95  void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
96 
98  FEATURESAPI_EXPORT
99  void setAdvancedMode(const bool theMode);
100 
102  FEATURESAPI_EXPORT
103  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
104 };
105 
107 typedef std::shared_ptr<FeaturesAPI_BooleanFuse> BooleanFusePtr;
108 
109 #define DUMMY_TOOLS std::pair<std::list<ModelHighAPI_Selection>, bool>\
110  (std::list<ModelHighAPI_Selection>(), false)
111 
114 FEATURESAPI_EXPORT BooleanFusePtr addFuse(
115  const std::shared_ptr<ModelAPI_Document>& part,
116  const std::list<ModelHighAPI_Selection>& objects,
117  const std::pair<std::list<ModelHighAPI_Selection>, bool>& tools = DUMMY_TOOLS,
118  const bool removeEdges = false,
120  const bool keepSubResults = false);
121 
122 #endif // FeaturesAPI_BooleanFuse_H_
Interface for Boolean Fuse feature.
Definition: FeaturesAPI_BooleanFuse.h:38
virtual ~FeaturesAPI_BooleanFuse()
Destructor.
Definition: FeaturesAPI_BooleanFuse.cpp:93
virtual std::shared_ptr< ModelAPI_AttributeDouble > fuzzyParam() const
Fuzzy parameter.
Definition: FeaturesAPI_BooleanFuse.h:75
void setAdvancedMode(const bool theMode)
Set mode.
Definition: FeaturesAPI_BooleanFuse.cpp:142
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > toolObjects() const
Tool objects.
Definition: FeaturesAPI_BooleanFuse.h:75
FeaturesAPI_BooleanFuse(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_BooleanFuse.cpp:31
void setMainObjects(const std::list< ModelHighAPI_Selection > &theMainObjects)
Set main objects.
Definition: FeaturesAPI_BooleanFuse.cpp:99
void setToolObjects(const std::list< ModelHighAPI_Selection > &theToolObjects)
Set tool objects.
Definition: FeaturesAPI_BooleanFuse.cpp:108
void setUseFuzzy(bool theUseFuzzy)
Set use fuzzy parameter.
Definition: FeaturesAPI_BooleanFuse.cpp:126
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > mainObjects() const
Main objects.
Definition: FeaturesAPI_BooleanFuse.h:75
virtual std::shared_ptr< ModelAPI_AttributeBoolean > removeEdges() const
Remove edges.
Definition: FeaturesAPI_BooleanFuse.h:75
virtual std::shared_ptr< ModelAPI_AttributeBoolean > useFuzzy() const
Use Fuzzy parameter.
Definition: FeaturesAPI_BooleanFuse.h:75
void setFuzzyValue(const ModelHighAPI_Double &theFuzzy)
Set fuzzy parameter.
Definition: FeaturesAPI_BooleanFuse.cpp:134
void setRemoveEdges(const bool theRemoveEdges)
Set remove edges.
Definition: FeaturesAPI_BooleanFuse.cpp:118
virtual std::shared_ptr< ModelAPI_AttributeString > creationMethod() const
Creation method.
Definition: FeaturesAPI_BooleanFuse.h:75
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_BooleanFuse.cpp:154
static const std::string & OBJECT_LIST_ID()
Attribute name of main objects.
Definition: FeaturesPlugin_BooleanFuse.h:68
static const std::string & REMOVE_INTERSECTION_EDGES_ID()
Attribute name of remove edges option.
Definition: FeaturesPlugin_BooleanFuse.h:82
static const std::string & TOOL_LIST_ID()
Attribute name of tool objects.
Definition: FeaturesPlugin_BooleanFuse.h:75
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_BooleanFuse.h:47
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_BooleanFuse.h:33
static const std::string & FUZZY_PARAM_ID()
Attribute name of fuzzy parameter.
Definition: FeaturesPlugin_Boolean.h:62
static const std::string & USE_FUZZY_ID()
Attribute name of use fuzzy parameter.
Definition: FeaturesPlugin_Boolean.h:55
Attribute that contains boolean value.
Definition: ModelAPI_AttributeBoolean.h:31
Attribute that contains real value with double precision.
Definition: ModelAPI_AttributeDouble.h:34
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33
Class for filling ModelAPI_AttributeDouble.
Definition: ModelHighAPI_Double.h:37
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Class for filling ModelAPI_AttributeInteger.
Definition: ModelHighAPI_Integer.h:36
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
BooleanFusePtr addFuse(const std::shared_ptr< ModelAPI_Document > &part, const std::list< ModelHighAPI_Selection > &objects, const std::pair< std::list< ModelHighAPI_Selection >, bool > &tools=std::pair< std::list< ModelHighAPI_Selection >, bool >(std::list< ModelHighAPI_Selection >(), false), const bool removeEdges=false, const ModelHighAPI_Double &fuzzyParam=ModelHighAPI_Double(-1), const bool keepSubResults=false)
Create Boolean Fuse feature.
Definition: FeaturesAPI_BooleanFuse.cpp:191