]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Box.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / GeomAPI / GeomAPI_Box.h
1 // Copyright (C) 2018-2019  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef GeomAPI_Box_H_
21 #define GeomAPI_Box_H_
22
23 #include <GeomAPI_Interface.h>
24 #include <memory>
25
26 class GeomAPI_Ax3;
27 class GeomAPI_Pnt;
28
29 /**\class GeomAPI_Box
30  * \ingroup DataModel
31  * \brief Box in 3D
32  */
33 class GeomAPI_Box : public GeomAPI_Interface
34 {
35 public:
36   /// Creation of torus defined by center point, direction, major and minor radii
37   GEOMAPI_EXPORT GeomAPI_Box(const std::shared_ptr<GeomAPI_Ax3>& theCorner,
38                              const double theWidth,
39                              const double theDepth,
40                              const double theHeight);
41
42   /// Return axes of the box
43   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Ax3> axes() const;
44
45   /// Return base corner of the box
46   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> corner() const;
47
48   /// Return width of the box
49   GEOMAPI_EXPORT double width() const;
50
51   /// Return depth of the box
52   GEOMAPI_EXPORT double depth() const;
53
54   /// Return height of the box
55   GEOMAPI_EXPORT double height() const;
56
57   /// Return \c true is the box is aligned in main axes
58   GEOMAPI_EXPORT bool isAxesAligned() const;
59 };
60
61 //! Pointer on the object
62 typedef std::shared_ptr<GeomAPI_Box> GeomBoxPtr;
63
64 #endif