fake-bpy-module 20240515__py3-none-any.whl → 20240517__py3-none-any.whl

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

@@ -20,7 +20,7 @@ class ProgressReport:
     wm: typing.Any
     """ """
 
-    def enter_substeps(self, nbr, msg):
+    def enter_substeps(self, nbr, msg=""):
         """
 
         :param nbr:
@@ -32,14 +32,14 @@ class ProgressReport:
         """ """
         ...
 
-    def initialize(self, wm):
-        """
+    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:
@@ -50,7 +50,7 @@ class ProgressReport:
         """ """
         ...
 
-    def step(self, msg, nbr):
+    def step(self, msg="", nbr=1):
         """
 
         :param msg:
@@ -58,7 +58,7 @@ class ProgressReport:
         """
         ...
 
-    def update(self, msg):
+    def update(self, msg=""):
         """
 
         :param msg:
@@ -66,7 +66,10 @@ 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
     """ """
@@ -83,7 +86,7 @@ class ProgressReportSubstep:
     progress: typing.Any
     """ """
 
-    def enter_substeps(self, nbr, msg):
+    def enter_substeps(self, nbr, msg=""):
         """
 
         :param nbr:
@@ -91,14 +94,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: