Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_MakeEdge2d.cdl
1 -- File:        BRepBuilderAPI_MakeEdge2d.cdl
2 -- Created:     Tue Jul  6 18:57:30 1993
3 -- Author:      Remi LEQUETTE
4 --              <rle@phylox>
5 ---Copyright:    Matra Datavision 1993
6
7
8
9 class MakeEdge2d from BRepBuilderAPI  inherits MakeShape from BRepBuilderAPI
10
11         ---Purpose: Provides methods to build edges.
12         --          
13         --          The   methods have  the  following   syntax, where
14         --          TheCurve is one of Lin2d, Circ2d, ...
15         --          
16         --          Create(C : TheCurve)
17         --            
18         --            Makes an edge on  the whole curve.  Add vertices
19         --            on finite curves.
20         --            
21         --          Create(C : TheCurve; p1,p2 : Real)
22         --          
23         --            Make an edge  on the curve between parameters p1
24         --            and p2. if p2 < p1 the edge will be REVERSED. If
25         --            p1  or p2 is infinite the  curve will be open in
26         --            that  direction. Vertices are created for finite
27         --            values of p1 and p2.
28         --            
29         --          Create(C : TheCurve; P1, P2 : Pnt2d from gp)
30         --          
31         --            Make an edge on the curve  between the points P1
32         --            and P2. The  points are projected on   the curve
33         --            and the   previous method is  used. An  error is
34         --            raised if the points are not on the curve.
35         --            
36         --          Create(C : TheCurve; V1, V2 : Vertex from TopoDS)
37         --          
38         --            Make an edge  on the curve  between the vertices
39         --            V1 and V2. Same as the  previous but no vertices
40         --            are created. If a vertex is  Null the curve will
41         --            be open in this direction.
42
43 uses
44     EdgeError  from BRepBuilderAPI,
45     Edge       from TopoDS,
46     Vertex     from TopoDS,
47     Pnt2d      from gp,
48     Lin2d      from gp,
49     Circ2d     from gp,
50     Elips2d    from gp,
51     Hypr2d     from gp,
52     Parab2d    from gp,
53     Curve      from Geom2d,
54     MakeEdge2d from BRepLib
55     
56 raises
57     NotDone from StdFail
58     
59 is
60
61     ----------------------------------------
62     -- Points
63     ----------------------------------------
64
65     Create(V1, V2 : Vertex from TopoDS)                    
66         ---Level: Public
67     returns MakeEdge2d from BRepBuilderAPI;
68
69     Create(P1, P2 : Pnt2d from gp)                           
70         ---Level: Public
71     returns MakeEdge2d from BRepBuilderAPI;
72
73
74     ----------------------------------------
75     -- Lin
76     ----------------------------------------
77         
78     Create(L : Lin2d from gp)                                
79         ---Level: Public
80     returns MakeEdge2d from BRepBuilderAPI;
81
82     Create(L : Lin2d from gp; p1,p2 : Real)                  
83         ---Level: Public
84     returns MakeEdge2d from BRepBuilderAPI;
85
86     Create(L : Lin2d from gp; P1,P2 : Pnt2d from gp)           
87         ---Level: Public
88     returns MakeEdge2d from BRepBuilderAPI;
89
90     Create(L : Lin2d from gp; V1, V2 : Vertex from TopoDS)   
91         ---Level: Public
92     returns MakeEdge2d from BRepBuilderAPI;
93
94     ----------------------------------------
95     -- Circ
96     ----------------------------------------
97         
98     Create(L : Circ2d from gp)                               
99         ---Level: Public
100     returns MakeEdge2d from BRepBuilderAPI;
101
102     Create(L : Circ2d from gp; p1,p2 : Real)                 
103         ---Level: Public
104     returns MakeEdge2d from BRepBuilderAPI;
105
106     Create(L : Circ2d from gp; P1,P2 : Pnt2d from gp)          
107         ---Level: Public
108     returns MakeEdge2d from BRepBuilderAPI;
109
110     Create(L : Circ2d from gp; V1, V2 : Vertex from TopoDS)  
111         ---Level: Public
112     returns MakeEdge2d from BRepBuilderAPI;
113
114         
115     ----------------------------------------
116     -- Elips
117     ----------------------------------------
118
119     Create(L : Elips2d from gp)                               
120         ---Level: Public
121     returns MakeEdge2d from BRepBuilderAPI;
122
123     Create(L : Elips2d from gp; p1,p2 : Real)                 
124         ---Level: Public
125     returns MakeEdge2d from BRepBuilderAPI;
126
127     Create(L : Elips2d from gp; P1,P2 : Pnt2d from gp)          
128         ---Level: Public
129     returns MakeEdge2d from BRepBuilderAPI;
130
131     Create(L : Elips2d from gp; V1, V2 : Vertex from TopoDS)  
132         ---Level: Public
133     returns MakeEdge2d from BRepBuilderAPI;
134
135     ----------------------------------------
136     -- Hypr
137     ----------------------------------------
138
139     Create(L : Hypr2d from gp)                               
140         ---Level: Public
141     returns MakeEdge2d from BRepBuilderAPI;
142
143     Create(L : Hypr2d from gp; p1,p2 : Real)                 
144         ---Level: Public
145     returns MakeEdge2d from BRepBuilderAPI;
146
147     Create(L : Hypr2d from gp; P1,P2 : Pnt2d from gp)          
148         ---Level: Public
149     returns MakeEdge2d from BRepBuilderAPI;
150
151     Create(L : Hypr2d from gp; V1, V2 : Vertex from TopoDS)  
152         ---Level: Public
153     returns MakeEdge2d from BRepBuilderAPI;
154
155     ----------------------------------------
156     -- Parab
157     ----------------------------------------
158
159     Create(L : Parab2d from gp)                               
160         ---Level: Public
161     returns MakeEdge2d from BRepBuilderAPI;
162
163     Create(L : Parab2d from gp; p1,p2 : Real)                 
164         ---Level: Public
165     returns MakeEdge2d from BRepBuilderAPI;
166
167     Create(L : Parab2d from gp; P1,P2 : Pnt2d from gp)          
168         ---Level: Public
169     returns MakeEdge2d from BRepBuilderAPI;
170
171     Create(L : Parab2d from gp; V1, V2 : Vertex from TopoDS)  
172         ---Level: Public
173     returns MakeEdge2d from BRepBuilderAPI;
174
175     ----------------------------------------
176     -- Curve
177     ----------------------------------------
178
179     Create(L : Curve from Geom2d)                               
180         ---Level: Public
181     returns MakeEdge2d from BRepBuilderAPI;
182
183     Create(L : Curve from Geom2d; p1,p2 : Real)                 
184         ---Level: Public
185     returns MakeEdge2d from BRepBuilderAPI;
186
187     Create(L : Curve from Geom2d; 
188     P1,P2 : Pnt2d from gp)                        
189         ---Level: Public
190     returns MakeEdge2d from BRepBuilderAPI;
191
192     Create(L : Curve from Geom2d; 
193     V1, V2 : Vertex from TopoDS)
194         ---Level: Public
195     returns MakeEdge2d from BRepBuilderAPI;
196
197     Create(L : Curve from Geom2d; 
198     P1,P2 : Pnt2d from gp; p1,p2 : Real)                        
199         ---Level: Public
200     returns MakeEdge2d from BRepBuilderAPI;
201
202     Create(L : Curve from Geom2d; 
203     V1, V2 : Vertex from TopoDS;
204     p1, p2 :Real) 
205         ---Level: Public                                            
206     returns MakeEdge2d from BRepBuilderAPI;
207
208     ----------------------------------------
209     --  Auxiliary methods
210     ----------------------------------------
211
212     Init(me : in out; C      : Curve from Geom2d)
213         ---Level: Public
214     is static;
215     
216     Init(me : in out; C      : Curve from Geom2d;
217                       p1, p2 : Real)
218         ---Level: Public
219     is static;                
220         
221     Init(me : in out; C      : Curve from Geom2d;
222                       P1, P2 : Pnt2d from gp)
223         ---Level: Public
224     is static;                
225         
226     Init(me : in out; C      : Curve  from Geom2d;
227                       V1, V2 : Vertex from TopoDS)
228         ---Level: Public
229     is static;
230         
231     Init(me : in out; C      : Curve from Geom2d;
232                       P1, P2 : Pnt2d from gp;
233                       p1, p2 : Real)
234         ---Level: Public
235     is static;                
236         
237     Init(me : in out; C      : Curve  from Geom2d;
238                       V1, V2 : Vertex from TopoDS;
239                       p1, p2 : Real)
240         ---Level: Public
241     is static;
242         
243
244     ----------------------------------------
245     --  Results
246     ----------------------------------------
247
248     IsDone(me) returns Boolean
249         ---Level: Public
250     is redefined;
251
252     Error(me)
253          returns EdgeError from BRepBuilderAPI
254         ---Purpose: Returns the error description when NotDone.
255         ---Level: Public        
256     is static;
257
258     Edge(me) returns Edge from TopoDS
259         ---C++: return const &
260         ---C++: alias "Standard_EXPORT operator TopoDS_Edge() const;"
261         ---Level: Public
262     raises
263         NotDone from StdFail
264     is static;
265     
266     Vertex1(me) returns Vertex from TopoDS
267         ---Purpose: Returns the first vertex of the edge. May be Null.
268         --          
269         ---C++: return const &
270         ---Level: Public
271     is static;
272     
273     Vertex2(me) returns Vertex from TopoDS
274         ---Purpose: Returns the second vertex of the edge. May be Null.
275         --          
276         ---C++: return const &
277         ---Level: Public
278     is static;
279      
280 fields
281
282     myMakeEdge2d : MakeEdge2d from BRepLib;
283
284 end MakeEdge2d;