0022792: Globally defined symbol PI conflicts with VTK definition (Intel compiler)
[occt.git] / src / IntImpParGen / IntImpParGen_ImpParTool.cdl
1 -- File:        ImpParTool.cdl
2 -- Created:     Mon Mar 30 18:19:14 1992
3 -- Author:      Laurent BUCHARD
4 --              <lbr@topsn3>
5 ---Copyright:    Matra Datavision 1992
6
7
8 generic class ImpParTool from IntImpParGen (
9         ImpTool      as any; -- as ImpTool from IntImpParGen
10         ParCurve     as any;
11         ParTool      as any) -- as ParTool from IntImpParGen(ParCurve) 
12
13 inherits FunctionWithDerivative from math
14
15         ---Purpose: Implements the function  used by FunctionAllRoots
16         --          to find  the areas where  the distance between the
17         --          implicit and the parametric curves  is less than a
18         --          tolerance.
19
20
21 uses    Pnt2d           from gp,
22         Vec2d           from gp
23         
24 is
25
26     Create(IT: ImpTool; PC: ParCurve)
27
28         ---Purpose: Constructor of the class.
29     
30         returns ImpParTool from IntImpParGen;
31         
32         
33     Value(me: in out; Param: Real from Standard; F: out Real from Standard)
34     
35         ---Purpose: Computes the value of the signed distance between
36         --          the implicit curve and the point at parameter Param
37         --          on the parametrised curve.
38
39         returns Boolean from Standard
40         is redefined static;
41         
42         
43     Derivative(me: in out; Param: Real from Standard; 
44                D: out Real from Standard)
45                
46         ---Purpose: Computes the derivative of the previous function at
47         --          parameter Param.
48
49         returns Boolean from Standard
50         is redefined static;
51         
52         
53     Values(me: in out; Param: Real from Standard; F,D: out Real from Standard)
54     
55         ---Purpose: Computes the value and the derivative of the function.
56
57         returns Boolean from Standard
58         is redefined static;
59
60 fields 
61
62     TheParCurve     : Address from Standard;
63     TheImpTool      : ImpTool;
64                   
65 end ImpParTool;
66