Debian Codegraph @

pyvista/trame/ui/vuetify3.py

raw
1 """PyVista Trame Viewer class for a Vue 3 client.
2
3 This class, derived from `pyvista.trame.ui.base_viewer`,
4 is intended for use with a trame application where the client type is "vue3".
5 Therefore, the `ui` method implemented by this class utilizes the API of Vuetify 3.
6 """
7
8 from __future__ import annotations
9
10 from typing import TYPE_CHECKING
11
12 from trame.ui.vuetify3 import VAppLayout
13 from trame.widgets import html
14 from trame.widgets import vuetify3 as vuetify
15
16 from pyvista.trame.views import PyVistaLocalView
17 from pyvista.trame.views import PyVistaRemoteLocalView
18 from pyvista.trame.views import PyVistaRemoteView
19
20 from .base_viewer import BaseViewer
21
22 if TYPE_CHECKING:
23 from trame_client.ui.core import AbstractLayout
24
25
26 def button(click, icon, tooltip): # numpydoc ignore=PR01
27 """Create a vuetify button."""
28 with vuetify.VTooltip(location='bottom'):
29 with vuetify.Template(v_slot_activator=('{ props }',)):
30 with vuetify.VBtn(
31 icon=True,
32 v_bind=('props',),
33 variant='text',
34 size='default',
35 click=click,
36 density='comfortable',
37 ):
38 vuetify.VIcon(icon)
39 html.Span(tooltip)
40
41
42 def checkbox(model, icons, tooltip): # numpydoc ignore=PR01
43 """Create a vuetify checkbox."""
44 with vuetify.VTooltip(location='bottom'):
45 with vuetify.Template(v_slot_activator=('{ props }',)):
46 with html.Div(v_bind=('props',)):
47 vuetify.VCheckbox(
48 v_model=model,
49 true_icon=icons[0],
50 false_icon=icons[1],
51 density='comfortable',
52 hide_details=True,
53 )
54 html.Span(tooltip)
55
56
57 def slider(model, tooltip, **kwargs): # numpydoc ignore=PR01
58 """Create a vuetify slider."""
59 with vuetify.VTooltip(bottom=True):
60 with vuetify.Template(v_slot_activator=('{ props }',)):
61 with html.Div(v_bind=('props',)):
62 vuetify.VSlider(v_model=model, **kwargs)
63 html.Span(tooltip)
64
65
66 def text_field(model, tooltip, **kwargs): # numpydoc ignore=PR01
67 """Create a vuetify text field."""
68 with vuetify.VTooltip(bottom=True):
69 with vuetify.Template(v_slot_activator=('{ props }',)):
70 with html.Div(v_bind=('props',)):
71 vuetify.VTextField(v_model=model, **kwargs)
72 html.Span(tooltip)
73
74
75 def select(model, tooltip, **kwargs): # numpydoc ignore=PR01
76 """Create a vuetify select menu."""
77 with vuetify.VTooltip(bottom=True):
78 with vuetify.Template(v_slot_activator=('{ props }',)):
79 with html.Div(v_bind=('props',)):
80 vuetify.VSelect(v_model=model, **kwargs)
81 html.Span(tooltip)
82
83
84 def divider(**kwargs): # numpydoc ignore=PR01
85 """Create a vuetify divider."""
86 vuetify.VDivider(**kwargs)
87
88
89 class Viewer(BaseViewer):
90 """Viewer implementation compatible with Vue 3 Trame Applications."""
91
92 def __init__(self, *args, **kwargs):
93 super().__init__(*args, **kwargs)
94
95 def make_layout(self, *args, **kwargs) -> AbstractLayout:
96 """Create instance of an AbstractLayout which is appropriate for this viewer.
97
98 Parameters
99 ----------
100 *args : tuple
101 Positional arguments.
102
103 **kwargs : dict, optional
104 Keyword arguments.
105
106 Returns
107 -------
108 VAppLayout (vue3)
109 A layout this viewer can be embedded in.
110
111 """
112 return VAppLayout(*args, **kwargs)
113
114 def ui_controls(self, mode=None, default_server_rendering=True, v_show=None):
115 """Create a VRow for the UI controls.
116
117 Parameters
118 ----------
119 mode : str, default: 'trame'
120 The UI view mode. Options are:
121
122 * ``'trame'``: Uses a view that can switch between client and server
123 rendering modes.
124 * ``'server'``: Uses a view that is purely server rendering.
125 * ``'client'``: Uses a view that is purely client rendering (generally
126 safe without a virtual frame buffer)
127
128 default_server_rendering : bool, default: True
129 Whether to use server-side or client-side rendering on-start when
130 using the ``'trame'`` mode.
131
132 v_show : bool, optional
133 Conditionally show the viewer controls.
134
135 """
136 with vuetify.VRow(
137 v_show=v_show,
138 classes='pa-0 ma-0 align-center fill-height',
139 style='flex-wrap: nowrap',
140 ) as row:
141 server = row.server
142 # Listen to state changes
143 server.state.change(self.EDGES)(self.on_edge_visibility_change)
144 server.state.change(self.GRID)(self.on_grid_visibility_change)
145 server.state.change(self.OUTLINE)(self.on_outline_visibility_change)
146 server.state.change(self.AXIS)(self.on_axis_visibility_change)
147 server.state.change(self.SERVER_RENDERING)(self.on_rendering_mode_change)
148 server.state.change(self.PARALLEL)(self.on_parallel_projection_change)
149 vuetify.VDivider(vertical=True, classes='mr-1')
150 button(
151 click=self.reset_camera,
152 icon='mdi-arrow-expand-all',
153 tooltip='Reset Camera',
154 )
155 vuetify.VDivider(vertical=True, classes='mx-1')
156 button(
157 click=self.view_isometric,
158 icon='mdi-axis-arrow',
159 tooltip='Perspective view',
160 )
161 button(
162 click=self.view_yz,
163 icon='mdi-axis-x-arrow',
164 tooltip='Reset Camera X',
165 )
166 button(
167 click=self.view_xz,
168 icon='mdi-axis-y-arrow',
169 tooltip='Reset Camera Y',
170 )
171 button(
172 click=self.view_xy,
173 icon='mdi-axis-z-arrow',
174 tooltip='Reset Camera Z',
175 )
176 vuetify.VDivider(vertical=True, classes='mx-1')
177 checkbox(
178 model=(self.EDGES, False),
179 icons=('mdi-grid', 'mdi-grid-off'),
180 tooltip=f"Toggle edge visibility ({{{{ {self.EDGES} ? 'on' : 'off' }}}})",
181 )
182 checkbox(
183 model=(self.OUTLINE, False),
184 icons=('mdi-cube', 'mdi-cube-off'),
185 tooltip=f"Toggle bounding box ({{{{ {self.OUTLINE} ? 'on' : 'off' }}}})",
186 )
187 checkbox(
188 model=(self.GRID, False),
189 icons=('mdi-ruler-square', 'mdi-ruler-square'),
190 tooltip=f"Toggle ruler ({{{{ {self.GRID} ? 'on' : 'off' }}}})",
191 )
192 checkbox(
193 model=(self.AXIS, False),
194 icons=('mdi-axis-arrow-info', 'mdi-axis-arrow-info'),
195 tooltip=f"Toggle axis ({{{{ {self.AXIS} ? 'on' : 'off' }}}})",
196 )
197 # Server rendering options
198 if mode == 'trame':
199 vuetify.VDivider(vertical=True, classes='mx-1')
200 checkbox(
201 model=(self.SERVER_RENDERING, default_server_rendering),
202 icons=('mdi-dns', 'mdi-open-in-app'),
203 tooltip=f'Toggle rendering mode '
204 f"({{{{ {self.SERVER_RENDERING} ? 'remote' : 'local' }}}})",
205 )
206 with vuetify.VRow(
207 v_show=(self.SERVER_RENDERING, default_server_rendering),
208 classes='pa-0 ma-0 align-center fill-height',
209 style='flex-wrap: nowrap; flex: unset',
210 ):
211 checkbox(
212 model=(self.PARALLEL, False),
213 icons=('mdi-camera-off', 'mdi-camera-switch'),
214 tooltip=f'Toggle parallel projection '
215 f"({{{{ {self.PARALLEL} ? 'on' : 'off' }}}})",
216 )
217
218 def attach_screenshot():
219 return server.protocol.addAttachment(self.screenshot())
220
221 button(
222 # Must use single-quote string for JS here
223 click="utils.download('screenshot.png', "
224 f"trigger('{server.trigger_name(attach_screenshot)}'), "
225 "'image/png')",
226 icon='mdi-file-png-box',
227 tooltip='Save screenshot',
228 )
229
230 def attach_export():
231 return server.protocol.addAttachment(self.export())
232
233 button(
234 # Must use single-quote string for JS here
235 click="utils.download('scene-export.html', "
236 f"trigger('{server.trigger_name(attach_export)}'), "
237 "'application/octet-stream')",
238 icon='mdi-download',
239 tooltip='Export scene as HTML',
240 )
241
242 def ui(
243 self,
244 mode=None,
245 default_server_rendering=True,
246 collapse_menu=False,
247 add_menu=True,
248 add_menu_items=None,
249 **kwargs,
250 ):
251 """Generate VContainer for PyVista Plotter.
252
253 Parameters
254 ----------
255 mode : str, default: 'trame'
256 The UI view mode. Options are:
257
258 * ``'trame'``: Uses a view that can switch between client and server
259 rendering modes.
260 * ``'server'``: Uses a view that is purely server rendering.
261 * ``'client'``: Uses a view that is purely client rendering (generally
262 safe without a virtual frame buffer)
263
264 default_server_rendering : bool, default: True
265 Whether to use server-side or client-side rendering on-start when
266 using the ``'trame'`` mode.
267
268 collapse_menu : bool, default: False
269 Collapse the UI menu (camera controls, etc.) on start.
270
271 add_menu : bool, default: True
272 Add a UI controls VCard to the VContainer.
273
274 add_menu_items : callable, default: None
275 Append more UI controls to the VCard menu. Should be a function similar to
276 `Viewer.ui_controls()`.
277
278 **kwargs : dict, optional
279 Additional keyword arguments are passed to the view being created.
280
281 Returns
282 -------
283 output : PyVistaRemoteLocalView | PyVistaRemoteView | PyVistaLocalView
284 Trame view interface for pyvista.
285
286 """
287 if mode is None:
288 mode = self.plotter._theme.trame.default_mode
289 if mode not in self.VALID_UI_MODES:
290 msg = f'`{mode}` is not a valid mode choice. Use one of: {self.VALID_UI_MODES}'
291 raise ValueError(msg)
292 if mode != 'trame':
293 default_server_rendering = mode == 'server'
294
295 with vuetify.VContainer(
296 fluid=True,
297 classes='pa-0 fill-height',
298 style='position: relative',
299 trame_server=self.server,
300 ) as container:
301 server = container.server
302 # Initialize state variables
303 server.state[self.EDGES] = False
304 server.state[self.GRID] = self.plotter.renderer.cube_axes_actor is not None
305 server.state[self.OUTLINE] = self.plotter.renderer._box_object is not None
306 server.state[self.AXIS] = (
307 self.plotter.renderer.axes_widget is not None
308 and self.plotter.renderer.axes_widget.GetEnabled()
309 )
310 server.state[self.SERVER_RENDERING] = default_server_rendering
311 if add_menu:
312 server.state[self.SHOW_UI] = not collapse_menu
313 with vuetify.VCard(
314 style='position: absolute; top: 20px; left: 20px; z-index: 1; height: 36px;',
315 classes=(f"{{ 'rounded-circle': !{self.SHOW_UI} }}",),
316 ) as self.menu:
317 with vuetify.VRow(
318 classes='pa-0 ma-0 align-center fill-height',
319 style='flex-wrap: nowrap',
320 ):
321 button(
322 click=f'{self.SHOW_UI}=!{self.SHOW_UI}',
323 icon='mdi-dots-vertical',
324 tooltip=f"{{{{ {self.SHOW_UI} ? 'Hide' : 'Show' }}}} menu",
325 )
326 self.ui_controls(
327 mode=mode,
328 default_server_rendering=default_server_rendering,
329 v_show=(f'{self.SHOW_UI}',),
330 )
331 if callable(add_menu_items):
332 with vuetify.VRow(
333 v_show=(f'{self.SHOW_UI}',),
334 classes='pa-0 ma-0 align-center',
335 ):
336 add_menu_items()
337 if mode == 'trame':
338 view = PyVistaRemoteLocalView(
339 self.plotter,
340 mode=(
341 # Must use single-quote string for JS here
342 f"{self.SERVER_RENDERING} ? 'remote' : 'local'",
343 'remote' if default_server_rendering else 'local',
344 ),
345 **kwargs,
346 )
347 elif mode == 'server':
348 view = PyVistaRemoteView(self.plotter, **kwargs)
349 elif mode == 'client':
350 view = PyVistaLocalView(self.plotter, **kwargs)
351
352 self._html_views.add(view)
353 if add_menu:
354 view.menu = self.menu
355
356 return view