Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_Revolution.cpp
index fc982e9c1e00431c407fab17dc869489ae7f62b8..2b560b8ba89014b3f9d13243b3edf229453f59c2 100644 (file)
@@ -1,12 +1,27 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesAPI_Revolution.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_Revolution.h"
 
 #include <ModelHighAPI_Double.h>
+#include <ModelHighAPI_Dumper.h>
+#include <ModelHighAPI_Reference.h>
 #include <ModelHighAPI_Tools.h>
 
 //==================================================================================================
@@ -17,10 +32,11 @@ FeaturesAPI_Revolution::FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Fe
 }
 
 //==================================================================================================
-FeaturesAPI_Revolution::FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                               const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                               const ModelHighAPI_Selection& theAxis,
-                                               const ModelHighAPI_Double& theAngle)
+FeaturesAPI_Revolution::FeaturesAPI_Revolution(
+  const std::shared_ptr<ModelAPI_Feature>& theFeature,
+  const std::list<ModelHighAPI_Selection>& theBaseObjects,
+  const ModelHighAPI_Selection& theAxis,
+  const ModelHighAPI_Double& theAngle)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
@@ -31,14 +47,18 @@ FeaturesAPI_Revolution::FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Fe
 }
 
 //==================================================================================================
-FeaturesAPI_Revolution::FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                               const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                               const ModelHighAPI_Selection& theAxis,
-                                               const ModelHighAPI_Double& theToAngle,
-                                               const ModelHighAPI_Double& theFromAngle)
+FeaturesAPI_Revolution::FeaturesAPI_Revolution(
+  const std::shared_ptr<ModelAPI_Feature>& theFeature,
+  const std::list<ModelHighAPI_Selection>& theBaseObjects,
+  const ModelHighAPI_Selection& theAxis,
+  const ModelHighAPI_Double& theToAngle,
+  const ModelHighAPI_Double& theFromAngle,
+  const std::string& theSelectionType)
 : ModelHighAPI_Interface(theFeature)
 {
   if(initialize()) {
+    if (!theSelectionType.empty())
+      mybaseObjects->setSelectionType(theSelectionType);
     fillAttribute(theBaseObjects, mybaseObjects);
     fillAttribute(theAxis, myaxis);
     setAngles(theToAngle, theFromAngle);
@@ -46,16 +66,20 @@ FeaturesAPI_Revolution::FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Fe
 }
 
 //==================================================================================================
-FeaturesAPI_Revolution::FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                                               const std::list<ModelHighAPI_Selection>& theBaseObjects,
-                                               const ModelHighAPI_Selection& theAxis,
-                                               const ModelHighAPI_Selection& theToObject,
-                                               const ModelHighAPI_Double& theToOffset,
-                                               const ModelHighAPI_Selection& theFromObject,
-                                               const ModelHighAPI_Double& theFromOffset)
+FeaturesAPI_Revolution::FeaturesAPI_Revolution(
+  const std::shared_ptr<ModelAPI_Feature>& theFeature,
+  const std::list<ModelHighAPI_Selection>& theBaseObjects,
+  const ModelHighAPI_Selection& theAxis,
+  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(theAxis, myaxis);
     setPlanesAndOffsets(theToObject, theToOffset, theFromObject, theFromOffset);
@@ -68,12 +92,34 @@ FeaturesAPI_Revolution::~FeaturesAPI_Revolution()
 
 }
 
+//==================================================================================================
+void FeaturesAPI_Revolution::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_Revolution::setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects)
 {
+  mysketch->setValue(ObjectPtr());
+  mybaseObjects->clear();
   fillAttribute(theBaseObjects, mybaseObjects);
 
-  execute();
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
@@ -81,7 +127,7 @@ void FeaturesAPI_Revolution::setAxis(const ModelHighAPI_Selection& theAxis)
 {
   fillAttribute(theAxis, myaxis);
 
-  execute();
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
@@ -92,17 +138,13 @@ void FeaturesAPI_Revolution::setAngles(const ModelHighAPI_Double& theToAngle,
   fillAttribute(theToAngle, mytoAngle);
   fillAttribute(theFromAngle, myfromAngle);
 
-  execute();
+  execIfBaseNotEmpty();
 }
 
 //==================================================================================================
 void FeaturesAPI_Revolution::setAngle(const ModelHighAPI_Double& theAngle)
 {
-  fillAttribute(FeaturesPlugin_Revolution::CREATION_METHOD_BY_ANGLES(), mycreationMethod);
-  fillAttribute(theAngle, mytoAngle);
-  fillAttribute(ModelHighAPI_Double(), myfromAngle);
-
-  execute();
+  setAngles(theAngle, ModelHighAPI_Double());
 }
 
 //==================================================================================================
@@ -117,7 +159,69 @@ void FeaturesAPI_Revolution::setPlanesAndOffsets(const ModelHighAPI_Selection& t
   fillAttribute(theFromObject, myfromObject);
   fillAttribute(theFromOffset, myfromOffset);
 
-  execute();
+  execIfBaseNotEmpty();
+}
+
+//==================================================================================================
+void FeaturesAPI_Revolution::dump(ModelHighAPI_Dumper& theDumper) const
+{
+  FeaturePtr aBase = feature();
+  const std::string& aDocName = theDumper.name(aBase->document());
+
+  AttributeReferencePtr anAttrSketch = aBase->reference(FeaturesPlugin_Revolution::SKETCH_ID());
+  AttributeSelectionListPtr anAttrObjects =
+    aBase->selectionList(FeaturesPlugin_Revolution::BASE_OBJECTS_ID());
+  AttributeSelectionPtr anAttrAxis = aBase->selection(FeaturesPlugin_Revolution::AXIS_OBJECT_ID());
+
+  theDumper << aBase << " = model.addRevolution(" << aDocName << ", ";
+  anAttrSketch->isInitialized() ? theDumper << "[]" : theDumper << anAttrObjects;
+  theDumper << ", " << anAttrAxis;
+
+  std::string aCreationMethod =
+    aBase->string(FeaturesPlugin_Revolution::CREATION_METHOD())->value();
+
+  if(aCreationMethod == FeaturesPlugin_Revolution::CREATION_METHOD_BY_ANGLES()) {
+    AttributeDoublePtr anAttrToAngle = aBase->real(FeaturesPlugin_Revolution::TO_ANGLE_ID());
+    AttributeDoublePtr anAttrFromAngle = aBase->real(FeaturesPlugin_Revolution::FROM_ANGLE_ID());
+
+    theDumper << ", " << anAttrToAngle << ", " << anAttrFromAngle;
+  } else if(aCreationMethod == FeaturesPlugin_Revolution::CREATION_METHOD_BY_PLANES()) {
+    AttributeSelectionPtr anAttrToObject =
+      aBase->selection(FeaturesPlugin_Revolution::TO_OBJECT_ID());
+    AttributeDoublePtr anAttrToOffset = aBase->real(FeaturesPlugin_Revolution::TO_OFFSET_ID());
+    AttributeSelectionPtr anAttrFromObject =
+      aBase->selection(FeaturesPlugin_Revolution::FROM_OBJECT_ID());
+    AttributeDoublePtr anAttrFromOffset = aBase->real(FeaturesPlugin_Revolution::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_Revolution::execIfBaseNotEmpty()
+{
+  if(mybaseObjects->size() > 0) {
+    execute();
+  }
 }
 
 //==================================================================================================
@@ -135,14 +239,16 @@ RevolutionPtr addRevolution(const std::shared_ptr<ModelAPI_Document>& thePart,
                             const std::list<ModelHighAPI_Selection>& theBaseObjects,
                             const ModelHighAPI_Selection& theAxis,
                             const ModelHighAPI_Double& theToAngle,
-                            const ModelHighAPI_Double& theFromAngle)
+                            const ModelHighAPI_Double& theFromAngle,
+                            const std::string& theSelectionType)
 {
   std::shared_ptr<ModelAPI_Feature> aFeature = thePart->addFeature(FeaturesAPI_Revolution::ID());
   return RevolutionPtr(new FeaturesAPI_Revolution(aFeature,
                                                 theBaseObjects,
                                                 theAxis,
                                                 theToAngle,
-                                                theFromAngle));
+                                                theFromAngle,
+                                                theSelectionType));
 }
 
 //==================================================================================================
@@ -152,7 +258,8 @@ RevolutionPtr addRevolution(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_Revolution::ID());
   return RevolutionPtr(new FeaturesAPI_Revolution(aFeature,
@@ -161,5 +268,6 @@ RevolutionPtr addRevolution(const std::shared_ptr<ModelAPI_Document>& thePart,
                                                 theToObject,
                                                 theToOffset,
                                                 theFromObject,
-                                                theFromOffset));
+                                                theFromOffset,
+                                                theSelectionType));
 }