feat: Add dark mode when background is dark (#228)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: AlejandroFernandezLuces

doc/changelog.d/228.added.md

@@ -0,0 +1 @@
+feat: Add dark mode when background is dark

src/ansys/tools/visualization_interface/backends/pyvista/pyvista.py

@@ -55,6 +55,8 @@
 
 _HAS_TRAME = importlib.util.find_spec("pyvista.trame") and importlib.util.find_spec("trame.app")
 
+DARK_MODE_THRESHOLD = 120
+
 if TYPE_CHECKING:
     import numpy as np
 
@@ -179,25 +181,31 @@ def scene(self) -> pv.Plotter:
         """PyVista scene."""
         return self._pl.scene
 
-    def enable_widgets(self):
-        """Enable the widgets for the plotter."""
+    def enable_widgets(self, dark_mode: bool = False) -> None:
+        """Enable the widgets for the plotter.
+
+        Parameters
+        ----------
+        dark_mode : bool, default: False
+            Whether to use dark mode for the widgets.
+        """
         # Create Plotter widgets
         if self._enable_widgets:
             self._widgets: List[PlotterWidget] = []
-            self._widgets.append(Ruler(self._pl._scene))
+            self._widgets.append(Ruler(self._pl._scene, dark_mode))
             [
-                self._widgets.append(DisplacementArrow(self._pl._scene, direction=dir))
+                self._widgets.append(DisplacementArrow(self._pl._scene, dir, dark_mode))
                 for dir in CameraPanDirection
             ]
             [
-                self._widgets.append(ViewButton(self._pl._scene, direction=dir))
+                self._widgets.append(ViewButton(self._pl._scene, dir, dark_mode))
                 for dir in ViewDirection
             ]
-            self._widgets.append(MeasureWidget(self))
-            self._widgets.append(ScreenshotButton(self))
+            self._widgets.append(MeasureWidget(self, dark_mode))
+            self._widgets.append(ScreenshotButton(self, dark_mode))
             if not self._use_qt:
-                self._widgets.append(MeshSliderWidget(self))
-            self._widgets.append(HideButton(self))
+                self._widgets.append(MeshSliderWidget(self, dark_mode))
+            self._widgets.append(HideButton(self, dark_mode))
 
     def add_widget(self, widget: Union[PlotterWidget, List[PlotterWidget]]):
         """Add one or more custom widgets to the plotter.
@@ -403,6 +411,7 @@ def show(
         screenshot: Optional[str] = None,
         view_2d: Dict = None,
         name_filter: str = None,
+        dark_mode: bool = False,
         **plotting_options,
     ) -> List[Any]:
         """Plot and show any PyAnsys object.
@@ -420,6 +429,8 @@ def show(
             Dictionary with the plane and the viewup vectors of the 2D plane.
         name_filter : str, default: None
             Regular expression with the desired name or names to include in the plotter.
+        dark_mode : bool, default: False
+            Whether to use dark mode for the widgets.
         **plotting_options : dict, default: None
             Keyword arguments. For allowable keyword arguments, see the
             :meth:`Plotter.add_mesh <pyvista.Plotter.add_mesh>` method.
@@ -446,7 +457,16 @@ def show(
             )
         # Enable widgets and picking capabilities
         if screenshot is None and not ansys.tools.visualization_interface.DOCUMENTATION_BUILD:
-            self.enable_widgets()
+            if dark_mode:
+                self.enable_widgets(dark_mode=dark_mode)
+            elif all([
+                    color < DARK_MODE_THRESHOLD
+                    for color in self._pl.scene.background_color.int_rgb
+                    ]):
+                print([color for color in self._pl.scene.background_color.int_rgb])
+                self.enable_widgets(dark_mode=True)
+            else:
+                self.enable_widgets()
 
         if self._allow_picking:
             self.enable_picking()