src/GeomAPI/GeomAPI_Ellipse.h

   1 // Copyright (C) 2017-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 // File:        GeomAPI_Ellipse.h
  21 // Created:     25 April 2017
  22 // Author:      Vitaly Smetannikov
  23
  24 #ifndef GeomAPI_Ellipse_H_
  25 #define GeomAPI_Ellipse_H_
  26
  27 #include <GeomAPI_Interface.h>
  28 #include <memory>
  29
  30 class GeomAPI_Ax2;
  31 class GeomAPI_Dir;
  32 class GeomAPI_Pnt;
  33
  34
  35 /**\class GeomAPI_Ellipse
  36  * \ingroup DataModel
  37  * \brief Ellipse in 3D
  38  */
  39 class GeomAPI_Ellipse : public GeomAPI_Interface
  40 {
  41 public:
  42
  43   /// \brief Constructs an epty ellipse
  44   GEOMAPI_EXPORT GeomAPI_Ellipse() : GeomAPI_Interface() {}
  45
  46   /** \brief Constructs an ellipse with major and minor radiuses,
  47    *  where theAx2 locates the ellipse and defines its orientation in 3D space such that:\n
  48    *  - the center of the circle is the origin of theAx2;\n
  49    *  - the origin, "X Direction" and "Y Direction" of theAx2 define the plane of the circle;\n
  50    *  - theAx2 is the local coordinate system of the circle.\n
  51    *    Note: It is possible to create a circle where Radius is equal to 0.0. raised if Radius < 0.
  52    */
  53   GEOMAPI_EXPORT GeomAPI_Ellipse(const std::shared_ptr<GeomAPI_Ax2>& theAx2,
  54                                  double theMajorRadius, double theMinorRadius);
  55
  56   /// Returns center of the ellipse
  57   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> center() const;
  58
  59   /// Returns first focus of the ellipse
  60   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> firstFocus() const;
  61
  62   /// Returns second focus of the ellipse
  63   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> secondFocus() const;
  64
  65   /// Return orthogonal direction to the ellipse's plane
  66   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> normal() const;
  67
  68   /// Returns minor radius of the ellipse
  69   GEOMAPI_EXPORT double minorRadius() const;
  70
  71   /// Returns major radius of the ellipse
  72   GEOMAPI_EXPORT double majorRadius() const;
  73
  74 };
  75
  76 //! Pointer on the object
  77 typedef std::shared_ptr<GeomAPI_Ellipse> GeomEllipsePtr;
  78
  79 #endif