src/GeomAPI/GeomAPI_Lin2d.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAPI_Lin2d.h
   4 // Created:     29 May 2014
   5 // Author:      Artem ZHIDKOV
   6
   7 #ifndef GeomAPI_Lin2d_H_
   8 #define GeomAPI_Lin2d_H_
   9
  10 #include <GeomAPI_Interface.h>
  11 #include <memory>
  12
  13 class GeomAPI_Dir2d;
  14 class GeomAPI_Pnt2d;
  15
  16 /**\class GeomAPI_Lin2d
  17  * \ingroup DataModel
  18  * \brief Line in 2D
  19  */
  20
  21 class GEOMAPI_EXPORT GeomAPI_Lin2d : public GeomAPI_Interface
  22 {
  23  public:
  24   /// Creation of line defined by cordinates of start and end points
  25   GeomAPI_Lin2d(const double theStartX, const double theStartY, const double theEndX,
  26                 const double theEndY);
  27   /// Creation of line defined by start and end points
  28   GeomAPI_Lin2d(const std::shared_ptr<GeomAPI_Pnt2d>& theStart,
  29                 const std::shared_ptr<GeomAPI_Pnt2d>& theEnd);
  30
  31   /// Returns point on the line (first point)
  32   std::shared_ptr<GeomAPI_Pnt2d> location();
  33
  34   /// Returns a line direction
  35   std::shared_ptr<GeomAPI_Dir2d> direction();
  36
  37   /// Distance between two points
  38   double distance(const std::shared_ptr<GeomAPI_Pnt2d>& theOther) const;
  39   /// Intersection of two lines
  40   const std::shared_ptr<GeomAPI_Pnt2d> intersect(
  41       const std::shared_ptr<GeomAPI_Lin2d>& theLine) const;
  42   /// Project point on line
  43   const std::shared_ptr<GeomAPI_Pnt2d> project(
  44       const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) const;
  45   /// Computes the cross product of the line direction and a vector from the line start point to the point
  46   bool isRight(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) const;
  47
  48   /// Returns a location point shifted on theShift in perpendicular direction
  49   std::shared_ptr<GeomAPI_Pnt2d> shiftedLocation(double theShift) const;
  50 };
  51
  52 #endif
  53