feat: add mating conditions (align, tangent, orient) (#2069)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: jonahrb

doc/changelog.d/2069.added.md

@@ -0,0 +1 @@
+Add mating conditions (align, tangent, orient)

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

@@ -1541,7 +1541,15 @@ def material(self, value: Material):  # noqa: D102
 
     @property
     def bounding_box(self) -> BoundingBox:  # noqa: D102
-        return self._template.bounding_box
+        self._template._grpc_client.log.debug(
+            f"Retrieving bounding box for body {self.id} from server."
+        )
+        response = self._template._grpc_client.services.bodies.get_bounding_box(id=self.id)
+        return BoundingBox(
+            min_corner=response.get("min"),
+            max_corner=response.get("max"),
+            center=response.get("center"),
+        )
 
     @ensure_design_is_active
     def assign_material(self, material: Material) -> None:  # noqa: D102

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

@@ -30,6 +30,7 @@
 from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
 from ansys.api.geometry.v0.commands_pb2 import (
     ChamferRequest,
+    CreateAlignTangentOrientGearConditionRequest,
     CreateCircularPatternRequest,
     CreateFillPatternRequest,
     CreateLinearPatternRequest,
@@ -61,6 +62,11 @@
     point3d_to_grpc_point,
     unit_vector_to_grpc_direction,
 )
+from ansys.geometry.core.designer.mating_conditions import (
+    AlignCondition,
+    OrientCondition,
+    TangentCondition,
+)
 from ansys.geometry.core.designer.selection import NamedSelection
 from ansys.geometry.core.errors import protect_grpc
 from ansys.geometry.core.math.plane import Plane
@@ -69,6 +75,7 @@
 from ansys.geometry.core.misc.auxiliary import (
     get_bodies_from_ids,
     get_design_from_body,
+    get_design_from_component,
     get_design_from_edge,
     get_design_from_face,
 )
@@ -1450,3 +1457,180 @@ def offset_faces_set_radius(
         )
 
         return result.success
+
+    @protect_grpc
+    @min_backend_version(26, 1, 0)
+    def create_align_condition(
+        self,
+        parent_component: "Component",
+        geometry_a: Union["Body", "Face", "Edge"],
+        geometry_b: Union["Body", "Face", "Edge"],
+    ) -> AlignCondition:
+        """Create an align condition between two geometry objects.
+
+        This will move the objects to be aligned with each other.
+
+        Parameters
+        ----------
+        parent_component : Component
+            The common ancestor component of the two geometry objects.
+        geometry_a : Body | Face | Edge
+            The first geometry object to align to the second.
+        geometry_b : Body | Face | Edge
+            The geometry object to be aligned to.
+
+        Returns
+        -------
+        AlignCondition
+            The persistent align condition that was created.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 26R1.
+        """
+        from ansys.geometry.core.designer.body import Body
+        from ansys.geometry.core.designer.component import Component
+        from ansys.geometry.core.designer.edge import Edge
+        from ansys.geometry.core.designer.face import Face
+
+        check_type(parent_component, Component)
+        check_type(geometry_a, (Body, Face, Edge))
+        check_type(geometry_b, (Body, Face, Edge))
+
+        result = self._commands_stub.CreateAlignCondition(
+            CreateAlignTangentOrientGearConditionRequest(
+                parent=parent_component._grpc_id,
+                geometric_a=geometry_a._grpc_id,
+                geometric_b=geometry_b._grpc_id,
+            )
+        )
+
+        get_design_from_component(parent_component)._update_design_inplace()
+
+        return AlignCondition(
+            result.condition.moniker,
+            result.condition.is_deleted,
+            result.condition.is_enabled,
+            result.condition.is_satisfied,
+            result.offset,
+            result.is_reversed,
+            result.is_valid,
+        )
+
+    @protect_grpc
+    @min_backend_version(26, 1, 0)
+    def create_tangent_condition(
+        self,
+        parent_component: "Component",
+        geometry_a: Union["Body", "Face", "Edge"],
+        geometry_b: Union["Body", "Face", "Edge"],
+    ) -> TangentCondition:
+        """Create a tangent condition between two geometry objects.
+
+        This aligns the objects so that they are tangent.
+
+        Parameters
+        ----------
+        parent_component : Component
+            The common ancestor component of the two geometry objects.
+        geometry_a : Body | Face | Edge
+            The first geometry object to tangent the second.
+        geometry_b : Body | Face | Edge
+            The geometry object to be tangent with.
+
+        Returns
+        -------
+        TangentCondition
+            The persistent tangent condition that was created.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 26R1.
+        """
+        from ansys.geometry.core.designer.body import Body
+        from ansys.geometry.core.designer.component import Component
+        from ansys.geometry.core.designer.edge import Edge
+        from ansys.geometry.core.designer.face import Face
+
+        check_type(parent_component, Component)
+        check_type(geometry_a, (Body, Face, Edge))
+        check_type(geometry_b, (Body, Face, Edge))
+
+        result = self._commands_stub.CreateTangentCondition(
+            CreateAlignTangentOrientGearConditionRequest(
+                parent=parent_component._grpc_id,
+                geometric_a=geometry_a._grpc_id,
+                geometric_b=geometry_b._grpc_id,
+            )
+        )
+
+        get_design_from_component(parent_component)._update_design_inplace()
+
+        return TangentCondition(
+            result.condition.moniker,
+            result.condition.is_deleted,
+            result.condition.is_enabled,
+            result.condition.is_satisfied,
+            result.offset,
+            result.is_reversed,
+            result.is_valid,
+        )
+
+    @protect_grpc
+    @min_backend_version(26, 1, 0)
+    def create_orient_condition(
+        self,
+        parent_component: "Component",
+        geometry_a: Union["Body", "Face", "Edge"],
+        geometry_b: Union["Body", "Face", "Edge"],
+    ) -> OrientCondition:
+        """Create an orient condition between two geometry objects.
+
+        This rotates the objects so that they are oriented in the same direction.
+
+        Parameters
+        ----------
+        parent_component : Component
+            The common ancestor component of the two geometry objects.
+        geometry_a : Body | Face | Edge
+            The first geometry object to orient with the second.
+        geometry_b : Body | Face | Edge
+            The geometry object to be oriented with.
+
+        Returns
+        -------
+        OrientCondition
+            The persistent orient condition that was created.
+
+        Warnings
+        --------
+        This method is only available starting on Ansys release 26R1.
+        """
+        from ansys.geometry.core.designer.body import Body
+        from ansys.geometry.core.designer.component import Component
+        from ansys.geometry.core.designer.edge import Edge
+        from ansys.geometry.core.designer.face import Face
+
+        check_type(parent_component, Component)
+        check_type(geometry_a, (Body, Face, Edge))
+        check_type(geometry_b, (Body, Face, Edge))
+
+        result = self._commands_stub.CreateOrientCondition(
+            CreateAlignTangentOrientGearConditionRequest(
+                parent=parent_component._grpc_id,
+                geometric_a=geometry_a._grpc_id,
+                geometric_b=geometry_b._grpc_id,
+            )
+        )
+
+        get_design_from_component(parent_component)._update_design_inplace()
+
+        return OrientCondition(
+            result.condition.moniker,
+            result.condition.is_deleted,
+            result.condition.is_enabled,
+            result.condition.is_satisfied,
+            result.offset,
+            result.is_reversed,
+            result.is_valid,
+        )

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

@@ -0,0 +1,61 @@
+# 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.
+"""Provides dataclasses for mating conditions."""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class MatingCondition:
+    """MatingCondition dataclass."""
+
+    id: str  # Id of the mating condition corresponding to the server-side object
+    is_deleted: bool  # True if the condition has been deleted
+    is_enabled: bool  # True if the condition is currently enabled
+    is_satisfied: bool  # True if the condition has been met
+
+
+@dataclass
+class AlignCondition(MatingCondition):
+    """AlignCondition dataclass."""
+
+    offset: float  # Separation value (only defined if at least one geometric has a surface)
+    is_reversed: bool  # True if the condition is reversed in sense
+    is_valid: bool  # True if the condition is valid
+
+
+@dataclass
+class TangentCondition(MatingCondition):
+    """TangentCondition dataclass."""
+
+    offset: float  # Separation value (only if both are surfaces)
+    is_reversed: bool  # True if the condition is reversed in sense
+    is_valid: bool  # True if the condition is valid
+
+
+@dataclass
+class OrientCondition(MatingCondition):
+    """OrientCondition dataclass."""
+
+    offset: float  # Rotation angle
+    is_reversed: bool  # True if the condition is reversed in sense
+    is_valid: bool  # True if the condition is valid

tests/integration/files/mating-conditions.scdocx

@@ -0,0 +1,74 @@
+# 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.
+
+from pathlib import Path
+
+import numpy as np
+
+from ansys.geometry.core import Modeler
+
+from .conftest import FILES_DIR
+
+
+def test_align_condition(modeler: Modeler):
+    """Test the creation of an align condition."""
+    design = modeler.open_file(Path(FILES_DIR, "mating-conditions.scdocx"))
+    face1 = next((ns for ns in design.named_selections if ns.name == "face1"), None).faces[0]
+    face2 = next((ns for ns in design.named_selections if ns.name == "face2"), None).faces[0]
+
+    old_center = face1.body.bounding_box.center
+
+    modeler.geometry_commands.create_align_condition(design, face1, face2)
+
+    new_center = face1.body.bounding_box.center
+
+    assert not np.allclose(old_center, new_center)
+
+
+def test_tangent_condition(modeler: Modeler):
+    """Test the creation of a tangent condition."""
+    design = modeler.open_file(Path(FILES_DIR, "mating-conditions.scdocx"))
+    face1 = next((ns for ns in design.named_selections if ns.name == "face1"), None).faces[0]
+    face2 = next((ns for ns in design.named_selections if ns.name == "face2"), None).faces[0]
+
+    old_center = face1.body.bounding_box.center
+
+    modeler.geometry_commands.create_tangent_condition(design, face1, face2)
+
+    new_center = face1.body.bounding_box.center
+
+    assert not np.allclose(old_center, new_center)
+
+
+def test_orient_condition(modeler: Modeler):
+    """Test the creation of an orient condition."""
+    design = modeler.open_file(Path(FILES_DIR, "mating-conditions.scdocx"))
+    face1 = next((ns for ns in design.named_selections if ns.name == "face3"), None).faces[0]
+    face2 = next((ns for ns in design.named_selections if ns.name == "face2"), None).faces[0]
+
+    old_center = face1.body.bounding_box.center
+
+    modeler.geometry_commands.create_orient_condition(design, face1, face2)
+
+    new_center = face1.body.bounding_box.center
+
+    assert not np.allclose(old_center, new_center)