fake-bpy-module 20240619__py3-none-any.whl → 20240621__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.
- bl_ui/space_userpref/__init__.pyi +225 -0
- bpy/ops/action/__init__.pyi +50 -50
- bpy/ops/anim/__init__.pyi +94 -94
- bpy/ops/armature/__init__.pyi +54 -54
- bpy/ops/asset/__init__.pyi +50 -50
- bpy/ops/brush/__init__.pyi +10 -10
- bpy/ops/buttons/__init__.pyi +88 -88
- bpy/ops/cachefile/__init__.pyi +88 -88
- bpy/ops/camera/__init__.pyi +14 -14
- bpy/ops/clip/__init__.pyi +175 -174
- bpy/ops/cloth/__init__.pyi +6 -6
- bpy/ops/collection/__init__.pyi +8 -8
- bpy/ops/console/__init__.pyi +26 -26
- bpy/ops/constraint/__init__.pyi +42 -42
- bpy/ops/curve/__init__.pyi +167 -122
- bpy/ops/curves/__init__.pyi +75 -58
- bpy/ops/cycles/__init__.pyi +10 -10
- bpy/ops/ed/__init__.pyi +50 -50
- bpy/ops/export_anim/__init__.pyi +14 -14
- bpy/ops/export_scene/__init__.pyi +250 -250
- bpy/ops/extensions/__init__.pyi +73 -73
- bpy/ops/file/__init__.pyi +94 -94
- bpy/ops/fluid/__init__.pyi +6 -6
- bpy/ops/font/__init__.pyi +100 -100
- bpy/ops/geometry/__init__.pyi +20 -20
- bpy/ops/gizmogroup/__init__.pyi +10 -10
- bpy/ops/gpencil/__init__.pyi +411 -410
- bpy/ops/graph/__init__.pyi +194 -194
- bpy/ops/grease_pencil/__init__.pyi +100 -100
- bpy/ops/image/__init__.pyi +399 -390
- bpy/ops/import_anim/__init__.pyi +16 -16
- bpy/ops/import_curve/__init__.pyi +4 -4
- bpy/ops/import_scene/__init__.pyi +56 -56
- bpy/ops/info/__init__.pyi +14 -14
- bpy/ops/lattice/__init__.pyi +10 -10
- bpy/ops/marker/__init__.pyi +34 -34
- bpy/ops/mask/__init__.pyi +63 -62
- bpy/ops/mball/__init__.pyi +12 -12
- bpy/ops/mesh/__init__.pyi +901 -798
- bpy/ops/nla/__init__.pyi +70 -70
- bpy/ops/node/__init__.pyi +192 -192
- bpy/ops/object/__init__.pyi +1017 -844
- bpy/ops/outliner/__init__.pyi +44 -44
- bpy/ops/paint/__init__.pyi +169 -168
- bpy/ops/paintcurve/__init__.pyi +12 -12
- bpy/ops/palette/__init__.pyi +4 -4
- bpy/ops/particle/__init__.pyi +34 -34
- bpy/ops/pose/__init__.pyi +60 -60
- bpy/ops/poselib/__init__.pyi +18 -18
- bpy/ops/preferences/__init__.pyi +150 -150
- bpy/ops/ptcache/__init__.pyi +4 -4
- bpy/ops/render/__init__.pyi +56 -56
- bpy/ops/rigidbody/__init__.pyi +8 -8
- bpy/ops/scene/__init__.pyi +20 -20
- bpy/ops/screen/__init__.pyi +128 -128
- bpy/ops/script/__init__.pyi +6 -6
- bpy/ops/sculpt/__init__.pyi +207 -202
- bpy/ops/sculpt_curves/__init__.pyi +12 -12
- bpy/ops/sequencer/__init__.pyi +465 -464
- bpy/ops/sound/__init__.pyi +154 -154
- bpy/ops/spreadsheet/__init__.pyi +6 -6
- bpy/ops/surface/__init__.pyi +109 -60
- bpy/ops/text/__init__.pyi +110 -110
- bpy/ops/text_editor/__init__.pyi +6 -6
- bpy/ops/transform/__init__.pyi +642 -580
- bpy/ops/ui/__init__.pyi +25 -24
- bpy/ops/uilist/__init__.pyi +12 -12
- bpy/ops/uv/__init__.pyi +235 -234
- bpy/ops/view2d/__init__.pyi +72 -72
- bpy/ops/view3d/__init__.pyi +144 -144
- bpy/ops/wm/__init__.pyi +1814 -1804
- bpy/ops/workspace/__init__.pyi +4 -4
- bpy/types/__init__.pyi +30115 -30082
- {fake_bpy_module-20240619.dist-info → fake_bpy_module-20240621.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240619.dist-info → fake_bpy_module-20240621.dist-info}/RECORD +78 -78
- {fake_bpy_module-20240619.dist-info → fake_bpy_module-20240621.dist-info}/WHEEL +1 -1
- freestyle/utils/__init__.pyi +1 -1
- {fake_bpy_module-20240619.dist-info → fake_bpy_module-20240621.dist-info}/top_level.txt +0 -0
bpy/ops/image/__init__.pyi
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import typing
|
|
2
2
|
import collections.abc
|
|
3
3
|
import bpy.types
|
|
4
|
+
import mathutils
|
|
4
5
|
|
|
5
6
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
6
7
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
@@ -24,7 +25,7 @@ def change_frame(
|
|
|
24
25
|
execution_context: int | str | None = None,
|
|
25
26
|
undo: bool | None = None,
|
|
26
27
|
*,
|
|
27
|
-
frame:
|
|
28
|
+
frame: int | None = 0,
|
|
28
29
|
):
|
|
29
30
|
"""Interactively change the current frame number
|
|
30
31
|
|
|
@@ -32,7 +33,7 @@ def change_frame(
|
|
|
32
33
|
:type execution_context: int | str | None
|
|
33
34
|
:type undo: bool | None
|
|
34
35
|
:param frame: Frame
|
|
35
|
-
:type frame:
|
|
36
|
+
:type frame: int | None
|
|
36
37
|
"""
|
|
37
38
|
|
|
38
39
|
...
|
|
@@ -101,18 +102,18 @@ def convert_to_mesh_plane(
|
|
|
101
102
|
interpolation: str | None = "Linear",
|
|
102
103
|
extension: str | None = "CLIP",
|
|
103
104
|
alpha_mode: str | None = "STRAIGHT",
|
|
104
|
-
use_auto_refresh: bool |
|
|
105
|
-
relative: bool |
|
|
105
|
+
use_auto_refresh: bool | None = True,
|
|
106
|
+
relative: bool | None = True,
|
|
106
107
|
shader: str | None = "PRINCIPLED",
|
|
107
|
-
emit_strength:
|
|
108
|
-
use_transparency: bool |
|
|
108
|
+
emit_strength: float | None = 1.0,
|
|
109
|
+
use_transparency: bool | None = True,
|
|
109
110
|
blend_method: str | None = "BLEND",
|
|
110
111
|
shadow_method: str | None = "CLIP",
|
|
111
|
-
use_backface_culling: bool |
|
|
112
|
-
show_transparent_back: bool |
|
|
113
|
-
overwrite_material: bool |
|
|
112
|
+
use_backface_culling: bool | None = False,
|
|
113
|
+
show_transparent_back: bool | None = True,
|
|
114
|
+
overwrite_material: bool | None = True,
|
|
114
115
|
name_from: str | None = "OBJECT",
|
|
115
|
-
delete_ref: bool |
|
|
116
|
+
delete_ref: bool | None = True,
|
|
116
117
|
):
|
|
117
118
|
"""Convert selected reference images to textured mesh plane
|
|
118
119
|
|
|
@@ -159,9 +160,9 @@ def convert_to_mesh_plane(
|
|
|
159
160
|
None -- Ignore alpha channel from the file and make image fully opaque.
|
|
160
161
|
:type alpha_mode: str | None
|
|
161
162
|
:param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
|
|
162
|
-
:type use_auto_refresh: bool |
|
|
163
|
+
:type use_auto_refresh: bool | None
|
|
163
164
|
:param relative: Relative Paths, Use relative file paths
|
|
164
|
-
:type relative: bool |
|
|
165
|
+
:type relative: bool | None
|
|
165
166
|
:param shader: Shader, Node shader to use
|
|
166
167
|
|
|
167
168
|
PRINCIPLED
|
|
@@ -174,9 +175,9 @@ def convert_to_mesh_plane(
|
|
|
174
175
|
Emission -- Emission shader.
|
|
175
176
|
:type shader: str | None
|
|
176
177
|
:param emit_strength: Emission Strength, Strength of emission
|
|
177
|
-
:type emit_strength:
|
|
178
|
+
:type emit_strength: float | None
|
|
178
179
|
:param use_transparency: Use Alpha, Use alpha channel for transparency
|
|
179
|
-
:type use_transparency: bool |
|
|
180
|
+
:type use_transparency: bool | None
|
|
180
181
|
:param blend_method: Blend Mode, Blend Mode for Transparent Faces
|
|
181
182
|
|
|
182
183
|
BLEND
|
|
@@ -206,11 +207,11 @@ def convert_to_mesh_plane(
|
|
|
206
207
|
None -- Material will cast no shadow.
|
|
207
208
|
:type shadow_method: str | None
|
|
208
209
|
:param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
|
|
209
|
-
:type use_backface_culling: bool |
|
|
210
|
+
:type use_backface_culling: bool | None
|
|
210
211
|
:param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
|
|
211
|
-
:type show_transparent_back: bool |
|
|
212
|
+
:type show_transparent_back: bool | None
|
|
212
213
|
:param overwrite_material: Overwrite Material, Overwrite existing material with the same name
|
|
213
|
-
:type overwrite_material: bool |
|
|
214
|
+
:type overwrite_material: bool | None
|
|
214
215
|
:param name_from: Name After, Name for new mesh object and material
|
|
215
216
|
|
|
216
217
|
OBJECT
|
|
@@ -220,7 +221,7 @@ def convert_to_mesh_plane(
|
|
|
220
221
|
Source Image -- name from laoded image.
|
|
221
222
|
:type name_from: str | None
|
|
222
223
|
:param delete_ref: Delete Reference Object, Delete empty image object once mesh plane is created
|
|
223
|
-
:type delete_ref: bool |
|
|
224
|
+
:type delete_ref: bool | None
|
|
224
225
|
"""
|
|
225
226
|
|
|
226
227
|
...
|
|
@@ -231,7 +232,7 @@ def curves_point_set(
|
|
|
231
232
|
undo: bool | None = None,
|
|
232
233
|
*,
|
|
233
234
|
point: str | None = "BLACK_POINT",
|
|
234
|
-
size:
|
|
235
|
+
size: int | None = 1,
|
|
235
236
|
):
|
|
236
237
|
"""Set black point or white point for curves
|
|
237
238
|
|
|
@@ -241,7 +242,7 @@ def curves_point_set(
|
|
|
241
242
|
:param point: Point, Set black point or white point for curves
|
|
242
243
|
:type point: str | None
|
|
243
244
|
:param size: Sample Size
|
|
244
|
-
:type size:
|
|
245
|
+
:type size: int | None
|
|
245
246
|
"""
|
|
246
247
|
|
|
247
248
|
...
|
|
@@ -251,7 +252,7 @@ def cycle_render_slot(
|
|
|
251
252
|
execution_context: int | str | None = None,
|
|
252
253
|
undo: bool | None = None,
|
|
253
254
|
*,
|
|
254
|
-
reverse: bool |
|
|
255
|
+
reverse: bool | None = False,
|
|
255
256
|
):
|
|
256
257
|
"""Cycle through all non-void render slots
|
|
257
258
|
|
|
@@ -259,7 +260,7 @@ def cycle_render_slot(
|
|
|
259
260
|
:type execution_context: int | str | None
|
|
260
261
|
:type undo: bool | None
|
|
261
262
|
:param reverse: Cycle in Reverse
|
|
262
|
-
:type reverse: bool |
|
|
263
|
+
:type reverse: bool | None
|
|
263
264
|
"""
|
|
264
265
|
|
|
265
266
|
...
|
|
@@ -269,7 +270,7 @@ def external_edit(
|
|
|
269
270
|
execution_context: int | str | None = None,
|
|
270
271
|
undo: bool | None = None,
|
|
271
272
|
*,
|
|
272
|
-
filepath: str
|
|
273
|
+
filepath: str = "",
|
|
273
274
|
):
|
|
274
275
|
"""Edit image in an external application
|
|
275
276
|
|
|
@@ -277,7 +278,7 @@ def external_edit(
|
|
|
277
278
|
:type execution_context: int | str | None
|
|
278
279
|
:type undo: bool | None
|
|
279
280
|
:param filepath: filepath
|
|
280
|
-
:type filepath: str
|
|
281
|
+
:type filepath: str
|
|
281
282
|
"""
|
|
282
283
|
|
|
283
284
|
...
|
|
@@ -287,30 +288,30 @@ def file_browse(
|
|
|
287
288
|
execution_context: int | str | None = None,
|
|
288
289
|
undo: bool | None = None,
|
|
289
290
|
*,
|
|
290
|
-
filepath: str
|
|
291
|
-
hide_props_region: bool |
|
|
292
|
-
check_existing: bool |
|
|
293
|
-
filter_blender: bool |
|
|
294
|
-
filter_backup: bool |
|
|
295
|
-
filter_image: bool |
|
|
296
|
-
filter_movie: bool |
|
|
297
|
-
filter_python: bool |
|
|
298
|
-
filter_font: bool |
|
|
299
|
-
filter_sound: bool |
|
|
300
|
-
filter_text: bool |
|
|
301
|
-
filter_archive: bool |
|
|
302
|
-
filter_btx: bool |
|
|
303
|
-
filter_collada: bool |
|
|
304
|
-
filter_alembic: bool |
|
|
305
|
-
filter_usd: bool |
|
|
306
|
-
filter_obj: bool |
|
|
307
|
-
filter_volume: bool |
|
|
308
|
-
filter_folder: bool |
|
|
309
|
-
filter_blenlib: bool |
|
|
310
|
-
filemode:
|
|
311
|
-
relative_path: bool |
|
|
312
|
-
show_multiview: bool |
|
|
313
|
-
use_multiview: bool |
|
|
291
|
+
filepath: str = "",
|
|
292
|
+
hide_props_region: bool | None = True,
|
|
293
|
+
check_existing: bool | None = False,
|
|
294
|
+
filter_blender: bool | None = False,
|
|
295
|
+
filter_backup: bool | None = False,
|
|
296
|
+
filter_image: bool | None = True,
|
|
297
|
+
filter_movie: bool | None = True,
|
|
298
|
+
filter_python: bool | None = False,
|
|
299
|
+
filter_font: bool | None = False,
|
|
300
|
+
filter_sound: bool | None = False,
|
|
301
|
+
filter_text: bool | None = False,
|
|
302
|
+
filter_archive: bool | None = False,
|
|
303
|
+
filter_btx: bool | None = False,
|
|
304
|
+
filter_collada: bool | None = False,
|
|
305
|
+
filter_alembic: bool | None = False,
|
|
306
|
+
filter_usd: bool | None = False,
|
|
307
|
+
filter_obj: bool | None = False,
|
|
308
|
+
filter_volume: bool | None = False,
|
|
309
|
+
filter_folder: bool | None = True,
|
|
310
|
+
filter_blenlib: bool | None = False,
|
|
311
|
+
filemode: int | None = 9,
|
|
312
|
+
relative_path: bool | None = True,
|
|
313
|
+
show_multiview: bool | None = False,
|
|
314
|
+
use_multiview: bool | None = False,
|
|
314
315
|
display_type: str | None = "DEFAULT",
|
|
315
316
|
sort_method: str | None = "",
|
|
316
317
|
):
|
|
@@ -320,53 +321,53 @@ def file_browse(
|
|
|
320
321
|
:type execution_context: int | str | None
|
|
321
322
|
:type undo: bool | None
|
|
322
323
|
:param filepath: File Path, Path to file
|
|
323
|
-
:type filepath: str
|
|
324
|
+
:type filepath: str
|
|
324
325
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
325
|
-
:type hide_props_region: bool |
|
|
326
|
+
:type hide_props_region: bool | None
|
|
326
327
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
327
|
-
:type check_existing: bool |
|
|
328
|
+
:type check_existing: bool | None
|
|
328
329
|
:param filter_blender: Filter .blend files
|
|
329
|
-
:type filter_blender: bool |
|
|
330
|
+
:type filter_blender: bool | None
|
|
330
331
|
:param filter_backup: Filter .blend files
|
|
331
|
-
:type filter_backup: bool |
|
|
332
|
+
:type filter_backup: bool | None
|
|
332
333
|
:param filter_image: Filter image files
|
|
333
|
-
:type filter_image: bool |
|
|
334
|
+
:type filter_image: bool | None
|
|
334
335
|
:param filter_movie: Filter movie files
|
|
335
|
-
:type filter_movie: bool |
|
|
336
|
+
:type filter_movie: bool | None
|
|
336
337
|
:param filter_python: Filter Python files
|
|
337
|
-
:type filter_python: bool |
|
|
338
|
+
:type filter_python: bool | None
|
|
338
339
|
:param filter_font: Filter font files
|
|
339
|
-
:type filter_font: bool |
|
|
340
|
+
:type filter_font: bool | None
|
|
340
341
|
:param filter_sound: Filter sound files
|
|
341
|
-
:type filter_sound: bool |
|
|
342
|
+
:type filter_sound: bool | None
|
|
342
343
|
:param filter_text: Filter text files
|
|
343
|
-
:type filter_text: bool |
|
|
344
|
+
:type filter_text: bool | None
|
|
344
345
|
:param filter_archive: Filter archive files
|
|
345
|
-
:type filter_archive: bool |
|
|
346
|
+
:type filter_archive: bool | None
|
|
346
347
|
:param filter_btx: Filter btx files
|
|
347
|
-
:type filter_btx: bool |
|
|
348
|
+
:type filter_btx: bool | None
|
|
348
349
|
:param filter_collada: Filter COLLADA files
|
|
349
|
-
:type filter_collada: bool |
|
|
350
|
+
:type filter_collada: bool | None
|
|
350
351
|
:param filter_alembic: Filter Alembic files
|
|
351
|
-
:type filter_alembic: bool |
|
|
352
|
+
:type filter_alembic: bool | None
|
|
352
353
|
:param filter_usd: Filter USD files
|
|
353
|
-
:type filter_usd: bool |
|
|
354
|
+
:type filter_usd: bool | None
|
|
354
355
|
:param filter_obj: Filter OBJ files
|
|
355
|
-
:type filter_obj: bool |
|
|
356
|
+
:type filter_obj: bool | None
|
|
356
357
|
:param filter_volume: Filter OpenVDB volume files
|
|
357
|
-
:type filter_volume: bool |
|
|
358
|
+
:type filter_volume: bool | None
|
|
358
359
|
:param filter_folder: Filter folders
|
|
359
|
-
:type filter_folder: bool |
|
|
360
|
+
:type filter_folder: bool | None
|
|
360
361
|
:param filter_blenlib: Filter Blender IDs
|
|
361
|
-
:type filter_blenlib: bool |
|
|
362
|
+
:type filter_blenlib: bool | None
|
|
362
363
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
363
|
-
:type filemode:
|
|
364
|
+
:type filemode: int | None
|
|
364
365
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
365
|
-
:type relative_path: bool |
|
|
366
|
+
:type relative_path: bool | None
|
|
366
367
|
:param show_multiview: Enable Multi-View
|
|
367
|
-
:type show_multiview: bool |
|
|
368
|
+
:type show_multiview: bool | None
|
|
368
369
|
:param use_multiview: Use Multi-View
|
|
369
|
-
:type use_multiview: bool |
|
|
370
|
+
:type use_multiview: bool | None
|
|
370
371
|
:param display_type: Display Type
|
|
371
372
|
|
|
372
373
|
DEFAULT
|
|
@@ -392,8 +393,8 @@ def flip(
|
|
|
392
393
|
execution_context: int | str | None = None,
|
|
393
394
|
undo: bool | None = None,
|
|
394
395
|
*,
|
|
395
|
-
use_flip_x: bool |
|
|
396
|
-
use_flip_y: bool |
|
|
396
|
+
use_flip_x: bool | None = False,
|
|
397
|
+
use_flip_y: bool | None = False,
|
|
397
398
|
):
|
|
398
399
|
"""Flip the image
|
|
399
400
|
|
|
@@ -401,9 +402,9 @@ def flip(
|
|
|
401
402
|
:type execution_context: int | str | None
|
|
402
403
|
:type undo: bool | None
|
|
403
404
|
:param use_flip_x: Horizontal, Flip the image horizontally
|
|
404
|
-
:type use_flip_x: bool |
|
|
405
|
+
:type use_flip_x: bool | None
|
|
405
406
|
:param use_flip_y: Vertical, Flip the image vertically
|
|
406
|
-
:type use_flip_y: bool |
|
|
407
|
+
:type use_flip_y: bool | None
|
|
407
408
|
"""
|
|
408
409
|
|
|
409
410
|
...
|
|
@@ -416,38 +417,46 @@ def import_as_mesh_planes(
|
|
|
416
417
|
interpolation: str | None = "Linear",
|
|
417
418
|
extension: str | None = "CLIP",
|
|
418
419
|
alpha_mode: str | None = "STRAIGHT",
|
|
419
|
-
use_auto_refresh: bool |
|
|
420
|
-
relative: bool |
|
|
420
|
+
use_auto_refresh: bool | None = True,
|
|
421
|
+
relative: bool | None = True,
|
|
421
422
|
shader: str | None = "PRINCIPLED",
|
|
422
|
-
emit_strength:
|
|
423
|
-
use_transparency: bool |
|
|
423
|
+
emit_strength: float | None = 1.0,
|
|
424
|
+
use_transparency: bool | None = True,
|
|
424
425
|
blend_method: str | None = "BLEND",
|
|
425
426
|
shadow_method: str | None = "CLIP",
|
|
426
|
-
use_backface_culling: bool |
|
|
427
|
-
show_transparent_back: bool |
|
|
428
|
-
overwrite_material: bool |
|
|
429
|
-
filepath: str
|
|
427
|
+
use_backface_culling: bool | None = False,
|
|
428
|
+
show_transparent_back: bool | None = True,
|
|
429
|
+
overwrite_material: bool | None = True,
|
|
430
|
+
filepath: str = "",
|
|
430
431
|
align: str | None = "WORLD",
|
|
431
|
-
location:
|
|
432
|
-
|
|
432
|
+
location: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
433
|
+
0.0,
|
|
434
|
+
0.0,
|
|
435
|
+
0.0,
|
|
436
|
+
),
|
|
437
|
+
rotation: collections.abc.Sequence[float] | mathutils.Euler | None = (
|
|
438
|
+
0.0,
|
|
439
|
+
0.0,
|
|
440
|
+
0.0,
|
|
441
|
+
),
|
|
433
442
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
434
443
|
| None = None,
|
|
435
|
-
directory: str
|
|
436
|
-
filter_image: bool |
|
|
437
|
-
filter_movie: bool |
|
|
438
|
-
filter_folder: bool |
|
|
439
|
-
force_reload: bool |
|
|
440
|
-
image_sequence: bool |
|
|
441
|
-
offset: bool |
|
|
444
|
+
directory: str = "",
|
|
445
|
+
filter_image: bool | None = True,
|
|
446
|
+
filter_movie: bool | None = True,
|
|
447
|
+
filter_folder: bool | None = True,
|
|
448
|
+
force_reload: bool | None = False,
|
|
449
|
+
image_sequence: bool | None = False,
|
|
450
|
+
offset: bool | None = True,
|
|
442
451
|
offset_axis: str | None = "+X",
|
|
443
|
-
offset_amount:
|
|
452
|
+
offset_amount: float | None = 0.1,
|
|
444
453
|
align_axis: str | None = "CAM_AX",
|
|
445
454
|
prev_align_axis: str | None = "NONE",
|
|
446
|
-
align_track: bool |
|
|
455
|
+
align_track: bool | None = False,
|
|
447
456
|
size_mode: str | None = "ABSOLUTE",
|
|
448
457
|
fill_mode: str | None = "FILL",
|
|
449
|
-
height:
|
|
450
|
-
factor:
|
|
458
|
+
height: float | None = 1.0,
|
|
459
|
+
factor: float | None = 600.0,
|
|
451
460
|
):
|
|
452
461
|
"""Create mesh plane(s) from image files with the appropriate aspect ratio
|
|
453
462
|
|
|
@@ -494,9 +503,9 @@ def import_as_mesh_planes(
|
|
|
494
503
|
None -- Ignore alpha channel from the file and make image fully opaque.
|
|
495
504
|
:type alpha_mode: str | None
|
|
496
505
|
:param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
|
|
497
|
-
:type use_auto_refresh: bool |
|
|
506
|
+
:type use_auto_refresh: bool | None
|
|
498
507
|
:param relative: Relative Paths, Use relative file paths
|
|
499
|
-
:type relative: bool |
|
|
508
|
+
:type relative: bool | None
|
|
500
509
|
:param shader: Shader, Node shader to use
|
|
501
510
|
|
|
502
511
|
PRINCIPLED
|
|
@@ -509,9 +518,9 @@ def import_as_mesh_planes(
|
|
|
509
518
|
Emission -- Emission shader.
|
|
510
519
|
:type shader: str | None
|
|
511
520
|
:param emit_strength: Emission Strength, Strength of emission
|
|
512
|
-
:type emit_strength:
|
|
521
|
+
:type emit_strength: float | None
|
|
513
522
|
:param use_transparency: Use Alpha, Use alpha channel for transparency
|
|
514
|
-
:type use_transparency: bool |
|
|
523
|
+
:type use_transparency: bool | None
|
|
515
524
|
:param blend_method: Blend Mode, Blend Mode for Transparent Faces
|
|
516
525
|
|
|
517
526
|
BLEND
|
|
@@ -541,13 +550,13 @@ def import_as_mesh_planes(
|
|
|
541
550
|
None -- Material will cast no shadow.
|
|
542
551
|
:type shadow_method: str | None
|
|
543
552
|
:param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
|
|
544
|
-
:type use_backface_culling: bool |
|
|
553
|
+
:type use_backface_culling: bool | None
|
|
545
554
|
:param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
|
|
546
|
-
:type show_transparent_back: bool |
|
|
555
|
+
:type show_transparent_back: bool | None
|
|
547
556
|
:param overwrite_material: Overwrite Material, Overwrite existing material with the same name
|
|
548
|
-
:type overwrite_material: bool |
|
|
557
|
+
:type overwrite_material: bool | None
|
|
549
558
|
:param filepath: File Path, Filepath used for importing the file
|
|
550
|
-
:type filepath: str
|
|
559
|
+
:type filepath: str
|
|
551
560
|
:param align: Align
|
|
552
561
|
|
|
553
562
|
WORLD
|
|
@@ -560,25 +569,25 @@ def import_as_mesh_planes(
|
|
|
560
569
|
3D Cursor -- Use the 3D cursor orientation for the new object.
|
|
561
570
|
:type align: str | None
|
|
562
571
|
:param location: Location
|
|
563
|
-
:type location:
|
|
572
|
+
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
564
573
|
:param rotation: Rotation
|
|
565
|
-
:type rotation:
|
|
574
|
+
:type rotation: collections.abc.Sequence[float] | mathutils.Euler | None
|
|
566
575
|
:param files: files
|
|
567
576
|
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
568
577
|
:param directory: directory
|
|
569
|
-
:type directory: str
|
|
578
|
+
:type directory: str
|
|
570
579
|
:param filter_image: filter_image
|
|
571
|
-
:type filter_image: bool |
|
|
580
|
+
:type filter_image: bool | None
|
|
572
581
|
:param filter_movie: filter_movie
|
|
573
|
-
:type filter_movie: bool |
|
|
582
|
+
:type filter_movie: bool | None
|
|
574
583
|
:param filter_folder: filter_folder
|
|
575
|
-
:type filter_folder: bool |
|
|
584
|
+
:type filter_folder: bool | None
|
|
576
585
|
:param force_reload: Force Reload, Force reload the image if it is already opened elsewhere in Blender
|
|
577
|
-
:type force_reload: bool |
|
|
586
|
+
:type force_reload: bool | None
|
|
578
587
|
:param image_sequence: Detect Image Sequences, Import sequentially numbered images as an animated image sequence instead of separate planes
|
|
579
|
-
:type image_sequence: bool |
|
|
588
|
+
:type image_sequence: bool | None
|
|
580
589
|
:param offset: Offset Planes, Offset planes from each other. If disabled, multiple planes will be created at the same location
|
|
581
|
-
:type offset: bool |
|
|
590
|
+
:type offset: bool | None
|
|
582
591
|
:param offset_axis: Offset Direction, How planes are oriented relative to each others' local axis
|
|
583
592
|
|
|
584
593
|
+X
|
|
@@ -600,7 +609,7 @@ def import_as_mesh_planes(
|
|
|
600
609
|
-Z -- Stacked Below.
|
|
601
610
|
:type offset_axis: str | None
|
|
602
611
|
:param offset_amount: Offset Distance, Set distance between each plane
|
|
603
|
-
:type offset_amount:
|
|
612
|
+
:type offset_amount: float | None
|
|
604
613
|
:param align_axis: Align, How to align the planes
|
|
605
614
|
|
|
606
615
|
+X
|
|
@@ -657,7 +666,7 @@ def import_as_mesh_planes(
|
|
|
657
666
|
Undocumented.
|
|
658
667
|
:type prev_align_axis: str | None
|
|
659
668
|
:param align_track: Track Camera, Add a constraint to make the planes track the camera
|
|
660
|
-
:type align_track: bool |
|
|
669
|
+
:type align_track: bool | None
|
|
661
670
|
:param size_mode: Size Mode, Method for computing the plane size
|
|
662
671
|
|
|
663
672
|
ABSOLUTE
|
|
@@ -681,9 +690,9 @@ def import_as_mesh_planes(
|
|
|
681
690
|
Fit -- Fit entire image within the camera frame.
|
|
682
691
|
:type fill_mode: str | None
|
|
683
692
|
:param height: Height, Height of the created plane
|
|
684
|
-
:type height:
|
|
693
|
+
:type height: float | None
|
|
685
694
|
:param factor: Definition, Number of pixels per inch or Blender Unit
|
|
686
|
-
:type factor:
|
|
695
|
+
:type factor: float | None
|
|
687
696
|
"""
|
|
688
697
|
|
|
689
698
|
...
|
|
@@ -693,10 +702,10 @@ def invert(
|
|
|
693
702
|
execution_context: int | str | None = None,
|
|
694
703
|
undo: bool | None = None,
|
|
695
704
|
*,
|
|
696
|
-
invert_r: bool |
|
|
697
|
-
invert_g: bool |
|
|
698
|
-
invert_b: bool |
|
|
699
|
-
invert_a: bool |
|
|
705
|
+
invert_r: bool | None = False,
|
|
706
|
+
invert_g: bool | None = False,
|
|
707
|
+
invert_b: bool | None = False,
|
|
708
|
+
invert_a: bool | None = False,
|
|
700
709
|
):
|
|
701
710
|
"""Invert image's channels
|
|
702
711
|
|
|
@@ -704,13 +713,13 @@ def invert(
|
|
|
704
713
|
:type execution_context: int | str | None
|
|
705
714
|
:type undo: bool | None
|
|
706
715
|
:param invert_r: Red, Invert red channel
|
|
707
|
-
:type invert_r: bool |
|
|
716
|
+
:type invert_r: bool | None
|
|
708
717
|
:param invert_g: Green, Invert green channel
|
|
709
|
-
:type invert_g: bool |
|
|
718
|
+
:type invert_g: bool | None
|
|
710
719
|
:param invert_b: Blue, Invert blue channel
|
|
711
|
-
:type invert_b: bool |
|
|
720
|
+
:type invert_b: bool | None
|
|
712
721
|
:param invert_a: Alpha, Invert alpha channel
|
|
713
|
-
:type invert_a: bool |
|
|
722
|
+
:type invert_a: bool | None
|
|
714
723
|
"""
|
|
715
724
|
|
|
716
725
|
...
|
|
@@ -734,15 +743,15 @@ def new(
|
|
|
734
743
|
execution_context: int | str | None = None,
|
|
735
744
|
undo: bool | None = None,
|
|
736
745
|
*,
|
|
737
|
-
name: str
|
|
738
|
-
width:
|
|
739
|
-
height:
|
|
740
|
-
color:
|
|
741
|
-
alpha: bool |
|
|
746
|
+
name: str = "Untitled",
|
|
747
|
+
width: int | None = 1024,
|
|
748
|
+
height: int | None = 1024,
|
|
749
|
+
color: collections.abc.Iterable[float] | None = (0.0, 0.0, 0.0, 1.0),
|
|
750
|
+
alpha: bool | None = True,
|
|
742
751
|
generated_type: str | None = "BLANK",
|
|
743
|
-
float: bool |
|
|
744
|
-
use_stereo_3d: bool |
|
|
745
|
-
tiled: bool |
|
|
752
|
+
float: bool | None = False,
|
|
753
|
+
use_stereo_3d: bool | None = False,
|
|
754
|
+
tiled: bool | None = False,
|
|
746
755
|
):
|
|
747
756
|
"""Create a new image
|
|
748
757
|
|
|
@@ -750,23 +759,23 @@ def new(
|
|
|
750
759
|
:type execution_context: int | str | None
|
|
751
760
|
:type undo: bool | None
|
|
752
761
|
:param name: Name, Image data-block name
|
|
753
|
-
:type name: str
|
|
762
|
+
:type name: str
|
|
754
763
|
:param width: Width, Image width
|
|
755
|
-
:type width:
|
|
764
|
+
:type width: int | None
|
|
756
765
|
:param height: Height, Image height
|
|
757
|
-
:type height:
|
|
766
|
+
:type height: int | None
|
|
758
767
|
:param color: Color, Default fill color
|
|
759
|
-
:type color:
|
|
768
|
+
:type color: collections.abc.Iterable[float] | None
|
|
760
769
|
:param alpha: Alpha, Create an image with an alpha channel
|
|
761
|
-
:type alpha: bool |
|
|
770
|
+
:type alpha: bool | None
|
|
762
771
|
:param generated_type: Generated Type, Fill the image with a grid for UV map testing
|
|
763
772
|
:type generated_type: str | None
|
|
764
773
|
:param float: 32-bit Float, Create image with 32-bit floating-point bit depth
|
|
765
|
-
:type float: bool |
|
|
774
|
+
:type float: bool | None
|
|
766
775
|
:param use_stereo_3d: Stereo 3D, Create an image with left and right views
|
|
767
|
-
:type use_stereo_3d: bool |
|
|
776
|
+
:type use_stereo_3d: bool | None
|
|
768
777
|
:param tiled: Tiled, Create a tiled image
|
|
769
|
-
:type tiled: bool |
|
|
778
|
+
:type tiled: bool | None
|
|
770
779
|
"""
|
|
771
780
|
|
|
772
781
|
...
|
|
@@ -776,38 +785,38 @@ def open(
|
|
|
776
785
|
execution_context: int | str | None = None,
|
|
777
786
|
undo: bool | None = None,
|
|
778
787
|
*,
|
|
779
|
-
allow_path_tokens: bool |
|
|
780
|
-
filepath: str
|
|
781
|
-
directory: str
|
|
788
|
+
allow_path_tokens: bool | None = True,
|
|
789
|
+
filepath: str = "",
|
|
790
|
+
directory: str = "",
|
|
782
791
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
783
792
|
| None = None,
|
|
784
|
-
hide_props_region: bool |
|
|
785
|
-
check_existing: bool |
|
|
786
|
-
filter_blender: bool |
|
|
787
|
-
filter_backup: bool |
|
|
788
|
-
filter_image: bool |
|
|
789
|
-
filter_movie: bool |
|
|
790
|
-
filter_python: bool |
|
|
791
|
-
filter_font: bool |
|
|
792
|
-
filter_sound: bool |
|
|
793
|
-
filter_text: bool |
|
|
794
|
-
filter_archive: bool |
|
|
795
|
-
filter_btx: bool |
|
|
796
|
-
filter_collada: bool |
|
|
797
|
-
filter_alembic: bool |
|
|
798
|
-
filter_usd: bool |
|
|
799
|
-
filter_obj: bool |
|
|
800
|
-
filter_volume: bool |
|
|
801
|
-
filter_folder: bool |
|
|
802
|
-
filter_blenlib: bool |
|
|
803
|
-
filemode:
|
|
804
|
-
relative_path: bool |
|
|
805
|
-
show_multiview: bool |
|
|
806
|
-
use_multiview: bool |
|
|
793
|
+
hide_props_region: bool | None = True,
|
|
794
|
+
check_existing: bool | None = False,
|
|
795
|
+
filter_blender: bool | None = False,
|
|
796
|
+
filter_backup: bool | None = False,
|
|
797
|
+
filter_image: bool | None = True,
|
|
798
|
+
filter_movie: bool | None = True,
|
|
799
|
+
filter_python: bool | None = False,
|
|
800
|
+
filter_font: bool | None = False,
|
|
801
|
+
filter_sound: bool | None = False,
|
|
802
|
+
filter_text: bool | None = False,
|
|
803
|
+
filter_archive: bool | None = False,
|
|
804
|
+
filter_btx: bool | None = False,
|
|
805
|
+
filter_collada: bool | None = False,
|
|
806
|
+
filter_alembic: bool | None = False,
|
|
807
|
+
filter_usd: bool | None = False,
|
|
808
|
+
filter_obj: bool | None = False,
|
|
809
|
+
filter_volume: bool | None = False,
|
|
810
|
+
filter_folder: bool | None = True,
|
|
811
|
+
filter_blenlib: bool | None = False,
|
|
812
|
+
filemode: int | None = 9,
|
|
813
|
+
relative_path: bool | None = True,
|
|
814
|
+
show_multiview: bool | None = False,
|
|
815
|
+
use_multiview: bool | None = False,
|
|
807
816
|
display_type: str | None = "DEFAULT",
|
|
808
817
|
sort_method: str | None = "",
|
|
809
|
-
use_sequence_detection: bool |
|
|
810
|
-
use_udim_detecting: bool |
|
|
818
|
+
use_sequence_detection: bool | None = True,
|
|
819
|
+
use_udim_detecting: bool | None = True,
|
|
811
820
|
):
|
|
812
821
|
"""Open image
|
|
813
822
|
|
|
@@ -815,59 +824,59 @@ def open(
|
|
|
815
824
|
:type execution_context: int | str | None
|
|
816
825
|
:type undo: bool | None
|
|
817
826
|
:param allow_path_tokens: Allow the path to contain substitution tokens
|
|
818
|
-
:type allow_path_tokens: bool |
|
|
827
|
+
:type allow_path_tokens: bool | None
|
|
819
828
|
:param filepath: File Path, Path to file
|
|
820
|
-
:type filepath: str
|
|
829
|
+
:type filepath: str
|
|
821
830
|
:param directory: Directory, Directory of the file
|
|
822
|
-
:type directory: str
|
|
831
|
+
:type directory: str
|
|
823
832
|
:param files: Files
|
|
824
833
|
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
825
834
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
826
|
-
:type hide_props_region: bool |
|
|
835
|
+
:type hide_props_region: bool | None
|
|
827
836
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
828
|
-
:type check_existing: bool |
|
|
837
|
+
:type check_existing: bool | None
|
|
829
838
|
:param filter_blender: Filter .blend files
|
|
830
|
-
:type filter_blender: bool |
|
|
839
|
+
:type filter_blender: bool | None
|
|
831
840
|
:param filter_backup: Filter .blend files
|
|
832
|
-
:type filter_backup: bool |
|
|
841
|
+
:type filter_backup: bool | None
|
|
833
842
|
:param filter_image: Filter image files
|
|
834
|
-
:type filter_image: bool |
|
|
843
|
+
:type filter_image: bool | None
|
|
835
844
|
:param filter_movie: Filter movie files
|
|
836
|
-
:type filter_movie: bool |
|
|
845
|
+
:type filter_movie: bool | None
|
|
837
846
|
:param filter_python: Filter Python files
|
|
838
|
-
:type filter_python: bool |
|
|
847
|
+
:type filter_python: bool | None
|
|
839
848
|
:param filter_font: Filter font files
|
|
840
|
-
:type filter_font: bool |
|
|
849
|
+
:type filter_font: bool | None
|
|
841
850
|
:param filter_sound: Filter sound files
|
|
842
|
-
:type filter_sound: bool |
|
|
851
|
+
:type filter_sound: bool | None
|
|
843
852
|
:param filter_text: Filter text files
|
|
844
|
-
:type filter_text: bool |
|
|
853
|
+
:type filter_text: bool | None
|
|
845
854
|
:param filter_archive: Filter archive files
|
|
846
|
-
:type filter_archive: bool |
|
|
855
|
+
:type filter_archive: bool | None
|
|
847
856
|
:param filter_btx: Filter btx files
|
|
848
|
-
:type filter_btx: bool |
|
|
857
|
+
:type filter_btx: bool | None
|
|
849
858
|
:param filter_collada: Filter COLLADA files
|
|
850
|
-
:type filter_collada: bool |
|
|
859
|
+
:type filter_collada: bool | None
|
|
851
860
|
:param filter_alembic: Filter Alembic files
|
|
852
|
-
:type filter_alembic: bool |
|
|
861
|
+
:type filter_alembic: bool | None
|
|
853
862
|
:param filter_usd: Filter USD files
|
|
854
|
-
:type filter_usd: bool |
|
|
863
|
+
:type filter_usd: bool | None
|
|
855
864
|
:param filter_obj: Filter OBJ files
|
|
856
|
-
:type filter_obj: bool |
|
|
865
|
+
:type filter_obj: bool | None
|
|
857
866
|
:param filter_volume: Filter OpenVDB volume files
|
|
858
|
-
:type filter_volume: bool |
|
|
867
|
+
:type filter_volume: bool | None
|
|
859
868
|
:param filter_folder: Filter folders
|
|
860
|
-
:type filter_folder: bool |
|
|
869
|
+
:type filter_folder: bool | None
|
|
861
870
|
:param filter_blenlib: Filter Blender IDs
|
|
862
|
-
:type filter_blenlib: bool |
|
|
871
|
+
:type filter_blenlib: bool | None
|
|
863
872
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
864
|
-
:type filemode:
|
|
873
|
+
:type filemode: int | None
|
|
865
874
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
866
|
-
:type relative_path: bool |
|
|
875
|
+
:type relative_path: bool | None
|
|
867
876
|
:param show_multiview: Enable Multi-View
|
|
868
|
-
:type show_multiview: bool |
|
|
877
|
+
:type show_multiview: bool | None
|
|
869
878
|
:param use_multiview: Use Multi-View
|
|
870
|
-
:type use_multiview: bool |
|
|
879
|
+
:type use_multiview: bool | None
|
|
871
880
|
:param display_type: Display Type
|
|
872
881
|
|
|
873
882
|
DEFAULT
|
|
@@ -885,9 +894,9 @@ def open(
|
|
|
885
894
|
:param sort_method: File sorting mode
|
|
886
895
|
:type sort_method: str | None
|
|
887
896
|
:param use_sequence_detection: Detect Sequences, Automatically detect animated sequences in selected images (based on file names)
|
|
888
|
-
:type use_sequence_detection: bool |
|
|
897
|
+
:type use_sequence_detection: bool | None
|
|
889
898
|
:param use_udim_detecting: Detect UDIMs, Detect selected UDIM files and load all matching tiles
|
|
890
|
-
:type use_udim_detecting: bool |
|
|
899
|
+
:type use_udim_detecting: bool | None
|
|
891
900
|
"""
|
|
892
901
|
|
|
893
902
|
...
|
|
@@ -897,12 +906,12 @@ def open_images(
|
|
|
897
906
|
execution_context: int | str | None = None,
|
|
898
907
|
undo: bool | None = None,
|
|
899
908
|
*,
|
|
900
|
-
directory: str
|
|
909
|
+
directory: str = "",
|
|
901
910
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
902
911
|
| None = None,
|
|
903
|
-
relative_path: bool |
|
|
904
|
-
use_sequence_detection: bool |
|
|
905
|
-
use_udim_detection: bool |
|
|
912
|
+
relative_path: bool | None = True,
|
|
913
|
+
use_sequence_detection: bool | None = True,
|
|
914
|
+
use_udim_detection: bool | None = True,
|
|
906
915
|
):
|
|
907
916
|
"""Undocumented, consider contributing.
|
|
908
917
|
|
|
@@ -910,15 +919,15 @@ def open_images(
|
|
|
910
919
|
:type execution_context: int | str | None
|
|
911
920
|
:type undo: bool | None
|
|
912
921
|
:param directory: directory
|
|
913
|
-
:type directory: str
|
|
922
|
+
:type directory: str
|
|
914
923
|
:param files: files
|
|
915
924
|
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
916
925
|
:param relative_path: Use relative path
|
|
917
|
-
:type relative_path: bool |
|
|
926
|
+
:type relative_path: bool | None
|
|
918
927
|
:param use_sequence_detection: Use sequence detection
|
|
919
|
-
:type use_sequence_detection: bool |
|
|
928
|
+
:type use_sequence_detection: bool | None
|
|
920
929
|
:param use_udim_detection: Use UDIM detection
|
|
921
|
-
:type use_udim_detection: bool |
|
|
930
|
+
:type use_udim_detection: bool | None
|
|
922
931
|
"""
|
|
923
932
|
|
|
924
933
|
...
|
|
@@ -1012,11 +1021,11 @@ def render_border(
|
|
|
1012
1021
|
execution_context: int | str | None = None,
|
|
1013
1022
|
undo: bool | None = None,
|
|
1014
1023
|
*,
|
|
1015
|
-
xmin:
|
|
1016
|
-
xmax:
|
|
1017
|
-
ymin:
|
|
1018
|
-
ymax:
|
|
1019
|
-
wait_for_input: bool |
|
|
1024
|
+
xmin: int | None = 0,
|
|
1025
|
+
xmax: int | None = 0,
|
|
1026
|
+
ymin: int | None = 0,
|
|
1027
|
+
ymax: int | None = 0,
|
|
1028
|
+
wait_for_input: bool | None = True,
|
|
1020
1029
|
):
|
|
1021
1030
|
"""Set the boundaries of the render region and enable render region
|
|
1022
1031
|
|
|
@@ -1024,15 +1033,15 @@ def render_border(
|
|
|
1024
1033
|
:type execution_context: int | str | None
|
|
1025
1034
|
:type undo: bool | None
|
|
1026
1035
|
:param xmin: X Min
|
|
1027
|
-
:type xmin:
|
|
1036
|
+
:type xmin: int | None
|
|
1028
1037
|
:param xmax: X Max
|
|
1029
|
-
:type xmax:
|
|
1038
|
+
:type xmax: int | None
|
|
1030
1039
|
:param ymin: Y Min
|
|
1031
|
-
:type ymin:
|
|
1040
|
+
:type ymin: int | None
|
|
1032
1041
|
:param ymax: Y Max
|
|
1033
|
-
:type ymax:
|
|
1042
|
+
:type ymax: int | None
|
|
1034
1043
|
:param wait_for_input: Wait for Input
|
|
1035
|
-
:type wait_for_input: bool |
|
|
1044
|
+
:type wait_for_input: bool | None
|
|
1036
1045
|
"""
|
|
1037
1046
|
|
|
1038
1047
|
...
|
|
@@ -1042,30 +1051,30 @@ def replace(
|
|
|
1042
1051
|
execution_context: int | str | None = None,
|
|
1043
1052
|
undo: bool | None = None,
|
|
1044
1053
|
*,
|
|
1045
|
-
filepath: str
|
|
1046
|
-
hide_props_region: bool |
|
|
1047
|
-
check_existing: bool |
|
|
1048
|
-
filter_blender: bool |
|
|
1049
|
-
filter_backup: bool |
|
|
1050
|
-
filter_image: bool |
|
|
1051
|
-
filter_movie: bool |
|
|
1052
|
-
filter_python: bool |
|
|
1053
|
-
filter_font: bool |
|
|
1054
|
-
filter_sound: bool |
|
|
1055
|
-
filter_text: bool |
|
|
1056
|
-
filter_archive: bool |
|
|
1057
|
-
filter_btx: bool |
|
|
1058
|
-
filter_collada: bool |
|
|
1059
|
-
filter_alembic: bool |
|
|
1060
|
-
filter_usd: bool |
|
|
1061
|
-
filter_obj: bool |
|
|
1062
|
-
filter_volume: bool |
|
|
1063
|
-
filter_folder: bool |
|
|
1064
|
-
filter_blenlib: bool |
|
|
1065
|
-
filemode:
|
|
1066
|
-
relative_path: bool |
|
|
1067
|
-
show_multiview: bool |
|
|
1068
|
-
use_multiview: bool |
|
|
1054
|
+
filepath: str = "",
|
|
1055
|
+
hide_props_region: bool | None = True,
|
|
1056
|
+
check_existing: bool | None = False,
|
|
1057
|
+
filter_blender: bool | None = False,
|
|
1058
|
+
filter_backup: bool | None = False,
|
|
1059
|
+
filter_image: bool | None = True,
|
|
1060
|
+
filter_movie: bool | None = True,
|
|
1061
|
+
filter_python: bool | None = False,
|
|
1062
|
+
filter_font: bool | None = False,
|
|
1063
|
+
filter_sound: bool | None = False,
|
|
1064
|
+
filter_text: bool | None = False,
|
|
1065
|
+
filter_archive: bool | None = False,
|
|
1066
|
+
filter_btx: bool | None = False,
|
|
1067
|
+
filter_collada: bool | None = False,
|
|
1068
|
+
filter_alembic: bool | None = False,
|
|
1069
|
+
filter_usd: bool | None = False,
|
|
1070
|
+
filter_obj: bool | None = False,
|
|
1071
|
+
filter_volume: bool | None = False,
|
|
1072
|
+
filter_folder: bool | None = True,
|
|
1073
|
+
filter_blenlib: bool | None = False,
|
|
1074
|
+
filemode: int | None = 9,
|
|
1075
|
+
relative_path: bool | None = True,
|
|
1076
|
+
show_multiview: bool | None = False,
|
|
1077
|
+
use_multiview: bool | None = False,
|
|
1069
1078
|
display_type: str | None = "DEFAULT",
|
|
1070
1079
|
sort_method: str | None = "",
|
|
1071
1080
|
):
|
|
@@ -1075,53 +1084,53 @@ def replace(
|
|
|
1075
1084
|
:type execution_context: int | str | None
|
|
1076
1085
|
:type undo: bool | None
|
|
1077
1086
|
:param filepath: File Path, Path to file
|
|
1078
|
-
:type filepath: str
|
|
1087
|
+
:type filepath: str
|
|
1079
1088
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1080
|
-
:type hide_props_region: bool |
|
|
1089
|
+
:type hide_props_region: bool | None
|
|
1081
1090
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1082
|
-
:type check_existing: bool |
|
|
1091
|
+
:type check_existing: bool | None
|
|
1083
1092
|
:param filter_blender: Filter .blend files
|
|
1084
|
-
:type filter_blender: bool |
|
|
1093
|
+
:type filter_blender: bool | None
|
|
1085
1094
|
:param filter_backup: Filter .blend files
|
|
1086
|
-
:type filter_backup: bool |
|
|
1095
|
+
:type filter_backup: bool | None
|
|
1087
1096
|
:param filter_image: Filter image files
|
|
1088
|
-
:type filter_image: bool |
|
|
1097
|
+
:type filter_image: bool | None
|
|
1089
1098
|
:param filter_movie: Filter movie files
|
|
1090
|
-
:type filter_movie: bool |
|
|
1099
|
+
:type filter_movie: bool | None
|
|
1091
1100
|
:param filter_python: Filter Python files
|
|
1092
|
-
:type filter_python: bool |
|
|
1101
|
+
:type filter_python: bool | None
|
|
1093
1102
|
:param filter_font: Filter font files
|
|
1094
|
-
:type filter_font: bool |
|
|
1103
|
+
:type filter_font: bool | None
|
|
1095
1104
|
:param filter_sound: Filter sound files
|
|
1096
|
-
:type filter_sound: bool |
|
|
1105
|
+
:type filter_sound: bool | None
|
|
1097
1106
|
:param filter_text: Filter text files
|
|
1098
|
-
:type filter_text: bool |
|
|
1107
|
+
:type filter_text: bool | None
|
|
1099
1108
|
:param filter_archive: Filter archive files
|
|
1100
|
-
:type filter_archive: bool |
|
|
1109
|
+
:type filter_archive: bool | None
|
|
1101
1110
|
:param filter_btx: Filter btx files
|
|
1102
|
-
:type filter_btx: bool |
|
|
1111
|
+
:type filter_btx: bool | None
|
|
1103
1112
|
:param filter_collada: Filter COLLADA files
|
|
1104
|
-
:type filter_collada: bool |
|
|
1113
|
+
:type filter_collada: bool | None
|
|
1105
1114
|
:param filter_alembic: Filter Alembic files
|
|
1106
|
-
:type filter_alembic: bool |
|
|
1115
|
+
:type filter_alembic: bool | None
|
|
1107
1116
|
:param filter_usd: Filter USD files
|
|
1108
|
-
:type filter_usd: bool |
|
|
1117
|
+
:type filter_usd: bool | None
|
|
1109
1118
|
:param filter_obj: Filter OBJ files
|
|
1110
|
-
:type filter_obj: bool |
|
|
1119
|
+
:type filter_obj: bool | None
|
|
1111
1120
|
:param filter_volume: Filter OpenVDB volume files
|
|
1112
|
-
:type filter_volume: bool |
|
|
1121
|
+
:type filter_volume: bool | None
|
|
1113
1122
|
:param filter_folder: Filter folders
|
|
1114
|
-
:type filter_folder: bool |
|
|
1123
|
+
:type filter_folder: bool | None
|
|
1115
1124
|
:param filter_blenlib: Filter Blender IDs
|
|
1116
|
-
:type filter_blenlib: bool |
|
|
1125
|
+
:type filter_blenlib: bool | None
|
|
1117
1126
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1118
|
-
:type filemode:
|
|
1127
|
+
:type filemode: int | None
|
|
1119
1128
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1120
|
-
:type relative_path: bool |
|
|
1129
|
+
:type relative_path: bool | None
|
|
1121
1130
|
:param show_multiview: Enable Multi-View
|
|
1122
|
-
:type show_multiview: bool |
|
|
1131
|
+
:type show_multiview: bool | None
|
|
1123
1132
|
:param use_multiview: Use Multi-View
|
|
1124
|
-
:type use_multiview: bool |
|
|
1133
|
+
:type use_multiview: bool | None
|
|
1125
1134
|
:param display_type: Display Type
|
|
1126
1135
|
|
|
1127
1136
|
DEFAULT
|
|
@@ -1147,7 +1156,7 @@ def resize(
|
|
|
1147
1156
|
execution_context: int | str | None = None,
|
|
1148
1157
|
undo: bool | None = None,
|
|
1149
1158
|
*,
|
|
1150
|
-
size:
|
|
1159
|
+
size: collections.abc.Iterable[int] | None = (0, 0),
|
|
1151
1160
|
):
|
|
1152
1161
|
"""Resize the image
|
|
1153
1162
|
|
|
@@ -1155,7 +1164,7 @@ def resize(
|
|
|
1155
1164
|
:type execution_context: int | str | None
|
|
1156
1165
|
:type undo: bool | None
|
|
1157
1166
|
:param size: Size
|
|
1158
|
-
:type size:
|
|
1167
|
+
:type size: collections.abc.Iterable[int] | None
|
|
1159
1168
|
"""
|
|
1160
1169
|
|
|
1161
1170
|
...
|
|
@@ -1192,7 +1201,7 @@ def sample(
|
|
|
1192
1201
|
execution_context: int | str | None = None,
|
|
1193
1202
|
undo: bool | None = None,
|
|
1194
1203
|
*,
|
|
1195
|
-
size:
|
|
1204
|
+
size: int | None = 1,
|
|
1196
1205
|
):
|
|
1197
1206
|
"""Use mouse to sample a color in current image
|
|
1198
1207
|
|
|
@@ -1200,7 +1209,7 @@ def sample(
|
|
|
1200
1209
|
:type execution_context: int | str | None
|
|
1201
1210
|
:type undo: bool | None
|
|
1202
1211
|
:param size: Sample Size
|
|
1203
|
-
:type size:
|
|
1212
|
+
:type size: int | None
|
|
1204
1213
|
"""
|
|
1205
1214
|
|
|
1206
1215
|
...
|
|
@@ -1210,12 +1219,12 @@ def sample_line(
|
|
|
1210
1219
|
execution_context: int | str | None = None,
|
|
1211
1220
|
undo: bool | None = None,
|
|
1212
1221
|
*,
|
|
1213
|
-
xstart:
|
|
1214
|
-
xend:
|
|
1215
|
-
ystart:
|
|
1216
|
-
yend:
|
|
1217
|
-
flip: bool |
|
|
1218
|
-
cursor:
|
|
1222
|
+
xstart: int | None = 0,
|
|
1223
|
+
xend: int | None = 0,
|
|
1224
|
+
ystart: int | None = 0,
|
|
1225
|
+
yend: int | None = 0,
|
|
1226
|
+
flip: bool | None = False,
|
|
1227
|
+
cursor: int | None = 5,
|
|
1219
1228
|
):
|
|
1220
1229
|
"""Sample a line and show it in Scope panels
|
|
1221
1230
|
|
|
@@ -1223,17 +1232,17 @@ def sample_line(
|
|
|
1223
1232
|
:type execution_context: int | str | None
|
|
1224
1233
|
:type undo: bool | None
|
|
1225
1234
|
:param xstart: X Start
|
|
1226
|
-
:type xstart:
|
|
1235
|
+
:type xstart: int | None
|
|
1227
1236
|
:param xend: X End
|
|
1228
|
-
:type xend:
|
|
1237
|
+
:type xend: int | None
|
|
1229
1238
|
:param ystart: Y Start
|
|
1230
|
-
:type ystart:
|
|
1239
|
+
:type ystart: int | None
|
|
1231
1240
|
:param yend: Y End
|
|
1232
|
-
:type yend:
|
|
1241
|
+
:type yend: int | None
|
|
1233
1242
|
:param flip: Flip
|
|
1234
|
-
:type flip: bool |
|
|
1243
|
+
:type flip: bool | None
|
|
1235
1244
|
:param cursor: Cursor, Mouse cursor style to use during the modal operator
|
|
1236
|
-
:type cursor:
|
|
1245
|
+
:type cursor: int | None
|
|
1237
1246
|
"""
|
|
1238
1247
|
|
|
1239
1248
|
...
|
|
@@ -1271,32 +1280,32 @@ def save_as(
|
|
|
1271
1280
|
execution_context: int | str | None = None,
|
|
1272
1281
|
undo: bool | None = None,
|
|
1273
1282
|
*,
|
|
1274
|
-
save_as_render: bool |
|
|
1275
|
-
copy: bool |
|
|
1276
|
-
allow_path_tokens: bool |
|
|
1277
|
-
filepath: str
|
|
1278
|
-
check_existing: bool |
|
|
1279
|
-
filter_blender: bool |
|
|
1280
|
-
filter_backup: bool |
|
|
1281
|
-
filter_image: bool |
|
|
1282
|
-
filter_movie: bool |
|
|
1283
|
-
filter_python: bool |
|
|
1284
|
-
filter_font: bool |
|
|
1285
|
-
filter_sound: bool |
|
|
1286
|
-
filter_text: bool |
|
|
1287
|
-
filter_archive: bool |
|
|
1288
|
-
filter_btx: bool |
|
|
1289
|
-
filter_collada: bool |
|
|
1290
|
-
filter_alembic: bool |
|
|
1291
|
-
filter_usd: bool |
|
|
1292
|
-
filter_obj: bool |
|
|
1293
|
-
filter_volume: bool |
|
|
1294
|
-
filter_folder: bool |
|
|
1295
|
-
filter_blenlib: bool |
|
|
1296
|
-
filemode:
|
|
1297
|
-
relative_path: bool |
|
|
1298
|
-
show_multiview: bool |
|
|
1299
|
-
use_multiview: bool |
|
|
1283
|
+
save_as_render: bool | None = False,
|
|
1284
|
+
copy: bool | None = False,
|
|
1285
|
+
allow_path_tokens: bool | None = True,
|
|
1286
|
+
filepath: str = "",
|
|
1287
|
+
check_existing: bool | None = True,
|
|
1288
|
+
filter_blender: bool | None = False,
|
|
1289
|
+
filter_backup: bool | None = False,
|
|
1290
|
+
filter_image: bool | None = True,
|
|
1291
|
+
filter_movie: bool | None = True,
|
|
1292
|
+
filter_python: bool | None = False,
|
|
1293
|
+
filter_font: bool | None = False,
|
|
1294
|
+
filter_sound: bool | None = False,
|
|
1295
|
+
filter_text: bool | None = False,
|
|
1296
|
+
filter_archive: bool | None = False,
|
|
1297
|
+
filter_btx: bool | None = False,
|
|
1298
|
+
filter_collada: bool | None = False,
|
|
1299
|
+
filter_alembic: bool | None = False,
|
|
1300
|
+
filter_usd: bool | None = False,
|
|
1301
|
+
filter_obj: bool | None = False,
|
|
1302
|
+
filter_volume: bool | None = False,
|
|
1303
|
+
filter_folder: bool | None = True,
|
|
1304
|
+
filter_blenlib: bool | None = False,
|
|
1305
|
+
filemode: int | None = 9,
|
|
1306
|
+
relative_path: bool | None = True,
|
|
1307
|
+
show_multiview: bool | None = False,
|
|
1308
|
+
use_multiview: bool | None = False,
|
|
1300
1309
|
display_type: str | None = "DEFAULT",
|
|
1301
1310
|
sort_method: str | None = "",
|
|
1302
1311
|
):
|
|
@@ -1306,57 +1315,57 @@ def save_as(
|
|
|
1306
1315
|
:type execution_context: int | str | None
|
|
1307
1316
|
:type undo: bool | None
|
|
1308
1317
|
:param save_as_render: Save As Render, Save image with render color management.For display image formats like PNG, apply view and display transform.For intermediate image formats like OpenEXR, use the default render output color space
|
|
1309
|
-
:type save_as_render: bool |
|
|
1318
|
+
:type save_as_render: bool | None
|
|
1310
1319
|
:param copy: Copy, Create a new image file without modifying the current image in Blender
|
|
1311
|
-
:type copy: bool |
|
|
1320
|
+
:type copy: bool | None
|
|
1312
1321
|
:param allow_path_tokens: Allow the path to contain substitution tokens
|
|
1313
|
-
:type allow_path_tokens: bool |
|
|
1322
|
+
:type allow_path_tokens: bool | None
|
|
1314
1323
|
:param filepath: File Path, Path to file
|
|
1315
|
-
:type filepath: str
|
|
1324
|
+
:type filepath: str
|
|
1316
1325
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1317
|
-
:type check_existing: bool |
|
|
1326
|
+
:type check_existing: bool | None
|
|
1318
1327
|
:param filter_blender: Filter .blend files
|
|
1319
|
-
:type filter_blender: bool |
|
|
1328
|
+
:type filter_blender: bool | None
|
|
1320
1329
|
:param filter_backup: Filter .blend files
|
|
1321
|
-
:type filter_backup: bool |
|
|
1330
|
+
:type filter_backup: bool | None
|
|
1322
1331
|
:param filter_image: Filter image files
|
|
1323
|
-
:type filter_image: bool |
|
|
1332
|
+
:type filter_image: bool | None
|
|
1324
1333
|
:param filter_movie: Filter movie files
|
|
1325
|
-
:type filter_movie: bool |
|
|
1334
|
+
:type filter_movie: bool | None
|
|
1326
1335
|
:param filter_python: Filter Python files
|
|
1327
|
-
:type filter_python: bool |
|
|
1336
|
+
:type filter_python: bool | None
|
|
1328
1337
|
:param filter_font: Filter font files
|
|
1329
|
-
:type filter_font: bool |
|
|
1338
|
+
:type filter_font: bool | None
|
|
1330
1339
|
:param filter_sound: Filter sound files
|
|
1331
|
-
:type filter_sound: bool |
|
|
1340
|
+
:type filter_sound: bool | None
|
|
1332
1341
|
:param filter_text: Filter text files
|
|
1333
|
-
:type filter_text: bool |
|
|
1342
|
+
:type filter_text: bool | None
|
|
1334
1343
|
:param filter_archive: Filter archive files
|
|
1335
|
-
:type filter_archive: bool |
|
|
1344
|
+
:type filter_archive: bool | None
|
|
1336
1345
|
:param filter_btx: Filter btx files
|
|
1337
|
-
:type filter_btx: bool |
|
|
1346
|
+
:type filter_btx: bool | None
|
|
1338
1347
|
:param filter_collada: Filter COLLADA files
|
|
1339
|
-
:type filter_collada: bool |
|
|
1348
|
+
:type filter_collada: bool | None
|
|
1340
1349
|
:param filter_alembic: Filter Alembic files
|
|
1341
|
-
:type filter_alembic: bool |
|
|
1350
|
+
:type filter_alembic: bool | None
|
|
1342
1351
|
:param filter_usd: Filter USD files
|
|
1343
|
-
:type filter_usd: bool |
|
|
1352
|
+
:type filter_usd: bool | None
|
|
1344
1353
|
:param filter_obj: Filter OBJ files
|
|
1345
|
-
:type filter_obj: bool |
|
|
1354
|
+
:type filter_obj: bool | None
|
|
1346
1355
|
:param filter_volume: Filter OpenVDB volume files
|
|
1347
|
-
:type filter_volume: bool |
|
|
1356
|
+
:type filter_volume: bool | None
|
|
1348
1357
|
:param filter_folder: Filter folders
|
|
1349
|
-
:type filter_folder: bool |
|
|
1358
|
+
:type filter_folder: bool | None
|
|
1350
1359
|
:param filter_blenlib: Filter Blender IDs
|
|
1351
|
-
:type filter_blenlib: bool |
|
|
1360
|
+
:type filter_blenlib: bool | None
|
|
1352
1361
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1353
|
-
:type filemode:
|
|
1362
|
+
:type filemode: int | None
|
|
1354
1363
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1355
|
-
:type relative_path: bool |
|
|
1364
|
+
:type relative_path: bool | None
|
|
1356
1365
|
:param show_multiview: Enable Multi-View
|
|
1357
|
-
:type show_multiview: bool |
|
|
1366
|
+
:type show_multiview: bool | None
|
|
1358
1367
|
:param use_multiview: Use Multi-View
|
|
1359
|
-
:type use_multiview: bool |
|
|
1368
|
+
:type use_multiview: bool | None
|
|
1360
1369
|
:param display_type: Display Type
|
|
1361
1370
|
|
|
1362
1371
|
DEFAULT
|
|
@@ -1396,16 +1405,16 @@ def tile_add(
|
|
|
1396
1405
|
execution_context: int | str | None = None,
|
|
1397
1406
|
undo: bool | None = None,
|
|
1398
1407
|
*,
|
|
1399
|
-
number:
|
|
1400
|
-
count:
|
|
1401
|
-
label: str
|
|
1402
|
-
fill: bool |
|
|
1403
|
-
color:
|
|
1408
|
+
number: int | None = 1002,
|
|
1409
|
+
count: int | None = 1,
|
|
1410
|
+
label: str = "",
|
|
1411
|
+
fill: bool | None = True,
|
|
1412
|
+
color: collections.abc.Iterable[float] | None = (0.0, 0.0, 0.0, 1.0),
|
|
1404
1413
|
generated_type: str | None = "BLANK",
|
|
1405
|
-
width:
|
|
1406
|
-
height:
|
|
1407
|
-
float: bool |
|
|
1408
|
-
alpha: bool |
|
|
1414
|
+
width: int | None = 1024,
|
|
1415
|
+
height: int | None = 1024,
|
|
1416
|
+
float: bool | None = False,
|
|
1417
|
+
alpha: bool | None = True,
|
|
1409
1418
|
):
|
|
1410
1419
|
"""Adds a tile to the image
|
|
1411
1420
|
|
|
@@ -1413,25 +1422,25 @@ def tile_add(
|
|
|
1413
1422
|
:type execution_context: int | str | None
|
|
1414
1423
|
:type undo: bool | None
|
|
1415
1424
|
:param number: Number, UDIM number of the tile
|
|
1416
|
-
:type number:
|
|
1425
|
+
:type number: int | None
|
|
1417
1426
|
:param count: Count, How many tiles to add
|
|
1418
|
-
:type count:
|
|
1427
|
+
:type count: int | None
|
|
1419
1428
|
:param label: Label, Optional tile label
|
|
1420
|
-
:type label: str
|
|
1429
|
+
:type label: str
|
|
1421
1430
|
:param fill: Fill, Fill new tile with a generated image
|
|
1422
|
-
:type fill: bool |
|
|
1431
|
+
:type fill: bool | None
|
|
1423
1432
|
:param color: Color, Default fill color
|
|
1424
|
-
:type color:
|
|
1433
|
+
:type color: collections.abc.Iterable[float] | None
|
|
1425
1434
|
:param generated_type: Generated Type, Fill the image with a grid for UV map testing
|
|
1426
1435
|
:type generated_type: str | None
|
|
1427
1436
|
:param width: Width, Image width
|
|
1428
|
-
:type width:
|
|
1437
|
+
:type width: int | None
|
|
1429
1438
|
:param height: Height, Image height
|
|
1430
|
-
:type height:
|
|
1439
|
+
:type height: int | None
|
|
1431
1440
|
:param float: 32-bit Float, Create image with 32-bit floating-point bit depth
|
|
1432
|
-
:type float: bool |
|
|
1441
|
+
:type float: bool | None
|
|
1433
1442
|
:param alpha: Alpha, Create an image with an alpha channel
|
|
1434
|
-
:type alpha: bool |
|
|
1443
|
+
:type alpha: bool | None
|
|
1435
1444
|
"""
|
|
1436
1445
|
|
|
1437
1446
|
...
|
|
@@ -1441,12 +1450,12 @@ def tile_fill(
|
|
|
1441
1450
|
execution_context: int | str | None = None,
|
|
1442
1451
|
undo: bool | None = None,
|
|
1443
1452
|
*,
|
|
1444
|
-
color:
|
|
1453
|
+
color: collections.abc.Iterable[float] | None = (0.0, 0.0, 0.0, 1.0),
|
|
1445
1454
|
generated_type: str | None = "BLANK",
|
|
1446
|
-
width:
|
|
1447
|
-
height:
|
|
1448
|
-
float: bool |
|
|
1449
|
-
alpha: bool |
|
|
1455
|
+
width: int | None = 1024,
|
|
1456
|
+
height: int | None = 1024,
|
|
1457
|
+
float: bool | None = False,
|
|
1458
|
+
alpha: bool | None = True,
|
|
1450
1459
|
):
|
|
1451
1460
|
"""Fill the current tile with a generated image
|
|
1452
1461
|
|
|
@@ -1454,17 +1463,17 @@ def tile_fill(
|
|
|
1454
1463
|
:type execution_context: int | str | None
|
|
1455
1464
|
:type undo: bool | None
|
|
1456
1465
|
:param color: Color, Default fill color
|
|
1457
|
-
:type color:
|
|
1466
|
+
:type color: collections.abc.Iterable[float] | None
|
|
1458
1467
|
:param generated_type: Generated Type, Fill the image with a grid for UV map testing
|
|
1459
1468
|
:type generated_type: str | None
|
|
1460
1469
|
:param width: Width, Image width
|
|
1461
|
-
:type width:
|
|
1470
|
+
:type width: int | None
|
|
1462
1471
|
:param height: Height, Image height
|
|
1463
|
-
:type height:
|
|
1472
|
+
:type height: int | None
|
|
1464
1473
|
:param float: 32-bit Float, Create image with 32-bit floating-point bit depth
|
|
1465
|
-
:type float: bool |
|
|
1474
|
+
:type float: bool | None
|
|
1466
1475
|
:param alpha: Alpha, Create an image with an alpha channel
|
|
1467
|
-
:type alpha: bool |
|
|
1476
|
+
:type alpha: bool | None
|
|
1468
1477
|
"""
|
|
1469
1478
|
|
|
1470
1479
|
...
|
|
@@ -1489,7 +1498,7 @@ def unpack(
|
|
|
1489
1498
|
undo: bool | None = None,
|
|
1490
1499
|
*,
|
|
1491
1500
|
method: str | None = "USE_LOCAL",
|
|
1492
|
-
id: str
|
|
1501
|
+
id: str = "",
|
|
1493
1502
|
):
|
|
1494
1503
|
"""Save an image packed in the .blend file to disk
|
|
1495
1504
|
|
|
@@ -1499,7 +1508,7 @@ def unpack(
|
|
|
1499
1508
|
:param method: Method, How to unpack
|
|
1500
1509
|
:type method: str | None
|
|
1501
1510
|
:param id: Image Name, Image data-block name to unpack
|
|
1502
|
-
:type id: str
|
|
1511
|
+
:type id: str
|
|
1503
1512
|
"""
|
|
1504
1513
|
|
|
1505
1514
|
...
|
|
@@ -1509,7 +1518,7 @@ def view_all(
|
|
|
1509
1518
|
execution_context: int | str | None = None,
|
|
1510
1519
|
undo: bool | None = None,
|
|
1511
1520
|
*,
|
|
1512
|
-
fit_view: bool |
|
|
1521
|
+
fit_view: bool | None = False,
|
|
1513
1522
|
):
|
|
1514
1523
|
"""View the entire image
|
|
1515
1524
|
|
|
@@ -1517,7 +1526,7 @@ def view_all(
|
|
|
1517
1526
|
:type execution_context: int | str | None
|
|
1518
1527
|
:type undo: bool | None
|
|
1519
1528
|
:param fit_view: Fit View, Fit frame to the viewport
|
|
1520
|
-
:type fit_view: bool |
|
|
1529
|
+
:type fit_view: bool | None
|
|
1521
1530
|
"""
|
|
1522
1531
|
|
|
1523
1532
|
...
|
|
@@ -1541,7 +1550,7 @@ def view_cursor_center(
|
|
|
1541
1550
|
execution_context: int | str | None = None,
|
|
1542
1551
|
undo: bool | None = None,
|
|
1543
1552
|
*,
|
|
1544
|
-
fit_view: bool |
|
|
1553
|
+
fit_view: bool | None = False,
|
|
1545
1554
|
):
|
|
1546
1555
|
"""Set 2D Cursor To Center View location
|
|
1547
1556
|
|
|
@@ -1549,7 +1558,7 @@ def view_cursor_center(
|
|
|
1549
1558
|
:type execution_context: int | str | None
|
|
1550
1559
|
:type undo: bool | None
|
|
1551
1560
|
:param fit_view: Fit View, Fit frame to the viewport
|
|
1552
|
-
:type fit_view: bool |
|
|
1561
|
+
:type fit_view: bool | None
|
|
1553
1562
|
"""
|
|
1554
1563
|
|
|
1555
1564
|
...
|
|
@@ -1573,7 +1582,7 @@ def view_pan(
|
|
|
1573
1582
|
execution_context: int | str | None = None,
|
|
1574
1583
|
undo: bool | None = None,
|
|
1575
1584
|
*,
|
|
1576
|
-
offset:
|
|
1585
|
+
offset: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
|
|
1577
1586
|
):
|
|
1578
1587
|
"""Pan the view
|
|
1579
1588
|
|
|
@@ -1581,7 +1590,7 @@ def view_pan(
|
|
|
1581
1590
|
:type execution_context: int | str | None
|
|
1582
1591
|
:type undo: bool | None
|
|
1583
1592
|
:param offset: Offset, Offset in floating-point units, 1.0 is the width and height of the image
|
|
1584
|
-
:type offset:
|
|
1593
|
+
:type offset: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
1585
1594
|
"""
|
|
1586
1595
|
|
|
1587
1596
|
...
|
|
@@ -1605,8 +1614,8 @@ def view_zoom(
|
|
|
1605
1614
|
execution_context: int | str | None = None,
|
|
1606
1615
|
undo: bool | None = None,
|
|
1607
1616
|
*,
|
|
1608
|
-
factor:
|
|
1609
|
-
use_cursor_init: bool |
|
|
1617
|
+
factor: float | None = 0.0,
|
|
1618
|
+
use_cursor_init: bool | None = True,
|
|
1610
1619
|
):
|
|
1611
1620
|
"""Zoom in/out the image
|
|
1612
1621
|
|
|
@@ -1614,9 +1623,9 @@ def view_zoom(
|
|
|
1614
1623
|
:type execution_context: int | str | None
|
|
1615
1624
|
:type undo: bool | None
|
|
1616
1625
|
:param factor: Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out
|
|
1617
|
-
:type factor:
|
|
1626
|
+
:type factor: float | None
|
|
1618
1627
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
1619
|
-
:type use_cursor_init: bool |
|
|
1628
|
+
:type use_cursor_init: bool | None
|
|
1620
1629
|
"""
|
|
1621
1630
|
|
|
1622
1631
|
...
|
|
@@ -1626,12 +1635,12 @@ def view_zoom_border(
|
|
|
1626
1635
|
execution_context: int | str | None = None,
|
|
1627
1636
|
undo: bool | None = None,
|
|
1628
1637
|
*,
|
|
1629
|
-
xmin:
|
|
1630
|
-
xmax:
|
|
1631
|
-
ymin:
|
|
1632
|
-
ymax:
|
|
1633
|
-
wait_for_input: bool |
|
|
1634
|
-
zoom_out: bool |
|
|
1638
|
+
xmin: int | None = 0,
|
|
1639
|
+
xmax: int | None = 0,
|
|
1640
|
+
ymin: int | None = 0,
|
|
1641
|
+
ymax: int | None = 0,
|
|
1642
|
+
wait_for_input: bool | None = True,
|
|
1643
|
+
zoom_out: bool | None = False,
|
|
1635
1644
|
):
|
|
1636
1645
|
"""Zoom in the view to the nearest item contained in the border
|
|
1637
1646
|
|
|
@@ -1639,17 +1648,17 @@ def view_zoom_border(
|
|
|
1639
1648
|
:type execution_context: int | str | None
|
|
1640
1649
|
:type undo: bool | None
|
|
1641
1650
|
:param xmin: X Min
|
|
1642
|
-
:type xmin:
|
|
1651
|
+
:type xmin: int | None
|
|
1643
1652
|
:param xmax: X Max
|
|
1644
|
-
:type xmax:
|
|
1653
|
+
:type xmax: int | None
|
|
1645
1654
|
:param ymin: Y Min
|
|
1646
|
-
:type ymin:
|
|
1655
|
+
:type ymin: int | None
|
|
1647
1656
|
:param ymax: Y Max
|
|
1648
|
-
:type ymax:
|
|
1657
|
+
:type ymax: int | None
|
|
1649
1658
|
:param wait_for_input: Wait for Input
|
|
1650
|
-
:type wait_for_input: bool |
|
|
1659
|
+
:type wait_for_input: bool | None
|
|
1651
1660
|
:param zoom_out: Zoom Out
|
|
1652
|
-
:type zoom_out: bool |
|
|
1661
|
+
:type zoom_out: bool | None
|
|
1653
1662
|
"""
|
|
1654
1663
|
|
|
1655
1664
|
...
|
|
@@ -1659,7 +1668,7 @@ def view_zoom_in(
|
|
|
1659
1668
|
execution_context: int | str | None = None,
|
|
1660
1669
|
undo: bool | None = None,
|
|
1661
1670
|
*,
|
|
1662
|
-
location:
|
|
1671
|
+
location: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
|
|
1663
1672
|
):
|
|
1664
1673
|
"""Zoom in the image (centered around 2D cursor)
|
|
1665
1674
|
|
|
@@ -1667,7 +1676,7 @@ def view_zoom_in(
|
|
|
1667
1676
|
:type execution_context: int | str | None
|
|
1668
1677
|
:type undo: bool | None
|
|
1669
1678
|
:param location: Location, Cursor location in screen coordinates
|
|
1670
|
-
:type location:
|
|
1679
|
+
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
1671
1680
|
"""
|
|
1672
1681
|
|
|
1673
1682
|
...
|
|
@@ -1677,7 +1686,7 @@ def view_zoom_out(
|
|
|
1677
1686
|
execution_context: int | str | None = None,
|
|
1678
1687
|
undo: bool | None = None,
|
|
1679
1688
|
*,
|
|
1680
|
-
location:
|
|
1689
|
+
location: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
|
|
1681
1690
|
):
|
|
1682
1691
|
"""Zoom out the image (centered around 2D cursor)
|
|
1683
1692
|
|
|
@@ -1685,7 +1694,7 @@ def view_zoom_out(
|
|
|
1685
1694
|
:type execution_context: int | str | None
|
|
1686
1695
|
:type undo: bool | None
|
|
1687
1696
|
:param location: Location, Cursor location in screen coordinates
|
|
1688
|
-
:type location:
|
|
1697
|
+
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
1689
1698
|
"""
|
|
1690
1699
|
|
|
1691
1700
|
...
|
|
@@ -1695,7 +1704,7 @@ def view_zoom_ratio(
|
|
|
1695
1704
|
execution_context: int | str | None = None,
|
|
1696
1705
|
undo: bool | None = None,
|
|
1697
1706
|
*,
|
|
1698
|
-
ratio:
|
|
1707
|
+
ratio: float | None = 0.0,
|
|
1699
1708
|
):
|
|
1700
1709
|
"""Set zoom ratio of the view
|
|
1701
1710
|
|
|
@@ -1703,7 +1712,7 @@ def view_zoom_ratio(
|
|
|
1703
1712
|
:type execution_context: int | str | None
|
|
1704
1713
|
:type undo: bool | None
|
|
1705
1714
|
:param ratio: Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out
|
|
1706
|
-
:type ratio:
|
|
1715
|
+
:type ratio: float | None
|
|
1707
1716
|
"""
|
|
1708
1717
|
|
|
1709
1718
|
...
|