0024624: Lost word in license statement in source files
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_MakeEdge2d.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 MakeEdge2d from BRepBuilderAPI inherits MakeShape from BRepBuilderAPI
18
19 ---Purpose: Provides methods to build edges.
20 --
21 -- The methods have the following syntax, where
22 -- TheCurve is one of Lin2d, Circ2d, ...
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 : Pnt2d 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 BRepBuilderAPI,
53 Edge from TopoDS,
54 Vertex from TopoDS,
55 Pnt2d from gp,
56 Lin2d from gp,
57 Circ2d from gp,
58 Elips2d from gp,
59 Hypr2d from gp,
60 Parab2d from gp,
61 Curve from Geom2d,
62 MakeEdge2d from BRepLib
63
64raises
65 NotDone from StdFail
66
67is
68
69 ----------------------------------------
70 -- Points
71 ----------------------------------------
72
73 Create(V1, V2 : Vertex from TopoDS)
74 ---Level: Public
75 returns MakeEdge2d from BRepBuilderAPI;
76
77 Create(P1, P2 : Pnt2d from gp)
78 ---Level: Public
79 returns MakeEdge2d from BRepBuilderAPI;
80
81
82 ----------------------------------------
83 -- Lin
84 ----------------------------------------
85
86 Create(L : Lin2d from gp)
87 ---Level: Public
88 returns MakeEdge2d from BRepBuilderAPI;
89
90 Create(L : Lin2d from gp; p1,p2 : Real)
91 ---Level: Public
92 returns MakeEdge2d from BRepBuilderAPI;
93
94 Create(L : Lin2d from gp; P1,P2 : Pnt2d from gp)
95 ---Level: Public
96 returns MakeEdge2d from BRepBuilderAPI;
97
98 Create(L : Lin2d from gp; V1, V2 : Vertex from TopoDS)
99 ---Level: Public
100 returns MakeEdge2d from BRepBuilderAPI;
101
102 ----------------------------------------
103 -- Circ
104 ----------------------------------------
105
106 Create(L : Circ2d from gp)
107 ---Level: Public
108 returns MakeEdge2d from BRepBuilderAPI;
109
110 Create(L : Circ2d from gp; p1,p2 : Real)
111 ---Level: Public
112 returns MakeEdge2d from BRepBuilderAPI;
113
114 Create(L : Circ2d from gp; P1,P2 : Pnt2d from gp)
115 ---Level: Public
116 returns MakeEdge2d from BRepBuilderAPI;
117
118 Create(L : Circ2d from gp; V1, V2 : Vertex from TopoDS)
119 ---Level: Public
120 returns MakeEdge2d from BRepBuilderAPI;
121
122
123 ----------------------------------------
124 -- Elips
125 ----------------------------------------
126
127 Create(L : Elips2d from gp)
128 ---Level: Public
129 returns MakeEdge2d from BRepBuilderAPI;
130
131 Create(L : Elips2d from gp; p1,p2 : Real)
132 ---Level: Public
133 returns MakeEdge2d from BRepBuilderAPI;
134
135 Create(L : Elips2d from gp; P1,P2 : Pnt2d from gp)
136 ---Level: Public
137 returns MakeEdge2d from BRepBuilderAPI;
138
139 Create(L : Elips2d from gp; V1, V2 : Vertex from TopoDS)
140 ---Level: Public
141 returns MakeEdge2d from BRepBuilderAPI;
142
143 ----------------------------------------
144 -- Hypr
145 ----------------------------------------
146
147 Create(L : Hypr2d from gp)
148 ---Level: Public
149 returns MakeEdge2d from BRepBuilderAPI;
150
151 Create(L : Hypr2d from gp; p1,p2 : Real)
152 ---Level: Public
153 returns MakeEdge2d from BRepBuilderAPI;
154
155 Create(L : Hypr2d from gp; P1,P2 : Pnt2d from gp)
156 ---Level: Public
157 returns MakeEdge2d from BRepBuilderAPI;
158
159 Create(L : Hypr2d from gp; V1, V2 : Vertex from TopoDS)
160 ---Level: Public
161 returns MakeEdge2d from BRepBuilderAPI;
162
163 ----------------------------------------
164 -- Parab
165 ----------------------------------------
166
167 Create(L : Parab2d from gp)
168 ---Level: Public
169 returns MakeEdge2d from BRepBuilderAPI;
170
171 Create(L : Parab2d from gp; p1,p2 : Real)
172 ---Level: Public
173 returns MakeEdge2d from BRepBuilderAPI;
174
175 Create(L : Parab2d from gp; P1,P2 : Pnt2d from gp)
176 ---Level: Public
177 returns MakeEdge2d from BRepBuilderAPI;
178
179 Create(L : Parab2d from gp; V1, V2 : Vertex from TopoDS)
180 ---Level: Public
181 returns MakeEdge2d from BRepBuilderAPI;
182
183 ----------------------------------------
184 -- Curve
185 ----------------------------------------
186
187 Create(L : Curve from Geom2d)
188 ---Level: Public
189 returns MakeEdge2d from BRepBuilderAPI;
190
191 Create(L : Curve from Geom2d; p1,p2 : Real)
192 ---Level: Public
193 returns MakeEdge2d from BRepBuilderAPI;
194
195 Create(L : Curve from Geom2d;
196 P1,P2 : Pnt2d from gp)
197 ---Level: Public
198 returns MakeEdge2d from BRepBuilderAPI;
199
200 Create(L : Curve from Geom2d;
201 V1, V2 : Vertex from TopoDS)
202 ---Level: Public
203 returns MakeEdge2d from BRepBuilderAPI;
204
205 Create(L : Curve from Geom2d;
206 P1,P2 : Pnt2d from gp; p1,p2 : Real)
207 ---Level: Public
208 returns MakeEdge2d from BRepBuilderAPI;
209
210 Create(L : Curve from Geom2d;
211 V1, V2 : Vertex from TopoDS;
212 p1, p2 :Real)
213 ---Level: Public
214 returns MakeEdge2d from BRepBuilderAPI;
215
216 ----------------------------------------
217 -- Auxiliary methods
218 ----------------------------------------
219
220 Init(me : in out; C : Curve from Geom2d)
221 ---Level: Public
222 is static;
223
224 Init(me : in out; C : Curve from Geom2d;
225 p1, p2 : Real)
226 ---Level: Public
227 is static;
228
229 Init(me : in out; C : Curve from Geom2d;
230 P1, P2 : Pnt2d from gp)
231 ---Level: Public
232 is static;
233
234 Init(me : in out; C : Curve from Geom2d;
235 V1, V2 : Vertex from TopoDS)
236 ---Level: Public
237 is static;
238
239 Init(me : in out; C : Curve from Geom2d;
240 P1, P2 : Pnt2d from gp;
241 p1, p2 : Real)
242 ---Level: Public
243 is static;
244
245 Init(me : in out; C : Curve from Geom2d;
246 V1, V2 : Vertex from TopoDS;
247 p1, p2 : Real)
248 ---Level: Public
249 is static;
250
251
252 ----------------------------------------
253 -- Results
254 ----------------------------------------
255
256 IsDone(me) returns Boolean
257 ---Level: Public
258 is redefined;
259
260 Error(me)
261 returns EdgeError from BRepBuilderAPI
262 ---Purpose: Returns the error description when NotDone.
263 ---Level: Public
264 is static;
265
266 Edge(me) returns Edge from TopoDS
267 ---C++: return const &
268 ---C++: alias "Standard_EXPORT operator TopoDS_Edge() const;"
269 ---Level: Public
270 raises
271 NotDone from StdFail
272 is static;
273
274 Vertex1(me) returns Vertex from TopoDS
275 ---Purpose: Returns the first vertex of the edge. May be Null.
276 --
277 ---C++: return const &
278 ---Level: Public
279 is static;
280
281 Vertex2(me) returns Vertex from TopoDS
282 ---Purpose: Returns the second vertex of the edge. May be Null.
283 --
284 ---C++: return const &
285 ---Level: Public
286 is static;
287
288fields
289
290 myMakeEdge2d : MakeEdge2d from BRepLib;
291
292end MakeEdge2d;