fake-bpy-module 20240803__py3-none-any.whl → 20240804__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.
- aud/__init__.pyi +77 -77
- bmesh/ops/__init__.pyi +54 -36
- bmesh/types/__init__.pyi +24 -24
- bpy/ops/action/__init__.pyi +55 -32
- bpy/ops/anim/__init__.pyi +22 -22
- bpy/ops/armature/__init__.pyi +47 -20
- bpy/ops/asset/__init__.pyi +5 -2
- bpy/ops/boid/__init__.pyi +12 -2
- bpy/ops/brush/__init__.pyi +18 -12
- bpy/ops/buttons/__init__.pyi +10 -4
- bpy/ops/cachefile/__init__.pyi +12 -6
- bpy/ops/clip/__init__.pyi +54 -38
- bpy/ops/console/__init__.pyi +17 -6
- bpy/ops/constraint/__init__.pyi +28 -28
- bpy/ops/curve/__init__.pyi +72 -34
- bpy/ops/curves/__init__.pyi +16 -16
- bpy/ops/dpaint/__init__.pyi +4 -4
- bpy/ops/ed/__init__.pyi +5 -2
- bpy/ops/export_anim/__init__.pyi +3 -2
- bpy/ops/export_scene/__init__.pyi +55 -45
- bpy/ops/file/__init__.pyi +40 -16
- bpy/ops/font/__init__.pyi +59 -16
- bpy/ops/geometry/__init__.pyi +55 -20
- bpy/ops/gpencil/__init__.pyi +155 -122
- bpy/ops/graph/__init__.pyi +131 -52
- bpy/ops/grease_pencil/__init__.pyi +78 -58
- bpy/ops/image/__init__.pyi +77 -54
- bpy/ops/import_anim/__init__.pyi +11 -8
- bpy/ops/import_scene/__init__.pyi +20 -18
- bpy/ops/info/__init__.pyi +4 -4
- bpy/ops/lattice/__init__.pyi +8 -8
- bpy/ops/marker/__init__.pyi +6 -6
- bpy/ops/mask/__init__.pyi +13 -12
- bpy/ops/mball/__init__.pyi +6 -6
- bpy/ops/mesh/__init__.pyi +290 -150
- bpy/ops/nla/__init__.pyi +28 -20
- bpy/ops/node/__init__.pyi +43 -32
- bpy/ops/object/__init__.pyi +651 -210
- bpy/ops/outliner/__init__.pyi +113 -32
- bpy/ops/paint/__init__.pyi +65 -56
- bpy/ops/palette/__init__.pyi +4 -4
- bpy/ops/particle/__init__.pyi +14 -14
- bpy/ops/pose/__init__.pyi +121 -44
- bpy/ops/preferences/__init__.pyi +9 -6
- bpy/ops/render/__init__.pyi +3 -2
- bpy/ops/rigidbody/__init__.pyi +45 -14
- bpy/ops/scene/__init__.pyi +69 -22
- bpy/ops/screen/__init__.pyi +78 -16
- bpy/ops/sculpt/__init__.pyi +131 -74
- bpy/ops/sculpt_curves/__init__.pyi +2 -2
- bpy/ops/sequencer/__init__.pyi +156 -60
- bpy/ops/sound/__init__.pyi +40 -16
- bpy/ops/surface/__init__.pyi +12 -12
- bpy/ops/text/__init__.pyi +65 -20
- bpy/ops/texture/__init__.pyi +2 -2
- bpy/ops/transform/__init__.pyi +344 -72
- bpy/ops/ui/__init__.pyi +9 -6
- bpy/ops/uilist/__init__.pyi +2 -2
- bpy/ops/uv/__init__.pyi +90 -66
- bpy/ops/view3d/__init__.pyi +36 -30
- bpy/ops/wm/__init__.pyi +443 -156
- bpy/types/__init__.pyi +28064 -2857
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/RECORD +72 -72
- freestyle/chainingiterators/__init__.pyi +4 -4
- freestyle/types/__init__.pyi +76 -63
- idprop/types/__init__.pyi +2 -2
- imbuf/types/__init__.pyi +2 -2
- mathutils/__init__.pyi +1004 -970
- mathutils/bvhtree/__init__.pyi +2 -2
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/top_level.txt +0 -0
bpy/ops/curves/__init__.pyi
CHANGED
|
@@ -15,7 +15,7 @@ def add_bezier(
|
|
|
15
15
|
*,
|
|
16
16
|
radius: float | None = 1.0,
|
|
17
17
|
enter_editmode: bool | None = False,
|
|
18
|
-
align:
|
|
18
|
+
align: typing.Literal["WORLD", "VIEW", "CURSOR"] | None = "WORLD",
|
|
19
19
|
location: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
20
20
|
0.0,
|
|
21
21
|
0.0,
|
|
@@ -47,7 +47,7 @@ def add_bezier(
|
|
|
47
47
|
|
|
48
48
|
CURSOR
|
|
49
49
|
3D Cursor -- Use the 3D cursor orientation for the new object.
|
|
50
|
-
:type align:
|
|
50
|
+
:type align: typing.Literal['WORLD','VIEW','CURSOR'] | None
|
|
51
51
|
:param location: Location, Location for the newly added object
|
|
52
52
|
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
53
53
|
:param rotation: Rotation, Rotation for the newly added object
|
|
@@ -65,7 +65,7 @@ def add_circle(
|
|
|
65
65
|
*,
|
|
66
66
|
radius: float | None = 1.0,
|
|
67
67
|
enter_editmode: bool | None = False,
|
|
68
|
-
align:
|
|
68
|
+
align: typing.Literal["WORLD", "VIEW", "CURSOR"] | None = "WORLD",
|
|
69
69
|
location: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
70
70
|
0.0,
|
|
71
71
|
0.0,
|
|
@@ -97,7 +97,7 @@ def add_circle(
|
|
|
97
97
|
|
|
98
98
|
CURSOR
|
|
99
99
|
3D Cursor -- Use the 3D cursor orientation for the new object.
|
|
100
|
-
:type align:
|
|
100
|
+
:type align: typing.Literal['WORLD','VIEW','CURSOR'] | None
|
|
101
101
|
:param location: Location, Location for the newly added object
|
|
102
102
|
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
103
103
|
:param rotation: Rotation, Rotation for the newly added object
|
|
@@ -177,7 +177,7 @@ def curve_type_set(
|
|
|
177
177
|
execution_context: int | str | None = None,
|
|
178
178
|
undo: bool | None = None,
|
|
179
179
|
*,
|
|
180
|
-
type:
|
|
180
|
+
type: typing.Literal["CATMULL_ROM", "POLY", "BEZIER", "NURBS"] | None = "POLY",
|
|
181
181
|
use_handles: bool | None = False,
|
|
182
182
|
):
|
|
183
183
|
"""Set type of selected curves
|
|
@@ -186,7 +186,7 @@ def curve_type_set(
|
|
|
186
186
|
:type execution_context: int | str | None
|
|
187
187
|
:type undo: bool | None
|
|
188
188
|
:param type: Type, Curve type
|
|
189
|
-
:type type:
|
|
189
|
+
:type type: typing.Literal['CATMULL_ROM', 'POLY', 'BEZIER', 'NURBS'] | None
|
|
190
190
|
:param use_handles: Handles, Take handle information into account in the conversion
|
|
191
191
|
:type use_handles: bool | None
|
|
192
192
|
"""
|
|
@@ -227,7 +227,7 @@ def draw(
|
|
|
227
227
|
undo: bool | None = None,
|
|
228
228
|
*,
|
|
229
229
|
error_threshold: float | None = 0.0,
|
|
230
|
-
fit_method:
|
|
230
|
+
fit_method: typing.Literal["REFIT", "SPLIT"] | None = "REFIT",
|
|
231
231
|
corner_angle: float | None = 1.22173,
|
|
232
232
|
use_cyclic: bool | None = True,
|
|
233
233
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
@@ -244,7 +244,7 @@ def draw(
|
|
|
244
244
|
:param error_threshold: Error, Error distance threshold (in object units)
|
|
245
245
|
:type error_threshold: float | None
|
|
246
246
|
:param fit_method: Fit Method
|
|
247
|
-
:type fit_method:
|
|
247
|
+
:type fit_method: typing.Literal['REFIT', 'SPLIT'] | None
|
|
248
248
|
:param corner_angle: Corner Angle
|
|
249
249
|
:type corner_angle: float | None
|
|
250
250
|
:param use_cyclic: Cyclic
|
|
@@ -336,7 +336,7 @@ def handle_type_set(
|
|
|
336
336
|
execution_context: int | str | None = None,
|
|
337
337
|
undo: bool | None = None,
|
|
338
338
|
*,
|
|
339
|
-
type:
|
|
339
|
+
type: typing.Literal["FREE", "AUTO", "VECTOR", "ALIGN"] | None = "AUTO",
|
|
340
340
|
):
|
|
341
341
|
"""Set the handle type for bezier curves
|
|
342
342
|
|
|
@@ -344,7 +344,7 @@ def handle_type_set(
|
|
|
344
344
|
:type execution_context: int | str | None
|
|
345
345
|
:type undo: bool | None
|
|
346
346
|
:param type: Type
|
|
347
|
-
:type type:
|
|
347
|
+
:type type: typing.Literal['FREE', 'AUTO', 'VECTOR', 'ALIGN'] | None
|
|
348
348
|
"""
|
|
349
349
|
|
|
350
350
|
...
|
|
@@ -368,7 +368,7 @@ def select_all(
|
|
|
368
368
|
execution_context: int | str | None = None,
|
|
369
369
|
undo: bool | None = None,
|
|
370
370
|
*,
|
|
371
|
-
action:
|
|
371
|
+
action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
|
|
372
372
|
):
|
|
373
373
|
"""(De)select all control points
|
|
374
374
|
|
|
@@ -388,7 +388,7 @@ def select_all(
|
|
|
388
388
|
|
|
389
389
|
INVERT
|
|
390
390
|
Invert -- Invert selection of all elements.
|
|
391
|
-
:type action:
|
|
391
|
+
:type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
|
|
392
392
|
"""
|
|
393
393
|
|
|
394
394
|
...
|
|
@@ -482,7 +482,7 @@ def set_selection_domain(
|
|
|
482
482
|
execution_context: int | str | None = None,
|
|
483
483
|
undo: bool | None = None,
|
|
484
484
|
*,
|
|
485
|
-
domain:
|
|
485
|
+
domain: typing.Literal["POINT", "CURVE"] | None = "POINT",
|
|
486
486
|
):
|
|
487
487
|
"""Change the mode used for selection masking in curves sculpt mode
|
|
488
488
|
|
|
@@ -490,7 +490,7 @@ def set_selection_domain(
|
|
|
490
490
|
:type execution_context: int | str | None
|
|
491
491
|
:type undo: bool | None
|
|
492
492
|
:param domain: Domain
|
|
493
|
-
:type domain:
|
|
493
|
+
:type domain: typing.Literal['POINT', 'CURVE'] | None
|
|
494
494
|
"""
|
|
495
495
|
|
|
496
496
|
...
|
|
@@ -500,7 +500,7 @@ def snap_curves_to_surface(
|
|
|
500
500
|
execution_context: int | str | None = None,
|
|
501
501
|
undo: bool | None = None,
|
|
502
502
|
*,
|
|
503
|
-
attach_mode:
|
|
503
|
+
attach_mode: typing.Literal["NEAREST", "DEFORM"] | None = "NEAREST",
|
|
504
504
|
):
|
|
505
505
|
"""Move curves so that the first point is exactly on the surface mesh
|
|
506
506
|
|
|
@@ -514,7 +514,7 @@ def snap_curves_to_surface(
|
|
|
514
514
|
|
|
515
515
|
DEFORM
|
|
516
516
|
Deform -- Re-attach curves to a deformed surface using the existing attachment information. This only works when the topology of the surface mesh has not changed.
|
|
517
|
-
:type attach_mode:
|
|
517
|
+
:type attach_mode: typing.Literal['NEAREST','DEFORM'] | None
|
|
518
518
|
"""
|
|
519
519
|
|
|
520
520
|
...
|
bpy/ops/dpaint/__init__.pyi
CHANGED
|
@@ -25,7 +25,7 @@ def output_toggle(
|
|
|
25
25
|
execution_context: int | str | None = None,
|
|
26
26
|
undo: bool | None = None,
|
|
27
27
|
*,
|
|
28
|
-
output:
|
|
28
|
+
output: typing.Literal["A", "B"] | None = "A",
|
|
29
29
|
):
|
|
30
30
|
"""Add or remove Dynamic Paint output data layer
|
|
31
31
|
|
|
@@ -33,7 +33,7 @@ def output_toggle(
|
|
|
33
33
|
:type execution_context: int | str | None
|
|
34
34
|
:type undo: bool | None
|
|
35
35
|
:param output: Output Toggle
|
|
36
|
-
:type output:
|
|
36
|
+
:type output: typing.Literal['A','B'] | None
|
|
37
37
|
"""
|
|
38
38
|
|
|
39
39
|
...
|
|
@@ -71,7 +71,7 @@ def type_toggle(
|
|
|
71
71
|
execution_context: int | str | None = None,
|
|
72
72
|
undo: bool | None = None,
|
|
73
73
|
*,
|
|
74
|
-
type:
|
|
74
|
+
type: typing.Literal["CANVAS", "BRUSH"] | None = "CANVAS",
|
|
75
75
|
):
|
|
76
76
|
"""Toggle whether given type is active or not
|
|
77
77
|
|
|
@@ -79,7 +79,7 @@ def type_toggle(
|
|
|
79
79
|
:type execution_context: int | str | None
|
|
80
80
|
:type undo: bool | None
|
|
81
81
|
:param type: Type
|
|
82
|
-
:type type:
|
|
82
|
+
:type type: typing.Literal['CANVAS', 'BRUSH'] | None
|
|
83
83
|
"""
|
|
84
84
|
|
|
85
85
|
...
|
bpy/ops/ed/__init__.pyi
CHANGED
|
@@ -90,7 +90,10 @@ def lib_id_load_custom_preview(
|
|
|
90
90
|
filemode: int | None = 9,
|
|
91
91
|
show_multiview: bool | None = False,
|
|
92
92
|
use_multiview: bool | None = False,
|
|
93
|
-
display_type:
|
|
93
|
+
display_type: typing.Literal[
|
|
94
|
+
"DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
|
|
95
|
+
]
|
|
96
|
+
| None = "DEFAULT",
|
|
94
97
|
sort_method: str | None = "",
|
|
95
98
|
):
|
|
96
99
|
"""Choose an image to help identify the data-block visually
|
|
@@ -157,7 +160,7 @@ def lib_id_load_custom_preview(
|
|
|
157
160
|
|
|
158
161
|
THUMBNAIL
|
|
159
162
|
Thumbnails -- Display files as thumbnails.
|
|
160
|
-
:type display_type:
|
|
163
|
+
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
161
164
|
:param sort_method: File sorting mode
|
|
162
165
|
:type sort_method: str | None
|
|
163
166
|
"""
|
bpy/ops/export_anim/__init__.pyi
CHANGED
|
@@ -17,7 +17,8 @@ def bvh(
|
|
|
17
17
|
global_scale: float | None = 1.0,
|
|
18
18
|
frame_start: int | None = 0,
|
|
19
19
|
frame_end: int | None = 0,
|
|
20
|
-
rotate_mode:
|
|
20
|
+
rotate_mode: typing.Literal["NATIVE", "XYZ", "XZY", "YXZ", "YZX", "ZXY", "ZYX"]
|
|
21
|
+
| None = "NATIVE",
|
|
21
22
|
root_transform_only: bool | None = False,
|
|
22
23
|
):
|
|
23
24
|
"""Save a BVH motion capture file from an armature
|
|
@@ -59,7 +60,7 @@ def bvh(
|
|
|
59
60
|
|
|
60
61
|
ZYX
|
|
61
62
|
Euler (ZYX) -- Convert rotations to euler ZYX.
|
|
62
|
-
:type rotate_mode:
|
|
63
|
+
:type rotate_mode: typing.Literal['NATIVE','XYZ','XZY','YXZ','YZX','ZXY','ZYX'] | None
|
|
63
64
|
:param root_transform_only: Root Translation Only, Only write out translation channels for the root bone
|
|
64
65
|
:type root_transform_only: bool | None
|
|
65
66
|
"""
|
|
@@ -20,21 +20,20 @@ def fbx(
|
|
|
20
20
|
collection: str = "",
|
|
21
21
|
global_scale: float | None = 1.0,
|
|
22
22
|
apply_unit_scale: bool | None = True,
|
|
23
|
-
apply_scale_options:
|
|
23
|
+
apply_scale_options: typing.Literal[
|
|
24
|
+
"FBX_SCALE_NONE", "FBX_SCALE_UNITS", "FBX_SCALE_CUSTOM", "FBX_SCALE_ALL"
|
|
25
|
+
]
|
|
26
|
+
| None = "FBX_SCALE_NONE",
|
|
24
27
|
use_space_transform: bool | None = True,
|
|
25
28
|
bake_space_transform: bool | None = False,
|
|
26
|
-
object_types: set[
|
|
27
|
-
"ARMATURE",
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
"LIGHT",
|
|
31
|
-
"MESH",
|
|
32
|
-
"OTHER",
|
|
33
|
-
},
|
|
29
|
+
object_types: set[
|
|
30
|
+
typing.Literal["EMPTY", "CAMERA", "LIGHT", "ARMATURE", "MESH", "OTHER"]
|
|
31
|
+
]
|
|
32
|
+
| None = {"ARMATURE", "CAMERA", "EMPTY", "LIGHT", "MESH", "OTHER"},
|
|
34
33
|
use_mesh_modifiers: bool | None = True,
|
|
35
34
|
use_mesh_modifiers_render: bool | None = True,
|
|
36
|
-
mesh_smooth_type:
|
|
37
|
-
colors_type:
|
|
35
|
+
mesh_smooth_type: typing.Literal["OFF", "FACE", "EDGE"] | None = "OFF",
|
|
36
|
+
colors_type: typing.Literal["NONE", "SRGB", "LINEAR"] | None = "SRGB",
|
|
38
37
|
prioritize_active_color: bool | None = False,
|
|
39
38
|
use_subsurf: bool | None = False,
|
|
40
39
|
use_mesh_edges: bool | None = False,
|
|
@@ -42,10 +41,10 @@ def fbx(
|
|
|
42
41
|
use_triangles: bool | None = False,
|
|
43
42
|
use_custom_props: bool | None = False,
|
|
44
43
|
add_leaf_bones: bool | None = True,
|
|
45
|
-
primary_bone_axis:
|
|
46
|
-
secondary_bone_axis:
|
|
44
|
+
primary_bone_axis: typing.Literal["X", "Y", "Z", "-X", "-Y", "-Z"] | None = "Y",
|
|
45
|
+
secondary_bone_axis: typing.Literal["X", "Y", "Z", "-X", "-Y", "-Z"] | None = "X",
|
|
47
46
|
use_armature_deform_only: bool | None = False,
|
|
48
|
-
armature_nodetype:
|
|
47
|
+
armature_nodetype: typing.Literal["NULL", "ROOT", "LIMBNODE"] | None = "NULL",
|
|
49
48
|
bake_anim: bool | None = True,
|
|
50
49
|
bake_anim_use_all_bones: bool | None = True,
|
|
51
50
|
bake_anim_use_nla_strips: bool | None = True,
|
|
@@ -53,13 +52,17 @@ def fbx(
|
|
|
53
52
|
bake_anim_force_startend_keying: bool | None = True,
|
|
54
53
|
bake_anim_step: float | None = 1.0,
|
|
55
54
|
bake_anim_simplify_factor: float | None = 1.0,
|
|
56
|
-
path_mode:
|
|
55
|
+
path_mode: typing.Literal["AUTO", "ABSOLUTE", "RELATIVE", "MATCH", "STRIP", "COPY"]
|
|
56
|
+
| None = "AUTO",
|
|
57
57
|
embed_textures: bool | None = False,
|
|
58
|
-
batch_mode:
|
|
58
|
+
batch_mode: typing.Literal[
|
|
59
|
+
"OFF", "SCENE", "COLLECTION", "SCENE_COLLECTION", "ACTIVE_SCENE_COLLECTION"
|
|
60
|
+
]
|
|
61
|
+
| None = "OFF",
|
|
59
62
|
use_batch_own_dir: bool | None = True,
|
|
60
63
|
use_metadata: bool | None = True,
|
|
61
|
-
axis_forward:
|
|
62
|
-
axis_up:
|
|
64
|
+
axis_forward: typing.Literal["X", "Y", "Z", "-X", "-Y", "-Z"] | None = "-Z",
|
|
65
|
+
axis_up: typing.Literal["X", "Y", "Z", "-X", "-Y", "-Z"] | None = "Y",
|
|
63
66
|
):
|
|
64
67
|
"""Write a FBX file
|
|
65
68
|
|
|
@@ -97,7 +100,7 @@ def fbx(
|
|
|
97
100
|
|
|
98
101
|
FBX_SCALE_ALL
|
|
99
102
|
FBX All -- Apply custom scaling and units scaling to FBX scale.
|
|
100
|
-
:type apply_scale_options:
|
|
103
|
+
:type apply_scale_options: typing.Literal['FBX_SCALE_NONE','FBX_SCALE_UNITS','FBX_SCALE_CUSTOM','FBX_SCALE_ALL'] | None
|
|
101
104
|
:param use_space_transform: Use Space Transform, Apply global space transform to the object rotations. When disabled only the axis space is written to the file and all object transforms are left as-is
|
|
102
105
|
:type use_space_transform: bool | None
|
|
103
106
|
:param bake_space_transform: Apply Transform, Bake space transform into object data, avoids getting unwanted rotations to objects when target space is not aligned with Blender's space (WARNING! experimental option, use at own risk, known to be broken with armatures/animations)
|
|
@@ -121,7 +124,7 @@ def fbx(
|
|
|
121
124
|
|
|
122
125
|
OTHER
|
|
123
126
|
Other -- Other geometry types, like curve, metaball, etc. (converted to meshes).
|
|
124
|
-
:type object_types: set[
|
|
127
|
+
:type object_types: set[typing.Literal['EMPTY','CAMERA','LIGHT','ARMATURE','MESH','OTHER']] | None
|
|
125
128
|
:param use_mesh_modifiers: Apply Modifiers, Apply modifiers to mesh objects (except Armature ones) - WARNING: prevents exporting shape keys
|
|
126
129
|
:type use_mesh_modifiers: bool | None
|
|
127
130
|
:param use_mesh_modifiers_render: Use Modifiers Render Setting, Use render settings when applying modifiers to mesh objects (DISABLED in Blender 2.8)
|
|
@@ -136,7 +139,7 @@ def fbx(
|
|
|
136
139
|
|
|
137
140
|
EDGE
|
|
138
141
|
Edge -- Write edge smoothing.
|
|
139
|
-
:type mesh_smooth_type:
|
|
142
|
+
:type mesh_smooth_type: typing.Literal['OFF','FACE','EDGE'] | None
|
|
140
143
|
:param colors_type: Vertex Colors, Export vertex color attributes
|
|
141
144
|
|
|
142
145
|
NONE
|
|
@@ -147,7 +150,7 @@ def fbx(
|
|
|
147
150
|
|
|
148
151
|
LINEAR
|
|
149
152
|
Linear -- Export colors in linear color space.
|
|
150
|
-
:type colors_type:
|
|
153
|
+
:type colors_type: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
151
154
|
:param prioritize_active_color: Prioritize Active Color, Make sure active color will be exported first. Could be important since some other software can discard other color attributes besides the first one
|
|
152
155
|
:type prioritize_active_color: bool | None
|
|
153
156
|
:param use_subsurf: Export Subdivision Surface, Export the last Catmull-Rom subdivision modifier as FBX subdivision (does not apply the modifier even if 'Apply Modifiers' is enabled)
|
|
@@ -163,9 +166,9 @@ def fbx(
|
|
|
163
166
|
:param add_leaf_bones: Add Leaf Bones, Append a final bone to the end of each chain to specify last bone length (use this when you intend to edit the armature from exported data)
|
|
164
167
|
:type add_leaf_bones: bool | None
|
|
165
168
|
:param primary_bone_axis: Primary Bone Axis
|
|
166
|
-
:type primary_bone_axis:
|
|
169
|
+
:type primary_bone_axis: typing.Literal['X','Y','Z','-X','-Y','-Z'] | None
|
|
167
170
|
:param secondary_bone_axis: Secondary Bone Axis
|
|
168
|
-
:type secondary_bone_axis:
|
|
171
|
+
:type secondary_bone_axis: typing.Literal['X','Y','Z','-X','-Y','-Z'] | None
|
|
169
172
|
:param use_armature_deform_only: Only Deform Bones, Only write deforming bones (and non-deforming ones when they have deforming children)
|
|
170
173
|
:type use_armature_deform_only: bool | None
|
|
171
174
|
:param armature_nodetype: Armature FBXNode Type, FBX type of node (object) used to represent Blender's armatures (use the Null type unless you experience issues with the other app, as other choices may not import back perfectly into Blender...)
|
|
@@ -178,7 +181,7 @@ def fbx(
|
|
|
178
181
|
|
|
179
182
|
LIMBNODE
|
|
180
183
|
LimbNode -- 'LimbNode' FBX node, a regular joint between two bones....
|
|
181
|
-
:type armature_nodetype:
|
|
184
|
+
:type armature_nodetype: typing.Literal['NULL','ROOT','LIMBNODE'] | None
|
|
182
185
|
:param bake_anim: Baked Animation, Export baked keyframe animation
|
|
183
186
|
:type bake_anim: bool | None
|
|
184
187
|
:param bake_anim_use_all_bones: Key All Bones, Force exporting at least one key of animation for all bones (needed with some target applications, like UE4)
|
|
@@ -212,7 +215,7 @@ def fbx(
|
|
|
212
215
|
|
|
213
216
|
COPY
|
|
214
217
|
Copy -- Copy the file to the destination path (or subdirectory).
|
|
215
|
-
:type path_mode:
|
|
218
|
+
:type path_mode: typing.Literal['AUTO','ABSOLUTE','RELATIVE','MATCH','STRIP','COPY'] | None
|
|
216
219
|
:param embed_textures: Embed Textures, Embed textures in FBX binary file (only for "Copy" path mode!)
|
|
217
220
|
:type embed_textures: bool | None
|
|
218
221
|
:param batch_mode: Batch Mode
|
|
@@ -231,15 +234,15 @@ def fbx(
|
|
|
231
234
|
|
|
232
235
|
ACTIVE_SCENE_COLLECTION
|
|
233
236
|
Active Scene Collections -- Each collection (including master, non-data-block one) of the active scene as a file, including content from children collections.
|
|
234
|
-
:type batch_mode:
|
|
237
|
+
:type batch_mode: typing.Literal['OFF','SCENE','COLLECTION','SCENE_COLLECTION','ACTIVE_SCENE_COLLECTION'] | None
|
|
235
238
|
:param use_batch_own_dir: Batch Own Dir, Create a dir for each exported file
|
|
236
239
|
:type use_batch_own_dir: bool | None
|
|
237
240
|
:param use_metadata: Use Metadata
|
|
238
241
|
:type use_metadata: bool | None
|
|
239
242
|
:param axis_forward: Forward
|
|
240
|
-
:type axis_forward:
|
|
243
|
+
:type axis_forward: typing.Literal['X','Y','Z','-X','-Y','-Z'] | None
|
|
241
244
|
:param axis_up: Up
|
|
242
|
-
:type axis_up:
|
|
245
|
+
:type axis_up: typing.Literal['X','Y','Z','-X','-Y','-Z'] | None
|
|
243
246
|
"""
|
|
244
247
|
|
|
245
248
|
...
|
|
@@ -251,7 +254,8 @@ def gltf(
|
|
|
251
254
|
*,
|
|
252
255
|
filepath: str = "",
|
|
253
256
|
check_existing: bool | None = True,
|
|
254
|
-
export_import_convert_lighting_mode:
|
|
257
|
+
export_import_convert_lighting_mode: typing.Literal["SPEC", "COMPAT", "RAW"]
|
|
258
|
+
| None = "SPEC",
|
|
255
259
|
gltf_export_id: str = "",
|
|
256
260
|
export_use_gltfpack: bool | None = False,
|
|
257
261
|
export_gltfpack_tc: bool | None = True,
|
|
@@ -263,12 +267,14 @@ def gltf(
|
|
|
263
267
|
export_gltfpack_vt: int | None = 12,
|
|
264
268
|
export_gltfpack_vn: int | None = 8,
|
|
265
269
|
export_gltfpack_vc: int | None = 8,
|
|
266
|
-
export_gltfpack_vpi:
|
|
270
|
+
export_gltfpack_vpi: typing.Literal["Integer", "Normalized", "Floating-point"]
|
|
271
|
+
| None = "Integer",
|
|
267
272
|
export_gltfpack_noq: bool | None = True,
|
|
268
273
|
export_format: str | None = "",
|
|
269
|
-
ui_tab:
|
|
274
|
+
ui_tab: typing.Literal["GENERAL", "MESHES", "OBJECTS", "ANIMATION"]
|
|
275
|
+
| None = "GENERAL",
|
|
270
276
|
export_copyright: str = "",
|
|
271
|
-
export_image_format:
|
|
277
|
+
export_image_format: typing.Literal["AUTO", "JPEG", "WEBP", "NONE"] | None = "AUTO",
|
|
272
278
|
export_image_add_webp: bool | None = False,
|
|
273
279
|
export_image_webp_fallback: bool | None = False,
|
|
274
280
|
export_texture_dir: str = "",
|
|
@@ -286,10 +292,11 @@ def gltf(
|
|
|
286
292
|
export_draco_color_quantization: int | None = 10,
|
|
287
293
|
export_draco_generic_quantization: int | None = 12,
|
|
288
294
|
export_tangents: bool | None = False,
|
|
289
|
-
export_materials:
|
|
295
|
+
export_materials: typing.Literal["EXPORT", "PLACEHOLDER", "NONE"] | None = "EXPORT",
|
|
290
296
|
export_unused_images: bool | None = False,
|
|
291
297
|
export_unused_textures: bool | None = False,
|
|
292
|
-
export_vertex_color:
|
|
298
|
+
export_vertex_color: typing.Literal["MATERIAL", "ACTIVE", "NONE"]
|
|
299
|
+
| None = "MATERIAL",
|
|
293
300
|
export_all_vertex_colors: bool | None = True,
|
|
294
301
|
export_active_vertex_color_when_no_material: bool | None = True,
|
|
295
302
|
export_attributes: bool | None = False,
|
|
@@ -313,7 +320,10 @@ def gltf(
|
|
|
313
320
|
export_frame_step: int | None = 1,
|
|
314
321
|
export_force_sampling: bool | None = True,
|
|
315
322
|
export_pointer_animation: bool | None = False,
|
|
316
|
-
export_animation_mode:
|
|
323
|
+
export_animation_mode: typing.Literal[
|
|
324
|
+
"ACTIONS", "ACTIVE_ACTIONS", "BROADCAST", "NLA_TRACKS", "SCENE"
|
|
325
|
+
]
|
|
326
|
+
| None = "ACTIONS",
|
|
317
327
|
export_nla_strips_merged_animation_name: str = "Animation",
|
|
318
328
|
export_def_bones: bool | None = False,
|
|
319
329
|
export_hierarchy_flatten_bones: bool | None = False,
|
|
@@ -324,7 +334,7 @@ def gltf(
|
|
|
324
334
|
export_optimize_animation_keep_anim_armature: bool | None = True,
|
|
325
335
|
export_optimize_animation_keep_anim_object: bool | None = False,
|
|
326
336
|
export_optimize_disable_viewport: bool | None = False,
|
|
327
|
-
export_negative_frame:
|
|
337
|
+
export_negative_frame: typing.Literal["SLIDE", "CROP"] | None = "SLIDE",
|
|
328
338
|
export_anim_slide_to_zero: bool | None = False,
|
|
329
339
|
export_bake_animation: bool | None = False,
|
|
330
340
|
export_anim_single_armature: bool | None = True,
|
|
@@ -372,7 +382,7 @@ def gltf(
|
|
|
372
382
|
|
|
373
383
|
RAW
|
|
374
384
|
Raw (Deprecated) -- Blender lighting strengths with no conversion.
|
|
375
|
-
:type export_import_convert_lighting_mode:
|
|
385
|
+
:type export_import_convert_lighting_mode: typing.Literal['SPEC','COMPAT','RAW'] | None
|
|
376
386
|
:param gltf_export_id: Identifier, Identifier of caller (in case of add-on calling this exporter). Can be useful in case of Extension added by other add-ons
|
|
377
387
|
:type gltf_export_id: str
|
|
378
388
|
:param export_use_gltfpack: Use Gltfpack, Use gltfpack to simplify the mesh and/or compress its textures
|
|
@@ -405,7 +415,7 @@ def gltf(
|
|
|
405
415
|
|
|
406
416
|
Floating-point
|
|
407
417
|
Floating-point -- Use floating-point attributes for positions.
|
|
408
|
-
:type export_gltfpack_vpi:
|
|
418
|
+
:type export_gltfpack_vpi: typing.Literal['Integer','Normalized','Floating-point'] | None
|
|
409
419
|
:param export_gltfpack_noq: Disable Quantization, Disable quantization; produces much larger glTF files with no extensions
|
|
410
420
|
:type export_gltfpack_noq: bool | None
|
|
411
421
|
:param export_format: Format, Output format. Binary is most efficient, but JSON may be easier to edit later
|
|
@@ -423,7 +433,7 @@ def gltf(
|
|
|
423
433
|
|
|
424
434
|
ANIMATION
|
|
425
435
|
Animation -- Animation settings.
|
|
426
|
-
:type ui_tab:
|
|
436
|
+
:type ui_tab: typing.Literal['GENERAL','MESHES','OBJECTS','ANIMATION'] | None
|
|
427
437
|
:param export_copyright: Copyright, Legal rights and conditions for the model
|
|
428
438
|
:type export_copyright: str
|
|
429
439
|
:param export_image_format: Images, Output format for images. PNG is lossless and generally preferred, but JPEG might be preferable for web applications due to the smaller file size. Alternatively they can be omitted if they are not needed
|
|
@@ -439,7 +449,7 @@ def gltf(
|
|
|
439
449
|
|
|
440
450
|
NONE
|
|
441
451
|
None -- Don't export images.
|
|
442
|
-
:type export_image_format:
|
|
452
|
+
:type export_image_format: typing.Literal['AUTO','JPEG','WEBP','NONE'] | None
|
|
443
453
|
:param export_image_add_webp: Create WebP, Creates WebP textures for every texture. For already WebP textures, nothing happens
|
|
444
454
|
:type export_image_add_webp: bool | None
|
|
445
455
|
:param export_image_webp_fallback: WebP fallback, For all WebP textures, create a PNG fallback texture
|
|
@@ -484,7 +494,7 @@ def gltf(
|
|
|
484
494
|
|
|
485
495
|
NONE
|
|
486
496
|
No export -- Do not export materials, and combine mesh primitive groups, losing material slot information.
|
|
487
|
-
:type export_materials:
|
|
497
|
+
:type export_materials: typing.Literal['EXPORT','PLACEHOLDER','NONE'] | None
|
|
488
498
|
:param export_unused_images: Unused images, Export images not assigned to any material
|
|
489
499
|
:type export_unused_images: bool | None
|
|
490
500
|
:param export_unused_textures: Prepare Unused textures, Export image texture nodes not assigned to any material. This feature is not standard and needs an external extension to be included in the glTF file
|
|
@@ -499,7 +509,7 @@ def gltf(
|
|
|
499
509
|
|
|
500
510
|
NONE
|
|
501
511
|
None -- Do not export vertex color.
|
|
502
|
-
:type export_vertex_color:
|
|
512
|
+
:type export_vertex_color: typing.Literal['MATERIAL','ACTIVE','NONE'] | None
|
|
503
513
|
:param export_all_vertex_colors: Export all vertex colors, Export all vertex colors, even if not used by any material. If no Vertex Color is used in the mesh materials, a fake COLOR_0 will be created, in order to keep material unchanged
|
|
504
514
|
:type export_all_vertex_colors: bool | None
|
|
505
515
|
:param export_active_vertex_color_when_no_material: Export active vertex color when no material, When there is no material on object, export active vertex color
|
|
@@ -562,7 +572,7 @@ def gltf(
|
|
|
562
572
|
|
|
563
573
|
SCENE
|
|
564
574
|
Scene -- Export baked scene as a single animation.
|
|
565
|
-
:type export_animation_mode:
|
|
575
|
+
:type export_animation_mode: typing.Literal['ACTIONS','ACTIVE_ACTIONS','BROADCAST','NLA_TRACKS','SCENE'] | None
|
|
566
576
|
:param export_nla_strips_merged_animation_name: Merged Animation Name, Name of single glTF animation to be exported
|
|
567
577
|
:type export_nla_strips_merged_animation_name: str
|
|
568
578
|
:param export_def_bones: Export Deformation Bones Only, Export Deformation bones only
|
|
@@ -590,7 +600,7 @@ def gltf(
|
|
|
590
600
|
|
|
591
601
|
CROP
|
|
592
602
|
Crop -- Keep only frames above frame 0.
|
|
593
|
-
:type export_negative_frame:
|
|
603
|
+
:type export_negative_frame: typing.Literal['SLIDE','CROP'] | None
|
|
594
604
|
:param export_anim_slide_to_zero: Set all glTF Animation starting at 0, Set all glTF animation starting at 0.0s. Can be useful for looping animations
|
|
595
605
|
:type export_anim_slide_to_zero: bool | None
|
|
596
606
|
:param export_bake_animation: Bake All Objects Animations, Force exporting animation on every object. Can be useful when using constraints or driver. Also useful when exporting only selection
|
bpy/ops/file/__init__.pyi
CHANGED
|
@@ -71,7 +71,7 @@ def bookmark_move(
|
|
|
71
71
|
execution_context: int | str | None = None,
|
|
72
72
|
undo: bool | None = None,
|
|
73
73
|
*,
|
|
74
|
-
direction:
|
|
74
|
+
direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "TOP",
|
|
75
75
|
):
|
|
76
76
|
"""Move the active bookmark up/down in the list
|
|
77
77
|
|
|
@@ -91,7 +91,7 @@ def bookmark_move(
|
|
|
91
91
|
|
|
92
92
|
BOTTOM
|
|
93
93
|
Bottom -- Bottom of the list.
|
|
94
|
-
:type direction:
|
|
94
|
+
:type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
|
|
95
95
|
"""
|
|
96
96
|
|
|
97
97
|
...
|
|
@@ -179,7 +179,24 @@ def external_operation(
|
|
|
179
179
|
undo: bool | None = None,
|
|
180
180
|
*,
|
|
181
181
|
filepath: str = "",
|
|
182
|
-
operation:
|
|
182
|
+
operation: typing.Literal[
|
|
183
|
+
"OPEN",
|
|
184
|
+
"FOLDER_OPEN",
|
|
185
|
+
"EDIT",
|
|
186
|
+
"NEW",
|
|
187
|
+
"FIND",
|
|
188
|
+
"SHOW",
|
|
189
|
+
"PLAY",
|
|
190
|
+
"BROWSE",
|
|
191
|
+
"PREVIEW",
|
|
192
|
+
"PRINT",
|
|
193
|
+
"INSTALL",
|
|
194
|
+
"RUNAS",
|
|
195
|
+
"PROPERTIES",
|
|
196
|
+
"FOLDER_FIND",
|
|
197
|
+
"CMD",
|
|
198
|
+
]
|
|
199
|
+
| None = "OPEN",
|
|
183
200
|
):
|
|
184
201
|
"""Perform external operation on a file or folder
|
|
185
202
|
|
|
@@ -234,7 +251,7 @@ def external_operation(
|
|
|
234
251
|
|
|
235
252
|
CMD
|
|
236
253
|
Command Prompt Here -- Open a command prompt here.
|
|
237
|
-
:type operation:
|
|
254
|
+
:type operation: typing.Literal['OPEN','FOLDER_OPEN','EDIT','NEW','FIND','SHOW','PLAY','BROWSE','PREVIEW','PRINT','INSTALL','RUNAS','PROPERTIES','FOLDER_FIND','CMD'] | None
|
|
238
255
|
"""
|
|
239
256
|
|
|
240
257
|
...
|
|
@@ -301,7 +318,10 @@ def find_missing_files(
|
|
|
301
318
|
filter_folder: bool | None = False,
|
|
302
319
|
filter_blenlib: bool | None = False,
|
|
303
320
|
filemode: int | None = 9,
|
|
304
|
-
display_type:
|
|
321
|
+
display_type: typing.Literal[
|
|
322
|
+
"DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
|
|
323
|
+
]
|
|
324
|
+
| None = "DEFAULT",
|
|
305
325
|
sort_method: str | None = "",
|
|
306
326
|
):
|
|
307
327
|
"""Try to find missing external files
|
|
@@ -366,7 +386,7 @@ def find_missing_files(
|
|
|
366
386
|
|
|
367
387
|
THUMBNAIL
|
|
368
388
|
Thumbnails -- Display files as thumbnails.
|
|
369
|
-
:type display_type:
|
|
389
|
+
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
370
390
|
:param sort_method: File sorting mode
|
|
371
391
|
:type sort_method: str | None
|
|
372
392
|
"""
|
|
@@ -616,7 +636,7 @@ def select_all(
|
|
|
616
636
|
execution_context: int | str | None = None,
|
|
617
637
|
undo: bool | None = None,
|
|
618
638
|
*,
|
|
619
|
-
action:
|
|
639
|
+
action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
|
|
620
640
|
):
|
|
621
641
|
"""Select or deselect all files
|
|
622
642
|
|
|
@@ -636,7 +656,7 @@ def select_all(
|
|
|
636
656
|
|
|
637
657
|
INVERT
|
|
638
658
|
Invert -- Invert selection of all elements.
|
|
639
|
-
:type action:
|
|
659
|
+
:type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
|
|
640
660
|
"""
|
|
641
661
|
|
|
642
662
|
...
|
|
@@ -669,7 +689,7 @@ def select_box(
|
|
|
669
689
|
ymin: int | None = 0,
|
|
670
690
|
ymax: int | None = 0,
|
|
671
691
|
wait_for_input: bool | None = True,
|
|
672
|
-
mode:
|
|
692
|
+
mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
|
|
673
693
|
):
|
|
674
694
|
"""Activate/select the file(s) contained in the border
|
|
675
695
|
|
|
@@ -696,7 +716,7 @@ def select_box(
|
|
|
696
716
|
|
|
697
717
|
SUB
|
|
698
718
|
Subtract -- Subtract existing selection.
|
|
699
|
-
:type mode:
|
|
719
|
+
:type mode: typing.Literal['SET','ADD','SUB'] | None
|
|
700
720
|
"""
|
|
701
721
|
|
|
702
722
|
...
|
|
@@ -706,7 +726,7 @@ def select_walk(
|
|
|
706
726
|
execution_context: int | str | None = None,
|
|
707
727
|
undo: bool | None = None,
|
|
708
728
|
*,
|
|
709
|
-
direction:
|
|
729
|
+
direction: typing.Literal["UP", "DOWN", "LEFT", "RIGHT"] | None = "UP",
|
|
710
730
|
extend: bool | None = False,
|
|
711
731
|
fill: bool | None = False,
|
|
712
732
|
):
|
|
@@ -716,7 +736,7 @@ def select_walk(
|
|
|
716
736
|
:type execution_context: int | str | None
|
|
717
737
|
:type undo: bool | None
|
|
718
738
|
:param direction: Walk Direction, Select/Deselect element in this direction
|
|
719
|
-
:type direction:
|
|
739
|
+
:type direction: typing.Literal['UP','DOWN','LEFT','RIGHT'] | None
|
|
720
740
|
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
721
741
|
:type extend: bool | None
|
|
722
742
|
:param fill: Fill, Select everything beginning with the last selection
|
|
@@ -772,7 +792,10 @@ def unpack_all(
|
|
|
772
792
|
execution_context: int | str | None = None,
|
|
773
793
|
undo: bool | None = None,
|
|
774
794
|
*,
|
|
775
|
-
method:
|
|
795
|
+
method: typing.Literal[
|
|
796
|
+
"USE_LOCAL", "WRITE_LOCAL", "USE_ORIGINAL", "WRITE_ORIGINAL", "KEEP", "REMOVE"
|
|
797
|
+
]
|
|
798
|
+
| None = "USE_LOCAL",
|
|
776
799
|
):
|
|
777
800
|
"""Unpack all files packed into this .blend to external ones
|
|
778
801
|
|
|
@@ -780,7 +803,7 @@ def unpack_all(
|
|
|
780
803
|
:type execution_context: int | str | None
|
|
781
804
|
:type undo: bool | None
|
|
782
805
|
:param method: Method, How to unpack
|
|
783
|
-
:type method:
|
|
806
|
+
:type method: typing.Literal['USE_LOCAL','WRITE_LOCAL','USE_ORIGINAL','WRITE_ORIGINAL','KEEP','REMOVE'] | None
|
|
784
807
|
"""
|
|
785
808
|
|
|
786
809
|
...
|
|
@@ -790,7 +813,8 @@ def unpack_item(
|
|
|
790
813
|
execution_context: int | str | None = None,
|
|
791
814
|
undo: bool | None = None,
|
|
792
815
|
*,
|
|
793
|
-
method:
|
|
816
|
+
method: typing.Literal["USE_LOCAL", "WRITE_LOCAL", "USE_ORIGINAL", "WRITE_ORIGINAL"]
|
|
817
|
+
| None = "USE_LOCAL",
|
|
794
818
|
id_name: str = "",
|
|
795
819
|
id_type: int | None = 19785,
|
|
796
820
|
):
|
|
@@ -800,7 +824,7 @@ def unpack_item(
|
|
|
800
824
|
:type execution_context: int | str | None
|
|
801
825
|
:type undo: bool | None
|
|
802
826
|
:param method: Method, How to unpack
|
|
803
|
-
:type method:
|
|
827
|
+
:type method: typing.Literal['USE_LOCAL','WRITE_LOCAL','USE_ORIGINAL','WRITE_ORIGINAL'] | None
|
|
804
828
|
:param id_name: ID Name, Name of ID block to unpack
|
|
805
829
|
:type id_name: str
|
|
806
830
|
:param id_type: ID Type, Identifier type of ID block
|