feat: Adapt PyMAPDL to common plotter

src/ansys/mapdl/core/mapdl_core.py

@@ -83,7 +83,7 @@
     from ansys.mapdl.core.xpl import ansXpl
 
 if _HAS_PYVISTA:
-    from ansys.mapdl.core.plotting import get_meshes_from_plotter
+    from ansys.mapdl.core.plotting.plotting import get_meshes_from_plotter
 
 from ansys.mapdl.core.post import PostProcessing
 
@@ -2499,7 +2499,7 @@ def gen_text(picked_entities=None):
             return text + f"Current {entity} selection: {picked_entities_str}"
 
         def callback_points(mesh, id_):
-            from ansys.mapdl.core.plotting import POINT_SIZE
+            from ansys.mapdl.core.plotting.plotting import POINT_SIZE
 
             point = mesh.points[id_]
             node_id = selector(

src/ansys/mapdl/core/mapdl_extended.py

@@ -51,7 +51,10 @@
 from ansys.mapdl.core.theme import get_ansys_colors
 
 if _HAS_PYVISTA:
-    from ansys.mapdl.core.plotting import general_plotter, get_meshes_from_plotter
+    from ansys.mapdl.core.plotting.plotting import (
+        general_plotter,
+        get_meshes_from_plotter,
+    )
 
 
 class _MapdlCommandExtended(_MapdlCore):

src/ansys/mapdl/core/misc.py

@@ -1185,7 +1185,7 @@ def wrapper(self, *args, **kwargs):
             type_, item, comp, vmin, vmax, vinc, kabs, kwargs = _get_args_xsel(
                 *args, **kwargs
             )
-            from ansys.mapdl.core.plotting import POINT_SIZE
+            from ansys.mapdl.core.plotting.plotting import POINT_SIZE
 
             if item == "P" and _HAS_PYVISTA:
                 if type_ not in ["S", "R", "A", "U"]:

src/ansys/mapdl/core/plotting.py → src/ansys/mapdl/core/plotting/plotting.py

@@ -29,8 +29,9 @@
 
 from ansys.mapdl.core import _HAS_PYVISTA
 from ansys.mapdl.core.misc import get_bounding_box, unique_rows
+from ansys.mapdl.core.plotting.visualizer import MapdlPlotter
 
-from .theme import MapdlTheme
+from ..theme import MapdlTheme
 
 POINT_SIZE = 10
 
@@ -412,7 +413,7 @@ def _general_plotter(
         raise TypeError("The kwarg 'plotter' can only accept pv.Plotter objects.")
 
     if not plotter:
-        plotter = pv.Plotter(
+        plotter = MapdlPlotter(
             off_screen=off_screen, notebook=notebook, theme=theme, **plotter_kwargs
         )
     else:
@@ -426,11 +427,13 @@ def _general_plotter(
         cmap = "bwr"
 
     if background:
-        plotter.set_background(background)
+        plotter.pv_interface.scene.set_background(background)
+    else:
+        plotter.pv_interface.scene.set_background("paraview")
 
     # Making sure that labels are visible in dark backgrounds
     if not text_color and background:
-        bg = plotter.background_color.float_rgb
+        bg = plotter.pv_interface.scene.background_color.float_rgb
         # from: https://graphicdesign.stackexchange.com/a/77747/113009
         gamma = 2.2
         threshold = (
@@ -481,31 +484,58 @@ def _general_plotter(
             mesh_ = [mesh_]
 
         for each_mesh in mesh_:
-            plotter.add_mesh(
-                each_mesh,
-                scalars=scalars,
-                scalar_bar_args=scalar_bar_args,
-                color=mesh.get("color", color),
-                style=mesh.get("style", style),
-                show_edges=show_edges,
-                edge_color=edge_color,
-                smooth_shading=smooth_shading,
-                split_sharp_edges=split_sharp_edges,
-                feature_angle=feature_angle,
-                point_size=point_size,
-                line_width=line_width,
-                show_scalar_bar=show_scalar_bar,
-                opacity=opacity,
-                flip_scalars=flip_scalars,
-                lighting=lighting,
-                n_colors=n_colors,
-                interpolate_before_map=interpolate_before_map,
-                cmap=cmap,
-                render_points_as_spheres=render_points_as_spheres,
-                render_lines_as_tubes=render_lines_as_tubes,
-                rgb=rgb,
-                **add_mesh_kwargs,
-            )
+            if isinstance(plotter, MapdlPlotter):
+                plotter.pv_interface.scene.add_mesh(
+                    each_mesh,
+                    scalars=scalars,
+                    scalar_bar_args=scalar_bar_args,
+                    color=mesh.get("color", color),
+                    style=mesh.get("style", style),
+                    show_edges=show_edges,
+                    edge_color=edge_color,
+                    smooth_shading=smooth_shading,
+                    split_sharp_edges=split_sharp_edges,
+                    feature_angle=feature_angle,
+                    point_size=point_size,
+                    line_width=line_width,
+                    show_scalar_bar=show_scalar_bar,
+                    opacity=opacity,
+                    flip_scalars=flip_scalars,
+                    lighting=lighting,
+                    n_colors=n_colors,
+                    interpolate_before_map=interpolate_before_map,
+                    cmap=cmap,
+                    render_points_as_spheres=render_points_as_spheres,
+                    render_lines_as_tubes=render_lines_as_tubes,
+                    rgb=rgb,
+                    **add_mesh_kwargs,
+                )
+            else:
+                plotter.add_mesh(
+                    each_mesh,
+                    scalars=scalars,
+                    scalar_bar_args=scalar_bar_args,
+                    color=mesh.get("color", color),
+                    style=mesh.get("style", style),
+                    show_edges=show_edges,
+                    edge_color=edge_color,
+                    smooth_shading=smooth_shading,
+                    split_sharp_edges=split_sharp_edges,
+                    feature_angle=feature_angle,
+                    point_size=point_size,
+                    line_width=line_width,
+                    show_scalar_bar=show_scalar_bar,
+                    opacity=opacity,
+                    flip_scalars=flip_scalars,
+                    lighting=lighting,
+                    n_colors=n_colors,
+                    interpolate_before_map=interpolate_before_map,
+                    cmap=cmap,
+                    render_points_as_spheres=render_points_as_spheres,
+                    render_lines_as_tubes=render_lines_as_tubes,
+                    rgb=rgb,
+                    **add_mesh_kwargs,
+                )
 
     for label in labels:
         # verify points are not duplicates
@@ -515,27 +545,40 @@ def _general_plotter(
 
         # Converting python order (0 based)
         labels_ = np.array(label["labels"] - 1)[idx]
-
-        plotter.add_point_labels(
-            points,
-            labels_,
-            show_points=False,
-            shadow=False,
-            font_size=font_size,
-            font_family=font_family,
-            text_color=text_color,
-            **add_point_labels_kwargs,
-        )
-
+        if isinstance(plotter, MapdlPlotter):
+            plotter.add_labels(
+                points,
+                labels_,
+                show_points=False,
+                shadow=False,
+                font_size=font_size,
+                font_family=font_family,
+                text_color=text_color,
+                always_visible=True,
+                **add_point_labels_kwargs,
+            )
+        else:
+            plotter.add_point_labels(
+                points,
+                labels_,
+                show_points=False,
+                shadow=False,
+                font_size=font_size,
+                font_family=font_family,
+                text_color=text_color,
+                always_visible=True,
+                **add_point_labels_kwargs,
+            )
     if cpos:
-        plotter.camera_position = cpos
-
+        if isinstance(plotter, MapdlPlotter):
+            plotter.pv_interface.scene.camera_position = cpos
+        else:
+            plotter.camera_position = cpos
     if show_bounds:
-        plotter.show_bounds()
-
-    if show_axes:
-        plotter.show_axes()
-
+        if isinstance(plotter, MapdlPlotter):
+            plotter.pv_interface.scene.show_bounds()
+        else:
+            plotter.show_bounds()
     return plotter
 
 
@@ -934,7 +977,10 @@ def general_plotter(
         )
 
     if title:  # Added here to avoid labels overlapping title
-        pl.add_title(title, color=text_color)
+        if isinstance(pl, MapdlPlotter):
+            pl.pv_interface.scene.add_title(title, color=text_color)
+        else:
+            pl.add_title(title, color=text_color)
 
     if return_cpos and return_plotter:
         raise ValueError(
@@ -943,28 +989,32 @@ def general_plotter(
 
     # permit user to save the figure as a screenshot
     if savefig:
-        pl.show(
+        pl.plot(
             title=title,
             auto_close=False,
             window_size=window_size,
             screenshot=True,
         )
-        pl.screenshot(savefig)
+        pl.pv_interface.scene.screenshot(savefig)
 
         # return unclosed plotter
         if return_plotter:
             return pl
 
         # if not returning plotter, close right away
-        pl.close()
+        pl.pv_interface.scene.close()
 
     else:
         if not return_plotter and not plotter:
-            pl.show()
+            pl.plot()
 
-    if return_plotter:
+    if return_plotter and isinstance(pl, MapdlPlotter):
+        return pl.pv_interface.scene
+    elif return_plotter and isinstance(pl, pv.Plotter):
         return pl
-    elif return_cpos:
+    elif return_cpos and isinstance(pl, MapdlPlotter):
+        return pl.pv_interface.scene.camera_position
+    elif return_cpos and isinstance(pl, pv.Plotter):
         return pl.camera_position
     else:
         return None
@@ -1083,7 +1133,7 @@ def bc_nodes_plotter(
             geom=BC_plot_settings[each_label]["glyph"],
         )
         name_ = f"{each_label}"
-        pl.add_mesh(
+        pl.add(
             glyphs,
             color=BC_plot_settings[each_label]["color"],
             style="surface",
@@ -1111,16 +1161,16 @@ def bc_nodes_plotter(
     if plot_bc_labels:
         pcloud = pv.PolyData(nodes_xyz)
         pcloud["labels"] = list(bc_point_labels.values())
-        pl.add_point_labels(
+        pl.add_labels(
             pcloud.points,
             pcloud["labels"],
             shape_opacity=0.25,
             font_size=bc_labels_font_size,
+            always_visible=True,
         )
 
     if plot_bc_legend:
         pl.add_legend(bcolor=None)
-
     return pl