feat: get and set body color (#1357)

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

Author: 3 people

doc/changelog.d/1357.added.md

@@ -0,0 +1 @@
+get and set body color

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

@@ -28,6 +28,7 @@
 from typing import TYPE_CHECKING, Union
 
 from beartype import beartype as check_input_types
+import matplotlib.colors as mcolors
 from pint import Quantity
 
 from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
@@ -40,6 +41,7 @@
     RotateRequest,
     ScaleRequest,
     SetAssignedMaterialRequest,
+    SetColorRequest,
     SetFillStyleRequest,
     SetNameRequest,
     TranslateRequest,
@@ -149,6 +151,23 @@ def set_fill_style(self, fill_style: FillStyle) -> None:
         """Set the fill style of the body."""
         return
 
+    @abstractmethod
+    def color(self) -> str:
+        """Get the color of the body."""
+        return
+
+    @abstractmethod
+    def set_color(self, color: str | tuple[float, float, float]) -> None:
+        """Set the color of the body.
+
+        Parameters
+        ----------
+        color : str | tuple[float, float, float]
+            Color to set the body to. This can be a string representing a color name
+            or a tuple of RGB values in the range [0, 1] (RGBA) or [0, 255] (pure RGB).
+        """
+        return
+
     @abstractmethod
     def faces(self) -> list[Face]:
         """Get a list of all faces within the body.
@@ -687,6 +706,7 @@ def __init__(
         self._commands_stub = CommandsStub(self._grpc_client.channel)
         self._tessellation = None
         self._fill_style = FillStyle.DEFAULT
+        self._color = None
 
     def reset_tessellation_cache(func):  # noqa: N805
         """Decorate ``MasterBody`` methods that need tessellation cache update.
@@ -734,6 +754,33 @@ def fill_style(self) -> str:  # noqa: D102
     def fill_style(self, value: FillStyle):  # noqa: D102
         self.set_fill_style(value)
 
+    @property
+    def color(self) -> str:  # noqa: D102
+        """Get the current color of the body."""
+        if self._color is None:
+            if self._grpc_client.backend_version < (25, 1, 0):  # pragma: no cover
+                # Server does not support color retrieval before version 25.1.0
+                self._grpc_client.log.warning(
+                    "Server does not support color retrieval. Assigning default."
+                )
+                self._color = "#000000"  # Default color
+            else:
+                # Fetch color from the server if it's not cached
+                color_response = self._bodies_stub.GetColor(EntityIdentifier(id=self._id))
+
+                if color_response.color:
+                    self._color = mcolors.to_hex(color_response.color)
+                else:  # pragma: no cover
+                    self._grpc_client.log.warning(
+                        f"Color could not be retrieved for body {self._id}. Assigning default."
+                    )
+                    self._color = "#000000"  # Default color
+        return self._color
+
+    @color.setter
+    def color(self, value: str | tuple[float, float, float]):  # noqa: D102
+        self.set_color(value)
+
     @property
     def is_surface(self) -> bool:  # noqa: D102
         return self._is_surface
@@ -926,6 +973,43 @@ def set_fill_style(  # noqa: D102
         )
         self._fill_style = fill_style
 
+    @protect_grpc
+    @check_input_types
+    @min_backend_version(25, 1, 0)
+    def set_color(self, color: str | tuple[float, float, float]) -> None:
+        """Set the color of the body."""
+        self._grpc_client.log.debug(f"Setting body color of {self.id} to {color}.")
+
+        try:
+            if isinstance(color, tuple):
+                # Ensure that all elements are within 0-1 or 0-255 range
+                if all(0 <= c <= 1 for c in color):
+                    # Ensure they are floats if in 0-1 range
+                    if not all(isinstance(c, float) for c in color):
+                        raise ValueError("RGB values in the 0-1 range must be floats.")
+                elif all(0 <= c <= 255 for c in color):
+                    # Ensure they are integers if in 0-255 range
+                    if not all(isinstance(c, int) for c in color):
+                        raise ValueError("RGB values in the 0-255 range must be integers.")
+                    # Normalize the 0-255 range to 0-1
+                    color = tuple(c / 255.0 for c in color)
+                else:
+                    raise ValueError("RGB tuple contains mixed ranges or invalid values.")
+
+                color = mcolors.to_hex(color)
+            elif isinstance(color, str):
+                color = mcolors.to_hex(color)
+        except ValueError as err:
+            raise ValueError(f"Invalid color value: {err}")
+
+        self._bodies_stub.SetColor(
+            SetColorRequest(
+                body_id=self.id,
+                color=color,
+            )
+        )
+        self._color = color
+
     @protect_grpc
     @check_input_types
     @reset_tessellation_cache
@@ -1140,6 +1224,14 @@ def fill_style(self) -> str:  # noqa: D102
     def fill_style(self, fill_style: FillStyle) -> str:  # noqa: D102
         self._template.fill_style = fill_style
 
+    @property
+    def color(self) -> str:  # noqa: D102
+        return self._template.color
+
+    @color.setter
+    def color(self, color: str | tuple[float, float, float]) -> None:  # noqa: D102
+        return self._template.set_color(color)
+
     @property
     def parent_component(self) -> "Component":  # noqa: D102
         return self._parent_component
@@ -1367,6 +1459,10 @@ def set_name(self, name: str) -> None:  # noqa: D102
     def set_fill_style(self, fill_style: FillStyle) -> None:  # noqa: D102
         return self._template.set_fill_style(fill_style)
 
+    @ensure_design_is_active
+    def set_color(self, color: str | tuple[float, float, float]) -> None:  # noqa: D102
+        return self._template.set_color(color)
+
     @ensure_design_is_active
     def translate(  # noqa: D102
         self, direction: UnitVector3D, distance: Quantity | Distance | Real

tests/integration/test_design.py

@@ -23,6 +23,7 @@
 
 import os
 
+import matplotlib.colors as mcolors
 import numpy as np
 from pint import Quantity
 import pytest
@@ -2010,6 +2011,50 @@ def test_set_fill_style(modeler: Modeler):
     assert box.fill_style == FillStyle.OPAQUE
 
 
+def test_set_body_color(modeler: Modeler):
+    """Test the getting and setting of body color."""
+    skip_if_linux(modeler, test_set_body_color.__name__, "set_color")  # Skip test on Linux
+
+    design = modeler.create_design("RVE2")
+    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("Block", box_plane, 1 * unit)
+
+    # Default body color is if it is not set on server side.
+    assert box.color == "#000000"
+
+    # Set the color of the body using hex code.
+    box.color = "#0000ff"
+    assert box.color == "#0000ff"
+
+    box.color = "#ffc000"
+    assert box.color == "#ffc000"
+
+    # Set the color of the body using color name.
+    box.set_color("green")
+    box.color == "#008000"
+
+    # Set the color of the body using RGB values between (0,1) as floats.
+    box.set_color((1.0, 0.0, 0.0))
+    box.color == "#ff0000"
+
+    # Set the color of the body using RGB values between (0,255) as integers).
+    box.set_color((0, 255, 0))
+    box.color == "#00ff00"
+
+    # Assigning color object directly
+    blue_color = mcolors.to_rgba("#0000FF")
+    box.color = blue_color
+    assert box.color == "#0000ff"
+
+
 def test_body_scale(modeler: Modeler):
     """Verify the correct scaling of a body."""
     design = modeler.create_design("BodyScale_Test")