Salome HOME
updated copyright message
[modules/shaper.git] / src / ConstructionPlugin / ConstructionPlugin_Plane.cpp
index 1189cb761d6e390b590593171d25912eafb57a6c..4d02af97f94a851faac0b50b2ece01d70a564271 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // 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
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #include "ConstructionPlugin_Plane.h"
@@ -25,6 +24,7 @@
 #include <GeomAlgoAPI_FaceBuilder.h>
 #include <GeomAlgoAPI_Rotation.h>
 #include <GeomAlgoAPI_ShapeTools.h>
+#include <GeomAlgoAPI_Tools.h>
 
 #include <GeomAPI_Ax1.h>
 #include <GeomAPI_Edge.h>
 #include <ModelAPI_AttributeSelection.h>
 #include <ModelAPI_AttributeString.h>
 #include <ModelAPI_AttributeBoolean.h>
+#include <ModelAPI_AttributeInteger.h>
 #include <ModelAPI_ResultConstruction.h>
 #include <ModelAPI_Session.h>
 #include <ModelAPI_Validator.h>
 
+#include <cfloat>
+
 
 static GeomShapePtr faceByThreeVertices(const std::shared_ptr<GeomAPI_Vertex> theV1,
                                         const std::shared_ptr<GeomAPI_Vertex> theV2,
@@ -97,51 +100,67 @@ void ConstructionPlugin_Plane::initAttributes()
   // By two parallel planes.
   data()->addAttribute(PLANE1(), ModelAPI_AttributeSelection::typeId());
   data()->addAttribute(PLANE2(), ModelAPI_AttributeSelection::typeId());
+
+  // By other plane.
+  AttributeIntegerPtr aNbCopies = std::dynamic_pointer_cast<ModelAPI_AttributeInteger>(
+    data()->addAttribute(NB_COPIES(), ModelAPI_AttributeInteger::typeId()));
+
+  if (!aNbCopies->isInitialized())
+    aNbCopies->setValue(1);
 }
 
 //==================================================================================================
 void ConstructionPlugin_Plane::execute()
 {
-  GeomShapePtr aShape;
+  ListOfShape aShapes;
 
   std::string aCreationMethod = string(CREATION_METHOD())->value();
   if(aCreationMethod == CREATION_METHOD_BY_GENERAL_EQUATION() ||
       aCreationMethod == "PlaneByGeneralEquation") {
-    aShape = createByGeneralEquation();
+    aShapes.push_back(createByGeneralEquation());
   } else if(aCreationMethod == CREATION_METHOD_BY_THREE_POINTS()) {
-    aShape = createByThreePoints();
+    aShapes.push_back(createByThreePoints());
   } else if(aCreationMethod == CREATION_METHOD_BY_LINE_AND_POINT()) {
-    aShape = createByLineAndPoint();
+    aShapes.push_back(createByLineAndPoint());
   } else if(aCreationMethod == CREATION_METHOD_BY_OTHER_PLANE()) {
     std::string aCreationMethodOption = string(CREATION_METHOD_BY_OTHER_PLANE_OPTION())->value();
     if(aCreationMethodOption == CREATION_METHOD_BY_DISTANCE_FROM_OTHER()) {
-      aShape = createByDistanceFromOther();
+      createByDistanceFromOther(aShapes);
     } else if(aCreationMethodOption == CREATION_METHOD_BY_COINCIDENT_TO_POINT()) {
-      aShape = createByCoincidentPoint();
+      aShapes.push_back(createByCoincidentPoint());
     } else if(aCreationMethodOption == CREATION_METHOD_BY_ROTATION()) {
-      aShape = createByRotation();
+      createByRotation(aShapes);
     }
   } else if(aCreationMethod == CREATION_METHOD_BY_TWO_PARALLEL_PLANES()) {
-    aShape = createByTwoParallelPlanes();
+    aShapes.push_back(createByTwoParallelPlanes());
   } else {
     setError("Error: Plane creation method \"" + aCreationMethod + "\" not supported.");
     return;
   }
 
-  if(!aShape.get()) {
+  if(aShapes.size() == 0) {
     setError("Error: Could not create a plane.");
     return;
   }
 
-  ResultConstructionPtr aConstr = document()->createConstruction(data());
-  aConstr->setInfinite(true);
-  aConstr->setShape(aShape);
-  setResult(aConstr);
+  int anIndex = 0;
+  for (auto aShapeIter = aShapes.begin(); aShapeIter != aShapes.end(); ++aShapeIter, ++anIndex)
+  {
+    if (!aShapeIter->get())
+    {
+      setError("Error: Could not create a plane.");
+      continue;
+    }
+    ResultConstructionPtr aConstr = document()->createConstruction(data(), anIndex);
+    aConstr->setInfinite(true);
+    aConstr->setShape(*aShapeIter);
+    setResult(aConstr, anIndex);
+  }
+  removeResults(anIndex);
 }
 
 //==================================================================================================
-bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
-                                                std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
+bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObjectPtr thePrs)
 {
   std::vector<int> aColor;
   // get color from the attribute of the result
@@ -155,7 +174,7 @@ bool ConstructionPlugin_Plane::customisePresentation(ResultPtr theResult, AISObj
     }
   }
   if (aColor.empty())
-    aColor = Config_PropManager::color("Visualization", "construction_plane_color");
+    aColor = Config_PropManager::color("Visualization", COLOR_NAME());
 
   bool isCustomized = false;
   if (aColor.size() == 3)
@@ -190,7 +209,6 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByGeneralEquation
   }
   return aPlaneFace;
 }
-
 //==================================================================================================
 std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByThreePoints()
 {
@@ -240,6 +258,8 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByLineAndPoint()
     GeomAPI_ShapeIterator anIt(aLineShape);
     anEdge = anIt.current()->edge();
   }
+  if (!anEdge)
+    return GeomShapePtr();
 
   // Get point.
   AttributeSelectionPtr aPointSelection = selection(POINT());
@@ -272,25 +292,26 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByLineAndPoint()
 }
 
 //==================================================================================================
-std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByDistanceFromOther()
+void ConstructionPlugin_Plane::createByDistanceFromOther(ListOfShape& theShapes)
 {
   AttributeSelectionPtr aFaceAttr = data()->selection(ConstructionPlugin_Plane::PLANE());
   AttributeDoublePtr aDistAttr = data()->real(ConstructionPlugin_Plane::DISTANCE());
-  std::shared_ptr<GeomAPI_Shape> aPlane;
+  AttributeIntegerPtr aNbCopyAttr = data()->integer(ConstructionPlugin_Plane::NB_COPIES());
   if ((aFaceAttr.get() != NULL) &&
-      (aDistAttr.get() != NULL) &&
+      (aDistAttr.get() != NULL) && (aNbCopyAttr.get() != NULL) &&
       aFaceAttr->isInitialized() && aDistAttr->isInitialized()) {
 
     double aDist = aDistAttr->value();
     bool anIsReverse = boolean(REVERSE())->value();
+    int aNumOfCopies = aNbCopyAttr->value();
     if(anIsReverse) aDist = -aDist;
     GeomShapePtr aShape = aFaceAttr->value();
-    if (!aShape.get()) {
+    if (!aShape.get() && aFaceAttr->context()) {
       aShape = aFaceAttr->context()->shape();
     }
 
     if(!aShape.get()) {
-      return aPlane;
+      return;
     }
 
     std::shared_ptr<GeomAPI_Face> aFace;
@@ -301,17 +322,23 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByDistanceFromOth
       GeomAPI_ShapeIterator anIt(aShape);
       aFace = anIt.current()->face();
     }
+    if (!aFace)
+      return;
 
     std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
     std::shared_ptr<GeomAPI_Pnt> aOrig = aPln->location();
     std::shared_ptr<GeomAPI_Dir> aDir = aPln->direction();
 
-    aOrig->translate(aDir, aDist);
-    std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aOrig, aDir));
+    for (int aNbCopy = 0; aNbCopy < aNumOfCopies; ++aNbCopy)
+    {
+      std::shared_ptr<GeomAPI_Shape> aPlane;
+      aOrig->translate(aDir, aDist);
+      std::shared_ptr<GeomAPI_Pln> aNewPln(new GeomAPI_Pln(aOrig, aDir));
 
-    aPlane = makeRectangularFace(aFace, aNewPln);
+      aPlane = makeRectangularFace(aFace, aNewPln);
+      theShapes.push_back(aPlane);
+    }
   }
-  return aPlane;
 }
 
 //==================================================================================================
@@ -338,7 +365,9 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByCoincidentPoint
   if(!aPointShape.get()) {
     aPointShape = aPointSelection->context()->shape();
   }
-  std::shared_ptr<GeomAPI_Vertex> aVertex(new GeomAPI_Vertex(aPointShape));
+  std::shared_ptr<GeomAPI_Vertex> aVertex = aPointShape->vertex();
+  if (!aVertex)
+    return GeomShapePtr();
 
   std::shared_ptr<GeomAPI_Pnt> anOrig = aVertex->point();
   std::shared_ptr<GeomAPI_Pln> aPln = aFace->getPlane();
@@ -350,7 +379,7 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByCoincidentPoint
 }
 
 //==================================================================================================
-std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
+void ConstructionPlugin_Plane::createByRotation(ListOfShape& theShapes)
 {
   // Get face.
   AttributeSelectionPtr aFaceSelection = selection(PLANE());
@@ -366,6 +395,8 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
     GeomAPI_ShapeIterator anIt(aFaceShape);
     aFace = anIt.current()->face();
   }
+  if (!aFace)
+    return;
   aFace = makeRectangularFace(aFace, aFace->getPlane());
 
   // Get axis.
@@ -382,6 +413,15 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
     GeomAPI_ShapeIterator anIt(anAxisShape);
     anEdge = anIt.current()->edge();
   }
+  if (!anEdge)
+    return;
+
+  AttributeIntegerPtr aNbCopyAttr = data()->integer(ConstructionPlugin_Plane::NB_COPIES());
+  int aNBCopy;
+  if (!aNbCopyAttr.get())
+    return;
+
+  aNBCopy = aNbCopyAttr->value();
 
   std::shared_ptr<GeomAPI_Ax1> anAxis =
     std::shared_ptr<GeomAPI_Ax1>(new GeomAPI_Ax1(anEdge->line()->location(),
@@ -390,19 +430,20 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByRotation()
   // Getting angle.
   double anAngle = real(ANGLE())->value();
 
-  GeomAlgoAPI_Rotation aRotationAlgo(aFace, anAxis, anAngle);
-  if (!aRotationAlgo.check()) {
-    setError(aRotationAlgo.getError());
-    return GeomShapePtr();
-  }
-  aRotationAlgo.build();
-  if (!aRotationAlgo.isDone()) {
-    setError("Error: Failed to rotate plane");
-    return GeomShapePtr();
-  }
+  for (int anIndex = 1; anIndex <= aNBCopy; ++anIndex)
+  {
+    std::shared_ptr<GeomAlgoAPI_Rotation> aRotationAlgo(
+      new GeomAlgoAPI_Rotation(aFace, anAxis, anAngle * anIndex));
+    // Checking that the algorithm worked properly.
+    std::string anError;
+    if (GeomAlgoAPI_Tools::AlgoError::isAlgorithmFailed(aRotationAlgo, getKind(), anError)) {
+      setError("Error: Failed to rotate plane");
+      return;
+    }
 
-  std::shared_ptr<GeomAPI_Face> aRes(new GeomAPI_Face(aRotationAlgo.shape()));
-  return aRes;
+    std::shared_ptr<GeomAPI_Face> aRes(new GeomAPI_Face(aRotationAlgo->shape()));
+    theShapes.push_back(aRes);
+  }
 }
 
 //==================================================================================================
@@ -422,6 +463,8 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByTwoParallelPlan
     GeomAPI_ShapeIterator anIt(aFaceShape1);
     aFace1 = anIt.current()->face();
   }
+  if (!aFace1)
+    return GeomShapePtr();
   std::shared_ptr<GeomAPI_Pln> aPln1 = aFace1->getPlane();
 
   // Get plane 2.
@@ -438,6 +481,8 @@ std::shared_ptr<GeomAPI_Shape> ConstructionPlugin_Plane::createByTwoParallelPlan
     GeomAPI_ShapeIterator anIt(aFaceShape2);
     aFace2 = anIt.current()->face();
   }
+  if (!aFace2)
+    return GeomShapePtr();
   std::shared_ptr<GeomAPI_Pln> aPln2 = aFace2->getPlane();
 
   std::shared_ptr<GeomAPI_Pnt> anOrig1 = aPln1->location();
@@ -482,7 +527,8 @@ std::shared_ptr<GeomAPI_Face> makeRectangularFace(const std::shared_ptr<GeomAPI_
 
   // use all 8 points of the bounding box to find the 2D bounds
   bool isFirst = true;
-  double aMinX2d, aMaxX2d, aMinY2d, aMaxY2d;
+  double aMinX2d = DBL_MAX, aMaxX2d = -DBL_MAX;
+  double aMinY2d = DBL_MAX, aMaxY2d = -DBL_MAX;
   for(int aXIsMin = 0; aXIsMin < 2; aXIsMin++) {
     for(int aYIsMin = 0; aYIsMin < 2; aYIsMin++) {
       for(int aZIsMin = 0; aZIsMin < 2; aZIsMin++) {