feat: tracking boolean operations (#2153)

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

Author: 5 people

doc/changelog.d/2153.added.md

@@ -0,0 +1 @@
+Tracking boolean operations

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

@@ -220,6 +220,9 @@ def boolean(self, **kwargs) -> dict:
         pass
 
     @abstractmethod
+    def combine(self, **kwargs) -> dict:
+        """Boolean operation through command."""
+
     def split_body(self, **kwargs) -> dict:
         """Split a body."""
         pass

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

@@ -128,3 +128,53 @@ def inspect_geometry(self, **kwargs) -> dict:
     def repair_geometry(self, **kwargs) -> dict:
         """Repair the geometry by addressing identified issues."""
         pass
+
+    @abstractmethod
+    def fix_duplicate_faces(self, **kwargs) -> dict:  # noqa: D102
+        """Fix duplicate faces in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_missing_faces(self, **kwargs) -> dict:  # noqa: D102
+        """Fix missing faces in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_inexact_edges(self, **kwargs) -> dict:  # noqa: D102
+        """Fix inexact edges in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_extra_edges(self, **kwargs) -> dict:  # noqa: D102
+        """Fix extra edges in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_short_edges(self, **kwargs) -> dict:  # noqa: D102
+        """Fix short edges in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_small_faces(self, **kwargs) -> dict:  # noqa: D102
+        """Fix small faces in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_split_edges(self, **kwargs) -> dict:  # noqa: D102
+        """Fix split edges in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_stitch_faces(self, **kwargs) -> dict:  # noqa: D102
+        """Fix stitch faces in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_unsimplified_faces(self, **kwargs) -> dict:  # noqa: D102
+        """Fix areas to simplify in the geometry."""
+        pass
+
+    @abstractmethod
+    def fix_interference(self, **kwargs) -> dict:  # noqa: D102
+        """Fix interferences in the geometry."""
+        pass

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

@@ -24,6 +24,7 @@
 import grpc
 import pint
 
+import ansys.geometry.core as pyansys_geom
 from ansys.geometry.core.errors import protect_grpc
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS
 
@@ -43,6 +44,7 @@
     from_trimmed_curve_to_grpc_trimmed_curve,
     from_trimmed_surface_to_grpc_trimmed_surface,
     from_unit_vector_to_grpc_direction,
+    serialize_tracker_command_response,
 )
 
 
@@ -714,15 +716,22 @@ def boolean(self, **kwargs) -> dict:  # noqa: D102
         from ansys.api.geometry.v0.bodies_pb2 import BooleanRequest
 
         # Call the gRPC service and build the requests accordingly
-        resp = 0
+        response_success = 0
+        serialized_tracker_response = {}
         try:
-            resp = self.stub.Boolean(
-                request=BooleanRequest(
-                    body1=kwargs["target"].id,
-                    tool_bodies=[other.id for other in kwargs["other"]],
-                    method=kwargs["method"],
+            request = BooleanRequest(
+                body1=kwargs["target"].id,
+                tool_bodies=[other.id for other in kwargs["other"]],
+                method=kwargs["method"],
+            )
+            if pyansys_geom.USE_TRACKER_TO_UPDATE_DESIGN:
+                request.keep_other = kwargs["keep_other"]
+            resp = self.stub.Boolean(request=request)
+            response_success = resp.empty_result
+            if pyansys_geom.USE_TRACKER_TO_UPDATE_DESIGN:
+                serialized_tracker_response = serialize_tracker_command_response(
+                    response=resp.response
                 )
-            ).empty_result
         except grpc.RpcError as err:  # pragma: no cover
             # TODO: to be deleted - old versions did not have "tool_bodies" in the request
             # This is a temporary fix to support old versions of the server - should be deleted
@@ -741,26 +750,82 @@ def boolean(self, **kwargs) -> dict:  # noqa: D102
                     all_resp.append(tmp_resp)
 
                 if all_resp.count(1) > 0:
-                    resp = 1
+                    response_success = 1
             elif len(kwargs["other"]) == 1:
                 resp = self.stub.Boolean(
                     request=BooleanRequest(
                         body1=kwargs["target"].id,
                         body2=kwargs["other"][0].id,
                         method=kwargs["method"],
                     )
-                ).empty_result
+                )
+                response_success = resp.empty_result
             else:
                 raise err
 
-        if resp == 1:
+        if response_success == 1:
             raise ValueError(
                 f"Boolean operation of type '{kwargs['method']}' failed: {kwargs['err_msg']}.\n"
                 f"Involving bodies:{kwargs['target']}, {kwargs['other']}"
             )
 
         # Return the response - formatted as a dictionary
-        return {}
+        return {"complete_command_response": serialized_tracker_response}
+
+    @protect_grpc
+    def combine(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.bodies_pb2 import (
+            CombineIntersectBodiesRequest,
+            CombineMergeBodiesRequest,
+        )
+
+        other_bodies = kwargs["other"]
+        type_bool_op = kwargs["type_bool_op"]
+        keep_other = kwargs["keep_other"]
+
+        if type_bool_op == "intersect":
+            body_ids = [body._grpc_id for body in other_bodies]
+            target_ids = [self._grpc_id]
+            request = CombineIntersectBodiesRequest(
+                target_selection=target_ids,
+                tool_selection=body_ids,
+                subtract_from_target=False,
+                keep_cutter=keep_other,
+            )
+            response = self._template._commands_stub.CombineIntersectBodies(request)
+        elif type_bool_op == "subtract":
+            body_ids = [body._grpc_id for body in other_bodies]
+            target_ids = [self._grpc_id]
+            request = CombineIntersectBodiesRequest(
+                target_selection=target_ids,
+                tool_selection=body_ids,
+                subtract_from_target=True,
+                keep_cutter=keep_other,
+            )
+            response = self._template._commands_stub.CombineIntersectBodies(request)
+        elif type_bool_op == "unite":
+            bodies = [self]
+            bodies.extend(other_bodies)
+            body_ids = [body._grpc_id for body in bodies]
+            request = CombineMergeBodiesRequest(target_selection=body_ids)
+            response = self._template._commands_stub.CombineMergeBodies(request)
+        else:
+            raise ValueError("Unknown operation requested")
+        if not response.success:
+            raise ValueError(
+                f"Operation of type '{type_bool_op}' failed: {kwargs['err_msg']}.\n"
+                f"Involving bodies:{self}, {other_bodies}"
+            )
+
+        if not keep_other:
+            for b in other_bodies:
+                b.parent_component.delete_body(b)
+
+        tracker_response = response.result.complete_command_response
+        serialized_tracker_response = serialize_tracker_command_response(response=tracker_response)
+
+        # Return the response - formatted as a dictionary
+        return {"complete_command_response": serialized_tracker_response}
 
     @protect_grpc
     def split_body(self, **kwargs) -> dict:  # noqa: D102

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

@@ -74,6 +74,8 @@ def create(self, **kwargs) -> dict:  # noqa: D102
             "id": response.component.id,
             "name": response.component.name,
             "instance_name": response.component.instance_name,
+            "template": response.template,
+            "component": response.component,
         }
 
     @protect_grpc

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

@@ -1329,3 +1329,55 @@ def _check_write_body_facets_input(backend_version: "semver.Version", write_body
             + "26.1.0, but the current version used is "
             + f"{backend_version}."
         )
+
+
+def serialize_tracker_command_response(**kwargs) -> dict:
+    """Serialize a TrackerCommandResponse object into a dictionary.
+
+    Parameters
+    ----------
+    response : TrackerCommandResponse
+        The gRPC TrackerCommandResponse object to serialize.
+
+    Returns
+    -------
+    dict
+        A dictionary representation of the TrackerCommandResponse object.
+    """
+
+    def serialize_body(body):
+        return {
+            "id": body.id,
+            "name": body.name,
+            "can_suppress": body.can_suppress,
+            "transform_to_master": {
+                "m00": body.transform_to_master.m00,
+                "m11": body.transform_to_master.m11,
+                "m22": body.transform_to_master.m22,
+                "m33": body.transform_to_master.m33,
+            },
+            "master_id": body.master_id,
+            "parent_id": body.parent_id,
+            "is_surface": body.is_surface,
+        }
+
+    def serialize_entity_identifier(entity):
+        """Serialize an EntityIdentifier object into a dictionary."""
+        return {
+            "id": entity.id,
+        }
+
+    response = kwargs["response"]
+    return {
+        "success": response.success,
+        "created_bodies": [
+            serialize_body(body) for body in getattr(response, "created_bodies", [])
+        ],
+        "modified_bodies": [
+            serialize_body(body) for body in getattr(response, "modified_bodies", [])
+        ],
+        "deleted_bodies": [
+            serialize_entity_identifier(entity)
+            for entity in getattr(response, "deleted_bodies", [])
+        ],
+    }