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