0031939: Coding - correction of spelling errors in comments
[occt.git] / src / GeomFill / GeomFill_Darboux.hxx
1 // Created on: 1998-03-04
2 // Created by: Roman BORISOV
3 // Copyright (c) 1998-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 _GeomFill_Darboux_HeaderFile
18 #define _GeomFill_Darboux_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <GeomFill_TrihedronLaw.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 #include <GeomAbs_Shape.hxx>
28 #include <TColStd_Array1OfReal.hxx>
29 class Standard_OutOfRange;
30 class Standard_ConstructionError;
31 class GeomFill_TrihedronLaw;
32 class gp_Vec;
33
34
35 class GeomFill_Darboux;
36 DEFINE_STANDARD_HANDLE(GeomFill_Darboux, GeomFill_TrihedronLaw)
37
38 //! Defines Darboux case of Frenet Trihedron Law
39 class GeomFill_Darboux : public GeomFill_TrihedronLaw
40 {
41
42 public:
43
44   
45   Standard_EXPORT GeomFill_Darboux();
46   
47   Standard_EXPORT virtual Handle(GeomFill_TrihedronLaw) Copy() const Standard_OVERRIDE;
48   
49   //! compute Triedrhon on curve at parameter <Param>
50   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Vec& Tangent, gp_Vec& Normal, gp_Vec& BiNormal) Standard_OVERRIDE;
51   
52   //! compute Triedrhon and  derivative Trihedron  on curve
53   //! at parameter <Param>
54   //! Warning : It used only for C1 or C2 aproximation
55   Standard_EXPORT virtual Standard_Boolean D1 (const Standard_Real Param, gp_Vec& Tangent, gp_Vec& DTangent, gp_Vec& Normal, gp_Vec& DNormal, gp_Vec& BiNormal, gp_Vec& DBiNormal) Standard_OVERRIDE;
56   
57   //! compute  Trihedron on curve
58   //! first and seconde  derivatives.
59   //! Warning : It used only for C2 aproximation
60   Standard_EXPORT virtual Standard_Boolean D2 (const Standard_Real Param, gp_Vec& Tangent, gp_Vec& DTangent, gp_Vec& D2Tangent, gp_Vec& Normal, gp_Vec& DNormal, gp_Vec& D2Normal, gp_Vec& BiNormal, gp_Vec& DBiNormal, gp_Vec& D2BiNormal) Standard_OVERRIDE;
61   
62   //! Returns  the number  of  intervals for  continuity
63   //! <S>.
64   //! May be one if Continuity(me) >= <S>
65   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
66   
67   //! Stores in <T> the  parameters bounding the intervals
68   //! of continuity <S>.
69   //!
70   //! The array must provide  enough room to  accommodate
71   //! for the parameters. i.e. T.Length() > NbIntervals()
72   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
73   
74   //! Get average value of Tangent(t) and Normal(t) it is usfull to
75   //! make fast approximation of rational  surfaces.
76   Standard_EXPORT virtual void GetAverageLaw (gp_Vec& ATangent, gp_Vec& ANormal, gp_Vec& ABiNormal) Standard_OVERRIDE;
77   
78   //! Say if the law is Constant.
79   Standard_EXPORT virtual Standard_Boolean IsConstant() const Standard_OVERRIDE;
80   
81   //! Return False.
82   Standard_EXPORT virtual Standard_Boolean IsOnlyBy3dCurve() const Standard_OVERRIDE;
83
84
85
86
87   DEFINE_STANDARD_RTTIEXT(GeomFill_Darboux,GeomFill_TrihedronLaw)
88
89 protected:
90
91
92
93
94 private:
95
96
97
98
99 };
100
101
102
103
104
105
106
107 #endif // _GeomFill_Darboux_HeaderFile