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_Pnt;
  14 class GeomAPI_Dir;
  15
  16 /**\class GeomAPI_Pln
  17  * \ingroup DataModel
  18  * \brief 3D point defined by three coordinates
  19  */
  20
  21 class GEOMAPI_EXPORT GeomAPI_Pln : public GeomAPI_Interface
  22 {
  23  public:
  24   /// Creation of plane by the point and normal
  25   GeomAPI_Pln(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
  26               const std::shared_ptr<GeomAPI_Dir>& theNormal);
  27
  28   /// Creation of plane by coefficients (Ax+By+Cz+D=0)
  29   GeomAPI_Pln(const double theA, const double theB, const double theC, const double theD);
  30
  31   /// Returns a point of this plane
  32   std::shared_ptr<GeomAPI_Pnt> location();
  33
  34   /// Returns a plane normal
  35   std::shared_ptr<GeomAPI_Dir> direction();
  36
  37   /// Returns the plane coefficients (Ax+By+Cz+D=0)
  38   void coefficients(double& theA, double& theB, double& theC, double& theD);
  39 };
  40
  41 #endif
  42