Merge branch 'feat/measurement_tools_relocation' of https://github.com/ansys/pyansys-geometry into feat/prepare_tools_migration

# Conflicts:
#	src/ansys/geometry/core/_grpc/_services/_service.py

Author: jacobrkerstetter

doc/changelog.d/1909.added.md

@@ -0,0 +1 @@
+grpc measurement tools stub implementation

src/ansys/geometry/core/_grpc/_services/_service.py

@@ -26,6 +26,7 @@
 from .base.admin import GRPCAdminService
 from .base.bodies import GRPCBodyService
 from .base.dbuapplication import GRPCDbuApplicationService
+from .base.measurement_tools import GRPCMeasurementToolsService
 from .base.named_selection import GRPCNamedSelectionService
 from .base.prepare_tools import GRPCPrepareToolsService
 
@@ -72,7 +73,8 @@ def __init__(self, channel: grpc.Channel, version: GeometryApiProtos | str | Non
         self._bodies = None
         self._dbu_application = None
         self._named_selection = None
-        self._prepare_tools = None
+        self._measurement_tools = None
+		self._prepare_tools = None
 
     @property
     def bodies(self) -> GRPCBodyService:
@@ -178,7 +180,33 @@ def named_selection(self) -> GRPCNamedSelectionService:
 
         return self._named_selection
 
-    @property
+	@property
+    def measurement_tools(self) -> GRPCMeasurementToolsService:
+        """
+        Get the measurement tools service for the specified version.
+
+        Returns
+        -------
+        MeasurementToolsServiceBase
+            The measurement tools service for the specified version.
+        """
+        if not self._measurement_tools:
+            # Import the appropriate measurement tools service based on the version
+            from .v0.measurement_tools import GRPCMeasurementToolsServiceV0
+            from .v1.measurement_tools import GRPCMeasurementToolsServiceV1
+
+            if self.version == GeometryApiProtos.V0:
+                self._measurement_tools = GRPCMeasurementToolsServiceV0(self.channel)
+            elif self.version == GeometryApiProtos.V1:  # pragma: no cover
+                # V1 is not implemented yet
+                self._measurement_tools = GRPCMeasurementToolsServiceV1(self.channel)
+            else:  # pragma: no cover
+                # This should never happen as the version is set in the constructor
+                raise ValueError(f"Unsupported version: {self.version}")
+
+        return self._measurement_tools
+        
+	@property
     def prepare_tools(self) -> GRPCPrepareToolsService:
         """
         Get the prepare tools service for the specified version.

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

@@ -0,0 +1,45 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Module containing the measurement tools service implementation (abstraction layer)."""
+
+from abc import ABC, abstractmethod
+
+import grpc
+
+
+class GRPCMeasurementToolsService(ABC):
+    """Measurement tools service for gRPC communication with the Geometry server.
+
+    Parameters
+    ----------
+    channel : grpc.Channel
+        The gRPC channel to the server.
+    """
+
+    def __init__(self, channel: grpc.Channel):
+        """Initialize the MeasurementToolsService class."""
+        pass  # pragma: no cover
+
+    @abstractmethod
+    def min_distance_between_objects(self, **kwargs) -> dict:
+        """Calculate the minimum distance between two objects."""
+        pass  # pragma: no cover

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

@@ -0,0 +1,75 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Module containing the measurement tools service implementation for v0."""
+
+import grpc
+
+from ansys.geometry.core.errors import protect_grpc
+
+from ..base.measurement_tools import GRPCMeasurementToolsService
+
+
+class GRPCMeasurementToolsServiceV0(GRPCMeasurementToolsService):
+    """Measurement tools service for gRPC communication with the Geometry server.
+
+    This class provides methods to interact with the Geometry server's
+    measurement tools service. It is specifically designed for the v0 version of the
+    Geometry API.
+
+    Parameters
+    ----------
+    channel : grpc.Channel
+        The gRPC channel to the server.
+    """
+
+    @protect_grpc
+    def __init__(self, channel: grpc.Channel):  # noqa: D102
+        from ansys.api.geometry.v0.measuretools_pb2_grpc import MeasureToolsStub
+
+        self.stub = MeasureToolsStub(channel)
+
+    @protect_grpc
+    def min_distance_between_objects(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.measuretools_pb2 import MinDistanceBetweenObjectsRequest
+
+        bodies = kwargs["bodies"]
+        selection = kwargs["selection"]
+        backend_version = kwargs["backend_version"]
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        # Request is different based on backend_version (25.2 vs. earlier)
+        if backend_version < (25, 2, 0):
+            request = MinDistanceBetweenObjectsRequest(bodies=bodies)
+        else:
+            from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
+
+            request = MinDistanceBetweenObjectsRequest(
+                selection=[EntityIdentifier(id=selection[0]), EntityIdentifier(id=selection[1])]
+            )
+
+        # Call the gRPC service
+        response = self.stub.MinDistanceBetweenSelectionObjects(request)
+
+        # Return the response - formatted as a dictionary
+        return {
+            "distance": response.gap.distance,
+        }

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

@@ -0,0 +1,52 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Module containing the measurement tools service implementation for v0."""
+
+import grpc
+
+from ansys.geometry.core.errors import protect_grpc
+
+from ..base.measurement_tools import GRPCMeasurementToolsService
+
+
+class GRPCMeasurementToolsServiceV1(GRPCMeasurementToolsService):
+    """Measurement tools service for gRPC communication with the Geometry server.
+
+    This class provides methods to interact with the Geometry server's
+    measurement tools service. It is specifically designed for the v0 version of the
+    Geometry API.
+
+    Parameters
+    ----------
+    channel : grpc.Channel
+        The gRPC channel to the server.
+    """
+
+    @protect_grpc
+    def __init__(self, channel: grpc.Channel):  # noqa: D102
+        from ansys.api.geometry.v0.measuretools_pb2_grpc import MeasureToolsStub
+
+        self.stub = MeasureToolsStub(channel)
+
+    @protect_grpc
+    def min_distance_between_objects(self, **kwargs):  # noqa: D102
+        raise NotImplementedError

src/ansys/geometry/core/tools/measurement_tools.py

@@ -23,15 +23,10 @@
 
 from typing import TYPE_CHECKING, Union
 
-from ansys.api.geometry.v0.measuretools_pb2 import (
-    MinDistanceBetweenObjectsRequest,
-    MinDistanceBetweenObjectsResponse,
-)
-from ansys.api.geometry.v0.measuretools_pb2_grpc import MeasureToolsStub
 from ansys.geometry.core.connection import GrpcClient
-from ansys.geometry.core.errors import protect_grpc
 from ansys.geometry.core.misc.checks import min_backend_version
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance
+from ansys.geometry.core.typing import Real
 
 if TYPE_CHECKING:  # pragma: no cover
     from ansys.geometry.core.designer.body import Body
@@ -58,7 +53,7 @@ def distance(self) -> Distance:
         return self._distance
 
     @classmethod
-    def _from_distance_response(cls, response: MinDistanceBetweenObjectsResponse) -> "Gap":
+    def _from_distance_response(cls, distance: Real) -> "Gap":
         """Construct ``Gap`` object from distance response.
 
         Parameters
@@ -71,7 +66,7 @@ def _from_distance_response(cls, response: MinDistanceBetweenObjectsResponse) ->
         This method is used internally to construct a ``Gap`` object from a
         gRPC response.
         """
-        distance = Distance(response.gap.distance, unit=DEFAULT_UNITS.LENGTH)
+        distance = Distance(distance, unit=DEFAULT_UNITS.LENGTH)
         return cls(distance)
 
 
@@ -84,13 +79,10 @@ class MeasurementTools:
         gRPC client to use for the measurement tools.
     """
 
-    @protect_grpc
     def __init__(self, grpc_client: GrpcClient):
         """Initialize measurement tools class."""
         self._grpc_client = grpc_client
-        self._measure_stub = MeasureToolsStub(self._grpc_client.channel)
 
-    @protect_grpc
     @min_backend_version(24, 2, 0)
     def min_distance_between_objects(
         self, object1: Union["Body", "Face", "Edge"], object2: Union["Body", "Face", "Edge"]
@@ -109,12 +101,9 @@ def min_distance_between_objects(
         Gap
             Gap between two bodies.
         """
-        if self._grpc_client.backend_version < (25, 2, 0):
-            response = self._measure_stub.MinDistanceBetweenObjects(
-                MinDistanceBetweenObjectsRequest(bodies=[object1.id, object2.id])
-            )
-        else:
-            response = self._measure_stub.MinDistanceBetweenSelectionObjects(
-                MinDistanceBetweenObjectsRequest(selection=[object1._grpc_id, object2._grpc_id])
-            )
-        return Gap._from_distance_response(response)
+        response = self._grpc_client.services.measurement_tools.min_distance_between_objects(
+            bodies=[object1.id, object2.id],
+            selection=[object1.id, object2.id],
+            backend_version=self._grpc_client.backend_version,
+        )
+        return Gap._from_distance_response(response["distance"])