feat: Adapt PyMAPDL to common plotter

doc/source/conf.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 import warnings
 
+import ansys.tools.visualization_interface as viz_interface
 from ansys_sphinx_theme import ansys_favicon, get_version_match
 import numpy as np
 import pyvista
@@ -14,11 +15,15 @@
 from ansys.mapdl import core as pymapdl
 from ansys.mapdl.core import __version__
 
+viz_interface.DOCUMENTATION_BUILD = True
+pyvista.BUILDING_GALLERY = True
+pyvista.OFF_SCREEN = True
+
 # Manage errors
 pyvista.set_error_output_file("errors.txt")
 
 # Ensure that offscreen rendering is used for docs generation
-pyvista.OFF_SCREEN = True
+# pyvista.OFF_SCREEN = True
 
 # must be less than or equal to the XVFB window size
 try:

examples/00-mapdl-examples/3d_notch.py

@@ -88,30 +88,21 @@
 # plate_with_hole_anum = mapdl.asba(rect_anum, circ_anum)
 cut_area = mapdl.asba(rect_anum, "ALL")  # cut all areas except the plate
 
-plotter = pv.Plotter(shape=(1, 3))
 
-plotter.subplot(0, 0)
 mapdl.lsla("S")
-mapdl.lplot(vtk=True, show_keypoint_numbering=True, plotter=plotter)
+mapdl.lplot(vtk=True, show_keypoint_numbering=True)
 mapdl.lsel("all")
 
 # plot the area using vtk/pyvista
-plotter.subplot(0, 1)
-mapdl.aplot(
-    vtk=True, show_area_numbering=True, show_lines=True, cpos="xy", plotter=plotter
-)
+mapdl.aplot(vtk=True, show_area_numbering=True, show_lines=True, cpos="xy")
 
 # Next, extrude the area to create volume
 thickness = 0.01
 mapdl.vext(cut_area, dz=thickness)
 
 # Checking volume plot
-plotter.subplot(0, 2)
-mapdl.vplot(
-    vtk=True, show_lines=True, show_axes=True, smooth_shading=True, plotter=plotter
-)
+mapdl.vplot(vtk=True, show_lines=True, show_axes=True, smooth_shading=True)
 
-plotter.show()
 
 ###############################################################################
 # Meshing

pyproject.toml

@@ -17,6 +17,7 @@ dependencies = [
     "ansys-mapdl-reader>=0.51.7",
     "ansys-math-core>=0.1.2",
     "ansys-platform-instancemanagement~=1.0",
+    "ansys-tools-visualization-interface>=0.2.6<0.3.0",
     "platformdirs>=3.6.0",
     "click>=8.1.3", # for CLI interface
     "tabulate>=0.8.0", # for cli plotting
@@ -54,11 +55,11 @@ classifiers = [
 jupyter = [
     "jupyterlab>=3",
     "ipywidgets",
-    "pyvista[jupyter]",
 ]
 
 tests = [
     "ansys-dpf-core==0.10.1",
+    "ansys-tools-visualization-interface==0.2.6",
     "autopep8==2.2.0",
     "matplotlib==3.9.0",
     "scipy==1.13.1",
@@ -77,6 +78,7 @@ doc = [
     "sphinx==7.3.7",
     "ansys-dpf-core==0.10.1",
     "ansys-mapdl-reader==0.53.0",
+    "ansys-tools-visualization-interface==0.2.6",
     "ansys-sphinx-theme==0.16.5",
     "grpcio==1.64.1",
     "imageio-ffmpeg==0.5.1",

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
 
@@ -2501,7 +2501,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

@@ -1168,7 +1168,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/__init__.py

@@ -0,0 +1,23 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from ansys.mapdl.core.plotting.plotting import *