Salome HOME
Change the paradigm of versioning of Boolean Operations on the Python API level.
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_BooleanCommon.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_BooleanCommon.h"
21
22 #include <ModelHighAPI_Dumper.h>
23 #include <ModelHighAPI_Selection.h>
24 #include <ModelHighAPI_Tools.h>
25
26 //==================================================================================================
27 FeaturesAPI_BooleanCommon::FeaturesAPI_BooleanCommon(
28   const std::shared_ptr<ModelAPI_Feature>& theFeature)
29 : ModelHighAPI_Interface(theFeature)
30 {
31   initialize();
32 }
33
34 //==================================================================================================
35 FeaturesAPI_BooleanCommon::FeaturesAPI_BooleanCommon(
36   const std::shared_ptr<ModelAPI_Feature>& theFeature,
37   const std::list<ModelHighAPI_Selection>& theMainObjects,
38   const int theVersion)
39 : ModelHighAPI_Interface(theFeature)
40 {
41   if(initialize()) {
42     fillAttribute(FeaturesPlugin_BooleanCommon::CREATION_METHOD_SIMPLE(), mycreationMethod);
43     fillAttribute(theVersion, theFeature->integer(FeaturesPlugin_Boolean::VERSION_ID()));
44     fillAttribute(theMainObjects, mymainObjects);
45
46     execute(false);
47   }
48 }
49
50 //==================================================================================================
51 FeaturesAPI_BooleanCommon::FeaturesAPI_BooleanCommon(
52   const std::shared_ptr<ModelAPI_Feature>& theFeature,
53   const std::list<ModelHighAPI_Selection>& theMainObjects,
54   const std::list<ModelHighAPI_Selection>& theToolObjects,
55   const int theVersion)
56 : ModelHighAPI_Interface(theFeature)
57 {
58   if(initialize()) {
59     fillAttribute(FeaturesPlugin_BooleanCommon::CREATION_METHOD_ADVANCED(), mycreationMethod);
60     fillAttribute(theVersion, theFeature->integer(FeaturesPlugin_Boolean::VERSION_ID()));
61     fillAttribute(theMainObjects, mymainObjects);
62     fillAttribute(theToolObjects, mytoolObjects);
63
64     execute(false);
65   }
66 }
67
68 //==================================================================================================
69 FeaturesAPI_BooleanCommon::~FeaturesAPI_BooleanCommon()
70 {
71 }
72
73
74 //==================================================================================================
75 void FeaturesAPI_BooleanCommon::setMainObjects(
76   const std::list<ModelHighAPI_Selection>& theMainObjects)
77 {
78   fillAttribute(theMainObjects, mymainObjects);
79
80   execute();
81 }
82
83 //==================================================================================================
84 void FeaturesAPI_BooleanCommon::setToolObjects(
85   const std::list<ModelHighAPI_Selection>& theToolObjects)
86 {
87   fillAttribute(FeaturesPlugin_BooleanCommon::CREATION_METHOD_ADVANCED(), mycreationMethod);
88   fillAttribute(theToolObjects, mytoolObjects);
89
90   execute();
91 }
92
93 //==================================================================================================
94 void FeaturesAPI_BooleanCommon::setAdvancedMode(const bool theMode)
95 {
96   if (theMode) {
97     fillAttribute(FeaturesPlugin_BooleanCommon::CREATION_METHOD_ADVANCED(), mycreationMethod);
98   } else {
99     fillAttribute(FeaturesPlugin_BooleanCommon::CREATION_METHOD_SIMPLE(), mycreationMethod);
100   }
101
102   execute();
103 }
104
105 //==================================================================================================
106 void FeaturesAPI_BooleanCommon::dump(ModelHighAPI_Dumper& theDumper) const
107 {
108   FeaturePtr aBase = feature();
109
110   theDumper << aBase << " = model.addCommon";
111
112   const std::string& aDocName = theDumper.name(aBase->document());
113   AttributeStringPtr aMode = aBase->string(FeaturesPlugin_BooleanCommon::CREATION_METHOD());
114   AttributeSelectionListPtr anObjects =
115     aBase->selectionList(FeaturesPlugin_BooleanCommon::OBJECT_LIST_ID());
116   AttributeSelectionListPtr aTools =
117     aBase->selectionList(FeaturesPlugin_BooleanCommon::TOOL_LIST_ID());
118   AttributeIntegerPtr aVersion =
119     aBase->integer(FeaturesPlugin_BooleanCommon::VERSION_ID());
120
121   theDumper << "(" << aDocName << ", " << anObjects;
122
123   if (aMode->value() == FeaturesPlugin_BooleanCommon::CREATION_METHOD_ADVANCED()) {
124     theDumper << ", " << aTools;
125   }
126
127   if (aVersion && aVersion->isInitialized() &&
128       aVersion->value() == FeaturesPlugin_VersionedBoolean::THE_VERSION_1) {
129     theDumper << ", keepSubResults = True";
130   }
131
132   theDumper << ")" << std::endl;
133 }
134
135 //==================================================================================================
136 static BooleanCommonPtr addCommon(const std::shared_ptr<ModelAPI_Document>& thePart,
137                                   const std::list<ModelHighAPI_Selection>& theMainObjects,
138                                   const int theVersion)
139 {
140   std::shared_ptr<ModelAPI_Feature> aFeature = thePart->addFeature(FeaturesAPI_BooleanCommon::ID());
141   return BooleanCommonPtr(new FeaturesAPI_BooleanCommon(aFeature, theMainObjects, theVersion));
142 }
143
144 //==================================================================================================
145 static BooleanCommonPtr addCommon(const std::shared_ptr<ModelAPI_Document>& thePart,
146                                   const std::list<ModelHighAPI_Selection>& theMainObjects,
147                                   const std::list<ModelHighAPI_Selection>& theToolObjects,
148                                   const int theVersion)
149 {
150   std::shared_ptr<ModelAPI_Feature> aFeature = thePart->addFeature(FeaturesAPI_BooleanCommon::ID());
151   return BooleanCommonPtr(new FeaturesAPI_BooleanCommon(aFeature,
152                                                         theMainObjects,
153                                                         theToolObjects,
154                                                         theVersion));
155 }
156
157 //==================================================================================================
158 BooleanCommonPtr addCommon(const std::shared_ptr<ModelAPI_Document>& thePart,
159                            const std::list<ModelHighAPI_Selection>& theMainObjects,
160                            const std::list<ModelHighAPI_Selection>& theToolObjects,
161                            const bool keepSubResults)
162 {
163   int aVersion = keepSubResults ? FeaturesPlugin_VersionedBoolean::THE_VERSION_1
164                                 : FeaturesPlugin_VersionedBoolean::THE_VERSION_0;
165   return theToolObjects.empty() ? addCommon(thePart, theMainObjects, aVersion)
166                                 : addCommon(thePart, theMainObjects, theToolObjects, aVersion);
167 }