feat: export glb (#1741)

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

Author: 3 people

doc/changelog.d/1741.added.md

@@ -0,0 +1 @@
+export glb

pyproject.toml

@@ -35,6 +35,7 @@ dependencies = [
     "numpy>=1.20.3,<3",
     "Pint>=0.18,<1",
     "protobuf>=3.20.2,<6",
+    "pygltflib>=1.16.3",
     "pyvista>=0.37.0,<1",
     "requests>=2,<3",
     "scipy>=1.7.3,<2",
@@ -61,6 +62,7 @@ tests = [
     "numpy==2.2.3",
     "Pint==0.24.4",
     "protobuf==5.29.3",
+    "pygltflib==1.16.3",
     "pytest==8.3.4",
     "pytest-cov==6.0.0",
     "pytest-pyvista==0.1.9",

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

@@ -22,9 +22,11 @@
 """Provides plotting for various PyAnsys Geometry objects."""
 
 from itertools import cycle
+from pathlib import Path
 from typing import Any
 
 import numpy as np
+from pygltflib.utils import gltf2glb
 import pyvista as pv
 from pyvista.plotting.tools import create_axes_marker
 
@@ -236,8 +238,19 @@ def add_body(self, body: Body, merge: bool = False, **plotting_options: dict | N
             Keyword arguments. For allowable keyword arguments,
             see the :meth:`Plotter.add_mesh <pyvista.Plotter.add_mesh>` method.
         """
+        if body.is_suppressed:
+            return
+
         if self.use_service_colors:
-            plotting_options["color"] = body.color
+            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
         # 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
@@ -466,3 +479,29 @@ def show(
                 else:  # Either a PyAnsys Geometry object or a PyVista object
                     lib_objects.append(element)
             return lib_objects
+
+    def export_glb(
+        self, plotting_object: Any = None, screenshot: str | 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.
+        **plotting_options : dict, default: None
+            Keyword arguments for the plotter. Arguments depend of the backend implementation
+            you are using.
+        """
+        if plotting_object is not None:
+            self.plot(plotting_object, **plotting_options)
+
+        gltf_filepath = str(screenshot) + ".gltf"
+
+        self.backend._pl._scene.hide_axes()
+        self.backend._pl._scene.export_gltf(gltf_filepath)
+
+        gltf2glb(gltf_filepath)
+        Path.unlink(gltf_filepath)

tests/integration/test_plotter.py

@@ -926,3 +926,86 @@ def test_plot_design_face_colors(modeler: Modeler, verify_image_cache):
         merge=False,
         multi_colors=True,
     )
+
+
+@skip_no_xserver
+def test_export_glb(modeler: Modeler, verify_image_cache):
+    """Test exporting a box to glb."""
+    # Create a Sketch
+    sketch = Sketch()
+    sketch.box(Point2D([10, 10], UNITS.mm), Quantity(10, UNITS.mm), Quantity(10, UNITS.mm))
+
+    # Create your design on the server side
+    design = modeler.create_design("BoxExtrusions")
+
+    # Extrude the sketch to create a body
+    box_body = design.extrude_sketch("JustABox", sketch, Quantity(10, UNITS.mm))
+
+    pl = GeometryPlotter()
+    pl.plot(box_body)
+
+    output_glb_path = Path(IMAGE_RESULTS_DIR, "plot_box_glb")
+    pl.export_glb(screenshot=output_glb_path)
+
+
+@skip_no_xserver
+def test_export_glb_with_color(modeler: Modeler, verify_image_cache):
+    """Test exporting a box to glb."""
+    # Create a Sketch
+    sketch = Sketch()
+    sketch.box(Point2D([10, 10], UNITS.mm), Quantity(10, UNITS.mm), Quantity(10, UNITS.mm))
+
+    # Create your design on the server side
+    design = modeler.create_design("BoxExtrusions")
+
+    # Extrude the sketch to create a body
+    box_body = design.extrude_sketch("JustABox", sketch, Quantity(10, UNITS.mm))
+    box_body.set_color((255, 0, 0))
+
+    pl = GeometryPlotter(use_service_colors=True)
+    pl.plot(box_body)
+
+    output_glb_path = Path(IMAGE_RESULTS_DIR, "plot_box_glb_colored")
+    pl.export_glb(screenshot=output_glb_path)
+
+
+@skip_no_xserver
+def test_export_glb_with_face_color(modeler: Modeler, verify_image_cache):
+    """Test exporting a box to glb."""
+    # Create a Sketch
+    sketch = Sketch()
+    sketch.box(Point2D([10, 10], UNITS.m), Quantity(10, UNITS.m), Quantity(10, UNITS.m))
+
+    # Create your design on the server side
+    design = modeler.create_design("BoxExtrusions")
+
+    # Extrude the sketch to create a body
+    box_body = design.extrude_sketch("JustABox", sketch, Quantity(10, UNITS.m))
+    box_body.set_color((255, 0, 0))
+    box_body.faces[0].set_color((0, 0, 255))
+    box_body.faces[1].set_color((0, 255, 0))
+
+    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)
+
+
+@skip_no_xserver
+def test_export_glb_cylinder_with_face_color(modeler: Modeler, verify_image_cache):
+    """Test exporting a cylinder to glb."""
+    # Create your design on the server side
+    design = modeler.create_design("BoxExtrusions")
+
+    # Create a sketch of a circle (overlapping the box slightly)
+    sketch_circle = Sketch().circle(Point2D([20, 0], unit=UNITS.m), radius=3 * UNITS.m)
+    cyl = design.extrude_sketch("Cylinder", sketch_circle, 50 * UNITS.m)
+
+    cyl.set_color((255, 0, 0))
+    cyl.faces[0].set_color((0, 0, 255))
+    cyl.faces[1].set_color((0, 255, 0))
+
+    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)