src/BuildPlugin/BuildPlugin_Filling.cpp

   1 // Copyright (C) 2017-20xx  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include "BuildPlugin_Filling.h"
  22
  23 #include <ModelAPI_AttributeBoolean.h>
  24 #include <ModelAPI_AttributeDouble.h>
  25 #include <ModelAPI_AttributeInteger.h>
  26 #include <ModelAPI_AttributeSelectionList.h>
  27 #include <ModelAPI_AttributeString.h>
  28 #include <ModelAPI_ResultBody.h>
  29
  30 #include <GeomAlgoAPI_Copy.h>
  31 #include <GeomAlgoAPI_Filling.h>
  32 #include <GeomAlgoAPI_ShapeTools.h>
  33
  34 #include <GeomAPI_Pnt.h>
  35 #include <GeomAPI_ShapeExplorer.h>
  36 #include <GeomAPI_Wire.h>
  37
  38 #include <cmath>
  39
  40 struct FillingParameters
  41 {
  42   std::string method;
  43   int minDegree;
  44   int maxDegree;
  45   int nbIter;
  46   double tol2D;
  47   double tol3D;
  48   bool isApprox;
  49 };
  50
  51
  52 //=================================================================================================
  53 BuildPlugin_Filling::BuildPlugin_Filling()
  54 {
  55 }
  56
  57 //=================================================================================================
  58 void BuildPlugin_Filling::initAttributes()
  59 {
  60   data()->addAttribute(BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList::typeId());
  61   data()->addAttribute(ADVANCED_OPTIONS_ID(), ModelAPI_AttributeString::typeId());
  62   data()->addAttribute(METHOD_ID(), ModelAPI_AttributeString::typeId());
  63   data()->addAttribute(MINIMAL_DEGREE_ID(), ModelAPI_AttributeInteger::typeId());
  64   data()->addAttribute(MAXIMAL_DEGREE_ID(), ModelAPI_AttributeInteger::typeId());
  65   data()->addAttribute(NUMBER_OF_ITERATIONS_ID(), ModelAPI_AttributeInteger::typeId());
  66   data()->addAttribute(TOLERANCE_2D_ID(), ModelAPI_AttributeDouble::typeId());
  67   data()->addAttribute(TOLERANCE_3D_ID(), ModelAPI_AttributeDouble::typeId());
  68   data()->addAttribute(APPROXIMATION_ID(), ModelAPI_AttributeBoolean::typeId());
  69
  70   restoreDefaultParameters();
  71   string(ADVANCED_OPTIONS_ID())->setValue("");
  72 }
  73
  74 //=================================================================================================
  75 void BuildPlugin_Filling::execute()
  76 {
  77   // get parameters of algorithm
  78   FillingParameters aParameters;
  79   aParameters.method = string(METHOD_ID())->value();
  80   aParameters.minDegree = integer(MINIMAL_DEGREE_ID())->value();
  81   aParameters.maxDegree = integer(MAXIMAL_DEGREE_ID())->value();
  82   aParameters.nbIter = integer(NUMBER_OF_ITERATIONS_ID())->value();
  83   aParameters.tol2D = real(TOLERANCE_2D_ID())->value();
  84   aParameters.tol3D = real(TOLERANCE_3D_ID())->value();
  85   aParameters.isApprox = boolean(APPROXIMATION_ID())->value();
  86
  87   if (aParameters.minDegree > aParameters.maxDegree) {
  88     setError("Error: " + getKind() + " algorithm failed (max deg < min deg).");
  89     return;
  90   }
  91
  92   std::shared_ptr<GeomAlgoAPI_Filling> aFilling(
  93       new GeomAlgoAPI_Filling(aParameters.minDegree, aParameters.maxDegree, aParameters.nbIter,
  94                               aParameters.tol2D, aParameters.tol3D));
  95
  96   // get base objects list
  97   AttributeSelectionListPtr aSelectionList = selectionList(BASE_OBJECTS_ID());
  98   if (aSelectionList->size() <= 1)
  99     return;
 100
 101   // collect base shapes
 102   for(int anIndex = 0; anIndex < aSelectionList->size(); ++anIndex) {
 103     AttributeSelectionPtr aSelection = aSelectionList->value(anIndex);
 104     GeomEdgePtr anEdge = toEdge(aSelection->value(), aParameters.method);
 105     if (!anEdge) {
 106       myLastEdgeStartPoint = GeomPointPtr();
 107       myLastEdgeEndPoint = GeomPointPtr();
 108       return;
 109     }
 110     aFilling->add(anEdge);
 111   }
 112   myLastEdgeStartPoint = GeomPointPtr();
 113   myLastEdgeEndPoint = GeomPointPtr();
 114
 115   // build result
 116   aFilling->build(aParameters.isApprox);
 117   if (isAlgorithmFailed(aFilling)) {
 118     removeResults(0);
 119     return;
 120   }
 121
 122   /// store result
 123   GeomShapePtr aCreatedFace = aFilling->shape();
 124   ResultBodyPtr aResultBody = document()->createBody(data());
 125   aResultBody->store(aCreatedFace);
 126   // store edges
 127   int anEdgeInd = 0;
 128   for(GeomAPI_ShapeExplorer anExp(aCreatedFace, GeomAPI_Shape::EDGE); anExp.more(); anExp.next()) {
 129     GeomShapePtr anEdge = anExp.current();
 130     aResultBody->generated(anEdge, "Edge_" + std::to_string((long long)anEdgeInd));
 131   }
 132   setResult(aResultBody, 0);
 133 }
 134
 135 bool BuildPlugin_Filling::isAlgorithmFailed(
 136     const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgorithm)
 137 {
 138   if (!theAlgorithm->isDone()) {
 139     static const std::string aFeatureError = "Error: filling algorithm failed.";
 140     std::string anAlgoError = theAlgorithm->getError();
 141     if (anAlgoError.empty())
 142       anAlgoError = aFeatureError;
 143     else
 144       anAlgoError = aFeatureError + " " + anAlgoError;
 145     setError(anAlgoError);
 146     return true;
 147   }
 148   if (theAlgorithm->shape()->isNull()) {
 149     static const std::string aShapeError = "Error: Resulting shape of filling is Null.";
 150     setError(aShapeError);
 151     return true;
 152   }
 153   if (!theAlgorithm->isValid()) {
 154     std::string aFeatureError = "Error: Resulting shape of filling is not valid.";
 155     setError(aFeatureError);
 156     return true;
 157   }
 158   return false;
 159 }
 160
 161 //=================================================================================================
 162 void BuildPlugin_Filling::attributeChanged(const std::string& theID)
 163 {
 164   if (theID == ADVANCED_OPTIONS_ID() && string(ADVANCED_OPTIONS_ID())->value().empty()) {
 165     // Advanced options flag just unchecked => restore default state of all parameters
 166     restoreDefaultParameters();
 167   }
 168 }
 169
 170 //=================================================================================================
 171 GeomEdgePtr BuildPlugin_Filling::toEdge(const GeomShapePtr& theShape, const std::string& theMethod)
 172 {
 173   GeomEdgePtr anEdge;
 174   switch (theShape->shapeType()) {
 175   case GeomAPI_Shape::EDGE:
 176     anEdge = GeomEdgePtr(new GeomAPI_Edge(GeomAlgoAPI_Copy(theShape).shape()));
 177     break;
 178   case GeomAPI_Shape::WIRE:
 179     anEdge = GeomAlgoAPI_ShapeTools::wireToEdge(
 180         GeomWirePtr(new GeomAPI_Wire(theShape)));
 181     break;
 182   default:
 183     break;
 184   }
 185
 186   if (!anEdge || anEdge->empty()) {
 187     static const std::string aFeatureError =
 188         "Error: incorrect type of input feature (edges/wire are supported only).";
 189     setError(aFeatureError);
 190     return anEdge;
 191   }
 192
 193   // correct edge orientation according to filling method
 194   if (theMethod == Method::AUTO_CORRECT_ORIENTATION()) {
 195     // check the distance to previous edge boundaries, reverse edge if necessary
 196     GeomPointPtr aStartPnt = anEdge->firstPoint();
 197     GeomPointPtr aEndPnt = anEdge->lastPoint();
 198     if (anEdge->orientation() == GeomAPI_Shape::REVERSED) {
 199       aStartPnt = anEdge->lastPoint();
 200       aEndPnt = anEdge->firstPoint();
 201     }
 202     bool isReverse = false;
 203     if (myLastEdgeStartPoint) {
 204       double d1 = myLastEdgeStartPoint->distance(aStartPnt)
 205                 + myLastEdgeEndPoint->distance(aEndPnt);
 206       double d2 = myLastEdgeStartPoint->distance(aEndPnt)
 207                 + myLastEdgeEndPoint->distance(aStartPnt);
 208       if (fabs(d1 - d2) < 1.e-7) {
 209         // undefined case => check distance to start point only
 210         d1 = myLastEdgeStartPoint->distance(aStartPnt);
 211         d2 = myLastEdgeStartPoint->distance(aEndPnt);
 212       }
 213       isReverse = d2 < d1;
 214     }
 215
 216     if (isReverse) {
 217       anEdge->reverse();
 218       myLastEdgeStartPoint = aEndPnt;
 219       myLastEdgeEndPoint = aStartPnt;
 220     } else {
 221       myLastEdgeStartPoint = aStartPnt;
 222       myLastEdgeEndPoint = aEndPnt;
 223     }
 224   }
 225   else if (theMethod == Method::USE_CURVE_INFORMATION()) {
 226     // make all edges FORWARD to avoid reversing the curves by GeomAlgoAPI_Filling algorithm
 227     anEdge->setOrientation(GeomAPI_Shape::FORWARD);
 228   }
 229   return anEdge;
 230 }
 231
 232 //=================================================================================================
 233 void BuildPlugin_Filling::restoreDefaultParameters()
 234 {
 235   string(METHOD_ID())->setValue(METHOD_DEFAULT());
 236   integer(MINIMAL_DEGREE_ID())->setValue(MINIMAL_DEGREE_DEFAULT());
 237   integer(MAXIMAL_DEGREE_ID())->setValue(MAXIMAL_DEGREE_DEFAULT());
 238   integer(NUMBER_OF_ITERATIONS_ID())->setValue(NUMBER_OF_ITERATIONS_DEFAULT());
 239   real(TOLERANCE_2D_ID())->setValue(TOLERANCE_2D_DEFAULT());
 240   real(TOLERANCE_3D_ID())->setValue(TOLERANCE_3D_DEFAULT());
 241   boolean(APPROXIMATION_ID())->setValue(APPROXIMATION_DEFAULT());
 242 }