0031939: Coding - correction of spelling errors in comments
[occt.git] / src / BlendFunc / BlendFunc_Ruled.hxx
1 // Created on: 1993-12-02
2 // Created by: Jacques GOUSSARD
3 // Copyright (c) 1993-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 _BlendFunc_Ruled_HeaderFile
18 #define _BlendFunc_Ruled_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <gp_Pnt.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <gp_Vec.hxx>
27 #include <gp_Vec2d.hxx>
28 #include <Standard_Real.hxx>
29 #include <Blend_Function.hxx>
30 #include <Standard_Integer.hxx>
31 #include <math_Vector.hxx>
32 #include <TColgp_Array1OfPnt.hxx>
33 #include <TColgp_Array1OfVec.hxx>
34 #include <TColStd_Array1OfReal.hxx>
35 #include <GeomAbs_Shape.hxx>
36 #include <TColStd_Array1OfInteger.hxx>
37 #include <TColgp_Array1OfPnt2d.hxx>
38 #include <TColgp_Array1OfVec2d.hxx>
39 class Adaptor3d_HSurface;
40 class Adaptor3d_HCurve;
41 class math_Matrix;
42 class gp_Pnt;
43 class gp_Vec;
44 class gp_Vec2d;
45 class Blend_Point;
46 class gp_Ax1;
47
48
49
50 class BlendFunc_Ruled  : public Blend_Function
51 {
52 public:
53
54   DEFINE_STANDARD_ALLOC
55
56   
57   Standard_EXPORT BlendFunc_Ruled(const Handle(Adaptor3d_HSurface)& S1, const Handle(Adaptor3d_HSurface)& S2, const Handle(Adaptor3d_HCurve)& C);
58   
59   //! returns the number of equations of the function.
60   Standard_EXPORT Standard_Integer NbEquations() const Standard_OVERRIDE;
61   
62   //! computes the values <F> of the Functions for the
63   //! variable <X>.
64   //! Returns True if the computation was done successfully,
65   //! False otherwise.
66   Standard_EXPORT Standard_Boolean Value (const math_Vector& X, math_Vector& F) Standard_OVERRIDE;
67   
68   //! returns the values <D> of the derivatives for the
69   //! variable <X>.
70   //! Returns True if the computation was done successfully,
71   //! False otherwise.
72   Standard_EXPORT Standard_Boolean Derivatives (const math_Vector& X, math_Matrix& D) Standard_OVERRIDE;
73   
74   //! returns the values <F> of the functions and the derivatives
75   //! <D> for the variable <X>.
76   //! Returns True if the computation was done successfully,
77   //! False otherwise.
78   Standard_EXPORT Standard_Boolean Values (const math_Vector& X, math_Vector& F, math_Matrix& D) Standard_OVERRIDE;
79   
80   Standard_EXPORT void Set (const Standard_Real Param) Standard_OVERRIDE;
81   
82   Standard_EXPORT void Set (const Standard_Real First, const Standard_Real Last) Standard_OVERRIDE;
83   
84   Standard_EXPORT void GetTolerance (math_Vector& Tolerance, const Standard_Real Tol) const Standard_OVERRIDE;
85   
86   Standard_EXPORT void GetBounds (math_Vector& InfBound, math_Vector& SupBound) const Standard_OVERRIDE;
87   
88   Standard_EXPORT Standard_Boolean IsSolution (const math_Vector& Sol, const Standard_Real Tol) Standard_OVERRIDE;
89   
90   //! Returns   the    minimal  Distance  between   two
91   //! extremities of calculated sections.
92   Standard_EXPORT Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
93   
94   Standard_EXPORT const gp_Pnt& PointOnS1() const Standard_OVERRIDE;
95   
96   Standard_EXPORT const gp_Pnt& PointOnS2() const Standard_OVERRIDE;
97   
98   Standard_EXPORT Standard_Boolean IsTangencyPoint() const Standard_OVERRIDE;
99   
100   Standard_EXPORT const gp_Vec& TangentOnS1() const Standard_OVERRIDE;
101   
102   Standard_EXPORT const gp_Vec2d& Tangent2dOnS1() const Standard_OVERRIDE;
103   
104   Standard_EXPORT const gp_Vec& TangentOnS2() const Standard_OVERRIDE;
105   
106   Standard_EXPORT const gp_Vec2d& Tangent2dOnS2() const Standard_OVERRIDE;
107   
108   //! Returns the tangent vector at the section,
109   //! at the beginning and the end of the section, and
110   //! returns the normal (of the surfaces) at
111   //! these points.
112   Standard_EXPORT void Tangent (const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2, gp_Vec& TgFirst, gp_Vec& TgLast, gp_Vec& NormFirst, gp_Vec& NormLast) const Standard_OVERRIDE;
113   
114   Standard_EXPORT Standard_Boolean GetSection (const Standard_Real Param, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2, TColgp_Array1OfPnt& tabP, TColgp_Array1OfVec& tabV);
115   
116   //! Returns False
117   Standard_EXPORT Standard_Boolean IsRational() const Standard_OVERRIDE;
118   
119   //! Returns the length of the maximum section
120   Standard_EXPORT Standard_Real GetSectionSize() const Standard_OVERRIDE;
121   
122   //! Compute the minimal value of weight for each poles
123   //! of all sections.
124   Standard_EXPORT void GetMinimalWeight (TColStd_Array1OfReal& Weigths) const Standard_OVERRIDE;
125   
126   //! Returns  the number  of  intervals for  continuity
127   //! <S>. May be one if Continuity(me) >= <S>
128   Standard_EXPORT Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE;
129   
130   //! Stores in <T> the  parameters bounding the intervals
131   //! of continuity <S>.
132   //!
133   //! The array must provide  enough room to  accommodate
134   //! for the parameters. i.e. T.Length() > NbIntervals()
135   //! raises
136   //! OutOfRange from Standard
137   Standard_EXPORT void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE;
138   
139   Standard_EXPORT void GetShape (Standard_Integer& NbPoles, Standard_Integer& NbKnots, Standard_Integer& Degree, Standard_Integer& NbPoles2d) Standard_OVERRIDE;
140   
141   //! Returns the tolerance to reach in approximation
142   //! to respecte
143   //! BoundTol error at the Boundary
144   //! AngleTol tangent error at the Boundary
145   //! SurfTol error inside the surface.
146   Standard_EXPORT void GetTolerance (const Standard_Real BoundTol, const Standard_Real SurfTol, const Standard_Real AngleTol, math_Vector& Tol3d, math_Vector& Tol1D) const Standard_OVERRIDE;
147   
148   Standard_EXPORT void Knots (TColStd_Array1OfReal& TKnots) Standard_OVERRIDE;
149   
150   Standard_EXPORT void Mults (TColStd_Array1OfInteger& TMults) Standard_OVERRIDE;
151   
152   //! Used for the first and last section
153   Standard_EXPORT Standard_Boolean Section (const Blend_Point& P, 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;
154   
155   //! Used for the first and last section
156   Standard_EXPORT Standard_Boolean Section (const Blend_Point& P, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE;
157   
158   Standard_EXPORT void Section (const Blend_Point& P, TColgp_Array1OfPnt& Poles, TColgp_Array1OfPnt2d& Poles2d, TColStd_Array1OfReal& Weigths) Standard_OVERRIDE;
159   
160   Standard_EXPORT gp_Ax1 AxeRot (const Standard_Real Prm);
161   
162   Standard_EXPORT void Resolution (const Standard_Integer IC2d, const Standard_Real Tol, Standard_Real& TolU, Standard_Real& TolV) const Standard_OVERRIDE;
163
164
165
166
167 protected:
168
169
170
171
172
173 private:
174
175
176
177   Handle(Adaptor3d_HSurface) surf1;
178   Handle(Adaptor3d_HSurface) surf2;
179   Handle(Adaptor3d_HCurve) curv;
180   gp_Pnt pts1;
181   gp_Pnt pts2;
182   Standard_Boolean istangent;
183   gp_Vec tg1;
184   gp_Vec2d tg12d;
185   gp_Vec tg2;
186   gp_Vec2d tg22d;
187   gp_Pnt ptgui;
188   gp_Vec d1gui;
189   gp_Vec d2gui;
190   gp_Vec nplan;
191   Standard_Real normtg;
192   Standard_Real theD;
193   Standard_Real distmin;
194
195
196 };
197
198
199
200
201
202
203
204 #endif // _BlendFunc_Ruled_HeaderFile