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
|
.. module:: ezdxf.units
.. _dxf units:
DXF Units
=========
The `DXF reference`_ has no explicit information how to handle units in DXF, any
information in this section is based on experiments with BricsCAD and may differ
in other CAD applications, BricsCAD tries to be as compatible with AutoCAD as
possible. Therefore, this information should also apply to AutoCAD.
Please open an issue on `github`_ if you have any corrections or additional
information about this topic.
Length Units
------------
Any length or coordinate value in DXF is unitless in the first place, there is
no unit information attached to the value. The unit information comes from the
context where a DXF entity is used. The document/modelspace get the unit
information from the header variable $INSUNITS, paperspace and block layouts get
their unit information from the attribute :attr:`~ezdxf.layouts.BaseLayout.units`.
The modelspace object has also a :attr:`units` property, but this value do not
represent the modelspace units, this value is always set to 0 "unitless".
Get and set document/modelspace units as enum by the
:class:`~ezdxf.document.Drawing` property :attr:`units`:
.. code-block:: python
import ezdxf
from ezdxf import units
doc = ezdxf.new()
# Set centimeter as document/modelspace units
doc.units = units.CM
# which is a shortcut (including validation) for
doc.header['$INSUNITS'] = units.CM
Block Units
-----------
As said each block definition can have independent units, but there is no
implicit unit conversion applied, not in CAD applications and not in `ezdxf`.
When inserting a block reference (INSERT) into the modelspace or another block
layout with different units, the scaling factor between these units **must** be
applied explicit as DXF attributes (:attr:`xscale`, ...) of the
:class:`~ezdxf.entities.Insert` entity, e.g. modelspace in meters and block in
centimeters, x-, y- and z-scaling has to be 0.01:
.. code-block:: python
doc.units = units.M
my_block = doc.blocks.new('MYBLOCK')
my_block.units = units.CM
block_ref = msp.add_block_ref('MYBLOCK')
# Set uniform scaling for x-, y- and z-axis
block_ref.set_scale(0.01)
Use helper function :func:`conversion_factor` to calculate the
scaling factor between units:
.. code-block:: python
factor = units.conversion_factor(doc.units, my_block.units)
# factor = 100 for 1m is 100cm
# scaling factor = 1 / factor
block_ref.set_scale(1.0/factor)
.. hint::
It is never a good idea to use different measurement system in one
project, ask the NASA about their Mars Climate Orbiter from 1999.
The same applies for units of the same measurement system, just use one unit
like meters or inches.
Angle Units
-----------
Angles are always in degrees (360 deg = full circle) in counter-clockwise
orientation, unless stated explicit otherwise.
Display Format
--------------
How values are shown in the CAD GUI is controlled by the header variables
$LUNITS and $AUNITS, but this has no meaning for values stored in DXF files.
$INSUNITS
---------
The most important setting is the header variable $INSUNITS, this variable
defines the drawing units for the modelspace and therefore for the DXF
document if no further settings are applied.
The modelspace LAYOUT entity has a property :attr:`~ezdxf.layouts.BaseLayout.units`
as any layout like object, but it seem to have no meaning for the modelspace,
BricsCAD set this property always to 0, which means unitless.
The most common units are 6 for meters and 1 for inches.
.. code-block:: python
doc.header['$INSUNITS'] = 6
=== ===============
0 Unitless
1 Inches, :attr:`units.IN`
2 Feet, :attr:`units.FT`
3 Miles, :attr:`units.MI`
4 Millimeters, :attr:`units.MM`
5 Centimeters, :attr:`units.CM`
6 Meters, :attr:`units.M`
7 Kilometers, :attr:`units.KM`
8 Microinches
9 Mils
10 Yards, :attr:`units.YD`
11 Angstroms
12 Nanometers
13 Microns
14 Decimeters, :attr:`units.DM`
15 Decameters
16 Hectometers
17 Gigameters
18 Astronomical units
19 Light years
20 Parsecs
21 US Survey Feet
22 US Survey Inch
23 US Survey Yard
24 US Survey Mile
=== ===============
See also enumeration :class:`ezdxf.enums.InsertUnits`.
$MEASUREMENT
------------
The header variable $MEASUREMENT controls whether the current drawing uses
imperial or metric hatch pattern and linetype files:
This setting is independent from $INSUNITS, it is possible to set the drawing
units to inch and use metric linetypes and hatch pattern.
In BricsCAD the base scaling of linetypes and hatch pattern is defined by
the $MEASUREMENT value, the value of $INSUNITS is ignored.
.. code-block:: python
doc.header['$MEASUREMENT'] = 1
=== ===============
0 English
1 Metric
=== ===============
See also enumeration :class:`ezdxf.enums.Measurement`
$LUNITS
-------
The header variable $LUNITS defines how CAD applications display linear values
in the GUI and has no meaning for `ezdxf`:
.. code-block:: python
doc.header['$LUNITS'] = 2
=== ===============
1 Scientific
2 Decimal (default)
3 Engineering
4 Architectural
5 Fractional
=== ===============
See also enumeration :class:`ezdxf.enums.LengthUnits`
$AUNITS
-------
The header variable $AUNITS defines how CAD applications display angular values
in the GUI and has no meaning for `ezdxf`, DXF angles are always stored as
degrees in counter-clockwise orientation, unless stated explicit otherwise:
.. code-block:: python
doc.header['$AUNITS'] = 0
=== ===============
0 Decimal degrees
1 Degrees/minutes/seconds
2 Grad
3 Radians
=== ===============
See also enumeration :class:`ezdxf.enums.AngularUnits`
Helper Tools
------------
.. autofunction:: conversion_factor
.. autofunction:: unit_name
.. autofunction:: angle_unit_name
.. _github: https://github.com/mozman/ezdxf/issues
.. _DXF reference: http://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-235B22E0-A567-4CF6-92D3-38A2306D73F3
|
