Salome HOME
Copyright update 2022
[modules/shaper.git] / src / FeaturesAPI / FeaturesAPI_Extrusion.h
index 9350d981737791046d7e3943c3b9108a8afe538d..a16f25b6a4971d7c71e548cccfcd9b694f612612 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesAPI_Extrusion.h
-// Created:     09 June 2016
-// Author:      Dmitry Bobylev
+// Copyright (C) 2014-2022  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_Extrusion_H_
 #define FeaturesAPI_Extrusion_H_
@@ -53,7 +66,8 @@ public:
                                  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::string());
 
   /// Constructor with values.
   FEATURESAPI_EXPORT
@@ -72,23 +86,34 @@ public:
                                  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::string());
 
   /// Destructor.
   FEATURESAPI_EXPORT
   virtual ~FeaturesAPI_Extrusion();
 
   INTERFACE_10(FeaturesPlugin_Extrusion::ID(),
-               sketch, FeaturesPlugin_Extrusion::SKETCH_ID(), ModelAPI_AttributeReference, /** Sketch launcher */,
-               baseObjects, FeaturesPlugin_Extrusion::BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList, /** Base objects */,
-               direction, FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID(), ModelAPI_AttributeSelection, /** Direction */,
-               creationMethod, FeaturesPlugin_Extrusion::CREATION_METHOD(), ModelAPI_AttributeString, /** Creation method */,
-               toSize, FeaturesPlugin_Extrusion::TO_SIZE_ID(), ModelAPI_AttributeDouble, /** To size */,
-               fromSize, FeaturesPlugin_Extrusion::FROM_SIZE_ID(), ModelAPI_AttributeDouble, /** From size */,
-               toObject, FeaturesPlugin_Extrusion::TO_OBJECT_ID(), ModelAPI_AttributeSelection, /** To object */,
-               toOffset, FeaturesPlugin_Extrusion::TO_OFFSET_ID(), ModelAPI_AttributeDouble, /** To offset */,
-               fromObject, FeaturesPlugin_Extrusion::FROM_OBJECT_ID(), ModelAPI_AttributeSelection, /** From object */,
-               fromOffset, FeaturesPlugin_Extrusion::FROM_OFFSET_ID(), ModelAPI_AttributeDouble, /** From offset */)
+               sketch, FeaturesPlugin_Extrusion::SKETCH_ID(),
+               ModelAPI_AttributeReference, /** Sketch launcher */,
+               baseObjects, FeaturesPlugin_Extrusion::BASE_OBJECTS_ID(),
+               ModelAPI_AttributeSelectionList, /** Base objects */,
+               direction, FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID(),
+               ModelAPI_AttributeSelection, /** Direction */,
+               creationMethod, FeaturesPlugin_Extrusion::CREATION_METHOD(),
+               ModelAPI_AttributeString, /** Creation method */,
+               toSize, FeaturesPlugin_Extrusion::TO_SIZE_ID(),
+               ModelAPI_AttributeDouble, /** To size */,
+               fromSize, FeaturesPlugin_Extrusion::FROM_SIZE_ID(),
+               ModelAPI_AttributeDouble, /** From size */,
+               toObject, FeaturesPlugin_Extrusion::TO_OBJECT_ID(),
+               ModelAPI_AttributeSelection, /** To object */,
+               toOffset, FeaturesPlugin_Extrusion::TO_OFFSET_ID(),
+               ModelAPI_AttributeDouble, /** To offset */,
+               fromObject, FeaturesPlugin_Extrusion::FROM_OBJECT_ID(),
+               ModelAPI_AttributeSelection, /** From object */,
+               fromOffset, FeaturesPlugin_Extrusion::FROM_OFFSET_ID(),
+               ModelAPI_AttributeDouble, /** From offset */)
 
   /// Modify base attribute of the feature.
   FEATURESAPI_EXPORT
@@ -104,13 +129,15 @@ public:
 
   /// Modify CreationMethod, to_size, from_size attributes of the feature.
   FEATURESAPI_EXPORT
-  void setSizes(const ModelHighAPI_Double& theToSize, const ModelHighAPI_Double& theFromSize);
+  void setSizes(const ModelHighAPI_Double& theToSize,
+                const ModelHighAPI_Double& theFromSize);
 
   /// Modify creation_method, to_size, from_size attributes of the feature.
   FEATURESAPI_EXPORT
   void setSize(const ModelHighAPI_Double& theSize);
 
-  /// Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature.
+  /// Modify creation_method, to_object, to_offset,
+  /// from_object, from_offset attributes of the feature.
   FEATURESAPI_EXPORT
   void setPlanesAndOffsets(const ModelHighAPI_Selection& theToObject,
                            const ModelHighAPI_Double& theToOffset,
@@ -158,7 +185,8 @@ 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::string());
 
 /// \ingroup CPPHighAPI
 /// \brief Create Extrusion feature.
@@ -179,6 +207,7 @@ 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::string());
 
 #endif // FeaturesAPI_Extrusion_H_