feat: Add threshold for auto selection

Author: AlejandroFernandezLuces

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
 
@@ -180,7 +182,13 @@ def scene(self) -> pv.Plotter:
         return self._pl.scene
 
     def enable_widgets(self, dark_mode: bool = False) -> None:
-        """Enable the widgets for the plotter."""
+        """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] = []
@@ -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(dark_mode=True)
+            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()

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

@@ -43,6 +43,8 @@ class Button(PlotterWidget):
         Plotter to draw the buttons on.
     button_config : tuple
         Tuple containing the position and the path to the icon of the button.
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
 
     """
 

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

@@ -30,12 +30,12 @@
 class CameraPanDirection(Enum):
     """Provides an enum with the available movement directions of the camera."""
 
-    XUP = 0, "upxarrow.png", (5, 170)
-    XDOWN = 1, "downarrow.png", (5, 130)
-    YUP = 2, "upyarrow.png", (35, 170)
-    YDOWN = 3, "downarrow.png", (35, 130)
-    ZUP = 4, "upzarrow.png", (65, 170)
-    ZDOWN = 5, "downarrow.png", (65, 130)
+    XUP = 0, "upxarrow", (5, 170)
+    XDOWN = 1, "downarrow", (5, 130)
+    YUP = 2, "upyarrow", (35, 170)
+    YDOWN = 3, "downarrow", (35, 130)
+    ZUP = 4, "upzarrow", (65, 170)
+    ZDOWN = 5, "downarrow", (65, 130)
 
 
 class DisplacementArrow(Button):
@@ -47,7 +47,8 @@ class DisplacementArrow(Button):
         Plotter to draw the buttons on.
     direction : CameraPanDirection
         Direction that the camera is to move.
-
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
     """
 
     def __init__(self, plotter: Plotter, direction: CameraPanDirection, dark_mode: bool = False) -> None:

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

@@ -38,6 +38,8 @@ class HideButton(PlotterWidget):
     ----------
     plotter_helper : PlotterHelper
         Plotter to add the hide widget to.
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
 
     """
 

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

@@ -38,6 +38,8 @@ class MeasureWidget(PlotterWidget):
     ----------
     plotter_helper : PlotterHelper
         Plotter to add the measure widget to.
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
 
     """
 

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

@@ -38,6 +38,8 @@ class MeshSliderWidget(PlotterWidget):
     ----------
     plotter_helper : PlotterHelper
         Plotter to add the mesh slider widget to.
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
 
     """
 

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

@@ -36,6 +36,8 @@ class Ruler(PlotterWidget):
     ----------
     plotter : ~pyvista.Plotter
         Provides the plotter to add the ruler widget to.
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
 
     """
 

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

@@ -36,6 +36,8 @@ class ScreenshotButton(PlotterWidget):
     ----------
     plotter : ~pyvista.Plotter
         Provides the plotter to add the screenshot widget to.
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
 
     """
 

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

@@ -49,7 +49,8 @@ class ViewButton(Button):
         Plotter to draw the buttons on.
     direction : ViewDirection
         Direction of the view.
-
+    dark_mode : bool, optional
+        Whether to activate the dark mode or not.
     """
 
     def __init__(self, plotter: Plotter, direction: tuple, dark_mode: bool = False) -> None: