fake-bpy-module 20240507__py3-none-any.whl → 20240509__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- bpy/ops/action/__init__.pyi +152 -76
- bpy/ops/anim/__init__.pyi +212 -106
- bpy/ops/armature/__init__.pyi +192 -96
- bpy/ops/asset/__init__.pyi +64 -32
- bpy/ops/boid/__init__.pyi +32 -16
- bpy/ops/brush/__init__.pyi +36 -18
- bpy/ops/buttons/__init__.pyi +24 -12
- bpy/ops/cachefile/__init__.pyi +20 -10
- bpy/ops/camera/__init__.pyi +8 -4
- bpy/ops/clip/__init__.pyi +368 -184
- bpy/ops/cloth/__init__.pyi +4 -2
- bpy/ops/collection/__init__.pyi +36 -18
- bpy/ops/console/__init__.pyi +84 -42
- bpy/ops/constraint/__init__.pyi +72 -36
- bpy/ops/curve/__init__.pyi +204 -102
- bpy/ops/curves/__init__.pyi +108 -54
- bpy/ops/cycles/__init__.pyi +12 -6
- bpy/ops/dpaint/__init__.pyi +20 -10
- bpy/ops/ed/__init__.pyi +48 -24
- bpy/ops/export_anim/__init__.pyi +4 -2
- bpy/ops/export_mesh/__init__.pyi +4 -2
- bpy/ops/export_scene/__init__.pyi +14 -8
- bpy/ops/file/__init__.pyi +160 -80
- bpy/ops/fluid/__init__.pyi +56 -28
- bpy/ops/font/__init__.pyi +92 -46
- bpy/ops/geometry/__init__.pyi +40 -20
- bpy/ops/gizmogroup/__init__.pyi +8 -4
- bpy/ops/gpencil/__init__.pyi +600 -300
- bpy/ops/graph/__init__.pyi +260 -130
- bpy/ops/grease_pencil/__init__.pyi +268 -134
- bpy/ops/image/__init__.pyi +188 -94
- bpy/ops/import_anim/__init__.pyi +4 -2
- bpy/ops/import_curve/__init__.pyi +4 -2
- bpy/ops/import_mesh/__init__.pyi +4 -2
- bpy/ops/import_scene/__init__.pyi +12 -6
- bpy/ops/info/__init__.pyi +28 -14
- bpy/ops/lattice/__init__.pyi +32 -16
- bpy/ops/marker/__init__.pyi +44 -22
- bpy/ops/mask/__init__.pyi +156 -78
- bpy/ops/material/__init__.pyi +12 -6
- bpy/ops/mball/__init__.pyi +32 -16
- bpy/ops/mesh/__init__.pyi +652 -326
- bpy/ops/nla/__init__.pyi +158 -80
- bpy/ops/node/__init__.pyi +404 -202
- bpy/ops/object/__init__.pyi +1002 -490
- bpy/ops/outliner/__init__.pyi +276 -138
- bpy/ops/paint/__init__.pyi +212 -106
- bpy/ops/paintcurve/__init__.pyi +32 -16
- bpy/ops/palette/__init__.pyi +28 -14
- bpy/ops/particle/__init__.pyi +144 -72
- bpy/ops/pose/__init__.pyi +156 -78
- bpy/ops/poselib/__init__.pyi +36 -18
- bpy/ops/preferences/__init__.pyi +152 -76
- bpy/ops/ptcache/__init__.pyi +28 -14
- bpy/ops/render/__init__.pyi +48 -24
- bpy/ops/rigidbody/__init__.pyi +52 -26
- bpy/ops/scene/__init__.pyi +156 -78
- bpy/ops/screen/__init__.pyi +156 -78
- bpy/ops/script/__init__.pyi +12 -6
- bpy/ops/sculpt/__init__.pyi +134 -68
- bpy/ops/sculpt_curves/__init__.pyi +16 -8
- bpy/ops/sequencer/__init__.pyi +340 -170
- bpy/ops/sound/__init__.pyi +28 -14
- bpy/ops/spreadsheet/__init__.pyi +16 -8
- bpy/ops/surface/__init__.pyi +24 -12
- bpy/ops/text/__init__.pyi +172 -86
- bpy/ops/text_editor/__init__.pyi +4 -2
- bpy/ops/texture/__init__.pyi +16 -8
- bpy/ops/transform/__init__.pyi +108 -54
- bpy/ops/ui/__init__.pyi +132 -66
- bpy/ops/uilist/__init__.pyi +12 -6
- bpy/ops/uv/__init__.pyi +196 -98
- bpy/ops/view2d/__init__.pyi +56 -28
- bpy/ops/view3d/__init__.pyi +268 -134
- bpy/ops/wm/__init__.pyi +493 -224
- bpy/ops/workspace/__init__.pyi +28 -14
- bpy/ops/world/__init__.pyi +4 -2
- bpy/types/__init__.pyi +1250 -631
- {fake_bpy_module-20240507.dist-info → fake_bpy_module-20240509.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240507.dist-info → fake_bpy_module-20240509.dist-info}/RECORD +83 -83
- mathutils/__init__.pyi +20 -0
- {fake_bpy_module-20240507.dist-info → fake_bpy_module-20240509.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240507.dist-info → fake_bpy_module-20240509.dist-info}/top_level.txt +0 -0
bpy/ops/image/__init__.pyi
CHANGED
|
@@ -4,13 +4,15 @@ import bpy.types
|
|
|
4
4
|
GenericType = typing.TypeVar("GenericType")
|
|
5
5
|
|
|
6
6
|
def add_render_slot(
|
|
7
|
-
override_context: typing.Optional[
|
|
7
|
+
override_context: typing.Optional[
|
|
8
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
9
|
+
] = None,
|
|
8
10
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
9
11
|
undo: typing.Optional[bool] = None,
|
|
10
12
|
):
|
|
11
13
|
"""Add a new render slot
|
|
12
14
|
|
|
13
|
-
:type override_context: typing.Optional[typing.Union[
|
|
15
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
14
16
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
15
17
|
:type undo: typing.Optional[bool]
|
|
16
18
|
"""
|
|
@@ -18,14 +20,16 @@ def add_render_slot(
|
|
|
18
20
|
...
|
|
19
21
|
|
|
20
22
|
def change_frame(
|
|
21
|
-
override_context: typing.Optional[
|
|
23
|
+
override_context: typing.Optional[
|
|
24
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
25
|
+
] = None,
|
|
22
26
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
23
27
|
undo: typing.Optional[bool] = None,
|
|
24
28
|
frame: typing.Optional[typing.Any] = 0,
|
|
25
29
|
):
|
|
26
30
|
"""Interactively change the current frame number
|
|
27
31
|
|
|
28
|
-
:type override_context: typing.Optional[typing.Union[
|
|
32
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
29
33
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
30
34
|
:type undo: typing.Optional[bool]
|
|
31
35
|
:param frame: Frame
|
|
@@ -35,13 +39,15 @@ def change_frame(
|
|
|
35
39
|
...
|
|
36
40
|
|
|
37
41
|
def clear_render_border(
|
|
38
|
-
override_context: typing.Optional[
|
|
42
|
+
override_context: typing.Optional[
|
|
43
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
44
|
+
] = None,
|
|
39
45
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
40
46
|
undo: typing.Optional[bool] = None,
|
|
41
47
|
):
|
|
42
48
|
"""Clear the boundaries of the render region and disable render region
|
|
43
49
|
|
|
44
|
-
:type override_context: typing.Optional[typing.Union[
|
|
50
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
45
51
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
46
52
|
:type undo: typing.Optional[bool]
|
|
47
53
|
"""
|
|
@@ -49,13 +55,15 @@ def clear_render_border(
|
|
|
49
55
|
...
|
|
50
56
|
|
|
51
57
|
def clear_render_slot(
|
|
52
|
-
override_context: typing.Optional[
|
|
58
|
+
override_context: typing.Optional[
|
|
59
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
60
|
+
] = None,
|
|
53
61
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
54
62
|
undo: typing.Optional[bool] = None,
|
|
55
63
|
):
|
|
56
64
|
"""Clear the currently selected render slot
|
|
57
65
|
|
|
58
|
-
:type override_context: typing.Optional[typing.Union[
|
|
66
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
59
67
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
60
68
|
:type undo: typing.Optional[bool]
|
|
61
69
|
"""
|
|
@@ -63,13 +71,15 @@ def clear_render_slot(
|
|
|
63
71
|
...
|
|
64
72
|
|
|
65
73
|
def clipboard_copy(
|
|
66
|
-
override_context: typing.Optional[
|
|
74
|
+
override_context: typing.Optional[
|
|
75
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
76
|
+
] = None,
|
|
67
77
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
68
78
|
undo: typing.Optional[bool] = None,
|
|
69
79
|
):
|
|
70
80
|
"""Copy the image to the clipboard
|
|
71
81
|
|
|
72
|
-
:type override_context: typing.Optional[typing.Union[
|
|
82
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
73
83
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
74
84
|
:type undo: typing.Optional[bool]
|
|
75
85
|
"""
|
|
@@ -77,13 +87,15 @@ def clipboard_copy(
|
|
|
77
87
|
...
|
|
78
88
|
|
|
79
89
|
def clipboard_paste(
|
|
80
|
-
override_context: typing.Optional[
|
|
90
|
+
override_context: typing.Optional[
|
|
91
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
92
|
+
] = None,
|
|
81
93
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
82
94
|
undo: typing.Optional[bool] = None,
|
|
83
95
|
):
|
|
84
96
|
"""Paste new image from the clipboard
|
|
85
97
|
|
|
86
|
-
:type override_context: typing.Optional[typing.Union[
|
|
98
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
87
99
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
88
100
|
:type undo: typing.Optional[bool]
|
|
89
101
|
"""
|
|
@@ -91,7 +103,9 @@ def clipboard_paste(
|
|
|
91
103
|
...
|
|
92
104
|
|
|
93
105
|
def curves_point_set(
|
|
94
|
-
override_context: typing.Optional[
|
|
106
|
+
override_context: typing.Optional[
|
|
107
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
108
|
+
] = None,
|
|
95
109
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
96
110
|
undo: typing.Optional[bool] = None,
|
|
97
111
|
point: typing.Optional[typing.Any] = "BLACK_POINT",
|
|
@@ -99,7 +113,7 @@ def curves_point_set(
|
|
|
99
113
|
):
|
|
100
114
|
"""Set black point or white point for curves
|
|
101
115
|
|
|
102
|
-
:type override_context: typing.Optional[typing.Union[
|
|
116
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
103
117
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
104
118
|
:type undo: typing.Optional[bool]
|
|
105
119
|
:param point: Point, Set black point or white point for curves
|
|
@@ -111,14 +125,16 @@ def curves_point_set(
|
|
|
111
125
|
...
|
|
112
126
|
|
|
113
127
|
def cycle_render_slot(
|
|
114
|
-
override_context: typing.Optional[
|
|
128
|
+
override_context: typing.Optional[
|
|
129
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
130
|
+
] = None,
|
|
115
131
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
116
132
|
undo: typing.Optional[bool] = None,
|
|
117
133
|
reverse: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
118
134
|
):
|
|
119
135
|
"""Cycle through all non-void render slots
|
|
120
136
|
|
|
121
|
-
:type override_context: typing.Optional[typing.Union[
|
|
137
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
122
138
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
123
139
|
:type undo: typing.Optional[bool]
|
|
124
140
|
:param reverse: Cycle in Reverse
|
|
@@ -128,14 +144,16 @@ def cycle_render_slot(
|
|
|
128
144
|
...
|
|
129
145
|
|
|
130
146
|
def external_edit(
|
|
131
|
-
override_context: typing.Optional[
|
|
147
|
+
override_context: typing.Optional[
|
|
148
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
149
|
+
] = None,
|
|
132
150
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
133
151
|
undo: typing.Optional[bool] = None,
|
|
134
152
|
filepath: typing.Union[str, typing.Any] = "",
|
|
135
153
|
):
|
|
136
154
|
"""Edit image in an external application
|
|
137
155
|
|
|
138
|
-
:type override_context: typing.Optional[typing.Union[
|
|
156
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
139
157
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
140
158
|
:type undo: typing.Optional[bool]
|
|
141
159
|
:param filepath: filepath
|
|
@@ -145,7 +163,9 @@ def external_edit(
|
|
|
145
163
|
...
|
|
146
164
|
|
|
147
165
|
def file_browse(
|
|
148
|
-
override_context: typing.Optional[
|
|
166
|
+
override_context: typing.Optional[
|
|
167
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
168
|
+
] = None,
|
|
149
169
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
150
170
|
undo: typing.Optional[bool] = None,
|
|
151
171
|
filepath: typing.Union[str, typing.Any] = "",
|
|
@@ -177,7 +197,7 @@ def file_browse(
|
|
|
177
197
|
):
|
|
178
198
|
"""Open an image file browser, hold Shift to open the file, Alt to browse containing directory
|
|
179
199
|
|
|
180
|
-
:type override_context: typing.Optional[typing.Union[
|
|
200
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
181
201
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
182
202
|
:type undo: typing.Optional[bool]
|
|
183
203
|
:param filepath: File Path, Path to file
|
|
@@ -249,7 +269,9 @@ def file_browse(
|
|
|
249
269
|
...
|
|
250
270
|
|
|
251
271
|
def flip(
|
|
252
|
-
override_context: typing.Optional[
|
|
272
|
+
override_context: typing.Optional[
|
|
273
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
274
|
+
] = None,
|
|
253
275
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
254
276
|
undo: typing.Optional[bool] = None,
|
|
255
277
|
use_flip_x: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
@@ -257,7 +279,7 @@ def flip(
|
|
|
257
279
|
):
|
|
258
280
|
"""Flip the image
|
|
259
281
|
|
|
260
|
-
:type override_context: typing.Optional[typing.Union[
|
|
282
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
261
283
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
262
284
|
:type undo: typing.Optional[bool]
|
|
263
285
|
:param use_flip_x: Horizontal, Flip the image horizontally
|
|
@@ -269,7 +291,9 @@ def flip(
|
|
|
269
291
|
...
|
|
270
292
|
|
|
271
293
|
def invert(
|
|
272
|
-
override_context: typing.Optional[
|
|
294
|
+
override_context: typing.Optional[
|
|
295
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
296
|
+
] = None,
|
|
273
297
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
274
298
|
undo: typing.Optional[bool] = None,
|
|
275
299
|
invert_r: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
@@ -279,7 +303,7 @@ def invert(
|
|
|
279
303
|
):
|
|
280
304
|
"""Invert image's channels
|
|
281
305
|
|
|
282
|
-
:type override_context: typing.Optional[typing.Union[
|
|
306
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
283
307
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
284
308
|
:type undo: typing.Optional[bool]
|
|
285
309
|
:param invert_r: Red, Invert red channel
|
|
@@ -295,13 +319,15 @@ def invert(
|
|
|
295
319
|
...
|
|
296
320
|
|
|
297
321
|
def match_movie_length(
|
|
298
|
-
override_context: typing.Optional[
|
|
322
|
+
override_context: typing.Optional[
|
|
323
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
324
|
+
] = None,
|
|
299
325
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
300
326
|
undo: typing.Optional[bool] = None,
|
|
301
327
|
):
|
|
302
328
|
"""Set image's user's length to the one of this video
|
|
303
329
|
|
|
304
|
-
:type override_context: typing.Optional[typing.Union[
|
|
330
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
305
331
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
306
332
|
:type undo: typing.Optional[bool]
|
|
307
333
|
"""
|
|
@@ -309,7 +335,9 @@ def match_movie_length(
|
|
|
309
335
|
...
|
|
310
336
|
|
|
311
337
|
def new(
|
|
312
|
-
override_context: typing.Optional[
|
|
338
|
+
override_context: typing.Optional[
|
|
339
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
340
|
+
] = None,
|
|
313
341
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
314
342
|
undo: typing.Optional[bool] = None,
|
|
315
343
|
name: typing.Union[str, typing.Any] = "Untitled",
|
|
@@ -324,7 +352,7 @@ def new(
|
|
|
324
352
|
):
|
|
325
353
|
"""Create a new image
|
|
326
354
|
|
|
327
|
-
:type override_context: typing.Optional[typing.Union[
|
|
355
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
328
356
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
329
357
|
:type undo: typing.Optional[bool]
|
|
330
358
|
:param name: Name, Image data-block name
|
|
@@ -350,7 +378,9 @@ def new(
|
|
|
350
378
|
...
|
|
351
379
|
|
|
352
380
|
def open(
|
|
353
|
-
override_context: typing.Optional[
|
|
381
|
+
override_context: typing.Optional[
|
|
382
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
383
|
+
] = None,
|
|
354
384
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
355
385
|
undo: typing.Optional[bool] = None,
|
|
356
386
|
allow_path_tokens: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
@@ -389,7 +419,7 @@ def open(
|
|
|
389
419
|
):
|
|
390
420
|
"""Open image
|
|
391
421
|
|
|
392
|
-
:type override_context: typing.Optional[typing.Union[
|
|
422
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
393
423
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
394
424
|
:type undo: typing.Optional[bool]
|
|
395
425
|
:param allow_path_tokens: Allow the path to contain substitution tokens
|
|
@@ -471,7 +501,9 @@ def open(
|
|
|
471
501
|
...
|
|
472
502
|
|
|
473
503
|
def open_images(
|
|
474
|
-
override_context: typing.Optional[
|
|
504
|
+
override_context: typing.Optional[
|
|
505
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
506
|
+
] = None,
|
|
475
507
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
476
508
|
undo: typing.Optional[bool] = None,
|
|
477
509
|
directory: typing.Union[str, typing.Any] = "",
|
|
@@ -484,7 +516,7 @@ def open_images(
|
|
|
484
516
|
):
|
|
485
517
|
"""Undocumented, consider contributing.
|
|
486
518
|
|
|
487
|
-
:type override_context: typing.Optional[typing.Union[
|
|
519
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
488
520
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
489
521
|
:type undo: typing.Optional[bool]
|
|
490
522
|
:param directory: directory
|
|
@@ -502,13 +534,15 @@ def open_images(
|
|
|
502
534
|
...
|
|
503
535
|
|
|
504
536
|
def pack(
|
|
505
|
-
override_context: typing.Optional[
|
|
537
|
+
override_context: typing.Optional[
|
|
538
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
539
|
+
] = None,
|
|
506
540
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
507
541
|
undo: typing.Optional[bool] = None,
|
|
508
542
|
):
|
|
509
543
|
"""Pack an image as embedded data into the .blend file
|
|
510
544
|
|
|
511
|
-
:type override_context: typing.Optional[typing.Union[
|
|
545
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
512
546
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
513
547
|
:type undo: typing.Optional[bool]
|
|
514
548
|
"""
|
|
@@ -516,13 +550,15 @@ def pack(
|
|
|
516
550
|
...
|
|
517
551
|
|
|
518
552
|
def project_apply(
|
|
519
|
-
override_context: typing.Optional[
|
|
553
|
+
override_context: typing.Optional[
|
|
554
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
555
|
+
] = None,
|
|
520
556
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
521
557
|
undo: typing.Optional[bool] = None,
|
|
522
558
|
):
|
|
523
559
|
"""Project edited image back onto the object
|
|
524
560
|
|
|
525
|
-
:type override_context: typing.Optional[typing.Union[
|
|
561
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
526
562
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
527
563
|
:type undo: typing.Optional[bool]
|
|
528
564
|
"""
|
|
@@ -530,13 +566,15 @@ def project_apply(
|
|
|
530
566
|
...
|
|
531
567
|
|
|
532
568
|
def project_edit(
|
|
533
|
-
override_context: typing.Optional[
|
|
569
|
+
override_context: typing.Optional[
|
|
570
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
571
|
+
] = None,
|
|
534
572
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
535
573
|
undo: typing.Optional[bool] = None,
|
|
536
574
|
):
|
|
537
575
|
"""Edit a snapshot of the 3D Viewport in an external image editor
|
|
538
576
|
|
|
539
|
-
:type override_context: typing.Optional[typing.Union[
|
|
577
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
540
578
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
541
579
|
:type undo: typing.Optional[bool]
|
|
542
580
|
"""
|
|
@@ -544,13 +582,15 @@ def project_edit(
|
|
|
544
582
|
...
|
|
545
583
|
|
|
546
584
|
def read_viewlayers(
|
|
547
|
-
override_context: typing.Optional[
|
|
585
|
+
override_context: typing.Optional[
|
|
586
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
587
|
+
] = None,
|
|
548
588
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
549
589
|
undo: typing.Optional[bool] = None,
|
|
550
590
|
):
|
|
551
591
|
"""Read all the current scene's view layers from cache, as needed
|
|
552
592
|
|
|
553
|
-
:type override_context: typing.Optional[typing.Union[
|
|
593
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
554
594
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
555
595
|
:type undo: typing.Optional[bool]
|
|
556
596
|
"""
|
|
@@ -558,13 +598,15 @@ def read_viewlayers(
|
|
|
558
598
|
...
|
|
559
599
|
|
|
560
600
|
def reload(
|
|
561
|
-
override_context: typing.Optional[
|
|
601
|
+
override_context: typing.Optional[
|
|
602
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
603
|
+
] = None,
|
|
562
604
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
563
605
|
undo: typing.Optional[bool] = None,
|
|
564
606
|
):
|
|
565
607
|
"""Reload current image from disk
|
|
566
608
|
|
|
567
|
-
:type override_context: typing.Optional[typing.Union[
|
|
609
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
568
610
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
569
611
|
:type undo: typing.Optional[bool]
|
|
570
612
|
"""
|
|
@@ -572,13 +614,15 @@ def reload(
|
|
|
572
614
|
...
|
|
573
615
|
|
|
574
616
|
def remove_render_slot(
|
|
575
|
-
override_context: typing.Optional[
|
|
617
|
+
override_context: typing.Optional[
|
|
618
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
619
|
+
] = None,
|
|
576
620
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
577
621
|
undo: typing.Optional[bool] = None,
|
|
578
622
|
):
|
|
579
623
|
"""Remove the current render slot
|
|
580
624
|
|
|
581
|
-
:type override_context: typing.Optional[typing.Union[
|
|
625
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
582
626
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
583
627
|
:type undo: typing.Optional[bool]
|
|
584
628
|
"""
|
|
@@ -586,7 +630,9 @@ def remove_render_slot(
|
|
|
586
630
|
...
|
|
587
631
|
|
|
588
632
|
def render_border(
|
|
589
|
-
override_context: typing.Optional[
|
|
633
|
+
override_context: typing.Optional[
|
|
634
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
635
|
+
] = None,
|
|
590
636
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
591
637
|
undo: typing.Optional[bool] = None,
|
|
592
638
|
xmin: typing.Optional[typing.Any] = 0,
|
|
@@ -597,7 +643,7 @@ def render_border(
|
|
|
597
643
|
):
|
|
598
644
|
"""Set the boundaries of the render region and enable render region
|
|
599
645
|
|
|
600
|
-
:type override_context: typing.Optional[typing.Union[
|
|
646
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
601
647
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
602
648
|
:type undo: typing.Optional[bool]
|
|
603
649
|
:param xmin: X Min
|
|
@@ -615,7 +661,9 @@ def render_border(
|
|
|
615
661
|
...
|
|
616
662
|
|
|
617
663
|
def replace(
|
|
618
|
-
override_context: typing.Optional[
|
|
664
|
+
override_context: typing.Optional[
|
|
665
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
666
|
+
] = None,
|
|
619
667
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
620
668
|
undo: typing.Optional[bool] = None,
|
|
621
669
|
filepath: typing.Union[str, typing.Any] = "",
|
|
@@ -647,7 +695,7 @@ def replace(
|
|
|
647
695
|
):
|
|
648
696
|
"""Replace current image by another one from disk
|
|
649
697
|
|
|
650
|
-
:type override_context: typing.Optional[typing.Union[
|
|
698
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
651
699
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
652
700
|
:type undo: typing.Optional[bool]
|
|
653
701
|
:param filepath: File Path, Path to file
|
|
@@ -719,14 +767,16 @@ def replace(
|
|
|
719
767
|
...
|
|
720
768
|
|
|
721
769
|
def resize(
|
|
722
|
-
override_context: typing.Optional[
|
|
770
|
+
override_context: typing.Optional[
|
|
771
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
772
|
+
] = None,
|
|
723
773
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
724
774
|
undo: typing.Optional[bool] = None,
|
|
725
775
|
size: typing.Optional[typing.Any] = (0, 0),
|
|
726
776
|
):
|
|
727
777
|
"""Resize the image
|
|
728
778
|
|
|
729
|
-
:type override_context: typing.Optional[typing.Union[
|
|
779
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
730
780
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
731
781
|
:type undo: typing.Optional[bool]
|
|
732
782
|
:param size: Size
|
|
@@ -736,14 +786,16 @@ def resize(
|
|
|
736
786
|
...
|
|
737
787
|
|
|
738
788
|
def rotate_orthogonal(
|
|
739
|
-
override_context: typing.Optional[
|
|
789
|
+
override_context: typing.Optional[
|
|
790
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
791
|
+
] = None,
|
|
740
792
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
741
793
|
undo: typing.Optional[bool] = None,
|
|
742
794
|
degrees: typing.Optional[typing.Any] = "90",
|
|
743
795
|
):
|
|
744
796
|
"""Rotate the image
|
|
745
797
|
|
|
746
|
-
:type override_context: typing.Optional[typing.Union[
|
|
798
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
747
799
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
748
800
|
:type undo: typing.Optional[bool]
|
|
749
801
|
:param degrees: Degrees, Amount of rotation in degrees (90, 180, 270)
|
|
@@ -762,14 +814,16 @@ def rotate_orthogonal(
|
|
|
762
814
|
...
|
|
763
815
|
|
|
764
816
|
def sample(
|
|
765
|
-
override_context: typing.Optional[
|
|
817
|
+
override_context: typing.Optional[
|
|
818
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
819
|
+
] = None,
|
|
766
820
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
767
821
|
undo: typing.Optional[bool] = None,
|
|
768
822
|
size: typing.Optional[typing.Any] = 1,
|
|
769
823
|
):
|
|
770
824
|
"""Use mouse to sample a color in current image
|
|
771
825
|
|
|
772
|
-
:type override_context: typing.Optional[typing.Union[
|
|
826
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
773
827
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
774
828
|
:type undo: typing.Optional[bool]
|
|
775
829
|
:param size: Sample Size
|
|
@@ -779,7 +833,9 @@ def sample(
|
|
|
779
833
|
...
|
|
780
834
|
|
|
781
835
|
def sample_line(
|
|
782
|
-
override_context: typing.Optional[
|
|
836
|
+
override_context: typing.Optional[
|
|
837
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
838
|
+
] = None,
|
|
783
839
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
784
840
|
undo: typing.Optional[bool] = None,
|
|
785
841
|
xstart: typing.Optional[typing.Any] = 0,
|
|
@@ -791,7 +847,7 @@ def sample_line(
|
|
|
791
847
|
):
|
|
792
848
|
"""Sample a line and show it in Scope panels
|
|
793
849
|
|
|
794
|
-
:type override_context: typing.Optional[typing.Union[
|
|
850
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
795
851
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
796
852
|
:type undo: typing.Optional[bool]
|
|
797
853
|
:param xstart: X Start
|
|
@@ -811,13 +867,15 @@ def sample_line(
|
|
|
811
867
|
...
|
|
812
868
|
|
|
813
869
|
def save(
|
|
814
|
-
override_context: typing.Optional[
|
|
870
|
+
override_context: typing.Optional[
|
|
871
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
872
|
+
] = None,
|
|
815
873
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
816
874
|
undo: typing.Optional[bool] = None,
|
|
817
875
|
):
|
|
818
876
|
"""Save the image with current name and settings
|
|
819
877
|
|
|
820
|
-
:type override_context: typing.Optional[typing.Union[
|
|
878
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
821
879
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
822
880
|
:type undo: typing.Optional[bool]
|
|
823
881
|
"""
|
|
@@ -825,13 +883,15 @@ def save(
|
|
|
825
883
|
...
|
|
826
884
|
|
|
827
885
|
def save_all_modified(
|
|
828
|
-
override_context: typing.Optional[
|
|
886
|
+
override_context: typing.Optional[
|
|
887
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
888
|
+
] = None,
|
|
829
889
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
830
890
|
undo: typing.Optional[bool] = None,
|
|
831
891
|
):
|
|
832
892
|
"""Save all modified images
|
|
833
893
|
|
|
834
|
-
:type override_context: typing.Optional[typing.Union[
|
|
894
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
835
895
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
836
896
|
:type undo: typing.Optional[bool]
|
|
837
897
|
"""
|
|
@@ -839,7 +899,9 @@ def save_all_modified(
|
|
|
839
899
|
...
|
|
840
900
|
|
|
841
901
|
def save_as(
|
|
842
|
-
override_context: typing.Optional[
|
|
902
|
+
override_context: typing.Optional[
|
|
903
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
904
|
+
] = None,
|
|
843
905
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
844
906
|
undo: typing.Optional[bool] = None,
|
|
845
907
|
save_as_render: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
@@ -873,7 +935,7 @@ def save_as(
|
|
|
873
935
|
):
|
|
874
936
|
"""Save the image with another name and/or settings
|
|
875
937
|
|
|
876
|
-
:type override_context: typing.Optional[typing.Union[
|
|
938
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
877
939
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
878
940
|
:type undo: typing.Optional[bool]
|
|
879
941
|
: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
|
|
@@ -949,13 +1011,15 @@ def save_as(
|
|
|
949
1011
|
...
|
|
950
1012
|
|
|
951
1013
|
def save_sequence(
|
|
952
|
-
override_context: typing.Optional[
|
|
1014
|
+
override_context: typing.Optional[
|
|
1015
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1016
|
+
] = None,
|
|
953
1017
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
954
1018
|
undo: typing.Optional[bool] = None,
|
|
955
1019
|
):
|
|
956
1020
|
"""Save a sequence of images
|
|
957
1021
|
|
|
958
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1022
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
959
1023
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
960
1024
|
:type undo: typing.Optional[bool]
|
|
961
1025
|
"""
|
|
@@ -963,7 +1027,9 @@ def save_sequence(
|
|
|
963
1027
|
...
|
|
964
1028
|
|
|
965
1029
|
def tile_add(
|
|
966
|
-
override_context: typing.Optional[
|
|
1030
|
+
override_context: typing.Optional[
|
|
1031
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1032
|
+
] = None,
|
|
967
1033
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
968
1034
|
undo: typing.Optional[bool] = None,
|
|
969
1035
|
number: typing.Optional[typing.Any] = 1002,
|
|
@@ -979,7 +1045,7 @@ def tile_add(
|
|
|
979
1045
|
):
|
|
980
1046
|
"""Adds a tile to the image
|
|
981
1047
|
|
|
982
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1048
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
983
1049
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
984
1050
|
:type undo: typing.Optional[bool]
|
|
985
1051
|
:param number: Number, UDIM number of the tile
|
|
@@ -1007,7 +1073,9 @@ def tile_add(
|
|
|
1007
1073
|
...
|
|
1008
1074
|
|
|
1009
1075
|
def tile_fill(
|
|
1010
|
-
override_context: typing.Optional[
|
|
1076
|
+
override_context: typing.Optional[
|
|
1077
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1078
|
+
] = None,
|
|
1011
1079
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1012
1080
|
undo: typing.Optional[bool] = None,
|
|
1013
1081
|
color: typing.Optional[typing.Any] = (0.0, 0.0, 0.0, 1.0),
|
|
@@ -1019,7 +1087,7 @@ def tile_fill(
|
|
|
1019
1087
|
):
|
|
1020
1088
|
"""Fill the current tile with a generated image
|
|
1021
1089
|
|
|
1022
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1090
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1023
1091
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1024
1092
|
:type undo: typing.Optional[bool]
|
|
1025
1093
|
:param color: Color, Default fill color
|
|
@@ -1039,13 +1107,15 @@ def tile_fill(
|
|
|
1039
1107
|
...
|
|
1040
1108
|
|
|
1041
1109
|
def tile_remove(
|
|
1042
|
-
override_context: typing.Optional[
|
|
1110
|
+
override_context: typing.Optional[
|
|
1111
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1112
|
+
] = None,
|
|
1043
1113
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1044
1114
|
undo: typing.Optional[bool] = None,
|
|
1045
1115
|
):
|
|
1046
1116
|
"""Removes a tile from the image
|
|
1047
1117
|
|
|
1048
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1118
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1049
1119
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1050
1120
|
:type undo: typing.Optional[bool]
|
|
1051
1121
|
"""
|
|
@@ -1053,7 +1123,9 @@ def tile_remove(
|
|
|
1053
1123
|
...
|
|
1054
1124
|
|
|
1055
1125
|
def unpack(
|
|
1056
|
-
override_context: typing.Optional[
|
|
1126
|
+
override_context: typing.Optional[
|
|
1127
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1128
|
+
] = None,
|
|
1057
1129
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1058
1130
|
undo: typing.Optional[bool] = None,
|
|
1059
1131
|
method: typing.Optional[typing.Union[str, int]] = "USE_LOCAL",
|
|
@@ -1061,7 +1133,7 @@ def unpack(
|
|
|
1061
1133
|
):
|
|
1062
1134
|
"""Save an image packed in the .blend file to disk
|
|
1063
1135
|
|
|
1064
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1136
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1065
1137
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1066
1138
|
:type undo: typing.Optional[bool]
|
|
1067
1139
|
:param method: Method, How to unpack
|
|
@@ -1073,14 +1145,16 @@ def unpack(
|
|
|
1073
1145
|
...
|
|
1074
1146
|
|
|
1075
1147
|
def view_all(
|
|
1076
|
-
override_context: typing.Optional[
|
|
1148
|
+
override_context: typing.Optional[
|
|
1149
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1150
|
+
] = None,
|
|
1077
1151
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1078
1152
|
undo: typing.Optional[bool] = None,
|
|
1079
1153
|
fit_view: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1080
1154
|
):
|
|
1081
1155
|
"""View the entire image
|
|
1082
1156
|
|
|
1083
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1157
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1084
1158
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1085
1159
|
:type undo: typing.Optional[bool]
|
|
1086
1160
|
:param fit_view: Fit View, Fit frame to the viewport
|
|
@@ -1090,13 +1164,15 @@ def view_all(
|
|
|
1090
1164
|
...
|
|
1091
1165
|
|
|
1092
1166
|
def view_center_cursor(
|
|
1093
|
-
override_context: typing.Optional[
|
|
1167
|
+
override_context: typing.Optional[
|
|
1168
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1169
|
+
] = None,
|
|
1094
1170
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1095
1171
|
undo: typing.Optional[bool] = None,
|
|
1096
1172
|
):
|
|
1097
1173
|
"""Center the view so that the cursor is in the middle of the view
|
|
1098
1174
|
|
|
1099
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1175
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1100
1176
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1101
1177
|
:type undo: typing.Optional[bool]
|
|
1102
1178
|
"""
|
|
@@ -1104,14 +1180,16 @@ def view_center_cursor(
|
|
|
1104
1180
|
...
|
|
1105
1181
|
|
|
1106
1182
|
def view_cursor_center(
|
|
1107
|
-
override_context: typing.Optional[
|
|
1183
|
+
override_context: typing.Optional[
|
|
1184
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1185
|
+
] = None,
|
|
1108
1186
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1109
1187
|
undo: typing.Optional[bool] = None,
|
|
1110
1188
|
fit_view: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1111
1189
|
):
|
|
1112
1190
|
"""Set 2D Cursor To Center View location
|
|
1113
1191
|
|
|
1114
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1192
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1115
1193
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1116
1194
|
:type undo: typing.Optional[bool]
|
|
1117
1195
|
:param fit_view: Fit View, Fit frame to the viewport
|
|
@@ -1121,13 +1199,15 @@ def view_cursor_center(
|
|
|
1121
1199
|
...
|
|
1122
1200
|
|
|
1123
1201
|
def view_ndof(
|
|
1124
|
-
override_context: typing.Optional[
|
|
1202
|
+
override_context: typing.Optional[
|
|
1203
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1204
|
+
] = None,
|
|
1125
1205
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1126
1206
|
undo: typing.Optional[bool] = None,
|
|
1127
1207
|
):
|
|
1128
1208
|
"""Use a 3D mouse device to pan/zoom the view
|
|
1129
1209
|
|
|
1130
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1210
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1131
1211
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1132
1212
|
:type undo: typing.Optional[bool]
|
|
1133
1213
|
"""
|
|
@@ -1135,14 +1215,16 @@ def view_ndof(
|
|
|
1135
1215
|
...
|
|
1136
1216
|
|
|
1137
1217
|
def view_pan(
|
|
1138
|
-
override_context: typing.Optional[
|
|
1218
|
+
override_context: typing.Optional[
|
|
1219
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1220
|
+
] = None,
|
|
1139
1221
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1140
1222
|
undo: typing.Optional[bool] = None,
|
|
1141
1223
|
offset: typing.Optional[typing.Any] = (0.0, 0.0),
|
|
1142
1224
|
):
|
|
1143
1225
|
"""Pan the view
|
|
1144
1226
|
|
|
1145
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1227
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1146
1228
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1147
1229
|
:type undo: typing.Optional[bool]
|
|
1148
1230
|
:param offset: Offset, Offset in floating-point units, 1.0 is the width and height of the image
|
|
@@ -1152,13 +1234,15 @@ def view_pan(
|
|
|
1152
1234
|
...
|
|
1153
1235
|
|
|
1154
1236
|
def view_selected(
|
|
1155
|
-
override_context: typing.Optional[
|
|
1237
|
+
override_context: typing.Optional[
|
|
1238
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1239
|
+
] = None,
|
|
1156
1240
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1157
1241
|
undo: typing.Optional[bool] = None,
|
|
1158
1242
|
):
|
|
1159
1243
|
"""View all selected UVs
|
|
1160
1244
|
|
|
1161
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1245
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1162
1246
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1163
1247
|
:type undo: typing.Optional[bool]
|
|
1164
1248
|
"""
|
|
@@ -1166,7 +1250,9 @@ def view_selected(
|
|
|
1166
1250
|
...
|
|
1167
1251
|
|
|
1168
1252
|
def view_zoom(
|
|
1169
|
-
override_context: typing.Optional[
|
|
1253
|
+
override_context: typing.Optional[
|
|
1254
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1255
|
+
] = None,
|
|
1170
1256
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1171
1257
|
undo: typing.Optional[bool] = None,
|
|
1172
1258
|
factor: typing.Optional[typing.Any] = 0.0,
|
|
@@ -1174,7 +1260,7 @@ def view_zoom(
|
|
|
1174
1260
|
):
|
|
1175
1261
|
"""Zoom in/out the image
|
|
1176
1262
|
|
|
1177
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1263
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1178
1264
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1179
1265
|
:type undo: typing.Optional[bool]
|
|
1180
1266
|
:param factor: Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out
|
|
@@ -1186,7 +1272,9 @@ def view_zoom(
|
|
|
1186
1272
|
...
|
|
1187
1273
|
|
|
1188
1274
|
def view_zoom_border(
|
|
1189
|
-
override_context: typing.Optional[
|
|
1275
|
+
override_context: typing.Optional[
|
|
1276
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1277
|
+
] = None,
|
|
1190
1278
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1191
1279
|
undo: typing.Optional[bool] = None,
|
|
1192
1280
|
xmin: typing.Optional[typing.Any] = 0,
|
|
@@ -1198,7 +1286,7 @@ def view_zoom_border(
|
|
|
1198
1286
|
):
|
|
1199
1287
|
"""Zoom in the view to the nearest item contained in the border
|
|
1200
1288
|
|
|
1201
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1289
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1202
1290
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1203
1291
|
:type undo: typing.Optional[bool]
|
|
1204
1292
|
:param xmin: X Min
|
|
@@ -1218,14 +1306,16 @@ def view_zoom_border(
|
|
|
1218
1306
|
...
|
|
1219
1307
|
|
|
1220
1308
|
def view_zoom_in(
|
|
1221
|
-
override_context: typing.Optional[
|
|
1309
|
+
override_context: typing.Optional[
|
|
1310
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1311
|
+
] = None,
|
|
1222
1312
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1223
1313
|
undo: typing.Optional[bool] = None,
|
|
1224
1314
|
location: typing.Optional[typing.Any] = (0.0, 0.0),
|
|
1225
1315
|
):
|
|
1226
1316
|
"""Zoom in the image (centered around 2D cursor)
|
|
1227
1317
|
|
|
1228
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1318
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1229
1319
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1230
1320
|
:type undo: typing.Optional[bool]
|
|
1231
1321
|
:param location: Location, Cursor location in screen coordinates
|
|
@@ -1235,14 +1325,16 @@ def view_zoom_in(
|
|
|
1235
1325
|
...
|
|
1236
1326
|
|
|
1237
1327
|
def view_zoom_out(
|
|
1238
|
-
override_context: typing.Optional[
|
|
1328
|
+
override_context: typing.Optional[
|
|
1329
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1330
|
+
] = None,
|
|
1239
1331
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1240
1332
|
undo: typing.Optional[bool] = None,
|
|
1241
1333
|
location: typing.Optional[typing.Any] = (0.0, 0.0),
|
|
1242
1334
|
):
|
|
1243
1335
|
"""Zoom out the image (centered around 2D cursor)
|
|
1244
1336
|
|
|
1245
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1337
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1246
1338
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1247
1339
|
:type undo: typing.Optional[bool]
|
|
1248
1340
|
:param location: Location, Cursor location in screen coordinates
|
|
@@ -1252,14 +1344,16 @@ def view_zoom_out(
|
|
|
1252
1344
|
...
|
|
1253
1345
|
|
|
1254
1346
|
def view_zoom_ratio(
|
|
1255
|
-
override_context: typing.Optional[
|
|
1347
|
+
override_context: typing.Optional[
|
|
1348
|
+
typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]
|
|
1349
|
+
] = None,
|
|
1256
1350
|
execution_context: typing.Optional[typing.Union[str, int]] = None,
|
|
1257
1351
|
undo: typing.Optional[bool] = None,
|
|
1258
1352
|
ratio: typing.Optional[typing.Any] = 0.0,
|
|
1259
1353
|
):
|
|
1260
1354
|
"""Set zoom ratio of the view
|
|
1261
1355
|
|
|
1262
|
-
:type override_context: typing.Optional[typing.Union[
|
|
1356
|
+
:type override_context: typing.Optional[typing.Union[typing.Dict[str, typing.Any], bpy.types.Context]]
|
|
1263
1357
|
:type execution_context: typing.Optional[typing.Union[str, int]]
|
|
1264
1358
|
:type undo: typing.Optional[bool]
|
|
1265
1359
|
:param ratio: Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out
|