1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
-- File: BRepBuilderAPI_MakePolygon.cdl
-- Created: Thu Jul 29 11:39:48 1993
-- Author: Remi LEQUETTE
-- <rle@phylox>
---Copyright: Matra Datavision 1993
class MakePolygon from BRepBuilderAPI inherits MakeShape from BRepBuilderAPI
---Purpose: Describes functions to build polygonal wires. A
-- polygonal wire can be built from any number of points
-- or vertices, and consists of a sequence of connected
-- rectilinear edges.
-- When a point or vertex is added to the polygon if
-- it is identic to the previous point no edge is
-- built. The method added can be used to test it.
-- Construction of a Polygonal Wire
-- You can construct:
-- - a complete polygonal wire by defining all its points
-- or vertices (limited to four), or
-- - an empty polygonal wire and add its points or
-- vertices in sequence (unlimited number).
-- A MakePolygon object provides a framework for:
-- - initializing the construction of a polygonal wire,
-- - adding points or vertices to the polygonal wire under construction, and
-- - consulting the result.
uses
Wire from TopoDS,
Edge from TopoDS,
Vertex from TopoDS,
Pnt from gp,
MakePolygon from BRepLib
raises
NotDone from StdFail
is
Create
returns MakePolygon from BRepBuilderAPI;
---Purpose: Initializes an empty polygonal wire, to which points or
-- vertices are added using the Add function.
-- As soon as the polygonal wire under construction
-- contains vertices, it can be consulted using the Wire function.
Create(P1, P2 : Pnt from gp)
---Level: Public
returns MakePolygon from BRepBuilderAPI;
Create(P1, P2, P3 : Pnt from gp;
Close : Boolean = Standard_False)
---Level: Public
returns MakePolygon from BRepBuilderAPI;
Create(P1, P2, P3, P4 : Pnt from gp;
Close : Boolean = Standard_False)
---Level: Public
returns MakePolygon from BRepBuilderAPI;
---Purpose: Constructs a polygonal wire from 2, 3 or 4 points. Vertices are
-- automatically created on the given points. The polygonal wire is
-- closed if Close is true; otherwise it is open. Further vertices can
-- be added using the Add function. The polygonal wire under
-- construction can be consulted at any time by using the Wire function.
-- Example
-- //an open polygon from four points
-- TopoDS_Wire W = BRepBuilderAPI_MakePolygon(P1,P2,P3,P4);
-- Warning: The process is equivalent to:
-- - initializing an empty polygonal wire,
-- - and adding the given points in sequence.
-- Consequently, be careful when using this function: if the
-- sequence of points p1 - p2 - p1 is found among the arguments of the
-- constructor, you will create a polygonal wire with two
-- consecutive coincident edges.
Create(V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakePolygon from BRepBuilderAPI;
Create(V1, V2, V3 : Vertex from TopoDS;
Close : Boolean = Standard_False)
---Level: Public
returns MakePolygon from BRepBuilderAPI;
Create(V1, V2, V3, V4 : Vertex from TopoDS;
Close : Boolean = Standard_False)
---Level: Public
returns MakePolygon from BRepBuilderAPI;
---Purpose: Constructs a polygonal wire from
-- 2, 3 or 4 vertices. The polygonal wire is closed if Close is true;
-- otherwise it is open (default value). Further vertices can be
-- added using the Add function. The polygonal wire under
-- construction can be consulted at any time by using the Wire function.
-- Example
-- //a closed triangle from three vertices
-- TopoDS_Wire W = BRepBuilderAPI_MakePolygon(V1,V2,V3,Standard_True);
-- Warning
-- The process is equivalent to:
-- - initializing an empty polygonal wire,
-- - then adding the given points in sequence.
-- So be careful, as when using this function, you could create a
-- polygonal wire with two consecutive coincident edges if
-- the sequence of vertices v1 - v2 - v1 is found among the
-- constructor's arguments.
Add(me : in out; P : Pnt from gp)
---Level: Public
is static;
Add(me : in out; V : Vertex from TopoDS)
---Level: Public
is static;
--- Purpose:
-- Adds the point P or the vertex V at the end of the
-- polygonal wire under construction. A vertex is
-- automatically created on the point P.
-- Warning
-- - When P or V is coincident to the previous vertex,
-- no edge is built. The method Added can be used to
-- test for this. Neither P nor V is checked to verify
-- that it is coincident with another vertex than the last
-- one, of the polygonal wire under construction. It is
-- also possible to add vertices on a closed polygon
-- (built for example by using a constructor which
-- declares the polygon closed, or after the use of the Close function).
-- Consequently, be careful using this function: you might create:
-- - a polygonal wire with two consecutive coincident edges, or
-- - a non manifold polygonal wire.
-- - P or V is not checked to verify if it is
-- coincident with another vertex but the last one, of
-- the polygonal wire under construction. It is also
-- possible to add vertices on a closed polygon (built
-- for example by using a constructor which declares
-- the polygon closed, or after the use of the Close function).
-- Consequently, be careful when using this function: you might create:
-- - a polygonal wire with two consecutive coincident edges, or
-- - a non-manifold polygonal wire.
Added(me) returns Boolean
---Purpose: Returns true if the last vertex added to the constructed
-- polygonal wire is not coincident with the previous one.
is static;
Close(me : in out)
---Purpose: Closes the polygonal wire under construction. Note - this
-- is equivalent to adding the first vertex to the polygonal
-- wire under construction.
is static;
FirstVertex(me) returns Vertex from TopoDS
---C++: return const &
---Level: Public
is static;
LastVertex(me) returns Vertex from TopoDS
---C++: return const &
---Level: Public
is static;
---Purpose: Returns the first or the last vertex of the polygonal wire under construction.
-- If the constructed polygonal wire is closed, the first and the last vertices are identical.
IsDone(me) returns Boolean
---Level: Public
is redefined;
---Purpose:
-- Returns true if this algorithm contains a valid polygonal
-- wire (i.e. if there is at least one edge).
-- IsDone returns false if fewer than two vertices have
-- been chained together by this construction algorithm.
Edge(me) returns Edge from TopoDS
---Purpose: Returns the edge built between the last two points or
-- vertices added to the constructed polygonal wire under construction.
-- Warning
-- If there is only one vertex in the polygonal wire, the result is a null edge.
---C++: return const &
---C++: alias "Standard_EXPORT operator TopoDS_Edge() const;"
raises
NotDone from StdFail
is static;
Wire(me) returns Wire from TopoDS
---Purpose:
-- Returns the constructed polygonal wire, or the already
-- built part of the polygonal wire under construction.
-- Exceptions
-- StdFail_NotDone if the wire is not built, i.e. if fewer than
-- two vertices have been chained together by this construction algorithm.
---C++: return const &
---C++: alias "Standard_EXPORT operator TopoDS_Wire() const;"
raises
NotDone from StdFail
is static;
fields
myMakePolygon : MakePolygon from BRepLib;
end MakePolygon;
|
