src/FeaturesPlugin/FeaturesPlugin_GlueFaces.cpp

   1 // Copyright (C) 2014-2022  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_GlueFaces.h"
  21
  22 #include <ModelAPI_AttributeBoolean.h>
  23 #include <ModelAPI_AttributeDouble.h>
  24 #include <ModelAPI_AttributeSelectionList.h>
  25 #include <ModelAPI_ResultBody.h>
  26 #include <ModelAPI_ResultConstruction.h>
  27 #include <ModelAPI_Session.h>
  28 #include <ModelAPI_Validator.h>
  29 #include <ModelAPI_Tools.h>
  30
  31 #include <GeomAPI_ShapeIterator.h>
  32 #include <GeomAPI_ShapeExplorer.h>
  33
  34 #include <GeomAlgoAPI_CompoundBuilder.h>
  35 #include <GeomAlgoAPI_GlueFaces.h>
  36 #include <GeomAlgoAPI_Tools.h>
  37
  38 #include <sstream>
  39
  40
  41 //==================================================================================================
  42 FeaturesPlugin_GlueFaces::FeaturesPlugin_GlueFaces()
  43 {
  44 }
  45
  46 //==================================================================================================
  47 void FeaturesPlugin_GlueFaces::initAttributes()
  48 {
  49   data()->addAttribute(OBJECTS_LIST_ID(), ModelAPI_AttributeSelectionList::typeId());
  50   data()->addAttribute(TOLERANCE_ID(), ModelAPI_AttributeDouble::typeId());
  51   data()->addAttribute(KEEP_NON_SOLIDS_ID(), ModelAPI_AttributeBoolean::typeId());
  52 }
  53
  54 //==================================================================================================
  55 void FeaturesPlugin_GlueFaces::execute()
  56 {
  57   // Collect all selected shapes into a single list of shapes
  58   ListOfShape aShapes;
  59   getOriginalShapes(OBJECTS_LIST_ID(), aShapes);
  60
  61   // Get all other feature arguments
  62   double aTolerance = real(FeaturesPlugin_GlueFaces::TOLERANCE_ID())->value();
  63   bool isKeepNonSolids = boolean(FeaturesPlugin_GlueFaces::KEEP_NON_SOLIDS_ID())->value();
  64
  65   std::shared_ptr<GeomAlgoAPI_GlueFaces> aGluingAlgo(new GeomAlgoAPI_GlueFaces(aShapes, aTolerance, isKeepNonSolids));
  66
  67   std::string anError;
  68   if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aGluingAlgo, getKind(), anError))
  69   {
  70     setError(anError);
  71     eraseResults();
  72     return;
  73   }
  74
  75   // Store result.
  76   GeomShapePtr aResult = aGluingAlgo->shape();
  77
  78   if (!isGlued(aShapes, aResult))
  79   {
  80     static const std::string anError2 = "Error: No faces were glued.";
  81     setError(anError2);
  82     data()->execState(ModelAPI_ExecState::ModelAPI_StateDone);
  83     eraseResults();
  84     setResultFromInput(aShapes);
  85     return;
  86   }
  87
  88   int anIndex = 0;
  89   ResultBodyPtr aResultBody = document()->createBody(data(), anIndex);
  90   aResultBody->storeModified(aShapes, aResult, aGluingAlgo);
  91
  92   // Ensure the result body is named after this feature
  93   std::wstring aBaseName = feature(aResultBody)->data()->name();
  94   std::wostringstream aNameStr;
  95   aNameStr << aBaseName << "_" << (anIndex+1);
  96   std::wstring aName = aNameStr.str();
  97   aResultBody->data()->setName(aName);
  98
  99   setResult(aResultBody, anIndex);
 100 }
 101
 102 //=================================================================================================
 103 void FeaturesPlugin_GlueFaces::getOriginalShapes(const std::string& theAttributeName,
 104                                                  ListOfShape&       theShapes)
 105 {
 106   // Collect all selections into a single list of shapes
 107   AttributeSelectionListPtr aSelectionList = selectionList(theAttributeName);
 108   for (int anIndex = 0; anIndex < aSelectionList->size(); ++anIndex)
 109   {
 110     AttributeSelectionPtr aSelection = aSelectionList->value(anIndex);
 111     GeomShapePtr aShape = aSelection->value();
 112     GeomShapePtr aContext = aSelection->context()->shape();
 113     if (!aShape.get())
 114     {
 115       aShape = aContext;
 116     }
 117     theShapes.push_back(aShape);
 118   }
 119 }
 120
 121 //=================================================================================================
 122 bool FeaturesPlugin_GlueFaces::isGlued(const ListOfShape& theInputs,
 123                                        const GeomShapePtr theResult)
 124 {
 125   if (!theResult.get())
 126     return false;
 127
 128   // Consider the list of input shapes the same as the result, if
 129   //  * the total number of faces did NOT change.
 130   int nbInputFaces = 0, nbInputEdges = 0;
 131   for (ListOfShape::const_iterator anIt = theInputs.cbegin();
 132        anIt != theInputs.cend();
 133        ++anIt)
 134   {
 135     GeomShapePtr aShape = *anIt;
 136     if (aShape.get())
 137     {
 138       nbInputFaces += aShape->subShapes(GeomAPI_Shape::FACE, true).size();
 139       nbInputEdges += aShape->subShapes(GeomAPI_Shape::EDGE, true).size();
 140     }
 141   }
 142
 143   int nbResultFaces = 0, nbResultEdges = 0;
 144   nbResultFaces = theResult->subShapes(GeomAPI_Shape::FACE, true).size();
 145   nbResultEdges = theResult->subShapes(GeomAPI_Shape::EDGE, true).size();
 146   return(0 < nbResultFaces && ((nbResultFaces < nbInputFaces) || (nbResultFaces == nbInputFaces && nbResultEdges < nbInputEdges)));
 147 }
 148
 149 //=================================================================================================
 150 void FeaturesPlugin_GlueFaces::setResultFromInput(const ListOfShape& theInputs)
 151 {
 152   GeomShapePtr aResult;
 153
 154   // Make sure the result will be a compound of the input shapes, if not already
 155   if (theInputs.size() == 1 && theInputs.front().get() && theInputs.front()->isCompound())
 156   {
 157     aResult = theInputs.front();
 158   }
 159   else
 160   {
 161     aResult = GeomAlgoAPI_CompoundBuilder::compound(theInputs);
 162   }
 163
 164   int anIndex = 0;
 165   ResultBodyPtr aResultBody = document()->createBody(data(), anIndex);
 166   aResultBody->store(aResult);
 167
 168   setResult(aResultBody, anIndex);
 169 }