0023024: Update headers of OCCT files
[occt.git] / src / Bisector / Bisector_FunctionH.cdl
1 -- Created on: 1994-04-05
2 -- Created by: Yves FRICAUD
3 -- Copyright (c) 1994-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
21
22
23 private class FunctionH from Bisector 
24
25 inherits FunctionWithDerivative from math
26      
27              --                                  2           2 
28         ---Purpose: H(v) = (T1  .P2(v) - P1) * ||T(v)||  -
29         --                                  2         2
30         --                 (T(v).P2(v) - P1) * ||T1|| 
31         
32 uses 
33     Curve from Geom2d,
34     Pnt2d from gp, 
35     Vec2d from gp  
36
37 is
38
39     Create (C2 : Curve from Geom2d ;
40             P1 : Pnt2d from gp     ;
41             T1   : Vec2d from gp   ) 
42     returns FunctionH from Bisector;
43     
44     Value(me : in out; X : Real; F : out Real) 
45         ---Purpose: Computes the values of the Functions for the variable <X>.
46     returns Boolean;
47     
48     Derivative(me : in out; X : Real; D : out Real) 
49     returns Boolean;
50
51     Values(me : in out ; X  : Real; F  : out Real; D  : out Real)    
52         ---Purpose: Returns the values of the functions and the derivatives
53         --          for the variable <X>.
54     returns Boolean;
55
56 fields
57     
58     curve2 : Curve from Geom2d;
59     p1     : Pnt2d from gp;
60     t1     : Vec2d from gp;
61     
62 end FunctionH;