0024168: Eliminate CLang compiler warning -Wunused-variable
[occt.git] / src / IntImpParGen / IntImpParGen_ImpParTool.cdl
CommitLineData
b311480e 1-- Created on: 1992-03-30
2-- Created by: Laurent BUCHARD
3-- Copyright (c) 1992-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23generic class ImpParTool from IntImpParGen (
24 ImpTool as any; -- as ImpTool from IntImpParGen
25 ParCurve as any;
26 ParTool as any) -- as ParTool from IntImpParGen(ParCurve)
27
28inherits FunctionWithDerivative from math
29
30 ---Purpose: Implements the function used by FunctionAllRoots
31 -- to find the areas where the distance between the
32 -- implicit and the parametric curves is less than a
33 -- tolerance.
34
35
36uses Pnt2d from gp,
37 Vec2d from gp
38
39is
40
41 Create(IT: ImpTool; PC: ParCurve)
42
43 ---Purpose: Constructor of the class.
44
45 returns ImpParTool from IntImpParGen;
46
47
48 Value(me: in out; Param: Real from Standard; F: out Real from Standard)
49
50 ---Purpose: Computes the value of the signed distance between
51 -- the implicit curve and the point at parameter Param
52 -- on the parametrised curve.
53
54 returns Boolean from Standard
55 is redefined static;
56
57
58 Derivative(me: in out; Param: Real from Standard;
59 D: out Real from Standard)
60
61 ---Purpose: Computes the derivative of the previous function at
62 -- parameter Param.
63
64 returns Boolean from Standard
65 is redefined static;
66
67
68 Values(me: in out; Param: Real from Standard; F,D: out Real from Standard)
69
70 ---Purpose: Computes the value and the derivative of the function.
71
72 returns Boolean from Standard
73 is redefined static;
74
75fields
76
77 TheParCurve : Address from Standard;
78 TheImpTool : ImpTool;
79
80end ImpParTool;
81