feat: Add dark mode

Author: AlejandroFernandezLuces

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

@@ -179,25 +179,25 @@ def scene(self) -> pv.Plotter:
         """PyVista scene."""
         return self._pl.scene
 
-    def enable_widgets(self):
+    def enable_widgets(self, dark_mode: bool = False) -> None:
         """Enable the widgets for the plotter."""
         # 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.
@@ -446,7 +446,7 @@ def show(
             )
         # Enable widgets and picking capabilities
         if screenshot is None and not ansys.tools.visualization_interface.DOCUMENTATION_BUILD:
-            self.enable_widgets()
+            self.enable_widgets(dark_mode=True)
 
         if self._allow_picking:
             self.enable_picking()

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

@@ -46,9 +46,10 @@ class Button(PlotterWidget):
 
     """
 
-    def __init__(self, plotter: Plotter, button_config: tuple):
+    def __init__(self, plotter: Plotter, button_config: tuple, dark_mode: bool = False) -> None:
         """Initialize the ``Button`` class."""
         super().__init__(plotter)
+        self._dark_mode = dark_mode
         self._button: vtkButtonWidget = self.plotter.add_checkbox_button_widget(
             self.callback, position=button_config.value[2], size=30, border_size=3
         )
@@ -68,9 +69,13 @@ def callback(self, state: bool) -> None:
 
     def update(self) -> None:
         """Assign the image that represents the button."""
+        if self._dark_mode:
+            is_inv = "_inv"
+        else:
+            is_inv = ""
         button_repr = self._button.GetRepresentation()
         button_icon_path = Path(
-            Path(__file__).parent / "_images", self.button_config.value[1]
+            Path(__file__).parent / "_images", self.button_config.value[1] + is_inv + ".png"
         )
         button_icon = vtkPNGReader()
         button_icon.SetFileName(button_icon_path)

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

@@ -50,9 +50,9 @@ class DisplacementArrow(Button):
 
     """
 
-    def __init__(self, plotter: Plotter, direction: CameraPanDirection):
+    def __init__(self, plotter: Plotter, direction: CameraPanDirection, dark_mode: bool = False) -> None:
         """Initialize the ``DisplacementArrow`` class."""
-        super().__init__(plotter, direction)
+        super().__init__(plotter, direction, dark_mode)
         self.direction = direction
         self.update()
 

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

@@ -41,11 +41,11 @@ class HideButton(PlotterWidget):
 
     """
 
-    def __init__(self, plotter: "Plotter") -> None:
+    def __init__(self, plotter: "Plotter", dark_mode: bool = False) -> None:
         """Initialize the ``HideButton`` class."""
         # Call PlotterWidget ctor
         super().__init__(plotter._pl.scene)
-
+        self._dark_mode = dark_mode
         # Initialize variables
         self._actor: vtkActor = None
         self._plotter = plotter
@@ -70,17 +70,22 @@ def callback(self, state: bool) -> None:
                     widget._button.GetRepresentation().SetVisibility(0)
         else:
             for widget in self.plotter._widgets:
-                    widget._button.On()
-                    widget._button.GetRepresentation().SetVisibility(1)
+                widget._button.On()
+                widget._button.GetRepresentation().SetVisibility(1)
 
     def update(self) -> None:
         """Define the hide widget button parameters."""
+        if self._dark_mode:
+            is_inv = "_inv"
+        else:
+            is_inv = ""
+
         show_vr = self._button.GetRepresentation()
         show_vison_icon_file = Path(
-            Path(__file__).parent / "_images"/ "visibilityon.png"
+            Path(__file__).parent / "_images" / ("visibilityon" + is_inv + ".png")
         )
         show_visoff_icon_file = Path(
-            Path(__file__).parent / "_images"/ "visibilityoff.png"
+            Path(__file__).parent / "_images" / ("visibilityon" + is_inv + ".png")
         )
         show_r_on = vtkPNGReader()
         show_r_on.SetFileName(show_vison_icon_file)

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

@@ -41,11 +41,11 @@ class MeasureWidget(PlotterWidget):
 
     """
 
-    def __init__(self, plotter_helper: "Plotter") -> None:
+    def __init__(self, plotter_helper: "Plotter", dark_mode: bool = False) -> None:
         """Initialize the ``MeasureWidget`` class."""
         # Call PlotterWidget ctor
         super().__init__(plotter_helper._pl.scene)
-
+        self._dark_mode = dark_mode
         # Initialize variables
         self._actor: vtkActor = None
         self.plotter_helper = plotter_helper
@@ -84,9 +84,13 @@ def callback(self, state: bool) -> None:
 
     def update(self) -> None:
         """Define the measurement widget button parameters."""
+        if self._dark_mode:
+            is_inv = "_inv"
+        else:
+            is_inv = ""
         show_measure_vr = self._button.GetRepresentation()
         show_measure_icon_file = Path(
-            Path(__file__).parent / "_images"/ "measurement.png"
+            Path(__file__).parent / "_images" / ("measurement" + is_inv + ".png")
         )
         show_measure_r = vtkPNGReader()
         show_measure_r.SetFileName(show_measure_icon_file)

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

@@ -41,11 +41,11 @@ class MeshSliderWidget(PlotterWidget):
 
     """
 
-    def __init__(self, plotter_helper: "Plotter") -> None:
+    def __init__(self, plotter_helper: "Plotter", dark_mode: bool = False) -> None:
         """Initialize the ``MeshSliderWidget`` class."""
         # Call PlotterWidget ctor
         super().__init__(plotter_helper._pl.scene)
-
+        self._dark_mode = dark_mode
         # Initialize variables
         self._widget_actor: vtkActor = None
         self.plotter_helper = plotter_helper
@@ -101,9 +101,13 @@ def callback(self, state: bool) -> None:
 
     def update(self) -> None:
         """Define the mesh slider widget button parameters."""
+        if self._dark_mode:
+            is_inv = "_inv"
+        else:
+            is_inv = ""
         show_measure_vr = self._button.GetRepresentation()
         show_measure_icon_file = Path(
-            Path(__file__).parent / "_images"/ "planecut.png"
+            Path(__file__).parent / "_images"/ ("planecut" + is_inv + ".png")
         )
         show_measure_r = vtkPNGReader()
         show_measure_r.SetFileName(show_measure_icon_file)

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

@@ -39,11 +39,11 @@ class Ruler(PlotterWidget):
 
     """
 
-    def __init__(self, plotter: Plotter) -> None:
+    def __init__(self, plotter: Plotter, dark_mode: bool = False) -> None:
         """Initialize the ``Ruler`` class."""
         # Call PlotterWidget ctor
         super().__init__(plotter)
-
+        self._dark_mode = dark_mode
         # Initialize variables
         self._actor: vtkActor = None
         self._button: vtkButtonWidget = self.plotter.add_checkbox_button_widget(
@@ -84,8 +84,12 @@ def callback(self, state: bool) -> None:
 
     def update(self) -> None:
         """Define the configuration and representation of the ruler widget button."""
+        if self._dark_mode:
+            is_inv = "_inv"
+        else:
+            is_inv = ""
         show_ruler_vr = self._button.GetRepresentation()
-        show_ruler_icon_file = Path(Path(__file__).parent / "_images" / "ruler.png")
+        show_ruler_icon_file = Path(Path(__file__).parent / "_images" / ("ruler" + is_inv + ".png"))
         show_ruler_r = vtkPNGReader()
         show_ruler_r.SetFileName(show_ruler_icon_file)
         show_ruler_r.Update()

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

@@ -39,11 +39,11 @@ class ScreenshotButton(PlotterWidget):
 
     """
 
-    def __init__(self, plotter: Plotter) -> None:
+    def __init__(self, plotter: Plotter, dark_mode: bool = False) -> None:
         """Initialize the ``ScreenshotButton`` class."""
         # Call PlotterWidget ctor
         super().__init__(plotter)
-
+        self._dark_mode = dark_mode
         # Initialize variables
         self._actor: vtkActor = None
         self._button: vtkButtonWidget = self.plotter._pl.scene.add_checkbox_button_widget(
@@ -69,8 +69,12 @@ def callback(self, state: bool) -> None:
 
     def update(self) -> None:
         """Define the configuration and representation of the screenshot widget button."""
+        if self._dark_mode:
+            is_inv = "_inv"
+        else:
+            is_inv = ""
         show_vr = self._button.GetRepresentation()
-        show_icon_file = Path(Path(__file__).parent / "_images" / "screenshot.png")
+        show_icon_file = Path(Path(__file__).parent / "_images" / ("screenshot" + is_inv + ".png"))
         show_r = vtkPNGReader()
         show_r.SetFileName(show_icon_file)
         show_r.Update()

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

@@ -31,13 +31,13 @@
 class ViewDirection(Enum):
     """Provides an enum with the available views."""
 
-    XYPLUS = 0, "+xy.png", (5, 220)
-    XYMINUS = 1, "-xy.png", (5, 251)
-    XZPLUS = 2, "+xz.png", (5, 282)
-    XZMINUS = 3, "-xz.png", (5, 313)
-    YZPLUS = 4, "+yz.png", (5, 344)
-    YZMINUS = 5, "-yz.png", (5, 375)
-    ISOMETRIC = 6, "isometric.png", (5, 406)
+    XYPLUS = 0, "+xy", (5, 220)
+    XYMINUS = 1, "-xy", (5, 251)
+    XZPLUS = 2, "+xz", (5, 282)
+    XZMINUS = 3, "-xz", (5, 313)
+    YZPLUS = 4, "+yz", (5, 344)
+    YZMINUS = 5, "-yz", (5, 375)
+    ISOMETRIC = 6, "isometric", (5, 406)
 
 
 class ViewButton(Button):
@@ -52,9 +52,9 @@ class ViewButton(Button):
 
     """
 
-    def __init__(self, plotter: Plotter, direction: tuple):
+    def __init__(self, plotter: Plotter, direction: tuple, dark_mode: bool = False) -> None:
         """Initialize the ``ViewButton`` class."""
-        super().__init__(plotter, direction)
+        super().__init__(plotter, direction, dark_mode)
         self.direction = direction
         self.update()