src/GeomAPI/GeomAPI_Pln.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAPI_Pln.hxx
   4 // Created:     23 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef GeomAPI_Pln_H_
   8 #define GeomAPI_Pln_H_
   9
  10 #include <memory>
  11 #include <GeomAPI_Interface.h>
  12
  13 class GeomAPI_Ax3;
  14 class GeomAPI_Pnt;
  15 class GeomAPI_Dir;
  16
  17 /**\class GeomAPI_Pln
  18  * \ingroup DataModel
  19  * \brief 3D point defined by three coordinates
  20  */
  21
  22 class GeomAPI_Pln : public GeomAPI_Interface
  23 {
  24  public:
  25   /// Creation of plane by the axis placement
  26   GEOMAPI_EXPORT
  27   GeomAPI_Pln(const std::shared_ptr<GeomAPI_Ax3>& theAxis);
  28
  29   /// Creation of plane by the point and normal
  30   GEOMAPI_EXPORT
  31   GeomAPI_Pln(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
  32               const std::shared_ptr<GeomAPI_Dir>& theNormal);
  33
  34   /// Creation of plane by coefficients (Ax+By+Cz+D=0)
  35   GEOMAPI_EXPORT
  36   GeomAPI_Pln(const double theA, const double theB, const double theC, const double theD);
  37
  38   /// Returns a point of this plane
  39   GEOMAPI_EXPORT
  40   std::shared_ptr<GeomAPI_Pnt> location();
  41
  42   /// Returns a plane normal
  43   GEOMAPI_EXPORT
  44   std::shared_ptr<GeomAPI_Dir> direction();
  45
  46   /// Returns the plane coefficients (Ax+By+Cz+D=0)
  47   GEOMAPI_EXPORT
  48   void coefficients(double& theA, double& theB, double& theC, double& theD);
  49 };
  50
  51 #endif
  52