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

bpy_extras/node_shader_utils/__init__.pyi

@@ -3,38 +3,18 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 class ShaderWrapper:
-    """ """
+    """Base class with minimal common ground for all types of shader interfaces we may want/need to implement."""
 
     NODES_LIST: typing.Any
-    """ """
-
     is_readonly: typing.Any
-    """ """
-
     material: typing.Any
-    """ """
-
     node_out: typing.Any
-    """ """
-
     node_texcoords: typing.Any
-    """ """
-
     use_nodes: typing.Any
-    """ """
-
-    def node_texcoords_get(self):
-        """ """
-        ...
-
-    def update(self):
-        """ """
-        ...
-
-    def use_nodes_get(self):
-        """ """
-        ...
 
+    def node_texcoords_get(self): ...
+    def update(self): ...
+    def use_nodes_get(self): ...
     def use_nodes_set(self, val):
         """
 
@@ -43,61 +23,28 @@ class ShaderWrapper:
         ...
 
 class ShaderImageTextureWrapper:
-    """ """
+    """Generic 'image texture'-like wrapper, handling image node, some mapping (texture coordinates transformations),
+    and texture coordinates source.
+    """
 
     NODES_LIST: typing.Any
-    """ """
-
     colorspace_is_data: typing.Any
-    """ """
-
     colorspace_name: typing.Any
-    """ """
-
     extension: typing.Any
-    """ """
-
     grid_row_diff: typing.Any
-    """ """
-
     image: typing.Any
-    """ """
-
     is_readonly: typing.Any
-    """ """
-
     node_dst: typing.Any
-    """ """
-
     node_image: typing.Any
-    """ """
-
     node_mapping: typing.Any
-    """ """
-
     owner_shader: typing.Any
-    """ """
-
     projection: typing.Any
-    """ """
-
     rotation: typing.Any
-    """ """
-
     scale: typing.Any
-    """ """
-
     socket_dst: typing.Any
-    """ """
-
     texcoords: typing.Any
-    """ """
-
     translation: typing.Any
-    """ """
-
     use_alpha: typing.Any
-    """ """
 
     def copy_from(self, tex):
         """
@@ -113,10 +60,7 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def extension_get(self):
-        """ """
-        ...
-
+    def extension_get(self): ...
     def extension_set(self, extension):
         """
 
@@ -124,14 +68,8 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def has_mapping_node(self):
-        """ """
-        ...
-
-    def image_get(self):
-        """ """
-        ...
-
+    def has_mapping_node(self): ...
+    def image_get(self): ...
     def image_set(self, image):
         """
 
@@ -139,18 +77,9 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def node_image_get(self):
-        """ """
-        ...
-
-    def node_mapping_get(self):
-        """ """
-        ...
-
-    def projection_get(self):
-        """ """
-        ...
-
+    def node_image_get(self): ...
+    def node_mapping_get(self): ...
+    def projection_get(self): ...
     def projection_set(self, projection):
         """
 
@@ -158,10 +87,7 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def rotation_get(self):
-        """ """
-        ...
-
+    def rotation_get(self): ...
     def rotation_set(self, rotation):
         """
 
@@ -169,10 +95,7 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def scale_get(self):
-        """ """
-        ...
-
+    def scale_get(self): ...
     def scale_set(self, scale):
         """
 
@@ -180,10 +103,7 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def texcoords_get(self):
-        """ """
-        ...
-
+    def texcoords_get(self): ...
     def texcoords_set(self, texcoords):
         """
 
@@ -191,10 +111,7 @@ class ShaderImageTextureWrapper:
         """
         ...
 
-    def translation_get(self):
-        """ """
-        ...
-
+    def translation_get(self): ...
     def translation_set(self, translation):
         """
 
@@ -203,102 +120,43 @@ class ShaderImageTextureWrapper:
         ...
 
 class PrincipledBSDFWrapper(ShaderWrapper):
-    """ """
+    """Hard coded shader setup, based in Principled BSDF.
+    Should cover most common cases on import, and gives a basic nodal shaders support for export.
+    Supports basic: diffuse/spec/reflect/transparency/normal, with texturing.
+    """
 
     NODES_LIST: typing.Any
-    """ """
-
     alpha: typing.Any
-    """ """
-
     alpha_texture: typing.Any
-    """ """
-
     base_color: typing.Any
-    """ """
-
     base_color_texture: typing.Any
-    """ """
-
     emission_color: typing.Any
-    """ """
-
     emission_color_texture: typing.Any
-    """ """
-
     emission_strength: typing.Any
-    """ """
-
     emission_strength_texture: typing.Any
-    """ """
-
     ior: typing.Any
-    """ """
-
     ior_texture: typing.Any
-    """ """
-
     is_readonly: typing.Any
-    """ """
-
     material: typing.Any
-    """ """
-
     metallic: typing.Any
-    """ """
-
     metallic_texture: typing.Any
-    """ """
-
     node_normalmap: typing.Any
-    """ """
-
     node_out: typing.Any
-    """ """
-
     node_principled_bsdf: typing.Any
-    """ """
-
     node_texcoords: typing.Any
-    """ """
-
     normalmap_strength: typing.Any
-    """ """
-
     normalmap_texture: typing.Any
-    """ """
-
     roughness: typing.Any
-    """ """
-
     roughness_texture: typing.Any
-    """ """
-
     specular: typing.Any
-    """ """
-
     specular_texture: typing.Any
-    """ """
-
     specular_tint: typing.Any
-    """ """
-
     specular_tint_texture: typing.Any
-    """ """
-
     transmission: typing.Any
-    """ """
-
     transmission_texture: typing.Any
-    """ """
-
     use_nodes: typing.Any
-    """ """
-
-    def alpha_get(self):
-        """ """
-        ...
 
+    def alpha_get(self): ...
     def alpha_set(self, value):
         """
 
@@ -306,14 +164,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def alpha_texture_get(self):
-        """ """
-        ...
-
-    def base_color_get(self):
-        """ """
-        ...
-
+    def alpha_texture_get(self): ...
+    def base_color_get(self): ...
     def base_color_set(self, color):
         """
 
@@ -321,14 +173,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def base_color_texture_get(self):
-        """ """
-        ...
-
-    def emission_color_get(self):
-        """ """
-        ...
-
+    def base_color_texture_get(self): ...
+    def emission_color_get(self): ...
     def emission_color_set(self, color):
         """
 
@@ -336,14 +182,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def emission_color_texture_get(self):
-        """ """
-        ...
-
-    def emission_strength_get(self):
-        """ """
-        ...
-
+    def emission_color_texture_get(self): ...
+    def emission_strength_get(self): ...
     def emission_strength_set(self, value):
         """
 
@@ -351,14 +191,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def emission_strength_texture_get(self):
-        """ """
-        ...
-
-    def ior_get(self):
-        """ """
-        ...
-
+    def emission_strength_texture_get(self): ...
+    def ior_get(self): ...
     def ior_set(self, value):
         """
 
@@ -366,14 +200,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def ior_texture_get(self):
-        """ """
-        ...
-
-    def metallic_get(self):
-        """ """
-        ...
-
+    def ior_texture_get(self): ...
+    def metallic_get(self): ...
     def metallic_set(self, value):
         """
 
@@ -381,22 +209,10 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def metallic_texture_get(self):
-        """ """
-        ...
-
-    def node_normalmap_get(self):
-        """ """
-        ...
-
-    def node_texcoords_get(self):
-        """ """
-        ...
-
-    def normalmap_strength_get(self):
-        """ """
-        ...
-
+    def metallic_texture_get(self): ...
+    def node_normalmap_get(self): ...
+    def node_texcoords_get(self): ...
+    def normalmap_strength_get(self): ...
     def normalmap_strength_set(self, value):
         """
 
@@ -404,14 +220,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def normalmap_texture_get(self):
-        """ """
-        ...
-
-    def roughness_get(self):
-        """ """
-        ...
-
+    def normalmap_texture_get(self): ...
+    def roughness_get(self): ...
     def roughness_set(self, value):
         """
 
@@ -419,14 +229,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def roughness_texture_get(self):
-        """ """
-        ...
-
-    def specular_get(self):
-        """ """
-        ...
-
+    def roughness_texture_get(self): ...
+    def specular_get(self): ...
     def specular_set(self, value):
         """
 
@@ -434,14 +238,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def specular_texture_get(self):
-        """ """
-        ...
-
-    def specular_tint_get(self):
-        """ """
-        ...
-
+    def specular_texture_get(self): ...
+    def specular_tint_get(self): ...
     def specular_tint_set(self, color):
         """
 
@@ -449,14 +247,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def specular_tint_texture_get(self):
-        """ """
-        ...
-
-    def transmission_get(self):
-        """ """
-        ...
-
+    def specular_tint_texture_get(self): ...
+    def transmission_get(self): ...
     def transmission_set(self, value):
         """
 
@@ -464,18 +256,9 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-    def transmission_texture_get(self):
-        """ """
-        ...
-
-    def update(self):
-        """ """
-        ...
-
-    def use_nodes_get(self):
-        """ """
-        ...
-
+    def transmission_texture_get(self): ...
+    def update(self): ...
+    def use_nodes_get(self): ...
     def use_nodes_set(self, val):
         """
 
@@ -483,27 +266,8 @@ class PrincipledBSDFWrapper(ShaderWrapper):
         """
         ...
 
-def node_input_value_get(node, input, default_value):
-    """ """
-
-    ...
-
-def node_input_value_set(node, input, value):
-    """ """
-
-    ...
-
-def rgb_to_rgba(rgb):
-    """ """
-
-    ...
-
-def rgba_to_rgb(rgba):
-    """ """
-
-    ...
-
-def values_clamp(val, minv, maxv):
-    """ """
-
-    ...
+def node_input_value_get(node, input, default_value=None): ...
+def node_input_value_set(node, input, value): ...
+def rgb_to_rgba(rgb): ...
+def rgba_to_rgb(rgba): ...
+def values_clamp(val, minv, maxv): ...

bpy_extras/node_utils/__init__.pyi

@@ -3,21 +3,21 @@ import typing
 GenericType = typing.TypeVar("GenericType")
 
 def connect_sockets(input, output):
-    """ """
+    """Connect sockets in a node tree.This is useful because the links created through the normal Python API are
+    invalid when one of the sockets is a virtual socket (grayed out sockets in
+    Group Input and Group Output nodes).It replaces node_tree.links.new(input, output)
+
+    """
 
     ...
 
 def find_base_socket_type(socket):
-    """ """
-
-    ...
+    """Find the base class of the socket.Sockets can have a subtype such as NodeSocketFloatFactor,
+    but only the base type is allowed, e. g. NodeSocketFloat
 
-def find_node_input(node, name):
-    """ """
+    """
 
     ...
 
-def find_node_input(node, name):
-    """ """
-
-    ...
+def find_node_input(node, name): ...
+def find_node_input(node, name): ...