updated copyright message

[modules/shaper.git] / src / PrimitivesPlugin / PrimitivesPlugin_Box.h

diff --git a/src/PrimitivesPlugin/PrimitivesPlugin_Box.h b/src/PrimitivesPlugin/PrimitivesPlugin_Box.h
index fa9eeb43c7f8144b24ae6de490aeb2969655ef81..1ca4620e9e1c902aa523fad3bfab26b86c546cc4 100644 (file)
--- a/src/PrimitivesPlugin/PrimitivesPlugin_Box.h
+++ b/src/PrimitivesPlugin/PrimitivesPlugin_Box.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// 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
@@ -12,10 +12,9 @@
 //
 // 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
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef PrimitivesPlugin_Box_H_
@@ -32,8 +31,9 @@ class ModelAPI_ResultBody;
  * \ingroup Plugins
  * \brief Feature for creation of a box primitive using various methods.
  *
- * Box creates a cuboid - Parallelepiped with 6 rectangular faces. It can be built via two
- * methods : using two points that define a diagonal, or using 3 lengths that define the 
+ * Box creates a cuboid - Parallelepiped with 6 rectangular faces. It can be built via three
+ * methods : using two points that define a diagonal, a point that define a center and 3 lengths
+ * that define the half-lengths on X, Y and Z-axes, or using 3 lengths that define the 
  * rectangular dimensions.
  */
 class PrimitivesPlugin_Box : public ModelAPI_Feature
@@ -67,6 +67,13 @@ class PrimitivesPlugin_Box : public ModelAPI_Feature
     return MY_CREATION_METHOD_ID;
   }
 
+  /// Attribute name for creation method
+  inline static const std::string& CREATION_METHOD_BY_ONE_POINT_AND_DIMS()
+  {
+    static const std::string MY_CREATION_METHOD_ID("BoxByOnePointAndDims");
+    return MY_CREATION_METHOD_ID;
+  }
+
   /// Attribute name of first point
   inline static const std::string& POINT_FIRST_ID()
   {
@@ -102,6 +109,48 @@ class PrimitivesPlugin_Box : public ModelAPI_Feature
     return MY_DZ_ID;
   }
 
+  /// Attribute name of the first coordinate of the center
+  inline static const std::string& OX_ID()
+  {
+    static const std::string MY_OX_ID("ox");
+    return MY_OX_ID;
+  }
+
+  /// Attribute name of the second coordinate of the center
+  inline static const std::string& OY_ID()
+  {
+    static const std::string MY_OY_ID("oy");
+    return MY_OY_ID;
+  }
+
+  /// Attribute name of the third coordinate of the center
+  inline static const std::string& OZ_ID()
+  {
+    static const std::string MY_OZ_ID("oz");
+    return MY_OZ_ID;
+  }
+
+  /// Attribute name of the half-length on X axis
+  inline static const std::string& HALF_DX_ID()
+  {
+    static const std::string MY_HALF_DX_ID("half_dx");
+    return MY_HALF_DX_ID;
+  }
+
+  /// Attribute name of the half-length on Y axis
+  inline static const std::string& HALF_DY_ID()
+  {
+    static const std::string MY_HALF_DY_ID("half_dy");
+    return MY_HALF_DY_ID;
+  }
+
+  /// Attribute name of the half-length on Z axis
+  inline static const std::string& HALF_DZ_ID()
+  {
+    static const std::string MY_HALF_DZ_ID("half_dz");
+    return MY_HALF_DZ_ID;
+  }
+
   /// Returns the kind of a feature
   PRIMITIVESPLUGIN_EXPORT virtual const std::string& getKind()
   {
@@ -129,6 +178,9 @@ class PrimitivesPlugin_Box : public ModelAPI_Feature
   ///Perform the creation of the box using three cordinates
   void createBoxByDimensions();
 
+  ///Perform the creation of the box using a center and three half-lenths
+  void createBoxByOnePointAndDims();
+
 };