chore: enhancements to GLB export and object plot() methods (#1750)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: RobPasMue

doc/changelog.d/1750.maintenance.md

@@ -0,0 +1 @@
+enhancements to GLB export and object ``plot()`` methods

pyproject.toml

@@ -35,7 +35,7 @@ dependencies = [
     "numpy>=1.20.3,<3",
     "Pint>=0.18,<1",
     "protobuf>=3.20.2,<6",
-    "pygltflib>=1.16.3",
+    "pygltflib>=1.16,<2",
     "pyvista>=0.37.0,<1",
     "requests>=2,<3",
     "scipy>=1.7.3,<2",

src/ansys/geometry/core/designer/body.py

@@ -1745,6 +1745,14 @@ def plot(  # noqa: D102
         # Add to plotting options as well... to be used by the plotter if necessary
         plotting_options["merge_bodies"] = merge
 
+        # In case that service colors are requested, merge will be ignored.
+        # An info message will be issued to the user.
+        if use_service_colors and merge:
+            self._template._grpc_client.log.info(
+                "Ignoring 'merge' option since 'use_service_colors' is set to True."
+            )
+            plotting_options["merge_bodies"] = False
+
         mesh_object = (
             self if use_service_colors else MeshObjectPlot(self, self.tessellate(merge=merge))
         )

src/ansys/geometry/core/designer/component.py

@@ -1588,13 +1588,19 @@ def plot(
         plotting_options["merge_bodies"] = merge_bodies
 
         # At component level, if ``multi_colors`` or ``use_service_colors`` are defined
-        # we should not merge the component.
+        # we should not merge the component or the bodies (only if ``use_service_colors`` is True).
         if plotting_options.get("multi_colors", False) or use_service_colors:
             plotting_options["merge_component"] = False
             self._grpc_client.log.info(
                 "Ignoring 'merge_component=True' (default behavior) as "
                 "'multi_colors' or 'use_service_colors' are defined."
             )
+            if use_service_colors:
+                plotting_options["merge_bodies"] = False
+                self._grpc_client.log.info(
+                    "Ignoring 'merge_bodies=True' (default behavior) as "
+                    "'use_service_colors' is defined."
+                )
 
         pl = GeometryPlotter(
             use_trame=use_trame,

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

@@ -243,14 +243,24 @@ def add_body(self, body: Body, merge: bool = False, **plotting_options: dict | N
 
         if self.use_service_colors:
             faces = body.faces
-            dataset = body.tessellate()
-            for i, block in enumerate(dataset):
-                if faces[i].color != Color.DEFAULT.value:
-                    plotting_options["color"] = faces[i].color
-                else:
-                    plotting_options["color"] = body.color
-                self._backend.pv_interface.plot(block, **plotting_options)
-            return
+            dataset = body.tessellate(merge=merge)
+            body_color = body.color
+            if not merge:
+                # ASSUMPTION: the faces returned by the service are in the same order
+                # as the tessellation information returned by the service...
+                elems = [elem for elem in dataset]
+                for face, block in zip(faces, elems):
+                    face_color = face.color
+                    if face_color != Color.DEFAULT.value:
+                        plotting_options["color"] = face_color
+                    else:
+                        plotting_options["color"] = body_color
+                    self._backend.pv_interface.plot(block, **plotting_options)
+                return
+            else:
+                plotting_options["color"] = body_color
+                self._backend.pv_interface.plot(dataset, **plotting_options)
+                return
         # WORKAROUND: multi_colors is not properly supported in PyVista PolyData
         # so if multi_colors is True and merge is True (returns PolyData) then
         # we need to set the color manually
@@ -481,27 +491,55 @@ def show(
             return lib_objects
 
     def export_glb(
-        self, plotting_object: Any = None, screenshot: str | None = None, **plotting_options
+        self, plotting_object: Any = None, filename: str | Path | None = None, **plotting_options
     ) -> None:
         """Export the design to a glb file. Does not support picked objects.
 
         Parameters
         ----------
         plotting_object : Any, default: None
             Object you can add to the plotter.
-        screenshot : str, default: None
-            Path to save a screenshot of the plotter. Do not include file extension.
+        filename : str | ~pathlib.Path, default: None
+            Path to save a GLB file of the plotter. If None, the file will be saved as
+            temp_glb.glb.
         **plotting_options : dict, default: None
             Keyword arguments for the plotter. Arguments depend of the backend implementation
             you are using.
+
+        Returns
+        -------
+        ~pathlib.Path
+            Path to the exported glb file.
         """
         if plotting_object is not None:
             self.plot(plotting_object, **plotting_options)
 
-        gltf_filepath = str(screenshot) + ".gltf"
+        # Depending on whether a name is provided, the file will be saved with the name
+        # provided or with a default name (temp_glb). If a name is provided, the file will
+        # be saved in the current working directory. If a path is provided, the file will be
+        # saved in the provided path. We will also make sure that the file has the .glb extension,
+        # and if not, we will add it.
+        if filename is None:
+            glb_filepath = Path("temp_glb.glb")
+        else:
+            glb_filepath = filename if isinstance(filename, Path) else Path(filename)
+            if glb_filepath.suffix != ".glb":
+                glb_filepath = glb_filepath.with_suffix(".glb")
 
+        # Temporary gltf file to export the scene
+        gltf_filepath = glb_filepath.with_suffix(".gltf")
+
+        # Hide the axes before exporting the gltf and then export it
         self.backend._pl._scene.hide_axes()
         self.backend._pl._scene.export_gltf(gltf_filepath)
 
+        # Convert the gltf to glb and remove the gltf file
         gltf2glb(gltf_filepath)
         Path.unlink(gltf_filepath)
+
+        # Check if the file was exported correctly
+        if not glb_filepath.exists():  # pragma: no cover
+            raise FileNotFoundError(f"GLB file not found at {glb_filepath}. Export failed.")
+
+        # Finally, return the path to the exported glb file
+        return glb_filepath

tests/integration/test_plotter.py

@@ -945,7 +945,7 @@ def test_export_glb(modeler: Modeler, verify_image_cache):
     pl.plot(box_body)
 
     output_glb_path = Path(IMAGE_RESULTS_DIR, "plot_box_glb")
-    pl.export_glb(screenshot=output_glb_path)
+    pl.export_glb(filename=output_glb_path)
 
 
 @skip_no_xserver
@@ -966,7 +966,7 @@ def test_export_glb_with_color(modeler: Modeler, verify_image_cache):
     pl.plot(box_body)
 
     output_glb_path = Path(IMAGE_RESULTS_DIR, "plot_box_glb_colored")
-    pl.export_glb(screenshot=output_glb_path)
+    pl.export_glb(filename=output_glb_path)
 
 
 @skip_no_xserver
@@ -988,7 +988,7 @@ def test_export_glb_with_face_color(modeler: Modeler, verify_image_cache):
     pl = GeometryPlotter(use_service_colors=True)
 
     output_glb_path = Path(IMAGE_RESULTS_DIR, "plot_box_glb_face_colored")
-    pl.export_glb(box_body, screenshot=output_glb_path)
+    pl.export_glb(box_body, filename=output_glb_path)
 
 
 @skip_no_xserver
@@ -1008,4 +1008,4 @@ def test_export_glb_cylinder_with_face_color(modeler: Modeler, verify_image_cach
     pl = GeometryPlotter(use_service_colors=True)
 
     output_glb_path = Path(IMAGE_RESULTS_DIR, "plot_cylinder_glb_face_colored")
-    pl.export_glb(cyl, screenshot=output_glb_path)
+    pl.export_glb(cyl, filename=output_glb_path)