Salome HOME
Task 3.2. Concealment into multi-level Compounds
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_Translation.h
index 995b880a83af0b79aeb8d1bf3b921817c0c8cc29..10e20a36806f5782aafed941d0779f673687c4ab 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesAPI_Translation.h
-// Created:     07 June 2016
-// Author:      Dmitry Bobylev
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// 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_Translation_H_
 #define FeaturesAPI_Translation_H_
@@ -30,31 +43,70 @@ public:
 
   /// Constructor with values.
   FEATURESAPI_EXPORT
-  FeaturesAPI_Translation(const std::shared_ptr<ModelAPI_Feature>& theFeature,
-                          const std::list<ModelHighAPI_Selection>& theMainObjects,
-                          const ModelHighAPI_Selection& theAxisObject,
-                          const ModelHighAPI_Double& theDistance);
+  explicit FeaturesAPI_Translation(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                                   const std::list<ModelHighAPI_Selection>& theMainObjects,
+                                   const ModelHighAPI_Selection& theAxisObject,
+                                   const ModelHighAPI_Double& theDistance);
+
+  /// Constructor with values.
+  FEATURESAPI_EXPORT
+  explicit FeaturesAPI_Translation(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                                   const std::list<ModelHighAPI_Selection>& theMainObjects,
+                                   const ModelHighAPI_Double& theDx,
+                                   const ModelHighAPI_Double& theDy,
+                                   const ModelHighAPI_Double& theDz);
+
+  /// Constructor with values.
+  FEATURESAPI_EXPORT
+  explicit FeaturesAPI_Translation(const std::shared_ptr<ModelAPI_Feature>& theFeature,
+                                   const std::list<ModelHighAPI_Selection>& theMainObjects,
+                                   const ModelHighAPI_Selection& theStartPoint,
+                                   const ModelHighAPI_Selection& theEndPoint);
 
   /// Destructor.
   FEATURESAPI_EXPORT
   virtual ~FeaturesAPI_Translation();
 
-  INTERFACE_3(FeaturesPlugin_Translation::ID(),
-              mainObjects, FeaturesPlugin_Translation::OBJECTS_LIST_ID(), ModelAPI_AttributeSelectionList, /** Main objects */,
-              axisObject, FeaturesPlugin_Translation::AXIS_OBJECT_ID(), ModelAPI_AttributeSelection, /** Axis object */,
-              distance, FeaturesPlugin_Translation::DISTANCE_ID(), ModelAPI_AttributeDouble, /** Distance */)
+  INTERFACE_9(FeaturesPlugin_Translation::ID(),
+              creationMethod, FeaturesPlugin_Translation::CREATION_METHOD(),
+              ModelAPI_AttributeString, /** Creation method */,
+              mainObjects, FeaturesPlugin_Translation::OBJECTS_LIST_ID(),
+              ModelAPI_AttributeSelectionList, /** Main objects */,
+              axisObject, FeaturesPlugin_Translation::AXIS_OBJECT_ID(),
+              ModelAPI_AttributeSelection, /** Axis object */,
+              distance, FeaturesPlugin_Translation::DISTANCE_ID(),
+              ModelAPI_AttributeDouble, /** Distance */,
+              dx, FeaturesPlugin_Translation::DX_ID(),
+              ModelAPI_AttributeDouble, /** Dimension in X */,
+              dy, FeaturesPlugin_Translation::DY_ID(),
+              ModelAPI_AttributeDouble, /** Dimension in Y */,
+              dz, FeaturesPlugin_Translation::DZ_ID(),
+              ModelAPI_AttributeDouble, /** Dimension in Z */,
+              startPoint, FeaturesPlugin_Translation::START_POINT_ID(),
+              ModelAPI_AttributeSelection, /** Start point object */,
+              endPoint, FeaturesPlugin_Translation::END_POINT_ID(),
+              ModelAPI_AttributeSelection, /** End point object */
+             )
 
   /// Set main objects.
   FEATURESAPI_EXPORT
   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
 
-  /// Set axis object.
+  /// Modify CreationMethod, axis_object, distance attributes of the feature.
+  FEATURESAPI_EXPORT
+  void setAxisAndDistance(const ModelHighAPI_Selection& theAxisObject,
+                          const ModelHighAPI_Double& theDistance);
+
+  /// Modify CreationMethod, dx, dy, dz attributes of the feature.
   FEATURESAPI_EXPORT
-  void setAxisObject(const ModelHighAPI_Selection& theAxisObject);
+  void setDimensions(const ModelHighAPI_Double& theDx,
+                     const ModelHighAPI_Double& theDy,
+                     const ModelHighAPI_Double& theDz);
 
-  /// Set distance.
+  /// Modify CreationMethod, start_point, end_point attributes of the feature.
   FEATURESAPI_EXPORT
-  void setDistance(const ModelHighAPI_Double& theDistance);
+  void setPoints(const ModelHighAPI_Selection& theStartPoint,
+                 const ModelHighAPI_Selection& theEndPoint);
 
   /// Dump wrapped feature
   FEATURESAPI_EXPORT
@@ -72,4 +124,21 @@ TranslationPtr addTranslation(const std::shared_ptr<ModelAPI_Document>& thePart,
                               const ModelHighAPI_Selection& theAxisObject,
                               const ModelHighAPI_Double& theDistance);
 
+/// \ingroup CPPHighAPI
+/// \brief Create Translation feature.
+FEATURESAPI_EXPORT
+TranslationPtr addTranslation(const std::shared_ptr<ModelAPI_Document>& thePart,
+                              const std::list<ModelHighAPI_Selection>& theMainObjects,
+                              const ModelHighAPI_Double& theDx,
+                              const ModelHighAPI_Double& theDy,
+                              const ModelHighAPI_Double& theDz);
+
+/// \ingroup CPPHighAPI
+/// \brief Create Translation feature.
+FEATURESAPI_EXPORT
+TranslationPtr addTranslation(const std::shared_ptr<ModelAPI_Document>& thePart,
+                              const std::list<ModelHighAPI_Selection>& theMainObjects,
+                              const ModelHighAPI_Selection& theStartPoint,
+                              const ModelHighAPI_Selection& theEndPoint);
+
 #endif // FeaturesAPI_Translation_H_