feat: Adapt to ansys-visualizer (#959)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 4 people

.github/workflows/ci_cd.yml

@@ -17,12 +17,13 @@ env:
   ANSRV_GEO_PORT: 700
   ANSRV_GEO_LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
   GEO_CONT_NAME: ans_geo
-  RESET_IMAGE_CACHE: 0
+  RESET_IMAGE_CACHE: 1
   IS_WORKFLOW_RUNNING: True
   ARTIFACTORY_VERSION: v242
   MEILISEARCH_API_KEY: ${{ secrets.MEILISEARCH_API_KEY }}
   MEILISEARCH_HOST_URL: ${{ vars.MEILISEARCH_HOST_URL }}
   MEILISEARCH_PUBLIC_API_KEY: ${{ secrets.MEILISEARCH_PUBLIC_API_KEY }}
+  PYANSYS_VISUALIZER_TESTMODE: true
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/nightly_docker_test.yml

@@ -11,6 +11,7 @@ env:
   ANSRV_GEO_PORT: 710
   ANSRV_GEO_LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
   GEO_CONT_NAME: ans_geo_nightly
+  PYANSYS_VISUALIZER_TESTMODE: true
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

doc/changelog.d/959.added.md

@@ -0,0 +1 @@
+feat: Adapt to ansys-visualizer

doc/source/examples/01_getting_started/05_plotter_picker.mystnb

@@ -36,7 +36,7 @@ from ansys.geometry.core.connection.defaults import GEOMETRY_SERVICE_DOCKER_IMAG
 from ansys.geometry.core.connection.docker_instance import LocalDockerInstance
 from ansys.geometry.core.math import Point2D
 from ansys.geometry.core.misc import UNITS
-from ansys.geometry.core.plotting import PlotterHelper
+from ansys.geometry.core.plotting import GeomPlotter
 from ansys.geometry.core.sketch import Sketch
 ```
 
@@ -158,25 +158,26 @@ You can simply plot one of the created objects.
 
 ```{code-cell} ipython3
 
-plotter = PlotterHelper()
-plotter.plot(box_body2)
+plotter = GeomPlotter()
+plotter.show(box_body2)
 ```
 
 You can plot the whole list of objects.
 
 ```{code-cell} ipython3
 
-plotter = PlotterHelper()
-plotter.plot(plot_list)
+plotter = GeomPlotter()
+plotter.show(plot_list)
 ```
 
 The Python visualizer is used by default. However, you can also use
 [trame](https://kitware.github.io/trame/index.html) for visualization.
 
 ```python
 
-plotter = PlotterHelper(use_trame=True)
-plotter.plot(plot_list)
+plotter = GeomPlotter
+(use_trame=True)
+plotter.show(plot_list)
 ```
 
 ## Clip objects
@@ -187,7 +188,7 @@ intersects the target object.
 ```{code-cell} ipython
 
 from ansys.geometry.core.math import Plane, Point3D
-ph = PlotterHelper()
+pl = GeomPlotter()
 
 # Define PyAnsys Geometry box
 box2 = Sketch()
@@ -199,8 +200,8 @@ origin = Point3D([-10., 20., 5.], UNITS.m)
 plane = Plane(origin=origin, direction_x=[1, 1, 1], direction_y=[-1, 0, 1])
 
 # Add the object with the clipping plane
-ph.add(box_body2, clipping_plane=plane)
-ph.plot()
+pl.plot(box_body2, clipping_plane=plane)
+pl.show()
 ```
 
 ## Select objects interactively
@@ -210,10 +211,10 @@ This enables you to pick objects for subsequent script manipulation.
 
 ```{code-cell} ipython3
 
-plotter = PlotterHelper(allow_picking=True)
+plotter = GeomPlotter(allow_picking=True)
 
 # Plotter returns picked bodies
-picked_list = plotter.plot(plot_list)
+picked_list = plotter.show(plot_list)
 print(picked_list)
 ```
 

doc/source/examples/02_sketching/advanced_sketching_gears.mystnb

@@ -29,7 +29,7 @@ from ansys.geometry.core import Modeler
 from ansys.geometry.core.math import Plane, Point2D, Point3D
 from ansys.geometry.core.misc import UNITS, Distance
 from ansys.geometry.core.sketch import Sketch
-from ansys.geometry.core.plotting import Plotter
+from ansys.geometry.core.plotting import GeomPlotter
 
 # Start a modeler session
 modeler = Modeler()

doc/source/examples/02_sketching/basic_usage.mystnb

@@ -24,7 +24,6 @@ Perform the required imports.
 ```{code-cell} ipython3
 from ansys.geometry.core.misc.units import UNITS as u
 from ansys.geometry.core.sketch import Sketch
-from ansys.geometry.core.plotting import Plotter
 ```
 
 ## Create a sketch
@@ -172,7 +171,9 @@ showing the plane of the sketch and its frame.
 
 ```{code-cell} ipython3
 # Plot the sketch in the whole scene
-pl = Plotter()
-pl.plot_sketch(sketch, show_plane=True, show_frame=True)
-pl.scene.show(jupyter_backend="panel")
+from ansys.geometry.core.plotting import GeomPlotter
+
+pl = GeomPlotter()
+pl.add_sketch(sketch, show_plane=True, show_frame=True)
+pl.show()
 ```

doc/source/examples/03_modeling/boolean_operations.mystnb

@@ -25,7 +25,7 @@ from ansys.geometry.core import launch_docker_modeler
 from ansys.geometry.core.designer import Body
 from ansys.geometry.core.math import Point2D
 from ansys.geometry.core.misc import UNITS
-from ansys.geometry.core.plotting import PlotterHelper
+from ansys.geometry.core.plotting import GeomPlotter
 from ansys.geometry.core.sketch import Sketch
 ```
 +++
@@ -87,7 +87,10 @@ example. As shown in this example, the plotter preserves the picking order, mean
 output list is sorted according to the picking order.
 
 ```python
-bodies: List[Body] = PlotterHelper(allow_picking=True).plot(design.bodies)
+pl = GeomPlotter(allow_picking=True)
+pl.plot(design.bodies)
+pl.show()
+bodies: List[Body] = GeomPlotter(allow_picking=True).show(design.bodies)
 ```
 
 Otherwise, you can select bodies from the design directly.
@@ -121,7 +124,7 @@ Perform the intersection and plot the results.
 
 ```{code-cell} ipython3
 prism.intersect(cylin)
-_ = PlotterHelper().plot(design.bodies)
+_ = GeomPlotter().show(design.bodies)
 ```
 
 The final remaining body is the ``prism`` body because
@@ -149,7 +152,7 @@ Perform the union and plot the results.
 
 ```{code-cell} ipython3
 prism.unite(cylin)
-_ = PlotterHelper().plot(design.bodies)
+_ = GeomPlotter().show(design.bodies)
 ```
 
 The final remaining body is the ``prism`` body because
@@ -177,7 +180,7 @@ Perform the subtraction and plot the results.
 
 ```{code-cell} ipython3
 prism.subtract(cylin)
-_ = PlotterHelper().plot(design.bodies)
+_ = GeomPlotter().show(design.bodies)
 ```
 
 The final remaining body is the ``prism`` body because
@@ -201,7 +204,7 @@ cylin = design.extrude_sketch("Cylinder", sketch_circle, 50 * UNITS.m)
 
 # Invert subtraction
 cylin.subtract(prism)
-_ = PlotterHelper().plot(design.bodies)
+_ = GeomPlotter().show(design.bodies)
 ```
 
 In this case, the final remaining body is the ``cylin`` body because

doc/source/examples/03_modeling/tessellation_usage.mystnb

@@ -28,7 +28,6 @@ from pint import Quantity
 from ansys.geometry.core import Modeler
 from ansys.geometry.core.math import Point2D, Point3D, Plane
 from ansys.geometry.core.misc import UNITS
-from ansys.geometry.core.plotting import Plotter
 from ansys.geometry.core.sketch import Sketch
 
 ```

doc/source/examples/04_applied/02_naca_fluent.mystnb

@@ -117,18 +117,18 @@ design.create_named_selection("Airfoil Faces", faces=airfoil.faces)
 ## Display the geometry
 
 The geometry is now ready for the simulation. The following code displays the geometry in the notebook.
-This example uses the ``PlotterHelper`` class to display the geometry for
+This example uses the ``GeomPlotter`` class to display the geometry for
 the airfoil and fluid domain in different colors with a specified opacity level.
 
 The airfoil is displayed in green, and the fluid domain is displayed in blue with an opacity of 0.25.
 
 ```{code-cell} ipython3
-from ansys.geometry.core.plotting import PlotterHelper
+from ansys.geometry.core.plotting import GeomPlotter
 
-plotter_helper = PlotterHelper()
-plotter_helper.add(airfoil, color="green")
-plotter_helper.add(fluid, color="blue", opacity=0.15)
-plotter_helper.show_plotter()
+plotter = GeomPlotter()
+plotter.plot(airfoil, color="green")
+plotter.plot(fluid, color="blue", opacity=0.15)
+plotter.show()
 ```
 
 ## Export the geometry

pyproject.toml

@@ -26,6 +26,7 @@ classifiers = [
 dependencies = [
     "ansys-api-geometry==0.4.2",
     "ansys-tools-path>=0.3,<1",
+    "ansys-tools-visualization-interface>=0.2,<1",
     "beartype>=0.11.0,<0.19",
     "grpcio>=1.35.0,<2",
     "grpcio-health-checking>=1.45.0,<2",
@@ -49,6 +50,7 @@ all = [
 tests = [
     "ansys-platform-instancemanagement==1.1.2",
     "ansys-tools-path==0.5.2",
+    "ansys-tools-visualization-interface==0.2.0",
     "beartype==0.18.5",
     "docker==7.1.0",
     "grpcio==1.64.0",
@@ -75,6 +77,7 @@ tests-minimal = [
 ]
 doc = [
     "ansys-sphinx-theme[autoapi]==0.16.2",
+    "ansys-tools-visualization-interface==0.2.0",
     "beartype==0.18.5",
     "docker==7.1.0",
     "ipyvtklink==0.2.3",