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