]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Curve.h
Salome HOME
Fix for the issue #2401
[modules/shaper.git] / src / GeomAPI / GeomAPI_Curve.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef GeomAPI_Curve_H_
22 #define GeomAPI_Curve_H_
23
24 #include <GeomAPI_Shape.h>
25 #include <memory>
26
27 class GeomAPI_Pnt;
28
29 /**\class GeomAPI_Curve
30  * \ingroup DataModel
31  * \brief Interface to the generic curve object
32  */
33
34 class GeomAPI_Curve : public GeomAPI_Interface
35 {
36  public:
37   /// Creation of empty (null) shape
38   GEOMAPI_EXPORT
39   GeomAPI_Curve();
40
41   /// Creates a curve from the shape (edge)
42   GEOMAPI_EXPORT
43   GeomAPI_Curve(const std::shared_ptr<GeomAPI_Shape>& theShape);
44
45   /// Returns true if curve is not initialized
46   GEOMAPI_EXPORT
47   bool isNull() const;
48
49   /// Returns whether the curve is linear
50   GEOMAPI_EXPORT
51   virtual bool isLine() const;
52
53   /// Returns whether the curve is circular
54   GEOMAPI_EXPORT
55   virtual bool isCircle() const;
56
57   /// Returns start parameter of the curve
58   GEOMAPI_EXPORT
59   double startParam() const { return myStart; }
60
61   /// Returns end parameter of the curve
62   GEOMAPI_EXPORT
63   double endParam() const { return myEnd; }
64
65   /// Returns point on the curve by parameter
66   /// \param theParam parameter on the curve
67   GEOMAPI_EXPORT
68   std::shared_ptr<GeomAPI_Pnt> getPoint(double theParam);
69
70 private:
71   double myStart;
72   double myEnd;
73 };
74
75 //! Pointer on the object
76 typedef std::shared_ptr<GeomAPI_Curve> GeomCurvePtr;
77
78 #endif