Add body.copy() method (#373)

Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: jonahrb

README.rst

@@ -119,7 +119,14 @@ If you want to change the defaults, modify the following environment variables:
    export ANSRV_GEO_HOST=127.0.0.1
    export ANSRV_GEO_PORT=50051
 
-**On Windows**
+**On Windows Powershell**
+
+.. code::
+
+   $env:ANSRV_GEO_HOST="127.0.0.1"
+   $env:ANSRV_GEO_PORT=50051
+
+**On Windows CMD**
 
 .. code::
 

doc/source/getting_started/docker.rst

@@ -140,7 +140,7 @@ Depending on the mechanism chosen to launch the Geometry service, you can set th
                     $env:ANSRV_GEO_ENABLE_TRACE=0
                     $env:ANSRV_GEO_LOG_LEVEL=2
 
-            .. tab-item:: Windows
+            .. tab-item:: Windows CMD
 
                 .. code-block:: bash
 
@@ -218,7 +218,14 @@ If you want to change the defaults, modify environment variables and the
                     export ANSRV_GEO_HOST=127.0.0.1
                     export ANSRV_GEO_PORT=50051
 
-            .. tab-item:: Windows
+            .. tab-item:: Powershell
+
+                .. code-block:: bash
+
+                    $env:ANSRV_GEO_HOST="127.0.0.1"
+                    $env:ANSRV_GEO_PORT=50051
+
+            .. tab-item:: Windows CMD
 
                 .. code-block:: bash
 

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

@@ -1,7 +1,11 @@
 """Provides the ``Body`` class module."""
 from enum import Enum
 
-from ansys.api.geometry.v0.bodies_pb2 import SetAssignedMaterialRequest, TranslateRequest
+from ansys.api.geometry.v0.bodies_pb2 import (
+    CopyRequest,
+    SetAssignedMaterialRequest,
+    TranslateRequest,
+)
 from ansys.api.geometry.v0.bodies_pb2_grpc import BodiesStub
 from ansys.api.geometry.v0.commands_pb2 import (
     AssignMidSurfaceOffsetTypeRequest,
@@ -400,6 +404,46 @@ def translate(self, direction: UnitVector3D, distance: Union[Quantity, Distance]
             )
         )
 
+    @protect_grpc
+    def copy(self, parent: "Component", name: str = None) -> "Body":
+        """Creates a copy of the geometry body and places it under the specified parent.
+
+        Parameters
+        ----------
+        parent: Component
+            The parent component that the new body should live under.
+        name: str
+            The name to give the new body.
+
+        Returns
+        -------
+        Body
+            Copy of the body.
+        """
+        from ansys.geometry.core.designer.component import Component
+
+        # Check input types
+        check_type(parent, Component)
+        check_type(name, (type(None), str))
+        copy_name = self.name if name is None else name
+
+        self._grpc_client.log.debug(f"Copying body {self.id}.")
+
+        # Perform copy request to server
+        response = self._bodies_stub.Copy(
+            CopyRequest(
+                id=self.id,
+                parent=parent.id,
+                name=copy_name,
+            )
+        )
+
+        # Assign the new body to its specified parent (and return the new body)
+        parent._bodies.append(
+            Body(response.id, copy_name, parent, self._grpc_client, is_surface=False)
+        )
+        return parent._bodies[-1]
+
     @protect_grpc
     def tessellate(self, merge: Optional[bool] = False) -> Union["PolyData", "MultiBlock"]:
         """Tessellate the body and return the geometry as triangles.

tests/integration/test_design.py

@@ -875,6 +875,41 @@ def test_project_and_imprint_curves(modeler: Modeler):
     assert len(body.faces) == 8
 
 
+def test_copy_body(modeler: Modeler):
+    """Test copying a body."""
+
+    # Create your design on the server side
+    design = modeler.create_design("Design")
+
+    sketch_1 = Sketch().circle(Point2D([10, 10], UNITS.mm), Quantity(10, UNITS.mm))
+    body = design.extrude_sketch("Original", sketch_1, Distance(1, UNITS.mm))
+
+    # Copy body at same design level
+    copy = body.copy(design, "Copy")
+    assert len(design.bodies) == 2
+    assert design.bodies[-1] == copy
+
+    # Bodies should be distinct
+    assert body != copy
+
+    # Copy body into sub-component
+    comp1 = design.add_component("comp1")
+    copy2 = body.copy(comp1, "Subcopy")
+    assert len(comp1.bodies) == 1
+    assert comp1.bodies[-1] == copy2
+
+    # Copy a copy
+    comp2 = comp1.add_component("comp2")
+    copy3 = copy2.copy(comp2, "Copy3")
+    assert len(comp2.bodies) == 1
+    assert comp2.bodies[-1] == copy3
+
+    # Ensure deleting original doesn't affect the copies
+    design.delete_body(body)
+    assert not body.is_alive
+    assert copy.is_alive
+
+
 def test_beams(modeler: Modeler):
     """Test beam creation."""
     # Create your design on the server side