0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IntCurve / IntCurve_ProjectOnPConicTool.hxx
1 // Created on: 1992-10-13
2 // Created by: Laurent BUCHARD
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 _IntCurve_ProjectOnPConicTool_HeaderFile
18 #define _IntCurve_ProjectOnPConicTool_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 class IntCurve_PConic;
26 class gp_Pnt2d;
27
28
29 //! This class provides a tool which computes the parameter
30 //! of a point near a parametric conic.
31 class IntCurve_ProjectOnPConicTool 
32 {
33 public:
34
35   DEFINE_STANDARD_ALLOC
36
37   
38   //! Returns  the parameter V  of the  point   on the
39   //! parametric  curve corresponding to  the  Point  Pnt.   The
40   //! Correspondance between  Pnt  and the  point   P(V) on  the
41   //! parametric    curve  must  be  coherent with    the way of
42   //! determination  of the signed  distance between a point and
43   //! the implicit curve.  Tol is the tolerance on  the distance
44   //! between a point and the parametrised curve.  In that case,
45   //! no bounds are given.  The research  of the rigth parameter
46   //! has to  be  made  on the natural  parametric domain of the
47   //! curve.
48   Standard_EXPORT static Standard_Real FindParameter (const IntCurve_PConic& C, const gp_Pnt2d& Pnt, const Standard_Real Tol);
49   
50   //! Returns the  parameter  V of the   point  on the
51   //! parametric  curve corresponding  to  the   Point Pnt.  The
52   //! Correspondance  between Pnt and  the   point  P(V) on  the
53   //! parametric  curve  must  be  coherent   with the  way   of
54   //! determination of the  signed distance between  a point and
55   //! the implicit curve.  Tol  is the tolerance on the distance
56   //! between a point and the  parametrised curve.  LowParameter
57   //! and HighParameter give the  boundaries of the interval  in
58   //! which the parameter certainly  lies.  These parameters are
59   //! given to implement a  more efficient  algorithm. So,  it is
60   //! not necessary to check   that the returned value  verifies
61   //! LowParameter <= Value <= HighParameter.
62   Standard_EXPORT static Standard_Real FindParameter (const IntCurve_PConic& C, const gp_Pnt2d& Pnt, const Standard_Real LowParameter, const Standard_Real HighParameter, const Standard_Real Tol);
63
64
65
66
67 protected:
68
69
70
71
72
73 private:
74
75
76
77
78
79 };
80
81
82
83
84
85
86
87 #endif // _IntCurve_ProjectOnPConicTool_HeaderFile