SHAPER 9.16.0
FeaturesAPI_BooleanCommon.h
1// Copyright (C) 2014-2026 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_BooleanCommon_H_
21#define FeaturesAPI_BooleanCommon_H_
22
23#include "FeaturesAPI.h"
24
25#include <FeaturesPlugin_BooleanCommon.h>
26
27#include <ModelHighAPI_Interface.h>
28#include <ModelHighAPI_Macro.h>
29#include <ModelHighAPI_Double.h>
30
33
38{
39public:
41 FEATURESAPI_EXPORT
42 explicit FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43
45 FEATURESAPI_EXPORT
46 FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47 const std::list<ModelHighAPI_Selection>& theMainObjects,
48 const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
49
51 FEATURESAPI_EXPORT
52 FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
53 const std::list<ModelHighAPI_Selection>& theMainObjects,
54 const std::list<ModelHighAPI_Selection>& theToolObjects,
55 const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
56
58 FEATURESAPI_EXPORT
60
72
73
74 FEATURESAPI_EXPORT
75 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
76
78 FEATURESAPI_EXPORT
79 void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
80
82 FEATURESAPI_EXPORT
83 void setUseFuzzy(bool theUseFuzzy);
84
86 FEATURESAPI_EXPORT
87 void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
88
90 FEATURESAPI_EXPORT
91 void setAdvancedMode(const bool theMode);
92
94 FEATURESAPI_EXPORT
95 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
96};
97
99typedef std::shared_ptr<FeaturesAPI_BooleanCommon> BooleanCommonPtr;
100
103FEATURESAPI_EXPORT BooleanCommonPtr addCommon(
104 const std::shared_ptr<ModelAPI_Document>& part,
105 const std::list<ModelHighAPI_Selection>& objects,
106 const std::list<ModelHighAPI_Selection>& tools = std::list<ModelHighAPI_Selection>(),
108 const bool keepSubResults = false);
109
110#endif // FeaturesAPI_BooleanCommon_H_
Interface for Boolean Common feature.
Definition: FeaturesAPI_BooleanCommon.h:38
virtual std::shared_ptr< ModelAPI_AttributeString > creationMethod() const
Creation method.
Definition: FeaturesAPI_BooleanCommon.h:71
virtual std::shared_ptr< ModelAPI_AttributeBoolean > useFuzzy() const
Use Fuzzy parameter.
Definition: FeaturesAPI_BooleanCommon.h:71
FeaturesAPI_BooleanCommon(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_BooleanCommon.cpp:31
void setToolObjects(const std::list< ModelHighAPI_Selection > &theToolObjects)
Set tool objects.
Definition: FeaturesAPI_BooleanCommon.cpp:104
virtual std::shared_ptr< ModelAPI_AttributeDouble > fuzzyParam() const
Fuzzy parameter.
Definition: FeaturesAPI_BooleanCommon.h:71
void setMainObjects(const std::list< ModelHighAPI_Selection > &theMainObjects)
Set main objects.
Definition: FeaturesAPI_BooleanCommon.cpp:95
void setAdvancedMode(const bool theMode)
Set mode.
Definition: FeaturesAPI_BooleanCommon.cpp:130
void setFuzzyValue(const ModelHighAPI_Double &theFuzzy)
Set fuzzy parameter.
Definition: FeaturesAPI_BooleanCommon.cpp:122
virtual ~FeaturesAPI_BooleanCommon()
Destructor.
Definition: FeaturesAPI_BooleanCommon.cpp:89
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > toolObjects() const
Tool objects.
Definition: FeaturesAPI_BooleanCommon.h:71
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > mainObjects() const
Main objects.
Definition: FeaturesAPI_BooleanCommon.h:71
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_BooleanCommon.cpp:142
void setUseFuzzy(bool theUseFuzzy)
Set use fuzzy parameter.
Definition: FeaturesAPI_BooleanCommon.cpp:114
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_BooleanCommon.h:49
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_BooleanCommon.h:35
static const std::string & TOOL_LIST_ID()
Attribute name of tool objects.
Definition: FeaturesPlugin_Boolean.h:48
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
static const std::string & FUZZY_PARAM_ID()
Attribute name of fuzzy parameter.
Definition: FeaturesPlugin_Boolean.h:62
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
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:53
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:46
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
BooleanCommonPtr addCommon(const std::shared_ptr< ModelAPI_Document > &part, const std::list< ModelHighAPI_Selection > &objects, const std::list< ModelHighAPI_Selection > &tools=std::list< ModelHighAPI_Selection >(), const ModelHighAPI_Double &fuzzyParam=ModelHighAPI_Double(-1), const bool keepSubResults=false)
Create Boolean Common feature.
Definition: FeaturesAPI_BooleanCommon.cpp:173