0024927: Getting rid of "Persistent" functionality -- Storable
[occt.git] / src / IntAna2d / IntAna2d_IntPoint.cdl
1 -- Created on: 1991-02-20
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1991-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 IntPoint from IntAna2d
18
19     ---Purpose: Geometrical intersection between two 2d elements.
20
21
22 uses Pnt2d from gp
23
24 raises DomainError from Standard
25
26 is
27
28     Create(X,Y: Real; U1,U2: Real)
29     
30         ---Purpose: Create an intersection point between 2 parametric 2d lines.
31         --          X,Y are the coordinate of the point. U1 is the parameter
32         --          on the first element, U2 the parameter on the second one.
33     
34         returns IntPoint;
35
36
37     Create(X,Y: Real; U1: Real)
38     
39         ---Purpose: Create an intersection point between a parametric 2d line,
40         --          and a line given by an implicit equation (ImplicitCurve).
41         --          X,Y are the coordinate of the point. U1 is the parameter
42         --          on the parametric element.
43     
44         returns IntPoint;
45
46
47     Create
48
49         ---Purpose: Empty constructor. It's necessary to use one of
50         --          the SetValue method after this one.
51
52         returns IntPoint;
53
54
55     SetValue(me : in out; X,Y: Real; U1,U2: Real)
56     
57         ---Purpose: Set the values for a "non-implicit" point.
58     is virtual;
59
60
61     SetValue(me : in out; X,Y:Real; U1: Real)
62     
63         ---Purpose: Set the values for an "implicit" point.
64     is virtual;
65
66     Value(me)
67     
68         ---Purpose: Returns the geometric point.
69         ---C++: inline
70         ---C++: return const&
71         returns Pnt2d from gp
72
73     is static;
74     
75     
76     SecondIsImplicit(me)
77     
78         ---Purpose: Returns True if the second curve is implicit.
79         ---C++: inline
80         returns Boolean from Standard
81         
82    is static;
83         
84     
85     ParamOnFirst(me)
86     
87         ---Purpose: Returns the parameter on the first element.
88         ---C++: inline
89         returns Real
90         
91     is static;
92
93  
94     ParamOnSecond(me)
95     
96         ---Purpose: Returns the parameter on the second element.
97         --          If the second element is an implicit curve, an exception
98         --          is raised.
99         ---C++: inline
100         returns Real
101         
102         raises DomainError from Standard
103     
104     is static;
105
106
107
108 fields
109
110     myu1        : Real  from Standard;
111     myu2        : Real  from Standard;
112     myp         : Pnt2d from gp;
113     myimplicit  : Boolean from Standard;
114
115 end IntPoint;