src/FeaturesPlugin/FeaturesPlugin_Symmetry.cpp

   1 // Copyright (C) 2014-2017  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 <FeaturesPlugin_Symmetry.h>
  22
  23 #include <GeomAlgoAPI_CompoundBuilder.h>
  24 #include <GeomAlgoAPI_PointBuilder.h>
  25 #include <GeomAlgoAPI_FaceBuilder.h>
  26 #include <GeomAlgoAPI_Copy.h>
  27 #include <GeomAlgoAPI_MakeShapeList.h>
  28
  29 #include <GeomAPI_Edge.h>
  30 #include <GeomAPI_Face.h>
  31 #include <GeomAPI_Lin.h>
  32 #include <GeomAPI_Pln.h>
  33 #include <GeomAPI_ShapeIterator.h>
  34 #include <GeomAPI_Trsf.h>
  35
  36 #include <ModelAPI_AttributeBoolean.h>
  37 #include <ModelAPI_AttributeSelectionList.h>
  38 #include <ModelAPI_AttributeString.h>
  39 #include <ModelAPI_ResultBody.h>
  40 #include <ModelAPI_ResultPart.h>
  41
  42 #include <FeaturesPlugin_Tools.h>
  43
  44 //=================================================================================================
  45 FeaturesPlugin_Symmetry::FeaturesPlugin_Symmetry()
  46 {
  47 }
  48
  49 //=================================================================================================
  50 void FeaturesPlugin_Symmetry::initAttributes()
  51 {
  52   data()->addAttribute(FeaturesPlugin_Symmetry::CREATION_METHOD(),
  53                        ModelAPI_AttributeString::typeId());
  54
  55   AttributeSelectionListPtr aSelection =
  56     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(data()->addAttribute(
  57     FeaturesPlugin_Symmetry::OBJECTS_LIST_ID(), ModelAPI_AttributeSelectionList::typeId()));
  58
  59   data()->addAttribute(FeaturesPlugin_Symmetry::POINT_OBJECT_ID(),
  60                        ModelAPI_AttributeSelection::typeId());
  61
  62   data()->addAttribute(FeaturesPlugin_Symmetry::AXIS_OBJECT_ID(),
  63                        ModelAPI_AttributeSelection::typeId());
  64
  65   data()->addAttribute(FeaturesPlugin_Symmetry::PLANE_OBJECT_ID(),
  66                        ModelAPI_AttributeSelection::typeId());
  67
  68   data()->addAttribute(FeaturesPlugin_Symmetry::KEEP_ORIGINAL_RESULT(),
  69                        ModelAPI_AttributeBoolean::typeId());
  70 }
  71
  72 //=================================================================================================
  73 void FeaturesPlugin_Symmetry::execute()
  74 {
  75   AttributeStringPtr aMethodTypeAttr = string(FeaturesPlugin_Symmetry::CREATION_METHOD());
  76   std::string aMethodType = aMethodTypeAttr->value();
  77
  78   if (aMethodType == CREATION_METHOD_BY_POINT()) {
  79     performSymmetryByPoint();
  80   }
  81
  82   if (aMethodType == CREATION_METHOD_BY_AXIS()) {
  83     performSymmetryByAxis();
  84   }
  85
  86   if (aMethodType == CREATION_METHOD_BY_PLANE()) {
  87     performSymmetryByPlane();
  88   }
  89 }
  90
  91 //=================================================================================================
  92 bool FeaturesPlugin_Symmetry::collectSourceObjects(ListOfShape& theSourceShapes,
  93                                                    std::list<ResultPtr>& theSourceResults)
  94 {
  95   AttributeSelectionListPtr anObjectsSelList =
  96     selectionList(FeaturesPlugin_Symmetry::OBJECTS_LIST_ID());
  97   if (anObjectsSelList->size() == 0) {
  98     return false;
  99   }
 100   for (int anObjectsIndex = 0; anObjectsIndex < anObjectsSelList->size(); anObjectsIndex++) {
 101     std::shared_ptr<ModelAPI_AttributeSelection> anObjectAttr =
 102       anObjectsSelList->value(anObjectsIndex);
 103     std::shared_ptr<GeomAPI_Shape> anObject = anObjectAttr->value();
 104     if (!anObject.get()) { // may be for not-activated parts
 105       return false;
 106     }
 107     theSourceShapes.push_back(anObject);
 108     theSourceResults.push_back(anObjectAttr->context());
 109   }
 110   return true;
 111 }
 112
 113 //=================================================================================================
 114 void FeaturesPlugin_Symmetry::performSymmetryByPoint()
 115 {
 116   // Getting objects.
 117   ListOfShape anObjects;
 118   std::list<ResultPtr> aContextes;
 119   if (!collectSourceObjects(anObjects, aContextes))
 120     return;
 121
 122   //Getting point.
 123   std::shared_ptr<GeomAPI_Pnt> aPoint;
 124   std::shared_ptr<ModelAPI_AttributeSelection> anObjRef =
 125     selection(FeaturesPlugin_Symmetry::POINT_OBJECT_ID());
 126   if (anObjRef.get() != NULL) {
 127     GeomShapePtr aShape1 = anObjRef->value();
 128     if (!aShape1.get()) {
 129       aShape1 = anObjRef->context()->shape();
 130     }
 131     if (aShape1) {
 132       aPoint = GeomAlgoAPI_PointBuilder::point(aShape1);
 133     }
 134   }
 135
 136   // Moving each object.
 137   int aResultIndex = 0;
 138   std::list<ResultPtr>::iterator aContext = aContextes.begin();
 139   for(ListOfShape::iterator anObjectsIt = anObjects.begin(); anObjectsIt != anObjects.end();
 140         anObjectsIt++, aContext++) {
 141     std::shared_ptr<GeomAPI_Shape> aBaseShape = *anObjectsIt;
 142     bool isPart = aContext->get() && (*aContext)->groupName() == ModelAPI_ResultPart::group();
 143
 144     // Setting result.
 145     if (isPart) {
 146       std::shared_ptr<GeomAPI_Trsf> aTrsf(new GeomAPI_Trsf());
 147       aTrsf->setSymmetry(aPoint);
 148       ResultPartPtr anOrigin = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aContext);
 149       buildResult(anOrigin, aTrsf, aResultIndex);
 150     }
 151     else {
 152       std::shared_ptr<GeomAlgoAPI_Symmetry> aSymmetryAlgo(
 153         new GeomAlgoAPI_Symmetry(aBaseShape, aPoint));
 154
 155       if (!aSymmetryAlgo->check()) {
 156         setError(aSymmetryAlgo->getError());
 157         return;
 158       }
 159
 160       aSymmetryAlgo->build();
 161
 162       // Checking that the algorithm worked properly.
 163       if(!aSymmetryAlgo->isDone()) {
 164         static const std::string aFeatureError = "Error: Symmetry algorithm failed.";
 165         setError(aFeatureError);
 166         break;
 167       }
 168       if(aSymmetryAlgo->shape()->isNull()) {
 169         static const std::string aShapeError = "Error: Resulting shape is Null.";
 170         setError(aShapeError);
 171         break;
 172       }
 173       if(!aSymmetryAlgo->isValid()) {
 174         std::string aFeatureError = "Error: Resulting shape is not valid.";
 175         setError(aFeatureError);
 176         break;
 177       }
 178
 179       buildResult(aSymmetryAlgo, aBaseShape, aResultIndex);
 180     }
 181     aResultIndex++;
 182   }
 183
 184   // Remove the rest results if there were produced in the previous pass.
 185   removeResults(aResultIndex);
 186 }
 187
 188 //=================================================================================================
 189 void FeaturesPlugin_Symmetry::performSymmetryByAxis()
 190 {
 191   // Getting objects.
 192   ListOfShape anObjects;
 193   std::list<ResultPtr> aContextes;
 194   if (!collectSourceObjects(anObjects, aContextes))
 195     return;
 196
 197   //Getting axis.
 198   static const std::string aSelectionError = "Error: The axis shape selection is bad.";
 199   AttributeSelectionPtr anObjRef = selection(AXIS_OBJECT_ID());
 200   GeomShapePtr aShape = anObjRef->value();
 201   if (!aShape.get()) {
 202     if (anObjRef->context().get()) {
 203       aShape = anObjRef->context()->shape();
 204     }
 205   }
 206   if (!aShape.get()) {
 207     setError(aSelectionError);
 208     return;
 209   }
 210
 211   GeomEdgePtr anEdge;
 212   if (aShape->isEdge())
 213   {
 214     anEdge = aShape->edge();
 215   }
 216   else if (aShape->isCompound())
 217   {
 218     GeomAPI_ShapeIterator anIt(aShape);
 219     anEdge = anIt.current()->edge();
 220   }
 221
 222   if (!anEdge.get())
 223   {
 224     setError(aSelectionError);
 225     return;
 226   }
 227
 228   std::shared_ptr<GeomAPI_Ax1> anAxis (new GeomAPI_Ax1(anEdge->line()->location(),
 229                                                        anEdge->line()->direction()));
 230
 231
 232   // Moving each object.
 233   int aResultIndex = 0;
 234   std::list<ResultPtr>::iterator aContext = aContextes.begin();
 235   for(ListOfShape::iterator anObjectsIt = anObjects.begin(); anObjectsIt != anObjects.end();
 236         anObjectsIt++, aContext++) {
 237     std::shared_ptr<GeomAPI_Shape> aBaseShape = *anObjectsIt;
 238     bool isPart = aContext->get() && (*aContext)->groupName() == ModelAPI_ResultPart::group();
 239
 240     // Setting result.
 241     if (isPart) {
 242       std::shared_ptr<GeomAPI_Trsf> aTrsf(new GeomAPI_Trsf());
 243       aTrsf->setSymmetry(anAxis);
 244       ResultPartPtr anOrigin = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aContext);
 245       buildResult(anOrigin, aTrsf, aResultIndex);
 246     }
 247     else {
 248       std::shared_ptr<GeomAlgoAPI_Symmetry> aSymmetryAlgo(
 249         new GeomAlgoAPI_Symmetry(aBaseShape, anAxis));
 250
 251       if (!aSymmetryAlgo->check()) {
 252         setError(aSymmetryAlgo->getError());
 253         return;
 254       }
 255
 256       aSymmetryAlgo->build();
 257
 258       // Checking that the algorithm worked properly.
 259       if(!aSymmetryAlgo->isDone()) {
 260         static const std::string aFeatureError = "Error: Symmetry algorithm failed.";
 261         setError(aFeatureError);
 262         break;
 263       }
 264       if(aSymmetryAlgo->shape()->isNull()) {
 265         static const std::string aShapeError = "Error: Resulting shape is Null.";
 266         setError(aShapeError);
 267         break;
 268       }
 269       if(!aSymmetryAlgo->isValid()) {
 270         std::string aFeatureError = "Error: Resulting shape is not valid.";
 271         setError(aFeatureError);
 272         break;
 273       }
 274
 275       buildResult(aSymmetryAlgo, aBaseShape, aResultIndex);
 276     }
 277     aResultIndex++;
 278   }
 279
 280   // Remove the rest results if there were produced in the previous pass.
 281   removeResults(aResultIndex);
 282 }
 283
 284 //=================================================================================================
 285 void FeaturesPlugin_Symmetry::performSymmetryByPlane()
 286 {
 287   // Getting objects.
 288   ListOfShape anObjects;
 289   std::list<ResultPtr> aContextes;
 290   if (!collectSourceObjects(anObjects, aContextes))
 291     return;
 292
 293   //Getting plane.
 294   static const std::string aSelectionError = "Error: The plane shape selection is bad.";
 295   AttributeSelectionPtr anObjRef = selection(PLANE_OBJECT_ID());
 296   GeomShapePtr aShape = anObjRef->value();
 297   if (!aShape.get()) {
 298     if (anObjRef->context().get()) {
 299       aShape = anObjRef->context()->shape();
 300     }
 301   }
 302   if (!aShape.get()) {
 303     setError(aSelectionError);
 304     return;
 305   }
 306
 307   GeomFacePtr aFace;
 308   if (aShape->isFace())
 309   {
 310     aFace = aShape->face();
 311   }
 312   else if (aShape->isCompound())
 313   {
 314     GeomAPI_ShapeIterator anIt(aShape);
 315     aFace = anIt.current()->face();
 316   }
 317
 318   if (!aFace.get())
 319   {
 320     setError(aSelectionError);
 321     return;
 322   }
 323
 324   std::shared_ptr<GeomAPI_Ax2> aPlane(new GeomAPI_Ax2(aFace->getPlane()->location(),
 325                                                       aFace->getPlane()->direction()));
 326
 327
 328   // Moving each object.
 329   int aResultIndex = 0;
 330   std::list<ResultPtr>::iterator aContext = aContextes.begin();
 331   for(ListOfShape::iterator anObjectsIt = anObjects.begin(); anObjectsIt != anObjects.end();
 332         anObjectsIt++, aContext++) {
 333     std::shared_ptr<GeomAPI_Shape> aBaseShape = *anObjectsIt;
 334     bool isPart = aContext->get() && (*aContext)->groupName() == ModelAPI_ResultPart::group();
 335
 336     // Setting result.
 337     if (isPart) {
 338       std::shared_ptr<GeomAPI_Trsf> aTrsf(new GeomAPI_Trsf());
 339       aTrsf->setSymmetry(aPlane);
 340       ResultPartPtr anOrigin = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aContext);
 341       buildResult(anOrigin, aTrsf, aResultIndex);
 342     } else {
 343       std::shared_ptr<GeomAlgoAPI_Symmetry> aSymmetryAlgo(
 344         new GeomAlgoAPI_Symmetry(aBaseShape, aPlane));
 345
 346       if (!aSymmetryAlgo->check()) {
 347         setError(aSymmetryAlgo->getError());
 348         return;
 349       }
 350
 351       aSymmetryAlgo->build();
 352
 353       // Checking that the algorithm worked properly.
 354       if(!aSymmetryAlgo->isDone()) {
 355         static const std::string aFeatureError = "Error: Symmetry algorithm failed.";
 356         setError(aFeatureError);
 357         break;
 358       }
 359       if(aSymmetryAlgo->shape()->isNull()) {
 360         static const std::string aShapeError = "Error: Resulting shape is Null.";
 361         setError(aShapeError);
 362         break;
 363       }
 364       if(!aSymmetryAlgo->isValid()) {
 365         std::string aFeatureError = "Error: Resulting shape is not valid.";
 366         setError(aFeatureError);
 367         break;
 368       }
 369
 370       buildResult(aSymmetryAlgo, aBaseShape, aResultIndex);
 371     }
 372     aResultIndex++;
 373   }
 374
 375   // Remove the rest results if there were produced in the previous pass.
 376   removeResults(aResultIndex);
 377 }
 378
 379 //=================================================================================================
 380 void FeaturesPlugin_Symmetry::buildResult(
 381   std::shared_ptr<GeomAlgoAPI_Symmetry>& theSymmetryAlgo,
 382   std::shared_ptr<GeomAPI_Shape> theBaseShape, int theResultIndex)
 383 {
 384   std::shared_ptr<GeomAlgoAPI_MakeShapeList> anAlgoList(new GeomAlgoAPI_MakeShapeList());
 385   anAlgoList->appendAlgo(theSymmetryAlgo);
 386   // Compose source shape and the result of symmetry.
 387   GeomShapePtr aCompound;
 388   if (boolean(KEEP_ORIGINAL_RESULT())->value()) {
 389     ListOfShape aShapes;
 390     // add a copy of a base shape otherwise selection of this base shape is bad (2592)
 391     std::shared_ptr<GeomAlgoAPI_Copy> aCopyAlgo(new GeomAlgoAPI_Copy(theBaseShape));
 392     aShapes.push_back(aCopyAlgo->shape());
 393     anAlgoList->appendAlgo(aCopyAlgo);
 394
 395     aShapes.push_back(theSymmetryAlgo->shape());
 396     aCompound = GeomAlgoAPI_CompoundBuilder::compound(aShapes);
 397   } else
 398     aCompound = theSymmetryAlgo->shape();
 399
 400   // Store and name the result.
 401   ResultBodyPtr aResultBody = document()->createBody(data(), theResultIndex);
 402   aResultBody->storeModified(theBaseShape, aCompound);
 403   FeaturesPlugin_Tools::loadModifiedShapes(aResultBody, theBaseShape, anAlgoList, "Symmetried");
 404   setResult(aResultBody, theResultIndex);
 405 }
 406
 407 //=================================================================================================
 408 void FeaturesPlugin_Symmetry::buildResult(ResultPartPtr theOriginal,
 409                                           std::shared_ptr<GeomAPI_Trsf> theTrsf,
 410                                           int& theResultIndex)
 411 {
 412   if (boolean(KEEP_ORIGINAL_RESULT())->value()) {
 413     std::shared_ptr<GeomAPI_Trsf> anIdentity(new GeomAPI_Trsf());
 414     ResultPartPtr aCopy = document()->copyPart(theOriginal, data(), theResultIndex);
 415     aCopy->setTrsf(theOriginal, anIdentity);
 416     setResult(aCopy, theResultIndex);
 417     ++theResultIndex;
 418   }
 419
 420   ResultPartPtr aResultPart = document()->copyPart(theOriginal, data(), theResultIndex);
 421   aResultPart->setTrsf(theOriginal, theTrsf);
 422   setResult(aResultPart, theResultIndex);
 423 }