0024510: Remove unused local variables
[occt.git] / src / IntCurve / IntCurve_ProjPCurGen.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 generic class ProjPCurGen from IntCurve (
18     TheCurve         as any;
19     TheCurveTool     as any) -- as CurveTool from IntCurve(TheCurve)
20
21     ---Purpose: this class provide a tool which computes the parameter
22     --          of a point near a parametric curve.
23
24     ---Level: Internal
25
26 uses Pnt2d     from gp,
27      Vec2d     from gp,
28      POnCurv2d from Extrema
29      
30      
31
32     class TheCurveLocator instantiates CurveLocator from Extrema (
33         TheCurve,
34         TheCurveTool,
35         TheCurve,
36         TheCurveTool,
37         POnCurv2d       from Extrema,
38         Pnt2d           from gp);
39         
40     class TheLocateExtPC instantiates GenLocateExtPC from Extrema (
41         TheCurve,
42         TheCurveTool,
43         POnCurv2d      from Extrema,
44         Pnt2d          from gp,
45         Vec2d          from gp);
46
47
48
49 is
50                  
51     FindParameter(myclass; C:   TheCurve;
52                            Pnt: Pnt2d  from gp;
53                            Tol: Real   from Standard)
54                            
55         --- Purpose: Returns the parameter V of the point on the 
56         --           parametric curve corresponding to the Point Pnt.
57         --           The Correspondance between Pnt and the point P(V) 
58         --           on the parametric curve must be coherent with the 
59         --           way of determination of the signed distance 
60         --           between a point and the implicit curve.
61         --           Tol is the tolerance on the distance between a point
62         --           and the parametrised curve.
63         --           In that case, no bounds are given. The research of
64         --           the rigth parameter has to be made on the natural
65         --           parametric domain of the curve.
66                            
67         returns Real from Standard;
68
69         
70     FindParameter(myclass; C:   TheCurve;
71                            Pnt: Pnt2d  from gp;
72                            LowParameter,HighParameter,Tol: Real from Standard)
73                            
74         --- Purpose: Returns the parameter V of the point on the 
75         --           parametric curve corresponding to the Point Pnt.
76         --           The Correspondance between Pnt and the point P(V) 
77         --           on the parametric curve must be coherent with the 
78         --           way of determination of the signed distance 
79         --           between a point and the implicit curve.
80         --           Tol is the tolerance on the distance between a point
81         --           and the parametrised curve.
82         --           LowParameter and HighParameter give the 
83         --           boundaries of the interval in wich the parameter 
84         --           certainly lies. These parameters are given to
85         --           implement a more efficient algoritm. So, it is not
86         --           necessary to check that the returned value verifies 
87         --                LowParameter <= Value <= HighParameter.
88                            
89         returns Real from Standard;
90         
91 end ProjPCurGen;
92
93
94