Salome HOME
Merge branch 'csgroup_IS2'
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Placement.cpp
index ee954f593161602b26ea927311725caffcab773f..efc09092acf21eee33242bd10659d3541a7c11ae 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesPlugin_Placement.cpp
-// Created:     2 Dec 2014
-// Author:      Artem ZHIDKOV
+// Copyright (C) 2014-2021  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_Placement.h"
 
 #include <ModelAPI_AttributeSelection.h>
 #include <ModelAPI_AttributeBoolean.h>
 #include <ModelAPI_AttributeSelectionList.h>
+#include <ModelAPI_BodyBuilder.h>
+#include <ModelAPI_Tools.h>
 
 #include <GeomAPI_Edge.h>
 #include <GeomAPI_Face.h>
 #include <GeomAPI_Pln.h>
+#include <GeomAPI_ShapeHierarchy.h>
+#include <GeomAPI_ShapeIterator.h>
+
+#include <GeomAlgoAPI_MakeShapeList.h>
 #include <GeomAlgoAPI_Placement.h>
 #include <GeomAlgoAPI_Transform.h>
+#include <GeomAlgoAPI_Tools.h>
+
+#include <FeaturesPlugin_Tools.h>
+
+static const std::string PLACEMENT_VERSION_1("v9.5");
 
-#define _MODIFIEDF_TAG 1
-#define _MODIFIEDE_TAG 2
-#define _MODIFIEDV_TAG 3
-#define _FACE 4
 FeaturesPlugin_Placement::FeaturesPlugin_Placement()
 {
 }
 
 void FeaturesPlugin_Placement::initAttributes()
 {
-
-  AttributeSelectionListPtr aSelection = 
+  AttributeSelectionListPtr aSelection =
     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(data()->addAttribute(
     OBJECTS_LIST_ID(), ModelAPI_AttributeSelectionList::typeId()));
-  // extrusion works with faces always
-  aSelection->setSelectionType("SOLID");
 
-  data()->addAttribute(START_FACE_ID(), ModelAPI_AttributeSelection::typeId());
-  data()->addAttribute(END_FACE_ID(), ModelAPI_AttributeSelection::typeId());
+  data()->addAttribute(START_SHAPE_ID(), ModelAPI_AttributeSelection::typeId());
+  data()->addAttribute(END_SHAPE_ID(), ModelAPI_AttributeSelection::typeId());
   data()->addAttribute(REVERSE_ID(), ModelAPI_AttributeBoolean::typeId());
   data()->addAttribute(CENTERING_ID(), ModelAPI_AttributeBoolean::typeId());
+
+  if (!aSelection->isInitialized()) {
+    // new feature, not read from file
+    data()->setVersion(PLACEMENT_VERSION_1);
+  }
 }
 
 void FeaturesPlugin_Placement::execute()
 {
+  bool isKeepSubShapes = data()->version() == PLACEMENT_VERSION_1;
+
   // Getting objects.
-  ListOfShape anObjects;
-  std::list<ResultPtr> aContextes;
+  GeomAPI_ShapeHierarchy anObjects;
+  std::list<ResultPtr> aParts;
+  std::string theTextureFile;
   AttributeSelectionListPtr anObjectsSelList = selectionList(OBJECTS_LIST_ID());
-  if(anObjectsSelList->size() == 0) {
+  if (!FeaturesPlugin_Tools::shapesFromSelectionList(
+       anObjectsSelList, isKeepSubShapes, anObjects, aParts, theTextureFile))
     return;
-  }
-  for(int anObjectsIndex = 0; anObjectsIndex < anObjectsSelList->size(); anObjectsIndex++) {
-    std::shared_ptr<ModelAPI_AttributeSelection> anObjectAttr = anObjectsSelList->value(anObjectsIndex);
-    std::shared_ptr<GeomAPI_Shape> anObject = anObjectAttr->value();
-    if(!anObject.get()) {
-      return;
-    }
-    anObjects.push_back(anObject);
-    aContextes.push_back(anObjectAttr->context());
-  }
 
-  // Verify the start face
-  AttributeSelectionPtr anObjRef = selection(START_FACE_ID());
+  // Verify the start shape
+  AttributeSelectionPtr anObjRef = selection(START_SHAPE_ID());
   if(!anObjRef) {
     return;
   }
-  std::shared_ptr<GeomAPI_Shape> aStartFace = anObjRef->value();
-  if(!aStartFace || !GeomAPI_Face(aStartFace).isPlanar()) {
-    static const std::string aSelectionError = "The start face selection is bad";
+  std::shared_ptr<GeomAPI_Shape> aStartShape = anObjRef->value();
+  if(!aStartShape) {
+    static const std::string aSelectionError = "Error: The start shape selection is bad.";
     setError(aSelectionError);
     return;
   }
 
 
-  std::shared_ptr<GeomAPI_Shape> aStartShape;
+  std::shared_ptr<GeomAPI_Shape> aStartShapeContext;
   ResultPtr aContextRes = anObjRef->context();
   if (aContextRes.get()) {
-    aStartShape = aContextRes->shape();
+    aStartShapeContext = aContextRes->shape();
   }
-  if(!aStartShape.get()) {
-    static const std::string aContextError = "The start face selection context is bad";
+  if(!aStartShapeContext.get()) {
+    static const std::string aContextError = "Error: The start shape selection context is bad.";
     setError(aContextError);
     return;
   }
 
-  // Verify the end face
-  anObjRef = selection(END_FACE_ID());
-  std::shared_ptr<GeomAPI_Shape> anEndFace = anObjRef->value();
-  if(!anEndFace || !GeomAPI_Face(anEndFace).isPlanar()) {
-    static const std::string aSelectionError = "The end face selection is bad";
+  // Verify the end shape
+  anObjRef = selection(END_SHAPE_ID());
+  std::shared_ptr<GeomAPI_Shape> anEndShape = anObjRef->value();
+  if(!anEndShape) {
+    static const std::string aSelectionError = "Error: The end shape selection is bad.";
     setError(aSelectionError);
     return;
   }
 
-  std::shared_ptr<GeomAPI_Shape> anEndShape;
+  std::shared_ptr<GeomAPI_Shape> anEndShapeContext;
   aContextRes = anObjRef->context();
   if(aContextRes.get()) {
-    anEndShape = aContextRes->shape();
+    anEndShapeContext = aContextRes->shape();
   }
-  if(!anEndShape.get()) {
-    static const std::string aContextError = "The end face selection context is bad";
+  if(!anEndShapeContext.get()) {
+    static const std::string aContextError = "Error: The end shape selection context is bad.";
     setError(aContextError);
     return;
   }
 
+  // Verify planarity of faces and linearity of edges
+  std::shared_ptr<GeomAPI_Shape> aShapes[2] = {aStartShape, anEndShape};
+  for (int i = 0; i < 2; i++) {
+    if (!isShapeValid(aShapes[i])) {
+      return;
+    }
+  }
+
   // Flags of the Placement
   bool isReverse = boolean(REVERSE_ID())->value();
   bool isCentering = boolean(CENTERING_ID())->value();
 
-  bool isPart = aContextRes->groupName() == ModelAPI_ResultPart::group();
-
   // Getting transformation.
   GeomAlgoAPI_Placement aPlacementAlgo(
-    aStartShape, anEndShape, aStartFace, anEndFace, isReverse, isCentering, true);
+    aStartShapeContext, anEndShapeContext, aStartShape, anEndShape, isReverse, isCentering, true);
   if(!aPlacementAlgo.isDone()) {
-    static const std::string aFeatureError = "Placement algorithm failed";
+    static const std::string aFeatureError = "Error: Placement algorithm failed.";
     setError(aFeatureError);
     return;
   }
   std::shared_ptr<GeomAPI_Trsf> aTrsf = aPlacementAlgo.transformation();
 
-  // Applying transformation to each object.
   int aResultIndex = 0;
-  std::list<ResultPtr>::iterator aContext = aContextes.begin();
-  for(ListOfShape::iterator anObjectsIt = anObjects.begin(); anObjectsIt != anObjects.end();
-      anObjectsIt++, aContext++) {
-
-    if (isPart) { // for part results just set transformation
-      ResultPartPtr anOrigin = std::dynamic_pointer_cast<ModelAPI_ResultPart>(aContextRes);
-      ResultPartPtr aResultPart = document()->copyPart(firstResult(), anOrigin);
-      aResultPart->setTrsf(aContextRes, aTrsf);
-      setResult(aResultPart);
-    } else {
-      std::shared_ptr<GeomAPI_Shape> aBaseShape = *anObjectsIt;
-      GeomAlgoAPI_Transform aTransformAlgo(aBaseShape, aTrsf);
-
-      // Checking that the algorithm worked properly.
-      if(!aTransformAlgo.isDone()) {
-        static const std::string aFeatureError = "Transform algorithm failed";
-        setError(aFeatureError);
-        break;
-      }
-      if(aTransformAlgo.shape()->isNull()) {
-        static const std::string aShapeError = "Resulting shape is Null";
-        setError(aShapeError);
-        break;
-      }
-      if(!aTransformAlgo.isValid()) {
-        std::string aFeatureError = "Warning: resulting shape is not valid";
-        setError(aFeatureError);
-        break;
-      }
+  std::string anError;
+  for (std::list<ResultPtr>::iterator aPRes = aParts.begin(); aPRes != aParts.end(); ++aPRes) {
+    // Applying transformation to each part.
+    ResultPartPtr anOrigin = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPRes);
+    ResultPartPtr aResultPart = document()->copyPart(anOrigin, data(), aResultIndex);
+    aResultPart->setTrsf(aContextRes, aTrsf);
+    setResult(aResultPart, aResultIndex++);
+  }
+
+  // Collect transformations for each object.
+  std::shared_ptr<GeomAlgoAPI_MakeShapeList> aMakeShapeList(new GeomAlgoAPI_MakeShapeList);
+
+  for(GeomAPI_ShapeHierarchy::iterator anObjectsIt = anObjects.begin();
+      anObjectsIt != anObjects.end(); anObjectsIt++) {
+    std::shared_ptr<GeomAPI_Shape> aBaseShape = *anObjectsIt;
+    std::shared_ptr<GeomAlgoAPI_Transform> aTransformAlgo(
+        new GeomAlgoAPI_Transform(aBaseShape, aTrsf));
 
-      //LoadNamingDS
-      std::shared_ptr<ModelAPI_ResultBody> aResultBody = document()->createBody(data(), aResultIndex);
-      LoadNamingDS(aTransformAlgo, aResultBody, aBaseShape);
-      setResult(aResultBody, aResultIndex);
+    // Checking that the algorithm worked properly.
+    if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aTransformAlgo, getKind(), anError)) {
+      setError(anError);
+      break;
     }
-    aResultIndex++;
+
+    anObjects.markModified(aBaseShape, aTransformAlgo->shape());
+    aMakeShapeList->appendAlgo(aTransformAlgo);
+  }
+
+  // Build results of the operation.
+  const ListOfShape& anOriginalShapes = anObjects.objects();
+  ListOfShape aTopLevel;
+  anObjects.topLevelObjects(aTopLevel);
+  for (ListOfShape::iterator anIt = aTopLevel.begin(); anIt != aTopLevel.end(); ++anIt) {
+    //LoadNamingDS
+    ResultBodyPtr aResultBody = document()->createBody(data(), aResultIndex);
+    FeaturesPlugin_Tools::loadModifiedShapes(aResultBody, anOriginalShapes, ListOfShape(),
+                                             aMakeShapeList, *anIt, "Placed");
+    aResultBody->setTextureFile(theTextureFile);
+    setResult(aResultBody, aResultIndex++);
   }
 
   // Remove the rest results if there were produced in the previous pass.
   removeResults(aResultIndex);
 }
 
-//============================================================================
-void FeaturesPlugin_Placement::LoadNamingDS(GeomAlgoAPI_Transform& theTransformAlgo,
-                                            std::shared_ptr<ModelAPI_ResultBody> theResultBody,
-                                            std::shared_ptr<GeomAPI_Shape> theSlaveObject)
+//==================================================================================================
+bool FeaturesPlugin_Placement::isShapeValid(GeomShapePtr theShape)
 {
-  //load result
-  theResultBody->storeModified(theSlaveObject, theTransformAlgo.shape()); // the initial Slave, the resulting Slave
+  if (theShape->isCompound()) {
+    GeomAPI_Shape::ShapeType aShapeType = GeomAPI_Shape::SHAPE;
+    for (GeomAPI_ShapeIterator anIt(theShape); anIt.more(); anIt.next()) {
+      GeomShapePtr aCurrentShape = anIt.current();
+      if (aShapeType == GeomAPI_Shape::SHAPE) {
+        aShapeType = aCurrentShape->shapeType();
+      }
+      else if (aShapeType != aCurrentShape->shapeType()) {
+        static const std::string aLinearityError =
+          "Error: Selected compound contains shapes with different types.";
+        setError(aLinearityError);
+        return false;
+      }
 
-  std::shared_ptr<GeomAPI_DataMapOfShapeShape> aSubShapes = theTransformAlgo.mapOfShapes();
+      if (!isShapeValid(aCurrentShape)) {
+        return false;
+      }
+    }
+  }
+  else if (theShape->isFace()) {
+    std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(theShape));
+    if (!aFace->isPlanar()) {
+      static const std::string aPlanarityError = "Error: One of selected faces is not planar.";
+      setError(aPlanarityError);
+      return false;
+    }
+  }
+  else if (theShape->isEdge()) {
+    std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(theShape));
+    if (!anEdge->isLine()) {
+      static const std::string aLinearityError = "Error: One of selected edges is not linear.";
+      setError(aLinearityError);
+      return false;
+    }
+  }
 
-    // put modifed faces in DF
-  std::string aModName = "Modified";
-  theResultBody->loadAndOrientModifiedShapes(theTransformAlgo.makeShape().get(),
-                                             theSlaveObject, _FACE,
-                                             _MODIFIEDF_TAG, aModName, *aSubShapes.get());
+  return true;
 }