fake-bpy-module 20240421__py3-none-any.whl → 20240423__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_operators/add_mesh_torus/__init__.pyi +2 -1
- bl_operators/assets/__init__.pyi +12 -12
- bl_operators/geometry_nodes/__init__.pyi +256 -238
- bl_operators/node/__init__.pyi +262 -260
- bl_operators/object_quick_effects/__init__.pyi +19 -19
- bl_operators/presets/__init__.pyi +371 -368
- bl_operators/wm/__init__.pyi +4 -4
- bl_ui/__init__.pyi +3 -3
- bl_ui/anim/__init__.pyi +1 -1
- bl_ui/asset_shelf/__init__.pyi +1 -1
- bl_ui/generic_ui_list/__init__.pyi +3 -3
- bl_ui/node_add_menu/__init__.pyi +1 -1
- bl_ui/node_add_menu_compositor/__init__.pyi +18 -18
- bl_ui/node_add_menu_geometry/__init__.pyi +50 -48
- bl_ui/node_add_menu_shader/__init__.pyi +10 -10
- bl_ui/node_add_menu_texture/__init__.pyi +9 -9
- bl_ui/properties_collection/__init__.pyi +39 -25
- bl_ui/properties_constraint/__init__.pyi +1257 -1041
- bl_ui/properties_data_armature/__init__.pyi +120 -96
- bl_ui/properties_data_bone/__init__.pyi +36 -29
- bl_ui/properties_data_camera/__init__.pyi +32 -14
- bl_ui/properties_data_curve/__init__.pyi +143 -116
- bl_ui/properties_data_curves/__init__.pyi +30 -25
- bl_ui/properties_data_empty/__init__.pyi +21 -21
- bl_ui/properties_data_gpencil/__init__.pyi +297 -260
- bl_ui/properties_data_grease_pencil/__init__.pyi +228 -205
- bl_ui/properties_data_lattice/__init__.pyi +25 -22
- bl_ui/properties_data_light/__init__.pyi +44 -31
- bl_ui/properties_data_lightprobe/__init__.pyi +54 -32
- bl_ui/properties_data_mesh/__init__.pyi +579 -570
- bl_ui/properties_data_metaball/__init__.pyi +29 -24
- bl_ui/properties_data_modifier/__init__.pyi +55 -43
- bl_ui/properties_data_pointcloud/__init__.pyi +146 -139
- bl_ui/properties_data_shaderfx/__init__.pyi +13 -13
- bl_ui/properties_data_speaker/__init__.pyi +27 -24
- bl_ui/properties_data_volume/__init__.pyi +75 -68
- bl_ui/properties_freestyle/__init__.pyi +407 -284
- bl_ui/properties_grease_pencil_common/__init__.pyi +13 -13
- bl_ui/properties_mask_common/__init__.pyi +7 -7
- bl_ui/properties_material/__init__.pyi +186 -162
- bl_ui/properties_material_gpencil/__init__.pyi +111 -87
- bl_ui/properties_object/__init__.pyi +102 -84
- bl_ui/properties_output/__init__.pyi +255 -228
- bl_ui/properties_paint_common/__init__.pyi +9 -9
- bl_ui/properties_particle/__init__.pyi +341 -254
- bl_ui/properties_physics_cloth/__init__.pyi +54 -33
- bl_ui/properties_physics_common/__init__.pyi +20 -20
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +231 -193
- bl_ui/properties_physics_field/__init__.pyi +52 -36
- bl_ui/properties_physics_fluid/__init__.pyi +119 -96
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +1 -1
- bl_ui/properties_physics_rigidbody/__init__.pyi +36 -20
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +51 -25
- bl_ui/properties_physics_softbody/__init__.pyi +62 -34
- bl_ui/properties_render/__init__.pyi +275 -187
- bl_ui/properties_scene/__init__.pyi +173 -154
- bl_ui/properties_texture/__init__.pyi +251 -205
- bl_ui/properties_view_layer/__init__.pyi +126 -93
- bl_ui/properties_workspace/__init__.pyi +82 -76
- bl_ui/properties_world/__init__.pyi +31 -26
- bl_ui/space_clip/__init__.pyi +495 -433
- bl_ui/space_console/__init__.pyi +6 -6
- bl_ui/space_dopesheet/__init__.pyi +209 -174
- bl_ui/space_filebrowser/__init__.pyi +691 -679
- bl_ui/space_graph/__init__.pyi +25 -20
- bl_ui/space_image/__init__.pyi +959 -845
- bl_ui/space_info/__init__.pyi +6 -6
- bl_ui/space_nla/__init__.pyi +26 -17
- bl_ui/space_node/__init__.pyi +49 -36
- bl_ui/space_outliner/__init__.pyi +14 -14
- bl_ui/space_properties/__init__.pyi +3 -3
- bl_ui/space_sequencer/__init__.pyi +510 -444
- bl_ui/space_spreadsheet/__init__.pyi +1 -1
- bl_ui/space_statusbar/__init__.pyi +1 -1
- bl_ui/space_text/__init__.pyi +16 -16
- bl_ui/space_time/__init__.pyi +27 -23
- bl_ui/space_toolsystem_common/__init__.pyi +1 -1
- bl_ui/space_toolsystem_toolbar/__init__.pyi +52 -4
- bl_ui/space_topbar/__init__.pyi +26 -26
- bl_ui/space_userpref/__init__.pyi +795 -658
- bl_ui/space_view3d/__init__.pyi +1460 -1428
- bl_ui/space_view3d_toolbar/__init__.pyi +2968 -2657
- bl_ui/temp_anim_layers/__init__.pyi +1 -1
- bmesh/types/__init__.pyi +13 -6
- bpy/app/__init__.pyi +4 -4
- bpy/app/icons/__init__.pyi +8 -6
- bpy/app/timers/__init__.pyi +10 -8
- bpy/app/translations/__init__.pyi +22 -20
- bpy/msgbus/__init__.pyi +4 -2
- bpy/ops/action/__init__.pyi +319 -316
- bpy/ops/anim/__init__.pyi +428 -428
- bpy/ops/armature/__init__.pyi +359 -358
- bpy/ops/asset/__init__.pyi +146 -146
- bpy/ops/boid/__init__.pyi +50 -50
- bpy/ops/brush/__init__.pyi +72 -72
- bpy/ops/buttons/__init__.pyi +128 -128
- bpy/ops/cachefile/__init__.pyi +124 -124
- bpy/ops/camera/__init__.pyi +22 -22
- bpy/ops/clip/__init__.pyi +773 -768
- bpy/ops/cloth/__init__.pyi +10 -10
- bpy/ops/collection/__init__.pyi +64 -64
- bpy/ops/console/__init__.pyi +150 -150
- bpy/ops/constraint/__init__.pyi +150 -150
- bpy/ops/curve/__init__.pyi +475 -472
- bpy/ops/curves/__init__.pyi +247 -244
- bpy/ops/cycles/__init__.pyi +18 -18
- bpy/ops/dpaint/__init__.pyi +34 -34
- bpy/ops/ed/__init__.pyi +122 -122
- bpy/ops/export_anim/__init__.pyi +18 -18
- bpy/ops/export_mesh/__init__.pyi +26 -26
- bpy/ops/export_scene/__init__.pyi +333 -307
- bpy/ops/file/__init__.pyi +340 -340
- bpy/ops/fluid/__init__.pyi +88 -88
- bpy/ops/font/__init__.pyi +252 -252
- bpy/ops/geometry/__init__.pyi +86 -86
- bpy/ops/gizmogroup/__init__.pyi +22 -22
- bpy/ops/gpencil/__init__.pyi +1459 -1444
- bpy/ops/graph/__init__.pyi +645 -642
- bpy/ops/grease_pencil/__init__.pyi +580 -436
- bpy/ops/image/__init__.pyi +614 -612
- bpy/ops/import_anim/__init__.pyi +26 -26
- bpy/ops/import_curve/__init__.pyi +6 -6
- bpy/ops/import_mesh/__init__.pyi +20 -18
- bpy/ops/import_scene/__init__.pyi +92 -86
- bpy/ops/info/__init__.pyi +60 -60
- bpy/ops/lattice/__init__.pyi +64 -64
- bpy/ops/marker/__init__.pyi +106 -106
- bpy/ops/mask/__init__.pyi +321 -318
- bpy/ops/material/__init__.pyi +18 -18
- bpy/ops/mball/__init__.pyi +71 -70
- bpy/ops/mesh/__init__.pyi +1997 -1990
- bpy/ops/nla/__init__.pyi +331 -330
- bpy/ops/node/__init__.pyi +867 -852
- bpy/ops/object/__init__.pyi +2433 -2430
- bpy/ops/outliner/__init__.pyi +498 -498
- bpy/ops/paint/__init__.pyi +554 -544
- bpy/ops/paintcurve/__init__.pyi +64 -64
- bpy/ops/palette/__init__.pyi +48 -48
- bpy/ops/particle/__init__.pyi +266 -264
- bpy/ops/pose/__init__.pyi +336 -336
- bpy/ops/poselib/__init__.pyi +70 -70
- bpy/ops/preferences/__init__.pyi +338 -336
- bpy/ops/ptcache/__init__.pyi +46 -46
- bpy/ops/render/__init__.pyi +114 -114
- bpy/ops/rigidbody/__init__.pyi +102 -102
- bpy/ops/scene/__init__.pyi +270 -270
- bpy/ops/screen/__init__.pyi +378 -378
- bpy/ops/script/__init__.pyi +18 -18
- bpy/ops/sculpt/__init__.pyi +411 -405
- bpy/ops/sculpt_curves/__init__.pyi +42 -40
- bpy/ops/sequencer/__init__.pyi +1053 -1040
- bpy/ops/sound/__init__.pyi +208 -208
- bpy/ops/spreadsheet/__init__.pyi +30 -30
- bpy/ops/surface/__init__.pyi +108 -108
- bpy/ops/text/__init__.pyi +382 -382
- bpy/ops/text_editor/__init__.pyi +10 -10
- bpy/ops/texture/__init__.pyi +26 -26
- bpy/ops/transform/__init__.pyi +826 -790
- bpy/ops/ui/__init__.pyi +216 -216
- bpy/ops/uilist/__init__.pyi +20 -20
- bpy/ops/uv/__init__.pyi +605 -600
- bpy/ops/view2d/__init__.pyi +156 -156
- bpy/ops/view3d/__init__.pyi +578 -576
- bpy/ops/wm/__init__.pyi +2418 -2376
- bpy/ops/workspace/__init__.pyi +42 -42
- bpy/ops/world/__init__.pyi +6 -6
- bpy/path/__init__.pyi +48 -33
- bpy/props/__init__.pyi +263 -261
- bpy/types/__init__.pyi +105733 -102298
- bpy/utils/__init__.pyi +87 -52
- bpy/utils/previews/__init__.pyi +2 -2
- bpy/utils/units/__init__.pyi +21 -18
- bpy_extras/anim_utils/__init__.pyi +9 -2
- bpy_extras/io_utils/__init__.pyi +2 -1
- bpy_extras/view3d_utils/__init__.pyi +2 -1
- bpy_types/__init__.pyi +236 -236
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/RECORD +187 -187
- freestyle/chainingiterators/__init__.pyi +7 -2
- freestyle/types/__init__.pyi +8 -3
- gpu_extras/presets/__init__.pyi +14 -2
- keyingsets_builtins/__init__.pyi +92 -92
- mathutils/__init__.pyi +9 -5
- mathutils/geometry/__init__.pyi +8 -4
- nodeitems_builtins/__init__.pyi +7 -7
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240421.dist-info → fake_bpy_module-20240423.dist-info}/top_level.txt +0 -0
bpy/ops/image/__init__.pyi
CHANGED
|
@@ -4,140 +4,140 @@ import bpy.types
|
|
|
4
4
|
GenericType = typing.TypeVar("GenericType")
|
|
5
5
|
|
|
6
6
|
def add_render_slot(
|
|
7
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
8
|
-
execution_context: typing.Union[str, int] = None,
|
|
9
|
-
undo: bool = None,
|
|
7
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
8
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
9
|
+
undo: typing.Optional[bool] = None,
|
|
10
10
|
):
|
|
11
11
|
"""Add a new render slot
|
|
12
12
|
|
|
13
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
14
|
-
:type execution_context: typing.Union[str, int]
|
|
15
|
-
:type undo: bool
|
|
13
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
14
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
15
|
+
:type undo: typing.Optional[bool]
|
|
16
16
|
"""
|
|
17
17
|
|
|
18
18
|
...
|
|
19
19
|
|
|
20
20
|
def change_frame(
|
|
21
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
22
|
-
execution_context: typing.Union[str, int] = None,
|
|
23
|
-
undo: bool = None,
|
|
24
|
-
frame: typing.Any = 0,
|
|
21
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
22
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
23
|
+
undo: typing.Optional[bool] = None,
|
|
24
|
+
frame: typing.Optional[typing.Any] = 0,
|
|
25
25
|
):
|
|
26
26
|
"""Interactively change the current frame number
|
|
27
27
|
|
|
28
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
29
|
-
:type execution_context: typing.Union[str, int]
|
|
30
|
-
:type undo: bool
|
|
28
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
29
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
30
|
+
:type undo: typing.Optional[bool]
|
|
31
31
|
:param frame: Frame
|
|
32
|
-
:type frame: typing.Any
|
|
32
|
+
:type frame: typing.Optional[typing.Any]
|
|
33
33
|
"""
|
|
34
34
|
|
|
35
35
|
...
|
|
36
36
|
|
|
37
37
|
def clear_render_border(
|
|
38
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
39
|
-
execution_context: typing.Union[str, int] = None,
|
|
40
|
-
undo: bool = None,
|
|
38
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
39
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
40
|
+
undo: typing.Optional[bool] = None,
|
|
41
41
|
):
|
|
42
42
|
"""Clear the boundaries of the render region and disable render region
|
|
43
43
|
|
|
44
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
45
|
-
:type execution_context: typing.Union[str, int]
|
|
46
|
-
:type undo: bool
|
|
44
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
45
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
46
|
+
:type undo: typing.Optional[bool]
|
|
47
47
|
"""
|
|
48
48
|
|
|
49
49
|
...
|
|
50
50
|
|
|
51
51
|
def clear_render_slot(
|
|
52
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
53
|
-
execution_context: typing.Union[str, int] = None,
|
|
54
|
-
undo: bool = None,
|
|
52
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
53
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
54
|
+
undo: typing.Optional[bool] = None,
|
|
55
55
|
):
|
|
56
56
|
"""Clear the currently selected render slot
|
|
57
57
|
|
|
58
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
59
|
-
:type execution_context: typing.Union[str, int]
|
|
60
|
-
:type undo: bool
|
|
58
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
59
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
60
|
+
:type undo: typing.Optional[bool]
|
|
61
61
|
"""
|
|
62
62
|
|
|
63
63
|
...
|
|
64
64
|
|
|
65
65
|
def clipboard_copy(
|
|
66
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
67
|
-
execution_context: typing.Union[str, int] = None,
|
|
68
|
-
undo: bool = None,
|
|
66
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
67
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
68
|
+
undo: typing.Optional[bool] = None,
|
|
69
69
|
):
|
|
70
70
|
"""Copy the image to the clipboard
|
|
71
71
|
|
|
72
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
73
|
-
:type execution_context: typing.Union[str, int]
|
|
74
|
-
:type undo: bool
|
|
72
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
73
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
74
|
+
:type undo: typing.Optional[bool]
|
|
75
75
|
"""
|
|
76
76
|
|
|
77
77
|
...
|
|
78
78
|
|
|
79
79
|
def clipboard_paste(
|
|
80
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
81
|
-
execution_context: typing.Union[str, int] = None,
|
|
82
|
-
undo: bool = None,
|
|
80
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
81
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
82
|
+
undo: typing.Optional[bool] = None,
|
|
83
83
|
):
|
|
84
84
|
"""Paste new image from the clipboard
|
|
85
85
|
|
|
86
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
87
|
-
:type execution_context: typing.Union[str, int]
|
|
88
|
-
:type undo: bool
|
|
86
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
87
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
88
|
+
:type undo: typing.Optional[bool]
|
|
89
89
|
"""
|
|
90
90
|
|
|
91
91
|
...
|
|
92
92
|
|
|
93
93
|
def curves_point_set(
|
|
94
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
95
|
-
execution_context: typing.Union[str, int] = None,
|
|
96
|
-
undo: bool = None,
|
|
97
|
-
point: typing.Any = "BLACK_POINT",
|
|
98
|
-
size: typing.Any = 1,
|
|
94
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
95
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
96
|
+
undo: typing.Optional[bool] = None,
|
|
97
|
+
point: typing.Optional[typing.Any] = "BLACK_POINT",
|
|
98
|
+
size: typing.Optional[typing.Any] = 1,
|
|
99
99
|
):
|
|
100
100
|
"""Set black point or white point for curves
|
|
101
101
|
|
|
102
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
103
|
-
:type execution_context: typing.Union[str, int]
|
|
104
|
-
:type undo: bool
|
|
102
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
103
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
104
|
+
:type undo: typing.Optional[bool]
|
|
105
105
|
:param point: Point, Set black point or white point for curves
|
|
106
|
-
:type point: typing.Any
|
|
106
|
+
:type point: typing.Optional[typing.Any]
|
|
107
107
|
:param size: Sample Size
|
|
108
|
-
:type size: typing.Any
|
|
108
|
+
:type size: typing.Optional[typing.Any]
|
|
109
109
|
"""
|
|
110
110
|
|
|
111
111
|
...
|
|
112
112
|
|
|
113
113
|
def cycle_render_slot(
|
|
114
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
115
|
-
execution_context: typing.Union[str, int] = None,
|
|
116
|
-
undo: bool = None,
|
|
117
|
-
reverse: typing.Union[bool, typing.Any] = False,
|
|
114
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
115
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
116
|
+
undo: typing.Optional[bool] = None,
|
|
117
|
+
reverse: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
118
118
|
):
|
|
119
119
|
"""Cycle through all non-void render slots
|
|
120
120
|
|
|
121
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
122
|
-
:type execution_context: typing.Union[str, int]
|
|
123
|
-
:type undo: bool
|
|
121
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
122
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
123
|
+
:type undo: typing.Optional[bool]
|
|
124
124
|
:param reverse: Cycle in Reverse
|
|
125
|
-
:type reverse: typing.Union[bool, typing.Any]
|
|
125
|
+
:type reverse: typing.Optional[typing.Union[bool, typing.Any]]
|
|
126
126
|
"""
|
|
127
127
|
|
|
128
128
|
...
|
|
129
129
|
|
|
130
130
|
def external_edit(
|
|
131
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
132
|
-
execution_context: typing.Union[str, int] = None,
|
|
133
|
-
undo: bool = None,
|
|
131
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
132
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
133
|
+
undo: typing.Optional[bool] = None,
|
|
134
134
|
filepath: typing.Union[str, typing.Any] = "",
|
|
135
135
|
):
|
|
136
136
|
"""Edit image in an external application
|
|
137
137
|
|
|
138
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
139
|
-
:type execution_context: typing.Union[str, int]
|
|
140
|
-
:type undo: bool
|
|
138
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
139
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
140
|
+
:type undo: typing.Optional[bool]
|
|
141
141
|
:param filepath: filepath
|
|
142
142
|
:type filepath: typing.Union[str, typing.Any]
|
|
143
143
|
"""
|
|
@@ -145,89 +145,89 @@ def external_edit(
|
|
|
145
145
|
...
|
|
146
146
|
|
|
147
147
|
def file_browse(
|
|
148
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
149
|
-
execution_context: typing.Union[str, int] = None,
|
|
150
|
-
undo: bool = None,
|
|
148
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
149
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
150
|
+
undo: typing.Optional[bool] = None,
|
|
151
151
|
filepath: typing.Union[str, typing.Any] = "",
|
|
152
|
-
hide_props_region: typing.Union[bool, typing.Any] = True,
|
|
153
|
-
check_existing: typing.Union[bool, typing.Any] = False,
|
|
154
|
-
filter_blender: typing.Union[bool, typing.Any] = False,
|
|
155
|
-
filter_backup: typing.Union[bool, typing.Any] = False,
|
|
156
|
-
filter_image: typing.Union[bool, typing.Any] = True,
|
|
157
|
-
filter_movie: typing.Union[bool, typing.Any] = True,
|
|
158
|
-
filter_python: typing.Union[bool, typing.Any] = False,
|
|
159
|
-
filter_font: typing.Union[bool, typing.Any] = False,
|
|
160
|
-
filter_sound: typing.Union[bool, typing.Any] = False,
|
|
161
|
-
filter_text: typing.Union[bool, typing.Any] = False,
|
|
162
|
-
filter_archive: typing.Union[bool, typing.Any] = False,
|
|
163
|
-
filter_btx: typing.Union[bool, typing.Any] = False,
|
|
164
|
-
filter_collada: typing.Union[bool, typing.Any] = False,
|
|
165
|
-
filter_alembic: typing.Union[bool, typing.Any] = False,
|
|
166
|
-
filter_usd: typing.Union[bool, typing.Any] = False,
|
|
167
|
-
filter_obj: typing.Union[bool, typing.Any] = False,
|
|
168
|
-
filter_volume: typing.Union[bool, typing.Any] = False,
|
|
169
|
-
filter_folder: typing.Union[bool, typing.Any] = True,
|
|
170
|
-
filter_blenlib: typing.Union[bool, typing.Any] = False,
|
|
171
|
-
filemode: typing.Any = 9,
|
|
172
|
-
relative_path: typing.Union[bool, typing.Any] = True,
|
|
173
|
-
show_multiview: typing.Union[bool, typing.Any] = False,
|
|
174
|
-
use_multiview: typing.Union[bool, typing.Any] = False,
|
|
175
|
-
display_type: typing.Any = "DEFAULT",
|
|
176
|
-
sort_method: typing.Union[str, int, typing.Any] = "",
|
|
152
|
+
hide_props_region: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
153
|
+
check_existing: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
154
|
+
filter_blender: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
155
|
+
filter_backup: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
156
|
+
filter_image: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
157
|
+
filter_movie: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
158
|
+
filter_python: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
159
|
+
filter_font: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
160
|
+
filter_sound: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
161
|
+
filter_text: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
162
|
+
filter_archive: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
163
|
+
filter_btx: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
164
|
+
filter_collada: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
165
|
+
filter_alembic: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
166
|
+
filter_usd: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
167
|
+
filter_obj: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
168
|
+
filter_volume: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
169
|
+
filter_folder: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
170
|
+
filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
171
|
+
filemode: typing.Optional[typing.Any] = 9,
|
|
172
|
+
relative_path: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
173
|
+
show_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
174
|
+
use_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
175
|
+
display_type: typing.Optional[typing.Any] = "DEFAULT",
|
|
176
|
+
sort_method: typing.Optional[typing.Union[str, int, typing.Any]] = "",
|
|
177
177
|
):
|
|
178
178
|
"""Open an image file browser, hold Shift to open the file, Alt to browse containing directory
|
|
179
179
|
|
|
180
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
181
|
-
:type execution_context: typing.Union[str, int]
|
|
182
|
-
:type undo: bool
|
|
180
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
181
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
182
|
+
:type undo: typing.Optional[bool]
|
|
183
183
|
:param filepath: File Path, Path to file
|
|
184
184
|
:type filepath: typing.Union[str, typing.Any]
|
|
185
185
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
186
|
-
:type hide_props_region: typing.Union[bool, typing.Any]
|
|
186
|
+
:type hide_props_region: typing.Optional[typing.Union[bool, typing.Any]]
|
|
187
187
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
188
|
-
:type check_existing: typing.Union[bool, typing.Any]
|
|
188
|
+
:type check_existing: typing.Optional[typing.Union[bool, typing.Any]]
|
|
189
189
|
:param filter_blender: Filter .blend files
|
|
190
|
-
:type filter_blender: typing.Union[bool, typing.Any]
|
|
190
|
+
:type filter_blender: typing.Optional[typing.Union[bool, typing.Any]]
|
|
191
191
|
:param filter_backup: Filter .blend files
|
|
192
|
-
:type filter_backup: typing.Union[bool, typing.Any]
|
|
192
|
+
:type filter_backup: typing.Optional[typing.Union[bool, typing.Any]]
|
|
193
193
|
:param filter_image: Filter image files
|
|
194
|
-
:type filter_image: typing.Union[bool, typing.Any]
|
|
194
|
+
:type filter_image: typing.Optional[typing.Union[bool, typing.Any]]
|
|
195
195
|
:param filter_movie: Filter movie files
|
|
196
|
-
:type filter_movie: typing.Union[bool, typing.Any]
|
|
196
|
+
:type filter_movie: typing.Optional[typing.Union[bool, typing.Any]]
|
|
197
197
|
:param filter_python: Filter Python files
|
|
198
|
-
:type filter_python: typing.Union[bool, typing.Any]
|
|
198
|
+
:type filter_python: typing.Optional[typing.Union[bool, typing.Any]]
|
|
199
199
|
:param filter_font: Filter font files
|
|
200
|
-
:type filter_font: typing.Union[bool, typing.Any]
|
|
200
|
+
:type filter_font: typing.Optional[typing.Union[bool, typing.Any]]
|
|
201
201
|
:param filter_sound: Filter sound files
|
|
202
|
-
:type filter_sound: typing.Union[bool, typing.Any]
|
|
202
|
+
:type filter_sound: typing.Optional[typing.Union[bool, typing.Any]]
|
|
203
203
|
:param filter_text: Filter text files
|
|
204
|
-
:type filter_text: typing.Union[bool, typing.Any]
|
|
204
|
+
:type filter_text: typing.Optional[typing.Union[bool, typing.Any]]
|
|
205
205
|
:param filter_archive: Filter archive files
|
|
206
|
-
:type filter_archive: typing.Union[bool, typing.Any]
|
|
206
|
+
:type filter_archive: typing.Optional[typing.Union[bool, typing.Any]]
|
|
207
207
|
:param filter_btx: Filter btx files
|
|
208
|
-
:type filter_btx: typing.Union[bool, typing.Any]
|
|
208
|
+
:type filter_btx: typing.Optional[typing.Union[bool, typing.Any]]
|
|
209
209
|
:param filter_collada: Filter COLLADA files
|
|
210
|
-
:type filter_collada: typing.Union[bool, typing.Any]
|
|
210
|
+
:type filter_collada: typing.Optional[typing.Union[bool, typing.Any]]
|
|
211
211
|
:param filter_alembic: Filter Alembic files
|
|
212
|
-
:type filter_alembic: typing.Union[bool, typing.Any]
|
|
212
|
+
:type filter_alembic: typing.Optional[typing.Union[bool, typing.Any]]
|
|
213
213
|
:param filter_usd: Filter USD files
|
|
214
|
-
:type filter_usd: typing.Union[bool, typing.Any]
|
|
214
|
+
:type filter_usd: typing.Optional[typing.Union[bool, typing.Any]]
|
|
215
215
|
:param filter_obj: Filter OBJ files
|
|
216
|
-
:type filter_obj: typing.Union[bool, typing.Any]
|
|
216
|
+
:type filter_obj: typing.Optional[typing.Union[bool, typing.Any]]
|
|
217
217
|
:param filter_volume: Filter OpenVDB volume files
|
|
218
|
-
:type filter_volume: typing.Union[bool, typing.Any]
|
|
218
|
+
:type filter_volume: typing.Optional[typing.Union[bool, typing.Any]]
|
|
219
219
|
:param filter_folder: Filter folders
|
|
220
|
-
:type filter_folder: typing.Union[bool, typing.Any]
|
|
220
|
+
:type filter_folder: typing.Optional[typing.Union[bool, typing.Any]]
|
|
221
221
|
:param filter_blenlib: Filter Blender IDs
|
|
222
|
-
:type filter_blenlib: typing.Union[bool, typing.Any]
|
|
222
|
+
:type filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]]
|
|
223
223
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
224
|
-
:type filemode: typing.Any
|
|
224
|
+
:type filemode: typing.Optional[typing.Any]
|
|
225
225
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
226
|
-
:type relative_path: typing.Union[bool, typing.Any]
|
|
226
|
+
:type relative_path: typing.Optional[typing.Union[bool, typing.Any]]
|
|
227
227
|
:param show_multiview: Enable Multi-View
|
|
228
|
-
:type show_multiview: typing.Union[bool, typing.Any]
|
|
228
|
+
:type show_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
229
229
|
:param use_multiview: Use Multi-View
|
|
230
|
-
:type use_multiview: typing.Union[bool, typing.Any]
|
|
230
|
+
:type use_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
231
231
|
:param display_type: Display Type
|
|
232
232
|
|
|
233
233
|
DEFAULT
|
|
@@ -241,209 +241,211 @@ def file_browse(
|
|
|
241
241
|
|
|
242
242
|
THUMBNAIL
|
|
243
243
|
Thumbnails -- Display files as thumbnails.
|
|
244
|
-
:type display_type: typing.Any
|
|
244
|
+
:type display_type: typing.Optional[typing.Any]
|
|
245
245
|
:param sort_method: File sorting mode
|
|
246
|
-
:type sort_method: typing.Union[str, int, typing.Any]
|
|
246
|
+
:type sort_method: typing.Optional[typing.Union[str, int, typing.Any]]
|
|
247
247
|
"""
|
|
248
248
|
|
|
249
249
|
...
|
|
250
250
|
|
|
251
251
|
def flip(
|
|
252
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
253
|
-
execution_context: typing.Union[str, int] = None,
|
|
254
|
-
undo: bool = None,
|
|
255
|
-
use_flip_x: typing.Union[bool, typing.Any] = False,
|
|
256
|
-
use_flip_y: typing.Union[bool, typing.Any] = False,
|
|
252
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
253
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
254
|
+
undo: typing.Optional[bool] = None,
|
|
255
|
+
use_flip_x: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
256
|
+
use_flip_y: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
257
257
|
):
|
|
258
258
|
"""Flip the image
|
|
259
259
|
|
|
260
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
261
|
-
:type execution_context: typing.Union[str, int]
|
|
262
|
-
:type undo: bool
|
|
260
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
261
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
262
|
+
:type undo: typing.Optional[bool]
|
|
263
263
|
:param use_flip_x: Horizontal, Flip the image horizontally
|
|
264
|
-
:type use_flip_x: typing.Union[bool, typing.Any]
|
|
264
|
+
:type use_flip_x: typing.Optional[typing.Union[bool, typing.Any]]
|
|
265
265
|
:param use_flip_y: Vertical, Flip the image vertically
|
|
266
|
-
:type use_flip_y: typing.Union[bool, typing.Any]
|
|
266
|
+
:type use_flip_y: typing.Optional[typing.Union[bool, typing.Any]]
|
|
267
267
|
"""
|
|
268
268
|
|
|
269
269
|
...
|
|
270
270
|
|
|
271
271
|
def invert(
|
|
272
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
273
|
-
execution_context: typing.Union[str, int] = None,
|
|
274
|
-
undo: bool = None,
|
|
275
|
-
invert_r: typing.Union[bool, typing.Any] = False,
|
|
276
|
-
invert_g: typing.Union[bool, typing.Any] = False,
|
|
277
|
-
invert_b: typing.Union[bool, typing.Any] = False,
|
|
278
|
-
invert_a: typing.Union[bool, typing.Any] = False,
|
|
272
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
273
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
274
|
+
undo: typing.Optional[bool] = None,
|
|
275
|
+
invert_r: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
276
|
+
invert_g: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
277
|
+
invert_b: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
278
|
+
invert_a: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
279
279
|
):
|
|
280
280
|
"""Invert image's channels
|
|
281
281
|
|
|
282
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
283
|
-
:type execution_context: typing.Union[str, int]
|
|
284
|
-
:type undo: bool
|
|
282
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
283
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
284
|
+
:type undo: typing.Optional[bool]
|
|
285
285
|
:param invert_r: Red, Invert red channel
|
|
286
|
-
:type invert_r: typing.Union[bool, typing.Any]
|
|
286
|
+
:type invert_r: typing.Optional[typing.Union[bool, typing.Any]]
|
|
287
287
|
:param invert_g: Green, Invert green channel
|
|
288
|
-
:type invert_g: typing.Union[bool, typing.Any]
|
|
288
|
+
:type invert_g: typing.Optional[typing.Union[bool, typing.Any]]
|
|
289
289
|
:param invert_b: Blue, Invert blue channel
|
|
290
|
-
:type invert_b: typing.Union[bool, typing.Any]
|
|
290
|
+
:type invert_b: typing.Optional[typing.Union[bool, typing.Any]]
|
|
291
291
|
:param invert_a: Alpha, Invert alpha channel
|
|
292
|
-
:type invert_a: typing.Union[bool, typing.Any]
|
|
292
|
+
:type invert_a: typing.Optional[typing.Union[bool, typing.Any]]
|
|
293
293
|
"""
|
|
294
294
|
|
|
295
295
|
...
|
|
296
296
|
|
|
297
297
|
def match_movie_length(
|
|
298
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
299
|
-
execution_context: typing.Union[str, int] = None,
|
|
300
|
-
undo: bool = None,
|
|
298
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
299
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
300
|
+
undo: typing.Optional[bool] = None,
|
|
301
301
|
):
|
|
302
302
|
"""Set image's user's length to the one of this video
|
|
303
303
|
|
|
304
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
305
|
-
:type execution_context: typing.Union[str, int]
|
|
306
|
-
:type undo: bool
|
|
304
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
305
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
306
|
+
:type undo: typing.Optional[bool]
|
|
307
307
|
"""
|
|
308
308
|
|
|
309
309
|
...
|
|
310
310
|
|
|
311
311
|
def new(
|
|
312
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
313
|
-
execution_context: typing.Union[str, int] = None,
|
|
314
|
-
undo: bool = None,
|
|
312
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
313
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
314
|
+
undo: typing.Optional[bool] = None,
|
|
315
315
|
name: typing.Union[str, typing.Any] = "Untitled",
|
|
316
|
-
width: typing.Any = 1024,
|
|
317
|
-
height: typing.Any = 1024,
|
|
318
|
-
color: typing.Any = (0.0, 0.0, 0.0, 1.0),
|
|
319
|
-
alpha: typing.Union[bool, typing.Any] = True,
|
|
320
|
-
generated_type: typing.Union[str, int] = "BLANK",
|
|
321
|
-
float: typing.Union[bool, typing.Any] = False,
|
|
322
|
-
use_stereo_3d: typing.Union[bool, typing.Any] = False,
|
|
323
|
-
tiled: typing.Union[bool, typing.Any] = False,
|
|
316
|
+
width: typing.Optional[typing.Any] = 1024,
|
|
317
|
+
height: typing.Optional[typing.Any] = 1024,
|
|
318
|
+
color: typing.Optional[typing.Any] = (0.0, 0.0, 0.0, 1.0),
|
|
319
|
+
alpha: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
320
|
+
generated_type: typing.Optional[typing.Union[str, int]] = "BLANK",
|
|
321
|
+
float: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
322
|
+
use_stereo_3d: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
323
|
+
tiled: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
324
324
|
):
|
|
325
325
|
"""Create a new image
|
|
326
326
|
|
|
327
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
328
|
-
:type execution_context: typing.Union[str, int]
|
|
329
|
-
:type undo: bool
|
|
327
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
328
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
329
|
+
:type undo: typing.Optional[bool]
|
|
330
330
|
:param name: Name, Image data-block name
|
|
331
331
|
:type name: typing.Union[str, typing.Any]
|
|
332
332
|
:param width: Width, Image width
|
|
333
|
-
:type width: typing.Any
|
|
333
|
+
:type width: typing.Optional[typing.Any]
|
|
334
334
|
:param height: Height, Image height
|
|
335
|
-
:type height: typing.Any
|
|
335
|
+
:type height: typing.Optional[typing.Any]
|
|
336
336
|
:param color: Color, Default fill color
|
|
337
|
-
:type color: typing.Any
|
|
337
|
+
:type color: typing.Optional[typing.Any]
|
|
338
338
|
:param alpha: Alpha, Create an image with an alpha channel
|
|
339
|
-
:type alpha: typing.Union[bool, typing.Any]
|
|
339
|
+
:type alpha: typing.Optional[typing.Union[bool, typing.Any]]
|
|
340
340
|
:param generated_type: Generated Type, Fill the image with a grid for UV map testing
|
|
341
|
-
:type generated_type: typing.Union[str, int]
|
|
341
|
+
:type generated_type: typing.Optional[typing.Union[str, int]]
|
|
342
342
|
:param float: 32-bit Float, Create image with 32-bit floating-point bit depth
|
|
343
|
-
:type float: typing.Union[bool, typing.Any]
|
|
343
|
+
:type float: typing.Optional[typing.Union[bool, typing.Any]]
|
|
344
344
|
:param use_stereo_3d: Stereo 3D, Create an image with left and right views
|
|
345
|
-
:type use_stereo_3d: typing.Union[bool, typing.Any]
|
|
345
|
+
:type use_stereo_3d: typing.Optional[typing.Union[bool, typing.Any]]
|
|
346
346
|
:param tiled: Tiled, Create a tiled image
|
|
347
|
-
:type tiled: typing.Union[bool, typing.Any]
|
|
347
|
+
:type tiled: typing.Optional[typing.Union[bool, typing.Any]]
|
|
348
348
|
"""
|
|
349
349
|
|
|
350
350
|
...
|
|
351
351
|
|
|
352
352
|
def open(
|
|
353
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
354
|
-
execution_context: typing.Union[str, int] = None,
|
|
355
|
-
undo: bool = None,
|
|
356
|
-
allow_path_tokens: typing.Union[bool, typing.Any] = True,
|
|
353
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
354
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
355
|
+
undo: typing.Optional[bool] = None,
|
|
356
|
+
allow_path_tokens: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
357
357
|
filepath: typing.Union[str, typing.Any] = "",
|
|
358
358
|
directory: typing.Union[str, typing.Any] = "",
|
|
359
|
-
files:
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
359
|
+
files: typing.Optional[
|
|
360
|
+
bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
361
|
+
] = None,
|
|
362
|
+
hide_props_region: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
363
|
+
check_existing: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
364
|
+
filter_blender: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
365
|
+
filter_backup: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
366
|
+
filter_image: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
367
|
+
filter_movie: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
368
|
+
filter_python: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
369
|
+
filter_font: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
370
|
+
filter_sound: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
371
|
+
filter_text: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
372
|
+
filter_archive: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
373
|
+
filter_btx: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
374
|
+
filter_collada: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
375
|
+
filter_alembic: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
376
|
+
filter_usd: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
377
|
+
filter_obj: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
378
|
+
filter_volume: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
379
|
+
filter_folder: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
380
|
+
filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
381
|
+
filemode: typing.Optional[typing.Any] = 9,
|
|
382
|
+
relative_path: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
383
|
+
show_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
384
|
+
use_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
385
|
+
display_type: typing.Optional[typing.Any] = "DEFAULT",
|
|
386
|
+
sort_method: typing.Optional[typing.Any] = "",
|
|
387
|
+
use_sequence_detection: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
388
|
+
use_udim_detecting: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
387
389
|
):
|
|
388
390
|
"""Open image
|
|
389
391
|
|
|
390
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
391
|
-
:type execution_context: typing.Union[str, int]
|
|
392
|
-
:type undo: bool
|
|
392
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
393
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
394
|
+
:type undo: typing.Optional[bool]
|
|
393
395
|
:param allow_path_tokens: Allow the path to contain substitution tokens
|
|
394
|
-
:type allow_path_tokens: typing.Union[bool, typing.Any]
|
|
396
|
+
:type allow_path_tokens: typing.Optional[typing.Union[bool, typing.Any]]
|
|
395
397
|
:param filepath: File Path, Path to file
|
|
396
398
|
:type filepath: typing.Union[str, typing.Any]
|
|
397
399
|
:param directory: Directory, Directory of the file
|
|
398
400
|
:type directory: typing.Union[str, typing.Any]
|
|
399
401
|
:param files: Files
|
|
400
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
402
|
+
:type files: typing.Optional[bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]]
|
|
401
403
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
402
|
-
:type hide_props_region: typing.Union[bool, typing.Any]
|
|
404
|
+
:type hide_props_region: typing.Optional[typing.Union[bool, typing.Any]]
|
|
403
405
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
404
|
-
:type check_existing: typing.Union[bool, typing.Any]
|
|
406
|
+
:type check_existing: typing.Optional[typing.Union[bool, typing.Any]]
|
|
405
407
|
:param filter_blender: Filter .blend files
|
|
406
|
-
:type filter_blender: typing.Union[bool, typing.Any]
|
|
408
|
+
:type filter_blender: typing.Optional[typing.Union[bool, typing.Any]]
|
|
407
409
|
:param filter_backup: Filter .blend files
|
|
408
|
-
:type filter_backup: typing.Union[bool, typing.Any]
|
|
410
|
+
:type filter_backup: typing.Optional[typing.Union[bool, typing.Any]]
|
|
409
411
|
:param filter_image: Filter image files
|
|
410
|
-
:type filter_image: typing.Union[bool, typing.Any]
|
|
412
|
+
:type filter_image: typing.Optional[typing.Union[bool, typing.Any]]
|
|
411
413
|
:param filter_movie: Filter movie files
|
|
412
|
-
:type filter_movie: typing.Union[bool, typing.Any]
|
|
414
|
+
:type filter_movie: typing.Optional[typing.Union[bool, typing.Any]]
|
|
413
415
|
:param filter_python: Filter Python files
|
|
414
|
-
:type filter_python: typing.Union[bool, typing.Any]
|
|
416
|
+
:type filter_python: typing.Optional[typing.Union[bool, typing.Any]]
|
|
415
417
|
:param filter_font: Filter font files
|
|
416
|
-
:type filter_font: typing.Union[bool, typing.Any]
|
|
418
|
+
:type filter_font: typing.Optional[typing.Union[bool, typing.Any]]
|
|
417
419
|
:param filter_sound: Filter sound files
|
|
418
|
-
:type filter_sound: typing.Union[bool, typing.Any]
|
|
420
|
+
:type filter_sound: typing.Optional[typing.Union[bool, typing.Any]]
|
|
419
421
|
:param filter_text: Filter text files
|
|
420
|
-
:type filter_text: typing.Union[bool, typing.Any]
|
|
422
|
+
:type filter_text: typing.Optional[typing.Union[bool, typing.Any]]
|
|
421
423
|
:param filter_archive: Filter archive files
|
|
422
|
-
:type filter_archive: typing.Union[bool, typing.Any]
|
|
424
|
+
:type filter_archive: typing.Optional[typing.Union[bool, typing.Any]]
|
|
423
425
|
:param filter_btx: Filter btx files
|
|
424
|
-
:type filter_btx: typing.Union[bool, typing.Any]
|
|
426
|
+
:type filter_btx: typing.Optional[typing.Union[bool, typing.Any]]
|
|
425
427
|
:param filter_collada: Filter COLLADA files
|
|
426
|
-
:type filter_collada: typing.Union[bool, typing.Any]
|
|
428
|
+
:type filter_collada: typing.Optional[typing.Union[bool, typing.Any]]
|
|
427
429
|
:param filter_alembic: Filter Alembic files
|
|
428
|
-
:type filter_alembic: typing.Union[bool, typing.Any]
|
|
430
|
+
:type filter_alembic: typing.Optional[typing.Union[bool, typing.Any]]
|
|
429
431
|
:param filter_usd: Filter USD files
|
|
430
|
-
:type filter_usd: typing.Union[bool, typing.Any]
|
|
432
|
+
:type filter_usd: typing.Optional[typing.Union[bool, typing.Any]]
|
|
431
433
|
:param filter_obj: Filter OBJ files
|
|
432
|
-
:type filter_obj: typing.Union[bool, typing.Any]
|
|
434
|
+
:type filter_obj: typing.Optional[typing.Union[bool, typing.Any]]
|
|
433
435
|
:param filter_volume: Filter OpenVDB volume files
|
|
434
|
-
:type filter_volume: typing.Union[bool, typing.Any]
|
|
436
|
+
:type filter_volume: typing.Optional[typing.Union[bool, typing.Any]]
|
|
435
437
|
:param filter_folder: Filter folders
|
|
436
|
-
:type filter_folder: typing.Union[bool, typing.Any]
|
|
438
|
+
:type filter_folder: typing.Optional[typing.Union[bool, typing.Any]]
|
|
437
439
|
:param filter_blenlib: Filter Blender IDs
|
|
438
|
-
:type filter_blenlib: typing.Union[bool, typing.Any]
|
|
440
|
+
:type filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]]
|
|
439
441
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
440
|
-
:type filemode: typing.Any
|
|
442
|
+
:type filemode: typing.Optional[typing.Any]
|
|
441
443
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
442
|
-
:type relative_path: typing.Union[bool, typing.Any]
|
|
444
|
+
:type relative_path: typing.Optional[typing.Union[bool, typing.Any]]
|
|
443
445
|
:param show_multiview: Enable Multi-View
|
|
444
|
-
:type show_multiview: typing.Union[bool, typing.Any]
|
|
446
|
+
:type show_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
445
447
|
:param use_multiview: Use Multi-View
|
|
446
|
-
:type use_multiview: typing.Union[bool, typing.Any]
|
|
448
|
+
:type use_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
447
449
|
:param display_type: Display Type
|
|
448
450
|
|
|
449
451
|
DEFAULT
|
|
@@ -457,7 +459,7 @@ def open(
|
|
|
457
459
|
|
|
458
460
|
THUMBNAIL
|
|
459
461
|
Thumbnails -- Display files as thumbnails.
|
|
460
|
-
:type display_type: typing.Any
|
|
462
|
+
:type display_type: typing.Optional[typing.Any]
|
|
461
463
|
:param sort_method: File sorting mode
|
|
462
464
|
|
|
463
465
|
DEFAULT
|
|
@@ -474,212 +476,212 @@ def open(
|
|
|
474
476
|
|
|
475
477
|
FILE_SORT_SIZE
|
|
476
478
|
Size -- Sort files by size.
|
|
477
|
-
:type sort_method: typing.Any
|
|
479
|
+
:type sort_method: typing.Optional[typing.Any]
|
|
478
480
|
:param use_sequence_detection: Detect Sequences, Automatically detect animated sequences in selected images (based on file names)
|
|
479
|
-
:type use_sequence_detection: typing.Union[bool, typing.Any]
|
|
481
|
+
:type use_sequence_detection: typing.Optional[typing.Union[bool, typing.Any]]
|
|
480
482
|
:param use_udim_detecting: Detect UDIMs, Detect selected UDIM files and load all matching tiles
|
|
481
|
-
:type use_udim_detecting: typing.Union[bool, typing.Any]
|
|
483
|
+
:type use_udim_detecting: typing.Optional[typing.Union[bool, typing.Any]]
|
|
482
484
|
"""
|
|
483
485
|
|
|
484
486
|
...
|
|
485
487
|
|
|
486
488
|
def pack(
|
|
487
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
488
|
-
execution_context: typing.Union[str, int] = None,
|
|
489
|
-
undo: bool = None,
|
|
489
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
490
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
491
|
+
undo: typing.Optional[bool] = None,
|
|
490
492
|
):
|
|
491
493
|
"""Pack an image as embedded data into the .blend file
|
|
492
494
|
|
|
493
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
494
|
-
:type execution_context: typing.Union[str, int]
|
|
495
|
-
:type undo: bool
|
|
495
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
496
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
497
|
+
:type undo: typing.Optional[bool]
|
|
496
498
|
"""
|
|
497
499
|
|
|
498
500
|
...
|
|
499
501
|
|
|
500
502
|
def project_apply(
|
|
501
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
502
|
-
execution_context: typing.Union[str, int] = None,
|
|
503
|
-
undo: bool = None,
|
|
503
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
504
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
505
|
+
undo: typing.Optional[bool] = None,
|
|
504
506
|
):
|
|
505
507
|
"""Project edited image back onto the object
|
|
506
508
|
|
|
507
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
508
|
-
:type execution_context: typing.Union[str, int]
|
|
509
|
-
:type undo: bool
|
|
509
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
510
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
511
|
+
:type undo: typing.Optional[bool]
|
|
510
512
|
"""
|
|
511
513
|
|
|
512
514
|
...
|
|
513
515
|
|
|
514
516
|
def project_edit(
|
|
515
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
516
|
-
execution_context: typing.Union[str, int] = None,
|
|
517
|
-
undo: bool = None,
|
|
517
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
518
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
519
|
+
undo: typing.Optional[bool] = None,
|
|
518
520
|
):
|
|
519
521
|
"""Edit a snapshot of the 3D Viewport in an external image editor
|
|
520
522
|
|
|
521
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
522
|
-
:type execution_context: typing.Union[str, int]
|
|
523
|
-
:type undo: bool
|
|
523
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
524
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
525
|
+
:type undo: typing.Optional[bool]
|
|
524
526
|
"""
|
|
525
527
|
|
|
526
528
|
...
|
|
527
529
|
|
|
528
530
|
def read_viewlayers(
|
|
529
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
530
|
-
execution_context: typing.Union[str, int] = None,
|
|
531
|
-
undo: bool = None,
|
|
531
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
532
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
533
|
+
undo: typing.Optional[bool] = None,
|
|
532
534
|
):
|
|
533
535
|
"""Read all the current scene's view layers from cache, as needed
|
|
534
536
|
|
|
535
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
536
|
-
:type execution_context: typing.Union[str, int]
|
|
537
|
-
:type undo: bool
|
|
537
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
538
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
539
|
+
:type undo: typing.Optional[bool]
|
|
538
540
|
"""
|
|
539
541
|
|
|
540
542
|
...
|
|
541
543
|
|
|
542
544
|
def reload(
|
|
543
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
544
|
-
execution_context: typing.Union[str, int] = None,
|
|
545
|
-
undo: bool = None,
|
|
545
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
546
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
547
|
+
undo: typing.Optional[bool] = None,
|
|
546
548
|
):
|
|
547
549
|
"""Reload current image from disk
|
|
548
550
|
|
|
549
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
550
|
-
:type execution_context: typing.Union[str, int]
|
|
551
|
-
:type undo: bool
|
|
551
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
552
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
553
|
+
:type undo: typing.Optional[bool]
|
|
552
554
|
"""
|
|
553
555
|
|
|
554
556
|
...
|
|
555
557
|
|
|
556
558
|
def remove_render_slot(
|
|
557
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
558
|
-
execution_context: typing.Union[str, int] = None,
|
|
559
|
-
undo: bool = None,
|
|
559
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
560
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
561
|
+
undo: typing.Optional[bool] = None,
|
|
560
562
|
):
|
|
561
563
|
"""Remove the current render slot
|
|
562
564
|
|
|
563
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
564
|
-
:type execution_context: typing.Union[str, int]
|
|
565
|
-
:type undo: bool
|
|
565
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
566
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
567
|
+
:type undo: typing.Optional[bool]
|
|
566
568
|
"""
|
|
567
569
|
|
|
568
570
|
...
|
|
569
571
|
|
|
570
572
|
def render_border(
|
|
571
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
572
|
-
execution_context: typing.Union[str, int] = None,
|
|
573
|
-
undo: bool = None,
|
|
574
|
-
xmin: typing.Any = 0,
|
|
575
|
-
xmax: typing.Any = 0,
|
|
576
|
-
ymin: typing.Any = 0,
|
|
577
|
-
ymax: typing.Any = 0,
|
|
578
|
-
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
573
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
574
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
575
|
+
undo: typing.Optional[bool] = None,
|
|
576
|
+
xmin: typing.Optional[typing.Any] = 0,
|
|
577
|
+
xmax: typing.Optional[typing.Any] = 0,
|
|
578
|
+
ymin: typing.Optional[typing.Any] = 0,
|
|
579
|
+
ymax: typing.Optional[typing.Any] = 0,
|
|
580
|
+
wait_for_input: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
579
581
|
):
|
|
580
582
|
"""Set the boundaries of the render region and enable render region
|
|
581
583
|
|
|
582
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
583
|
-
:type execution_context: typing.Union[str, int]
|
|
584
|
-
:type undo: bool
|
|
584
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
585
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
586
|
+
:type undo: typing.Optional[bool]
|
|
585
587
|
:param xmin: X Min
|
|
586
|
-
:type xmin: typing.Any
|
|
588
|
+
:type xmin: typing.Optional[typing.Any]
|
|
587
589
|
:param xmax: X Max
|
|
588
|
-
:type xmax: typing.Any
|
|
590
|
+
:type xmax: typing.Optional[typing.Any]
|
|
589
591
|
:param ymin: Y Min
|
|
590
|
-
:type ymin: typing.Any
|
|
592
|
+
:type ymin: typing.Optional[typing.Any]
|
|
591
593
|
:param ymax: Y Max
|
|
592
|
-
:type ymax: typing.Any
|
|
594
|
+
:type ymax: typing.Optional[typing.Any]
|
|
593
595
|
:param wait_for_input: Wait for Input
|
|
594
|
-
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
596
|
+
:type wait_for_input: typing.Optional[typing.Union[bool, typing.Any]]
|
|
595
597
|
"""
|
|
596
598
|
|
|
597
599
|
...
|
|
598
600
|
|
|
599
601
|
def replace(
|
|
600
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
601
|
-
execution_context: typing.Union[str, int] = None,
|
|
602
|
-
undo: bool = None,
|
|
602
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
603
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
604
|
+
undo: typing.Optional[bool] = None,
|
|
603
605
|
filepath: typing.Union[str, typing.Any] = "",
|
|
604
|
-
hide_props_region: typing.Union[bool, typing.Any] = True,
|
|
605
|
-
check_existing: typing.Union[bool, typing.Any] = False,
|
|
606
|
-
filter_blender: typing.Union[bool, typing.Any] = False,
|
|
607
|
-
filter_backup: typing.Union[bool, typing.Any] = False,
|
|
608
|
-
filter_image: typing.Union[bool, typing.Any] = True,
|
|
609
|
-
filter_movie: typing.Union[bool, typing.Any] = True,
|
|
610
|
-
filter_python: typing.Union[bool, typing.Any] = False,
|
|
611
|
-
filter_font: typing.Union[bool, typing.Any] = False,
|
|
612
|
-
filter_sound: typing.Union[bool, typing.Any] = False,
|
|
613
|
-
filter_text: typing.Union[bool, typing.Any] = False,
|
|
614
|
-
filter_archive: typing.Union[bool, typing.Any] = False,
|
|
615
|
-
filter_btx: typing.Union[bool, typing.Any] = False,
|
|
616
|
-
filter_collada: typing.Union[bool, typing.Any] = False,
|
|
617
|
-
filter_alembic: typing.Union[bool, typing.Any] = False,
|
|
618
|
-
filter_usd: typing.Union[bool, typing.Any] = False,
|
|
619
|
-
filter_obj: typing.Union[bool, typing.Any] = False,
|
|
620
|
-
filter_volume: typing.Union[bool, typing.Any] = False,
|
|
621
|
-
filter_folder: typing.Union[bool, typing.Any] = True,
|
|
622
|
-
filter_blenlib: typing.Union[bool, typing.Any] = False,
|
|
623
|
-
filemode: typing.Any = 9,
|
|
624
|
-
relative_path: typing.Union[bool, typing.Any] = True,
|
|
625
|
-
show_multiview: typing.Union[bool, typing.Any] = False,
|
|
626
|
-
use_multiview: typing.Union[bool, typing.Any] = False,
|
|
627
|
-
display_type: typing.Any = "DEFAULT",
|
|
628
|
-
sort_method: typing.Union[str, int, typing.Any] = "",
|
|
606
|
+
hide_props_region: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
607
|
+
check_existing: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
608
|
+
filter_blender: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
609
|
+
filter_backup: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
610
|
+
filter_image: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
611
|
+
filter_movie: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
612
|
+
filter_python: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
613
|
+
filter_font: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
614
|
+
filter_sound: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
615
|
+
filter_text: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
616
|
+
filter_archive: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
617
|
+
filter_btx: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
618
|
+
filter_collada: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
619
|
+
filter_alembic: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
620
|
+
filter_usd: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
621
|
+
filter_obj: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
622
|
+
filter_volume: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
623
|
+
filter_folder: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
624
|
+
filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
625
|
+
filemode: typing.Optional[typing.Any] = 9,
|
|
626
|
+
relative_path: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
627
|
+
show_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
628
|
+
use_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
629
|
+
display_type: typing.Optional[typing.Any] = "DEFAULT",
|
|
630
|
+
sort_method: typing.Optional[typing.Union[str, int, typing.Any]] = "",
|
|
629
631
|
):
|
|
630
632
|
"""Replace current image by another one from disk
|
|
631
633
|
|
|
632
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
633
|
-
:type execution_context: typing.Union[str, int]
|
|
634
|
-
:type undo: bool
|
|
634
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
635
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
636
|
+
:type undo: typing.Optional[bool]
|
|
635
637
|
:param filepath: File Path, Path to file
|
|
636
638
|
:type filepath: typing.Union[str, typing.Any]
|
|
637
639
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
638
|
-
:type hide_props_region: typing.Union[bool, typing.Any]
|
|
640
|
+
:type hide_props_region: typing.Optional[typing.Union[bool, typing.Any]]
|
|
639
641
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
640
|
-
:type check_existing: typing.Union[bool, typing.Any]
|
|
642
|
+
:type check_existing: typing.Optional[typing.Union[bool, typing.Any]]
|
|
641
643
|
:param filter_blender: Filter .blend files
|
|
642
|
-
:type filter_blender: typing.Union[bool, typing.Any]
|
|
644
|
+
:type filter_blender: typing.Optional[typing.Union[bool, typing.Any]]
|
|
643
645
|
:param filter_backup: Filter .blend files
|
|
644
|
-
:type filter_backup: typing.Union[bool, typing.Any]
|
|
646
|
+
:type filter_backup: typing.Optional[typing.Union[bool, typing.Any]]
|
|
645
647
|
:param filter_image: Filter image files
|
|
646
|
-
:type filter_image: typing.Union[bool, typing.Any]
|
|
648
|
+
:type filter_image: typing.Optional[typing.Union[bool, typing.Any]]
|
|
647
649
|
:param filter_movie: Filter movie files
|
|
648
|
-
:type filter_movie: typing.Union[bool, typing.Any]
|
|
650
|
+
:type filter_movie: typing.Optional[typing.Union[bool, typing.Any]]
|
|
649
651
|
:param filter_python: Filter Python files
|
|
650
|
-
:type filter_python: typing.Union[bool, typing.Any]
|
|
652
|
+
:type filter_python: typing.Optional[typing.Union[bool, typing.Any]]
|
|
651
653
|
:param filter_font: Filter font files
|
|
652
|
-
:type filter_font: typing.Union[bool, typing.Any]
|
|
654
|
+
:type filter_font: typing.Optional[typing.Union[bool, typing.Any]]
|
|
653
655
|
:param filter_sound: Filter sound files
|
|
654
|
-
:type filter_sound: typing.Union[bool, typing.Any]
|
|
656
|
+
:type filter_sound: typing.Optional[typing.Union[bool, typing.Any]]
|
|
655
657
|
:param filter_text: Filter text files
|
|
656
|
-
:type filter_text: typing.Union[bool, typing.Any]
|
|
658
|
+
:type filter_text: typing.Optional[typing.Union[bool, typing.Any]]
|
|
657
659
|
:param filter_archive: Filter archive files
|
|
658
|
-
:type filter_archive: typing.Union[bool, typing.Any]
|
|
660
|
+
:type filter_archive: typing.Optional[typing.Union[bool, typing.Any]]
|
|
659
661
|
:param filter_btx: Filter btx files
|
|
660
|
-
:type filter_btx: typing.Union[bool, typing.Any]
|
|
662
|
+
:type filter_btx: typing.Optional[typing.Union[bool, typing.Any]]
|
|
661
663
|
:param filter_collada: Filter COLLADA files
|
|
662
|
-
:type filter_collada: typing.Union[bool, typing.Any]
|
|
664
|
+
:type filter_collada: typing.Optional[typing.Union[bool, typing.Any]]
|
|
663
665
|
:param filter_alembic: Filter Alembic files
|
|
664
|
-
:type filter_alembic: typing.Union[bool, typing.Any]
|
|
666
|
+
:type filter_alembic: typing.Optional[typing.Union[bool, typing.Any]]
|
|
665
667
|
:param filter_usd: Filter USD files
|
|
666
|
-
:type filter_usd: typing.Union[bool, typing.Any]
|
|
668
|
+
:type filter_usd: typing.Optional[typing.Union[bool, typing.Any]]
|
|
667
669
|
:param filter_obj: Filter OBJ files
|
|
668
|
-
:type filter_obj: typing.Union[bool, typing.Any]
|
|
670
|
+
:type filter_obj: typing.Optional[typing.Union[bool, typing.Any]]
|
|
669
671
|
:param filter_volume: Filter OpenVDB volume files
|
|
670
|
-
:type filter_volume: typing.Union[bool, typing.Any]
|
|
672
|
+
:type filter_volume: typing.Optional[typing.Union[bool, typing.Any]]
|
|
671
673
|
:param filter_folder: Filter folders
|
|
672
|
-
:type filter_folder: typing.Union[bool, typing.Any]
|
|
674
|
+
:type filter_folder: typing.Optional[typing.Union[bool, typing.Any]]
|
|
673
675
|
:param filter_blenlib: Filter Blender IDs
|
|
674
|
-
:type filter_blenlib: typing.Union[bool, typing.Any]
|
|
676
|
+
:type filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]]
|
|
675
677
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
676
|
-
:type filemode: typing.Any
|
|
678
|
+
:type filemode: typing.Optional[typing.Any]
|
|
677
679
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
678
|
-
:type relative_path: typing.Union[bool, typing.Any]
|
|
680
|
+
:type relative_path: typing.Optional[typing.Union[bool, typing.Any]]
|
|
679
681
|
:param show_multiview: Enable Multi-View
|
|
680
|
-
:type show_multiview: typing.Union[bool, typing.Any]
|
|
682
|
+
:type show_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
681
683
|
:param use_multiview: Use Multi-View
|
|
682
|
-
:type use_multiview: typing.Union[bool, typing.Any]
|
|
684
|
+
:type use_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
683
685
|
:param display_type: Display Type
|
|
684
686
|
|
|
685
687
|
DEFAULT
|
|
@@ -693,41 +695,41 @@ def replace(
|
|
|
693
695
|
|
|
694
696
|
THUMBNAIL
|
|
695
697
|
Thumbnails -- Display files as thumbnails.
|
|
696
|
-
:type display_type: typing.Any
|
|
698
|
+
:type display_type: typing.Optional[typing.Any]
|
|
697
699
|
:param sort_method: File sorting mode
|
|
698
|
-
:type sort_method: typing.Union[str, int, typing.Any]
|
|
700
|
+
:type sort_method: typing.Optional[typing.Union[str, int, typing.Any]]
|
|
699
701
|
"""
|
|
700
702
|
|
|
701
703
|
...
|
|
702
704
|
|
|
703
705
|
def resize(
|
|
704
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
705
|
-
execution_context: typing.Union[str, int] = None,
|
|
706
|
-
undo: bool = None,
|
|
707
|
-
size: typing.Any = (0, 0),
|
|
706
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
707
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
708
|
+
undo: typing.Optional[bool] = None,
|
|
709
|
+
size: typing.Optional[typing.Any] = (0, 0),
|
|
708
710
|
):
|
|
709
711
|
"""Resize the image
|
|
710
712
|
|
|
711
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
712
|
-
:type execution_context: typing.Union[str, int]
|
|
713
|
-
:type undo: bool
|
|
713
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
714
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
715
|
+
:type undo: typing.Optional[bool]
|
|
714
716
|
:param size: Size
|
|
715
|
-
:type size: typing.Any
|
|
717
|
+
:type size: typing.Optional[typing.Any]
|
|
716
718
|
"""
|
|
717
719
|
|
|
718
720
|
...
|
|
719
721
|
|
|
720
722
|
def rotate_orthogonal(
|
|
721
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
722
|
-
execution_context: typing.Union[str, int] = None,
|
|
723
|
-
undo: bool = None,
|
|
724
|
-
degrees: typing.Any = "90",
|
|
723
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
724
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
725
|
+
undo: typing.Optional[bool] = None,
|
|
726
|
+
degrees: typing.Optional[typing.Any] = "90",
|
|
725
727
|
):
|
|
726
728
|
"""Rotate the image
|
|
727
729
|
|
|
728
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
729
|
-
:type execution_context: typing.Union[str, int]
|
|
730
|
-
:type undo: bool
|
|
730
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
731
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
732
|
+
:type undo: typing.Optional[bool]
|
|
731
733
|
:param degrees: Degrees, Amount of rotation in degrees (90, 180, 270)
|
|
732
734
|
|
|
733
735
|
90
|
|
@@ -738,178 +740,178 @@ def rotate_orthogonal(
|
|
|
738
740
|
|
|
739
741
|
270
|
|
740
742
|
270 Degrees -- Rotate 270 degrees clockwise.
|
|
741
|
-
:type degrees: typing.Any
|
|
743
|
+
:type degrees: typing.Optional[typing.Any]
|
|
742
744
|
"""
|
|
743
745
|
|
|
744
746
|
...
|
|
745
747
|
|
|
746
748
|
def sample(
|
|
747
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
748
|
-
execution_context: typing.Union[str, int] = None,
|
|
749
|
-
undo: bool = None,
|
|
750
|
-
size: typing.Any = 1,
|
|
749
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
750
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
751
|
+
undo: typing.Optional[bool] = None,
|
|
752
|
+
size: typing.Optional[typing.Any] = 1,
|
|
751
753
|
):
|
|
752
754
|
"""Use mouse to sample a color in current image
|
|
753
755
|
|
|
754
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
755
|
-
:type execution_context: typing.Union[str, int]
|
|
756
|
-
:type undo: bool
|
|
756
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
757
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
758
|
+
:type undo: typing.Optional[bool]
|
|
757
759
|
:param size: Sample Size
|
|
758
|
-
:type size: typing.Any
|
|
760
|
+
:type size: typing.Optional[typing.Any]
|
|
759
761
|
"""
|
|
760
762
|
|
|
761
763
|
...
|
|
762
764
|
|
|
763
765
|
def sample_line(
|
|
764
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
765
|
-
execution_context: typing.Union[str, int] = None,
|
|
766
|
-
undo: bool = None,
|
|
767
|
-
xstart: typing.Any = 0,
|
|
768
|
-
xend: typing.Any = 0,
|
|
769
|
-
ystart: typing.Any = 0,
|
|
770
|
-
yend: typing.Any = 0,
|
|
771
|
-
flip: typing.Union[bool, typing.Any] = False,
|
|
772
|
-
cursor: typing.Any = 5,
|
|
766
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
767
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
768
|
+
undo: typing.Optional[bool] = None,
|
|
769
|
+
xstart: typing.Optional[typing.Any] = 0,
|
|
770
|
+
xend: typing.Optional[typing.Any] = 0,
|
|
771
|
+
ystart: typing.Optional[typing.Any] = 0,
|
|
772
|
+
yend: typing.Optional[typing.Any] = 0,
|
|
773
|
+
flip: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
774
|
+
cursor: typing.Optional[typing.Any] = 5,
|
|
773
775
|
):
|
|
774
776
|
"""Sample a line and show it in Scope panels
|
|
775
777
|
|
|
776
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
777
|
-
:type execution_context: typing.Union[str, int]
|
|
778
|
-
:type undo: bool
|
|
778
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
779
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
780
|
+
:type undo: typing.Optional[bool]
|
|
779
781
|
:param xstart: X Start
|
|
780
|
-
:type xstart: typing.Any
|
|
782
|
+
:type xstart: typing.Optional[typing.Any]
|
|
781
783
|
:param xend: X End
|
|
782
|
-
:type xend: typing.Any
|
|
784
|
+
:type xend: typing.Optional[typing.Any]
|
|
783
785
|
:param ystart: Y Start
|
|
784
|
-
:type ystart: typing.Any
|
|
786
|
+
:type ystart: typing.Optional[typing.Any]
|
|
785
787
|
:param yend: Y End
|
|
786
|
-
:type yend: typing.Any
|
|
788
|
+
:type yend: typing.Optional[typing.Any]
|
|
787
789
|
:param flip: Flip
|
|
788
|
-
:type flip: typing.Union[bool, typing.Any]
|
|
790
|
+
:type flip: typing.Optional[typing.Union[bool, typing.Any]]
|
|
789
791
|
:param cursor: Cursor, Mouse cursor style to use during the modal operator
|
|
790
|
-
:type cursor: typing.Any
|
|
792
|
+
:type cursor: typing.Optional[typing.Any]
|
|
791
793
|
"""
|
|
792
794
|
|
|
793
795
|
...
|
|
794
796
|
|
|
795
797
|
def save(
|
|
796
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
797
|
-
execution_context: typing.Union[str, int] = None,
|
|
798
|
-
undo: bool = None,
|
|
798
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
799
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
800
|
+
undo: typing.Optional[bool] = None,
|
|
799
801
|
):
|
|
800
802
|
"""Save the image with current name and settings
|
|
801
803
|
|
|
802
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
803
|
-
:type execution_context: typing.Union[str, int]
|
|
804
|
-
:type undo: bool
|
|
804
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
805
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
806
|
+
:type undo: typing.Optional[bool]
|
|
805
807
|
"""
|
|
806
808
|
|
|
807
809
|
...
|
|
808
810
|
|
|
809
811
|
def save_all_modified(
|
|
810
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
811
|
-
execution_context: typing.Union[str, int] = None,
|
|
812
|
-
undo: bool = None,
|
|
812
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
813
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
814
|
+
undo: typing.Optional[bool] = None,
|
|
813
815
|
):
|
|
814
816
|
"""Save all modified images
|
|
815
817
|
|
|
816
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
817
|
-
:type execution_context: typing.Union[str, int]
|
|
818
|
-
:type undo: bool
|
|
818
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
819
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
820
|
+
:type undo: typing.Optional[bool]
|
|
819
821
|
"""
|
|
820
822
|
|
|
821
823
|
...
|
|
822
824
|
|
|
823
825
|
def save_as(
|
|
824
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
825
|
-
execution_context: typing.Union[str, int] = None,
|
|
826
|
-
undo: bool = None,
|
|
827
|
-
save_as_render: typing.Union[bool, typing.Any] = False,
|
|
828
|
-
copy: typing.Union[bool, typing.Any] = False,
|
|
829
|
-
allow_path_tokens: typing.Union[bool, typing.Any] = True,
|
|
826
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
827
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
828
|
+
undo: typing.Optional[bool] = None,
|
|
829
|
+
save_as_render: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
830
|
+
copy: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
831
|
+
allow_path_tokens: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
830
832
|
filepath: typing.Union[str, typing.Any] = "",
|
|
831
|
-
check_existing: typing.Union[bool, typing.Any] = True,
|
|
832
|
-
filter_blender: typing.Union[bool, typing.Any] = False,
|
|
833
|
-
filter_backup: typing.Union[bool, typing.Any] = False,
|
|
834
|
-
filter_image: typing.Union[bool, typing.Any] = True,
|
|
835
|
-
filter_movie: typing.Union[bool, typing.Any] = True,
|
|
836
|
-
filter_python: typing.Union[bool, typing.Any] = False,
|
|
837
|
-
filter_font: typing.Union[bool, typing.Any] = False,
|
|
838
|
-
filter_sound: typing.Union[bool, typing.Any] = False,
|
|
839
|
-
filter_text: typing.Union[bool, typing.Any] = False,
|
|
840
|
-
filter_archive: typing.Union[bool, typing.Any] = False,
|
|
841
|
-
filter_btx: typing.Union[bool, typing.Any] = False,
|
|
842
|
-
filter_collada: typing.Union[bool, typing.Any] = False,
|
|
843
|
-
filter_alembic: typing.Union[bool, typing.Any] = False,
|
|
844
|
-
filter_usd: typing.Union[bool, typing.Any] = False,
|
|
845
|
-
filter_obj: typing.Union[bool, typing.Any] = False,
|
|
846
|
-
filter_volume: typing.Union[bool, typing.Any] = False,
|
|
847
|
-
filter_folder: typing.Union[bool, typing.Any] = True,
|
|
848
|
-
filter_blenlib: typing.Union[bool, typing.Any] = False,
|
|
849
|
-
filemode: typing.Any = 9,
|
|
850
|
-
relative_path: typing.Union[bool, typing.Any] = True,
|
|
851
|
-
show_multiview: typing.Union[bool, typing.Any] = False,
|
|
852
|
-
use_multiview: typing.Union[bool, typing.Any] = False,
|
|
853
|
-
display_type: typing.Any = "DEFAULT",
|
|
854
|
-
sort_method: typing.Union[str, int, typing.Any] = "",
|
|
833
|
+
check_existing: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
834
|
+
filter_blender: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
835
|
+
filter_backup: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
836
|
+
filter_image: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
837
|
+
filter_movie: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
838
|
+
filter_python: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
839
|
+
filter_font: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
840
|
+
filter_sound: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
841
|
+
filter_text: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
842
|
+
filter_archive: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
843
|
+
filter_btx: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
844
|
+
filter_collada: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
845
|
+
filter_alembic: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
846
|
+
filter_usd: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
847
|
+
filter_obj: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
848
|
+
filter_volume: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
849
|
+
filter_folder: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
850
|
+
filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
851
|
+
filemode: typing.Optional[typing.Any] = 9,
|
|
852
|
+
relative_path: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
853
|
+
show_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
854
|
+
use_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
855
|
+
display_type: typing.Optional[typing.Any] = "DEFAULT",
|
|
856
|
+
sort_method: typing.Optional[typing.Union[str, int, typing.Any]] = "",
|
|
855
857
|
):
|
|
856
858
|
"""Save the image with another name and/or settings
|
|
857
859
|
|
|
858
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
859
|
-
:type execution_context: typing.Union[str, int]
|
|
860
|
-
:type undo: bool
|
|
860
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
861
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
862
|
+
:type undo: typing.Optional[bool]
|
|
861
863
|
: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
|
|
862
|
-
:type save_as_render: typing.Union[bool, typing.Any]
|
|
864
|
+
:type save_as_render: typing.Optional[typing.Union[bool, typing.Any]]
|
|
863
865
|
:param copy: Copy, Create a new image file without modifying the current image in Blender
|
|
864
|
-
:type copy: typing.Union[bool, typing.Any]
|
|
866
|
+
:type copy: typing.Optional[typing.Union[bool, typing.Any]]
|
|
865
867
|
:param allow_path_tokens: Allow the path to contain substitution tokens
|
|
866
|
-
:type allow_path_tokens: typing.Union[bool, typing.Any]
|
|
868
|
+
:type allow_path_tokens: typing.Optional[typing.Union[bool, typing.Any]]
|
|
867
869
|
:param filepath: File Path, Path to file
|
|
868
870
|
:type filepath: typing.Union[str, typing.Any]
|
|
869
871
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
870
|
-
:type check_existing: typing.Union[bool, typing.Any]
|
|
872
|
+
:type check_existing: typing.Optional[typing.Union[bool, typing.Any]]
|
|
871
873
|
:param filter_blender: Filter .blend files
|
|
872
|
-
:type filter_blender: typing.Union[bool, typing.Any]
|
|
874
|
+
:type filter_blender: typing.Optional[typing.Union[bool, typing.Any]]
|
|
873
875
|
:param filter_backup: Filter .blend files
|
|
874
|
-
:type filter_backup: typing.Union[bool, typing.Any]
|
|
876
|
+
:type filter_backup: typing.Optional[typing.Union[bool, typing.Any]]
|
|
875
877
|
:param filter_image: Filter image files
|
|
876
|
-
:type filter_image: typing.Union[bool, typing.Any]
|
|
878
|
+
:type filter_image: typing.Optional[typing.Union[bool, typing.Any]]
|
|
877
879
|
:param filter_movie: Filter movie files
|
|
878
|
-
:type filter_movie: typing.Union[bool, typing.Any]
|
|
880
|
+
:type filter_movie: typing.Optional[typing.Union[bool, typing.Any]]
|
|
879
881
|
:param filter_python: Filter Python files
|
|
880
|
-
:type filter_python: typing.Union[bool, typing.Any]
|
|
882
|
+
:type filter_python: typing.Optional[typing.Union[bool, typing.Any]]
|
|
881
883
|
:param filter_font: Filter font files
|
|
882
|
-
:type filter_font: typing.Union[bool, typing.Any]
|
|
884
|
+
:type filter_font: typing.Optional[typing.Union[bool, typing.Any]]
|
|
883
885
|
:param filter_sound: Filter sound files
|
|
884
|
-
:type filter_sound: typing.Union[bool, typing.Any]
|
|
886
|
+
:type filter_sound: typing.Optional[typing.Union[bool, typing.Any]]
|
|
885
887
|
:param filter_text: Filter text files
|
|
886
|
-
:type filter_text: typing.Union[bool, typing.Any]
|
|
888
|
+
:type filter_text: typing.Optional[typing.Union[bool, typing.Any]]
|
|
887
889
|
:param filter_archive: Filter archive files
|
|
888
|
-
:type filter_archive: typing.Union[bool, typing.Any]
|
|
890
|
+
:type filter_archive: typing.Optional[typing.Union[bool, typing.Any]]
|
|
889
891
|
:param filter_btx: Filter btx files
|
|
890
|
-
:type filter_btx: typing.Union[bool, typing.Any]
|
|
892
|
+
:type filter_btx: typing.Optional[typing.Union[bool, typing.Any]]
|
|
891
893
|
:param filter_collada: Filter COLLADA files
|
|
892
|
-
:type filter_collada: typing.Union[bool, typing.Any]
|
|
894
|
+
:type filter_collada: typing.Optional[typing.Union[bool, typing.Any]]
|
|
893
895
|
:param filter_alembic: Filter Alembic files
|
|
894
|
-
:type filter_alembic: typing.Union[bool, typing.Any]
|
|
896
|
+
:type filter_alembic: typing.Optional[typing.Union[bool, typing.Any]]
|
|
895
897
|
:param filter_usd: Filter USD files
|
|
896
|
-
:type filter_usd: typing.Union[bool, typing.Any]
|
|
898
|
+
:type filter_usd: typing.Optional[typing.Union[bool, typing.Any]]
|
|
897
899
|
:param filter_obj: Filter OBJ files
|
|
898
|
-
:type filter_obj: typing.Union[bool, typing.Any]
|
|
900
|
+
:type filter_obj: typing.Optional[typing.Union[bool, typing.Any]]
|
|
899
901
|
:param filter_volume: Filter OpenVDB volume files
|
|
900
|
-
:type filter_volume: typing.Union[bool, typing.Any]
|
|
902
|
+
:type filter_volume: typing.Optional[typing.Union[bool, typing.Any]]
|
|
901
903
|
:param filter_folder: Filter folders
|
|
902
|
-
:type filter_folder: typing.Union[bool, typing.Any]
|
|
904
|
+
:type filter_folder: typing.Optional[typing.Union[bool, typing.Any]]
|
|
903
905
|
:param filter_blenlib: Filter Blender IDs
|
|
904
|
-
:type filter_blenlib: typing.Union[bool, typing.Any]
|
|
906
|
+
:type filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]]
|
|
905
907
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
906
|
-
:type filemode: typing.Any
|
|
908
|
+
:type filemode: typing.Optional[typing.Any]
|
|
907
909
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
908
|
-
:type relative_path: typing.Union[bool, typing.Any]
|
|
910
|
+
:type relative_path: typing.Optional[typing.Union[bool, typing.Any]]
|
|
909
911
|
:param show_multiview: Enable Multi-View
|
|
910
|
-
:type show_multiview: typing.Union[bool, typing.Any]
|
|
912
|
+
:type show_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
911
913
|
:param use_multiview: Use Multi-View
|
|
912
|
-
:type use_multiview: typing.Union[bool, typing.Any]
|
|
914
|
+
:type use_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
913
915
|
:param display_type: Display Type
|
|
914
916
|
|
|
915
917
|
DEFAULT
|
|
@@ -923,131 +925,131 @@ def save_as(
|
|
|
923
925
|
|
|
924
926
|
THUMBNAIL
|
|
925
927
|
Thumbnails -- Display files as thumbnails.
|
|
926
|
-
:type display_type: typing.Any
|
|
928
|
+
:type display_type: typing.Optional[typing.Any]
|
|
927
929
|
:param sort_method: File sorting mode
|
|
928
|
-
:type sort_method: typing.Union[str, int, typing.Any]
|
|
930
|
+
:type sort_method: typing.Optional[typing.Union[str, int, typing.Any]]
|
|
929
931
|
"""
|
|
930
932
|
|
|
931
933
|
...
|
|
932
934
|
|
|
933
935
|
def save_sequence(
|
|
934
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
935
|
-
execution_context: typing.Union[str, int] = None,
|
|
936
|
-
undo: bool = None,
|
|
936
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
937
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
938
|
+
undo: typing.Optional[bool] = None,
|
|
937
939
|
):
|
|
938
940
|
"""Save a sequence of images
|
|
939
941
|
|
|
940
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
941
|
-
:type execution_context: typing.Union[str, int]
|
|
942
|
-
:type undo: bool
|
|
942
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
943
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
944
|
+
:type undo: typing.Optional[bool]
|
|
943
945
|
"""
|
|
944
946
|
|
|
945
947
|
...
|
|
946
948
|
|
|
947
949
|
def tile_add(
|
|
948
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
949
|
-
execution_context: typing.Union[str, int] = None,
|
|
950
|
-
undo: bool = None,
|
|
951
|
-
number: typing.Any = 1002,
|
|
952
|
-
count: typing.Any = 1,
|
|
950
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
951
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
952
|
+
undo: typing.Optional[bool] = None,
|
|
953
|
+
number: typing.Optional[typing.Any] = 1002,
|
|
954
|
+
count: typing.Optional[typing.Any] = 1,
|
|
953
955
|
label: typing.Union[str, typing.Any] = "",
|
|
954
|
-
fill: typing.Union[bool, typing.Any] = True,
|
|
955
|
-
color: typing.Any = (0.0, 0.0, 0.0, 1.0),
|
|
956
|
-
generated_type: typing.Union[str, int] = "BLANK",
|
|
957
|
-
width: typing.Any = 1024,
|
|
958
|
-
height: typing.Any = 1024,
|
|
959
|
-
float: typing.Union[bool, typing.Any] = False,
|
|
960
|
-
alpha: typing.Union[bool, typing.Any] = True,
|
|
956
|
+
fill: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
957
|
+
color: typing.Optional[typing.Any] = (0.0, 0.0, 0.0, 1.0),
|
|
958
|
+
generated_type: typing.Optional[typing.Union[str, int]] = "BLANK",
|
|
959
|
+
width: typing.Optional[typing.Any] = 1024,
|
|
960
|
+
height: typing.Optional[typing.Any] = 1024,
|
|
961
|
+
float: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
962
|
+
alpha: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
961
963
|
):
|
|
962
964
|
"""Adds a tile to the image
|
|
963
965
|
|
|
964
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
965
|
-
:type execution_context: typing.Union[str, int]
|
|
966
|
-
:type undo: bool
|
|
966
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
967
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
968
|
+
:type undo: typing.Optional[bool]
|
|
967
969
|
:param number: Number, UDIM number of the tile
|
|
968
|
-
:type number: typing.Any
|
|
970
|
+
:type number: typing.Optional[typing.Any]
|
|
969
971
|
:param count: Count, How many tiles to add
|
|
970
|
-
:type count: typing.Any
|
|
972
|
+
:type count: typing.Optional[typing.Any]
|
|
971
973
|
:param label: Label, Optional tile label
|
|
972
974
|
:type label: typing.Union[str, typing.Any]
|
|
973
975
|
:param fill: Fill, Fill new tile with a generated image
|
|
974
|
-
:type fill: typing.Union[bool, typing.Any]
|
|
976
|
+
:type fill: typing.Optional[typing.Union[bool, typing.Any]]
|
|
975
977
|
:param color: Color, Default fill color
|
|
976
|
-
:type color: typing.Any
|
|
978
|
+
:type color: typing.Optional[typing.Any]
|
|
977
979
|
:param generated_type: Generated Type, Fill the image with a grid for UV map testing
|
|
978
|
-
:type generated_type: typing.Union[str, int]
|
|
980
|
+
:type generated_type: typing.Optional[typing.Union[str, int]]
|
|
979
981
|
:param width: Width, Image width
|
|
980
|
-
:type width: typing.Any
|
|
982
|
+
:type width: typing.Optional[typing.Any]
|
|
981
983
|
:param height: Height, Image height
|
|
982
|
-
:type height: typing.Any
|
|
984
|
+
:type height: typing.Optional[typing.Any]
|
|
983
985
|
:param float: 32-bit Float, Create image with 32-bit floating-point bit depth
|
|
984
|
-
:type float: typing.Union[bool, typing.Any]
|
|
986
|
+
:type float: typing.Optional[typing.Union[bool, typing.Any]]
|
|
985
987
|
:param alpha: Alpha, Create an image with an alpha channel
|
|
986
|
-
:type alpha: typing.Union[bool, typing.Any]
|
|
988
|
+
:type alpha: typing.Optional[typing.Union[bool, typing.Any]]
|
|
987
989
|
"""
|
|
988
990
|
|
|
989
991
|
...
|
|
990
992
|
|
|
991
993
|
def tile_fill(
|
|
992
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
993
|
-
execution_context: typing.Union[str, int] = None,
|
|
994
|
-
undo: bool = None,
|
|
995
|
-
color: typing.Any = (0.0, 0.0, 0.0, 1.0),
|
|
996
|
-
generated_type: typing.Union[str, int] = "BLANK",
|
|
997
|
-
width: typing.Any = 1024,
|
|
998
|
-
height: typing.Any = 1024,
|
|
999
|
-
float: typing.Union[bool, typing.Any] = False,
|
|
1000
|
-
alpha: typing.Union[bool, typing.Any] = True,
|
|
994
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
995
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
996
|
+
undo: typing.Optional[bool] = None,
|
|
997
|
+
color: typing.Optional[typing.Any] = (0.0, 0.0, 0.0, 1.0),
|
|
998
|
+
generated_type: typing.Optional[typing.Union[str, int]] = "BLANK",
|
|
999
|
+
width: typing.Optional[typing.Any] = 1024,
|
|
1000
|
+
height: typing.Optional[typing.Any] = 1024,
|
|
1001
|
+
float: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1002
|
+
alpha: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
1001
1003
|
):
|
|
1002
1004
|
"""Fill the current tile with a generated image
|
|
1003
1005
|
|
|
1004
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1005
|
-
:type execution_context: typing.Union[str, int]
|
|
1006
|
-
:type undo: bool
|
|
1006
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1007
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1008
|
+
:type undo: typing.Optional[bool]
|
|
1007
1009
|
:param color: Color, Default fill color
|
|
1008
|
-
:type color: typing.Any
|
|
1010
|
+
:type color: typing.Optional[typing.Any]
|
|
1009
1011
|
:param generated_type: Generated Type, Fill the image with a grid for UV map testing
|
|
1010
|
-
:type generated_type: typing.Union[str, int]
|
|
1012
|
+
:type generated_type: typing.Optional[typing.Union[str, int]]
|
|
1011
1013
|
:param width: Width, Image width
|
|
1012
|
-
:type width: typing.Any
|
|
1014
|
+
:type width: typing.Optional[typing.Any]
|
|
1013
1015
|
:param height: Height, Image height
|
|
1014
|
-
:type height: typing.Any
|
|
1016
|
+
:type height: typing.Optional[typing.Any]
|
|
1015
1017
|
:param float: 32-bit Float, Create image with 32-bit floating-point bit depth
|
|
1016
|
-
:type float: typing.Union[bool, typing.Any]
|
|
1018
|
+
:type float: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1017
1019
|
:param alpha: Alpha, Create an image with an alpha channel
|
|
1018
|
-
:type alpha: typing.Union[bool, typing.Any]
|
|
1020
|
+
:type alpha: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1019
1021
|
"""
|
|
1020
1022
|
|
|
1021
1023
|
...
|
|
1022
1024
|
|
|
1023
1025
|
def tile_remove(
|
|
1024
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1025
|
-
execution_context: typing.Union[str, int] = None,
|
|
1026
|
-
undo: bool = None,
|
|
1026
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1027
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1028
|
+
undo: typing.Optional[bool] = None,
|
|
1027
1029
|
):
|
|
1028
1030
|
"""Removes a tile from the image
|
|
1029
1031
|
|
|
1030
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1031
|
-
:type execution_context: typing.Union[str, int]
|
|
1032
|
-
:type undo: bool
|
|
1032
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1033
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1034
|
+
:type undo: typing.Optional[bool]
|
|
1033
1035
|
"""
|
|
1034
1036
|
|
|
1035
1037
|
...
|
|
1036
1038
|
|
|
1037
1039
|
def unpack(
|
|
1038
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1039
|
-
execution_context: typing.Union[str, int] = None,
|
|
1040
|
-
undo: bool = None,
|
|
1041
|
-
method: typing.Union[str, int] = "USE_LOCAL",
|
|
1040
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1041
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1042
|
+
undo: typing.Optional[bool] = None,
|
|
1043
|
+
method: typing.Optional[typing.Union[str, int]] = "USE_LOCAL",
|
|
1042
1044
|
id: typing.Union[str, typing.Any] = "",
|
|
1043
1045
|
):
|
|
1044
1046
|
"""Save an image packed in the .blend file to disk
|
|
1045
1047
|
|
|
1046
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1047
|
-
:type execution_context: typing.Union[str, int]
|
|
1048
|
-
:type undo: bool
|
|
1048
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1049
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1050
|
+
:type undo: typing.Optional[bool]
|
|
1049
1051
|
:param method: Method, How to unpack
|
|
1050
|
-
:type method: typing.Union[str, int]
|
|
1052
|
+
:type method: typing.Optional[typing.Union[str, int]]
|
|
1051
1053
|
:param id: Image Name, Image data-block name to unpack
|
|
1052
1054
|
:type id: typing.Union[str, typing.Any]
|
|
1053
1055
|
"""
|
|
@@ -1055,197 +1057,197 @@ def unpack(
|
|
|
1055
1057
|
...
|
|
1056
1058
|
|
|
1057
1059
|
def view_all(
|
|
1058
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1059
|
-
execution_context: typing.Union[str, int] = None,
|
|
1060
|
-
undo: bool = None,
|
|
1061
|
-
fit_view: typing.Union[bool, typing.Any] = False,
|
|
1060
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1061
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1062
|
+
undo: typing.Optional[bool] = None,
|
|
1063
|
+
fit_view: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1062
1064
|
):
|
|
1063
1065
|
"""View the entire image
|
|
1064
1066
|
|
|
1065
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1066
|
-
:type execution_context: typing.Union[str, int]
|
|
1067
|
-
:type undo: bool
|
|
1067
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1068
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1069
|
+
:type undo: typing.Optional[bool]
|
|
1068
1070
|
:param fit_view: Fit View, Fit frame to the viewport
|
|
1069
|
-
:type fit_view: typing.Union[bool, typing.Any]
|
|
1071
|
+
:type fit_view: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1070
1072
|
"""
|
|
1071
1073
|
|
|
1072
1074
|
...
|
|
1073
1075
|
|
|
1074
1076
|
def view_center_cursor(
|
|
1075
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1076
|
-
execution_context: typing.Union[str, int] = None,
|
|
1077
|
-
undo: bool = None,
|
|
1077
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1078
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1079
|
+
undo: typing.Optional[bool] = None,
|
|
1078
1080
|
):
|
|
1079
1081
|
"""Center the view so that the cursor is in the middle of the view
|
|
1080
1082
|
|
|
1081
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1082
|
-
:type execution_context: typing.Union[str, int]
|
|
1083
|
-
:type undo: bool
|
|
1083
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1084
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1085
|
+
:type undo: typing.Optional[bool]
|
|
1084
1086
|
"""
|
|
1085
1087
|
|
|
1086
1088
|
...
|
|
1087
1089
|
|
|
1088
1090
|
def view_cursor_center(
|
|
1089
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1090
|
-
execution_context: typing.Union[str, int] = None,
|
|
1091
|
-
undo: bool = None,
|
|
1092
|
-
fit_view: typing.Union[bool, typing.Any] = False,
|
|
1091
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1092
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1093
|
+
undo: typing.Optional[bool] = None,
|
|
1094
|
+
fit_view: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1093
1095
|
):
|
|
1094
1096
|
"""Set 2D Cursor To Center View location
|
|
1095
1097
|
|
|
1096
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1097
|
-
:type execution_context: typing.Union[str, int]
|
|
1098
|
-
:type undo: bool
|
|
1098
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1099
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1100
|
+
:type undo: typing.Optional[bool]
|
|
1099
1101
|
:param fit_view: Fit View, Fit frame to the viewport
|
|
1100
|
-
:type fit_view: typing.Union[bool, typing.Any]
|
|
1102
|
+
:type fit_view: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1101
1103
|
"""
|
|
1102
1104
|
|
|
1103
1105
|
...
|
|
1104
1106
|
|
|
1105
1107
|
def view_ndof(
|
|
1106
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1107
|
-
execution_context: typing.Union[str, int] = None,
|
|
1108
|
-
undo: bool = None,
|
|
1108
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1109
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1110
|
+
undo: typing.Optional[bool] = None,
|
|
1109
1111
|
):
|
|
1110
1112
|
"""Use a 3D mouse device to pan/zoom the view
|
|
1111
1113
|
|
|
1112
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1113
|
-
:type execution_context: typing.Union[str, int]
|
|
1114
|
-
:type undo: bool
|
|
1114
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1115
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1116
|
+
:type undo: typing.Optional[bool]
|
|
1115
1117
|
"""
|
|
1116
1118
|
|
|
1117
1119
|
...
|
|
1118
1120
|
|
|
1119
1121
|
def view_pan(
|
|
1120
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1121
|
-
execution_context: typing.Union[str, int] = None,
|
|
1122
|
-
undo: bool = None,
|
|
1123
|
-
offset: typing.Any = (0.0, 0.0),
|
|
1122
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1123
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1124
|
+
undo: typing.Optional[bool] = None,
|
|
1125
|
+
offset: typing.Optional[typing.Any] = (0.0, 0.0),
|
|
1124
1126
|
):
|
|
1125
1127
|
"""Pan the view
|
|
1126
1128
|
|
|
1127
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1128
|
-
:type execution_context: typing.Union[str, int]
|
|
1129
|
-
:type undo: bool
|
|
1129
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1130
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1131
|
+
:type undo: typing.Optional[bool]
|
|
1130
1132
|
:param offset: Offset, Offset in floating-point units, 1.0 is the width and height of the image
|
|
1131
|
-
:type offset: typing.Any
|
|
1133
|
+
:type offset: typing.Optional[typing.Any]
|
|
1132
1134
|
"""
|
|
1133
1135
|
|
|
1134
1136
|
...
|
|
1135
1137
|
|
|
1136
1138
|
def view_selected(
|
|
1137
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1138
|
-
execution_context: typing.Union[str, int] = None,
|
|
1139
|
-
undo: bool = None,
|
|
1139
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1140
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1141
|
+
undo: typing.Optional[bool] = None,
|
|
1140
1142
|
):
|
|
1141
1143
|
"""View all selected UVs
|
|
1142
1144
|
|
|
1143
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1144
|
-
:type execution_context: typing.Union[str, int]
|
|
1145
|
-
:type undo: bool
|
|
1145
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1146
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1147
|
+
:type undo: typing.Optional[bool]
|
|
1146
1148
|
"""
|
|
1147
1149
|
|
|
1148
1150
|
...
|
|
1149
1151
|
|
|
1150
1152
|
def view_zoom(
|
|
1151
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1152
|
-
execution_context: typing.Union[str, int] = None,
|
|
1153
|
-
undo: bool = None,
|
|
1154
|
-
factor: typing.Any = 0.0,
|
|
1155
|
-
use_cursor_init: typing.Union[bool, typing.Any] = True,
|
|
1153
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1154
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1155
|
+
undo: typing.Optional[bool] = None,
|
|
1156
|
+
factor: typing.Optional[typing.Any] = 0.0,
|
|
1157
|
+
use_cursor_init: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
1156
1158
|
):
|
|
1157
1159
|
"""Zoom in/out the image
|
|
1158
1160
|
|
|
1159
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1160
|
-
:type execution_context: typing.Union[str, int]
|
|
1161
|
-
:type undo: bool
|
|
1161
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1162
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1163
|
+
:type undo: typing.Optional[bool]
|
|
1162
1164
|
:param factor: Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out
|
|
1163
|
-
:type factor: typing.Any
|
|
1165
|
+
:type factor: typing.Optional[typing.Any]
|
|
1164
1166
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
1165
|
-
:type use_cursor_init: typing.Union[bool, typing.Any]
|
|
1167
|
+
:type use_cursor_init: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1166
1168
|
"""
|
|
1167
1169
|
|
|
1168
1170
|
...
|
|
1169
1171
|
|
|
1170
1172
|
def view_zoom_border(
|
|
1171
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1172
|
-
execution_context: typing.Union[str, int] = None,
|
|
1173
|
-
undo: bool = None,
|
|
1174
|
-
xmin: typing.Any = 0,
|
|
1175
|
-
xmax: typing.Any = 0,
|
|
1176
|
-
ymin: typing.Any = 0,
|
|
1177
|
-
ymax: typing.Any = 0,
|
|
1178
|
-
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
1179
|
-
zoom_out: typing.Union[bool, typing.Any] = False,
|
|
1173
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1174
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1175
|
+
undo: typing.Optional[bool] = None,
|
|
1176
|
+
xmin: typing.Optional[typing.Any] = 0,
|
|
1177
|
+
xmax: typing.Optional[typing.Any] = 0,
|
|
1178
|
+
ymin: typing.Optional[typing.Any] = 0,
|
|
1179
|
+
ymax: typing.Optional[typing.Any] = 0,
|
|
1180
|
+
wait_for_input: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
1181
|
+
zoom_out: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1180
1182
|
):
|
|
1181
1183
|
"""Zoom in the view to the nearest item contained in the border
|
|
1182
1184
|
|
|
1183
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1184
|
-
:type execution_context: typing.Union[str, int]
|
|
1185
|
-
:type undo: bool
|
|
1185
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1186
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1187
|
+
:type undo: typing.Optional[bool]
|
|
1186
1188
|
:param xmin: X Min
|
|
1187
|
-
:type xmin: typing.Any
|
|
1189
|
+
:type xmin: typing.Optional[typing.Any]
|
|
1188
1190
|
:param xmax: X Max
|
|
1189
|
-
:type xmax: typing.Any
|
|
1191
|
+
:type xmax: typing.Optional[typing.Any]
|
|
1190
1192
|
:param ymin: Y Min
|
|
1191
|
-
:type ymin: typing.Any
|
|
1193
|
+
:type ymin: typing.Optional[typing.Any]
|
|
1192
1194
|
:param ymax: Y Max
|
|
1193
|
-
:type ymax: typing.Any
|
|
1195
|
+
:type ymax: typing.Optional[typing.Any]
|
|
1194
1196
|
:param wait_for_input: Wait for Input
|
|
1195
|
-
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
1197
|
+
:type wait_for_input: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1196
1198
|
:param zoom_out: Zoom Out
|
|
1197
|
-
:type zoom_out: typing.Union[bool, typing.Any]
|
|
1199
|
+
:type zoom_out: typing.Optional[typing.Union[bool, typing.Any]]
|
|
1198
1200
|
"""
|
|
1199
1201
|
|
|
1200
1202
|
...
|
|
1201
1203
|
|
|
1202
1204
|
def view_zoom_in(
|
|
1203
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1204
|
-
execution_context: typing.Union[str, int] = None,
|
|
1205
|
-
undo: bool = None,
|
|
1206
|
-
location: typing.Any = (0.0, 0.0),
|
|
1205
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1206
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1207
|
+
undo: typing.Optional[bool] = None,
|
|
1208
|
+
location: typing.Optional[typing.Any] = (0.0, 0.0),
|
|
1207
1209
|
):
|
|
1208
1210
|
"""Zoom in the image (centered around 2D cursor)
|
|
1209
1211
|
|
|
1210
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1211
|
-
:type execution_context: typing.Union[str, int]
|
|
1212
|
-
:type undo: bool
|
|
1212
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1213
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1214
|
+
:type undo: typing.Optional[bool]
|
|
1213
1215
|
:param location: Location, Cursor location in screen coordinates
|
|
1214
|
-
:type location: typing.Any
|
|
1216
|
+
:type location: typing.Optional[typing.Any]
|
|
1215
1217
|
"""
|
|
1216
1218
|
|
|
1217
1219
|
...
|
|
1218
1220
|
|
|
1219
1221
|
def view_zoom_out(
|
|
1220
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1221
|
-
execution_context: typing.Union[str, int] = None,
|
|
1222
|
-
undo: bool = None,
|
|
1223
|
-
location: typing.Any = (0.0, 0.0),
|
|
1222
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1223
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1224
|
+
undo: typing.Optional[bool] = None,
|
|
1225
|
+
location: typing.Optional[typing.Any] = (0.0, 0.0),
|
|
1224
1226
|
):
|
|
1225
1227
|
"""Zoom out the image (centered around 2D cursor)
|
|
1226
1228
|
|
|
1227
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1228
|
-
:type execution_context: typing.Union[str, int]
|
|
1229
|
-
:type undo: bool
|
|
1229
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1230
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1231
|
+
:type undo: typing.Optional[bool]
|
|
1230
1232
|
:param location: Location, Cursor location in screen coordinates
|
|
1231
|
-
:type location: typing.Any
|
|
1233
|
+
:type location: typing.Optional[typing.Any]
|
|
1232
1234
|
"""
|
|
1233
1235
|
|
|
1234
1236
|
...
|
|
1235
1237
|
|
|
1236
1238
|
def view_zoom_ratio(
|
|
1237
|
-
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1238
|
-
execution_context: typing.Union[str, int] = None,
|
|
1239
|
-
undo: bool = None,
|
|
1240
|
-
ratio: typing.Any = 0.0,
|
|
1239
|
+
override_context: typing.Optional[typing.Union[dict, bpy.types.Context]] = None,
|
|
1240
|
+
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1241
|
+
undo: typing.Optional[bool] = None,
|
|
1242
|
+
ratio: typing.Optional[typing.Any] = 0.0,
|
|
1241
1243
|
):
|
|
1242
1244
|
"""Set zoom ratio of the view
|
|
1243
1245
|
|
|
1244
|
-
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1245
|
-
:type execution_context: typing.Union[str, int]
|
|
1246
|
-
:type undo: bool
|
|
1246
|
+
:type override_context: typing.Optional[typing.Union[dict, bpy.types.Context]]
|
|
1247
|
+
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1248
|
+
:type undo: typing.Optional[bool]
|
|
1247
1249
|
:param ratio: Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out
|
|
1248
|
-
:type ratio: typing.Any
|
|
1250
|
+
:type ratio: typing.Optional[typing.Any]
|
|
1249
1251
|
"""
|
|
1250
1252
|
|
|
1251
1253
|
...
|