0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BRepBlend / BRepBlend_CurvPointRadInv.hxx
1 // Created on: 1997-02-12
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_CurvPointRadInv_HeaderFile
18 #define _BRepBlend_CurvPointRadInv_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_Integer.hxx>
26 #include <Blend_CurvPointFuncInv.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <math_Vector.hxx>
29 #include <Standard_Real.hxx>
30 class Adaptor3d_HCurve;
31 class math_Matrix;
32 class gp_Pnt;
33
34
35 //! Function of reframing between a point and a curve.
36 //! valid in cases of constant and progressive radius.
37 //! This function  is used  to find a  solution on  a done
38 //! point   of   the curve 1 when   using  RstRstConsRad or
39 //! CSConstRad...
40 //! The vector <X>  used in Value, Values and  Derivatives
41 //! methods  has  to   be the  vector   of the  parametric
42 //! coordinates w, U where w is  the parameter  on the
43 //! guide line, U   are the parametric coordinates of  a
44 //! point on the partner curve 2.
45 class BRepBlend_CurvPointRadInv  : public Blend_CurvPointFuncInv
46 {
47 public:
48
49   DEFINE_STANDARD_ALLOC
50
51   
52   Standard_EXPORT BRepBlend_CurvPointRadInv(const Handle(Adaptor3d_HCurve)& C1, const Handle(Adaptor3d_HCurve)& C2);
53   
54   Standard_EXPORT void Set (const Standard_Integer Choix);
55   
56   //! returns 2.
57   Standard_EXPORT Standard_Integer NbEquations() const;
58   
59   //! computes the values <F> of the Functions for the
60   //! variable <X>.
61   //! Returns True if the computation was done successfully,
62   //! False otherwise.
63   Standard_EXPORT Standard_Boolean Value (const math_Vector& X, math_Vector& F);
64   
65   //! returns the values <D> of the derivatives for the
66   //! variable <X>.
67   //! Returns True if the computation was done successfully,
68   //! False otherwise.
69   Standard_EXPORT Standard_Boolean Derivatives (const math_Vector& X, math_Matrix& D);
70   
71   //! returns the values <F> of the functions and the derivatives
72   //! <D> for the variable <X>.
73   //! Returns True if the computation was done successfully,
74   //! False otherwise.
75   Standard_EXPORT Standard_Boolean Values (const math_Vector& X, math_Vector& F, math_Matrix& D);
76   
77   //! Set the Point on which a solution has to be found.
78   Standard_EXPORT void Set (const gp_Pnt& P);
79   
80   //! Returns in the vector Tolerance the parametric tolerance
81   //! for each of the 3 variables;
82   //! Tol is the tolerance used in 3d space.
83   Standard_EXPORT void GetTolerance (math_Vector& Tolerance, const Standard_Real Tol) const;
84   
85   //! Returns in the vector InfBound the lowest values allowed
86   //! for each of the 3 variables.
87   //! Returns in the vector SupBound the greatest values allowed
88   //! for each of the 3 variables.
89   Standard_EXPORT void GetBounds (math_Vector& InfBound, math_Vector& SupBound) const;
90   
91   //! Returns Standard_True if Sol is a zero of the function.
92   //! Tol is the tolerance used in 3d space.
93   Standard_EXPORT Standard_Boolean IsSolution (const math_Vector& Sol, const Standard_Real Tol);
94
95
96
97
98 protected:
99
100
101
102
103
104 private:
105
106
107
108   Handle(Adaptor3d_HCurve) curv1;
109   Handle(Adaptor3d_HCurve) curv2;
110   gp_Pnt point;
111   Standard_Integer choix;
112
113
114 };
115
116
117
118
119
120
121
122 #endif // _BRepBlend_CurvPointRadInv_HeaderFile