0031939: Coding - correction of spelling errors in comments
[occt.git] / src / GeomFill / GeomFill_LocationDraft.hxx
1 // Created on: 1998-04-21
2 // Created by: Stephanie HUMEAU
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_LocationDraft_HeaderFile
18 #define _GeomFill_LocationDraft_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <gp_Mat.hxx>
24 #include <gp_Dir.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 #include <TColgp_HArray1OfPnt2d.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <GeomFill_LocationLaw.hxx>
30 #include <TColgp_Array1OfPnt2d.hxx>
31 #include <TColgp_Array1OfVec2d.hxx>
32 #include <GeomAbs_Shape.hxx>
33 #include <TColStd_Array1OfReal.hxx>
34 class GeomFill_DraftTrihedron;
35 class Adaptor3d_HSurface;
36 class Adaptor3d_HCurve;
37 class Standard_NotImplemented;
38 class Standard_OutOfRange;
39 class gp_Dir;
40 class gp_Mat;
41 class GeomFill_LocationLaw;
42 class gp_Vec;
43 class gp_Pnt;
44
45
46 class GeomFill_LocationDraft;
47 DEFINE_STANDARD_HANDLE(GeomFill_LocationDraft, GeomFill_LocationLaw)
48
49
50 class GeomFill_LocationDraft : public GeomFill_LocationLaw
51 {
52
53 public:
54
55   
56   Standard_EXPORT GeomFill_LocationDraft(const gp_Dir& Direction, const Standard_Real Angle);
57   
58   Standard_EXPORT void SetStopSurf (const Handle(Adaptor3d_HSurface)& Surf);
59   
60   Standard_EXPORT void SetAngle (const Standard_Real Angle);
61   
62   Standard_EXPORT virtual void SetCurve (const Handle(Adaptor3d_HCurve)& C) Standard_OVERRIDE;
63   
64   Standard_EXPORT virtual const Handle(Adaptor3d_HCurve)& GetCurve() const Standard_OVERRIDE;
65   
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
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 aproximation
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 aproximation
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   //! Say if the first restriction is defined in this class.
87   //! If it  is true the  first element  of poles array   in
88   //! D0,D1,D2... Correspond to this restriction.
89   //! Returns Standard_False (default implementation)
90   Standard_EXPORT virtual Standard_Boolean HasFirstRestriction() const Standard_OVERRIDE;
91   
92   //! Say if the last restriction is defined in this class.
93   //! If it is  true the  last element  of poles array in
94   //! D0,D1,D2... Correspond to this restriction.
95   //! Returns Standard_False (default implementation)
96   Standard_EXPORT virtual Standard_Boolean HasLastRestriction() const Standard_OVERRIDE;
97   
98   //! Give the number of trace (Curves 2d which are not restriction)
99   //! Returns 1 (default implementation)
100   Standard_EXPORT virtual Standard_Integer TraceNumber() const Standard_OVERRIDE;
101   
102   //! Returns  the number  of  intervals for  continuity
103   //! <S>.
104   //! May be one if Continuity(me) >= <S>
105   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
106   
107   //! Stores in <T> the  parameters bounding the intervals
108   //! of continuity <S>.
109   //!
110   //! The array must provide  enough room to  accommodate
111   //! for the parameters. i.e. T.Length() > NbIntervals()
112   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
113   
114   //! Sets the bounds of the parametric interval on
115   //! the function
116   //! This determines the derivatives in these values if the
117   //! function is not Cn.
118   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last) Standard_OVERRIDE;
119   
120   //! Gets the bounds of the parametric interval on
121   //! the function
122   Standard_EXPORT virtual void GetInterval (Standard_Real& First, Standard_Real& Last) const Standard_OVERRIDE;
123   
124   //! Gets the bounds of the function parametric domain.
125   //! Warning: This domain it is  not modified by the
126   //! SetValue method
127   Standard_EXPORT virtual void GetDomain (Standard_Real& First, Standard_Real& Last) const Standard_OVERRIDE;
128   
129   //! Returns the resolutions in the  sub-space 2d <Index>
130   //! This information is usfull to find an good tolerance in
131   //! 2d approximation.
132   //! Warning: Used only if Nb2dCurve > 0
133   Standard_EXPORT virtual void Resolution (const Standard_Integer Index, const Standard_Real Tol, Standard_Real& TolU, Standard_Real& TolV) const Standard_OVERRIDE;
134   
135   //! Get the maximum Norm  of the matrix-location part.  It
136   //! is usful to find an good Tolerance to approx M(t).
137   Standard_EXPORT virtual Standard_Real GetMaximalNorm() Standard_OVERRIDE;
138   
139   //! Get average value of M(t) and V(t) it is usfull to
140   //! make fast approximation of rational  surfaces.
141   Standard_EXPORT virtual void GetAverageLaw (gp_Mat& AM, gp_Vec& AV) Standard_OVERRIDE;
142   
143   //! Say if the Location  Law, is an translation of  Location
144   //! The default implementation is " returns False ".
145   Standard_EXPORT virtual Standard_Boolean IsTranslation (Standard_Real& Error) const Standard_OVERRIDE;
146   
147   //! Say if the Location  Law, is a rotation of Location
148   //! The default implementation is " returns False ".
149   Standard_EXPORT virtual Standard_Boolean IsRotation (Standard_Real& Error) const Standard_OVERRIDE;
150   
151   Standard_EXPORT virtual void Rotation (gp_Pnt& Center) const Standard_OVERRIDE;
152   
153   //! Say if the generatrice interset the surface
154   Standard_EXPORT Standard_Boolean IsIntersec() const;
155   
156   Standard_EXPORT gp_Dir Direction() const;
157
158
159
160
161   DEFINE_STANDARD_RTTIEXT(GeomFill_LocationDraft,GeomFill_LocationLaw)
162
163 protected:
164
165
166   Handle(TColgp_HArray1OfPnt2d) myPoles2d;
167
168
169 private:
170
171   
172   Standard_EXPORT void Prepare();
173
174   gp_Mat Trans;
175   Handle(GeomFill_DraftTrihedron) myLaw;
176   Handle(Adaptor3d_HSurface) mySurf;
177   Handle(Adaptor3d_HCurve) myCurve;
178   Handle(Adaptor3d_HCurve) myTrimmed;
179   gp_Dir myDir;
180   Standard_Real myAngle;
181   Standard_Integer myNbPts;
182   Standard_Boolean Intersec;
183   Standard_Boolean WithTrans;
184
185
186 };
187
188
189
190
191
192
193
194 #endif // _GeomFill_LocationDraft_HeaderFile