FEAT: Project sheet (#6757)

Co-authored-by: Xiaoyang Ma <[email protected]>
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: 4 people

doc/changelog.d/6757.added.md

@@ -0,0 +1 @@
+Project sheet

src/ansys/aedt/core/modeler/cad/primitives.py

@@ -5870,6 +5870,65 @@ def wrap_sheet(self, sheet, object, imprinted=False):
             self.cleanup_objects()
         return True
 
+    def project_sheet(self, sheet, object, thickness, draft_angle=0, angle_unit="deg", keep_originals=True):
+        """Project sheet on an object.
+
+        If projection produces an unclassified operation it will be reverted.
+
+        Parameters
+        ----------
+        sheet : str, int, or :class:`ansys.aedt.core.modeler.cad.object_3d.Object3d`
+            Sheet name, id, or sheet object.
+        object : list, str, int, or :class:`ansys.aedt.core.modeler.cad.object_3d.Object3d`
+            Object name, id, or solid object to be projected on.
+        thickness : float, str
+            Thickness of the projected sheet in model units.
+        draft_angle : float, str, optional
+            Draft angle for the projection. Default is ``0``.
+        angle_unit : str, optional
+            Angle unit. Default is ``deg``.
+        keep_originals : bool, optional
+            Whether to keep the original objects. Default is ``True``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        References
+        ----------
+        >>> oEditor.ProjectSheet
+        """
+        sheet = self.convert_to_selections(sheet, False)
+        object = self.convert_to_selections(object, False)
+
+        try:
+            unclassified = [i for i in self.unclassified_objects]
+            self.oeditor.ProjectSheet(
+                ["NAME:Selections", "Selections:=", f"{sheet},{object}"],
+                [
+                    "NAME:ProjectSheetParameters",
+                    "Thickness:=",
+                    self._app.value_with_units(thickness),
+                    "DraftAngle:=",
+                    self._app.value_with_units(draft_angle, angle_unit),
+                    "KeepOriginals:=",
+                    keep_originals,
+                ],
+            )
+            unclassified_new = [i for i in self.unclassified_objects if i not in unclassified]
+            if unclassified_new:
+                self.logger.error("Failed to Project Sheet. Reverting to original objects.")
+                self._odesign.Undo()
+                return False
+        except Exception:
+            self.logger.error("Failed to Project Sheet.")
+            return False
+
+        if not keep_originals:
+            self.cleanup_objects()
+        return True
+
     @pyaedt_function_handler(input_objects_list="assignment")
     def heal_objects(
         self,

tests/system/general/test_02_3D_modeler.py

@@ -1231,3 +1231,83 @@ def test_pointing_to_axis(self):
         assert go.is_vector_equal(x, [0.7053456158585983, 0.07053456158585983, 0.7053456158585983])
         assert go.is_vector_equal(y, [0.19470872568244801, 0.9374864569895649, -0.28845737138140465])
         assert go.is_vector_equal(z, [-0.681598176590997, 0.3407990882954985, 0.6475182677614472])
+
+    def test_project_sheet_success_with_single_object(self):
+        """Test project sheet method with a single object."""
+        EXPECTED_POSITIONS = [
+            [5.0, -5.0, 11.0],
+            [5.0, -5.0, 10.0],
+            [-5.0, -5.0, 11.0],
+            [-5.0, -5.0, 10.0],
+            [-5.0, 10.0, 10.0],
+            [5.0, 10.0, 10.0],
+            [5.0, 11.0, 11.0],
+            [-5.0, 11.0, 11.0],
+            [5.0, 10.0, -10.0],
+            [-5.0, 10.0, -10.0],
+            [-5.0, 11.0, -11.0],
+            [5.0, 11.0, -11.0],
+        ]
+        rect = self.aedtapp.modeler.create_rectangle(Plane.XY, [-5, -5, 15], [10, 20], "sheet_project_operation")
+        box = self.aedtapp.modeler.create_box([-10, -10, -10], [20, 20, 20], "box_project_operation")
+
+        assert self.aedtapp.modeler.project_sheet(rect, box, 1, keep_originals=False)
+
+        obj = self.aedtapp.modeler.get_object_from_name("sheet_project_operation")
+        assert obj is not None, "Expected object not found"
+        assert 12 == len(obj.vertices), "Object has not the number of expected vertices"
+        positions = [vertex.position for vertex in list(obj.vertices)]
+        assert sorted(EXPECTED_POSITIONS) == sorted(positions), "Object has not the expected vertices positions"
+        self.aedtapp.modeler.delete(self.aedtapp.modeler.object_names)
+
+    def test_project_sheet_success_with_multiple_objects(self):
+        """Test project sheet method with multiple objects."""
+        EXPECTED_POSITIONS = [
+            [5.0, -5.0, 11.0],
+            [5.0, -5.0, 10.0],
+            [-5.0, -5.0, 11.0],
+            [-5.0, -5.0, 10.0],
+            [-5.0, 10.0, 10.0],
+            [5.0, 10.0, 10.0],
+            [5.0, 11.0, 11.0],
+            [-5.0, 11.0, 11.0],
+            [5.0, 10.0, -10.0],
+            [-5.0, 10.0, -10.0],
+            [-5.0, 11.0, -11.0],
+            [5.0, 11.0, -11.0],
+            [-2.0, 2, 13.0],
+            [-2.0, -2, 13.0],
+            [-2.0, -2, 11.0],
+            [-2.0, 2, 11.0],
+            [2.0, -2, 13.0],
+            [2.0, 2, 13.0],
+            [2.0, -2, 11.0],
+            [2.0, 2, 11.0],
+            [-1.0, 1.0, 10.0],
+            [-1.0, -1.0, 10.0],
+            [1.0, 1.0, 10.0],
+            [1.0, -1.0, 10.0],
+            [1.0, -1.0, 12.0],
+            [-1.0, -1.0, 12.0],
+            [1.0, 1.0, 12.0],
+            [-1.0, 1.0, 12.0],
+        ]
+        rect = self.aedtapp.modeler.create_rectangle(Plane.XY, [-5, -5, 15], [10, 20], "sheet_project_operation")
+        box_0 = self.aedtapp.modeler.create_box([-10, -10, -10], [20, 20, 20], "box_project_operation_0")
+        box_1 = self.aedtapp.modeler.create_box([-1, -1, 10], [2, 2, 2], "box_project_operation_1")
+
+        assert self.aedtapp.modeler.project_sheet(rect, [box_0, box_1], 1, keep_originals=False)
+
+        obj = self.aedtapp.modeler.get_object_from_name("sheet_project_operation")
+        assert obj is not None, "Expected object not found"
+        assert 28 == len(obj.vertices), "Object has not the number of expected vertices"
+        positions = [vertex.position for vertex in list(obj.vertices)]
+        assert sorted(EXPECTED_POSITIONS) == sorted(positions), "Object has not the expected vertices positions"
+        self.aedtapp.modeler.delete(self.aedtapp.modeler.object_names)
+
+    def test_project_sheet_failure(self):
+        rect = self.aedtapp.modeler.create_rectangle(Plane.XY, [-5, -5, 15], [10, 20], "sheet_project_operation")
+        box_0 = self.aedtapp.modeler.create_box([-10, -10, -10], [20, 20, 20], "box_project_operation_0")
+
+        assert not self.aedtapp.modeler.project_sheet(rect, box_0, 5, "10deg")
+        self.aedtapp.modeler.delete(self.aedtapp.modeler.object_names)

tests/unit/test_geometry_modeler.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 - 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.
+
+import logging
+from unittest.mock import MagicMock
+from unittest.mock import PropertyMock
+from unittest.mock import patch
+
+import pytest
+
+from ansys.aedt.core import Hfss
+from ansys.aedt.core.modeler.cad.primitives import GeometryModeler
+
+
+@pytest.fixture
+def mock_hfss_app():
+    """Fixture used to mock the creation of a Maxwell instance."""
+    with patch("ansys.aedt.core.hfss.Hfss.__init__", lambda x: None):
+        mock_instance = Hfss()
+        mock_instance._logger = logging.getLogger(__name__)
+        mock_instance._oeditor = PropertyMock(return_value=MagicMock())
+        mock_instance.value_with_units = MagicMock(return_value="1mm")
+        mock_instance._odesign = MagicMock()
+        yield mock_instance
+
+
+@patch("ansys.aedt.core.modeler.cad.primitives.GeometryModeler.unclassified_objects", new_callable=PropertyMock)
+def test_project_object_failure(mock_unclassified_objects, mock_hfss_app, caplog: pytest.LogCaptureFixture):
+    mock_unclassified_objects.side_effect = [[], [MagicMock()]]
+    gm = GeometryModeler(mock_hfss_app)
+
+    assert not gm.project_sheet("rect", "box", 1)
+    assert any(
+        "Failed to Project Sheet. Reverting to original objects." in record.getMessage() for record in caplog.records
+    )