SHAPER  9.12.0
GeomAPI_Box.h
1 // Copyright (C) 2018-2023 CEA, EDF
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 
34 {
35 public:
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 
43  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Ax3> axes() const;
44 
46  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> corner() const;
47 
49  GEOMAPI_EXPORT double width() const;
50 
52  GEOMAPI_EXPORT double depth() const;
53 
55  GEOMAPI_EXPORT double height() const;
56 
58  GEOMAPI_EXPORT bool isAxesAligned() const;
59 };
60 
62 typedef std::shared_ptr<GeomAPI_Box> GeomBoxPtr;
63 
64 #endif
The class represents a coordinate plane which is 2d plane with X and Y directions and origin.
Definition: GeomAPI_Ax3.h:33
Box in 3D.
Definition: GeomAPI_Box.h:34
GEOMAPI_EXPORT double depth() const
Return depth of the box.
Definition: GeomAPI_Box.cpp:73
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Ax3 > axes() const
Return axes of the box.
Definition: GeomAPI_Box.cpp:55
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt > corner() const
Return base corner of the box.
Definition: GeomAPI_Box.cpp:61
GEOMAPI_EXPORT double height() const
Return height of the box.
Definition: GeomAPI_Box.cpp:79
GEOMAPI_EXPORT GeomAPI_Box(const std::shared_ptr< GeomAPI_Ax3 > &theCorner, const double theWidth, const double theDepth, const double theHeight)
Creation of torus defined by center point, direction, major and minor radii.
Definition: GeomAPI_Box.cpp:46
GEOMAPI_EXPORT bool isAxesAligned() const
Return true is the box is aligned in main axes.
Definition: GeomAPI_Box.cpp:85
GEOMAPI_EXPORT double width() const
Return width of the box.
Definition: GeomAPI_Box.cpp:67
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
3D point defined by three coordinates
Definition: GeomAPI_Pnt.h:38