Salome HOME
Merge branch 'csgroup_IS2'
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Placement.cpp
index 63f25c921c447afb0c3da63fa0f57d214da0000c..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()
 {
-  /* Modification for specification of 1.3.0
-  AttributeSelectionListPtr aSelection = 
+  AttributeSelectionListPtr aSelection =
     std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(data()->addAttribute(
-    FeaturesPlugin_Placement::LIST_ID(), ModelAPI_AttributeSelectionList::typeId()));
-  // extrusion works with faces always
-  aSelection->setSelectionType("SOLID");
-  */
-  data()->addAttribute(FeaturesPlugin_Placement::BASE_OBJECT_ID(), ModelAPI_AttributeSelection::typeId());
-  data()->addAttribute(FeaturesPlugin_Placement::ATTRACT_OBJECT_ID(), ModelAPI_AttributeSelection::typeId());
-  data()->addAttribute(FeaturesPlugin_Placement::REVERSE_ID(), ModelAPI_AttributeBoolean::typeId());
-  data()->addAttribute(FeaturesPlugin_Placement::CENTERING_ID(), ModelAPI_AttributeBoolean::typeId());
+    OBJECTS_LIST_ID(), ModelAPI_AttributeSelectionList::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()
 {
-  // Verify the base face
-  std::shared_ptr<ModelAPI_AttributeSelection> anObjRef = std::dynamic_pointer_cast<
-    ModelAPI_AttributeSelection>(data()->attribute(FeaturesPlugin_Placement::BASE_OBJECT_ID()));
-  if (!anObjRef)
+  bool isKeepSubShapes = data()->version() == PLACEMENT_VERSION_1;
+
+  // Getting objects.
+  GeomAPI_ShapeHierarchy anObjects;
+  std::list<ResultPtr> aParts;
+  std::string theTextureFile;
+  AttributeSelectionListPtr anObjectsSelList = selectionList(OBJECTS_LIST_ID());
+  if (!FeaturesPlugin_Tools::shapesFromSelectionList(
+       anObjectsSelList, isKeepSubShapes, anObjects, aParts, theTextureFile))
     return;
 
-  std::shared_ptr<GeomAPI_Shape> aBaseShape = 
-    std::dynamic_pointer_cast<GeomAPI_Shape>(anObjRef->value());
-  if (!aBaseShape)
+  // Verify the start shape
+  AttributeSelectionPtr anObjRef = selection(START_SHAPE_ID());
+  if(!anObjRef) {
     return;
+  }
+  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> aBaseObject;
+
+  std::shared_ptr<GeomAPI_Shape> aStartShapeContext;
   ResultPtr aContextRes = anObjRef->context();
   if (aContextRes.get()) {
-    aBaseObject = aContextRes->shape();
+    aStartShapeContext = aContextRes->shape();
   }
-  if (!aBaseObject.get()) {
-    static const std::string aContextError = "The base 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 attractive face
-  anObjRef = std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(
-      data()->attribute(FeaturesPlugin_Placement::ATTRACT_OBJECT_ID()));
-
-  std::shared_ptr<GeomAPI_Shape> aSlaveShape = 
-    std::dynamic_pointer_cast<GeomAPI_Shape>(anObjRef->value());
-  if (!aSlaveShape)
+  // 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> aSlaveObject;
+  std::shared_ptr<GeomAPI_Shape> anEndShapeContext;
   aContextRes = anObjRef->context();
-  if (aContextRes.get()) {
-    aSlaveObject = aContextRes->shape();
+  if(aContextRes.get()) {
+    anEndShapeContext = aContextRes->shape();
   }
-  if (!aSlaveObject.get()) {
-    static const std::string aContextError = "The tool 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] = {aBaseShape, aSlaveShape};
+  std::shared_ptr<GeomAPI_Shape> aShapes[2] = {aStartShape, anEndShape};
   for (int i = 0; i < 2; i++) {
-    if (aShapes[i]->isFace()) {
-      std::shared_ptr<GeomAPI_Face> aFace(new GeomAPI_Face(aShapes[i]));
-      if (!aFace->isPlanar()) {
-        static const std::string aPlanarityError = "One of selected faces is not planar";
-        setError(aPlanarityError);
-        return;
-      }
-    }
-    else if (aShapes[i]->isEdge()) {
-      std::shared_ptr<GeomAPI_Edge> anEdge(new GeomAPI_Edge(aShapes[i]));
-      if (!anEdge->isLine()) {
-        static const std::string aLinearityError = "One of selected endges is not linear";
-        setError(aLinearityError);
-        return;
-      }
+    if (!isShapeValid(aShapes[i])) {
+      return;
     }
   }
 
   // Flags of the Placement
-  AttributeBooleanPtr aBoolAttr = std::dynamic_pointer_cast<ModelAPI_AttributeBoolean>(
-      data()->attribute(FeaturesPlugin_Placement::REVERSE_ID()));
-  bool isReverse = aBoolAttr->value();
-  aBoolAttr = std::dynamic_pointer_cast<ModelAPI_AttributeBoolean>(
-      data()->attribute(FeaturesPlugin_Placement::CENTERING_ID()));
-  bool isCentering = aBoolAttr->value();
-
-  bool isPart = aContextRes->groupName() == ModelAPI_ResultPart::group();
-
-  std::shared_ptr<ModelAPI_ResultBody> aResultBody;
-  if (isPart) 
-    aResultBody = document()->createBody(data());
-  GeomAlgoAPI_Placement aFeature(aSlaveObject, aBaseObject, aSlaveShape, aBaseShape, isReverse, isCentering);
-  if(!aFeature.isDone()) {
-    static const std::string aFeatureError = "Placement algorithm failed";
+  bool isReverse = boolean(REVERSE_ID())->value();
+  bool isCentering = boolean(CENTERING_ID())->value();
+
+  // Getting transformation.
+  GeomAlgoAPI_Placement aPlacementAlgo(
+    aStartShapeContext, anEndShapeContext, aStartShape, anEndShape, isReverse, isCentering, true);
+  if(!aPlacementAlgo.isDone()) {
+    static const std::string aFeatureError = "Error: Placement algorithm failed.";
     setError(aFeatureError);
     return;
   }
+  std::shared_ptr<GeomAPI_Trsf> aTrsf = aPlacementAlgo.transformation();
+
+  int aResultIndex = 0;
+  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++);
+  }
 
-  // Check if shape is valid
-  if (aFeature.shape()->isNull()) {
-    static const std::string aShapeError = "Resulting shape is Null";
-    setError(aShapeError);
-    return;
+  // 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));
+
+    // Checking that the algorithm worked properly.
+    if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aTransformAlgo, getKind(), anError)) {
+      setError(anError);
+      break;
+    }
+
+    anObjects.markModified(aBaseShape, aTransformAlgo->shape());
+    aMakeShapeList->appendAlgo(aTransformAlgo);
   }
-  if(!aFeature.isValid()) {
-    std::string aFeatureError = "Warning: resulting shape is not valid";
-    setError(aFeatureError);
-    return;
-  }  
-
-  if (isPart) { // for part results just set transformation
-    ResultPartPtr anOrigin = std::dynamic_pointer_cast<ModelAPI_ResultPart>(aContextRes);
-    ResultPartPtr aResultPart = document()->copyPart(firstResult(), anOrigin);
-    aResultPart->setShape(aContextRes, aFeature.shape());
-    setResult(aResultPart);
-  } else {
-    //LoadNamingDS
-    LoadNamingDS(aFeature, aResultBody, aSlaveObject);
 
-    setResult(aResultBody);
+  // 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_Placement& theFeature,
-    std::shared_ptr<ModelAPI_ResultBody> theResultBody,
-    std::shared_ptr<GeomAPI_Shape> theSlaveObject)
+//==================================================================================================
+bool FeaturesPlugin_Placement::isShapeValid(GeomShapePtr theShape)
 {
-  //load result
-  theResultBody->storeModified(theSlaveObject, theFeature.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;
+      }
 
-  GeomAPI_DataMapOfShapeShape* aSubShapes = new GeomAPI_DataMapOfShapeShape();
-  theFeature.mapOfShapes(*aSubShapes);
-  
-    // put modifed faces in DF
-  std::string aModName = "Modified";
-  theResultBody->loadAndOrientModifiedShapes(theFeature.makeShape(), theSlaveObject, _FACE, _MODIFIEDF_TAG, aModName, *aSubShapes); 
+      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;
+    }
+  }
 
+  return true;
 }