]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Lin.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / GeomAPI / GeomAPI_Lin.h
1 // Copyright (C) 2014-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 #ifndef GeomAPI_Lin_H_
21 #define GeomAPI_Lin_H_
22
23 #include <GeomAPI_Interface.h>
24 #include <memory>
25
26 class GeomAPI_Dir;
27 class GeomAPI_Pnt;
28
29 /**\class GeomAPI_Lin
30  * \ingroup DataModel
31  * \brief Line in 3D
32  */
33
34 class GeomAPI_Lin : public GeomAPI_Interface
35 {
36  public:
37   /// Creation of line defined by cordinates of start and end points
38   GEOMAPI_EXPORT
39   GeomAPI_Lin(const double theStartX, const double theStartY, const double theStartZ,
40               const double theEndX, const double theEndY, const double theEndZ);
41   /// Creation of line defined by start and end points
42   GEOMAPI_EXPORT
43   GeomAPI_Lin(const std::shared_ptr<GeomAPI_Pnt>& theStart,
44               const std::shared_ptr<GeomAPI_Pnt>& theEnd);
45   /// Creation of line defined by origin and direction
46   GEOMAPI_EXPORT
47   GeomAPI_Lin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
48               const std::shared_ptr<GeomAPI_Dir>& theDirection);
49
50   /// Returns point on the line (first point)
51   GEOMAPI_EXPORT
52   std::shared_ptr<GeomAPI_Pnt> location();
53
54   /// Returns a line direction
55   GEOMAPI_EXPORT
56   std::shared_ptr<GeomAPI_Dir> direction();
57
58   /// Distance between two points
59   GEOMAPI_EXPORT
60   double distance(const std::shared_ptr<GeomAPI_Pnt>& thePoint) const;
61   /// Intersection of two lines
62   GEOMAPI_EXPORT
63   const std::shared_ptr<GeomAPI_Pnt> intersect(
64       const std::shared_ptr<GeomAPI_Lin>& theLine) const;
65   /// Project point on line
66   GEOMAPI_EXPORT
67   const std::shared_ptr<GeomAPI_Pnt> project(
68       const std::shared_ptr<GeomAPI_Pnt>& thePoint) const;
69
70   /// Returns parameter of the point projection
71   GEOMAPI_EXPORT
72   double projParam(const std::shared_ptr<GeomAPI_Pnt>& thePoint) const;
73
74   /// \return true if this line contains thePoint, that is,
75   /// if the distance between thePoint and this line
76   ///         is less than or equal to theLinearTolerance.
77   GEOMAPI_EXPORT
78   bool contains(const std::shared_ptr<GeomAPI_Pnt> thePoint,
79                 const double theLinearTolerance = 1.e-7) const;
80
81   /// \return true if lines are parallel.
82   GEOMAPI_EXPORT
83   bool isParallel(const std::shared_ptr<GeomAPI_Lin> theLin) const;
84
85   /// \return true if lines are coplanar.
86   GEOMAPI_EXPORT
87   bool isCoplanar(const std::shared_ptr<GeomAPI_Lin> theLin) const;
88 };
89
90 //! Pointer on the object
91 typedef std::shared_ptr<GeomAPI_Lin> GeomLinePtr;
92
93 #endif
94