Adding plotter to inputs. (#1545)

* Adding plotter to inputs.

* Added unit test to increase coverage

* Apply suggestions from code review

Thank you @akaszynski ! My bad!

Co-authored-by: Alex Kaszynski <[email protected]>

Co-authored-by: Alex Kaszynski <[email protected]>

Author: germa89

src/ansys/mapdl/core/plotting.py

@@ -1,4 +1,6 @@
 """Plotting helper for MAPDL using pyvista"""
+from warnings import warn
+
 import numpy as np
 
 from ansys.mapdl.core import _HAS_PYVISTA
@@ -158,6 +160,7 @@ def _general_plotter(
     font_family=None,
     text_color=None,
     theme=None,
+    plotter=None,
 ):
     """General pymapdl plotter for APDL geometry and meshes.
 
@@ -285,6 +288,13 @@ def _general_plotter(
         PyVista theme. Defaults to `PyMAPDL theme <https://github
         .com/pyansys/pyansys-sphinx-theme>`_.
 
+    plotter : pyvista.Plotter, optional
+        If a :class:`pyvista.Plotter` not is provided, then creates its
+        own plotter. If a :class:`pyvista.Plotter` is provided, the arguments
+        ``notebook``, ``off_screen`` and ``theme`` are ignored, since
+        they should be set when instantiated the provided plotter.
+        Defaults to ``None`` (create the Plotter object).
+
     Returns
     -------
     pyvista.Plotter
@@ -321,13 +331,23 @@ def _general_plotter(
     if theme is None:
         theme = MapdlTheme()
 
-    pl = pv.Plotter(off_screen=off_screen, notebook=notebook, theme=theme)
+    if not (plotter is None or isinstance(plotter, pv.Plotter)):
+        raise TypeError("The kwarg 'plotter' can only accept pv.Plotter objects.")
+
+    if not plotter:
+        plotter = pv.Plotter(off_screen=off_screen, notebook=notebook, theme=theme)
+    else:
+        if off_screen or notebook or theme:
+            warn(
+                "The kwargs 'off_screen', 'notebook' and 'theme' are ignored when using 'plotter' kwarg.",
+                UserWarning,
+            )
 
     if background:
-        pl.set_background(background)
+        plotter.set_background(background)
 
     for point in points:
-        pl.add_points(
+        plotter.add_points(
             point["points"],
             scalars=point.get("scalars", None),
             color=color,
@@ -346,7 +366,7 @@ def _general_plotter(
         )
 
     for mesh in meshes:
-        pl.add_mesh(
+        plotter.add_mesh(
             mesh["mesh"],
             scalars=mesh.get("scalars"),
             scalar_bar_args=scalar_bar_args,
@@ -375,7 +395,7 @@ def _general_plotter(
         points, idx, _ = unique_rows(np.array(label["points"]))
         labels = np.array(label["labels"])[idx].tolist()
 
-        pl.add_point_labels(
+        plotter.add_point_labels(
             points,
             labels,
             show_points=False,
@@ -386,15 +406,15 @@ def _general_plotter(
         )
 
     if cpos:
-        pl.camera_position = cpos
+        plotter.camera_position = cpos
 
     if show_bounds:
-        pl.show_bounds()
+        plotter.show_bounds()
 
     if show_axes:
-        pl.show_axes()
+        plotter.show_axes()
 
-    return pl
+    return plotter
 
 
 # Using * to force all the following arguments to be keyword only.
@@ -446,6 +466,7 @@ def general_plotter(
     bc_target=None,
     bc_glyph_size=None,
     bc_labels_font_size=16,
+    plotter=None,
 ):
     """General pymapdl plotter for APDL geometry and meshes.
 
@@ -625,6 +646,13 @@ def general_plotter(
         Size of the text on the boundary conditions labels.
         By default it is 16.
 
+    plotter : pyvista.Plotter, optional
+        If a :class:`pyvista.Plotter` not is provided, then creates its
+        own plotter. If a :class:`pyvista.Plotter` is provided, the arguments
+        ``notebook``, ``off_screen`` and ``theme`` are ignored, since
+        they should be set when instantiated the provided plotter.
+        Defaults to ``None`` (create the Plotter object).
+
     Returns
     -------
     cpos or pyvista.Plotter or None
@@ -719,6 +747,7 @@ def general_plotter(
         font_family=font_family,
         text_color=text_color,
         theme=theme,
+        plotter=plotter,
     )
 
     if plot_bc:

tests/test_plotting.py

@@ -469,3 +469,44 @@ def debug_orders_1(pl, point):
         "S", "P", _debug=lambda x: debug_orders_1(x, point=point), tolerance=0.1
     )
     assert selected == []
+
+
+def test_plotter_input(mapdl, make_block):
+    pl = Plotter(off_screen=True)
+    # because in CICD we use 'screen_off', this will trigger a warning,
+    # since using 'plotter' will overwrite this kwarg.
+    with pytest.warns(UserWarning):
+        pl2 = mapdl.eplot(return_plotter=True, plotter=pl)
+    assert pl == pl2
+    assert pl is pl2
+
+    # invalid plotter type
+    with pytest.raises(TypeError):
+        pl2 = mapdl.eplot(return_plotter=True, plotter=[])
+
+
+def test_cpos_input(mapdl, make_block):
+    cpos = [
+        (0.3914, 0.4542, 0.7670),
+        (0.0243, 0.0336, -0.0222),
+        (-0.2148, 0.8998, -0.3796),
+    ]
+
+    cpos1 = mapdl.eplot(cpos=cpos, return_cpos=True)
+    assert np.allclose(np.array(cpos), np.array([each for each in cpos1]), rtol=1e-4)
+
+
+def test_show_bounds(mapdl, make_block):
+    default_bounds = [-1.0, 1.0, -1.0, 1.0, -1.0, 1.0]
+    pl = mapdl.eplot(show_bounds=True, return_plotter=True)
+
+    assert pl.bounds
+    assert len(pl.bounds) == 6
+    assert pl.bounds != default_bounds
+
+
+def test_background(mapdl, make_block):
+    default_color = "#4c4c4cff"
+    pl = mapdl.eplot(background="red", return_plotter=True)
+    assert pl.background_color != default_color
+    assert pl.background_color == "red"