SHAPER  9.12.0
FeaturesAPI_BooleanCut.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_BooleanCut_H_
21 #define FeaturesAPI_BooleanCut_H_
22 
23 #include "FeaturesAPI.h"
24 
25 #include <FeaturesPlugin_BooleanCut.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_BooleanCut(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 
45  FEATURESAPI_EXPORT
46  FeaturesAPI_BooleanCut(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47  const std::list<ModelHighAPI_Selection>& theMainObjects,
48  const std::list<ModelHighAPI_Selection>& theToolObjects,
49  const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
50 
52  FEATURESAPI_EXPORT
53  virtual ~FeaturesAPI_BooleanCut();
54 
55  INTERFACE_4(FeaturesPlugin_BooleanCut::ID(),
64 
65 
66  FEATURESAPI_EXPORT
67  void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
68 
70  FEATURESAPI_EXPORT
71  void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
72 
74  FEATURESAPI_EXPORT
75  void setUseFuzzy(bool theUseFuzzy);
76 
78  FEATURESAPI_EXPORT
79  void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
80 
82  FEATURESAPI_EXPORT
83  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
84 };
85 
87 typedef std::shared_ptr<FeaturesAPI_BooleanCut> BooleanCutPtr;
88 
91 FEATURESAPI_EXPORT
92 BooleanCutPtr addCut(const std::shared_ptr<ModelAPI_Document>& thePart,
93  const std::list<ModelHighAPI_Selection>& theMainObjects,
94  const std::list<ModelHighAPI_Selection>& theToolObjects,
96  const bool keepSubResults = false);
97 
98 #endif // FeaturesAPI_BooleanCut_H_
Interface for Boolean Cut feature.
Definition: FeaturesAPI_BooleanCut.h:38
virtual std::shared_ptr< ModelAPI_AttributeDouble > fuzzyParam() const
Fuzzy parameter.
Definition: FeaturesAPI_BooleanCut.h:63
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_BooleanCut.cpp:101
void setFuzzyValue(const ModelHighAPI_Double &theFuzzy)
Set fuzzy parameter.
Definition: FeaturesAPI_BooleanCut.cpp:93
void setToolObjects(const std::list< ModelHighAPI_Selection > &theToolObjects)
Set tool objects.
Definition: FeaturesAPI_BooleanCut.cpp:77
void setMainObjects(const std::list< ModelHighAPI_Selection > &theMainObjects)
Set main objects.
Definition: FeaturesAPI_BooleanCut.cpp:69
FeaturesAPI_BooleanCut(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_BooleanCut.cpp:31
virtual ~FeaturesAPI_BooleanCut()
Destructor.
Definition: FeaturesAPI_BooleanCut.cpp:63
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > toolObjects() const
Tool objects.
Definition: FeaturesAPI_BooleanCut.h:63
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > mainObjects() const
Main objects.
Definition: FeaturesAPI_BooleanCut.h:63
void setUseFuzzy(bool theUseFuzzy)
Set use fuzzy parameter.
Definition: FeaturesAPI_BooleanCut.cpp:85
virtual std::shared_ptr< ModelAPI_AttributeBoolean > useFuzzy() const
Use Fuzzy parameter.
Definition: FeaturesAPI_BooleanCut.h:63
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_BooleanCut.h:36
static const std::string & TOOL_LIST_ID()
Attribute name of tool objects.
Definition: FeaturesPlugin_Boolean.h:48
static const std::string & FUZZY_PARAM_ID()
Attribute name of fuzzy parameter.
Definition: FeaturesPlugin_Boolean.h:62
static const std::string & OBJECT_LIST_ID()
Attribute name of main objects.
Definition: FeaturesPlugin_Boolean.h:41
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
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
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
BooleanCutPtr addCut(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theMainObjects, const std::list< ModelHighAPI_Selection > &theToolObjects, const ModelHighAPI_Double &fuzzyParam=ModelHighAPI_Double(-1), const bool keepSubResults=false)
Create Boolean Cut feature.
Definition: FeaturesAPI_BooleanCut.cpp:127