feat: add face color, round info, bring measure tools to linux (#1732)

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

Author: 5 people

doc/changelog.d/1732.added.md

@@ -0,0 +1 @@
+add face color, round info, bring measure tools to linux

src/ansys/geometry/core/connection/conversions.py

@@ -322,6 +322,25 @@ def point3d_to_grpc_point(point: Point3D) -> GRPCPoint:
     )
 
 
+def grpc_point_to_point3d(point: GRPCPoint) -> Point3D:
+    """Convert a point gRPC message class to a ``Point3D`` class.
+
+    Parameters
+    ----------
+    point : GRPCPoint
+        Source point data.
+
+    Returns
+    -------
+    Point3D
+        Converted point.
+    """
+    return Point3D(
+        [point.x, point.y, point.z],
+        DEFAULT_UNITS.SERVER_LENGTH,
+    )
+
+
 def point2d_to_grpc_point(plane: Plane, point2d: Point2D) -> GRPCPoint:
     """Convert a ``Point2D`` class to a point gRPC message.
 

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

@@ -79,7 +79,10 @@
 from ansys.geometry.core.math.plane import Plane
 from ansys.geometry.core.math.point import Point3D
 from ansys.geometry.core.math.vector import UnitVector3D
-from ansys.geometry.core.misc.auxiliary import get_design_from_body
+from ansys.geometry.core.misc.auxiliary import (
+    convert_color_to_hex,
+    get_design_from_body,
+)
 from ansys.geometry.core.misc.checks import (
     check_type,
     check_type_all_elements_in_iterable,
@@ -1108,28 +1111,7 @@ def set_suppressed(  # noqa: D102
     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}")
+        color = convert_color_to_hex(color)
 
         self._bodies_stub.SetColor(
             SetColorRequest(

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

@@ -80,6 +80,7 @@
 from ansys.geometry.core.math.vector import UnitVector3D, Vector3D
 from ansys.geometry.core.misc.checks import ensure_design_is_active, min_backend_version
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance
+from ansys.geometry.core.misc.options import ImportOptions
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.parameters.parameter import Parameter, ParameterUpdateStatus
 from ansys.geometry.core.typing import RealSequence
@@ -958,21 +959,25 @@ def delete_beam_profile(self, beam_profile: BeamProfile | str) -> None:
     @check_input_types
     @ensure_design_is_active
     @min_backend_version(24, 2, 0)
-    def insert_file(self, file_location: Path | str) -> Component:
+    def insert_file(
+        self, file_location: Path | str, import_options: ImportOptions = ImportOptions()
+    ) -> Component:
         """Insert a file into the design.
 
         Parameters
         ----------
         file_location : ~pathlib.Path | str
             Location on disk where the file is located.
+        import_options : ImportOptions
+            The options to pass into upload file
 
         Returns
         -------
         Component
             The newly inserted component.
         """
         # Upload the file to the server
-        filepath_server = self._modeler._upload_file(file_location)
+        filepath_server = self._modeler._upload_file(file_location, import_options=import_options)
 
         # Insert the file into the design
         self._design_stub.Insert(InsertRequest(filepath=filepath_server))

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

@@ -22,8 +22,11 @@
 """Module for managing a face."""
 
 from enum import Enum, unique
+from functools import cached_property
 from typing import TYPE_CHECKING
 
+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
@@ -34,15 +37,18 @@
     CreateIsoParamCurvesRequest,
     EvaluateRequest,
     GetNormalRequest,
+    SetColorRequest,
 )
 from ansys.api.geometry.v0.faces_pb2_grpc import FacesStub
 from ansys.api.geometry.v0.models_pb2 import Edge as GRPCEdge
 from ansys.geometry.core.connection.client import GrpcClient
 from ansys.geometry.core.connection.conversions import grpc_curve_to_curve, grpc_surface_to_surface
 from ansys.geometry.core.designer.edge import Edge
 from ansys.geometry.core.errors import GeometryRuntimeError, protect_grpc
+from ansys.geometry.core.math.bbox import BoundingBox2D
 from ansys.geometry.core.math.point import Point3D
 from ansys.geometry.core.math.vector import UnitVector3D
+from ansys.geometry.core.misc.auxiliary import convert_color_to_hex
 from ansys.geometry.core.misc.checks import (
     deprecated_method,
     ensure_design_is_active,
@@ -56,6 +62,7 @@
     ReversedTrimmedSurface,
     TrimmedSurface,
 )
+from ansys.tools.visualization_interface.utils.color import Color
 
 if TYPE_CHECKING:  # pragma: no cover
     from ansys.geometry.core.designer.body import Body
@@ -181,6 +188,7 @@ def __init__(
         self._commands_stub = CommandsStub(grpc_client.channel)
         self._is_reversed = is_reversed
         self._shape = None
+        self._color = None
 
     @property
     def id(self) -> str:
@@ -287,6 +295,57 @@ def loops(self) -> list[FaceLoop]:
 
         return loops
 
+    @property
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
+    def color(self) -> str:
+        """Get the current color of the face."""
+        if self._color is None and self.body.is_alive:
+            # Assigning default value first
+            self._color = Color.DEFAULT.value
+
+            # If color is not cached, retrieve from the server
+            response = self._faces_stub.GetColor(EntityIdentifier(id=self.id))
+
+            # Return if valid color returned
+            if response.color:
+                self._color = mcolors.to_hex(response.color)
+            else:
+                self._color = Color.DEFAULT.value
+
+        return self._color
+
+    @color.setter
+    def color(self, color: str | tuple[float, float, float]) -> None:
+        self.set_color(color)
+
+    @cached_property
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
+    def bounding_box(self) -> BoundingBox2D:
+        """Get the bounding box for the face."""
+        self._grpc_client.log.debug(f"Getting bounding box for {self.id}.")
+
+        result = self._faces_stub.GetBoundingBox(request=self._grpc_id)
+
+        return BoundingBox2D(result.min.x, result.max.x, result.min.y, result.max.y)
+
+    @protect_grpc
+    @check_input_types
+    @min_backend_version(25, 2, 0)
+    def set_color(self, color: str | tuple[float, float, float]) -> None:
+        """Set the color of the face."""
+        self._grpc_client.log.debug(f"Setting face color of {self.id} to {color}.")
+        color = convert_color_to_hex(color)
+
+        self._faces_stub.SetColor(
+            SetColorRequest(
+                face_id=self.id,
+                color=color,
+            )
+        )
+        self._color = color
+
     @protect_grpc
     @ensure_design_is_active
     def normal(self, u: float = 0.5, v: float = 0.5) -> UnitVector3D:

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

@@ -42,6 +42,7 @@
     RevolveFacesByHelixRequest,
     RevolveFacesRequest,
     RevolveFacesUpToRequest,
+    RoundInfoRequest,
     SplitBodyRequest,
 )
 from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
@@ -1082,15 +1083,15 @@ def split_body(
         Parameters
         ----------
         bodies : list[Body]
-            Bodies to split
+            Bodies to split.
         plane : Plane
             Plane to split with
         slicers : Edge | list[Edge] | Face | list[Face]
-            Slicers to split with
+            Slicers to split with.
         faces : list[Face]
-            Faces to split with
+            Faces to split with.
         extendFaces : bool
-            Extend faces if split with faces
+            Extend faces if split with faces.
 
         Returns
         -------
@@ -1138,3 +1139,23 @@ def split_body(
             design._update_design_inplace()
 
         return result.success
+
+    @protect_grpc
+    @min_backend_version(25, 2, 0)
+    def get_round_info(self, face: "Face") -> tuple[bool, Real]:
+        """Get info on the rounding of a face.
+
+        Parameters
+        ----------
+        Face
+            The design face to get round info on.
+
+        Returns
+        -------
+        tuple[bool, Real]
+            ``True`` if round is aligned with face's U-parameter direction, ``False`` otherwise.
+            Radius of the round.
+        """
+        result = self._commands_stub.GetRoundInfo(RoundInfoRequest(face=face._grpc_id))
+
+        return (result.along_u, result.radius)

src/ansys/geometry/core/math/bbox.py

@@ -22,9 +22,11 @@
 """Provides for managing a bounding box."""
 
 import sys
+from typing import Union
 
 from beartype import beartype as check_input_types
 
+from ansys.geometry.core.math.misc import intersect_interval
 from ansys.geometry.core.math.point import Point2D
 from ansys.geometry.core.misc.accuracy import Accuracy
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS
@@ -206,6 +208,39 @@ def __eq__(self, other: "BoundingBox2D") -> bool:
             and self.y_max == other.y_max
         )
 
+    @check_input_types
     def __ne__(self, other: "BoundingBox2D") -> bool:
         """Not equals operator for the ``BoundingBox2D`` class."""
         return not self == other
+
+    @staticmethod
+    def intersect_bboxes(
+        box_1: "BoundingBox2D", box_2: "BoundingBox2D"
+    ) -> Union[None, "BoundingBox2D"]:
+        """Find the intersection of 2 BoundingBox2D objects.
+
+        Parameters
+        ----------
+        box_1: BoundingBox2D
+            The box to consider the intersection of with respect to box_2.
+        box_2: BoundingBox2D
+            The box to consider the intersection of with respect to box_1.
+
+        Returns
+        -------
+        BoundingBox2D:
+            The box representing the intersection of the two passed in boxes.
+        """
+        intersect, min_x, max_x = intersect_interval(
+            box_1.x_min, box_2.x_min, box_1.x_max, box_2.x_max
+        )
+        if not intersect:
+            return None
+
+        intersect, min_y, max_y = intersect_interval(
+            box_1.y_min, box_2.y_min, box_1.y_max, box_2.y_max
+        )
+        if not intersect:
+            return None
+
+        return BoundingBox2D(min_x, max_x, min_y, max_y)

src/ansys/geometry/core/math/misc.py

@@ -24,6 +24,7 @@
 from beartype import beartype as check_input_types
 import numpy as np
 
+from ansys.geometry.core.misc.accuracy import Accuracy
 from ansys.geometry.core.typing import Real
 
 
@@ -92,3 +93,42 @@ def get_two_circle_intersections(
         y4 = y2 + dy
 
         return ((x3, y3), (x4, y4))
+
+
+def intersect_interval(first_min, second_min, first_max, second_max) -> tuple[bool, Real, Real]:
+    """Find the intersection of two intervals.
+
+    Parameters
+    ----------
+    first_min : Real
+        The minimum value of the first interval.
+    second_min : Real
+        The minimum value of the second interval.
+    first_max : Real
+        The maximum value of the first interval.
+    second_max : Real
+        The maximum value of the second interval.
+
+    Returns
+    -------
+    tuple[bool, Real, Real]
+        Tuple with a boolean to indicate whether the intervals intersect,
+        the minimum value of the intersection interval,
+        and the maximum value of the intersection interval.
+        If they do not intersect, then the boolean is False and the other values are 0.
+    """
+    minimum = second_min
+    if first_min > minimum:
+        minimum = first_min
+
+    maximum = second_max
+    if first_max < maximum:
+        maximum = first_max
+
+    if minimum > maximum:
+        if minimum - maximum > Accuracy.length_accuracy():
+            return False, 0, 0
+
+        maximum, minimum = minimum, maximum
+
+    return True, minimum, maximum