1 // Copyright (C) 2014-2023 CEA, EDF
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_BooleanCommon_H_
21 #define FeaturesAPI_BooleanCommon_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_BooleanCommon.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 #include <ModelHighAPI_Double.h>
31 class ModelHighAPI_Integer;
32 class ModelHighAPI_Selection;
34 /// \class FeaturesAPI_BooleanCommon
35 /// \ingroup CPPHighAPI
36 /// \brief Interface for Boolean Common feature.
37 class FeaturesAPI_BooleanCommon: public ModelHighAPI_Interface
40 /// Constructor without values.
42 explicit FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature);
44 /// Constructor with values.
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));
50 /// Constructor with values.
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));
59 virtual ~FeaturesAPI_BooleanCommon();
61 INTERFACE_5(FeaturesPlugin_BooleanCommon::ID(),
62 creationMethod, FeaturesPlugin_BooleanCommon::CREATION_METHOD(),
63 ModelAPI_AttributeString, /** Creation method */,
64 mainObjects, FeaturesPlugin_BooleanCommon::OBJECT_LIST_ID(),
65 ModelAPI_AttributeSelectionList, /** Main objects */,
66 toolObjects, FeaturesPlugin_BooleanCommon::TOOL_LIST_ID(),
67 ModelAPI_AttributeSelectionList, /** Tool objects*/,
68 useFuzzy, FeaturesPlugin_BooleanCommon::USE_FUZZY_ID(),
69 ModelAPI_AttributeBoolean, /** Use Fuzzy parameter*/,
70 fuzzyParam, FeaturesPlugin_BooleanCommon::FUZZY_PARAM_ID(),
71 ModelAPI_AttributeDouble, /** Fuzzy parameter*/)
75 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
79 void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
81 /// Set use fuzzy parameter.
83 void setUseFuzzy(bool theUseFuzzy);
85 /// Set fuzzy parameter.
87 void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
91 void setAdvancedMode(const bool theMode);
93 /// Dump wrapped feature
95 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
98 /// Pointer on Boolean object.
99 typedef std::shared_ptr<FeaturesAPI_BooleanCommon> BooleanCommonPtr;
101 /// \ingroup CPPHighAPI
102 /// \brief Create Boolean Common feature.
103 FEATURESAPI_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>(),
107 const ModelHighAPI_Double& fuzzyParam = ModelHighAPI_Double(-1),
108 const bool keepSubResults = false);
110 #endif // FeaturesAPI_BooleanCommon_H_