src/GeomAPI/GeomAPI_Box.h

   1 // Copyright (C) 2018-20xx  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef GeomAPI_Box_H_
  22 #define GeomAPI_Box_H_
  23
  24 #include <GeomAPI_Interface.h>
  25 #include <memory>
  26
  27 class GeomAPI_Ax3;
  28 class GeomAPI_Pnt;
  29
  30 /**\class GeomAPI_Box
  31  * \ingroup DataModel
  32  * \brief Box in 3D
  33  */
  34 class GeomAPI_Box : public GeomAPI_Interface
  35 {
  36 public:
  37   /// Default constructor
  38   GEOMAPI_EXPORT GeomAPI_Box();
  39
  40   /// Creation of torus defined by center point, direction, major and minor radii
  41   GEOMAPI_EXPORT GeomAPI_Box(const std::shared_ptr<GeomAPI_Ax3>& theCorner,
  42                              const double theWidth,
  43                              const double theDepth,
  44                              const double theHeight);
  45
  46   /// Return axes of the box
  47   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Ax3> axes() const;
  48
  49   /// Return base corner of the box
  50   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> corner() const;
  51
  52   /// Return width of the box
  53   GEOMAPI_EXPORT double width() const;
  54
  55   /// Return depth of the box
  56   GEOMAPI_EXPORT double depth() const;
  57
  58   /// Return height of the box
  59   GEOMAPI_EXPORT double height() const;
  60
  61   /// Return \c true is the box is aligned in main axes
  62   GEOMAPI_EXPORT bool isAxesAligned() const;
  63 };
  64
  65 //! Pointer on the object
  66 typedef std::shared_ptr<GeomAPI_Box> GeomBoxPtr;
  67
  68 #endif