Merge pull request #7 from Kitware/widget-handling

fix(widgets): handle registration and state delivery

Author: jourdain

README.rst

@@ -20,7 +20,7 @@ Installation
     # We need a VTK that has its wasm counterpart
     # This is the first version available with it
     # For ParaView (not yet supported), VTK don't need to be installed
-    pip install "vtk==9.3.20240525.dev0" --extra-index-url https://wheels.vtk.org
+    pip install "vtk==9.3.20240817.dev0" --extra-index-url https://wheels.vtk.org
 
 
 Development
@@ -64,11 +64,21 @@ Running examples
     # We need a VTK that has its wasm counterpart
     # This is the first version available with it
     # For ParaView (not yet supported), VTK don't need to be installed
-    pip install "vtk==9.3.20240418.dev0" --extra-index-url https://wheels.vtk.org
+    pip install "vtk==9.3.20240810.dev0" --extra-index-url https://wheels.vtk.org
 
     # regular trame app
     python ./examples/vtk/cone.py 
 
 
 Some example are meant to test and validate WASM rendering.
 Some will default for remote rendering but if you want to force them to use WASM just run `export USE_WASM=1` before executing them.
+
+SharedArrayBuffer
+----------------------------------------
+
+To enable SharedArrayBuffer within trame you can run the following.
+
+.. code-block:: console
+
+    export WSLINK_HTTP_HEADERS=./http_headers.json
+    python ./examples/vtk/cone.py

examples/pv/README.md

@@ -1,3 +1,7 @@
+# ParaView support
+
+Not Supported yet but we hope to get it working with 5.14 or nightly after 5.13 release.
+
 ## Setup 
 
 ```

examples/pv/cone.py

@@ -16,6 +16,10 @@
 class DemoApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type=CLIENT_TYPE)
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
         self.cone = simple.Cone()
         self.representation = simple.Show()
         self.view = simple.Render()

examples/pyvista/basic.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import pyvista as pv
 from pyvista import examples
 
@@ -7,7 +7,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -32,6 +32,10 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
         self.render_window, self.widgets = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()

examples/pyvista/bg_image.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import pyvista as pv
 from pyvista import examples
 
@@ -7,7 +7,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -17,9 +17,10 @@ def setup_pyvista():
     p.add_mesh(examples.load_airplane(), smooth_shading=True)
     p.add_background_image(examples.mapfile)
     p.reset_camera()
-    # p.show_axes() # FIXME
+    p.show_axes()
+    widgets = [r.axes_widget for r in p.renderers if hasattr(r, "axes_widget")]
 
-    return p.ren_win
+    return p.ren_win, widgets
 
 
 # -----------------------------------------------------------------------------
@@ -28,7 +29,11 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
-        self.render_window = setup_pyvista()
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
+        self.render_window, self.widgets = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()
 
@@ -40,6 +45,8 @@ def _ui(self):
             ):
                 if WASM:
                     self.html_view = vtklocal.LocalView(self.render_window)
+                    for w in self.widgets:
+                        self.html_view.register_widget(w)
                 else:
                     self.html_view = vtk_widgets.VtkRemoteView(
                         self.render_window, interactive_ratio=1

examples/pyvista/drap2dsurf.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import numpy as np
 import pyvista as pv
 from pyvista import examples
@@ -8,7 +8,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -34,9 +34,10 @@ def setup_pyvista():
     p.add_mesh(grid, cmap="seismic", clim=[-1, 1])
     p.add_mesh(pv.PolyData(path), color="orange")
     p.reset_camera()
-    # p.show_axes() # FIXME
+    p.show_axes()
+    widgets = [r.axes_widget for r in p.renderers if hasattr(r, "axes_widget")]
 
-    return p.ren_win
+    return p.ren_win, widgets
 
 
 # -----------------------------------------------------------------------------
@@ -45,7 +46,11 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
-        self.render_window = setup_pyvista()
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
+        self.render_window, self.widgets = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()
 
@@ -57,6 +62,8 @@ def _ui(self):
             ):
                 if WASM:
                     self.html_view = vtklocal.LocalView(self.render_window)
+                    for w in self.widgets:
+                        self.html_view.register_widget(w)
                 else:
                     self.html_view = vtk_widgets.VtkRemoteView(
                         self.render_window, interactive_ratio=1

examples/pyvista/eye_dome_lighting.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import pyvista as pv
 from pyvista import examples
 
@@ -7,7 +7,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -20,8 +20,9 @@ def setup_pyvista():
     p.enable_eye_dome_lighting()
     p.reset_camera()
     p.show_axes()
+    widgets = [r.axes_widget for r in p.renderers if hasattr(r, "axes_widget")]
 
-    return p.ren_win
+    return p.ren_win, widgets
 
 
 # -----------------------------------------------------------------------------
@@ -30,7 +31,11 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
-        self.render_window = setup_pyvista()
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
+        self.render_window, self.widgets = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()
 
@@ -42,6 +47,8 @@ def _ui(self):
             ):
                 if WASM:
                     self.html_view = vtklocal.LocalView(self.render_window)
+                    for w in self.widgets:
+                        self.html_view.register_widget(w)
                 else:
                     self.html_view = vtk_widgets.VtkRemoteView(
                         self.render_window, interactive_ratio=1

examples/pyvista/glyph.py

@@ -32,6 +32,10 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
         self.render_window = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()

examples/pyvista/isolines.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import pyvista as pv
 from pyvista import examples
 
@@ -7,7 +7,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -31,6 +31,10 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
         self.render_window = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()

examples/pyvista/labels.py

@@ -1,4 +1,3 @@
-import os
 import numpy as np
 import pyvista as pv
 
@@ -7,7 +6,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -40,7 +39,7 @@ def get_point_along_spline(distance):
 
     p = pv.Plotter()
     p.add_mesh(spline, scalars="arc_length", render_lines_as_tubes=True, line_width=10)
-    p.add_point_labels(
+    labels = p.add_point_labels(
         label_points,
         labels,
         always_visible=True,
@@ -61,9 +60,19 @@ def get_point_along_spline(distance):
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
         self.render_window = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()
+        self.server.state.change("scale")(self.update_scale)
+
+    def update_scale(self, scale, **_):
+        print(scale)
+        # self.text.SetTextScaleModeToViewport()
+        # self.html_view.update()
 
     def _ui(self):
         with DivLayout(self.server) as layout:
@@ -77,6 +86,14 @@ def _ui(self):
                     self.html_view = vtk_widgets.VtkRemoteView(
                         self.render_window, interactive_ratio=1
                     )
+                html.Input(
+                    type="range",
+                    min=0.5,
+                    max=4,
+                    step=0.1,
+                    v_model=("scale", 1),
+                    style="position: absolute; top: 10px; left: 10px; z-index: 100; width: calc(100vw - 20px);",
+                )
 
         return layout
 

examples/pyvista/linked_view.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import pyvista as pv
 from pyvista import examples
 
@@ -7,7 +7,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -25,9 +25,10 @@ def setup_pyvista():
     p.add_mesh(decimated, color=True, show_edges=True)
     p.link_views()  # link all the views
     p.reset_camera()
-    # p.show_axes() # FIXME
+    p.show_axes()
+    widgets = [r.axes_widget for r in p.renderers if hasattr(r, "axes_widget")]
 
-    return p.ren_win
+    return p.ren_win, widgets
 
 
 # -----------------------------------------------------------------------------
@@ -36,7 +37,11 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
-        self.render_window = setup_pyvista()
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
+        self.render_window, self.widgets = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()
 
@@ -48,6 +53,8 @@ def _ui(self):
             ):
                 if WASM:
                     self.html_view = vtklocal.LocalView(self.render_window)
+                    for w in self.widgets:
+                        self.html_view.register_widget(w)
                 else:
                     self.html_view = vtk_widgets.VtkRemoteView(
                         self.render_window, interactive_ratio=1

examples/pyvista/pbr.py

@@ -1,4 +1,4 @@
-import os
+# import os
 import pyvista as pv
 from pyvista import examples
 
@@ -7,7 +7,7 @@
 from trame.widgets import html, client, vtk as vtk_widgets
 from trame_vtklocal.widgets import vtklocal
 
-WASM = "USE_WASM" in os.environ
+WASM = True  # "USE_WASM" in os.environ
 
 # -----------------------------------------------------------------------------
 
@@ -33,6 +33,10 @@ def setup_pyvista():
 class TrameApp:
     def __init__(self, server=None):
         self.server = get_server(server, client_type="vue3")
+
+        # enable shared array buffer
+        self.server.http_headers.shared_array_buffer = True
+
         self.render_window = setup_pyvista()
         self.html_view = None
         self.ui = self._ui()