0028966: Coding Rules - remove Adaptor2d_HCurve2d, Adaptor3d_HCurve and Adaptor3d_HSu...
[occt.git] / src / BRepBlend / BRepBlend_SurfCurvEvolRadInv.hxx
1 // Created on: 1997-07-29
2 // Created by: Jerome LEMONIER
3 // Copyright (c) 1997-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_SurfCurvEvolRadInv_HeaderFile
18 #define _BRepBlend_SurfCurvEvolRadInv_HeaderFile
19
20 #include <Adaptor3d_Surface.hxx>
21 #include <Blend_SurfCurvFuncInv.hxx>
22 #include <math_Vector.hxx>
23
24 class Law_Function;
25 class math_Matrix;
26
27
28 //! Function of reframing between a surface restriction
29 //! of the surface and a curve.
30 //! Class     used   to   compute  a    solution   of  the
31 //! surfRstConstRad  problem  on a done restriction of the
32 //! surface.
33 //! The vector  <X> used in  Value, Values and Derivatives
34 //! methods  has   to  be the   vector  of  the parametric
35 //! coordinates  wguide, wcurv, wrst  where  wguide is the
36 //! parameter on the guide line, wcurv is the parameter on
37 //! the curve, wrst is the parameter on the restriction on
38 //! the surface.
39 class BRepBlend_SurfCurvEvolRadInv  : public Blend_SurfCurvFuncInv
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   
46   Standard_EXPORT BRepBlend_SurfCurvEvolRadInv(const Handle(Adaptor3d_Surface)& S, const Handle(Adaptor3d_Curve)& C, const Handle(Adaptor3d_Curve)& Cg, const Handle(Law_Function)& Evol);
47   
48   Standard_EXPORT void Set (const Standard_Integer Choix);
49   
50   //! returns 3.
51   Standard_EXPORT Standard_Integer NbEquations() const;
52   
53   //! computes the values <F> of the Functions for the
54   //! variable <X>.
55   //! Returns True if the computation was done successfully,
56   //! False otherwise.
57   Standard_EXPORT Standard_Boolean Value (const math_Vector& X, math_Vector& F);
58   
59   //! returns the values <D> of the derivatives for the
60   //! variable <X>.
61   //! Returns True if the computation was done successfully,
62   //! False otherwise.
63   Standard_EXPORT Standard_Boolean Derivatives (const math_Vector& X, math_Matrix& D);
64   
65   //! returns the values <F> of the functions and the derivatives
66   //! <D> for the variable <X>.
67   //! Returns True if the computation was done successfully,
68   //! False otherwise.
69   Standard_EXPORT Standard_Boolean Values (const math_Vector& X, math_Vector& F, math_Matrix& D);
70   
71   //! Set the restriction on which a solution has to be found.
72   Standard_EXPORT void Set (const Handle(Adaptor2d_Curve2d)& Rst);
73   
74   //! Returns in the vector Tolerance the parametric tolerance
75   //! for each of the 3 variables;
76   //! Tol is the tolerance used in 3d space.
77   Standard_EXPORT void GetTolerance (math_Vector& Tolerance, const Standard_Real Tol) const;
78   
79   //! Returns in the vector InfBound the lowest values allowed
80   //! for each of the 3 variables.
81   //! Returns in the vector SupBound the greatest values allowed
82   //! for each of the 3 variables.
83   Standard_EXPORT void GetBounds (math_Vector& InfBound, math_Vector& SupBound) const;
84   
85   //! Returns Standard_True if Sol is a zero of the function.
86   //! Tol is the tolerance used in 3d space.
87   Standard_EXPORT Standard_Boolean IsSolution (const math_Vector& Sol, const Standard_Real Tol);
88
89
90
91
92 protected:
93
94
95
96
97
98 private:
99
100
101
102   Handle(Adaptor3d_Surface) surf;
103   Handle(Adaptor3d_Curve) curv;
104   Handle(Adaptor3d_Curve) guide;
105   Handle(Adaptor2d_Curve2d) rst;
106   Standard_Real ray;
107   Standard_Integer choix;
108   Handle(Law_Function) tevol;
109   Standard_Real sg1;
110
111
112 };
113
114
115
116
117
118
119
120 #endif // _BRepBlend_SurfCurvEvolRadInv_HeaderFile