0031939: Coding - correction of spelling errors in comments
[occt.git] / src / BRepBlend / BRepBlend_AppFuncRoot.hxx
1 // Created on: 1998-05-12
2 // Created by: Philippe NOUAILLE
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 _BRepBlend_AppFuncRoot_HeaderFile
18 #define _BRepBlend_AppFuncRoot_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Address.hxx>
24 #include <math_Vector.hxx>
25 #include <Blend_Point.hxx>
26 #include <gp_Pnt.hxx>
27 #include <Approx_SweepFunction.hxx>
28 #include <Standard_Real.hxx>
29 #include <Standard_Boolean.hxx>
30 #include <TColgp_Array1OfPnt.hxx>
31 #include <TColgp_Array1OfPnt2d.hxx>
32 #include <TColStd_Array1OfReal.hxx>
33 #include <TColgp_Array1OfVec.hxx>
34 #include <TColgp_Array1OfVec2d.hxx>
35 #include <Standard_Integer.hxx>
36 #include <TColStd_Array1OfInteger.hxx>
37 #include <GeomAbs_Shape.hxx>
38 class BRepBlend_Line;
39 class Standard_OutOfRange;
40 class Blend_AppFunction;
41 class gp_Pnt;
42 class Blend_Point;
43
44
45 class BRepBlend_AppFuncRoot;
46 DEFINE_STANDARD_HANDLE(BRepBlend_AppFuncRoot, Approx_SweepFunction)
47
48 //! Function to approximate by AppSurface
49 class BRepBlend_AppFuncRoot : public Approx_SweepFunction
50 {
51
52 public:
53
54   
55   //! compute the section for v = param
56   Standard_EXPORT virtual Standard_Boolean D0 (const Standard_Real Param, const Standard_Real First, const Standard_Real Last, TColgp_Array1OfPnt& Poles, TColgp_Array1OfPnt2d& Poles2d, TColStd_Array1OfReal& Weigths) Standard_OVERRIDE;
57   
58   //! compute the first  derivative in v direction  of the
59   //! section for v =  param
60   Standard_EXPORT virtual Standard_Boolean D1 (const Standard_Real Param, const Standard_Real First, const Standard_Real Last, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE;
61   
62   //! compute the second derivative  in v direction of the
63   //! section  for v = param
64   Standard_EXPORT virtual Standard_Boolean D2 (const Standard_Real Param, const Standard_Real First, const Standard_Real Last, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColgp_Array1OfVec& D2Poles, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColgp_Array1OfVec2d& D2Poles2d, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths, TColStd_Array1OfReal& D2Weigths) Standard_OVERRIDE;
65   
66   //! get the number of 2d curves to  approximate.
67   Standard_EXPORT virtual Standard_Integer Nb2dCurves() const Standard_OVERRIDE;
68   
69   //! get the format of an  section
70   Standard_EXPORT virtual void SectionShape (Standard_Integer& NbPoles, Standard_Integer& NbKnots, Standard_Integer& Degree) const Standard_OVERRIDE;
71   
72   //! get the Knots of the section
73   Standard_EXPORT virtual void Knots (TColStd_Array1OfReal& TKnots) const Standard_OVERRIDE;
74   
75   //! get the Multplicities of the section
76   Standard_EXPORT virtual void Mults (TColStd_Array1OfInteger& TMults) const Standard_OVERRIDE;
77   
78   //! Returns if the section is rationnal or not
79   Standard_EXPORT virtual Standard_Boolean IsRational() const Standard_OVERRIDE;
80   
81   //! Returns  the number  of  intervals for  continuity
82   //! <S>. May be one if Continuity(me) >= <S>
83   Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
84   
85   //! Stores in <T> the  parameters bounding the intervals
86   //! of continuity <S>.
87   //!
88   //! The array must provide  enough room to  accommodate
89   //! for the parameters. i.e. T.Length() > NbIntervals()
90   Standard_EXPORT virtual void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
91   
92   //! Sets the bounds of the parametric interval on
93   //! the fonction
94   //! This determines the derivatives in these values if the
95   //! function is not Cn.
96   Standard_EXPORT virtual void SetInterval (const Standard_Real First, const Standard_Real Last) Standard_OVERRIDE;
97   
98   //! Returns the resolutions in the  sub-space 2d <Index> --
99   //! This information is usfull to find an good tolerance in
100   //! 2d approximation
101   Standard_EXPORT virtual void Resolution (const Standard_Integer Index, const Standard_Real Tol, Standard_Real& TolU, Standard_Real& TolV) const Standard_OVERRIDE;
102   
103   //! Returns the tolerance to reach in approximation
104   //! to respecte
105   //! BoundTol error at the Boundary
106   //! AngleTol tangent error at the Boundary (in radian)
107   //! SurfTol error inside the surface.
108   Standard_EXPORT virtual void GetTolerance (const Standard_Real BoundTol, const Standard_Real SurfTol, const Standard_Real AngleTol, TColStd_Array1OfReal& Tol3d) const Standard_OVERRIDE;
109   
110   //! Is usfull, if (me) have to  be run numerical
111   //! algorithme to perform D0, D1 or D2
112   Standard_EXPORT virtual void SetTolerance (const Standard_Real Tol3d, const Standard_Real Tol2d) Standard_OVERRIDE;
113   
114   //! Get    the   barycentre of   Surface.   An   very  poor
115   //! estimation is sufficent. This information is usefull
116   //! to perform well conditioned rational approximation.
117   Standard_EXPORT virtual gp_Pnt BarycentreOfSurf() const Standard_OVERRIDE;
118   
119   //! Returns the   length of the maximum section. This
120   //! information is usefull to perform well conditioned rational
121   //! approximation.
122   Standard_EXPORT virtual Standard_Real MaximalSection() const Standard_OVERRIDE;
123   
124   //! Compute the minimal value of weight for each poles
125   //! of all  sections.  This information is  usefull to
126   //! perform well conditioned rational approximation.
127   Standard_EXPORT virtual void GetMinimalWeight (TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
128   
129   Standard_EXPORT virtual void Point (const Blend_AppFunction& Func, const Standard_Real Param, const math_Vector& Sol, Blend_Point& Pnt) const = 0;
130   
131   Standard_EXPORT virtual void Vec (math_Vector& Sol, const Blend_Point& Pnt) const = 0;
132
133
134
135
136   DEFINE_STANDARD_RTTIEXT(BRepBlend_AppFuncRoot,Approx_SweepFunction)
137
138 protected:
139
140   
141   Standard_EXPORT BRepBlend_AppFuncRoot(Handle(BRepBlend_Line)& Line, Blend_AppFunction& Func, const Standard_Real Tol3d, const Standard_Real Tol2d);
142
143
144
145 private:
146
147   
148   Standard_EXPORT Standard_Boolean SearchPoint (Blend_AppFunction& Func, const Standard_Real Param, Blend_Point& Pnt);
149   
150   Standard_EXPORT Standard_Boolean SearchLocation (const Standard_Real Param, const Standard_Integer FirstIndex, const Standard_Integer LastIndex, Standard_Integer& ParamIndex) const;
151
152   Handle(BRepBlend_Line) myLine;
153   Standard_Address myFunc;
154   math_Vector myTolerance;
155   Blend_Point myPnt;
156   gp_Pnt myBary;
157   math_Vector X1;
158   math_Vector X2;
159   math_Vector XInit;
160   math_Vector Sol;
161
162
163 };
164
165
166
167
168
169
170
171 #endif // _BRepBlend_AppFuncRoot_HeaderFile