src/FeaturesPlugin/FeaturesPlugin_BooleanFuse.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 "FeaturesPlugin_BooleanFuse.h"
  21
  22 #include "FeaturesPlugin_Tools.h"
  23
  24 #include <ModelAPI_ResultBody.h>
  25 #include <ModelAPI_AttributeBoolean.h>
  26 #include <ModelAPI_AttributeInteger.h>
  27 #include <ModelAPI_AttributeSelectionList.h>
  28 #include <ModelAPI_AttributeString.h>
  29 #include <ModelAPI_Session.h>
  30 #include <ModelAPI_Tools.h>
  31 #include <ModelAPI_Validator.h>
  32
  33 #include <GeomAlgoAPI_Boolean.h>
  34 #include <GeomAlgoAPI_MakeShapeList.h>
  35 #include <GeomAlgoAPI_PaveFiller.h>
  36 #include <GeomAlgoAPI_ShapeBuilder.h>
  37 #include <GeomAlgoAPI_ShapeTools.h>
  38 #include <GeomAlgoAPI_Tools.h>
  39 #include <GeomAlgoAPI_UnifySameDomain.h>
  40
  41 #include <GeomAPI_ShapeExplorer.h>
  42 #include <GeomAPI_ShapeIterator.h>
  43
  44 //==================================================================================================
  45 FeaturesPlugin_BooleanFuse::FeaturesPlugin_BooleanFuse()
  46 : FeaturesPlugin_Boolean(FeaturesPlugin_Boolean::BOOL_FUSE)
  47 {
  48 }
  49
  50 //==================================================================================================
  51 void FeaturesPlugin_BooleanFuse::initAttributes()
  52 {
  53   data()->addAttribute(CREATION_METHOD(), ModelAPI_AttributeString::typeId());
  54
  55   data()->addAttribute(OBJECT_LIST_ID(), ModelAPI_AttributeSelectionList::typeId());
  56   data()->addAttribute(TOOL_LIST_ID(), ModelAPI_AttributeSelectionList::typeId());
  57
  58   data()->addAttribute(REMOVE_INTERSECTION_EDGES_ID(), ModelAPI_AttributeBoolean::typeId());
  59
  60   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), OBJECT_LIST_ID());
  61   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), TOOL_LIST_ID());
  62
  63   initVersion(THE_VERSION_1, selectionList(OBJECT_LIST_ID()), selectionList(TOOL_LIST_ID()));
  64 }
  65
  66 //==================================================================================================
  67 void FeaturesPlugin_BooleanFuse::execute()
  68 {
  69   std::string anError;
  70   ObjectHierarchy anObjectsHierarchy, aToolsHierarchy;
  71   ListOfShape aPlanes;
  72
  73   bool isSimpleCreation = false;
  74
  75   AttributeStringPtr aCreationMethodAttr = string(CREATION_METHOD());
  76   if (aCreationMethodAttr.get()
  77       && aCreationMethodAttr->value() == CREATION_METHOD_SIMPLE())
  78   {
  79     isSimpleCreation = true;
  80   }
  81
  82   // Getting objects.
  83   if (!processAttribute(OBJECT_LIST_ID(), anObjectsHierarchy, aPlanes))
  84     return;
  85
  86   // Getting tools.
  87   if (!isSimpleCreation &&
  88       !processAttribute(TOOL_LIST_ID(), aToolsHierarchy, aPlanes))
  89     return;
  90
  91   ListOfShape anObjects, aTools, anEdgesAndFaces;
  92   // all objects except edges and faces
  93   anObjectsHierarchy.ObjectsByType(anEdgesAndFaces, anObjects,
  94                                    GeomAPI_Shape::FACE, GeomAPI_Shape::EDGE);
  95   aToolsHierarchy.ObjectsByType(anEdgesAndFaces, aTools,
  96                                 GeomAPI_Shape::FACE, GeomAPI_Shape::EDGE);
  97
  98   if ((anObjects.size() + aTools.size() + anEdgesAndFaces.size()) < 2) {
  99     std::string aFeatureError = "Error: Not enough objects for boolean operation.";
 100     setError(aFeatureError);
 101     return;
 102   }
 103
 104   // version of FUSE feature
 105   int aFuseVersion = version();
 106
 107   // Collecting all solids which will be fused.
 108   ListOfShape aSolidsToFuse;
 109   aSolidsToFuse.insert(aSolidsToFuse.end(), anObjects.begin(), anObjects.end());
 110   aSolidsToFuse.insert(aSolidsToFuse.end(), aTools.begin(), aTools.end());
 111
 112   // Collecting solids from compsolids which will not be modified
 113   // in boolean operation and will be added to result.
 114   ListOfShape aShapesToAdd;
 115   for (ObjectHierarchy::Iterator anObjectsIt = anObjectsHierarchy.Begin();
 116        !isSimpleCreation && anObjectsIt != anObjectsHierarchy.End();
 117        ++anObjectsIt) {
 118     GeomShapePtr anObject = *anObjectsIt;
 119     GeomShapePtr aParent = anObjectsHierarchy.Parent(anObject, false);
 120
 121     if (aParent && aParent->shapeType() == GeomAPI_Shape::COMPSOLID) {
 122       // mark all subs of this parent as precessed to avoid handling twice
 123       aParent = anObjectsHierarchy.Parent(anObject);
 124
 125       ListOfShape aUsed, aNotUsed;
 126       anObjectsHierarchy.SplitCompound(aParent, aUsed, aNotUsed);
 127       aShapesToAdd.insert(aShapesToAdd.end(), aNotUsed.begin(), aNotUsed.end());
 128     }
 129   }
 130
 131   ListOfShape anOriginalShapes = aSolidsToFuse;
 132   anOriginalShapes.insert(anOriginalShapes.end(), aShapesToAdd.begin(), aShapesToAdd.end());
 133
 134   // Cut edges and faces(if we have any) with solids.
 135   std::shared_ptr<GeomAlgoAPI_MakeShapeList> aMakeShapeList(new GeomAlgoAPI_MakeShapeList());
 136   GeomShapePtr aCuttedEdgesAndFaces;
 137   if (!anEdgesAndFaces.empty()) {
 138     std::shared_ptr<GeomAlgoAPI_Boolean> aCutAlgo(new GeomAlgoAPI_Boolean(anEdgesAndFaces,
 139       anOriginalShapes, GeomAlgoAPI_Tools::BOOL_CUT));
 140     if (aCutAlgo->isDone()) {
 141       aCuttedEdgesAndFaces = aCutAlgo->shape();
 142       aMakeShapeList->appendAlgo(aCutAlgo);
 143     }
 144   }
 145   anOriginalShapes.insert(anOriginalShapes.end(), anEdgesAndFaces.begin(),
 146                           anEdgesAndFaces.end());
 147
 148   // If we have compsolids then cut with not used solids all others.
 149   if (!aShapesToAdd.empty()) {
 150     aSolidsToFuse.clear();
 151     for (ListOfShape::iterator
 152          anIt = anOriginalShapes.begin(); anIt != anOriginalShapes.end(); anIt++) {
 153       ListOfShape aOneObjectList;
 154       aOneObjectList.push_back(*anIt);
 155       std::shared_ptr<GeomAlgoAPI_Boolean> aCutAlgo(
 156         new GeomAlgoAPI_Boolean(aOneObjectList, aShapesToAdd, GeomAlgoAPI_Tools::BOOL_CUT));
 157
 158       if (GeomAlgoAPI_ShapeTools::volume(aCutAlgo->shape()) > 1.e-27) {
 159         aSolidsToFuse.push_back(aCutAlgo->shape());
 160         aMakeShapeList->appendAlgo(aCutAlgo);
 161       }
 162     }
 163   }
 164
 165   if (!aSolidsToFuse.empty()) {
 166     anObjects.clear();
 167     anObjects.push_back(aSolidsToFuse.back());
 168     aSolidsToFuse.pop_back();
 169     aTools = aSolidsToFuse;
 170   }
 171
 172   // Fuse all objects and all tools.
 173   GeomShapePtr aShape;
 174   if (anObjects.size() == 1 && aTools.empty()) {
 175     aShape = anObjects.front();
 176   } else if (anObjects.empty() && aTools.size() == 1) {
 177     aShape = aTools.front();
 178   } else if ((anObjects.size() + aTools.size()) > 1) {
 179     std::shared_ptr<GeomAlgoAPI_Boolean> aFuseAlgo(new GeomAlgoAPI_Boolean(anObjects,
 180       aTools,
 181       GeomAlgoAPI_Tools::BOOL_FUSE));
 182
 183     // Checking that the algorithm worked properly.
 184     if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aFuseAlgo, getKind(), anError)) {
 185       setError(anError);
 186       return;
 187     }
 188
 189     aShape = aFuseAlgo->shape();
 190     aMakeShapeList->appendAlgo(aFuseAlgo);
 191   }
 192
 193   // Combine result with not used solids from compsolid and edges and faces (if we have any).
 194   if (aCuttedEdgesAndFaces.get() && !aCuttedEdgesAndFaces->isNull()) {
 195     aShapesToAdd.push_back(aCuttedEdgesAndFaces);
 196   } else {
 197     aShapesToAdd.insert(aShapesToAdd.end(), anEdgesAndFaces.begin(), anEdgesAndFaces.end());
 198   }
 199   if (!aShapesToAdd.empty()) {
 200     if (aShape.get()) {
 201       aShapesToAdd.push_back(aShape);
 202     }
 203     std::shared_ptr<GeomAlgoAPI_PaveFiller> aFillerAlgo(
 204       new GeomAlgoAPI_PaveFiller(aShapesToAdd, true));
 205     if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aFillerAlgo, getKind(), anError)) {
 206       setError(anError);
 207       return;
 208     }
 209
 210     aShape = aFillerAlgo->shape();
 211     aMakeShapeList->appendAlgo(aFillerAlgo);
 212   }
 213
 214   bool isRemoveEdges = false;
 215   AttributeBooleanPtr removeEdgesAttr = boolean(REMOVE_INTERSECTION_EDGES_ID());
 216   if (removeEdgesAttr.get()) {
 217     isRemoveEdges = removeEdgesAttr->value();
 218   }
 219
 220   if (isRemoveEdges) {
 221     std::shared_ptr<GeomAlgoAPI_UnifySameDomain> aUnifyAlgo(
 222       new GeomAlgoAPI_UnifySameDomain(aShape));
 223
 224     if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aUnifyAlgo, getKind(), anError)) {
 225       setError(anError);
 226       return;
 227     }
 228
 229     aShape = aUnifyAlgo->shape();
 230     aMakeShapeList->appendAlgo(aUnifyAlgo);
 231   }
 232
 233   if (aFuseVersion == THE_VERSION_1) {
 234     // merge hierarchies of compounds containing objects and tools
 235     // and append the result of the FUSE operation
 236     aShape = keepUnusedSubsOfCompound(aShape, anObjectsHierarchy, aToolsHierarchy, aMakeShapeList);
 237   }
 238
 239   int aResultIndex = 0;
 240
 241   ResultBodyPtr aResultBody = document()->createBody(data(), aResultIndex);
 242
 243   ListOfShape anEmptyTools;
 244   FeaturesPlugin_Tools::loadModifiedShapes(aResultBody,
 245                                            anOriginalShapes,
 246                                            anEmptyTools,
 247                                            aMakeShapeList,
 248                                            aShape);
 249   setResult(aResultBody, aResultIndex);
 250   aResultIndex++;
 251
 252   FeaturesPlugin_Tools::loadDeletedShapes(aResultBody,
 253                                           GeomShapePtr(),
 254                                           anOriginalShapes,
 255                                           aMakeShapeList,
 256                                           aShape);
 257
 258   // remove the rest results if there were produced in the previous pass
 259   removeResults(aResultIndex);
 260 }