fake-bpy-module 20231205__py3-none-any.whl → 20231207__py3-none-any.whl

bmesh/types/__init__.pyi

@@ -0,0 +1,1399 @@
+import sys
+import typing
+import bpy.types
+import mathutils
+
+GenericType = typing.TypeVar("GenericType")
+
+
+class BMDeformVert:
+    def clear(self):
+        ''' Clears all weights.
+
+        '''
+        ...
+
+    def get(self, key: int, default: typing.Any = None):
+        ''' Returns the deform weight matching the key or default when not found (matches Python's dictionary function of the same name).
+
+        :param key: The key associated with deform weight.
+        :type key: int
+        :param default: Optional argument for the value to return if *key* is not found.
+        :type default: typing.Any
+        '''
+        ...
+
+    def items(self) -> typing.List:
+        ''' Return (group, weight) pairs for this vertex (matching Python's dict.items() functionality).
+
+        :rtype: typing.List
+        :return: (key, value) pairs for each deform weight of this vertex.
+        '''
+        ...
+
+    def keys(self) -> typing.List[int]:
+        ''' Return the group indices used by this vertex (matching Python's dict.keys() functionality).
+
+        :rtype: typing.List[int]
+        :return: the deform group this vertex uses
+        '''
+        ...
+
+    def values(self) -> typing.List[float]:
+        ''' Return the weights of the deform vertex (matching Python's dict.values() functionality).
+
+        :rtype: typing.List[float]
+        :return: The weights that influence this vertex
+        '''
+        ...
+
+
+class BMEdge:
+    ''' The BMesh edge connecting 2 verts
+    '''
+
+    hide: bool
+    ''' Hidden state of this element.
+
+    :type: bool
+    '''
+
+    index: int
+    ''' Index of this element.
+
+    :type: int
+    '''
+
+    is_boundary: bool
+    ''' True when this edge is at the boundary of a face (read-only).
+
+    :type: bool
+    '''
+
+    is_contiguous: bool
+    ''' True when this edge is manifold, between two faces with the same winding (read-only).
+
+    :type: bool
+    '''
+
+    is_convex: bool
+    ''' True when this edge joins two convex faces, depends on a valid face normal (read-only).
+
+    :type: bool
+    '''
+
+    is_manifold: bool
+    ''' True when this edge is manifold (read-only).
+
+    :type: bool
+    '''
+
+    is_valid: bool
+    ''' True when this element is valid (hasn't been removed).
+
+    :type: bool
+    '''
+
+    is_wire: bool
+    ''' True when this edge is not connected to any faces (read-only).
+
+    :type: bool
+    '''
+
+    link_faces: typing.Union[typing.List['BMFace'], 'BMElemSeq']
+    ''' Faces connected to this edge, (read-only).
+
+    :type: typing.Union[typing.List['BMFace'], 'BMElemSeq']
+    '''
+
+    link_loops: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    ''' Loops connected to this edge, (read-only).
+
+    :type: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    '''
+
+    seam: bool
+    ''' Seam for UV unwrapping.
+
+    :type: bool
+    '''
+
+    select: bool
+    ''' Selected state of this element.
+
+    :type: bool
+    '''
+
+    smooth: bool
+    ''' Smooth state of this element.
+
+    :type: bool
+    '''
+
+    tag: bool
+    ''' Generic attribute scripts can use for own logic
+
+    :type: bool
+    '''
+
+    verts: typing.Union[typing.List['BMVert'], 'BMElemSeq']
+    ''' Verts this edge uses (always 2), (read-only).
+
+    :type: typing.Union[typing.List['BMVert'], 'BMElemSeq']
+    '''
+
+    def calc_face_angle(self, fallback: typing.Any = None) -> float:
+        ''' 
+
+        :param fallback: return this when the edge doesn't have 2 faces (instead of raising a :exc:`ValueError`).
+        :type fallback: typing.Any
+        :rtype: float
+        :return: The angle between 2 connected faces in radians.
+        '''
+        ...
+
+    def calc_face_angle_signed(self, fallback: typing.Any = None) -> float:
+        ''' 
+
+        :param fallback: return this when the edge doesn't have 2 faces (instead of raising a :exc:`ValueError`).
+        :type fallback: typing.Any
+        :rtype: float
+        :return: The angle between 2 connected faces in radians (negative for concave join).
+        '''
+        ...
+
+    def calc_length(self) -> float:
+        ''' 
+
+        :rtype: float
+        :return: The length between both verts.
+        '''
+        ...
+
+    def calc_tangent(self, loop: 'BMLoop') -> 'mathutils.Vector':
+        ''' Return the tangent at this edge relative to a face (pointing inward into the face). This uses the face normal for calculation.
+
+        :param loop: The loop used for tangent calculation.
+        :type loop: 'BMLoop'
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def copy_from(self, other):
+        ''' Copy values from another element of matching type.
+
+        '''
+        ...
+
+    def hide_set(self, hide: bool):
+        ''' Set the hide state. This is different from the *hide* attribute because it updates the selection and hide state of associated geometry.
+
+        :param hide: Hidden or visible.
+        :type hide: bool
+        '''
+        ...
+
+    def normal_update(self):
+        ''' Update normals of all connected faces and the edge verts.
+
+        '''
+        ...
+
+    def other_vert(self, vert: 'BMVert') -> 'BMVert':
+        ''' Return the other vertex on this edge or None if the vertex is not used by this edge.
+
+        :param vert: a vert in this edge.
+        :type vert: 'BMVert'
+        :rtype: 'BMVert'
+        :return: The edges other vert.
+        '''
+        ...
+
+    def select_set(self, select: bool):
+        ''' Set the selection. This is different from the *select* attribute because it updates the selection state of associated geometry.
+
+        :param select: Select or de-select.
+        :type select: bool
+        '''
+        ...
+
+
+class BMEdgeSeq:
+    layers: 'BMLayerAccessEdge'
+    ''' custom-data layers (read-only).
+
+    :type: 'BMLayerAccessEdge'
+    '''
+
+    def ensure_lookup_table(self):
+        ''' Ensure internal data needed for int subscription is initialized with verts/edges/faces, eg ``bm.verts[index]``. This needs to be called again after adding/removing data in this sequence.
+
+        '''
+        ...
+
+    def get(self, verts: 'BMVert', fallback: typing.Any = None) -> 'BMEdge':
+        ''' Return an edge which uses the **verts** passed.
+
+        :param verts: Sequence of verts.
+        :type verts: 'BMVert'
+        :param fallback:  Return this value if nothing is found.
+        :type fallback: typing.Any
+        :rtype: 'BMEdge'
+        :return: The edge found or None
+        '''
+        ...
+
+    def index_update(self):
+        ''' Initialize the index values of this sequence. This is the equivalent of looping over all elements and assigning the index values.
+
+        '''
+        ...
+
+    def new(self, verts: 'BMVert', example: 'BMEdge' = None) -> 'BMEdge':
+        ''' Create a new edge from a given pair of verts.
+
+        :param verts: Vertex pair.
+        :type verts: 'BMVert'
+        :param example: Existing edge to initialize settings (optional argument).
+        :type example: 'BMEdge'
+        :rtype: 'BMEdge'
+        :return: The newly created edge.
+        '''
+        ...
+
+    def remove(self, edge):
+        ''' Remove an edge.
+
+        '''
+        ...
+
+    def sort(self, key: typing.Any = None, reverse: typing.Any = False):
+        ''' Sort the elements of this sequence, using an optional custom sort key. Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.
+
+        :param key: The key that sets the ordering of the elements.
+        :type key: typing.Any
+        :param reverse: Reverse the order of the elements
+        :type reverse: typing.Any
+        '''
+        ...
+
+    def __iter__(self):
+        ''' 
+
+        '''
+        ...
+
+    def __getitem__(self, key: int) -> 'BMEdge':
+        ''' 
+
+        :param key: 
+        :type key: int
+        :rtype: 'BMEdge'
+        '''
+        ...
+
+
+class BMEditSelIter:
+    ...
+
+
+class BMEditSelSeq:
+    active: typing.Union['BMVert', 'BMEdge', 'BMFace']
+    ''' The last selected element or None (read-only).
+
+    :type: typing.Union['BMVert', 'BMEdge', 'BMFace']
+    '''
+
+    def add(self, element):
+        ''' Add an element to the selection history (no action taken if its already added).
+
+        '''
+        ...
+
+    def clear(self):
+        ''' Empties the selection history.
+
+        '''
+        ...
+
+    def discard(self, element):
+        ''' Discard an element from the selection history. Like remove but doesn't raise an error when the elements not in the selection list.
+
+        '''
+        ...
+
+    def remove(self, element):
+        ''' Remove an element from the selection history.
+
+        '''
+        ...
+
+    def validate(self):
+        ''' Ensures all elements in the selection history are selected.
+
+        '''
+        ...
+
+
+class BMElemSeq:
+    ''' General sequence type used for accessing any sequence of `BMVert`, `BMEdge`, `BMFace`, `BMLoop`. When accessed via `BMesh.verts`, `BMesh.edges`, `BMesh.faces` there are also functions to create/remove items.
+    '''
+
+    def index_update(self):
+        ''' Initialize the index values of this sequence. This is the equivalent of looping over all elements and assigning the index values.
+
+        '''
+        ...
+
+    def __iter__(self):
+        ''' 
+
+        '''
+        ...
+
+
+class BMFace:
+    ''' The BMesh face with 3 or more sides
+    '''
+
+    edges: typing.Union[typing.List['BMEdge'], 'BMElemSeq']
+    ''' Edges of this face, (read-only).
+
+    :type: typing.Union[typing.List['BMEdge'], 'BMElemSeq']
+    '''
+
+    hide: bool
+    ''' Hidden state of this element.
+
+    :type: bool
+    '''
+
+    index: int
+    ''' Index of this element.
+
+    :type: int
+    '''
+
+    is_valid: bool
+    ''' True when this element is valid (hasn't been removed).
+
+    :type: bool
+    '''
+
+    loops: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    ''' Loops of this face, (read-only).
+
+    :type: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    '''
+
+    material_index: int
+    ''' The face's material index.
+
+    :type: int
+    '''
+
+    normal: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    ''' The normal for this face as a 3D, wrapped vector.
+
+    :type: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    '''
+
+    select: bool
+    ''' Selected state of this element.
+
+    :type: bool
+    '''
+
+    smooth: bool
+    ''' Smooth state of this element.
+
+    :type: bool
+    '''
+
+    tag: bool
+    ''' Generic attribute scripts can use for own logic
+
+    :type: bool
+    '''
+
+    verts: typing.Union[typing.List['BMVert'], 'BMElemSeq']
+    ''' Verts of this face, (read-only).
+
+    :type: typing.Union[typing.List['BMVert'], 'BMElemSeq']
+    '''
+
+    def calc_area(self) -> float:
+        ''' Return the area of the face.
+
+        :rtype: float
+        :return: Return the area of the face.
+        '''
+        ...
+
+    def calc_center_bounds(self) -> 'mathutils.Vector':
+        ''' Return bounds center of the face.
+
+        :rtype: 'mathutils.Vector'
+        :return: a 3D vector.
+        '''
+        ...
+
+    def calc_center_median(self) -> 'mathutils.Vector':
+        ''' Return median center of the face.
+
+        :rtype: 'mathutils.Vector'
+        :return: a 3D vector.
+        '''
+        ...
+
+    def calc_center_median_weighted(self) -> 'mathutils.Vector':
+        ''' Return median center of the face weighted by edge lengths.
+
+        :rtype: 'mathutils.Vector'
+        :return: a 3D vector.
+        '''
+        ...
+
+    def calc_perimeter(self) -> float:
+        ''' Return the perimeter of the face.
+
+        :rtype: float
+        :return: Return the perimeter of the face.
+        '''
+        ...
+
+    def calc_tangent_edge(self) -> 'mathutils.Vector':
+        ''' Return face tangent based on longest edge.
+
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def calc_tangent_edge_diagonal(self) -> 'mathutils.Vector':
+        ''' Return face tangent based on the edge farthest from any vertex.
+
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def calc_tangent_edge_pair(self) -> 'mathutils.Vector':
+        ''' Return face tangent based on the two longest disconnected edges. - Tris: Use the edge pair with the most similar lengths. - Quads: Use the longest edge pair. - NGons: Use the two longest disconnected edges.
+
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def calc_tangent_vert_diagonal(self) -> 'mathutils.Vector':
+        ''' Return face tangent based on the two most distant vertices.
+
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def copy(self, verts: bool = True, edges: bool = True) -> 'BMFace':
+        ''' Make a copy of this face.
+
+        :param verts: When set, the faces verts will be duplicated too.
+        :type verts: bool
+        :param edges: When set, the faces edges will be duplicated too.
+        :type edges: bool
+        :rtype: 'BMFace'
+        :return: The newly created face.
+        '''
+        ...
+
+    def copy_from(self, other):
+        ''' Copy values from another element of matching type.
+
+        '''
+        ...
+
+    def copy_from_face_interp(self, face: 'BMFace', 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: 'BMFace'
+        :param vert: When True, also copy vertex data.
+        :type vert: bool
+        '''
+        ...
+
+    def hide_set(self, hide: bool):
+        ''' Set the hide state. This is different from the *hide* attribute because it updates the selection and hide state of associated geometry.
+
+        :param hide: Hidden or visible.
+        :type hide: bool
+        '''
+        ...
+
+    def normal_flip(self):
+        ''' Reverses winding of a face, which flips its normal.
+
+        '''
+        ...
+
+    def normal_update(self):
+        ''' Update face normal based on the positions of the face verts. This does not update the normals of face verts.
+
+        '''
+        ...
+
+    def select_set(self, select: bool):
+        ''' Set the selection. This is different from the *select* attribute because it updates the selection state of associated geometry.
+
+        :param select: Select or de-select.
+        :type select: bool
+        '''
+        ...
+
+
+class BMFaceSeq:
+    active: 'BMFace'
+    ''' active face.
+
+    :type: 'BMFace'
+    '''
+
+    layers: 'BMLayerAccessFace'
+    ''' custom-data layers (read-only).
+
+    :type: 'BMLayerAccessFace'
+    '''
+
+    def ensure_lookup_table(self):
+        ''' Ensure internal data needed for int subscription is initialized with verts/edges/faces, eg ``bm.verts[index]``. This needs to be called again after adding/removing data in this sequence.
+
+        '''
+        ...
+
+    def get(self, verts: 'BMVert', fallback: typing.Any = None) -> 'BMFace':
+        ''' Return a face which uses the **verts** passed.
+
+        :param verts: Sequence of verts.
+        :type verts: 'BMVert'
+        :param fallback:  Return this value if nothing is found.
+        :type fallback: typing.Any
+        :rtype: 'BMFace'
+        :return: The face found or None
+        '''
+        ...
+
+    def index_update(self):
+        ''' Initialize the index values of this sequence. This is the equivalent of looping over all elements and assigning the index values.
+
+        '''
+        ...
+
+    def new(self, verts: typing.Iterable['BMVert'],
+            example: 'BMFace' = None) -> 'BMFace':
+        ''' Create a new face from a given set of verts.
+
+        :param verts: Sequence of 3 or more verts.
+        :type verts: typing.Iterable['BMVert']
+        :param example: Existing face to initialize settings (optional argument).
+        :type example: 'BMFace'
+        :rtype: 'BMFace'
+        :return: The newly created face.
+        '''
+        ...
+
+    def remove(self, face):
+        ''' Remove a face.
+
+        '''
+        ...
+
+    def sort(self, key: typing.Any = None, reverse: typing.Any = False):
+        ''' Sort the elements of this sequence, using an optional custom sort key. Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.
+
+        :param key: The key that sets the ordering of the elements.
+        :type key: typing.Any
+        :param reverse: Reverse the order of the elements
+        :type reverse: typing.Any
+        '''
+        ...
+
+    def __iter__(self):
+        ''' 
+
+        '''
+        ...
+
+    def __getitem__(self, key: int) -> 'BMFace':
+        ''' 
+
+        :param key: 
+        :type key: int
+        :rtype: 'BMFace'
+        '''
+        ...
+
+
+class BMIter:
+    ''' Internal BMesh type for looping over verts/faces/edges, used for iterating over `BMElemSeq` types.
+    '''
+
+    ...
+
+
+class BMLayerAccessEdge:
+    ''' Exposes custom-data layer attributes.
+    '''
+
+    color: typing.Any
+    ''' Generic RGBA color with 8-bit precision custom-data layer. type: `BMLayerCollection`'''
+
+    float: typing.Any
+    ''' Generic float custom-data layer. type: `BMLayerCollection`'''
+
+    float_color: typing.Any
+    ''' Generic RGBA color with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    float_vector: typing.Any
+    ''' Generic 3D vector with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    freestyle: typing.Any
+    ''' Accessor for Freestyle edge layer. type: `BMLayerCollection`'''
+
+    int: typing.Any
+    ''' Generic int custom-data layer. type: `BMLayerCollection`'''
+
+    string: typing.Any
+    ''' Generic string custom-data layer (exposed as bytes, 255 max length). type: `BMLayerCollection`'''
+
+
+class BMLayerAccessFace:
+    ''' Exposes custom-data layer attributes.
+    '''
+
+    color: typing.Any
+    ''' Generic RGBA color with 8-bit precision custom-data layer. type: `BMLayerCollection`'''
+
+    float: typing.Any
+    ''' Generic float custom-data layer. type: `BMLayerCollection`'''
+
+    float_color: typing.Any
+    ''' Generic RGBA color with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    float_vector: typing.Any
+    ''' Generic 3D vector with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    freestyle: typing.Any
+    ''' Accessor for Freestyle face layer. type: `BMLayerCollection`'''
+
+    int: typing.Any
+    ''' Generic int custom-data layer. type: `BMLayerCollection`'''
+
+    string: typing.Any
+    ''' Generic string custom-data layer (exposed as bytes, 255 max length). type: `BMLayerCollection`'''
+
+
+class BMLayerAccessLoop:
+    ''' Exposes custom-data layer attributes.
+    '''
+
+    color: typing.Any
+    ''' Generic RGBA color with 8-bit precision custom-data layer. type: `BMLayerCollection`'''
+
+    float: typing.Any
+    ''' Generic float custom-data layer. type: `BMLayerCollection`'''
+
+    float_color: typing.Any
+    ''' Generic RGBA color with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    float_vector: typing.Any
+    ''' Generic 3D vector with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    int: typing.Any
+    ''' Generic int custom-data layer. type: `BMLayerCollection`'''
+
+    string: typing.Any
+    ''' Generic string custom-data layer (exposed as bytes, 255 max length). type: `BMLayerCollection`'''
+
+    uv: typing.Any
+    ''' Accessor for `BMLoopUV` UV (as a 2D Vector). type: `BMLayerCollection`'''
+
+
+class BMLayerAccessVert:
+    ''' Exposes custom-data layer attributes.
+    '''
+
+    color: typing.Any
+    ''' Generic RGBA color with 8-bit precision custom-data layer. type: `BMLayerCollection`'''
+
+    deform: typing.Any
+    ''' Vertex deform weight `BMDeformVert` (TODO). type: `BMLayerCollection`'''
+
+    float: typing.Any
+    ''' Generic float custom-data layer. type: `BMLayerCollection`'''
+
+    float_color: typing.Any
+    ''' Generic RGBA color with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    float_vector: typing.Any
+    ''' Generic 3D vector with float precision custom-data layer. type: `BMLayerCollection`'''
+
+    int: typing.Any
+    ''' Generic int custom-data layer. type: `BMLayerCollection`'''
+
+    shape: 'BMLayerCollection'
+    ''' Vertex shapekey absolute location (as a 3D Vector).
+
+    :type: 'BMLayerCollection'
+    '''
+
+    skin: typing.Any
+    ''' Accessor for skin layer. type: `BMLayerCollection`'''
+
+    string: typing.Any
+    ''' Generic string custom-data layer (exposed as bytes, 255 max length). type: `BMLayerCollection`'''
+
+
+class BMLayerCollection:
+    ''' Gives access to a collection of custom-data layers of the same type and behaves like Python dictionaries, except for the ability to do list like index access.
+    '''
+
+    active: 'BMLayerItem'
+    ''' The active layer of this type (read-only).
+
+    :type: 'BMLayerItem'
+    '''
+
+    is_singleton: bool
+    ''' True if there can exists only one layer of this type (read-only).
+
+    :type: bool
+    '''
+
+    def get(self, key: str, default: typing.Any = None):
+        ''' Returns the value of the layer matching the key or default when not found (matches Python's dictionary function of the same name).
+
+        :param key: The key associated with the layer.
+        :type key: str
+        :param default: Optional argument for the value to return if *key* is not found.
+        :type default: typing.Any
+        '''
+        ...
+
+    def items(self) -> typing.List:
+        ''' Return the identifiers of collection members (matching Python's dict.items() functionality).
+
+        :rtype: typing.List
+        :return: (key, value) pairs for each member of this collection.
+        '''
+        ...
+
+    def keys(self) -> typing.List[str]:
+        ''' Return the identifiers of collection members (matching Python's dict.keys() functionality).
+
+        :rtype: typing.List[str]
+        :return: the identifiers for each member of this collection.
+        '''
+        ...
+
+    def new(self, name: str) -> 'BMLayerItem':
+        ''' Create a new layer
+
+        :param name: Optional name argument (will be made unique).
+        :type name: str
+        :rtype: 'BMLayerItem'
+        :return: The newly created layer.
+        '''
+        ...
+
+    def remove(self, layer: 'BMLayerItem'):
+        ''' Remove a layer
+
+        :param layer: The layer to remove.
+        :type layer: 'BMLayerItem'
+        '''
+        ...
+
+    def values(self) -> typing.List:
+        ''' Return the values of collection (matching Python's dict.values() functionality).
+
+        :rtype: typing.List
+        :return: the members of this collection.
+        '''
+        ...
+
+    def verify(self) -> 'BMLayerItem':
+        ''' Create a new layer or return an existing active layer
+
+        :rtype: 'BMLayerItem'
+        :return: The newly verified layer.
+        '''
+        ...
+
+
+class BMLayerItem:
+    ''' Exposes a single custom data layer, their main purpose is for use as item accessors to custom-data when used with vert/edge/face/loop data.
+    '''
+
+    name: str
+    ''' The layers unique name (read-only).
+
+    :type: str
+    '''
+
+    def copy_from(self, other: typing.Any):
+        ''' Return a copy of the layer
+
+        :param other:  Another layer to copy from.
+        :type other: typing.Any
+        :param other:  `BMLayerItem`
+        :type other: typing.Any
+        '''
+        ...
+
+
+class BMLoop:
+    ''' This is normally accessed from `BMFace.loops` where each face loop represents a corner of the face.
+    '''
+
+    edge: 'BMEdge'
+    ''' The loop's edge (between this loop and the next), (read-only).
+
+    :type: 'BMEdge'
+    '''
+
+    face: 'BMFace'
+    ''' The face this loop makes (read-only).
+
+    :type: 'BMFace'
+    '''
+
+    index: int
+    ''' Index of this element.
+
+    :type: int
+    '''
+
+    is_convex: bool
+    ''' True when this loop is at the convex corner of a face, depends on a valid face normal (read-only).
+
+    :type: bool
+    '''
+
+    is_valid: bool
+    ''' True when this element is valid (hasn't been removed).
+
+    :type: bool
+    '''
+
+    link_loop_next: 'BMLoop'
+    ''' The next face corner (read-only).
+
+    :type: 'BMLoop'
+    '''
+
+    link_loop_prev: 'BMLoop'
+    ''' The previous face corner (read-only).
+
+    :type: 'BMLoop'
+    '''
+
+    link_loop_radial_next: 'BMLoop'
+    ''' The next loop around the edge (read-only).
+
+    :type: 'BMLoop'
+    '''
+
+    link_loop_radial_prev: 'BMLoop'
+    ''' The previous loop around the edge (read-only).
+
+    :type: 'BMLoop'
+    '''
+
+    link_loops: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    ''' Loops connected to this loop, (read-only).
+
+    :type: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    '''
+
+    tag: bool
+    ''' Generic attribute scripts can use for own logic
+
+    :type: bool
+    '''
+
+    vert: 'BMVert'
+    ''' The loop's vertex (read-only).
+
+    :type: 'BMVert'
+    '''
+
+    def calc_angle(self) -> float:
+        ''' Return the angle at this loops corner of the face. This is calculated so sharper corners give lower angles.
+
+        :rtype: float
+        :return: The angle in radians.
+        '''
+        ...
+
+    def calc_normal(self) -> 'mathutils.Vector':
+        ''' Return normal at this loops corner of the face. Falls back to the face normal for straight lines.
+
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def calc_tangent(self) -> 'mathutils.Vector':
+        ''' Return the tangent at this loops corner of the face (pointing inward into the face). Falls back to the face normal for straight lines.
+
+        :rtype: 'mathutils.Vector'
+        :return: a normalized vector.
+        '''
+        ...
+
+    def copy_from(self, other):
+        ''' Copy values from another element of matching type.
+
+        '''
+        ...
+
+    def copy_from_face_interp(self,
+                              face: 'BMFace',
+                              vert: bool = True,
+                              multires: bool = True):
+        ''' Interpolate the customdata from a face onto this loop (the loops vert should overlap the face).
+
+        :param face: The face to interpolate data from.
+        :type face: 'BMFace'
+        :param vert: When enabled, interpolate the loops vertex data (optional).
+        :type vert: bool
+        :param multires: When enabled, interpolate the loops multires data (optional).
+        :type multires: bool
+        '''
+        ...
+
+
+class BMLoopSeq:
+    layers: 'BMLayerAccessLoop'
+    ''' custom-data layers (read-only).
+
+    :type: 'BMLayerAccessLoop'
+    '''
+
+    def __iter__(self):
+        ''' 
+
+        '''
+        ...
+
+    def __getitem__(self, key: int) -> 'BMLoop':
+        ''' 
+
+        :param key: 
+        :type key: int
+        :rtype: 'BMLoop'
+        '''
+        ...
+
+
+class BMLoopUV:
+    pin_uv: bool
+    ''' UV pin state.
+
+    :type: bool
+    '''
+
+    select: bool
+    ''' UV select state.
+
+    :type: bool
+    '''
+
+    select_edge: bool
+    ''' UV edge select state.
+
+    :type: bool
+    '''
+
+    uv: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    ''' Loops UV (as a 2D Vector).
+
+    :type: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    '''
+
+
+class BMVert:
+    ''' The BMesh vertex type
+    '''
+
+    co: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    ''' The coordinates for this vertex as a 3D, wrapped vector.
+
+    :type: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    '''
+
+    hide: bool
+    ''' Hidden state of this element.
+
+    :type: bool
+    '''
+
+    index: int
+    ''' Index of this element.
+
+    :type: int
+    '''
+
+    is_boundary: bool
+    ''' True when this vertex is connected to boundary edges (read-only).
+
+    :type: bool
+    '''
+
+    is_manifold: bool
+    ''' True when this vertex is manifold (read-only).
+
+    :type: bool
+    '''
+
+    is_valid: bool
+    ''' True when this element is valid (hasn't been removed).
+
+    :type: bool
+    '''
+
+    is_wire: bool
+    ''' True when this vertex is not connected to any faces (read-only).
+
+    :type: bool
+    '''
+
+    link_edges: typing.Union[typing.List['BMEdge'], 'BMElemSeq']
+    ''' Edges connected to this vertex (read-only).
+
+    :type: typing.Union[typing.List['BMEdge'], 'BMElemSeq']
+    '''
+
+    link_faces: typing.Union[typing.List['BMFace'], 'BMElemSeq']
+    ''' Faces connected to this vertex (read-only).
+
+    :type: typing.Union[typing.List['BMFace'], 'BMElemSeq']
+    '''
+
+    link_loops: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    ''' Loops that use this vertex (read-only).
+
+    :type: typing.Union[typing.List['BMLoop'], 'BMElemSeq']
+    '''
+
+    normal: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    ''' The normal for this vertex as a 3D, wrapped vector.
+
+    :type: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+    '''
+
+    select: bool
+    ''' Selected state of this element.
+
+    :type: bool
+    '''
+
+    tag: bool
+    ''' Generic attribute scripts can use for own logic
+
+    :type: bool
+    '''
+
+    def calc_edge_angle(self, fallback: typing.Any = None) -> float:
+        ''' Return the angle between this vert's two connected edges.
+
+        :param fallback: return this when the vert doesn't have 2 edges (instead of raising a :exc:`ValueError`).
+        :type fallback: typing.Any
+        :rtype: float
+        :return: Angle between edges in radians.
+        '''
+        ...
+
+    def calc_shell_factor(self) -> float:
+        ''' Return a multiplier calculated based on the sharpness of the vertex. Where a flat surface gives 1.0, and higher values sharper edges. This is used to maintain shell thickness when offsetting verts along their normals.
+
+        :rtype: float
+        :return: offset multiplier
+        '''
+        ...
+
+    def copy_from(self, other):
+        ''' Copy values from another element of matching type.
+
+        '''
+        ...
+
+    def copy_from_face_interp(self, face: 'BMFace'):
+        ''' Interpolate the customdata from a face onto this loop (the loops vert should overlap the face).
+
+        :param face: The face to interpolate data from.
+        :type face: 'BMFace'
+        '''
+        ...
+
+    def copy_from_vert_interp(self, vert_pair: 'BMVert', fac):
+        ''' Interpolate the customdata from a vert between 2 other verts.
+
+        :param vert_pair: The vert to interpolate data from.
+        :type vert_pair: 'BMVert'
+        '''
+        ...
+
+    def hide_set(self, hide: bool):
+        ''' Set the hide state. This is different from the *hide* attribute because it updates the selection and hide state of associated geometry.
+
+        :param hide: Hidden or visible.
+        :type hide: bool
+        '''
+        ...
+
+    def normal_update(self):
+        ''' Update vertex normal. This does not update the normals of adjoining faces.
+
+        '''
+        ...
+
+    def select_set(self, select: bool):
+        ''' Set the selection. This is different from the *select* attribute because it updates the selection state of associated geometry.
+
+        :param select: Select or de-select.
+        :type select: bool
+        '''
+        ...
+
+
+class BMVertSeq:
+    layers: 'BMLayerAccessVert'
+    ''' custom-data layers (read-only).
+
+    :type: 'BMLayerAccessVert'
+    '''
+
+    def ensure_lookup_table(self):
+        ''' Ensure internal data needed for int subscription is initialized with verts/edges/faces, eg ``bm.verts[index]``. This needs to be called again after adding/removing data in this sequence.
+
+        '''
+        ...
+
+    def index_update(self):
+        ''' Initialize the index values of this sequence. This is the equivalent of looping over all elements and assigning the index values.
+
+        '''
+        ...
+
+    def new(self,
+            co: typing.Union[typing.Sequence[float], 'mathutils.Vector'] = (
+                0.0, 0.0, 0.0),
+            example: 'BMVert' = None) -> 'BMVert':
+        ''' Create a new vertex.
+
+        :param co: The initial location of the vertex (optional argument).
+        :type co: typing.Union[typing.Sequence[float], 'mathutils.Vector']
+        :param example: Existing vert to initialize settings.
+        :type example: 'BMVert'
+        :rtype: 'BMVert'
+        :return: The newly created vertex.
+        '''
+        ...
+
+    def remove(self, vert):
+        ''' Remove a vert.
+
+        '''
+        ...
+
+    def sort(self, key: typing.Any = None, reverse: typing.Any = False):
+        ''' Sort the elements of this sequence, using an optional custom sort key. Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.
+
+        :param key: The key that sets the ordering of the elements.
+        :type key: typing.Any
+        :param reverse: Reverse the order of the elements
+        :type reverse: typing.Any
+        '''
+        ...
+
+    def __iter__(self):
+        ''' 
+
+        '''
+        ...
+
+    def __getitem__(self, key: int) -> 'BMVert':
+        ''' 
+
+        :param key: 
+        :type key: int
+        :rtype: 'BMVert'
+        '''
+        ...
+
+
+class BMesh:
+    ''' The BMesh data structure
+    '''
+
+    edges: 'BMEdgeSeq'
+    ''' This meshes edge sequence (read-only).
+
+    :type: 'BMEdgeSeq'
+    '''
+
+    faces: 'BMFaceSeq'
+    ''' This meshes face sequence (read-only).
+
+    :type: 'BMFaceSeq'
+    '''
+
+    is_valid: bool
+    ''' True when this element is valid (hasn't been removed).
+
+    :type: bool
+    '''
+
+    is_wrapped: bool
+    ''' True when this mesh is owned by blender (typically the editmode BMesh).
+
+    :type: bool
+    '''
+
+    loops: 'BMLoopSeq'
+    ''' This meshes loops (read-only).
+
+    :type: 'BMLoopSeq'
+    '''
+
+    select_history: 'BMEditSelSeq'
+    ''' Sequence of selected items (the last is displayed as active).
+
+    :type: 'BMEditSelSeq'
+    '''
+
+    select_mode: typing.Set
+    ''' The selection mode, values can be {'VERT', 'EDGE', 'FACE'}, can't be assigned an empty set.
+
+    :type: typing.Set
+    '''
+
+    verts: 'BMVertSeq'
+    ''' This meshes vert sequence (read-only).
+
+    :type: 'BMVertSeq'
+    '''
+
+    def calc_loop_triangles(self) -> typing.List['BMLoop']:
+        ''' Calculate triangle tessellation from quads/ngons.
+
+        :rtype: typing.List['BMLoop']
+        :return: The triangulated faces.
+        '''
+        ...
+
+    def calc_volume(self, signed: bool = False) -> float:
+        ''' Calculate mesh volume based on face normals.
+
+        :param signed: when signed is true, negative values may be returned.
+        :type signed: bool
+        :rtype: float
+        :return: The volume of the mesh.
+        '''
+        ...
+
+    def clear(self):
+        ''' Clear all mesh data.
+
+        '''
+        ...
+
+    def copy(self) -> 'BMesh':
+        ''' 
+
+        :rtype: 'BMesh'
+        :return: A copy of this BMesh.
+        '''
+        ...
+
+    def free(self):
+        ''' Explicitly free the BMesh data from memory, causing exceptions on further access.
+
+        '''
+        ...
+
+    def from_mesh(self,
+                  mesh: 'bpy.types.Mesh',
+                  face_normals=True,
+                  vertex_normals=True,
+                  use_shape_key: bool = False,
+                  shape_key_index: int = 0):
+        ''' Initialize this bmesh from existing mesh datablock.
+
+        :param mesh: The mesh data to load.
+        :type mesh: 'bpy.types.Mesh'
+        :param use_shape_key: Use the locations from a shape key.
+        :type use_shape_key: bool
+        :param shape_key_index: The shape key index to use.
+        :type shape_key_index: int
+        '''
+        ...
+
+    def from_object(self,
+                    object: 'bpy.types.Object',
+                    depsgraph,
+                    cage: bool = False,
+                    face_normals: bool = True,
+                    vertex_normals: bool = True):
+        ''' Initialize this bmesh from existing object data-block (only meshes are currently supported).
+
+        :param object: The object data to load.
+        :type object: 'bpy.types.Object'
+        :param cage: Get the mesh as a deformed cage.
+        :type cage: bool
+        :param face_normals: Calculate face normals.
+        :type face_normals: bool
+        :param vertex_normals: Calculate vertex normals.
+        :type vertex_normals: bool
+        '''
+        ...
+
+    def normal_update(self):
+        ''' Update normals of mesh faces and verts.
+
+        '''
+        ...
+
+    def select_flush(self, select: bool):
+        ''' Flush selection, independent of the current selection mode.
+
+        :param select: flush selection or de-selected elements.
+        :type select: bool
+        '''
+        ...
+
+    def select_flush_mode(self):
+        ''' flush selection based on the current mode current `BMesh.select_mode`.
+
+        '''
+        ...
+
+    def to_mesh(self, mesh: 'bpy.types.Mesh'):
+        ''' Writes this BMesh data into an existing Mesh datablock.
+
+        :param mesh: The mesh data to write into.
+        :type mesh: 'bpy.types.Mesh'
+        '''
+        ...
+
+    def transform(self, matrix: 'mathutils.Matrix', filter: typing.Set = None):
+        ''' Transform the mesh (optionally filtering flagged data only).
+
+        :param matrix: transform matrix.
+        :type matrix: 'mathutils.Matrix'
+        :param filter: set of values in ('SELECT', 'HIDE', 'SEAM', 'SMOOTH', 'TAG').
+        :type filter: typing.Set
+        '''
+        ...