Salome HOME
Issue #2622: Weak naming
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Box.h
index 23bcb8d350c40b66532c8cea836d9c20a069129e..5d61686b2b4113d7f32d06cc09d18d3a423b7d50 100644 (file)
@@ -1,11 +1,25 @@
-// Copyright (C) 2014-2016 CEA/DEN, EDF R&D
+// Copyright (C) 2014-2017  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<mailto:webmaster.salome@opencascade.com>
+//
 
-// File:        GeomAlgoAPI_Box.h
-// Created:     17 Mar 2016
-// Author:      Clarisse Genrault (CEA)
-
-#ifndef GeomAlgoAPI_Box_H_
-#define GeomAlgoAPI_Box_H_
+#ifndef GEOMALGOAPI_BOX_H_
+#define GEOMALGOAPI_BOX_H_
 
 #include <GeomAPI_Pnt.h>
 #include <GeomAlgoAPI_MakeShape.h>
  */
 class GeomAlgoAPI_Box : public GeomAlgoAPI_MakeShape
 {
- public: 
+ public:
+  /// Type of box operation
+  enum MethodType {
+    BOX_DIM,   ///< Box with dimensions
+    BOX_POINTS,  ///< Box with points
+  };
+
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Box();
-  
+
   /// Creates a box using the dimensions.
   /// \param theDx The dimension on X
   /// \param theDy The dimension on Y
   /// \param theDz The dimension on Z
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Box(const double theDx, const double theDy, const double theDz);
-  
-  /// Checks if each dimension "Dx", Dy" and "Dz" for the box construction is OK.
+
+  /// Creates a box using the two points that defined a diagonal.
+  /// \param theFirstPoint One extermity of the diagonal
+  /// \param theSecondPoint The other extremity of the diagonal
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Box(std::shared_ptr<GeomAPI_Pnt> theFirstPoint,
+                                     std::shared_ptr<GeomAPI_Pnt> theSecondPoint);
+
+  /// Checks if data for the box construction is OK.
   GEOMALGOAPI_EXPORT bool check();
-  
-  /// Builds the box with the dimensions "Dx", "Dy" and "Dz".
+
+  /// Builds the box.
   GEOMALGOAPI_EXPORT void build();
-  
+
   /// Prepare the naming (redifined because it is specific for a box).
   GEOMALGOAPI_EXPORT void prepareNamingFaces();
-  
+
  private:
+  /// Builds the box with the dimensions "Dx", "Dy" and "Dz".
+  void buildWithDimensions();
+  /// Builds the box with two points
+  void buildWithPoints();
+
   double myDx; /// Dimension on X to create a box.
   double myDy; /// Dimension on Y to create a box.
   double myDz; /// Dimension Z to create a box.
+  std::shared_ptr<GeomAPI_Pnt> myFirstPoint; /// First point to create a box.
+  std::shared_ptr<GeomAPI_Pnt> mySecondPoint; /// Second point to create a box.
+  MethodType myMethodType; /// Type of method used.
 };
 
 
-#endif
+#endif // GEOMALGOAPI_BOX_H_