feat: rename object

doc/changelog.d/1648.added.md

@@ -0,0 +1 @@
+rename object

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

@@ -24,6 +24,7 @@
 from enum import Enum, unique
 from typing import TYPE_CHECKING, List, Union
 
+from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
 from ansys.api.geometry.v0.commands_pb2 import (
     ChamferRequest,
     CreateCircularPatternRequest,
@@ -37,6 +38,7 @@
     FullFilletRequest,
     ModifyLinearPatternRequest,
     PatternRequest,
+    RenameObjectRequest,
 )
 from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
 from ansys.geometry.core.connection import GrpcClient
@@ -308,7 +310,7 @@ def extrude_faces_up_to(
         seed_point : Point3D
             Origin to define the extrusion.
         direction : UnitVector3D, default: None
-            Direction of extrusion.
+            Direction of extrusion. If no direction is provided, it will be inferred.
         extrude_type : ExtrudeType, default: ExtrudeType.ADD
             Type of extrusion to be performed.
         offset_mode : OffsetMode, default: OffsetMode.MOVE_FACES_TOGETHER
@@ -496,6 +498,28 @@ def extrude_edges_up_to(
 
     @protect_grpc
     @min_backend_version(25, 2, 0)
+    def rename_object(self, selection: List[EntityIdentifier], name: str) -> bool:
+        """Rename an object.
+
+        Parameters
+        ----------
+        selection : List[str]
+            Selection of the object to rename.
+        name : str
+            New name for the object.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+        """
+        result = self._commands_stub.RenameObject(
+            RenameObjectRequest(
+                selection=[EntityIdentifier(id=entity_id) for entity_id in selection], name=name
+            )
+        )
+        return result.success
+
     def create_linear_pattern(
         self,
         selection: Union["Face", List["Face"]],
@@ -524,11 +548,6 @@ def create_linear_pattern(
             How many times the pattern repeats in the y direction.
         pitch_y : Real, default: None
             The spacing between each pattern member in the y direction.
-
-        Returns
-        -------
-        bool
-            ``True`` when successful, ``False`` when failed.
         """
         from ansys.geometry.core.designer.face import Face
 

tests/integration/test_geometry_commands.py

@@ -277,6 +277,48 @@ def test_extrude_edges_and_up_to(modeler: Modeler):
     )
 
 
+def test_rename_body_object(modeler: Modeler):
+    """Test renaming body objects."""
+    design = modeler.create_design("rename")
+    body = design.extrude_sketch("box", Sketch().box(Point2D([0, 0]), 1, 1), 1)
+
+    selection = [body.id]
+    result = modeler.geometry_commands.rename_object(selection, "new_name")
+    design._update_design_inplace()
+
+    body = design.bodies[0]
+    assert result
+    assert body.name == "new_name"
+
+    result = modeler.geometry_commands.rename_object(selection, "new_name2")
+    design._update_design_inplace()
+
+    body = design.bodies[0]
+    assert result
+    assert body.name == "new_name2"
+
+
+def test_rename_component_object(modeler: Modeler):
+    """Test renaming component objects."""
+    design = modeler.create_design("rename_component")
+    body = design.extrude_sketch("box", Sketch().box(Point2D([0, 0]), 1, 1), 1)
+
+    selection = [body.parent_component.id]
+    result = modeler.geometry_commands.rename_object(selection, "new_name")
+    design._update_design_inplace()
+
+    component = body.parent_component
+    assert result
+    assert component.name == "new_name"
+
+    result = modeler.geometry_commands.rename_object(selection, "new_name2")
+    design._update_design_inplace()
+
+    component = body.parent_component
+    assert result
+    assert component.name == "new_name2"
+
+
 def test_linear_pattern(modeler: Modeler):
     design = modeler.create_design("linear_pattern")
     body = design.extrude_sketch("box", Sketch().box(Point2D([0, 0]), 1, 1), 1)