Salome HOME
Change the paradigm of versioning of Boolean Operations on the Python API level.
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_BooleanCut.cpp
1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
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 #include "FeaturesAPI_BooleanCut.h"
21
22 #include <ModelHighAPI_Dumper.h>
23 #include <ModelHighAPI_Selection.h>
24 #include <ModelHighAPI_Tools.h>
25
26 //==================================================================================================
27 FeaturesAPI_BooleanCut::FeaturesAPI_BooleanCut(const std::shared_ptr<ModelAPI_Feature>& theFeature)
28 : ModelHighAPI_Interface(theFeature)
29 {
30   initialize();
31 }
32
33 //==================================================================================================
34 FeaturesAPI_BooleanCut::FeaturesAPI_BooleanCut(
35   const std::shared_ptr<ModelAPI_Feature>& theFeature,
36   const std::list<ModelHighAPI_Selection>& theMainObjects,
37   const std::list<ModelHighAPI_Selection>& theToolObjects,
38   const int theVersion)
39 : ModelHighAPI_Interface(theFeature)
40 {
41   if(initialize()) {
42     fillAttribute(theVersion, theFeature->integer(FeaturesPlugin_Boolean::VERSION_ID()));
43     fillAttribute(theMainObjects, mymainObjects);
44     fillAttribute(theToolObjects, mytoolObjects);
45
46     execute(false);
47   }
48 }
49
50 //==================================================================================================
51 FeaturesAPI_BooleanCut::~FeaturesAPI_BooleanCut()
52 {
53 }
54
55
56 //==================================================================================================
57 void FeaturesAPI_BooleanCut::setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects)
58 {
59   fillAttribute(theMainObjects, mymainObjects);
60
61   execute();
62 }
63
64 //==================================================================================================
65 void FeaturesAPI_BooleanCut::setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects)
66 {
67   fillAttribute(theToolObjects, mytoolObjects);
68
69   execute();
70 }
71
72 //==================================================================================================
73 void FeaturesAPI_BooleanCut::dump(ModelHighAPI_Dumper& theDumper) const
74 {
75   FeaturePtr aBase = feature();
76
77   theDumper << aBase << " = model.addCut";
78
79   const std::string& aDocName = theDumper.name(aBase->document());
80   AttributeSelectionListPtr anObjects =
81     aBase->selectionList(FeaturesPlugin_BooleanCut::OBJECT_LIST_ID());
82   AttributeSelectionListPtr aTools =
83     aBase->selectionList(FeaturesPlugin_BooleanCut::TOOL_LIST_ID());
84   AttributeIntegerPtr aVersion =
85     aBase->integer(FeaturesPlugin_BooleanCut::VERSION_ID());
86
87   theDumper << "(" << aDocName << ", " << anObjects << ", " << aTools;
88
89   if (aVersion && aVersion->isInitialized() &&
90       aVersion->value() == FeaturesPlugin_VersionedBoolean::THE_VERSION_1)
91     theDumper << ", keepSubResults = True";
92
93   theDumper << ")" << std::endl;
94 }
95
96 //==================================================================================================
97 BooleanCutPtr addCut(const std::shared_ptr<ModelAPI_Document>& thePart,
98                      const std::list<ModelHighAPI_Selection>& theMainObjects,
99                      const std::list<ModelHighAPI_Selection>& theToolObjects,
100                      const bool keepSubResults)
101 {
102   std::shared_ptr<ModelAPI_Feature> aFeature = thePart->addFeature(FeaturesAPI_BooleanCut::ID());
103   int aVersion = keepSubResults ? FeaturesPlugin_VersionedBoolean::THE_VERSION_1
104                                 : FeaturesPlugin_VersionedBoolean::THE_VERSION_0;
105   return BooleanCutPtr(new FeaturesAPI_BooleanCut(aFeature,
106                                                   theMainObjects,
107                                                   theToolObjects,
108                                                   aVersion));
109 }