fake-bpy-module 20240516__py3-none-any.whl → 20240518__py3-none-any.whl

bpy_extras/object_utils/__init__.pyi

@@ -5,8 +5,6 @@ import mathutils
 GenericType = typing.TypeVar("GenericType")
 
 class AddObjectHelper:
-    """ """
-
     def align_update_callback(self, _context):
         """
 
@@ -36,8 +34,18 @@ def add_object_align_init(
 
     ...
 
-def add_object_align_init(context, operator):
-    """ """
+def add_object_align_init(
+    context: bpy.types.Context, operator: bpy.types.Operator
+) -> mathutils.Matrix:
+    """Return a matrix using the operator settings and view context.
+
+    :param context: The context to use.
+    :type context: bpy.types.Context
+    :param operator: The operator, checked for location and rotation properties.
+    :type operator: bpy.types.Operator
+    :return: the matrix from the context and settings.
+    :rtype: mathutils.Matrix
+    """
 
     ...
 
@@ -50,7 +58,10 @@ def object_add_grid_scale(context):
     ...
 
 def object_add_grid_scale(context):
-    """ """
+    """Return scale which should be applied on object
+    data to align it to grid scale
+
+    """
 
     ...
 
@@ -60,7 +71,7 @@ def object_add_grid_scale_apply_operator(operator, context):
     ...
 
 def object_add_grid_scale_apply_operator(operator, context):
-    """ """
+    """Scale an operators distance values by the grid size."""
 
     ...
 
@@ -86,8 +97,25 @@ def object_data_add(
 
     ...
 
-def object_data_add(context, obdata, operator, name):
-    """ """
+def object_data_add(
+    context: bpy.types.Context,
+    obdata,
+    operator: bpy.types.Operator = None,
+    name: str = None,
+) -> bpy.types.Object:
+    """Add an object using the view context and preference to initialize the
+    location, rotation and layer.
+
+        :param context: The context to use.
+        :type context: bpy.types.Context
+        :param obdata: the data used for the new object.
+        :param operator: The operator, checked for location and rotation properties.
+        :type operator: bpy.types.Operator
+        :param name: Optional name
+        :type name: str
+        :return: the newly created object in the scene.
+        :rtype: bpy.types.Object
+    """
 
     ...
 
@@ -105,15 +133,24 @@ def object_report_if_active_shape_key_is_locked(
 
     ...
 
-def object_report_if_active_shape_key_is_locked(obj, operator):
-    """ """
+def object_report_if_active_shape_key_is_locked(
+    obj: bpy.types.Object, operator: bpy.types.Operator
+):
+    """Checks if the active shape key of the specified object is locked, and reports an error if so.If the object has no shape keys, there is nothing to lock, and the function returns False.
+
+    :param obj: Object to check.
+    :type obj: bpy.types.Object
+    :param operator: Currently running operator to report the error through. Use None to suppress emitting the message.
+    :type operator: bpy.types.Operator
+    :return: True if the shape key was locked.
+    """
 
     ...
 
 def world_to_camera_view(
     scene: bpy.types.Scene,
     obj: bpy.types.Object,
-    coord: typing.Union[typing.Sequence[float], mathutils.Vector],
+    coord: typing.Sequence[float] | mathutils.Vector,
 ) -> mathutils.Vector:
     """Returns the camera space coords for a 3d point.
     (also known as: normalized device coordinates - NDC).Where (0, 0) is the bottom left and (1, 1)
@@ -127,7 +164,7 @@ def world_to_camera_view(
         :param obj: Camera object.
         :type obj: bpy.types.Object
         :param coord: World space location.
-        :type coord: typing.Union[typing.Sequence[float], mathutils.Vector]
+        :type coord: typing.Sequence[float] | mathutils.Vector
         :return: a vector where X and Y map to the view plane and
     Z is the depth on the view axis.
         :rtype: mathutils.Vector
@@ -135,7 +172,27 @@ def world_to_camera_view(
 
     ...
 
-def world_to_camera_view(scene, obj, coord):
-    """ """
+def world_to_camera_view(
+    scene: bpy.types.Scene,
+    obj: bpy.types.Object,
+    coord: typing.Sequence[float] | mathutils.Vector,
+) -> mathutils.Vector:
+    """Returns the camera space coords for a 3d point.
+    (also known as: normalized device coordinates - NDC).Where (0, 0) is the bottom left and (1, 1)
+    is the top right of the camera frame.
+    values outside 0-1 are also supported.
+    A negative 'z' value means the point is behind the camera.Takes shift-x/y, lens angle and sensor size into account
+    as well as perspective/ortho projections.
+
+        :param scene: Scene to use for frame size.
+        :type scene: bpy.types.Scene
+        :param obj: Camera object.
+        :type obj: bpy.types.Object
+        :param coord: World space location.
+        :type coord: typing.Sequence[float] | mathutils.Vector
+        :return: a vector where X and Y map to the view plane and
+    Z is the depth on the view axis.
+        :rtype: mathutils.Vector
+    """
 
     ...

bpy_extras/view3d_utils/__init__.pyi

@@ -26,8 +26,25 @@ def location_3d_to_region_2d(
 
     ...
 
-def location_3d_to_region_2d(region, rv3d, coord, default):
-    """ """
+def location_3d_to_region_2d(
+    region: bpy.types.Region,
+    rv3d: bpy.types.RegionView3D,
+    coord: mathutils.Vector,
+    default=None,
+) -> mathutils.Vector:
+    """Return the region relative 2d location of a 3d position.
+
+        :param region: region of the 3D viewport, typically bpy.context.region.
+        :type region: bpy.types.Region
+        :param rv3d: 3D region data, typically bpy.context.space_data.region_3d.
+        :type rv3d: bpy.types.RegionView3D
+        :param coord: 3d world-space location.
+        :type coord: mathutils.Vector
+        :param default: Return this value if coord
+    is behind the origin of a perspective view.
+        :return: 2d location
+        :rtype: mathutils.Vector
+    """
 
     ...
 
@@ -56,8 +73,28 @@ def region_2d_to_location_3d(
 
     ...
 
-def region_2d_to_location_3d(region, rv3d, coord, depth_location):
-    """ """
+def region_2d_to_location_3d(
+    region: bpy.types.Region,
+    rv3d: bpy.types.RegionView3D,
+    coord: mathutils.Vector,
+    depth_location: mathutils.Vector,
+) -> mathutils.Vector:
+    """Return a 3d location from the region relative 2d coords, aligned with
+    depth_location.
+
+        :param region: region of the 3D viewport, typically bpy.context.region.
+        :type region: bpy.types.Region
+        :param rv3d: 3D region data, typically bpy.context.space_data.region_3d.
+        :type rv3d: bpy.types.RegionView3D
+        :param coord: 2d coordinates relative to the region;
+    (event.mouse_region_x, event.mouse_region_y) for example.
+        :type coord: mathutils.Vector
+        :param depth_location: the returned vectors depth is aligned with this since
+    there is no defined depth with a 2d region input.
+        :type depth_location: mathutils.Vector
+        :return: normalized 3d vector.
+        :rtype: mathutils.Vector
+    """
 
     ...
 
@@ -65,7 +102,7 @@ def region_2d_to_origin_3d(
     region: bpy.types.Region,
     rv3d: bpy.types.RegionView3D,
     coord: mathutils.Vector,
-    clamp: typing.Optional[float] = None,
+    clamp: float | None = None,
 ) -> mathutils.Vector:
     """Return the 3d view origin from the region relative 2d coords.
 
@@ -78,15 +115,34 @@ def region_2d_to_origin_3d(
         :type coord: mathutils.Vector
         :param clamp: Clamp the maximum far-clip value used.
     (negative value will move the offset away from the view_location)
-        :type clamp: typing.Optional[float]
+        :type clamp: float | None
         :return: The origin of the viewpoint in 3d space.
         :rtype: mathutils.Vector
     """
 
     ...
 
-def region_2d_to_origin_3d(region, rv3d, coord, clamp):
-    """ """
+def region_2d_to_origin_3d(
+    region: bpy.types.Region,
+    rv3d: bpy.types.RegionView3D,
+    coord: mathutils.Vector,
+    clamp: float | None = None,
+) -> mathutils.Vector:
+    """Return the 3d view origin from the region relative 2d coords.
+
+        :param region: region of the 3D viewport, typically bpy.context.region.
+        :type region: bpy.types.Region
+        :param rv3d: 3D region data, typically bpy.context.space_data.region_3d.
+        :type rv3d: bpy.types.RegionView3D
+        :param coord: 2d coordinates relative to the region;
+    (event.mouse_region_x, event.mouse_region_y) for example.
+        :type coord: mathutils.Vector
+        :param clamp: Clamp the maximum far-clip value used.
+    (negative value will move the offset away from the view_location)
+        :type clamp: float | None
+        :return: The origin of the viewpoint in 3d space.
+        :rtype: mathutils.Vector
+    """
 
     ...
 
@@ -109,7 +165,21 @@ def region_2d_to_vector_3d(
 
     ...
 
-def region_2d_to_vector_3d(region, rv3d, coord):
-    """ """
+def region_2d_to_vector_3d(
+    region: bpy.types.Region, rv3d: bpy.types.RegionView3D, coord: mathutils.Vector
+) -> mathutils.Vector:
+    """Return a direction vector from the viewport at the specific 2d region
+    coordinate.
+
+        :param region: region of the 3D viewport, typically bpy.context.region.
+        :type region: bpy.types.Region
+        :param rv3d: 3D region data, typically bpy.context.space_data.region_3d.
+        :type rv3d: bpy.types.RegionView3D
+        :param coord: 2d coordinates relative to the region:
+    (event.mouse_region_x, event.mouse_region_y) for example.
+        :type coord: mathutils.Vector
+        :return: normalized 3d vector.
+        :rtype: mathutils.Vector
+    """
 
     ...

bpy_extras/wm_utils/progress_report/__init__.pyi

@@ -3,24 +3,13 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class ProgressReport:
-    """ """
-
     curr_step: typing.Any
-    """ """
-
     running: typing.Any
-    """ """
-
     start_time: typing.Any
-    """ """
-
     steps: typing.Any
-    """ """
-
     wm: typing.Any
-    """ """
 
-    def enter_substeps(self, nbr, msg):
+    def enter_substeps(self, nbr, msg=""):
         """
 
         :param nbr:
@@ -28,29 +17,23 @@ class ProgressReport:
         """
         ...
 
-    def finalize(self):
-        """ """
-        ...
-
-    def initialize(self, wm):
-        """
+    def finalize(self): ...
+    def initialize(self, wm=None):
+        """Initialize self.  See help(type(self)) for accurate signature.
 
         :param wm:
         """
         ...
 
-    def leave_substeps(self, msg):
+    def leave_substeps(self, msg=""):
         """
 
         :param msg:
         """
         ...
 
-    def start(self):
-        """ """
-        ...
-
-    def step(self, msg, nbr):
+    def start(self): ...
+    def step(self, msg="", nbr=1):
         """
 
         :param msg:
@@ -58,7 +41,7 @@ class ProgressReport:
         """
         ...
 
-    def update(self, msg):
+    def update(self, msg=""):
         """
 
         :param msg:
@@ -66,24 +49,18 @@ class ProgressReport:
         ...
 
 class ProgressReportSubstep:
-    """ """
+    """A sub-step context manager for ProgressReport.It can be used to generate other sub-step contexts too, and can act as a (limited) proxy of its real ProgressReport.Its exit method always ensure ProgressReport is back on 'level' it was before entering this context.
+    This means it is especially useful to ensure a coherent behavior around code that could return/continue/break
+    from many places, without having to bother to explicitly leave sub-step in each and every possible place!
+    """
 
     final_msg: typing.Any
-    """ """
-
     level: typing.Any
-    """ """
-
     msg: typing.Any
-    """ """
-
     nbr: typing.Any
-    """ """
-
     progress: typing.Any
-    """ """
 
-    def enter_substeps(self, nbr, msg):
+    def enter_substeps(self, nbr, msg=""):
         """
 
         :param nbr:
@@ -91,14 +68,14 @@ class ProgressReportSubstep:
         """
         ...
 
-    def leave_substeps(self, msg):
+    def leave_substeps(self, msg=""):
         """
 
         :param msg:
         """
         ...
 
-    def step(self, msg, nbr):
+    def step(self, msg="", nbr=1):
         """
 
         :param msg:

bpy_restrict_state/__init__.pyi

@@ -3,24 +3,11 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class RestrictBlend:
-    """ """
-
     context: typing.Any
-    """ """
-
     data: typing.Any
-    """ """
 
 class _RestrictContext:
-    """ """
-
     preferences: typing.Any
-    """ """
-
     window_manager: typing.Any
-    """ """
-
-class _RestrictData:
-    """ """
 
-    ...
+class _RestrictData: ...