src/GeomAPI/GeomAPI_Circ.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAPI_Circ.h
   4 // Created:     24 Jun 2014
   5 // Author:      Artem ZHIDKOV
   6
   7 #ifndef GeomAPI_Circ_H_
   8 #define GeomAPI_Circ_H_
   9
  10 #include <GeomAPI_Interface.h>
  11 #include <memory>
  12
  13 class GeomAPI_Pnt;
  14 class GeomAPI_Dir;
  15
  16 /**\class GeomAPI_Circ
  17  * \ingroup DataModel
  18  * \brief Circle in 3D
  19  */
  20
  21 class GEOMAPI_EXPORT GeomAPI_Circ : public GeomAPI_Interface
  22 {
  23  public:
  24   /// Creation of circle defined by center point, direction and circle radius
  25   GeomAPI_Circ(const std::shared_ptr<GeomAPI_Pnt>& theCenter,
  26                const std::shared_ptr<GeomAPI_Dir>& theDir, double theRadius);
  27
  28   /// Return center of the circle
  29   const std::shared_ptr<GeomAPI_Pnt> center() const;
  30
  31   /// Return radius of the circle
  32   double radius() const;
  33
  34   /// Project point on circle
  35   const std::shared_ptr<GeomAPI_Pnt> project(
  36       const std::shared_ptr<GeomAPI_Pnt>& thePoint) const;
  37 };
  38
  39 #endif
  40