fake-bge-module 20250103__py3-none-any.whl → 20250201__py3-none-any.whl

mathutils/geometry/__init__.pyi

@@ -53,20 +53,26 @@ def barycentric_transform(
     :rtype: mathutils.Vector
     """
 
-def box_fit_2d(points) -> float:
+def box_fit_2d(
+    points: collections.abc.Sequence[collections.abc.Sequence[float]],
+) -> float:
     """Returns an angle that best fits the points to an axis aligned rectangle
 
     :param points: Sequence of 2D points.
+    :type points: collections.abc.Sequence[collections.abc.Sequence[float]]
     :return: angle
     :rtype: float
     """
 
-def box_pack_2d(boxes: float):
+def box_pack_2d(
+    boxes: list[list[float, float, float, float, ...]],
+) -> tuple[float, float]:
     """Returns a tuple with the width and height of the packed bounding box.
 
     :param boxes: list of boxes, each box is a list where the first 4 items are [X, Y, width, height, ...] other items are ignored. The X & Y values in this list are modified to set the packed positions.
-    :type boxes: float
+    :type boxes: list[list[float, float, float, float, ...]]
     :return: The width and height of the packed bounding box.
+    :rtype: tuple[float, float]
     """
 
 def closest_point_on_tri(
@@ -89,16 +95,34 @@ def closest_point_on_tri(
     :rtype: mathutils.Vector
     """
 
-def convex_hull_2d(points):
+def convex_hull_2d(
+    points: collections.abc.Sequence[collections.abc.Sequence[float]],
+) -> list[int]:
     """Returns a list of indices into the list given
 
     :param points: Sequence of 2D points.
+    :type points: collections.abc.Sequence[collections.abc.Sequence[float]]
     :return: a list of indices
+    :rtype: list[int]
     """
 
 def delaunay_2d_cdt(
-    vert_coords, edges, faces, output_type: int, epsilon: float, need_ids=True
-):
+    vert_coords: collections.abc.Sequence[
+        collections.abc.Sequence[float] | mathutils.Vector
+    ],
+    edges: collections.abc.Sequence[collections.abc.Sequence[int, int]],
+    faces: collections.abc.Sequence[collections.abc.Sequence[int]],
+    output_type: int,
+    epsilon: float,
+    need_ids=True,
+) -> tuple[
+    list[mathutils.Vector],
+    list[tuple[int, int]],
+    list[list[int]],
+    list[list[int]],
+    list[list[int]],
+    list[list[int]],
+]:
     """Computes the Constrained Delaunay Triangulation of a set of vertices,
     with edges and faces that must appear in the triangulation.
     Some triangles may be eaten away, or combined with other triangles,
@@ -113,14 +137,18 @@ def delaunay_2d_cdt(
     of the orig arrays, which may save some time.
 
         :param vert_coords: Vertex coordinates (2d)
+        :type vert_coords: collections.abc.Sequence[collections.abc.Sequence[float] | mathutils.Vector]
         :param edges: Edges, as pairs of indices in vert_coords
+        :type edges: collections.abc.Sequence[collections.abc.Sequence[int, int]]
         :param faces: Faces, each sublist is a face, as indices in vert_coords (CCW oriented)
+        :type faces: collections.abc.Sequence[collections.abc.Sequence[int]]
         :param output_type: What output looks like. 0 => triangles with convex hull. 1 => triangles inside constraints. 2 => the input constraints, intersected. 3 => like 2 but detect holes and omit them from output. 4 => like 2 but with extra edges to make valid BMesh faces. 5 => like 4 but detect holes and omit them from output.
         :type output_type: int
         :param epsilon: For nearness tests; should not be zero
         :type epsilon: float
         :param need_ids: are the orig output arrays needed?
         :return: Output tuple, (vert_coords, edges, faces, orig_verts, orig_edges, orig_faces)
+        :rtype: tuple[list[mathutils.Vector], list[tuple[int, int]], list[list[int]], list[list[int]], list[list[int]], list[list[int]]]
     """
 
 def distance_point_to_plane(
@@ -145,7 +173,7 @@ def interpolate_bezier(
     handle2: collections.abc.Sequence[float] | mathutils.Vector,
     knot2: collections.abc.Sequence[float] | mathutils.Vector,
     resolution: int,
-):
+) -> list[mathutils.Vector]:
     """Interpolate a bezier spline segment.
 
     :param knot1: First bezier spline point.
@@ -159,6 +187,7 @@ def interpolate_bezier(
     :param resolution: Number of points to return.
     :type resolution: int
     :return: The interpolated points.
+    :rtype: list[mathutils.Vector]
     """
 
 def intersect_line_line(
@@ -166,7 +195,7 @@ def intersect_line_line(
     v2: collections.abc.Sequence[float] | mathutils.Vector,
     v3: collections.abc.Sequence[float] | mathutils.Vector,
     v4: collections.abc.Sequence[float] | mathutils.Vector,
-):
+) -> None | tuple[mathutils.Vector, mathutils.Vector]:
     """Returns a tuple with the points on each line respectively closest to the other.
 
     :param v1: First point of the first line
@@ -178,6 +207,7 @@ def intersect_line_line(
     :param v4: Second point of the second line
     :type v4: collections.abc.Sequence[float] | mathutils.Vector
     :return: The intersection on each line or None when the lines are co-linear.
+    :rtype: None | tuple[mathutils.Vector, mathutils.Vector]
     """
 
 def intersect_line_line_2d(
@@ -185,7 +215,7 @@ def intersect_line_line_2d(
     lineA_p2: collections.abc.Sequence[float] | mathutils.Vector,
     lineB_p1: collections.abc.Sequence[float] | mathutils.Vector,
     lineB_p2: collections.abc.Sequence[float] | mathutils.Vector,
-):
+) -> None | mathutils.Vector:
     """Takes 2 segments (defined by 4 vectors) and returns a vector for their point of intersection or None.
 
     :param lineA_p1: First point of the first line
@@ -197,6 +227,7 @@ def intersect_line_line_2d(
     :param lineB_p2: Second point of the second line
     :type lineB_p2: collections.abc.Sequence[float] | mathutils.Vector
     :return: The point of intersection or None when not found
+    :rtype: None | mathutils.Vector
     """
 
 def intersect_line_plane(
@@ -205,7 +236,7 @@ def intersect_line_plane(
     plane_co: collections.abc.Sequence[float] | mathutils.Vector,
     plane_no: collections.abc.Sequence[float] | mathutils.Vector,
     no_flip=False,
-):
+) -> None | mathutils.Vector:
     """Calculate the intersection between a line (as 2 vectors) and a plane.
     Returns a vector for the intersection or None.
 
@@ -218,6 +249,7 @@ def intersect_line_plane(
         :param plane_no: The direction the plane is facing
         :type plane_no: collections.abc.Sequence[float] | mathutils.Vector
         :return: The point of intersection or None when not found
+        :rtype: None | mathutils.Vector
     """
 
 def intersect_line_sphere(
@@ -226,7 +258,7 @@ def intersect_line_sphere(
     sphere_co: collections.abc.Sequence[float] | mathutils.Vector,
     sphere_radius: float,
     clip=True,
-):
+) -> tuple[mathutils.Vector | None, mathutils.Vector | None]:
     """Takes a line (as 2 points) and a sphere (as a point and a radius) and
     returns the intersection
 
@@ -239,6 +271,7 @@ def intersect_line_sphere(
         :param sphere_radius: Radius of the sphere
         :type sphere_radius: float
         :return: The intersection points as a pair of vectors or None when there is no intersection
+        :rtype: tuple[mathutils.Vector | None, mathutils.Vector | None]
     """
 
 def intersect_line_sphere_2d(
@@ -247,7 +280,7 @@ def intersect_line_sphere_2d(
     sphere_co: collections.abc.Sequence[float] | mathutils.Vector,
     sphere_radius: float,
     clip=True,
-):
+) -> tuple[mathutils.Vector | None, mathutils.Vector | None]:
     """Takes a line (as 2 points) and a sphere (as a point and a radius) and
     returns the intersection
 
@@ -260,6 +293,7 @@ def intersect_line_sphere_2d(
         :param sphere_radius: Radius of the sphere
         :type sphere_radius: float
         :return: The intersection points as a pair of vectors or None when there is no intersection
+        :rtype: tuple[mathutils.Vector | None, mathutils.Vector | None]
     """
 
 def intersect_plane_plane(
@@ -267,7 +301,7 @@ def intersect_plane_plane(
     plane_a_no: collections.abc.Sequence[float] | mathutils.Vector,
     plane_b_co: collections.abc.Sequence[float] | mathutils.Vector,
     plane_b_no: collections.abc.Sequence[float] | mathutils.Vector,
-):
+) -> tuple[None, None] | tuple[mathutils.Vector, mathutils.Vector]:
     """Return the intersection between two planes
 
     :param plane_a_co: Point on the first plane
@@ -279,19 +313,21 @@ def intersect_plane_plane(
     :param plane_b_no: Normal of the second plane
     :type plane_b_no: collections.abc.Sequence[float] | mathutils.Vector
     :return: The line of the intersection represented as a point and a vector or None if the intersection can't be calculated
+    :rtype: tuple[None, None] | tuple[mathutils.Vector, mathutils.Vector]
     """
 
 def intersect_point_line(
     pt: collections.abc.Sequence[float] | mathutils.Vector,
     line_p1: collections.abc.Sequence[float] | mathutils.Vector,
     line_p2,
-):
+) -> tuple[mathutils.Vector, float]:
     """Takes a point and a line and returns a tuple with the closest point on the line and its distance from the first point of the line as a percentage of the length of the line.
 
     :param pt: Point
     :type pt: collections.abc.Sequence[float] | mathutils.Vector
     :param line_p1: First point of the lineSecond point of the line
     :type line_p1: collections.abc.Sequence[float] | mathutils.Vector
+    :rtype: tuple[mathutils.Vector, float]
     """
 
 def intersect_point_quad_2d(
@@ -323,7 +359,7 @@ def intersect_point_tri(
     tri_p1: collections.abc.Sequence[float] | mathutils.Vector,
     tri_p2: collections.abc.Sequence[float] | mathutils.Vector,
     tri_p3: collections.abc.Sequence[float] | mathutils.Vector,
-):
+) -> None | mathutils.Vector:
     """Takes 4 vectors: one is the point and the next 3 define the triangle. Projects the point onto the triangle plane and checks if it is within the triangle.
 
     :param pt: Point
@@ -335,6 +371,7 @@ def intersect_point_tri(
     :param tri_p3: Third point of the triangle
     :type tri_p3: collections.abc.Sequence[float] | mathutils.Vector
     :return: Point on the triangles plane or None if its outside the triangle
+    :rtype: None | mathutils.Vector
     """
 
 def intersect_point_tri_2d(
@@ -363,7 +400,7 @@ def intersect_ray_tri(
     ray: collections.abc.Sequence[float] | mathutils.Vector,
     orig: collections.abc.Sequence[float] | mathutils.Vector,
     clip: bool = True,
-):
+) -> None | mathutils.Vector:
     """Returns the intersection between a ray and a triangle, if possible, returns None otherwise.
 
     :param v1: Point1
@@ -379,6 +416,7 @@ def intersect_ray_tri(
     :param clip: When False, don't restrict the intersection to the area of the triangle, use the infinite plane defined by the triangle.
     :type clip: bool
     :return: The point of intersection or None if no intersection is found
+    :rtype: None | mathutils.Vector
     """
 
 def intersect_sphere_sphere_2d(
@@ -386,7 +424,7 @@ def intersect_sphere_sphere_2d(
     radius_a: float,
     p_b: collections.abc.Sequence[float] | mathutils.Vector,
     radius_b: float,
-):
+) -> tuple[None, None] | tuple[mathutils.Vector, mathutils.Vector]:
     """Returns 2 points on between intersecting circles.
 
     :param p_a: Center of the first circle
@@ -398,6 +436,7 @@ def intersect_sphere_sphere_2d(
     :param radius_b: Radius of the second circle
     :type radius_b: float
     :return: 2 points on between intersecting circles or None when there is no intersection.
+    :rtype: tuple[None, None] | tuple[mathutils.Vector, mathutils.Vector]
     """
 
 def intersect_tri_tri_2d(tri_a1, tri_a2, tri_a3, tri_b1, tri_b2, tri_b3) -> bool:
@@ -406,31 +445,38 @@ def intersect_tri_tri_2d(tri_a1, tri_a2, tri_a3, tri_b1, tri_b2, tri_b3) -> bool
     :rtype: bool
     """
 
-def normal(vectors) -> mathutils.Vector:
+def normal(
+    vectors: collections.abc.Sequence[collections.abc.Sequence[float]],
+) -> mathutils.Vector:
     """Returns the normal of a 3D polygon.
 
     :param vectors: 3 or more vectors to calculate normals.
+    :type vectors: collections.abc.Sequence[collections.abc.Sequence[float]]
     :rtype: mathutils.Vector
     """
 
 def points_in_planes(
-    planes, epsilon_coplanar: float = 0.0001, epsilon_isect: float = 1e-06
-):
+    planes: list[collections.abc.Sequence[float] | mathutils.Vector],
+    epsilon_coplanar: float = 0.0001,
+    epsilon_isect: float = 1e-06,
+) -> tuple[list[mathutils.Vector], list[int]]:
     """Returns a list of points inside all planes given and a list of index values for the planes used.
 
     :param planes: List of planes (4D vectors).
+    :type planes: list[collections.abc.Sequence[float] | mathutils.Vector]
     :param epsilon_coplanar: Epsilon value for interpreting plane pairs as co-plannar.
     :type epsilon_coplanar: float
     :param epsilon_isect: Epsilon value for intersection.
     :type epsilon_isect: float
     :return: Two lists, once containing the 3D coordinates inside the planes, another containing the plane indices used.
+    :rtype: tuple[list[mathutils.Vector], list[int]]
     """
 
-def tessellate_polygon(polylines) -> int:
+def tessellate_polygon(polylines) -> list[tuple[int, int, int]]:
     """Takes a list of polylines (each point a pair or triplet of numbers) and returns the point indices for a polyline filled with triangles. Does not handle degenerate geometry (such as zero-length lines due to consecutive identical points).
 
     :param polylines: Polygons where each polygon is a sequence of 2D or 3D points.
-    :rtype: int
+    :rtype: list[tuple[int, int, int]]
     """
 
 def volume_tetrahedron(

mathutils/interpolate/__init__.pyi

@@ -7,9 +7,13 @@ import typing
 import collections.abc
 import typing_extensions
 
-def poly_3d_calc(veclist, pt):
+def poly_3d_calc(
+    veclist: collections.abc.Sequence[collections.abc.Sequence[float]], pt
+) -> list[float]:
     """Calculate barycentric weights for a point on a polygon.
 
     :param veclist: Sequence of 3D positions.
+    :type veclist: collections.abc.Sequence[collections.abc.Sequence[float]]
     :param pt: 2D or 3D position.   :type pt: Sequence[float]   :return: list of per-vector weights.
+    :rtype: list[float]
     """

mathutils/kdtree/__init__.pyi

@@ -8,6 +8,7 @@ Generic 3-dimensional kd-tree to perform spatial searches.
 import typing
 import collections.abc
 import typing_extensions
+import mathutils
 
 class KDTree:
     """KdTree(size) -> new kd-tree initialized to hold size items."""
@@ -15,40 +16,52 @@ class KDTree:
     def balance(self):
         """Balance the tree."""
 
-    def find(self, co, filter: collections.abc.Callable | None = None) -> int:
+    def find(
+        self,
+        co: collections.abc.Sequence[float],
+        filter: collections.abc.Callable[int, bool] | None = None,
+    ) -> tuple[mathutils.Vector, int, float]:
         """Find nearest point to co.
 
         :param co: 3D coordinates.
+        :type co: collections.abc.Sequence[float]
         :param filter: function which takes an index and returns True for indices to include in the search.
-        :type filter: collections.abc.Callable | None
+        :type filter: collections.abc.Callable[int, bool] | None
         :return: Returns (position, index, distance).
-        :rtype: int
+        :rtype: tuple[mathutils.Vector, int, float]
         """
 
-    def find_n(self, co, n: int) -> int:
+    def find_n(
+        self, co: collections.abc.Sequence[float], n: int
+    ) -> list[tuple[mathutils.Vector, int, float]]:
         """Find nearest n points to co.
 
         :param co: 3D coordinates.
+        :type co: collections.abc.Sequence[float]
         :param n: Number of points to find.
         :type n: int
         :return: Returns a list of tuples (position, index, distance).
-        :rtype: int
+        :rtype: list[tuple[mathutils.Vector, int, float]]
         """
 
-    def find_range(self, co, radius: float) -> int:
+    def find_range(
+        self, co: collections.abc.Sequence[float], radius: float
+    ) -> list[tuple[mathutils.Vector, int, float]]:
         """Find all points within radius of co.
 
         :param co: 3D coordinates.
+        :type co: collections.abc.Sequence[float]
         :param radius: Distance to search for points.
         :type radius: float
         :return: Returns a list of tuples (position, index, distance).
-        :rtype: int
+        :rtype: list[tuple[mathutils.Vector, int, float]]
         """
 
-    def insert(self, co, index: int):
+    def insert(self, co: collections.abc.Sequence[float], index: int):
         """Insert a point into the KDTree.
 
         :param co: Point 3d position.
+        :type co: collections.abc.Sequence[float]
         :param index: The index of the point.
         :type index: int
         """

mathutils/noise/__init__.pyi

@@ -295,7 +295,7 @@ def voronoi(
     position: collections.abc.Sequence[float] | mathutils.Vector,
     distance_metric: str = "DISTANCE",
     exponent: float = 2.5,
-):
+) -> list[list[float], list[mathutils.Vector]]:
     """Returns a list of distances to the four closest features and their locations.
 
     :param position: The position to evaluate the selected noise function.
@@ -305,4 +305,5 @@ def voronoi(
     :param exponent: The exponent for Minkowski distance metric.
     :type exponent: float
     :return: A list of distances to the four closest features and their locations.
+    :rtype: list[list[float], list[mathutils.Vector]]
     """

rna_info/__init__.pyi

@@ -66,7 +66,7 @@ class InfoPropertyRNA:
         class_fmt="{:s}",
         mathutils_fmt="{:s}",
         collection_id="Collection",
-        enum_descr_override=None,
+        enum_descr_override: None | str | None = None,
     ):
         """
 
@@ -77,6 +77,7 @@ class InfoPropertyRNA:
                 :param collection_id:
                 :param enum_descr_override: Optionally override items for enum.
         Otherwise expand the literal items.
+                :type enum_descr_override: None | str | None
         """
 
 class InfoStructRNA: