Integration of OCCT 6.5.0 from SVN
[occt.git] / src / BRepLib / BRepLib_MakePolygon.cdl
1 -- File:        BRepLib_MakePolygon.cdl
2 -- Created:     Thu Jul 29 11:39:48 1993
3 -- Author:      Remi LEQUETTE
4 --              <rle@phylox>
5 ---Copyright:    Matra Datavision 1993
6
7
8 class MakePolygon from BRepLib  inherits MakeShape from BRepLib 
9
10         ---Purpose: Class to build polygonal wires.
11         --          
12         --          A polygonal wire may be build from
13         --          
14         --          - 2,4,3 points.
15         --          
16         --          - 2,3,4 vertices.
17         --          
18         --          - any number of points.
19         --          
20         --          - any number of vertices.
21         --          
22         --          
23         --          When a point or vertex is added to the  polygon if
24         --          it is identic  to the previous  point no  edge  is
25         --          built. The method added can be used to test it.
26
27 uses
28     Wire   from TopoDS,
29     Edge   from TopoDS,
30     Vertex from TopoDS,
31     Pnt    from gp
32
33 raises
34     NotDone           from StdFail
35
36 is
37     Create 
38     returns MakePolygon from BRepLib;
39         ---Purpose: Creates an empty MakePolygon.
40         ---Level: Public
41         
42     Create(P1, P2 : Pnt from gp)
43         ---Level: Public
44     returns MakePolygon from BRepLib;
45
46     Create(P1, P2, P3 : Pnt from gp; 
47            Close : Boolean = Standard_False)
48         ---Level: Public
49     returns MakePolygon from BRepLib;
50
51     Create(P1, P2, P3, P4 : Pnt from gp; 
52            Close : Boolean = Standard_False)
53         ---Level: Public
54     returns MakePolygon from BRepLib;
55
56     Create(V1, V2 : Vertex from TopoDS)
57         ---Level: Public
58     returns MakePolygon from BRepLib;
59
60     Create(V1, V2, V3 : Vertex from TopoDS; 
61            Close : Boolean = Standard_False)
62         ---Level: Public
63     returns MakePolygon from BRepLib;
64
65     Create(V1, V2, V3, V4 : Vertex from TopoDS; 
66            Close : Boolean = Standard_False)
67         ---Level: Public
68     returns MakePolygon from BRepLib;
69
70
71     Add(me : in out; P : Pnt from gp)
72         ---Level: Public
73     is static;
74
75     Add(me : in out; V : Vertex from TopoDS)
76         ---Level: Public
77     is static;
78     
79     Added(me) returns Boolean
80         ---Purpose: Returns  True if  the last   vertex  or point  was
81         --          succesfully added.
82         ---Level: Public
83     is static;
84     
85     Close(me : in out)
86         ---Level: Public
87     is static;
88     
89     FirstVertex(me) returns Vertex from TopoDS
90         ---C++: return const &
91         ---Level: Public
92     is static;
93
94     LastVertex(me) returns Vertex from TopoDS
95         ---C++: return const &
96         ---Level: Public
97     is static;
98     
99     Edge(me) returns Edge from TopoDS
100         ---Purpose: Returns the last edge added to the polygon.
101         --          
102         ---C++: return const &
103         ---C++: alias "Standard_EXPORT operator TopoDS_Edge() const;"
104         ---Level: Public
105     raises
106         NotDone from StdFail
107     is static;
108
109     Wire(me) returns Wire from TopoDS
110         ---C++: return const &
111         ---C++: alias "Standard_EXPORT operator TopoDS_Wire() const;"
112         ---Level: Public
113     raises
114         NotDone from StdFail
115     is static;
116
117 fields
118
119     myFirstVertex : Vertex from TopoDS;
120     myLastVertex  : Vertex from TopoDS;
121     myEdge        : Edge from TopoDS;
122
123 end MakePolygon;