0031939: Coding - correction of spelling errors in comments
[occt.git] / src / HLRBRep / HLRBRep_Curve.hxx
1 // Created on: 1993-04-01
2 // Created by: Modelistation
3 // Copyright (c) 1993-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 _HLRBRep_Curve_HeaderFile
18 #define _HLRBRep_Curve_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <BRepAdaptor_Curve.hxx>
25 #include <GeomAbs_CurveType.hxx>
26 #include <Standard_Real.hxx>
27 #include <gp_Pnt.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <GeomAbs_Shape.hxx>
30 #include <Standard_Integer.hxx>
31 #include <TColStd_Array1OfReal.hxx>
32 #include <gp_Pnt2d.hxx>
33 #include <TColgp_Array1OfPnt2d.hxx>
34 #include <TColStd_Array1OfInteger.hxx>
35 class Standard_NoSuchObject;
36 class Standard_DomainError;
37 class Standard_OutOfRange;
38 class StdFail_UndefinedDerivative;
39 class BRepAdaptor_Curve;
40 class TopoDS_Edge;
41 class gp_Pnt;
42 class gp_Vec;
43 class gp_Pnt2d;
44 class gp_Dir2d;
45 class gp_Vec2d;
46 class gp_Lin2d;
47 class gp_Circ2d;
48 class gp_Elips2d;
49 class gp_Hypr2d;
50 class gp_Parab2d;
51 class Geom_BSplineCurve;
52 class HLRAlgo_Projector;
53
54
55 //! Defines a 2d curve by projection of  a 3D curve on
56 //! a    plane     with  an     optional   perspective
57 //! transformation.
58 class HLRBRep_Curve 
59 {
60 public:
61
62   DEFINE_STANDARD_ALLOC
63
64   
65   //! Creates an undefined Curve.
66   Standard_EXPORT HLRBRep_Curve();
67   
68     void Projector (const HLRAlgo_Projector* Proj)
69     {myProj = Proj;}
70   
71   //! Returns the 3D curve.
72     BRepAdaptor_Curve& Curve();
73   
74   //! Sets the 3D curve to be projected.
75   Standard_EXPORT void Curve (const TopoDS_Edge& E);
76   
77   //! Returns the 3D curve.
78     const BRepAdaptor_Curve& GetCurve() const;
79   
80   //! Returns the parameter   on the 2d  curve  from the
81   //! parameter on the 3d curve.
82   Standard_EXPORT Standard_Real Parameter2d (const Standard_Real P3d) const;
83   
84   //! Returns the parameter   on the 3d  curve  from the
85   //! parameter on the 2d curve.
86   Standard_EXPORT Standard_Real Parameter3d (const Standard_Real P2d) const;
87   
88   //! Update the minmax and the internal data
89   Standard_EXPORT Standard_Real Update (Standard_Real TotMin[16], Standard_Real TotMax[16]);
90   
91   //! Update the minmax returns tol for enlarge;
92   Standard_EXPORT Standard_Real UpdateMinMax (Standard_Real TotMin[16], Standard_Real TotMax[16]);
93   
94   //! Computes the Z    coordinate  of the  point  of
95   //! parameter U on the curve in the viewing coordinate system
96   Standard_EXPORT Standard_Real Z (const Standard_Real U) const;
97   
98   //! Computes the 3D point   of parameter U  on the
99   //! curve.
100     gp_Pnt Value3D (const Standard_Real U) const;
101   
102   //! Computes the 3D point   of parameter U  on the
103   //! curve.
104     void D0 (const Standard_Real U, gp_Pnt& P) const;
105   
106   //! Computes the point of parameter  U on the curve
107   //! with its first derivative.
108     void D1 (const Standard_Real U, gp_Pnt& P, gp_Vec& V) const;
109   
110   //! Depending on <AtStart> computes the 2D point and
111   //! tangent on the curve  at sart (or at  end).  If the  first
112   //! derivative is null look after  at start (or before at end)
113   //! with the second derivative.
114   Standard_EXPORT void Tangent (const Standard_Boolean AtStart, gp_Pnt2d& P, gp_Dir2d& D) const;
115   
116     Standard_Real FirstParameter() const;
117   
118     Standard_Real LastParameter() const;
119   
120     GeomAbs_Shape Continuity() const;
121   
122   //! If necessary,  breaks the  curve in  intervals  of
123   //! continuity  <S>.    And  returns   the number   of
124   //! intervals.
125     Standard_Integer NbIntervals (const GeomAbs_Shape S) const;
126   
127   //! Stores in <T> the  parameters bounding the intervals
128   //! of continuity <S>.
129   //!
130   //! The array must provide  enough room to  accommodate
131   //! for the parameters. i.e. T.Length() > NbIntervals()
132     void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const;
133   
134     Standard_Boolean IsClosed() const;
135   
136     Standard_Boolean IsPeriodic() const;
137   
138     Standard_Real Period() const;
139   
140   //! Computes the point of parameter U on the curve.
141     gp_Pnt2d Value (const Standard_Real U) const;
142   
143   //! Computes the point of parameter U on the curve.
144   Standard_EXPORT void D0 (const Standard_Real U, gp_Pnt2d& P) const;
145   
146   //! Computes the point  of  parameter U on the curve
147   //! with its first derivative.
148   //! Raised if the continuity of the current interval
149   //! is not C1.
150   Standard_EXPORT void D1 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V) const;
151   
152   //! Raised if the continuity of the current interval
153   //! is not C2.
154   Standard_EXPORT void D2 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V1, gp_Vec2d& V2) const;
155   
156
157   //! Returns the point P of parameter U, the first, the second
158   //! and the third derivative.
159   //! Raised if the continuity of the current interval
160   //! is not C3.
161   Standard_EXPORT void D3 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V1, gp_Vec2d& V2, gp_Vec2d& V3) const;
162   
163
164   //! The returned vector gives the value of the derivative for the
165   //! order of derivation N.
166   //! Raised if the continuity of the current interval
167   //! is not CN.
168   //! Raised if N < 1.
169   Standard_EXPORT gp_Vec2d DN (const Standard_Real U, const Standard_Integer N) const;
170   
171   //! Returns the parametric  resolution corresponding
172   //! to the real space resolution <R3d>.
173     Standard_Real Resolution (const Standard_Real R3d) const;
174   
175   //! Returns  the  type of the   curve  in the  current
176   //! interval :   Line,   Circle,   Ellipse, Hyperbola,
177   //! Parabola, BezierCurve, BSplineCurve, OtherCurve.
178     GeomAbs_CurveType GetType() const;
179   
180   Standard_EXPORT gp_Lin2d Line() const;
181   
182   Standard_EXPORT gp_Circ2d Circle() const;
183   
184   Standard_EXPORT gp_Elips2d Ellipse() const;
185   
186   Standard_EXPORT gp_Hypr2d Hyperbola() const;
187   
188   Standard_EXPORT gp_Parab2d Parabola() const;
189   
190     Standard_Boolean IsRational() const;
191   
192     Standard_Integer Degree() const;
193   
194     Standard_Integer NbPoles() const;
195   
196   Standard_EXPORT void Poles (TColgp_Array1OfPnt2d& TP) const;
197   
198   Standard_EXPORT void Poles (const Handle(Geom_BSplineCurve)& aCurve, TColgp_Array1OfPnt2d& TP) const;
199   
200   Standard_EXPORT void PolesAndWeights (TColgp_Array1OfPnt2d& TP, TColStd_Array1OfReal& TW) const;
201   
202   Standard_EXPORT void PolesAndWeights (const Handle(Geom_BSplineCurve)& aCurve, TColgp_Array1OfPnt2d& TP, TColStd_Array1OfReal& TW) const;
203   
204     Standard_Integer NbKnots() const;
205   
206   Standard_EXPORT void Knots (TColStd_Array1OfReal& kn) const;
207   
208   Standard_EXPORT void Multiplicities (TColStd_Array1OfInteger& mu) const;
209
210
211
212
213 protected:
214
215
216
217
218
219 private:
220
221
222
223   BRepAdaptor_Curve myCurve;
224   GeomAbs_CurveType myType;
225   const HLRAlgo_Projector* myProj;
226   Standard_Real myOX;
227   Standard_Real myOZ;
228   Standard_Real myVX;
229   Standard_Real myVZ;
230   Standard_Real myOF;
231
232
233 };
234
235
236 #include <HLRBRep_Curve.lxx>
237
238
239
240
241
242 #endif // _HLRBRep_Curve_HeaderFile