0024510: Remove unused local variables
[occt.git] / src / IntCurve / IntCurve_ProjectOnPConicTool.cdl
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
9 -- under the terms of the GNU Lesser General Public 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 private class ProjectOnPConicTool from IntCurve
18     
19     ---Purpose: This class provides a tool which computes the parameter
20     --          of a point near a parametric conic.
21
22 uses Pnt2d     from gp,
23      PConic    from IntCurve 
24 is
25                  
26     FindParameter(myclass; C:   PConic from IntCurve;
27                            Pnt: Pnt2d  from gp;
28                            Tol: Real   from Standard)
29                            
30         --- Purpose:  Returns  the parameter V  of the  point   on the
31         --  parametric  curve corresponding to  the  Point  Pnt.   The
32         --  Correspondance between  Pnt  and the  point   P(V) on  the
33         --  parametric    curve  must  be  coherent with    the way of
34         --  determination  of the signed  distance between a point and
35         --  the implicit curve.  Tol is the tolerance on  the distance
36         --  between a point and the parametrised curve.  In that case,
37         --  no bounds are given.  The research  of the rigth parameter
38         --  has to  be  made  on the natural  parametric domain of the
39         --  curve.
40                            
41         returns Real from Standard;
42
43         
44     FindParameter(myclass; C:   PConic from IntCurve;
45                            Pnt: Pnt2d  from gp;
46                            LowParameter,HighParameter,Tol: Real from Standard)
47                            
48         --- Purpose:  Returns the  parameter  V of the   point  on the
49         --  parametric  curve corresponding  to  the   Point Pnt.  The
50         --  Correspondance  between Pnt and  the   point  P(V) on  the
51         --  parametric  curve  must  be  coherent   with the  way   of
52         --  determination of the  signed distance between  a point and
53         --  the implicit curve.  Tol  is the tolerance on the distance
54         --  between a point and the  parametrised curve.  LowParameter
55         --  and HighParameter give the  boundaries of the interval  in
56         --  wich the parameter  certainly  lies.  These parameters are
57         --  given to implement a  more efficient  algoritm. So,  it is
58         --  not necessary to check   that the returned value  verifies
59         --  LowParameter <= Value <= HighParameter.
60                            
61         returns Real from Standard;
62         
63 end ProjectOnPConicTool;