fake-bpy-module 20240803__py3-none-any.whl → 20240804__py3-none-any.whl

bmesh/ops/__init__.pyi

@@ -41,7 +41,7 @@ def beautify_fill(
     faces: list[bmesh.types.BMFace] = [],
     edges: list[bmesh.types.BMEdge] = [],
     use_restrict_tag: bool = False,
-    method: str = "AREA",
+    method: typing.Literal["AREA", "ANGLE"] = "AREA",
 ) -> dict[str, typing.Any]:
     """Beautify Fill.Rotate edges to create more evenly spaced triangles.
 
@@ -54,7 +54,7 @@ def beautify_fill(
         :param use_restrict_tag: restrict edge rotation to mixed tagged vertices
         :type use_restrict_tag: bool
         :param method: method to define what is beautiful
-        :type method: str
+        :type method: typing.Literal['AREA','ANGLE']
         :return: geom: new flipped faces and edges
 
     type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
@@ -69,23 +69,25 @@ def bevel(
     | list[bmesh.types.BMFace]
     | list[bmesh.types.BMVert] = [],
     offset: float = 0,
-    offset_type: str = "OFFSET",
-    profile_type: str = "SUPERELLIPSE",
+    offset_type: typing.Literal[
+        "OFFSET", "WIDTH", "DEPTH", "PERCENT", "ABSOLUTE"
+    ] = "OFFSET",
+    profile_type: typing.Literal["SUPERELLIPSE", "CUSTOM"] = "SUPERELLIPSE",
     segments: int = 0,
     profile: float = 0,
-    affect: str = "VERTICES",
+    affect: typing.Literal["VERTICES", "EDGES"] = "VERTICES",
     clamp_overlap: bool = False,
     material: int = 0,
     loop_slide: bool = False,
     mark_seam: bool = False,
     mark_sharp: bool = False,
     harden_normals: bool = False,
-    face_strength_mode: str = "NONE",
-    miter_outer: str = "SHARP",
-    miter_inner: str = "SHARP",
+    face_strength_mode: typing.Literal["NONE", "NEW", "AFFECTED", "ALL"] = "NONE",
+    miter_outer: typing.Literal["SHARP", "PATCH", "ARC"] = "SHARP",
+    miter_inner: typing.Literal["SHARP", "PATCH", "ARC"] = "SHARP",
     spread: float = 0,
     custom_profile: bpy.types.bpy_struct = None,
-    vmesh_method: str = "ADJ",
+    vmesh_method: typing.Literal["ADJ", "CUTOFF"] = "ADJ",
 ) -> dict[str, typing.Any]:
     """Bevel.Bevels edges and vertices
 
@@ -96,15 +98,15 @@ def bevel(
         :param offset: amount to offset beveled edge
         :type offset: float
         :param offset_type: how to measure the offset
-        :type offset_type: str
+        :type offset_type: typing.Literal['OFFSET','WIDTH','DEPTH','PERCENT','ABSOLUTE']
         :param profile_type: The profile type to use for bevel.
-        :type profile_type: str
+        :type profile_type: typing.Literal['SUPERELLIPSE','CUSTOM']
         :param segments: number of segments in bevel
         :type segments: int
         :param profile: profile shape, 0->1 (.5=>round)
         :type profile: float
         :param affect: Whether to bevel vertices or edges.
-        :type affect: str
+        :type affect: typing.Literal['VERTICES','EDGES']
         :param clamp_overlap: do not allow beveled edges/vertices to overlap each other
         :type clamp_overlap: bool
         :param material: material for bevel faces, -1 means get from adjacent faces
@@ -118,17 +120,17 @@ def bevel(
         :param harden_normals: harden normals
         :type harden_normals: bool
         :param face_strength_mode: whether to set face strength, and which faces to set if so
-        :type face_strength_mode: str
+        :type face_strength_mode: typing.Literal['NONE','NEW','AFFECTED','ALL']
         :param miter_outer: outer miter kind
-        :type miter_outer: str
+        :type miter_outer: typing.Literal['SHARP','PATCH','ARC']
         :param miter_inner: outer miter kind
-        :type miter_inner: str
+        :type miter_inner: typing.Literal['SHARP','PATCH','ARC']
         :param spread: amount to offset beveled edge
         :type spread: float
         :param custom_profile: CurveProfile, if None ignored
         :type custom_profile: bpy.types.bpy_struct
         :param vmesh_method: The method to use to create meshes at intersections.
-        :type vmesh_method: str
+        :type vmesh_method: typing.Literal['ADJ','CUTOFF']
         :return: faces: output faces
 
     type list of (`bmesh.types.BMFace`)
@@ -690,7 +692,15 @@ def delete(
     geom: list[bmesh.types.BMEdge]
     | list[bmesh.types.BMFace]
     | list[bmesh.types.BMVert] = [],
-    context: str = "VERTS",
+    context: typing.Literal[
+        "VERTS",
+        "EDGES",
+        "FACES_ONLY",
+        "EDGES_FACES",
+        "FACES",
+        "FACES_KEEP_BOUNDARY",
+        "TAGGED_ONLY",
+    ] = "VERTS",
 ):
     """Delete Geometry.Utility operator to delete geometry.
 
@@ -699,7 +709,7 @@ def delete(
     :param geom: input geometry
     :type geom: list[bmesh.types.BMEdge] | list[bmesh.types.BMFace] | list[bmesh.types.BMVert]
     :param context: geometry types to delete
-    :type context: str
+    :type context: typing.Literal['VERTS','EDGES','FACES_ONLY','EDGES_FACES','FACES','FACES_KEEP_BOUNDARY','TAGGED_ONLY']
     """
 
     ...
@@ -1299,7 +1309,7 @@ def mirror(
     matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
     | mathutils.Matrix = mathutils.Matrix.Identity(4),
     merge_dist: float = 0,
-    axis: str = "X",
+    axis: typing.Literal["X", "Y", "Z"] = "X",
     mirror_u: bool = False,
     mirror_v: bool = False,
     mirror_udim: bool = False,
@@ -1318,7 +1328,7 @@ def mirror(
         :param merge_dist: maximum distance for merging. does no merging if 0.
         :type merge_dist: float
         :param axis: the axis to use.
-        :type axis: str
+        :type axis: typing.Literal['X','Y','Z']
         :param mirror_u: mirror UVs across the u axis
         :type mirror_u: bool
         :param mirror_v: mirror UVs across the v axis
@@ -1434,7 +1444,7 @@ def poke(
     bm: bmesh.types.BMesh,
     faces: list[bmesh.types.BMFace] = [],
     offset: float = 0,
-    center_mode: str = "MEAN_WEIGHTED",
+    center_mode: typing.Literal["MEAN_WEIGHTED", "MEAN", "BOUNDS"] = "MEAN_WEIGHTED",
     use_relative_offset: bool = False,
 ) -> dict[str, typing.Any]:
     """Pokes a face.Splits a face into a triangle fan.
@@ -1446,7 +1456,7 @@ def poke(
         :param offset: center vertex offset along normal
         :type offset: float
         :param center_mode: calculation mode for center vertex
-        :type center_mode: str
+        :type center_mode: typing.Literal['MEAN_WEIGHTED','MEAN','BOUNDS']
         :param use_relative_offset: apply offset
         :type use_relative_offset: bool
         :return: verts: output verts
@@ -1876,10 +1886,12 @@ def split_edges(
 def subdivide_edgering(
     bm: bmesh.types.BMesh,
     edges: list[bmesh.types.BMEdge] = [],
-    interp_mode: str = "LINEAR",
+    interp_mode: typing.Literal["LINEAR", "PATH", "SURFACE"] = "LINEAR",
     smooth: float = 0,
     cuts: int = 0,
-    profile_shape: str = "SMOOTH",
+    profile_shape: typing.Literal[
+        "SMOOTH", "SPHERE", "ROOT", "SHARP", "LINEAR", "INVERSE_SQUARE"
+    ] = "SMOOTH",
     profile_shape_factor: float = 0,
 ) -> dict[str, typing.Any]:
     """Subdivide Edge-Ring.Take an edge-ring, and subdivide with interpolation options.
@@ -1889,13 +1901,13 @@ def subdivide_edgering(
         :param edges: input vertices
         :type edges: list[bmesh.types.BMEdge]
         :param interp_mode: interpolation method
-        :type interp_mode: str
+        :type interp_mode: typing.Literal['LINEAR','PATH','SURFACE']
         :param smooth: smoothness factor
         :type smooth: float
         :param cuts: number of cuts
         :type cuts: int
         :param profile_shape: profile shape type
-        :type profile_shape: str
+        :type profile_shape: typing.Literal['SMOOTH','SPHERE','ROOT','SHARP','LINEAR','INVERSE_SQUARE']
         :param profile_shape_factor: how much intermediary new edges are shrunk/expanded
         :type profile_shape_factor: float
         :return: faces: output faces
@@ -1910,14 +1922,18 @@ def subdivide_edges(
     bm: bmesh.types.BMesh,
     edges: list[bmesh.types.BMEdge] = [],
     smooth: float = 0,
-    smooth_falloff: str = "SMOOTH",
+    smooth_falloff: typing.Literal[
+        "SMOOTH", "SPHERE", "ROOT", "SHARP", "LINEAR", "INVERSE_SQUARE"
+    ] = "SMOOTH",
     fractal: float = 0,
     along_normal: float = 0,
     cuts: int = 0,
     seed: int = 0,
     custom_patterns={},
     edge_percents={},
-    quad_corner_type: str = "STRAIGHT_CUT",
+    quad_corner_type: typing.Literal[
+        "STRAIGHT_CUT", "INNER_VERT", "PATH", "FAN"
+    ] = "STRAIGHT_CUT",
     use_grid_fill: bool = False,
     use_single_edge: bool = False,
     use_only_quads: bool = False,
@@ -1934,7 +1950,7 @@ def subdivide_edges(
         :param smooth: smoothness factor
         :type smooth: float
         :param smooth_falloff: smooth falloff type
-        :type smooth_falloff: str
+        :type smooth_falloff: typing.Literal['SMOOTH','SPHERE','ROOT','SHARP','LINEAR','INVERSE_SQUARE']
         :param fractal: fractal randomness factor
         :type fractal: float
         :param along_normal: apply fractal displacement along normal only
@@ -1946,7 +1962,7 @@ def subdivide_edges(
         :param custom_patterns: uses custom pointers
         :param edge_percents: Undocumented.
         :param quad_corner_type: quad corner type
-        :type quad_corner_type: str
+        :type quad_corner_type: typing.Literal['STRAIGHT_CUT','INNER_VERT','PATH','FAN']
         :param use_grid_fill: fill in fully-selected faces with a grid
         :type use_grid_fill: bool
         :param use_single_edge: tessellate the case of one edge selected in a quad or triangle
@@ -1978,7 +1994,7 @@ def symmetrize(
     input: list[bmesh.types.BMEdge]
     | list[bmesh.types.BMFace]
     | list[bmesh.types.BMVert] = [],
-    direction: str = "-X",
+    direction: typing.Literal["-X", "-Y", "-Z", "X", "Y", "Z"] = "-X",
     dist: float = 0,
     use_shapekey: bool = False,
 ) -> dict[str, typing.Any]:
@@ -1992,7 +2008,7 @@ def symmetrize(
         :param input: input geometry
         :type input: list[bmesh.types.BMEdge] | list[bmesh.types.BMFace] | list[bmesh.types.BMVert]
         :param direction: axis to use
-        :type direction: str
+        :type direction: typing.Literal['-X','-Y','-Z','X','Y','Z']
         :param dist: minimum distance
         :type dist: float
         :param use_shapekey: Transform shape keys too.
@@ -2085,8 +2101,10 @@ def triangle_fill(
 def triangulate(
     bm: bmesh.types.BMesh,
     faces: list[bmesh.types.BMFace] = [],
-    quad_method: str = "BEAUTY",
-    ngon_method: str = "BEAUTY",
+    quad_method: typing.Literal[
+        "BEAUTY", "FIXED", "ALTERNATE", "SHORT_EDGE", "LONG_EDGE"
+    ] = "BEAUTY",
+    ngon_method: typing.Literal["BEAUTY", "EAR_CLIP"] = "BEAUTY",
 ) -> dict[str, typing.Any]:
     """Triangulate.
 
@@ -2095,9 +2113,9 @@ def triangulate(
         :param faces: input faces
         :type faces: list[bmesh.types.BMFace]
         :param quad_method: method for splitting the quads into triangles
-        :type quad_method: str
+        :type quad_method: typing.Literal['BEAUTY','FIXED','ALTERNATE','SHORT_EDGE','LONG_EDGE']
         :param ngon_method: method for splitting the polygons into triangles
-        :type ngon_method: str
+        :type ngon_method: typing.Literal['BEAUTY','EAR_CLIP']
         :return: edges:
 
     type list of (`bmesh.types.BMEdge`)

bmesh/types/__init__.pyi

@@ -204,11 +204,11 @@ class BMEdge:
         """
         ...
 
-    def copy_from(self, other: typing.Self):
+    def copy_from(self, other: typing_extensions.Self):
         """Copy values from another element of matching type.
 
         :param other:
-        :type other: typing.Self
+        :type other: typing_extensions.Self
         """
         ...
 
@@ -595,7 +595,7 @@ class BMFace:
         """
         ...
 
-    def copy(self, verts: bool = True, edges: bool = True) -> typing.Self:
+    def copy(self, verts: bool = True, edges: bool = True) -> typing_extensions.Self:
         """Make a copy of this face.
 
         :param verts: When set, the faces verts will be duplicated too.
@@ -603,23 +603,23 @@ class BMFace:
         :param edges: When set, the faces edges will be duplicated too.
         :type edges: bool
         :return: The newly created face.
-        :rtype: typing.Self
+        :rtype: typing_extensions.Self
         """
         ...
 
-    def copy_from(self, other: typing.Self):
+    def copy_from(self, other: typing_extensions.Self):
         """Copy values from another element of matching type.
 
         :param other:
-        :type other: typing.Self
+        :type other: typing_extensions.Self
         """
         ...
 
-    def copy_from_face_interp(self, face: typing.Self, vert: bool = True):
+    def copy_from_face_interp(self, face: typing_extensions.Self, vert: bool = True):
         """Interpolate the customdata from another face onto this one (faces should overlap).
 
         :param face: The face to interpolate data from.
-        :type face: typing.Self
+        :type face: typing_extensions.Self
         :param vert: When True, also copy vertex data.
         :type vert: bool
         """
@@ -1085,11 +1085,11 @@ class BMLayerItem:
     :type: str
     """
 
-    def copy_from(self, other: typing.Self):
+    def copy_from(self, other: typing_extensions.Self):
         """Return a copy of the layer
 
         :param other: Another layer to copy from.
-        :type other: typing.Self
+        :type other: typing_extensions.Self
         """
         ...
 
@@ -1126,28 +1126,28 @@ class BMLoop:
     :type: bool
     """
 
-    link_loop_next: typing.Self
+    link_loop_next: typing_extensions.Self
     """ The next face corner (read-only).
 
-    :type: typing.Self
+    :type: typing_extensions.Self
     """
 
-    link_loop_prev: typing.Self
+    link_loop_prev: typing_extensions.Self
     """ The previous face corner (read-only).
 
-    :type: typing.Self
+    :type: typing_extensions.Self
     """
 
-    link_loop_radial_next: typing.Self
+    link_loop_radial_next: typing_extensions.Self
     """ The next loop around the edge (read-only).
 
-    :type: typing.Self
+    :type: typing_extensions.Self
     """
 
-    link_loop_radial_prev: typing.Self
+    link_loop_radial_prev: typing_extensions.Self
     """ The previous loop around the edge (read-only).
 
-    :type: typing.Self
+    :type: typing_extensions.Self
     """
 
     link_loops: BMElemSeq[BMLoop]
@@ -1195,11 +1195,11 @@ class BMLoop:
         """
         ...
 
-    def copy_from(self, other: typing.Self):
+    def copy_from(self, other: typing_extensions.Self):
         """Copy values from another element of matching type.
 
         :param other:
-        :type other: typing.Self
+        :type other: typing_extensions.Self
         """
         ...
 
@@ -1379,11 +1379,11 @@ class BMVert:
         """
         ...
 
-    def copy_from(self, other: typing.Self):
+    def copy_from(self, other: typing_extensions.Self):
         """Copy values from another element of matching type.
 
         :param other:
-        :type other: typing.Self
+        :type other: typing_extensions.Self
         """
         ...
 
@@ -1617,11 +1617,11 @@ class BMesh:
         """Clear all mesh data."""
         ...
 
-    def copy(self) -> typing.Self:
+    def copy(self) -> typing_extensions.Self:
         """
 
         :return: A copy of this BMesh.
-        :rtype: typing.Self
+        :rtype: typing_extensions.Self
         """
         ...