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