0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepLib / BRepLib_MakeEdge.cdl
CommitLineData
b311480e 1-- Created on: 1993-07-06
2-- Created by: Remi LEQUETTE
3-- Copyright (c) 1993-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 MakeEdge from BRepLib inherits MakeShape from BRepLib
18
19 ---Purpose: Provides methods to build edges.
20 --
21 -- The methods have the following syntax, where
22 -- TheCurve is one of Lin, Circ, ...
23 --
24 -- Create(C : TheCurve)
25 --
26 -- Makes an edge on the whole curve. Add vertices
27 -- on finite curves.
28 --
29 -- Create(C : TheCurve; p1,p2 : Real)
30 --
31 -- Make an edge on the curve between parameters p1
32 -- and p2. if p2 < p1 the edge will be REVERSED. If
33 -- p1 or p2 is infinite the curve will be open in
34 -- that direction. Vertices are created for finite
35 -- values of p1 and p2.
36 --
37 -- Create(C : TheCurve; P1, P2 : Pnt from gp)
38 --
39 -- Make an edge on the curve between the points P1
40 -- and P2. The points are projected on the curve
41 -- and the previous method is used. An error is
42 -- raised if the points are not on the curve.
43 --
44 -- Create(C : TheCurve; V1, V2 : Vertex from TopoDS)
45 --
46 -- Make an edge on the curve between the vertices
47 -- V1 and V2. Same as the previous but no vertices
48 -- are created. If a vertex is Null the curve will
49 -- be open in this direction.
50
51uses
52 EdgeError from BRepLib,
53 Edge from TopoDS,
54 Vertex from TopoDS,
55 Pnt from gp,
56 Lin from gp,
57 Circ from gp,
58 Elips from gp,
59 Hypr from gp,
60 Parab from gp,
61 Curve from Geom2d,
62 Curve from Geom,
63 Surface from Geom
64
65raises
66 NotDone from StdFail
67
68is
69
70 Create returns MakeEdge from BRepLib;
71
72 ----------------------------------------
73 -- Points
74 ----------------------------------------
75
76 Create(V1, V2 : Vertex from TopoDS)
77 ---Level: Public
78 returns MakeEdge from BRepLib;
79
80 Create(P1, P2 : Pnt from gp)
81 ---Level: Public
82 returns MakeEdge from BRepLib;
83
84
85 ----------------------------------------
86 -- Lin
87 ----------------------------------------
88
89 Create(L : Lin from gp)
90 ---Level: Public
91 returns MakeEdge from BRepLib;
92
93 Create(L : Lin from gp; p1,p2 : Real)
94 ---Level: Public
95 returns MakeEdge from BRepLib;
96
97 Create(L : Lin from gp; P1,P2 : Pnt from gp)
98 ---Level: Public
99 returns MakeEdge from BRepLib;
100
101 Create(L : Lin from gp; V1, V2 : Vertex from TopoDS)
102 ---Level: Public
103 returns MakeEdge from BRepLib;
104
105 ----------------------------------------
106 -- Circ
107 ----------------------------------------
108
109 Create(L : Circ from gp)
110 ---Level: Public
111 returns MakeEdge from BRepLib;
112
113 Create(L : Circ from gp; p1,p2 : Real)
114 ---Level: Public
115 returns MakeEdge from BRepLib;
116
117 Create(L : Circ from gp; P1,P2 : Pnt from gp)
118 ---Level: Public
119 returns MakeEdge from BRepLib;
120
121 Create(L : Circ from gp; V1, V2 : Vertex from TopoDS)
122 ---Level: Public
123 returns MakeEdge from BRepLib;
124
125
126 ----------------------------------------
127 -- Elips
128 ----------------------------------------
129
130 Create(L : Elips from gp)
131 ---Level: Public
132 returns MakeEdge from BRepLib;
133
134 Create(L : Elips from gp; p1,p2 : Real)
135 ---Level: Public
136 returns MakeEdge from BRepLib;
137
138 Create(L : Elips from gp; P1,P2 : Pnt from gp)
139 ---Level: Public
140 returns MakeEdge from BRepLib;
141
142 Create(L : Elips from gp; V1, V2 : Vertex from TopoDS)
143 ---Level: Public
144 returns MakeEdge from BRepLib;
145
146 ----------------------------------------
147 -- Hypr
148 ----------------------------------------
149
150 Create(L : Hypr from gp)
151 ---Level: Public
152 returns MakeEdge from BRepLib;
153
154 Create(L : Hypr from gp; p1,p2 : Real)
155 ---Level: Public
156 returns MakeEdge from BRepLib;
157
158 Create(L : Hypr from gp; P1,P2 : Pnt from gp)
159 ---Level: Public
160 returns MakeEdge from BRepLib;
161
162 Create(L : Hypr from gp; V1, V2 : Vertex from TopoDS)
163 ---Level: Public
164 returns MakeEdge from BRepLib;
165
166 ----------------------------------------
167 -- Parab
168 ----------------------------------------
169
170 Create(L : Parab from gp)
171 ---Level: Public
172 returns MakeEdge from BRepLib;
173
174 Create(L : Parab from gp; p1,p2 : Real)
175 ---Level: Public
176 returns MakeEdge from BRepLib;
177
178 Create(L : Parab from gp; P1,P2 : Pnt from gp)
179 ---Level: Public
180 returns MakeEdge from BRepLib;
181
182 Create(L : Parab from gp; V1, V2 : Vertex from TopoDS)
183 ---Level: Public
184 returns MakeEdge from BRepLib;
185
186 ----------------------------------------
187 -- Curve
188 ----------------------------------------
189
190 Create(L : Curve from Geom)
191 ---Level: Public
192 returns MakeEdge from BRepLib;
193
194 Create(L : Curve from Geom; p1,p2 : Real)
195 ---Level: Public
196 returns MakeEdge from BRepLib;
197
198 Create(L : Curve from Geom;
199 P1,P2 : Pnt from gp)
200 ---Level: Public
201 returns MakeEdge from BRepLib;
202
203 Create(L : Curve from Geom;
204 V1, V2 : Vertex from TopoDS)
205 ---Level: Public
206 returns MakeEdge from BRepLib;
207
208 Create(L : Curve from Geom;
209 P1,P2 : Pnt from gp; p1,p2 : Real)
210 ---Level: Public
211 returns MakeEdge from BRepLib;
212
213 Create(L : Curve from Geom;
214 V1, V2 : Vertex from TopoDS;
215 p1, p2 :Real)
216 ---Level: Public
217 returns MakeEdge from BRepLib;
218
219 ----------------------------------------
220 -- Curve and surface
221 ----------------------------------------
222
223 Create(L : Curve from Geom2d; S : Surface from Geom)
224 ---Level: Public
225 returns MakeEdge from BRepLib;
226
227 Create(L : Curve from Geom2d; S : Surface from Geom; p1,p2 : Real)
228 ---Level: Public
229 returns MakeEdge from BRepLib;
230
231 Create(L : Curve from Geom2d; S : Surface from Geom;
232 P1,P2 : Pnt from gp)
233 ---Level: Public
234 returns MakeEdge from BRepLib;
235
236 Create(L : Curve from Geom2d; S : Surface from Geom;
237 V1, V2 : Vertex from TopoDS)
238 ---Level: Public
239 returns MakeEdge from BRepLib;
240
241 Create(L : Curve from Geom2d; S : Surface from Geom;
242 P1,P2 : Pnt from gp; p1,p2 : Real)
243 ---Level: Public
244 returns MakeEdge from BRepLib;
245
246 Create(L : Curve from Geom2d; S : Surface from Geom;
247 V1, V2 : Vertex from TopoDS;
248 p1, p2 :Real)
249 ---Level: Public
250 returns MakeEdge from BRepLib;
251
252 ----------------------------------------
253 -- Auxiliary methods
254 ----------------------------------------
255
256 Init(me : in out; C : Curve from Geom)
257 ---Level: Public
258 is static;
259
260 Init(me : in out; C : Curve from Geom;
261 p1, p2 : Real)
262 ---Level: Public
263 is static;
264
265 Init(me : in out; C : Curve from Geom;
266 P1, P2 : Pnt from gp)
267 ---Level: Public
268 is static;
269
270 Init(me : in out; C : Curve from Geom;
271 V1, V2 : Vertex from TopoDS)
272 ---Level: Public
273 is static;
274
275 Init(me : in out; C : Curve from Geom;
276 P1, P2 : Pnt from gp;
277 p1, p2 : Real)
278 ---Level: Public
279 is static;
280
281 Init(me : in out; C : Curve from Geom;
282 V1, V2 : Vertex from TopoDS;
283 p1, p2 : Real)
284 ---Level: Public
285 is static;
286
287 Init(me : in out; C : Curve from Geom2d; S : Surface from Geom)
288 ---Level: Public
289 is static;
290
291 Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
292 p1, p2 : Real)
293 ---Level: Public
294 is static;
295
296 Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
297 P1, P2 : Pnt from gp)
298 ---Level: Public
299 is static;
300
301 Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
302 V1, V2 : Vertex from TopoDS)
303 ---Level: Public
304 is static;
305
306 Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
307 P1, P2 : Pnt from gp;
308 p1, p2 : Real)
309 ---Level: Public
310 is static;
311
312 Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
313 V1, V2 : Vertex from TopoDS;
314 p1, p2 : Real)
315 ---Level: Public
316 is static;
317
318
319 ----------------------------------------
320 -- Results
321 ----------------------------------------
322
323 Error(me) returns EdgeError from BRepLib
324 ---Purpose: Returns the error description when NotDone.
325 ---Level: Public
326 is static;
327
328 Edge(me) returns Edge from TopoDS
329 ---C++: return const &
330 ---C++: alias "Standard_EXPORT operator TopoDS_Edge() const;"
331 ---Level: Public
332 raises
333 NotDone from StdFail
334 is static;
335
336 Vertex1(me) returns Vertex from TopoDS
337 ---Purpose: Returns the first vertex of the edge. May be Null.
338 --
339 ---C++: return const &
340 ---Level: Public
341 is static;
342
343 Vertex2(me) returns Vertex from TopoDS
344 ---Purpose: Returns the second vertex of the edge. May be Null.
345 --
346 ---C++: return const &
347 ---Level: Public
348 is static;
349
350fields
351
352 myError : EdgeError from BRepLib;
353 myVertex1 : Vertex from TopoDS;
354 myVertex2 : Vertex from TopoDS;
355
356end MakeEdge;