fake-bpy-module 20241103__py3-none-any.whl → 20241112__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.
- addon_utils/__init__.pyi +28 -13
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +1 -2
- bl_console_utils/autocomplete/complete_import/__init__.pyi +3 -6
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +1 -2
- bl_console_utils/autocomplete/intellisense/__init__.pyi +2 -6
- bl_operators/image_as_planes/__init__.pyi +12 -39
- bl_operators/uvcalc_transform/__init__.pyi +4 -42
- bl_operators/wm/__init__.pyi +8 -0
- bl_ui/generic_ui_list/__init__.pyi +2 -1
- bl_ui/properties_grease_pencil_common/__init__.pyi +0 -7
- bl_ui/space_userpref/__init__.pyi +2 -2
- blf/__init__.pyi +3 -5
- bmesh/types/__init__.pyi +22 -33
- bmesh/utils/__init__.pyi +6 -16
- bpy/app/icons/__init__.pyi +5 -11
- bpy/app/translations/__init__.pyi +7 -14
- bpy/msgbus/__init__.pyi +7 -8
- bpy/ops/curves/__init__.pyi +16 -0
- bpy/ops/nla/__init__.pyi +1 -1
- bpy/ops/sequencer/__init__.pyi +3 -0
- bpy/path/__init__.pyi +6 -16
- bpy/props/__init__.pyi +122 -135
- bpy/types/__init__.pyi +418 -615
- bpy/typing/__init__.pyi +1 -1
- bpy/utils/__init__.pyi +30 -29
- bpy/utils/previews/__init__.pyi +1 -2
- bpy/utils/units/__init__.pyi +1 -2
- bpy_extras/anim_utils/__init__.pyi +5 -12
- bpy_extras/bmesh_utils/__init__.pyi +1 -2
- bpy_extras/image_utils/__init__.pyi +2 -5
- bpy_extras/io_utils/__init__.pyi +8 -14
- bpy_extras/mesh_utils/__init__.pyi +14 -29
- bpy_extras/object_utils/__init__.pyi +1 -1
- bpy_extras/view3d_utils/__init__.pyi +3 -10
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/METADATA +1 -1
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/RECORD +57 -57
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/WHEEL +1 -1
- freestyle/chainingiterators/__init__.pyi +2 -7
- freestyle/functions/__init__.pyi +4 -16
- freestyle/types/__init__.pyi +29 -63
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +1 -2
- gpu/__init__.pyi +19 -5
- gpu/matrix/__init__.pyi +2 -2
- gpu/state/__init__.pyi +16 -8
- gpu/types/__init__.pyi +14 -29
- gpu_extras/batch/__init__.pyi +9 -9
- gpu_extras/presets/__init__.pyi +4 -11
- idprop/types/__init__.pyi +1 -2
- imbuf/__init__.pyi +2 -4
- mathutils/__init__.pyi +30 -95
- mathutils/bvhtree/__init__.pyi +13 -17
- mathutils/geometry/__init__.pyi +26 -45
- mathutils/interpolate/__init__.pyi +2 -2
- mathutils/kdtree/__init__.pyi +13 -28
- rna_info/__init__.pyi +1 -2
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/top_level.txt +0 -0
bpy/types/__init__.pyi
CHANGED
|
@@ -10526,7 +10526,6 @@ The USDHookExample
|
|
|
10526
10526
|
|
|
10527
10527
|
--------------------
|
|
10528
10528
|
|
|
10529
|
-
* bpy.context.active_gpencil_frame
|
|
10530
10529
|
* GreasePencilv3.layers
|
|
10531
10530
|
* GreasePencilv3Layers.active
|
|
10532
10531
|
* GreasePencilv3Layers.move
|
|
@@ -35695,8 +35694,6 @@ Executing the operator will then print all values.
|
|
|
35695
35694
|
--------------------
|
|
35696
35695
|
|
|
35697
35696
|
* bpy.context.active_annotation_layer
|
|
35698
|
-
* bpy.context.active_gpencil_layer
|
|
35699
|
-
* bpy.context.visible_gpencil_layers
|
|
35700
35697
|
* GreasePencil.layers
|
|
35701
35698
|
* GreasePencilLayers.new
|
|
35702
35699
|
* GreasePencilLayers.remove
|
|
@@ -52833,7 +52830,6 @@ at its creation, all editing in the original image's buffer is 'lost' in its cop
|
|
|
52833
52830
|
|
|
52834
52831
|
* bpy.context.annotation_data
|
|
52835
52832
|
* bpy.context.gpencil
|
|
52836
|
-
* bpy.context.gpencil_data
|
|
52837
52833
|
* BlendData.grease_pencils
|
|
52838
52834
|
* BlendDataGreasePencils.new
|
|
52839
52835
|
* BlendDataGreasePencils.remove
|
|
@@ -73931,7 +73927,6 @@ Menu.poll function.
|
|
|
73931
73927
|
--------------------
|
|
73932
73928
|
|
|
73933
73929
|
* bpy.context.annotation_data_owner
|
|
73934
|
-
* bpy.context.gpencil_data_owner
|
|
73935
73930
|
* bpy.context.id
|
|
73936
73931
|
* bpy.context.selected_ids
|
|
73937
73932
|
* bpy.context.texture_user
|
|
@@ -80874,11 +80869,7 @@ The function should return {'FINISHED'}
|
|
|
80874
80869
|
|
|
80875
80870
|
, the latter
|
|
80876
80871
|
meaning that operator execution was aborted without making any changes, and
|
|
80877
|
-
|
|
80878
|
-
have already been made, use the {'FINISHED'}
|
|
80879
|
-
|
|
80880
|
-
return code, or the behavior
|
|
80881
|
-
of undo will be confusing for the user.
|
|
80872
|
+
that no undo step will created (see next example for more info about undo).
|
|
80882
80873
|
|
|
80883
80874
|
[NOTE]
|
|
80884
80875
|
Operator subclasses must be registered before accessing them from blender.
|
|
@@ -80886,6 +80877,52 @@ Operator subclasses must be registered before accessing them from blender.
|
|
|
80886
80877
|
```../examples/bpy.types.Operator.py```
|
|
80887
80878
|
|
|
80888
80879
|
|
|
80880
|
+
--------------------
|
|
80881
|
+
|
|
80882
|
+
Any operator modifying Blender data should enable the 'UNDO'
|
|
80883
|
+
|
|
80884
|
+
option.
|
|
80885
|
+
This will make Blender automatically create an undo step when the operator
|
|
80886
|
+
finishes its execute
|
|
80887
|
+
|
|
80888
|
+
(or invoke
|
|
80889
|
+
|
|
80890
|
+
, see below) functions, and returns
|
|
80891
|
+
{'FINISHED'}
|
|
80892
|
+
|
|
80893
|
+
.
|
|
80894
|
+
|
|
80895
|
+
Otherwise, no undo step will be created, which will at best corrupt the
|
|
80896
|
+
undo stack and confuse the user (since modifications done by the operator
|
|
80897
|
+
may either not be undoable, or be undone together with other edits done
|
|
80898
|
+
before). In many cases, this can even lead to data corruption and crashes.
|
|
80899
|
+
|
|
80900
|
+
Note that when an operator returns {'CANCELLED'}
|
|
80901
|
+
|
|
80902
|
+
, no undo step will be
|
|
80903
|
+
created. This means that if an error occurs *after* modifying some data
|
|
80904
|
+
already, it is better to return {'FINISHED'}
|
|
80905
|
+
|
|
80906
|
+
, unless it is possible to
|
|
80907
|
+
fully undo the changes before returning.
|
|
80908
|
+
|
|
80909
|
+
[NOTE]
|
|
80910
|
+
Most examples in this page do not do any edit to Blender data, which is
|
|
80911
|
+
why it is safe to keep the default bl_options
|
|
80912
|
+
|
|
80913
|
+
value for these operators.
|
|
80914
|
+
|
|
80915
|
+
[NOTE]
|
|
80916
|
+
In some complex cases, the automatic undo step created on operator exit may
|
|
80917
|
+
not be enough. For example, if the operator does mode switching, or calls
|
|
80918
|
+
other operators that should create an extra undo step, etc.
|
|
80919
|
+
Such manual undo push is possible using the bpy.ops.ed.undo_push
|
|
80920
|
+
function. Be careful though, this is considered an advanced feature and
|
|
80921
|
+
requires some understanding of the actual undo system in Blender code.
|
|
80922
|
+
|
|
80923
|
+
```../examples/bpy.types.Operator.1.py```
|
|
80924
|
+
|
|
80925
|
+
|
|
80889
80926
|
--------------------
|
|
80890
80927
|
|
|
80891
80928
|
Operator.invoke is used to initialize the operator from the context
|
|
@@ -80904,7 +80941,7 @@ to typical class properties because blender registers them with the
|
|
|
80904
80941
|
operator, to use as arguments when called, saved for operator undo/redo and
|
|
80905
80942
|
automatically added into the user interface.
|
|
80906
80943
|
|
|
80907
|
-
```../examples/bpy.types.Operator.
|
|
80944
|
+
```../examples/bpy.types.Operator.2.py```
|
|
80908
80945
|
|
|
80909
80946
|
|
|
80910
80947
|
--------------------
|
|
@@ -80923,14 +80960,14 @@ user confirms.
|
|
|
80923
80960
|
The Operator.poll function is optional, used to check if the operator
|
|
80924
80961
|
can run.
|
|
80925
80962
|
|
|
80926
|
-
```../examples/bpy.types.Operator.
|
|
80963
|
+
```../examples/bpy.types.Operator.3.py```
|
|
80927
80964
|
|
|
80928
80965
|
|
|
80929
80966
|
--------------------
|
|
80930
80967
|
|
|
80931
80968
|
This operator uses its Operator.invoke function to call a popup.
|
|
80932
80969
|
|
|
80933
|
-
```../examples/bpy.types.Operator.
|
|
80970
|
+
```../examples/bpy.types.Operator.4.py```
|
|
80934
80971
|
|
|
80935
80972
|
|
|
80936
80973
|
--------------------
|
|
@@ -80942,7 +80979,7 @@ Operator.draw function.
|
|
|
80942
80979
|
This works like the Panel and Menu draw functions, its used
|
|
80943
80980
|
for dialogs and file selectors.
|
|
80944
80981
|
|
|
80945
|
-
```../examples/bpy.types.Operator.
|
|
80982
|
+
```../examples/bpy.types.Operator.5.py```
|
|
80946
80983
|
|
|
80947
80984
|
|
|
80948
80985
|
--------------------
|
|
@@ -80973,7 +81010,7 @@ Notice __init__()
|
|
|
80973
81010
|
For other operator types they are not useful but for modal operators they will
|
|
80974
81011
|
be called before the Operator.invoke and after the operator finishes.
|
|
80975
81012
|
|
|
80976
|
-
```../examples/bpy.types.Operator.
|
|
81013
|
+
```../examples/bpy.types.Operator.6.py```
|
|
80977
81014
|
|
|
80978
81015
|
|
|
80979
81016
|
--------------------
|
|
@@ -80981,7 +81018,7 @@ be called before the Operator.invoke and after the operator finishes.
|
|
|
80981
81018
|
You may want to have an operator prompt the user to select an item
|
|
80982
81019
|
from a search field, this can be done using bpy.types.Operator.invoke_search_popup.
|
|
80983
81020
|
|
|
80984
|
-
```../examples/bpy.types.Operator.
|
|
81021
|
+
```../examples/bpy.types.Operator.7.py```
|
|
80985
81022
|
|
|
80986
81023
|
|
|
80987
81024
|
--------------------
|
|
@@ -102040,19 +102077,18 @@ class bpy_prop_collection[_GenericType1]:
|
|
|
102040
102077
|
:rtype: list[tuple[str, _GenericType1]]
|
|
102041
102078
|
"""
|
|
102042
102079
|
|
|
102043
|
-
def keys(self)
|
|
102080
|
+
def keys(self):
|
|
102044
102081
|
"""Return the identifiers of collection members
|
|
102045
102082
|
(matching Python's dict.keys() functionality).
|
|
102046
102083
|
|
|
102047
102084
|
:return: the identifiers for each member of this collection.
|
|
102048
|
-
:rtype: list[str]
|
|
102049
102085
|
"""
|
|
102050
102086
|
|
|
102051
102087
|
def values(self) -> list[_GenericType1 | None]:
|
|
102052
102088
|
"""Return the values of collection
|
|
102053
102089
|
(matching Python's dict.values() functionality).
|
|
102054
102090
|
|
|
102055
|
-
:return:
|
|
102091
|
+
:return: The members of this collection.
|
|
102056
102092
|
:rtype: list[_GenericType1 | None]
|
|
102057
102093
|
"""
|
|
102058
102094
|
|
|
@@ -102154,15 +102190,14 @@ class bpy_struct[_GenericType1]:
|
|
|
102154
102190
|
:rtype: int
|
|
102155
102191
|
"""
|
|
102156
102192
|
|
|
102157
|
-
def driver_add(self, path: str | None, index: int | None = -1)
|
|
102193
|
+
def driver_add(self, path: str | None, index: int | None = -1):
|
|
102158
102194
|
"""Adds driver(s) to the given property
|
|
102159
102195
|
|
|
102160
102196
|
:param path: path to the property to drive, analogous to the fcurve's data path.
|
|
102161
102197
|
:type path: str | None
|
|
102162
102198
|
:param index: array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array.
|
|
102163
102199
|
:type index: int | None
|
|
102164
|
-
:return: The driver
|
|
102165
|
-
:rtype: FCurve
|
|
102200
|
+
:return: The driver added or a list of drivers when index is -1.
|
|
102166
102201
|
"""
|
|
102167
102202
|
|
|
102168
102203
|
def driver_remove(self, path: str | None, index: int | None = -1) -> bool:
|
|
@@ -102279,7 +102314,7 @@ class bpy_struct[_GenericType1]:
|
|
|
102279
102314
|
index: int | None = -1,
|
|
102280
102315
|
frame: float | None = bpy.context.scene.frame_current,
|
|
102281
102316
|
group: str | None = "",
|
|
102282
|
-
options
|
|
102317
|
+
options=set(),
|
|
102283
102318
|
keytype: str | None = "KEYFRAME",
|
|
102284
102319
|
) -> bool:
|
|
102285
102320
|
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.This is the most simple example of inserting a keyframe from python.Note that when keying data paths which contain nested properties this must be
|
|
@@ -102308,7 +102343,6 @@ class bpy_struct[_GenericType1]:
|
|
|
102308
102343
|
INSERTKEY_AVAILABLE Only insert into already existing F-Curves.
|
|
102309
102344
|
|
|
102310
102345
|
INSERTKEY_CYCLE_AWARE Take cyclic extrapolation into account (Cycle-Aware Keying option).
|
|
102311
|
-
:type options: set | None
|
|
102312
102346
|
:param keytype: Type of the key: 'KEYFRAME', 'BREAKDOWN', 'MOVING_HOLD', 'EXTREME', 'JITTER', or 'GENERATED'
|
|
102313
102347
|
:type keytype: str | None
|
|
102314
102348
|
:return: Success of keyframe insertion.
|
|
@@ -102369,11 +102403,12 @@ class bpy_struct[_GenericType1]:
|
|
|
102369
102403
|
:param property:
|
|
102370
102404
|
"""
|
|
102371
102405
|
|
|
102372
|
-
def type_recast(self):
|
|
102406
|
+
def type_recast(self) -> typing_extensions.Self:
|
|
102373
102407
|
"""Return a new instance, this is needed because types
|
|
102374
102408
|
such as textures can be changed at runtime.
|
|
102375
102409
|
|
|
102376
102410
|
:return: a new instance of this object with the type initialized again.
|
|
102411
|
+
:rtype: typing_extensions.Self
|
|
102377
102412
|
"""
|
|
102378
102413
|
|
|
102379
102414
|
def values(self) -> idprop.types.IDPropertyGroupViewValues:
|
|
@@ -102556,7 +102591,7 @@ class AOVs(bpy_prop_collection[AOV], bpy_struct):
|
|
|
102556
102591
|
class ActionChannelBagFCurves(bpy_prop_collection[FCurve], bpy_struct):
|
|
102557
102592
|
"""Collection of F-Curves for a specific action slot, on a specific strip"""
|
|
102558
102593
|
|
|
102559
|
-
def new(self, data_path: str, index: int | None = 0) -> FCurve:
|
|
102594
|
+
def new(self, data_path: str, *, index: int | None = 0) -> FCurve:
|
|
102560
102595
|
"""Add an F-Curve to the channelbag
|
|
102561
102596
|
|
|
102562
102597
|
:param data_path: Data Path, F-Curve data path to use
|
|
@@ -102567,7 +102602,7 @@ class ActionChannelBagFCurves(bpy_prop_collection[FCurve], bpy_struct):
|
|
|
102567
102602
|
:rtype: FCurve
|
|
102568
102603
|
"""
|
|
102569
102604
|
|
|
102570
|
-
def find(self, data_path: str, index: int | None = 0) -> FCurve:
|
|
102605
|
+
def find(self, data_path: str, *, index: int | None = 0) -> FCurve:
|
|
102571
102606
|
"""Find an F-Curve. Note that this function performs a linear scan of all F-Curves in the channelbag.
|
|
102572
102607
|
|
|
102573
102608
|
:param data_path: Data Path, F-Curve data path
|
|
@@ -102696,7 +102731,7 @@ class ActionFCurves(bpy_prop_collection[FCurve], bpy_struct):
|
|
|
102696
102731
|
"""Collection of action F-Curves"""
|
|
102697
102732
|
|
|
102698
102733
|
def new(
|
|
102699
|
-
self, data_path: str, index: int | None = 0, action_group: str = ""
|
|
102734
|
+
self, data_path: str, *, index: int | None = 0, action_group: str = ""
|
|
102700
102735
|
) -> FCurve:
|
|
102701
102736
|
"""Add an F-Curve to the action
|
|
102702
102737
|
|
|
@@ -102710,7 +102745,7 @@ class ActionFCurves(bpy_prop_collection[FCurve], bpy_struct):
|
|
|
102710
102745
|
:rtype: FCurve
|
|
102711
102746
|
"""
|
|
102712
102747
|
|
|
102713
|
-
def find(self, data_path: str, index: int | None = 0) -> FCurve:
|
|
102748
|
+
def find(self, data_path: str, *, index: int | None = 0) -> FCurve:
|
|
102714
102749
|
"""Find an F-Curve. Note that this function performs a linear scan of all F-Curves in the action.
|
|
102715
102750
|
|
|
102716
102751
|
:param data_path: Data Path, F-Curve data path
|
|
@@ -102897,7 +102932,7 @@ class ActionSlots(bpy_prop_collection[ActionSlot], bpy_struct):
|
|
|
102897
102932
|
:type: ActionSlot | None
|
|
102898
102933
|
"""
|
|
102899
102934
|
|
|
102900
|
-
def new(self, for_id: ID | None = None) -> ActionSlot:
|
|
102935
|
+
def new(self, *, for_id: ID | None = None) -> ActionSlot:
|
|
102901
102936
|
"""Add a slot to the Action
|
|
102902
102937
|
|
|
102903
102938
|
:param for_id: Data-Block, If given, the new slot will be named after this data-block, and limited to animating data-blocks of its type. If ommitted, limiting the ID type will happen as soon as the slot is assigned.
|
|
@@ -102938,7 +102973,9 @@ class ActionSlots(bpy_prop_collection[ActionSlot], bpy_struct):
|
|
|
102938
102973
|
class ActionStrips(bpy_prop_collection[ActionStrip], bpy_struct):
|
|
102939
102974
|
"""Collection of animation strips"""
|
|
102940
102975
|
|
|
102941
|
-
def new(
|
|
102976
|
+
def new(
|
|
102977
|
+
self, *, type: typing.Literal["KEYFRAME"] | None = "KEYFRAME"
|
|
102978
|
+
) -> ActionStrip:
|
|
102942
102979
|
"""Add a new strip to the layer. Currently a layer can only have one strip, with infinite boundaries.
|
|
102943
102980
|
|
|
102944
102981
|
:param type: Type, The type of strip to create
|
|
@@ -103023,7 +103060,7 @@ class Addons(bpy_prop_collection[Addon], bpy_struct):
|
|
|
103023
103060
|
class AnimDataDrivers(bpy_prop_collection[FCurve], bpy_struct):
|
|
103024
103061
|
"""Collection of Driver F-Curves"""
|
|
103025
103062
|
|
|
103026
|
-
def new(self, data_path: str, index: int | None = 0) -> FCurve:
|
|
103063
|
+
def new(self, data_path: str, *, index: int | None = 0) -> FCurve:
|
|
103027
103064
|
"""new
|
|
103028
103065
|
|
|
103029
103066
|
:param data_path: Data Path, F-Curve data path to use
|
|
@@ -103041,7 +103078,7 @@ class AnimDataDrivers(bpy_prop_collection[FCurve], bpy_struct):
|
|
|
103041
103078
|
:type driver: FCurve
|
|
103042
103079
|
"""
|
|
103043
103080
|
|
|
103044
|
-
def from_existing(self, src_driver: FCurve | None = None) -> FCurve:
|
|
103081
|
+
def from_existing(self, *, src_driver: FCurve | None = None) -> FCurve:
|
|
103045
103082
|
"""Add a new driver given an existing one
|
|
103046
103083
|
|
|
103047
103084
|
:param src_driver: Existing Driver F-Curve to use as template for a new one
|
|
@@ -103050,7 +103087,7 @@ class AnimDataDrivers(bpy_prop_collection[FCurve], bpy_struct):
|
|
|
103050
103087
|
:rtype: FCurve
|
|
103051
103088
|
"""
|
|
103052
103089
|
|
|
103053
|
-
def find(self, data_path: str, index: int | None = 0) -> FCurve:
|
|
103090
|
+
def find(self, data_path: str, *, index: int | None = 0) -> FCurve:
|
|
103054
103091
|
"""Find a driver F-Curve. Note that this function performs a linear scan of all driver F-Curves.
|
|
103055
103092
|
|
|
103056
103093
|
:param data_path: Data Path, F-Curve data path
|
|
@@ -103238,7 +103275,7 @@ class AssetLibraryCollection(bpy_prop_collection[UserAssetLibrary], bpy_struct):
|
|
|
103238
103275
|
"""Collection of user asset libraries"""
|
|
103239
103276
|
|
|
103240
103277
|
@classmethod
|
|
103241
|
-
def new(cls, name: str = "", directory: str = "") -> UserAssetLibrary:
|
|
103278
|
+
def new(cls, *, name: str = "", directory: str = "") -> UserAssetLibrary:
|
|
103242
103279
|
"""Add a new Asset Library
|
|
103243
103280
|
|
|
103244
103281
|
:param name: Name
|
|
@@ -103282,7 +103319,7 @@ class AssetLibraryCollection(bpy_prop_collection[UserAssetLibrary], bpy_struct):
|
|
|
103282
103319
|
class AssetTags(bpy_prop_collection[AssetTag], bpy_struct):
|
|
103283
103320
|
"""Collection of custom asset tags"""
|
|
103284
103321
|
|
|
103285
|
-
def new(self, name: str, skip_if_exists: bool | None = False) -> AssetTag:
|
|
103322
|
+
def new(self, name: str, *, skip_if_exists: bool | None = False) -> AssetTag:
|
|
103286
103323
|
"""Add a new tag to this asset
|
|
103287
103324
|
|
|
103288
103325
|
:param name: Name
|
|
@@ -103722,6 +103759,7 @@ class BlendDataActions(bpy_prop_collection[Action], bpy_struct):
|
|
|
103722
103759
|
def remove(
|
|
103723
103760
|
self,
|
|
103724
103761
|
action: Action,
|
|
103762
|
+
*,
|
|
103725
103763
|
do_unlink: bool | None = True,
|
|
103726
103764
|
do_id_user: bool | None = True,
|
|
103727
103765
|
do_ui_user: bool | None = True,
|
|
@@ -103782,6 +103820,7 @@ class BlendDataArmatures(bpy_prop_collection[Armature], bpy_struct):
|
|
|
103782
103820
|
def remove(
|
|
103783
103821
|
self,
|
|
103784
103822
|
armature: Armature,
|
|
103823
|
+
*,
|
|
103785
103824
|
do_unlink: bool | None = True,
|
|
103786
103825
|
do_id_user: bool | None = True,
|
|
103787
103826
|
do_ui_user: bool | None = True,
|
|
@@ -103831,7 +103870,7 @@ class BlendDataBrushes(bpy_prop_collection[Brush], bpy_struct):
|
|
|
103831
103870
|
"""Collection of brushes"""
|
|
103832
103871
|
|
|
103833
103872
|
def new(
|
|
103834
|
-
self, name: str, mode: bpy.typing.ObjectModeItems | None = "TEXTURE_PAINT"
|
|
103873
|
+
self, name: str, *, mode: bpy.typing.ObjectModeItems | None = "TEXTURE_PAINT"
|
|
103835
103874
|
) -> Brush:
|
|
103836
103875
|
"""Add a new brush to the main database
|
|
103837
103876
|
|
|
@@ -103846,6 +103885,7 @@ class BlendDataBrushes(bpy_prop_collection[Brush], bpy_struct):
|
|
|
103846
103885
|
def remove(
|
|
103847
103886
|
self,
|
|
103848
103887
|
brush: Brush,
|
|
103888
|
+
*,
|
|
103849
103889
|
do_unlink: bool | None = True,
|
|
103850
103890
|
do_id_user: bool | None = True,
|
|
103851
103891
|
do_ui_user: bool | None = True,
|
|
@@ -103945,6 +103985,7 @@ class BlendDataCameras(bpy_prop_collection[Camera], bpy_struct):
|
|
|
103945
103985
|
def remove(
|
|
103946
103986
|
self,
|
|
103947
103987
|
camera: Camera,
|
|
103988
|
+
*,
|
|
103948
103989
|
do_unlink: bool | None = True,
|
|
103949
103990
|
do_id_user: bool | None = True,
|
|
103950
103991
|
do_ui_user: bool | None = True,
|
|
@@ -104005,6 +104046,7 @@ class BlendDataCollections(bpy_prop_collection[Collection], bpy_struct):
|
|
|
104005
104046
|
def remove(
|
|
104006
104047
|
self,
|
|
104007
104048
|
collection: Collection,
|
|
104049
|
+
*,
|
|
104008
104050
|
do_unlink: bool | None = True,
|
|
104009
104051
|
do_id_user: bool | None = True,
|
|
104010
104052
|
do_ui_user: bool | None = True,
|
|
@@ -104067,6 +104109,7 @@ class BlendDataCurves(bpy_prop_collection[Curve], bpy_struct):
|
|
|
104067
104109
|
def remove(
|
|
104068
104110
|
self,
|
|
104069
104111
|
curve: Curve,
|
|
104112
|
+
*,
|
|
104070
104113
|
do_unlink: bool | None = True,
|
|
104071
104114
|
do_id_user: bool | None = True,
|
|
104072
104115
|
do_ui_user: bool | None = True,
|
|
@@ -104115,7 +104158,7 @@ class BlendDataCurves(bpy_prop_collection[Curve], bpy_struct):
|
|
|
104115
104158
|
class BlendDataFonts(bpy_prop_collection[VectorFont], bpy_struct):
|
|
104116
104159
|
"""Collection of fonts"""
|
|
104117
104160
|
|
|
104118
|
-
def load(self, filepath: str, check_existing: bool | None = False) -> VectorFont:
|
|
104161
|
+
def load(self, filepath: str, *, check_existing: bool | None = False) -> VectorFont:
|
|
104119
104162
|
"""Load a new font into the main database
|
|
104120
104163
|
|
|
104121
104164
|
:param filepath: path of the font to load
|
|
@@ -104129,6 +104172,7 @@ class BlendDataFonts(bpy_prop_collection[VectorFont], bpy_struct):
|
|
|
104129
104172
|
def remove(
|
|
104130
104173
|
self,
|
|
104131
104174
|
vfont: VectorFont,
|
|
104175
|
+
*,
|
|
104132
104176
|
do_unlink: bool | None = True,
|
|
104133
104177
|
do_id_user: bool | None = True,
|
|
104134
104178
|
do_ui_user: bool | None = True,
|
|
@@ -104196,6 +104240,7 @@ class BlendDataGreasePencils(bpy_prop_collection[GreasePencil], bpy_struct):
|
|
|
104196
104240
|
def remove(
|
|
104197
104241
|
self,
|
|
104198
104242
|
grease_pencil: GreasePencil,
|
|
104243
|
+
*,
|
|
104199
104244
|
do_unlink: bool | None = True,
|
|
104200
104245
|
do_id_user: bool | None = True,
|
|
104201
104246
|
do_ui_user: bool | None = True,
|
|
@@ -104256,6 +104301,7 @@ class BlendDataGreasePencilsV3(bpy_prop_collection[GreasePencilv3], bpy_struct):
|
|
|
104256
104301
|
def remove(
|
|
104257
104302
|
self,
|
|
104258
104303
|
grease_pencil: GreasePencilv3,
|
|
104304
|
+
*,
|
|
104259
104305
|
do_unlink: bool | None = True,
|
|
104260
104306
|
do_id_user: bool | None = True,
|
|
104261
104307
|
do_ui_user: bool | None = True,
|
|
@@ -104309,6 +104355,7 @@ class BlendDataHairCurves(bpy_prop_collection[Curves], bpy_struct):
|
|
|
104309
104355
|
def remove(
|
|
104310
104356
|
self,
|
|
104311
104357
|
curves: Curves,
|
|
104358
|
+
*,
|
|
104312
104359
|
do_unlink: bool | None = True,
|
|
104313
104360
|
do_id_user: bool | None = True,
|
|
104314
104361
|
do_ui_user: bool | None = True,
|
|
@@ -104362,6 +104409,7 @@ class BlendDataImages(bpy_prop_collection[Image], bpy_struct):
|
|
|
104362
104409
|
name: str,
|
|
104363
104410
|
width: int | None,
|
|
104364
104411
|
height: int | None,
|
|
104412
|
+
*,
|
|
104365
104413
|
alpha: bool | None = False,
|
|
104366
104414
|
float_buffer: bool | None = False,
|
|
104367
104415
|
stereo3d: bool | None = False,
|
|
@@ -104390,7 +104438,7 @@ class BlendDataImages(bpy_prop_collection[Image], bpy_struct):
|
|
|
104390
104438
|
:rtype: Image
|
|
104391
104439
|
"""
|
|
104392
104440
|
|
|
104393
|
-
def load(self, filepath: str, check_existing: bool | None = False) -> Image:
|
|
104441
|
+
def load(self, filepath: str, *, check_existing: bool | None = False) -> Image:
|
|
104394
104442
|
"""Load a new image into the main database
|
|
104395
104443
|
|
|
104396
104444
|
:param filepath: Path of the file to load
|
|
@@ -104404,6 +104452,7 @@ class BlendDataImages(bpy_prop_collection[Image], bpy_struct):
|
|
|
104404
104452
|
def remove(
|
|
104405
104453
|
self,
|
|
104406
104454
|
image: Image,
|
|
104455
|
+
*,
|
|
104407
104456
|
do_unlink: bool | None = True,
|
|
104408
104457
|
do_id_user: bool | None = True,
|
|
104409
104458
|
do_ui_user: bool | None = True,
|
|
@@ -104464,6 +104513,7 @@ class BlendDataLattices(bpy_prop_collection[Lattice], bpy_struct):
|
|
|
104464
104513
|
def remove(
|
|
104465
104514
|
self,
|
|
104466
104515
|
lattice: Lattice,
|
|
104516
|
+
*,
|
|
104467
104517
|
do_unlink: bool | None = True,
|
|
104468
104518
|
do_id_user: bool | None = True,
|
|
104469
104519
|
do_ui_user: bool | None = True,
|
|
@@ -104522,6 +104572,7 @@ class BlendDataLibraries(bpy_prop_collection[Library], bpy_struct):
|
|
|
104522
104572
|
def remove(
|
|
104523
104573
|
self,
|
|
104524
104574
|
library: Library,
|
|
104575
|
+
*,
|
|
104525
104576
|
do_unlink: bool | None = True,
|
|
104526
104577
|
do_id_user: bool | None = True,
|
|
104527
104578
|
do_ui_user: bool | None = True,
|
|
@@ -104562,7 +104613,7 @@ class BlendDataLibraries(bpy_prop_collection[Library], bpy_struct):
|
|
|
104562
104613
|
|
|
104563
104614
|
def load(
|
|
104564
104615
|
self,
|
|
104565
|
-
filepath
|
|
104616
|
+
filepath,
|
|
104566
104617
|
link: bool | None = False,
|
|
104567
104618
|
relative: bool | None = False,
|
|
104568
104619
|
assets_only: bool | None = False,
|
|
@@ -104574,7 +104625,6 @@ class BlendDataLibraries(bpy_prop_collection[Library], bpy_struct):
|
|
|
104574
104625
|
Each object has attributes matching bpy.data which are lists of strings to be linked.
|
|
104575
104626
|
|
|
104576
104627
|
:param filepath: The path to a blend file.
|
|
104577
|
-
:type filepath: bytes | str | None
|
|
104578
104628
|
:param link: When False reference to the original file is lost.
|
|
104579
104629
|
:type link: bool | None
|
|
104580
104630
|
:param relative: When True the path is stored relative to the open blend file.
|
|
@@ -104594,8 +104644,8 @@ class BlendDataLibraries(bpy_prop_collection[Library], bpy_struct):
|
|
|
104594
104644
|
|
|
104595
104645
|
def write(
|
|
104596
104646
|
self,
|
|
104597
|
-
filepath
|
|
104598
|
-
datablocks
|
|
104647
|
+
filepath,
|
|
104648
|
+
datablocks,
|
|
104599
104649
|
path_remap: str | None = False,
|
|
104600
104650
|
fake_user: bool | None = False,
|
|
104601
104651
|
compress: bool | None = False,
|
|
@@ -104603,9 +104653,7 @@ class BlendDataLibraries(bpy_prop_collection[Library], bpy_struct):
|
|
|
104603
104653
|
"""Write data-blocks into a blend file.
|
|
104604
104654
|
|
|
104605
104655
|
:param filepath: The path to write the blend-file.
|
|
104606
|
-
:
|
|
104607
|
-
:param datablocks: set of data-blocks (`bpy.types.ID` instances).
|
|
104608
|
-
:type datablocks: set | None
|
|
104656
|
+
:param datablocks: set of data-blocks.
|
|
104609
104657
|
:param path_remap: Optionally remap paths when writing the file:
|
|
104610
104658
|
|
|
104611
104659
|
NONE No path manipulation (default).
|
|
@@ -104639,6 +104687,7 @@ class BlendDataLights(bpy_prop_collection[Light], bpy_struct):
|
|
|
104639
104687
|
def remove(
|
|
104640
104688
|
self,
|
|
104641
104689
|
light: Light,
|
|
104690
|
+
*,
|
|
104642
104691
|
do_unlink: bool | None = True,
|
|
104643
104692
|
do_id_user: bool | None = True,
|
|
104644
104693
|
do_ui_user: bool | None = True,
|
|
@@ -104706,6 +104755,7 @@ class BlendDataLineStyles(bpy_prop_collection[FreestyleLineStyle], bpy_struct):
|
|
|
104706
104755
|
def remove(
|
|
104707
104756
|
self,
|
|
104708
104757
|
linestyle: FreestyleLineStyle,
|
|
104758
|
+
*,
|
|
104709
104759
|
do_unlink: bool | None = True,
|
|
104710
104760
|
do_id_user: bool | None = True,
|
|
104711
104761
|
do_ui_user: bool | None = True,
|
|
@@ -104766,6 +104816,7 @@ class BlendDataMasks(bpy_prop_collection[Mask], bpy_struct):
|
|
|
104766
104816
|
def remove(
|
|
104767
104817
|
self,
|
|
104768
104818
|
mask: Mask,
|
|
104819
|
+
*,
|
|
104769
104820
|
do_unlink: bool | None = True,
|
|
104770
104821
|
do_id_user: bool | None = True,
|
|
104771
104822
|
do_ui_user: bool | None = True,
|
|
@@ -104833,6 +104884,7 @@ class BlendDataMaterials(bpy_prop_collection[Material], bpy_struct):
|
|
|
104833
104884
|
def remove(
|
|
104834
104885
|
self,
|
|
104835
104886
|
material: Material,
|
|
104887
|
+
*,
|
|
104836
104888
|
do_unlink: bool | None = True,
|
|
104837
104889
|
do_id_user: bool | None = True,
|
|
104838
104890
|
do_ui_user: bool | None = True,
|
|
@@ -104893,6 +104945,7 @@ class BlendDataMeshes(bpy_prop_collection[Mesh], bpy_struct):
|
|
|
104893
104945
|
def new_from_object(
|
|
104894
104946
|
self,
|
|
104895
104947
|
object: Object,
|
|
104948
|
+
*,
|
|
104896
104949
|
preserve_all_data_layers: bool | None = False,
|
|
104897
104950
|
depsgraph: Depsgraph | None = None,
|
|
104898
104951
|
) -> Mesh:
|
|
@@ -104911,6 +104964,7 @@ class BlendDataMeshes(bpy_prop_collection[Mesh], bpy_struct):
|
|
|
104911
104964
|
def remove(
|
|
104912
104965
|
self,
|
|
104913
104966
|
mesh: Mesh,
|
|
104967
|
+
*,
|
|
104914
104968
|
do_unlink: bool | None = True,
|
|
104915
104969
|
do_id_user: bool | None = True,
|
|
104916
104970
|
do_ui_user: bool | None = True,
|
|
@@ -104971,6 +105025,7 @@ class BlendDataMetaBalls(bpy_prop_collection[MetaBall], bpy_struct):
|
|
|
104971
105025
|
def remove(
|
|
104972
105026
|
self,
|
|
104973
105027
|
metaball: MetaBall,
|
|
105028
|
+
*,
|
|
104974
105029
|
do_unlink: bool | None = True,
|
|
104975
105030
|
do_id_user: bool | None = True,
|
|
104976
105031
|
do_ui_user: bool | None = True,
|
|
@@ -105029,6 +105084,7 @@ class BlendDataMovieClips(bpy_prop_collection[MovieClip], bpy_struct):
|
|
|
105029
105084
|
def remove(
|
|
105030
105085
|
self,
|
|
105031
105086
|
clip: MovieClip,
|
|
105087
|
+
*,
|
|
105032
105088
|
do_unlink: bool | None = True,
|
|
105033
105089
|
do_id_user: bool | None = True,
|
|
105034
105090
|
do_ui_user: bool | None = True,
|
|
@@ -105045,7 +105101,7 @@ class BlendDataMovieClips(bpy_prop_collection[MovieClip], bpy_struct):
|
|
|
105045
105101
|
:type do_ui_user: bool | None
|
|
105046
105102
|
"""
|
|
105047
105103
|
|
|
105048
|
-
def load(self, filepath: str, check_existing: bool | None = False) -> MovieClip:
|
|
105104
|
+
def load(self, filepath: str, *, check_existing: bool | None = False) -> MovieClip:
|
|
105049
105105
|
"""Add a new movie clip to the main database from a file (while check_existing is disabled for consistency with other load functions, behavior with multiple movie-clips using the same file may incorrectly generate proxies)
|
|
105050
105106
|
|
|
105051
105107
|
:param filepath: path for the data-block
|
|
@@ -105095,6 +105151,7 @@ class BlendDataNodeTrees(bpy_prop_collection[NodeTree], bpy_struct):
|
|
|
105095
105151
|
def remove(
|
|
105096
105152
|
self,
|
|
105097
105153
|
tree: NodeTree,
|
|
105154
|
+
*,
|
|
105098
105155
|
do_unlink: bool | None = True,
|
|
105099
105156
|
do_id_user: bool | None = True,
|
|
105100
105157
|
do_ui_user: bool | None = True,
|
|
@@ -105157,6 +105214,7 @@ class BlendDataObjects(bpy_prop_collection[Object], bpy_struct):
|
|
|
105157
105214
|
def remove(
|
|
105158
105215
|
self,
|
|
105159
105216
|
object: Object,
|
|
105217
|
+
*,
|
|
105160
105218
|
do_unlink: bool | None = True,
|
|
105161
105219
|
do_id_user: bool | None = True,
|
|
105162
105220
|
do_ui_user: bool | None = True,
|
|
@@ -105249,6 +105307,7 @@ class BlendDataPalettes(bpy_prop_collection[Palette], bpy_struct):
|
|
|
105249
105307
|
def remove(
|
|
105250
105308
|
self,
|
|
105251
105309
|
palette: Palette,
|
|
105310
|
+
*,
|
|
105252
105311
|
do_unlink: bool | None = True,
|
|
105253
105312
|
do_id_user: bool | None = True,
|
|
105254
105313
|
do_ui_user: bool | None = True,
|
|
@@ -105309,6 +105368,7 @@ class BlendDataParticles(bpy_prop_collection[ParticleSettings], bpy_struct):
|
|
|
105309
105368
|
def remove(
|
|
105310
105369
|
self,
|
|
105311
105370
|
particle: ParticleSettings,
|
|
105371
|
+
*,
|
|
105312
105372
|
do_unlink: bool | None = True,
|
|
105313
105373
|
do_id_user: bool | None = True,
|
|
105314
105374
|
do_ui_user: bool | None = True,
|
|
@@ -105369,6 +105429,7 @@ class BlendDataPointClouds(bpy_prop_collection[PointCloud], bpy_struct):
|
|
|
105369
105429
|
def remove(
|
|
105370
105430
|
self,
|
|
105371
105431
|
pointcloud: PointCloud,
|
|
105432
|
+
*,
|
|
105372
105433
|
do_unlink: bool | None = True,
|
|
105373
105434
|
do_id_user: bool | None = True,
|
|
105374
105435
|
do_ui_user: bool | None = True,
|
|
@@ -105433,6 +105494,7 @@ class BlendDataProbes(bpy_prop_collection[LightProbe], bpy_struct):
|
|
|
105433
105494
|
def remove(
|
|
105434
105495
|
self,
|
|
105435
105496
|
lightprobe: LightProbe,
|
|
105497
|
+
*,
|
|
105436
105498
|
do_unlink: bool | None = True,
|
|
105437
105499
|
do_id_user: bool | None = True,
|
|
105438
105500
|
do_ui_user: bool | None = True,
|
|
@@ -105490,7 +105552,7 @@ class BlendDataScenes(bpy_prop_collection[Scene], bpy_struct):
|
|
|
105490
105552
|
:rtype: Scene
|
|
105491
105553
|
"""
|
|
105492
105554
|
|
|
105493
|
-
def remove(self, scene: Scene, do_unlink: bool | None = True):
|
|
105555
|
+
def remove(self, scene: Scene, *, do_unlink: bool | None = True):
|
|
105494
105556
|
"""Remove a scene from the current blendfile
|
|
105495
105557
|
|
|
105496
105558
|
:param scene: Scene to remove
|
|
@@ -105563,7 +105625,7 @@ class BlendDataScreens(bpy_prop_collection[Screen], bpy_struct):
|
|
|
105563
105625
|
class BlendDataSounds(bpy_prop_collection[Sound], bpy_struct):
|
|
105564
105626
|
"""Collection of sounds"""
|
|
105565
105627
|
|
|
105566
|
-
def load(self, filepath: str, check_existing: bool | None = False) -> Sound:
|
|
105628
|
+
def load(self, filepath: str, *, check_existing: bool | None = False) -> Sound:
|
|
105567
105629
|
"""Add a new sound to the main database from a file
|
|
105568
105630
|
|
|
105569
105631
|
:param filepath: path for the data-block
|
|
@@ -105577,6 +105639,7 @@ class BlendDataSounds(bpy_prop_collection[Sound], bpy_struct):
|
|
|
105577
105639
|
def remove(
|
|
105578
105640
|
self,
|
|
105579
105641
|
sound: Sound,
|
|
105642
|
+
*,
|
|
105580
105643
|
do_unlink: bool | None = True,
|
|
105581
105644
|
do_id_user: bool | None = True,
|
|
105582
105645
|
do_ui_user: bool | None = True,
|
|
@@ -105637,6 +105700,7 @@ class BlendDataSpeakers(bpy_prop_collection[Speaker], bpy_struct):
|
|
|
105637
105700
|
def remove(
|
|
105638
105701
|
self,
|
|
105639
105702
|
speaker: Speaker,
|
|
105703
|
+
*,
|
|
105640
105704
|
do_unlink: bool | None = True,
|
|
105641
105705
|
do_id_user: bool | None = True,
|
|
105642
105706
|
do_ui_user: bool | None = True,
|
|
@@ -105697,6 +105761,7 @@ class BlendDataTexts(bpy_prop_collection[Text], bpy_struct):
|
|
|
105697
105761
|
def remove(
|
|
105698
105762
|
self,
|
|
105699
105763
|
text: Text,
|
|
105764
|
+
*,
|
|
105700
105765
|
do_unlink: bool | None = True,
|
|
105701
105766
|
do_id_user: bool | None = True,
|
|
105702
105767
|
do_ui_user: bool | None = True,
|
|
@@ -105713,7 +105778,7 @@ class BlendDataTexts(bpy_prop_collection[Text], bpy_struct):
|
|
|
105713
105778
|
:type do_ui_user: bool | None
|
|
105714
105779
|
"""
|
|
105715
105780
|
|
|
105716
|
-
def load(self, filepath: str, internal: bool | None = False) -> Text:
|
|
105781
|
+
def load(self, filepath: str, *, internal: bool | None = False) -> Text:
|
|
105717
105782
|
"""Add a new text to the main database from a file
|
|
105718
105783
|
|
|
105719
105784
|
:param filepath: path for the data-block
|
|
@@ -105770,6 +105835,7 @@ class BlendDataTextures(bpy_prop_collection[Texture], bpy_struct):
|
|
|
105770
105835
|
def remove(
|
|
105771
105836
|
self,
|
|
105772
105837
|
texture: Texture,
|
|
105838
|
+
*,
|
|
105773
105839
|
do_unlink: bool | None = True,
|
|
105774
105840
|
do_id_user: bool | None = True,
|
|
105775
105841
|
do_ui_user: bool | None = True,
|
|
@@ -105830,6 +105896,7 @@ class BlendDataVolumes(bpy_prop_collection[Volume], bpy_struct):
|
|
|
105830
105896
|
def remove(
|
|
105831
105897
|
self,
|
|
105832
105898
|
volume: Volume,
|
|
105899
|
+
*,
|
|
105833
105900
|
do_unlink: bool | None = True,
|
|
105834
105901
|
do_id_user: bool | None = True,
|
|
105835
105902
|
do_ui_user: bool | None = True,
|
|
@@ -105954,6 +106021,7 @@ class BlendDataWorlds(bpy_prop_collection[World], bpy_struct):
|
|
|
105954
106021
|
def remove(
|
|
105955
106022
|
self,
|
|
105956
106023
|
world: World,
|
|
106024
|
+
*,
|
|
105957
106025
|
do_unlink: bool | None = True,
|
|
105958
106026
|
do_id_user: bool | None = True,
|
|
105959
106027
|
do_ui_user: bool | None = True,
|
|
@@ -106106,7 +106174,7 @@ class BoneCollections(bpy_prop_collection[BoneCollection], bpy_struct):
|
|
|
106106
106174
|
:type: bool
|
|
106107
106175
|
"""
|
|
106108
106176
|
|
|
106109
|
-
def new(self, name: str, parent: BoneCollection | None = None) -> BoneCollection:
|
|
106177
|
+
def new(self, name: str, *, parent: BoneCollection | None = None) -> BoneCollection:
|
|
106110
106178
|
"""Add a new empty bone collection to the armature
|
|
106111
106179
|
|
|
106112
106180
|
:param name: Name, Name of the new collection. Blender will ensure it is unique within the collections of the Armature.
|
|
@@ -106717,6 +106785,7 @@ class FCurveKeyframePoints(bpy_prop_collection[Keyframe], bpy_struct):
|
|
|
106717
106785
|
self,
|
|
106718
106786
|
frame: float | None,
|
|
106719
106787
|
value: float | None,
|
|
106788
|
+
*,
|
|
106720
106789
|
options: set[typing.Literal["REPLACE", "NEEDED", "FAST"]] | None = {},
|
|
106721
106790
|
keyframe_type: bpy.typing.BeztripleKeyframeTypeItems | None = "KEYFRAME",
|
|
106722
106791
|
) -> Keyframe:
|
|
@@ -106750,7 +106819,7 @@ class FCurveKeyframePoints(bpy_prop_collection[Keyframe], bpy_struct):
|
|
|
106750
106819
|
:type count: int | None
|
|
106751
106820
|
"""
|
|
106752
106821
|
|
|
106753
|
-
def remove(self, keyframe: Keyframe, fast: bool | None = False):
|
|
106822
|
+
def remove(self, keyframe: Keyframe, *, fast: bool | None = False):
|
|
106754
106823
|
"""Remove keyframe from an F-Curve
|
|
106755
106824
|
|
|
106756
106825
|
:param keyframe: Keyframe to remove
|
|
@@ -106926,7 +106995,7 @@ class GPencilFrames(bpy_prop_collection[GPencilFrame], bpy_struct):
|
|
|
106926
106995
|
"""Collection of annotation frames"""
|
|
106927
106996
|
|
|
106928
106997
|
def new(
|
|
106929
|
-
self, frame_number: int | None, active: bool | None = False
|
|
106998
|
+
self, frame_number: int | None, *, active: bool | None = False
|
|
106930
106999
|
) -> GPencilFrame:
|
|
106931
107000
|
"""Add a new annotation frame
|
|
106932
107001
|
|
|
@@ -107043,6 +107112,7 @@ class GreasePencilFrames(bpy_prop_collection[GreasePencilFrame], bpy_struct):
|
|
|
107043
107112
|
self,
|
|
107044
107113
|
from_frame_number: int | None,
|
|
107045
107114
|
to_frame_number: int | None,
|
|
107115
|
+
*,
|
|
107046
107116
|
instance_drawing: bool | None = False,
|
|
107047
107117
|
) -> GreasePencilFrame:
|
|
107048
107118
|
"""Copy a Grease Pencil frame
|
|
@@ -107138,7 +107208,7 @@ class GreasePencilLayers(bpy_prop_collection[GPencilLayer], bpy_struct):
|
|
|
107138
107208
|
:type: str | None
|
|
107139
107209
|
"""
|
|
107140
107210
|
|
|
107141
|
-
def new(self, name: str, set_active: bool | None = True) -> GPencilLayer:
|
|
107211
|
+
def new(self, name: str, *, set_active: bool | None = True) -> GPencilLayer:
|
|
107142
107212
|
"""Add a new annotation layer
|
|
107143
107213
|
|
|
107144
107214
|
:param name: Name, Name of the layer
|
|
@@ -107188,7 +107258,7 @@ class GreasePencilv3LayerGroup(bpy_prop_collection[GreasePencilLayerGroup], bpy_
|
|
|
107188
107258
|
"""
|
|
107189
107259
|
|
|
107190
107260
|
def new(
|
|
107191
|
-
self, name: str, parent_group: GreasePencilLayerGroup | None = None
|
|
107261
|
+
self, name: str, *, parent_group: GreasePencilLayerGroup | None = None
|
|
107192
107262
|
) -> GreasePencilLayerGroup:
|
|
107193
107263
|
"""Add a new Grease Pencil layer group
|
|
107194
107264
|
|
|
@@ -107201,7 +107271,7 @@ class GreasePencilv3LayerGroup(bpy_prop_collection[GreasePencilLayerGroup], bpy_
|
|
|
107201
107271
|
"""
|
|
107202
107272
|
|
|
107203
107273
|
def remove(
|
|
107204
|
-
self, layer_group: GreasePencilLayerGroup, keep_children: bool | None = False
|
|
107274
|
+
self, layer_group: GreasePencilLayerGroup, *, keep_children: bool | None = False
|
|
107205
107275
|
):
|
|
107206
107276
|
"""Remove a new Grease Pencil layer group
|
|
107207
107277
|
|
|
@@ -107285,6 +107355,7 @@ class GreasePencilv3Layers(bpy_prop_collection[GreasePencilLayer], bpy_struct):
|
|
|
107285
107355
|
def new(
|
|
107286
107356
|
self,
|
|
107287
107357
|
name: str,
|
|
107358
|
+
*,
|
|
107288
107359
|
set_active: bool | None = True,
|
|
107289
107360
|
layer_group: GreasePencilLayerGroup | None = None,
|
|
107290
107361
|
) -> GreasePencilLayer:
|
|
@@ -107467,6 +107538,7 @@ class IDOverrideLibraryPropertyOperations(
|
|
|
107467
107538
|
"INSERT_BEFORE",
|
|
107468
107539
|
]
|
|
107469
107540
|
| None,
|
|
107541
|
+
*,
|
|
107470
107542
|
use_id: bool | None = False,
|
|
107471
107543
|
subitem_reference_name: str = "",
|
|
107472
107544
|
subitem_local_name: str = "",
|
|
@@ -107593,6 +107665,7 @@ class KeyConfigurations(bpy_prop_collection[KeyConfig], bpy_struct):
|
|
|
107593
107665
|
def find_item_from_operator(
|
|
107594
107666
|
self,
|
|
107595
107667
|
idname: str,
|
|
107668
|
+
*,
|
|
107596
107669
|
context: bpy.typing.OperatorContextItems | None = "INVOKE_DEFAULT",
|
|
107597
107670
|
properties: OperatorProperties | None = None,
|
|
107598
107671
|
include: set[bpy.typing.EventTypeMaskItems] | None = {
|
|
@@ -107620,7 +107693,7 @@ class KeyConfigurations(bpy_prop_collection[KeyConfig], bpy_struct):
|
|
|
107620
107693
|
item, `KeyMapItem`
|
|
107621
107694
|
"""
|
|
107622
107695
|
|
|
107623
|
-
def update(self, keep_properties: bool | None = False):
|
|
107696
|
+
def update(self, *, keep_properties: bool | None = False):
|
|
107624
107697
|
"""update
|
|
107625
107698
|
|
|
107626
107699
|
:param keep_properties: Keep Properties, Operator properties are kept to allow the operators to be registered again in the future
|
|
@@ -107657,6 +107730,7 @@ class KeyMapItems(bpy_prop_collection[KeyMapItem], bpy_struct):
|
|
|
107657
107730
|
idname: str,
|
|
107658
107731
|
type: bpy.typing.EventTypeItems | None,
|
|
107659
107732
|
value: bpy.typing.EventValueItems | None,
|
|
107733
|
+
*,
|
|
107660
107734
|
any: bool | None = False,
|
|
107661
107735
|
shift: int | None = 0,
|
|
107662
107736
|
ctrl: int | None = 0,
|
|
@@ -107702,6 +107776,7 @@ class KeyMapItems(bpy_prop_collection[KeyMapItem], bpy_struct):
|
|
|
107702
107776
|
propvalue: str,
|
|
107703
107777
|
type: bpy.typing.EventTypeItems | None,
|
|
107704
107778
|
value: bpy.typing.EventValueItems | None,
|
|
107779
|
+
*,
|
|
107705
107780
|
any: bool | None = False,
|
|
107706
107781
|
shift: int | None = 0,
|
|
107707
107782
|
ctrl: int | None = 0,
|
|
@@ -107739,7 +107814,9 @@ class KeyMapItems(bpy_prop_collection[KeyMapItem], bpy_struct):
|
|
|
107739
107814
|
:rtype: KeyMapItem
|
|
107740
107815
|
"""
|
|
107741
107816
|
|
|
107742
|
-
def new_from_item(
|
|
107817
|
+
def new_from_item(
|
|
107818
|
+
self, item: KeyMapItem, *, head: bool | None = False
|
|
107819
|
+
) -> KeyMapItem:
|
|
107743
107820
|
"""new_from_item
|
|
107744
107821
|
|
|
107745
107822
|
:param item: Item, Item to use as a reference
|
|
@@ -107769,6 +107846,7 @@ class KeyMapItems(bpy_prop_collection[KeyMapItem], bpy_struct):
|
|
|
107769
107846
|
def find_from_operator(
|
|
107770
107847
|
self,
|
|
107771
107848
|
idname: str,
|
|
107849
|
+
*,
|
|
107772
107850
|
properties: OperatorProperties | None = None,
|
|
107773
107851
|
include: set[bpy.typing.EventTypeMaskItems] | None = {
|
|
107774
107852
|
"ACTIONZONE",
|
|
@@ -107829,6 +107907,7 @@ class KeyMaps(bpy_prop_collection[KeyMap], bpy_struct):
|
|
|
107829
107907
|
def new(
|
|
107830
107908
|
self,
|
|
107831
107909
|
name: str,
|
|
107910
|
+
*,
|
|
107832
107911
|
space_type: bpy.typing.SpaceTypeItems | None = "EMPTY",
|
|
107833
107912
|
region_type: bpy.typing.RegionTypeItems | None = "WINDOW",
|
|
107834
107913
|
modal: bool | None = False,
|
|
@@ -107863,6 +107942,7 @@ class KeyMaps(bpy_prop_collection[KeyMap], bpy_struct):
|
|
|
107863
107942
|
def find(
|
|
107864
107943
|
self,
|
|
107865
107944
|
name: str,
|
|
107945
|
+
*,
|
|
107866
107946
|
space_type: bpy.typing.SpaceTypeItems | None = "EMPTY",
|
|
107867
107947
|
region_type: bpy.typing.RegionTypeItems | None = "WINDOW",
|
|
107868
107948
|
) -> KeyMap:
|
|
@@ -107928,6 +108008,7 @@ class KeyingSetPaths(bpy_prop_collection[KeyingSetPath], bpy_struct):
|
|
|
107928
108008
|
self,
|
|
107929
108009
|
target_id: ID | None,
|
|
107930
108010
|
data_path: str,
|
|
108011
|
+
*,
|
|
107931
108012
|
index: int | None = -1,
|
|
107932
108013
|
group_method: bpy.typing.KeyingsetPathGroupingItems | None = "KEYINGSET",
|
|
107933
108014
|
group_name: str = "",
|
|
@@ -107995,7 +108076,7 @@ class KeyingSets(bpy_prop_collection[KeyingSet], bpy_struct):
|
|
|
107995
108076
|
:type: int | None
|
|
107996
108077
|
"""
|
|
107997
108078
|
|
|
107998
|
-
def new(self, idname: str = "KeyingSet", name: str = "KeyingSet") -> KeyingSet:
|
|
108079
|
+
def new(self, *, idname: str = "KeyingSet", name: str = "KeyingSet") -> KeyingSet:
|
|
107999
108080
|
"""Add a new Keying Set to Scene
|
|
108000
108081
|
|
|
108001
108082
|
:param idname: IDName, Internal identifier of Keying Set
|
|
@@ -108105,7 +108186,7 @@ class LayerObjects(bpy_prop_collection[Object], bpy_struct):
|
|
|
108105
108186
|
class Lightgroups(bpy_prop_collection[Lightgroup], bpy_struct):
|
|
108106
108187
|
"""Collection of Lightgroups"""
|
|
108107
108188
|
|
|
108108
|
-
def add(self, name: str = "") -> Lightgroup:
|
|
108189
|
+
def add(self, *, name: str = "") -> Lightgroup:
|
|
108109
108190
|
"""add
|
|
108110
108191
|
|
|
108111
108192
|
:param name: Name, Name of newly created lightgroup
|
|
@@ -108439,7 +108520,9 @@ class LoopColors(bpy_prop_collection[MeshLoopColorLayer], bpy_struct):
|
|
|
108439
108520
|
:type: int | None
|
|
108440
108521
|
"""
|
|
108441
108522
|
|
|
108442
|
-
def new(
|
|
108523
|
+
def new(
|
|
108524
|
+
self, *, name: str = "Col", do_init: bool | None = True
|
|
108525
|
+
) -> MeshLoopColorLayer:
|
|
108443
108526
|
"""Add a vertex color layer to Mesh
|
|
108444
108527
|
|
|
108445
108528
|
:param name: Vertex color name
|
|
@@ -108488,7 +108571,7 @@ class MaskLayers(bpy_prop_collection[MaskLayer], bpy_struct):
|
|
|
108488
108571
|
:type: MaskLayer | None
|
|
108489
108572
|
"""
|
|
108490
108573
|
|
|
108491
|
-
def new(self, name: str = "") -> MaskLayer:
|
|
108574
|
+
def new(self, *, name: str = "") -> MaskLayer:
|
|
108492
108575
|
"""Add layer to this mask
|
|
108493
108576
|
|
|
108494
108577
|
:param name: Name, Name of new layer
|
|
@@ -108787,7 +108870,7 @@ class MetaBallElements(bpy_prop_collection[MetaElement], bpy_struct):
|
|
|
108787
108870
|
:type: MetaElement | None
|
|
108788
108871
|
"""
|
|
108789
108872
|
|
|
108790
|
-
def new(self, type: bpy.typing.MetaelemTypeItems | None = "BALL") -> MetaElement:
|
|
108873
|
+
def new(self, *, type: bpy.typing.MetaelemTypeItems | None = "BALL") -> MetaElement:
|
|
108791
108874
|
"""Add a new element to the metaball
|
|
108792
108875
|
|
|
108793
108876
|
:param type: Type for the new metaball element
|
|
@@ -108832,7 +108915,7 @@ class MovieTrackingMarkers(bpy_prop_collection[MovieTrackingMarker], bpy_struct)
|
|
|
108832
108915
|
"""Collection of markers for movie tracking track"""
|
|
108833
108916
|
|
|
108834
108917
|
def find_frame(
|
|
108835
|
-
self, frame: int | None, exact: bool | None = True
|
|
108918
|
+
self, frame: int | None, *, exact: bool | None = True
|
|
108836
108919
|
) -> MovieTrackingMarker:
|
|
108837
108920
|
"""Get marker for specified frame
|
|
108838
108921
|
|
|
@@ -108847,6 +108930,7 @@ class MovieTrackingMarkers(bpy_prop_collection[MovieTrackingMarker], bpy_struct)
|
|
|
108847
108930
|
def insert_frame(
|
|
108848
108931
|
self,
|
|
108849
108932
|
frame: int | None,
|
|
108933
|
+
*,
|
|
108850
108934
|
co: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
|
|
108851
108935
|
) -> MovieTrackingMarker:
|
|
108852
108936
|
"""Insert a new marker at the specified frame
|
|
@@ -108930,7 +109014,7 @@ class MovieTrackingObjectTracks(bpy_prop_collection[MovieTrackingTrack], bpy_str
|
|
|
108930
109014
|
:type: MovieTrackingTrack | None
|
|
108931
109015
|
"""
|
|
108932
109016
|
|
|
108933
|
-
def new(self, name: str = "", frame: int | None = 1) -> MovieTrackingTrack:
|
|
109017
|
+
def new(self, *, name: str = "", frame: int | None = 1) -> MovieTrackingTrack:
|
|
108934
109018
|
"""create new motion track in this movie clip
|
|
108935
109019
|
|
|
108936
109020
|
:param name: Name of new track
|
|
@@ -109016,7 +109100,7 @@ class MovieTrackingPlaneMarkers(
|
|
|
109016
109100
|
"""Collection of markers for movie tracking plane track"""
|
|
109017
109101
|
|
|
109018
109102
|
def find_frame(
|
|
109019
|
-
self, frame: int | None, exact: bool | None = True
|
|
109103
|
+
self, frame: int | None, *, exact: bool | None = True
|
|
109020
109104
|
) -> MovieTrackingPlaneMarker:
|
|
109021
109105
|
"""Get plane marker for specified frame
|
|
109022
109106
|
|
|
@@ -109104,7 +109188,7 @@ class MovieTrackingReconstructedCameras(
|
|
|
109104
109188
|
):
|
|
109105
109189
|
"""Collection of solved cameras"""
|
|
109106
109190
|
|
|
109107
|
-
def find_frame(self, frame: int | None = 1) -> MovieReconstructedCamera:
|
|
109191
|
+
def find_frame(self, *, frame: int | None = 1) -> MovieReconstructedCamera:
|
|
109108
109192
|
"""Find a reconstructed camera for a give frame number
|
|
109109
109193
|
|
|
109110
109194
|
:param frame: Frame, Frame number to find camera for
|
|
@@ -109113,7 +109197,7 @@ class MovieTrackingReconstructedCameras(
|
|
|
109113
109197
|
:rtype: MovieReconstructedCamera
|
|
109114
109198
|
"""
|
|
109115
109199
|
|
|
109116
|
-
def matrix_from_frame(self, frame: int | None = 1) -> mathutils.Matrix:
|
|
109200
|
+
def matrix_from_frame(self, *, frame: int | None = 1) -> mathutils.Matrix:
|
|
109117
109201
|
"""Return interpolated camera matrix for a given frame
|
|
109118
109202
|
|
|
109119
109203
|
:param frame: Frame, Frame number to find camera for
|
|
@@ -109153,7 +109237,7 @@ class MovieTrackingTracks(bpy_prop_collection[MovieTrackingTrack], bpy_struct):
|
|
|
109153
109237
|
:type: MovieTrackingTrack | None
|
|
109154
109238
|
"""
|
|
109155
109239
|
|
|
109156
|
-
def new(self, name: str = "", frame: int | None = 1) -> MovieTrackingTrack:
|
|
109240
|
+
def new(self, *, name: str = "", frame: int | None = 1) -> MovieTrackingTrack:
|
|
109157
109241
|
"""Create new motion track in this movie clip
|
|
109158
109242
|
|
|
109159
109243
|
:param name: Name of new track
|
|
@@ -109189,7 +109273,7 @@ class MovieTrackingTracks(bpy_prop_collection[MovieTrackingTrack], bpy_struct):
|
|
|
109189
109273
|
class NlaStripFCurves(bpy_prop_collection[FCurve], bpy_struct):
|
|
109190
109274
|
"""Collection of NLA strip F-Curves"""
|
|
109191
109275
|
|
|
109192
|
-
def find(self, data_path: str, index: int | None = 0) -> FCurve:
|
|
109276
|
+
def find(self, data_path: str, *, index: int | None = 0) -> FCurve:
|
|
109193
109277
|
"""Find an F-Curve. Note that this function performs a linear scan of all F-Curves in the NLA strip.
|
|
109194
109278
|
|
|
109195
109279
|
:param data_path: Data Path, F-Curve data path
|
|
@@ -109276,7 +109360,7 @@ class NlaTracks(bpy_prop_collection[NlaTrack], bpy_struct):
|
|
|
109276
109360
|
:type: NlaTrack | None
|
|
109277
109361
|
"""
|
|
109278
109362
|
|
|
109279
|
-
def new(self, prev: NlaTrack | None = None) -> NlaTrack:
|
|
109363
|
+
def new(self, *, prev: NlaTrack | None = None) -> NlaTrack:
|
|
109280
109364
|
"""Add a new NLA Track
|
|
109281
109365
|
|
|
109282
109366
|
:param prev: NLA Track to add the new one after
|
|
@@ -109781,6 +109865,7 @@ class NodeInputs(bpy_prop_collection[NodeSocket], bpy_struct):
|
|
|
109781
109865
|
self,
|
|
109782
109866
|
type: str,
|
|
109783
109867
|
name: str,
|
|
109868
|
+
*,
|
|
109784
109869
|
identifier: str = "",
|
|
109785
109870
|
use_multi_input: bool | None = False,
|
|
109786
109871
|
) -> NodeSocket:
|
|
@@ -109846,6 +109931,7 @@ class NodeLinks(bpy_prop_collection[NodeLink], bpy_struct):
|
|
|
109846
109931
|
self,
|
|
109847
109932
|
input: NodeSocket,
|
|
109848
109933
|
output: NodeSocket,
|
|
109934
|
+
*,
|
|
109849
109935
|
verify_limits: bool | None = True,
|
|
109850
109936
|
handle_dynamic_sockets: bool | None = False,
|
|
109851
109937
|
) -> NodeLink:
|
|
@@ -109955,6 +110041,7 @@ class NodeOutputs(bpy_prop_collection[NodeSocket], bpy_struct):
|
|
|
109955
110041
|
self,
|
|
109956
110042
|
type: str,
|
|
109957
110043
|
name: str,
|
|
110044
|
+
*,
|
|
109958
110045
|
identifier: str = "",
|
|
109959
110046
|
use_multi_input: bool | None = False,
|
|
109960
110047
|
) -> NodeSocket:
|
|
@@ -110664,7 +110751,7 @@ class RenderSlots(bpy_prop_collection[RenderSlot], bpy_struct):
|
|
|
110664
110751
|
:type: int | None
|
|
110665
110752
|
"""
|
|
110666
110753
|
|
|
110667
|
-
def new(self, name: str = "") -> RenderSlot:
|
|
110754
|
+
def new(self, *, name: str = "") -> RenderSlot:
|
|
110668
110755
|
"""Add a render slot to the image
|
|
110669
110756
|
|
|
110670
110757
|
:param name: Name, New name for the render slot
|
|
@@ -110751,7 +110838,7 @@ class RenderViews(bpy_prop_collection[SceneRenderView], bpy_struct):
|
|
|
110751
110838
|
class RetimingKeys(bpy_prop_collection[RetimingKey], bpy_struct):
|
|
110752
110839
|
"""Collection of RetimingKey"""
|
|
110753
110840
|
|
|
110754
|
-
def add(self, timeline_frame: int | None = 0) -> RetimingKey:
|
|
110841
|
+
def add(self, *, timeline_frame: int | None = 0) -> RetimingKey:
|
|
110755
110842
|
"""Add retiming key
|
|
110756
110843
|
|
|
110757
110844
|
:param timeline_frame: Timeline Frame
|
|
@@ -110998,6 +111085,7 @@ class SequencesMeta(bpy_prop_collection[Sequence], bpy_struct):
|
|
|
110998
111085
|
filepath: str,
|
|
110999
111086
|
channel: int | None,
|
|
111000
111087
|
frame_start: int | None,
|
|
111088
|
+
*,
|
|
111001
111089
|
fit_method: typing.Literal["FIT", "FILL", "STRETCH", "ORIGINAL"]
|
|
111002
111090
|
| None = "ORIGINAL",
|
|
111003
111091
|
) -> Sequence:
|
|
@@ -111035,6 +111123,7 @@ class SequencesMeta(bpy_prop_collection[Sequence], bpy_struct):
|
|
|
111035
111123
|
filepath: str,
|
|
111036
111124
|
channel: int | None,
|
|
111037
111125
|
frame_start: int | None,
|
|
111126
|
+
*,
|
|
111038
111127
|
fit_method: typing.Literal["FIT", "FILL", "STRETCH", "ORIGINAL"]
|
|
111039
111128
|
| None = "ORIGINAL",
|
|
111040
111129
|
) -> Sequence:
|
|
@@ -111124,6 +111213,7 @@ class SequencesMeta(bpy_prop_collection[Sequence], bpy_struct):
|
|
|
111124
111213
|
| None,
|
|
111125
111214
|
channel: int | None,
|
|
111126
111215
|
frame_start: int | None,
|
|
111216
|
+
*,
|
|
111127
111217
|
frame_end: int | None = 0,
|
|
111128
111218
|
seq1: Sequence | None = None,
|
|
111129
111219
|
seq2: Sequence | None = None,
|
|
@@ -111237,6 +111327,7 @@ class SequencesTopLevel(bpy_prop_collection[Sequence], bpy_struct):
|
|
|
111237
111327
|
filepath: str,
|
|
111238
111328
|
channel: int | None,
|
|
111239
111329
|
frame_start: int | None,
|
|
111330
|
+
*,
|
|
111240
111331
|
fit_method: typing.Literal["FIT", "FILL", "STRETCH", "ORIGINAL"]
|
|
111241
111332
|
| None = "ORIGINAL",
|
|
111242
111333
|
) -> Sequence:
|
|
@@ -111274,6 +111365,7 @@ class SequencesTopLevel(bpy_prop_collection[Sequence], bpy_struct):
|
|
|
111274
111365
|
filepath: str,
|
|
111275
111366
|
channel: int | None,
|
|
111276
111367
|
frame_start: int | None,
|
|
111368
|
+
*,
|
|
111277
111369
|
fit_method: typing.Literal["FIT", "FILL", "STRETCH", "ORIGINAL"]
|
|
111278
111370
|
| None = "ORIGINAL",
|
|
111279
111371
|
) -> Sequence:
|
|
@@ -111363,6 +111455,7 @@ class SequencesTopLevel(bpy_prop_collection[Sequence], bpy_struct):
|
|
|
111363
111455
|
| None,
|
|
111364
111456
|
channel: int | None,
|
|
111365
111457
|
frame_start: int | None,
|
|
111458
|
+
*,
|
|
111366
111459
|
frame_end: int | None = 0,
|
|
111367
111460
|
seq1: Sequence | None = None,
|
|
111368
111461
|
seq2: Sequence | None = None,
|
|
@@ -111435,7 +111528,7 @@ class SpaceNodeEditorPath(bpy_prop_collection[NodeTreePath], bpy_struct):
|
|
|
111435
111528
|
:type node_tree: NodeTree | None
|
|
111436
111529
|
"""
|
|
111437
111530
|
|
|
111438
|
-
def append(self, node_tree: NodeTree | None, node: Node | None = None):
|
|
111531
|
+
def append(self, node_tree: NodeTree | None, *, node: Node | None = None):
|
|
111439
111532
|
"""Append a node group tree to the path
|
|
111440
111533
|
|
|
111441
111534
|
:param node_tree: Node Tree, Node tree to append to the node editor path
|
|
@@ -111593,7 +111686,7 @@ class StudioLights(bpy_prop_collection[StudioLight], bpy_struct):
|
|
|
111593
111686
|
class TimelineMarkers(bpy_prop_collection[TimelineMarker], bpy_struct):
|
|
111594
111687
|
"""Collection of timeline markers"""
|
|
111595
111688
|
|
|
111596
|
-
def new(self, name: str, frame: int | None = 1) -> TimelineMarker:
|
|
111689
|
+
def new(self, name: str, *, frame: int | None = 1) -> TimelineMarker:
|
|
111597
111690
|
"""Add a keyframe to the curve
|
|
111598
111691
|
|
|
111599
111692
|
:param name: New name for the marker (not unique)
|
|
@@ -111651,7 +111744,7 @@ class UDIMTiles(bpy_prop_collection[UDIMTile], bpy_struct):
|
|
|
111651
111744
|
:type: int | None
|
|
111652
111745
|
"""
|
|
111653
111746
|
|
|
111654
|
-
def new(self, tile_number: int | None, label: str = "") -> UDIMTile:
|
|
111747
|
+
def new(self, tile_number: int | None, *, label: str = "") -> UDIMTile:
|
|
111655
111748
|
"""Add a tile to the image
|
|
111656
111749
|
|
|
111657
111750
|
:param tile_number: Number of the newly created tile
|
|
@@ -111715,7 +111808,9 @@ class UVLoopLayers(bpy_prop_collection[MeshUVLoopLayer], bpy_struct):
|
|
|
111715
111808
|
:type: int | None
|
|
111716
111809
|
"""
|
|
111717
111810
|
|
|
111718
|
-
def new(
|
|
111811
|
+
def new(
|
|
111812
|
+
self, *, name: str = "UVMap", do_init: bool | None = True
|
|
111813
|
+
) -> MeshUVLoopLayer:
|
|
111719
111814
|
"""Add a UV map layer to Mesh
|
|
111720
111815
|
|
|
111721
111816
|
:param name: UV map name
|
|
@@ -111761,6 +111856,7 @@ class UserExtensionRepoCollection(bpy_prop_collection[UserExtensionRepo], bpy_st
|
|
|
111761
111856
|
@classmethod
|
|
111762
111857
|
def new(
|
|
111763
111858
|
cls,
|
|
111859
|
+
*,
|
|
111764
111860
|
name: str = "",
|
|
111765
111861
|
module: str = "",
|
|
111766
111862
|
custom_directory: str = "",
|
|
@@ -111834,7 +111930,7 @@ class VertexGroups(bpy_prop_collection[VertexGroup], bpy_struct):
|
|
|
111834
111930
|
:type: int | None
|
|
111835
111931
|
"""
|
|
111836
111932
|
|
|
111837
|
-
def new(self, name: str = "Group") -> VertexGroup:
|
|
111933
|
+
def new(self, *, name: str = "Group") -> VertexGroup:
|
|
111838
111934
|
"""Add vertex group to object
|
|
111839
111935
|
|
|
111840
111936
|
:param name: Vertex group name
|
|
@@ -112342,7 +112438,7 @@ class wmOwnerIDs(bpy_prop_collection[wmOwnerID], bpy_struct):
|
|
|
112342
112438
|
|
|
112343
112439
|
class wmTools(bpy_prop_collection[WorkSpaceTool], bpy_struct):
|
|
112344
112440
|
def from_space_view3d_mode(
|
|
112345
|
-
self, mode: bpy.typing.ContextModeItems | None, create: bool | None = False
|
|
112441
|
+
self, mode: bpy.typing.ContextModeItems | None, *, create: bool | None = False
|
|
112346
112442
|
) -> WorkSpaceTool:
|
|
112347
112443
|
"""
|
|
112348
112444
|
|
|
@@ -112357,6 +112453,7 @@ class wmTools(bpy_prop_collection[WorkSpaceTool], bpy_struct):
|
|
|
112357
112453
|
def from_space_image_mode(
|
|
112358
112454
|
self,
|
|
112359
112455
|
mode: bpy.typing.SpaceImageModeAllItems | None,
|
|
112456
|
+
*,
|
|
112360
112457
|
create: bool | None = False,
|
|
112361
112458
|
) -> WorkSpaceTool:
|
|
112362
112459
|
"""
|
|
@@ -112369,7 +112466,7 @@ class wmTools(bpy_prop_collection[WorkSpaceTool], bpy_struct):
|
|
|
112369
112466
|
:rtype: WorkSpaceTool
|
|
112370
112467
|
"""
|
|
112371
112468
|
|
|
112372
|
-
def from_space_node(self, create: bool | None = False) -> WorkSpaceTool:
|
|
112469
|
+
def from_space_node(self, *, create: bool | None = False) -> WorkSpaceTool:
|
|
112373
112470
|
"""
|
|
112374
112471
|
|
|
112375
112472
|
:param create: Create
|
|
@@ -112381,6 +112478,7 @@ class wmTools(bpy_prop_collection[WorkSpaceTool], bpy_struct):
|
|
|
112381
112478
|
def from_space_sequencer(
|
|
112382
112479
|
self,
|
|
112383
112480
|
mode: bpy.typing.SpaceSequencerViewTypeItems | None,
|
|
112481
|
+
*,
|
|
112384
112482
|
create: bool | None = False,
|
|
112385
112483
|
) -> WorkSpaceTool:
|
|
112386
112484
|
"""
|
|
@@ -113524,7 +113622,7 @@ class AnimData(bpy_struct):
|
|
|
113524
113622
|
"""
|
|
113525
113623
|
|
|
113526
113624
|
def nla_tweak_strip_time_to_scene(
|
|
113527
|
-
self, frame: float | None, invert: bool | None = False
|
|
113625
|
+
self, frame: float | None, *, invert: bool | None = False
|
|
113528
113626
|
) -> float:
|
|
113529
113627
|
"""Convert a time value from the local time of the tweaked strip to scene time, exactly as done by built-in key editing tools. Returns the input time unchanged if not tweaking.
|
|
113530
113628
|
|
|
@@ -113537,7 +113635,7 @@ class AnimData(bpy_struct):
|
|
|
113537
113635
|
"""
|
|
113538
113636
|
|
|
113539
113637
|
def fix_paths_rename_all(
|
|
113540
|
-
self, prefix: str = "", old_name: str = "", new_name: str = ""
|
|
113638
|
+
self, *, prefix: str = "", old_name: str = "", new_name: str = ""
|
|
113541
113639
|
):
|
|
113542
113640
|
"""Rename the property paths in the animation system, since properties are animated via string paths, it's needed to keep them valid after properties has been renamed
|
|
113543
113641
|
|
|
@@ -113828,48 +113926,18 @@ class Area(bpy_struct):
|
|
|
113828
113926
|
class AreaLight(Light, ID, bpy_struct):
|
|
113829
113927
|
"""Directional area Light"""
|
|
113830
113928
|
|
|
113831
|
-
contact_shadow_bias: float
|
|
113832
|
-
""" Bias to avoid self shadowing
|
|
113833
|
-
|
|
113834
|
-
:type: float
|
|
113835
|
-
"""
|
|
113836
|
-
|
|
113837
|
-
contact_shadow_distance: float
|
|
113838
|
-
""" World space distance in which to search for screen space occluder
|
|
113839
|
-
|
|
113840
|
-
:type: float
|
|
113841
|
-
"""
|
|
113842
|
-
|
|
113843
|
-
contact_shadow_thickness: float
|
|
113844
|
-
""" Pixel thickness used to detect occlusion
|
|
113845
|
-
|
|
113846
|
-
:type: float
|
|
113847
|
-
"""
|
|
113848
|
-
|
|
113849
113929
|
energy: float
|
|
113850
113930
|
""" Light energy emitted over the entire area of the light in all directions
|
|
113851
113931
|
|
|
113852
113932
|
:type: float
|
|
113853
113933
|
"""
|
|
113854
113934
|
|
|
113855
|
-
shadow_buffer_bias: float
|
|
113856
|
-
""" Bias for reducing self shadowing
|
|
113857
|
-
|
|
113858
|
-
:type: float
|
|
113859
|
-
"""
|
|
113860
|
-
|
|
113861
113935
|
shadow_buffer_clip_start: float
|
|
113862
113936
|
""" Shadow map clip start, below which objects will not generate shadows
|
|
113863
113937
|
|
|
113864
113938
|
:type: float
|
|
113865
113939
|
"""
|
|
113866
113940
|
|
|
113867
|
-
shadow_color: mathutils.Color
|
|
113868
|
-
""" Color of shadows cast by the light
|
|
113869
|
-
|
|
113870
|
-
:type: mathutils.Color
|
|
113871
|
-
"""
|
|
113872
|
-
|
|
113873
113941
|
shadow_filter_radius: float
|
|
113874
113942
|
""" Blur shadow aliasing using Percentage Closer Filtering
|
|
113875
113943
|
|
|
@@ -113924,12 +113992,6 @@ class AreaLight(Light, ID, bpy_struct):
|
|
|
113924
113992
|
:type: bool
|
|
113925
113993
|
"""
|
|
113926
113994
|
|
|
113927
|
-
use_contact_shadow: bool
|
|
113928
|
-
""" Use screen space ray-tracing to have correct shadowing near occluder, or for small features that does not appear in shadow maps
|
|
113929
|
-
|
|
113930
|
-
:type: bool
|
|
113931
|
-
"""
|
|
113932
|
-
|
|
113933
113995
|
use_shadow_jitter: bool
|
|
113934
113996
|
""" Enable jittered soft shadows to increase shadow precision (disabled in viewport unless enabled in the render settings). Has a high performance impact.
|
|
113935
113997
|
|
|
@@ -115542,7 +115604,7 @@ class BlendData(bpy_struct):
|
|
|
115542
115604
|
"""Remove (delete) several IDs at once.WARNING: Considered experimental feature currently.Note that this function is quicker than individual calls to `remove()` (from `bpy.types.BlendData`
|
|
115543
115605
|
ID collections), but less safe/versatile (it can break Blender, e.g. by removing all scenes...).
|
|
115544
115606
|
|
|
115545
|
-
:param ids:
|
|
115607
|
+
:param ids: Sequence of IDs (types can be mixed).
|
|
115546
115608
|
"""
|
|
115547
115609
|
|
|
115548
115610
|
@classmethod
|
|
@@ -115573,31 +115635,21 @@ class BlendData(bpy_struct):
|
|
|
115573
115635
|
:return: The number of deleted IDs.
|
|
115574
115636
|
"""
|
|
115575
115637
|
|
|
115576
|
-
def temp_data(self, filepath
|
|
115638
|
+
def temp_data(self, filepath=None) -> typing_extensions.Self:
|
|
115577
115639
|
"""A context manager that temporarily creates blender file data.
|
|
115578
115640
|
|
|
115579
115641
|
:param filepath: The file path for the newly temporary data. When None, the path of the currently open file is used.
|
|
115580
|
-
:type filepath: bytes | str | None
|
|
115581
115642
|
:return: Blend file data which is freed once the context exists.
|
|
115582
115643
|
:rtype: typing_extensions.Self
|
|
115583
115644
|
"""
|
|
115584
115645
|
|
|
115585
|
-
def user_map(
|
|
115586
|
-
|
|
115587
|
-
subset: collections.abc.Sequence | None,
|
|
115588
|
-
key_types: set[str] | None,
|
|
115589
|
-
value_types: set[str] | None,
|
|
115590
|
-
) -> dict:
|
|
115591
|
-
"""Returns a mapping of all ID data-blocks in current bpy.data to a set of all datablocks using them.For list of valid set members for key_types & value_types, see: `bpy.types.KeyingSetPath.id_type`.
|
|
115646
|
+
def user_map(self, subset, key_types, value_types):
|
|
115647
|
+
"""Returns a mapping of all ID data-blocks in current bpy.data to a set of all data-blocks using them.For list of valid set members for key_types & value_types, see: `bpy.types.KeyingSetPath.id_type`.
|
|
115592
115648
|
|
|
115593
115649
|
:param subset: When passed, only these data-blocks and their users will be included as keys/values in the map.
|
|
115594
|
-
:type subset: collections.abc.Sequence | None
|
|
115595
115650
|
:param key_types: Filter the keys mapped by ID types.
|
|
115596
|
-
:type key_types: set[str] | None
|
|
115597
115651
|
:param value_types: Filter the values in the set by ID types.
|
|
115598
|
-
:
|
|
115599
|
-
:return: dictionary of `bpy.types.ID` instances, with sets of ID's as their values.
|
|
115600
|
-
:rtype: dict
|
|
115652
|
+
:return: dictionary that maps data-blocks ID's to their users.
|
|
115601
115653
|
"""
|
|
115602
115654
|
|
|
115603
115655
|
class BlendImportContext(bpy_struct):
|
|
@@ -116782,6 +116834,7 @@ Utility function for (tail - head)(readonly)"""
|
|
|
116782
116834
|
matrix_local: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
116783
116835
|
| mathutils.Matrix
|
|
116784
116836
|
| None,
|
|
116837
|
+
*,
|
|
116785
116838
|
parent_matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
116786
116839
|
| mathutils.Matrix
|
|
116787
116840
|
| None = (
|
|
@@ -116839,6 +116892,7 @@ Utility function for (tail - head)(readonly)"""
|
|
|
116839
116892
|
cls,
|
|
116840
116893
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
116841
116894
|
| mathutils.Matrix,
|
|
116895
|
+
*,
|
|
116842
116896
|
axis: collections.abc.Iterable[float] | None = (0.0, 0.0, 0.0),
|
|
116843
116897
|
):
|
|
116844
116898
|
"""Convert a rotational matrix to the axis + roll representation. Note that the resulting value of the roll may not be as expected if the matrix has shear or negative determinant.
|
|
@@ -120402,7 +120456,7 @@ class Camera(ID, bpy_struct):
|
|
|
120402
120456
|
:type: typing.Literal['PERSP','ORTHO','PANO']
|
|
120403
120457
|
"""
|
|
120404
120458
|
|
|
120405
|
-
def view_frame(self, scene: Scene | None = None):
|
|
120459
|
+
def view_frame(self, *, scene: Scene | None = None):
|
|
120406
120460
|
"""Return 4 points for the cameras frame (before object transformation)
|
|
120407
120461
|
|
|
120408
120462
|
:param scene: Scene to use for aspect calculation, when omitted 1:1 aspect is used
|
|
@@ -131819,6 +131873,7 @@ class Curve(ID, bpy_struct):
|
|
|
131819
131873
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
131820
131874
|
| mathutils.Matrix
|
|
131821
131875
|
| None,
|
|
131876
|
+
*,
|
|
131822
131877
|
shape_keys: bool | None = False,
|
|
131823
131878
|
):
|
|
131824
131879
|
"""Transform curve by a matrix
|
|
@@ -132538,7 +132593,7 @@ class Curves(ID, bpy_struct):
|
|
|
132538
132593
|
:type sizes: collections.abc.Iterable[int] | None
|
|
132539
132594
|
"""
|
|
132540
132595
|
|
|
132541
|
-
def remove_curves(self, indices: collections.abc.Iterable[int] | None = (0)):
|
|
132596
|
+
def remove_curves(self, *, indices: collections.abc.Iterable[int] | None = (0)):
|
|
132542
132597
|
"""Remove all curves. If indices are provided, remove only the curves with the given indices.
|
|
132543
132598
|
|
|
132544
132599
|
:param indices: Indices, The indices of the curves to remove
|
|
@@ -132548,6 +132603,7 @@ class Curves(ID, bpy_struct):
|
|
|
132548
132603
|
def resize_curves(
|
|
132549
132604
|
self,
|
|
132550
132605
|
sizes: collections.abc.Iterable[int] | None,
|
|
132606
|
+
*,
|
|
132551
132607
|
indices: collections.abc.Iterable[int] | None = (0),
|
|
132552
132608
|
):
|
|
132553
132609
|
"""Resize all existing curves. If indices are provided, resize only the curves with the given indices. If the new size for a curve is smaller, the curve is trimmed. If the new size for a curve is larger, the new end values are default initialized.
|
|
@@ -132558,6 +132614,20 @@ class Curves(ID, bpy_struct):
|
|
|
132558
132614
|
:type indices: collections.abc.Iterable[int] | None
|
|
132559
132615
|
"""
|
|
132560
132616
|
|
|
132617
|
+
def set_types(
|
|
132618
|
+
self,
|
|
132619
|
+
*,
|
|
132620
|
+
type: bpy.typing.CurvesTypeItems | None = "CATMULL_ROM",
|
|
132621
|
+
indices: collections.abc.Iterable[int] | None = (0),
|
|
132622
|
+
):
|
|
132623
|
+
"""Set the curve type. If indices are provided, set only the types with the given curve indices.
|
|
132624
|
+
|
|
132625
|
+
:param type: Type
|
|
132626
|
+
:type type: bpy.typing.CurvesTypeItems | None
|
|
132627
|
+
:param indices: Indices, The indices of the curves to resize
|
|
132628
|
+
:type indices: collections.abc.Iterable[int] | None
|
|
132629
|
+
"""
|
|
132630
|
+
|
|
132561
132631
|
@classmethod
|
|
132562
132632
|
def bl_rna_get_subclass(cls, id: str | None, default=None) -> Struct:
|
|
132563
132633
|
"""
|
|
@@ -133111,7 +133181,7 @@ class Depsgraph(bpy_struct):
|
|
|
133111
133181
|
:type: ViewLayer
|
|
133112
133182
|
"""
|
|
133113
133183
|
|
|
133114
|
-
def debug_relations_graphviz(self, filepath: str = "") -> str:
|
|
133184
|
+
def debug_relations_graphviz(self, *, filepath: str = "") -> str:
|
|
133115
133185
|
"""debug_relations_graphviz
|
|
133116
133186
|
|
|
133117
133187
|
:param filepath: File Name, Optional output path for the graphviz debug file
|
|
@@ -135911,6 +135981,7 @@ class FCurve(bpy_struct):
|
|
|
135911
135981
|
self,
|
|
135912
135982
|
start: int | None,
|
|
135913
135983
|
end: int | None,
|
|
135984
|
+
*,
|
|
135914
135985
|
step: float | None = 1.0,
|
|
135915
135986
|
remove: typing.Literal["NONE", "IN_RANGE", "OUT_RANGE", "ALL"]
|
|
135916
135987
|
| None = "IN_RANGE",
|
|
@@ -156006,7 +156077,7 @@ class Gizmo(bpy_struct):
|
|
|
156006
156077
|
:type context: Context | None
|
|
156007
156078
|
"""
|
|
156008
156079
|
|
|
156009
|
-
def draw_select(self, context: Context | None, select_id: int | None = 0):
|
|
156080
|
+
def draw_select(self, context: Context | None, *, select_id: int | None = 0):
|
|
156010
156081
|
"""
|
|
156011
156082
|
|
|
156012
156083
|
:param context:
|
|
@@ -156075,6 +156146,7 @@ class Gizmo(bpy_struct):
|
|
|
156075
156146
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
156076
156147
|
| mathutils.Matrix
|
|
156077
156148
|
| None,
|
|
156149
|
+
*,
|
|
156078
156150
|
select_id: int | None = -1,
|
|
156079
156151
|
):
|
|
156080
156152
|
"""Draw a box
|
|
@@ -156090,6 +156162,7 @@ class Gizmo(bpy_struct):
|
|
|
156090
156162
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
156091
156163
|
| mathutils.Matrix
|
|
156092
156164
|
| None,
|
|
156165
|
+
*,
|
|
156093
156166
|
axis: bpy.typing.ObjectAxisItems | None = "POS_Z",
|
|
156094
156167
|
select_id: int | None = -1,
|
|
156095
156168
|
):
|
|
@@ -156108,6 +156181,7 @@ class Gizmo(bpy_struct):
|
|
|
156108
156181
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
156109
156182
|
| mathutils.Matrix
|
|
156110
156183
|
| None,
|
|
156184
|
+
*,
|
|
156111
156185
|
axis: bpy.typing.ObjectAxisItems | None = "POS_Z",
|
|
156112
156186
|
select_id: int | None = -1,
|
|
156113
156187
|
):
|
|
@@ -156122,7 +156196,7 @@ class Gizmo(bpy_struct):
|
|
|
156122
156196
|
"""
|
|
156123
156197
|
|
|
156124
156198
|
def target_set_prop(
|
|
156125
|
-
self, target: str, data: typing.Any, property: str, index: int | None = -1
|
|
156199
|
+
self, target: str, data: typing.Any, property: str, *, index: int | None = -1
|
|
156126
156200
|
):
|
|
156127
156201
|
"""
|
|
156128
156202
|
|
|
@@ -156137,7 +156211,7 @@ class Gizmo(bpy_struct):
|
|
|
156137
156211
|
"""
|
|
156138
156212
|
|
|
156139
156213
|
def target_set_operator(
|
|
156140
|
-
self, operator: str, index: int | None = 0
|
|
156214
|
+
self, operator: str, *, index: int | None = 0
|
|
156141
156215
|
) -> OperatorProperties:
|
|
156142
156216
|
"""Operator to run when activating the gizmo (overrides property targets)
|
|
156143
156217
|
|
|
@@ -156183,8 +156257,8 @@ class Gizmo(bpy_struct):
|
|
|
156183
156257
|
|
|
156184
156258
|
:param type: The type of shape to create in (POINTS, LINES, TRIS, LINE_STRIP).
|
|
156185
156259
|
:type type: str | None
|
|
156186
|
-
:param verts:
|
|
156187
|
-
:return: The newly created shape.
|
|
156260
|
+
:param verts: Sequence of 2D or 3D coordinates.
|
|
156261
|
+
:return: The newly created shape (the return type make change).
|
|
156188
156262
|
"""
|
|
156189
156263
|
|
|
156190
156264
|
@classmethod
|
|
@@ -156221,7 +156295,7 @@ class Gizmo(bpy_struct):
|
|
|
156221
156295
|
|
|
156222
156296
|
:param target: Target property name.
|
|
156223
156297
|
:type target: str | None
|
|
156224
|
-
:return: The value of the target property.
|
|
156298
|
+
:return: The value of the target property as a value or array based on the target type.
|
|
156225
156299
|
"""
|
|
156226
156300
|
|
|
156227
156301
|
def target_set_handler(
|
|
@@ -156239,7 +156313,7 @@ class Gizmo(bpy_struct):
|
|
|
156239
156313
|
:type get: collections.abc.Callable | None
|
|
156240
156314
|
:param set: Function that takes a single value argument and applies it.
|
|
156241
156315
|
:type set: collections.abc.Callable | None
|
|
156242
|
-
:param range: Function that returns a (min, max) tuple for gizmos that use a range.
|
|
156316
|
+
:param range: Function that returns a (min, max) tuple for gizmos that use a range. The returned value is not used.
|
|
156243
156317
|
:type range: collections.abc.Callable | None
|
|
156244
156318
|
"""
|
|
156245
156319
|
|
|
@@ -157465,7 +157539,7 @@ class GreasePencilDrawing(bpy_struct):
|
|
|
157465
157539
|
:type sizes: collections.abc.Iterable[int] | None
|
|
157466
157540
|
"""
|
|
157467
157541
|
|
|
157468
|
-
def remove_strokes(self, indices: collections.abc.Iterable[int] | None = (0)):
|
|
157542
|
+
def remove_strokes(self, *, indices: collections.abc.Iterable[int] | None = (0)):
|
|
157469
157543
|
"""Remove all strokes. If indices are provided, remove only the strokes with the given indices.
|
|
157470
157544
|
|
|
157471
157545
|
:param indices: Indices, The indices of the strokes to remove
|
|
@@ -157475,6 +157549,7 @@ class GreasePencilDrawing(bpy_struct):
|
|
|
157475
157549
|
def resize_strokes(
|
|
157476
157550
|
self,
|
|
157477
157551
|
sizes: collections.abc.Iterable[int] | None,
|
|
157552
|
+
*,
|
|
157478
157553
|
indices: collections.abc.Iterable[int] | None = (0),
|
|
157479
157554
|
):
|
|
157480
157555
|
"""Resize all existing strokes. If indices are provided, resize only the strokes with the given indices. If the new size for a stroke is smaller, the stroke is trimmed. If the new size for a stroke is larger, the new end values are default initialized.
|
|
@@ -157485,6 +157560,20 @@ class GreasePencilDrawing(bpy_struct):
|
|
|
157485
157560
|
:type indices: collections.abc.Iterable[int] | None
|
|
157486
157561
|
"""
|
|
157487
157562
|
|
|
157563
|
+
def set_types(
|
|
157564
|
+
self,
|
|
157565
|
+
*,
|
|
157566
|
+
type: bpy.typing.CurvesTypeItems | None = "CATMULL_ROM",
|
|
157567
|
+
indices: collections.abc.Iterable[int] | None = (0),
|
|
157568
|
+
):
|
|
157569
|
+
"""Set the curve type. If indices are provided, set only the types with the given curve indices.
|
|
157570
|
+
|
|
157571
|
+
:param type: Type
|
|
157572
|
+
:type type: bpy.typing.CurvesTypeItems | None
|
|
157573
|
+
:param indices: Indices, The indices of the curves to resize
|
|
157574
|
+
:type indices: collections.abc.Iterable[int] | None
|
|
157575
|
+
"""
|
|
157576
|
+
|
|
157488
157577
|
def tag_positions_changed(self):
|
|
157489
157578
|
"""Indicate that the positions of points in the drawing have changed"""
|
|
157490
157579
|
|
|
@@ -161927,6 +162016,7 @@ class ID(bpy_struct):
|
|
|
161927
162016
|
def rename(
|
|
161928
162017
|
self,
|
|
161929
162018
|
name: str,
|
|
162019
|
+
*,
|
|
161930
162020
|
mode: typing.Literal["NEVER", "ALWAYS", "SAME_ROOT"] | None = "NEVER",
|
|
161931
162021
|
) -> typing.Literal[
|
|
161932
162022
|
"UNCHANGED",
|
|
@@ -161995,7 +162085,7 @@ class ID(bpy_struct):
|
|
|
161995
162085
|
"""Generate preview image (might be scheduled in a background thread)"""
|
|
161996
162086
|
|
|
161997
162087
|
def override_create(
|
|
161998
|
-
self, remap_local_usages: bool | None = False
|
|
162088
|
+
self, *, remap_local_usages: bool | None = False
|
|
161999
162089
|
) -> typing_extensions.Self:
|
|
162000
162090
|
"""Create an overridden local copy of this linked data-block (not supported for all data-blocks)
|
|
162001
162091
|
|
|
@@ -162009,6 +162099,7 @@ class ID(bpy_struct):
|
|
|
162009
162099
|
self,
|
|
162010
162100
|
scene: Scene,
|
|
162011
162101
|
view_layer: ViewLayer,
|
|
162102
|
+
*,
|
|
162012
162103
|
reference: typing_extensions.Self | None = None,
|
|
162013
162104
|
do_fully_editable: bool | None = False,
|
|
162014
162105
|
) -> typing_extensions.Self:
|
|
@@ -162041,6 +162132,7 @@ class ID(bpy_struct):
|
|
|
162041
162132
|
|
|
162042
162133
|
def make_local(
|
|
162043
162134
|
self,
|
|
162135
|
+
*,
|
|
162044
162136
|
clear_proxy: bool | None = True,
|
|
162045
162137
|
clear_liboverride: bool | None = False,
|
|
162046
162138
|
clear_asset_data: bool | None = True,
|
|
@@ -162077,7 +162169,7 @@ class ID(bpy_struct):
|
|
|
162077
162169
|
"""Clear animation on this ID"""
|
|
162078
162170
|
|
|
162079
162171
|
def update_tag(
|
|
162080
|
-
self, refresh: set[typing.Literal["OBJECT", "DATA", "TIME"]] | None = {}
|
|
162172
|
+
self, *, refresh: set[typing.Literal["OBJECT", "DATA", "TIME"]] | None = {}
|
|
162081
162173
|
):
|
|
162082
162174
|
"""Tag the ID to update its display data, e.g. when calling `bpy.types.Scene.update`
|
|
162083
162175
|
|
|
@@ -162151,7 +162243,10 @@ class IDOverrideLibrary(bpy_struct):
|
|
|
162151
162243
|
"""Update the library override operations based on the differences between this override ID and its reference"""
|
|
162152
162244
|
|
|
162153
162245
|
def reset(
|
|
162154
|
-
self,
|
|
162246
|
+
self,
|
|
162247
|
+
*,
|
|
162248
|
+
do_hierarchy: bool | None = True,
|
|
162249
|
+
set_system_override: bool | None = False,
|
|
162155
162250
|
):
|
|
162156
162251
|
"""Reset this override to match again its linked reference ID
|
|
162157
162252
|
|
|
@@ -162161,7 +162256,7 @@ class IDOverrideLibrary(bpy_struct):
|
|
|
162161
162256
|
:type set_system_override: bool | None
|
|
162162
162257
|
"""
|
|
162163
162258
|
|
|
162164
|
-
def destroy(self, do_hierarchy: bool | None = True):
|
|
162259
|
+
def destroy(self, *, do_hierarchy: bool | None = True):
|
|
162165
162260
|
"""Delete this override ID and remap its usages to its linked reference ID instead
|
|
162166
162261
|
|
|
162167
162262
|
:param do_hierarchy: Also delete all the dependencies of this override and remap their usages to their reference linked IDs
|
|
@@ -162171,6 +162266,7 @@ class IDOverrideLibrary(bpy_struct):
|
|
|
162171
162266
|
def resync(
|
|
162172
162267
|
self,
|
|
162173
162268
|
scene: Scene,
|
|
162269
|
+
*,
|
|
162174
162270
|
view_layer: ViewLayer | None = None,
|
|
162175
162271
|
residual_storage: Collection | None = None,
|
|
162176
162272
|
do_hierarchy_enforce: bool | None = False,
|
|
@@ -162858,7 +162954,7 @@ class Image(ID, bpy_struct):
|
|
|
162858
162954
|
"""
|
|
162859
162955
|
|
|
162860
162956
|
def save_render(
|
|
162861
|
-
self, filepath: str, scene: Scene | None = None, quality: int | None = 0
|
|
162957
|
+
self, filepath: str, *, scene: Scene | None = None, quality: int | None = 0
|
|
162862
162958
|
):
|
|
162863
162959
|
"""Save image to a specific path using a scenes render settings
|
|
162864
162960
|
|
|
@@ -162870,7 +162966,7 @@ class Image(ID, bpy_struct):
|
|
|
162870
162966
|
:type quality: int | None
|
|
162871
162967
|
"""
|
|
162872
162968
|
|
|
162873
|
-
def save(self, filepath: str = "", quality: int | None = 0):
|
|
162969
|
+
def save(self, *, filepath: str = "", quality: int | None = 0):
|
|
162874
162970
|
"""Save image
|
|
162875
162971
|
|
|
162876
162972
|
:param filepath: Output path, uses image data-block filepath if not specified
|
|
@@ -162879,7 +162975,7 @@ class Image(ID, bpy_struct):
|
|
|
162879
162975
|
:type quality: int | None
|
|
162880
162976
|
"""
|
|
162881
162977
|
|
|
162882
|
-
def pack(self, data: str = "", data_len: int | None = 0):
|
|
162978
|
+
def pack(self, *, data: str = "", data_len: int | None = 0):
|
|
162883
162979
|
"""Pack an image as embedded data into the .blend file
|
|
162884
162980
|
|
|
162885
162981
|
:param data: data, Raw data (bytes, exact content of the embedded file)
|
|
@@ -162888,7 +162984,7 @@ class Image(ID, bpy_struct):
|
|
|
162888
162984
|
:type data_len: int | None
|
|
162889
162985
|
"""
|
|
162890
162986
|
|
|
162891
|
-
def unpack(self, method: bpy.typing.UnpackMethodItems | None = "USE_LOCAL"):
|
|
162987
|
+
def unpack(self, *, method: bpy.typing.UnpackMethodItems | None = "USE_LOCAL"):
|
|
162892
162988
|
"""Save an image packed in the .blend file to disk
|
|
162893
162989
|
|
|
162894
162990
|
:param method: method, How to unpack
|
|
@@ -162905,6 +163001,7 @@ class Image(ID, bpy_struct):
|
|
|
162905
163001
|
self,
|
|
162906
163002
|
width: int | None,
|
|
162907
163003
|
height: int | None,
|
|
163004
|
+
*,
|
|
162908
163005
|
frame: int | None = 0,
|
|
162909
163006
|
tile_index: int | None = 0,
|
|
162910
163007
|
):
|
|
@@ -162922,6 +163019,7 @@ class Image(ID, bpy_struct):
|
|
|
162922
163019
|
|
|
162923
163020
|
def gl_touch(
|
|
162924
163021
|
self,
|
|
163022
|
+
*,
|
|
162925
163023
|
frame: int | None = 0,
|
|
162926
163024
|
layer_index: int | None = 0,
|
|
162927
163025
|
pass_index: int | None = 0,
|
|
@@ -162940,6 +163038,7 @@ class Image(ID, bpy_struct):
|
|
|
162940
163038
|
|
|
162941
163039
|
def gl_load(
|
|
162942
163040
|
self,
|
|
163041
|
+
*,
|
|
162943
163042
|
frame: int | None = 0,
|
|
162944
163043
|
layer_index: int | None = 0,
|
|
162945
163044
|
pass_index: int | None = 0,
|
|
@@ -162959,7 +163058,7 @@ class Image(ID, bpy_struct):
|
|
|
162959
163058
|
def gl_free(self):
|
|
162960
163059
|
"""Free the image from OpenGL graphics memory"""
|
|
162961
163060
|
|
|
162962
|
-
def filepath_from_user(self, image_user: ImageUser | None = None) -> str:
|
|
163061
|
+
def filepath_from_user(self, *, image_user: ImageUser | None = None) -> str:
|
|
162963
163062
|
"""Return the absolute path to the filepath of an image frame specified by the image user
|
|
162964
163063
|
|
|
162965
163064
|
:param image_user: Image user of the image to get filepath for
|
|
@@ -164617,7 +164716,7 @@ class KeyMapItem(bpy_struct):
|
|
|
164617
164716
|
:rtype: bool
|
|
164618
164717
|
"""
|
|
164619
164718
|
|
|
164620
|
-
def to_string(self, compact: bool | None = False) -> str:
|
|
164719
|
+
def to_string(self, *, compact: bool | None = False) -> str:
|
|
164621
164720
|
"""to_string
|
|
164622
164721
|
|
|
164623
164722
|
:param compact: Compact
|
|
@@ -165405,6 +165504,7 @@ class Lattice(ID, bpy_struct):
|
|
|
165405
165504
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
165406
165505
|
| mathutils.Matrix
|
|
165407
165506
|
| None,
|
|
165507
|
+
*,
|
|
165408
165508
|
shape_keys: bool | None = False,
|
|
165409
165509
|
):
|
|
165410
165510
|
"""Transform lattice by a matrix
|
|
@@ -171487,12 +171587,6 @@ class Material(ID, bpy_struct):
|
|
|
171487
171587
|
:type: float
|
|
171488
171588
|
"""
|
|
171489
171589
|
|
|
171490
|
-
shadow_method: typing.Literal["NONE", "OPAQUE", "CLIP", "HASHED"]
|
|
171491
|
-
""" Shadow mapping method
|
|
171492
|
-
|
|
171493
|
-
:type: typing.Literal['NONE','OPAQUE','CLIP','HASHED']
|
|
171494
|
-
"""
|
|
171495
|
-
|
|
171496
171590
|
show_transparent_back: bool
|
|
171497
171591
|
""" Render multiple transparent layers (may introduce transparency sorting problems) (Deprecated: use 'use_tranparency_overlap')
|
|
171498
171592
|
|
|
@@ -172027,10 +172121,10 @@ class Menu(bpy_struct):
|
|
|
172027
172121
|
def is_extended(cls): ...
|
|
172028
172122
|
def path_menu(
|
|
172029
172123
|
self,
|
|
172030
|
-
searchpaths
|
|
172124
|
+
searchpaths,
|
|
172031
172125
|
operator: str | None,
|
|
172032
172126
|
*,
|
|
172033
|
-
props_default
|
|
172127
|
+
props_default=None,
|
|
172034
172128
|
prop_filepath: str | None = "filepath",
|
|
172035
172129
|
filter_ext: collections.abc.Callable | None = None,
|
|
172036
172130
|
filter_path=None,
|
|
@@ -172041,11 +172135,9 @@ class Menu(bpy_struct):
|
|
|
172041
172135
|
"""Populate a menu from a list of paths.
|
|
172042
172136
|
|
|
172043
172137
|
:param searchpaths: Paths to scan.
|
|
172044
|
-
:type searchpaths: list[str] | None
|
|
172045
172138
|
:param operator: The operator id to use with each file.
|
|
172046
172139
|
:type operator: str | None
|
|
172047
172140
|
:param props_default: Properties to assign to each operator.
|
|
172048
|
-
:type props_default: dict | None
|
|
172049
172141
|
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
172050
172142
|
:type prop_filepath: str | None
|
|
172051
172143
|
:param filter_ext: Optional callback that takes the file extensions.
|
|
@@ -172404,6 +172496,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172404
172496
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
172405
172497
|
| mathutils.Matrix
|
|
172406
172498
|
| None,
|
|
172499
|
+
*,
|
|
172407
172500
|
shape_keys: bool | None = False,
|
|
172408
172501
|
):
|
|
172409
172502
|
"""Transform mesh vertices by a matrix (Warning: inverts normals if matrix is negative)
|
|
@@ -172417,7 +172510,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172417
172510
|
def flip_normals(self):
|
|
172418
172511
|
"""Invert winding of all polygons (clears tessellation, does not handle custom normals)"""
|
|
172419
172512
|
|
|
172420
|
-
def set_sharp_from_angle(self, angle: float | None = 3.14159):
|
|
172513
|
+
def set_sharp_from_angle(self, *, angle: float | None = 3.14159):
|
|
172421
172514
|
"""Reset and fill the "sharp_edge" attribute based on the angle of faces neighboring manifold edges
|
|
172422
172515
|
|
|
172423
172516
|
:param angle: Angle, Angle between faces beyond which edges are marked sharp
|
|
@@ -172427,7 +172520,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172427
172520
|
def split_faces(self):
|
|
172428
172521
|
"""Split faces based on the edge angle"""
|
|
172429
172522
|
|
|
172430
|
-
def calc_tangents(self, uvmap: str = ""):
|
|
172523
|
+
def calc_tangents(self, *, uvmap: str = ""):
|
|
172431
172524
|
"""Compute tangents and bitangent signs, to be used together with the split normals to get a complete tangent space for normal mapping (split normals are also computed if not yet present)
|
|
172432
172525
|
|
|
172433
172526
|
:param uvmap: Name of the UV map to use for tangent space computation
|
|
@@ -172440,7 +172533,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172440
172533
|
def calc_loop_triangles(self):
|
|
172441
172534
|
"""Calculate loop triangle tessellation (supports editmode too)"""
|
|
172442
172535
|
|
|
172443
|
-
def calc_smooth_groups(self, use_bitflags: bool | None = False):
|
|
172536
|
+
def calc_smooth_groups(self, *, use_bitflags: bool | None = False):
|
|
172444
172537
|
"""Calculate smooth groups from sharp edges
|
|
172445
172538
|
|
|
172446
172539
|
:param use_bitflags: Produce bitflags groups instead of simple numeric values
|
|
@@ -172469,7 +172562,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172469
172562
|
"""
|
|
172470
172563
|
|
|
172471
172564
|
def update(
|
|
172472
|
-
self, calc_edges: bool | None = False, calc_edges_loose: bool | None = False
|
|
172565
|
+
self, *, calc_edges: bool | None = False, calc_edges_loose: bool | None = False
|
|
172473
172566
|
):
|
|
172474
172567
|
"""update
|
|
172475
172568
|
|
|
@@ -172484,6 +172577,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172484
172577
|
|
|
172485
172578
|
def unit_test_compare(
|
|
172486
172579
|
self,
|
|
172580
|
+
*,
|
|
172487
172581
|
mesh: typing_extensions.Self | None = None,
|
|
172488
172582
|
threshold: float | None = 7.1526e-06,
|
|
172489
172583
|
) -> str:
|
|
@@ -172501,7 +172595,7 @@ class Mesh(ID, bpy_struct):
|
|
|
172501
172595
|
"""Remove all geometry from the mesh. Note that this does not free shape keys or materials."""
|
|
172502
172596
|
|
|
172503
172597
|
def validate(
|
|
172504
|
-
self, verbose: bool | None = False, clean_customdata: bool | None = True
|
|
172598
|
+
self, *, verbose: bool | None = False, clean_customdata: bool | None = True
|
|
172505
172599
|
) -> bool:
|
|
172506
172600
|
"""Validate geometry, return True when the mesh has had invalid geometry corrected/removed
|
|
172507
172601
|
|
|
@@ -172529,27 +172623,18 @@ class Mesh(ID, bpy_struct):
|
|
|
172529
172623
|
|
|
172530
172624
|
def edge_creases_ensure(self): ...
|
|
172531
172625
|
def edge_creases_remove(self): ...
|
|
172532
|
-
def from_pydata(
|
|
172533
|
-
self,
|
|
172534
|
-
vertices: list | None,
|
|
172535
|
-
edges: list | None,
|
|
172536
|
-
faces: list | None,
|
|
172537
|
-
shade_flat=True,
|
|
172538
|
-
):
|
|
172626
|
+
def from_pydata(self, vertices, edges, faces, shade_flat=True):
|
|
172539
172627
|
"""Make a mesh from a list of vertices/edges/faces
|
|
172540
172628
|
Until we have a nicer way to make geometry, use this.
|
|
172541
172629
|
|
|
172542
172630
|
:param vertices: float triplets each representing (X, Y, Z)
|
|
172543
172631
|
eg: [(0.0, 1.0, 0.5), ...].
|
|
172544
|
-
:type vertices: list | None
|
|
172545
172632
|
:param edges: int pairs, each pair contains two indices to the
|
|
172546
172633
|
vertices argument. eg: [(1, 2), ...]
|
|
172547
172634
|
|
|
172548
172635
|
When an empty iterable is passed in, the edges are inferred from the polygons.
|
|
172549
|
-
:type edges: list | None
|
|
172550
172636
|
:param faces: iterator of faces, each faces contains three or more indices to
|
|
172551
172637
|
the vertices argument. eg: [(5, 6, 8, 9), (1, 2, 3), ...]
|
|
172552
|
-
:type faces: list | None
|
|
172553
172638
|
:param shade_flat:
|
|
172554
172639
|
"""
|
|
172555
172640
|
|
|
@@ -179688,6 +179773,7 @@ class NodeTreeInterface(bpy_struct):
|
|
|
179688
179773
|
def new_socket(
|
|
179689
179774
|
self,
|
|
179690
179775
|
name: str,
|
|
179776
|
+
*,
|
|
179691
179777
|
description: str = "",
|
|
179692
179778
|
in_out: typing.Literal["INPUT", "OUTPUT"] | None = "INPUT",
|
|
179693
179779
|
socket_type: str | None = "DEFAULT",
|
|
@@ -179716,7 +179802,7 @@ class NodeTreeInterface(bpy_struct):
|
|
|
179716
179802
|
"""
|
|
179717
179803
|
|
|
179718
179804
|
def new_panel(
|
|
179719
|
-
self, name: str, description: str = "", default_closed: bool | None = False
|
|
179805
|
+
self, name: str, *, description: str = "", default_closed: bool | None = False
|
|
179720
179806
|
) -> NodeTreeInterfacePanel:
|
|
179721
179807
|
"""Add a new panel to the interface
|
|
179722
179808
|
|
|
@@ -179740,7 +179826,7 @@ class NodeTreeInterface(bpy_struct):
|
|
|
179740
179826
|
"""
|
|
179741
179827
|
|
|
179742
179828
|
def remove(
|
|
179743
|
-
self, item: NodeTreeInterfaceItem, move_content_to_parent: bool | None = True
|
|
179829
|
+
self, item: NodeTreeInterfaceItem, *, move_content_to_parent: bool | None = True
|
|
179744
179830
|
):
|
|
179745
179831
|
"""Remove an item from the interface
|
|
179746
179832
|
|
|
@@ -183820,7 +183906,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183820
183906
|
:type: tuple[Scene, ...]
|
|
183821
183907
|
"""
|
|
183822
183908
|
|
|
183823
|
-
def select_get(self, view_layer: ViewLayer | None = None) -> bool:
|
|
183909
|
+
def select_get(self, *, view_layer: ViewLayer | None = None) -> bool:
|
|
183824
183910
|
"""Test if the object is selected. The selection state is per view layer.
|
|
183825
183911
|
|
|
183826
183912
|
:param view_layer: Use this instead of the active view layer
|
|
@@ -183829,7 +183915,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183829
183915
|
:rtype: bool
|
|
183830
183916
|
"""
|
|
183831
183917
|
|
|
183832
|
-
def select_set(self, state: bool | None, view_layer: ViewLayer | None = None):
|
|
183918
|
+
def select_set(self, state: bool | None, *, view_layer: ViewLayer | None = None):
|
|
183833
183919
|
"""Select or deselect the object. The selection state is per view layer.
|
|
183834
183920
|
|
|
183835
183921
|
:param state: Selection state to define
|
|
@@ -183838,7 +183924,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183838
183924
|
:type view_layer: ViewLayer | None
|
|
183839
183925
|
"""
|
|
183840
183926
|
|
|
183841
|
-
def hide_get(self, view_layer: ViewLayer | None = None) -> bool:
|
|
183927
|
+
def hide_get(self, *, view_layer: ViewLayer | None = None) -> bool:
|
|
183842
183928
|
"""Test if the object is hidden for viewport editing. This hiding state is per view layer.
|
|
183843
183929
|
|
|
183844
183930
|
:param view_layer: Use this instead of the active view layer
|
|
@@ -183847,7 +183933,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183847
183933
|
:rtype: bool
|
|
183848
183934
|
"""
|
|
183849
183935
|
|
|
183850
|
-
def hide_set(self, state: bool | None, view_layer: ViewLayer | None = None):
|
|
183936
|
+
def hide_set(self, state: bool | None, *, view_layer: ViewLayer | None = None):
|
|
183851
183937
|
"""Hide the object for viewport editing. This hiding state is per view layer.
|
|
183852
183938
|
|
|
183853
183939
|
:param state: Hide state to define
|
|
@@ -183857,7 +183943,10 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183857
183943
|
"""
|
|
183858
183944
|
|
|
183859
183945
|
def visible_get(
|
|
183860
|
-
self,
|
|
183946
|
+
self,
|
|
183947
|
+
*,
|
|
183948
|
+
view_layer: ViewLayer | None = None,
|
|
183949
|
+
viewport: SpaceView3D | None = None,
|
|
183861
183950
|
) -> bool:
|
|
183862
183951
|
"""Test if the object is visible in the 3D viewport, taking into account all visibility settings
|
|
183863
183952
|
|
|
@@ -183869,7 +183958,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183869
183958
|
:rtype: bool
|
|
183870
183959
|
"""
|
|
183871
183960
|
|
|
183872
|
-
def holdout_get(self, view_layer: ViewLayer | None = None) -> bool:
|
|
183961
|
+
def holdout_get(self, *, view_layer: ViewLayer | None = None) -> bool:
|
|
183873
183962
|
"""Test if object is masked in the view layer
|
|
183874
183963
|
|
|
183875
183964
|
:param view_layer: Use this instead of the active view layer
|
|
@@ -183878,7 +183967,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183878
183967
|
:rtype: bool
|
|
183879
183968
|
"""
|
|
183880
183969
|
|
|
183881
|
-
def indirect_only_get(self, view_layer: ViewLayer | None = None) -> bool:
|
|
183970
|
+
def indirect_only_get(self, *, view_layer: ViewLayer | None = None) -> bool:
|
|
183882
183971
|
"""Test if object is set to contribute only indirectly (through shadows and reflections) in the view layer
|
|
183883
183972
|
|
|
183884
183973
|
:param view_layer: Use this instead of the active view layer
|
|
@@ -183916,6 +184005,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183916
184005
|
|
|
183917
184006
|
def convert_space(
|
|
183918
184007
|
self,
|
|
184008
|
+
*,
|
|
183919
184009
|
pose_bone: PoseBone | None = None,
|
|
183920
184010
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
183921
184011
|
| mathutils.Matrix
|
|
@@ -183971,6 +184061,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
183971
184061
|
def calc_matrix_camera(
|
|
183972
184062
|
self,
|
|
183973
184063
|
depsgraph: Depsgraph | None,
|
|
184064
|
+
*,
|
|
183974
184065
|
x: int | None = 1,
|
|
183975
184066
|
y: int | None = 1,
|
|
183976
184067
|
scale_x: float | None = 1.0,
|
|
@@ -184017,6 +184108,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184017
184108
|
|
|
184018
184109
|
def crazyspace_displacement_to_deformed(
|
|
184019
184110
|
self,
|
|
184111
|
+
*,
|
|
184020
184112
|
vertex_index: int | None = 0,
|
|
184021
184113
|
displacement: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
184022
184114
|
0.0,
|
|
@@ -184036,6 +184128,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184036
184128
|
|
|
184037
184129
|
def crazyspace_displacement_to_original(
|
|
184038
184130
|
self,
|
|
184131
|
+
*,
|
|
184039
184132
|
vertex_index: int | None = 0,
|
|
184040
184133
|
displacement: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
184041
184134
|
0.0,
|
|
@@ -184058,6 +184151,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184058
184151
|
|
|
184059
184152
|
def to_mesh(
|
|
184060
184153
|
self,
|
|
184154
|
+
*,
|
|
184061
184155
|
preserve_all_data_layers: bool | None = False,
|
|
184062
184156
|
depsgraph: Depsgraph | None = None,
|
|
184063
184157
|
) -> Mesh:
|
|
@@ -184075,7 +184169,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184075
184169
|
"""Clears mesh data-block created by to_mesh()"""
|
|
184076
184170
|
|
|
184077
184171
|
def to_curve(
|
|
184078
|
-
self, depsgraph: Depsgraph | None, apply_modifiers: bool | None = False
|
|
184172
|
+
self, depsgraph: Depsgraph | None, *, apply_modifiers: bool | None = False
|
|
184079
184173
|
) -> Curve:
|
|
184080
184174
|
"""Create a Curve data-block from the current state of the object. This only works for curve and text objects. The object owns the data-block. To force free it, use to_curve_clear(). The result is temporary and cannot be used by objects from the main database.
|
|
184081
184175
|
|
|
@@ -184098,7 +184192,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184098
184192
|
"""
|
|
184099
184193
|
|
|
184100
184194
|
def shape_key_add(
|
|
184101
|
-
self, name: str = "Key", from_mix: bool | None = True
|
|
184195
|
+
self, *, name: str = "Key", from_mix: bool | None = True
|
|
184102
184196
|
) -> ShapeKey:
|
|
184103
184197
|
"""Add shape key to this object
|
|
184104
184198
|
|
|
@@ -184124,6 +184218,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184124
184218
|
self,
|
|
184125
184219
|
origin: collections.abc.Sequence[float] | mathutils.Vector | None,
|
|
184126
184220
|
direction: collections.abc.Sequence[float] | mathutils.Vector | None,
|
|
184221
|
+
*,
|
|
184127
184222
|
distance: float | None = 1.70141e38,
|
|
184128
184223
|
depsgraph: Depsgraph | None = None,
|
|
184129
184224
|
):
|
|
@@ -184149,6 +184244,7 @@ Warning: Only takes into account object parenting, so e.g. in case of bone paren
|
|
|
184149
184244
|
def closest_point_on_mesh(
|
|
184150
184245
|
self,
|
|
184151
184246
|
origin: collections.abc.Sequence[float] | mathutils.Vector | None,
|
|
184247
|
+
*,
|
|
184152
184248
|
distance: float | None = 1.84467e19,
|
|
184153
184249
|
depsgraph: Depsgraph | None = None,
|
|
184154
184250
|
):
|
|
@@ -184905,11 +185001,10 @@ expanding an operator into a menu.
|
|
|
184905
185001
|
"""
|
|
184906
185002
|
|
|
184907
185003
|
@classmethod
|
|
184908
|
-
def poll_message_set(cls, message
|
|
185004
|
+
def poll_message_set(cls, message, *args):
|
|
184909
185005
|
"""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.
|
|
184910
185006
|
|
|
184911
185007
|
:param message: The message or a function that returns the message.
|
|
184912
|
-
:type message: str | None
|
|
184913
185008
|
:param args:
|
|
184914
185009
|
"""
|
|
184915
185010
|
|
|
@@ -188141,7 +188236,7 @@ class ParticleSystem(bpy_struct):
|
|
|
188141
188236
|
"""
|
|
188142
188237
|
|
|
188143
188238
|
def co_hair(
|
|
188144
|
-
self, object: Object, particle_no: int | None = 0, step: int | None = 0
|
|
188239
|
+
self, object: Object, *, particle_no: int | None = 0, step: int | None = 0
|
|
188145
188240
|
) -> mathutils.Vector:
|
|
188146
188241
|
"""Obtain cache hair data
|
|
188147
188242
|
|
|
@@ -188159,6 +188254,7 @@ class ParticleSystem(bpy_struct):
|
|
|
188159
188254
|
self,
|
|
188160
188255
|
modifier: ParticleSystemModifier,
|
|
188161
188256
|
particle: Particle,
|
|
188257
|
+
*,
|
|
188162
188258
|
particle_no: int | None = 0,
|
|
188163
188259
|
uv_no: int | None = 0,
|
|
188164
188260
|
) -> mathutils.Vector:
|
|
@@ -188180,6 +188276,7 @@ class ParticleSystem(bpy_struct):
|
|
|
188180
188276
|
self,
|
|
188181
188277
|
modifier: ParticleSystemModifier,
|
|
188182
188278
|
particle: Particle,
|
|
188279
|
+
*,
|
|
188183
188280
|
particle_no: int | None = 0,
|
|
188184
188281
|
vcol_no: int | None = 0,
|
|
188185
188282
|
) -> mathutils.Color:
|
|
@@ -188758,48 +188855,18 @@ class PointCloud(ID, bpy_struct):
|
|
|
188758
188855
|
class PointLight(Light, ID, bpy_struct):
|
|
188759
188856
|
"""Omnidirectional point Light"""
|
|
188760
188857
|
|
|
188761
|
-
contact_shadow_bias: float
|
|
188762
|
-
""" Bias to avoid self shadowing
|
|
188763
|
-
|
|
188764
|
-
:type: float
|
|
188765
|
-
"""
|
|
188766
|
-
|
|
188767
|
-
contact_shadow_distance: float
|
|
188768
|
-
""" World space distance in which to search for screen space occluder
|
|
188769
|
-
|
|
188770
|
-
:type: float
|
|
188771
|
-
"""
|
|
188772
|
-
|
|
188773
|
-
contact_shadow_thickness: float
|
|
188774
|
-
""" Pixel thickness used to detect occlusion
|
|
188775
|
-
|
|
188776
|
-
:type: float
|
|
188777
|
-
"""
|
|
188778
|
-
|
|
188779
188858
|
energy: float
|
|
188780
188859
|
""" Light energy emitted over the entire area of the light in all directions
|
|
188781
188860
|
|
|
188782
188861
|
:type: float
|
|
188783
188862
|
"""
|
|
188784
188863
|
|
|
188785
|
-
shadow_buffer_bias: float
|
|
188786
|
-
""" Bias for reducing self shadowing
|
|
188787
|
-
|
|
188788
|
-
:type: float
|
|
188789
|
-
"""
|
|
188790
|
-
|
|
188791
188864
|
shadow_buffer_clip_start: float
|
|
188792
188865
|
""" Shadow map clip start, below which objects will not generate shadows
|
|
188793
188866
|
|
|
188794
188867
|
:type: float
|
|
188795
188868
|
"""
|
|
188796
188869
|
|
|
188797
|
-
shadow_color: mathutils.Color
|
|
188798
|
-
""" Color of shadows cast by the light
|
|
188799
|
-
|
|
188800
|
-
:type: mathutils.Color
|
|
188801
|
-
"""
|
|
188802
|
-
|
|
188803
188870
|
shadow_filter_radius: float
|
|
188804
188871
|
""" Blur shadow aliasing using Percentage Closer Filtering
|
|
188805
188872
|
|
|
@@ -188830,12 +188897,6 @@ class PointLight(Light, ID, bpy_struct):
|
|
|
188830
188897
|
:type: bool
|
|
188831
188898
|
"""
|
|
188832
188899
|
|
|
188833
|
-
use_contact_shadow: bool
|
|
188834
|
-
""" Use screen space ray-tracing to have correct shadowing near occluder, or for small features that does not appear in shadow maps
|
|
188835
|
-
|
|
188836
|
-
:type: bool
|
|
188837
|
-
"""
|
|
188838
|
-
|
|
188839
188900
|
use_shadow_jitter: bool
|
|
188840
188901
|
""" Enable jittered soft shadows to increase shadow precision (disabled in viewport unless enabled in the render settings). Has a high performance impact.
|
|
188841
188902
|
|
|
@@ -188948,7 +189009,7 @@ class Pose(bpy_struct):
|
|
|
188948
189009
|
|
|
188949
189010
|
@classmethod
|
|
188950
189011
|
def apply_pose_from_action(
|
|
188951
|
-
cls, action: Action | None, evaluation_time: float | None = 0.0
|
|
189012
|
+
cls, action: Action | None, *, evaluation_time: float | None = 0.0
|
|
188952
189013
|
):
|
|
188953
189014
|
"""Apply the given action to this pose by evaluating it at a specific time. Only updates the pose of selected bones, or all bones if none are selected.
|
|
188954
189015
|
|
|
@@ -188962,6 +189023,7 @@ class Pose(bpy_struct):
|
|
|
188962
189023
|
def blend_pose_from_action(
|
|
188963
189024
|
cls,
|
|
188964
189025
|
action: Action | None,
|
|
189026
|
+
*,
|
|
188965
189027
|
blend_factor: float | None = 1.0,
|
|
188966
189028
|
evaluation_time: float | None = 0.0,
|
|
188967
189029
|
):
|
|
@@ -189462,7 +189524,7 @@ Utility function for (tail - head)(readonly)"""
|
|
|
189462
189524
|
"""
|
|
189463
189525
|
|
|
189464
189526
|
def bbone_segment_matrix(
|
|
189465
|
-
self, index: int | None, rest: bool | None = False
|
|
189527
|
+
self, index: int | None, *, rest: bool | None = False
|
|
189466
189528
|
) -> mathutils.Matrix:
|
|
189467
189529
|
"""Retrieve the matrix of the joint between B-Bone segments if availableThis example shows how to use B-Bone segment matrices to emulate deformation
|
|
189468
189530
|
produced by the Armature modifier or constraint when assigned to the given bone
|
|
@@ -189478,6 +189540,7 @@ Utility function for (tail - head)(readonly)"""
|
|
|
189478
189540
|
|
|
189479
189541
|
def compute_bbone_handles(
|
|
189480
189542
|
self,
|
|
189543
|
+
*,
|
|
189481
189544
|
rest: bool | None = False,
|
|
189482
189545
|
ease: bool | None = False,
|
|
189483
189546
|
offsets: bool | None = False,
|
|
@@ -192669,7 +192732,9 @@ class RenderEngine(bpy_struct):
|
|
|
192669
192732
|
:type: bool
|
|
192670
192733
|
"""
|
|
192671
192734
|
|
|
192672
|
-
def update(
|
|
192735
|
+
def update(
|
|
192736
|
+
self, *, data: BlendData | None = None, depsgraph: Depsgraph | None = None
|
|
192737
|
+
):
|
|
192673
192738
|
"""Export scene data for render
|
|
192674
192739
|
|
|
192675
192740
|
:param data:
|
|
@@ -192740,7 +192805,7 @@ class RenderEngine(bpy_struct):
|
|
|
192740
192805
|
:type depsgraph: Depsgraph | None
|
|
192741
192806
|
"""
|
|
192742
192807
|
|
|
192743
|
-
def update_script_node(self, node: Node | None = None):
|
|
192808
|
+
def update_script_node(self, *, node: Node | None = None):
|
|
192744
192809
|
"""Compile shader script node
|
|
192745
192810
|
|
|
192746
192811
|
:param node:
|
|
@@ -192748,7 +192813,7 @@ class RenderEngine(bpy_struct):
|
|
|
192748
192813
|
"""
|
|
192749
192814
|
|
|
192750
192815
|
def update_render_passes(
|
|
192751
|
-
self, scene: Scene | None = None, renderlayer: ViewLayer | None = None
|
|
192816
|
+
self, *, scene: Scene | None = None, renderlayer: ViewLayer | None = None
|
|
192752
192817
|
):
|
|
192753
192818
|
"""Update the render passes that will be generated
|
|
192754
192819
|
|
|
@@ -192770,6 +192835,7 @@ class RenderEngine(bpy_struct):
|
|
|
192770
192835
|
y: int | None,
|
|
192771
192836
|
w: int | None,
|
|
192772
192837
|
h: int | None,
|
|
192838
|
+
*,
|
|
192773
192839
|
layer: str = "",
|
|
192774
192840
|
view: str = "",
|
|
192775
192841
|
) -> RenderResult:
|
|
@@ -192801,6 +192867,7 @@ class RenderEngine(bpy_struct):
|
|
|
192801
192867
|
def end_result(
|
|
192802
192868
|
self,
|
|
192803
192869
|
result: RenderResult | None,
|
|
192870
|
+
*,
|
|
192804
192871
|
cancel: bool | None = False,
|
|
192805
192872
|
highlight: bool | None = False,
|
|
192806
192873
|
do_merge_results: bool | None = False,
|
|
@@ -192817,7 +192884,9 @@ class RenderEngine(bpy_struct):
|
|
|
192817
192884
|
:type do_merge_results: bool | None
|
|
192818
192885
|
"""
|
|
192819
192886
|
|
|
192820
|
-
def add_pass(
|
|
192887
|
+
def add_pass(
|
|
192888
|
+
self, name: str, channels: int | None, chan_id: str, *, layer: str = ""
|
|
192889
|
+
):
|
|
192821
192890
|
"""Add a pass to the render layer
|
|
192822
192891
|
|
|
192823
192892
|
:param name: Name, Name of the Pass, without view or channel tag
|
|
@@ -192870,7 +192939,7 @@ class RenderEngine(bpy_struct):
|
|
|
192870
192939
|
"""
|
|
192871
192940
|
|
|
192872
192941
|
def camera_shift_x(
|
|
192873
|
-
self, camera: Object | None, use_spherical_stereo: bool | None = False
|
|
192942
|
+
self, camera: Object | None, *, use_spherical_stereo: bool | None = False
|
|
192874
192943
|
) -> float:
|
|
192875
192944
|
"""camera_shift_x
|
|
192876
192945
|
|
|
@@ -192883,7 +192952,7 @@ class RenderEngine(bpy_struct):
|
|
|
192883
192952
|
"""
|
|
192884
192953
|
|
|
192885
192954
|
def camera_model_matrix(
|
|
192886
|
-
self, camera: Object | None, use_spherical_stereo: bool | None = False
|
|
192955
|
+
self, camera: Object | None, *, use_spherical_stereo: bool | None = False
|
|
192887
192956
|
) -> mathutils.Matrix:
|
|
192888
192957
|
"""camera_model_matrix
|
|
192889
192958
|
|
|
@@ -192930,7 +192999,7 @@ class RenderEngine(bpy_struct):
|
|
|
192930
192999
|
"""
|
|
192931
193000
|
|
|
192932
193001
|
def update_memory_stats(
|
|
192933
|
-
self, memory_used: float | None = 0.0, memory_peak: float | None = 0.0
|
|
193002
|
+
self, *, memory_used: float | None = 0.0, memory_peak: float | None = 0.0
|
|
192934
193003
|
):
|
|
192935
193004
|
"""Update memory usage statistics
|
|
192936
193005
|
|
|
@@ -193258,7 +193327,7 @@ class RenderLayer(bpy_struct):
|
|
|
193258
193327
|
:type: bool
|
|
193259
193328
|
"""
|
|
193260
193329
|
|
|
193261
|
-
def load_from_file(self, filepath: str, x: int | None = 0, y: int | None = 0):
|
|
193330
|
+
def load_from_file(self, filepath: str, *, x: int | None = 0, y: int | None = 0):
|
|
193262
193331
|
"""Copies the pixels of this renderlayer from an image file
|
|
193263
193332
|
|
|
193264
193333
|
:param filepath: File Path, File path to load into this render tile, must be no smaller than the renderlayer
|
|
@@ -194044,6 +194113,7 @@ class RenderSettings(bpy_struct):
|
|
|
194044
194113
|
|
|
194045
194114
|
def frame_path(
|
|
194046
194115
|
self,
|
|
194116
|
+
*,
|
|
194047
194117
|
frame: int | None = -2147483648,
|
|
194048
194118
|
preview: bool | None = False,
|
|
194049
194119
|
view: str = "",
|
|
@@ -195495,7 +195565,7 @@ class Scene(ID, bpy_struct):
|
|
|
195495
195565
|
:rtype: str
|
|
195496
195566
|
"""
|
|
195497
195567
|
|
|
195498
|
-
def frame_set(self, frame: int | None, subframe: float | None = 0.0):
|
|
195568
|
+
def frame_set(self, frame: int | None, *, subframe: float | None = 0.0):
|
|
195499
195569
|
"""Set scene frame updating all objects immediately
|
|
195500
195570
|
|
|
195501
195571
|
:param frame: Frame number to set
|
|
@@ -195518,6 +195588,7 @@ class Scene(ID, bpy_struct):
|
|
|
195518
195588
|
depsgraph: Depsgraph,
|
|
195519
195589
|
origin: collections.abc.Sequence[float] | mathutils.Vector | None,
|
|
195520
195590
|
direction: collections.abc.Sequence[float] | mathutils.Vector | None,
|
|
195591
|
+
*,
|
|
195521
195592
|
distance: float | None = 1.70141e38,
|
|
195522
195593
|
):
|
|
195523
195594
|
"""Cast a ray onto in object space
|
|
@@ -195556,6 +195627,7 @@ class Scene(ID, bpy_struct):
|
|
|
195556
195627
|
def alembic_export(
|
|
195557
195628
|
self,
|
|
195558
195629
|
filepath: str,
|
|
195630
|
+
*,
|
|
195559
195631
|
frame_start: int | None = 1,
|
|
195560
195632
|
frame_end: int | None = 1,
|
|
195561
195633
|
xform_samples: int | None = 1,
|
|
@@ -195733,48 +195805,6 @@ class SceneDisplay(bpy_struct):
|
|
|
195733
195805
|
class SceneEEVEE(bpy_struct):
|
|
195734
195806
|
"""Scene display settings for 3D viewport"""
|
|
195735
195807
|
|
|
195736
|
-
bloom_clamp: float
|
|
195737
|
-
""" Maximum intensity a bloom pixel can have (0 to disable) (deprecated)
|
|
195738
|
-
|
|
195739
|
-
:type: float
|
|
195740
|
-
"""
|
|
195741
|
-
|
|
195742
|
-
bloom_color: mathutils.Color
|
|
195743
|
-
""" Color applied to the bloom effect (deprecated)
|
|
195744
|
-
|
|
195745
|
-
:type: mathutils.Color
|
|
195746
|
-
"""
|
|
195747
|
-
|
|
195748
|
-
bloom_intensity: float
|
|
195749
|
-
""" Blend factor (deprecated)
|
|
195750
|
-
|
|
195751
|
-
:type: float
|
|
195752
|
-
"""
|
|
195753
|
-
|
|
195754
|
-
bloom_knee: float
|
|
195755
|
-
""" Makes transition between under/over-threshold gradual (deprecated)
|
|
195756
|
-
|
|
195757
|
-
:type: float
|
|
195758
|
-
"""
|
|
195759
|
-
|
|
195760
|
-
bloom_radius: float
|
|
195761
|
-
""" Bloom spread distance (deprecated)
|
|
195762
|
-
|
|
195763
|
-
:type: float
|
|
195764
|
-
"""
|
|
195765
|
-
|
|
195766
|
-
bloom_threshold: float
|
|
195767
|
-
""" Filters out pixels under this level of brightness (deprecated)
|
|
195768
|
-
|
|
195769
|
-
:type: float
|
|
195770
|
-
"""
|
|
195771
|
-
|
|
195772
|
-
bokeh_denoise_fac: float
|
|
195773
|
-
""" Amount of flicker removal applied to bokeh highlights
|
|
195774
|
-
|
|
195775
|
-
:type: float
|
|
195776
|
-
"""
|
|
195777
|
-
|
|
195778
195808
|
bokeh_max_size: float
|
|
195779
195809
|
""" Max size of the bokeh shape for the depth of field (lower is faster)
|
|
195780
195810
|
|
|
@@ -195877,12 +195907,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
195877
195907
|
:type: float
|
|
195878
195908
|
"""
|
|
195879
195909
|
|
|
195880
|
-
gi_cubemap_display_size: float
|
|
195881
|
-
""" Size of the cubemap spheres to debug captured light
|
|
195882
|
-
|
|
195883
|
-
:type: float
|
|
195884
|
-
"""
|
|
195885
|
-
|
|
195886
195910
|
gi_cubemap_resolution: typing.Literal["128", "256", "512", "1024", "2048", "4096"]
|
|
195887
195911
|
""" Size of every cubemaps
|
|
195888
195912
|
|
|
@@ -195895,24 +195919,12 @@ class SceneEEVEE(bpy_struct):
|
|
|
195895
195919
|
:type: int
|
|
195896
195920
|
"""
|
|
195897
195921
|
|
|
195898
|
-
gi_filter_quality: float
|
|
195899
|
-
""" Take more samples during cubemap filtering to remove artifacts
|
|
195900
|
-
|
|
195901
|
-
:type: float
|
|
195902
|
-
"""
|
|
195903
|
-
|
|
195904
195922
|
gi_glossy_clamp: float
|
|
195905
195923
|
""" Clamp pixel intensity to reduce noise inside glossy reflections from reflection cubemaps (0 to disable)
|
|
195906
195924
|
|
|
195907
195925
|
:type: float
|
|
195908
195926
|
"""
|
|
195909
195927
|
|
|
195910
|
-
gi_irradiance_display_size: float
|
|
195911
|
-
""" Size of the irradiance sample spheres to debug captured light
|
|
195912
|
-
|
|
195913
|
-
:type: float
|
|
195914
|
-
"""
|
|
195915
|
-
|
|
195916
195928
|
gi_irradiance_pool_size: typing.Literal[
|
|
195917
195929
|
"16", "32", "64", "128", "256", "512", "1024"
|
|
195918
195930
|
]
|
|
@@ -195921,24 +195933,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
195921
195933
|
:type: typing.Literal['16','32','64','128','256','512','1024']
|
|
195922
195934
|
"""
|
|
195923
195935
|
|
|
195924
|
-
gi_irradiance_smoothing: float
|
|
195925
|
-
""" Smoother irradiance interpolation but introduce light bleeding
|
|
195926
|
-
|
|
195927
|
-
:type: float
|
|
195928
|
-
"""
|
|
195929
|
-
|
|
195930
|
-
gi_show_cubemaps: bool
|
|
195931
|
-
""" Display captured cubemaps in the viewport
|
|
195932
|
-
|
|
195933
|
-
:type: bool
|
|
195934
|
-
"""
|
|
195935
|
-
|
|
195936
|
-
gi_show_irradiance: bool
|
|
195937
|
-
""" Display irradiance samples in the viewport
|
|
195938
|
-
|
|
195939
|
-
:type: bool
|
|
195940
|
-
"""
|
|
195941
|
-
|
|
195942
195936
|
gi_visibility_resolution: typing.Literal["8", "16", "32", "64"]
|
|
195943
195937
|
""" Size of the shadow map applied to each irradiance sample
|
|
195944
195938
|
|
|
@@ -195951,12 +195945,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
195951
195945
|
:type: float
|
|
195952
195946
|
"""
|
|
195953
195947
|
|
|
195954
|
-
gtao_factor: float
|
|
195955
|
-
""" Factor for ambient occlusion blending
|
|
195956
|
-
|
|
195957
|
-
:type: float
|
|
195958
|
-
"""
|
|
195959
|
-
|
|
195960
195948
|
gtao_quality: float
|
|
195961
195949
|
""" Precision of the horizon search
|
|
195962
195950
|
|
|
@@ -196005,18 +195993,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196005
195993
|
:type: RaytraceEEVEE
|
|
196006
195994
|
"""
|
|
196007
195995
|
|
|
196008
|
-
shadow_cascade_size: typing.Literal["128", "256", "512", "1024", "2048", "4096"]
|
|
196009
|
-
""" Size of sun light shadow maps (deprecated)
|
|
196010
|
-
|
|
196011
|
-
:type: typing.Literal['128','256','512','1024','2048','4096']
|
|
196012
|
-
"""
|
|
196013
|
-
|
|
196014
|
-
shadow_cube_size: typing.Literal["128", "256", "512", "1024", "2048", "4096"]
|
|
196015
|
-
""" Size of point and area light shadow maps (deprecated)
|
|
196016
|
-
|
|
196017
|
-
:type: typing.Literal['128','256','512','1024','2048','4096']
|
|
196018
|
-
"""
|
|
196019
|
-
|
|
196020
195996
|
shadow_pool_size: typing.Literal["16", "32", "64", "128", "256", "512", "1024"]
|
|
196021
195997
|
""" Size of the shadow pool, a bigger pool size allows for more shadows in the scene but might not fit into GPU memory
|
|
196022
195998
|
|
|
@@ -196041,48 +196017,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196041
196017
|
:type: int
|
|
196042
196018
|
"""
|
|
196043
196019
|
|
|
196044
|
-
ssr_border_fade: float
|
|
196045
|
-
""" Screen percentage used to fade the SSR
|
|
196046
|
-
|
|
196047
|
-
:type: float
|
|
196048
|
-
"""
|
|
196049
|
-
|
|
196050
|
-
ssr_firefly_fac: float
|
|
196051
|
-
""" Clamp pixel intensity to remove noise (0 to disable)
|
|
196052
|
-
|
|
196053
|
-
:type: float
|
|
196054
|
-
"""
|
|
196055
|
-
|
|
196056
|
-
ssr_max_roughness: float
|
|
196057
|
-
""" Do not raytrace reflections for roughness above this value
|
|
196058
|
-
|
|
196059
|
-
:type: float
|
|
196060
|
-
"""
|
|
196061
|
-
|
|
196062
|
-
ssr_quality: float
|
|
196063
|
-
""" Precision of the screen space ray-tracing
|
|
196064
|
-
|
|
196065
|
-
:type: float
|
|
196066
|
-
"""
|
|
196067
|
-
|
|
196068
|
-
ssr_thickness: float
|
|
196069
|
-
""" Pixel thickness used to detect intersection
|
|
196070
|
-
|
|
196071
|
-
:type: float
|
|
196072
|
-
"""
|
|
196073
|
-
|
|
196074
|
-
sss_jitter_threshold: float
|
|
196075
|
-
""" Rotate samples that are below this threshold
|
|
196076
|
-
|
|
196077
|
-
:type: float
|
|
196078
|
-
"""
|
|
196079
|
-
|
|
196080
|
-
sss_samples: int
|
|
196081
|
-
""" Number of samples to compute the scattering effect
|
|
196082
|
-
|
|
196083
|
-
:type: int
|
|
196084
|
-
"""
|
|
196085
|
-
|
|
196086
196020
|
taa_render_samples: int
|
|
196087
196021
|
""" Number of samples per pixel for rendering
|
|
196088
196022
|
|
|
@@ -196095,18 +196029,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196095
196029
|
:type: int
|
|
196096
196030
|
"""
|
|
196097
196031
|
|
|
196098
|
-
use_bloom: bool
|
|
196099
|
-
""" High brightness pixels generate a glowing effect (deprecated)
|
|
196100
|
-
|
|
196101
|
-
:type: bool
|
|
196102
|
-
"""
|
|
196103
|
-
|
|
196104
|
-
use_bokeh_high_quality_slight_defocus: bool
|
|
196105
|
-
""" Sample all pixels in almost in-focus regions to eliminate noise
|
|
196106
|
-
|
|
196107
|
-
:type: bool
|
|
196108
|
-
"""
|
|
196109
|
-
|
|
196110
196032
|
use_bokeh_jittered: bool
|
|
196111
196033
|
""" Jitter camera position to create accurate blurring using render samples (only for final render)
|
|
196112
196034
|
|
|
@@ -196125,18 +196047,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196125
196047
|
:type: bool
|
|
196126
196048
|
"""
|
|
196127
196049
|
|
|
196128
|
-
use_gtao_bent_normals: bool
|
|
196129
|
-
""" Compute main non occluded direction to sample the environment
|
|
196130
|
-
|
|
196131
|
-
:type: bool
|
|
196132
|
-
"""
|
|
196133
|
-
|
|
196134
|
-
use_gtao_bounce: bool
|
|
196135
|
-
""" An approximation to simulate light bounces giving less occlusion on brighter objects
|
|
196136
|
-
|
|
196137
|
-
:type: bool
|
|
196138
|
-
"""
|
|
196139
|
-
|
|
196140
196050
|
use_overscan: bool
|
|
196141
196051
|
""" Internally render past the image border to avoid screen-space effects disappearing
|
|
196142
196052
|
|
|
@@ -196149,12 +196059,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196149
196059
|
:type: bool
|
|
196150
196060
|
"""
|
|
196151
196061
|
|
|
196152
|
-
use_shadow_high_bitdepth: bool
|
|
196153
|
-
""" Use 32-bit shadows
|
|
196154
|
-
|
|
196155
|
-
:type: bool
|
|
196156
|
-
"""
|
|
196157
|
-
|
|
196158
196062
|
use_shadow_jitter_viewport: bool
|
|
196159
196063
|
""" Enable jittered shadows on the viewport. (Jittered shadows are always enabled for final renders).
|
|
196160
196064
|
|
|
@@ -196167,30 +196071,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196167
196071
|
:type: bool
|
|
196168
196072
|
"""
|
|
196169
196073
|
|
|
196170
|
-
use_soft_shadows: bool
|
|
196171
|
-
""" Randomize shadowmaps origin to create soft shadows
|
|
196172
|
-
|
|
196173
|
-
:type: bool
|
|
196174
|
-
"""
|
|
196175
|
-
|
|
196176
|
-
use_ssr: bool
|
|
196177
|
-
""" Enable screen space reflection
|
|
196178
|
-
|
|
196179
|
-
:type: bool
|
|
196180
|
-
"""
|
|
196181
|
-
|
|
196182
|
-
use_ssr_halfres: bool
|
|
196183
|
-
""" Raytrace at a lower resolution
|
|
196184
|
-
|
|
196185
|
-
:type: bool
|
|
196186
|
-
"""
|
|
196187
|
-
|
|
196188
|
-
use_ssr_refraction: bool
|
|
196189
|
-
""" Enable screen space Refractions
|
|
196190
|
-
|
|
196191
|
-
:type: bool
|
|
196192
|
-
"""
|
|
196193
|
-
|
|
196194
196074
|
use_taa_reprojection: bool
|
|
196195
196075
|
""" Denoise image using temporal reprojection (can leave some ghosting)
|
|
196196
196076
|
|
|
@@ -196203,12 +196083,6 @@ class SceneEEVEE(bpy_struct):
|
|
|
196203
196083
|
:type: bool
|
|
196204
196084
|
"""
|
|
196205
196085
|
|
|
196206
|
-
use_volumetric_lights: bool
|
|
196207
|
-
""" Enable scene light interactions with volumetrics
|
|
196208
|
-
|
|
196209
|
-
:type: bool
|
|
196210
|
-
"""
|
|
196211
|
-
|
|
196212
196086
|
use_volumetric_shadows: bool
|
|
196213
196087
|
""" Cast shadows from volumetric materials onto volumetric materials (Very expensive)
|
|
196214
196088
|
|
|
@@ -198432,6 +198306,12 @@ class SequencerToolSettings(bpy_struct):
|
|
|
198432
198306
|
:type: bool
|
|
198433
198307
|
"""
|
|
198434
198308
|
|
|
198309
|
+
snap_to_retiming_keys: bool
|
|
198310
|
+
""" Snap to retiming keys
|
|
198311
|
+
|
|
198312
|
+
:type: bool
|
|
198313
|
+
"""
|
|
198314
|
+
|
|
198435
198315
|
snap_to_strips_preview: bool
|
|
198436
198316
|
""" Snap to borders and origins of deselected, visible strips
|
|
198437
198317
|
|
|
@@ -204103,7 +203983,7 @@ class ShaderNodeTexPointDensity(ShaderNode, NodeInternal, Node, bpy_struct):
|
|
|
204103
203983
|
:rtype: NodeInternalSocketTemplate
|
|
204104
203984
|
"""
|
|
204105
203985
|
|
|
204106
|
-
def cache_point_density(self, depsgraph: Depsgraph | None = None):
|
|
203986
|
+
def cache_point_density(self, *, depsgraph: Depsgraph | None = None):
|
|
204107
203987
|
"""Cache point density data for later calculation
|
|
204108
203988
|
|
|
204109
203989
|
:param depsgraph:
|
|
@@ -204111,7 +203991,7 @@ class ShaderNodeTexPointDensity(ShaderNode, NodeInternal, Node, bpy_struct):
|
|
|
204111
203991
|
"""
|
|
204112
203992
|
|
|
204113
203993
|
def calc_point_density(
|
|
204114
|
-
self, depsgraph: Depsgraph | None = None
|
|
203994
|
+
self, *, depsgraph: Depsgraph | None = None
|
|
204115
203995
|
) -> bpy_prop_array[float]:
|
|
204116
203996
|
"""Calculate point density
|
|
204117
203997
|
|
|
@@ -204121,7 +204001,7 @@ class ShaderNodeTexPointDensity(ShaderNode, NodeInternal, Node, bpy_struct):
|
|
|
204121
204001
|
:rtype: bpy_prop_array[float]
|
|
204122
204002
|
"""
|
|
204123
204003
|
|
|
204124
|
-
def calc_point_density_minmax(self, depsgraph: Depsgraph | None = None):
|
|
204004
|
+
def calc_point_density_minmax(self, *, depsgraph: Depsgraph | None = None):
|
|
204125
204005
|
"""Calculate point density
|
|
204126
204006
|
|
|
204127
204007
|
:param depsgraph:
|
|
@@ -206855,7 +206735,7 @@ class Sound(ID, bpy_struct):
|
|
|
206855
206735
|
def pack(self):
|
|
206856
206736
|
"""Pack the sound into the current blend file"""
|
|
206857
206737
|
|
|
206858
|
-
def unpack(self, method: bpy.typing.UnpackMethodItems | None = "USE_LOCAL"):
|
|
206738
|
+
def unpack(self, *, method: bpy.typing.UnpackMethodItems | None = "USE_LOCAL"):
|
|
206859
206739
|
"""Unpack the sound to the samples filename
|
|
206860
206740
|
|
|
206861
206741
|
:param method: method, How to unpack
|
|
@@ -207044,8 +206924,8 @@ class Space(bpy_struct):
|
|
|
207044
206924
|
@classmethod
|
|
207045
206925
|
def draw_handler_add(
|
|
207046
206926
|
cls,
|
|
207047
|
-
callback:
|
|
207048
|
-
args
|
|
206927
|
+
callback: collections.abc.Callable | None,
|
|
206928
|
+
args,
|
|
207049
206929
|
region_type: str | None,
|
|
207050
206930
|
draw_type: str | None,
|
|
207051
206931
|
) -> typing.Any:
|
|
@@ -207054,10 +206934,9 @@ class Space(bpy_struct):
|
|
|
207054
206934
|
Note: All arguments are positional only for now.
|
|
207055
206935
|
|
|
207056
206936
|
:param callback: A function that will be called when the region is drawn.
|
|
207057
|
-
It gets the specified arguments as input.
|
|
207058
|
-
:type callback:
|
|
206937
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
206938
|
+
:type callback: collections.abc.Callable | None
|
|
207059
206939
|
:param args: Arguments that will be passed to the callback.
|
|
207060
|
-
:type args: tuple | None
|
|
207061
206940
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
207062
206941
|
:type region_type: str | None
|
|
207063
206942
|
: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.
|
|
@@ -207388,8 +207267,8 @@ class SpaceClipEditor(Space, bpy_struct):
|
|
|
207388
207267
|
@classmethod
|
|
207389
207268
|
def draw_handler_add(
|
|
207390
207269
|
cls,
|
|
207391
|
-
callback:
|
|
207392
|
-
args
|
|
207270
|
+
callback: collections.abc.Callable | None,
|
|
207271
|
+
args,
|
|
207393
207272
|
region_type: str | None,
|
|
207394
207273
|
draw_type: str | None,
|
|
207395
207274
|
) -> typing.Any:
|
|
@@ -207398,10 +207277,9 @@ class SpaceClipEditor(Space, bpy_struct):
|
|
|
207398
207277
|
Note: All arguments are positional only for now.
|
|
207399
207278
|
|
|
207400
207279
|
:param callback: A function that will be called when the region is drawn.
|
|
207401
|
-
It gets the specified arguments as input.
|
|
207402
|
-
:type callback:
|
|
207280
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
207281
|
+
:type callback: collections.abc.Callable | None
|
|
207403
207282
|
:param args: Arguments that will be passed to the callback.
|
|
207404
|
-
:type args: tuple | None
|
|
207405
207283
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
207406
207284
|
:type region_type: str | None
|
|
207407
207285
|
: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.
|
|
@@ -207490,8 +207368,8 @@ class SpaceConsole(Space, bpy_struct):
|
|
|
207490
207368
|
@classmethod
|
|
207491
207369
|
def draw_handler_add(
|
|
207492
207370
|
cls,
|
|
207493
|
-
callback:
|
|
207494
|
-
args
|
|
207371
|
+
callback: collections.abc.Callable | None,
|
|
207372
|
+
args,
|
|
207495
207373
|
region_type: str | None,
|
|
207496
207374
|
draw_type: str | None,
|
|
207497
207375
|
) -> typing.Any:
|
|
@@ -207500,10 +207378,9 @@ class SpaceConsole(Space, bpy_struct):
|
|
|
207500
207378
|
Note: All arguments are positional only for now.
|
|
207501
207379
|
|
|
207502
207380
|
:param callback: A function that will be called when the region is drawn.
|
|
207503
|
-
It gets the specified arguments as input.
|
|
207504
|
-
:type callback:
|
|
207381
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
207382
|
+
:type callback: collections.abc.Callable | None
|
|
207505
207383
|
:param args: Arguments that will be passed to the callback.
|
|
207506
|
-
:type args: tuple | None
|
|
207507
207384
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
207508
207385
|
:type region_type: str | None
|
|
207509
207386
|
: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.
|
|
@@ -207698,8 +207575,8 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
|
|
|
207698
207575
|
@classmethod
|
|
207699
207576
|
def draw_handler_add(
|
|
207700
207577
|
cls,
|
|
207701
|
-
callback:
|
|
207702
|
-
args
|
|
207578
|
+
callback: collections.abc.Callable | None,
|
|
207579
|
+
args,
|
|
207703
207580
|
region_type: str | None,
|
|
207704
207581
|
draw_type: str | None,
|
|
207705
207582
|
) -> typing.Any:
|
|
@@ -207708,10 +207585,9 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
|
|
|
207708
207585
|
Note: All arguments are positional only for now.
|
|
207709
207586
|
|
|
207710
207587
|
:param callback: A function that will be called when the region is drawn.
|
|
207711
|
-
It gets the specified arguments as input.
|
|
207712
|
-
:type callback:
|
|
207588
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
207589
|
+
:type callback: collections.abc.Callable | None
|
|
207713
207590
|
:param args: Arguments that will be passed to the callback.
|
|
207714
|
-
:type args: tuple | None
|
|
207715
207591
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
207716
207592
|
:type region_type: str | None
|
|
207717
207593
|
: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.
|
|
@@ -207824,7 +207700,7 @@ class SpaceFileBrowser(Space, bpy_struct):
|
|
|
207824
207700
|
"""
|
|
207825
207701
|
|
|
207826
207702
|
def activate_asset_by_id(
|
|
207827
|
-
self, id_to_activate: ID | None, deferred: bool | None = False
|
|
207703
|
+
self, id_to_activate: ID | None, *, deferred: bool | None = False
|
|
207828
207704
|
):
|
|
207829
207705
|
"""Activate and select the asset entry that represents the given ID
|
|
207830
207706
|
|
|
@@ -207834,7 +207710,7 @@ class SpaceFileBrowser(Space, bpy_struct):
|
|
|
207834
207710
|
:type deferred: bool | None
|
|
207835
207711
|
"""
|
|
207836
207712
|
|
|
207837
|
-
def activate_file_by_relative_path(self, relative_path: str = ""):
|
|
207713
|
+
def activate_file_by_relative_path(self, *, relative_path: str = ""):
|
|
207838
207714
|
"""Set active file and add to selection based on relative path to current File Browser directory
|
|
207839
207715
|
|
|
207840
207716
|
:param relative_path: relative_path
|
|
@@ -207869,8 +207745,8 @@ class SpaceFileBrowser(Space, bpy_struct):
|
|
|
207869
207745
|
@classmethod
|
|
207870
207746
|
def draw_handler_add(
|
|
207871
207747
|
cls,
|
|
207872
|
-
callback:
|
|
207873
|
-
args
|
|
207748
|
+
callback: collections.abc.Callable | None,
|
|
207749
|
+
args,
|
|
207874
207750
|
region_type: str | None,
|
|
207875
207751
|
draw_type: str | None,
|
|
207876
207752
|
) -> typing.Any:
|
|
@@ -207879,10 +207755,9 @@ class SpaceFileBrowser(Space, bpy_struct):
|
|
|
207879
207755
|
Note: All arguments are positional only for now.
|
|
207880
207756
|
|
|
207881
207757
|
:param callback: A function that will be called when the region is drawn.
|
|
207882
|
-
It gets the specified arguments as input.
|
|
207883
|
-
:type callback:
|
|
207758
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
207759
|
+
:type callback: collections.abc.Callable | None
|
|
207884
207760
|
:param args: Arguments that will be passed to the callback.
|
|
207885
|
-
:type args: tuple | None
|
|
207886
207761
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
207887
207762
|
:type region_type: str | None
|
|
207888
207763
|
: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.
|
|
@@ -208055,8 +207930,8 @@ class SpaceGraphEditor(Space, bpy_struct):
|
|
|
208055
207930
|
@classmethod
|
|
208056
207931
|
def draw_handler_add(
|
|
208057
207932
|
cls,
|
|
208058
|
-
callback:
|
|
208059
|
-
args
|
|
207933
|
+
callback: collections.abc.Callable | None,
|
|
207934
|
+
args,
|
|
208060
207935
|
region_type: str | None,
|
|
208061
207936
|
draw_type: str | None,
|
|
208062
207937
|
) -> typing.Any:
|
|
@@ -208065,10 +207940,9 @@ class SpaceGraphEditor(Space, bpy_struct):
|
|
|
208065
207940
|
Note: All arguments are positional only for now.
|
|
208066
207941
|
|
|
208067
207942
|
:param callback: A function that will be called when the region is drawn.
|
|
208068
|
-
It gets the specified arguments as input.
|
|
208069
|
-
:type callback:
|
|
207943
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
207944
|
+
:type callback: collections.abc.Callable | None
|
|
208070
207945
|
:param args: Arguments that will be passed to the callback.
|
|
208071
|
-
:type args: tuple | None
|
|
208072
207946
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208073
207947
|
:type region_type: str | None
|
|
208074
207948
|
: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.
|
|
@@ -208339,8 +208213,8 @@ class SpaceImageEditor(Space, bpy_struct):
|
|
|
208339
208213
|
@classmethod
|
|
208340
208214
|
def draw_handler_add(
|
|
208341
208215
|
cls,
|
|
208342
|
-
callback:
|
|
208343
|
-
args
|
|
208216
|
+
callback: collections.abc.Callable | None,
|
|
208217
|
+
args,
|
|
208344
208218
|
region_type: str | None,
|
|
208345
208219
|
draw_type: str | None,
|
|
208346
208220
|
) -> typing.Any:
|
|
@@ -208349,10 +208223,9 @@ class SpaceImageEditor(Space, bpy_struct):
|
|
|
208349
208223
|
Note: All arguments are positional only for now.
|
|
208350
208224
|
|
|
208351
208225
|
:param callback: A function that will be called when the region is drawn.
|
|
208352
|
-
It gets the specified arguments as input.
|
|
208353
|
-
:type callback:
|
|
208226
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
208227
|
+
:type callback: collections.abc.Callable | None
|
|
208354
208228
|
:param args: Arguments that will be passed to the callback.
|
|
208355
|
-
:type args: tuple | None
|
|
208356
208229
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208357
208230
|
:type region_type: str | None
|
|
208358
208231
|
: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.
|
|
@@ -208466,8 +208339,8 @@ class SpaceInfo(Space, bpy_struct):
|
|
|
208466
208339
|
@classmethod
|
|
208467
208340
|
def draw_handler_add(
|
|
208468
208341
|
cls,
|
|
208469
|
-
callback:
|
|
208470
|
-
args
|
|
208342
|
+
callback: collections.abc.Callable | None,
|
|
208343
|
+
args,
|
|
208471
208344
|
region_type: str | None,
|
|
208472
208345
|
draw_type: str | None,
|
|
208473
208346
|
) -> typing.Any:
|
|
@@ -208476,10 +208349,9 @@ class SpaceInfo(Space, bpy_struct):
|
|
|
208476
208349
|
Note: All arguments are positional only for now.
|
|
208477
208350
|
|
|
208478
208351
|
:param callback: A function that will be called when the region is drawn.
|
|
208479
|
-
It gets the specified arguments as input.
|
|
208480
|
-
:type callback:
|
|
208352
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
208353
|
+
:type callback: collections.abc.Callable | None
|
|
208481
208354
|
:param args: Arguments that will be passed to the callback.
|
|
208482
|
-
:type args: tuple | None
|
|
208483
208355
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208484
208356
|
:type region_type: str | None
|
|
208485
208357
|
: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.
|
|
@@ -208580,8 +208452,8 @@ class SpaceNLA(Space, bpy_struct):
|
|
|
208580
208452
|
@classmethod
|
|
208581
208453
|
def draw_handler_add(
|
|
208582
208454
|
cls,
|
|
208583
|
-
callback:
|
|
208584
|
-
args
|
|
208455
|
+
callback: collections.abc.Callable | None,
|
|
208456
|
+
args,
|
|
208585
208457
|
region_type: str | None,
|
|
208586
208458
|
draw_type: str | None,
|
|
208587
208459
|
) -> typing.Any:
|
|
@@ -208590,10 +208462,9 @@ class SpaceNLA(Space, bpy_struct):
|
|
|
208590
208462
|
Note: All arguments are positional only for now.
|
|
208591
208463
|
|
|
208592
208464
|
:param callback: A function that will be called when the region is drawn.
|
|
208593
|
-
It gets the specified arguments as input.
|
|
208594
|
-
:type callback:
|
|
208465
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
208466
|
+
:type callback: collections.abc.Callable | None
|
|
208595
208467
|
:param args: Arguments that will be passed to the callback.
|
|
208596
|
-
:type args: tuple | None
|
|
208597
208468
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208598
208469
|
:type region_type: str | None
|
|
208599
208470
|
: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.
|
|
@@ -208783,8 +208654,8 @@ class SpaceNodeEditor(Space, bpy_struct):
|
|
|
208783
208654
|
@classmethod
|
|
208784
208655
|
def draw_handler_add(
|
|
208785
208656
|
cls,
|
|
208786
|
-
callback:
|
|
208787
|
-
args
|
|
208657
|
+
callback: collections.abc.Callable | None,
|
|
208658
|
+
args,
|
|
208788
208659
|
region_type: str | None,
|
|
208789
208660
|
draw_type: str | None,
|
|
208790
208661
|
) -> typing.Any:
|
|
@@ -208793,10 +208664,9 @@ class SpaceNodeEditor(Space, bpy_struct):
|
|
|
208793
208664
|
Note: All arguments are positional only for now.
|
|
208794
208665
|
|
|
208795
208666
|
:param callback: A function that will be called when the region is drawn.
|
|
208796
|
-
It gets the specified arguments as input.
|
|
208797
|
-
:type callback:
|
|
208667
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
208668
|
+
:type callback: collections.abc.Callable | None
|
|
208798
208669
|
:param args: Arguments that will be passed to the callback.
|
|
208799
|
-
:type args: tuple | None
|
|
208800
208670
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208801
208671
|
:type region_type: str | None
|
|
208802
208672
|
: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.
|
|
@@ -209116,8 +208986,8 @@ class SpaceOutliner(Space, bpy_struct):
|
|
|
209116
208986
|
@classmethod
|
|
209117
208987
|
def draw_handler_add(
|
|
209118
208988
|
cls,
|
|
209119
|
-
callback:
|
|
209120
|
-
args
|
|
208989
|
+
callback: collections.abc.Callable | None,
|
|
208990
|
+
args,
|
|
209121
208991
|
region_type: str | None,
|
|
209122
208992
|
draw_type: str | None,
|
|
209123
208993
|
) -> typing.Any:
|
|
@@ -209126,10 +208996,9 @@ class SpaceOutliner(Space, bpy_struct):
|
|
|
209126
208996
|
Note: All arguments are positional only for now.
|
|
209127
208997
|
|
|
209128
208998
|
:param callback: A function that will be called when the region is drawn.
|
|
209129
|
-
It gets the specified arguments as input.
|
|
209130
|
-
:type callback:
|
|
208999
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
209000
|
+
:type callback: collections.abc.Callable | None
|
|
209131
209001
|
:param args: Arguments that will be passed to the callback.
|
|
209132
|
-
:type args: tuple | None
|
|
209133
209002
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209134
209003
|
:type region_type: str | None
|
|
209135
209004
|
: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.
|
|
@@ -209188,8 +209057,8 @@ class SpacePreferences(Space, bpy_struct):
|
|
|
209188
209057
|
@classmethod
|
|
209189
209058
|
def draw_handler_add(
|
|
209190
209059
|
cls,
|
|
209191
|
-
callback:
|
|
209192
|
-
args
|
|
209060
|
+
callback: collections.abc.Callable | None,
|
|
209061
|
+
args,
|
|
209193
209062
|
region_type: str | None,
|
|
209194
209063
|
draw_type: str | None,
|
|
209195
209064
|
) -> typing.Any:
|
|
@@ -209198,10 +209067,9 @@ class SpacePreferences(Space, bpy_struct):
|
|
|
209198
209067
|
Note: All arguments are positional only for now.
|
|
209199
209068
|
|
|
209200
209069
|
:param callback: A function that will be called when the region is drawn.
|
|
209201
|
-
It gets the specified arguments as input.
|
|
209202
|
-
:type callback:
|
|
209070
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
209071
|
+
:type callback: collections.abc.Callable | None
|
|
209203
209072
|
:param args: Arguments that will be passed to the callback.
|
|
209204
|
-
:type args: tuple | None
|
|
209205
209073
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209206
209074
|
:type region_type: str | None
|
|
209207
209075
|
: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.
|
|
@@ -209303,8 +209171,8 @@ class SpaceProperties(Space, bpy_struct):
|
|
|
209303
209171
|
@classmethod
|
|
209304
209172
|
def draw_handler_add(
|
|
209305
209173
|
cls,
|
|
209306
|
-
callback:
|
|
209307
|
-
args
|
|
209174
|
+
callback: collections.abc.Callable | None,
|
|
209175
|
+
args,
|
|
209308
209176
|
region_type: str | None,
|
|
209309
209177
|
draw_type: str | None,
|
|
209310
209178
|
) -> typing.Any:
|
|
@@ -209313,10 +209181,9 @@ class SpaceProperties(Space, bpy_struct):
|
|
|
209313
209181
|
Note: All arguments are positional only for now.
|
|
209314
209182
|
|
|
209315
209183
|
:param callback: A function that will be called when the region is drawn.
|
|
209316
|
-
It gets the specified arguments as input.
|
|
209317
|
-
:type callback:
|
|
209184
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
209185
|
+
:type callback: collections.abc.Callable | None
|
|
209318
209186
|
:param args: Arguments that will be passed to the callback.
|
|
209319
|
-
:type args: tuple | None
|
|
209320
209187
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209321
209188
|
:type region_type: str | None
|
|
209322
209189
|
: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.
|
|
@@ -209559,8 +209426,8 @@ class SpaceSequenceEditor(Space, bpy_struct):
|
|
|
209559
209426
|
@classmethod
|
|
209560
209427
|
def draw_handler_add(
|
|
209561
209428
|
cls,
|
|
209562
|
-
callback:
|
|
209563
|
-
args
|
|
209429
|
+
callback: collections.abc.Callable | None,
|
|
209430
|
+
args,
|
|
209564
209431
|
region_type: str | None,
|
|
209565
209432
|
draw_type: str | None,
|
|
209566
209433
|
) -> typing.Any:
|
|
@@ -209569,10 +209436,9 @@ class SpaceSequenceEditor(Space, bpy_struct):
|
|
|
209569
209436
|
Note: All arguments are positional only for now.
|
|
209570
209437
|
|
|
209571
209438
|
:param callback: A function that will be called when the region is drawn.
|
|
209572
|
-
It gets the specified arguments as input.
|
|
209573
|
-
:type callback:
|
|
209439
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
209440
|
+
:type callback: collections.abc.Callable | None
|
|
209574
209441
|
:param args: Arguments that will be passed to the callback.
|
|
209575
|
-
:type args: tuple | None
|
|
209576
209442
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209577
209443
|
:type region_type: str | None
|
|
209578
209444
|
: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.
|
|
@@ -209703,8 +209569,8 @@ class SpaceSpreadsheet(Space, bpy_struct):
|
|
|
209703
209569
|
@classmethod
|
|
209704
209570
|
def draw_handler_add(
|
|
209705
209571
|
cls,
|
|
209706
|
-
callback:
|
|
209707
|
-
args
|
|
209572
|
+
callback: collections.abc.Callable | None,
|
|
209573
|
+
args,
|
|
209708
209574
|
region_type: str | None,
|
|
209709
209575
|
draw_type: str | None,
|
|
209710
209576
|
) -> typing.Any:
|
|
@@ -209713,10 +209579,9 @@ class SpaceSpreadsheet(Space, bpy_struct):
|
|
|
209713
209579
|
Note: All arguments are positional only for now.
|
|
209714
209580
|
|
|
209715
209581
|
:param callback: A function that will be called when the region is drawn.
|
|
209716
|
-
It gets the specified arguments as input.
|
|
209717
|
-
:type callback:
|
|
209582
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
209583
|
+
:type callback: collections.abc.Callable | None
|
|
209718
209584
|
:param args: Arguments that will be passed to the callback.
|
|
209719
|
-
:type args: tuple | None
|
|
209720
209585
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209721
209586
|
:type region_type: str | None
|
|
209722
209587
|
: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.
|
|
@@ -209903,8 +209768,8 @@ class SpaceTextEditor(Space, bpy_struct):
|
|
|
209903
209768
|
@classmethod
|
|
209904
209769
|
def draw_handler_add(
|
|
209905
209770
|
cls,
|
|
209906
|
-
callback:
|
|
209907
|
-
args
|
|
209771
|
+
callback: collections.abc.Callable | None,
|
|
209772
|
+
args,
|
|
209908
209773
|
region_type: str | None,
|
|
209909
209774
|
draw_type: str | None,
|
|
209910
209775
|
) -> typing.Any:
|
|
@@ -209913,10 +209778,9 @@ class SpaceTextEditor(Space, bpy_struct):
|
|
|
209913
209778
|
Note: All arguments are positional only for now.
|
|
209914
209779
|
|
|
209915
209780
|
:param callback: A function that will be called when the region is drawn.
|
|
209916
|
-
It gets the specified arguments as input.
|
|
209917
|
-
:type callback:
|
|
209781
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
209782
|
+
:type callback: collections.abc.Callable | None
|
|
209918
209783
|
:param args: Arguments that will be passed to the callback.
|
|
209919
|
-
:type args: tuple | None
|
|
209920
209784
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209921
209785
|
:type region_type: str | None
|
|
209922
209786
|
: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.
|
|
@@ -210608,8 +210472,8 @@ class SpaceView3D(Space, bpy_struct):
|
|
|
210608
210472
|
@classmethod
|
|
210609
210473
|
def draw_handler_add(
|
|
210610
210474
|
cls,
|
|
210611
|
-
callback:
|
|
210612
|
-
args
|
|
210475
|
+
callback: collections.abc.Callable | None,
|
|
210476
|
+
args,
|
|
210613
210477
|
region_type: str | None,
|
|
210614
210478
|
draw_type: str | None,
|
|
210615
210479
|
) -> typing.Any:
|
|
@@ -210618,10 +210482,9 @@ class SpaceView3D(Space, bpy_struct):
|
|
|
210618
210482
|
Note: All arguments are positional only for now.
|
|
210619
210483
|
|
|
210620
210484
|
:param callback: A function that will be called when the region is drawn.
|
|
210621
|
-
It gets the specified arguments as input.
|
|
210622
|
-
:type callback:
|
|
210485
|
+
It gets the specified arguments as input, it's return value is ignored.
|
|
210486
|
+
:type callback: collections.abc.Callable | None
|
|
210623
210487
|
:param args: Arguments that will be passed to the callback.
|
|
210624
|
-
:type args: tuple | None
|
|
210625
210488
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210626
210489
|
:type region_type: str | None
|
|
210627
210490
|
: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.
|
|
@@ -210939,7 +210802,7 @@ class Spline(bpy_struct):
|
|
|
210939
210802
|
:type: bool
|
|
210940
210803
|
"""
|
|
210941
210804
|
|
|
210942
|
-
def calc_length(self, resolution: int | None = 0) -> float:
|
|
210805
|
+
def calc_length(self, *, resolution: int | None = 0) -> float:
|
|
210943
210806
|
"""Calculate spline length
|
|
210944
210807
|
|
|
210945
210808
|
:param resolution: Resolution, Spline resolution to be used, 0 defaults to the resolution_u
|
|
@@ -211166,48 +211029,18 @@ class SplinePoint(bpy_struct):
|
|
|
211166
211029
|
class SpotLight(Light, ID, bpy_struct):
|
|
211167
211030
|
"""Directional cone Light"""
|
|
211168
211031
|
|
|
211169
|
-
contact_shadow_bias: float
|
|
211170
|
-
""" Bias to avoid self shadowing
|
|
211171
|
-
|
|
211172
|
-
:type: float
|
|
211173
|
-
"""
|
|
211174
|
-
|
|
211175
|
-
contact_shadow_distance: float
|
|
211176
|
-
""" World space distance in which to search for screen space occluder
|
|
211177
|
-
|
|
211178
|
-
:type: float
|
|
211179
|
-
"""
|
|
211180
|
-
|
|
211181
|
-
contact_shadow_thickness: float
|
|
211182
|
-
""" Pixel thickness used to detect occlusion
|
|
211183
|
-
|
|
211184
|
-
:type: float
|
|
211185
|
-
"""
|
|
211186
|
-
|
|
211187
211032
|
energy: float
|
|
211188
211033
|
""" The energy this light would emit over its entire area if it wasn't limited by the spot angle
|
|
211189
211034
|
|
|
211190
211035
|
:type: float
|
|
211191
211036
|
"""
|
|
211192
211037
|
|
|
211193
|
-
shadow_buffer_bias: float
|
|
211194
|
-
""" Bias for reducing self shadowing
|
|
211195
|
-
|
|
211196
|
-
:type: float
|
|
211197
|
-
"""
|
|
211198
|
-
|
|
211199
211038
|
shadow_buffer_clip_start: float
|
|
211200
211039
|
""" Shadow map clip start, below which objects will not generate shadows
|
|
211201
211040
|
|
|
211202
211041
|
:type: float
|
|
211203
211042
|
"""
|
|
211204
211043
|
|
|
211205
|
-
shadow_color: mathutils.Color
|
|
211206
|
-
""" Color of shadows cast by the light
|
|
211207
|
-
|
|
211208
|
-
:type: mathutils.Color
|
|
211209
|
-
"""
|
|
211210
|
-
|
|
211211
211044
|
shadow_filter_radius: float
|
|
211212
211045
|
""" Blur shadow aliasing using Percentage Closer Filtering
|
|
211213
211046
|
|
|
@@ -211256,12 +211089,6 @@ class SpotLight(Light, ID, bpy_struct):
|
|
|
211256
211089
|
:type: bool
|
|
211257
211090
|
"""
|
|
211258
211091
|
|
|
211259
|
-
use_contact_shadow: bool
|
|
211260
|
-
""" Use screen space ray-tracing to have correct shadowing near occluder, or for small features that does not appear in shadow maps
|
|
211261
|
-
|
|
211262
|
-
:type: bool
|
|
211263
|
-
"""
|
|
211264
|
-
|
|
211265
211092
|
use_shadow_jitter: bool
|
|
211266
211093
|
""" Enable jittered soft shadows to increase shadow precision (disabled in viewport unless enabled in the render settings). Has a high performance impact.
|
|
211267
211094
|
|
|
@@ -212164,36 +211991,12 @@ class SunLight(Light, ID, bpy_struct):
|
|
|
212164
211991
|
:type: float
|
|
212165
211992
|
"""
|
|
212166
211993
|
|
|
212167
|
-
contact_shadow_bias: float
|
|
212168
|
-
""" Bias to avoid self shadowing
|
|
212169
|
-
|
|
212170
|
-
:type: float
|
|
212171
|
-
"""
|
|
212172
|
-
|
|
212173
|
-
contact_shadow_distance: float
|
|
212174
|
-
""" World space distance in which to search for screen space occluder
|
|
212175
|
-
|
|
212176
|
-
:type: float
|
|
212177
|
-
"""
|
|
212178
|
-
|
|
212179
|
-
contact_shadow_thickness: float
|
|
212180
|
-
""" Pixel thickness used to detect occlusion
|
|
212181
|
-
|
|
212182
|
-
:type: float
|
|
212183
|
-
"""
|
|
212184
|
-
|
|
212185
211994
|
energy: float
|
|
212186
211995
|
""" Sunlight strength in watts per meter squared (W/m²)
|
|
212187
211996
|
|
|
212188
211997
|
:type: float
|
|
212189
211998
|
"""
|
|
212190
211999
|
|
|
212191
|
-
shadow_buffer_bias: float
|
|
212192
|
-
""" Bias for reducing self shadowing
|
|
212193
|
-
|
|
212194
|
-
:type: float
|
|
212195
|
-
"""
|
|
212196
|
-
|
|
212197
212000
|
shadow_buffer_clip_start: float
|
|
212198
212001
|
""" Shadow map clip start, below which objects will not generate shadows
|
|
212199
212002
|
|
|
@@ -212224,12 +212027,6 @@ class SunLight(Light, ID, bpy_struct):
|
|
|
212224
212027
|
:type: float
|
|
212225
212028
|
"""
|
|
212226
212029
|
|
|
212227
|
-
shadow_color: mathutils.Color
|
|
212228
|
-
""" Color of shadows cast by the light
|
|
212229
|
-
|
|
212230
|
-
:type: mathutils.Color
|
|
212231
|
-
"""
|
|
212232
|
-
|
|
212233
212030
|
shadow_filter_radius: float
|
|
212234
212031
|
""" Blur shadow aliasing using Percentage Closer Filtering
|
|
212235
212032
|
|
|
@@ -212254,12 +212051,6 @@ class SunLight(Light, ID, bpy_struct):
|
|
|
212254
212051
|
:type: float
|
|
212255
212052
|
"""
|
|
212256
212053
|
|
|
212257
|
-
use_contact_shadow: bool
|
|
212258
|
-
""" Use screen space ray-tracing to have correct shadowing near occluder, or for small features that does not appear in shadow maps
|
|
212259
|
-
|
|
212260
|
-
:type: bool
|
|
212261
|
-
"""
|
|
212262
|
-
|
|
212263
212054
|
use_shadow_jitter: bool
|
|
212264
212055
|
""" Enable jittered soft shadows to increase shadow precision (disabled in viewport unless enabled in the render settings). Has a high performance impact.
|
|
212265
212056
|
|
|
@@ -212773,7 +212564,11 @@ class Text(ID, bpy_struct):
|
|
|
212773
212564
|
"""
|
|
212774
212565
|
|
|
212775
212566
|
def cursor_set(
|
|
212776
|
-
self,
|
|
212567
|
+
self,
|
|
212568
|
+
line: int | None,
|
|
212569
|
+
*,
|
|
212570
|
+
character: int | None = 0,
|
|
212571
|
+
select: bool | None = False,
|
|
212777
212572
|
):
|
|
212778
212573
|
"""Set cursor by line and (optionally) character index
|
|
212779
212574
|
|
|
@@ -223150,6 +222945,7 @@ class UIList(bpy_struct):
|
|
|
223150
222945
|
icon: int | None,
|
|
223151
222946
|
active_data: typing.Any,
|
|
223152
222947
|
active_property: str | None,
|
|
222948
|
+
*,
|
|
223153
222949
|
index: int | None = 0,
|
|
223154
222950
|
flt_flag: int | None = 0,
|
|
223155
222951
|
):
|
|
@@ -224931,7 +224727,7 @@ class VectorFont(ID, bpy_struct):
|
|
|
224931
224727
|
def pack(self):
|
|
224932
224728
|
"""Pack the font into the current blend file"""
|
|
224933
224729
|
|
|
224934
|
-
def unpack(self, method: bpy.typing.UnpackMethodItems | None = "USE_LOCAL"):
|
|
224730
|
+
def unpack(self, *, method: bpy.typing.UnpackMethodItems | None = "USE_LOCAL"):
|
|
224935
224731
|
"""Unpack the font to the samples filename
|
|
224936
224732
|
|
|
224937
224733
|
:param method: method, How to unpack
|
|
@@ -225570,7 +225366,7 @@ class View2D(bpy_struct):
|
|
|
225570
225366
|
"""
|
|
225571
225367
|
|
|
225572
225368
|
def view_to_region(
|
|
225573
|
-
self, x: float | None, y: float | None, clip: bool | None = True
|
|
225369
|
+
self, x: float | None, y: float | None, *, clip: bool | None = True
|
|
225574
225370
|
) -> bpy_prop_array[int]:
|
|
225575
225371
|
"""Transform 2D view coordinates to region
|
|
225576
225372
|
|
|
@@ -228290,6 +228086,7 @@ class Window(bpy_struct):
|
|
|
228290
228086
|
self,
|
|
228291
228087
|
type: bpy.typing.EventTypeItems | None,
|
|
228292
228088
|
value: bpy.typing.EventValueItems | None,
|
|
228089
|
+
*,
|
|
228293
228090
|
unicode: str | None = "",
|
|
228294
228091
|
x: int | None = 0,
|
|
228295
228092
|
y: int | None = 0,
|
|
@@ -228492,7 +228289,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228492
228289
|
"""
|
|
228493
228290
|
|
|
228494
228291
|
def event_timer_add(
|
|
228495
|
-
self, time_step: float | None, window: Window | None = None
|
|
228292
|
+
self, time_step: float | None, *, window: Window | None = None
|
|
228496
228293
|
) -> Timer:
|
|
228497
228294
|
"""Add a timer to the given window, to generate periodic 'TIMER' events
|
|
228498
228295
|
|
|
@@ -228564,6 +228361,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228564
228361
|
def invoke_props_dialog(
|
|
228565
228362
|
cls,
|
|
228566
228363
|
operator: Operator | None,
|
|
228364
|
+
*,
|
|
228567
228365
|
width: int | None = 300,
|
|
228568
228366
|
title: str = "",
|
|
228569
228367
|
confirm_text: str = "",
|
|
@@ -228601,7 +228399,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228601
228399
|
|
|
228602
228400
|
@classmethod
|
|
228603
228401
|
def invoke_popup(
|
|
228604
|
-
cls, operator: Operator | None, width: int | None = 300
|
|
228402
|
+
cls, operator: Operator | None, *, width: int | None = 300
|
|
228605
228403
|
) -> set[bpy.typing.OperatorReturnItems]:
|
|
228606
228404
|
"""Operator popup invoke (only shows operator's properties, without executing it)
|
|
228607
228405
|
|
|
@@ -228618,6 +228416,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228618
228416
|
cls,
|
|
228619
228417
|
operator: Operator | None,
|
|
228620
228418
|
event: Event | None,
|
|
228419
|
+
*,
|
|
228621
228420
|
title: str = "",
|
|
228622
228421
|
message: str = "",
|
|
228623
228422
|
confirm_text: str = "",
|
|
@@ -228650,7 +228449,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228650
228449
|
|
|
228651
228450
|
@classmethod
|
|
228652
228451
|
def popmenu_begin__internal(
|
|
228653
|
-
cls, title: str, icon: bpy.typing.IconItems | None = "NONE"
|
|
228452
|
+
cls, title: str, *, icon: bpy.typing.IconItems | None = "NONE"
|
|
228654
228453
|
) -> UIPopupMenu:
|
|
228655
228454
|
"""popmenu_begin__internal
|
|
228656
228455
|
|
|
@@ -228672,7 +228471,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228672
228471
|
|
|
228673
228472
|
@classmethod
|
|
228674
228473
|
def popover_begin__internal(
|
|
228675
|
-
cls, ui_units_x: int | None = 0, from_active_button: bool | None = False
|
|
228474
|
+
cls, *, ui_units_x: int | None = 0, from_active_button: bool | None = False
|
|
228676
228475
|
) -> UIPopover:
|
|
228677
228476
|
"""popover_begin__internal
|
|
228678
228477
|
|
|
@@ -228685,7 +228484,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
228685
228484
|
"""
|
|
228686
228485
|
|
|
228687
228486
|
@classmethod
|
|
228688
|
-
def popover_end__internal(cls, menu: UIPopover, keymap: KeyMap | None = None):
|
|
228487
|
+
def popover_end__internal(cls, menu: UIPopover, *, keymap: KeyMap | None = None):
|
|
228689
228488
|
"""popover_end__internal
|
|
228690
228489
|
|
|
228691
228490
|
:param menu:
|
|
@@ -228696,7 +228495,11 @@ class WindowManager(ID, bpy_struct):
|
|
|
228696
228495
|
|
|
228697
228496
|
@classmethod
|
|
228698
228497
|
def piemenu_begin__internal(
|
|
228699
|
-
cls,
|
|
228498
|
+
cls,
|
|
228499
|
+
title: str,
|
|
228500
|
+
*,
|
|
228501
|
+
icon: bpy.typing.IconItems | None = "NONE",
|
|
228502
|
+
event: Event = None,
|
|
228700
228503
|
) -> UIPieMenu:
|
|
228701
228504
|
"""piemenu_begin__internal
|
|
228702
228505
|
|
|
@@ -228788,8 +228591,8 @@ class WindowManager(ID, bpy_struct):
|
|
|
228788
228591
|
@classmethod
|
|
228789
228592
|
def draw_cursor_add(
|
|
228790
228593
|
cls,
|
|
228791
|
-
callback:
|
|
228792
|
-
args
|
|
228594
|
+
callback: collections.abc.Callable | None,
|
|
228595
|
+
args,
|
|
228793
228596
|
space_type: str | None,
|
|
228794
228597
|
region_type: str | None,
|
|
228795
228598
|
) -> typing.Any:
|
|
@@ -228799,9 +228602,8 @@ class WindowManager(ID, bpy_struct):
|
|
|
228799
228602
|
|
|
228800
228603
|
:param callback: A function that will be called when the cursor is drawn.
|
|
228801
228604
|
It gets the specified arguments as input with the mouse position (tuple) as last argument.
|
|
228802
|
-
:type callback:
|
|
228605
|
+
:type callback: collections.abc.Callable | None
|
|
228803
228606
|
:param args: Arguments that will be passed to the callback.
|
|
228804
|
-
:type args: tuple | None
|
|
228805
228607
|
:param space_type: The space type the callback draws in; for example VIEW_3D. (`bpy.types.Space.type`)
|
|
228806
228608
|
:type space_type: str | None
|
|
228807
228609
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
@@ -229218,6 +229020,7 @@ class WorkSpaceTool(bpy_struct):
|
|
|
229218
229020
|
def setup(
|
|
229219
229021
|
self,
|
|
229220
229022
|
idname: str,
|
|
229023
|
+
*,
|
|
229221
229024
|
cursor: bpy.typing.WindowCursorItems | None = "DEFAULT",
|
|
229222
229025
|
keymap: str = "",
|
|
229223
229026
|
gizmo_group: str = "",
|