Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_Scale.h
index 137763c62e642ee5972d9aebb82e51e17f399779..2662c7bc50e18baad722aa255bc9c8aa906666a4 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-201x CEA/DEN, EDF R&D -->
-
-// File:        FeaturesAPI_Scale.h
-// Created:     24 Jan 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_SCALE_H_
 #define FEATURESAPI_SCALE_H_
 
 #include <FeaturesPlugin_Scale.h>
 
+#include <ModelHighAPI_Double.h>
 #include <ModelHighAPI_Interface.h>
 #include <ModelHighAPI_Macro.h>
 
-class ModelHighAPI_Double;
 class ModelHighAPI_Dumper;
 class ModelHighAPI_Selection;
 
@@ -35,17 +48,34 @@ public:
                              const ModelHighAPI_Selection& theCenterPoint,
                              const ModelHighAPI_Double& theScaleFactor);
 
+  /// Constructor with values.
+  FEATURESAPI_EXPORT
+  explicit FeaturesAPI_Scale(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                             const std::list<ModelHighAPI_Selection>& theMainObjects,
+                             const ModelHighAPI_Selection& theCenterPoint,
+                             const ModelHighAPI_Double& theScaleFactorX,
+                             const ModelHighAPI_Double& theScaleFactorY,
+                             const ModelHighAPI_Double& theScaleFactorZ);
+
   /// Destructor.
   FEATURESAPI_EXPORT
   virtual ~FeaturesAPI_Scale();
 
-  INTERFACE_3(FeaturesPlugin_Scale::ID(),
+  INTERFACE_7(FeaturesPlugin_Scale::ID(),
+              creationMethod, FeaturesPlugin_Scale::CREATION_METHOD(),
+              ModelAPI_AttributeString, /** Creation method */,
               mainObjects, FeaturesPlugin_Scale::OBJECTS_LIST_ID(),
               ModelAPI_AttributeSelectionList, /** Main objects */,
               centerPoint, FeaturesPlugin_Scale::CENTER_POINT_ID(),
               ModelAPI_AttributeSelection, /** Center point */,
               scaleFactor, FeaturesPlugin_Scale::SCALE_FACTOR_ID(),
-              ModelAPI_AttributeDouble, /** Scale factor */)
+              ModelAPI_AttributeDouble, /** Scale factor */,
+              scaleFactorX, FeaturesPlugin_Scale::SCALE_FACTOR_X_ID(),
+              ModelAPI_AttributeDouble, /** Scale factor in X */,
+              scaleFactorY, FeaturesPlugin_Scale::SCALE_FACTOR_Y_ID(),
+              ModelAPI_AttributeDouble, /** Scale factor in Y */,
+              scaleFactorZ, FeaturesPlugin_Scale::SCALE_FACTOR_Z_ID(),
+              ModelAPI_AttributeDouble, /** Scale factor in Z */)
 
   /// Set main objects.
   FEATURESAPI_EXPORT
@@ -59,6 +89,13 @@ public:
   FEATURESAPI_EXPORT
   void setScaleFactor(const ModelHighAPI_Double& theScaleFactor);
 
+  /// Modify Creation Method and scale_factor_x, scale_factor_y and scale_factor_z
+  /// attributes of the feature.
+  FEATURESAPI_EXPORT
+  void setDimensions(const ModelHighAPI_Double& theScaleFactorX,
+                     const ModelHighAPI_Double& theScaleFactorY,
+                     const ModelHighAPI_Double& theScaleFactorZ);
+
   /// Dump wrapped feature
   FEATURESAPI_EXPORT
   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
@@ -73,6 +110,9 @@ FEATURESAPI_EXPORT
 ScalePtr addScale(const std::shared_ptr<ModelAPI_Document>& thePart,
                   const std::list<ModelHighAPI_Selection>& theMainObjects,
                   const ModelHighAPI_Selection& theCenterPoint,
-                  const ModelHighAPI_Double& theScaleFactor);
+                  const ModelHighAPI_Double& theScaleFactorX,
+                  const ModelHighAPI_Double& theScaleFactorY = ModelHighAPI_Double(0.0),
+                  const ModelHighAPI_Double& theScaleFactorZ = ModelHighAPI_Double(0.0),
+                  const bool keepSubResults = false);
 
 #endif // FEATURESAPI_SCALE_H_
\ No newline at end of file