0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / Geom2dInt / Geom2dInt_TheProjPCurOfGInter.hxx
1 // Created on: 1992-06-04
2 // Created by: Jacques GOUSSARD
3 // Copyright (c) 1992-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 _Geom2dInt_TheProjPCurOfGInter_HeaderFile
18 #define _Geom2dInt_TheProjPCurOfGInter_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 class Adaptor2d_Curve2d;
26 class Geom2dInt_Geom2dCurveTool;
27 class Geom2dInt_TheCurveLocatorOfTheProjPCurOfGInter;
28 class Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter;
29 class Geom2dInt_PCLocFOfTheLocateExtPCOfTheProjPCurOfGInter;
30 class gp_Pnt2d;
31
32
33
34 class Geom2dInt_TheProjPCurOfGInter 
35 {
36 public:
37
38   DEFINE_STANDARD_ALLOC
39
40   
41   //! Returns the parameter V of the point on the
42   //! parametric curve corresponding to the Point Pnt.
43   //! The Correspondance between Pnt and the point P(V)
44   //! on the parametric curve must be coherent with the
45   //! way of determination of the signed distance
46   //! between a point and the implicit curve.
47   //! Tol is the tolerance on the distance between a point
48   //! and the parametrised curve.
49   //! In that case, no bounds are given. The research of
50   //! the rigth parameter has to be made on the natural
51   //! parametric domain of the curve.
52   Standard_EXPORT static Standard_Real FindParameter (const Adaptor2d_Curve2d& C, const gp_Pnt2d& Pnt, const Standard_Real Tol);
53   
54   //! Returns the parameter V of the point on the
55   //! parametric curve corresponding to the Point Pnt.
56   //! The Correspondance between Pnt and the point P(V)
57   //! on the parametric curve must be coherent with the
58   //! way of determination of the signed distance
59   //! between a point and the implicit curve.
60   //! Tol is the tolerance on the distance between a point
61   //! and the parametrised curve.
62   //! LowParameter and HighParameter give the
63   //! boundaries of the interval in wich the parameter
64   //! certainly lies. These parameters are given to
65   //! implement a more efficient algoritm. So, it is not
66   //! necessary to check that the returned value verifies
67   //! LowParameter <= Value <= HighParameter.
68   Standard_EXPORT static Standard_Real FindParameter (const Adaptor2d_Curve2d& C, const gp_Pnt2d& Pnt, const Standard_Real LowParameter, const Standard_Real HighParameter, const Standard_Real Tol);
69
70
71
72
73 protected:
74
75
76
77
78
79 private:
80
81
82
83
84
85 };
86
87
88
89
90
91
92
93 #endif // _Geom2dInt_TheProjPCurOfGInter_HeaderFile