-
Notifications
You must be signed in to change notification settings - Fork 64
Expand file tree
/
Copy path_common.py
More file actions
293 lines (214 loc) · 8.33 KB
/
_common.py
File metadata and controls
293 lines (214 loc) · 8.33 KB
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
from typing import Sequence
import numpy as np
from ._base import GraphicFeature, GraphicFeatureEvent, block_reentrance
class Name(GraphicFeature):
event_info_spec = [
{"dict key": "value", "type": "str", "description": "user provided name"},
]
def __init__(self, value: str, property_name: str = "name"):
"""Graphic name"""
self._value = value
super().__init__(property_name=property_name)
@property
def value(self) -> str:
return self._value
@block_reentrance
def set_value(self, graphic, value: str):
if not isinstance(value, str):
raise TypeError("`Graphic` name must be of type <str>")
if graphic._plot_area is not None:
graphic._plot_area._check_graphic_name_exists(value)
self._value = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class Offset(GraphicFeature):
event_info_spec = [
{
"dict key": "value",
"type": "np.ndarray[float, float, float]",
"description": "new offset (x, y, z)",
},
]
def __init__(
self, value: np.ndarray | Sequence[float], property_name: str = "offset"
):
"""Offset position of the graphic, [x, y, z]"""
self._validate(value)
# initialize zeros array
self._value = np.zeros(3)
# set values
self._value[:] = value
super().__init__(property_name=property_name)
def _validate(self, value):
if not len(value) == 3:
raise ValueError("offset must be a list, tuple, or array of 3 float values")
@property
def value(self) -> np.ndarray:
return self._value
@block_reentrance
def set_value(self, graphic, value: np.ndarray | Sequence[float]):
self._validate(value)
value = np.asarray(value)
graphic.world_object.world.position = value
# sometimes there are transforms so get the final position value like this
value = graphic.world_object.world.position.copy()
# set value of existing feature value array
self._value[:] = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class Rotation(GraphicFeature):
event_info_spec = [
{
"dict key": "value",
"type": "np.ndarray[float, float, float, float]",
"description": "new rotation quaternion",
},
]
def __init__(
self, value: np.ndarray | Sequence[float], property_name: str = "rotation"
):
"""Graphic rotation quaternion"""
self._validate(value)
# create zeros array
self._value = np.zeros(4)
self._value[:] = value
super().__init__(property_name=property_name)
def _validate(self, value):
if not len(value) == 4:
raise ValueError(
"rotation quaternion must be a list, tuple, or array of 4 float values"
)
@property
def value(self) -> np.ndarray:
return self._value
@block_reentrance
def set_value(self, graphic, value: np.ndarray | Sequence[float]):
self._validate(value)
value = np.asarray(value)
graphic.world_object.world.rotation = value
# get the actual final quaternion value, pygfx adjusts to make sure || q ||_2 == 1
# i.e. pygfx checks to make sure norm 1 and other transforms
value = graphic.world_object.world.rotation.copy()
# set value of existing feature value array
self._value[:] = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class Scale(GraphicFeature):
event_info_spec = [
{
"dict key": "value",
"type": "np.ndarray[float, float, float, float]",
"description": "new scale",
},
]
def __init__(
self, value: np.ndarray | Sequence[float], property_name: str = "scale"
):
"""Graphic scaling factor"""
self._validate(value)
# create ones array
self._value = np.ones(3)
self._value[:] = value
super().__init__(property_name=property_name)
def _validate(self, value):
if not len(value) in [2, 3]:
raise ValueError(
"scale must be a list, tuple, or array of 2 or 3 float values indicating (x, y) or (x, y, z) scaling"
)
@property
def value(self) -> np.ndarray:
return self._value
@block_reentrance
def set_value(self, graphic, value: np.ndarray | Sequence[float]):
self._validate(value)
if len(value) == 2:
value = (*value, graphic.world_object.world.scale_z)
value = np.asarray(value)
graphic.world_object.world.scale = value
# set value of existing feature value array
self._value[:] = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class Alpha(GraphicFeature):
"""The alpha value (i.e. opacity) of a graphic."""
event_info_spec = [
{"dict key": "value", "type": "float", "description": "new alpha value"},
]
def __init__(self, value: float, property_name: str = "alpha"):
self._value = value
super().__init__(property_name=property_name)
@property
def value(self) -> float:
return self._value
@block_reentrance
def set_value(self, graphic, value: float):
wo = graphic.world_object
if wo.material is not None:
wo.material.opacity = value
if "Image" in graphic.__class__.__name__:
# Image and ImageVolume use tiling and share one material
graphic._material.alpha = value
self._value = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class AlphaMode(GraphicFeature):
"""The alpha-mode value of a graphic (i.e. how alpha is handled by the renderer)."""
event_info_spec = [
{"dict key": "value", "type": "str", "description": "new alpha mode"},
]
def __init__(self, value: str, property_name: str = "alpha_mode"):
self._value = value
super().__init__(property_name=property_name)
@property
def value(self) -> str:
return self._value
@block_reentrance
def set_value(self, graphic, value: str):
wo = graphic.world_object
if wo.material is not None:
wo.alpha_mode = value
if "Image" in graphic.__class__.__name__:
# Image and ImageVolume use tiling and share one material
graphic._material.alpha_mode = value
self._value = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class Visible(GraphicFeature):
"""Access or change the visibility."""
event_info_spec = [
{"dict key": "value", "type": "bool", "description": "new visibility bool"},
]
def __init__(self, value: bool, property_name: str = "visible"):
self._value = value
super().__init__(property_name=property_name)
@property
def value(self) -> bool:
return self._value
@block_reentrance
def set_value(self, graphic, value: bool):
graphic.world_object.visible = value
self._value = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)
class Deleted(GraphicFeature):
"""
Used when a graphic is deleted, triggers events that can be useful to indicate this graphic has been deleted
"""
event_info_spec = [
{
"dict key": "value",
"type": "bool",
"description": "True when graphic was deleted",
},
]
def __init__(self, value: bool, property_name: str = "deleted"):
self._value = value
super().__init__(property_name=property_name)
@property
def value(self) -> bool:
return self._value
@block_reentrance
def set_value(self, graphic, value: bool):
self._value = value
event = GraphicFeatureEvent(type=self._property_name, info={"value": value})
self._call_event_handlers(event)