Merge pull request #22 from edsaac/custom_vtkjs

Custom vtkjs for interactive view

Author: edsaac

stpyvista/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v 0.0.17] - 2024-04-11
+- Rewrite buffer using context manager 
+- Introduce and experimental viewer based on trame and vanilla vtk-js
+
 ## [v 0.0.16] - 2024-03-29
 - Add controls help description 
 - Remove network utility - it should be a different component

stpyvista/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stpyvista"
-version = "0.0.16"
+version = "0.0.17"
 authors = [
   { name="Edwin Saavedra C.", email="esaavedrac@u.northwestern.edu" },
 ]

stpyvista/requirements.txt

@@ -1,4 +1,4 @@
 streamlit
 pyvista
 bokeh
-panel
+panel<1.4.0

stpyvista/src/stpyvista/__init__.py

@@ -1,22 +1,19 @@
 # __init__.py
 
-from io import BytesIO
+from io import StringIO
 from pathlib import Path
 from typing import Optional, Literal
+import base64
+
 import streamlit.components.v1 as components
-import pyvista as pv
+from pyvista.plotting import Plotter
+
 import panel as pn
 
 from bokeh.resources import CDN, INLINE
 
-BOKEH_RESOURCES = {"CDN": CDN, "INLINE": INLINE}
-
 pn.extension("vtk", sizing_mode="stretch_both")
-
-# Tell streamlit that there is a component called stpyvista,
-# and that the code to display that component is in the "frontend" folder
-frontend_dir = (Path(__file__).parent / "frontend").absolute()
-_component_func = components.declare_component("stpyvista", path=str(frontend_dir))
+BOKEH_RESOURCES = {"CDN": CDN, "INLINE": INLINE}
 
 
 class stpyvistaTypeError(TypeError):
@@ -27,19 +24,54 @@ class stpyvistaValueError(ValueError):
     pass
 
 
-# Create the python function that will be called from the front end
+# Tell streamlit that there is a component called `experimental_vtkjs`,
+# and that the code to display that component is in the "vanilla_vtkjs" folder
+experimental_frontend_dir = (Path(__file__).parent / "vanilla_vtkjs").absolute()
+_exp_component_func = components.declare_component(
+    "experimental_vtkjs", path=str(experimental_frontend_dir)
+)
+
+
+def experimental_vtkjs(vtksz_data: bytes, key: Optional[str] = None):
+    """
+    Renders an interactive Pyvista Plotter in streamlit.
+    
+    Parameters
+    ----------
+    vtksz_data: bytes
+        Data from a vtksz in zip format.
+    
+    Returns
+    -------
+    str
+        A stringified JSON with camera view properties.
+    """
+    
+    base64_str = base64.b64encode(vtksz_data).decode().replace("\n", "")
+
+    component_value = _exp_component_func(
+        plotter_data=base64_str,
+        key=key,
+        default=0,
+    )
+
+    return component_value
+
+
+frontend_dir = (Path(__file__).parent / "panel_based").absolute()
+_component_func = components.declare_component("stpyvista", path=str(frontend_dir))
 
 
 def stpyvista(
-    plotter: pv.Plotter,
+    plotter: Plotter,
     use_container_width: bool = True,
     horizontal_align: Literal["center", "left", "right"] = "center",
     panel_kwargs: Optional[dict] = None,
     bokeh_resources: Literal["CDN", "INLINE"] = "INLINE",
     key: Optional[str] = None,
 ) -> None:
     """
-    Renders an interactive pyvisya Plotter in streamlit.
+    Renders an interactive Pyvista Plotter in streamlit.
     
     Parameters
     ----------
@@ -79,7 +111,7 @@ def stpyvista(
 
     """
 
-    if isinstance(plotter, pv.Plotter):
+    if isinstance(plotter, Plotter):
         if panel_kwargs is None:
             panel_kwargs = dict()
 
@@ -95,10 +127,9 @@ def stpyvista(
             )
 
         # Create HTML file
-        model_bytes = BytesIO()
-        geo_pan_pv.save(model_bytes, resources=BOKEH_RESOURCES[bokeh_resources])
-        panel_html = model_bytes.getvalue().decode("utf-8")
-        model_bytes.close()
+        with StringIO() as model_bytes:
+            geo_pan_pv.save(model_bytes, resources=BOKEH_RESOURCES[bokeh_resources])
+            panel_html = model_bytes.getvalue()
 
         component_value = _component_func(
             panel_html=panel_html,

stpyvista/src/stpyvista/export.py

@@ -0,0 +1,53 @@
+from trame.app import get_server
+from trame.widgets import (
+    vuetify as vuetify,
+)
+
+from trame.widgets.vtk import VtkLocalView
+from trame.ui.vuetify import SinglePageLayout
+
+from pyvista.plotting import Plotter
+
+SERVER_NAME = "stpyvista_server"
+
+
+async def export_vtksz(plotter: Plotter):
+    """Export this plotter as a VTK.js OfflineLocalView file.
+
+    Parameters
+    ----------
+    plotter : Plotter
+        PyVista Plotter object.
+
+    Returns
+    -------
+    bytes
+        The exported plotter view.
+    """
+
+    # Get a trame server and launch it
+    server = get_server(name=SERVER_NAME, client_type="vue2")
+    _, ctrl = server.state, server.controller
+
+    with SinglePageLayout(server) as layout:
+        with layout.content:
+            view = VtkLocalView(plotter.ren_win)
+            ctrl.view_update = view.update
+
+    server.start(
+        exec_mode="task",
+        host="127.0.0.1",
+        port="0",
+        open_browser=False,
+        show_connection_info=False,
+        disable_logging=True,
+        timeout=0,
+        backend="tornado",
+    )
+
+    content = view.export(format=format)
+    view.release_resources()
+
+    return content
+
+