feat: component name setting (#1820)

Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Umut Soysal <[email protected]>
Co-authored-by: Jacob Kerstetter <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 5 people

doc/changelog.d/1820.added.md

@@ -0,0 +1 @@
+component name setting

pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "ansys-api-geometry==0.4.46",
+    "ansys-api-geometry==0.4.47",
     "ansys-tools-path>=0.3,<1",
     "attrs!=24.3.0",
     "beartype>=0.11.0,<0.20",

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

@@ -52,7 +52,7 @@
     SetSharedTopologyRequest,
 )
 from ansys.api.geometry.v0.components_pb2_grpc import ComponentsStub
-from ansys.api.geometry.v0.models_pb2 import Direction, Line, TrimmedCurveList
+from ansys.api.geometry.v0.models_pb2 import Direction, Line, SetObjectNameRequest, TrimmedCurveList
 from ansys.geometry.core.connection.client import GrpcClient
 from ansys.geometry.core.connection.conversions import (
     grpc_matrix_to_matrix,
@@ -266,6 +266,20 @@ def name(self) -> str:
         """Name of the component."""
         return self._name
 
+    @name.setter
+    def name(self, value: str) -> None:
+        """Set the name of the component."""
+        self.set_name(value)
+
+    @protect_grpc
+    @check_input_types
+    @min_backend_version(25, 2, 0)
+    def set_name(self, name: str) -> None:
+        """Set the name of the component."""
+        self._grpc_client.log.debug(f"Renaming component {self.id} from '{self.name}' to '{name}'.")
+        self._component_stub.SetName(SetObjectNameRequest(id=self._grpc_id, name=name))
+        self._name = name
+
     @property
     def instance_name(self) -> str:
         """Name of the component instance."""

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

@@ -214,7 +214,9 @@ def end(self) -> Point3D:
             # Only for versions earlier than 24.2.0 (before the introduction of the shape property)
             self._grpc_client.log.debug("Requesting edge end point from server.")
             response = self._edges_stub.GetStartAndEndPoints(self._grpc_id)
-            return Point3D([response.end.x, response.end.y, response.end.z])
+            return Point3D(
+                [response.end.x, response.end.y, response.end.z], unit=DEFAULT_UNITS.SERVER_LENGTH
+            )
 
     @property
     @protect_grpc

tests/integration/test_design.py

@@ -3192,6 +3192,17 @@ def test_set_face_color(modeler: Modeler):
         faces[3].opacity = 255
 
 
+def test_set_component_name(modeler: Modeler):
+    """Test the setting of component names."""
+
+    design = modeler.create_design("ComponentNameTest")
+    component = design.add_component("Component1")
+    assert component.name == "Component1"
+
+    component.name = "ChangedComponentName"
+    assert component.name == "ChangedComponentName"
+
+
 def test_get_face_bounding_box(modeler: Modeler):
     """Test getting the bounding box of a face."""
     design = modeler.create_design("face_bounding_box")