feat: tessellation speed enhancements (#2294)

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/2294.added.md

@@ -0,0 +1 @@
+Tessellation speed enhancements

src/ansys/geometry/core/_grpc/_services/base/designs.py

@@ -93,3 +93,8 @@ def upload_file(self, **kwargs) -> dict:
     def upload_file_stream(self, **kwargs) -> dict:
         """Upload a file to the server using streaming."""
         pass
+
+    @abstractmethod
+    def stream_design_tessellation(self, **kwargs) -> dict:
+        """Stream the tessellation of a design."""
+        pass

src/ansys/geometry/core/_grpc/_services/v0/bodies.py

@@ -37,6 +37,7 @@
     from_grpc_material_to_material,
     from_grpc_point_to_point3d,
     from_grpc_tess_to_pd,
+    from_grpc_tess_to_raw_data,
     from_plane_to_grpc_plane,
     from_point3d_to_grpc_point,
     from_sketch_shapes_to_grpc_geometries,
@@ -683,7 +684,11 @@ def get_tesellation(self, **kwargs) -> dict:  # noqa: D102
 
         for elem in resp:
             for face_id, face_tess in elem.face_tessellation.items():
-                tess_map[face_id] = from_grpc_tess_to_pd(face_tess)
+                tess_map[face_id] = (
+                    from_grpc_tess_to_raw_data(face_tess)
+                    if kwargs["raw_data"]
+                    else from_grpc_tess_to_pd(face_tess)
+                )
 
         return {"tessellation": tess_map}
 
@@ -707,7 +712,11 @@ def get_tesellation_with_options(self, **kwargs) -> dict:  # noqa: D102
 
         for elem in resp:
             for face_id, face_tess in elem.face_tessellation.items():
-                tess_map[face_id] = from_grpc_tess_to_pd(face_tess)
+                tess_map[face_id] = (
+                    from_grpc_tess_to_raw_data(face_tess)
+                    if kwargs["raw_data"]
+                    else from_grpc_tess_to_pd(face_tess)
+                )
 
         return {"tessellation": tess_map}
 

src/ansys/geometry/core/_grpc/_services/v0/conversions.py

@@ -375,6 +375,11 @@ def from_grpc_tess_to_pd(tess: GRPCTessellation) -> "pv.PolyData":
     return pv.PolyData(var_inp=np.array(tess.vertices).reshape(-1, 3), faces=tess.faces)
 
 
+def from_grpc_tess_to_raw_data(tess: GRPCTessellation) -> dict:
+    """Convert a ``Tessellation`` to raw data."""
+    return {"vertices": tess.vertices, "faces": tess.faces}
+
+
 def from_tess_options_to_grpc_tess_options(
     options: "TessellationOptions",
 ) -> GRPCTessellationOptions:

src/ansys/geometry/core/_grpc/_services/v0/designs.py

@@ -30,6 +30,8 @@
     _check_write_body_facets_input,
     build_grpc_id,
     from_design_file_format_to_grpc_part_export_format,
+    from_grpc_tess_to_raw_data,
+    from_tess_options_to_grpc_tess_options,
 )
 
 
@@ -256,3 +258,33 @@ def request_generator(
 
         # Return the response - formatted as a dictionary
         return {"file_path": response.file_path}
+
+    @protect_grpc
+    def stream_design_tessellation(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.dbu.v0.designs_pb2 import DesignTessellationRequest
+
+        # If there are options, convert to gRPC options
+        options = (
+            from_tess_options_to_grpc_tess_options(kwargs["options"])
+            if kwargs["options"] is not None
+            else None
+        )
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = DesignTessellationRequest(options=options)
+
+        # Call the gRPC service
+        response = self.designs_stub.StreamDesignTessellation(request)
+
+        # Return the response - formatted as a dictionary
+        tess_map = {}
+        for elem in response:
+            for body_id, body_tess in elem.body_tessellation.items():
+                tess = {}
+                for face_id, face_tess in body_tess.face_tessellation.items():
+                    tess[face_id] = from_grpc_tess_to_raw_data(face_tess)
+                tess_map[body_id] = tess
+
+        return {
+            "tessellation": tess_map,
+        }

src/ansys/geometry/core/_grpc/_services/v1/designs.py

@@ -90,3 +90,7 @@ def upload_file(self, **kwargs) -> dict:  # noqa: D102
     @protect_grpc
     def upload_file_stream(self, **kwargs) -> dict:  # noqa: D102
         raise NotImplementedError
+
+    @protect_grpc
+    def stream_design_tessellation(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError

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

@@ -572,9 +572,34 @@ def copy(self, parent: "Component", name: str = None) -> "Body":
         """
         return
 
+    @abstractmethod
+    def get_raw_tessellation(
+        self,
+        tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
+    ) -> dict:
+        """Tessellate the body and return the raw tessellation data.
+
+        Parameters
+        ----------
+        tess_options : TessellationOptions | None, default: None
+            A set of options to determine the tessellation quality.
+        reset_cache : bool, default: False
+            Whether to reset the tessellation cache and re-request the tessellation
+            from the server.
+
+        Returns
+        -------
+        dict
+            Dictionary with face IDs as keys and face tessellation data as values.
+        """
+
     @abstractmethod
     def tessellate(
-        self, merge: bool = False, tess_options: TessellationOptions | None = None
+        self,
+        merge: bool = False,
+        tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
     ) -> Union["PolyData", "MultiBlock"]:
         """Tessellate the body and return the geometry as triangles.
 
@@ -586,6 +611,9 @@ def tessellate(
             When ``True``, the individual faces of the tessellation are merged.
         tess_options : TessellationOptions | None, default: None
             A set of options to determine the tessellation quality.
+        reset_cache : bool, default: False
+            Whether to reset the tessellation cache and re-request the tessellation
+            from the server.
 
         Returns
         -------
@@ -856,6 +884,7 @@ def __init__(
         self._surface_offset = None
         self._is_alive = True
         self._tessellation = None
+        self._raw_tessellation = None
         self._fill_style = FillStyle.DEFAULT
         self._color = None
 
@@ -876,6 +905,7 @@ def reset_tessellation_cache(func):  # noqa: N805
         @wraps(func)
         def wrapper(self: "MasterBody", *args, **kwargs):
             self._tessellation = None
+            self._raw_tessellation = None
             return func(self, *args, **kwargs)
 
         return wrapper
@@ -1251,12 +1281,46 @@ def copy(self, parent: "Component", name: str = None) -> "Body":  # noqa: D102
         body_id = f"{parent.id}/{tb.id}" if parent.parent_component else tb.id
         return Body(body_id, response.get("name"), parent, tb)
 
+    def get_raw_tessellation(  # noqa: D102
+        self,
+        tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
+    ) -> dict:
+        if not self.is_alive:
+            return {}
+
+        # If the server does not support tessellation options, ignore them
+        if tess_options is not None and self._grpc_client.backend_version < (25, 2, 0):
+            self._grpc_client.log.warning(
+                "Tessellation options are not supported by server"
+                f" version {self._grpc_client.backend_version}. Ignoring options."
+            )
+            tess_options = None
+
+        self._grpc_client.log.debug(f"Requesting tessellation for body {self.id}.")
+
+        # cache tessellation
+        if not self._raw_tessellation or reset_cache:
+            if tess_options is not None:
+                response = self._grpc_client.services.bodies.get_tesellation_with_options(
+                    id=self.id, options=tess_options, raw_data=True
+                )
+            else:
+                response = self._grpc_client.services.bodies.get_tesellation(
+                    id=self.id, backend_version=self._grpc_client.backend_version, raw_data=True
+                )
+
+            self._raw_tessellation = response.get("tessellation")
+
+        return self._raw_tessellation
+
     @graphics_required
     def tessellate(  # noqa: D102
         self,
         merge: bool = False,
         transform: Matrix44 = IDENTITY_MATRIX44,
         tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
     ) -> Union["PolyData", "MultiBlock"]:
         # lazy import here to improve initial module load time
         import pyvista as pv
@@ -1275,16 +1339,14 @@ def tessellate(  # noqa: D102
         self._grpc_client.log.debug(f"Requesting tessellation for body {self.id}.")
 
         # cache tessellation
-        if not self._tessellation:
+        if not self._tessellation or reset_cache:
             if tess_options is not None:
                 response = self._grpc_client.services.bodies.get_tesellation_with_options(
-                    id=self.id,
-                    options=tess_options,
+                    id=self.id, options=tess_options, raw_data=False
                 )
             else:
                 response = self._grpc_client.services.bodies.get_tesellation(
-                    id=self.id,
-                    backend_version=self._grpc_client.backend_version,
+                    id=self.id, backend_version=self._grpc_client.backend_version, raw_data=False
                 )
 
             self._tessellation = response.get("tessellation")
@@ -1441,6 +1503,7 @@ def wrapper(self: "Body", *args, **kwargs):
     def _reset_tessellation_cache(self):  # noqa: N805
         """Reset the cached tessellation for a body."""
         self._template._tessellation = None
+        self._template._raw_tessellation = None
         # if this reference is stale, reset the real cache in the part
         # this gets the matching id master body in the part
         master_in_part = next(
@@ -1453,6 +1516,7 @@ def _reset_tessellation_cache(self):  # noqa: N805
         )
         if master_in_part is not None:
             master_in_part._tessellation = None
+            master_in_part._raw_tessellation = None
 
     @property
     def id(self) -> str:  # noqa: D102
@@ -1786,12 +1850,23 @@ def get_collision(self, body: "Body") -> CollisionType:  # noqa: D102
     def copy(self, parent: "Component", name: str = None) -> "Body":  # noqa: D102
         return self._template.copy(parent, name)
 
+    @ensure_design_is_active
+    def get_raw_tessellation(  # noqa: D102
+        self,
+        tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
+    ) -> dict:
+        return self._template.get_raw_tessellation(tess_options, reset_cache)
+
     @ensure_design_is_active
     def tessellate(  # noqa: D102
-        self, merge: bool = False, tess_options: TessellationOptions | None = None
+        self,
+        merge: bool = False,
+        tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
     ) -> Union["PolyData", "MultiBlock"]:
         return self._template.tessellate(
-            merge, self.parent_component.get_world_transform(), tess_options
+            merge, self.parent_component.get_world_transform(), tess_options, reset_cache
         )
 
     @ensure_design_is_active

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

@@ -71,9 +71,12 @@
 from ansys.geometry.core.math.plane import Plane
 from ansys.geometry.core.math.point import Point3D
 from ansys.geometry.core.math.vector import UnitVector3D, Vector3D
-from ansys.geometry.core.misc.checks import ensure_design_is_active, min_backend_version
+from ansys.geometry.core.misc.checks import (
+    ensure_design_is_active,
+    min_backend_version,
+)
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance
-from ansys.geometry.core.misc.options import ImportOptions
+from ansys.geometry.core.misc.options import ImportOptions, TessellationOptions
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.parameters.parameter import Parameter, ParameterUpdateStatus
 from ansys.geometry.core.shapes.curves.trimmed_curve import TrimmedCurve
@@ -139,6 +142,7 @@ def __init__(self, name: str, modeler: Modeler, read_existing_design: bool = Fal
         self._design_id = ""
         self._is_active = False
         self._modeler = modeler
+        self._design_tess = None
 
         # Check whether we want to process an existing design or create a new one.
         if read_existing_design:
@@ -1029,6 +1033,44 @@ def insert_file(
         # Return the newly inserted component
         return self._components[-1]
 
+    @min_backend_version(26, 1, 0)
+    @check_input_types
+    def get_raw_tessellation(
+        self,
+        tess_options: TessellationOptions | None = None,
+        reset_cache: bool = False,
+    ) -> dict:
+        """Tessellate the entire design and return the geometry as triangles.
+
+        Parameters
+        ----------
+        tess_options : TessellationOptions, optional
+            Options for the tessellation. If None, default options are used.
+        reset_cache : bool, default: False
+            Whether to reset the cache before performing the tessellation.
+
+        Returns
+        -------
+        dict
+            A dictionary with body IDs as keys and another dictionary as values.
+            The inner dictionary has face IDs as keys and the corresponding face/vertice arrays
+            as values.
+        """
+        if not self.is_alive:
+            return {}  # Return an empty dictionary if the design is not alive
+
+        self._grpc_client.log.debug(f"Requesting tessellation for design {self.id}.")
+
+        # cache tessellation
+        if not self._design_tess or reset_cache:
+            response = self._grpc_client.services.designs.stream_design_tessellation(
+                options=tess_options,
+            )
+
+            self._design_tess = response.get("tessellation")
+
+        return self._design_tess
+
     def __repr__(self) -> str:
         """Represent the ``Design`` as a string."""
         alive_bodies = [1 if body.is_alive else 0 for body in self.bodies]