fake-bpy-module 20240620__py3-none-any.whl → 20240622__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- bl_ui/space_userpref/__init__.pyi +225 -0
- bpy/ops/action/__init__.pyi +50 -50
- bpy/ops/anim/__init__.pyi +94 -94
- bpy/ops/armature/__init__.pyi +54 -54
- bpy/ops/asset/__init__.pyi +50 -50
- bpy/ops/brush/__init__.pyi +10 -10
- bpy/ops/buttons/__init__.pyi +88 -88
- bpy/ops/cachefile/__init__.pyi +88 -88
- bpy/ops/camera/__init__.pyi +14 -14
- bpy/ops/clip/__init__.pyi +175 -174
- bpy/ops/cloth/__init__.pyi +6 -6
- bpy/ops/collection/__init__.pyi +8 -8
- bpy/ops/console/__init__.pyi +26 -26
- bpy/ops/constraint/__init__.pyi +42 -42
- bpy/ops/curve/__init__.pyi +167 -122
- bpy/ops/curves/__init__.pyi +75 -58
- bpy/ops/cycles/__init__.pyi +10 -10
- bpy/ops/ed/__init__.pyi +50 -50
- bpy/ops/export_anim/__init__.pyi +14 -14
- bpy/ops/export_scene/__init__.pyi +250 -250
- bpy/ops/extensions/__init__.pyi +73 -73
- bpy/ops/file/__init__.pyi +94 -94
- bpy/ops/fluid/__init__.pyi +6 -6
- bpy/ops/font/__init__.pyi +100 -100
- bpy/ops/geometry/__init__.pyi +20 -20
- bpy/ops/gizmogroup/__init__.pyi +10 -10
- bpy/ops/gpencil/__init__.pyi +411 -410
- bpy/ops/graph/__init__.pyi +194 -194
- bpy/ops/grease_pencil/__init__.pyi +100 -100
- bpy/ops/image/__init__.pyi +399 -390
- bpy/ops/import_anim/__init__.pyi +16 -16
- bpy/ops/import_curve/__init__.pyi +4 -4
- bpy/ops/import_scene/__init__.pyi +56 -56
- bpy/ops/info/__init__.pyi +14 -14
- bpy/ops/lattice/__init__.pyi +8 -8
- bpy/ops/marker/__init__.pyi +34 -34
- bpy/ops/mask/__init__.pyi +63 -62
- bpy/ops/mball/__init__.pyi +12 -12
- bpy/ops/mesh/__init__.pyi +893 -790
- bpy/ops/nla/__init__.pyi +70 -70
- bpy/ops/node/__init__.pyi +192 -192
- bpy/ops/object/__init__.pyi +1013 -840
- bpy/ops/outliner/__init__.pyi +44 -44
- bpy/ops/paint/__init__.pyi +169 -168
- bpy/ops/paintcurve/__init__.pyi +12 -12
- bpy/ops/palette/__init__.pyi +4 -4
- bpy/ops/particle/__init__.pyi +34 -34
- bpy/ops/pose/__init__.pyi +60 -60
- bpy/ops/poselib/__init__.pyi +18 -18
- bpy/ops/preferences/__init__.pyi +150 -150
- bpy/ops/ptcache/__init__.pyi +4 -4
- bpy/ops/render/__init__.pyi +56 -56
- bpy/ops/rigidbody/__init__.pyi +8 -8
- bpy/ops/scene/__init__.pyi +20 -20
- bpy/ops/screen/__init__.pyi +128 -128
- bpy/ops/script/__init__.pyi +6 -6
- bpy/ops/sculpt/__init__.pyi +207 -202
- bpy/ops/sculpt_curves/__init__.pyi +12 -12
- bpy/ops/sequencer/__init__.pyi +465 -464
- bpy/ops/sound/__init__.pyi +154 -154
- bpy/ops/spreadsheet/__init__.pyi +6 -6
- bpy/ops/surface/__init__.pyi +109 -60
- bpy/ops/text/__init__.pyi +110 -110
- bpy/ops/text_editor/__init__.pyi +6 -6
- bpy/ops/transform/__init__.pyi +628 -566
- bpy/ops/ui/__init__.pyi +25 -24
- bpy/ops/uilist/__init__.pyi +12 -12
- bpy/ops/uv/__init__.pyi +235 -234
- bpy/ops/view2d/__init__.pyi +72 -72
- bpy/ops/view3d/__init__.pyi +144 -144
- bpy/ops/wm/__init__.pyi +1813 -1806
- bpy/ops/workspace/__init__.pyi +4 -4
- bpy/types/__init__.pyi +1614 -1805
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240622.dist-info}/METADATA +3 -5
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240622.dist-info}/RECORD +77 -77
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240622.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240622.dist-info}/top_level.txt +0 -0
bpy/ops/view3d/__init__.pyi
CHANGED
|
@@ -11,9 +11,9 @@ def bone_select_menu(
|
|
|
11
11
|
undo: bool | None = None,
|
|
12
12
|
*,
|
|
13
13
|
name: str | None = "",
|
|
14
|
-
extend: bool |
|
|
15
|
-
deselect: bool |
|
|
16
|
-
toggle: bool |
|
|
14
|
+
extend: bool | None = False,
|
|
15
|
+
deselect: bool | None = False,
|
|
16
|
+
toggle: bool | None = False,
|
|
17
17
|
):
|
|
18
18
|
"""Menu bone selection
|
|
19
19
|
|
|
@@ -23,11 +23,11 @@ def bone_select_menu(
|
|
|
23
23
|
:param name: Bone Name
|
|
24
24
|
:type name: str | None
|
|
25
25
|
:param extend: Extend
|
|
26
|
-
:type extend: bool |
|
|
26
|
+
:type extend: bool | None
|
|
27
27
|
:param deselect: Deselect
|
|
28
|
-
:type deselect: bool |
|
|
28
|
+
:type deselect: bool | None
|
|
29
29
|
:param toggle: Toggle
|
|
30
|
-
:type toggle: bool |
|
|
30
|
+
:type toggle: bool | None
|
|
31
31
|
"""
|
|
32
32
|
|
|
33
33
|
...
|
|
@@ -37,10 +37,10 @@ def camera_background_image_add(
|
|
|
37
37
|
execution_context: int | str | None = None,
|
|
38
38
|
undo: bool | None = None,
|
|
39
39
|
*,
|
|
40
|
-
filepath: str
|
|
41
|
-
relative_path: bool |
|
|
42
|
-
name: str
|
|
43
|
-
session_uid:
|
|
40
|
+
filepath: str = "",
|
|
41
|
+
relative_path: bool | None = True,
|
|
42
|
+
name: str = "",
|
|
43
|
+
session_uid: int | None = 0,
|
|
44
44
|
):
|
|
45
45
|
"""Add a new background image to the active camera
|
|
46
46
|
|
|
@@ -48,13 +48,13 @@ def camera_background_image_add(
|
|
|
48
48
|
:type execution_context: int | str | None
|
|
49
49
|
:type undo: bool | None
|
|
50
50
|
:param filepath: Filepath, Path to image file
|
|
51
|
-
:type filepath: str
|
|
51
|
+
:type filepath: str
|
|
52
52
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
53
|
-
:type relative_path: bool |
|
|
53
|
+
:type relative_path: bool | None
|
|
54
54
|
:param name: Name, Name of the data-block to use by the operator
|
|
55
|
-
:type name: str
|
|
55
|
+
:type name: str
|
|
56
56
|
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
57
|
-
:type session_uid:
|
|
57
|
+
:type session_uid: int | None
|
|
58
58
|
"""
|
|
59
59
|
|
|
60
60
|
...
|
|
@@ -64,7 +64,7 @@ def camera_background_image_remove(
|
|
|
64
64
|
execution_context: int | str | None = None,
|
|
65
65
|
undo: bool | None = None,
|
|
66
66
|
*,
|
|
67
|
-
index:
|
|
67
|
+
index: int | None = 0,
|
|
68
68
|
):
|
|
69
69
|
"""Remove a background image from the camera
|
|
70
70
|
|
|
@@ -72,7 +72,7 @@ def camera_background_image_remove(
|
|
|
72
72
|
:type execution_context: int | str | None
|
|
73
73
|
:type undo: bool | None
|
|
74
74
|
:param index: Index, Background image index to remove
|
|
75
|
-
:type index:
|
|
75
|
+
:type index: int | None
|
|
76
76
|
"""
|
|
77
77
|
|
|
78
78
|
...
|
|
@@ -124,11 +124,11 @@ def clip_border(
|
|
|
124
124
|
execution_context: int | str | None = None,
|
|
125
125
|
undo: bool | None = None,
|
|
126
126
|
*,
|
|
127
|
-
xmin:
|
|
128
|
-
xmax:
|
|
129
|
-
ymin:
|
|
130
|
-
ymax:
|
|
131
|
-
wait_for_input: bool |
|
|
127
|
+
xmin: int | None = 0,
|
|
128
|
+
xmax: int | None = 0,
|
|
129
|
+
ymin: int | None = 0,
|
|
130
|
+
ymax: int | None = 0,
|
|
131
|
+
wait_for_input: bool | None = True,
|
|
132
132
|
):
|
|
133
133
|
"""Set the view clipping region
|
|
134
134
|
|
|
@@ -136,15 +136,15 @@ def clip_border(
|
|
|
136
136
|
:type execution_context: int | str | None
|
|
137
137
|
:type undo: bool | None
|
|
138
138
|
:param xmin: X Min
|
|
139
|
-
:type xmin:
|
|
139
|
+
:type xmin: int | None
|
|
140
140
|
:param xmax: X Max
|
|
141
|
-
:type xmax:
|
|
141
|
+
:type xmax: int | None
|
|
142
142
|
:param ymin: Y Min
|
|
143
|
-
:type ymin:
|
|
143
|
+
:type ymin: int | None
|
|
144
144
|
:param ymax: Y Max
|
|
145
|
-
:type ymax:
|
|
145
|
+
:type ymax: int | None
|
|
146
146
|
:param wait_for_input: Wait for Input
|
|
147
|
-
:type wait_for_input: bool |
|
|
147
|
+
:type wait_for_input: bool | None
|
|
148
148
|
"""
|
|
149
149
|
|
|
150
150
|
...
|
|
@@ -168,7 +168,7 @@ def cursor3d(
|
|
|
168
168
|
execution_context: int | str | None = None,
|
|
169
169
|
undo: bool | None = None,
|
|
170
170
|
*,
|
|
171
|
-
use_depth: bool |
|
|
171
|
+
use_depth: bool | None = True,
|
|
172
172
|
orientation: str | None = "VIEW",
|
|
173
173
|
):
|
|
174
174
|
"""Set the location of the 3D cursor
|
|
@@ -177,7 +177,7 @@ def cursor3d(
|
|
|
177
177
|
:type execution_context: int | str | None
|
|
178
178
|
:type undo: bool | None
|
|
179
179
|
:param use_depth: Surface Project, Project onto the surface
|
|
180
|
-
:type use_depth: bool |
|
|
180
|
+
:type use_depth: bool | None
|
|
181
181
|
:param orientation: Orientation, Preset viewpoint to use
|
|
182
182
|
|
|
183
183
|
NONE
|
|
@@ -201,10 +201,10 @@ def dolly(
|
|
|
201
201
|
execution_context: int | str | None = None,
|
|
202
202
|
undo: bool | None = None,
|
|
203
203
|
*,
|
|
204
|
-
mx:
|
|
205
|
-
my:
|
|
206
|
-
delta:
|
|
207
|
-
use_cursor_init: bool |
|
|
204
|
+
mx: int | None = 0,
|
|
205
|
+
my: int | None = 0,
|
|
206
|
+
delta: int | None = 0,
|
|
207
|
+
use_cursor_init: bool | None = True,
|
|
208
208
|
):
|
|
209
209
|
"""Dolly in/out in the view
|
|
210
210
|
|
|
@@ -212,13 +212,13 @@ def dolly(
|
|
|
212
212
|
:type execution_context: int | str | None
|
|
213
213
|
:type undo: bool | None
|
|
214
214
|
:param mx: Region Position X
|
|
215
|
-
:type mx:
|
|
215
|
+
:type mx: int | None
|
|
216
216
|
:param my: Region Position Y
|
|
217
|
-
:type my:
|
|
217
|
+
:type my: int | None
|
|
218
218
|
:param delta: Delta
|
|
219
|
-
:type delta:
|
|
219
|
+
:type delta: int | None
|
|
220
220
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
221
|
-
:type use_cursor_init: bool |
|
|
221
|
+
:type use_cursor_init: bool | None
|
|
222
222
|
"""
|
|
223
223
|
|
|
224
224
|
...
|
|
@@ -228,8 +228,8 @@ def drop_world(
|
|
|
228
228
|
execution_context: int | str | None = None,
|
|
229
229
|
undo: bool | None = None,
|
|
230
230
|
*,
|
|
231
|
-
name: str
|
|
232
|
-
session_uid:
|
|
231
|
+
name: str = "",
|
|
232
|
+
session_uid: int | None = 0,
|
|
233
233
|
):
|
|
234
234
|
"""Drop a world into the scene
|
|
235
235
|
|
|
@@ -237,9 +237,9 @@ def drop_world(
|
|
|
237
237
|
:type execution_context: int | str | None
|
|
238
238
|
:type undo: bool | None
|
|
239
239
|
:param name: Name, Name of the data-block to use by the operator
|
|
240
|
-
:type name: str
|
|
240
|
+
:type name: str
|
|
241
241
|
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
242
|
-
:type session_uid:
|
|
242
|
+
:type session_uid: int | None
|
|
243
243
|
"""
|
|
244
244
|
|
|
245
245
|
...
|
|
@@ -277,7 +277,7 @@ def edit_mesh_extrude_move_normal(
|
|
|
277
277
|
execution_context: int | str | None = None,
|
|
278
278
|
undo: bool | None = None,
|
|
279
279
|
*,
|
|
280
|
-
dissolve_and_intersect: bool |
|
|
280
|
+
dissolve_and_intersect: bool | None = False,
|
|
281
281
|
):
|
|
282
282
|
"""Extrude region together along the average normal
|
|
283
283
|
|
|
@@ -285,7 +285,7 @@ def edit_mesh_extrude_move_normal(
|
|
|
285
285
|
:type execution_context: int | str | None
|
|
286
286
|
:type undo: bool | None
|
|
287
287
|
:param dissolve_and_intersect: dissolve_and_intersect, Dissolves adjacent faces and intersects new geometry
|
|
288
|
-
:type dissolve_and_intersect: bool |
|
|
288
|
+
:type dissolve_and_intersect: bool | None
|
|
289
289
|
"""
|
|
290
290
|
|
|
291
291
|
...
|
|
@@ -328,7 +328,7 @@ def interactive_add(
|
|
|
328
328
|
plane_origin_depth: str | None = "EDGE",
|
|
329
329
|
plane_aspect_base: str | None = "FREE",
|
|
330
330
|
plane_aspect_depth: str | None = "FREE",
|
|
331
|
-
wait_for_input: bool |
|
|
331
|
+
wait_for_input: bool | None = True,
|
|
332
332
|
):
|
|
333
333
|
"""Interactively add an object
|
|
334
334
|
|
|
@@ -370,7 +370,7 @@ def interactive_add(
|
|
|
370
370
|
Fixed -- Use a fixed 1:1 aspect.
|
|
371
371
|
:type plane_aspect_depth: str | None
|
|
372
372
|
:param wait_for_input: Wait for Input
|
|
373
|
-
:type wait_for_input: bool |
|
|
373
|
+
:type wait_for_input: bool | None
|
|
374
374
|
"""
|
|
375
375
|
|
|
376
376
|
...
|
|
@@ -380,7 +380,7 @@ def localview(
|
|
|
380
380
|
execution_context: int | str | None = None,
|
|
381
381
|
undo: bool | None = None,
|
|
382
382
|
*,
|
|
383
|
-
frame_selected: bool |
|
|
383
|
+
frame_selected: bool | None = True,
|
|
384
384
|
):
|
|
385
385
|
"""Toggle display of selected object(s) separately and centered in view
|
|
386
386
|
|
|
@@ -388,7 +388,7 @@ def localview(
|
|
|
388
388
|
:type execution_context: int | str | None
|
|
389
389
|
:type undo: bool | None
|
|
390
390
|
:param frame_selected: Frame Selected, Move the view to frame the selected objects
|
|
391
|
-
:type frame_selected: bool |
|
|
391
|
+
:type frame_selected: bool | None
|
|
392
392
|
"""
|
|
393
393
|
|
|
394
394
|
...
|
|
@@ -412,7 +412,7 @@ def move(
|
|
|
412
412
|
execution_context: int | str | None = None,
|
|
413
413
|
undo: bool | None = None,
|
|
414
414
|
*,
|
|
415
|
-
use_cursor_init: bool |
|
|
415
|
+
use_cursor_init: bool | None = True,
|
|
416
416
|
):
|
|
417
417
|
"""Move the view
|
|
418
418
|
|
|
@@ -420,7 +420,7 @@ def move(
|
|
|
420
420
|
:type execution_context: int | str | None
|
|
421
421
|
:type undo: bool | None
|
|
422
422
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
423
|
-
:type use_cursor_init: bool |
|
|
423
|
+
:type use_cursor_init: bool | None
|
|
424
424
|
"""
|
|
425
425
|
|
|
426
426
|
...
|
|
@@ -528,8 +528,8 @@ def pastebuffer(
|
|
|
528
528
|
execution_context: int | str | None = None,
|
|
529
529
|
undo: bool | None = None,
|
|
530
530
|
*,
|
|
531
|
-
autoselect: bool |
|
|
532
|
-
active_collection: bool |
|
|
531
|
+
autoselect: bool | None = True,
|
|
532
|
+
active_collection: bool | None = True,
|
|
533
533
|
):
|
|
534
534
|
"""Paste objects from the internal clipboard
|
|
535
535
|
|
|
@@ -537,9 +537,9 @@ def pastebuffer(
|
|
|
537
537
|
:type execution_context: int | str | None
|
|
538
538
|
:type undo: bool | None
|
|
539
539
|
:param autoselect: Select, Select pasted objects
|
|
540
|
-
:type autoselect: bool |
|
|
540
|
+
:type autoselect: bool | None
|
|
541
541
|
:param active_collection: Active Collection, Put pasted objects in the active collection
|
|
542
|
-
:type active_collection: bool |
|
|
542
|
+
:type active_collection: bool | None
|
|
543
543
|
"""
|
|
544
544
|
|
|
545
545
|
...
|
|
@@ -549,11 +549,11 @@ def render_border(
|
|
|
549
549
|
execution_context: int | str | None = None,
|
|
550
550
|
undo: bool | None = None,
|
|
551
551
|
*,
|
|
552
|
-
xmin:
|
|
553
|
-
xmax:
|
|
554
|
-
ymin:
|
|
555
|
-
ymax:
|
|
556
|
-
wait_for_input: bool |
|
|
552
|
+
xmin: int | None = 0,
|
|
553
|
+
xmax: int | None = 0,
|
|
554
|
+
ymin: int | None = 0,
|
|
555
|
+
ymax: int | None = 0,
|
|
556
|
+
wait_for_input: bool | None = True,
|
|
557
557
|
):
|
|
558
558
|
"""Set the boundaries of the border render and enable border render
|
|
559
559
|
|
|
@@ -561,15 +561,15 @@ def render_border(
|
|
|
561
561
|
:type execution_context: int | str | None
|
|
562
562
|
:type undo: bool | None
|
|
563
563
|
:param xmin: X Min
|
|
564
|
-
:type xmin:
|
|
564
|
+
:type xmin: int | None
|
|
565
565
|
:param xmax: X Max
|
|
566
|
-
:type xmax:
|
|
566
|
+
:type xmax: int | None
|
|
567
567
|
:param ymin: Y Min
|
|
568
|
-
:type ymin:
|
|
568
|
+
:type ymin: int | None
|
|
569
569
|
:param ymax: Y Max
|
|
570
|
-
:type ymax:
|
|
570
|
+
:type ymax: int | None
|
|
571
571
|
:param wait_for_input: Wait for Input
|
|
572
|
-
:type wait_for_input: bool |
|
|
572
|
+
:type wait_for_input: bool | None
|
|
573
573
|
"""
|
|
574
574
|
|
|
575
575
|
...
|
|
@@ -579,7 +579,7 @@ def rotate(
|
|
|
579
579
|
execution_context: int | str | None = None,
|
|
580
580
|
undo: bool | None = None,
|
|
581
581
|
*,
|
|
582
|
-
use_cursor_init: bool |
|
|
582
|
+
use_cursor_init: bool | None = True,
|
|
583
583
|
):
|
|
584
584
|
"""Rotate the view
|
|
585
585
|
|
|
@@ -587,7 +587,7 @@ def rotate(
|
|
|
587
587
|
:type execution_context: int | str | None
|
|
588
588
|
:type undo: bool | None
|
|
589
589
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
590
|
-
:type use_cursor_init: bool |
|
|
590
|
+
:type use_cursor_init: bool | None
|
|
591
591
|
"""
|
|
592
592
|
|
|
593
593
|
...
|
|
@@ -625,15 +625,15 @@ def select(
|
|
|
625
625
|
execution_context: int | str | None = None,
|
|
626
626
|
undo: bool | None = None,
|
|
627
627
|
*,
|
|
628
|
-
extend: bool |
|
|
629
|
-
deselect: bool |
|
|
630
|
-
toggle: bool |
|
|
631
|
-
deselect_all: bool |
|
|
632
|
-
select_passthrough: bool |
|
|
633
|
-
center: bool |
|
|
634
|
-
enumerate: bool |
|
|
635
|
-
object: bool |
|
|
636
|
-
location:
|
|
628
|
+
extend: bool | None = False,
|
|
629
|
+
deselect: bool | None = False,
|
|
630
|
+
toggle: bool | None = False,
|
|
631
|
+
deselect_all: bool | None = False,
|
|
632
|
+
select_passthrough: bool | None = False,
|
|
633
|
+
center: bool | None = False,
|
|
634
|
+
enumerate: bool | None = False,
|
|
635
|
+
object: bool | None = False,
|
|
636
|
+
location: collections.abc.Iterable[int] | None = (0, 0),
|
|
637
637
|
):
|
|
638
638
|
"""Select and activate item(s)
|
|
639
639
|
|
|
@@ -641,23 +641,23 @@ def select(
|
|
|
641
641
|
:type execution_context: int | str | None
|
|
642
642
|
:type undo: bool | None
|
|
643
643
|
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
644
|
-
:type extend: bool |
|
|
644
|
+
:type extend: bool | None
|
|
645
645
|
:param deselect: Deselect, Remove from selection
|
|
646
|
-
:type deselect: bool |
|
|
646
|
+
:type deselect: bool | None
|
|
647
647
|
:param toggle: Toggle Selection, Toggle the selection
|
|
648
|
-
:type toggle: bool |
|
|
648
|
+
:type toggle: bool | None
|
|
649
649
|
:param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
|
|
650
|
-
:type deselect_all: bool |
|
|
650
|
+
:type deselect_all: bool | None
|
|
651
651
|
:param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
|
|
652
|
-
:type select_passthrough: bool |
|
|
652
|
+
:type select_passthrough: bool | None
|
|
653
653
|
:param center: Center, Use the object center when selecting, in edit mode used to extend object selection
|
|
654
|
-
:type center: bool |
|
|
654
|
+
:type center: bool | None
|
|
655
655
|
:param enumerate: Enumerate, List objects under the mouse (object mode only)
|
|
656
|
-
:type enumerate: bool |
|
|
656
|
+
:type enumerate: bool | None
|
|
657
657
|
:param object: Object, Use object selection (edit mode only)
|
|
658
|
-
:type object: bool |
|
|
658
|
+
:type object: bool | None
|
|
659
659
|
:param location: Location, Mouse location
|
|
660
|
-
:type location:
|
|
660
|
+
:type location: collections.abc.Iterable[int] | None
|
|
661
661
|
"""
|
|
662
662
|
|
|
663
663
|
...
|
|
@@ -667,11 +667,11 @@ def select_box(
|
|
|
667
667
|
execution_context: int | str | None = None,
|
|
668
668
|
undo: bool | None = None,
|
|
669
669
|
*,
|
|
670
|
-
xmin:
|
|
671
|
-
xmax:
|
|
672
|
-
ymin:
|
|
673
|
-
ymax:
|
|
674
|
-
wait_for_input: bool |
|
|
670
|
+
xmin: int | None = 0,
|
|
671
|
+
xmax: int | None = 0,
|
|
672
|
+
ymin: int | None = 0,
|
|
673
|
+
ymax: int | None = 0,
|
|
674
|
+
wait_for_input: bool | None = True,
|
|
675
675
|
mode: str | None = "SET",
|
|
676
676
|
):
|
|
677
677
|
"""Select items using box selection
|
|
@@ -680,15 +680,15 @@ def select_box(
|
|
|
680
680
|
:type execution_context: int | str | None
|
|
681
681
|
:type undo: bool | None
|
|
682
682
|
:param xmin: X Min
|
|
683
|
-
:type xmin:
|
|
683
|
+
:type xmin: int | None
|
|
684
684
|
:param xmax: X Max
|
|
685
|
-
:type xmax:
|
|
685
|
+
:type xmax: int | None
|
|
686
686
|
:param ymin: Y Min
|
|
687
|
-
:type ymin:
|
|
687
|
+
:type ymin: int | None
|
|
688
688
|
:param ymax: Y Max
|
|
689
|
-
:type ymax:
|
|
689
|
+
:type ymax: int | None
|
|
690
690
|
:param wait_for_input: Wait for Input
|
|
691
|
-
:type wait_for_input: bool |
|
|
691
|
+
:type wait_for_input: bool | None
|
|
692
692
|
:param mode: Mode
|
|
693
693
|
|
|
694
694
|
SET
|
|
@@ -715,10 +715,10 @@ def select_circle(
|
|
|
715
715
|
execution_context: int | str | None = None,
|
|
716
716
|
undo: bool | None = None,
|
|
717
717
|
*,
|
|
718
|
-
x:
|
|
719
|
-
y:
|
|
720
|
-
radius:
|
|
721
|
-
wait_for_input: bool |
|
|
718
|
+
x: int | None = 0,
|
|
719
|
+
y: int | None = 0,
|
|
720
|
+
radius: int | None = 25,
|
|
721
|
+
wait_for_input: bool | None = True,
|
|
722
722
|
mode: str | None = "SET",
|
|
723
723
|
):
|
|
724
724
|
"""Select items using circle selection
|
|
@@ -727,13 +727,13 @@ def select_circle(
|
|
|
727
727
|
:type execution_context: int | str | None
|
|
728
728
|
:type undo: bool | None
|
|
729
729
|
:param x: X
|
|
730
|
-
:type x:
|
|
730
|
+
:type x: int | None
|
|
731
731
|
:param y: Y
|
|
732
|
-
:type y:
|
|
732
|
+
:type y: int | None
|
|
733
733
|
:param radius: Radius
|
|
734
|
-
:type radius:
|
|
734
|
+
:type radius: int | None
|
|
735
735
|
:param wait_for_input: Wait for Input
|
|
736
|
-
:type wait_for_input: bool |
|
|
736
|
+
:type wait_for_input: bool | None
|
|
737
737
|
:param mode: Mode
|
|
738
738
|
|
|
739
739
|
SET
|
|
@@ -791,9 +791,9 @@ def select_menu(
|
|
|
791
791
|
undo: bool | None = None,
|
|
792
792
|
*,
|
|
793
793
|
name: str | None = "",
|
|
794
|
-
extend: bool |
|
|
795
|
-
deselect: bool |
|
|
796
|
-
toggle: bool |
|
|
794
|
+
extend: bool | None = False,
|
|
795
|
+
deselect: bool | None = False,
|
|
796
|
+
toggle: bool | None = False,
|
|
797
797
|
):
|
|
798
798
|
"""Menu object selection
|
|
799
799
|
|
|
@@ -803,11 +803,11 @@ def select_menu(
|
|
|
803
803
|
:param name: Object Name
|
|
804
804
|
:type name: str | None
|
|
805
805
|
:param extend: Extend
|
|
806
|
-
:type extend: bool |
|
|
806
|
+
:type extend: bool | None
|
|
807
807
|
:param deselect: Deselect
|
|
808
|
-
:type deselect: bool |
|
|
808
|
+
:type deselect: bool | None
|
|
809
809
|
:param toggle: Toggle
|
|
810
|
-
:type toggle: bool |
|
|
810
|
+
:type toggle: bool | None
|
|
811
811
|
"""
|
|
812
812
|
|
|
813
813
|
...
|
|
@@ -901,7 +901,7 @@ def snap_selected_to_cursor(
|
|
|
901
901
|
execution_context: int | str | None = None,
|
|
902
902
|
undo: bool | None = None,
|
|
903
903
|
*,
|
|
904
|
-
use_offset: bool |
|
|
904
|
+
use_offset: bool | None = True,
|
|
905
905
|
):
|
|
906
906
|
"""Snap selected item(s) to the 3D cursor
|
|
907
907
|
|
|
@@ -909,7 +909,7 @@ def snap_selected_to_cursor(
|
|
|
909
909
|
:type execution_context: int | str | None
|
|
910
910
|
:type undo: bool | None
|
|
911
911
|
:param use_offset: Offset, If the selection should be snapped as a whole or by each object center
|
|
912
|
-
:type use_offset: bool |
|
|
912
|
+
:type use_offset: bool | None
|
|
913
913
|
"""
|
|
914
914
|
|
|
915
915
|
...
|
|
@@ -991,7 +991,7 @@ def transform_gizmo_set(
|
|
|
991
991
|
execution_context: int | str | None = None,
|
|
992
992
|
undo: bool | None = None,
|
|
993
993
|
*,
|
|
994
|
-
extend: bool |
|
|
994
|
+
extend: bool | None = False,
|
|
995
995
|
type: set[str] | None = {},
|
|
996
996
|
):
|
|
997
997
|
"""Set the current transform gizmo
|
|
@@ -1000,7 +1000,7 @@ def transform_gizmo_set(
|
|
|
1000
1000
|
:type execution_context: int | str | None
|
|
1001
1001
|
:type undo: bool | None
|
|
1002
1002
|
:param extend: Extend
|
|
1003
|
-
:type extend: bool |
|
|
1003
|
+
:type extend: bool | None
|
|
1004
1004
|
:param type: Type
|
|
1005
1005
|
:type type: set[str] | None
|
|
1006
1006
|
"""
|
|
@@ -1012,8 +1012,8 @@ def view_all(
|
|
|
1012
1012
|
execution_context: int | str | None = None,
|
|
1013
1013
|
undo: bool | None = None,
|
|
1014
1014
|
*,
|
|
1015
|
-
use_all_regions: bool |
|
|
1016
|
-
center: bool |
|
|
1015
|
+
use_all_regions: bool | None = False,
|
|
1016
|
+
center: bool | None = False,
|
|
1017
1017
|
):
|
|
1018
1018
|
"""View all objects in scene
|
|
1019
1019
|
|
|
@@ -1021,9 +1021,9 @@ def view_all(
|
|
|
1021
1021
|
:type execution_context: int | str | None
|
|
1022
1022
|
:type undo: bool | None
|
|
1023
1023
|
:param use_all_regions: All Regions, View selected for all regions
|
|
1024
|
-
:type use_all_regions: bool |
|
|
1024
|
+
:type use_all_regions: bool | None
|
|
1025
1025
|
:param center: Center
|
|
1026
|
-
:type center: bool |
|
|
1026
|
+
:type center: bool | None
|
|
1027
1027
|
"""
|
|
1028
1028
|
|
|
1029
1029
|
...
|
|
@@ -1034,8 +1034,8 @@ def view_axis(
|
|
|
1034
1034
|
undo: bool | None = None,
|
|
1035
1035
|
*,
|
|
1036
1036
|
type: str | None = "LEFT",
|
|
1037
|
-
align_active: bool |
|
|
1038
|
-
relative: bool |
|
|
1037
|
+
align_active: bool | None = False,
|
|
1038
|
+
relative: bool | None = False,
|
|
1039
1039
|
):
|
|
1040
1040
|
"""Use a preset viewpoint
|
|
1041
1041
|
|
|
@@ -1063,9 +1063,9 @@ def view_axis(
|
|
|
1063
1063
|
Back -- View from the back.
|
|
1064
1064
|
:type type: str | None
|
|
1065
1065
|
:param align_active: Align Active, Align to the active object's axis
|
|
1066
|
-
:type align_active: bool |
|
|
1066
|
+
:type align_active: bool | None
|
|
1067
1067
|
:param relative: Relative, Rotate relative to the current orientation
|
|
1068
|
-
:type relative: bool |
|
|
1068
|
+
:type relative: bool | None
|
|
1069
1069
|
"""
|
|
1070
1070
|
|
|
1071
1071
|
...
|
|
@@ -1173,7 +1173,7 @@ def view_orbit(
|
|
|
1173
1173
|
execution_context: int | str | None = None,
|
|
1174
1174
|
undo: bool | None = None,
|
|
1175
1175
|
*,
|
|
1176
|
-
angle:
|
|
1176
|
+
angle: float | None = 0.0,
|
|
1177
1177
|
type: str | None = "ORBITLEFT",
|
|
1178
1178
|
):
|
|
1179
1179
|
"""Orbit the view
|
|
@@ -1182,7 +1182,7 @@ def view_orbit(
|
|
|
1182
1182
|
:type execution_context: int | str | None
|
|
1183
1183
|
:type undo: bool | None
|
|
1184
1184
|
:param angle: Roll
|
|
1185
|
-
:type angle:
|
|
1185
|
+
:type angle: float | None
|
|
1186
1186
|
:param type: Orbit, Direction of View Orbit
|
|
1187
1187
|
|
|
1188
1188
|
ORBITLEFT
|
|
@@ -1250,7 +1250,7 @@ def view_roll(
|
|
|
1250
1250
|
execution_context: int | str | None = None,
|
|
1251
1251
|
undo: bool | None = None,
|
|
1252
1252
|
*,
|
|
1253
|
-
angle:
|
|
1253
|
+
angle: float | None = 0.0,
|
|
1254
1254
|
type: str | None = "ANGLE",
|
|
1255
1255
|
):
|
|
1256
1256
|
"""Roll the view
|
|
@@ -1259,7 +1259,7 @@ def view_roll(
|
|
|
1259
1259
|
:type execution_context: int | str | None
|
|
1260
1260
|
:type undo: bool | None
|
|
1261
1261
|
:param angle: Roll
|
|
1262
|
-
:type angle:
|
|
1262
|
+
:type angle: float | None
|
|
1263
1263
|
:param type: Roll Angle Source, How roll angle is calculated
|
|
1264
1264
|
|
|
1265
1265
|
ANGLE
|
|
@@ -1280,7 +1280,7 @@ def view_selected(
|
|
|
1280
1280
|
execution_context: int | str | None = None,
|
|
1281
1281
|
undo: bool | None = None,
|
|
1282
1282
|
*,
|
|
1283
|
-
use_all_regions: bool |
|
|
1283
|
+
use_all_regions: bool | None = False,
|
|
1284
1284
|
):
|
|
1285
1285
|
"""Move the view to the selection center
|
|
1286
1286
|
|
|
@@ -1288,7 +1288,7 @@ def view_selected(
|
|
|
1288
1288
|
:type execution_context: int | str | None
|
|
1289
1289
|
:type undo: bool | None
|
|
1290
1290
|
:param use_all_regions: All Regions, View selected for all regions
|
|
1291
|
-
:type use_all_regions: bool |
|
|
1291
|
+
:type use_all_regions: bool | None
|
|
1292
1292
|
"""
|
|
1293
1293
|
|
|
1294
1294
|
...
|
|
@@ -1312,10 +1312,10 @@ def zoom(
|
|
|
1312
1312
|
execution_context: int | str | None = None,
|
|
1313
1313
|
undo: bool | None = None,
|
|
1314
1314
|
*,
|
|
1315
|
-
mx:
|
|
1316
|
-
my:
|
|
1317
|
-
delta:
|
|
1318
|
-
use_cursor_init: bool |
|
|
1315
|
+
mx: int | None = 0,
|
|
1316
|
+
my: int | None = 0,
|
|
1317
|
+
delta: int | None = 0,
|
|
1318
|
+
use_cursor_init: bool | None = True,
|
|
1319
1319
|
):
|
|
1320
1320
|
"""Zoom in/out in the view
|
|
1321
1321
|
|
|
@@ -1323,13 +1323,13 @@ def zoom(
|
|
|
1323
1323
|
:type execution_context: int | str | None
|
|
1324
1324
|
:type undo: bool | None
|
|
1325
1325
|
:param mx: Region Position X
|
|
1326
|
-
:type mx:
|
|
1326
|
+
:type mx: int | None
|
|
1327
1327
|
:param my: Region Position Y
|
|
1328
|
-
:type my:
|
|
1328
|
+
:type my: int | None
|
|
1329
1329
|
:param delta: Delta
|
|
1330
|
-
:type delta:
|
|
1330
|
+
:type delta: int | None
|
|
1331
1331
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
1332
|
-
:type use_cursor_init: bool |
|
|
1332
|
+
:type use_cursor_init: bool | None
|
|
1333
1333
|
"""
|
|
1334
1334
|
|
|
1335
1335
|
...
|
|
@@ -1339,12 +1339,12 @@ def zoom_border(
|
|
|
1339
1339
|
execution_context: int | str | None = None,
|
|
1340
1340
|
undo: bool | None = None,
|
|
1341
1341
|
*,
|
|
1342
|
-
xmin:
|
|
1343
|
-
xmax:
|
|
1344
|
-
ymin:
|
|
1345
|
-
ymax:
|
|
1346
|
-
wait_for_input: bool |
|
|
1347
|
-
zoom_out: bool |
|
|
1342
|
+
xmin: int | None = 0,
|
|
1343
|
+
xmax: int | None = 0,
|
|
1344
|
+
ymin: int | None = 0,
|
|
1345
|
+
ymax: int | None = 0,
|
|
1346
|
+
wait_for_input: bool | None = True,
|
|
1347
|
+
zoom_out: bool | None = False,
|
|
1348
1348
|
):
|
|
1349
1349
|
"""Zoom in the view to the nearest object contained in the border
|
|
1350
1350
|
|
|
@@ -1352,17 +1352,17 @@ def zoom_border(
|
|
|
1352
1352
|
:type execution_context: int | str | None
|
|
1353
1353
|
:type undo: bool | None
|
|
1354
1354
|
:param xmin: X Min
|
|
1355
|
-
:type xmin:
|
|
1355
|
+
:type xmin: int | None
|
|
1356
1356
|
:param xmax: X Max
|
|
1357
|
-
:type xmax:
|
|
1357
|
+
:type xmax: int | None
|
|
1358
1358
|
:param ymin: Y Min
|
|
1359
|
-
:type ymin:
|
|
1359
|
+
:type ymin: int | None
|
|
1360
1360
|
:param ymax: Y Max
|
|
1361
|
-
:type ymax:
|
|
1361
|
+
:type ymax: int | None
|
|
1362
1362
|
:param wait_for_input: Wait for Input
|
|
1363
|
-
:type wait_for_input: bool |
|
|
1363
|
+
:type wait_for_input: bool | None
|
|
1364
1364
|
:param zoom_out: Zoom Out
|
|
1365
|
-
:type zoom_out: bool |
|
|
1365
|
+
:type zoom_out: bool | None
|
|
1366
1366
|
"""
|
|
1367
1367
|
|
|
1368
1368
|
...
|