0023022: This is desirable to access OpenGl extensions and core API (1.2+) in one...
[occt.git] / src / IntCurve / IntCurve_ProjPCurGen.cdl
1 -- File:        ProjPCurGen.cdl
2 -- Created:     Tue Oct 13 18:27:03 1992
3 -- Author:      Laurent BUCHARD
4 --              <lbr@sdsun2>
5 ---Copyright:    Matra Datavision 1992
6
7
8
9
10 generic class ProjPCurGen from IntCurve (
11     TheCurve         as any;
12     TheCurveTool     as any) -- as CurveTool from IntCurve(TheCurve)
13
14     ---Purpose: this class provide a tool which computes the parameter
15     --          of a point near a parametric curve.
16
17     ---Level: Internal
18
19 uses Pnt2d     from gp,
20      Vec2d     from gp,
21      POnCurv2d from Extrema
22      
23      
24
25     class TheCurveLocator instantiates CurveLocator from Extrema (
26         TheCurve,
27         TheCurveTool,
28         TheCurve,
29         TheCurveTool,
30         POnCurv2d       from Extrema,
31         Pnt2d           from gp);
32         
33     class TheLocateExtPC instantiates GenLocateExtPC from Extrema (
34         TheCurve,
35         TheCurveTool,
36         POnCurv2d      from Extrema,
37         Pnt2d          from gp,
38         Vec2d          from gp);
39
40
41
42 is
43                  
44     FindParameter(myclass; C:   TheCurve;
45                            Pnt: Pnt2d  from gp;
46                            Tol: Real   from Standard)
47                            
48         --- Purpose: Returns the parameter V of the point on the 
49         --           parametric curve corresponding to the Point Pnt.
50         --           The Correspondance between Pnt and the point P(V) 
51         --           on the parametric curve must be coherent with the 
52         --           way of determination of the signed distance 
53         --           between a point and the implicit curve.
54         --           Tol is the tolerance on the distance between a point
55         --           and the parametrised curve.
56         --           In that case, no bounds are given. The research of
57         --           the rigth parameter has to be made on the natural
58         --           parametric domain of the curve.
59                            
60         returns Real from Standard;
61
62         
63     FindParameter(myclass; C:   TheCurve;
64                            Pnt: Pnt2d  from gp;
65                            LowParameter,HighParameter,Tol: Real from Standard)
66                            
67         --- Purpose: Returns the parameter V of the point on the 
68         --           parametric curve corresponding to the Point Pnt.
69         --           The Correspondance between Pnt and the point P(V) 
70         --           on the parametric curve must be coherent with the 
71         --           way of determination of the signed distance 
72         --           between a point and the implicit curve.
73         --           Tol is the tolerance on the distance between a point
74         --           and the parametrised curve.
75         --           LowParameter and HighParameter give the 
76         --           boundaries of the interval in wich the parameter 
77         --           certainly lies. These parameters are given to
78         --           implement a more efficient algoritm. So, it is not
79         --           necessary to check that the returned value verifies 
80         --                LowParameter <= Value <= HighParameter.
81                            
82         returns Real from Standard;
83         
84 end ProjPCurGen;
85
86
87