FIX: fix geometry doc (#543)

Co-authored-by: drewm102 <[email protected]>

Author: ansminsisung

doc/source/api/geometry.rst

@@ -11,6 +11,7 @@ Classes
 
    arc_data.ArcData
    r_tree.RTree
+   r_tree.RTreeObj
    polygon_data.PolygonData
    point_data.PointData
    point3d_data.Point3DData
@@ -22,6 +23,7 @@ Enums
 .. autosummary::
    :toctree: _autosummary
 
+   arc_data.RotationDirection
    polygon_data.ExtentType
    polygon_data.PolygonSenseType
    polygon_data.IntersectionType

src/ansys/edb/core/geometry/arc_data.py

@@ -1,4 +1,12 @@
 """Arc data."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ansys.edb.core.typing import PointLike
+
+
 from enum import Enum
 import math
 
@@ -23,19 +31,15 @@ class ArcData:
 
     __stub: arc_data_pb2_grpc.ArcDataServiceStub = session.StubAccessor(session.StubType.arc_data)
 
-    def __init__(self, start, end, **kwargs):
+    def __init__(self, start: PointLike, end: PointLike, **kwargs):
         """Create an arc.
 
         Parameters
         ----------
-        start : ansys.edb.core.typing.PointLike
-        end : ansys.edb.core.typing.PointLike
+        start : :term:`Point2DLike`
+        end : :term:`Point2DLike`
         height: float, int, optional
-        thru : ansys.edb.core.typing.PointLike, optional
         direction : Literal["cw", "ccw", "colinear"], optional
-        radius : float, optional
-        center : ansys.edb.core.typing.PointLike, optional
-        is_big : bool, optional
         """
         self._start = conversions.to_point(start)
         self._end = conversions.to_point(end)
@@ -47,7 +51,7 @@ def __init__(self, start, end, **kwargs):
         if "direction" in kwargs:
             self._height_options["direction"] = RotationDirection(kwargs["direction"])
 
-    def __str__(self):
+    def __str__(self) -> str:
         """Generate a readable string for the arc.
 
         Returns
@@ -61,31 +65,43 @@ def __str__(self):
             return f"{self.start} {arc} {self.end}"
 
     @property
-    def start(self):
-        """:class:`.PointData`: Start point of the arc."""
+    def start(self) -> PointData:
+        """
+        :class:`.PointData`: Start point of the arc.
+
+        This property is read-only.
+        """
         return self._start
 
     @property
-    def end(self):
-        """:class:`.PointData`: End point of the arc."""
+    def end(self) -> PointData:
+        """
+        :class:`.PointData`: End point of the arc.
+
+        This property is read-only.
+        """
         return self._end
 
     @property
-    def height(self):
-        """:obj:`float`: Height of the arc."""
+    def height(self) -> float:
+        """
+        :obj:`float`: Height of the arc.
+
+        This property is read-only.
+        """
         if self._height is None:
             self._height = self.__stub.GetHeight(messages.arc_message(self)).value
 
         return self._height
 
-    def is_point(self, tolerance=0.0):
+    def is_point(self, tolerance: float = 0.0) -> bool:
         """Determine if the arc is a point.
 
         An arc is a point when its start and end points are the same.
 
         Parameters
         ----------
-        tolerance : float, optional
+        tolerance : float, default: 0.0
            Tolearance.
 
         Returns
@@ -95,12 +111,12 @@ def is_point(self, tolerance=0.0):
         """
         return self.is_segment(tolerance) and self.start.equals(self.end, tolerance)
 
-    def is_segment(self, tolerance=0.0):
+    def is_segment(self, tolerance: float = 0.0) -> bool:
         """Determine if the arc is a straight line segment.
 
         Parameters
         ----------
-        tolerance : float, optional
+        tolerance : float, default: 0.0
             Tolearance.
 
         Returns
@@ -112,28 +128,44 @@ def is_segment(self, tolerance=0.0):
 
     @property
     @parser.to_point_data
-    def center(self):
-        """:class:`.PointData`: Center point of the arc."""
+    def center(self) -> PointData:
+        """
+        :class:`.PointData`: Center point of the arc.
+
+        This property is read-only.
+        """
         return self.__stub.GetCenter(messages.arc_message(self))
 
     @property
     @parser.to_point_data
-    def midpoint(self):
-        """:class:`.PointData`: Midpoint of the arc."""
+    def midpoint(self) -> PointData:
+        """
+        :class:`.PointData`: Midpoint of the arc.
+
+        This property is read-only.
+        """
         return self.__stub.GetMidpoint(messages.arc_message(self))
 
     @property
-    def radius(self):
-        """:obj:`float`: Radius of the arc."""
+    def radius(self) -> float:
+        """
+        :obj:`float`: Radius of the arc.
+
+        This property is read-only.
+        """
         return self.__stub.GetRadius(messages.arc_message(self)).value
 
     @property
     @parser.to_polygon_data
-    def bbox(self):
-        """:class:`.PolygonData`: Rectangular bounding box of the arc."""
+    def bbox(self) -> PolygonData:
+        """
+        :class:`.PolygonData`: Rectangular bounding box of the arc.
+
+        This property is read-only.
+        """
         return self.__stub.GetBoundingBox(messages.arc_message(self))
 
-    def is_big(self):
+    def is_big(self) -> bool:
         """Determine if the arc is big.
 
         Returns
@@ -144,10 +176,10 @@ def is_big(self):
         dist = self.start.distance(self.end)
         return 2 * math.fabs(self.height) > dist
 
-    def is_left(self):
+    def is_left(self) -> bool:
         """Determine if the arc rotates clockwise.
 
-        This method is the same as the ``is_cw`` method.
+        This method is the same as the :obj:`is_cw` method.
 
         Returns
         -------
@@ -156,7 +188,7 @@ def is_left(self):
         """
         return self.is_cw()
 
-    def is_cw(self):
+    def is_cw(self) -> bool:
         """Determine if the arc rotates clockwise.
 
         This method is the same as the ``is_left`` method.
@@ -168,7 +200,7 @@ def is_cw(self):
         """
         return self.height > 0.0
 
-    def is_ccw(self):
+    def is_ccw(self) -> bool:
         """Determine if the arc rotates counter-clockwise.
 
         Returns
@@ -179,16 +211,20 @@ def is_ccw(self):
         return self.height < 0.0
 
     @property
-    def direction(self):
-        """:obj:`Literal["cw", "ccw", "colinear"]`: Rotational direction of the arc."""
+    def direction(self) -> str:
+        """
+        :obj:`str` : Rotational direction of the arc which can be "cw" or "ccw" or "colinear".
+
+        This property is read-only.
+        """
         if self.is_cw():
             return "cw"
         elif self.is_ccw():
             return "ccw"
         else:
             return "colinear"
 
-    def angle(self, arc=None):
+    def angle(self, arc: ArcData = None) -> float:
         """Get the angle between this arc and another arc if provided or the angle of this arc.
 
         Parameters
@@ -214,24 +250,32 @@ def angle(self, arc=None):
         return vec1.angle(vec2)
 
     @property
-    def length(self):
-        """:obj:`str`: Circumference length of the arc."""
+    def length(self) -> str:
+        """
+        :obj:`str`: Circumference length of the arc.
+
+        This property is read-only.
+        """
         if self.is_segment():
             return self.start.distance(self.end)
         else:
             return math.fabs(self.angle() * self.radius)
 
     @property
-    def points(self):
-        """:obj:`list` of :class:`.PointData`: Geometric points representing the arc."""
+    def points(self) -> list[PointData]:
+        """
+        :obj:`list` of :class:`.PointData`: Geometric points representing the arc.
+
+        This property is read-only.
+        """
         return [self._start, PointData(self.height), self._end]
 
-    def tangent_at(self, point):
+    def tangent_at(self, point: PointLike) -> PointData:
         """Get the tangent vector of the arc at a given point.
 
         Parameters
         ----------
-        point : ansys.edb.core.typing.PointLike
+        point : :term:`Point2DLike`
             Point.
 
         Returns
@@ -250,16 +294,16 @@ def tangent_at(self, point):
             return PointData(vec.y, -vec.x)
 
     @parser.to_box
-    def closest_points(self, other):
+    def closest_points(self, other: ArcData) -> tuple[PointData, PointData]:
         """Get the closest points from this arc to another arc, and vice versa.
 
         Parameters
         ----------
-        other : ArcData
+        other : .ArcData
             Other arc.
 
         Returns
         -------
-        tuple[.PointData, .PointData]
+        tuple of (.PointData, .PointData)
         """
         return self.__stub.ClosestPoints(messages.arc_data_two_points(self, other))