feat: Add name filtering in the plotter (#735)

Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>

Author: AlejandroFernandezLuces

src/ansys/geometry/core/plotting/plotter.py

@@ -20,6 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """Provides plotting for various PyAnsys Geometry objects."""
+import re
+
 from beartype.typing import Any, Dict, List, Optional
 import numpy as np
 import pyvista as pv
@@ -349,6 +351,7 @@ def add(
         object: Any,
         merge_bodies: bool = False,
         merge_components: bool = False,
+        filter: str = None,
         **plotting_options,
     ) -> Dict[pv.Actor, GeomObjectPlot]:
         """
@@ -369,6 +372,8 @@ def add(
             Whether to merge the component into a single dataset. When
             ``True``, all the individual bodies are effectively combined
             into a single dataset without any hierarchy.
+        filter : str, default: None
+            Regular expression with the desired name or names you want to include in the plotter.
         **plotting_options : dict, default: None
             Keyword arguments. For allowable keyword arguments, see the
             :meth:`Plotter.add_mesh <pyvista.Plotter.add_mesh>` method.
@@ -379,7 +384,13 @@ def add(
             Mapping between the ~pyvista.Actor and the PyAnsys Geometry object.
         """
         logger.debug(f"Adding object type {type(object)} to the PyVista plotter")
+        if filter:
+            if hasattr(object, "name"):
+                if not re.search(filter, object.name):
+                    logger.debug(f"Name {object.name} not found in regex {filter}.")
+                    return self._geom_object_actors_map
 
+        # Check what kind of object we are dealing with
         if isinstance(object, List) and isinstance(object[0], pv.PolyData):
             self.add_sketch_polydata(object, **plotting_options)
         elif isinstance(object, pv.PolyData):
@@ -401,6 +412,7 @@ def add_list(
         plotting_list: List[Any],
         merge_bodies: bool = False,
         merge_components: bool = False,
+        filter: str = None,
         **plotting_options,
     ) -> Dict[pv.Actor, GeomObjectPlot]:
         """
@@ -421,6 +433,8 @@ def add_list(
             Whether to merge each body into a single dataset. When ``True``,
             all the faces of each individual body are effectively combined
             into a single dataset without separating faces.
+        filter : str, default: None
+            Regular expression with the desired name or names you want to include in the plotter.
         **plotting_options : dict, default: None
             Keyword arguments. For allowable keyword arguments, see the
             :meth:`Plotter.add_mesh <pyvista.Plotter.add_mesh>` method.
@@ -431,7 +445,7 @@ def add_list(
             Mapping between the ~pyvista.Actor and the PyAnsys Geometry objects.
         """
         for object in plotting_list:
-            _ = self.add(object, merge_bodies, merge_components, **plotting_options)
+            _ = self.add(object, merge_bodies, merge_components, filter, **plotting_options)
         return self._geom_object_actors_map
 
     def show(

src/ansys/geometry/core/plotting/plotter_helper.py

@@ -244,6 +244,7 @@ def plot(
         merge_bodies: bool = False,
         merge_component: bool = False,
         view_2d: Dict = None,
+        filter: str = None,
         **plotting_options,
     ) -> List[Any]:
         """
@@ -268,6 +269,8 @@ def plot(
             dataset without any hierarchy.
         view_2d : Dict, default: None
             Dictionary with the plane and the viewup vectors of the 2D plane.
+        filter : str, default: None
+            Regular expression with the desired name or names you want to include in the plotter.
         **plotting_options : dict, default: None
             Keyword arguments. For allowable keyword arguments, see the
             :meth:`Plotter.add_mesh <pyvista.Plotter.add_mesh>` method.
@@ -280,11 +283,11 @@ def plot(
         if isinstance(object, List) and not isinstance(object[0], pv.PolyData):
             logger.debug("Plotting objects in list...")
             self._geom_object_actors_map = self._pl.add_list(
-                object, merge_bodies, merge_component, **plotting_options
+                object, merge_bodies, merge_component, filter, **plotting_options
             )
         else:
             self._geom_object_actors_map = self._pl.add(
-                object, merge_bodies, merge_component, **plotting_options
+                object, merge_bodies, merge_component, filter, **plotting_options
             )
 
         self.compute_edge_object_map()

tests/integration/test_plotter.py

@@ -635,3 +635,25 @@ def test_visualization_polydata():
     assert box.visualization_polydata.n_cells == 1
     assert box.visualization_polydata.n_points == 4
     assert box.visualization_polydata.n_open_edges == 4
+
+
+def test_name_filter(modeler: Modeler, verify_image_cache):
+    # init modeler
+    design = modeler.create_design("Multiplot")
+
+    # define cylinder
+    cyl_sketch = Sketch()
+    cyl_sketch.circle(Point2D([-20, 5], UNITS.m), Quantity(10, UNITS.m))
+    cyl_body = design.extrude_sketch("JustACyl", cyl_sketch, Quantity(10, UNITS.m))
+
+    # define box
+    body_sketch = Sketch()
+    body_sketch.box(Point2D([10, 10], UNITS.m), Quantity(10, UNITS.m), Quantity(10, UNITS.m))
+    box_body = design.extrude_sketch("JustABox", body_sketch, Quantity(10, UNITS.m))
+
+    # plot together
+    PlotterHelper().plot(
+        [cyl_body, box_body],
+        filter="Cyl",
+        screenshot=Path(IMAGE_RESULTS_DIR, "test_name_filter.png"),
+    )