Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_Extrusion.cpp
index d79749b5f28389b1114568008bcb158d71327588..6d49af50ffc8baacf7b6abfe1e141889c2a9296f 100644 (file)
@@ -1,12 +1,27 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesAPI_Extrusion.cpp
-// Created:     09 June 2016
-// Author:      Dmitry Bobylev
+// 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
+// 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 "FeaturesAPI_Extrusion.h"
 
 #include <ModelHighAPI_Double.h>
+#include <ModelHighAPI_Dumper.h>
+#include <ModelHighAPI_Reference.h>
 #include <ModelHighAPI_Tools.h>
 
 //==================================================================================================
@@ -18,8 +33,8 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 
 //==================================================================================================
 FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                             const ModelHighAPI_Double& theSize)
+                                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
+                                          const ModelHighAPI_Double& theSize)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
@@ -30,9 +45,9 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 
 //==================================================================================================
 FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                             const ModelHighAPI_Selection& theDirection,
-                                             const ModelHighAPI_Double& theSize)
+                                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
+                                          const ModelHighAPI_Selection& theDirection,
+                                          const ModelHighAPI_Double& theSize)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
@@ -44,9 +59,9 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 
 //==================================================================================================
 FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                             const ModelHighAPI_Double& theToSize,
-                                             const ModelHighAPI_Double& theFromSize)
+                                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
+                                          const ModelHighAPI_Double& theToSize,
+                                          const ModelHighAPI_Double& theFromSize)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
@@ -57,13 +72,16 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 
 //==================================================================================================
 FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                             const ModelHighAPI_Selection& theDirection,
-                                             const ModelHighAPI_Double& theToSize,
-                                             const ModelHighAPI_Double& theFromSize)
+                                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
+                                          const ModelHighAPI_Selection& theDirection,
+                                          const ModelHighAPI_Double& theToSize,
+                                          const ModelHighAPI_Double& theFromSize,
+                                          const std::string& theSelectionType)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
+    if (!theSelectionType.empty())
+      mybaseObjects->setSelectionType(theSelectionType);
     fillAttribute(theBaseObjects, mybaseObjects);
     fillAttribute(theDirection, mydirection);
     setSizes(theToSize, theFromSize);
@@ -72,11 +90,11 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 
 //==================================================================================================
 FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                             const ModelHighAPI_Selection& theToObject,
-                                             const ModelHighAPI_Double& theToOffset,
-                                             const ModelHighAPI_Selection& theFromObject,
-                                             const ModelHighAPI_Double& theFromOffset)
+                                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
+                                          const ModelHighAPI_Selection& theToObject,
+                                          const ModelHighAPI_Double& theToOffset,
+                                          const ModelHighAPI_Selection& theFromObject,
+                                          const ModelHighAPI_Double& theFromOffset)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
@@ -87,15 +105,18 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 
 //==================================================================================================
 FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                             const ModelHighAPI_Selection& theDirection,
-                                             const ModelHighAPI_Selection& theToObject,
-                                             const ModelHighAPI_Double& theToOffset,
-                                             const ModelHighAPI_Selection& theFromObject,
-                                             const ModelHighAPI_Double& theFromOffset)
+                                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
+                                          const ModelHighAPI_Selection& theDirection,
+                                          const ModelHighAPI_Selection& theToObject,
+                                          const ModelHighAPI_Double& theToOffset,
+                                          const ModelHighAPI_Selection& theFromObject,
+                                          const ModelHighAPI_Double& theFromOffset,
+                                          const std::string& theSelectionType)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
+    if (!theSelectionType.empty())
+      mybaseObjects->setSelectionType(theSelectionType);
     fillAttribute(theBaseObjects, mybaseObjects);
     fillAttribute(theDirection, mydirection);
     setPlanesAndOffsets(theToObject, theToOffset, theFromObject, theFromOffset);
@@ -105,15 +126,36 @@ FeaturesAPI_Extrusion::FeaturesAPI_Extrusion(const std::shared_ptr<ModelAPI_Feat
 //==================================================================================================
 FeaturesAPI_Extrusion::~FeaturesAPI_Extrusion()
 {
+}
+
+//==================================================================================================
+void FeaturesAPI_Extrusion::setNestedSketch(const ModelHighAPI_Reference& theSketch)
+{
+  mysketch->setValue(theSketch.feature());
 
+  // To make Sketch feature execute and subfeatures execute.
+  feature()->document()->setCurrentFeature(feature(), false);
+
+  // to inform that the history is updated due to the sketch moved under the composite feature
+  if (theSketch.feature().get()) {
+    theSketch.feature()->document()->updateHistory(ModelAPI_Feature::group());
+    if (theSketch.feature()->firstResult().get())
+      theSketch.feature()->firstResult()->setDisplayed(false);
+  }
+  mybaseObjects->clear();
+  mybaseObjects->append(theSketch.feature()->firstResult(), GeomShapePtr());
+
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
 void FeaturesAPI_Extrusion::setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects)
 {
+  mysketch->setValue(ObjectPtr());
+  mybaseObjects->clear();
   fillAttribute(theBaseObjects, mybaseObjects);
 
-  execute();
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
@@ -121,7 +163,7 @@ void FeaturesAPI_Extrusion::setDirection(const ModelHighAPI_Selection& theDirect
 {
   fillAttribute(theDirection, mydirection);
 
-  execute();
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
@@ -132,17 +174,13 @@ void FeaturesAPI_Extrusion::setSizes(const ModelHighAPI_Double& theToSize,
   fillAttribute(theToSize, mytoSize);
   fillAttribute(theFromSize, myfromSize);
 
-  execute();
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
 void FeaturesAPI_Extrusion::setSize(const ModelHighAPI_Double& theSize)
 {
-  fillAttribute(FeaturesPlugin_Extrusion::CREATION_METHOD_BY_SIZES(), mycreationMethod);
-  fillAttribute(theSize, mytoSize);
-  fillAttribute(ModelHighAPI_Double(), myfromSize);
-
-  execute();
+  setSizes(theSize, ModelHighAPI_Double());
 }
 
 //==================================================================================================
@@ -157,7 +195,70 @@ void FeaturesAPI_Extrusion::setPlanesAndOffsets(const ModelHighAPI_Selection& th
   fillAttribute(theFromObject, myfromObject);
   fillAttribute(theFromOffset, myfromOffset);
 
-  execute();
+  execIfBaseNotEmpty();
+}
+
+//==================================================================================================
+void FeaturesAPI_Extrusion::dump(ModelHighAPI_Dumper& theDumper) const
+{
+  FeaturePtr aBase = feature();
+  const std::string& aDocName = theDumper.name(aBase->document());
+
+  AttributeReferencePtr anAttrSketch = aBase->reference(FeaturesPlugin_Extrusion::SKETCH_ID());
+  AttributeSelectionListPtr anAttrObjects =
+    aBase->selectionList(FeaturesPlugin_Extrusion::BASE_OBJECTS_ID());
+  AttributeSelectionPtr anAttrDirection =
+    aBase->selection(FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID());
+
+  theDumper << aBase << " = model.addExtrusion(" << aDocName << ", ";
+  anAttrSketch->isInitialized() ? theDumper << "[]" : theDumper << anAttrObjects;
+  theDumper << ", " << anAttrDirection;
+
+  std::string aCreationMethod =
+    aBase->string(FeaturesPlugin_Extrusion::CREATION_METHOD())->value();
+
+  if(aCreationMethod == FeaturesPlugin_Extrusion::CREATION_METHOD_BY_SIZES()) {
+    AttributeDoublePtr anAttrToSize = aBase->real(FeaturesPlugin_Extrusion::TO_SIZE_ID());
+    AttributeDoublePtr anAttrFromSize = aBase->real(FeaturesPlugin_Extrusion::FROM_SIZE_ID());
+
+    theDumper << ", " << anAttrToSize << ", " << anAttrFromSize;
+  } else if(aCreationMethod == FeaturesPlugin_Extrusion::CREATION_METHOD_BY_PLANES()) {
+    AttributeSelectionPtr anAttrToObject =
+      aBase->selection(FeaturesPlugin_Extrusion::TO_OBJECT_ID());
+    AttributeDoublePtr anAttrToOffset = aBase->real(FeaturesPlugin_Extrusion::TO_OFFSET_ID());
+    AttributeSelectionPtr anAttrFromObject =
+      aBase->selection(FeaturesPlugin_Extrusion::FROM_OBJECT_ID());
+    AttributeDoublePtr anAttrFromOffset = aBase->real(FeaturesPlugin_Extrusion::FROM_OFFSET_ID());
+
+    theDumper << ", " << anAttrToObject << ", " << anAttrToOffset <<
+      ", " << anAttrFromObject << ", " << anAttrFromOffset;
+  }
+
+  // write explicitly the type of selection if it does not correspond
+  // to the type of first selected shape
+  if (!anAttrSketch->isInitialized()) {
+    std::string aListSelType = anAttrObjects->selectionType();
+    AttributeSelectionPtr aFirstSelection = anAttrObjects->value(0);
+    GeomShapePtr aFirstShape = aFirstSelection->value();
+    if (!aFirstShape)
+      aFirstShape = aFirstSelection->context()->shape();
+    if (!aFirstShape || aFirstShape->shapeType() != GeomAPI_Shape::shapeTypeByStr(aListSelType))
+      theDumper << ", \"" << aListSelType << "\"";
+  }
+
+  theDumper << ")" << std::endl;
+
+  if(anAttrSketch->isInitialized()) {
+    theDumper << aBase << ".setNestedSketch(" << anAttrSketch << ")" << std::endl;
+  }
+}
+
+//==================================================================================================
+void FeaturesAPI_Extrusion::execIfBaseNotEmpty()
+{
+  if(mybaseObjects->size() > 0) {
+    execute();
+  }
 }
 
 //==================================================================================================
@@ -194,14 +295,16 @@ ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
                           const ModelHighAPI_Selection& theDirection,
                           const ModelHighAPI_Double& theToSize,
-                          const ModelHighAPI_Double& theFromSize)
+                          const ModelHighAPI_Double& theFromSize,
+                          const std::string& theSelectionType)
 {
   std::shared_ptr<ModelAPI_Feature> aFeature = thePart->addFeature(FeaturesAPI_Extrusion::ID());
   return ExtrusionPtr(new FeaturesAPI_Extrusion(aFeature,
                                                 theBaseObjects,
                                                 theDirection,
                                                 theToSize,
-                                                theFromSize));
+                                                theFromSize,
+                                                theSelectionType));
 }
 
 //==================================================================================================
@@ -228,7 +331,8 @@ ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
                           const ModelHighAPI_Selection& theToObject,
                           const ModelHighAPI_Double& theToOffset,
                           const ModelHighAPI_Selection& theFromObject,
-                          const ModelHighAPI_Double& theFromOffset)
+                          const ModelHighAPI_Double& theFromOffset,
+                          const std::string& theSelectionType)
 {
   std::shared_ptr<ModelAPI_Feature> aFeature = thePart->addFeature(FeaturesAPI_Extrusion::ID());
   return ExtrusionPtr(new FeaturesAPI_Extrusion(aFeature,
@@ -237,5 +341,6 @@ ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,
                                                 theToObject,
                                                 theToOffset,
                                                 theFromObject,
-                                                theFromOffset));
+                                                theFromOffset,
+                                                theSelectionType));
 }