feat: expose enclosure methods (#2383)

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

Author: 4 people

doc/changelog.d/2383.added.md

@@ -0,0 +1 @@
+Expose enclosure methods

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

@@ -83,3 +83,18 @@ def remove_logo(self, **kwargs) -> dict:
     def detect_helixes(self, **kwargs) -> dict:
         """Detect helixes in geometry."""
         pass
+
+    @abstractmethod
+    def create_box_enclosure(self, **kwargs) -> dict:
+        """Create a box enclosure around bodies."""
+        pass
+
+    @abstractmethod
+    def create_cylinder_enclosure(self, **kwargs) -> dict:
+        """Create a cylinder enclosure around bodies."""
+        pass
+
+    @abstractmethod
+    def create_sphere_enclosure(self, **kwargs) -> dict:
+        """Create a sphere enclosure around bodies."""
+        pass

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

@@ -56,6 +56,7 @@
     TrimmedCurve as GRPCTrimmedCurve,
     TrimmedSurface as GRPCTrimmedSurface,
 )
+from ansys.api.geometry.v0.preparetools_pb2 import EnclosureOptions as GRPCEnclosureOptions
 import pint
 
 from ansys.geometry.core.errors import GeometryRuntimeError
@@ -95,6 +96,7 @@
     from ansys.geometry.core.sketch.nurbs import SketchNurbs
     from ansys.geometry.core.sketch.polygon import Polygon
     from ansys.geometry.core.sketch.segment import SketchSegment
+    from ansys.geometry.core.tools.prepare_tools import EnclosureOptions
 
 
 def from_point3d_to_grpc_point(point: "Point3D") -> GRPCPoint:
@@ -1410,3 +1412,27 @@ def serialize_entity_identifier(entity):
             for entity in getattr(response, "deleted_bodies", [])
         ],
     }
+
+
+def from_enclosure_options_to_grpc_enclosure_options(
+    enclosure_options: "EnclosureOptions",
+) -> GRPCEnclosureOptions:
+    """Convert enclosure_options to grpc definition.
+
+    Parameters
+    ----------
+    enclosure_options : EnclosureOptions
+        Definition of the enclosure options.
+
+    Returns
+    -------
+    GRPCEnclosureOptions
+        Grpc converted definition.
+    """
+    frame = enclosure_options.frame
+    return GRPCEnclosureOptions(
+        create_shared_topology=enclosure_options.create_shared_topology,
+        subtract_bodies=enclosure_options.subtract_bodies,
+        frame=from_frame_to_grpc_frame(frame) if frame is not None else None,
+        cushion_proportion=enclosure_options.cushion_proportion,
+    )

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

@@ -27,7 +27,11 @@
 
 from ..base.conversions import from_measurement_to_server_length
 from ..base.prepare_tools import GRPCPrepareToolsService
-from .conversions import build_grpc_id
+from .conversions import (
+    build_grpc_id,
+    from_enclosure_options_to_grpc_enclosure_options,
+    serialize_tracker_command_response,
+)
 
 
 class GRPCPrepareToolsServiceV0(GRPCPrepareToolsService):
@@ -295,3 +299,97 @@ def detect_helixes(self, **kwargs) -> dict:  # noqa: D102
                 for helix in response.helixes
             ]
         }
+
+    @protect_grpc
+    def create_box_enclosure(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.models_pb2 import Body as GRPCBody
+        from ansys.api.geometry.v0.preparetools_pb2 import CreateEnclosureBoxRequest
+
+        grpc_enclosure_options = from_enclosure_options_to_grpc_enclosure_options(
+            kwargs["enclosure_options"]
+        )
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = CreateEnclosureBoxRequest(
+            bodies=[GRPCBody(id=body.id) for body in kwargs["bodies"]],
+            x_low=from_measurement_to_server_length(kwargs["x_low"]),
+            x_high=from_measurement_to_server_length(kwargs["x_high"]),
+            y_low=from_measurement_to_server_length(kwargs["y_low"]),
+            y_high=from_measurement_to_server_length(kwargs["y_high"]),
+            z_low=from_measurement_to_server_length(kwargs["z_low"]),
+            z_high=from_measurement_to_server_length(kwargs["z_high"]),
+            enclosure_options=grpc_enclosure_options,
+        )
+
+        # Call the gRPC service
+        response = self.stub.CreateEnclosureBox(request)
+
+        # Return the response - formatted as a dictionary
+        serialized_tracker_response = serialize_tracker_command_response(
+            response=response.command_response
+        )
+        return {
+            "success": response.success,
+            "created_bodies": [body.id for body in response.created_bodies],
+            "tracker_response": serialized_tracker_response,
+        }
+
+    @protect_grpc
+    def create_cylinder_enclosure(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.models_pb2 import Body as GRPCBody
+        from ansys.api.geometry.v0.preparetools_pb2 import CreateEnclosureCylinderRequest
+
+        grpc_enclosure_options = from_enclosure_options_to_grpc_enclosure_options(
+            kwargs["enclosure_options"]
+        )
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = CreateEnclosureCylinderRequest(
+            bodies=[GRPCBody(id=body.id) for body in kwargs["bodies"]],
+            axial_distance_low=from_measurement_to_server_length(kwargs["axial_distance_low"]),
+            axial_distance_high=from_measurement_to_server_length(kwargs["axial_distance_high"]),
+            radial_distance=from_measurement_to_server_length(kwargs["radial_distance"]),
+            enclosure_options=grpc_enclosure_options,
+        )
+
+        # Call the gRPC service
+        response = self.stub.CreateEnclosureCylinder(request)
+
+        # Return the response - formatted as a dictionary
+        serialized_tracker_response = serialize_tracker_command_response(
+            response=response.command_response
+        )
+        return {
+            "success": response.success,
+            "created_bodies": [body.id for body in response.created_bodies],
+            "tracker_response": serialized_tracker_response,
+        }
+
+    @protect_grpc
+    def create_sphere_enclosure(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.models_pb2 import Body as GRPCBody
+        from ansys.api.geometry.v0.preparetools_pb2 import CreateEnclosureSphereRequest
+
+        grpc_enclosure_options = from_enclosure_options_to_grpc_enclosure_options(
+            kwargs["enclosure_options"]
+        )
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = CreateEnclosureSphereRequest(
+            bodies=[GRPCBody(id=body.id) for body in kwargs["bodies"]],
+            radial_distance=from_measurement_to_server_length(kwargs["radial_distance"]),
+            enclosure_options=grpc_enclosure_options,
+        )
+
+        # Call the gRPC service
+        response = self.stub.CreateEnclosureSphere(request)
+
+        # Return the response - formatted as a dictionary
+        serialized_tracker_response = serialize_tracker_command_response(
+            response=response.command_response
+        )
+        return {
+            "success": response.success,
+            "created_bodies": [body.id for body in response.created_bodies],
+            "tracker_response": serialized_tracker_response,
+        }

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

@@ -82,3 +82,15 @@ def remove_logo(self, **kwargs) -> dict:  # noqa: D102
     @protect_grpc
     def detect_helixes(self, **kwargs) -> dict:  # noqa: D102
         raise NotImplementedError
+
+    @protect_grpc
+    def create_box_enclosure(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError
+
+    @protect_grpc
+    def create_cylinder_enclosure(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError
+
+    @protect_grpc
+    def create_sphere_enclosure(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError