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