feat(background): add menu to select bg color

Author: jourdain

src/e3sm_quickview/app.py

@@ -232,6 +232,7 @@ def _build_ui(self, **_):
             with v3.VLayout():
                 drawers.Tools(
                     reset_camera=self.view_manager.reset_camera,
+                    update_background=self.view_manager.update_background,
                 )
 
                 with v3.VMain():

src/e3sm_quickview/components/drawers.py

@@ -8,7 +8,7 @@
 
 
 class Tools(v3.VNavigationDrawer):
-    def __init__(self, reset_camera=None):
+    def __init__(self, reset_camera=None, update_background=None):
         super().__init__(
             permanent=True,
             rail=("compact_drawer", True),
@@ -50,6 +50,7 @@ def __init__(self, reset_camera=None):
                     v3.VDivider(classes="my-1")  # ---------------------
 
                     tools.CaptureFullPanel(click="utils.quickview.capturePanel()")
+                    tools.BackgroundColors(update_background=update_background)
 
                     # dev add-on ui reload
                     if self.server.hot_reload:

src/e3sm_quickview/components/tools.py

@@ -343,3 +343,77 @@ async def _tauri_save(self):
         txt_content = self.ctrl.download_state()
         Path(export_path).write_text(txt_content)
         self._pending_task = None
+
+
+class BackgroundColors(v3.VTooltip):
+    def __init__(
+        self,
+        compact="compact_drawer",
+        title="Background Colors",
+        update_background=None,
+    ):
+        super().__init__(
+            text=title,
+            disabled=(f"!{compact}",),
+        )
+        self._pending_task = None
+        with self:
+            with v3.Template(v_slot_activator="{ props }"):
+                with v3.VListItem(
+                    v_bind="props",
+                    prepend_icon="mdi-format-color-fill",
+                    title=(f"{compact} ? null : '{title}'",),
+                ):
+                    with v3.VMenu(
+                        activator="parent",
+                        location="end",
+                        offset=10,
+                    ):
+                        with v3.VList(density="compact"):
+                            v3.VListItem(
+                                title="Dark gradient background",
+                                click=(
+                                    update_background,
+                                    "[[84 / 255, 89 / 255, 109 / 255, 0, 0, 42 / 255]]",
+                                ),
+                            )
+                            v3.VListItem(
+                                title="Soft Black",
+                                click=(update_background, "[[0.071,0.071,0.071]]"),
+                            )
+                            v3.VListItem(
+                                title="Charcoal",
+                                click=(update_background, "[[0.118,0.118,0.118]]"),
+                            )
+                            v3.VListItem(
+                                title="Dark Gray",
+                                click=(update_background, "[[0.169,0.169,0.169]]"),
+                            )
+                            v3.VListItem(
+                                title="Graphite",
+                                click=(update_background, "[[0.200,0.200,0.200]]"),
+                            )
+                            v3.VListItem(
+                                title="Perceptual Mid-Gray",
+                                click=(update_background, "[[0.467,0.467,0.467]]"),
+                            )
+                            v3.VListItem(
+                                title="Medium Gray",
+                                click=(update_background, "[[0.502,0.502,0.502]]"),
+                            )
+                            v3.VListItem(
+                                title="Light Gray",
+                                click=(update_background, "[[0.851,0.851,0.851]]"),
+                            )
+                            v3.VListItem(
+                                title="Off-White",
+                                click=(update_background, "[[0.949,0.949,0.949]]"),
+                            )
+                            v3.VListItem(
+                                title="White",
+                                click=(update_background, "[[1,1,1]]"),
+                            )
+                            v3.VListItem(
+                                title="Deep Space Blue",
+                                click=(update_background, "[[0.043,0.063,0.125]]"),
+                            )

src/e3sm_quickview/view_manager.py

@@ -61,6 +61,7 @@ def __init__(self, server, source):
         self._render_window = vtkRenderWindow()
         self._render_window.OffScreenRenderingOn()
         self._picker = vtkCellPicker(tolerance=0.0005)
+        self._bg_color = None
 
         # Perf: time the actual VTK render on the shared render window.
         # Emits `view.shared.render_window` with the elapsed time for
@@ -162,6 +163,13 @@ def refresh_ui(self, **_):
         for view in self._var2view.values():
             view._build_ui()
 
+    def update_background(self, color):
+        self._bg_color = color
+        for view in self._var2view.values():
+            view.update_background(color)
+
+        self.render()
+
     def camera_projection(self):
         self._camera.focal_point = (0, 0, 0)
         self._camera.position = (0, 0, 1)
@@ -325,6 +333,7 @@ def get_view(self, variable_name, variable_type):
                 self.server, self.source, variable_name, variable_type, self._camera
             )
             self._var2view[variable_name] = view
+            view.update_background(self._bg_color)
 
         return view
 

src/e3sm_quickview/view_panel.py

@@ -100,6 +100,24 @@ def render(self):
         if self.ctx.view:
             self.ctx.view.update()
 
+    def update_background(self, color):
+        if color is None:
+            return
+
+        size = len(color)
+        if size == 3:
+            self.renderer.background = tuple(color)
+            self.renderer.gradient_background = 0
+        elif size == 6:
+            self.renderer.background = tuple(color[0:3])
+            self.renderer.background2 = tuple(color[3:6])
+            self.renderer.gradient_background = 1
+        else:
+            msg = f"Invalid background color: {color}"
+            raise ValueError(msg)
+
+        self.render()
+
     @property
     def data_array(self):
         data_reader = self.source.data_reader