fake-bpy-module 20241230__tar.gz → 20250102__tar.gz

{fake_bpy_module-20241230 → fake_bpy_module-20250102}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fake-bpy-module
-Version: 20241230
+Version: 20250102
 Summary: Collection of the fake Blender Python API module for the code completion.
 Author: nutti
 Author-email: nutti.metro@gmail.com

{fake_bpy_module-20241230 → fake_bpy_module-20250102}/bpy/types/__init__.pyi

@@ -5547,86 +5547,273 @@ print(positions_data)
 This example shows an implementation of USDHook
 
  to extend USD
-export and import functionalty.
+export and import functionality.
+
+
+--------------------
 
 One may optionally define any or all of the following callback functions
 in the USDHook
 
  subclass.
 
-Hook function on_export()
 
- is called before the USD export finalizes,
-allowing modifications to the USD stage immediately before it is
-saved.  This function takes as an argument an instance of an
-internally defined class USDSceneExportContext
+--------------------
 
- which provides the
-following accessors to the scene data:
+Called before the USD export finalizes, allowing modifications to the USD
+stage immediately before it is saved.
 
-* get_stage()
+Args:
 
- returns the USD stage to be saved.
-* get_depsgraph()
+* export_context
 
- returns the Blender scene dependency graph.
+ (USDSceneExportContext): Provides access to the stage and dependency graph
 
-Hook function on_material_export()
+Returns:
 
- is called for each material that is exported,
-allowing modifications to the USD material, such as shader generation.
-It is called with three arguments:
+* True
 
--export_context
+ on success or False
 
-: An instance of the internally defined type USDMaterialExportContext
+ if the operation was bypassed or otherwise failed to complete
 
-.
--bl_material
 
-: The source Blender material.
--usd_material
+--------------------
 
-: The target USD material to be exported.
+Called for each material that is exported, allowing modifications to the USD material,
+such as shader generation.
 
-USDMaterialExportContext
+Args:
 
- implements a get_stage()
+* export_context
 
- function which returns the
-USD stage to be saved.
+ (USDMaterialExportContext): Provides access to the stage and a texture export utility function
+* bl_material
+
+ (bpy.types.Material
+
+): The source Blender material
+* usd_material
+
+ (pxr.UsdShade.Material
+
+): The target USD material to be exported
+
+Returns:
+
+* True
+
+ on success or False
+
+ if the operation was bypassed or otherwise failed to complete
 
 Note that the target USD material might already have connected shaders created by the USD exporter or
 by other material export hooks.
 
-Hook function on_import()
 
- is called after the USD import finalizes. This function takes
-as an argument an instance of an internally defined class USDSceneImportContext
+--------------------
+
+Called after the USD import finalizes.
+
+Args:
+
+* import_context
+
+ (USDSceneImportContext):
+Provides access to the stage and a map associating USD prim paths and Blender IDs
+
+Returns:
+
+* True
+
+ on success or False
+
+ if the operation was bypassed or otherwise failed to complete
+
+
+--------------------
+
+Called to determine if the USDHook
+
+ implementation can convert a given USD material.
+
+Args:
+
+* import_context
+
+ (USDMaterialImportContext): Provides access to the stage and a texture import utility function
+* usd_material
+
+ (pxr.UsdShade.Material
+
+): The source USD material to be exported
+
+Returns:
+
+* True
+
+ if the hook can convert the material or False
+
+ otherwise
+
+If any hook returns True
+
+ from material_import_poll
+
+, the USD importer will skip standard USD Preview Surface
+
+
+or MaterialX
+
+ import and invoke the hook's on_material_import method to convert the material instead.
+
+
+--------------------
+
+Called for each material that is imported, to allow converting the USD material to nodes on the Blender material.
+To ensure that this function gets called, the hook must also implement the material_import_poll()
+
+
+callback to return True
+
+ for the given USD material.
+
+Args:
+
+* import_context
+
+ (USDMaterialImportContext): Provides access to the stage and a texture import utility function
+* bl_material
+
+ (bpy.types.Material
+
+): The target Blender material with an empty node tree
+* usd_material
+
+ (pxr.UsdShade.Material
+
+): The source USD material to be imported
+
+Returns:
+
+* True
+
+ on success or False
+
+ if the conversion failed or otherwise did not complete
+
+
+--------------------
+
+Instances of the following built-in classes are provided as arguments to the callbacks.
+
+
+--------------------
 
- which provides the
-following accessors to the scene data:
+Argument for on_export.
+
+Methods:
+
+* get_stage()
+
+: returns the USD stage to be saved
+* get_depsgraph()
+
+: returns the Blender scene dependency graph
+
+
+--------------------
+
+Argument for on_material_export.
+
+Methods:
+
+* get_stage()
+
+: returns the USD stage to be saved
+* export_texture(image: bpy.types.Image)
+
+: Returns the USD asset path for the given texture image
+
+The export_texture
+
+ function will save in-memory images and may copy texture assets,
+depending on the current USD export options.
+For example, by default calling export_texture(/foo/bar.png)
+
+ will copy the file to a textures
+
+
+directory next to the exported USD and will return the relative path ./textures/bar.png
+
+.
+
+
+--------------------
+
+Argument for on_import.
+
+Methods:
 
 * get_prim_map()
 
- returns a dict where the key is an imported USD Prim path and the value a list of
-    the IDs created by the imported prim.
+ returns a dict
+
+ where the key is an imported USD Prim path and the value a list
 
+
+of the IDs created by the imported prim.
 * get_stage()
 
  returns the USD stage which was imported.
 
-The hook functions should return True
 
- on success or False
+--------------------
+
+Argument for material_import_poll and on_material_import.
+
+Methods:
+
+* get_stage()
+
+:
+returns the USD stage to be saved.
+* import_texture(asset_path: str)
+
+:
+for the given USD texture asset path, returns a tuple[str, bool]
+
+,
+containing the asset's local path and a bool indicating whether the path references a temporary file.
+
+The import_texture
+
+ function may copy the texture to the local file system if the given asset path is a
+package-relative path for a USDZ archive, depending on the current USD Import Textures
 
- if the operation was bypassed or
-otherwise failed to complete.  Exceptions raised by these functions will be reported in Blender, with
-the exception details printed to the console.
+ options.
+When the Import Textures
+
+ mode is Packed
+
+, the texture is saved to a temporary location and the
+second element of the returned tuple is True
+
+, indicating that the file is temporary, in which
+case it may be necessary to pack the image. The original asset path will be returned unchanged if it's
+already a local file or if it could not be copied to a local destination.
+
+
+--------------------
+
+Exceptions raised by these functions will be reported in Blender with the exception details printed to the console.
+
+
+--------------------
 
 The USDHookExample
 
- class in this example impements the fllowing functions:
+ class in the example below implements the following functions:
 
 * on_export()
 
@@ -5635,10 +5822,24 @@ The USDHookExample
 
  function to create a simple MaterialX
 
- shader on the givne USD material.
+ shader on the given USD material.
 * on_import()
 
  function to create a text object to display the stage's custom layer data.
+* material_import_poll()
+
+ returns True
+
+ if the given USD material has an mtlx
+
+ context.
+* on_material_import()
+
+ function to convert a simple MaterialX
+
+ shader with a base_color
+
+ input.
 
 ```../examples/bpy.types.USDHook.py```
 

{fake_bpy_module-20241230 → fake_bpy_module-20250102}/fake_bpy_module.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fake-bpy-module
-Version: 20241230
+Version: 20250102
 Summary: Collection of the fake Blender Python API module for the code completion.
 Author: nutti
 Author-email: nutti.metro@gmail.com