fake-bpy-module 20240524__py3-none-any.whl → 20240529__py3-none-any.whl

bl_operators/image_as_planes/__init__.pyi

@@ -0,0 +1,463 @@
+import typing
+import collections.abc
+import bpy.types
+import bpy_extras.io_utils
+import bpy_extras.object_utils
+import bpy_types
+
+GenericType1 = typing.TypeVar("GenericType1")
+GenericType2 = typing.TypeVar("GenericType2")
+
+class IMAGE_OT_import_as_mesh_planes(
+    bpy_extras.io_utils.ImportHelper,
+    bpy_extras.object_utils.AddObjectHelper,
+    bpy_types.Operator,
+):
+    """Create mesh plane(s) from image files with the appropriate aspect ratio"""
+
+    AXIS_MODES: typing.Any
+    axis_id_to_vector: typing.Any
+    bl_idname: typing.Any
+    bl_label: typing.Any
+    bl_options: typing.Any
+    bl_rna: typing.Any
+    id_data: typing.Any
+    t: typing.Any
+
+    def align_plane(self, context, plane):
+        """Pick an axis and align the plane to it
+
+        :param context:
+        :param plane:
+        """
+        ...
+
+    def align_update_callback(self, _context):
+        """
+
+        :param _context:
+        """
+        ...
+
+    def apply_image_options(self, image):
+        """
+
+        :param image:
+        """
+        ...
+
+    def apply_material_options(self, material, slot):
+        """
+
+        :param material:
+        :param slot:
+        """
+        ...
+
+    def apply_texture_options(self, texture, img_spec):
+        """
+
+        :param texture:
+        :param img_spec:
+        """
+        ...
+
+    def as_keywords(self, ignore=()):
+        """Return a copy of the properties as a dictionary
+
+        :param ignore:
+        """
+        ...
+
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
+        ...
+
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
+        ...
+
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
+        ...
+
+    def check(self, _context):
+        """
+
+        :param _context:
+        """
+        ...
+
+    def compute_plane_size(self, context, img_spec):
+        """Given the image size in pixels and location, determine size of plane
+
+        :param context:
+        :param img_spec:
+        """
+        ...
+
+    def create_cycles_material(self, img_spec, name):
+        """
+
+        :param img_spec:
+        :param name:
+        """
+        ...
+
+    def create_cycles_texnode(self, node_tree, img_spec):
+        """
+
+        :param node_tree:
+        :param img_spec:
+        """
+        ...
+
+    def create_image_plane(self, context, name, img_spec):
+        """
+
+        :param context:
+        :param name:
+        :param img_spec:
+        """
+        ...
+
+    def draw(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def draw_import_config(self, _context):
+        """
+
+        :param _context:
+        """
+        ...
+
+    def draw_material_config(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def draw_spatial_config(self, _context):
+        """
+
+        :param _context:
+        """
+        ...
+
+    def draw_texture_config(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
+
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
+        """
+        ...
+
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
+        ...
+
+    def execute(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def get(self):
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
+        ...
+
+    def id_properties_clear(self):
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
+        ...
+
+    def id_properties_ensure(self):
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
+        ...
+
+    def id_properties_ui(self):
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
+        ...
+
+    def import_images(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def invoke(self, context, _event):
+        """
+
+        :param context:
+        :param _event:
+        """
+        ...
+
+    def invoke_popup(self, context, confirm_text=""):
+        """
+
+        :param context:
+        :param confirm_text:
+        """
+        ...
+
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
+        ...
+
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
+        ...
+
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
+        ...
+
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
+        ...
+
+    def items(self):
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
+        ...
+
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
+        ...
+
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
+        ...
+
+    def keys(self):
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
+        ...
+
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
+        ...
+
+    def path_resolve(self):
+        """Returns the property from the path, raise an exception when not found."""
+        ...
+
+    def poll(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+    def poll_message_set(self):
+        """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
+        ...
+
+    def pop(self):
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
+        ...
+
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
+        ...
+
+    def property_unset(self):
+        """Unset a property, will use default value afterward."""
+        ...
+
+    def single_image_spec_to_plane(self, context, img_spec):
+        """
+
+        :param context:
+        :param img_spec:
+        """
+        ...
+
+    def type_recast(self):
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
+        ...
+
+    def update_size_mode(self, _context):
+        """If sizing relative to the camera, always face the camera
+
+        :param _context:
+        """
+        ...
+
+    def values(self):
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
+        ...
+
+class ImageSpec:
+    """ImageSpec(image, size, frame_start, frame_offset, frame_duration)"""
+
+    frame_duration: typing.Any
+    frame_offset: typing.Any
+    frame_start: typing.Any
+    image: typing.Any
+    size: typing.Any
+
+    def count(self, value):
+        """Return number of occurrences of value.
+
+        :param value:
+        """
+        ...
+
+    def index(self, value, start=0, stop=9223372036854775807):
+        """Return first index of value.Raises ValueError if the value is not present.
+
+        :param value:
+        :param start:
+        :param stop:
+        """
+        ...
+
+def auto_align_nodes(node_tree):
+    """Given a shader node tree, arrange nodes neatly relative to the output node."""
+
+    ...
+
+def center_in_camera(camera, ob, axis=(1, 1)):
+    """Center object along specified axis of the camera"""
+
+    ...
+
+def clean_node_tree(node_tree):
+    """Clear all nodes in a shader node tree except the output.Returns the output node"""
+
+    ...
+
+def compute_camera_size(context, center, fill_mode, aspect):
+    """Determine how large an object needs to be to fit or fill the camera's field of view."""
+
+    ...
+
+def find_image_sequences(files):
+    """From a group of files, detect image sequences.This returns a generator of tuples, which contain the filename,
+    start frame, and length of the detected sequence
+
+    """
+
+    ...
+
+def get_input_nodes(node, links):
+    """Get nodes that are a inputs to the given node"""
+
+    ...
+
+def get_shadeless_node(dest_node_tree):
+    """Return a "shadeless" cycles/EEVEE node, creating a node group if nonexistent"""
+
+    ...
+
+def load_images(
+    filenames, directory, force_reload=False, frame_start=1, find_sequences=False
+):
+    """Wrapper for bpy_extras.image_utils.load_image.Loads a set of images, movies, or even image sequences
+    Returns a generator of ImageSpec wrapper objects later used for texture setup
+
+    """
+
+    ...
+
+def offset_planes(planes, gap, axis):
+    """Offset planes from each other by gap amount along a _local_ vector axisFor example, offset_planes([obj1, obj2], 0.5, Vector(0, 0, 1)) will place
+    obj2 0.5 blender units away from obj1 along the local positive Z axis.This is in local space, not world space, so all planes should share
+    a common scale and rotation.
+
+    """
+
+    ...

bl_operators/node_editor/__init__.pyi

@@ -0,0 +1,6 @@
+import typing
+import collections.abc
+from . import node_functions
+
+GenericType1 = typing.TypeVar("GenericType1")
+GenericType2 = typing.TypeVar("GenericType2")

bl_operators/node_editor/node_functions/__init__.pyi

@@ -0,0 +1,23 @@
+import typing
+import collections.abc
+
+GenericType1 = typing.TypeVar("GenericType1")
+GenericType2 = typing.TypeVar("GenericType2")
+
+class NodeEditorBase:
+    def poll(self, context):
+        """
+
+        :param context:
+        """
+        ...
+
+def force_update(context): ...
+def get_group_output_node(tree, output_node_idname="NodeGroupOutput"): ...
+def get_internal_socket(socket): ...
+def get_output_location(tree): ...
+def is_viewer_link(link, output_node): ...
+def is_viewer_socket(socket): ...
+def is_visible_socket(socket): ...
+def node_editor_poll(cls, context): ...
+def node_space_type_poll(cls, context, types): ...

bl_operators/presets/__init__.pyi

@@ -434,10 +434,10 @@ class WM_MT_operator_presets(bpy_types.Menu, bpy_types._GenericUI):
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -450,14 +450,14 @@ class WM_MT_operator_presets(bpy_types.Menu, bpy_types._GenericUI):
                 :param props_default: Properties to assign to each operator.
                 :type props_default: dict
                 :param prop_filepath: Optional operator filepath property (defaults to "filepath").
-                :type prop_filepath: str
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """
@@ -913,10 +913,10 @@ class WM_PT_operator_presets(
         searchpaths: list[str],
         operator: str,
         props_default: dict = None,
-        prop_filepath: str = "filepath",
-        filter_ext: typing.Callable = None,
+        prop_filepath: str | None = "filepath",
+        filter_ext: collections.abc.Callable | None = None,
         filter_path=None,
-        display_name: typing.Callable = None,
+        display_name: collections.abc.Callable | None = None,
         add_operator=None,
         add_operator_props=None,
     ):
@@ -929,14 +929,14 @@ class WM_PT_operator_presets(
                 :param props_default: Properties to assign to each operator.
                 :type props_default: dict
                 :param prop_filepath: Optional operator filepath property (defaults to "filepath").
-                :type prop_filepath: str
+                :type prop_filepath: str | None
                 :param filter_ext: Optional callback that takes the file extensions.
 
         Returning false excludes the file from the list.
-                :type filter_ext: typing.Callable
+                :type filter_ext: collections.abc.Callable | None
                 :param filter_path:
                 :param display_name: Optional callback that takes the full path, returns the name to display.
-                :type display_name: typing.Callable
+                :type display_name: collections.abc.Callable | None
                 :param add_operator:
                 :param add_operator_props:
         """