fix: Add support for MultiBlock

Author: AlejandroFernandezLuces

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

@@ -46,6 +46,15 @@
 # Plot the mesh
 pl.plot(mesh)
 
+
+# Create a PyVista MultiBlock
+multi_block = pv.MultiBlock()
+multi_block.append(pv.Sphere(center=(-1, -1, 0)))
+multi_block.append(pv.Cube(center=(-1, 1, 0)))
+
+# Plot the MultiBlock
+pl.plot(multi_block)
+
 #####################
 # Display the plotter
 #
@@ -66,7 +75,6 @@ def name(self):
         return self.name
 
 
-
 # Create a custom object
 custom_cube = CustomObject()
 custom_cube.name = "CustomCube"
@@ -111,6 +119,8 @@ def name(self):
 )
 pl.plot(scatter)
 
+
+
 ###########################
 # Display the plotter again
 # =========================

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

@@ -24,6 +24,7 @@
 from typing import Any, Iterable, Union
 
 import plotly.graph_objects as go
+import pyvista as pv
 from pyvista import PolyData
 
 from ansys.tools.visualization_interface.backends._base import BaseBackend
@@ -37,8 +38,46 @@ def __init__(self) -> None:
         """Initialize the Plotly backend."""
         self._fig = go.Figure()
 
-    def _pv_to_mesh3d(self, pv_mesh: PolyData) -> go.Mesh3d:
-        """Convert a PyVista PolyData mesh to Plotly Mesh3d format.
+    def _pv_to_mesh3d(self, pv_mesh: Union[PolyData, pv.MultiBlock]) -> Union[go.Mesh3d, list]:
+        """Convert a PyVista PolyData or MultiBlock mesh to Plotly Mesh3d format.
+
+        Parameters
+        ----------
+        pv_mesh : Union[PolyData, pv.MultiBlock]
+            The PyVista PolyData or MultiBlock mesh to convert.
+
+        Returns
+        -------
+        Union[go.Mesh3d, list]
+            The converted Plotly Mesh3d object(s). Returns a single Mesh3d for PolyData,
+            or a list of Mesh3d objects for MultiBlock.
+        """
+        if isinstance(pv_mesh, pv.MultiBlock):
+            # Handle MultiBlock by converting each block and returning a list
+            mesh_list = []
+            for i, block in enumerate(pv_mesh):
+                if block is not None:
+                    # Convert each block to PolyData if needed
+                    if hasattr(block, 'extract_surface'):
+                        # For volume meshes, extract the surface
+                        block = block.extract_surface()
+                    elif not isinstance(block, PolyData):
+                        # Try to convert to PolyData
+                        try:
+                            block = block.cast_to_polydata()
+                        except AttributeError:
+                            continue  # Skip blocks that can't be converted
+
+                    # Now convert the PolyData block
+                    mesh_3d = self._convert_polydata_to_mesh3d(block)
+                    mesh_list.append(mesh_3d)
+            return mesh_list
+        else:
+            # Handle single PolyData
+            return self._convert_polydata_to_mesh3d(pv_mesh)
+
+    def _convert_polydata_to_mesh3d(self, pv_mesh: PolyData) -> go.Mesh3d:
+        """Convert a single PolyData mesh to Plotly Mesh3d format.
 
         Parameters
         ----------
@@ -96,23 +135,36 @@ def plot_iter(self, plotting_list: Iterable[Any]) -> None:
             self.plot(item)
 
 
-    def plot(self, plottable_object: Union[PolyData, MeshObjectPlot, go.Mesh3d], **plotting_options) -> None:
+    def plot(
+            self,
+            plottable_object: Union[PolyData, pv.MultiBlock, MeshObjectPlot, go.Mesh3d],
+            **plotting_options
+        ) -> None:
         """Plot a single object using Plotly.
 
         Parameters
         ----------
-        plottable_object : Union[PolyData, MeshObjectPlot, go.Mesh3d]
-            The object to plot. Can be a PyVista PolyData, a MeshObjectPlot, or a Plotly Mesh3d.
+        plottable_object : Union[PolyData, pv.MultiBlock, MeshObjectPlot, go.Mesh3d]
+            The object to plot. Can be a PyVista PolyData, MultiBlock, a MeshObjectPlot, or a Plotly Mesh3d.
         plotting_options : dict
             Additional plotting options.
         """
-        if isinstance(plottable_object, PolyData):
-            mesh = self._pv_to_mesh3d(plottable_object)
-            self._fig.add_trace(mesh)
-        elif isinstance(plottable_object, MeshObjectPlot):
-            pv_mesh = plottable_object.mesh
-            mesh = self._pv_to_mesh3d(pv_mesh)
-            self._fig.add_trace(mesh)
+        if isinstance(plottable_object, MeshObjectPlot):
+            mesh = plottable_object.mesh
+        else:
+            mesh = plottable_object
+
+        if isinstance(mesh, (PolyData, pv.MultiBlock)):
+            mesh_result = self._pv_to_mesh3d(mesh)
+
+            # Handle both single mesh and list of meshes
+            if isinstance(mesh_result, list):
+                # MultiBlock case - add all meshes
+                for mesh_3d in mesh_result:
+                    self._fig.add_trace(mesh_3d)
+            else:
+                # Single PolyData case
+                self._fig.add_trace(mesh_result)
         elif isinstance(plottable_object, go.Mesh3d):
             self._fig.add_trace(plottable_object)
         else:

src/ansys/tools/visualization_interface/types/edge_plot.py

@@ -22,8 +22,9 @@
 """Provides the edge type for plotting."""
 
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Union
 
+from plotly.graph_objects import Mesh3d
 import pyvista as pv
 
 if TYPE_CHECKING:
@@ -34,7 +35,7 @@ class EdgePlot:
 
     Parameters
     ----------
-    actor : ~pyvista.Actor
+    actor : Union[~pyvista.Actor, Mesh3d]
         PyVista actor that represents the edge.
     edge_object : Edge
         PyAnsys object edge that is represented by the PyVista actor.
@@ -43,7 +44,7 @@ class EdgePlot:
 
     """
 
-    def __init__(self, actor: pv.Actor, edge_object: Any, parent: Any = None) -> None:
+    def __init__(self, actor: Union[pv.Actor, Mesh3d], edge_object: Any, parent: Any = None) -> None:
         """Initialize ``EdgePlot`` variables."""
         self._actor = actor
         self._object = edge_object

src/ansys/tools/visualization_interface/types/mesh_object_plot.py

@@ -22,8 +22,9 @@
 """Provides the ``MeshObjectPlot`` class."""
 
 
-from typing import Any, List, Union
+from typing import Any, List, Type, Union
 
+from plotly.graph_objects import Mesh3d
 import pyvista as pv
 
 from ansys.tools.visualization_interface.types.edge_plot import EdgePlot
@@ -35,7 +36,7 @@ class MeshObjectPlot:
     def __init__(
         self,
         custom_object: Any,
-        mesh: Union[pv.PolyData, pv.MultiBlock],
+        mesh: Union[pv.PolyData, pv.MultiBlock, Mesh3d],
         actor: pv.Actor = None,
         edges: List[EdgePlot] = None,
     ) -> None:
@@ -49,7 +50,7 @@ def __init__(
         ----------
         custom_object : Any
             Any object that the consumer library wants to relate with a mesh.
-        mesh : Union[pv.PolyData, pv.MultiBlock]
+        mesh : Union[pv.PolyData, pv.MultiBlock, Mesh3d]
             PyVista mesh that represents the custom object.
         actor : pv.Actor, default: None
             Actor of the mesh in the plotter.
@@ -63,7 +64,7 @@ def __init__(
         self._edges = edges
 
     @property
-    def mesh(self) -> Union[pv.PolyData, pv.MultiBlock]:
+    def mesh(self) -> Union[pv.PolyData, pv.MultiBlock, Mesh3d]:
         """Mesh of the object in PyVista format.
 
         Returns
@@ -75,12 +76,12 @@ def mesh(self) -> Union[pv.PolyData, pv.MultiBlock]:
         return self._mesh
 
     @mesh.setter
-    def mesh(self, mesh: Union[pv.PolyData, pv.MultiBlock]):
+    def mesh(self, mesh: Union[pv.PolyData, pv.MultiBlock, Mesh3d]):
         """Set the mesh of the object in PyVista format.
 
         Parameters
         ----------
-        mesh : Union[pv.PolyData, pv.MultiBlock]
+        mesh : Union[pv.PolyData, pv.MultiBlock, Mesh3d]
             Mesh of the object.
 
         """
@@ -174,3 +175,15 @@ def name(self) -> str:
             return self._custom_object.id
         else:
             return "Unknown"
+
+    @property
+    def mesh_type(self) -> Type:
+        """Type of the mesh.
+
+        Returns
+        -------
+        type
+            Type of the mesh.
+
+        """
+        return type(self._mesh)

tests/test_plotly_backend.py

@@ -71,6 +71,25 @@ def test_plot_pyvista_mesh(tmp_path, image_compare):
     assert image_compare(file)
 
 
+def test_plot_pyvista_multiblock(tmp_path, image_compare):
+    """Test plotting a PyVista MultiBlock mesh."""
+    # Create a plotter with the Plotly backend
+    pl = Plotter(backend=PlotlyBackend())
+
+    # Create a PyVista MultiBlock
+    multi_block = pv.MultiBlock()
+    multi_block.append(pv.Sphere(center=(-1, -1, 0)))
+    multi_block.append(pv.Cube(center=(-1, 1, 0)))
+
+    # Plot the MultiBlock
+    pl.plot(multi_block)
+
+    # Show the plot (this will open a browser window)
+    file = tmp_path / "test_plot_pyvista_multiblock.png"
+    pl.show(screenshot=file)
+    assert image_compare(file)
+
+
 def test_plot_mesh_object_plot(tmp_path, image_compare):
     """Test plotting a MeshObjectPlot."""
     # Create a plotter with the Plotly backend