fake-bpy-module 20241230__py3-none-any.whl → 20250103__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

bpy/types/__init__.pyi CHANGED
@@ -5547,86 +5547,273 @@ print(positions_data)
5547
5547
  This example shows an implementation of USDHook
5548
5548
 
5549
5549
  to extend USD
5550
- export and import functionalty.
5550
+ export and import functionality.
5551
+
5552
+
5553
+ --------------------
5551
5554
 
5552
5555
  One may optionally define any or all of the following callback functions
5553
5556
  in the USDHook
5554
5557
 
5555
5558
  subclass.
5556
5559
 
5557
- Hook function on_export()
5558
5560
 
5559
- is called before the USD export finalizes,
5560
- allowing modifications to the USD stage immediately before it is
5561
- saved. This function takes as an argument an instance of an
5562
- internally defined class USDSceneExportContext
5561
+ --------------------
5563
5562
 
5564
- which provides the
5565
- following accessors to the scene data:
5563
+ Called before the USD export finalizes, allowing modifications to the USD
5564
+ stage immediately before it is saved.
5566
5565
 
5567
- * get_stage()
5566
+ Args:
5568
5567
 
5569
- returns the USD stage to be saved.
5570
- * get_depsgraph()
5568
+ * export_context
5571
5569
 
5572
- returns the Blender scene dependency graph.
5570
+ (USDSceneExportContext): Provides access to the stage and dependency graph
5573
5571
 
5574
- Hook function on_material_export()
5572
+ Returns:
5575
5573
 
5576
- is called for each material that is exported,
5577
- allowing modifications to the USD material, such as shader generation.
5578
- It is called with three arguments:
5574
+ * True
5579
5575
 
5580
- -export_context
5576
+ on success or False
5581
5577
 
5582
- : An instance of the internally defined type USDMaterialExportContext
5578
+ if the operation was bypassed or otherwise failed to complete
5583
5579
 
5584
- .
5585
- -bl_material
5586
5580
 
5587
- : The source Blender material.
5588
- -usd_material
5581
+ --------------------
5589
5582
 
5590
- : The target USD material to be exported.
5583
+ Called for each material that is exported, allowing modifications to the USD material,
5584
+ such as shader generation.
5591
5585
 
5592
- USDMaterialExportContext
5586
+ Args:
5593
5587
 
5594
- implements a get_stage()
5588
+ * export_context
5595
5589
 
5596
- function which returns the
5597
- USD stage to be saved.
5590
+ (USDMaterialExportContext): Provides access to the stage and a texture export utility function
5591
+ * bl_material
5592
+
5593
+ (bpy.types.Material
5594
+
5595
+ ): The source Blender material
5596
+ * usd_material
5597
+
5598
+ (pxr.UsdShade.Material
5599
+
5600
+ ): The target USD material to be exported
5601
+
5602
+ Returns:
5603
+
5604
+ * True
5605
+
5606
+ on success or False
5607
+
5608
+ if the operation was bypassed or otherwise failed to complete
5598
5609
 
5599
5610
  Note that the target USD material might already have connected shaders created by the USD exporter or
5600
5611
  by other material export hooks.
5601
5612
 
5602
- Hook function on_import()
5603
5613
 
5604
- is called after the USD import finalizes. This function takes
5605
- as an argument an instance of an internally defined class USDSceneImportContext
5614
+ --------------------
5615
+
5616
+ Called after the USD import finalizes.
5617
+
5618
+ Args:
5619
+
5620
+ * import_context
5621
+
5622
+ (USDSceneImportContext):
5623
+ Provides access to the stage and a map associating USD prim paths and Blender IDs
5624
+
5625
+ Returns:
5626
+
5627
+ * True
5628
+
5629
+ on success or False
5630
+
5631
+ if the operation was bypassed or otherwise failed to complete
5632
+
5633
+
5634
+ --------------------
5635
+
5636
+ Called to determine if the USDHook
5637
+
5638
+ implementation can convert a given USD material.
5639
+
5640
+ Args:
5641
+
5642
+ * import_context
5643
+
5644
+ (USDMaterialImportContext): Provides access to the stage and a texture import utility function
5645
+ * usd_material
5646
+
5647
+ (pxr.UsdShade.Material
5648
+
5649
+ ): The source USD material to be exported
5650
+
5651
+ Returns:
5652
+
5653
+ * True
5654
+
5655
+ if the hook can convert the material or False
5656
+
5657
+ otherwise
5658
+
5659
+ If any hook returns True
5660
+
5661
+ from material_import_poll
5662
+
5663
+ , the USD importer will skip standard USD Preview Surface
5664
+
5665
+
5666
+ or MaterialX
5667
+
5668
+ import and invoke the hook's on_material_import method to convert the material instead.
5669
+
5670
+
5671
+ --------------------
5672
+
5673
+ Called for each material that is imported, to allow converting the USD material to nodes on the Blender material.
5674
+ To ensure that this function gets called, the hook must also implement the material_import_poll()
5675
+
5676
+
5677
+ callback to return True
5678
+
5679
+ for the given USD material.
5680
+
5681
+ Args:
5682
+
5683
+ * import_context
5684
+
5685
+ (USDMaterialImportContext): Provides access to the stage and a texture import utility function
5686
+ * bl_material
5687
+
5688
+ (bpy.types.Material
5689
+
5690
+ ): The target Blender material with an empty node tree
5691
+ * usd_material
5692
+
5693
+ (pxr.UsdShade.Material
5694
+
5695
+ ): The source USD material to be imported
5696
+
5697
+ Returns:
5698
+
5699
+ * True
5700
+
5701
+ on success or False
5702
+
5703
+ if the conversion failed or otherwise did not complete
5704
+
5705
+
5706
+ --------------------
5707
+
5708
+ Instances of the following built-in classes are provided as arguments to the callbacks.
5709
+
5710
+
5711
+ --------------------
5606
5712
 
5607
- which provides the
5608
- following accessors to the scene data:
5713
+ Argument for on_export.
5714
+
5715
+ Methods:
5716
+
5717
+ * get_stage()
5718
+
5719
+ : returns the USD stage to be saved
5720
+ * get_depsgraph()
5721
+
5722
+ : returns the Blender scene dependency graph
5723
+
5724
+
5725
+ --------------------
5726
+
5727
+ Argument for on_material_export.
5728
+
5729
+ Methods:
5730
+
5731
+ * get_stage()
5732
+
5733
+ : returns the USD stage to be saved
5734
+ * export_texture(image: bpy.types.Image)
5735
+
5736
+ : Returns the USD asset path for the given texture image
5737
+
5738
+ The export_texture
5739
+
5740
+ function will save in-memory images and may copy texture assets,
5741
+ depending on the current USD export options.
5742
+ For example, by default calling export_texture(/foo/bar.png)
5743
+
5744
+ will copy the file to a textures
5745
+
5746
+
5747
+ directory next to the exported USD and will return the relative path ./textures/bar.png
5748
+
5749
+ .
5750
+
5751
+
5752
+ --------------------
5753
+
5754
+ Argument for on_import.
5755
+
5756
+ Methods:
5609
5757
 
5610
5758
  * get_prim_map()
5611
5759
 
5612
- returns a dict where the key is an imported USD Prim path and the value a list of
5613
- the IDs created by the imported prim.
5760
+ returns a dict
5761
+
5762
+ where the key is an imported USD Prim path and the value a list
5614
5763
 
5764
+
5765
+ of the IDs created by the imported prim.
5615
5766
  * get_stage()
5616
5767
 
5617
5768
  returns the USD stage which was imported.
5618
5769
 
5619
- The hook functions should return True
5620
5770
 
5621
- on success or False
5771
+ --------------------
5772
+
5773
+ Argument for material_import_poll and on_material_import.
5774
+
5775
+ Methods:
5776
+
5777
+ * get_stage()
5778
+
5779
+ :
5780
+ returns the USD stage to be saved.
5781
+ * import_texture(asset_path: str)
5782
+
5783
+ :
5784
+ for the given USD texture asset path, returns a tuple[str, bool]
5785
+
5786
+ ,
5787
+ containing the asset's local path and a bool indicating whether the path references a temporary file.
5788
+
5789
+ The import_texture
5790
+
5791
+ function may copy the texture to the local file system if the given asset path is a
5792
+ package-relative path for a USDZ archive, depending on the current USD Import Textures
5622
5793
 
5623
- if the operation was bypassed or
5624
- otherwise failed to complete. Exceptions raised by these functions will be reported in Blender, with
5625
- the exception details printed to the console.
5794
+ options.
5795
+ When the Import Textures
5796
+
5797
+ mode is Packed
5798
+
5799
+ , the texture is saved to a temporary location and the
5800
+ second element of the returned tuple is True
5801
+
5802
+ , indicating that the file is temporary, in which
5803
+ case it may be necessary to pack the image. The original asset path will be returned unchanged if it's
5804
+ already a local file or if it could not be copied to a local destination.
5805
+
5806
+
5807
+ --------------------
5808
+
5809
+ Exceptions raised by these functions will be reported in Blender with the exception details printed to the console.
5810
+
5811
+
5812
+ --------------------
5626
5813
 
5627
5814
  The USDHookExample
5628
5815
 
5629
- class in this example impements the fllowing functions:
5816
+ class in the example below implements the following functions:
5630
5817
 
5631
5818
  * on_export()
5632
5819
 
@@ -5635,10 +5822,24 @@ The USDHookExample
5635
5822
 
5636
5823
  function to create a simple MaterialX
5637
5824
 
5638
- shader on the givne USD material.
5825
+ shader on the given USD material.
5639
5826
  * on_import()
5640
5827
 
5641
5828
  function to create a text object to display the stage's custom layer data.
5829
+ * material_import_poll()
5830
+
5831
+ returns True
5832
+
5833
+ if the given USD material has an mtlx
5834
+
5835
+ context.
5836
+ * on_material_import()
5837
+
5838
+ function to convert a simple MaterialX
5839
+
5840
+ shader with a base_color
5841
+
5842
+ input.
5642
5843
 
5643
5844
  ```../examples/bpy.types.USDHook.py```
5644
5845
 
@@ -157916,20 +158117,20 @@ class Gizmo(bpy_struct):
157916
158117
  :rtype: tuple[float, float]
157917
158118
  """
157918
158119
 
157919
- def target_get_value(self, target: str | None) -> float | tuple[float, int]:
158120
+ def target_get_value(self, target: str | None) -> float | tuple[float, ...]:
157920
158121
  """Get the value of this target property.
157921
158122
 
157922
158123
  :param target: Target property name.
157923
158124
  :type target: str | None
157924
158125
  :return: The value of the target property as a value or array based on the target type.
157925
- :rtype: float | tuple[float, int]
158126
+ :rtype: float | tuple[float, ...]
157926
158127
  """
157927
158128
 
157928
158129
  def target_set_handler(
157929
158130
  self,
157930
158131
  target: str | None,
157931
158132
  get: collections.abc.Callable[float | collections.abc.Sequence[float]] | None,
157932
- set: collections.abc.Callable[[tuple[float, int]], typing.Any] | None,
158133
+ set: collections.abc.Callable[[tuple[float, ...]], typing.Any] | None,
157933
158134
  range: collections.abc.Callable | None = None,
157934
158135
  ):
157935
158136
  """Assigns callbacks to a gizmos property.
@@ -157939,7 +158140,7 @@ class Gizmo(bpy_struct):
157939
158140
  :param get: Function that returns the value for this property (single value or sequence).
157940
158141
  :type get: collections.abc.Callable[float | collections.abc.Sequence[float]] | None
157941
158142
  :param set: Function that takes a single value argument and applies it.
157942
- :type set: collections.abc.Callable[[tuple[float, int]], typing.Any] | None
158143
+ :type set: collections.abc.Callable[[tuple[float, ...]], typing.Any] | None
157943
158144
  :param range: Function that returns a (min, max) tuple for gizmos that use a range. The returned value is not used.
157944
158145
  :type range: collections.abc.Callable | None
157945
158146
  """
@@ -186704,13 +186905,13 @@ expanding an operator into a menu.
186704
186905
  @classmethod
186705
186906
  def poll_message_set(
186706
186907
  cls,
186707
- message: collections.abc.Callable[[typing.Any, int], str | None] | str | None,
186908
+ message: collections.abc.Callable[[typing.Any, ...], str | None] | str | None,
186708
186909
  *args,
186709
186910
  ):
186710
186911
  """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.
186711
186912
 
186712
186913
  :param message: The message or a function that returns the message.
186713
- :type message: collections.abc.Callable[[typing.Any, int], str | None] | str | None
186914
+ :type message: collections.abc.Callable[[typing.Any, ...], str | None] | str | None
186714
186915
  :param args:
186715
186916
  """
186716
186917
 
@@ -208694,8 +208895,8 @@ class Space(bpy_struct):
208694
208895
  @classmethod
208695
208896
  def draw_handler_add(
208696
208897
  cls,
208697
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
208698
- args: tuple[typing.Any, int] | None,
208898
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
208899
+ args: tuple[typing.Any, ...] | None,
208699
208900
  region_type: str | None,
208700
208901
  draw_type: str | None,
208701
208902
  ) -> typing.Any:
@@ -208705,9 +208906,9 @@ class Space(bpy_struct):
208705
208906
 
208706
208907
  :param callback: A function that will be called when the region is drawn.
208707
208908
  It gets the specified arguments as input, it's return value is ignored.
208708
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
208909
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
208709
208910
  :param args: Arguments that will be passed to the callback.
208710
- :type args: tuple[typing.Any, int] | None
208911
+ :type args: tuple[typing.Any, ...] | None
208711
208912
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
208712
208913
  :type region_type: str | None
208713
208914
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209038,8 +209239,8 @@ class SpaceClipEditor(Space, bpy_struct):
209038
209239
  @classmethod
209039
209240
  def draw_handler_add(
209040
209241
  cls,
209041
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
209042
- args: tuple[typing.Any, int] | None,
209242
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
209243
+ args: tuple[typing.Any, ...] | None,
209043
209244
  region_type: str | None,
209044
209245
  draw_type: str | None,
209045
209246
  ) -> typing.Any:
@@ -209049,9 +209250,9 @@ class SpaceClipEditor(Space, bpy_struct):
209049
209250
 
209050
209251
  :param callback: A function that will be called when the region is drawn.
209051
209252
  It gets the specified arguments as input, it's return value is ignored.
209052
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
209253
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
209053
209254
  :param args: Arguments that will be passed to the callback.
209054
- :type args: tuple[typing.Any, int] | None
209255
+ :type args: tuple[typing.Any, ...] | None
209055
209256
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209056
209257
  :type region_type: str | None
209057
209258
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209140,8 +209341,8 @@ class SpaceConsole(Space, bpy_struct):
209140
209341
  @classmethod
209141
209342
  def draw_handler_add(
209142
209343
  cls,
209143
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
209144
- args: tuple[typing.Any, int] | None,
209344
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
209345
+ args: tuple[typing.Any, ...] | None,
209145
209346
  region_type: str | None,
209146
209347
  draw_type: str | None,
209147
209348
  ) -> typing.Any:
@@ -209151,9 +209352,9 @@ class SpaceConsole(Space, bpy_struct):
209151
209352
 
209152
209353
  :param callback: A function that will be called when the region is drawn.
209153
209354
  It gets the specified arguments as input, it's return value is ignored.
209154
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
209355
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
209155
209356
  :param args: Arguments that will be passed to the callback.
209156
- :type args: tuple[typing.Any, int] | None
209357
+ :type args: tuple[typing.Any, ...] | None
209157
209358
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209158
209359
  :type region_type: str | None
209159
209360
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209348,8 +209549,8 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
209348
209549
  @classmethod
209349
209550
  def draw_handler_add(
209350
209551
  cls,
209351
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
209352
- args: tuple[typing.Any, int] | None,
209552
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
209553
+ args: tuple[typing.Any, ...] | None,
209353
209554
  region_type: str | None,
209354
209555
  draw_type: str | None,
209355
209556
  ) -> typing.Any:
@@ -209359,9 +209560,9 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
209359
209560
 
209360
209561
  :param callback: A function that will be called when the region is drawn.
209361
209562
  It gets the specified arguments as input, it's return value is ignored.
209362
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
209563
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
209363
209564
  :param args: Arguments that will be passed to the callback.
209364
- :type args: tuple[typing.Any, int] | None
209565
+ :type args: tuple[typing.Any, ...] | None
209365
209566
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209366
209567
  :type region_type: str | None
209367
209568
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209519,8 +209720,8 @@ class SpaceFileBrowser(Space, bpy_struct):
209519
209720
  @classmethod
209520
209721
  def draw_handler_add(
209521
209722
  cls,
209522
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
209523
- args: tuple[typing.Any, int] | None,
209723
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
209724
+ args: tuple[typing.Any, ...] | None,
209524
209725
  region_type: str | None,
209525
209726
  draw_type: str | None,
209526
209727
  ) -> typing.Any:
@@ -209530,9 +209731,9 @@ class SpaceFileBrowser(Space, bpy_struct):
209530
209731
 
209531
209732
  :param callback: A function that will be called when the region is drawn.
209532
209733
  It gets the specified arguments as input, it's return value is ignored.
209533
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
209734
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
209534
209735
  :param args: Arguments that will be passed to the callback.
209535
- :type args: tuple[typing.Any, int] | None
209736
+ :type args: tuple[typing.Any, ...] | None
209536
209737
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209537
209738
  :type region_type: str | None
209538
209739
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209705,8 +209906,8 @@ class SpaceGraphEditor(Space, bpy_struct):
209705
209906
  @classmethod
209706
209907
  def draw_handler_add(
209707
209908
  cls,
209708
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
209709
- args: tuple[typing.Any, int] | None,
209909
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
209910
+ args: tuple[typing.Any, ...] | None,
209710
209911
  region_type: str | None,
209711
209912
  draw_type: str | None,
209712
209913
  ) -> typing.Any:
@@ -209716,9 +209917,9 @@ class SpaceGraphEditor(Space, bpy_struct):
209716
209917
 
209717
209918
  :param callback: A function that will be called when the region is drawn.
209718
209919
  It gets the specified arguments as input, it's return value is ignored.
209719
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
209920
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
209720
209921
  :param args: Arguments that will be passed to the callback.
209721
- :type args: tuple[typing.Any, int] | None
209922
+ :type args: tuple[typing.Any, ...] | None
209722
209923
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
209723
209924
  :type region_type: str | None
209724
209925
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -209989,8 +210190,8 @@ class SpaceImageEditor(Space, bpy_struct):
209989
210190
  @classmethod
209990
210191
  def draw_handler_add(
209991
210192
  cls,
209992
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
209993
- args: tuple[typing.Any, int] | None,
210193
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
210194
+ args: tuple[typing.Any, ...] | None,
209994
210195
  region_type: str | None,
209995
210196
  draw_type: str | None,
209996
210197
  ) -> typing.Any:
@@ -210000,9 +210201,9 @@ class SpaceImageEditor(Space, bpy_struct):
210000
210201
 
210001
210202
  :param callback: A function that will be called when the region is drawn.
210002
210203
  It gets the specified arguments as input, it's return value is ignored.
210003
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
210204
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210004
210205
  :param args: Arguments that will be passed to the callback.
210005
- :type args: tuple[typing.Any, int] | None
210206
+ :type args: tuple[typing.Any, ...] | None
210006
210207
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210007
210208
  :type region_type: str | None
210008
210209
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210116,8 +210317,8 @@ class SpaceInfo(Space, bpy_struct):
210116
210317
  @classmethod
210117
210318
  def draw_handler_add(
210118
210319
  cls,
210119
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
210120
- args: tuple[typing.Any, int] | None,
210320
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
210321
+ args: tuple[typing.Any, ...] | None,
210121
210322
  region_type: str | None,
210122
210323
  draw_type: str | None,
210123
210324
  ) -> typing.Any:
@@ -210127,9 +210328,9 @@ class SpaceInfo(Space, bpy_struct):
210127
210328
 
210128
210329
  :param callback: A function that will be called when the region is drawn.
210129
210330
  It gets the specified arguments as input, it's return value is ignored.
210130
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
210331
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210131
210332
  :param args: Arguments that will be passed to the callback.
210132
- :type args: tuple[typing.Any, int] | None
210333
+ :type args: tuple[typing.Any, ...] | None
210133
210334
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210134
210335
  :type region_type: str | None
210135
210336
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210230,8 +210431,8 @@ class SpaceNLA(Space, bpy_struct):
210230
210431
  @classmethod
210231
210432
  def draw_handler_add(
210232
210433
  cls,
210233
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
210234
- args: tuple[typing.Any, int] | None,
210434
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
210435
+ args: tuple[typing.Any, ...] | None,
210235
210436
  region_type: str | None,
210236
210437
  draw_type: str | None,
210237
210438
  ) -> typing.Any:
@@ -210241,9 +210442,9 @@ class SpaceNLA(Space, bpy_struct):
210241
210442
 
210242
210443
  :param callback: A function that will be called when the region is drawn.
210243
210444
  It gets the specified arguments as input, it's return value is ignored.
210244
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
210445
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210245
210446
  :param args: Arguments that will be passed to the callback.
210246
- :type args: tuple[typing.Any, int] | None
210447
+ :type args: tuple[typing.Any, ...] | None
210247
210448
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210248
210449
  :type region_type: str | None
210249
210450
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210433,8 +210634,8 @@ class SpaceNodeEditor(Space, bpy_struct):
210433
210634
  @classmethod
210434
210635
  def draw_handler_add(
210435
210636
  cls,
210436
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
210437
- args: tuple[typing.Any, int] | None,
210637
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
210638
+ args: tuple[typing.Any, ...] | None,
210438
210639
  region_type: str | None,
210439
210640
  draw_type: str | None,
210440
210641
  ) -> typing.Any:
@@ -210444,9 +210645,9 @@ class SpaceNodeEditor(Space, bpy_struct):
210444
210645
 
210445
210646
  :param callback: A function that will be called when the region is drawn.
210446
210647
  It gets the specified arguments as input, it's return value is ignored.
210447
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
210648
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210448
210649
  :param args: Arguments that will be passed to the callback.
210449
- :type args: tuple[typing.Any, int] | None
210650
+ :type args: tuple[typing.Any, ...] | None
210450
210651
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210451
210652
  :type region_type: str | None
210452
210653
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210766,8 +210967,8 @@ class SpaceOutliner(Space, bpy_struct):
210766
210967
  @classmethod
210767
210968
  def draw_handler_add(
210768
210969
  cls,
210769
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
210770
- args: tuple[typing.Any, int] | None,
210970
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
210971
+ args: tuple[typing.Any, ...] | None,
210771
210972
  region_type: str | None,
210772
210973
  draw_type: str | None,
210773
210974
  ) -> typing.Any:
@@ -210777,9 +210978,9 @@ class SpaceOutliner(Space, bpy_struct):
210777
210978
 
210778
210979
  :param callback: A function that will be called when the region is drawn.
210779
210980
  It gets the specified arguments as input, it's return value is ignored.
210780
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
210981
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210781
210982
  :param args: Arguments that will be passed to the callback.
210782
- :type args: tuple[typing.Any, int] | None
210983
+ :type args: tuple[typing.Any, ...] | None
210783
210984
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210784
210985
  :type region_type: str | None
210785
210986
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210838,8 +211039,8 @@ class SpacePreferences(Space, bpy_struct):
210838
211039
  @classmethod
210839
211040
  def draw_handler_add(
210840
211041
  cls,
210841
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
210842
- args: tuple[typing.Any, int] | None,
211042
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
211043
+ args: tuple[typing.Any, ...] | None,
210843
211044
  region_type: str | None,
210844
211045
  draw_type: str | None,
210845
211046
  ) -> typing.Any:
@@ -210849,9 +211050,9 @@ class SpacePreferences(Space, bpy_struct):
210849
211050
 
210850
211051
  :param callback: A function that will be called when the region is drawn.
210851
211052
  It gets the specified arguments as input, it's return value is ignored.
210852
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
211053
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210853
211054
  :param args: Arguments that will be passed to the callback.
210854
- :type args: tuple[typing.Any, int] | None
211055
+ :type args: tuple[typing.Any, ...] | None
210855
211056
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210856
211057
  :type region_type: str | None
210857
211058
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -210953,8 +211154,8 @@ class SpaceProperties(Space, bpy_struct):
210953
211154
  @classmethod
210954
211155
  def draw_handler_add(
210955
211156
  cls,
210956
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
210957
- args: tuple[typing.Any, int] | None,
211157
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
211158
+ args: tuple[typing.Any, ...] | None,
210958
211159
  region_type: str | None,
210959
211160
  draw_type: str | None,
210960
211161
  ) -> typing.Any:
@@ -210964,9 +211165,9 @@ class SpaceProperties(Space, bpy_struct):
210964
211165
 
210965
211166
  :param callback: A function that will be called when the region is drawn.
210966
211167
  It gets the specified arguments as input, it's return value is ignored.
210967
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
211168
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
210968
211169
  :param args: Arguments that will be passed to the callback.
210969
- :type args: tuple[typing.Any, int] | None
211170
+ :type args: tuple[typing.Any, ...] | None
210970
211171
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
210971
211172
  :type region_type: str | None
210972
211173
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -211209,8 +211410,8 @@ class SpaceSequenceEditor(Space, bpy_struct):
211209
211410
  @classmethod
211210
211411
  def draw_handler_add(
211211
211412
  cls,
211212
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
211213
- args: tuple[typing.Any, int] | None,
211413
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
211414
+ args: tuple[typing.Any, ...] | None,
211214
211415
  region_type: str | None,
211215
211416
  draw_type: str | None,
211216
211417
  ) -> typing.Any:
@@ -211220,9 +211421,9 @@ class SpaceSequenceEditor(Space, bpy_struct):
211220
211421
 
211221
211422
  :param callback: A function that will be called when the region is drawn.
211222
211423
  It gets the specified arguments as input, it's return value is ignored.
211223
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
211424
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
211224
211425
  :param args: Arguments that will be passed to the callback.
211225
- :type args: tuple[typing.Any, int] | None
211426
+ :type args: tuple[typing.Any, ...] | None
211226
211427
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
211227
211428
  :type region_type: str | None
211228
211429
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -211353,8 +211554,8 @@ class SpaceSpreadsheet(Space, bpy_struct):
211353
211554
  @classmethod
211354
211555
  def draw_handler_add(
211355
211556
  cls,
211356
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
211357
- args: tuple[typing.Any, int] | None,
211557
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
211558
+ args: tuple[typing.Any, ...] | None,
211358
211559
  region_type: str | None,
211359
211560
  draw_type: str | None,
211360
211561
  ) -> typing.Any:
@@ -211364,9 +211565,9 @@ class SpaceSpreadsheet(Space, bpy_struct):
211364
211565
 
211365
211566
  :param callback: A function that will be called when the region is drawn.
211366
211567
  It gets the specified arguments as input, it's return value is ignored.
211367
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
211568
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
211368
211569
  :param args: Arguments that will be passed to the callback.
211369
- :type args: tuple[typing.Any, int] | None
211570
+ :type args: tuple[typing.Any, ...] | None
211370
211571
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
211371
211572
  :type region_type: str | None
211372
211573
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -211553,8 +211754,8 @@ class SpaceTextEditor(Space, bpy_struct):
211553
211754
  @classmethod
211554
211755
  def draw_handler_add(
211555
211756
  cls,
211556
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
211557
- args: tuple[typing.Any, int] | None,
211757
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
211758
+ args: tuple[typing.Any, ...] | None,
211558
211759
  region_type: str | None,
211559
211760
  draw_type: str | None,
211560
211761
  ) -> typing.Any:
@@ -211564,9 +211765,9 @@ class SpaceTextEditor(Space, bpy_struct):
211564
211765
 
211565
211766
  :param callback: A function that will be called when the region is drawn.
211566
211767
  It gets the specified arguments as input, it's return value is ignored.
211567
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
211768
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
211568
211769
  :param args: Arguments that will be passed to the callback.
211569
- :type args: tuple[typing.Any, int] | None
211770
+ :type args: tuple[typing.Any, ...] | None
211570
211771
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
211571
211772
  :type region_type: str | None
211572
211773
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -212258,8 +212459,8 @@ class SpaceView3D(Space, bpy_struct):
212258
212459
  @classmethod
212259
212460
  def draw_handler_add(
212260
212461
  cls,
212261
- callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None,
212262
- args: tuple[typing.Any, int] | None,
212462
+ callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None,
212463
+ args: tuple[typing.Any, ...] | None,
212263
212464
  region_type: str | None,
212264
212465
  draw_type: str | None,
212265
212466
  ) -> typing.Any:
@@ -212269,9 +212470,9 @@ class SpaceView3D(Space, bpy_struct):
212269
212470
 
212270
212471
  :param callback: A function that will be called when the region is drawn.
212271
212472
  It gets the specified arguments as input, it's return value is ignored.
212272
- :type callback: collections.abc.Callable[[typing.Any, int], typing.Any] | None
212473
+ :type callback: collections.abc.Callable[[typing.Any, ...], typing.Any] | None
212273
212474
  :param args: Arguments that will be passed to the callback.
212274
- :type args: tuple[typing.Any, int] | None
212475
+ :type args: tuple[typing.Any, ...] | None
212275
212476
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
212276
212477
  :type region_type: str | None
212277
212478
  :param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
@@ -230397,10 +230598,10 @@ class WindowManager(ID, bpy_struct):
230397
230598
  def draw_cursor_add(
230398
230599
  cls,
230399
230600
  callback: collections.abc.Callable[
230400
- [typing.Any, int, tuple[int, int]], typing.Any
230601
+ [typing.Any, ..., tuple[int, int]], typing.Any
230401
230602
  ]
230402
230603
  | None,
230403
- args: tuple[typing.Any, int] | None,
230604
+ args: tuple[typing.Any, ...] | None,
230404
230605
  space_type: str | None,
230405
230606
  region_type: str | None,
230406
230607
  ) -> typing.Any:
@@ -230410,9 +230611,9 @@ class WindowManager(ID, bpy_struct):
230410
230611
 
230411
230612
  :param callback: A function that will be called when the cursor is drawn.
230412
230613
  It gets the specified arguments as input with the mouse position (tuple) as last argument.
230413
- :type callback: collections.abc.Callable[[typing.Any, int, tuple[int, int]], typing.Any] | None
230614
+ :type callback: collections.abc.Callable[[typing.Any, ..., tuple[int, int]], typing.Any] | None
230414
230615
  :param args: Arguments that will be passed to the callback.
230415
- :type args: tuple[typing.Any, int] | None
230616
+ :type args: tuple[typing.Any, ...] | None
230416
230617
  :param space_type: The space type the callback draws in; for example VIEW_3D. (`bpy.types.Space.type`)
230417
230618
  :type space_type: str | None
230418
230619
  :param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)