0024927: Getting rid of "Persistent" functionality -- Storable
[occt.git] / src / IntRes2d / IntRes2d_IntersectionPoint.cdl
1 -- Created on: 1992-04-03
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 under
9 -- the terms of the GNU Lesser General Public License 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 class IntersectionPoint from IntRes2d
18
19     ---Purpose: Definition of an intersection point between two
20     --          2D curves.
21
22 uses Pnt2d      from gp,
23      Transition from IntRes2d
24 is
25
26     Create
27
28         ---Purpose: Empty constructor.
29
30         returns IntersectionPoint from IntRes2d;
31
32
33     Create(P: Pnt2d from gp; Uc1,Uc2:Real from Standard;
34            Trans1,Trans2: Transition from IntRes2d;
35            ReversedFlag: Boolean from Standard)
36            
37         ---Purpose: Creates an IntersectionPoint.
38         --          if ReversedFlag is False, the parameter Uc1(resp. Uc2)
39         --          and the Transition Trans1 (resp. Trans2) refer to 
40         --          the first curve (resp. second curve) otherwise Uc1 
41         --          and Trans1 (resp. Uc2 and Trans2) refer to the 
42         --          second curve (resp. the first curve).
43
44         ---C++: inline     
45
46         returns IntersectionPoint from IntRes2d;
47         
48
49     SetValues(me:in out; P: Pnt2d from gp; Uc1,Uc2:Real from Standard;
50               Trans1,Trans2: Transition from IntRes2d;
51               ReversedFlag: Boolean from Standard)
52
53         ---Purpose: Sets the values for an existing intersection 
54         --          point. The meaning of the parameters are the same 
55         --          as for the Create.
56
57         ---C++: inline
58
59         is static;
60
61
62
63     Value(me)
64     
65         ---Purpose: Returns the value of the coordinates of the
66         --          intersection point in the 2D space.
67
68         ---C++: inline
69         ---C++: return const &
70
71         returns Pnt2d from gp
72         is static;
73
74
75     ParamOnFirst(me)
76
77         ---Purpose: Returns the parameter on the first curve.
78
79         ---C++: inline
80
81         returns Real from Standard
82         is static;
83
84
85     ParamOnSecond(me)
86
87         ---Purpose: Returns the parameter on the second curve.
88
89         ---C++: inline
90
91         returns Real from Standard
92         is static;
93
94
95     TransitionOfFirst(me)
96     
97         ---Purpose: Returns the transition of the 1st curve compared to
98         --          the 2nd one.
99
100         ---C++: inline
101         ---C++: return const &
102         returns Transition from IntRes2d
103         is static;
104
105
106     TransitionOfSecond(me)
107     
108         ---Purpose: returns the transition of the 2nd curve compared to
109         --          the 1st one.
110
111         ---C++: inline
112         ---C++: return const &
113         returns Transition from IntRes2d
114         is static;
115
116
117 fields
118
119     pt       : Pnt2d      from gp;
120     p1       : Real       from Standard;
121     p2       : Real       from Standard;
122     trans1   : Transition from IntRes2d;
123     trans2   : Transition from IntRes2d;
124
125 end IntersectionPoint;
126  
127