File: user_data_stored_in_XDATA.py

package info (click to toggle)
ezdxf 1.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 104,528 kB
  • sloc: python: 182,341; makefile: 116; lisp: 20; ansic: 4
file content (139 lines) | stat: -rw-r--r-- 2,767 bytes parent folder | download
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
#  Copyright (c) 2021-2022, Manfred Moitzi
#  License: MIT License

import pathlib
import ezdxf
from ezdxf.math import Vec3
from ezdxf.render.forms import gear
from ezdxf import zoom
from ezdxf.entities.xdata import XDataUserDict, XDataUserList

CWD = pathlib.Path("~/Desktop/Outbox").expanduser()
if not CWD.exists():
    CWD = pathlib.Path(".")

# ------------------------------------------------------------------------------
# This example shows how to store user data in the XDATA section of DXF entities.
# docs: https://ezdxf.mozman.at/docs/user_xdata.html#
# tutorial: https://ezdxf.mozman.at/docs/tutorials/custom_data.html
# ------------------------------------------------------------------------------

doc = ezdxf.new()
msp = doc.modelspace()
gear = msp.add_lwpolyline(
    gear(16, top_width=1, bottom_width=3, height=2, outside_radius=10),
    close=True,
)
handle = gear.dxf.handle

# default dict name = "DefaultDict"
# default appid = "EZDXF"
# If using an own AppID, don't forget to create the requited AppID table entry
# e.g. doc.appids.new("MyAppID"), otherwise AutoCAD will not open the DXF file.

# Supported data: str, int, float and Vec3

with XDataUserDict.entity(gear) as user_dict:
    # has a dict-like interface
    user_dict["CreatedBy"] = "mozman"
    user_dict["Float"] = 3.1415
    user_dict["Int"] = 4711
    user_dict["Point"] = Vec3(1, 2, 3)

# The XDATA structure looks like this:
#   0
# LWPOLYLINE
# ...
# 1001
# EZDXF
# 1000
# DefaultDict
# 1002
# {
# 1000
# CreatedBy
# 1000
# mozman
# 1000
# Float
# 1040
# 3.1415
# 1000
# Int
# 1071
# 4711
# 1000
# Point
# 1010
# 1.0
# 1020
# 2.0
# 1030
# 3.0
# 1002
# }

# default list name = "DefaultList"
with XDataUserList.entity(gear, name="AppendedPoints") as user_list:
    # has a list-like interface
    user_list.append(Vec3(1, 0, 0))
    user_list.append(Vec3(0, 1, 0))
    user_list.append(Vec3(0, 0, 1))

# The XDATA structure looks like this:
#   0
# LWPOLYLINE
# ...
# 1001
# EZDXF
# 1000
# DefaultDict
# ...
# 1000
# AppendedPoints
# 1002
# {
# 1010
# 1.0
# 1020
# 0.0
# 1030
# 0.0
# 1010
# 0.0
# 1020
# 1.0
# 1030
# 0.0
# 1010
# 0.0
# 1020
# 0.0
# 1030
# 1.0
# 1002
# }

# XDATA will be preserved by AutoCAD, BricsCAD and of course ezdxf.

zoom.objects(msp, [gear])
doc.saveas(CWD / "gear_with_xdata.dxf")

# Retrieve data:
doc2 = ezdxf.readfile(CWD / "gear_with_xdata.dxf")
loaded_gear = doc2.entitydb.get(handle)


with XDataUserDict.entity(loaded_gear) as user_dict:
    print(user_dict)
    # acts like any other dict()
    storage = dict(user_dict)

print(f"Copy of XDataUserDict: {storage}")


with XDataUserList.entity(loaded_gear, name="AppendedPoints") as user_list:
    print(user_list)
    storage = list(user_list)

print(f"Copy of XDataUserList: {storage}")