fake-bpy-module 20240224__py3-none-any.whl → 20240326__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.
- addon_utils/__init__.pyi +54 -10
- animsys_refactor/__init__.pyi +36 -6
- aud/__init__.pyi +132 -125
- bgl/__init__.pyi +2545 -546
- bl_app_override/__init__.pyi +14 -3
- bl_app_override/helpers/__init__.pyi +24 -2
- bl_app_template_utils/__init__.pyi +19 -4
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -5
- bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -3
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -5
- bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -2
- bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -15
- bl_i18n_utils/merge_po/__init__.pyi +4 -1
- bl_i18n_utils/settings/__init__.pyi +53 -6
- bl_i18n_utils/utils/__init__.pyi +332 -44
- bl_i18n_utils/utils_cli/__init__.pyi +29 -6
- bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -1
- bl_i18n_utils/utils_rtl/__init__.pyi +9 -2
- bl_keymap_utils/io/__init__.pyi +44 -9
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -1
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -1
- bl_keymap_utils/platform_helpers/__init__.pyi +9 -2
- bl_keymap_utils/versioning/__init__.pyi +4 -1
- bl_math/__init__.pyi +3 -3
- bl_operators/__init__.pyi +9 -2
- bl_operators/add_mesh_torus/__init__.pyi +171 -37
- bl_operators/anim/__init__.pyi +1065 -226
- bl_operators/assets/__init__.pyi +427 -92
- bl_operators/bmesh/find_adjacent/__init__.pyi +44 -9
- bl_operators/clip/__init__.pyi +1342 -287
- bl_operators/console/__init__.pyi +647 -140
- bl_operators/constraint/__init__.pyi +524 -112
- bl_operators/file/__init__.pyi +396 -84
- bl_operators/freestyle/__init__.pyi +532 -113
- bl_operators/geometry_nodes/__init__.pyi +2412 -596
- bl_operators/image/__init__.pyi +380 -82
- bl_operators/mesh/__init__.pyi +401 -85
- bl_operators/node/__init__.pyi +1756 -384
- bl_operators/object/__init__.pyi +2022 -552
- bl_operators/object_align/__init__.pyi +145 -31
- bl_operators/object_quick_effects/__init__.pyi +555 -124
- bl_operators/object_randomize_transform/__init__.pyi +136 -32
- bl_operators/presets/__init__.pyi +3516 -708
- bl_operators/rigidbody/__init__.pyi +401 -85
- bl_operators/screen_play_rendered_anim/__init__.pyi +129 -29
- bl_operators/sequencer/__init__.pyi +731 -149
- bl_operators/spreadsheet/__init__.pyi +145 -30
- bl_operators/userpref/__init__.pyi +3416 -824
- bl_operators/uvcalc_follow_active/__init__.pyi +149 -32
- bl_operators/uvcalc_lightmap/__init__.pyi +187 -34
- bl_operators/uvcalc_transform/__init__.pyi +344 -73
- bl_operators/vertexpaint_dirt/__init__.pyi +140 -30
- bl_operators/view3d/__init__.pyi +697 -146
- bl_operators/wm/__init__.pyi +6287 -1533
- bl_previews_utils/bl_previews_render/__init__.pyi +34 -7
- bl_rna_utils/data_path/__init__.pyi +12 -2
- bl_text_utils/external_editor/__init__.pyi +4 -1
- bl_ui/__init__.pyi +504 -106
- bl_ui/anim/__init__.pyi +164 -33
- bl_ui/asset_shelf/__init__.pyi +146 -31
- bl_ui/generic_ui_list/__init__.pyi +471 -99
- bl_ui/node_add_menu/__init__.pyi +196 -40
- bl_ui/node_add_menu_compositor/__init__.pyi +3017 -621
- bl_ui/node_add_menu_geometry/__init__.pyi +8060 -1625
- bl_ui/node_add_menu_shader/__init__.pyi +1709 -348
- bl_ui/node_add_menu_texture/__init__.pyi +1502 -305
- bl_ui/properties_animviz/__init__.pyi +32 -2
- bl_ui/properties_collection/__init__.pyi +787 -179
- bl_ui/properties_constraint/__init__.pyi +28635 -5523
- bl_ui/properties_data_armature/__init__.pyi +1905 -448
- bl_ui/properties_data_bone/__init__.pyi +1560 -336
- bl_ui/properties_data_camera/__init__.pyi +2269 -494
- bl_ui/properties_data_curve/__init__.pyi +2362 -534
- bl_ui/properties_data_curves/__init__.pyi +951 -203
- bl_ui/properties_data_empty/__init__.pyi +317 -69
- bl_ui/properties_data_gpencil/__init__.pyi +2924 -734
- bl_ui/properties_data_grease_pencil/__init__.pyi +1631 -188
- bl_ui/properties_data_lattice/__init__.pyi +472 -104
- bl_ui/properties_data_light/__init__.pyi +1570 -337
- bl_ui/properties_data_lightprobe/__init__.pyi +938 -208
- bl_ui/properties_data_mesh/__init__.pyi +3205 -767
- bl_ui/properties_data_metaball/__init__.pyi +774 -170
- bl_ui/properties_data_modifier/__init__.pyi +1554 -328
- bl_ui/properties_data_pointcloud/__init__.pyi +821 -194
- bl_ui/properties_data_shaderfx/__init__.pyi +154 -34
- bl_ui/properties_data_speaker/__init__.pyi +782 -168
- bl_ui/properties_data_volume/__init__.pyi +1243 -281
- bl_ui/properties_freestyle/__init__.pyi +4071 -1030
- bl_ui/properties_grease_pencil_common/__init__.pyi +2399 -483
- bl_ui/properties_mask_common/__init__.pyi +1256 -249
- bl_ui/properties_material/__init__.pyi +2351 -542
- bl_ui/properties_material_gpencil/__init__.pyi +1590 -365
- bl_ui/properties_object/__init__.pyi +2179 -512
- bl_ui/properties_output/__init__.pyi +2956 -705
- bl_ui/properties_paint_common/__init__.pyi +947 -140
- bl_ui/properties_particle/__init__.pyi +8322 -1970
- bl_ui/properties_physics_cloth/__init__.pyi +2254 -508
- bl_ui/properties_physics_common/__init__.pyi +200 -44
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +4454 -965
- bl_ui/properties_physics_field/__init__.pyi +1695 -364
- bl_ui/properties_physics_fluid/__init__.pyi +6127 -1280
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +157 -32
- bl_ui/properties_physics_rigidbody/__init__.pyi +1254 -278
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +2053 -483
- bl_ui/properties_physics_softbody/__init__.pyi +2394 -542
- bl_ui/properties_render/__init__.pyi +8312 -1933
- bl_ui/properties_scene/__init__.pyi +2211 -539
- bl_ui/properties_texture/__init__.pyi +4185 -1013
- bl_ui/properties_view_layer/__init__.pyi +2803 -664
- bl_ui/properties_workspace/__init__.pyi +626 -148
- bl_ui/properties_world/__init__.pyi +1092 -234
- bl_ui/space_clip/__init__.pyi +11475 -2805
- bl_ui/space_console/__init__.pyi +967 -202
- bl_ui/space_dopesheet/__init__.pyi +4260 -966
- bl_ui/space_filebrowser/__init__.pyi +4852 -1187
- bl_ui/space_graph/__init__.pyi +3251 -702
- bl_ui/space_image/__init__.pyi +12219 -2968
- bl_ui/space_info/__init__.pyi +964 -200
- bl_ui/space_nla/__init__.pyi +2756 -584
- bl_ui/space_node/__init__.pyi +5661 -1265
- bl_ui/space_outliner/__init__.pyi +2294 -478
- bl_ui/space_properties/__init__.pyi +417 -92
- bl_ui/space_sequencer/__init__.pyi +12436 -3009
- bl_ui/space_spreadsheet/__init__.pyi +184 -36
- bl_ui/space_statusbar/__init__.pyi +135 -30
- bl_ui/space_text/__init__.pyi +2556 -542
- bl_ui/space_time/__init__.pyi +1151 -243
- bl_ui/space_toolsystem_common/__init__.pyi +368 -66
- bl_ui/space_toolsystem_toolbar/__init__.pyi +1378 -228
- bl_ui/space_topbar/__init__.pyi +4214 -887
- bl_ui/space_userpref/__init__.pyi +13920 -3468
- bl_ui/space_view3d/__init__.pyi +43701 -10599
- bl_ui/space_view3d_toolbar/__init__.pyi +16380 -3860
- bl_ui/utils/__init__.pyi +42 -4
- bl_ui_utils/bug_report_url/__init__.pyi +4 -1
- bl_ui_utils/layout/__init__.pyi +4 -1
- blend_render_info/__init__.pyi +13 -3
- blf/__init__.pyi +5 -7
- bmesh/__init__.pyi +7 -7
- bmesh/geometry/__init__.pyi +5 -5
- bmesh/ops/__init__.pyi +490 -504
- bmesh/types/__init__.pyi +268 -262
- bmesh/utils/__init__.pyi +55 -55
- bpy/__init__.pyi +2 -2
- bpy/app/__init__.pyi +4 -5
- bpy/app/handlers/__init__.pyi +36 -36
- bpy/app/icons/__init__.pyi +8 -10
- bpy/app/timers/__init__.pyi +9 -11
- bpy/app/translations/__init__.pyi +20 -22
- bpy/msgbus/__init__.pyi +3 -12
- bpy/ops/action/__init__.pyi +350 -305
- bpy/ops/anim/__init__.pyi +464 -426
- bpy/ops/armature/__init__.pyi +392 -360
- bpy/ops/asset/__init__.pyi +166 -129
- bpy/ops/boid/__init__.pyi +64 -37
- bpy/ops/brush/__init__.pyi +78 -72
- bpy/ops/buttons/__init__.pyi +136 -122
- bpy/ops/cachefile/__init__.pyi +128 -123
- bpy/ops/camera/__init__.pyi +22 -24
- bpy/ops/clip/__init__.pyi +844 -735
- bpy/ops/cloth/__init__.pyi +10 -11
- bpy/ops/collection/__init__.pyi +38 -38
- bpy/ops/console/__init__.pyi +170 -141
- bpy/ops/constraint/__init__.pyi +156 -159
- bpy/ops/curve/__init__.pyi +518 -461
- bpy/ops/curves/__init__.pyi +188 -159
- bpy/ops/cycles/__init__.pyi +20 -18
- bpy/ops/dpaint/__init__.pyi +40 -30
- bpy/ops/ed/__init__.pyi +136 -107
- bpy/ops/export_anim/__init__.pyi +18 -19
- bpy/ops/export_mesh/__init__.pyi +26 -27
- bpy/ops/export_scene/__init__.pyi +313 -334
- bpy/ops/file/__init__.pyi +394 -304
- bpy/ops/fluid/__init__.pyi +114 -63
- bpy/ops/font/__init__.pyi +272 -245
- bpy/ops/geometry/__init__.pyi +92 -87
- bpy/ops/gizmogroup/__init__.pyi +24 -21
- bpy/ops/gpencil/__init__.pyi +1530 -1476
- bpy/ops/graph/__init__.pyi +680 -659
- bpy/ops/grease_pencil/__init__.pyi +510 -390
- bpy/ops/image/__init__.pyi +650 -603
- bpy/ops/import_anim/__init__.pyi +26 -27
- bpy/ops/import_curve/__init__.pyi +6 -7
- bpy/ops/import_mesh/__init__.pyi +18 -21
- bpy/ops/import_scene/__init__.pyi +86 -95
- bpy/ops/info/__init__.pyi +68 -55
- bpy/ops/lattice/__init__.pyi +70 -63
- bpy/ops/marker/__init__.pyi +110 -111
- bpy/ops/mask/__init__.pyi +352 -308
- bpy/ops/material/__init__.pyi +24 -12
- bpy/ops/mball/__init__.pyi +72 -75
- bpy/ops/mesh/__init__.pyi +2052 -2088
- bpy/ops/nla/__init__.pyi +369 -313
- bpy/ops/node/__init__.pyi +944 -805
- bpy/ops/object/__init__.pyi +2662 -2461
- bpy/ops/outliner/__init__.pyi +582 -431
- bpy/ops/paint/__init__.pyi +605 -516
- bpy/ops/paintcurve/__init__.pyi +72 -60
- bpy/ops/palette/__init__.pyi +54 -46
- bpy/ops/particle/__init__.pyi +302 -245
- bpy/ops/pose/__init__.pyi +366 -330
- bpy/ops/poselib/__init__.pyi +78 -64
- bpy/ops/preferences/__init__.pyi +361 -341
- bpy/ops/ptcache/__init__.pyi +56 -38
- bpy/ops/render/__init__.pyi +120 -117
- bpy/ops/rigidbody/__init__.pyi +114 -97
- bpy/ops/scene/__init__.pyi +302 -240
- bpy/ops/screen/__init__.pyi +414 -363
- bpy/ops/script/__init__.pyi +20 -18
- bpy/ops/sculpt/__init__.pyi +414 -452
- bpy/ops/sculpt_curves/__init__.pyi +42 -43
- bpy/ops/sequencer/__init__.pyi +1094 -1053
- bpy/ops/sound/__init__.pyi +214 -206
- bpy/ops/spreadsheet/__init__.pyi +34 -28
- bpy/ops/surface/__init__.pyi +108 -114
- bpy/ops/text/__init__.pyi +432 -350
- bpy/ops/text_editor/__init__.pyi +10 -11
- bpy/ops/texture/__init__.pyi +32 -21
- bpy/ops/transform/__init__.pyi +801 -854
- bpy/ops/ui/__init__.pyi +254 -185
- bpy/ops/uilist/__init__.pyi +20 -23
- bpy/ops/uv/__init__.pyi +618 -626
- bpy/ops/view2d/__init__.pyi +162 -161
- bpy/ops/view3d/__init__.pyi +669 -658
- bpy/ops/wm/__init__.pyi +2433 -2415
- bpy/ops/workspace/__init__.pyi +54 -31
- bpy/ops/world/__init__.pyi +8 -4
- bpy/path/__init__.pyi +111 -68
- bpy/props/__init__.pyi +263 -267
- bpy/types/__init__.pyi +86789 -85719
- bpy/utils/__init__.pyi +265 -123
- bpy/utils/previews/__init__.pyi +103 -17
- bpy/utils/units/__init__.pyi +19 -22
- bpy_extras/__init__.pyi +0 -4
- bpy_extras/anim_utils/__init__.pyi +11 -46
- bpy_extras/asset_utils/__init__.pyi +3 -12
- bpy_extras/id_map_utils/__init__.pyi +0 -2
- bpy_extras/image_utils/__init__.pyi +2 -2
- bpy_extras/io_utils/__init__.pyi +30 -27
- bpy_extras/keyconfig_utils/__init__.pyi +4 -1
- bpy_extras/mesh_utils/__init__.pyi +18 -18
- bpy_extras/node_utils/__init__.pyi +4 -3
- bpy_extras/object_utils/__init__.pyi +25 -26
- bpy_extras/view3d_utils/__init__.pyi +33 -38
- bpy_restrict_state/__init__.pyi +14 -1
- bpy_types/__init__.pyi +3873 -997
- console_python/__init__.pyi +41 -7
- console_shell/__init__.pyi +24 -5
- {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/METADATA +1 -1
- fake_bpy_module-20240326.dist-info/RECORD +343 -0
- {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/WHEEL +1 -1
- freestyle/chainingiterators/__init__.pyi +50 -52
- freestyle/functions/__init__.pyi +303 -207
- freestyle/predicates/__init__.pyi +299 -115
- freestyle/shaders/__init__.pyi +49 -80
- freestyle/types/__init__.pyi +465 -472
- freestyle/utils/ContextFunctions/__init__.pyi +9 -9
- freestyle/utils/__init__.pyi +28 -18
- gpu/capabilities/__init__.pyi +27 -19
- gpu/matrix/__init__.pyi +14 -16
- gpu/platform/__init__.pyi +5 -5
- gpu/shader/__init__.pyi +2 -5
- gpu/state/__init__.pyi +1 -1
- gpu/texture/__init__.pyi +3 -3
- gpu/types/__init__.pyi +54 -85
- gpu_extras/batch/__init__.pyi +27 -5
- gpu_extras/presets/__init__.pyi +52 -14
- graphviz_export/__init__.pyi +9 -2
- idprop/types/__init__.pyi +36 -12
- imbuf/__init__.pyi +8 -9
- imbuf/types/__init__.pyi +8 -15
- keyingsets_builtins/__init__.pyi +3149 -701
- keyingsets_utils/__init__.pyi +69 -14
- mathutils/__init__.pyi +502 -427
- mathutils/bvhtree/__init__.pyi +28 -32
- mathutils/geometry/__init__.pyi +177 -186
- mathutils/kdtree/__init__.pyi +16 -18
- mathutils/noise/__init__.pyi +47 -48
- nodeitems_builtins/__init__.pyi +50 -10
- nodeitems_utils/__init__.pyi +58 -10
- rna_info/__init__.pyi +230 -26
- rna_keymap_ui/__init__.pyi +29 -6
- rna_prop_ui/__init__.pyi +69 -12
- rna_xml/__init__.pyi +29 -6
- sys_info/__init__.pyi +4 -1
- bpy_extras/bmesh_utils/__init__.pyi +0 -6
- bpy_extras/extensions/__init__.pyi +0 -4
- bpy_extras/extensions/junction_module/__init__.pyi +0 -12
- bpy_extras/node_shader_utils/__init__.pyi +0 -131
- bpy_extras/wm_utils/__init__.pyi +0 -4
- bpy_extras/wm_utils/progress_report/__init__.pyi +0 -29
- fake_bpy_module-20240224.dist-info/RECORD +0 -349
- {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/top_level.txt +0 -0
bpy/ops/view3d/__init__.pyi
CHANGED
|
@@ -3,262 +3,174 @@ import bpy.types
|
|
|
3
3
|
|
|
4
4
|
GenericType = typing.TypeVar("GenericType")
|
|
5
5
|
|
|
6
|
-
def background_image_add(
|
|
7
|
-
override_context=None,
|
|
8
|
-
execution_context=None,
|
|
9
|
-
undo=None,
|
|
10
|
-
*,
|
|
11
|
-
name: typing.Union[str, typing.Any] = "",
|
|
12
|
-
session_uid: typing.Optional[typing.Any] = 0,
|
|
13
|
-
filepath: typing.Union[str, typing.Any] = "",
|
|
14
|
-
hide_props_region: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
15
|
-
check_existing: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
16
|
-
filter_blender: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
17
|
-
filter_backup: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
18
|
-
filter_image: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
19
|
-
filter_movie: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
20
|
-
filter_python: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
21
|
-
filter_font: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
22
|
-
filter_sound: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
23
|
-
filter_text: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
24
|
-
filter_archive: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
25
|
-
filter_btx: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
26
|
-
filter_collada: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
27
|
-
filter_alembic: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
28
|
-
filter_usd: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
29
|
-
filter_obj: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
30
|
-
filter_volume: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
31
|
-
filter_folder: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
32
|
-
filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
33
|
-
filemode: typing.Optional[typing.Any] = 9,
|
|
34
|
-
relative_path: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
35
|
-
show_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
36
|
-
use_multiview: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
37
|
-
display_type: typing.Optional[typing.Any] = "DEFAULT",
|
|
38
|
-
sort_method: typing.Optional[typing.Any] = "",
|
|
39
|
-
):
|
|
40
|
-
"""Add a new background image
|
|
41
|
-
|
|
42
|
-
:type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
|
|
43
|
-
:type execution_context: typing.Optional[typing.Union[int, str]]
|
|
44
|
-
:type undo: typing.Optional[bool]
|
|
45
|
-
:param name: Name, Name of the data-block to use by the operator
|
|
46
|
-
:type name: typing.Union[str, typing.Any]
|
|
47
|
-
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
48
|
-
:type session_uid: typing.Optional[typing.Any]
|
|
49
|
-
:param filepath: File Path, Path to file
|
|
50
|
-
:type filepath: typing.Union[str, typing.Any]
|
|
51
|
-
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
52
|
-
:type hide_props_region: typing.Optional[typing.Union[bool, typing.Any]]
|
|
53
|
-
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
54
|
-
:type check_existing: typing.Optional[typing.Union[bool, typing.Any]]
|
|
55
|
-
:param filter_blender: Filter .blend files
|
|
56
|
-
:type filter_blender: typing.Optional[typing.Union[bool, typing.Any]]
|
|
57
|
-
:param filter_backup: Filter .blend files
|
|
58
|
-
:type filter_backup: typing.Optional[typing.Union[bool, typing.Any]]
|
|
59
|
-
:param filter_image: Filter image files
|
|
60
|
-
:type filter_image: typing.Optional[typing.Union[bool, typing.Any]]
|
|
61
|
-
:param filter_movie: Filter movie files
|
|
62
|
-
:type filter_movie: typing.Optional[typing.Union[bool, typing.Any]]
|
|
63
|
-
:param filter_python: Filter Python files
|
|
64
|
-
:type filter_python: typing.Optional[typing.Union[bool, typing.Any]]
|
|
65
|
-
:param filter_font: Filter font files
|
|
66
|
-
:type filter_font: typing.Optional[typing.Union[bool, typing.Any]]
|
|
67
|
-
:param filter_sound: Filter sound files
|
|
68
|
-
:type filter_sound: typing.Optional[typing.Union[bool, typing.Any]]
|
|
69
|
-
:param filter_text: Filter text files
|
|
70
|
-
:type filter_text: typing.Optional[typing.Union[bool, typing.Any]]
|
|
71
|
-
:param filter_archive: Filter archive files
|
|
72
|
-
:type filter_archive: typing.Optional[typing.Union[bool, typing.Any]]
|
|
73
|
-
:param filter_btx: Filter btx files
|
|
74
|
-
:type filter_btx: typing.Optional[typing.Union[bool, typing.Any]]
|
|
75
|
-
:param filter_collada: Filter COLLADA files
|
|
76
|
-
:type filter_collada: typing.Optional[typing.Union[bool, typing.Any]]
|
|
77
|
-
:param filter_alembic: Filter Alembic files
|
|
78
|
-
:type filter_alembic: typing.Optional[typing.Union[bool, typing.Any]]
|
|
79
|
-
:param filter_usd: Filter USD files
|
|
80
|
-
:type filter_usd: typing.Optional[typing.Union[bool, typing.Any]]
|
|
81
|
-
:param filter_obj: Filter OBJ files
|
|
82
|
-
:type filter_obj: typing.Optional[typing.Union[bool, typing.Any]]
|
|
83
|
-
:param filter_volume: Filter OpenVDB volume files
|
|
84
|
-
:type filter_volume: typing.Optional[typing.Union[bool, typing.Any]]
|
|
85
|
-
:param filter_folder: Filter folders
|
|
86
|
-
:type filter_folder: typing.Optional[typing.Union[bool, typing.Any]]
|
|
87
|
-
:param filter_blenlib: Filter Blender IDs
|
|
88
|
-
:type filter_blenlib: typing.Optional[typing.Union[bool, typing.Any]]
|
|
89
|
-
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
90
|
-
:type filemode: typing.Optional[typing.Any]
|
|
91
|
-
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
92
|
-
:type relative_path: typing.Optional[typing.Union[bool, typing.Any]]
|
|
93
|
-
:param show_multiview: Enable Multi-View
|
|
94
|
-
:type show_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
95
|
-
:param use_multiview: Use Multi-View
|
|
96
|
-
:type use_multiview: typing.Optional[typing.Union[bool, typing.Any]]
|
|
97
|
-
:param display_type: Display Type
|
|
98
|
-
|
|
99
|
-
DEFAULT
|
|
100
|
-
Default -- Automatically determine display type for files.
|
|
101
|
-
|
|
102
|
-
LIST_VERTICAL
|
|
103
|
-
Short List -- Display files as short list.
|
|
104
|
-
|
|
105
|
-
LIST_HORIZONTAL
|
|
106
|
-
Long List -- Display files as a detailed list.
|
|
107
|
-
|
|
108
|
-
THUMBNAIL
|
|
109
|
-
Thumbnails -- Display files as thumbnails.
|
|
110
|
-
:type display_type: typing.Optional[typing.Any]
|
|
111
|
-
:param sort_method: File sorting mode
|
|
112
|
-
|
|
113
|
-
DEFAULT
|
|
114
|
-
Default -- Automatically determine sort method for files.
|
|
115
|
-
|
|
116
|
-
FILE_SORT_ALPHA
|
|
117
|
-
Name -- Sort the file list alphabetically.
|
|
118
|
-
|
|
119
|
-
FILE_SORT_EXTENSION
|
|
120
|
-
Extension -- Sort the file list by extension/type.
|
|
121
|
-
|
|
122
|
-
FILE_SORT_TIME
|
|
123
|
-
Modified Date -- Sort files by modification time.
|
|
124
|
-
|
|
125
|
-
FILE_SORT_SIZE
|
|
126
|
-
Size -- Sort files by size.
|
|
127
|
-
:type sort_method: typing.Optional[typing.Any]
|
|
128
|
-
"""
|
|
129
|
-
|
|
130
|
-
...
|
|
131
|
-
|
|
132
|
-
def background_image_remove(
|
|
133
|
-
override_context=None,
|
|
134
|
-
execution_context=None,
|
|
135
|
-
undo=None,
|
|
136
|
-
*,
|
|
137
|
-
index: typing.Optional[typing.Any] = 0,
|
|
138
|
-
):
|
|
139
|
-
"""Remove a background image from the 3D view
|
|
140
|
-
|
|
141
|
-
:type override_context: typing.Optional[typing.Union['bpy.types.Context', typing.Dict]]
|
|
142
|
-
:type execution_context: typing.Optional[typing.Union[int, str]]
|
|
143
|
-
:type undo: typing.Optional[bool]
|
|
144
|
-
:param index: Index, Background image index to remove
|
|
145
|
-
:type index: typing.Optional[typing.Any]
|
|
146
|
-
"""
|
|
147
|
-
|
|
148
|
-
...
|
|
149
|
-
|
|
150
6
|
def bone_select_menu(
|
|
151
|
-
override_context=None,
|
|
152
|
-
execution_context=None,
|
|
153
|
-
undo=None,
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
toggle: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
7
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
8
|
+
execution_context: typing.Union[str, int] = None,
|
|
9
|
+
undo: bool = None,
|
|
10
|
+
name: typing.Union[str, int, typing.Any] = "",
|
|
11
|
+
extend: typing.Union[bool, typing.Any] = False,
|
|
12
|
+
deselect: typing.Union[bool, typing.Any] = False,
|
|
13
|
+
toggle: typing.Union[bool, typing.Any] = False,
|
|
159
14
|
):
|
|
160
15
|
"""Menu bone selection
|
|
161
16
|
|
|
162
|
-
:type override_context: typing.
|
|
163
|
-
:type execution_context: typing.
|
|
164
|
-
:type undo:
|
|
17
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
18
|
+
:type execution_context: typing.Union[str, int]
|
|
19
|
+
:type undo: bool
|
|
165
20
|
:param name: Bone Name
|
|
166
|
-
:type name: typing.
|
|
21
|
+
:type name: typing.Union[str, int, typing.Any]
|
|
167
22
|
:param extend: Extend
|
|
168
|
-
:type extend: typing.
|
|
23
|
+
:type extend: typing.Union[bool, typing.Any]
|
|
169
24
|
:param deselect: Deselect
|
|
170
|
-
:type deselect: typing.
|
|
25
|
+
:type deselect: typing.Union[bool, typing.Any]
|
|
171
26
|
:param toggle: Toggle
|
|
172
|
-
:type toggle: typing.
|
|
27
|
+
:type toggle: typing.Union[bool, typing.Any]
|
|
173
28
|
"""
|
|
174
29
|
|
|
175
30
|
...
|
|
176
31
|
|
|
177
|
-
def
|
|
32
|
+
def camera_background_image_add(
|
|
33
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
34
|
+
execution_context: typing.Union[str, int] = None,
|
|
35
|
+
undo: bool = None,
|
|
36
|
+
filepath: typing.Union[str, typing.Any] = "",
|
|
37
|
+
relative_path: typing.Union[bool, typing.Any] = True,
|
|
38
|
+
name: typing.Union[str, typing.Any] = "",
|
|
39
|
+
session_uid: typing.Any = 0,
|
|
40
|
+
):
|
|
41
|
+
"""Add a new background image to the active camera
|
|
42
|
+
|
|
43
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
44
|
+
:type execution_context: typing.Union[str, int]
|
|
45
|
+
:type undo: bool
|
|
46
|
+
:param filepath: Filepath, Path to image file
|
|
47
|
+
:type filepath: typing.Union[str, typing.Any]
|
|
48
|
+
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
49
|
+
:type relative_path: typing.Union[bool, typing.Any]
|
|
50
|
+
:param name: Name, Name of the data-block to use by the operator
|
|
51
|
+
:type name: typing.Union[str, typing.Any]
|
|
52
|
+
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
53
|
+
:type session_uid: typing.Any
|
|
54
|
+
"""
|
|
55
|
+
|
|
56
|
+
...
|
|
57
|
+
|
|
58
|
+
def camera_background_image_remove(
|
|
59
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
60
|
+
execution_context: typing.Union[str, int] = None,
|
|
61
|
+
undo: bool = None,
|
|
62
|
+
index: typing.Any = 0,
|
|
63
|
+
):
|
|
64
|
+
"""Remove a background image from the camera
|
|
65
|
+
|
|
66
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
67
|
+
:type execution_context: typing.Union[str, int]
|
|
68
|
+
:type undo: bool
|
|
69
|
+
:param index: Index, Background image index to remove
|
|
70
|
+
:type index: typing.Any
|
|
71
|
+
"""
|
|
72
|
+
|
|
73
|
+
...
|
|
74
|
+
|
|
75
|
+
def camera_to_view(
|
|
76
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
77
|
+
execution_context: typing.Union[str, int] = None,
|
|
78
|
+
undo: bool = None,
|
|
79
|
+
):
|
|
178
80
|
"""Set camera view to active view
|
|
179
81
|
|
|
180
|
-
:type override_context: typing.
|
|
181
|
-
:type execution_context: typing.
|
|
182
|
-
:type undo:
|
|
82
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
83
|
+
:type execution_context: typing.Union[str, int]
|
|
84
|
+
:type undo: bool
|
|
183
85
|
"""
|
|
184
86
|
|
|
185
87
|
...
|
|
186
88
|
|
|
187
|
-
def camera_to_view_selected(
|
|
89
|
+
def camera_to_view_selected(
|
|
90
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
91
|
+
execution_context: typing.Union[str, int] = None,
|
|
92
|
+
undo: bool = None,
|
|
93
|
+
):
|
|
188
94
|
"""Move the camera so selected objects are framed
|
|
189
95
|
|
|
190
|
-
:type override_context: typing.
|
|
191
|
-
:type execution_context: typing.
|
|
192
|
-
:type undo:
|
|
96
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
97
|
+
:type execution_context: typing.Union[str, int]
|
|
98
|
+
:type undo: bool
|
|
193
99
|
"""
|
|
194
100
|
|
|
195
101
|
...
|
|
196
102
|
|
|
197
|
-
def clear_render_border(
|
|
103
|
+
def clear_render_border(
|
|
104
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
105
|
+
execution_context: typing.Union[str, int] = None,
|
|
106
|
+
undo: bool = None,
|
|
107
|
+
):
|
|
198
108
|
"""Clear the boundaries of the border render and disable border render
|
|
199
109
|
|
|
200
|
-
:type override_context: typing.
|
|
201
|
-
:type execution_context: typing.
|
|
202
|
-
:type undo:
|
|
110
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
111
|
+
:type execution_context: typing.Union[str, int]
|
|
112
|
+
:type undo: bool
|
|
203
113
|
"""
|
|
204
114
|
|
|
205
115
|
...
|
|
206
116
|
|
|
207
117
|
def clip_border(
|
|
208
|
-
override_context=None,
|
|
209
|
-
execution_context=None,
|
|
210
|
-
undo=None,
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
wait_for_input: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
118
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
119
|
+
execution_context: typing.Union[str, int] = None,
|
|
120
|
+
undo: bool = None,
|
|
121
|
+
xmin: typing.Any = 0,
|
|
122
|
+
xmax: typing.Any = 0,
|
|
123
|
+
ymin: typing.Any = 0,
|
|
124
|
+
ymax: typing.Any = 0,
|
|
125
|
+
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
217
126
|
):
|
|
218
127
|
"""Set the view clipping region
|
|
219
128
|
|
|
220
|
-
:type override_context: typing.
|
|
221
|
-
:type execution_context: typing.
|
|
222
|
-
:type undo:
|
|
129
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
130
|
+
:type execution_context: typing.Union[str, int]
|
|
131
|
+
:type undo: bool
|
|
223
132
|
:param xmin: X Min
|
|
224
|
-
:type xmin: typing.
|
|
133
|
+
:type xmin: typing.Any
|
|
225
134
|
:param xmax: X Max
|
|
226
|
-
:type xmax: typing.
|
|
135
|
+
:type xmax: typing.Any
|
|
227
136
|
:param ymin: Y Min
|
|
228
|
-
:type ymin: typing.
|
|
137
|
+
:type ymin: typing.Any
|
|
229
138
|
:param ymax: Y Max
|
|
230
|
-
:type ymax: typing.
|
|
139
|
+
:type ymax: typing.Any
|
|
231
140
|
:param wait_for_input: Wait for Input
|
|
232
|
-
:type wait_for_input: typing.
|
|
141
|
+
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
233
142
|
"""
|
|
234
143
|
|
|
235
144
|
...
|
|
236
145
|
|
|
237
|
-
def copybuffer(
|
|
146
|
+
def copybuffer(
|
|
147
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
148
|
+
execution_context: typing.Union[str, int] = None,
|
|
149
|
+
undo: bool = None,
|
|
150
|
+
):
|
|
238
151
|
"""Copy the selected objects to the internal clipboard
|
|
239
152
|
|
|
240
|
-
:type override_context: typing.
|
|
241
|
-
:type execution_context: typing.
|
|
242
|
-
:type undo:
|
|
153
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
154
|
+
:type execution_context: typing.Union[str, int]
|
|
155
|
+
:type undo: bool
|
|
243
156
|
"""
|
|
244
157
|
|
|
245
158
|
...
|
|
246
159
|
|
|
247
160
|
def cursor3d(
|
|
248
|
-
override_context=None,
|
|
249
|
-
execution_context=None,
|
|
250
|
-
undo=None,
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
orientation: typing.Optional[typing.Any] = "VIEW",
|
|
161
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
162
|
+
execution_context: typing.Union[str, int] = None,
|
|
163
|
+
undo: bool = None,
|
|
164
|
+
use_depth: typing.Union[bool, typing.Any] = True,
|
|
165
|
+
orientation: typing.Any = "VIEW",
|
|
254
166
|
):
|
|
255
167
|
"""Set the location of the 3D cursor
|
|
256
168
|
|
|
257
|
-
:type override_context: typing.
|
|
258
|
-
:type execution_context: typing.
|
|
259
|
-
:type undo:
|
|
169
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
170
|
+
:type execution_context: typing.Union[str, int]
|
|
171
|
+
:type undo: bool
|
|
260
172
|
:param use_depth: Surface Project, Project onto the surface
|
|
261
|
-
:type use_depth: typing.
|
|
173
|
+
:type use_depth: typing.Union[bool, typing.Any]
|
|
262
174
|
:param orientation: Orientation, Preset viewpoint to use
|
|
263
175
|
|
|
264
176
|
NONE
|
|
@@ -272,142 +184,148 @@ def cursor3d(
|
|
|
272
184
|
|
|
273
185
|
GEOM
|
|
274
186
|
Geometry -- Match the surface normal.
|
|
275
|
-
:type orientation: typing.
|
|
187
|
+
:type orientation: typing.Any
|
|
276
188
|
"""
|
|
277
189
|
|
|
278
190
|
...
|
|
279
191
|
|
|
280
192
|
def dolly(
|
|
281
|
-
override_context=None,
|
|
282
|
-
execution_context=None,
|
|
283
|
-
undo=None,
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
use_cursor_init: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
193
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
194
|
+
execution_context: typing.Union[str, int] = None,
|
|
195
|
+
undo: bool = None,
|
|
196
|
+
mx: typing.Any = 0,
|
|
197
|
+
my: typing.Any = 0,
|
|
198
|
+
delta: typing.Any = 0,
|
|
199
|
+
use_cursor_init: typing.Union[bool, typing.Any] = True,
|
|
289
200
|
):
|
|
290
201
|
"""Dolly in/out in the view
|
|
291
202
|
|
|
292
|
-
:type override_context: typing.
|
|
293
|
-
:type execution_context: typing.
|
|
294
|
-
:type undo:
|
|
203
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
204
|
+
:type execution_context: typing.Union[str, int]
|
|
205
|
+
:type undo: bool
|
|
295
206
|
:param mx: Region Position X
|
|
296
|
-
:type mx: typing.
|
|
207
|
+
:type mx: typing.Any
|
|
297
208
|
:param my: Region Position Y
|
|
298
|
-
:type my: typing.
|
|
209
|
+
:type my: typing.Any
|
|
299
210
|
:param delta: Delta
|
|
300
|
-
:type delta: typing.
|
|
211
|
+
:type delta: typing.Any
|
|
301
212
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
302
|
-
:type use_cursor_init: typing.
|
|
213
|
+
:type use_cursor_init: typing.Union[bool, typing.Any]
|
|
303
214
|
"""
|
|
304
215
|
|
|
305
216
|
...
|
|
306
217
|
|
|
307
218
|
def drop_world(
|
|
308
|
-
override_context=None,
|
|
309
|
-
execution_context=None,
|
|
310
|
-
undo=None,
|
|
311
|
-
*,
|
|
219
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
220
|
+
execution_context: typing.Union[str, int] = None,
|
|
221
|
+
undo: bool = None,
|
|
312
222
|
name: typing.Union[str, typing.Any] = "",
|
|
313
|
-
session_uid: typing.
|
|
223
|
+
session_uid: typing.Any = 0,
|
|
314
224
|
):
|
|
315
225
|
"""Drop a world into the scene
|
|
316
226
|
|
|
317
|
-
:type override_context: typing.
|
|
318
|
-
:type execution_context: typing.
|
|
319
|
-
:type undo:
|
|
227
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
228
|
+
:type execution_context: typing.Union[str, int]
|
|
229
|
+
:type undo: bool
|
|
320
230
|
:param name: Name, Name of the data-block to use by the operator
|
|
321
231
|
:type name: typing.Union[str, typing.Any]
|
|
322
232
|
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
323
|
-
:type session_uid: typing.
|
|
233
|
+
:type session_uid: typing.Any
|
|
324
234
|
"""
|
|
325
235
|
|
|
326
236
|
...
|
|
327
237
|
|
|
328
238
|
def edit_mesh_extrude_individual_move(
|
|
329
|
-
override_context
|
|
239
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
240
|
+
execution_context: typing.Union[str, int] = None,
|
|
241
|
+
undo: bool = None,
|
|
330
242
|
):
|
|
331
243
|
"""Extrude each individual face separately along local normals
|
|
332
244
|
|
|
333
|
-
:type override_context: typing.
|
|
334
|
-
:type execution_context: typing.
|
|
335
|
-
:type undo:
|
|
245
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
246
|
+
:type execution_context: typing.Union[str, int]
|
|
247
|
+
:type undo: bool
|
|
336
248
|
"""
|
|
337
249
|
|
|
338
250
|
...
|
|
339
251
|
|
|
340
252
|
def edit_mesh_extrude_manifold_normal(
|
|
341
|
-
override_context
|
|
253
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
254
|
+
execution_context: typing.Union[str, int] = None,
|
|
255
|
+
undo: bool = None,
|
|
342
256
|
):
|
|
343
257
|
"""Extrude manifold region along normals
|
|
344
258
|
|
|
345
|
-
:type override_context: typing.
|
|
346
|
-
:type execution_context: typing.
|
|
347
|
-
:type undo:
|
|
259
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
260
|
+
:type execution_context: typing.Union[str, int]
|
|
261
|
+
:type undo: bool
|
|
348
262
|
"""
|
|
349
263
|
|
|
350
264
|
...
|
|
351
265
|
|
|
352
266
|
def edit_mesh_extrude_move_normal(
|
|
353
|
-
override_context=None,
|
|
354
|
-
execution_context=None,
|
|
355
|
-
undo=None,
|
|
356
|
-
|
|
357
|
-
dissolve_and_intersect: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
267
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
268
|
+
execution_context: typing.Union[str, int] = None,
|
|
269
|
+
undo: bool = None,
|
|
270
|
+
dissolve_and_intersect: typing.Union[bool, typing.Any] = False,
|
|
358
271
|
):
|
|
359
272
|
"""Extrude region together along the average normal
|
|
360
273
|
|
|
361
|
-
:type override_context: typing.
|
|
362
|
-
:type execution_context: typing.
|
|
363
|
-
:type undo:
|
|
274
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
275
|
+
:type execution_context: typing.Union[str, int]
|
|
276
|
+
:type undo: bool
|
|
364
277
|
:param dissolve_and_intersect: dissolve_and_intersect, Dissolves adjacent faces and intersects new geometry
|
|
365
|
-
:type dissolve_and_intersect: typing.
|
|
278
|
+
:type dissolve_and_intersect: typing.Union[bool, typing.Any]
|
|
366
279
|
"""
|
|
367
280
|
|
|
368
281
|
...
|
|
369
282
|
|
|
370
283
|
def edit_mesh_extrude_move_shrink_fatten(
|
|
371
|
-
override_context
|
|
284
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
285
|
+
execution_context: typing.Union[str, int] = None,
|
|
286
|
+
undo: bool = None,
|
|
372
287
|
):
|
|
373
288
|
"""Extrude region together along local normals
|
|
374
289
|
|
|
375
|
-
:type override_context: typing.
|
|
376
|
-
:type execution_context: typing.
|
|
377
|
-
:type undo:
|
|
290
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
291
|
+
:type execution_context: typing.Union[str, int]
|
|
292
|
+
:type undo: bool
|
|
378
293
|
"""
|
|
379
294
|
|
|
380
295
|
...
|
|
381
296
|
|
|
382
|
-
def fly(
|
|
297
|
+
def fly(
|
|
298
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
299
|
+
execution_context: typing.Union[str, int] = None,
|
|
300
|
+
undo: bool = None,
|
|
301
|
+
):
|
|
383
302
|
"""Interactively fly around the scene
|
|
384
303
|
|
|
385
|
-
:type override_context: typing.
|
|
386
|
-
:type execution_context: typing.
|
|
387
|
-
:type undo:
|
|
304
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
305
|
+
:type execution_context: typing.Union[str, int]
|
|
306
|
+
:type undo: bool
|
|
388
307
|
"""
|
|
389
308
|
|
|
390
309
|
...
|
|
391
310
|
|
|
392
311
|
def interactive_add(
|
|
393
|
-
override_context=None,
|
|
394
|
-
execution_context=None,
|
|
395
|
-
undo=None,
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
wait_for_input: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
312
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
313
|
+
execution_context: typing.Union[str, int] = None,
|
|
314
|
+
undo: bool = None,
|
|
315
|
+
primitive_type: typing.Any = "CUBE",
|
|
316
|
+
plane_origin_base: typing.Any = "EDGE",
|
|
317
|
+
plane_origin_depth: typing.Any = "EDGE",
|
|
318
|
+
plane_aspect_base: typing.Any = "FREE",
|
|
319
|
+
plane_aspect_depth: typing.Any = "FREE",
|
|
320
|
+
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
403
321
|
):
|
|
404
322
|
"""Interactively add an object
|
|
405
323
|
|
|
406
|
-
:type override_context: typing.
|
|
407
|
-
:type execution_context: typing.
|
|
408
|
-
:type undo:
|
|
324
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
325
|
+
:type execution_context: typing.Union[str, int]
|
|
326
|
+
:type undo: bool
|
|
409
327
|
:param primitive_type: Primitive
|
|
410
|
-
:type primitive_type: typing.
|
|
328
|
+
:type primitive_type: typing.Any
|
|
411
329
|
:param plane_origin_base: Origin, The initial position for placement
|
|
412
330
|
|
|
413
331
|
EDGE
|
|
@@ -415,7 +333,7 @@ def interactive_add(
|
|
|
415
333
|
|
|
416
334
|
CENTER
|
|
417
335
|
Center -- Start placing the center position.
|
|
418
|
-
:type plane_origin_base: typing.
|
|
336
|
+
:type plane_origin_base: typing.Any
|
|
419
337
|
:param plane_origin_depth: Origin, The initial position for placement
|
|
420
338
|
|
|
421
339
|
EDGE
|
|
@@ -423,7 +341,7 @@ def interactive_add(
|
|
|
423
341
|
|
|
424
342
|
CENTER
|
|
425
343
|
Center -- Start placing the center position.
|
|
426
|
-
:type plane_origin_depth: typing.
|
|
344
|
+
:type plane_origin_depth: typing.Any
|
|
427
345
|
:param plane_aspect_base: Aspect, The initial aspect setting
|
|
428
346
|
|
|
429
347
|
FREE
|
|
@@ -431,7 +349,7 @@ def interactive_add(
|
|
|
431
349
|
|
|
432
350
|
FIXED
|
|
433
351
|
Fixed -- Use a fixed 1:1 aspect.
|
|
434
|
-
:type plane_aspect_base: typing.
|
|
352
|
+
:type plane_aspect_base: typing.Any
|
|
435
353
|
:param plane_aspect_depth: Aspect, The initial aspect setting
|
|
436
354
|
|
|
437
355
|
FREE
|
|
@@ -439,287 +357,320 @@ def interactive_add(
|
|
|
439
357
|
|
|
440
358
|
FIXED
|
|
441
359
|
Fixed -- Use a fixed 1:1 aspect.
|
|
442
|
-
:type plane_aspect_depth: typing.
|
|
360
|
+
:type plane_aspect_depth: typing.Any
|
|
443
361
|
:param wait_for_input: Wait for Input
|
|
444
|
-
:type wait_for_input: typing.
|
|
362
|
+
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
445
363
|
"""
|
|
446
364
|
|
|
447
365
|
...
|
|
448
366
|
|
|
449
367
|
def localview(
|
|
450
|
-
override_context=None,
|
|
451
|
-
execution_context=None,
|
|
452
|
-
undo=None,
|
|
453
|
-
|
|
454
|
-
frame_selected: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
368
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
369
|
+
execution_context: typing.Union[str, int] = None,
|
|
370
|
+
undo: bool = None,
|
|
371
|
+
frame_selected: typing.Union[bool, typing.Any] = True,
|
|
455
372
|
):
|
|
456
373
|
"""Toggle display of selected object(s) separately and centered in view
|
|
457
374
|
|
|
458
|
-
:type override_context: typing.
|
|
459
|
-
:type execution_context: typing.
|
|
460
|
-
:type undo:
|
|
375
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
376
|
+
:type execution_context: typing.Union[str, int]
|
|
377
|
+
:type undo: bool
|
|
461
378
|
:param frame_selected: Frame Selected, Move the view to frame the selected objects
|
|
462
|
-
:type frame_selected: typing.
|
|
379
|
+
:type frame_selected: typing.Union[bool, typing.Any]
|
|
463
380
|
"""
|
|
464
381
|
|
|
465
382
|
...
|
|
466
383
|
|
|
467
|
-
def localview_remove_from(
|
|
384
|
+
def localview_remove_from(
|
|
385
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
386
|
+
execution_context: typing.Union[str, int] = None,
|
|
387
|
+
undo: bool = None,
|
|
388
|
+
):
|
|
468
389
|
"""Move selected objects out of local view
|
|
469
390
|
|
|
470
|
-
:type override_context: typing.
|
|
471
|
-
:type execution_context: typing.
|
|
472
|
-
:type undo:
|
|
391
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
392
|
+
:type execution_context: typing.Union[str, int]
|
|
393
|
+
:type undo: bool
|
|
473
394
|
"""
|
|
474
395
|
|
|
475
396
|
...
|
|
476
397
|
|
|
477
398
|
def move(
|
|
478
|
-
override_context=None,
|
|
479
|
-
execution_context=None,
|
|
480
|
-
undo=None,
|
|
481
|
-
|
|
482
|
-
use_cursor_init: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
399
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
400
|
+
execution_context: typing.Union[str, int] = None,
|
|
401
|
+
undo: bool = None,
|
|
402
|
+
use_cursor_init: typing.Union[bool, typing.Any] = True,
|
|
483
403
|
):
|
|
484
404
|
"""Move the view
|
|
485
405
|
|
|
486
|
-
:type override_context: typing.
|
|
487
|
-
:type execution_context: typing.
|
|
488
|
-
:type undo:
|
|
406
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
407
|
+
:type execution_context: typing.Union[str, int]
|
|
408
|
+
:type undo: bool
|
|
489
409
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
490
|
-
:type use_cursor_init: typing.
|
|
410
|
+
:type use_cursor_init: typing.Union[bool, typing.Any]
|
|
491
411
|
"""
|
|
492
412
|
|
|
493
413
|
...
|
|
494
414
|
|
|
495
|
-
def navigate(
|
|
415
|
+
def navigate(
|
|
416
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
417
|
+
execution_context: typing.Union[str, int] = None,
|
|
418
|
+
undo: bool = None,
|
|
419
|
+
):
|
|
496
420
|
"""Interactively navigate around the scene (uses the mode (walk/fly) preference)
|
|
497
421
|
|
|
498
|
-
:type override_context: typing.
|
|
499
|
-
:type execution_context: typing.
|
|
500
|
-
:type undo:
|
|
422
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
423
|
+
:type execution_context: typing.Union[str, int]
|
|
424
|
+
:type undo: bool
|
|
501
425
|
"""
|
|
502
426
|
|
|
503
427
|
...
|
|
504
428
|
|
|
505
|
-
def ndof_all(
|
|
429
|
+
def ndof_all(
|
|
430
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
431
|
+
execution_context: typing.Union[str, int] = None,
|
|
432
|
+
undo: bool = None,
|
|
433
|
+
):
|
|
506
434
|
"""Pan and rotate the view with the 3D mouse
|
|
507
435
|
|
|
508
|
-
:type override_context: typing.
|
|
509
|
-
:type execution_context: typing.
|
|
510
|
-
:type undo:
|
|
436
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
437
|
+
:type execution_context: typing.Union[str, int]
|
|
438
|
+
:type undo: bool
|
|
511
439
|
"""
|
|
512
440
|
|
|
513
441
|
...
|
|
514
442
|
|
|
515
|
-
def ndof_orbit(
|
|
443
|
+
def ndof_orbit(
|
|
444
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
445
|
+
execution_context: typing.Union[str, int] = None,
|
|
446
|
+
undo: bool = None,
|
|
447
|
+
):
|
|
516
448
|
"""Orbit the view using the 3D mouse
|
|
517
449
|
|
|
518
|
-
:type override_context: typing.
|
|
519
|
-
:type execution_context: typing.
|
|
520
|
-
:type undo:
|
|
450
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
451
|
+
:type execution_context: typing.Union[str, int]
|
|
452
|
+
:type undo: bool
|
|
521
453
|
"""
|
|
522
454
|
|
|
523
455
|
...
|
|
524
456
|
|
|
525
|
-
def ndof_orbit_zoom(
|
|
457
|
+
def ndof_orbit_zoom(
|
|
458
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
459
|
+
execution_context: typing.Union[str, int] = None,
|
|
460
|
+
undo: bool = None,
|
|
461
|
+
):
|
|
526
462
|
"""Orbit and zoom the view using the 3D mouse
|
|
527
463
|
|
|
528
|
-
:type override_context: typing.
|
|
529
|
-
:type execution_context: typing.
|
|
530
|
-
:type undo:
|
|
464
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
465
|
+
:type execution_context: typing.Union[str, int]
|
|
466
|
+
:type undo: bool
|
|
531
467
|
"""
|
|
532
468
|
|
|
533
469
|
...
|
|
534
470
|
|
|
535
|
-
def ndof_pan(
|
|
471
|
+
def ndof_pan(
|
|
472
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
473
|
+
execution_context: typing.Union[str, int] = None,
|
|
474
|
+
undo: bool = None,
|
|
475
|
+
):
|
|
536
476
|
"""Pan the view with the 3D mouse
|
|
537
477
|
|
|
538
|
-
:type override_context: typing.
|
|
539
|
-
:type execution_context: typing.
|
|
540
|
-
:type undo:
|
|
478
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
479
|
+
:type execution_context: typing.Union[str, int]
|
|
480
|
+
:type undo: bool
|
|
541
481
|
"""
|
|
542
482
|
|
|
543
483
|
...
|
|
544
484
|
|
|
545
|
-
def object_as_camera(
|
|
485
|
+
def object_as_camera(
|
|
486
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
487
|
+
execution_context: typing.Union[str, int] = None,
|
|
488
|
+
undo: bool = None,
|
|
489
|
+
):
|
|
546
490
|
"""Set the active object as the active camera for this view or scene
|
|
547
491
|
|
|
548
|
-
:type override_context: typing.
|
|
549
|
-
:type execution_context: typing.
|
|
550
|
-
:type undo:
|
|
492
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
493
|
+
:type execution_context: typing.Union[str, int]
|
|
494
|
+
:type undo: bool
|
|
551
495
|
"""
|
|
552
496
|
|
|
553
497
|
...
|
|
554
498
|
|
|
555
|
-
def object_mode_pie_or_toggle(
|
|
499
|
+
def object_mode_pie_or_toggle(
|
|
500
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
501
|
+
execution_context: typing.Union[str, int] = None,
|
|
502
|
+
undo: bool = None,
|
|
503
|
+
):
|
|
556
504
|
"""Undocumented, consider contributing.
|
|
557
505
|
|
|
558
|
-
:type override_context: typing.
|
|
559
|
-
:type execution_context: typing.
|
|
560
|
-
:type undo:
|
|
506
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
507
|
+
:type execution_context: typing.Union[str, int]
|
|
508
|
+
:type undo: bool
|
|
561
509
|
"""
|
|
562
510
|
|
|
563
511
|
...
|
|
564
512
|
|
|
565
513
|
def pastebuffer(
|
|
566
|
-
override_context=None,
|
|
567
|
-
execution_context=None,
|
|
568
|
-
undo=None,
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
active_collection: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
514
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
515
|
+
execution_context: typing.Union[str, int] = None,
|
|
516
|
+
undo: bool = None,
|
|
517
|
+
autoselect: typing.Union[bool, typing.Any] = True,
|
|
518
|
+
active_collection: typing.Union[bool, typing.Any] = True,
|
|
572
519
|
):
|
|
573
520
|
"""Paste objects from the internal clipboard
|
|
574
521
|
|
|
575
|
-
:type override_context: typing.
|
|
576
|
-
:type execution_context: typing.
|
|
577
|
-
:type undo:
|
|
522
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
523
|
+
:type execution_context: typing.Union[str, int]
|
|
524
|
+
:type undo: bool
|
|
578
525
|
:param autoselect: Select, Select pasted objects
|
|
579
|
-
:type autoselect: typing.
|
|
526
|
+
:type autoselect: typing.Union[bool, typing.Any]
|
|
580
527
|
:param active_collection: Active Collection, Put pasted objects in the active collection
|
|
581
|
-
:type active_collection: typing.
|
|
528
|
+
:type active_collection: typing.Union[bool, typing.Any]
|
|
582
529
|
"""
|
|
583
530
|
|
|
584
531
|
...
|
|
585
532
|
|
|
586
533
|
def render_border(
|
|
587
|
-
override_context=None,
|
|
588
|
-
execution_context=None,
|
|
589
|
-
undo=None,
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
wait_for_input: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
534
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
535
|
+
execution_context: typing.Union[str, int] = None,
|
|
536
|
+
undo: bool = None,
|
|
537
|
+
xmin: typing.Any = 0,
|
|
538
|
+
xmax: typing.Any = 0,
|
|
539
|
+
ymin: typing.Any = 0,
|
|
540
|
+
ymax: typing.Any = 0,
|
|
541
|
+
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
596
542
|
):
|
|
597
543
|
"""Set the boundaries of the border render and enable border render
|
|
598
544
|
|
|
599
|
-
:type override_context: typing.
|
|
600
|
-
:type execution_context: typing.
|
|
601
|
-
:type undo:
|
|
545
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
546
|
+
:type execution_context: typing.Union[str, int]
|
|
547
|
+
:type undo: bool
|
|
602
548
|
:param xmin: X Min
|
|
603
|
-
:type xmin: typing.
|
|
549
|
+
:type xmin: typing.Any
|
|
604
550
|
:param xmax: X Max
|
|
605
|
-
:type xmax: typing.
|
|
551
|
+
:type xmax: typing.Any
|
|
606
552
|
:param ymin: Y Min
|
|
607
|
-
:type ymin: typing.
|
|
553
|
+
:type ymin: typing.Any
|
|
608
554
|
:param ymax: Y Max
|
|
609
|
-
:type ymax: typing.
|
|
555
|
+
:type ymax: typing.Any
|
|
610
556
|
:param wait_for_input: Wait for Input
|
|
611
|
-
:type wait_for_input: typing.
|
|
557
|
+
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
612
558
|
"""
|
|
613
559
|
|
|
614
560
|
...
|
|
615
561
|
|
|
616
562
|
def rotate(
|
|
617
|
-
override_context=None,
|
|
618
|
-
execution_context=None,
|
|
619
|
-
undo=None,
|
|
620
|
-
|
|
621
|
-
use_cursor_init: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
563
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
564
|
+
execution_context: typing.Union[str, int] = None,
|
|
565
|
+
undo: bool = None,
|
|
566
|
+
use_cursor_init: typing.Union[bool, typing.Any] = True,
|
|
622
567
|
):
|
|
623
568
|
"""Rotate the view
|
|
624
569
|
|
|
625
|
-
:type override_context: typing.
|
|
626
|
-
:type execution_context: typing.
|
|
627
|
-
:type undo:
|
|
570
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
571
|
+
:type execution_context: typing.Union[str, int]
|
|
572
|
+
:type undo: bool
|
|
628
573
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
629
|
-
:type use_cursor_init: typing.
|
|
574
|
+
:type use_cursor_init: typing.Union[bool, typing.Any]
|
|
630
575
|
"""
|
|
631
576
|
|
|
632
577
|
...
|
|
633
578
|
|
|
634
|
-
def ruler_add(
|
|
579
|
+
def ruler_add(
|
|
580
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
581
|
+
execution_context: typing.Union[str, int] = None,
|
|
582
|
+
undo: bool = None,
|
|
583
|
+
):
|
|
635
584
|
"""Add ruler
|
|
636
585
|
|
|
637
|
-
:type override_context: typing.
|
|
638
|
-
:type execution_context: typing.
|
|
639
|
-
:type undo:
|
|
586
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
587
|
+
:type execution_context: typing.Union[str, int]
|
|
588
|
+
:type undo: bool
|
|
640
589
|
"""
|
|
641
590
|
|
|
642
591
|
...
|
|
643
592
|
|
|
644
|
-
def ruler_remove(
|
|
593
|
+
def ruler_remove(
|
|
594
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
595
|
+
execution_context: typing.Union[str, int] = None,
|
|
596
|
+
undo: bool = None,
|
|
597
|
+
):
|
|
645
598
|
"""Undocumented, consider contributing.
|
|
646
599
|
|
|
647
|
-
:type override_context: typing.
|
|
648
|
-
:type execution_context: typing.
|
|
649
|
-
:type undo:
|
|
600
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
601
|
+
:type execution_context: typing.Union[str, int]
|
|
602
|
+
:type undo: bool
|
|
650
603
|
"""
|
|
651
604
|
|
|
652
605
|
...
|
|
653
606
|
|
|
654
607
|
def select(
|
|
655
|
-
override_context=None,
|
|
656
|
-
execution_context=None,
|
|
657
|
-
undo=None,
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
location: typing.Optional[typing.Any] = (0, 0),
|
|
608
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
609
|
+
execution_context: typing.Union[str, int] = None,
|
|
610
|
+
undo: bool = None,
|
|
611
|
+
extend: typing.Union[bool, typing.Any] = False,
|
|
612
|
+
deselect: typing.Union[bool, typing.Any] = False,
|
|
613
|
+
toggle: typing.Union[bool, typing.Any] = False,
|
|
614
|
+
deselect_all: typing.Union[bool, typing.Any] = False,
|
|
615
|
+
select_passthrough: typing.Union[bool, typing.Any] = False,
|
|
616
|
+
center: typing.Union[bool, typing.Any] = False,
|
|
617
|
+
enumerate: typing.Union[bool, typing.Any] = False,
|
|
618
|
+
object: typing.Union[bool, typing.Any] = False,
|
|
619
|
+
location: typing.Any = (0, 0),
|
|
668
620
|
):
|
|
669
621
|
"""Select and activate item(s)
|
|
670
622
|
|
|
671
|
-
:type override_context: typing.
|
|
672
|
-
:type execution_context: typing.
|
|
673
|
-
:type undo:
|
|
623
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
624
|
+
:type execution_context: typing.Union[str, int]
|
|
625
|
+
:type undo: bool
|
|
674
626
|
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
675
|
-
:type extend: typing.
|
|
627
|
+
:type extend: typing.Union[bool, typing.Any]
|
|
676
628
|
:param deselect: Deselect, Remove from selection
|
|
677
|
-
:type deselect: typing.
|
|
629
|
+
:type deselect: typing.Union[bool, typing.Any]
|
|
678
630
|
:param toggle: Toggle Selection, Toggle the selection
|
|
679
|
-
:type toggle: typing.
|
|
631
|
+
:type toggle: typing.Union[bool, typing.Any]
|
|
680
632
|
:param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
|
|
681
|
-
:type deselect_all: typing.
|
|
633
|
+
:type deselect_all: typing.Union[bool, typing.Any]
|
|
682
634
|
:param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
|
|
683
|
-
:type select_passthrough: typing.
|
|
635
|
+
:type select_passthrough: typing.Union[bool, typing.Any]
|
|
684
636
|
:param center: Center, Use the object center when selecting, in edit mode used to extend object selection
|
|
685
|
-
:type center: typing.
|
|
637
|
+
:type center: typing.Union[bool, typing.Any]
|
|
686
638
|
:param enumerate: Enumerate, List objects under the mouse (object mode only)
|
|
687
|
-
:type enumerate: typing.
|
|
639
|
+
:type enumerate: typing.Union[bool, typing.Any]
|
|
688
640
|
:param object: Object, Use object selection (edit mode only)
|
|
689
|
-
:type object: typing.
|
|
641
|
+
:type object: typing.Union[bool, typing.Any]
|
|
690
642
|
:param location: Location, Mouse location
|
|
691
|
-
:type location: typing.
|
|
643
|
+
:type location: typing.Any
|
|
692
644
|
"""
|
|
693
645
|
|
|
694
646
|
...
|
|
695
647
|
|
|
696
648
|
def select_box(
|
|
697
|
-
override_context=None,
|
|
698
|
-
execution_context=None,
|
|
699
|
-
undo=None,
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
mode: typing.Optional[typing.Any] = "SET",
|
|
649
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
650
|
+
execution_context: typing.Union[str, int] = None,
|
|
651
|
+
undo: bool = None,
|
|
652
|
+
xmin: typing.Any = 0,
|
|
653
|
+
xmax: typing.Any = 0,
|
|
654
|
+
ymin: typing.Any = 0,
|
|
655
|
+
ymax: typing.Any = 0,
|
|
656
|
+
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
657
|
+
mode: typing.Any = "SET",
|
|
707
658
|
):
|
|
708
659
|
"""Select items using box selection
|
|
709
660
|
|
|
710
|
-
:type override_context: typing.
|
|
711
|
-
:type execution_context: typing.
|
|
712
|
-
:type undo:
|
|
661
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
662
|
+
:type execution_context: typing.Union[str, int]
|
|
663
|
+
:type undo: bool
|
|
713
664
|
:param xmin: X Min
|
|
714
|
-
:type xmin: typing.
|
|
665
|
+
:type xmin: typing.Any
|
|
715
666
|
:param xmax: X Max
|
|
716
|
-
:type xmax: typing.
|
|
667
|
+
:type xmax: typing.Any
|
|
717
668
|
:param ymin: Y Min
|
|
718
|
-
:type ymin: typing.
|
|
669
|
+
:type ymin: typing.Any
|
|
719
670
|
:param ymax: Y Max
|
|
720
|
-
:type ymax: typing.
|
|
671
|
+
:type ymax: typing.Any
|
|
721
672
|
:param wait_for_input: Wait for Input
|
|
722
|
-
:type wait_for_input: typing.
|
|
673
|
+
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
723
674
|
:param mode: Mode
|
|
724
675
|
|
|
725
676
|
SET
|
|
@@ -736,35 +687,34 @@ def select_box(
|
|
|
736
687
|
|
|
737
688
|
AND
|
|
738
689
|
Intersect -- Intersect existing selection.
|
|
739
|
-
:type mode: typing.
|
|
690
|
+
:type mode: typing.Any
|
|
740
691
|
"""
|
|
741
692
|
|
|
742
693
|
...
|
|
743
694
|
|
|
744
695
|
def select_circle(
|
|
745
|
-
override_context=None,
|
|
746
|
-
execution_context=None,
|
|
747
|
-
undo=None,
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
mode: typing.Optional[typing.Any] = "SET",
|
|
696
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
697
|
+
execution_context: typing.Union[str, int] = None,
|
|
698
|
+
undo: bool = None,
|
|
699
|
+
x: typing.Any = 0,
|
|
700
|
+
y: typing.Any = 0,
|
|
701
|
+
radius: typing.Any = 25,
|
|
702
|
+
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
703
|
+
mode: typing.Any = "SET",
|
|
754
704
|
):
|
|
755
705
|
"""Select items using circle selection
|
|
756
706
|
|
|
757
|
-
:type override_context: typing.
|
|
758
|
-
:type execution_context: typing.
|
|
759
|
-
:type undo:
|
|
707
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
708
|
+
:type execution_context: typing.Union[str, int]
|
|
709
|
+
:type undo: bool
|
|
760
710
|
:param x: X
|
|
761
|
-
:type x: typing.
|
|
711
|
+
:type x: typing.Any
|
|
762
712
|
:param y: Y
|
|
763
|
-
:type y: typing.
|
|
713
|
+
:type y: typing.Any
|
|
764
714
|
:param radius: Radius
|
|
765
|
-
:type radius: typing.
|
|
715
|
+
:type radius: typing.Any
|
|
766
716
|
:param wait_for_input: Wait for Input
|
|
767
|
-
:type wait_for_input: typing.
|
|
717
|
+
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
768
718
|
:param mode: Mode
|
|
769
719
|
|
|
770
720
|
SET
|
|
@@ -775,28 +725,25 @@ def select_circle(
|
|
|
775
725
|
|
|
776
726
|
SUB
|
|
777
727
|
Subtract -- Subtract existing selection.
|
|
778
|
-
:type mode: typing.
|
|
728
|
+
:type mode: typing.Any
|
|
779
729
|
"""
|
|
780
730
|
|
|
781
731
|
...
|
|
782
732
|
|
|
783
733
|
def select_lasso(
|
|
784
|
-
override_context=None,
|
|
785
|
-
execution_context=None,
|
|
786
|
-
undo=None,
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
bpy.types.bpy_prop_collection["bpy.types.OperatorMousePath"]
|
|
790
|
-
] = None,
|
|
791
|
-
mode: typing.Optional[typing.Any] = "SET",
|
|
734
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
735
|
+
execution_context: typing.Union[str, int] = None,
|
|
736
|
+
undo: bool = None,
|
|
737
|
+
path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] = None,
|
|
738
|
+
mode: typing.Any = "SET",
|
|
792
739
|
):
|
|
793
740
|
"""Select items using lasso selection
|
|
794
741
|
|
|
795
|
-
:type override_context: typing.
|
|
796
|
-
:type execution_context: typing.
|
|
797
|
-
:type undo:
|
|
742
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
743
|
+
:type execution_context: typing.Union[str, int]
|
|
744
|
+
:type undo: bool
|
|
798
745
|
:param path: Path
|
|
799
|
-
:type path:
|
|
746
|
+
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath]
|
|
800
747
|
:param mode: Mode
|
|
801
748
|
|
|
802
749
|
SET
|
|
@@ -813,148 +760,177 @@ def select_lasso(
|
|
|
813
760
|
|
|
814
761
|
AND
|
|
815
762
|
Intersect -- Intersect existing selection.
|
|
816
|
-
:type mode: typing.
|
|
763
|
+
:type mode: typing.Any
|
|
817
764
|
"""
|
|
818
765
|
|
|
819
766
|
...
|
|
820
767
|
|
|
821
768
|
def select_menu(
|
|
822
|
-
override_context=None,
|
|
823
|
-
execution_context=None,
|
|
824
|
-
undo=None,
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
toggle: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
769
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
770
|
+
execution_context: typing.Union[str, int] = None,
|
|
771
|
+
undo: bool = None,
|
|
772
|
+
name: typing.Union[str, int, typing.Any] = "",
|
|
773
|
+
extend: typing.Union[bool, typing.Any] = False,
|
|
774
|
+
deselect: typing.Union[bool, typing.Any] = False,
|
|
775
|
+
toggle: typing.Union[bool, typing.Any] = False,
|
|
830
776
|
):
|
|
831
777
|
"""Menu object selection
|
|
832
778
|
|
|
833
|
-
:type override_context: typing.
|
|
834
|
-
:type execution_context: typing.
|
|
835
|
-
:type undo:
|
|
779
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
780
|
+
:type execution_context: typing.Union[str, int]
|
|
781
|
+
:type undo: bool
|
|
836
782
|
:param name: Object Name
|
|
837
|
-
:type name: typing.
|
|
783
|
+
:type name: typing.Union[str, int, typing.Any]
|
|
838
784
|
:param extend: Extend
|
|
839
|
-
:type extend: typing.
|
|
785
|
+
:type extend: typing.Union[bool, typing.Any]
|
|
840
786
|
:param deselect: Deselect
|
|
841
|
-
:type deselect: typing.
|
|
787
|
+
:type deselect: typing.Union[bool, typing.Any]
|
|
842
788
|
:param toggle: Toggle
|
|
843
|
-
:type toggle: typing.
|
|
789
|
+
:type toggle: typing.Union[bool, typing.Any]
|
|
844
790
|
"""
|
|
845
791
|
|
|
846
792
|
...
|
|
847
793
|
|
|
848
|
-
def smoothview(
|
|
794
|
+
def smoothview(
|
|
795
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
796
|
+
execution_context: typing.Union[str, int] = None,
|
|
797
|
+
undo: bool = None,
|
|
798
|
+
):
|
|
849
799
|
"""Undocumented, consider contributing.
|
|
850
800
|
|
|
851
|
-
:type override_context: typing.
|
|
852
|
-
:type execution_context: typing.
|
|
853
|
-
:type undo:
|
|
801
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
802
|
+
:type execution_context: typing.Union[str, int]
|
|
803
|
+
:type undo: bool
|
|
854
804
|
"""
|
|
855
805
|
|
|
856
806
|
...
|
|
857
807
|
|
|
858
|
-
def snap_cursor_to_active(
|
|
808
|
+
def snap_cursor_to_active(
|
|
809
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
810
|
+
execution_context: typing.Union[str, int] = None,
|
|
811
|
+
undo: bool = None,
|
|
812
|
+
):
|
|
859
813
|
"""Snap 3D cursor to the active item
|
|
860
814
|
|
|
861
|
-
:type override_context: typing.
|
|
862
|
-
:type execution_context: typing.
|
|
863
|
-
:type undo:
|
|
815
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
816
|
+
:type execution_context: typing.Union[str, int]
|
|
817
|
+
:type undo: bool
|
|
864
818
|
"""
|
|
865
819
|
|
|
866
820
|
...
|
|
867
821
|
|
|
868
|
-
def snap_cursor_to_center(
|
|
822
|
+
def snap_cursor_to_center(
|
|
823
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
824
|
+
execution_context: typing.Union[str, int] = None,
|
|
825
|
+
undo: bool = None,
|
|
826
|
+
):
|
|
869
827
|
"""Snap 3D cursor to the world origin
|
|
870
828
|
|
|
871
|
-
:type override_context: typing.
|
|
872
|
-
:type execution_context: typing.
|
|
873
|
-
:type undo:
|
|
829
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
830
|
+
:type execution_context: typing.Union[str, int]
|
|
831
|
+
:type undo: bool
|
|
874
832
|
"""
|
|
875
833
|
|
|
876
834
|
...
|
|
877
835
|
|
|
878
|
-
def snap_cursor_to_grid(
|
|
836
|
+
def snap_cursor_to_grid(
|
|
837
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
838
|
+
execution_context: typing.Union[str, int] = None,
|
|
839
|
+
undo: bool = None,
|
|
840
|
+
):
|
|
879
841
|
"""Snap 3D cursor to the nearest grid division
|
|
880
842
|
|
|
881
|
-
:type override_context: typing.
|
|
882
|
-
:type execution_context: typing.
|
|
883
|
-
:type undo:
|
|
843
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
844
|
+
:type execution_context: typing.Union[str, int]
|
|
845
|
+
:type undo: bool
|
|
884
846
|
"""
|
|
885
847
|
|
|
886
848
|
...
|
|
887
849
|
|
|
888
|
-
def snap_cursor_to_selected(
|
|
850
|
+
def snap_cursor_to_selected(
|
|
851
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
852
|
+
execution_context: typing.Union[str, int] = None,
|
|
853
|
+
undo: bool = None,
|
|
854
|
+
):
|
|
889
855
|
"""Snap 3D cursor to the middle of the selected item(s)
|
|
890
856
|
|
|
891
|
-
:type override_context: typing.
|
|
892
|
-
:type execution_context: typing.
|
|
893
|
-
:type undo:
|
|
857
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
858
|
+
:type execution_context: typing.Union[str, int]
|
|
859
|
+
:type undo: bool
|
|
894
860
|
"""
|
|
895
861
|
|
|
896
862
|
...
|
|
897
863
|
|
|
898
|
-
def snap_selected_to_active(
|
|
864
|
+
def snap_selected_to_active(
|
|
865
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
866
|
+
execution_context: typing.Union[str, int] = None,
|
|
867
|
+
undo: bool = None,
|
|
868
|
+
):
|
|
899
869
|
"""Snap selected item(s) to the active item
|
|
900
870
|
|
|
901
|
-
:type override_context: typing.
|
|
902
|
-
:type execution_context: typing.
|
|
903
|
-
:type undo:
|
|
871
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
872
|
+
:type execution_context: typing.Union[str, int]
|
|
873
|
+
:type undo: bool
|
|
904
874
|
"""
|
|
905
875
|
|
|
906
876
|
...
|
|
907
877
|
|
|
908
878
|
def snap_selected_to_cursor(
|
|
909
|
-
override_context=None,
|
|
910
|
-
execution_context=None,
|
|
911
|
-
undo=None,
|
|
912
|
-
|
|
913
|
-
use_offset: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
879
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
880
|
+
execution_context: typing.Union[str, int] = None,
|
|
881
|
+
undo: bool = None,
|
|
882
|
+
use_offset: typing.Union[bool, typing.Any] = True,
|
|
914
883
|
):
|
|
915
884
|
"""Snap selected item(s) to the 3D cursor
|
|
916
885
|
|
|
917
|
-
:type override_context: typing.
|
|
918
|
-
:type execution_context: typing.
|
|
919
|
-
:type undo:
|
|
886
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
887
|
+
:type execution_context: typing.Union[str, int]
|
|
888
|
+
:type undo: bool
|
|
920
889
|
:param use_offset: Offset, If the selection should be snapped as a whole or by each object center
|
|
921
|
-
:type use_offset: typing.
|
|
890
|
+
:type use_offset: typing.Union[bool, typing.Any]
|
|
922
891
|
"""
|
|
923
892
|
|
|
924
893
|
...
|
|
925
894
|
|
|
926
|
-
def snap_selected_to_grid(
|
|
895
|
+
def snap_selected_to_grid(
|
|
896
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
897
|
+
execution_context: typing.Union[str, int] = None,
|
|
898
|
+
undo: bool = None,
|
|
899
|
+
):
|
|
927
900
|
"""Snap selected item(s) to their nearest grid division
|
|
928
901
|
|
|
929
|
-
:type override_context: typing.
|
|
930
|
-
:type execution_context: typing.
|
|
931
|
-
:type undo:
|
|
902
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
903
|
+
:type execution_context: typing.Union[str, int]
|
|
904
|
+
:type undo: bool
|
|
932
905
|
"""
|
|
933
906
|
|
|
934
907
|
...
|
|
935
908
|
|
|
936
|
-
def toggle_matcap_flip(
|
|
909
|
+
def toggle_matcap_flip(
|
|
910
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
911
|
+
execution_context: typing.Union[str, int] = None,
|
|
912
|
+
undo: bool = None,
|
|
913
|
+
):
|
|
937
914
|
"""Flip MatCap
|
|
938
915
|
|
|
939
|
-
:type override_context: typing.
|
|
940
|
-
:type execution_context: typing.
|
|
941
|
-
:type undo:
|
|
916
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
917
|
+
:type execution_context: typing.Union[str, int]
|
|
918
|
+
:type undo: bool
|
|
942
919
|
"""
|
|
943
920
|
|
|
944
921
|
...
|
|
945
922
|
|
|
946
923
|
def toggle_shading(
|
|
947
|
-
override_context=None,
|
|
948
|
-
execution_context=None,
|
|
949
|
-
undo=None,
|
|
950
|
-
|
|
951
|
-
type: typing.Optional[typing.Any] = "WIREFRAME",
|
|
924
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
925
|
+
execution_context: typing.Union[str, int] = None,
|
|
926
|
+
undo: bool = None,
|
|
927
|
+
type: typing.Any = "WIREFRAME",
|
|
952
928
|
):
|
|
953
929
|
"""Toggle shading type in 3D viewport
|
|
954
930
|
|
|
955
|
-
:type override_context: typing.
|
|
956
|
-
:type execution_context: typing.
|
|
957
|
-
:type undo:
|
|
931
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
932
|
+
:type execution_context: typing.Union[str, int]
|
|
933
|
+
:type undo: bool
|
|
958
934
|
:param type: Type, Shading type to toggle
|
|
959
935
|
|
|
960
936
|
WIREFRAME
|
|
@@ -968,77 +944,78 @@ def toggle_shading(
|
|
|
968
944
|
|
|
969
945
|
RENDERED
|
|
970
946
|
Rendered -- Toggle rendered shading.
|
|
971
|
-
:type type: typing.
|
|
947
|
+
:type type: typing.Any
|
|
972
948
|
"""
|
|
973
949
|
|
|
974
950
|
...
|
|
975
951
|
|
|
976
|
-
def toggle_xray(
|
|
952
|
+
def toggle_xray(
|
|
953
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
954
|
+
execution_context: typing.Union[str, int] = None,
|
|
955
|
+
undo: bool = None,
|
|
956
|
+
):
|
|
977
957
|
"""Transparent scene display. Allow selecting through items
|
|
978
958
|
|
|
979
|
-
:type override_context: typing.
|
|
980
|
-
:type execution_context: typing.
|
|
981
|
-
:type undo:
|
|
959
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
960
|
+
:type execution_context: typing.Union[str, int]
|
|
961
|
+
:type undo: bool
|
|
982
962
|
"""
|
|
983
963
|
|
|
984
964
|
...
|
|
985
965
|
|
|
986
966
|
def transform_gizmo_set(
|
|
987
|
-
override_context=None,
|
|
988
|
-
execution_context=None,
|
|
989
|
-
undo=None,
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
type: typing.Optional[typing.Any] = {},
|
|
967
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
968
|
+
execution_context: typing.Union[str, int] = None,
|
|
969
|
+
undo: bool = None,
|
|
970
|
+
extend: typing.Union[bool, typing.Any] = False,
|
|
971
|
+
type: typing.Any = {},
|
|
993
972
|
):
|
|
994
973
|
"""Set the current transform gizmo
|
|
995
974
|
|
|
996
|
-
:type override_context: typing.
|
|
997
|
-
:type execution_context: typing.
|
|
998
|
-
:type undo:
|
|
975
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
976
|
+
:type execution_context: typing.Union[str, int]
|
|
977
|
+
:type undo: bool
|
|
999
978
|
:param extend: Extend
|
|
1000
|
-
:type extend: typing.
|
|
979
|
+
:type extend: typing.Union[bool, typing.Any]
|
|
1001
980
|
:param type: Type
|
|
1002
|
-
:type type: typing.
|
|
981
|
+
:type type: typing.Any
|
|
1003
982
|
"""
|
|
1004
983
|
|
|
1005
984
|
...
|
|
1006
985
|
|
|
1007
986
|
def view_all(
|
|
1008
|
-
override_context=None,
|
|
1009
|
-
execution_context=None,
|
|
1010
|
-
undo=None,
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
center: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
987
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
988
|
+
execution_context: typing.Union[str, int] = None,
|
|
989
|
+
undo: bool = None,
|
|
990
|
+
use_all_regions: typing.Union[bool, typing.Any] = False,
|
|
991
|
+
center: typing.Union[bool, typing.Any] = False,
|
|
1014
992
|
):
|
|
1015
993
|
"""View all objects in scene
|
|
1016
994
|
|
|
1017
|
-
:type override_context: typing.
|
|
1018
|
-
:type execution_context: typing.
|
|
1019
|
-
:type undo:
|
|
995
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
996
|
+
:type execution_context: typing.Union[str, int]
|
|
997
|
+
:type undo: bool
|
|
1020
998
|
:param use_all_regions: All Regions, View selected for all regions
|
|
1021
|
-
:type use_all_regions: typing.
|
|
999
|
+
:type use_all_regions: typing.Union[bool, typing.Any]
|
|
1022
1000
|
:param center: Center
|
|
1023
|
-
:type center: typing.
|
|
1001
|
+
:type center: typing.Union[bool, typing.Any]
|
|
1024
1002
|
"""
|
|
1025
1003
|
|
|
1026
1004
|
...
|
|
1027
1005
|
|
|
1028
1006
|
def view_axis(
|
|
1029
|
-
override_context=None,
|
|
1030
|
-
execution_context=None,
|
|
1031
|
-
undo=None,
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
relative: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1007
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1008
|
+
execution_context: typing.Union[str, int] = None,
|
|
1009
|
+
undo: bool = None,
|
|
1010
|
+
type: typing.Any = "LEFT",
|
|
1011
|
+
align_active: typing.Union[bool, typing.Any] = False,
|
|
1012
|
+
relative: typing.Union[bool, typing.Any] = False,
|
|
1036
1013
|
):
|
|
1037
1014
|
"""Use a preset viewpoint
|
|
1038
1015
|
|
|
1039
|
-
:type override_context: typing.
|
|
1040
|
-
:type execution_context: typing.
|
|
1041
|
-
:type undo:
|
|
1016
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1017
|
+
:type execution_context: typing.Union[str, int]
|
|
1018
|
+
:type undo: bool
|
|
1042
1019
|
:param type: View, Preset viewpoint to use
|
|
1043
1020
|
|
|
1044
1021
|
LEFT
|
|
@@ -1058,100 +1035,127 @@ def view_axis(
|
|
|
1058
1035
|
|
|
1059
1036
|
BACK
|
|
1060
1037
|
Back -- View from the back.
|
|
1061
|
-
:type type: typing.
|
|
1038
|
+
:type type: typing.Any
|
|
1062
1039
|
:param align_active: Align Active, Align to the active object's axis
|
|
1063
|
-
:type align_active: typing.
|
|
1040
|
+
:type align_active: typing.Union[bool, typing.Any]
|
|
1064
1041
|
:param relative: Relative, Rotate relative to the current orientation
|
|
1065
|
-
:type relative: typing.
|
|
1042
|
+
:type relative: typing.Union[bool, typing.Any]
|
|
1066
1043
|
"""
|
|
1067
1044
|
|
|
1068
1045
|
...
|
|
1069
1046
|
|
|
1070
|
-
def view_camera(
|
|
1047
|
+
def view_camera(
|
|
1048
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1049
|
+
execution_context: typing.Union[str, int] = None,
|
|
1050
|
+
undo: bool = None,
|
|
1051
|
+
):
|
|
1071
1052
|
"""Toggle the camera view
|
|
1072
1053
|
|
|
1073
|
-
:type override_context: typing.
|
|
1074
|
-
:type execution_context: typing.
|
|
1075
|
-
:type undo:
|
|
1054
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1055
|
+
:type execution_context: typing.Union[str, int]
|
|
1056
|
+
:type undo: bool
|
|
1076
1057
|
"""
|
|
1077
1058
|
|
|
1078
1059
|
...
|
|
1079
1060
|
|
|
1080
|
-
def view_center_camera(
|
|
1061
|
+
def view_center_camera(
|
|
1062
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1063
|
+
execution_context: typing.Union[str, int] = None,
|
|
1064
|
+
undo: bool = None,
|
|
1065
|
+
):
|
|
1081
1066
|
"""Center the camera view, resizing the view to fit its bounds
|
|
1082
1067
|
|
|
1083
|
-
:type override_context: typing.
|
|
1084
|
-
:type execution_context: typing.
|
|
1085
|
-
:type undo:
|
|
1068
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1069
|
+
:type execution_context: typing.Union[str, int]
|
|
1070
|
+
:type undo: bool
|
|
1086
1071
|
"""
|
|
1087
1072
|
|
|
1088
1073
|
...
|
|
1089
1074
|
|
|
1090
|
-
def view_center_cursor(
|
|
1075
|
+
def view_center_cursor(
|
|
1076
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1077
|
+
execution_context: typing.Union[str, int] = None,
|
|
1078
|
+
undo: bool = None,
|
|
1079
|
+
):
|
|
1091
1080
|
"""Center the view so that the cursor is in the middle of the view
|
|
1092
1081
|
|
|
1093
|
-
:type override_context: typing.
|
|
1094
|
-
:type execution_context: typing.
|
|
1095
|
-
:type undo:
|
|
1082
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1083
|
+
:type execution_context: typing.Union[str, int]
|
|
1084
|
+
:type undo: bool
|
|
1096
1085
|
"""
|
|
1097
1086
|
|
|
1098
1087
|
...
|
|
1099
1088
|
|
|
1100
|
-
def view_center_lock(
|
|
1089
|
+
def view_center_lock(
|
|
1090
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1091
|
+
execution_context: typing.Union[str, int] = None,
|
|
1092
|
+
undo: bool = None,
|
|
1093
|
+
):
|
|
1101
1094
|
"""Center the view lock offset
|
|
1102
1095
|
|
|
1103
|
-
:type override_context: typing.
|
|
1104
|
-
:type execution_context: typing.
|
|
1105
|
-
:type undo:
|
|
1096
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1097
|
+
:type execution_context: typing.Union[str, int]
|
|
1098
|
+
:type undo: bool
|
|
1106
1099
|
"""
|
|
1107
1100
|
|
|
1108
1101
|
...
|
|
1109
1102
|
|
|
1110
|
-
def view_center_pick(
|
|
1103
|
+
def view_center_pick(
|
|
1104
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1105
|
+
execution_context: typing.Union[str, int] = None,
|
|
1106
|
+
undo: bool = None,
|
|
1107
|
+
):
|
|
1111
1108
|
"""Center the view to the Z-depth position under the mouse cursor
|
|
1112
1109
|
|
|
1113
|
-
:type override_context: typing.
|
|
1114
|
-
:type execution_context: typing.
|
|
1115
|
-
:type undo:
|
|
1110
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1111
|
+
:type execution_context: typing.Union[str, int]
|
|
1112
|
+
:type undo: bool
|
|
1116
1113
|
"""
|
|
1117
1114
|
|
|
1118
1115
|
...
|
|
1119
1116
|
|
|
1120
|
-
def view_lock_clear(
|
|
1117
|
+
def view_lock_clear(
|
|
1118
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1119
|
+
execution_context: typing.Union[str, int] = None,
|
|
1120
|
+
undo: bool = None,
|
|
1121
|
+
):
|
|
1121
1122
|
"""Clear all view locking
|
|
1122
1123
|
|
|
1123
|
-
:type override_context: typing.
|
|
1124
|
-
:type execution_context: typing.
|
|
1125
|
-
:type undo:
|
|
1124
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1125
|
+
:type execution_context: typing.Union[str, int]
|
|
1126
|
+
:type undo: bool
|
|
1126
1127
|
"""
|
|
1127
1128
|
|
|
1128
1129
|
...
|
|
1129
1130
|
|
|
1130
|
-
def view_lock_to_active(
|
|
1131
|
+
def view_lock_to_active(
|
|
1132
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1133
|
+
execution_context: typing.Union[str, int] = None,
|
|
1134
|
+
undo: bool = None,
|
|
1135
|
+
):
|
|
1131
1136
|
"""Lock the view to the active object/bone
|
|
1132
1137
|
|
|
1133
|
-
:type override_context: typing.
|
|
1134
|
-
:type execution_context: typing.
|
|
1135
|
-
:type undo:
|
|
1138
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1139
|
+
:type execution_context: typing.Union[str, int]
|
|
1140
|
+
:type undo: bool
|
|
1136
1141
|
"""
|
|
1137
1142
|
|
|
1138
1143
|
...
|
|
1139
1144
|
|
|
1140
1145
|
def view_orbit(
|
|
1141
|
-
override_context=None,
|
|
1142
|
-
execution_context=None,
|
|
1143
|
-
undo=None,
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
type: typing.Optional[typing.Any] = "ORBITLEFT",
|
|
1146
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1147
|
+
execution_context: typing.Union[str, int] = None,
|
|
1148
|
+
undo: bool = None,
|
|
1149
|
+
angle: typing.Any = 0.0,
|
|
1150
|
+
type: typing.Any = "ORBITLEFT",
|
|
1147
1151
|
):
|
|
1148
1152
|
"""Orbit the view
|
|
1149
1153
|
|
|
1150
|
-
:type override_context: typing.
|
|
1151
|
-
:type execution_context: typing.
|
|
1152
|
-
:type undo:
|
|
1154
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1155
|
+
:type execution_context: typing.Union[str, int]
|
|
1156
|
+
:type undo: bool
|
|
1153
1157
|
:param angle: Roll
|
|
1154
|
-
:type angle: typing.
|
|
1158
|
+
:type angle: typing.Any
|
|
1155
1159
|
:param type: Orbit, Direction of View Orbit
|
|
1156
1160
|
|
|
1157
1161
|
ORBITLEFT
|
|
@@ -1165,23 +1169,22 @@ def view_orbit(
|
|
|
1165
1169
|
|
|
1166
1170
|
ORBITDOWN
|
|
1167
1171
|
Orbit Down -- Orbit the view down.
|
|
1168
|
-
:type type: typing.
|
|
1172
|
+
:type type: typing.Any
|
|
1169
1173
|
"""
|
|
1170
1174
|
|
|
1171
1175
|
...
|
|
1172
1176
|
|
|
1173
1177
|
def view_pan(
|
|
1174
|
-
override_context=None,
|
|
1175
|
-
execution_context=None,
|
|
1176
|
-
undo=None,
|
|
1177
|
-
|
|
1178
|
-
type: typing.Optional[typing.Any] = "PANLEFT",
|
|
1178
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1179
|
+
execution_context: typing.Union[str, int] = None,
|
|
1180
|
+
undo: bool = None,
|
|
1181
|
+
type: typing.Any = "PANLEFT",
|
|
1179
1182
|
):
|
|
1180
1183
|
"""Pan the view in a given direction
|
|
1181
1184
|
|
|
1182
|
-
:type override_context: typing.
|
|
1183
|
-
:type execution_context: typing.
|
|
1184
|
-
:type undo:
|
|
1185
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1186
|
+
:type execution_context: typing.Union[str, int]
|
|
1187
|
+
:type undo: bool
|
|
1185
1188
|
:param type: Pan, Direction of View Pan
|
|
1186
1189
|
|
|
1187
1190
|
PANLEFT
|
|
@@ -1195,36 +1198,39 @@ def view_pan(
|
|
|
1195
1198
|
|
|
1196
1199
|
PANDOWN
|
|
1197
1200
|
Pan Down -- Pan the view down.
|
|
1198
|
-
:type type: typing.
|
|
1201
|
+
:type type: typing.Any
|
|
1199
1202
|
"""
|
|
1200
1203
|
|
|
1201
1204
|
...
|
|
1202
1205
|
|
|
1203
|
-
def view_persportho(
|
|
1206
|
+
def view_persportho(
|
|
1207
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1208
|
+
execution_context: typing.Union[str, int] = None,
|
|
1209
|
+
undo: bool = None,
|
|
1210
|
+
):
|
|
1204
1211
|
"""Switch the current view from perspective/orthographic projection
|
|
1205
1212
|
|
|
1206
|
-
:type override_context: typing.
|
|
1207
|
-
:type execution_context: typing.
|
|
1208
|
-
:type undo:
|
|
1213
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1214
|
+
:type execution_context: typing.Union[str, int]
|
|
1215
|
+
:type undo: bool
|
|
1209
1216
|
"""
|
|
1210
1217
|
|
|
1211
1218
|
...
|
|
1212
1219
|
|
|
1213
1220
|
def view_roll(
|
|
1214
|
-
override_context=None,
|
|
1215
|
-
execution_context=None,
|
|
1216
|
-
undo=None,
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
type: typing.Optional[typing.Any] = "ANGLE",
|
|
1221
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1222
|
+
execution_context: typing.Union[str, int] = None,
|
|
1223
|
+
undo: bool = None,
|
|
1224
|
+
angle: typing.Any = 0.0,
|
|
1225
|
+
type: typing.Any = "ANGLE",
|
|
1220
1226
|
):
|
|
1221
1227
|
"""Roll the view
|
|
1222
1228
|
|
|
1223
|
-
:type override_context: typing.
|
|
1224
|
-
:type execution_context: typing.
|
|
1225
|
-
:type undo:
|
|
1229
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1230
|
+
:type execution_context: typing.Union[str, int]
|
|
1231
|
+
:type undo: bool
|
|
1226
1232
|
:param angle: Roll
|
|
1227
|
-
:type angle: typing.
|
|
1233
|
+
:type angle: typing.Any
|
|
1228
1234
|
:param type: Roll Angle Source, How roll angle is calculated
|
|
1229
1235
|
|
|
1230
1236
|
ANGLE
|
|
@@ -1235,105 +1241,110 @@ def view_roll(
|
|
|
1235
1241
|
|
|
1236
1242
|
RIGHT
|
|
1237
1243
|
Roll Right -- Roll the view around to the right.
|
|
1238
|
-
:type type: typing.
|
|
1244
|
+
:type type: typing.Any
|
|
1239
1245
|
"""
|
|
1240
1246
|
|
|
1241
1247
|
...
|
|
1242
1248
|
|
|
1243
1249
|
def view_selected(
|
|
1244
|
-
override_context=None,
|
|
1245
|
-
execution_context=None,
|
|
1246
|
-
undo=None,
|
|
1247
|
-
|
|
1248
|
-
use_all_regions: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1250
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1251
|
+
execution_context: typing.Union[str, int] = None,
|
|
1252
|
+
undo: bool = None,
|
|
1253
|
+
use_all_regions: typing.Union[bool, typing.Any] = False,
|
|
1249
1254
|
):
|
|
1250
1255
|
"""Move the view to the selection center
|
|
1251
1256
|
|
|
1252
|
-
:type override_context: typing.
|
|
1253
|
-
:type execution_context: typing.
|
|
1254
|
-
:type undo:
|
|
1257
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1258
|
+
:type execution_context: typing.Union[str, int]
|
|
1259
|
+
:type undo: bool
|
|
1255
1260
|
:param use_all_regions: All Regions, View selected for all regions
|
|
1256
|
-
:type use_all_regions: typing.
|
|
1261
|
+
:type use_all_regions: typing.Union[bool, typing.Any]
|
|
1257
1262
|
"""
|
|
1258
1263
|
|
|
1259
1264
|
...
|
|
1260
1265
|
|
|
1261
|
-
def walk(
|
|
1266
|
+
def walk(
|
|
1267
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1268
|
+
execution_context: typing.Union[str, int] = None,
|
|
1269
|
+
undo: bool = None,
|
|
1270
|
+
):
|
|
1262
1271
|
"""Interactively walk around the scene
|
|
1263
1272
|
|
|
1264
|
-
:type override_context: typing.
|
|
1265
|
-
:type execution_context: typing.
|
|
1266
|
-
:type undo:
|
|
1273
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1274
|
+
:type execution_context: typing.Union[str, int]
|
|
1275
|
+
:type undo: bool
|
|
1267
1276
|
"""
|
|
1268
1277
|
|
|
1269
1278
|
...
|
|
1270
1279
|
|
|
1271
1280
|
def zoom(
|
|
1272
|
-
override_context=None,
|
|
1273
|
-
execution_context=None,
|
|
1274
|
-
undo=None,
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
use_cursor_init: typing.Optional[typing.Union[bool, typing.Any]] = True,
|
|
1281
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1282
|
+
execution_context: typing.Union[str, int] = None,
|
|
1283
|
+
undo: bool = None,
|
|
1284
|
+
mx: typing.Any = 0,
|
|
1285
|
+
my: typing.Any = 0,
|
|
1286
|
+
delta: typing.Any = 0,
|
|
1287
|
+
use_cursor_init: typing.Union[bool, typing.Any] = True,
|
|
1280
1288
|
):
|
|
1281
1289
|
"""Zoom in/out in the view
|
|
1282
1290
|
|
|
1283
|
-
:type override_context: typing.
|
|
1284
|
-
:type execution_context: typing.
|
|
1285
|
-
:type undo:
|
|
1291
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1292
|
+
:type execution_context: typing.Union[str, int]
|
|
1293
|
+
:type undo: bool
|
|
1286
1294
|
:param mx: Region Position X
|
|
1287
|
-
:type mx: typing.
|
|
1295
|
+
:type mx: typing.Any
|
|
1288
1296
|
:param my: Region Position Y
|
|
1289
|
-
:type my: typing.
|
|
1297
|
+
:type my: typing.Any
|
|
1290
1298
|
:param delta: Delta
|
|
1291
|
-
:type delta: typing.
|
|
1299
|
+
:type delta: typing.Any
|
|
1292
1300
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
1293
|
-
:type use_cursor_init: typing.
|
|
1301
|
+
:type use_cursor_init: typing.Union[bool, typing.Any]
|
|
1294
1302
|
"""
|
|
1295
1303
|
|
|
1296
1304
|
...
|
|
1297
1305
|
|
|
1298
1306
|
def zoom_border(
|
|
1299
|
-
override_context=None,
|
|
1300
|
-
execution_context=None,
|
|
1301
|
-
undo=None,
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
zoom_out: typing.Optional[typing.Union[bool, typing.Any]] = False,
|
|
1307
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1308
|
+
execution_context: typing.Union[str, int] = None,
|
|
1309
|
+
undo: bool = None,
|
|
1310
|
+
xmin: typing.Any = 0,
|
|
1311
|
+
xmax: typing.Any = 0,
|
|
1312
|
+
ymin: typing.Any = 0,
|
|
1313
|
+
ymax: typing.Any = 0,
|
|
1314
|
+
wait_for_input: typing.Union[bool, typing.Any] = True,
|
|
1315
|
+
zoom_out: typing.Union[bool, typing.Any] = False,
|
|
1309
1316
|
):
|
|
1310
1317
|
"""Zoom in the view to the nearest object contained in the border
|
|
1311
1318
|
|
|
1312
|
-
:type override_context: typing.
|
|
1313
|
-
:type execution_context: typing.
|
|
1314
|
-
:type undo:
|
|
1319
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1320
|
+
:type execution_context: typing.Union[str, int]
|
|
1321
|
+
:type undo: bool
|
|
1315
1322
|
:param xmin: X Min
|
|
1316
|
-
:type xmin: typing.
|
|
1323
|
+
:type xmin: typing.Any
|
|
1317
1324
|
:param xmax: X Max
|
|
1318
|
-
:type xmax: typing.
|
|
1325
|
+
:type xmax: typing.Any
|
|
1319
1326
|
:param ymin: Y Min
|
|
1320
|
-
:type ymin: typing.
|
|
1327
|
+
:type ymin: typing.Any
|
|
1321
1328
|
:param ymax: Y Max
|
|
1322
|
-
:type ymax: typing.
|
|
1329
|
+
:type ymax: typing.Any
|
|
1323
1330
|
:param wait_for_input: Wait for Input
|
|
1324
|
-
:type wait_for_input: typing.
|
|
1331
|
+
:type wait_for_input: typing.Union[bool, typing.Any]
|
|
1325
1332
|
:param zoom_out: Zoom Out
|
|
1326
|
-
:type zoom_out: typing.
|
|
1333
|
+
:type zoom_out: typing.Union[bool, typing.Any]
|
|
1327
1334
|
"""
|
|
1328
1335
|
|
|
1329
1336
|
...
|
|
1330
1337
|
|
|
1331
|
-
def zoom_camera_1_to_1(
|
|
1338
|
+
def zoom_camera_1_to_1(
|
|
1339
|
+
override_context: typing.Union[dict, bpy.types.Context] = None,
|
|
1340
|
+
execution_context: typing.Union[str, int] = None,
|
|
1341
|
+
undo: bool = None,
|
|
1342
|
+
):
|
|
1332
1343
|
"""Match the camera to 1:1 to the render output
|
|
1333
1344
|
|
|
1334
|
-
:type override_context: typing.
|
|
1335
|
-
:type execution_context: typing.
|
|
1336
|
-
:type undo:
|
|
1345
|
+
:type override_context: typing.Union[dict, bpy.types.Context]
|
|
1346
|
+
:type execution_context: typing.Union[str, int]
|
|
1347
|
+
:type undo: bool
|
|
1337
1348
|
"""
|
|
1338
1349
|
|
|
1339
1350
|
...
|