FIX: Fix geometry doc

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

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

@@ -4,7 +4,6 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from ansys.edb.core.geometry.arc_data import ArcData
     from ansys.edb.core.typing import PointLike
 
 
@@ -37,8 +36,8 @@ def __init__(self, start: PointLike, end: PointLike, **kwargs):
 
         Parameters
         ----------
-        start : .PointLike
-        end : .PointLike
+        start : :term:`Point2DLike`
+        end : :term:`Point2DLike`
         height: float, int, optional
         direction : Literal["cw", "ccw", "colinear"], optional
         """
@@ -152,7 +151,7 @@ def is_big(self) -> bool:
     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
         -------
@@ -185,7 +184,7 @@ def is_ccw(self) -> bool:
 
     @property
     def direction(self) -> str:
-        """:obj:`Literal["cw", "ccw", "colinear"]`: Rotational direction of the arc."""
+        """:obj:`str` : Rotational direction of the arc which can be "cw" or "ccw" or "colinear"."""
         if self.is_cw():
             return "cw"
         elif self.is_ccw():
@@ -236,7 +235,7 @@ def tangent_at(self, point: PointLike) -> PointData:
 
         Parameters
         ----------
-        point : .PointLike
+        point : :term:`Point2DLike`
             Point.
 
         Returns
@@ -260,7 +259,7 @@ def closest_points(self, other: ArcData) -> tuple[PointData, PointData]:
 
         Parameters
         ----------
-        other : .ArcDataother
+        other : .ArcData
             Other arc.
 
         Returns

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

@@ -1,4 +1,13 @@
 """Point data."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ansys.edb.core.typing import ValueLike, PointLike
+    from ansys.edb.core.utility.value import Value
+    from typing import Iterable
+
 from functools import reduce
 import math
 import operator
@@ -18,12 +27,12 @@ class PointData:
         session.StubType.point_data
     )
 
-    def __init__(self, *data):
+    def __init__(self, *data: Iterable[ValueLike]):
         """Initialize point data from a list of coordinates.
 
         Parameters
         ----------
-        data : Iterable[Iterable[ansys.edb.core.typing.ValueLike], ansys.edb.core.typing.ValueLike]
+        data : :obj:`list` of :term:`ValueLike`
         """
         self._x = self._y = self._arc_h = None
 
@@ -49,20 +58,20 @@ def __init__(self, *data):
                 f"two values representing x and y coordinates. - Received '{data}'"
             )
 
-    def __eq__(self, other):
+    def __eq__(self, other: PointData) -> bool:
         """Determine if two objects represent the same coordinates.
 
         Parameters
         ----------
-        other : PointData
+        other : .PointData
 
         Returns
         -------
         bool
         """
         return self.equals(other)
 
-    def __len__(self):
+    def __len__(self) -> int:
         """Return the number of coordinates present.
 
         Returns
@@ -71,33 +80,33 @@ def __len__(self):
         """
         return len(self._matrix_values)
 
-    def __add__(self, other):
+    def __add__(self, other: PointLike) -> PointData:
         """Perform matrix addition of two points.
 
         Parameters
         ----------
-        other : ansys.edb.core.typing.PointLike
+        other : :term:`Point2DLike`
 
         Returns
         -------
-        PointData
+        .PointData
         """
         return self.__class__(self._map_reduce(other, operator.__add__))
 
-    def __sub__(self, other):
+    def __sub__(self, other: PointLike) -> PointData:
         """Perform matrix subtraction of two points.
 
         Parameters
         ----------
-        other : ansys.edb.core.typing.PointLike
+        other : :term:`Point2DLike`
 
         Returns
         -------
-        PointData
+        .PointData
         """
         return self.__class__(self._map_reduce(other, operator.__sub__))
 
-    def __str__(self):
+    def __str__(self) -> str:
         """Generate unique name for the point object.
 
         Returns
@@ -107,13 +116,13 @@ def __str__(self):
         coord = ",".join([str(v) for v in self._matrix_values])
         return f"<{coord}>" if self.is_arc else f"({coord})"
 
-    def equals(self, other, tolerance=0.0):
+    def equals(self, other, tolerance: float = 0.0) -> bool:
         """Determine if two points are located at the same coordinates.
 
         Parameters
         ----------
-        other : ansys.edb.core.typing.PointLike
-        tolerance : float, optional
+        other : :term:`Point2DLike`
+        tolerance : float, default: 0.0
 
         Returns
         -------
@@ -131,7 +140,7 @@ def value_equals(a, b):
             return False
 
     @property
-    def _matrix_values(self):
+    def _matrix_values(self) -> list[Value]:
         """:obj:`list` of :class:`.Value`: Coordinates of the point as a list of values."""
         return [self.arc_height] if self.is_arc else [self.x, self.y]
 
@@ -140,31 +149,31 @@ def _map_reduce(self, other, op):
         return [reduce(op, values) for values in zip(self._matrix_values, other._matrix_values)]
 
     @property
-    def is_arc(self):
+    def is_arc(self) -> bool:
         """:obj:`bool`: Flag indicating if the point represents an arc."""
         return self._arc_h is not None
 
     @property
-    def arc_height(self):
+    def arc_height(self) -> Value:
         """:class:`.Value`: Height of the arc."""
         return self._arc_h
 
     @property
-    def x(self):
+    def x(self) -> Value:
         """:class:`.Value`: X coordinate."""
         return self._x
 
     @property
-    def y(self):
+    def y(self) -> Value:
         """:class:`.Value`: Y coordinate."""
         return self._y
 
     @property
-    def is_parametric(self):
+    def is_parametric(self) -> bool:
         """:obj:`bool`: Flag indicating if the point contains parametric values (variable expressions)."""
         return any(val.is_parametric for val in self._matrix_values)
 
-    def magnitude(self):
+    def magnitude(self) -> float:
         """Get the magnitude of the point vector.
 
         Returns
@@ -176,7 +185,7 @@ def magnitude(self):
             return 0
         return math.sqrt(sum([v**2 for v in self._matrix_values], value.Value(0)).value)
 
-    def normalized(self):
+    def normalized(self) -> PointData:
         """Normalize the point vector.
 
         Returns
@@ -188,32 +197,32 @@ def normalized(self):
         return self.__class__(n)
 
     @parser.to_point_data
-    def closest(self, start, end):
+    def closest(self, start: PointLike, end: PointLike) -> PointData | None:
         """Get the closest point on a line segment from the point.
 
         Parameters
         ----------
-        start : ansys.edb.core.typing.PointLike
+        start : :term:`Point2DLike`
             Start point of the line segment.
-        end : ansys.edb.core.typing.PointLike
+        end : :term:`Point2DLike`
             End point of the line segment.
 
         Returns
         -------
-        typing.Optional[PointData] or ``None`` if either point is an arc.
+        .PointData or :obj:`None` if either point is an arc.
         """
         if not self.is_arc:
             return self.__stub.ClosestPoint(messages.point_data_with_line_message(self, start, end))
 
-    def distance(self, start, end=None):
+    def distance(self, start: PointLike, end: PointLike = None) -> float:
         """Compute the shortest distance from the point to a line segment when an end point is given. \
         Otherwise, compute the distance between this point and another point.
 
         Parameters
         ----------
-        start : ansys.edb.core.typing.PointLike
+        start : :term:`Point2DLike`
             Start point of the line segment.
-        end : ansys.edb.core.typing.PointLike, default: None
+        end : :term:`Point2DLike`, default: None
             End point of the line segment.
 
         Returns
@@ -227,62 +236,62 @@ def distance(self, start, end=None):
                 messages.point_data_with_line_message(self, start, end)
             ).value
 
-    def cross(self, other):
+    def cross(self, other: PointLike) -> Value | None:
         """Compute the cross product of the point vector with another point vector.
 
         Parameters
         ----------
-        other : ansys.edb.core.typing.PointLike
+        other : :term:`Point2DLike`
             Other point vector.
 
         Returns
         -------
-        typing.Optional[.Value] or ``None`` if either point is an arc.
+        .Value or :obj:`None` if either point is an arc.
         """
         other = conversions.to_point(other)
         if not self.is_arc and not other.is_arc:
             return self.x * other.y - self.y * other.x
 
-    def move(self, vector):
+    def move(self, vector: PointLike) -> PointData:
         """Move the point by a vector.
 
         Parameters
         ----------
-        vector : ansys.edb.core.typing.PointLike
+        vector : :term:`Point2DLike`
            Vector.
 
         Returns
         -------
-        typing.Optional[PointData] or ``None`` if either point is an arc.
+        .PointData or :obj:`None` if either point is an arc.
         """
         vector = conversions.to_point(vector)
         if not self.is_arc and not vector.is_arc:
             return self + vector
 
     @parser.to_point_data
-    def rotate(self, angle, center):
+    def rotate(self, angle: float, center: PointLike) -> PointData | None:
         """Rotate a point at a given center by a given angle.
 
         Parameters
         ----------
         angle : float
             Angle in radians.
-        center : ansys.edb.core.typing.PointLike
+        center : :term:`Point2DLike`
             Center.
 
         Returns
         -------
-        typing.Optional[PointData] or ``None`` if either point is an arc.
+        .PointData or :obj:`None` if either point is an arc.
         """
         if not self.is_arc:
             return self.__stub.Rotate(messages.point_data_rotate_message(self, center, angle))
 
-    def dot(self, other):
+    def dot(self, other: PointLike) -> float:
         """Perform per-component multiplication (dot product) of this point and another point.
 
         Parameters
         ----------
-        other : ansys.edb.core.typing.PointLike
+        other : :term:`Point2DLike`
             Other point.
 
         Returns
@@ -292,12 +301,12 @@ def dot(self, other):
         """
         return sum(self._map_reduce(other, operator.__mul__), value.Value(0)).value
 
-    def angle(self, other):
+    def angle(self, other: PointLike) -> float:
         """Get the angle between this vector and another vector.
 
         Parameters
         ----------
-        other : ansys.edb.core.typing.PointLike
+        other : :term:`Point2DLike`
             Other vector.
 
         Returns