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_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>
30 class ModelHighAPI_Integer;
31 class ModelHighAPI_Selection;
33 /// \class FeaturesAPI_BooleanCommon
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for Boolean Common feature.
36 class FeaturesAPI_BooleanCommon: public ModelHighAPI_Interface
39 /// Constructor without values.
41 explicit FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 /// Constructor with values.
45 FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46 const std::list<ModelHighAPI_Selection>& theMainObjects);
48 /// Constructor with values.
50 FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
51 const std::list<ModelHighAPI_Selection>& theMainObjects,
52 const std::list<ModelHighAPI_Selection>& theToolObjects);
56 virtual ~FeaturesAPI_BooleanCommon();
58 INTERFACE_3(FeaturesPlugin_BooleanCommon::ID(),
59 creationMethod, FeaturesPlugin_BooleanCommon::CREATION_METHOD(),
60 ModelAPI_AttributeString, /** Creation method */,
61 mainObjects, FeaturesPlugin_BooleanCommon::OBJECT_LIST_ID(),
62 ModelAPI_AttributeSelectionList, /** Main objects */,
63 toolObjects, FeaturesPlugin_BooleanCommon::TOOL_LIST_ID(),
64 ModelAPI_AttributeSelectionList, /** Tool objects*/)
68 void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
72 void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
76 void setAdvancedMode(const bool theMode);
78 /// Dump wrapped feature
80 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
83 /// Pointer on Boolean object.
84 typedef std::shared_ptr<FeaturesAPI_BooleanCommon> BooleanCommonPtr;
86 /// \ingroup CPPHighAPI
87 /// \brief Create Boolean Common feature.
88 FEATURESAPI_EXPORT BooleanCommonPtr addCommon(
89 const std::shared_ptr<ModelAPI_Document>& part,
90 const std::list<ModelHighAPI_Selection>& objects,
91 const std::list<ModelHighAPI_Selection>& tools = std::list<ModelHighAPI_Selection>(),
92 const bool keepSubResults = false);
94 #endif // FeaturesAPI_BooleanCommon_H_