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