0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / GeomFill / GeomFill_CurveAndTrihedron.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_CurveAndTrihedron_HeaderFile
18 #define _GeomFill_CurveAndTrihedron_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Boolean.hxx>
24 #include <gp_Pnt.hxx>
25 #include <gp_Vec.hxx>
26 #include <gp_Mat.hxx>
27 #include <GeomFill_LocationLaw.hxx>
28 #include <Standard_Real.hxx>
29 #include <TColgp_Array1OfPnt2d.hxx>
30 #include <TColgp_Array1OfVec2d.hxx>
31 #include <Standard_Integer.hxx>
32 #include <GeomAbs_Shape.hxx>
33 #include <TColStd_Array1OfReal.hxx>
34 class GeomFill_TrihedronLaw;
35 class Standard_OutOfRange;
36 class gp_Mat;
37 class GeomFill_LocationLaw;
38 class gp_Vec;
39 class gp_Pnt;
40
41
42 class GeomFill_CurveAndTrihedron;
43 DEFINE_STANDARD_HANDLE(GeomFill_CurveAndTrihedron, GeomFill_LocationLaw)
44
45 //! Define location law with an TrihedronLaw and an
46 //! curve
47 //! Definition Location is :
48 //! transformed  section   coordinates  in  (Curve(v)),
49 //! (Normal(v),   BiNormal(v), Tangente(v))) systeme are
50 //! the  same like section  shape coordinates in
51 //! (O,(OX, OY, OZ)) systeme.
52 class GeomFill_CurveAndTrihedron : public GeomFill_LocationLaw
53 {
54
55 public:
56
57   
58   Standard_EXPORT GeomFill_CurveAndTrihedron(const Handle(GeomFill_TrihedronLaw)& Trihedron);
59   
60   Standard_EXPORT virtual void SetCurve (const Handle(Adaptor3d_Curve)& C) Standard_OVERRIDE;
61   
62   Standard_EXPORT virtual const Handle(Adaptor3d_Curve)& GetCurve() const Standard_OVERRIDE;
63   
64   //! Set a transformation Matrix like   the law M(t) become
65   //! Mat * M(t)
66   Standard_EXPORT virtual void SetTrsf (const gp_Mat& Transfo) Standard_OVERRIDE;
67   
68   Standard_EXPORT virtual Handle(GeomFill_LocationLaw) Copy() const Standard_OVERRIDE;
69   
70   //! compute Location and 2d points
71   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Mat& M, gp_Vec& V) Standard_OVERRIDE;
72   
73   //! compute Location and 2d points
74   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, TColgp_Array1OfPnt2d& Poles2d) Standard_OVERRIDE;
75   
76   //! compute location 2d  points and  associated
77   //! first derivatives.
78   //! Warning : It used only for C1 or C2 approximation
79   Standard_EXPORT virtual Standard_Boolean D1 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, gp_Mat& DM, gp_Vec& DV, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d) Standard_OVERRIDE;
80   
81   //! compute location 2d  points and associated
82   //! first and seconde  derivatives.
83   //! Warning : It used only for C2 approximation
84   Standard_EXPORT virtual Standard_Boolean D2 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, gp_Mat& DM, gp_Vec& DV, gp_Mat& D2M, gp_Vec& D2V, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColgp_Array1OfVec2d& D2Poles2d) Standard_OVERRIDE;
85   
86   //! Returns  the number  of  intervals for  continuity
87   //! <S>.
88   //! May be one if Continuity(me) >= <S>
89   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
90   
91   //! Stores in <T> the  parameters bounding the intervals
92   //! of continuity <S>.
93   //!
94   //! The array must provide  enough room to  accommodate
95   //! for the parameters. i.e. T.Length() > NbIntervals()
96   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
97   
98   //! Sets the bounds of the parametric interval on
99   //! the function
100   //! This determines the derivatives in these values if the
101   //! function is not Cn.
102   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last) Standard_OVERRIDE;
103   
104   //! Gets the bounds of the parametric interval on
105   //! the function
106   Standard_EXPORT virtual void GetInterval (Standard_Real& First, Standard_Real& Last) const Standard_OVERRIDE;
107   
108   //! Gets the bounds of the function parametric domain.
109   //! Warning: This domain it is  not modified by the
110   //! SetValue method
111   Standard_EXPORT virtual void GetDomain (Standard_Real& First, Standard_Real& Last) const Standard_OVERRIDE;
112   
113   //! Get the maximum Norm  of the matrix-location part.  It
114   //! is usful to find an good Tolerance to approx M(t).
115   Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
116   
117   //! Get average value of M(t) and V(t) it is usfull to
118   //! make fast approximation of rational  surfaces.
119   Standard_EXPORT virtual void GetAverageLaw (gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
120   
121   //! Say if the Location  Law, is an translation of  Location
122   //! The default implementation is " returns False ".
123   Standard_EXPORT virtual Standard_Boolean IsTranslation (Standard_Real& Error) const Standard_OVERRIDE;
124   
125   //! Say if the Location  Law, is a rotation of Location
126   //! The default implementation is " returns False ".
127   Standard_EXPORT virtual Standard_Boolean IsRotation (Standard_Real& Error) const Standard_OVERRIDE;
128   
129   Standard_EXPORT virtual void Rotation (gp_Pnt& Center) const Standard_OVERRIDE;
130
131
132
133
134   DEFINE_STANDARD_RTTIEXT(GeomFill_CurveAndTrihedron,GeomFill_LocationLaw)
135
136 protected:
137
138
139
140
141 private:
142
143
144   Standard_Boolean WithTrans;
145   Handle(GeomFill_TrihedronLaw) myLaw;
146   Handle(Adaptor3d_Curve) myCurve;
147   Handle(Adaptor3d_Curve) myTrimmed;
148   gp_Pnt Point;
149   gp_Vec V1;
150   gp_Vec V2;
151   gp_Vec V3;
152   gp_Mat Trans;
153
154
155 };
156
157
158
159
160
161
162
163 #endif // _GeomFill_CurveAndTrihedron_HeaderFile