feat: name setter and fill style getter setters (#1299)

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

Author: 5 people

doc/changelog.d/1299.added.md

@@ -0,0 +1 @@
+feat: name setter and fill style getter setters

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

@@ -35,6 +35,8 @@
     RotateRequest,
     ScaleRequest,
     SetAssignedMaterialRequest,
+    SetFillStyleRequest,
+    SetNameRequest,
     TranslateRequest,
 )
 from ansys.api.geometry.v0.bodies_pb2_grpc import BodiesStub
@@ -105,6 +107,15 @@ class CollisionType(Enum):
     CONTAINEDTOUCH = 4
 
 
+@unique
+class FillStyle(Enum):
+    """Provides values for fill styles supported."""
+
+    DEFAULT = 0
+    OPAQUE = 1
+    TRANSPARENT = 2
+
+
 class IBody(ABC):
     """Defines the common methods for a body, providing the abstract body interface.
 
@@ -122,6 +133,21 @@ def name(self) -> str:
         """Get the name of the body."""
         return
 
+    @abstractmethod
+    def set_name(self, str) -> None:
+        """Set the name of the body."""
+        return
+
+    @abstractmethod
+    def fill_style(self) -> FillStyle:
+        """Get the fill style of the body."""
+        return
+
+    @abstractmethod
+    def set_fill_style(self, fill_style: FillStyle) -> None:
+        """Set the fill style of the body."""
+        return
+
     @abstractmethod
     def faces(self) -> List[Face]:
         """Get a list of all faces within the body.
@@ -659,6 +685,7 @@ def __init__(
         self._bodies_stub = BodiesStub(self._grpc_client.channel)
         self._commands_stub = CommandsStub(self._grpc_client.channel)
         self._tessellation = None
+        self._fill_style = FillStyle.DEFAULT
 
     def reset_tessellation_cache(func):  # noqa: N805
         """Decorate ``MasterBody`` methods that need tessellation cache update.
@@ -694,6 +721,18 @@ def id(self) -> str:  # noqa: D102
     def name(self) -> str:  # noqa: D102
         return self._name
 
+    @name.setter
+    def name(self, value: str):  # noqa: D102
+        self.set_name(value)
+
+    @property
+    def fill_style(self) -> str:  # noqa: D102
+        return self._fill_style
+
+    @fill_style.setter
+    def fill_style(self, value: FillStyle):  # noqa: D102
+        self.set_fill_style(value)
+
     @property
     def is_surface(self) -> bool:  # noqa: D102
         return self._is_surface
@@ -856,6 +895,36 @@ def translate(  # noqa: D102
             )
         )
 
+    @protect_grpc
+    @check_input_types
+    @min_backend_version(25, 1, 0)
+    def set_name(  # noqa: D102
+        self, name: str
+    ) -> None:
+        self._grpc_client.log.debug(f"Renaming body {self.id} from '{self.name}' to '{name}'.")
+        self._bodies_stub.SetName(
+            SetNameRequest(
+                body_id=self.id,
+                name=name,
+            )
+        )
+        self._name = name
+
+    @protect_grpc
+    @check_input_types
+    @min_backend_version(25, 1, 0)
+    def set_fill_style(  # noqa: D102
+        self, fill_style: FillStyle
+    ) -> None:
+        self._grpc_client.log.debug(f"Setting body fill style {self.id}.")
+        self._bodies_stub.SetFillStyle(
+            SetFillStyleRequest(
+                body_id=self.id,
+                fill_style=fill_style.value,
+            )
+        )
+        self._fill_style = fill_style
+
     @protect_grpc
     @check_input_types
     @reset_tessellation_cache
@@ -1058,6 +1127,18 @@ def id(self) -> str:  # noqa: D102
     def name(self) -> str:  # noqa: D102
         return self._template.name
 
+    @name.setter
+    def name(self, value: str):  # noqa: D102
+        self._template.name = value
+
+    @property
+    def fill_style(self) -> str:  # noqa: D102
+        return self._template.fill_style
+
+    @fill_style.setter
+    def fill_style(self, fill_style: FillStyle) -> str:  # noqa: D102
+        self._template.fill_style = fill_style
+
     @property
     def parent_component(self) -> "Component":  # noqa: D102
         return self._parent_component
@@ -1277,6 +1358,14 @@ def imprint_projected_curves(  # noqa: D102
 
         return imprinted_faces
 
+    @ensure_design_is_active
+    def set_name(self, name: str) -> None:  # noqa: D102
+        return self._template.set_name(name)
+
+    @ensure_design_is_active
+    def set_fill_style(self, fill_style: FillStyle) -> None:  # noqa: D102
+        return self._template.set_fill_style(fill_style)
+
     @ensure_design_is_active
     def translate(  # noqa: D102
         self, direction: UnitVector3D, distance: Union[Quantity, Distance, Real]

tests/integration/test_design.py

@@ -38,7 +38,7 @@
     SharedTopologyType,
     SurfaceType,
 )
-from ansys.geometry.core.designer.body import CollisionType
+from ansys.geometry.core.designer.body import CollisionType, FillStyle
 from ansys.geometry.core.designer.face import FaceLoopType
 from ansys.geometry.core.errors import GeometryExitedError
 from ansys.geometry.core.materials import Material, MaterialProperty, MaterialPropertyType
@@ -1964,6 +1964,51 @@ def test_get_collision(modeler: Modeler):
     assert body2.get_collision(body3) == CollisionType.NONE
 
 
+def test_set_body_name(modeler: Modeler):
+    """Test the setting the name of a body."""
+    skip_if_linux(modeler, test_set_body_name.__name__, "set_name")  # Skip test on Linux
+
+    design = modeler.create_design("simple_cube")
+    unit = DEFAULT_UNITS.LENGTH
+    plane = Plane(
+        Point3D([1 / 2, 1 / 2, 0.0], unit=unit),
+        UNITVECTOR3D_X,
+        UNITVECTOR3D_Y,
+    )
+    box_plane = Sketch(plane)
+    box_plane.box(Point2D([0.0, 0.0]), width=1 * unit, height=1 * unit)
+    box = design.extrude_sketch("first_name", box_plane, 1 * unit)
+    assert box.name == "first_name"
+    box.set_name("updated_name")
+    assert box.name == "updated_name"
+    box.name = "updated_name2"
+    assert box.name == "updated_name2"
+
+
+def test_set_fill_style(modeler: Modeler):
+    """Test the setting the fill style of a body."""
+    skip_if_linux(modeler, test_set_fill_style.__name__, "set_fill_style")  # Skip test on Linux
+
+    design = modeler.create_design("RVE")
+    unit = DEFAULT_UNITS.LENGTH
+
+    plane = Plane(
+        Point3D([1 / 2, 1 / 2, 0.0], unit=unit),
+        UNITVECTOR3D_X,
+        UNITVECTOR3D_Y,
+    )
+
+    box_plane = Sketch(plane)
+    box_plane.box(Point2D([0.0, 0.0]), width=1 * unit, height=1 * unit)
+    box = design.extrude_sketch("Matrix", box_plane, 1 * unit)
+
+    assert box.fill_style == FillStyle.DEFAULT
+    box.set_fill_style(FillStyle.TRANSPARENT)
+    assert box.fill_style == FillStyle.TRANSPARENT
+    box.fill_style = FillStyle.OPAQUE
+    assert box.fill_style == FillStyle.OPAQUE
+
+
 def test_body_scale(modeler: Modeler):
     """Verify the correct scaling of a body."""
     design = modeler.create_design("BodyScale_Test")