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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
Polyline
========
.. module:: ezdxf.entities
:noindex:
The POLYLINE entity (`POLYLINE DXF Reference`_) is very complex, it's used to build
2D/3D polylines, 3D meshes and 3D polyfaces. For every type exists a different wrapper
class but they all have the same DXF type "POLYLINE". Detect the actual POLYLINE
type by the method :meth:`Polyline.get_mode`.
POLYLINE types returned by :meth:`Polyline.get_mode`:
- ``'AcDb2dPolyline'`` for 2D :class:`Polyline`
- ``'AcDb3dPolyline'`` for 3D :class:`Polyline`
- ``'AcDbPolygonMesh'`` for :class:`Polymesh`
- ``'AcDbPolyFaceMesh'`` for :class:`Polyface`
For 2D entities all vertices in :ref:`OCS`.
For 3D entities all vertices in :ref:`WCS`.
======================== ==========================================
Subclass of :class:`ezdxf.entities.DXFGraphic`
DXF type ``'POLYLINE'``
2D factory function :meth:`ezdxf.layouts.BaseLayout.add_polyline2d`
3D factory function :meth:`ezdxf.layouts.BaseLayout.add_polyline3d`
Inherited DXF attributes :ref:`Common graphical DXF attributes`
======================== ==========================================
.. warning::
Do not instantiate entity classes by yourself - always use the provided factory functions!
.. _POLYLINE DXF Reference: http://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-ABF6B778-BE20-4B49-9B58-A94E64CEFFF3
.. class:: Polyline
The :class:`Vertex` entities are stored in the Python list :attr:`Polyline.vertices`.
The VERTEX entities can be retrieved and deleted by direct access to the
:attr:`Polyline.vertices` attribute:
.. code-block:: python
# delete first and second vertex
del polyline.vertices[:2]
.. attribute:: dxf.elevation
Elevation point, the X and Y values are always 0, and the Z value is the
polyline elevation (3D Point).
.. attribute:: dxf.flags
Constants defined in :mod:`ezdxf.lldxf.const`:
================================== ===== ====================================
:attr:`Polyline.dxf.flags` Value Description
================================== ===== ====================================
POLYLINE_CLOSED 1 This is a closed Polyline (or a
polygon mesh closed in the M
direction)
POLYLINE_MESH_CLOSED_M_DIRECTION 1 equals POLYLINE_CLOSED
POLYLINE_CURVE_FIT_VERTICES_ADDED 2 Curve-fit vertices have been added
POLYLINE_SPLINE_FIT_VERTICES_ADDED 4 Spline-fit vertices have been added
POLYLINE_3D_POLYLINE 8 This is a 3D Polyline
POLYLINE_3D_POLYMESH 16 This is a 3D polygon mesh
POLYLINE_MESH_CLOSED_N_DIRECTION 32 The polygon mesh is closed in the
N direction
POLYLINE_POLYFACE_MESH 64 This Polyline is a polyface mesh
POLYLINE_GENERATE_LINETYPE_PATTERN 128 The linetype pattern is generated
continuously around the vertices of
this Polyline
================================== ===== ====================================
.. attribute:: dxf.default_start_width
Default line start width (float); default is 0
.. attribute:: dxf.default_end_width
Default line end width (float); default is 0
.. attribute:: dxf.m_count
Polymesh M vertex count (int); default is 1
.. attribute:: dxf.n_count
Polymesh N vertex count (int); default is 1
.. attribute:: dxf.m_smooth_density
Smooth surface M density (int); default is 0
.. attribute:: dxf.n_smooth_density
Smooth surface N density (int); default is 0
.. attribute:: dxf.smooth_type
Curves and smooth surface type (int); default is 0, see table below
Constants for :attr:`smooth_type` defined in :mod:`ezdxf.lldxf.const`:
================================ ===== =============================
:attr:`Polyline.dxf.smooth_type` Value Description
================================ ===== =============================
POLYMESH_NO_SMOOTH 0 no smooth surface fitted
POLYMESH_QUADRATIC_BSPLINE 5 quadratic B-spline surface
POLYMESH_CUBIC_BSPLINE 6 cubic B-spline surface
POLYMESH_BEZIER_SURFACE 8 Bezier surface
================================ ===== =============================
.. attribute:: vertices
List of :class:`Vertex` entities.
.. autoattribute:: is_2d_polyline
.. autoattribute:: is_3d_polyline
.. autoattribute:: is_polygon_mesh
.. autoattribute:: is_poly_face_mesh
.. autoattribute:: is_closed
.. autoattribute:: is_m_closed
.. autoattribute:: is_n_closed
.. autoattribute:: has_arc
.. autoattribute:: has_width
.. automethod:: get_mode
.. automethod:: m_close
.. automethod:: n_close
.. automethod:: close
.. automethod:: __len__
.. automethod:: __getitem__
.. automethod:: points
.. automethod:: points_in_wcs
.. automethod:: append_vertex
.. automethod:: append_vertices
.. automethod:: append_formatted_vertices
.. automethod:: insert_vertices
.. automethod:: transform
.. automethod:: virtual_entities
.. automethod:: explode
Vertex
======
A VERTEX (`VERTEX DXF Reference`_) represents a polyline/mesh vertex.
======================== ==========================================
Subclass of :class:`ezdxf.entities.DXFGraphic`
DXF type ``'VERTEX'``
Factory function :meth:`Polyline.append_vertex`
Factory function :meth:`Polyline.extend`
Factory function :meth:`Polyline.insert_vertices`
Inherited DXF Attributes :ref:`Common graphical DXF attributes`
======================== ==========================================
.. _VERTEX DXF Reference: http://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-0741E831-599E-4CBF-91E1-8ADBCFD6556D
.. class:: Vertex
.. attribute:: dxf.location
Vertex location (2D/3D Point :ref:`OCS` when 2D, :ref:`WCS` when 3D)
.. attribute:: dxf.start_width
Line segment start width (float); default is 0
.. attribute:: dxf.end_width
Line segment end width (float); default is 0
.. attribute:: dxf.bulge
:ref:`bulge value` (float); default is 0.
The bulge value is used to create arc shaped line segments.
.. attribute:: dxf.flags
Constants defined in :mod:`ezdxf.lldxf.const`:
============================== ======= ===========
Vertex.dxf.flags Value Description
============================== ======= ===========
VTX_EXTRA_VERTEX_CREATED 1 Extra vertex created by curve-fitting
VTX_CURVE_FIT_TANGENT 2 curve-fit tangent defined for this vertex. A curve-fit tangent direction of 0 may be omitted from the DXF output, but is significant if this bit is set.
VTX_SPLINE_VERTEX_CREATED 8 spline vertex created by spline-fitting
VTX_SPLINE_FRAME_CONTROL_POINT 16 spline frame control point
VTX_3D_POLYLINE_VERTEX 32 3D polyline vertex
VTX_3D_POLYGON_MESH_VERTEX 64 3D polygon mesh
VTX_3D_POLYFACE_MESH_VERTEX 128 polyface mesh vertex
============================== ======= ===========
.. attribute:: dxf.tangent
Curve fit tangent direction (float), used for 2D spline in DXF R12.
.. attribute:: dxf.vtx1
Index of 1st vertex, if used as face (feature for experts)
.. attribute:: dxf.vtx2
Index of 2nd vertex, if used as face (feature for experts)
.. attribute:: dxf.vtx3
Index of 3rd vertex, if used as face (feature for experts)
.. attribute:: dxf.vtx4
Index of 4th vertex, if used as face (feature for experts)
.. attribute:: is_2d_polyline_vertex
.. attribute:: is_3d_polyline_vertex
.. attribute:: is_polygon_mesh_vertex
.. attribute:: is_poly_face_mesh_vertex
.. attribute:: is_face_record
.. method:: format(format='xyz') -> Sequence
Return formatted vertex components as tuple.
Format codes:
- "x" = x-coordinate
- "y" = y-coordinate
- "z" = z-coordinate
- "s" = start width
- "e" = end width
- "b" = bulge value
- "v" = (x, y, z) as tuple
Args:
format: format string, default is "xyz"
Polymesh
========
======================== ==========================================
Subclass of :class:`ezdxf.entities.Polyline`
DXF type ``'POLYLINE'``
Factory function :meth:`ezdxf.layouts.BaseLayout.add_polymesh`
Inherited DXF Attributes :ref:`Common graphical DXF attributes`
======================== ==========================================
.. class:: Polymesh
A polymesh is a grid of :attr:`m_count` by :attr:`n_count` vertices, every vertex has
its own (x, y, z) location. The :class:`Polymesh` is a subclass of :class:`Polyline`,
the DXF type is also "POLYLINE", the method :meth:`get_mode` returns "AcDbPolygonMesh".
.. automethod:: get_mesh_vertex
.. automethod:: set_mesh_vertex
.. automethod:: get_mesh_vertex_cache
MeshVertexCache
---------------
.. class:: MeshVertexCache
Cache mesh vertices in a dict, keys are 0-based (row, col) tuples.
Set vertex location: :code:`cache[row, col] = (x, y, z)`
Get vertex location: :code:`x, y, z = cache[row, col]`
.. attribute:: vertices
Dict of mesh vertices, keys are 0-based (row, col) tuples.
.. automethod:: __getitem__
.. automethod:: __setitem__
Polyface
========
======================== ==========================================
Subclass of :class:`ezdxf.entities.Polyline`
DXF type ``'POLYLINE'``
Factory function :meth:`ezdxf.layouts.BaseLayout.add_polyface`
Inherited DXF Attributes :ref:`Common graphical DXF attributes`
======================== ==========================================
.. seealso::
:ref:`tut_polyface`
.. class:: Polyface
A polyface consist of multiple 3D areas called faces, only faces with 3 or 4
vertices are supported.
The :class:`Polyface` is a subclass of :class:`Polyline`, the DXF type is also
"POLYLINE", the :meth:`~Polyline.get_mode` returns "AcDbPolyFaceMesh".
.. automethod:: append_face
.. automethod:: append_faces
.. automethod:: faces
.. automethod:: optimize
|
