Debian Codegraph @

pyvista/trame/ui/__init__.py

raw
1 """PyVista Trame User Interface.
2
3 This module builds a base UI for manipulating a PyVista Plotter.
4 The UI generated here is the default for rendering in Jupyter
5 environments and provides a starting point for custom user-built
6 applications.
7 """
8
9 from __future__ import annotations
10
11 from typing import TYPE_CHECKING
12
13 from trame.app import get_server
14
15 from pyvista._warn_external import warn_external
16
17 from .vuetify2 import Viewer as Vue2Viewer
18 from .vuetify3 import Viewer as Vue3Viewer
19
20 if TYPE_CHECKING:
21 from .base_viewer import BaseViewer
22
23 _VIEWERS: dict[str, BaseViewer] = {}
24 UI_TITLE = 'PyVista'
25
26
27 def get_viewer(plotter, server=None, suppress_rendering=False):
28 """Get a Viewer instance for a given Plotter.
29
30 There should be only one Viewer instance per plotter. A Viewer
31 can have multiple UI views though.
32
33 Parameters
34 ----------
35 plotter : pyvista.Plotter
36 Plotter to return or create the viewer instance for.
37
38 server : trame.Server, optional
39 Current server for Trame application.
40
41 suppress_rendering : bool, default: False
42 Suppress rendering on the plotter.
43
44 Returns
45 -------
46 pyvista.trame.ui.Viewer
47 Trame viewer.
48
49 """
50 if plotter._id_name in _VIEWERS:
51 viewer = _VIEWERS[plotter._id_name]
52 if suppress_rendering != plotter.suppress_rendering:
53 plotter.suppress_rendering = suppress_rendering
54 warn_external(
55 'Suppress rendering on the plotter is changed to ' + str(suppress_rendering),
56 UserWarning,
57 )
58 return viewer
59
60 if not server:
61 server = get_server()
62 if server.client_type == 'vue2':
63 viewer = Vue2Viewer(plotter, suppress_rendering=suppress_rendering, server=server)
64 else:
65 viewer = Vue3Viewer(plotter, suppress_rendering=suppress_rendering, server=server)
66
67 _VIEWERS[plotter._id_name] = viewer
68 return viewer
69
70
71 def plotter_ui(
72 plotter,
73 mode=None,
74 default_server_rendering=True,
75 collapse_menu=False,
76 add_menu=True,
77 **kwargs,
78 ):
79 """Create a UI view for the given Plotter.
80
81 Parameters
82 ----------
83 plotter : pyvista.Plotter
84 Plotter to create the UI for.
85
86 mode : str, default: 'trame'
87 The UI view mode. Options are:
88
89 * ``'trame'``: Uses a view that can switch between client and server
90 rendering modes.
91 * ``'server'``: Uses a view that is purely server rendering.
92 * ``'client'``: Uses a view that is purely client rendering (generally
93 safe without a virtual frame buffer)
94
95 default_server_rendering : bool, default: True
96 Whether to use server-side or client-side rendering on-start when
97 using the ``'trame'`` mode.
98
99 collapse_menu : bool, default: False
100 Collapse the UI menu (camera controls, etc.) on start.
101
102 add_menu : bool, default: True
103 Add a UI controls VCard to the VContainer.
104
105 **kwargs : dict, optional
106 Additional keyword arguments are passed to the viewer being created.
107
108 Returns
109 -------
110 output : PyVistaRemoteLocalView | PyVistaRemoteView | PyVistaLocalView
111 Trame view interface for pyvista.
112
113 """
114 viewer = get_viewer(plotter, server=kwargs.get('server'), suppress_rendering=mode == 'client')
115 return viewer.ui(
116 mode=mode,
117 default_server_rendering=default_server_rendering,
118 collapse_menu=collapse_menu,
119 add_menu=add_menu,
120 **kwargs,
121 )