0031939: Coding - correction of spelling errors in comments [part 3]
[occt.git] / src / GeomFill / GeomFill_NSections.hxx
1 // Created on: 1998-12-14
2 // Created by: Joelle CHAUVET
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_NSections_HeaderFile
18 #define _GeomFill_NSections_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Real.hxx>
24 #include <TColGeom_SequenceOfCurve.hxx>
25 #include <GeomFill_SequenceOfTrsf.hxx>
26 #include <TColStd_SequenceOfReal.hxx>
27 #include <GeomFill_SectionLaw.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <TColgp_Array1OfPnt.hxx>
30 #include <TColStd_Array1OfReal.hxx>
31 #include <TColgp_Array1OfVec.hxx>
32 #include <Standard_Integer.hxx>
33 #include <TColStd_Array1OfInteger.hxx>
34 #include <GeomAbs_Shape.hxx>
35 class Geom_BSplineSurface;
36 class Standard_OutOfRange;
37 class gp_Pnt;
38 class Geom_Curve;
39
40
41 class GeomFill_NSections;
42 DEFINE_STANDARD_HANDLE(GeomFill_NSections, GeomFill_SectionLaw)
43
44 //! Define a Section Law by N Sections
45 class GeomFill_NSections : public GeomFill_SectionLaw
46 {
47
48 public:
49
50   
51   //! Make a SectionLaw with N Curves.
52   Standard_EXPORT GeomFill_NSections(const TColGeom_SequenceOfCurve& NC);
53   
54   //! Make a SectionLaw with N Curves and N associated parameters.
55   Standard_EXPORT GeomFill_NSections(const TColGeom_SequenceOfCurve& NC, const TColStd_SequenceOfReal& NP);
56   
57   //! Make a SectionLaw with N Curves and N associated parameters.
58   //! UF and UL are the parametric bounds of the NSections
59   Standard_EXPORT GeomFill_NSections(const TColGeom_SequenceOfCurve& NC, const TColStd_SequenceOfReal& NP, const Standard_Real UF, const Standard_Real UL);
60   
61   //! Make a SectionLaw with N Curves and N associated parameters.
62   //! UF and UL are the parametric bounds of the NSections
63   //! VF and VL are the parametric bounds of the path
64   Standard_EXPORT GeomFill_NSections(const TColGeom_SequenceOfCurve& NC, const TColStd_SequenceOfReal& NP, const Standard_Real UF, const Standard_Real UL, const Standard_Real VF, const Standard_Real VL);
65   
66   //! Make a SectionLaw with N Curves and N associated parameters.
67   //! UF and UL are the parametric bounds of the NSections
68   //! VF and VL are the parametric bounds of the path
69   //! UF and UL are the parametric bounds of the NSections
70   //! Surf is a reference surface used by BRepFill_NSections
71   Standard_EXPORT GeomFill_NSections(const TColGeom_SequenceOfCurve& NC, const GeomFill_SequenceOfTrsf& Trsfs, const TColStd_SequenceOfReal& NP, const Standard_Real UF, const Standard_Real UL, const Standard_Real VF, const Standard_Real VL, const Handle(Geom_BSplineSurface)& Surf);
72   
73   //! compute the section for v = param
74   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, TColgp_Array1OfPnt& Poles, TColStd_Array1OfReal& Weigths) Standard_OVERRIDE;
75   
76   //! compute the first  derivative in v direction  of the
77   //! section for v =  param
78   //! Warning : It used only for C1 or C2 approximation
79   Standard_EXPORT virtual Standard_Boolean D1 (const Standard_Real Param, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE;
80   
81   //! compute the second derivative  in v direction of the
82   //! section  for v = param
83   //! Warning : It used only for C2 approximation
84   Standard_EXPORT virtual Standard_Boolean D2 (const Standard_Real Param, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColgp_Array1OfVec& D2Poles, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths, TColStd_Array1OfReal& D2Weigths) Standard_OVERRIDE;
85   
86   //! Sets the reference surface
87   Standard_EXPORT void SetSurface (const Handle(Geom_BSplineSurface)& RefSurf);
88   
89   //! Computes the surface
90   Standard_EXPORT void ComputeSurface();
91   
92   //! give if possible an bspline Surface, like iso-v are the
93   //! section.  If it is  not possible  this methode have  to
94   //! get an Null Surface.  Is it the default implementation.
95   Standard_EXPORT virtual Handle(Geom_BSplineSurface) BSplineSurface() const Standard_OVERRIDE;
96   
97   //! get the format of an  section
98   Standard_EXPORT virtual void SectionShape (Standard_Integer& NbPoles, Standard_Integer& NbKnots, Standard_Integer& Degree) const Standard_OVERRIDE;
99   
100   //! get the Knots of the section
101   Standard_EXPORT virtual void Knots (TColStd_Array1OfReal& TKnots) const Standard_OVERRIDE;
102   
103   //! get the Multplicities of the section
104   Standard_EXPORT virtual void Mults (TColStd_Array1OfInteger& TMults) const Standard_OVERRIDE;
105   
106   //! Returns if the sections are rationnal or not
107   Standard_EXPORT virtual Standard_Boolean IsRational() const Standard_OVERRIDE;
108   
109   //! Returns if the sections are periodic or not
110   Standard_EXPORT virtual Standard_Boolean IsUPeriodic() const Standard_OVERRIDE;
111   
112   //! Returns if the law  isperiodic or not
113   Standard_EXPORT virtual Standard_Boolean IsVPeriodic() const Standard_OVERRIDE;
114   
115   //! Returns  the number  of  intervals for  continuity
116   //! <S>.
117   //! May be one if Continuity(me) >= <S>
118   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
119   
120   //! Stores in <T> the  parameters bounding the intervals
121   //! of continuity <S>.
122   //!
123   //! The array must provide  enough room to  accommodate
124   //! for the parameters. i.e. T.Length() > NbIntervals()
125   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
126   
127   //! Sets the bounds of the parametric interval on
128   //! the function
129   //! This determines the derivatives in these values if the
130   //! function is not Cn.
131   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last) Standard_OVERRIDE;
132   
133   //! Gets the bounds of the parametric interval on
134   //! the function
135   Standard_EXPORT virtual void GetInterval (Standard_Real& First, Standard_Real& Last) const Standard_OVERRIDE;
136   
137   //! Gets the bounds of the function parametric domain.
138   //! Warning: This domain it is  not modified by the
139   //! SetValue method
140   Standard_EXPORT virtual void GetDomain (Standard_Real& First, Standard_Real& Last) const Standard_OVERRIDE;
141   
142   //! Returns the tolerances associated at each poles to
143   //! reach  in approximation, to satisfy: BoundTol error
144   //! at the   Boundary  AngleTol tangent error  at  the
145   //! Boundary  (in radian)  SurfTol   error inside the
146   //! surface.
147   Standard_EXPORT virtual void GetTolerance (const Standard_Real BoundTol, const Standard_Real SurfTol, const Standard_Real AngleTol, TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
148   
149   //! Get the barycentre of Surface.
150   //! An   very  poor estimation is sufficient.
151   //! This information is useful to perform well
152   //! conditioned rational approximation.
153   //! Warning: Used only if <me> IsRational
154   Standard_EXPORT virtual gp_Pnt BarycentreOfSurf() const Standard_OVERRIDE;
155   
156   //! Returns the   length of the greater section. This
157   //! information is useful to G1's control.
158   //! Warning: With an little value, approximation can be slower.
159   Standard_EXPORT virtual Standard_Real MaximalSection() const Standard_OVERRIDE;
160   
161   //! Compute the minimal value of weight for each poles
162   //! in all  sections.
163   //! This information is  useful to control error
164   //! in rational approximation.
165   //! Warning: Used only if <me> IsRational
166   Standard_EXPORT virtual void GetMinimalWeight (TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
167   
168   //! return True If the Law isConstant
169   Standard_EXPORT virtual Standard_Boolean IsConstant (Standard_Real& Error) const Standard_OVERRIDE;
170   
171   //! Return the constant Section if <me>  IsConstant.
172   Standard_EXPORT virtual Handle(Geom_Curve) ConstantSection() const Standard_OVERRIDE;
173   
174   //! Returns True if all section  are circle, with same
175   //! plane,same center and  linear  radius  evolution
176   //! Return False by Default.
177   Standard_EXPORT virtual Standard_Boolean IsConicalLaw (Standard_Real& Error) const Standard_OVERRIDE;
178   
179   //! Return the circle section  at parameter <Param>, if
180   //! <me> a  IsConicalLaw
181   Standard_EXPORT virtual Handle(Geom_Curve) CirclSection (const Standard_Real Param) const Standard_OVERRIDE;
182
183
184
185
186   DEFINE_STANDARD_RTTIEXT(GeomFill_NSections,GeomFill_SectionLaw)
187
188 protected:
189
190
191
192
193 private:
194
195
196   Standard_Real UFirst;
197   Standard_Real ULast;
198   Standard_Real VFirst;
199   Standard_Real VLast;
200   TColGeom_SequenceOfCurve mySections;
201   GeomFill_SequenceOfTrsf myTrsfs;
202   TColStd_SequenceOfReal myParams;
203   Handle(Geom_BSplineSurface) mySurface;
204   Handle(Geom_BSplineSurface) myRefSurf;
205
206
207 };
208
209
210
211
212
213
214
215 #endif // _GeomFill_NSections_HeaderFile