feat: Add support for plotly backend

Author: AlejandroFernandezLuces

examples/01-basic-plotly-examples/plain-usage.py

@@ -0,0 +1,71 @@
+from ansys.tools.visualization_interface.backends.plotly.plotly_interface import PlotlyBackend
+from ansys.tools.visualization_interface.types import MeshObjectPlot
+from ansys.tools.visualization_interface import Plotter
+import pyvista as pv
+from plotly.graph_objects import Mesh3d
+
+# Create a plotter with the Plotly backend
+pl = Plotter(backend=PlotlyBackend())
+
+# Create a PyVista mesh
+mesh = pv.Sphere()
+
+# Plot the mesh
+pl.plot(mesh)
+
+# Display the plotter
+pl.show()
+
+# Now create a custom object
+class CustomObject:
+    def __init__(self):
+        self.name = "CustomObject"
+        self.mesh = pv.Cube(center=(1, 1, 0))
+
+    def get_mesh(self):
+        return self.mesh
+
+    def name(self):
+        return self.name
+
+
+
+# Create a custom object
+custom_cube = CustomObject()
+custom_cube.name = "CustomCube"
+
+# Create a MeshObjectPlot instance
+mesh_object_cube = MeshObjectPlot(custom_cube, custom_cube.get_mesh())
+
+# Plot the custom mesh object
+pl.plot(mesh_object_cube)
+
+# Since Plotly is a web-based visualization, we can show the plot again to include the new object
+pl.show()
+
+# Add a Plotly Mesh3d object directly
+custom_mesh3d = Mesh3d(
+    x=[0, 1, 2],
+    y=[0, 1, 0],
+    z=[0, 0, 1],
+    i=[0],
+    j=[1],
+    k=[2],
+    color='lightblue',
+    opacity=0.50
+)
+pl.plot(custom_mesh3d)
+pl.show()
+
+# Show other plotly objects like Scatter3d
+from plotly.graph_objects import Scatter3d
+
+scatter = Scatter3d(
+    x=[0, 1, 2],
+    y=[0, 1, 0],
+    z=[0, 0, 1],
+    mode='markers',
+    marker=dict(size=5, color='red')
+)
+pl.plot(scatter)
+pl.show()

examples/01-advanced-pyansys-examples/README.txt renamed to examples/99-advanced-pyansys-examples/README.txt

@@ -39,6 +39,7 @@ pyvistaqt = [
 
 plotly = [
     "plotly >= 5.15.0,<6",
+    "kaleido >= 1.1.0,<2",
 ]
 tests = [
     "pytest==8.4.2",

examples/01-advanced-pyansys-examples/mixing_elbow.vtk renamed to examples/99-advanced-pyansys-examples/mixing_elbow.vtk

@@ -6,7 +6,7 @@
 from typing import Union, Iterable, Any
 
 
-class PlotlyInterface(BaseBackend):
+class PlotlyBackend(BaseBackend):
     """Plotly interface for visualization."""
 
     def __init__(self, **kwargs):
@@ -17,16 +17,20 @@ def _pv_to_mesh3d(self, pv_mesh: PolyData) -> go.Mesh3d:
         points = pv_mesh.points
         x, y, z = points[:, 0], points[:, 1], points[:, 2]
 
-        faces = pv_mesh.faces.reshape((-1, 4))  # First number in each row is the number of points in the face (3 for triangles)
+        # Convert mesh to triangular mesh if needed, since Plotly only supports triangular faces
+        triangulated_mesh = pv_mesh.triangulate()
+        
+        # Extract triangular faces
+        faces = triangulated_mesh.faces.reshape((-1, 4))  # Now we know all faces are triangular (3 vertices + count)
         i, j, k = faces[:, 1], faces[:, 2], faces[:, 3]
 
         return go.Mesh3d(x=x, y=y, z=z, i=i, j=j, k=k)
     @property
     def layout(self) -> Any:
         """Get the current layout of the Plotly figure."""
         return self._fig.layout
-    
-    @setters.layout
+
+    @layout.setter
     def layout(self, new_layout: Any):
         """Set a new layout for the Plotly figure."""
         self._fig.update_layout(new_layout)
@@ -54,6 +58,22 @@ def plot(self, plottable_object: Union[PolyData, MeshObjectPlot, go.Mesh3d], **p
             except Exception:
                 raise TypeError("Unsupported plottable_object type for PlotlyInterface.")
 
-    def show(self):
+    def show(self, 
+            plottable_object=None,
+            screenshot: str = None,
+            name_filter=None,
+            **kwargs):
         """Render the Plotly scene."""
-        self._fig.show()
+        if plottable_object is not None:
+            self.plot(plottable_object)
+        
+        # Only show in browser if no screenshot is being taken
+        if not screenshot:
+            self._fig.show(**kwargs)
+        
+        if screenshot:
+            screenshot_str = str(screenshot)
+            if screenshot_str.endswith('.html'):
+                self._fig.write_html(screenshot_str)
+            else:
+                self._fig.write_image(screenshot_str)

examples/01-advanced-pyansys-examples/using_meshobject_with_field_data.py renamed to examples/99-advanced-pyansys-examples/using_meshobject_with_field_data.py

@@ -49,6 +49,18 @@ def backend(self):
         """Return the base plotter object."""
         return self._backend
 
+    def plot_iter(self, plotting_list: List, **plotting_options):
+        """Plots multiple objects using the specified backend.
+
+        Parameters
+        ----------
+        plotting_list : List
+            List of objects to plot.
+        plotting_options : dict
+            Additional plotting options.
+        """
+        self._backend.plot_iter(plotting_list=plotting_list, **plotting_options)
+
     def plot(self, plottable_object: Any, **plotting_options):
         """Plots an object using the specified backend.
 

pyproject.toml

@@ -20,3 +20,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Provides custom types."""
+from .mesh_object_plot import MeshObjectPlot

src/ansys/tools/visualization_interface/backends/plotly/plotly_interface.py

@@ -23,21 +23,51 @@
 import os
 
 import pytest
+from PIL import Image, ImageChops
+from pathlib import Path
 
 os.environ.setdefault("PYANSYS_VISUALIZER_TESTMODE", "true")
 
-@pytest.fixture(autouse=True)
-def wrapped_verify_image_cache(verify_image_cache):
-    """Wraps the verify_image_cache fixture to ensure that the image cache is verified.
-
-    Parameters
-    ----------
-    verify_image_cache : fixture
-        Fixture to wrap.
-
-    Returns
-    -------
-    fixture
-        Wrapped fixture.
-    """
-    return verify_image_cache
+@pytest.fixture
+def image_compare():
+    """Fixture to compare images."""
+    def _compare_images(generated_image_path):
+        """Compare two images and optionally save the difference image.
+
+        Parameters
+        ----------
+        generated_image_path : str
+            Path to the generated image.
+        baseline_image_path : str
+            Path to the baseline image.
+        diff_image_path : str, optional
+            Path to save the difference image if images do not match.
+
+        Returns
+        -------
+        bool
+            True if images match, False otherwise.
+        """
+        # Get the name of the image file using Pathlib
+        image_name = Path(generated_image_path).name
+
+        # Define the baseline image path
+        baseline_image_path = Path(__file__).parent / "_image_cache" / image_name
+
+        img1 = Image.open(generated_image_path).convert("RGB")
+        try:
+            img2 = Image.open(baseline_image_path).convert("RGB")
+        except FileNotFoundError:
+            # copy generated image to baseline location if baseline does not exist
+            img1.save(baseline_image_path)
+            img2 = Image.open(baseline_image_path).convert("RGB")
+
+        # Compute the difference between the two images
+        diff = ImageChops.difference(img1, img2)
+
+        if diff.getbbox() is None:
+            return True
+        else:
+            return False
+
+    return _compare_images

src/ansys/tools/visualization_interface/plotter.py

@@ -42,6 +42,23 @@ def __init__(self, name) -> None:
         self.name = name
 
 
+@pytest.fixture(autouse=True)
+def wrapped_verify_image_cache(verify_image_cache):
+    """Wraps the verify_image_cache fixture to ensure that the image cache is verified.
+
+    Parameters
+    ----------
+    verify_image_cache : fixture
+        Fixture to wrap.
+
+    Returns
+    -------
+    fixture
+        Wrapped fixture.
+    """
+    return verify_image_cache
+
+
 def test_plotter_add_pd():
     """Adds polydata to the plotter."""
     pl = Plotter()