Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_MultiTranslation.h
index a06c71f2ff1a6f47cef7432f3c80effc9ac29ded..ab1f1167a9682872ac3852d93608336484cb6397 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesAPI_MultiTranslation.h
-// Created:     09 Feb 2017
-// Author:      Clarisse Genrault (CEA)
+// 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
+//
 
 #ifndef FEATURESAPI_MULTITRANSLATION_H_
 #define FEATURESAPI_MULTITRANSLATION_H_
 
 #include <FeaturesPlugin_MultiTranslation.h>
 
+#include <ModelHighAPI_Double.h>
+#include <ModelHighAPI_Integer.h>
 #include <ModelHighAPI_Interface.h>
 #include <ModelHighAPI_Macro.h>
+#include <ModelHighAPI_Selection.h>
 
-class ModelHighAPI_Double;
 class ModelHighAPI_Dumper;
-class ModelHighAPI_Integer;
-class ModelHighAPI_Selection;
 
 /// \class FeaturesAPI_MultiTranslation
 /// \ingroup CPPHighAPI
@@ -84,7 +97,7 @@ public:
   FEATURESAPI_EXPORT
   void setSecondAxisAndDistance(const ModelHighAPI_Selection& theAxisObject,
                                 const ModelHighAPI_Double& theDistance);
-  
+
   /// Modify CreationMethod, nb_first_dir attribute of the feature.
   FEATURESAPI_EXPORT
   void setFirstNumber(const ModelHighAPI_Integer& theFirstNumber);
@@ -98,28 +111,20 @@ public:
   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 };
 
-/// Pointer on Translation object.
+/// Pointer on MultiTranslation object.
 typedef std::shared_ptr<FeaturesAPI_MultiTranslation> MultiTranslationPtr;
 
 /// \ingroup CPPHighAPI
 /// \brief Create MultiTranslation feature.
-FEATURESAPI_EXPORT
-MultiTranslationPtr addMultiTranslation(const std::shared_ptr<ModelAPI_Document>& thePart,
-                                        const std::list<ModelHighAPI_Selection>& theMainObjects,
-                                        const ModelHighAPI_Selection& theAxisObject,
-                                        const ModelHighAPI_Double& theStep,
-                                        const ModelHighAPI_Integer& theNumber);
-
-/// \ingroup CPPHighAPI
-/// \brief Create MultiTranslation feature.
-FEATURESAPI_EXPORT
-MultiTranslationPtr addMultiTranslation(const std::shared_ptr<ModelAPI_Document>& thePart,
-                                        const std::list<ModelHighAPI_Selection>& theMainObjects,
-                                        const ModelHighAPI_Selection& theFirstAxisObject,
-                                        const ModelHighAPI_Double& theFirstStep,
-                                        const ModelHighAPI_Integer& theFirstNumber,
-                                        const ModelHighAPI_Selection& theSecondAxisObject,
-                                        const ModelHighAPI_Double& theSecondStep,
-                                        const ModelHighAPI_Integer& theSecondNumber);
+FEATURESAPI_EXPORT MultiTranslationPtr addMultiTranslation(
+    const std::shared_ptr<ModelAPI_Document>& thePart,
+    const std::list<ModelHighAPI_Selection>& theMainObjects,
+    const ModelHighAPI_Selection& theFirstAxisObject,
+    const ModelHighAPI_Double& theFirstStep,
+    const ModelHighAPI_Integer& theFirstNumber,
+    const ModelHighAPI_Selection& theSecondAxisObject = ModelHighAPI_Selection(),
+    const ModelHighAPI_Double& theSecondStep = ModelHighAPI_Double(),
+    const ModelHighAPI_Integer& theSecondNumber = ModelHighAPI_Integer(),
+    const bool keepSubResults = false);
 
 #endif // FEATURESAPI_MULTITRANSLATION_H_