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
|
Underlay
========
.. module:: ezdxf.entities
:noindex:
The UNDERLAY entity (`DXF Reference`_) links an underlay file to the DXF file, the file
itself is not embedded into the DXF file, it is always a separated file.
The (PDF)UNDERLAY entity is like a block reference, you can use it multiple times to add
the underlay on different locations with different scales and rotations. But therefore
you need a also a (PDF)DEFINITION entity, see :class:`UnderlayDefinition`.
The DXF standard supports three different file formats: PDF, DWF (DWFx) and DGN.
An Underlay can be clipped by a rectangle or a polygon path. The clipping coordinates
are 2D :ref:`OCS` coordinates in drawing units but without scaling.
.. _DXF Reference: http://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-3EC8FBCC-A85A-4B0B-93CD-C6C785959077
======================== ==========================================
Subclass of :class:`ezdxf.entities.DXFGraphic`
DXF type internal base class
Factory function :meth:`ezdxf.layouts.BaseLayout.add_underlay`
Inherited DXF attributes :ref:`Common graphical DXF attributes`
Required DXF version DXF R2000 (``'AC1015'``)
======================== ==========================================
.. class:: Underlay
Base class of :class:`PdfUnderlay`, :class:`DwfUnderlay` and :class:`DgnUnderlay`
.. attribute:: dxf.insert
Insertion point, lower left corner of the image in :ref:`OCS`.
.. attribute:: dxf.scale_x
Scaling factor in x-direction (float)
.. attribute:: dxf.scale_y
Scaling factor in y-direction (float)
.. attribute:: dxf.scale_z
Scaling factor in z-direction (float)
.. attribute:: dxf.rotation
ccw rotation in degrees around the extrusion vector (float)
.. attribute:: dxf.extrusion
extrusion vector, default is (0, 0, 1)
.. attribute:: dxf.underlay_def_handle
Handle to the underlay definition entity, see :class:`UnderlayDefinition`
.. attribute:: dxf.flags
============================== ======= ===========
:attr:`dxf.flags` Value Description
============================== ======= ===========
UNDERLAY_CLIPPING 1 clipping is on/off
UNDERLAY_ON 2 underlay is on/off
UNDERLAY_MONOCHROME 4 Monochrome
UNDERLAY_ADJUST_FOR_BACKGROUND 8 Adjust for background
============================== ======= ===========
.. attribute:: dxf.contrast
Contrast value (20 - 100; default is 100)
.. attribute:: dxf.fade
Fade value (0 - 80; default is 0)
.. attribute:: clipping
``True`` or ``False`` (read/write)
.. attribute:: on
``True`` or ``False`` (read/write)
.. attribute:: monochrome
``True`` or ``False`` (read/write)
.. attribute:: adjust_for_background
``True`` or ``False`` (read/write)
.. attribute:: scale
Scaling (x, y, z) tuple (read/write)
.. attribute:: boundary_path
Boundary path as list of vertices (read/write).
Two vertices describe a rectangle (lower left and upper right corner), more than
two vertices is a polygon as clipping path.
.. method:: get_underlay_def
Returns the associated DEFINITION entity. see :class:`UnderlayDefinition`.
.. method:: set_underlay_def
Set the associated DEFINITION entity. see :class:`UnderlayDefinition`.
.. automethod:: reset_boundary_path
PdfUnderlay
-----------
======================== ==========================================
Subclass of :class:`ezdxf.entities.Underlay`
DXF type ``'PDFUNDERLAY'``
Factory function :meth:`ezdxf.layouts.BaseLayout.add_underlay`
Inherited DXF attributes :ref:`Common graphical DXF attributes`
Required DXF version DXF R2000 (``'AC1015'``)
======================== ==========================================
.. class:: PdfUnderlay
PDF underlay.
DwfUnderlay
-----------
======================== ==========================================
Subclass of :class:`ezdxf.entities.Underlay`
DXF type ``'DWFUNDERLAY'``
Factory function :meth:`ezdxf.layouts.BaseLayout.add_underlay`
Inherited DXF attributes :ref:`Common graphical DXF attributes`
Required DXF version DXF R2000 (``'AC1015'``)
======================== ==========================================
.. class:: DwfUnderlay
DWF underlay.
DgnUnderlay
-----------
======================== ==========================================
Subclass of :class:`ezdxf.entities.Underlay`
DXF type ``'DGNUNDERLAY'``
Factory function :meth:`ezdxf.layouts.BaseLayout.add_underlay`
Inherited DXF attributes :ref:`Common graphical DXF attributes`
Required DXF version DXF R2000 (``'AC1015'``)
======================== ==========================================
.. class:: DgnUnderlay
DGN underlay.
|
