0024624: Lost word in license statement in source files
[occt.git] / src / IntRes2d / IntRes2d_IntersectionPoint.cdl
CommitLineData
b311480e 1-- Created on: 1992-04-03
2-- Created by: Laurent BUCHARD
3-- Copyright (c) 1992-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class IntersectionPoint from IntRes2d
18
19 ---Purpose: Definition of an intersection point between two
20 -- 2D curves.
21
22
23inherits Storable from Standard
24
25uses Pnt2d from gp,
26 Transition from IntRes2d
27is
28
29 Create
30
31 ---Purpose: Empty constructor.
32
33 returns IntersectionPoint from IntRes2d;
34
35
36 Create(P: Pnt2d from gp; Uc1,Uc2:Real from Standard;
37 Trans1,Trans2: Transition from IntRes2d;
38 ReversedFlag: Boolean from Standard)
39
40 ---Purpose: Creates an IntersectionPoint.
41 -- if ReversedFlag is False, the parameter Uc1(resp. Uc2)
42 -- and the Transition Trans1 (resp. Trans2) refer to
43 -- the first curve (resp. second curve) otherwise Uc1
44 -- and Trans1 (resp. Uc2 and Trans2) refer to the
45 -- second curve (resp. the first curve).
46
47 ---C++: inline
48
49 returns IntersectionPoint from IntRes2d;
50
51
52 SetValues(me:in out; P: Pnt2d from gp; Uc1,Uc2:Real from Standard;
53 Trans1,Trans2: Transition from IntRes2d;
54 ReversedFlag: Boolean from Standard)
55
56 ---Purpose: Sets the values for an existing intersection
57 -- point. The meaning of the parameters are the same
58 -- as for the Create.
59
60 ---C++: inline
61
62 is static;
63
64
65
66 Value(me)
67
68 ---Purpose: Returns the value of the coordinates of the
69 -- intersection point in the 2D space.
70
71 ---C++: inline
72 ---C++: return const &
73
74 returns Pnt2d from gp
75 is static;
76
77
78 ParamOnFirst(me)
79
80 ---Purpose: Returns the parameter on the first curve.
81
82 ---C++: inline
83
84 returns Real from Standard
85 is static;
86
87
88 ParamOnSecond(me)
89
90 ---Purpose: Returns the parameter on the second curve.
91
92 ---C++: inline
93
94 returns Real from Standard
95 is static;
96
97
98 TransitionOfFirst(me)
99
100 ---Purpose: Returns the transition of the 1st curve compared to
101 -- the 2nd one.
102
103 ---C++: inline
104 ---C++: return const &
105 returns Transition from IntRes2d
106 is static;
107
108
109 TransitionOfSecond(me)
110
111 ---Purpose: returns the transition of the 2nd curve compared to
112 -- the 1st one.
113
114 ---C++: inline
115 ---C++: return const &
116 returns Transition from IntRes2d
117 is static;
118
119
120fields
121
122 pt : Pnt2d from gp;
123 p1 : Real from Standard;
124 p2 : Real from Standard;
125 trans1 : Transition from IntRes2d;
126 trans2 : Transition from IntRes2d;
127
128end IntersectionPoint;
129
130