fake-bpy-module 20250828__py3-none-any.whl → 20260119__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.
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +0 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +0 -5
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +0 -11
- {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +0 -10
- {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +1 -0
- {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +1 -0
- {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +2 -0
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- _bpy_internal/__init__.pyi +3 -1
- _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
- _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
- _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
- _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
- _bpy_internal/filesystem/__init__.pyi +5 -0
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_types/__init__.pyi +115 -117
- {rna_info → _rna_info}/__init__.pyi +0 -1
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +66 -142
- bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
- bl_app_templates_system/__init__.pyi +5 -0
- bl_app_templates_system/py.typed +0 -0
- bl_math/__init__.pyi +2 -12
- bl_operators/__init__.pyi +1 -0
- bl_operators/add_mesh_torus/__init__.pyi +0 -2
- bl_operators/anim/__init__.pyi +47 -24
- bl_operators/assets/__init__.pyi +0 -6
- bl_operators/bone_selection_sets/__init__.pyi +0 -28
- bl_operators/clip/__init__.pyi +0 -20
- bl_operators/connect_to_output/__init__.pyi +0 -2
- bl_operators/console/__init__.pyi +0 -10
- bl_operators/constraint/__init__.pyi +0 -8
- bl_operators/copy_global_transform/__init__.pyi +261 -0
- bl_operators/file/__init__.pyi +0 -6
- bl_operators/freestyle/__init__.pyi +0 -8
- bl_operators/geometry_nodes/__init__.pyi +0 -8
- bl_operators/grease_pencil/__init__.pyi +0 -2
- bl_operators/image/__init__.pyi +0 -10
- bl_operators/image_as_planes/__init__.pyi +0 -4
- bl_operators/mesh/__init__.pyi +0 -47
- bl_operators/node/__init__.pyi +277 -57
- bl_operators/object/__init__.pyi +0 -37
- bl_operators/object_align/__init__.pyi +0 -2
- bl_operators/object_quick_effects/__init__.pyi +0 -8
- bl_operators/object_randomize_transform/__init__.pyi +0 -2
- bl_operators/presets/__init__.pyi +1 -51
- bl_operators/rigidbody/__init__.pyi +0 -6
- bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
- bl_operators/sequencer/__init__.pyi +0 -16
- bl_operators/spreadsheet/__init__.pyi +0 -2
- bl_operators/userpref/__init__.pyi +0 -50
- bl_operators/uvcalc_follow_active/__init__.pyi +1 -3
- bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
- bl_operators/uvcalc_transform/__init__.pyi +21 -12
- bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
- bl_operators/view3d/__init__.pyi +0 -16
- bl_operators/wm/__init__.pyi +0 -92
- bl_operators/world/__init__.pyi +0 -2
- bl_ui/__init__.pyi +3 -4
- bl_ui/anim/__init__.pyi +0 -2
- bl_ui/asset_shelf/__init__.pyi +0 -2
- bl_ui/generic_ui_list/__init__.pyi +1 -17
- bl_ui/node_add_menu/__init__.pyi +261 -6
- bl_ui/node_add_menu_compositor/__init__.pyi +96 -80
- bl_ui/node_add_menu_geometry/__init__.pyi +266 -306
- bl_ui/node_add_menu_shader/__init__.pyi +49 -50
- bl_ui/node_add_menu_texture/__init__.pyi +16 -62
- bl_ui/properties_collection/__init__.pyi +0 -14
- bl_ui/properties_constraint/__init__.pyi +55 -209
- bl_ui/properties_data_armature/__init__.pyi +0 -36
- bl_ui/properties_data_bone/__init__.pyi +0 -20
- bl_ui/properties_data_camera/__init__.pyi +0 -30
- bl_ui/properties_data_curve/__init__.pyi +0 -30
- bl_ui/properties_data_curves/__init__.pyi +0 -16
- bl_ui/properties_data_empty/__init__.pyi +0 -4
- bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
- bl_ui/properties_data_lattice/__init__.pyi +0 -8
- bl_ui/properties_data_light/__init__.pyi +0 -20
- bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
- bl_ui/properties_data_mesh/__init__.pyi +1 -42
- bl_ui/properties_data_metaball/__init__.pyi +0 -12
- bl_ui/properties_data_modifier/__init__.pyi +12 -19
- bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
- bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
- bl_ui/properties_data_speaker/__init__.pyi +0 -12
- bl_ui/properties_data_volume/__init__.pyi +0 -18
- bl_ui/properties_freestyle/__init__.pyi +0 -50
- bl_ui/properties_grease_pencil_common/__init__.pyi +0 -159
- bl_ui/properties_mask_common/__init__.pyi +0 -14
- bl_ui/properties_material/__init__.pyi +0 -32
- bl_ui/properties_material_gpencil/__init__.pyi +23 -45
- bl_ui/properties_object/__init__.pyi +35 -42
- bl_ui/properties_output/__init__.pyi +0 -40
- bl_ui/properties_paint_common/__init__.pyi +23 -19
- bl_ui/properties_particle/__init__.pyi +0 -106
- bl_ui/properties_physics_cloth/__init__.pyi +0 -28
- bl_ui/properties_physics_common/__init__.pyi +0 -2
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
- bl_ui/properties_physics_field/__init__.pyi +0 -20
- bl_ui/properties_physics_fluid/__init__.pyi +0 -56
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
- bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
- bl_ui/properties_physics_softbody/__init__.pyi +0 -30
- bl_ui/properties_render/__init__.pyi +58 -86
- bl_ui/properties_scene/__init__.pyi +0 -34
- bl_ui/properties_strip/__init__.pyi +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +0 -54
- bl_ui/properties_view_layer/__init__.pyi +7 -28
- bl_ui/properties_workspace/__init__.pyi +0 -8
- bl_ui/properties_world/__init__.pyi +0 -22
- bl_ui/space_clip/__init__.pyi +82 -166
- bl_ui/space_console/__init__.pyi +0 -12
- bl_ui/space_dopesheet/__init__.pyi +67 -76
- bl_ui/space_filebrowser/__init__.pyi +0 -60
- bl_ui/space_graph/__init__.pyi +0 -66
- bl_ui/space_image/__init__.pyi +28 -162
- bl_ui/space_info/__init__.pyi +0 -12
- bl_ui/space_nla/__init__.pyi +0 -58
- bl_ui/space_node/__init__.pyi +99 -132
- bl_ui/space_outliner/__init__.pyi +0 -30
- bl_ui/space_properties/__init__.pyi +29 -6
- bl_ui/space_sequencer/__init__.pyi +159 -987
- bl_ui/space_spreadsheet/__init__.pyi +0 -6
- bl_ui/space_statusbar/__init__.pyi +0 -2
- bl_ui/space_text/__init__.pyi +0 -32
- bl_ui/space_time/__init__.pyi +29 -22
- bl_ui/space_toolsystem_toolbar/__init__.pyi +7 -2
- bl_ui/space_topbar/__init__.pyi +7 -52
- bl_ui/space_userpref/__init__.pyi +77 -225
- bl_ui/space_view3d/__init__.pyi +69 -551
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +22 -799
- bl_ui/utils/__init__.pyi +0 -17
- blf/__init__.pyi +6 -50
- bmesh/__init__.pyi +0 -7
- bmesh/geometry/__init__.pyi +0 -3
- bmesh/ops/__init__.pyi +5 -450
- bmesh/types/__init__.pyi +298 -639
- bmesh/utils/__init__.pyi +16 -43
- bpy/app/__init__.pyi +66 -58
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +0 -6
- bpy/app/translations/__init__.pyi +1 -16
- bpy/msgbus/__init__.pyi +1 -4
- bpy/ops/action/__init__.pyi +17 -186
- bpy/ops/anim/__init__.pyi +38 -279
- bpy/ops/armature/__init__.pyi +20 -191
- bpy/ops/asset/__init__.pyi +11 -97
- bpy/ops/boid/__init__.pyi +7 -38
- bpy/ops/brush/__init__.pyi +3 -104
- bpy/ops/buttons/__init__.pyi +4 -71
- bpy/ops/cachefile/__init__.pyi +2 -63
- bpy/ops/camera/__init__.pyi +0 -11
- bpy/ops/clip/__init__.pyi +43 -427
- bpy/ops/cloth/__init__.pyi +0 -5
- bpy/ops/collection/__init__.pyi +3 -35
- bpy/ops/console/__init__.pyi +10 -88
- bpy/ops/constraint/__init__.pyi +3 -80
- bpy/ops/curve/__init__.pyi +23 -254
- bpy/ops/curves/__init__.pyi +54 -149
- bpy/ops/cycles/__init__.pyi +1 -14
- bpy/ops/dpaint/__init__.pyi +3 -21
- bpy/ops/ed/__init__.pyi +10 -82
- bpy/ops/export_anim/__init__.pyi +2 -10
- bpy/ops/export_scene/__init__.pyi +1 -155
- bpy/ops/extensions/__init__.pyi +15 -150
- bpy/ops/file/__init__.pyi +29 -216
- bpy/ops/fluid/__init__.pyi +13 -70
- bpy/ops/font/__init__.pyi +10 -134
- bpy/ops/geometry/__init__.pyi +3 -124
- bpy/ops/gizmogroup/__init__.pyi +1 -12
- bpy/ops/gpencil/__init__.pyi +5 -49
- bpy/ops/graph/__init__.pyi +20 -315
- bpy/ops/grease_pencil/__init__.pyi +62 -523
- bpy/ops/image/__init__.pyi +19 -379
- bpy/ops/import_anim/__init__.pyi +2 -16
- bpy/ops/import_curve/__init__.pyi +0 -6
- bpy/ops/import_scene/__init__.pyi +0 -50
- bpy/ops/info/__init__.pyi +4 -35
- bpy/ops/lattice/__init__.pyi +3 -33
- bpy/ops/marker/__init__.pyi +4 -49
- bpy/ops/mask/__init__.pyi +17 -176
- bpy/ops/material/__init__.pyi +3 -15
- bpy/ops/mball/__init__.pyi +1 -30
- bpy/ops/mesh/__init__.pyi +34 -932
- bpy/ops/nla/__init__.pyi +22 -183
- bpy/ops/node/__init__.pyi +420 -625
- bpy/ops/object/__init__.pyi +197 -1239
- bpy/ops/outliner/__init__.pyi +47 -327
- bpy/ops/paint/__init__.pyi +29 -282
- bpy/ops/paintcurve/__init__.pyi +4 -36
- bpy/ops/palette/__init__.pyi +3 -27
- bpy/ops/particle/__init__.pyi +20 -160
- bpy/ops/pointcloud/__init__.pyi +3 -35
- bpy/ops/pose/__init__.pyi +29 -234
- bpy/ops/poselib/__init__.pyi +19 -66
- bpy/ops/preferences/__init__.pyi +9 -177
- bpy/ops/ptcache/__init__.pyi +5 -31
- bpy/ops/render/__init__.pyi +10 -68
- bpy/ops/rigidbody/__init__.pyi +6 -56
- bpy/ops/scene/__init__.pyi +23 -168
- bpy/ops/screen/__init__.pyi +36 -202
- bpy/ops/script/__init__.pyi +1 -12
- bpy/ops/sculpt/__init__.pyi +42 -313
- bpy/ops/sculpt_curves/__init__.pyi +6 -21
- bpy/ops/sequencer/__init__.pyi +187 -644
- bpy/ops/sound/__init__.pyi +3 -109
- bpy/ops/spreadsheet/__init__.pyi +5 -32
- bpy/ops/surface/__init__.pyi +0 -48
- bpy/ops/text/__init__.pyi +27 -225
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +3 -18
- bpy/ops/transform/__init__.pyi +10 -382
- bpy/ops/ui/__init__.pyi +29 -154
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +195 -288
- bpy/ops/view2d/__init__.pyi +3 -73
- bpy/ops/view3d/__init__.pyi +37 -339
- bpy/ops/wm/__init__.pyi +129 -1317
- bpy/ops/workspace/__init__.pyi +7 -39
- bpy/ops/world/__init__.pyi +2 -10
- bpy/path/__init__.pyi +0 -34
- bpy/props/__init__.pyi +332 -203
- bpy/stub_internal/rna_enums/__init__.pyi +102 -82
- bpy/types/__init__.pyi +51712 -89245
- bpy/utils/__init__.pyi +4 -75
- bpy/utils/previews/__init__.pyi +1 -10
- bpy/utils/units/__init__.pyi +0 -12
- bpy_extras/anim_utils/__init__.pyi +24 -16
- bpy_extras/bmesh_utils/__init__.pyi +0 -1
- bpy_extras/id_map_utils/__init__.pyi +14 -6
- bpy_extras/image_utils/__init__.pyi +0 -9
- bpy_extras/io_utils/__init__.pyi +4 -23
- bpy_extras/keyconfig_utils/__init__.pyi +1 -1
- bpy_extras/mesh_utils/__init__.pyi +0 -12
- bpy_extras/node_shader_utils/__init__.pyi +0 -8
- bpy_extras/object_utils/__init__.pyi +0 -14
- bpy_extras/view3d_utils/__init__.pyi +0 -18
- {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/METADATA +4 -1
- fake_bpy_module-20260119.dist-info/RECORD +385 -0
- {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/top_level.txt +15 -14
- freestyle/chainingiterators/__init__.pyi +0 -22
- freestyle/functions/__init__.pyi +0 -139
- freestyle/predicates/__init__.pyi +0 -51
- freestyle/shaders/__init__.pyi +0 -65
- freestyle/types/__init__.pyi +139 -777
- freestyle/utils/ContextFunctions/__init__.pyi +0 -23
- freestyle/utils/__init__.pyi +0 -6
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +1 -10
- gpu/platform/__init__.pyi +0 -5
- gpu/shader/__init__.pyi +22 -6
- gpu/state/__init__.pyi +59 -38
- gpu/texture/__init__.pyi +0 -2
- gpu/types/__init__.pyi +84 -152
- gpu_extras/batch/__init__.pyi +0 -4
- gpu_extras/presets/__init__.pyi +6 -8
- idprop/types/__init__.pyi +6 -6
- imbuf/__init__.pyi +2 -9
- imbuf/types/__init__.pyi +5 -25
- keyingsets_builtins/__init__.pyi +1 -45
- mathutils/__init__.pyi +106 -2168
- mathutils/bvhtree/__init__.pyi +3 -25
- mathutils/geometry/__init__.pyi +41 -133
- mathutils/interpolate/__init__.pyi +3 -4
- mathutils/kdtree/__init__.pyi +0 -11
- mathutils/noise/__init__.pyi +0 -62
- fake_bpy_module-20250828.dist-info/RECORD +0 -370
- {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
- {animsys_refactor → _animsys_refactor}/py.typed +0 -0
- {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
- {bl_console_utils → _bl_console_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/py.typed +0 -0
- {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
- {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
- {bl_rna_utils → _bl_rna_utils}/py.typed +0 -0
- {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
- {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
- {bl_text_utils → _bl_text_utils}/py.typed +0 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
- {bl_ui_utils → _bl_ui_utils}/py.typed +0 -0
- /_bpy_internal/{freedesktop → platform/freedesktop}/__init__.pyi +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
- {console_python → _console_python}/__init__.pyi +0 -0
- {console_python → _console_python}/py.typed +0 -0
- {console_shell → _console_shell}/__init__.pyi +0 -0
- {console_shell → _console_shell}/py.typed +0 -0
- {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
- {graphviz_export → _graphviz_export}/py.typed +0 -0
- {keyingsets_utils → _keyingsets_utils}/__init__.pyi +0 -0
- {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
- {rna_info → _rna_info}/py.typed +0 -0
- {rna_xml → _rna_xml}/__init__.pyi +0 -0
- {rna_xml → _rna_xml}/py.typed +0 -0
- {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/WHEEL +0 -0
bpy/ops/view3d/__init__.pyi
CHANGED
|
@@ -16,16 +16,10 @@ def bone_select_menu(
|
|
|
16
16
|
) -> None:
|
|
17
17
|
"""Menu bone selection
|
|
18
18
|
|
|
19
|
-
:type execution_context: int | str | None
|
|
20
|
-
:type undo: bool | None
|
|
21
19
|
:param name: Bone Name
|
|
22
|
-
:type name: str | None
|
|
23
20
|
:param extend: Extend
|
|
24
|
-
:type extend: bool | None
|
|
25
21
|
:param deselect: Deselect
|
|
26
|
-
:type deselect: bool | None
|
|
27
22
|
:param toggle: Toggle
|
|
28
|
-
:type toggle: bool | None
|
|
29
23
|
"""
|
|
30
24
|
|
|
31
25
|
def camera_background_image_add(
|
|
@@ -40,16 +34,10 @@ def camera_background_image_add(
|
|
|
40
34
|
) -> None:
|
|
41
35
|
"""Add a new background image to the active camera
|
|
42
36
|
|
|
43
|
-
:type execution_context: int | str | None
|
|
44
|
-
:type undo: bool | None
|
|
45
37
|
:param filepath: Filepath, Path to image file
|
|
46
|
-
:type filepath: str | None
|
|
47
38
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
48
|
-
:type relative_path: bool | None
|
|
49
39
|
:param name: Name, Name of the data-block to use by the operator
|
|
50
|
-
:type name: str
|
|
51
40
|
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
52
|
-
:type session_uid: int | None
|
|
53
41
|
"""
|
|
54
42
|
|
|
55
43
|
def camera_background_image_remove(
|
|
@@ -61,10 +49,7 @@ def camera_background_image_remove(
|
|
|
61
49
|
) -> None:
|
|
62
50
|
"""Remove a background image from the camera
|
|
63
51
|
|
|
64
|
-
:type execution_context: int | str | None
|
|
65
|
-
:type undo: bool | None
|
|
66
52
|
:param index: Index, Background image index to remove
|
|
67
|
-
:type index: int | None
|
|
68
53
|
"""
|
|
69
54
|
|
|
70
55
|
def camera_to_view(
|
|
@@ -72,33 +57,21 @@ def camera_to_view(
|
|
|
72
57
|
undo: bool | None = None,
|
|
73
58
|
/,
|
|
74
59
|
) -> None:
|
|
75
|
-
"""Set camera view to active view
|
|
76
|
-
|
|
77
|
-
:type execution_context: int | str | None
|
|
78
|
-
:type undo: bool | None
|
|
79
|
-
"""
|
|
60
|
+
"""Set camera view to active view"""
|
|
80
61
|
|
|
81
62
|
def camera_to_view_selected(
|
|
82
63
|
execution_context: int | str | None = None,
|
|
83
64
|
undo: bool | None = None,
|
|
84
65
|
/,
|
|
85
66
|
) -> None:
|
|
86
|
-
"""Move the camera so selected objects are framed
|
|
87
|
-
|
|
88
|
-
:type execution_context: int | str | None
|
|
89
|
-
:type undo: bool | None
|
|
90
|
-
"""
|
|
67
|
+
"""Move the camera so selected objects are framed"""
|
|
91
68
|
|
|
92
69
|
def clear_render_border(
|
|
93
70
|
execution_context: int | str | None = None,
|
|
94
71
|
undo: bool | None = None,
|
|
95
72
|
/,
|
|
96
73
|
) -> None:
|
|
97
|
-
"""Clear the boundaries of the border render and disable border render
|
|
98
|
-
|
|
99
|
-
:type execution_context: int | str | None
|
|
100
|
-
:type undo: bool | None
|
|
101
|
-
"""
|
|
74
|
+
"""Clear the boundaries of the border render and disable border render"""
|
|
102
75
|
|
|
103
76
|
def clip_border(
|
|
104
77
|
execution_context: int | str | None = None,
|
|
@@ -113,18 +86,11 @@ def clip_border(
|
|
|
113
86
|
) -> None:
|
|
114
87
|
"""Set the view clipping region
|
|
115
88
|
|
|
116
|
-
:type execution_context: int | str | None
|
|
117
|
-
:type undo: bool | None
|
|
118
89
|
:param xmin: X Min
|
|
119
|
-
:type xmin: int | None
|
|
120
90
|
:param xmax: X Max
|
|
121
|
-
:type xmax: int | None
|
|
122
91
|
:param ymin: Y Min
|
|
123
|
-
:type ymin: int | None
|
|
124
92
|
:param ymax: Y Max
|
|
125
|
-
:type ymax: int | None
|
|
126
93
|
:param wait_for_input: Wait for Input
|
|
127
|
-
:type wait_for_input: bool | None
|
|
128
94
|
"""
|
|
129
95
|
|
|
130
96
|
def copybuffer(
|
|
@@ -132,11 +98,7 @@ def copybuffer(
|
|
|
132
98
|
undo: bool | None = None,
|
|
133
99
|
/,
|
|
134
100
|
) -> None:
|
|
135
|
-
"""Copy the selected objects to the internal clipboard
|
|
136
|
-
|
|
137
|
-
:type execution_context: int | str | None
|
|
138
|
-
:type undo: bool | None
|
|
139
|
-
"""
|
|
101
|
+
"""Copy the selected objects to the internal clipboard"""
|
|
140
102
|
|
|
141
103
|
def cursor3d(
|
|
142
104
|
execution_context: int | str | None = None,
|
|
@@ -148,10 +110,7 @@ def cursor3d(
|
|
|
148
110
|
) -> None:
|
|
149
111
|
"""Set the location of the 3D cursor
|
|
150
112
|
|
|
151
|
-
:type execution_context: int | str | None
|
|
152
|
-
:type undo: bool | None
|
|
153
113
|
:param use_depth: Surface Project, Project onto the surface
|
|
154
|
-
:type use_depth: bool | None
|
|
155
114
|
:param orientation: Orientation, Preset viewpoint to use
|
|
156
115
|
|
|
157
116
|
NONE
|
|
@@ -165,7 +124,6 @@ def cursor3d(
|
|
|
165
124
|
|
|
166
125
|
GEOM
|
|
167
126
|
Geometry -- Match the surface normal.
|
|
168
|
-
:type orientation: typing.Literal['NONE','VIEW','XFORM','GEOM'] | None
|
|
169
127
|
"""
|
|
170
128
|
|
|
171
129
|
def dolly(
|
|
@@ -180,16 +138,10 @@ def dolly(
|
|
|
180
138
|
) -> None:
|
|
181
139
|
"""Dolly in/out in the view
|
|
182
140
|
|
|
183
|
-
:type execution_context: int | str | None
|
|
184
|
-
:type undo: bool | None
|
|
185
141
|
:param mx: Region Position X
|
|
186
|
-
:type mx: int | None
|
|
187
142
|
:param my: Region Position Y
|
|
188
|
-
:type my: int | None
|
|
189
143
|
:param delta: Delta
|
|
190
|
-
:type delta: int | None
|
|
191
144
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
192
|
-
:type use_cursor_init: bool | None
|
|
193
145
|
"""
|
|
194
146
|
|
|
195
147
|
def drop_world(
|
|
@@ -202,12 +154,8 @@ def drop_world(
|
|
|
202
154
|
) -> None:
|
|
203
155
|
"""Drop a world into the scene
|
|
204
156
|
|
|
205
|
-
:type execution_context: int | str | None
|
|
206
|
-
:type undo: bool | None
|
|
207
157
|
:param name: Name, Name of the data-block to use by the operator
|
|
208
|
-
:type name: str
|
|
209
158
|
:param session_uid: Session UID, Session UID of the data-block to use by the operator
|
|
210
|
-
:type session_uid: int | None
|
|
211
159
|
"""
|
|
212
160
|
|
|
213
161
|
def edit_mesh_extrude_individual_move(
|
|
@@ -215,22 +163,14 @@ def edit_mesh_extrude_individual_move(
|
|
|
215
163
|
undo: bool | None = None,
|
|
216
164
|
/,
|
|
217
165
|
) -> None:
|
|
218
|
-
"""Extrude each individual face separately along local normals
|
|
219
|
-
|
|
220
|
-
:type execution_context: int | str | None
|
|
221
|
-
:type undo: bool | None
|
|
222
|
-
"""
|
|
166
|
+
"""Extrude each individual face separately along local normals"""
|
|
223
167
|
|
|
224
168
|
def edit_mesh_extrude_manifold_normal(
|
|
225
169
|
execution_context: int | str | None = None,
|
|
226
170
|
undo: bool | None = None,
|
|
227
171
|
/,
|
|
228
172
|
) -> None:
|
|
229
|
-
"""Extrude manifold region along normals
|
|
230
|
-
|
|
231
|
-
:type execution_context: int | str | None
|
|
232
|
-
:type undo: bool | None
|
|
233
|
-
"""
|
|
173
|
+
"""Extrude manifold region along normals"""
|
|
234
174
|
|
|
235
175
|
def edit_mesh_extrude_move_normal(
|
|
236
176
|
execution_context: int | str | None = None,
|
|
@@ -241,10 +181,7 @@ def edit_mesh_extrude_move_normal(
|
|
|
241
181
|
) -> None:
|
|
242
182
|
"""Extrude region together along the average normal
|
|
243
183
|
|
|
244
|
-
:type execution_context: int | str | None
|
|
245
|
-
:type undo: bool | None
|
|
246
184
|
:param dissolve_and_intersect: dissolve_and_intersect, Dissolves adjacent faces and intersects new geometry
|
|
247
|
-
:type dissolve_and_intersect: bool | None
|
|
248
185
|
"""
|
|
249
186
|
|
|
250
187
|
def edit_mesh_extrude_move_shrink_fatten(
|
|
@@ -252,22 +189,14 @@ def edit_mesh_extrude_move_shrink_fatten(
|
|
|
252
189
|
undo: bool | None = None,
|
|
253
190
|
/,
|
|
254
191
|
) -> None:
|
|
255
|
-
"""Extrude region together along local normals
|
|
256
|
-
|
|
257
|
-
:type execution_context: int | str | None
|
|
258
|
-
:type undo: bool | None
|
|
259
|
-
"""
|
|
192
|
+
"""Extrude region together along local normals"""
|
|
260
193
|
|
|
261
194
|
def fly(
|
|
262
195
|
execution_context: int | str | None = None,
|
|
263
196
|
undo: bool | None = None,
|
|
264
197
|
/,
|
|
265
198
|
) -> None:
|
|
266
|
-
"""Interactively fly around the scene
|
|
267
|
-
|
|
268
|
-
:type execution_context: int | str | None
|
|
269
|
-
:type undo: bool | None
|
|
270
|
-
"""
|
|
199
|
+
"""Interactively fly around the scene"""
|
|
271
200
|
|
|
272
201
|
def interactive_add(
|
|
273
202
|
execution_context: int | str | None = None,
|
|
@@ -286,10 +215,7 @@ def interactive_add(
|
|
|
286
215
|
) -> None:
|
|
287
216
|
"""Interactively add an object
|
|
288
217
|
|
|
289
|
-
:type execution_context: int | str | None
|
|
290
|
-
:type undo: bool | None
|
|
291
218
|
:param primitive_type: Primitive
|
|
292
|
-
:type primitive_type: typing.Literal['CUBE','CYLINDER','CONE','SPHERE_UV','SPHERE_ICO'] | None
|
|
293
219
|
:param plane_origin_base: Origin, The initial position for placement
|
|
294
220
|
|
|
295
221
|
EDGE
|
|
@@ -297,7 +223,6 @@ def interactive_add(
|
|
|
297
223
|
|
|
298
224
|
CENTER
|
|
299
225
|
Center -- Start placing the center position.
|
|
300
|
-
:type plane_origin_base: typing.Literal['EDGE','CENTER'] | None
|
|
301
226
|
:param plane_origin_depth: Origin, The initial position for placement
|
|
302
227
|
|
|
303
228
|
EDGE
|
|
@@ -305,7 +230,6 @@ def interactive_add(
|
|
|
305
230
|
|
|
306
231
|
CENTER
|
|
307
232
|
Center -- Start placing the center position.
|
|
308
|
-
:type plane_origin_depth: typing.Literal['EDGE','CENTER'] | None
|
|
309
233
|
:param plane_aspect_base: Aspect, The initial aspect setting
|
|
310
234
|
|
|
311
235
|
FREE
|
|
@@ -313,7 +237,6 @@ def interactive_add(
|
|
|
313
237
|
|
|
314
238
|
FIXED
|
|
315
239
|
Fixed -- Use a fixed 1:1 aspect.
|
|
316
|
-
:type plane_aspect_base: typing.Literal['FREE','FIXED'] | None
|
|
317
240
|
:param plane_aspect_depth: Aspect, The initial aspect setting
|
|
318
241
|
|
|
319
242
|
FREE
|
|
@@ -321,9 +244,7 @@ def interactive_add(
|
|
|
321
244
|
|
|
322
245
|
FIXED
|
|
323
246
|
Fixed -- Use a fixed 1:1 aspect.
|
|
324
|
-
:type plane_aspect_depth: typing.Literal['FREE','FIXED'] | None
|
|
325
247
|
:param wait_for_input: Wait for Input
|
|
326
|
-
:type wait_for_input: bool | None
|
|
327
248
|
"""
|
|
328
249
|
|
|
329
250
|
def localview(
|
|
@@ -335,10 +256,7 @@ def localview(
|
|
|
335
256
|
) -> None:
|
|
336
257
|
"""Toggle display of selected object(s) separately and centered in view
|
|
337
258
|
|
|
338
|
-
:type execution_context: int | str | None
|
|
339
|
-
:type undo: bool | None
|
|
340
259
|
:param frame_selected: Frame Selected, Move the view to frame the selected objects
|
|
341
|
-
:type frame_selected: bool | None
|
|
342
260
|
"""
|
|
343
261
|
|
|
344
262
|
def localview_remove_from(
|
|
@@ -346,11 +264,7 @@ def localview_remove_from(
|
|
|
346
264
|
undo: bool | None = None,
|
|
347
265
|
/,
|
|
348
266
|
) -> None:
|
|
349
|
-
"""Move selected objects out of local view
|
|
350
|
-
|
|
351
|
-
:type execution_context: int | str | None
|
|
352
|
-
:type undo: bool | None
|
|
353
|
-
"""
|
|
267
|
+
"""Move selected objects out of local view"""
|
|
354
268
|
|
|
355
269
|
def move(
|
|
356
270
|
execution_context: int | str | None = None,
|
|
@@ -361,10 +275,7 @@ def move(
|
|
|
361
275
|
) -> None:
|
|
362
276
|
"""Move the view
|
|
363
277
|
|
|
364
|
-
:type execution_context: int | str | None
|
|
365
|
-
:type undo: bool | None
|
|
366
278
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
367
|
-
:type use_cursor_init: bool | None
|
|
368
279
|
"""
|
|
369
280
|
|
|
370
281
|
def navigate(
|
|
@@ -372,77 +283,49 @@ def navigate(
|
|
|
372
283
|
undo: bool | None = None,
|
|
373
284
|
/,
|
|
374
285
|
) -> None:
|
|
375
|
-
"""Interactively navigate around the scene (uses the mode (walk/fly) preference)
|
|
376
|
-
|
|
377
|
-
:type execution_context: int | str | None
|
|
378
|
-
:type undo: bool | None
|
|
379
|
-
"""
|
|
286
|
+
"""Interactively navigate around the scene (uses the mode (walk/fly) preference)"""
|
|
380
287
|
|
|
381
288
|
def ndof_all(
|
|
382
289
|
execution_context: int | str | None = None,
|
|
383
290
|
undo: bool | None = None,
|
|
384
291
|
/,
|
|
385
292
|
) -> None:
|
|
386
|
-
"""Pan and rotate the view with the 3D mouse
|
|
387
|
-
|
|
388
|
-
:type execution_context: int | str | None
|
|
389
|
-
:type undo: bool | None
|
|
390
|
-
"""
|
|
293
|
+
"""Pan and rotate the view with the 3D mouse"""
|
|
391
294
|
|
|
392
295
|
def ndof_orbit(
|
|
393
296
|
execution_context: int | str | None = None,
|
|
394
297
|
undo: bool | None = None,
|
|
395
298
|
/,
|
|
396
299
|
) -> None:
|
|
397
|
-
"""Orbit the view using the 3D mouse
|
|
398
|
-
|
|
399
|
-
:type execution_context: int | str | None
|
|
400
|
-
:type undo: bool | None
|
|
401
|
-
"""
|
|
300
|
+
"""Orbit the view using the 3D mouse"""
|
|
402
301
|
|
|
403
302
|
def ndof_orbit_zoom(
|
|
404
303
|
execution_context: int | str | None = None,
|
|
405
304
|
undo: bool | None = None,
|
|
406
305
|
/,
|
|
407
306
|
) -> None:
|
|
408
|
-
"""Orbit and zoom the view using the 3D mouse
|
|
409
|
-
|
|
410
|
-
:type execution_context: int | str | None
|
|
411
|
-
:type undo: bool | None
|
|
412
|
-
"""
|
|
307
|
+
"""Orbit and zoom the view using the 3D mouse"""
|
|
413
308
|
|
|
414
309
|
def ndof_pan(
|
|
415
310
|
execution_context: int | str | None = None,
|
|
416
311
|
undo: bool | None = None,
|
|
417
312
|
/,
|
|
418
313
|
) -> None:
|
|
419
|
-
"""Pan the view with the 3D mouse
|
|
420
|
-
|
|
421
|
-
:type execution_context: int | str | None
|
|
422
|
-
:type undo: bool | None
|
|
423
|
-
"""
|
|
314
|
+
"""Pan the view with the 3D mouse"""
|
|
424
315
|
|
|
425
316
|
def object_as_camera(
|
|
426
317
|
execution_context: int | str | None = None,
|
|
427
318
|
undo: bool | None = None,
|
|
428
319
|
/,
|
|
429
320
|
) -> None:
|
|
430
|
-
"""Set the active object as the active camera for this view or scene
|
|
431
|
-
|
|
432
|
-
:type execution_context: int | str | None
|
|
433
|
-
:type undo: bool | None
|
|
434
|
-
"""
|
|
321
|
+
"""Set the active object as the active camera for this view or scene"""
|
|
435
322
|
|
|
436
323
|
def object_mode_pie_or_toggle(
|
|
437
324
|
execution_context: int | str | None = None,
|
|
438
325
|
undo: bool | None = None,
|
|
439
326
|
/,
|
|
440
327
|
) -> None:
|
|
441
|
-
"""Undocumented, consider contributing.
|
|
442
|
-
|
|
443
|
-
:type execution_context: int | str | None
|
|
444
|
-
:type undo: bool | None
|
|
445
|
-
"""
|
|
328
|
+
"""Undocumented, consider contributing."""
|
|
446
329
|
|
|
447
330
|
def pastebuffer(
|
|
448
331
|
execution_context: int | str | None = None,
|
|
@@ -454,12 +337,8 @@ def pastebuffer(
|
|
|
454
337
|
) -> None:
|
|
455
338
|
"""Paste objects from the internal clipboard
|
|
456
339
|
|
|
457
|
-
:type execution_context: int | str | None
|
|
458
|
-
:type undo: bool | None
|
|
459
340
|
:param autoselect: Select, Select pasted objects
|
|
460
|
-
:type autoselect: bool | None
|
|
461
341
|
:param active_collection: Active Collection, Put pasted objects in the active collection
|
|
462
|
-
:type active_collection: bool | None
|
|
463
342
|
"""
|
|
464
343
|
|
|
465
344
|
def render_border(
|
|
@@ -475,18 +354,11 @@ def render_border(
|
|
|
475
354
|
) -> None:
|
|
476
355
|
"""Set the boundaries of the border render and enable border render
|
|
477
356
|
|
|
478
|
-
:type execution_context: int | str | None
|
|
479
|
-
:type undo: bool | None
|
|
480
357
|
:param xmin: X Min
|
|
481
|
-
:type xmin: int | None
|
|
482
358
|
:param xmax: X Max
|
|
483
|
-
:type xmax: int | None
|
|
484
359
|
:param ymin: Y Min
|
|
485
|
-
:type ymin: int | None
|
|
486
360
|
:param ymax: Y Max
|
|
487
|
-
:type ymax: int | None
|
|
488
361
|
:param wait_for_input: Wait for Input
|
|
489
|
-
:type wait_for_input: bool | None
|
|
490
362
|
"""
|
|
491
363
|
|
|
492
364
|
def rotate(
|
|
@@ -498,10 +370,7 @@ def rotate(
|
|
|
498
370
|
) -> None:
|
|
499
371
|
"""Rotate the view
|
|
500
372
|
|
|
501
|
-
:type execution_context: int | str | None
|
|
502
|
-
:type undo: bool | None
|
|
503
373
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
504
|
-
:type use_cursor_init: bool | None
|
|
505
374
|
"""
|
|
506
375
|
|
|
507
376
|
def ruler_add(
|
|
@@ -509,22 +378,14 @@ def ruler_add(
|
|
|
509
378
|
undo: bool | None = None,
|
|
510
379
|
/,
|
|
511
380
|
) -> None:
|
|
512
|
-
"""Add ruler
|
|
513
|
-
|
|
514
|
-
:type execution_context: int | str | None
|
|
515
|
-
:type undo: bool | None
|
|
516
|
-
"""
|
|
381
|
+
"""Add ruler"""
|
|
517
382
|
|
|
518
383
|
def ruler_remove(
|
|
519
384
|
execution_context: int | str | None = None,
|
|
520
385
|
undo: bool | None = None,
|
|
521
386
|
/,
|
|
522
387
|
) -> None:
|
|
523
|
-
"""Undocumented, consider contributing.
|
|
524
|
-
|
|
525
|
-
:type execution_context: int | str | None
|
|
526
|
-
:type undo: bool | None
|
|
527
|
-
"""
|
|
388
|
+
"""Undocumented, consider contributing."""
|
|
528
389
|
|
|
529
390
|
def select(
|
|
530
391
|
execution_context: int | str | None = None,
|
|
@@ -543,26 +404,15 @@ def select(
|
|
|
543
404
|
) -> None:
|
|
544
405
|
"""Select and activate item(s)
|
|
545
406
|
|
|
546
|
-
:type execution_context: int | str | None
|
|
547
|
-
:type undo: bool | None
|
|
548
407
|
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
549
|
-
:type extend: bool | None
|
|
550
408
|
:param deselect: Deselect, Remove from selection
|
|
551
|
-
:type deselect: bool | None
|
|
552
409
|
:param toggle: Toggle Selection, Toggle the selection
|
|
553
|
-
:type toggle: bool | None
|
|
554
410
|
:param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
|
|
555
|
-
:type deselect_all: bool | None
|
|
556
411
|
:param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
|
|
557
|
-
:type select_passthrough: bool | None
|
|
558
412
|
:param center: Center, Use the object center when selecting, in edit mode used to extend object selection
|
|
559
|
-
:type center: bool | None
|
|
560
413
|
:param enumerate: Enumerate, List objects under the mouse (object mode only)
|
|
561
|
-
:type enumerate: bool | None
|
|
562
414
|
:param object: Object, Use object selection (edit mode only)
|
|
563
|
-
:type object: bool | None
|
|
564
415
|
:param location: Location, Mouse location
|
|
565
|
-
:type location: collections.abc.Iterable[int] | None
|
|
566
416
|
"""
|
|
567
417
|
|
|
568
418
|
def select_box(
|
|
@@ -579,18 +429,11 @@ def select_box(
|
|
|
579
429
|
) -> None:
|
|
580
430
|
"""Select items using box selection
|
|
581
431
|
|
|
582
|
-
:type execution_context: int | str | None
|
|
583
|
-
:type undo: bool | None
|
|
584
432
|
:param xmin: X Min
|
|
585
|
-
:type xmin: int | None
|
|
586
433
|
:param xmax: X Max
|
|
587
|
-
:type xmax: int | None
|
|
588
434
|
:param ymin: Y Min
|
|
589
|
-
:type ymin: int | None
|
|
590
435
|
:param ymax: Y Max
|
|
591
|
-
:type ymax: int | None
|
|
592
436
|
:param wait_for_input: Wait for Input
|
|
593
|
-
:type wait_for_input: bool | None
|
|
594
437
|
:param mode: Mode
|
|
595
438
|
|
|
596
439
|
SET
|
|
@@ -607,7 +450,6 @@ def select_box(
|
|
|
607
450
|
|
|
608
451
|
AND
|
|
609
452
|
Intersect -- Intersect existing selection.
|
|
610
|
-
:type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
|
|
611
453
|
"""
|
|
612
454
|
|
|
613
455
|
def select_circle(
|
|
@@ -623,16 +465,10 @@ def select_circle(
|
|
|
623
465
|
) -> None:
|
|
624
466
|
"""Select items using circle selection
|
|
625
467
|
|
|
626
|
-
:type execution_context: int | str | None
|
|
627
|
-
:type undo: bool | None
|
|
628
468
|
:param x: X
|
|
629
|
-
:type x: int | None
|
|
630
469
|
:param y: Y
|
|
631
|
-
:type y: int | None
|
|
632
470
|
:param radius: Radius
|
|
633
|
-
:type radius: int | None
|
|
634
471
|
:param wait_for_input: Wait for Input
|
|
635
|
-
:type wait_for_input: bool | None
|
|
636
472
|
:param mode: Mode
|
|
637
473
|
|
|
638
474
|
SET
|
|
@@ -643,7 +479,6 @@ def select_circle(
|
|
|
643
479
|
|
|
644
480
|
SUB
|
|
645
481
|
Subtract -- Subtract existing selection.
|
|
646
|
-
:type mode: typing.Literal['SET','ADD','SUB'] | None
|
|
647
482
|
"""
|
|
648
483
|
|
|
649
484
|
def select_lasso(
|
|
@@ -659,16 +494,10 @@ def select_lasso(
|
|
|
659
494
|
) -> None:
|
|
660
495
|
"""Select items using lasso selection
|
|
661
496
|
|
|
662
|
-
:type execution_context: int | str | None
|
|
663
|
-
:type undo: bool | None
|
|
664
497
|
:param path: Path
|
|
665
|
-
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
666
498
|
:param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
|
|
667
|
-
:type use_smooth_stroke: bool | None
|
|
668
499
|
:param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
|
|
669
|
-
:type smooth_stroke_factor: float | None
|
|
670
500
|
:param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
|
|
671
|
-
:type smooth_stroke_radius: int | None
|
|
672
501
|
:param mode: Mode
|
|
673
502
|
|
|
674
503
|
SET
|
|
@@ -685,7 +514,6 @@ def select_lasso(
|
|
|
685
514
|
|
|
686
515
|
AND
|
|
687
516
|
Intersect -- Intersect existing selection.
|
|
688
|
-
:type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
|
|
689
517
|
"""
|
|
690
518
|
|
|
691
519
|
def select_menu(
|
|
@@ -700,16 +528,10 @@ def select_menu(
|
|
|
700
528
|
) -> None:
|
|
701
529
|
"""Menu object selection
|
|
702
530
|
|
|
703
|
-
:type execution_context: int | str | None
|
|
704
|
-
:type undo: bool | None
|
|
705
531
|
:param name: Object Name
|
|
706
|
-
:type name: str | None
|
|
707
532
|
:param extend: Extend
|
|
708
|
-
:type extend: bool | None
|
|
709
533
|
:param deselect: Deselect
|
|
710
|
-
:type deselect: bool | None
|
|
711
534
|
:param toggle: Toggle
|
|
712
|
-
:type toggle: bool | None
|
|
713
535
|
"""
|
|
714
536
|
|
|
715
537
|
def smoothview(
|
|
@@ -717,66 +539,42 @@ def smoothview(
|
|
|
717
539
|
undo: bool | None = None,
|
|
718
540
|
/,
|
|
719
541
|
) -> None:
|
|
720
|
-
"""Undocumented, consider contributing.
|
|
721
|
-
|
|
722
|
-
:type execution_context: int | str | None
|
|
723
|
-
:type undo: bool | None
|
|
724
|
-
"""
|
|
542
|
+
"""Undocumented, consider contributing."""
|
|
725
543
|
|
|
726
544
|
def snap_cursor_to_active(
|
|
727
545
|
execution_context: int | str | None = None,
|
|
728
546
|
undo: bool | None = None,
|
|
729
547
|
/,
|
|
730
548
|
) -> None:
|
|
731
|
-
"""Snap 3D cursor to the active item
|
|
732
|
-
|
|
733
|
-
:type execution_context: int | str | None
|
|
734
|
-
:type undo: bool | None
|
|
735
|
-
"""
|
|
549
|
+
"""Snap 3D cursor to the active item"""
|
|
736
550
|
|
|
737
551
|
def snap_cursor_to_center(
|
|
738
552
|
execution_context: int | str | None = None,
|
|
739
553
|
undo: bool | None = None,
|
|
740
554
|
/,
|
|
741
555
|
) -> None:
|
|
742
|
-
"""Snap 3D cursor to the world origin
|
|
743
|
-
|
|
744
|
-
:type execution_context: int | str | None
|
|
745
|
-
:type undo: bool | None
|
|
746
|
-
"""
|
|
556
|
+
"""Snap 3D cursor to the world origin"""
|
|
747
557
|
|
|
748
558
|
def snap_cursor_to_grid(
|
|
749
559
|
execution_context: int | str | None = None,
|
|
750
560
|
undo: bool | None = None,
|
|
751
561
|
/,
|
|
752
562
|
) -> None:
|
|
753
|
-
"""Snap 3D cursor to the nearest grid division
|
|
754
|
-
|
|
755
|
-
:type execution_context: int | str | None
|
|
756
|
-
:type undo: bool | None
|
|
757
|
-
"""
|
|
563
|
+
"""Snap 3D cursor to the nearest grid division"""
|
|
758
564
|
|
|
759
565
|
def snap_cursor_to_selected(
|
|
760
566
|
execution_context: int | str | None = None,
|
|
761
567
|
undo: bool | None = None,
|
|
762
568
|
/,
|
|
763
569
|
) -> None:
|
|
764
|
-
"""Snap 3D cursor to the middle of the selected item(s)
|
|
765
|
-
|
|
766
|
-
:type execution_context: int | str | None
|
|
767
|
-
:type undo: bool | None
|
|
768
|
-
"""
|
|
570
|
+
"""Snap 3D cursor to the middle of the selected item(s)"""
|
|
769
571
|
|
|
770
572
|
def snap_selected_to_active(
|
|
771
573
|
execution_context: int | str | None = None,
|
|
772
574
|
undo: bool | None = None,
|
|
773
575
|
/,
|
|
774
576
|
) -> None:
|
|
775
|
-
"""Snap selected item(s) to the active item
|
|
776
|
-
|
|
777
|
-
:type execution_context: int | str | None
|
|
778
|
-
:type undo: bool | None
|
|
779
|
-
"""
|
|
577
|
+
"""Snap selected item(s) to the active item"""
|
|
780
578
|
|
|
781
579
|
def snap_selected_to_cursor(
|
|
782
580
|
execution_context: int | str | None = None,
|
|
@@ -788,12 +586,8 @@ def snap_selected_to_cursor(
|
|
|
788
586
|
) -> None:
|
|
789
587
|
"""Snap selected item(s) to the 3D cursor
|
|
790
588
|
|
|
791
|
-
:type execution_context: int | str | None
|
|
792
|
-
:type undo: bool | None
|
|
793
589
|
:param use_offset: Offset, If the selection should be snapped as a whole or by each object center
|
|
794
|
-
:type use_offset: bool | None
|
|
795
590
|
:param use_rotation: Rotation, If the selection should be rotated to match the cursor
|
|
796
|
-
:type use_rotation: bool | None
|
|
797
591
|
"""
|
|
798
592
|
|
|
799
593
|
def snap_selected_to_grid(
|
|
@@ -801,22 +595,14 @@ def snap_selected_to_grid(
|
|
|
801
595
|
undo: bool | None = None,
|
|
802
596
|
/,
|
|
803
597
|
) -> None:
|
|
804
|
-
"""Snap selected item(s) to their nearest grid division
|
|
805
|
-
|
|
806
|
-
:type execution_context: int | str | None
|
|
807
|
-
:type undo: bool | None
|
|
808
|
-
"""
|
|
598
|
+
"""Snap selected item(s) to their nearest grid division"""
|
|
809
599
|
|
|
810
600
|
def toggle_matcap_flip(
|
|
811
601
|
execution_context: int | str | None = None,
|
|
812
602
|
undo: bool | None = None,
|
|
813
603
|
/,
|
|
814
604
|
) -> None:
|
|
815
|
-
"""Flip MatCap
|
|
816
|
-
|
|
817
|
-
:type execution_context: int | str | None
|
|
818
|
-
:type undo: bool | None
|
|
819
|
-
"""
|
|
605
|
+
"""Flip MatCap"""
|
|
820
606
|
|
|
821
607
|
def toggle_shading(
|
|
822
608
|
execution_context: int | str | None = None,
|
|
@@ -828,8 +614,6 @@ def toggle_shading(
|
|
|
828
614
|
) -> None:
|
|
829
615
|
"""Toggle shading type in 3D viewport
|
|
830
616
|
|
|
831
|
-
:type execution_context: int | str | None
|
|
832
|
-
:type undo: bool | None
|
|
833
617
|
:param type: Type, Shading type to toggle
|
|
834
618
|
|
|
835
619
|
WIREFRAME
|
|
@@ -843,7 +627,6 @@ def toggle_shading(
|
|
|
843
627
|
|
|
844
628
|
RENDERED
|
|
845
629
|
Rendered -- Toggle rendered shading.
|
|
846
|
-
:type type: typing.Literal['WIREFRAME','SOLID','MATERIAL','RENDERED'] | None
|
|
847
630
|
"""
|
|
848
631
|
|
|
849
632
|
def toggle_xray(
|
|
@@ -851,11 +634,7 @@ def toggle_xray(
|
|
|
851
634
|
undo: bool | None = None,
|
|
852
635
|
/,
|
|
853
636
|
) -> None:
|
|
854
|
-
"""Transparent scene display. Allow selecting through items
|
|
855
|
-
|
|
856
|
-
:type execution_context: int | str | None
|
|
857
|
-
:type undo: bool | None
|
|
858
|
-
"""
|
|
637
|
+
"""Transparent scene display. Allow selecting through items"""
|
|
859
638
|
|
|
860
639
|
def transform_gizmo_set(
|
|
861
640
|
execution_context: int | str | None = None,
|
|
@@ -867,12 +646,8 @@ def transform_gizmo_set(
|
|
|
867
646
|
) -> None:
|
|
868
647
|
"""Set the current transform gizmo
|
|
869
648
|
|
|
870
|
-
:type execution_context: int | str | None
|
|
871
|
-
:type undo: bool | None
|
|
872
649
|
:param extend: Extend
|
|
873
|
-
:type extend: bool | None
|
|
874
650
|
:param type: Type
|
|
875
|
-
:type type: set[typing.Literal['TRANSLATE','ROTATE','SCALE']] | None
|
|
876
651
|
"""
|
|
877
652
|
|
|
878
653
|
def view_all(
|
|
@@ -885,12 +660,8 @@ def view_all(
|
|
|
885
660
|
) -> None:
|
|
886
661
|
"""View all objects in scene
|
|
887
662
|
|
|
888
|
-
:type execution_context: int | str | None
|
|
889
|
-
:type undo: bool | None
|
|
890
663
|
:param use_all_regions: All Regions, View selected for all regions
|
|
891
|
-
:type use_all_regions: bool | None
|
|
892
664
|
:param center: Center
|
|
893
|
-
:type center: bool | None
|
|
894
665
|
"""
|
|
895
666
|
|
|
896
667
|
def view_axis(
|
|
@@ -905,8 +676,6 @@ def view_axis(
|
|
|
905
676
|
) -> None:
|
|
906
677
|
"""Use a preset viewpoint
|
|
907
678
|
|
|
908
|
-
:type execution_context: int | str | None
|
|
909
|
-
:type undo: bool | None
|
|
910
679
|
:param type: View, Preset viewpoint to use
|
|
911
680
|
|
|
912
681
|
LEFT
|
|
@@ -926,11 +695,8 @@ def view_axis(
|
|
|
926
695
|
|
|
927
696
|
BACK
|
|
928
697
|
Back -- View from the back.
|
|
929
|
-
:type type: typing.Literal['LEFT','RIGHT','BOTTOM','TOP','FRONT','BACK'] | None
|
|
930
698
|
:param align_active: Align Active, Align to the active objects axis
|
|
931
|
-
:type align_active: bool | None
|
|
932
699
|
:param relative: Relative, Rotate relative to the current orientation
|
|
933
|
-
:type relative: bool | None
|
|
934
700
|
"""
|
|
935
701
|
|
|
936
702
|
def view_camera(
|
|
@@ -938,77 +704,49 @@ def view_camera(
|
|
|
938
704
|
undo: bool | None = None,
|
|
939
705
|
/,
|
|
940
706
|
) -> None:
|
|
941
|
-
"""Toggle the camera view
|
|
942
|
-
|
|
943
|
-
:type execution_context: int | str | None
|
|
944
|
-
:type undo: bool | None
|
|
945
|
-
"""
|
|
707
|
+
"""Toggle the camera view"""
|
|
946
708
|
|
|
947
709
|
def view_center_camera(
|
|
948
710
|
execution_context: int | str | None = None,
|
|
949
711
|
undo: bool | None = None,
|
|
950
712
|
/,
|
|
951
713
|
) -> None:
|
|
952
|
-
"""Center the camera view, resizing the view to fit its bounds
|
|
953
|
-
|
|
954
|
-
:type execution_context: int | str | None
|
|
955
|
-
:type undo: bool | None
|
|
956
|
-
"""
|
|
714
|
+
"""Center the camera view, resizing the view to fit its bounds"""
|
|
957
715
|
|
|
958
716
|
def view_center_cursor(
|
|
959
717
|
execution_context: int | str | None = None,
|
|
960
718
|
undo: bool | None = None,
|
|
961
719
|
/,
|
|
962
720
|
) -> None:
|
|
963
|
-
"""Center the view so that the cursor is in the middle of the view
|
|
964
|
-
|
|
965
|
-
:type execution_context: int | str | None
|
|
966
|
-
:type undo: bool | None
|
|
967
|
-
"""
|
|
721
|
+
"""Center the view so that the cursor is in the middle of the view"""
|
|
968
722
|
|
|
969
723
|
def view_center_lock(
|
|
970
724
|
execution_context: int | str | None = None,
|
|
971
725
|
undo: bool | None = None,
|
|
972
726
|
/,
|
|
973
727
|
) -> None:
|
|
974
|
-
"""Center the view lock offset
|
|
975
|
-
|
|
976
|
-
:type execution_context: int | str | None
|
|
977
|
-
:type undo: bool | None
|
|
978
|
-
"""
|
|
728
|
+
"""Center the view lock offset"""
|
|
979
729
|
|
|
980
730
|
def view_center_pick(
|
|
981
731
|
execution_context: int | str | None = None,
|
|
982
732
|
undo: bool | None = None,
|
|
983
733
|
/,
|
|
984
734
|
) -> None:
|
|
985
|
-
"""Center the view to the Z-depth position under the mouse cursor
|
|
986
|
-
|
|
987
|
-
:type execution_context: int | str | None
|
|
988
|
-
:type undo: bool | None
|
|
989
|
-
"""
|
|
735
|
+
"""Center the view to the Z-depth position under the mouse cursor"""
|
|
990
736
|
|
|
991
737
|
def view_lock_clear(
|
|
992
738
|
execution_context: int | str | None = None,
|
|
993
739
|
undo: bool | None = None,
|
|
994
740
|
/,
|
|
995
741
|
) -> None:
|
|
996
|
-
"""Clear all view locking
|
|
997
|
-
|
|
998
|
-
:type execution_context: int | str | None
|
|
999
|
-
:type undo: bool | None
|
|
1000
|
-
"""
|
|
742
|
+
"""Clear all view locking"""
|
|
1001
743
|
|
|
1002
744
|
def view_lock_to_active(
|
|
1003
745
|
execution_context: int | str | None = None,
|
|
1004
746
|
undo: bool | None = None,
|
|
1005
747
|
/,
|
|
1006
748
|
) -> None:
|
|
1007
|
-
"""Lock the view to the active object/bone
|
|
1008
|
-
|
|
1009
|
-
:type execution_context: int | str | None
|
|
1010
|
-
:type undo: bool | None
|
|
1011
|
-
"""
|
|
749
|
+
"""Lock the view to the active object/bone"""
|
|
1012
750
|
|
|
1013
751
|
def view_orbit(
|
|
1014
752
|
execution_context: int | str | None = None,
|
|
@@ -1021,10 +759,7 @@ def view_orbit(
|
|
|
1021
759
|
) -> None:
|
|
1022
760
|
"""Orbit the view
|
|
1023
761
|
|
|
1024
|
-
:type execution_context: int | str | None
|
|
1025
|
-
:type undo: bool | None
|
|
1026
762
|
:param angle: Roll
|
|
1027
|
-
:type angle: float | None
|
|
1028
763
|
:param type: Orbit, Direction of View Orbit
|
|
1029
764
|
|
|
1030
765
|
ORBITLEFT
|
|
@@ -1038,7 +773,6 @@ def view_orbit(
|
|
|
1038
773
|
|
|
1039
774
|
ORBITDOWN
|
|
1040
775
|
Orbit Down -- Orbit the view down.
|
|
1041
|
-
:type type: typing.Literal['ORBITLEFT','ORBITRIGHT','ORBITUP','ORBITDOWN'] | None
|
|
1042
776
|
"""
|
|
1043
777
|
|
|
1044
778
|
def view_pan(
|
|
@@ -1050,8 +784,6 @@ def view_pan(
|
|
|
1050
784
|
) -> None:
|
|
1051
785
|
"""Pan the view in a given direction
|
|
1052
786
|
|
|
1053
|
-
:type execution_context: int | str | None
|
|
1054
|
-
:type undo: bool | None
|
|
1055
787
|
:param type: Pan, Direction of View Pan
|
|
1056
788
|
|
|
1057
789
|
PANLEFT
|
|
@@ -1065,7 +797,6 @@ def view_pan(
|
|
|
1065
797
|
|
|
1066
798
|
PANDOWN
|
|
1067
799
|
Pan Down -- Pan the view down.
|
|
1068
|
-
:type type: typing.Literal['PANLEFT','PANRIGHT','PANUP','PANDOWN'] | None
|
|
1069
800
|
"""
|
|
1070
801
|
|
|
1071
802
|
def view_persportho(
|
|
@@ -1073,11 +804,7 @@ def view_persportho(
|
|
|
1073
804
|
undo: bool | None = None,
|
|
1074
805
|
/,
|
|
1075
806
|
) -> None:
|
|
1076
|
-
"""Switch the current view from perspective/orthographic projection
|
|
1077
|
-
|
|
1078
|
-
:type execution_context: int | str | None
|
|
1079
|
-
:type undo: bool | None
|
|
1080
|
-
"""
|
|
807
|
+
"""Switch the current view from perspective/orthographic projection"""
|
|
1081
808
|
|
|
1082
809
|
def view_roll(
|
|
1083
810
|
execution_context: int | str | None = None,
|
|
@@ -1089,10 +816,7 @@ def view_roll(
|
|
|
1089
816
|
) -> None:
|
|
1090
817
|
"""Roll the view
|
|
1091
818
|
|
|
1092
|
-
:type execution_context: int | str | None
|
|
1093
|
-
:type undo: bool | None
|
|
1094
819
|
:param angle: Roll
|
|
1095
|
-
:type angle: float | None
|
|
1096
820
|
:param type: Roll Angle Source, How roll angle is calculated
|
|
1097
821
|
|
|
1098
822
|
ANGLE
|
|
@@ -1103,7 +827,6 @@ def view_roll(
|
|
|
1103
827
|
|
|
1104
828
|
RIGHT
|
|
1105
829
|
Roll Right -- Roll the view around to the right.
|
|
1106
|
-
:type type: typing.Literal['ANGLE','LEFT','RIGHT'] | None
|
|
1107
830
|
"""
|
|
1108
831
|
|
|
1109
832
|
def view_selected(
|
|
@@ -1115,10 +838,7 @@ def view_selected(
|
|
|
1115
838
|
) -> None:
|
|
1116
839
|
"""Move the view to the selection center
|
|
1117
840
|
|
|
1118
|
-
:type execution_context: int | str | None
|
|
1119
|
-
:type undo: bool | None
|
|
1120
841
|
:param use_all_regions: All Regions, View selected for all regions
|
|
1121
|
-
:type use_all_regions: bool | None
|
|
1122
842
|
"""
|
|
1123
843
|
|
|
1124
844
|
def walk(
|
|
@@ -1126,11 +846,7 @@ def walk(
|
|
|
1126
846
|
undo: bool | None = None,
|
|
1127
847
|
/,
|
|
1128
848
|
) -> None:
|
|
1129
|
-
"""Interactively walk around the scene
|
|
1130
|
-
|
|
1131
|
-
:type execution_context: int | str | None
|
|
1132
|
-
:type undo: bool | None
|
|
1133
|
-
"""
|
|
849
|
+
"""Interactively walk around the scene"""
|
|
1134
850
|
|
|
1135
851
|
def zoom(
|
|
1136
852
|
execution_context: int | str | None = None,
|
|
@@ -1144,16 +860,10 @@ def zoom(
|
|
|
1144
860
|
) -> None:
|
|
1145
861
|
"""Zoom in/out in the view
|
|
1146
862
|
|
|
1147
|
-
:type execution_context: int | str | None
|
|
1148
|
-
:type undo: bool | None
|
|
1149
863
|
:param mx: Region Position X
|
|
1150
|
-
:type mx: int | None
|
|
1151
864
|
:param my: Region Position Y
|
|
1152
|
-
:type my: int | None
|
|
1153
865
|
:param delta: Delta
|
|
1154
|
-
:type delta: int | None
|
|
1155
866
|
:param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
|
|
1156
|
-
:type use_cursor_init: bool | None
|
|
1157
867
|
"""
|
|
1158
868
|
|
|
1159
869
|
def zoom_border(
|
|
@@ -1170,20 +880,12 @@ def zoom_border(
|
|
|
1170
880
|
) -> None:
|
|
1171
881
|
"""Zoom in the view to the nearest object contained in the border
|
|
1172
882
|
|
|
1173
|
-
:type execution_context: int | str | None
|
|
1174
|
-
:type undo: bool | None
|
|
1175
883
|
:param xmin: X Min
|
|
1176
|
-
:type xmin: int | None
|
|
1177
884
|
:param xmax: X Max
|
|
1178
|
-
:type xmax: int | None
|
|
1179
885
|
:param ymin: Y Min
|
|
1180
|
-
:type ymin: int | None
|
|
1181
886
|
:param ymax: Y Max
|
|
1182
|
-
:type ymax: int | None
|
|
1183
887
|
:param wait_for_input: Wait for Input
|
|
1184
|
-
:type wait_for_input: bool | None
|
|
1185
888
|
:param zoom_out: Zoom Out
|
|
1186
|
-
:type zoom_out: bool | None
|
|
1187
889
|
"""
|
|
1188
890
|
|
|
1189
891
|
def zoom_camera_1_to_1(
|
|
@@ -1191,8 +893,4 @@ def zoom_camera_1_to_1(
|
|
|
1191
893
|
undo: bool | None = None,
|
|
1192
894
|
/,
|
|
1193
895
|
) -> None:
|
|
1194
|
-
"""Match the camera to 1:1 to the render output
|
|
1195
|
-
|
|
1196
|
-
:type execution_context: int | str | None
|
|
1197
|
-
:type undo: bool | None
|
|
1198
|
-
"""
|
|
896
|
+
"""Match the camera to 1:1 to the render output"""
|