0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / GeomFill / GeomFill_TrihedronLaw.hxx
1 // Created on: 1997-12-02
2 // Created by: Philippe MANGIN
3 // Copyright (c) 1997-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_TrihedronLaw_HeaderFile
18 #define _GeomFill_TrihedronLaw_HeaderFile
19
20 #include <Adaptor3d_Curve.hxx>
21 #include <GeomFill_PipeError.hxx>
22 #include <GeomAbs_Shape.hxx>
23 #include <TColStd_Array1OfReal.hxx>
24
25 class Standard_OutOfRange;
26 class Standard_NotImplemented;
27 class gp_Vec;
28
29
30 class GeomFill_TrihedronLaw;
31 DEFINE_STANDARD_HANDLE(GeomFill_TrihedronLaw, Standard_Transient)
32
33 //! To define Trihedron along one Curve
34 class GeomFill_TrihedronLaw : public Standard_Transient
35 {
36
37 public:
38
39   
40   Standard_EXPORT virtual void SetCurve (const Handle(Adaptor3d_Curve)& C);
41   
42   Standard_EXPORT virtual Handle(GeomFill_TrihedronLaw) Copy() const = 0;
43   
44   //! Give a status to the Law
45   //! Returns PipeOk (default implementation)
46   Standard_EXPORT virtual GeomFill_PipeError ErrorStatus() const;
47   
48   //! compute Triedrhon on curve at parameter <Param>
49   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Vec& Tangent, gp_Vec& Normal, gp_Vec& BiNormal) = 0;
50   
51   //! compute Triedrhon and  derivative Trihedron  on curve
52   //! at parameter <Param>
53   //! Warning : It used only for C1 or C2 approximation
54   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);
55   
56   //! compute  Trihedron on curve
57   //! first and seconde  derivatives.
58   //! Warning : It used only for C2 approximation
59   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);
60   
61   //! Returns  the number  of  intervals for  continuity
62   //! <S>.
63   //! May be one if Continuity(me) >= <S>
64   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const = 0;
65   
66   //! Stores in <T> the  parameters bounding the intervals
67   //! of continuity <S>.
68   //!
69   //! The array must provide  enough room to  accommodate
70   //! for the parameters. i.e. T.Length() > NbIntervals()
71   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
72   
73   //! Sets the bounds of the parametric interval on
74   //! the function
75   //! This determines the derivatives in these values if the
76   //! function is not Cn.
77   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last);
78   
79   //! Gets the bounds of the parametric interval on
80   //! the function
81   Standard_EXPORT void GetInterval (Standard_Real& First, Standard_Real& Last);
82   
83   //! Get average value of M(t) and V(t) it is usfull to
84   //! make fast approximation of rational  surfaces.
85   Standard_EXPORT virtual void GetAverageLaw (gp_Vec& ATangent, gp_Vec& ANormal, gp_Vec& ABiNormal) = 0;
86   
87   //! Say if the law is Constant
88   Standard_EXPORT virtual Standard_Boolean IsConstant() const;
89   
90   //! Say if the law is defined, only by the 3d Geometry of
91   //! the setted Curve
92   //! Return False by Default.
93   Standard_EXPORT virtual Standard_Boolean IsOnlyBy3dCurve() const;
94
95
96
97
98   DEFINE_STANDARD_RTTIEXT(GeomFill_TrihedronLaw,Standard_Transient)
99
100 protected:
101
102
103   Handle(Adaptor3d_Curve) myCurve;
104   Handle(Adaptor3d_Curve) myTrimmed;
105
106
107 private:
108
109
110
111
112 };
113
114
115
116
117
118
119
120 #endif // _GeomFill_TrihedronLaw_HeaderFile