0024624: Lost word in license statement in source files
[occt.git] / src / IntRes2d / IntRes2d_Intersection.cdl
1 -- Created on: 1992-04-27
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 deferred class Intersection from IntRes2d
18
19
20     ---Purpose: Defines  the root   class  of  all  the  Intersections
21     --          between  two 2D-Curves, and  provides all  the methods
22     --          about the results of the Intersections Algorithms.
23
24
25 uses IntersectionPoint             from IntRes2d,
26      IntersectionSegment           from IntRes2d,
27      SequenceOfIntersectionPoint   from IntRes2d,
28      SequenceOfIntersectionSegment from IntRes2d
29
30 raises NotDone    from StdFail,
31        OutOfRange from Standard
32
33 is
34
35     Initialize
36     
37         ---Purpose: Empty constructor.          
38         is protected;
39         ---C++:inline
40
41         
42     Initialize(Other: Intersection from IntRes2d)
43         ---C++:inline
44         is protected;
45     
46     IsDone(me)
47     
48         ---Purpose: returns TRUE when the computation was successful.
49         ---C++: inline
50         returns Boolean from Standard
51         is static;
52
53
54     IsEmpty(me)
55     
56         ---Purpose: Returns TRUE if there is no intersection between the
57         --          given arguments.
58         --          The exception NotDone is raised if IsDone returns FALSE.
59         ---C++: inline
60         returns Boolean from Standard
61         raises  NotDone from StdFail
62         is static;
63
64
65     NbPoints(me)
66
67         ---Purpose: This function returns the number of intersection
68         --          points between the 2 curves.
69         --          The exception NotDone is raised if IsDone returns FALSE.
70         ---C++: inline
71         
72         returns Integer from Standard
73         raises  NotDone from StdFail
74         is static;
75
76
77     Point(me; N : Integer from Standard)
78
79         ---Purpose: This function returns the intersection point
80         --          of range N;
81         --          The exception NotDone is raised if IsDone returns FALSE.
82         --          The exception OutOfRange is raised if (N <= 0) 
83         --          or (N > NbPoints).
84         ---C++: inline
85
86         returns IntersectionPoint from IntRes2d
87         ---C++: return const &
88         raises  NotDone           from StdFail,
89                 OutOfRange        from Standard
90         is static;
91
92
93     NbSegments(me)
94
95         ---Purpose: This function returns the number of intersection
96         --          segments between the two curves.
97         --          The exception NotDone is raised if IsDone returns FALSE.
98         ---C++: inline
99         
100         returns Integer from Standard
101         raises  NotDone from StdFail
102         is static;
103         
104         
105     Segment(me; N : Integer)
106
107         ---Purpose: This function returns the intersection segment
108         --          of range N;
109         --          The exception NotDone is raised if IsDone returns FALSE.
110         --          The exception OutOfRange is raised if (N <= 0) 
111         --          or (N > NbPoints).
112         ---C++: inline
113
114         returns IntersectionSegment from IntRes2d
115         ---C++: return const &
116         raises  NotDone             from StdFail,
117                 OutOfRange          from Standard
118         is static;
119
120
121
122     SetValues(me: in out; Inter: Intersection from IntRes2d)
123
124         --Purpose: Copies  the Inters values into the current object.
125                 
126         is static protected;
127
128
129     Append(me: in out; Inter      : Intersection from IntRes2d;
130                        FirstParam1: Real         from Standard;
131                        LastParam1 : Real         from Standard;
132                        FirstParam2: Real         from Standard;
133                        LastParam2 : Real         from Standard)                
134
135         --Purpose: Appends  the Inters values to the current object
136         --         FirstParam and LastParam are the parameters of
137         --         the bounds of the parameter interval of the 
138         --         curves.
139         
140         is static protected;
141
142
143     Append(me: in out; Seg: IntersectionSegment from IntRes2d) 
144
145         --Purpose: Appends a new Intersection Segment.
146         ---C++: inline
147         is static protected;
148
149
150     Append(me: in out; Pnt: IntersectionPoint from IntRes2d) 
151     
152         --Purpose: Appends a new Intersection Point.
153         ---C++: inline          
154         is static protected;
155         
156
157     Insert(me: in out; Pnt: IntersectionPoint from IntRes2d) 
158     
159         --Purpose: Inserts a new Intersection Point.
160                 
161         is static protected;
162         
163
164     ResetFields(me: in out)
165     
166         --Purpose: Resets all fields.  
167         ---C++: inline      
168         is static protected;
169
170
171     SetReversedParameters(me: in out; Reverseflag: Boolean from Standard)
172     
173         --Purpose: Initialize the  reverse flag. This flag is  used to
174         --         determine  if the first and  second parameters have
175         --         to be   swaped when    the intersection  points and
176         --         segments are created.
177         ---C++: inline      
178         is static;
179
180
181     ReversedParameters(me)
182     
183         --Purpose: Returns the value of the reverse flag.
184         ---C++: inline  
185         returns Boolean from Standard
186         is static protected;
187
188 fields
189
190     done    : Boolean                       from Standard is protected;
191     reverse : Boolean                       from Standard;          
192     lpnt    : SequenceOfIntersectionPoint   from IntRes2d;
193     lseg    : SequenceOfIntersectionSegment from IntRes2d; 
194
195 end Intersection;
196