Salome HOME
Copyright update 2022
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Extrusion.cpp
index 535eb2fdd631548d7a1ef911ce84aa7d372f167a..10504a1832da15caa49a5e1368fd01d68edba40f 100644 (file)
@@ -1,25 +1,38 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesPlugin_Extrusion.cpp
-// Created:     30 May 2014
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2022  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #include "FeaturesPlugin_Extrusion.h"
 
-#include <ModelAPI_Session.h>
-#include <ModelAPI_Validator.h>
-#include <ModelAPI_ResultConstruction.h>
-#include <ModelAPI_ResultBody.h>
 #include <ModelAPI_AttributeDouble.h>
 #include <ModelAPI_AttributeSelection.h>
-#include <ModelAPI_AttributeSelectionList.h>
 #include <ModelAPI_AttributeString.h>
+#include <ModelAPI_Session.h>
+#include <ModelAPI_Validator.h>
+#include <ModelAPI_Tools.h>
 
-#include <GeomAlgoAPI_CompoundBuilder.h>
 #include <GeomAlgoAPI_Prism.h>
-#include <GeomAlgoAPI_ShapeTools.h>
+#include <GeomAlgoAPI_Tools.h>
 
-#include <sstream>
+#include <GeomAPI_Dir.h>
+#include <GeomAPI_Edge.h>
+#include <GeomAPI_Lin.h>
+#include <GeomAPI_ShapeIterator.h>
 
 //=================================================================================================
 FeaturesPlugin_Extrusion::FeaturesPlugin_Extrusion()
@@ -29,11 +42,7 @@ FeaturesPlugin_Extrusion::FeaturesPlugin_Extrusion()
 //=================================================================================================
 void FeaturesPlugin_Extrusion::initAttributes()
 {
-  AttributeSelectionListPtr aSelection = 
-    std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(data()->addAttribute(
-    LIST_ID(), ModelAPI_AttributeSelectionList::typeId()));
-  // extrusion works with faces always
-  aSelection->setSelectionType("FACE");
+  initCompositeSketchAttribtues(InitBaseObjectsList);
 
   data()->addAttribute(CREATION_METHOD(), ModelAPI_AttributeString::typeId());
 
@@ -46,161 +55,174 @@ void FeaturesPlugin_Extrusion::initAttributes()
   data()->addAttribute(FROM_OBJECT_ID(), ModelAPI_AttributeSelection::typeId());
   data()->addAttribute(FROM_OFFSET_ID(), ModelAPI_AttributeDouble::typeId());
 
+  data()->addAttribute(DIRECTION_OBJECT_ID(), ModelAPI_AttributeSelection::typeId());
+
   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), TO_OBJECT_ID());
   ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), FROM_OBJECT_ID());
+  ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(), DIRECTION_OBJECT_ID());
+
+  initCompositeSketchAttribtues(InitSketchLauncher);
 }
 
 //=================================================================================================
 void FeaturesPlugin_Extrusion::execute()
 {
-  // Getting faces.
-  ListOfShape aFacesList;
-  AttributeSelectionListPtr aFacesSelectionList = selectionList(LIST_ID());
-  for(int anIndex = 0; anIndex < aFacesSelectionList->size(); anIndex++) {
-    AttributeSelectionPtr aFaceSel = aFacesSelectionList->value(anIndex);
-    std::shared_ptr<GeomAPI_Shape> aFaceShape = aFaceSel->value();
-    if(aFaceShape.get() && !aFaceShape->isNull()) { // Getting face.
-      aFacesList.push_back(aFaceShape);
-    } else { // This may be the whole sketch result selected, check and get faces.
-      ResultPtr aContext = aFaceSel->context();
-      std::shared_ptr<GeomAPI_Shape> aContextShape = aContext->shape();
-      if(!aContextShape.get()) {
-        static const std::string aContextError = "The selection context is bad";
-        setError(aContextError);
-        return;
-      }
-      ResultConstructionPtr aConstruction = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(aContext);
-      if(!aConstruction.get()) {
-        static const std::string aFaceError = "Can not find basis for extrusion";
-        setError(aFaceError);
-        return;
-      }
-      int aFacesNum = aConstruction->facesNum();
-      for(int aFaceIndex = 0; aFaceIndex < aFacesNum || aFacesNum == -1; aFaceIndex++) {
-        aFaceShape = std::dynamic_pointer_cast<GeomAPI_Shape>(aConstruction->face(aFaceIndex));
-        aFacesList.push_back(aFaceShape);
-      }
-    }
+  ListOfShape aBaseShapesList, aBoundaryShapes;
+  ListOfMakeShape aMakeShapesList;
+
+  // Make extrusions.
+  if(!makeExtrusions(aBaseShapesList, aBoundaryShapes, aMakeShapesList)) {
+    return;
+  }
+
+  // Store results.
+  int aResultIndex = 0;
+  ListOfShape::const_iterator aBaseIt = aBaseShapesList.cbegin();
+  ListOfMakeShape::const_iterator anAlgoIt = aMakeShapesList.cbegin();
+  for(; aBaseIt != aBaseShapesList.cend() && anAlgoIt != aMakeShapesList.cend();
+        ++aBaseIt, ++anAlgoIt) {
+    if (aBoundaryShapes.empty())
+      storeResult(*aBaseIt, *anAlgoIt, aResultIndex++);
+    else
+      storeResultWithBoundaries(*aBaseIt, aBoundaryShapes, *anAlgoIt, aResultIndex++);
   }
 
+  removeResults(aResultIndex);
+}
+
+//=================================================================================================
+bool FeaturesPlugin_Extrusion::makeExtrusions(ListOfShape& theBaseShapes,
+                                              ListOfShape& theBoundaryShapes,
+                                              ListOfMakeShape& theMakeShapes)
+{
+  theMakeShapes.clear();
+
+  // Getting base shapes.
+  getBaseShapes(theBaseShapes);
+
+  //Getting direction.
+  std::shared_ptr<GeomAPI_Dir> aDir;
+  getDirection(aDir);
+
   // Getting sizes.
   double aToSize = 0.0;
   double aFromSize = 0.0;
-
-  if(string(CREATION_METHOD())->value() == "BySizes") {
-    aToSize = real(TO_SIZE_ID())->value();
-    aFromSize =  real(FROM_SIZE_ID())->value();
-  } else {
-    aToSize = real(TO_OFFSET_ID())->value();
-    aFromSize =  real(FROM_OFFSET_ID())->value();
-  }
+  getSizes(aToSize, aFromSize);
 
   // Getting bounding planes.
-  std::shared_ptr<GeomAPI_Shape> aToShape;
-  std::shared_ptr<GeomAPI_Shape> aFromShape;
-
-  if(string(CREATION_METHOD())->value() == "ByPlanesAndOffsets") {
-    std::shared_ptr<ModelAPI_AttributeSelection> anObjRef = selection(TO_OBJECT_ID());
-    if(anObjRef.get() != NULL) {
-      aToShape = std::dynamic_pointer_cast<GeomAPI_Shape>(anObjRef->value());
-      if(aToShape.get() == NULL && anObjRef->context().get() != NULL) {
-        aToShape =  anObjRef->context()->shape();
+  GeomShapePtr aToShape;
+  GeomShapePtr aFromShape;
+
+  if(string(CREATION_METHOD())->value() == CREATION_METHOD_BY_PLANES()) {
+    AttributeSelectionPtr aSelection = selection(TO_OBJECT_ID());
+    if(aSelection.get()) {
+      aToShape = std::dynamic_pointer_cast<GeomAPI_Shape>(aSelection->value());
+      if(!aToShape.get() && aSelection->context().get()) {
+        aToShape = aSelection->context()->shape();
+      }
+      if (aToShape.get() && aToShape->isCompound()) {
+        GeomAPI_ShapeIterator anIt(aToShape);
+        aToShape = anIt.current();
       }
     }
-    anObjRef = selection(FROM_OBJECT_ID());
-    if(anObjRef.get() != NULL) {
-      aFromShape = std::dynamic_pointer_cast<GeomAPI_Shape>(anObjRef->value());
-      if(aFromShape.get() == NULL && anObjRef->context().get() != NULL) {
-        aFromShape = anObjRef->context()->shape();
+    aSelection = selection(FROM_OBJECT_ID());
+    if(aSelection.get()) {
+      aFromShape = std::dynamic_pointer_cast<GeomAPI_Shape>(aSelection->value());
+      if(!aFromShape.get() && aSelection->context().get()) {
+        aFromShape = aSelection->context()->shape();
+      }
+      if (aFromShape.get() && aFromShape->isCompound()) {
+        GeomAPI_ShapeIterator anIt(aFromShape);
+        aFromShape = anIt.current();
       }
     }
   }
-
-  // Searching faces with common edges.
-  ListOfShape aShells;
-  ListOfShape aFreeFaces;
-  std::shared_ptr<GeomAPI_Shape> aFacesCompound = GeomAlgoAPI_CompoundBuilder::compound(aFacesList);
-  GeomAlgoAPI_ShapeTools::combineShapes(aFacesCompound, GeomAPI_Shape::SHELL, aShells, aFreeFaces);
-  aShells.insert(aShells.end(), aFreeFaces.begin(), aFreeFaces.end());
-
-  // Generating result for each shell and face.
-  int aResultIndex = 0;
-  for(ListOfShape::const_iterator anIter = aShells.cbegin(); anIter != aShells.cend(); anIter++) {
+  if (aToShape && !aToShape->isPlanar())
+    theBoundaryShapes.push_back(aToShape);
+  if (aFromShape && !aFromShape->isPlanar())
+    theBoundaryShapes.push_back(aFromShape);
+
+  // Generating result for each base shape.
+  std::string anError;
+  for(ListOfShape::const_iterator
+      anIter = theBaseShapes.cbegin(); anIter != theBaseShapes.cend(); anIter++) {
     std::shared_ptr<GeomAPI_Shape> aBaseShape = *anIter;
 
-    GeomAlgoAPI_Prism aPrismAlgo(aBaseShape, aToShape, aToSize, aFromShape, aFromSize);
-    if(!aPrismAlgo.isDone()) {
-      static const std::string aPrismAlgoError = "Extrusion algorithm failed";
-      setError(aPrismAlgoError);
-      aResultIndex = 0;
-      break;
+    std::shared_ptr<GeomAlgoAPI_Prism> aPrismAlgo(new GeomAlgoAPI_Prism(aBaseShape, aDir,
+                                                                        aToShape, aToSize,
+                                                                        aFromShape, aFromSize));
+    if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aPrismAlgo, getKind(), anError)) {
+      setError(anError);
+      return false;
     }
 
-    // Check if shape is valid
-    if(!aPrismAlgo.shape().get() || aPrismAlgo.shape()->isNull()) {
-      static const std::string aShapeError = "Resulting shape is Null";
-      setError(aShapeError);
-      aResultIndex = 0;
-      break;
-    }
-    if(!aPrismAlgo.isValid()) {
-      std::string aPrismAlgoError = "Warning: resulting shape is not valid";
-      setError(aPrismAlgoError);
-      aResultIndex = 0;
-      break;
-    }
-
-    ResultBodyPtr aResultBody = document()->createBody(data(), aResultIndex);
-    loadNamingDS(aPrismAlgo, aResultBody, aBaseShape);
-    setResult(aResultBody, aResultIndex);
-    aResultIndex++;
+    theMakeShapes.push_back(aPrismAlgo);
   }
 
-  removeResults(aResultIndex);
+  return true;
+}
+
+//=================================================================================================
+void FeaturesPlugin_Extrusion::storeResultWithBoundaries(
+    const GeomShapePtr theBaseShape,
+    const ListOfShape& theBoundaryShapes,
+    const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+    const int theIndex)
+{
+  // Create result body.
+  ResultBodyPtr aResultBody = document()->createBody(data(), theIndex);
+
+  // Store modified shapes.
+  ModelAPI_Tools::loadModifiedShapes(aResultBody, theBoundaryShapes, ListOfShape(),
+                                     theMakeShape, theMakeShape->shape());
+
+  // Store generated edges/faces.
+  storeGenerationHistory(aResultBody, theBaseShape, theMakeShape);
+
+  setResult(aResultBody, theIndex);
 }
 
 //=================================================================================================
-void FeaturesPlugin_Extrusion::loadNamingDS(GeomAlgoAPI_Prism& thePrismAlgo,
-                                            std::shared_ptr<ModelAPI_ResultBody> theResultBody,
-                                            std::shared_ptr<GeomAPI_Shape> theBasis)
+void FeaturesPlugin_Extrusion::getDirection(std::shared_ptr<GeomAPI_Dir>& theDir)
 {
-  //load result
-  theResultBody->storeGenerated(theBasis, thePrismAlgo.shape());
-
-  std::shared_ptr<GeomAPI_DataMapOfShapeShape> aSubShapes = thePrismAlgo.mapOfSubShapes();
-
-  //Insert lateral face : Face from Edge
-  const std::string aLatName = "LateralFace";
-  const int aLatTag = 1;
-  theResultBody->loadAndOrientGeneratedShapes(&thePrismAlgo, theBasis, GeomAPI_Shape::EDGE, aLatTag, aLatName, *aSubShapes);
-
-  //Insert to faces
-  int aToFaceIndex = 1;
-  const std::string aToName = "ToFace";
-  int aToTag = 2;
-  const ListOfShape& aToFaces = thePrismAlgo.toFaces();
-  for(ListOfShape::const_iterator anIt = aToFaces.cbegin(); anIt != aToFaces.cend(); anIt++) {
-    std::shared_ptr<GeomAPI_Shape> aToFace = *anIt;
-    if(aSubShapes->isBound(aToFace)) {
-      aToFace = aSubShapes->find(aToFace);
+  static const std::string aSelectionError = "Error: The direction shape selection is bad.";
+  AttributeSelectionPtr aSelection = selection(DIRECTION_OBJECT_ID());
+  GeomShapePtr aShape = aSelection->value();
+  if (!aShape.get()) {
+    if (aSelection->context().get()) {
+      aShape = aSelection->context()->shape();
+    }
+  }
+
+  GeomEdgePtr anEdge;
+  if (aShape.get()) {
+    if (aShape->isEdge())
+    {
+      anEdge = aShape->edge();
+    }
+    else if (aShape->isCompound())
+    {
+      GeomAPI_ShapeIterator anIt(aShape);
+      anEdge = anIt.current()->edge();
     }
-    std::ostringstream aStr;
-    aStr << aToName << "_" << aToFaceIndex++;
-    theResultBody->generated(aToFace, aStr.str(), aToTag++);
   }
 
-  //Insert from faces
-  int aFromFaceIndex = 1;
-  const std::string aFromName = "FromFace";
-  int aFromTag = aToTag > 10000 ? aToTag : 10000;
-  const ListOfShape& aFromFaces = thePrismAlgo.fromFaces();
-  for(ListOfShape::const_iterator anIt = aFromFaces.cbegin(); anIt != aFromFaces.cend(); anIt++) {
-    std::shared_ptr<GeomAPI_Shape> aFromFace = *anIt;
-    if(aSubShapes->isBound(aFromFace)) {
-      aFromFace = aSubShapes->find(aFromFace);
+  if (anEdge.get()) {
+    if (anEdge->isLine()) {
+      theDir = anEdge->line()->direction();
     }
-    std::ostringstream aStr;
-    aStr << aFromName << "_" << aFromFaceIndex++;
-    theResultBody->generated(aFromFace, aStr.str(), aFromTag++);
+  }
+}
+
+//=================================================================================================
+void FeaturesPlugin_Extrusion::getSizes(double& theToSize, double& theFromSize)
+{
+  if (string(CREATION_METHOD())->value() == CREATION_METHOD_BY_SIZES()) {
+    theToSize = real(TO_SIZE_ID())->value();
+    theFromSize = real(FROM_SIZE_ID())->value();
+  } else if (string(CREATION_METHOD())->value() == CREATION_METHOD_BY_PLANES()) {
+    theToSize = real(TO_OFFSET_ID())->value();
+    theFromSize = real(FROM_OFFSET_ID())->value();
+  } else {
   }
 }