0031939: Coding - correction of spelling errors in comments
[occt.git] / src / Adaptor2d / Adaptor2d_Line2d.hxx
1 // Created on: 1995-05-02
2 // Created by: Modelistation
3 // Copyright (c) 1995-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Adaptor2d_Line2d_HeaderFile
18 #define _Adaptor2d_Line2d_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 #include <gp_Ax2d.hxx>
26 #include <Adaptor2d_Curve2d.hxx>
27 #include <GeomAbs_Shape.hxx>
28 #include <Standard_Integer.hxx>
29 #include <TColStd_Array1OfReal.hxx>
30 #include <Standard_Boolean.hxx>
31 #include <GeomAbs_CurveType.hxx>
32 class Standard_OutOfRange;
33 class Standard_NoSuchObject;
34 class Standard_DomainError;
35 class gp_Pnt2d;
36 class gp_Dir2d;
37 class gp_Lin2d;
38 class Adaptor2d_HCurve2d;
39 class gp_Vec2d;
40 class gp_Circ2d;
41 class gp_Elips2d;
42 class gp_Hypr2d;
43 class gp_Parab2d;
44 class Geom2d_BezierCurve;
45 class Geom2d_BSplineCurve;
46
47 //! Use by the TopolTool to trim a surface.
48
49 class Adaptor2d_Line2d  : public Adaptor2d_Curve2d
50 {
51 public:
52
53   DEFINE_STANDARD_ALLOC
54
55   
56   Standard_EXPORT Adaptor2d_Line2d();
57   
58   Standard_EXPORT Adaptor2d_Line2d(const gp_Pnt2d& P, const gp_Dir2d& D, const Standard_Real UFirst, const Standard_Real ULast);
59   
60   Standard_EXPORT void Load (const gp_Lin2d& L);
61   
62   Standard_EXPORT void Load (const gp_Lin2d& L, const Standard_Real UFirst, const Standard_Real ULast);
63   
64   Standard_EXPORT Standard_Real FirstParameter() const Standard_OVERRIDE;
65   
66   Standard_EXPORT Standard_Real LastParameter() const Standard_OVERRIDE;
67   
68   Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
69   
70   //! If necessary,  breaks the  curve in  intervals  of
71   //! continuity  <S>.    And  returns   the number   of
72   //! intervals.
73   Standard_EXPORT Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
74   
75   //! Stores in <T> the  parameters bounding the intervals
76   //! of continuity <S>.
77   //!
78   //! The array must provide  enough room to  accommodate
79   //! for the parameters. i.e. T.Length() > NbIntervals()
80   Standard_EXPORT void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
81   
82   //! Returns    a  curve equivalent   of  <me>  between
83   //! parameters <First>  and <Last>. <Tol>  is used  to
84   //! test for 3d points confusion.
85   //! If <First> >= <Last>
86   Standard_EXPORT Handle(Adaptor2d_HCurve2d) Trim (const Standard_Real First, const Standard_Real Last, const Standard_Real Tol) const Standard_OVERRIDE;
87   
88   Standard_EXPORT Standard_Boolean IsClosed() const Standard_OVERRIDE;
89   
90   Standard_EXPORT Standard_Boolean IsPeriodic() const Standard_OVERRIDE;
91   
92   Standard_EXPORT Standard_Real Period() const Standard_OVERRIDE;
93   
94   Standard_EXPORT gp_Pnt2d Value (const Standard_Real X) const Standard_OVERRIDE;
95   
96   Standard_EXPORT void D0 (const Standard_Real X, gp_Pnt2d& P) const Standard_OVERRIDE;
97   
98   Standard_EXPORT void D1 (const Standard_Real X, gp_Pnt2d& P, gp_Vec2d& V) const Standard_OVERRIDE;
99   
100   Standard_EXPORT void D2 (const Standard_Real X, gp_Pnt2d& P, gp_Vec2d& V1, gp_Vec2d& V2) const Standard_OVERRIDE;
101   
102   Standard_EXPORT void D3 (const Standard_Real X, gp_Pnt2d& P, gp_Vec2d& V1, gp_Vec2d& V2, gp_Vec2d& V3) const Standard_OVERRIDE;
103   
104   Standard_EXPORT gp_Vec2d DN (const Standard_Real U, const Standard_Integer N) const Standard_OVERRIDE;
105   
106   Standard_EXPORT Standard_Real Resolution (const Standard_Real R3d) const Standard_OVERRIDE;
107   
108   Standard_EXPORT GeomAbs_CurveType GetType() const Standard_OVERRIDE;
109   
110   Standard_EXPORT gp_Lin2d Line() const Standard_OVERRIDE;
111   
112   Standard_EXPORT gp_Circ2d Circle() const Standard_OVERRIDE;
113   
114   Standard_EXPORT gp_Elips2d Ellipse() const Standard_OVERRIDE;
115   
116   Standard_EXPORT gp_Hypr2d Hyperbola() const Standard_OVERRIDE;
117   
118   Standard_EXPORT gp_Parab2d Parabola() const Standard_OVERRIDE;
119   
120   Standard_EXPORT Standard_Integer Degree() const Standard_OVERRIDE;
121   
122   Standard_EXPORT Standard_Boolean IsRational() const Standard_OVERRIDE;
123   
124   Standard_EXPORT Standard_Integer NbPoles() const Standard_OVERRIDE;
125   
126   Standard_EXPORT Standard_Integer NbKnots() const Standard_OVERRIDE;
127   
128   Standard_EXPORT Handle(Geom2d_BezierCurve) Bezier() const Standard_OVERRIDE;
129   
130   Standard_EXPORT Handle(Geom2d_BSplineCurve) BSpline() const Standard_OVERRIDE;
131
132
133
134
135 protected:
136
137
138
139
140
141 private:
142
143
144
145   Standard_Real myUfirst;
146   Standard_Real myUlast;
147   gp_Ax2d myAx2d;
148
149
150 };
151
152
153
154
155
156
157
158 #endif // _Adaptor2d_Line2d_HeaderFile