Debian Codegraph @

pyvista/trame/ui/base_viewer.py

raw
1 """PyVista Trame Base Viewer class.
2
3 This base class defines methods to manipulate a PyVista Plotter.
4 This base class does not define a `ui` method, but its derived classes do.
5 See `pyvista.trame.ui.vuetify2` and ``pyvista.trame.ui.vuetify3` for its derived classes.
6 """
7
8 from __future__ import annotations
9
10 import io
11 from typing import TYPE_CHECKING
12
13 from trame.app import get_server
14
15 import pyvista as pv
16
17 if TYPE_CHECKING:
18 from trame_client.ui.core import AbstractLayout
19
20
21 class BaseViewer:
22 """Internal wrapper to sync trame view with Plotter.
23
24 Parameters
25 ----------
26 plotter : pyvista.Plotter
27 Target Plotter instance to view.
28 server : trame.Server, optional
29 Current Server for Trame Application.
30 suppress_rendering : bool, default=False
31 Whether to suppress rendering on the Plotter.
32
33 """
34
35 def __init__(self, plotter, server=None, suppress_rendering=False):
36 """Initialize Viewer."""
37 self._html_views = set()
38
39 if server is None:
40 server = get_server()
41 self.server = server
42 self.plotter = plotter
43 self.plotter.suppress_rendering = suppress_rendering
44
45 # State variable names
46 self.SHOW_UI = f'{plotter._id_name}_show_ui'
47 self.GRID = f'{plotter._id_name}_grid_visibility'
48 self.OUTLINE = f'{plotter._id_name}_outline_visibility'
49 self.EDGES = f'{plotter._id_name}_edge_visibility'
50 self.AXIS = f'{plotter._id_name}_axis_visibility'
51 self.PARALLEL = f'{plotter._id_name}_parallel_projection'
52 self.SERVER_RENDERING = f'{plotter._id_name}_use_server_rendering'
53 self.VALID_UI_MODES = [
54 'trame',
55 'client',
56 'server',
57 ]
58 server.state[self.SHOW_UI] = True
59 server.state[self.GRID] = False
60 server.state[self.OUTLINE] = False
61 server.state[self.EDGES] = False
62 server.state[self.AXIS] = False
63 server.state[self.PARALLEL] = False
64
65 @property
66 def views(self): # numpydoc ignore=RT01
67 """Get a set of all associate trame views for this viewer."""
68 return self._html_views
69
70 def update(self, **kwargs): # noqa: ARG002
71 """Update all associated views.
72
73 Parameters
74 ----------
75 **kwargs : dict, optional
76 Unused keyword arguments.
77
78 """
79 for view in self._html_views:
80 view.update()
81
82 def push_camera(self, **kwargs): # noqa: ARG002
83 """Push camera to all associated views.
84
85 Parameters
86 ----------
87 **kwargs : dict, optional
88 Unused keyword arguments.
89
90 """
91 for view in self._html_views:
92 view.push_camera()
93
94 def reset_camera(self, **kwargs): # noqa: ARG002
95 """Reset camera for all associated views.
96
97 Parameters
98 ----------
99 **kwargs : dict, optional
100 Unused keyword arguments.
101
102 """
103 for view in self._html_views:
104 view.reset_camera()
105
106 def update_image(self, **kwargs): # noqa: ARG002
107 """Update image for all associated views.
108
109 Parameters
110 ----------
111 **kwargs : dict, optional
112 Unused keyword arguments.
113
114 """
115 for view in self._html_views:
116 view.update_image()
117
118 def update_camera(self, **kwargs): # noqa: ARG002
119 """Update image and camera for all associated views.
120
121 Parameters
122 ----------
123 **kwargs : dict, optional
124 Unused keyword arguments.
125
126 """
127 for view in self._html_views:
128 view.update_camera()
129
130 def view_isometric(self):
131 """View isometric."""
132 self.plotter.view_isometric(render=False)
133 self.update_camera()
134
135 def view_yz(self):
136 """View YZ plane."""
137 self.plotter.view_yz(render=False)
138 self.update_camera()
139
140 def view_xz(self):
141 """View XZ plane."""
142 self.plotter.view_xz(render=False)
143 self.update_camera()
144
145 def view_xy(self):
146 """View XY plane."""
147 self.plotter.view_xy(render=False)
148 self.update_camera()
149
150 def on_parallel_projection_change(self, **kwargs):
151 """Toggle parallel projection for all renderers.
152
153 Parameters
154 ----------
155 **kwargs : dict, optional
156 Unused keyword arguments.
157
158 """
159 value = kwargs[self.PARALLEL]
160 for renderer in self.plotter.renderers:
161 if value:
162 renderer.enable_parallel_projection()
163 else:
164 renderer.disable_parallel_projection()
165 self.update()
166
167 def on_edge_visibility_change(self, **kwargs):
168 """Toggle edge visibility for all actors.
169
170 Parameters
171 ----------
172 **kwargs : dict, optional
173 Unused keyword arguments.
174
175 """
176 value = kwargs[self.EDGES]
177 for renderer in self.plotter.renderers:
178 for actor in renderer.actors.values():
179 if isinstance(actor, pv.Actor):
180 actor.prop.show_edges = value
181 self.update()
182
183 def on_grid_visibility_change(self, **kwargs):
184 """Handle axes grid visibility.
185
186 Parameters
187 ----------
188 **kwargs : dict, optional
189 Unused keyword arguments.
190
191 """
192 value = kwargs[self.GRID]
193 for renderer in self.plotter.renderers:
194 if value:
195 renderer.show_grid()
196 else:
197 renderer.remove_bounds_axes()
198 self.update()
199
200 def on_outline_visibility_change(self, **kwargs):
201 """Handle outline visibility.
202
203 Parameters
204 ----------
205 **kwargs : dict, optional
206 Unused keyword arguments.
207
208 """
209 value = kwargs[self.OUTLINE]
210 for renderer in self.plotter.renderers:
211 if value:
212 renderer.add_bounding_box(reset_camera=False)
213 else:
214 renderer.remove_bounding_box()
215 self.update()
216
217 def on_axis_visibility_change(self, **kwargs):
218 """Handle outline visibility.
219
220 Parameters
221 ----------
222 **kwargs : dict, optional
223 Unused keyword arguments.
224
225 """
226 value = kwargs[self.AXIS]
227 for renderer in self.plotter.renderers:
228 if value:
229 renderer.show_axes()
230 else:
231 renderer.hide_axes()
232 for view in self._html_views:
233 # Check if 'set_widgets' is defined directly in the class, not just as a
234 # dynamic attribute. The Trame-Client getattr prints an error message which
235 # is undesirable in this case.
236 # https://github.com/Kitware/trame-client/blob/8e3e2042214fd238b628216bff48d1762adf50a3/trame_client/widgets/core.py#L467
237 if 'set_widgets' in type(view).__dict__:
238 method = getattr(view, 'set_widgets', None)
239 # VtkRemoteView does not have set_widgets function, but
240 # VtkRemoteLocalView and VtkLocalView do.
241 if callable(method):
242 method(
243 [
244 ren.axes_widget
245 for ren in self.plotter.renderers
246 if ren.axes_widget is not None
247 ],
248 )
249 self.update()
250
251 def on_rendering_mode_change(self, **kwargs):
252 """Handle any configurations when the render mode changes between client and server.
253
254 Parameters
255 ----------
256 **kwargs : dict, optional
257 Unused keyword arguments.
258
259 """
260 if not kwargs[self.SERVER_RENDERING]:
261 self.update_camera()
262
263 @property
264 def actors(self): # numpydoc ignore=RT01
265 """Get dataset actors."""
266 return {k: v for k, v in self.plotter.actors.items() if isinstance(v, pv.Actor)}
267
268 def screenshot(self):
269 """Take screenshot and add attachament.
270
271 Returns
272 -------
273 memoryview
274 Screenshot as a ``memoryview``.
275
276 """
277 self.plotter.render()
278 self.update() # makes sure the plotter and views are in sync
279 buffer = io.BytesIO()
280 self.plotter.screenshot(filename=buffer)
281 buffer.seek(0)
282 return memoryview(buffer.read())
283
284 def export(self): # numpydoc ignore=RT01
285 """Export the scene as a zip file."""
286 for view in self._html_views:
287 return memoryview(view.export_html())
288 msg = 'This viewer cannot be exported.'
289 raise TypeError(msg)
290
291 def ui(self):
292 """Implement in derived classes."""
293 raise NotImplementedError
294
295 def make_layout(self, *args, **kwargs) -> AbstractLayout: # pragma: no cover
296 """Create an instance of an AbstractLayout which is appropriate for a concrete viewer.
297
298 Parameters
299 ----------
300 *args : tuple
301 Positional arguments.
302
303 **kwargs : dict, optional
304 Keyword arguments.
305
306 Returns
307 -------
308 AbstractLayout
309 A layout this viewer can be embedded in.
310
311 """
312 raise NotImplementedError