0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / GeomFill / GeomFill_LocationLaw.hxx
1 // Created on: 1997-11-20
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_LocationLaw_HeaderFile
18 #define _GeomFill_LocationLaw_HeaderFile
19
20 #include <Adaptor3d_Curve.hxx>
21 #include <GeomAbs_Shape.hxx>
22 #include <GeomFill_PipeError.hxx>
23 #include <TColgp_Array1OfPnt2d.hxx>
24 #include <TColgp_Array1OfVec2d.hxx>
25 #include <TColStd_Array1OfReal.hxx>
26
27 class Standard_NotImplemented;
28 class Standard_OutOfRange;
29 class gp_Mat;
30 class gp_Vec;
31 class gp_Pnt;
32
33 class GeomFill_LocationLaw;
34 DEFINE_STANDARD_HANDLE(GeomFill_LocationLaw, Standard_Transient)
35
36 //! To define location  law in Sweeping location is --
37 //! defined   by an  Matrix  M and  an Vector  V,  and
38 //! transform an point P in MP+V.
39 class GeomFill_LocationLaw : public Standard_Transient
40 {
41
42 public:
43
44   
45   Standard_EXPORT virtual void SetCurve (const Handle(Adaptor3d_Curve)& C) = 0;
46   
47   Standard_EXPORT virtual const Handle(Adaptor3d_Curve)& GetCurve() const = 0;
48   
49   //! Set a transformation Matrix like   the law M(t) become
50   //! Mat * M(t)
51   Standard_EXPORT virtual void SetTrsf (const gp_Mat& Transfo) = 0;
52   
53   Standard_EXPORT virtual Handle(GeomFill_LocationLaw) Copy() const = 0;
54   
55   //! compute Location
56   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Mat& M, gp_Vec& V) = 0;
57   
58   //! compute Location and 2d points
59   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, gp_Mat& M, gp_Vec& V, TColgp_Array1OfPnt2d& Poles2d) = 0;
60   
61   //! compute location 2d  points and  associated
62   //! first derivatives.
63   //! Warning : It used only for C1 or C2 approximation
64   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);
65   
66   //! compute location 2d  points and associated
67   //! first and seconde  derivatives.
68   //! Warning : It used only for C2 approximation
69   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);
70   
71   //! get the number of  2d  curves (Restrictions  +  Traces)
72   //! to approximate.
73   Standard_EXPORT Standard_Integer Nb2dCurves() const;
74   
75   //! Say if the first restriction is defined in this class.
76   //! If it  is true the  first element  of poles array   in
77   //! D0,D1,D2... Correspond to this restriction.
78   //! Returns Standard_False (default implementation)
79   Standard_EXPORT virtual Standard_Boolean HasFirstRestriction() const;
80   
81   //! Say if the last restriction is defined in this class.
82   //! If it is  true the  last element  of poles array in
83   //! D0,D1,D2... Correspond to this restriction.
84   //! Returns Standard_False (default implementation)
85   Standard_EXPORT virtual Standard_Boolean HasLastRestriction() const;
86   
87   //! Give the number of trace (Curves 2d which are not restriction)
88   //! Returns 0 (default implementation)
89   Standard_EXPORT virtual Standard_Integer TraceNumber() const;
90   
91   //! Give a status to the Law
92   //! Returns PipeOk (default implementation)
93   Standard_EXPORT virtual GeomFill_PipeError ErrorStatus() const;
94   
95   //! Returns  the number  of  intervals for  continuity
96   //! <S>.
97   //! May be one if Continuity(me) >= <S>
98   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const = 0;
99   
100   //! Stores in <T> the  parameters bounding the intervals
101   //! of continuity <S>.
102   //!
103   //! The array must provide  enough room to  accommodate
104   //! for the parameters. i.e. T.Length() > NbIntervals()
105   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
106   
107   //! Sets the bounds of the parametric interval on
108   //! the function
109   //! This determines the derivatives in these values if the
110   //! function is not Cn.
111   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last) = 0;
112   
113   //! Gets the bounds of the parametric interval on
114   //! the function
115   Standard_EXPORT virtual void GetInterval (Standard_Real& First, Standard_Real& Last) const = 0;
116   
117   //! Gets the bounds of the function parametric domain.
118   //! Warning: This domain it is  not modified by the
119   //! SetValue method
120   Standard_EXPORT virtual void GetDomain (Standard_Real& First, Standard_Real& Last) const = 0;
121   
122   //! Returns the resolutions in the  sub-space 2d <Index>
123   //! This information is usfull to find an good tolerance in
124   //! 2d approximation.
125   Standard_EXPORT virtual void Resolution (const Standard_Integer Index, const Standard_Real Tol, Standard_Real& TolU, Standard_Real& TolV) const;
126   
127   //! Is useful, if (me) have to run numerical
128   //! algorithm to perform D0, D1 or D2
129   //! The default implementation make nothing.
130   Standard_EXPORT virtual void SetTolerance (const Standard_Real Tol3d, const Standard_Real Tol2d);
131   
132   //! Get the maximum Norm  of the matrix-location part.  It
133   //! is usful to find an good Tolerance to approx M(t).
134   Standard_EXPORT virtual Standard_Real GetMaximalNorm() = 0;
135   
136   //! Get average value of M(t) and V(t) it is usfull to
137   //! make fast approximation of rational surfaces.
138   Standard_EXPORT virtual void GetAverageLaw (gp_Mat& AM, gp_Vec& AV) = 0;
139   
140   //! Say if the Location  Law, is an translation of  Location
141   //! The default implementation is " returns False ".
142   Standard_EXPORT virtual Standard_Boolean IsTranslation (Standard_Real& Error) const;
143   
144   //! Say if the Location  Law, is a rotation of Location
145   //! The default implementation is " returns False ".
146   Standard_EXPORT virtual Standard_Boolean IsRotation (Standard_Real& Error) const;
147   
148   Standard_EXPORT virtual void Rotation (gp_Pnt& Center) const;
149
150
151
152
153   DEFINE_STANDARD_RTTIEXT(GeomFill_LocationLaw,Standard_Transient)
154
155 protected:
156
157
158
159
160 private:
161
162
163
164
165 };
166
167
168
169
170
171
172
173 #endif // _GeomFill_LocationLaw_HeaderFile