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/wm/__init__.pyi
CHANGED
|
@@ -44,7 +44,6 @@ def alembic_export(
|
|
|
44
44
|
sh_open: float | None = 0.0,
|
|
45
45
|
sh_close: float | None = 1.0,
|
|
46
46
|
selected: bool | None = False,
|
|
47
|
-
visible_objects_only: bool | None = False,
|
|
48
47
|
flatten: bool | None = False,
|
|
49
48
|
collection: str = "",
|
|
50
49
|
uvs: bool | None = True,
|
|
@@ -72,46 +71,25 @@ def alembic_export(
|
|
|
72
71
|
) -> None:
|
|
73
72
|
"""Export current scene in an Alembic archive
|
|
74
73
|
|
|
75
|
-
:type execution_context: int | str | None
|
|
76
|
-
:type undo: bool | None
|
|
77
74
|
:param filepath: File Path, Path to file
|
|
78
|
-
:type filepath: str
|
|
79
75
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
80
|
-
:type check_existing: bool | None
|
|
81
76
|
:param filter_blender: Filter .blend files
|
|
82
|
-
:type filter_blender: bool | None
|
|
83
77
|
:param filter_backup: Filter .blend files
|
|
84
|
-
:type filter_backup: bool | None
|
|
85
78
|
:param filter_image: Filter image files
|
|
86
|
-
:type filter_image: bool | None
|
|
87
79
|
:param filter_movie: Filter movie files
|
|
88
|
-
:type filter_movie: bool | None
|
|
89
80
|
:param filter_python: Filter Python files
|
|
90
|
-
:type filter_python: bool | None
|
|
91
81
|
:param filter_font: Filter font files
|
|
92
|
-
:type filter_font: bool | None
|
|
93
82
|
:param filter_sound: Filter sound files
|
|
94
|
-
:type filter_sound: bool | None
|
|
95
83
|
:param filter_text: Filter text files
|
|
96
|
-
:type filter_text: bool | None
|
|
97
84
|
:param filter_archive: Filter archive files
|
|
98
|
-
:type filter_archive: bool | None
|
|
99
85
|
:param filter_btx: Filter btx files
|
|
100
|
-
:type filter_btx: bool | None
|
|
101
86
|
:param filter_alembic: Filter Alembic files
|
|
102
|
-
:type filter_alembic: bool | None
|
|
103
87
|
:param filter_usd: Filter USD files
|
|
104
|
-
:type filter_usd: bool | None
|
|
105
88
|
:param filter_obj: Filter OBJ files
|
|
106
|
-
:type filter_obj: bool | None
|
|
107
89
|
:param filter_volume: Filter OpenVDB volume files
|
|
108
|
-
:type filter_volume: bool | None
|
|
109
90
|
:param filter_folder: Filter folders
|
|
110
|
-
:type filter_folder: bool | None
|
|
111
91
|
:param filter_blenlib: Filter Blender IDs
|
|
112
|
-
:type filter_blenlib: bool | None
|
|
113
92
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
114
|
-
:type filemode: int | None
|
|
115
93
|
:param display_type: Display Type
|
|
116
94
|
|
|
117
95
|
DEFAULT
|
|
@@ -125,66 +103,34 @@ def alembic_export(
|
|
|
125
103
|
|
|
126
104
|
THUMBNAIL
|
|
127
105
|
Thumbnails -- Display files as thumbnails.
|
|
128
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
129
106
|
:param sort_method: File sorting mode
|
|
130
|
-
:type sort_method: str | None
|
|
131
|
-
:type filter_glob: str
|
|
132
107
|
:param start: Start Frame, Start frame of the export, use the default value to take the start frame of the current scene
|
|
133
|
-
:type start: int | None
|
|
134
108
|
:param end: End Frame, End frame of the export, use the default value to take the end frame of the current scene
|
|
135
|
-
:type end: int | None
|
|
136
109
|
:param xsamples: Transform Samples, Number of times per frame transformations are sampled
|
|
137
|
-
:type xsamples: int | None
|
|
138
110
|
:param gsamples: Geometry Samples, Number of times per frame object data are sampled
|
|
139
|
-
:type gsamples: int | None
|
|
140
111
|
:param sh_open: Shutter Open, Time at which the shutter is open
|
|
141
|
-
:type sh_open: float | None
|
|
142
112
|
:param sh_close: Shutter Close, Time at which the shutter is closed
|
|
143
|
-
:type sh_close: float | None
|
|
144
113
|
:param selected: Selected Objects Only, Export only selected objects
|
|
145
|
-
:type selected: bool | None
|
|
146
|
-
:param visible_objects_only: Visible Objects Only, Export only objects that are visible
|
|
147
|
-
:type visible_objects_only: bool | None
|
|
148
114
|
:param flatten: Flatten Hierarchy, Do not preserve objects parent/children relationship
|
|
149
|
-
:type flatten: bool | None
|
|
150
115
|
:param collection: Collection
|
|
151
|
-
:type collection: str
|
|
152
116
|
:param uvs: UV Coordinates, Export UV coordinates
|
|
153
|
-
:type uvs: bool | None
|
|
154
117
|
:param packuv: Merge UVs
|
|
155
|
-
:type packuv: bool | None
|
|
156
118
|
:param normals: Normals, Export normals
|
|
157
|
-
:type normals: bool | None
|
|
158
119
|
:param vcolors: Color Attributes, Export color attributes
|
|
159
|
-
:type vcolors: bool | None
|
|
160
120
|
:param orcos: Generated Coordinates, Export undeformed mesh vertex coordinates
|
|
161
|
-
:type orcos: bool | None
|
|
162
121
|
:param face_sets: Face Sets, Export per face shading group assignments
|
|
163
|
-
:type face_sets: bool | None
|
|
164
122
|
:param subdiv_schema: Use Subdivision Schema, Export meshes using Alembics subdivision schema
|
|
165
|
-
:type subdiv_schema: bool | None
|
|
166
123
|
:param apply_subdiv: Apply Subdivision Surface, Export subdivision surfaces as meshes
|
|
167
|
-
:type apply_subdiv: bool | None
|
|
168
124
|
:param curves_as_mesh: Curves as Mesh, Export curves and NURBS surfaces as meshes
|
|
169
|
-
:type curves_as_mesh: bool | None
|
|
170
125
|
:param use_instancing: Use Instancing, Export data of duplicated objects as Alembic instances; speeds up the export and can be disabled for compatibility with other software
|
|
171
|
-
:type use_instancing: bool | None
|
|
172
126
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
173
|
-
:type global_scale: float | None
|
|
174
127
|
:param triangulate: Triangulate, Export polygons (quads and n-gons) as triangles
|
|
175
|
-
:type triangulate: bool | None
|
|
176
128
|
:param quad_method: Quad Method, Method for splitting the quads into triangles
|
|
177
|
-
:type quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems | None
|
|
178
129
|
:param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
|
|
179
|
-
:type ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems | None
|
|
180
130
|
:param export_hair: Export Hair, Exports hair particle systems as animated curves
|
|
181
|
-
:type export_hair: bool | None
|
|
182
131
|
:param export_particles: Export Particles, Exports non-hair particle systems
|
|
183
|
-
:type export_particles: bool | None
|
|
184
132
|
:param export_custom_properties: Export Custom Properties, Export custom properties to Alembic .userProperties
|
|
185
|
-
:type export_custom_properties: bool | None
|
|
186
133
|
:param as_background_job: Run as Background Job, Enable this to run the import in the background, disable to block Blender while importing. This option is deprecated; EXECUTE this operator to run in the foreground, and INVOKE it to run as a background job
|
|
187
|
-
:type as_background_job: bool | None
|
|
188
134
|
:param evaluation_mode: Settings, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering
|
|
189
135
|
|
|
190
136
|
RENDER
|
|
@@ -192,8 +138,6 @@ def alembic_export(
|
|
|
192
138
|
|
|
193
139
|
VIEWPORT
|
|
194
140
|
Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
|
|
195
|
-
:type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
|
|
196
|
-
:type init_scene_frame_range: bool | None
|
|
197
141
|
"""
|
|
198
142
|
|
|
199
143
|
def alembic_import(
|
|
@@ -239,52 +183,28 @@ def alembic_import(
|
|
|
239
183
|
) -> None:
|
|
240
184
|
"""Load an Alembic archive
|
|
241
185
|
|
|
242
|
-
:type execution_context: int | str | None
|
|
243
|
-
:type undo: bool | None
|
|
244
186
|
:param filepath: File Path, Path to file
|
|
245
|
-
:type filepath: str
|
|
246
187
|
:param directory: Directory, Directory of the file
|
|
247
|
-
:type directory: str
|
|
248
188
|
:param files: Files
|
|
249
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
250
189
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
251
|
-
:type check_existing: bool | None
|
|
252
190
|
:param filter_blender: Filter .blend files
|
|
253
|
-
:type filter_blender: bool | None
|
|
254
191
|
:param filter_backup: Filter .blend files
|
|
255
|
-
:type filter_backup: bool | None
|
|
256
192
|
:param filter_image: Filter image files
|
|
257
|
-
:type filter_image: bool | None
|
|
258
193
|
:param filter_movie: Filter movie files
|
|
259
|
-
:type filter_movie: bool | None
|
|
260
194
|
:param filter_python: Filter Python files
|
|
261
|
-
:type filter_python: bool | None
|
|
262
195
|
:param filter_font: Filter font files
|
|
263
|
-
:type filter_font: bool | None
|
|
264
196
|
:param filter_sound: Filter sound files
|
|
265
|
-
:type filter_sound: bool | None
|
|
266
197
|
:param filter_text: Filter text files
|
|
267
|
-
:type filter_text: bool | None
|
|
268
198
|
:param filter_archive: Filter archive files
|
|
269
|
-
:type filter_archive: bool | None
|
|
270
199
|
:param filter_btx: Filter btx files
|
|
271
|
-
:type filter_btx: bool | None
|
|
272
200
|
:param filter_alembic: Filter Alembic files
|
|
273
|
-
:type filter_alembic: bool | None
|
|
274
201
|
:param filter_usd: Filter USD files
|
|
275
|
-
:type filter_usd: bool | None
|
|
276
202
|
:param filter_obj: Filter OBJ files
|
|
277
|
-
:type filter_obj: bool | None
|
|
278
203
|
:param filter_volume: Filter OpenVDB volume files
|
|
279
|
-
:type filter_volume: bool | None
|
|
280
204
|
:param filter_folder: Filter folders
|
|
281
|
-
:type filter_folder: bool | None
|
|
282
205
|
:param filter_blenlib: Filter Blender IDs
|
|
283
|
-
:type filter_blenlib: bool | None
|
|
284
206
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
285
|
-
:type filemode: int | None
|
|
286
207
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
287
|
-
:type relative_path: bool | None
|
|
288
208
|
:param display_type: Display Type
|
|
289
209
|
|
|
290
210
|
DEFAULT
|
|
@@ -298,22 +218,13 @@ def alembic_import(
|
|
|
298
218
|
|
|
299
219
|
THUMBNAIL
|
|
300
220
|
Thumbnails -- Display files as thumbnails.
|
|
301
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
302
221
|
:param sort_method: File sorting mode
|
|
303
|
-
:type sort_method: str | None
|
|
304
|
-
:type filter_glob: str
|
|
305
222
|
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
306
|
-
:type scale: float | None
|
|
307
223
|
:param set_frame_range: Set Frame Range, If checked, update scenes start and end frame to match those of the Alembic archive
|
|
308
|
-
:type set_frame_range: bool | None
|
|
309
224
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
310
|
-
:type validate_meshes: bool | None
|
|
311
225
|
:param always_add_cache_reader: Always Add Cache Reader, Add cache modifiers and constraints to imported objects even if they are not animated so that they can be updated when reloading the Alembic archive
|
|
312
|
-
:type always_add_cache_reader: bool | None
|
|
313
226
|
:param is_sequence: Is Sequence, Set to true if the cache is split into separate files
|
|
314
|
-
:type is_sequence: bool | None
|
|
315
227
|
:param as_background_job: Run as Background Job, Enable this to run the export in the background, disable to block Blender while exporting. This option is deprecated; EXECUTE this operator to run in the foreground, and INVOKE it to run as a background job
|
|
316
|
-
:type as_background_job: bool | None
|
|
317
228
|
"""
|
|
318
229
|
|
|
319
230
|
def append(
|
|
@@ -361,52 +272,28 @@ def append(
|
|
|
361
272
|
) -> None:
|
|
362
273
|
"""Append from a Library .blend file
|
|
363
274
|
|
|
364
|
-
:type execution_context: int | str | None
|
|
365
|
-
:type undo: bool | None
|
|
366
275
|
:param filepath: File Path, Path to file
|
|
367
|
-
:type filepath: str
|
|
368
276
|
:param directory: Directory, Directory of the file
|
|
369
|
-
:type directory: str
|
|
370
277
|
:param filename: File Name, Name of the file
|
|
371
|
-
:type filename: str
|
|
372
278
|
:param files: Files
|
|
373
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
374
279
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
375
|
-
:type check_existing: bool | None
|
|
376
280
|
:param filter_blender: Filter .blend files
|
|
377
|
-
:type filter_blender: bool | None
|
|
378
281
|
:param filter_backup: Filter .blend files
|
|
379
|
-
:type filter_backup: bool | None
|
|
380
282
|
:param filter_image: Filter image files
|
|
381
|
-
:type filter_image: bool | None
|
|
382
283
|
:param filter_movie: Filter movie files
|
|
383
|
-
:type filter_movie: bool | None
|
|
384
284
|
:param filter_python: Filter Python files
|
|
385
|
-
:type filter_python: bool | None
|
|
386
285
|
:param filter_font: Filter font files
|
|
387
|
-
:type filter_font: bool | None
|
|
388
286
|
:param filter_sound: Filter sound files
|
|
389
|
-
:type filter_sound: bool | None
|
|
390
287
|
:param filter_text: Filter text files
|
|
391
|
-
:type filter_text: bool | None
|
|
392
288
|
:param filter_archive: Filter archive files
|
|
393
|
-
:type filter_archive: bool | None
|
|
394
289
|
:param filter_btx: Filter btx files
|
|
395
|
-
:type filter_btx: bool | None
|
|
396
290
|
:param filter_alembic: Filter Alembic files
|
|
397
|
-
:type filter_alembic: bool | None
|
|
398
291
|
:param filter_usd: Filter USD files
|
|
399
|
-
:type filter_usd: bool | None
|
|
400
292
|
:param filter_obj: Filter OBJ files
|
|
401
|
-
:type filter_obj: bool | None
|
|
402
293
|
:param filter_volume: Filter OpenVDB volume files
|
|
403
|
-
:type filter_volume: bool | None
|
|
404
294
|
:param filter_folder: Filter folders
|
|
405
|
-
:type filter_folder: bool | None
|
|
406
295
|
:param filter_blenlib: Filter Blender IDs
|
|
407
|
-
:type filter_blenlib: bool | None
|
|
408
296
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
409
|
-
:type filemode: int | None
|
|
410
297
|
:param display_type: Display Type
|
|
411
298
|
|
|
412
299
|
DEFAULT
|
|
@@ -420,27 +307,16 @@ def append(
|
|
|
420
307
|
|
|
421
308
|
THUMBNAIL
|
|
422
309
|
Thumbnails -- Display files as thumbnails.
|
|
423
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
424
310
|
:param sort_method: File sorting mode
|
|
425
|
-
:type sort_method: str | None
|
|
426
311
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
427
|
-
:type link: bool | None
|
|
428
312
|
:param do_reuse_local_id: Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy
|
|
429
|
-
:type do_reuse_local_id: bool | None
|
|
430
313
|
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
431
|
-
:type clear_asset_data: bool | None
|
|
432
314
|
:param autoselect: Select, Select new objects
|
|
433
|
-
:type autoselect: bool | None
|
|
434
315
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
435
|
-
:type active_collection: bool | None
|
|
436
316
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
437
|
-
:type instance_collections: bool | None
|
|
438
317
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
439
|
-
:type instance_object_data: bool | None
|
|
440
318
|
:param set_fake: Fake User, Set "Fake User" for appended items (except objects and collections)
|
|
441
|
-
:type set_fake: bool | None
|
|
442
319
|
:param use_recursive: Localize All, Localize all appended data, including those indirectly linked from other libraries
|
|
443
|
-
:type use_recursive: bool | None
|
|
444
320
|
"""
|
|
445
321
|
|
|
446
322
|
def batch_rename(
|
|
@@ -477,14 +353,9 @@ def batch_rename(
|
|
|
477
353
|
) -> None:
|
|
478
354
|
"""Rename multiple items at once
|
|
479
355
|
|
|
480
|
-
:type execution_context: int | str | None
|
|
481
|
-
:type undo: bool | None
|
|
482
356
|
:param data_type: Type, Type of data to rename
|
|
483
|
-
:type data_type: typing.Literal['OBJECT','COLLECTION','MATERIAL','MESH','CURVE','META','VOLUME','GREASEPENCIL','ARMATURE','LATTICE','LIGHT','LIGHT_PROBE','CAMERA','SPEAKER','BONE','NODE','SEQUENCE_STRIP','ACTION_CLIP','SCENE','BRUSH'] | None
|
|
484
357
|
:param data_source: Source
|
|
485
|
-
:type data_source: typing.Literal['SELECT','ALL'] | None
|
|
486
358
|
:param actions: actions
|
|
487
|
-
:type actions: bpy.types.bpy_prop_collection[bl_operators.wm.BatchRenameAction] | None
|
|
488
359
|
"""
|
|
489
360
|
|
|
490
361
|
def blend_strings_utf8_validate(
|
|
@@ -492,11 +363,7 @@ def blend_strings_utf8_validate(
|
|
|
492
363
|
undo: bool | None = None,
|
|
493
364
|
/,
|
|
494
365
|
) -> None:
|
|
495
|
-
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)
|
|
496
|
-
|
|
497
|
-
:type execution_context: int | str | None
|
|
498
|
-
:type undo: bool | None
|
|
499
|
-
"""
|
|
366
|
+
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)"""
|
|
500
367
|
|
|
501
368
|
def call_asset_shelf_popover(
|
|
502
369
|
execution_context: int | str | None = None,
|
|
@@ -507,10 +374,7 @@ def call_asset_shelf_popover(
|
|
|
507
374
|
) -> None:
|
|
508
375
|
"""Open a predefined asset shelf in a popup
|
|
509
376
|
|
|
510
|
-
:type execution_context: int | str | None
|
|
511
|
-
:type undo: bool | None
|
|
512
377
|
:param name: Asset Shelf Name, Identifier of the asset shelf to display
|
|
513
|
-
:type name: str
|
|
514
378
|
"""
|
|
515
379
|
|
|
516
380
|
def call_menu(
|
|
@@ -522,10 +386,7 @@ def call_menu(
|
|
|
522
386
|
) -> None:
|
|
523
387
|
"""Open a predefined menu
|
|
524
388
|
|
|
525
|
-
:type execution_context: int | str | None
|
|
526
|
-
:type undo: bool | None
|
|
527
389
|
:param name: Name, Name of the menu
|
|
528
|
-
:type name: str
|
|
529
390
|
"""
|
|
530
391
|
|
|
531
392
|
def call_menu_pie(
|
|
@@ -537,10 +398,7 @@ def call_menu_pie(
|
|
|
537
398
|
) -> None:
|
|
538
399
|
"""Open a predefined pie menu
|
|
539
400
|
|
|
540
|
-
:type execution_context: int | str | None
|
|
541
|
-
:type undo: bool | None
|
|
542
401
|
:param name: Name, Name of the pie menu
|
|
543
|
-
:type name: str
|
|
544
402
|
"""
|
|
545
403
|
|
|
546
404
|
def call_panel(
|
|
@@ -553,12 +411,8 @@ def call_panel(
|
|
|
553
411
|
) -> None:
|
|
554
412
|
"""Open a predefined panel
|
|
555
413
|
|
|
556
|
-
:type execution_context: int | str | None
|
|
557
|
-
:type undo: bool | None
|
|
558
414
|
:param name: Name, Name of the menu
|
|
559
|
-
:type name: str
|
|
560
415
|
:param keep_open: Keep Open
|
|
561
|
-
:type keep_open: bool | None
|
|
562
416
|
"""
|
|
563
417
|
|
|
564
418
|
def clear_recent_files(
|
|
@@ -570,10 +424,7 @@ def clear_recent_files(
|
|
|
570
424
|
) -> None:
|
|
571
425
|
"""Clear the recent files list
|
|
572
426
|
|
|
573
|
-
:type execution_context: int | str | None
|
|
574
|
-
:type undo: bool | None
|
|
575
427
|
:param remove: Remove
|
|
576
|
-
:type remove: typing.Literal['ALL','MISSING'] | None
|
|
577
428
|
"""
|
|
578
429
|
|
|
579
430
|
def collection_export_all(
|
|
@@ -581,11 +432,7 @@ def collection_export_all(
|
|
|
581
432
|
undo: bool | None = None,
|
|
582
433
|
/,
|
|
583
434
|
) -> None:
|
|
584
|
-
"""Invoke all configured exporters for all collections
|
|
585
|
-
|
|
586
|
-
:type execution_context: int | str | None
|
|
587
|
-
:type undo: bool | None
|
|
588
|
-
"""
|
|
435
|
+
"""Invoke all configured exporters for all collections"""
|
|
589
436
|
|
|
590
437
|
def context_collection_boolean_set(
|
|
591
438
|
execution_context: int | str | None = None,
|
|
@@ -598,14 +445,9 @@ def context_collection_boolean_set(
|
|
|
598
445
|
) -> None:
|
|
599
446
|
"""Set boolean values for a collection of items
|
|
600
447
|
|
|
601
|
-
:type execution_context: int | str | None
|
|
602
|
-
:type undo: bool | None
|
|
603
448
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
604
|
-
:type data_path_iter: str
|
|
605
449
|
:param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
|
|
606
|
-
:type data_path_item: str
|
|
607
450
|
:param type: Type
|
|
608
|
-
:type type: typing.Literal['TOGGLE','ENABLE','DISABLE'] | None
|
|
609
451
|
"""
|
|
610
452
|
|
|
611
453
|
def context_cycle_array(
|
|
@@ -618,12 +460,8 @@ def context_cycle_array(
|
|
|
618
460
|
) -> None:
|
|
619
461
|
"""Set a context array value (useful for cycling the active mesh edit mode)
|
|
620
462
|
|
|
621
|
-
:type execution_context: int | str | None
|
|
622
|
-
:type undo: bool | None
|
|
623
463
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
624
|
-
:type data_path: str
|
|
625
464
|
:param reverse: Reverse, Cycle backwards
|
|
626
|
-
:type reverse: bool | None
|
|
627
465
|
"""
|
|
628
466
|
|
|
629
467
|
def context_cycle_enum(
|
|
@@ -637,14 +475,9 @@ def context_cycle_enum(
|
|
|
637
475
|
) -> None:
|
|
638
476
|
"""Toggle a context value
|
|
639
477
|
|
|
640
|
-
:type execution_context: int | str | None
|
|
641
|
-
:type undo: bool | None
|
|
642
478
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
643
|
-
:type data_path: str
|
|
644
479
|
:param reverse: Reverse, Cycle backwards
|
|
645
|
-
:type reverse: bool | None
|
|
646
480
|
:param wrap: Wrap, Wrap back to the first/last values
|
|
647
|
-
:type wrap: bool | None
|
|
648
481
|
"""
|
|
649
482
|
|
|
650
483
|
def context_cycle_int(
|
|
@@ -658,14 +491,9 @@ def context_cycle_int(
|
|
|
658
491
|
) -> None:
|
|
659
492
|
"""Set a context value (useful for cycling active material, shape keys, groups, etc.)
|
|
660
493
|
|
|
661
|
-
:type execution_context: int | str | None
|
|
662
|
-
:type undo: bool | None
|
|
663
494
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
664
|
-
:type data_path: str
|
|
665
495
|
:param reverse: Reverse, Cycle backwards
|
|
666
|
-
:type reverse: bool | None
|
|
667
496
|
:param wrap: Wrap, Wrap back to the first/last values
|
|
668
|
-
:type wrap: bool | None
|
|
669
497
|
"""
|
|
670
498
|
|
|
671
499
|
def context_menu_enum(
|
|
@@ -677,10 +505,7 @@ def context_menu_enum(
|
|
|
677
505
|
) -> None:
|
|
678
506
|
"""Undocumented, consider contributing.
|
|
679
507
|
|
|
680
|
-
:type execution_context: int | str | None
|
|
681
|
-
:type undo: bool | None
|
|
682
508
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
683
|
-
:type data_path: str
|
|
684
509
|
"""
|
|
685
510
|
|
|
686
511
|
def context_modal_mouse(
|
|
@@ -697,20 +522,12 @@ def context_modal_mouse(
|
|
|
697
522
|
) -> None:
|
|
698
523
|
"""Adjust arbitrary values with mouse input
|
|
699
524
|
|
|
700
|
-
:type execution_context: int | str | None
|
|
701
|
-
:type undo: bool | None
|
|
702
525
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
703
|
-
:type data_path_iter: str
|
|
704
526
|
:param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
|
|
705
|
-
:type data_path_item: str
|
|
706
527
|
:param header_text: Header Text, Text to display in header during scale
|
|
707
|
-
:type header_text: str
|
|
708
528
|
:param input_scale: input_scale, Scale the mouse movement by this value before applying the delta
|
|
709
|
-
:type input_scale: float | None
|
|
710
529
|
:param invert: invert, Invert the mouse input
|
|
711
|
-
:type invert: bool | None
|
|
712
530
|
:param initial_x: initial_x
|
|
713
|
-
:type initial_x: int | None
|
|
714
531
|
"""
|
|
715
532
|
|
|
716
533
|
def context_pie_enum(
|
|
@@ -722,10 +539,7 @@ def context_pie_enum(
|
|
|
722
539
|
) -> None:
|
|
723
540
|
"""Undocumented, consider contributing.
|
|
724
541
|
|
|
725
|
-
:type execution_context: int | str | None
|
|
726
|
-
:type undo: bool | None
|
|
727
542
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
728
|
-
:type data_path: str
|
|
729
543
|
"""
|
|
730
544
|
|
|
731
545
|
def context_scale_float(
|
|
@@ -738,12 +552,8 @@ def context_scale_float(
|
|
|
738
552
|
) -> None:
|
|
739
553
|
"""Scale a float context value
|
|
740
554
|
|
|
741
|
-
:type execution_context: int | str | None
|
|
742
|
-
:type undo: bool | None
|
|
743
555
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
744
|
-
:type data_path: str
|
|
745
556
|
:param value: Value, Assign value
|
|
746
|
-
:type value: float | None
|
|
747
557
|
"""
|
|
748
558
|
|
|
749
559
|
def context_scale_int(
|
|
@@ -757,14 +567,9 @@ def context_scale_int(
|
|
|
757
567
|
) -> None:
|
|
758
568
|
"""Scale an int context value
|
|
759
569
|
|
|
760
|
-
:type execution_context: int | str | None
|
|
761
|
-
:type undo: bool | None
|
|
762
570
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
763
|
-
:type data_path: str
|
|
764
571
|
:param value: Value, Assign value
|
|
765
|
-
:type value: float | None
|
|
766
572
|
:param always_step: Always Step, Always adjust the value by a minimum of 1 when value is not 1.0
|
|
767
|
-
:type always_step: bool | None
|
|
768
573
|
"""
|
|
769
574
|
|
|
770
575
|
def context_set_boolean(
|
|
@@ -777,12 +582,8 @@ def context_set_boolean(
|
|
|
777
582
|
) -> None:
|
|
778
583
|
"""Set a context value
|
|
779
584
|
|
|
780
|
-
:type execution_context: int | str | None
|
|
781
|
-
:type undo: bool | None
|
|
782
585
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
783
|
-
:type data_path: str
|
|
784
586
|
:param value: Value, Assignment value
|
|
785
|
-
:type value: bool | None
|
|
786
587
|
"""
|
|
787
588
|
|
|
788
589
|
def context_set_enum(
|
|
@@ -795,12 +596,8 @@ def context_set_enum(
|
|
|
795
596
|
) -> None:
|
|
796
597
|
"""Set a context value
|
|
797
598
|
|
|
798
|
-
:type execution_context: int | str | None
|
|
799
|
-
:type undo: bool | None
|
|
800
599
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
801
|
-
:type data_path: str
|
|
802
600
|
:param value: Value, Assignment value (as a string)
|
|
803
|
-
:type value: str
|
|
804
601
|
"""
|
|
805
602
|
|
|
806
603
|
def context_set_float(
|
|
@@ -814,14 +611,9 @@ def context_set_float(
|
|
|
814
611
|
) -> None:
|
|
815
612
|
"""Set a context value
|
|
816
613
|
|
|
817
|
-
:type execution_context: int | str | None
|
|
818
|
-
:type undo: bool | None
|
|
819
614
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
820
|
-
:type data_path: str
|
|
821
615
|
:param value: Value, Assignment value
|
|
822
|
-
:type value: float | None
|
|
823
616
|
:param relative: Relative, Apply relative to the current value (delta)
|
|
824
|
-
:type relative: bool | None
|
|
825
617
|
"""
|
|
826
618
|
|
|
827
619
|
def context_set_id(
|
|
@@ -834,12 +626,8 @@ def context_set_id(
|
|
|
834
626
|
) -> None:
|
|
835
627
|
"""Set a context value to an ID data-block
|
|
836
628
|
|
|
837
|
-
:type execution_context: int | str | None
|
|
838
|
-
:type undo: bool | None
|
|
839
629
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
840
|
-
:type data_path: str
|
|
841
630
|
:param value: Value, Assign value
|
|
842
|
-
:type value: str
|
|
843
631
|
"""
|
|
844
632
|
|
|
845
633
|
def context_set_int(
|
|
@@ -853,14 +641,9 @@ def context_set_int(
|
|
|
853
641
|
) -> None:
|
|
854
642
|
"""Set a context value
|
|
855
643
|
|
|
856
|
-
:type execution_context: int | str | None
|
|
857
|
-
:type undo: bool | None
|
|
858
644
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
859
|
-
:type data_path: str
|
|
860
645
|
:param value: Value, Assign value
|
|
861
|
-
:type value: int | None
|
|
862
646
|
:param relative: Relative, Apply relative to the current value (delta)
|
|
863
|
-
:type relative: bool | None
|
|
864
647
|
"""
|
|
865
648
|
|
|
866
649
|
def context_set_string(
|
|
@@ -873,12 +656,8 @@ def context_set_string(
|
|
|
873
656
|
) -> None:
|
|
874
657
|
"""Set a context value
|
|
875
658
|
|
|
876
|
-
:type execution_context: int | str | None
|
|
877
|
-
:type undo: bool | None
|
|
878
659
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
879
|
-
:type data_path: str
|
|
880
660
|
:param value: Value, Assign value
|
|
881
|
-
:type value: str
|
|
882
661
|
"""
|
|
883
662
|
|
|
884
663
|
def context_set_value(
|
|
@@ -891,12 +670,8 @@ def context_set_value(
|
|
|
891
670
|
) -> None:
|
|
892
671
|
"""Set a context value
|
|
893
672
|
|
|
894
|
-
:type execution_context: int | str | None
|
|
895
|
-
:type undo: bool | None
|
|
896
673
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
897
|
-
:type data_path: str
|
|
898
674
|
:param value: Value, Assignment value (as a string)
|
|
899
|
-
:type value: str
|
|
900
675
|
"""
|
|
901
676
|
|
|
902
677
|
def context_toggle(
|
|
@@ -909,12 +684,8 @@ def context_toggle(
|
|
|
909
684
|
) -> None:
|
|
910
685
|
"""Toggle a context value
|
|
911
686
|
|
|
912
|
-
:type execution_context: int | str | None
|
|
913
|
-
:type undo: bool | None
|
|
914
687
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
915
|
-
:type data_path: str
|
|
916
688
|
:param module: Module, Optionally override the context with a module
|
|
917
|
-
:type module: str
|
|
918
689
|
"""
|
|
919
690
|
|
|
920
691
|
def context_toggle_enum(
|
|
@@ -928,14 +699,9 @@ def context_toggle_enum(
|
|
|
928
699
|
) -> None:
|
|
929
700
|
"""Toggle a context value
|
|
930
701
|
|
|
931
|
-
:type execution_context: int | str | None
|
|
932
|
-
:type undo: bool | None
|
|
933
702
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
934
|
-
:type data_path: str
|
|
935
703
|
:param value_1: Value, Toggle enum
|
|
936
|
-
:type value_1: str
|
|
937
704
|
:param value_2: Value, Toggle enum
|
|
938
|
-
:type value_2: str
|
|
939
705
|
"""
|
|
940
706
|
|
|
941
707
|
def debug_menu(
|
|
@@ -947,10 +713,7 @@ def debug_menu(
|
|
|
947
713
|
) -> None:
|
|
948
714
|
"""Open a popup to set the debug level
|
|
949
715
|
|
|
950
|
-
:type execution_context: int | str | None
|
|
951
|
-
:type undo: bool | None
|
|
952
716
|
:param debug_value: Debug Value
|
|
953
|
-
:type debug_value: int | None
|
|
954
717
|
"""
|
|
955
718
|
|
|
956
719
|
def doc_view(
|
|
@@ -962,10 +725,7 @@ def doc_view(
|
|
|
962
725
|
) -> None:
|
|
963
726
|
"""Open online reference docs in a web browser
|
|
964
727
|
|
|
965
|
-
:type execution_context: int | str | None
|
|
966
|
-
:type undo: bool | None
|
|
967
728
|
:param doc_id: Doc ID
|
|
968
|
-
:type doc_id: str
|
|
969
729
|
"""
|
|
970
730
|
|
|
971
731
|
def doc_view_manual(
|
|
@@ -977,10 +737,7 @@ def doc_view_manual(
|
|
|
977
737
|
) -> None:
|
|
978
738
|
"""Load online manual
|
|
979
739
|
|
|
980
|
-
:type execution_context: int | str | None
|
|
981
|
-
:type undo: bool | None
|
|
982
740
|
:param doc_id: Doc ID
|
|
983
|
-
:type doc_id: str
|
|
984
741
|
"""
|
|
985
742
|
|
|
986
743
|
def doc_view_manual_ui_context(
|
|
@@ -988,11 +745,7 @@ def doc_view_manual_ui_context(
|
|
|
988
745
|
undo: bool | None = None,
|
|
989
746
|
/,
|
|
990
747
|
) -> None:
|
|
991
|
-
"""View a context based online manual in a web browser
|
|
992
|
-
|
|
993
|
-
:type execution_context: int | str | None
|
|
994
|
-
:type undo: bool | None
|
|
995
|
-
"""
|
|
748
|
+
"""View a context based online manual in a web browser"""
|
|
996
749
|
|
|
997
750
|
def drop_blend_file(
|
|
998
751
|
execution_context: int | str | None = None,
|
|
@@ -1003,10 +756,7 @@ def drop_blend_file(
|
|
|
1003
756
|
) -> None:
|
|
1004
757
|
"""Undocumented, consider contributing.
|
|
1005
758
|
|
|
1006
|
-
:type execution_context: int | str | None
|
|
1007
|
-
:type undo: bool | None
|
|
1008
759
|
:param filepath: filepath
|
|
1009
|
-
:type filepath: str
|
|
1010
760
|
"""
|
|
1011
761
|
|
|
1012
762
|
def drop_import_file(
|
|
@@ -1020,12 +770,8 @@ def drop_import_file(
|
|
|
1020
770
|
) -> None:
|
|
1021
771
|
"""Operator that allows file handlers to receive file drops
|
|
1022
772
|
|
|
1023
|
-
:type execution_context: int | str | None
|
|
1024
|
-
:type undo: bool | None
|
|
1025
773
|
:param directory: Directory, Directory of the file
|
|
1026
|
-
:type directory: str
|
|
1027
774
|
:param files: Files
|
|
1028
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1029
775
|
"""
|
|
1030
776
|
|
|
1031
777
|
def fbx_import(
|
|
@@ -1076,50 +822,27 @@ def fbx_import(
|
|
|
1076
822
|
) -> None:
|
|
1077
823
|
"""Import FBX file into current scene
|
|
1078
824
|
|
|
1079
|
-
:type execution_context: int | str | None
|
|
1080
|
-
:type undo: bool | None
|
|
1081
825
|
:param filepath: File Path, Path to file
|
|
1082
|
-
:type filepath: str
|
|
1083
826
|
:param directory: Directory, Directory of the file
|
|
1084
|
-
:type directory: str
|
|
1085
827
|
:param files: Files
|
|
1086
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1087
828
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1088
|
-
:type check_existing: bool | None
|
|
1089
829
|
:param filter_blender: Filter .blend files
|
|
1090
|
-
:type filter_blender: bool | None
|
|
1091
830
|
:param filter_backup: Filter .blend files
|
|
1092
|
-
:type filter_backup: bool | None
|
|
1093
831
|
:param filter_image: Filter image files
|
|
1094
|
-
:type filter_image: bool | None
|
|
1095
832
|
:param filter_movie: Filter movie files
|
|
1096
|
-
:type filter_movie: bool | None
|
|
1097
833
|
:param filter_python: Filter Python files
|
|
1098
|
-
:type filter_python: bool | None
|
|
1099
834
|
:param filter_font: Filter font files
|
|
1100
|
-
:type filter_font: bool | None
|
|
1101
835
|
:param filter_sound: Filter sound files
|
|
1102
|
-
:type filter_sound: bool | None
|
|
1103
836
|
:param filter_text: Filter text files
|
|
1104
|
-
:type filter_text: bool | None
|
|
1105
837
|
:param filter_archive: Filter archive files
|
|
1106
|
-
:type filter_archive: bool | None
|
|
1107
838
|
:param filter_btx: Filter btx files
|
|
1108
|
-
:type filter_btx: bool | None
|
|
1109
839
|
:param filter_alembic: Filter Alembic files
|
|
1110
|
-
:type filter_alembic: bool | None
|
|
1111
840
|
:param filter_usd: Filter USD files
|
|
1112
|
-
:type filter_usd: bool | None
|
|
1113
841
|
:param filter_obj: Filter OBJ files
|
|
1114
|
-
:type filter_obj: bool | None
|
|
1115
842
|
:param filter_volume: Filter OpenVDB volume files
|
|
1116
|
-
:type filter_volume: bool | None
|
|
1117
843
|
:param filter_folder: Filter folders
|
|
1118
|
-
:type filter_folder: bool | None
|
|
1119
844
|
:param filter_blenlib: Filter Blender IDs
|
|
1120
|
-
:type filter_blenlib: bool | None
|
|
1121
845
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1122
|
-
:type filemode: int | None
|
|
1123
846
|
:param display_type: Display Type
|
|
1124
847
|
|
|
1125
848
|
DEFAULT
|
|
@@ -1133,11 +856,8 @@ def fbx_import(
|
|
|
1133
856
|
|
|
1134
857
|
THUMBNAIL
|
|
1135
858
|
Thumbnails -- Display files as thumbnails.
|
|
1136
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1137
859
|
:param sort_method: File sorting mode
|
|
1138
|
-
:type sort_method: str | None
|
|
1139
860
|
:param global_scale: Scale
|
|
1140
|
-
:type global_scale: float | None
|
|
1141
861
|
:param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
|
|
1142
862
|
|
|
1143
863
|
MAKE_UNIQUE
|
|
@@ -1145,7 +865,6 @@ def fbx_import(
|
|
|
1145
865
|
|
|
1146
866
|
REFERENCE_EXISTING
|
|
1147
867
|
Reference Existing -- If a material with the same name already exists, reference that instead of importing.
|
|
1148
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
1149
868
|
:param import_colors: Vertex Colors, Import vertex color attributes
|
|
1150
869
|
|
|
1151
870
|
NONE
|
|
@@ -1156,25 +875,15 @@ def fbx_import(
|
|
|
1156
875
|
|
|
1157
876
|
LINEAR
|
|
1158
877
|
Linear -- Vertex colors in the file are in linear color space.
|
|
1159
|
-
:type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
1160
878
|
:param use_custom_normals: Custom Normals, Import custom normals, if available (otherwise Blender will compute them)
|
|
1161
|
-
:type use_custom_normals: bool | None
|
|
1162
879
|
:param use_custom_props: Custom Properties, Import user properties as custom properties
|
|
1163
|
-
:type use_custom_props: bool | None
|
|
1164
880
|
:param use_custom_props_enum_as_string: Enums As Strings, Store custom property enumeration values as strings
|
|
1165
|
-
:type use_custom_props_enum_as_string: bool | None
|
|
1166
881
|
:param import_subdivision: Subdivision Data, Import FBX subdivision information as subdivision surface modifiers
|
|
1167
|
-
:type import_subdivision: bool | None
|
|
1168
882
|
:param ignore_leaf_bones: Ignore Leaf Bones, Ignore the last bone at the end of each chain (used to mark the length of the previous bone)
|
|
1169
|
-
:type ignore_leaf_bones: bool | None
|
|
1170
883
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
1171
|
-
:type validate_meshes: bool | None
|
|
1172
884
|
:param use_anim: Import Animation, Import FBX animation
|
|
1173
|
-
:type use_anim: bool | None
|
|
1174
885
|
:param anim_offset: Offset, Offset to apply to animation timestamps, in frames
|
|
1175
|
-
:type anim_offset: float | None
|
|
1176
886
|
:param filter_glob: Extension Filter
|
|
1177
|
-
:type filter_glob: str
|
|
1178
887
|
"""
|
|
1179
888
|
|
|
1180
889
|
def grease_pencil_export_pdf(
|
|
@@ -1215,46 +924,25 @@ def grease_pencil_export_pdf(
|
|
|
1215
924
|
) -> None:
|
|
1216
925
|
"""Export Grease Pencil to PDF
|
|
1217
926
|
|
|
1218
|
-
:type execution_context: int | str | None
|
|
1219
|
-
:type undo: bool | None
|
|
1220
927
|
:param filepath: File Path, Path to file
|
|
1221
|
-
:type filepath: str
|
|
1222
928
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1223
|
-
:type check_existing: bool | None
|
|
1224
929
|
:param filter_blender: Filter .blend files
|
|
1225
|
-
:type filter_blender: bool | None
|
|
1226
930
|
:param filter_backup: Filter .blend files
|
|
1227
|
-
:type filter_backup: bool | None
|
|
1228
931
|
:param filter_image: Filter image files
|
|
1229
|
-
:type filter_image: bool | None
|
|
1230
932
|
:param filter_movie: Filter movie files
|
|
1231
|
-
:type filter_movie: bool | None
|
|
1232
933
|
:param filter_python: Filter Python files
|
|
1233
|
-
:type filter_python: bool | None
|
|
1234
934
|
:param filter_font: Filter font files
|
|
1235
|
-
:type filter_font: bool | None
|
|
1236
935
|
:param filter_sound: Filter sound files
|
|
1237
|
-
:type filter_sound: bool | None
|
|
1238
936
|
:param filter_text: Filter text files
|
|
1239
|
-
:type filter_text: bool | None
|
|
1240
937
|
:param filter_archive: Filter archive files
|
|
1241
|
-
:type filter_archive: bool | None
|
|
1242
938
|
:param filter_btx: Filter btx files
|
|
1243
|
-
:type filter_btx: bool | None
|
|
1244
939
|
:param filter_alembic: Filter Alembic files
|
|
1245
|
-
:type filter_alembic: bool | None
|
|
1246
940
|
:param filter_usd: Filter USD files
|
|
1247
|
-
:type filter_usd: bool | None
|
|
1248
941
|
:param filter_obj: Filter OBJ files
|
|
1249
|
-
:type filter_obj: bool | None
|
|
1250
942
|
:param filter_volume: Filter OpenVDB volume files
|
|
1251
|
-
:type filter_volume: bool | None
|
|
1252
943
|
:param filter_folder: Filter folders
|
|
1253
|
-
:type filter_folder: bool | None
|
|
1254
944
|
:param filter_blenlib: Filter Blender IDs
|
|
1255
|
-
:type filter_blenlib: bool | None
|
|
1256
945
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1257
|
-
:type filemode: int | None
|
|
1258
946
|
:param display_type: Display Type
|
|
1259
947
|
|
|
1260
948
|
DEFAULT
|
|
@@ -1268,11 +956,8 @@ def grease_pencil_export_pdf(
|
|
|
1268
956
|
|
|
1269
957
|
THUMBNAIL
|
|
1270
958
|
Thumbnails -- Display files as thumbnails.
|
|
1271
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1272
959
|
:param sort_method: File sorting mode
|
|
1273
|
-
:type sort_method: str | None
|
|
1274
960
|
:param use_fill: Fill, Export strokes with fill enabled
|
|
1275
|
-
:type use_fill: bool | None
|
|
1276
961
|
:param selected_object_type: Object, Which objects to include in the export
|
|
1277
962
|
|
|
1278
963
|
ACTIVE
|
|
@@ -1283,7 +968,6 @@ def grease_pencil_export_pdf(
|
|
|
1283
968
|
|
|
1284
969
|
VISIBLE
|
|
1285
970
|
Visible -- Include all visible objects.
|
|
1286
|
-
:type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
|
|
1287
971
|
:param frame_mode: Frames, Which frames to include in the export
|
|
1288
972
|
|
|
1289
973
|
ACTIVE
|
|
@@ -1294,11 +978,8 @@ def grease_pencil_export_pdf(
|
|
|
1294
978
|
|
|
1295
979
|
SCENE
|
|
1296
980
|
Scene -- Include all scene frames.
|
|
1297
|
-
:type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
|
|
1298
981
|
:param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
|
|
1299
|
-
:type stroke_sample: float | None
|
|
1300
982
|
:param use_uniform_width: Uniform Width, Export strokes with uniform width
|
|
1301
|
-
:type use_uniform_width: bool | None
|
|
1302
983
|
"""
|
|
1303
984
|
|
|
1304
985
|
def grease_pencil_export_svg(
|
|
@@ -1340,46 +1021,25 @@ def grease_pencil_export_svg(
|
|
|
1340
1021
|
) -> None:
|
|
1341
1022
|
"""Export Grease Pencil to SVG
|
|
1342
1023
|
|
|
1343
|
-
:type execution_context: int | str | None
|
|
1344
|
-
:type undo: bool | None
|
|
1345
1024
|
:param filepath: File Path, Path to file
|
|
1346
|
-
:type filepath: str
|
|
1347
1025
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1348
|
-
:type check_existing: bool | None
|
|
1349
1026
|
:param filter_blender: Filter .blend files
|
|
1350
|
-
:type filter_blender: bool | None
|
|
1351
1027
|
:param filter_backup: Filter .blend files
|
|
1352
|
-
:type filter_backup: bool | None
|
|
1353
1028
|
:param filter_image: Filter image files
|
|
1354
|
-
:type filter_image: bool | None
|
|
1355
1029
|
:param filter_movie: Filter movie files
|
|
1356
|
-
:type filter_movie: bool | None
|
|
1357
1030
|
:param filter_python: Filter Python files
|
|
1358
|
-
:type filter_python: bool | None
|
|
1359
1031
|
:param filter_font: Filter font files
|
|
1360
|
-
:type filter_font: bool | None
|
|
1361
1032
|
:param filter_sound: Filter sound files
|
|
1362
|
-
:type filter_sound: bool | None
|
|
1363
1033
|
:param filter_text: Filter text files
|
|
1364
|
-
:type filter_text: bool | None
|
|
1365
1034
|
:param filter_archive: Filter archive files
|
|
1366
|
-
:type filter_archive: bool | None
|
|
1367
1035
|
:param filter_btx: Filter btx files
|
|
1368
|
-
:type filter_btx: bool | None
|
|
1369
1036
|
:param filter_alembic: Filter Alembic files
|
|
1370
|
-
:type filter_alembic: bool | None
|
|
1371
1037
|
:param filter_usd: Filter USD files
|
|
1372
|
-
:type filter_usd: bool | None
|
|
1373
1038
|
:param filter_obj: Filter OBJ files
|
|
1374
|
-
:type filter_obj: bool | None
|
|
1375
1039
|
:param filter_volume: Filter OpenVDB volume files
|
|
1376
|
-
:type filter_volume: bool | None
|
|
1377
1040
|
:param filter_folder: Filter folders
|
|
1378
|
-
:type filter_folder: bool | None
|
|
1379
1041
|
:param filter_blenlib: Filter Blender IDs
|
|
1380
|
-
:type filter_blenlib: bool | None
|
|
1381
1042
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1382
|
-
:type filemode: int | None
|
|
1383
1043
|
:param display_type: Display Type
|
|
1384
1044
|
|
|
1385
1045
|
DEFAULT
|
|
@@ -1393,11 +1053,8 @@ def grease_pencil_export_svg(
|
|
|
1393
1053
|
|
|
1394
1054
|
THUMBNAIL
|
|
1395
1055
|
Thumbnails -- Display files as thumbnails.
|
|
1396
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1397
1056
|
:param sort_method: File sorting mode
|
|
1398
|
-
:type sort_method: str | None
|
|
1399
1057
|
:param use_fill: Fill, Export strokes with fill enabled
|
|
1400
|
-
:type use_fill: bool | None
|
|
1401
1058
|
:param selected_object_type: Object, Which objects to include in the export
|
|
1402
1059
|
|
|
1403
1060
|
ACTIVE
|
|
@@ -1408,7 +1065,6 @@ def grease_pencil_export_svg(
|
|
|
1408
1065
|
|
|
1409
1066
|
VISIBLE
|
|
1410
1067
|
Visible -- Include all visible objects.
|
|
1411
|
-
:type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
|
|
1412
1068
|
:param frame_mode: Frames, Which frames to include in the export
|
|
1413
1069
|
|
|
1414
1070
|
ACTIVE
|
|
@@ -1419,13 +1075,9 @@ def grease_pencil_export_svg(
|
|
|
1419
1075
|
|
|
1420
1076
|
SCENE
|
|
1421
1077
|
Scene -- Include all scene frames.
|
|
1422
|
-
:type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
|
|
1423
1078
|
:param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
|
|
1424
|
-
:type stroke_sample: float | None
|
|
1425
1079
|
:param use_uniform_width: Uniform Width, Export strokes with uniform width
|
|
1426
|
-
:type use_uniform_width: bool | None
|
|
1427
1080
|
:param use_clip_camera: Clip Camera, Clip drawings to camera size when exporting in camera view
|
|
1428
|
-
:type use_clip_camera: bool | None
|
|
1429
1081
|
"""
|
|
1430
1082
|
|
|
1431
1083
|
def grease_pencil_import_svg(
|
|
@@ -1467,52 +1119,28 @@ def grease_pencil_import_svg(
|
|
|
1467
1119
|
) -> None:
|
|
1468
1120
|
"""Import SVG into Grease Pencil
|
|
1469
1121
|
|
|
1470
|
-
:type execution_context: int | str | None
|
|
1471
|
-
:type undo: bool | None
|
|
1472
1122
|
:param filepath: File Path, Path to file
|
|
1473
|
-
:type filepath: str
|
|
1474
1123
|
:param directory: Directory, Directory of the file
|
|
1475
|
-
:type directory: str
|
|
1476
1124
|
:param files: Files
|
|
1477
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1478
1125
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1479
|
-
:type check_existing: bool | None
|
|
1480
1126
|
:param filter_blender: Filter .blend files
|
|
1481
|
-
:type filter_blender: bool | None
|
|
1482
1127
|
:param filter_backup: Filter .blend files
|
|
1483
|
-
:type filter_backup: bool | None
|
|
1484
1128
|
:param filter_image: Filter image files
|
|
1485
|
-
:type filter_image: bool | None
|
|
1486
1129
|
:param filter_movie: Filter movie files
|
|
1487
|
-
:type filter_movie: bool | None
|
|
1488
1130
|
:param filter_python: Filter Python files
|
|
1489
|
-
:type filter_python: bool | None
|
|
1490
1131
|
:param filter_font: Filter font files
|
|
1491
|
-
:type filter_font: bool | None
|
|
1492
1132
|
:param filter_sound: Filter sound files
|
|
1493
|
-
:type filter_sound: bool | None
|
|
1494
1133
|
:param filter_text: Filter text files
|
|
1495
|
-
:type filter_text: bool | None
|
|
1496
1134
|
:param filter_archive: Filter archive files
|
|
1497
|
-
:type filter_archive: bool | None
|
|
1498
1135
|
:param filter_btx: Filter btx files
|
|
1499
|
-
:type filter_btx: bool | None
|
|
1500
1136
|
:param filter_alembic: Filter Alembic files
|
|
1501
|
-
:type filter_alembic: bool | None
|
|
1502
1137
|
:param filter_usd: Filter USD files
|
|
1503
|
-
:type filter_usd: bool | None
|
|
1504
1138
|
:param filter_obj: Filter OBJ files
|
|
1505
|
-
:type filter_obj: bool | None
|
|
1506
1139
|
:param filter_volume: Filter OpenVDB volume files
|
|
1507
|
-
:type filter_volume: bool | None
|
|
1508
1140
|
:param filter_folder: Filter folders
|
|
1509
|
-
:type filter_folder: bool | None
|
|
1510
1141
|
:param filter_blenlib: Filter Blender IDs
|
|
1511
|
-
:type filter_blenlib: bool | None
|
|
1512
1142
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1513
|
-
:type filemode: int | None
|
|
1514
1143
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1515
|
-
:type relative_path: bool | None
|
|
1516
1144
|
:param display_type: Display Type
|
|
1517
1145
|
|
|
1518
1146
|
DEFAULT
|
|
@@ -1526,15 +1154,10 @@ def grease_pencil_import_svg(
|
|
|
1526
1154
|
|
|
1527
1155
|
THUMBNAIL
|
|
1528
1156
|
Thumbnails -- Display files as thumbnails.
|
|
1529
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1530
1157
|
:param sort_method: File sorting mode
|
|
1531
|
-
:type sort_method: str | None
|
|
1532
1158
|
:param resolution: Resolution, Resolution of the generated strokes
|
|
1533
|
-
:type resolution: int | None
|
|
1534
1159
|
:param scale: Scale, Scale of the final strokes
|
|
1535
|
-
:type scale: float | None
|
|
1536
1160
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
1537
|
-
:type use_scene_unit: bool | None
|
|
1538
1161
|
"""
|
|
1539
1162
|
|
|
1540
1163
|
def id_linked_relocate(
|
|
@@ -1580,54 +1203,29 @@ def id_linked_relocate(
|
|
|
1580
1203
|
) -> None:
|
|
1581
1204
|
"""Relocate a linked ID, i.e. select another ID to link, and remap its local usages to that newly linked data-block). Currently only designed as an internal operator, not directly exposed to the user
|
|
1582
1205
|
|
|
1583
|
-
:type execution_context: int | str | None
|
|
1584
|
-
:type undo: bool | None
|
|
1585
1206
|
:param id_session_uid: Linked ID Session UID, Unique runtime identifier for the linked ID to relocate
|
|
1586
|
-
:type id_session_uid: int | None
|
|
1587
1207
|
:param filepath: File Path, Path to file
|
|
1588
|
-
:type filepath: str
|
|
1589
1208
|
:param directory: Directory, Directory of the file
|
|
1590
|
-
:type directory: str
|
|
1591
1209
|
:param filename: File Name, Name of the file
|
|
1592
|
-
:type filename: str
|
|
1593
1210
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1594
|
-
:type check_existing: bool | None
|
|
1595
1211
|
:param filter_blender: Filter .blend files
|
|
1596
|
-
:type filter_blender: bool | None
|
|
1597
1212
|
:param filter_backup: Filter .blend files
|
|
1598
|
-
:type filter_backup: bool | None
|
|
1599
1213
|
:param filter_image: Filter image files
|
|
1600
|
-
:type filter_image: bool | None
|
|
1601
1214
|
:param filter_movie: Filter movie files
|
|
1602
|
-
:type filter_movie: bool | None
|
|
1603
1215
|
:param filter_python: Filter Python files
|
|
1604
|
-
:type filter_python: bool | None
|
|
1605
1216
|
:param filter_font: Filter font files
|
|
1606
|
-
:type filter_font: bool | None
|
|
1607
1217
|
:param filter_sound: Filter sound files
|
|
1608
|
-
:type filter_sound: bool | None
|
|
1609
1218
|
:param filter_text: Filter text files
|
|
1610
|
-
:type filter_text: bool | None
|
|
1611
1219
|
:param filter_archive: Filter archive files
|
|
1612
|
-
:type filter_archive: bool | None
|
|
1613
1220
|
:param filter_btx: Filter btx files
|
|
1614
|
-
:type filter_btx: bool | None
|
|
1615
1221
|
:param filter_alembic: Filter Alembic files
|
|
1616
|
-
:type filter_alembic: bool | None
|
|
1617
1222
|
:param filter_usd: Filter USD files
|
|
1618
|
-
:type filter_usd: bool | None
|
|
1619
1223
|
:param filter_obj: Filter OBJ files
|
|
1620
|
-
:type filter_obj: bool | None
|
|
1621
1224
|
:param filter_volume: Filter OpenVDB volume files
|
|
1622
|
-
:type filter_volume: bool | None
|
|
1623
1225
|
:param filter_folder: Filter folders
|
|
1624
|
-
:type filter_folder: bool | None
|
|
1625
1226
|
:param filter_blenlib: Filter Blender IDs
|
|
1626
|
-
:type filter_blenlib: bool | None
|
|
1627
1227
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1628
|
-
:type filemode: int | None
|
|
1629
1228
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1630
|
-
:type relative_path: bool | None
|
|
1631
1229
|
:param display_type: Display Type
|
|
1632
1230
|
|
|
1633
1231
|
DEFAULT
|
|
@@ -1641,23 +1239,14 @@ def id_linked_relocate(
|
|
|
1641
1239
|
|
|
1642
1240
|
THUMBNAIL
|
|
1643
1241
|
Thumbnails -- Display files as thumbnails.
|
|
1644
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1645
1242
|
:param sort_method: File sorting mode
|
|
1646
|
-
:type sort_method: str | None
|
|
1647
1243
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
1648
|
-
:type link: bool | None
|
|
1649
1244
|
:param do_reuse_local_id: Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy
|
|
1650
|
-
:type do_reuse_local_id: bool | None
|
|
1651
1245
|
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
1652
|
-
:type clear_asset_data: bool | None
|
|
1653
1246
|
:param autoselect: Select, Select new objects
|
|
1654
|
-
:type autoselect: bool | None
|
|
1655
1247
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
1656
|
-
:type active_collection: bool | None
|
|
1657
1248
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
1658
|
-
:type instance_collections: bool | None
|
|
1659
1249
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
1660
|
-
:type instance_object_data: bool | None
|
|
1661
1250
|
"""
|
|
1662
1251
|
|
|
1663
1252
|
def interface_theme_preset_add(
|
|
@@ -1671,14 +1260,9 @@ def interface_theme_preset_add(
|
|
|
1671
1260
|
) -> None:
|
|
1672
1261
|
"""Add a custom theme to the preset list
|
|
1673
1262
|
|
|
1674
|
-
:type execution_context: int | str | None
|
|
1675
|
-
:type undo: bool | None
|
|
1676
1263
|
:param name: Name, Name of the preset, used to make the path name
|
|
1677
|
-
:type name: str
|
|
1678
1264
|
:param remove_name: remove_name
|
|
1679
|
-
:type remove_name: bool | None
|
|
1680
1265
|
:param remove_active: remove_active
|
|
1681
|
-
:type remove_active: bool | None
|
|
1682
1266
|
"""
|
|
1683
1267
|
|
|
1684
1268
|
def interface_theme_preset_remove(
|
|
@@ -1692,14 +1276,9 @@ def interface_theme_preset_remove(
|
|
|
1692
1276
|
) -> None:
|
|
1693
1277
|
"""Remove a custom theme from the preset list
|
|
1694
1278
|
|
|
1695
|
-
:type execution_context: int | str | None
|
|
1696
|
-
:type undo: bool | None
|
|
1697
1279
|
:param name: Name, Name of the preset, used to make the path name
|
|
1698
|
-
:type name: str
|
|
1699
1280
|
:param remove_name: remove_name
|
|
1700
|
-
:type remove_name: bool | None
|
|
1701
1281
|
:param remove_active: remove_active
|
|
1702
|
-
:type remove_active: bool | None
|
|
1703
1282
|
"""
|
|
1704
1283
|
|
|
1705
1284
|
def interface_theme_preset_save(
|
|
@@ -1713,14 +1292,9 @@ def interface_theme_preset_save(
|
|
|
1713
1292
|
) -> None:
|
|
1714
1293
|
"""Save a custom theme in the preset list
|
|
1715
1294
|
|
|
1716
|
-
:type execution_context: int | str | None
|
|
1717
|
-
:type undo: bool | None
|
|
1718
1295
|
:param name: Name, Name of the preset, used to make the path name
|
|
1719
|
-
:type name: str
|
|
1720
1296
|
:param remove_name: remove_name
|
|
1721
|
-
:type remove_name: bool | None
|
|
1722
1297
|
:param remove_active: remove_active
|
|
1723
|
-
:type remove_active: bool | None
|
|
1724
1298
|
"""
|
|
1725
1299
|
|
|
1726
1300
|
def keyconfig_preset_add(
|
|
@@ -1734,14 +1308,9 @@ def keyconfig_preset_add(
|
|
|
1734
1308
|
) -> None:
|
|
1735
1309
|
"""Add a custom keymap configuration to the preset list
|
|
1736
1310
|
|
|
1737
|
-
:type execution_context: int | str | None
|
|
1738
|
-
:type undo: bool | None
|
|
1739
1311
|
:param name: Name, Name of the preset, used to make the path name
|
|
1740
|
-
:type name: str
|
|
1741
1312
|
:param remove_name: remove_name
|
|
1742
|
-
:type remove_name: bool | None
|
|
1743
1313
|
:param remove_active: remove_active
|
|
1744
|
-
:type remove_active: bool | None
|
|
1745
1314
|
"""
|
|
1746
1315
|
|
|
1747
1316
|
def keyconfig_preset_remove(
|
|
@@ -1755,14 +1324,9 @@ def keyconfig_preset_remove(
|
|
|
1755
1324
|
) -> None:
|
|
1756
1325
|
"""Remove a custom keymap configuration from the preset list
|
|
1757
1326
|
|
|
1758
|
-
:type execution_context: int | str | None
|
|
1759
|
-
:type undo: bool | None
|
|
1760
1327
|
:param name: Name, Name of the preset, used to make the path name
|
|
1761
|
-
:type name: str
|
|
1762
1328
|
:param remove_name: remove_name
|
|
1763
|
-
:type remove_name: bool | None
|
|
1764
1329
|
:param remove_active: remove_active
|
|
1765
|
-
:type remove_active: bool | None
|
|
1766
1330
|
"""
|
|
1767
1331
|
|
|
1768
1332
|
def lib_reload(
|
|
@@ -1802,56 +1366,30 @@ def lib_reload(
|
|
|
1802
1366
|
) -> None:
|
|
1803
1367
|
"""Reload the given library
|
|
1804
1368
|
|
|
1805
|
-
:type execution_context: int | str | None
|
|
1806
|
-
:type undo: bool | None
|
|
1807
1369
|
:param library: Library, Library to reload
|
|
1808
|
-
:type library: str
|
|
1809
1370
|
:param filepath: File Path, Path to file
|
|
1810
|
-
:type filepath: str
|
|
1811
1371
|
:param directory: Directory, Directory of the file
|
|
1812
|
-
:type directory: str
|
|
1813
1372
|
:param filename: File Name, Name of the file
|
|
1814
|
-
:type filename: str
|
|
1815
1373
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1816
|
-
:type hide_props_region: bool | None
|
|
1817
1374
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1818
|
-
:type check_existing: bool | None
|
|
1819
1375
|
:param filter_blender: Filter .blend files
|
|
1820
|
-
:type filter_blender: bool | None
|
|
1821
1376
|
:param filter_backup: Filter .blend files
|
|
1822
|
-
:type filter_backup: bool | None
|
|
1823
1377
|
:param filter_image: Filter image files
|
|
1824
|
-
:type filter_image: bool | None
|
|
1825
1378
|
:param filter_movie: Filter movie files
|
|
1826
|
-
:type filter_movie: bool | None
|
|
1827
1379
|
:param filter_python: Filter Python files
|
|
1828
|
-
:type filter_python: bool | None
|
|
1829
1380
|
:param filter_font: Filter font files
|
|
1830
|
-
:type filter_font: bool | None
|
|
1831
1381
|
:param filter_sound: Filter sound files
|
|
1832
|
-
:type filter_sound: bool | None
|
|
1833
1382
|
:param filter_text: Filter text files
|
|
1834
|
-
:type filter_text: bool | None
|
|
1835
1383
|
:param filter_archive: Filter archive files
|
|
1836
|
-
:type filter_archive: bool | None
|
|
1837
1384
|
:param filter_btx: Filter btx files
|
|
1838
|
-
:type filter_btx: bool | None
|
|
1839
1385
|
:param filter_alembic: Filter Alembic files
|
|
1840
|
-
:type filter_alembic: bool | None
|
|
1841
1386
|
:param filter_usd: Filter USD files
|
|
1842
|
-
:type filter_usd: bool | None
|
|
1843
1387
|
:param filter_obj: Filter OBJ files
|
|
1844
|
-
:type filter_obj: bool | None
|
|
1845
1388
|
:param filter_volume: Filter OpenVDB volume files
|
|
1846
|
-
:type filter_volume: bool | None
|
|
1847
1389
|
:param filter_folder: Filter folders
|
|
1848
|
-
:type filter_folder: bool | None
|
|
1849
1390
|
:param filter_blenlib: Filter Blender IDs
|
|
1850
|
-
:type filter_blenlib: bool | None
|
|
1851
1391
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1852
|
-
:type filemode: int | None
|
|
1853
1392
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1854
|
-
:type relative_path: bool | None
|
|
1855
1393
|
:param display_type: Display Type
|
|
1856
1394
|
|
|
1857
1395
|
DEFAULT
|
|
@@ -1865,9 +1403,7 @@ def lib_reload(
|
|
|
1865
1403
|
|
|
1866
1404
|
THUMBNAIL
|
|
1867
1405
|
Thumbnails -- Display files as thumbnails.
|
|
1868
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1869
1406
|
:param sort_method: File sorting mode
|
|
1870
|
-
:type sort_method: str | None
|
|
1871
1407
|
"""
|
|
1872
1408
|
|
|
1873
1409
|
def lib_relocate(
|
|
@@ -1909,58 +1445,31 @@ def lib_relocate(
|
|
|
1909
1445
|
) -> None:
|
|
1910
1446
|
"""Relocate the given library to one or several others
|
|
1911
1447
|
|
|
1912
|
-
:type execution_context: int | str | None
|
|
1913
|
-
:type undo: bool | None
|
|
1914
1448
|
:param library: Library, Library to relocate
|
|
1915
|
-
:type library: str
|
|
1916
1449
|
:param filepath: File Path, Path to file
|
|
1917
|
-
:type filepath: str
|
|
1918
1450
|
:param directory: Directory, Directory of the file
|
|
1919
|
-
:type directory: str
|
|
1920
1451
|
:param filename: File Name, Name of the file
|
|
1921
|
-
:type filename: str
|
|
1922
1452
|
:param files: Files
|
|
1923
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1924
1453
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1925
|
-
:type hide_props_region: bool | None
|
|
1926
1454
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1927
|
-
:type check_existing: bool | None
|
|
1928
1455
|
:param filter_blender: Filter .blend files
|
|
1929
|
-
:type filter_blender: bool | None
|
|
1930
1456
|
:param filter_backup: Filter .blend files
|
|
1931
|
-
:type filter_backup: bool | None
|
|
1932
1457
|
:param filter_image: Filter image files
|
|
1933
|
-
:type filter_image: bool | None
|
|
1934
1458
|
:param filter_movie: Filter movie files
|
|
1935
|
-
:type filter_movie: bool | None
|
|
1936
1459
|
:param filter_python: Filter Python files
|
|
1937
|
-
:type filter_python: bool | None
|
|
1938
1460
|
:param filter_font: Filter font files
|
|
1939
|
-
:type filter_font: bool | None
|
|
1940
1461
|
:param filter_sound: Filter sound files
|
|
1941
|
-
:type filter_sound: bool | None
|
|
1942
1462
|
:param filter_text: Filter text files
|
|
1943
|
-
:type filter_text: bool | None
|
|
1944
1463
|
:param filter_archive: Filter archive files
|
|
1945
|
-
:type filter_archive: bool | None
|
|
1946
1464
|
:param filter_btx: Filter btx files
|
|
1947
|
-
:type filter_btx: bool | None
|
|
1948
1465
|
:param filter_alembic: Filter Alembic files
|
|
1949
|
-
:type filter_alembic: bool | None
|
|
1950
1466
|
:param filter_usd: Filter USD files
|
|
1951
|
-
:type filter_usd: bool | None
|
|
1952
1467
|
:param filter_obj: Filter OBJ files
|
|
1953
|
-
:type filter_obj: bool | None
|
|
1954
1468
|
:param filter_volume: Filter OpenVDB volume files
|
|
1955
|
-
:type filter_volume: bool | None
|
|
1956
1469
|
:param filter_folder: Filter folders
|
|
1957
|
-
:type filter_folder: bool | None
|
|
1958
1470
|
:param filter_blenlib: Filter Blender IDs
|
|
1959
|
-
:type filter_blenlib: bool | None
|
|
1960
1471
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1961
|
-
:type filemode: int | None
|
|
1962
1472
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1963
|
-
:type relative_path: bool | None
|
|
1964
1473
|
:param display_type: Display Type
|
|
1965
1474
|
|
|
1966
1475
|
DEFAULT
|
|
@@ -1974,9 +1483,7 @@ def lib_relocate(
|
|
|
1974
1483
|
|
|
1975
1484
|
THUMBNAIL
|
|
1976
1485
|
Thumbnails -- Display files as thumbnails.
|
|
1977
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1978
1486
|
:param sort_method: File sorting mode
|
|
1979
|
-
:type sort_method: str | None
|
|
1980
1487
|
"""
|
|
1981
1488
|
|
|
1982
1489
|
def link(
|
|
@@ -2023,54 +1530,29 @@ def link(
|
|
|
2023
1530
|
) -> None:
|
|
2024
1531
|
"""Link from a Library .blend file
|
|
2025
1532
|
|
|
2026
|
-
:type execution_context: int | str | None
|
|
2027
|
-
:type undo: bool | None
|
|
2028
1533
|
:param filepath: File Path, Path to file
|
|
2029
|
-
:type filepath: str
|
|
2030
1534
|
:param directory: Directory, Directory of the file
|
|
2031
|
-
:type directory: str
|
|
2032
1535
|
:param filename: File Name, Name of the file
|
|
2033
|
-
:type filename: str
|
|
2034
1536
|
:param files: Files
|
|
2035
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2036
1537
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2037
|
-
:type check_existing: bool | None
|
|
2038
1538
|
:param filter_blender: Filter .blend files
|
|
2039
|
-
:type filter_blender: bool | None
|
|
2040
1539
|
:param filter_backup: Filter .blend files
|
|
2041
|
-
:type filter_backup: bool | None
|
|
2042
1540
|
:param filter_image: Filter image files
|
|
2043
|
-
:type filter_image: bool | None
|
|
2044
1541
|
:param filter_movie: Filter movie files
|
|
2045
|
-
:type filter_movie: bool | None
|
|
2046
1542
|
:param filter_python: Filter Python files
|
|
2047
|
-
:type filter_python: bool | None
|
|
2048
1543
|
:param filter_font: Filter font files
|
|
2049
|
-
:type filter_font: bool | None
|
|
2050
1544
|
:param filter_sound: Filter sound files
|
|
2051
|
-
:type filter_sound: bool | None
|
|
2052
1545
|
:param filter_text: Filter text files
|
|
2053
|
-
:type filter_text: bool | None
|
|
2054
1546
|
:param filter_archive: Filter archive files
|
|
2055
|
-
:type filter_archive: bool | None
|
|
2056
1547
|
:param filter_btx: Filter btx files
|
|
2057
|
-
:type filter_btx: bool | None
|
|
2058
1548
|
:param filter_alembic: Filter Alembic files
|
|
2059
|
-
:type filter_alembic: bool | None
|
|
2060
1549
|
:param filter_usd: Filter USD files
|
|
2061
|
-
:type filter_usd: bool | None
|
|
2062
1550
|
:param filter_obj: Filter OBJ files
|
|
2063
|
-
:type filter_obj: bool | None
|
|
2064
1551
|
:param filter_volume: Filter OpenVDB volume files
|
|
2065
|
-
:type filter_volume: bool | None
|
|
2066
1552
|
:param filter_folder: Filter folders
|
|
2067
|
-
:type filter_folder: bool | None
|
|
2068
1553
|
:param filter_blenlib: Filter Blender IDs
|
|
2069
|
-
:type filter_blenlib: bool | None
|
|
2070
1554
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2071
|
-
:type filemode: int | None
|
|
2072
1555
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
2073
|
-
:type relative_path: bool | None
|
|
2074
1556
|
:param display_type: Display Type
|
|
2075
1557
|
|
|
2076
1558
|
DEFAULT
|
|
@@ -2084,23 +1566,14 @@ def link(
|
|
|
2084
1566
|
|
|
2085
1567
|
THUMBNAIL
|
|
2086
1568
|
Thumbnails -- Display files as thumbnails.
|
|
2087
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2088
1569
|
:param sort_method: File sorting mode
|
|
2089
|
-
:type sort_method: str | None
|
|
2090
1570
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
2091
|
-
:type link: bool | None
|
|
2092
1571
|
:param do_reuse_local_id: Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy
|
|
2093
|
-
:type do_reuse_local_id: bool | None
|
|
2094
1572
|
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
2095
|
-
:type clear_asset_data: bool | None
|
|
2096
1573
|
:param autoselect: Select, Select new objects
|
|
2097
|
-
:type autoselect: bool | None
|
|
2098
1574
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
2099
|
-
:type active_collection: bool | None
|
|
2100
1575
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
2101
|
-
:type instance_collections: bool | None
|
|
2102
1576
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
2103
|
-
:type instance_object_data: bool | None
|
|
2104
1577
|
"""
|
|
2105
1578
|
|
|
2106
1579
|
def memory_statistics(
|
|
@@ -2108,11 +1581,7 @@ def memory_statistics(
|
|
|
2108
1581
|
undo: bool | None = None,
|
|
2109
1582
|
/,
|
|
2110
1583
|
) -> None:
|
|
2111
|
-
"""Print memory statistics to the console
|
|
2112
|
-
|
|
2113
|
-
:type execution_context: int | str | None
|
|
2114
|
-
:type undo: bool | None
|
|
2115
|
-
"""
|
|
1584
|
+
"""Print memory statistics to the console"""
|
|
2116
1585
|
|
|
2117
1586
|
def obj_export(
|
|
2118
1587
|
execution_context: int | str | None = None,
|
|
@@ -2177,46 +1646,25 @@ def obj_export(
|
|
|
2177
1646
|
) -> None:
|
|
2178
1647
|
"""Save the scene to a Wavefront OBJ file
|
|
2179
1648
|
|
|
2180
|
-
:type execution_context: int | str | None
|
|
2181
|
-
:type undo: bool | None
|
|
2182
1649
|
:param filepath: File Path, Path to file
|
|
2183
|
-
:type filepath: str
|
|
2184
1650
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2185
|
-
:type check_existing: bool | None
|
|
2186
1651
|
:param filter_blender: Filter .blend files
|
|
2187
|
-
:type filter_blender: bool | None
|
|
2188
1652
|
:param filter_backup: Filter .blend files
|
|
2189
|
-
:type filter_backup: bool | None
|
|
2190
1653
|
:param filter_image: Filter image files
|
|
2191
|
-
:type filter_image: bool | None
|
|
2192
1654
|
:param filter_movie: Filter movie files
|
|
2193
|
-
:type filter_movie: bool | None
|
|
2194
1655
|
:param filter_python: Filter Python files
|
|
2195
|
-
:type filter_python: bool | None
|
|
2196
1656
|
:param filter_font: Filter font files
|
|
2197
|
-
:type filter_font: bool | None
|
|
2198
1657
|
:param filter_sound: Filter sound files
|
|
2199
|
-
:type filter_sound: bool | None
|
|
2200
1658
|
:param filter_text: Filter text files
|
|
2201
|
-
:type filter_text: bool | None
|
|
2202
1659
|
:param filter_archive: Filter archive files
|
|
2203
|
-
:type filter_archive: bool | None
|
|
2204
1660
|
:param filter_btx: Filter btx files
|
|
2205
|
-
:type filter_btx: bool | None
|
|
2206
1661
|
:param filter_alembic: Filter Alembic files
|
|
2207
|
-
:type filter_alembic: bool | None
|
|
2208
1662
|
:param filter_usd: Filter USD files
|
|
2209
|
-
:type filter_usd: bool | None
|
|
2210
1663
|
:param filter_obj: Filter OBJ files
|
|
2211
|
-
:type filter_obj: bool | None
|
|
2212
1664
|
:param filter_volume: Filter OpenVDB volume files
|
|
2213
|
-
:type filter_volume: bool | None
|
|
2214
1665
|
:param filter_folder: Filter folders
|
|
2215
|
-
:type filter_folder: bool | None
|
|
2216
1666
|
:param filter_blenlib: Filter Blender IDs
|
|
2217
|
-
:type filter_blenlib: bool | None
|
|
2218
1667
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2219
|
-
:type filemode: int | None
|
|
2220
1668
|
:param display_type: Display Type
|
|
2221
1669
|
|
|
2222
1670
|
DEFAULT
|
|
@@ -2230,15 +1678,10 @@ def obj_export(
|
|
|
2230
1678
|
|
|
2231
1679
|
THUMBNAIL
|
|
2232
1680
|
Thumbnails -- Display files as thumbnails.
|
|
2233
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2234
1681
|
:param sort_method: File sorting mode
|
|
2235
|
-
:type sort_method: str | None
|
|
2236
1682
|
:param export_animation: Export Animation, Export multiple frames instead of the current frame only
|
|
2237
|
-
:type export_animation: bool | None
|
|
2238
1683
|
:param start_frame: Start Frame, The first frame to be exported
|
|
2239
|
-
:type start_frame: int | None
|
|
2240
1684
|
:param end_frame: End Frame, The last frame to be exported
|
|
2241
|
-
:type end_frame: int | None
|
|
2242
1685
|
:param forward_axis: Forward Axis
|
|
2243
1686
|
|
|
2244
1687
|
X
|
|
@@ -2258,7 +1701,6 @@ def obj_export(
|
|
|
2258
1701
|
|
|
2259
1702
|
NEGATIVE_Z
|
|
2260
1703
|
-Z -- Negative Z axis.
|
|
2261
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2262
1704
|
:param up_axis: Up Axis
|
|
2263
1705
|
|
|
2264
1706
|
X
|
|
@@ -2278,13 +1720,9 @@ def obj_export(
|
|
|
2278
1720
|
|
|
2279
1721
|
NEGATIVE_Z
|
|
2280
1722
|
-Z -- Negative Z axis.
|
|
2281
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2282
1723
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2283
|
-
:type global_scale: float | None
|
|
2284
1724
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
2285
|
-
:type apply_modifiers: bool | None
|
|
2286
1725
|
:param apply_transform: Apply Transform, Apply object transforms to exported vertices
|
|
2287
|
-
:type apply_transform: bool | None
|
|
2288
1726
|
:param export_eval_mode: Object Properties, Determines properties like object visibility, modifiers etc., where they differ for Render and Viewport
|
|
2289
1727
|
|
|
2290
1728
|
DAG_EVAL_RENDER
|
|
@@ -2292,19 +1730,12 @@ def obj_export(
|
|
|
2292
1730
|
|
|
2293
1731
|
DAG_EVAL_VIEWPORT
|
|
2294
1732
|
Viewport -- Export objects as they appear in the viewport.
|
|
2295
|
-
:type export_eval_mode: typing.Literal['DAG_EVAL_RENDER','DAG_EVAL_VIEWPORT'] | None
|
|
2296
1733
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
2297
|
-
:type export_selected_objects: bool | None
|
|
2298
1734
|
:param export_uv: Export UVs
|
|
2299
|
-
:type export_uv: bool | None
|
|
2300
1735
|
:param export_normals: Export Normals, Export per-face normals if the face is flat-shaded, per-face-corner normals if smooth-shaded
|
|
2301
|
-
:type export_normals: bool | None
|
|
2302
1736
|
:param export_colors: Export Colors, Export per-vertex colors
|
|
2303
|
-
:type export_colors: bool | None
|
|
2304
1737
|
:param export_materials: Export Materials, Export MTL library. There must be a Principled-BSDF node for image textures to be exported to the MTL file
|
|
2305
|
-
:type export_materials: bool | None
|
|
2306
1738
|
:param export_pbr_extensions: Export Materials with PBR Extensions, Export MTL library using PBR extensions (roughness, metallic, sheen, coat, anisotropy, transmission)
|
|
2307
|
-
:type export_pbr_extensions: bool | None
|
|
2308
1739
|
:param path_mode: Path Mode, Method used to reference paths
|
|
2309
1740
|
|
|
2310
1741
|
AUTO
|
|
@@ -2324,25 +1755,15 @@ def obj_export(
|
|
|
2324
1755
|
|
|
2325
1756
|
COPY
|
|
2326
1757
|
Copy -- Copy the file to the destination path.
|
|
2327
|
-
:type path_mode: typing.Literal['AUTO','ABSOLUTE','RELATIVE','MATCH','STRIP','COPY'] | None
|
|
2328
1758
|
:param export_triangulated_mesh: Export Triangulated Mesh, All ngons with four or more vertices will be triangulated. Meshes in the scene will not be affected. Behaves like Triangulate Modifier with ngon-method: "Beauty", quad-method: "Shortest Diagonal", min vertices: 4
|
|
2329
|
-
:type export_triangulated_mesh: bool | None
|
|
2330
1759
|
:param export_curves_as_nurbs: Export Curves as NURBS, Export curves in parametric form instead of exporting as mesh
|
|
2331
|
-
:type export_curves_as_nurbs: bool | None
|
|
2332
1760
|
:param export_object_groups: Export Object Groups, Append mesh name to object name, separated by a _
|
|
2333
|
-
:type export_object_groups: bool | None
|
|
2334
1761
|
:param export_material_groups: Export Material Groups, Generate an OBJ group for each part of a geometry using a different material
|
|
2335
|
-
:type export_material_groups: bool | None
|
|
2336
1762
|
:param export_vertex_groups: Export Vertex Groups, Export the name of the vertex group of a face. It is approximated by choosing the vertex group with the most members among the vertices of a face
|
|
2337
|
-
:type export_vertex_groups: bool | None
|
|
2338
1763
|
:param export_smooth_groups: Export Smooth Groups, Generate smooth groups identifiers for each group of smooth faces, as unique integer values by default
|
|
2339
|
-
:type export_smooth_groups: bool | None
|
|
2340
1764
|
:param smooth_group_bitflags: Bitflags Smooth Groups, If exporting smoothgroups, generate bitflags values for the groups, instead of unique integer values. The same bitflag value can be re-used for different groups of smooth faces, as long as they have no common sharp edges or vertices
|
|
2341
|
-
:type smooth_group_bitflags: bool | None
|
|
2342
1765
|
:param filter_glob: Extension Filter
|
|
2343
|
-
:type filter_glob: str
|
|
2344
1766
|
:param collection: Collection
|
|
2345
|
-
:type collection: str
|
|
2346
1767
|
"""
|
|
2347
1768
|
|
|
2348
1769
|
def obj_import(
|
|
@@ -2397,50 +1818,27 @@ def obj_import(
|
|
|
2397
1818
|
) -> None:
|
|
2398
1819
|
"""Load a Wavefront OBJ scene
|
|
2399
1820
|
|
|
2400
|
-
:type execution_context: int | str | None
|
|
2401
|
-
:type undo: bool | None
|
|
2402
1821
|
:param filepath: File Path, Path to file
|
|
2403
|
-
:type filepath: str
|
|
2404
1822
|
:param directory: Directory, Directory of the file
|
|
2405
|
-
:type directory: str
|
|
2406
1823
|
:param files: Files
|
|
2407
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2408
1824
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2409
|
-
:type check_existing: bool | None
|
|
2410
1825
|
:param filter_blender: Filter .blend files
|
|
2411
|
-
:type filter_blender: bool | None
|
|
2412
1826
|
:param filter_backup: Filter .blend files
|
|
2413
|
-
:type filter_backup: bool | None
|
|
2414
1827
|
:param filter_image: Filter image files
|
|
2415
|
-
:type filter_image: bool | None
|
|
2416
1828
|
:param filter_movie: Filter movie files
|
|
2417
|
-
:type filter_movie: bool | None
|
|
2418
1829
|
:param filter_python: Filter Python files
|
|
2419
|
-
:type filter_python: bool | None
|
|
2420
1830
|
:param filter_font: Filter font files
|
|
2421
|
-
:type filter_font: bool | None
|
|
2422
1831
|
:param filter_sound: Filter sound files
|
|
2423
|
-
:type filter_sound: bool | None
|
|
2424
1832
|
:param filter_text: Filter text files
|
|
2425
|
-
:type filter_text: bool | None
|
|
2426
1833
|
:param filter_archive: Filter archive files
|
|
2427
|
-
:type filter_archive: bool | None
|
|
2428
1834
|
:param filter_btx: Filter btx files
|
|
2429
|
-
:type filter_btx: bool | None
|
|
2430
1835
|
:param filter_alembic: Filter Alembic files
|
|
2431
|
-
:type filter_alembic: bool | None
|
|
2432
1836
|
:param filter_usd: Filter USD files
|
|
2433
|
-
:type filter_usd: bool | None
|
|
2434
1837
|
:param filter_obj: Filter OBJ files
|
|
2435
|
-
:type filter_obj: bool | None
|
|
2436
1838
|
:param filter_volume: Filter OpenVDB volume files
|
|
2437
|
-
:type filter_volume: bool | None
|
|
2438
1839
|
:param filter_folder: Filter folders
|
|
2439
|
-
:type filter_folder: bool | None
|
|
2440
1840
|
:param filter_blenlib: Filter Blender IDs
|
|
2441
|
-
:type filter_blenlib: bool | None
|
|
2442
1841
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2443
|
-
:type filemode: int | None
|
|
2444
1842
|
:param display_type: Display Type
|
|
2445
1843
|
|
|
2446
1844
|
DEFAULT
|
|
@@ -2454,13 +1852,9 @@ def obj_import(
|
|
|
2454
1852
|
|
|
2455
1853
|
THUMBNAIL
|
|
2456
1854
|
Thumbnails -- Display files as thumbnails.
|
|
2457
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2458
1855
|
:param sort_method: File sorting mode
|
|
2459
|
-
:type sort_method: str | None
|
|
2460
1856
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2461
|
-
:type global_scale: float | None
|
|
2462
1857
|
:param clamp_size: Clamp Bounding Box, Resize the objects to keep bounding box under this value. Value 0 disables clamping
|
|
2463
|
-
:type clamp_size: float | None
|
|
2464
1858
|
:param forward_axis: Forward Axis
|
|
2465
1859
|
|
|
2466
1860
|
X
|
|
@@ -2480,7 +1874,6 @@ def obj_import(
|
|
|
2480
1874
|
|
|
2481
1875
|
NEGATIVE_Z
|
|
2482
1876
|
-Z -- Negative Z axis.
|
|
2483
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2484
1877
|
:param up_axis: Up Axis
|
|
2485
1878
|
|
|
2486
1879
|
X
|
|
@@ -2500,19 +1893,12 @@ def obj_import(
|
|
|
2500
1893
|
|
|
2501
1894
|
NEGATIVE_Z
|
|
2502
1895
|
-Z -- Negative Z axis.
|
|
2503
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2504
1896
|
:param use_split_objects: Split By Object, Import each OBJ o as a separate object
|
|
2505
|
-
:type use_split_objects: bool | None
|
|
2506
1897
|
:param use_split_groups: Split By Group, Import each OBJ g as a separate object
|
|
2507
|
-
:type use_split_groups: bool | None
|
|
2508
1898
|
:param import_vertex_groups: Vertex Groups, Import OBJ groups as vertex groups
|
|
2509
|
-
:type import_vertex_groups: bool | None
|
|
2510
1899
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
2511
|
-
:type validate_meshes: bool | None
|
|
2512
1900
|
:param close_spline_loops: Detect Cyclic Curves, Join curve endpoints if overlapping control points are detected (if disabled, no curves will be cyclic)
|
|
2513
|
-
:type close_spline_loops: bool | None
|
|
2514
1901
|
:param collection_separator: Path Separator, Character used to separate objects name into hierarchical structure
|
|
2515
|
-
:type collection_separator: str
|
|
2516
1902
|
:param mtl_name_collision_mode: Material Name Collision, How to handle naming collisions when importing materials
|
|
2517
1903
|
|
|
2518
1904
|
MAKE_UNIQUE
|
|
@@ -2520,9 +1906,7 @@ def obj_import(
|
|
|
2520
1906
|
|
|
2521
1907
|
REFERENCE_EXISTING
|
|
2522
1908
|
Reference Existing -- Use existing materials with same name instead of creating new ones.
|
|
2523
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
2524
1909
|
:param filter_glob: Extension Filter
|
|
2525
|
-
:type filter_glob: str
|
|
2526
1910
|
"""
|
|
2527
1911
|
|
|
2528
1912
|
def open_mainfile(
|
|
@@ -2562,48 +1946,26 @@ def open_mainfile(
|
|
|
2562
1946
|
) -> None:
|
|
2563
1947
|
"""Open a Blender file
|
|
2564
1948
|
|
|
2565
|
-
:type execution_context: int | str | None
|
|
2566
|
-
:type undo: bool | None
|
|
2567
1949
|
:param filepath: File Path, Path to file
|
|
2568
|
-
:type filepath: str
|
|
2569
1950
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
2570
|
-
:type hide_props_region: bool | None
|
|
2571
1951
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2572
|
-
:type check_existing: bool | None
|
|
2573
1952
|
:param filter_blender: Filter .blend files
|
|
2574
|
-
:type filter_blender: bool | None
|
|
2575
1953
|
:param filter_backup: Filter .blend files
|
|
2576
|
-
:type filter_backup: bool | None
|
|
2577
1954
|
:param filter_image: Filter image files
|
|
2578
|
-
:type filter_image: bool | None
|
|
2579
1955
|
:param filter_movie: Filter movie files
|
|
2580
|
-
:type filter_movie: bool | None
|
|
2581
1956
|
:param filter_python: Filter Python files
|
|
2582
|
-
:type filter_python: bool | None
|
|
2583
1957
|
:param filter_font: Filter font files
|
|
2584
|
-
:type filter_font: bool | None
|
|
2585
1958
|
:param filter_sound: Filter sound files
|
|
2586
|
-
:type filter_sound: bool | None
|
|
2587
1959
|
:param filter_text: Filter text files
|
|
2588
|
-
:type filter_text: bool | None
|
|
2589
1960
|
:param filter_archive: Filter archive files
|
|
2590
|
-
:type filter_archive: bool | None
|
|
2591
1961
|
:param filter_btx: Filter btx files
|
|
2592
|
-
:type filter_btx: bool | None
|
|
2593
1962
|
:param filter_alembic: Filter Alembic files
|
|
2594
|
-
:type filter_alembic: bool | None
|
|
2595
1963
|
:param filter_usd: Filter USD files
|
|
2596
|
-
:type filter_usd: bool | None
|
|
2597
1964
|
:param filter_obj: Filter OBJ files
|
|
2598
|
-
:type filter_obj: bool | None
|
|
2599
1965
|
:param filter_volume: Filter OpenVDB volume files
|
|
2600
|
-
:type filter_volume: bool | None
|
|
2601
1966
|
:param filter_folder: Filter folders
|
|
2602
|
-
:type filter_folder: bool | None
|
|
2603
1967
|
:param filter_blenlib: Filter Blender IDs
|
|
2604
|
-
:type filter_blenlib: bool | None
|
|
2605
1968
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2606
|
-
:type filemode: int | None
|
|
2607
1969
|
:param display_type: Display Type
|
|
2608
1970
|
|
|
2609
1971
|
DEFAULT
|
|
@@ -2617,17 +1979,11 @@ def open_mainfile(
|
|
|
2617
1979
|
|
|
2618
1980
|
THUMBNAIL
|
|
2619
1981
|
Thumbnails -- Display files as thumbnails.
|
|
2620
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2621
1982
|
:param sort_method: File sorting mode
|
|
2622
|
-
:type sort_method: str | None
|
|
2623
1983
|
:param load_ui: Load UI, Load user interface setup in the .blend file
|
|
2624
|
-
:type load_ui: bool | None
|
|
2625
1984
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
2626
|
-
:type use_scripts: bool | None
|
|
2627
1985
|
:param display_file_selector: Display File Selector
|
|
2628
|
-
:type display_file_selector: bool | None
|
|
2629
1986
|
:param state: State
|
|
2630
|
-
:type state: int | None
|
|
2631
1987
|
"""
|
|
2632
1988
|
|
|
2633
1989
|
def operator_cheat_sheet(
|
|
@@ -2635,22 +1991,14 @@ def operator_cheat_sheet(
|
|
|
2635
1991
|
undo: bool | None = None,
|
|
2636
1992
|
/,
|
|
2637
1993
|
) -> None:
|
|
2638
|
-
"""List all the operators in a text-block, useful for scripting
|
|
2639
|
-
|
|
2640
|
-
:type execution_context: int | str | None
|
|
2641
|
-
:type undo: bool | None
|
|
2642
|
-
"""
|
|
1994
|
+
"""List all the operators in a text-block, useful for scripting"""
|
|
2643
1995
|
|
|
2644
1996
|
def operator_defaults(
|
|
2645
1997
|
execution_context: int | str | None = None,
|
|
2646
1998
|
undo: bool | None = None,
|
|
2647
1999
|
/,
|
|
2648
2000
|
) -> None:
|
|
2649
|
-
"""Set the active operator to its default values
|
|
2650
|
-
|
|
2651
|
-
:type execution_context: int | str | None
|
|
2652
|
-
:type undo: bool | None
|
|
2653
|
-
"""
|
|
2001
|
+
"""Set the active operator to its default values"""
|
|
2654
2002
|
|
|
2655
2003
|
def operator_pie_enum(
|
|
2656
2004
|
execution_context: int | str | None = None,
|
|
@@ -2662,12 +2010,8 @@ def operator_pie_enum(
|
|
|
2662
2010
|
) -> None:
|
|
2663
2011
|
"""Undocumented, consider contributing.
|
|
2664
2012
|
|
|
2665
|
-
:type execution_context: int | str | None
|
|
2666
|
-
:type undo: bool | None
|
|
2667
2013
|
:param data_path: Operator, Operator name (in Python as string)
|
|
2668
|
-
:type data_path: str
|
|
2669
2014
|
:param prop_string: Property, Property name (as a string)
|
|
2670
|
-
:type prop_string: str
|
|
2671
2015
|
"""
|
|
2672
2016
|
|
|
2673
2017
|
def operator_preset_add(
|
|
@@ -2682,16 +2026,10 @@ def operator_preset_add(
|
|
|
2682
2026
|
) -> None:
|
|
2683
2027
|
"""Add or remove an Operator Preset
|
|
2684
2028
|
|
|
2685
|
-
:type execution_context: int | str | None
|
|
2686
|
-
:type undo: bool | None
|
|
2687
2029
|
:param name: Name, Name of the preset, used to make the path name
|
|
2688
|
-
:type name: str
|
|
2689
2030
|
:param remove_name: remove_name
|
|
2690
|
-
:type remove_name: bool | None
|
|
2691
2031
|
:param remove_active: remove_active
|
|
2692
|
-
:type remove_active: bool | None
|
|
2693
2032
|
:param operator: Operator
|
|
2694
|
-
:type operator: str
|
|
2695
2033
|
"""
|
|
2696
2034
|
|
|
2697
2035
|
def operator_presets_cleanup(
|
|
@@ -2705,12 +2043,8 @@ def operator_presets_cleanup(
|
|
|
2705
2043
|
) -> None:
|
|
2706
2044
|
"""Remove outdated operator properties from presets that may cause problems
|
|
2707
2045
|
|
|
2708
|
-
:type execution_context: int | str | None
|
|
2709
|
-
:type undo: bool | None
|
|
2710
2046
|
:param operator: operator
|
|
2711
|
-
:type operator: str
|
|
2712
2047
|
:param properties: properties
|
|
2713
|
-
:type properties: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2714
2048
|
"""
|
|
2715
2049
|
|
|
2716
2050
|
def owner_disable(
|
|
@@ -2722,10 +2056,7 @@ def owner_disable(
|
|
|
2722
2056
|
) -> None:
|
|
2723
2057
|
"""Disable add-on for workspace
|
|
2724
2058
|
|
|
2725
|
-
:type execution_context: int | str | None
|
|
2726
|
-
:type undo: bool | None
|
|
2727
2059
|
:param owner_id: UI Tag
|
|
2728
|
-
:type owner_id: str
|
|
2729
2060
|
"""
|
|
2730
2061
|
|
|
2731
2062
|
def owner_enable(
|
|
@@ -2737,10 +2068,7 @@ def owner_enable(
|
|
|
2737
2068
|
) -> None:
|
|
2738
2069
|
"""Enable add-on for workspace
|
|
2739
2070
|
|
|
2740
|
-
:type execution_context: int | str | None
|
|
2741
|
-
:type undo: bool | None
|
|
2742
2071
|
:param owner_id: UI Tag
|
|
2743
|
-
:type owner_id: str
|
|
2744
2072
|
"""
|
|
2745
2073
|
|
|
2746
2074
|
def path_open(
|
|
@@ -2752,10 +2080,7 @@ def path_open(
|
|
|
2752
2080
|
) -> None:
|
|
2753
2081
|
"""Open a path in a file browser
|
|
2754
2082
|
|
|
2755
|
-
:type execution_context: int | str | None
|
|
2756
|
-
:type undo: bool | None
|
|
2757
2083
|
:param filepath: filepath
|
|
2758
|
-
:type filepath: str
|
|
2759
2084
|
"""
|
|
2760
2085
|
|
|
2761
2086
|
def ply_export(
|
|
@@ -2807,46 +2132,25 @@ def ply_export(
|
|
|
2807
2132
|
) -> None:
|
|
2808
2133
|
"""Save the scene to a PLY file
|
|
2809
2134
|
|
|
2810
|
-
:type execution_context: int | str | None
|
|
2811
|
-
:type undo: bool | None
|
|
2812
2135
|
:param filepath: File Path, Path to file
|
|
2813
|
-
:type filepath: str
|
|
2814
2136
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2815
|
-
:type check_existing: bool | None
|
|
2816
2137
|
:param filter_blender: Filter .blend files
|
|
2817
|
-
:type filter_blender: bool | None
|
|
2818
2138
|
:param filter_backup: Filter .blend files
|
|
2819
|
-
:type filter_backup: bool | None
|
|
2820
2139
|
:param filter_image: Filter image files
|
|
2821
|
-
:type filter_image: bool | None
|
|
2822
2140
|
:param filter_movie: Filter movie files
|
|
2823
|
-
:type filter_movie: bool | None
|
|
2824
2141
|
:param filter_python: Filter Python files
|
|
2825
|
-
:type filter_python: bool | None
|
|
2826
2142
|
:param filter_font: Filter font files
|
|
2827
|
-
:type filter_font: bool | None
|
|
2828
2143
|
:param filter_sound: Filter sound files
|
|
2829
|
-
:type filter_sound: bool | None
|
|
2830
2144
|
:param filter_text: Filter text files
|
|
2831
|
-
:type filter_text: bool | None
|
|
2832
2145
|
:param filter_archive: Filter archive files
|
|
2833
|
-
:type filter_archive: bool | None
|
|
2834
2146
|
:param filter_btx: Filter btx files
|
|
2835
|
-
:type filter_btx: bool | None
|
|
2836
2147
|
:param filter_alembic: Filter Alembic files
|
|
2837
|
-
:type filter_alembic: bool | None
|
|
2838
2148
|
:param filter_usd: Filter USD files
|
|
2839
|
-
:type filter_usd: bool | None
|
|
2840
2149
|
:param filter_obj: Filter OBJ files
|
|
2841
|
-
:type filter_obj: bool | None
|
|
2842
2150
|
:param filter_volume: Filter OpenVDB volume files
|
|
2843
|
-
:type filter_volume: bool | None
|
|
2844
2151
|
:param filter_folder: Filter folders
|
|
2845
|
-
:type filter_folder: bool | None
|
|
2846
2152
|
:param filter_blenlib: Filter Blender IDs
|
|
2847
|
-
:type filter_blenlib: bool | None
|
|
2848
2153
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2849
|
-
:type filemode: int | None
|
|
2850
2154
|
:param display_type: Display Type
|
|
2851
2155
|
|
|
2852
2156
|
DEFAULT
|
|
@@ -2860,9 +2164,7 @@ def ply_export(
|
|
|
2860
2164
|
|
|
2861
2165
|
THUMBNAIL
|
|
2862
2166
|
Thumbnails -- Display files as thumbnails.
|
|
2863
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2864
2167
|
:param sort_method: File sorting mode
|
|
2865
|
-
:type sort_method: str | None
|
|
2866
2168
|
:param forward_axis: Forward Axis
|
|
2867
2169
|
|
|
2868
2170
|
X
|
|
@@ -2882,7 +2184,6 @@ def ply_export(
|
|
|
2882
2184
|
|
|
2883
2185
|
NEGATIVE_Z
|
|
2884
2186
|
-Z -- Negative Z axis.
|
|
2885
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2886
2187
|
:param up_axis: Up Axis
|
|
2887
2188
|
|
|
2888
2189
|
X
|
|
@@ -2902,19 +2203,12 @@ def ply_export(
|
|
|
2902
2203
|
|
|
2903
2204
|
NEGATIVE_Z
|
|
2904
2205
|
-Z -- Negative Z axis.
|
|
2905
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2906
2206
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2907
|
-
:type global_scale: float | None
|
|
2908
2207
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
2909
|
-
:type apply_modifiers: bool | None
|
|
2910
2208
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
2911
|
-
:type export_selected_objects: bool | None
|
|
2912
2209
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
2913
|
-
:type collection: str
|
|
2914
2210
|
:param export_uv: Export UVs
|
|
2915
|
-
:type export_uv: bool | None
|
|
2916
2211
|
:param export_normals: Export Vertex Normals, Export specific vertex normals if available, export calculated normals otherwise
|
|
2917
|
-
:type export_normals: bool | None
|
|
2918
2212
|
:param export_colors: Export Vertex Colors, Export vertex color attributes
|
|
2919
2213
|
|
|
2920
2214
|
NONE
|
|
@@ -2925,15 +2219,10 @@ def ply_export(
|
|
|
2925
2219
|
|
|
2926
2220
|
LINEAR
|
|
2927
2221
|
Linear -- Vertex colors in the file are in linear color space.
|
|
2928
|
-
:type export_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
2929
2222
|
:param export_attributes: Export Vertex Attributes, Export custom vertex attributes
|
|
2930
|
-
:type export_attributes: bool | None
|
|
2931
2223
|
:param export_triangulated_mesh: Export Triangulated Mesh, All ngons with four or more vertices will be triangulated. Meshes in the scene will not be affected. Behaves like Triangulate Modifier with ngon-method: "Beauty", quad-method: "Shortest Diagonal", min vertices: 4
|
|
2932
|
-
:type export_triangulated_mesh: bool | None
|
|
2933
2224
|
:param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
|
|
2934
|
-
:type ascii_format: bool | None
|
|
2935
2225
|
:param filter_glob: Extension Filter
|
|
2936
|
-
:type filter_glob: str
|
|
2937
2226
|
"""
|
|
2938
2227
|
|
|
2939
2228
|
def ply_import(
|
|
@@ -2983,50 +2272,27 @@ def ply_import(
|
|
|
2983
2272
|
) -> None:
|
|
2984
2273
|
"""Import an PLY file as an object
|
|
2985
2274
|
|
|
2986
|
-
:type execution_context: int | str | None
|
|
2987
|
-
:type undo: bool | None
|
|
2988
2275
|
:param filepath: File Path, Path to file
|
|
2989
|
-
:type filepath: str
|
|
2990
2276
|
:param directory: Directory, Directory of the file
|
|
2991
|
-
:type directory: str
|
|
2992
2277
|
:param files: Files
|
|
2993
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2994
2278
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2995
|
-
:type check_existing: bool | None
|
|
2996
2279
|
:param filter_blender: Filter .blend files
|
|
2997
|
-
:type filter_blender: bool | None
|
|
2998
2280
|
:param filter_backup: Filter .blend files
|
|
2999
|
-
:type filter_backup: bool | None
|
|
3000
2281
|
:param filter_image: Filter image files
|
|
3001
|
-
:type filter_image: bool | None
|
|
3002
2282
|
:param filter_movie: Filter movie files
|
|
3003
|
-
:type filter_movie: bool | None
|
|
3004
2283
|
:param filter_python: Filter Python files
|
|
3005
|
-
:type filter_python: bool | None
|
|
3006
2284
|
:param filter_font: Filter font files
|
|
3007
|
-
:type filter_font: bool | None
|
|
3008
2285
|
:param filter_sound: Filter sound files
|
|
3009
|
-
:type filter_sound: bool | None
|
|
3010
2286
|
:param filter_text: Filter text files
|
|
3011
|
-
:type filter_text: bool | None
|
|
3012
2287
|
:param filter_archive: Filter archive files
|
|
3013
|
-
:type filter_archive: bool | None
|
|
3014
2288
|
:param filter_btx: Filter btx files
|
|
3015
|
-
:type filter_btx: bool | None
|
|
3016
2289
|
:param filter_alembic: Filter Alembic files
|
|
3017
|
-
:type filter_alembic: bool | None
|
|
3018
2290
|
:param filter_usd: Filter USD files
|
|
3019
|
-
:type filter_usd: bool | None
|
|
3020
2291
|
:param filter_obj: Filter OBJ files
|
|
3021
|
-
:type filter_obj: bool | None
|
|
3022
2292
|
:param filter_volume: Filter OpenVDB volume files
|
|
3023
|
-
:type filter_volume: bool | None
|
|
3024
2293
|
:param filter_folder: Filter folders
|
|
3025
|
-
:type filter_folder: bool | None
|
|
3026
2294
|
:param filter_blenlib: Filter Blender IDs
|
|
3027
|
-
:type filter_blenlib: bool | None
|
|
3028
2295
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
3029
|
-
:type filemode: int | None
|
|
3030
2296
|
:param display_type: Display Type
|
|
3031
2297
|
|
|
3032
2298
|
DEFAULT
|
|
@@ -3040,13 +2306,9 @@ def ply_import(
|
|
|
3040
2306
|
|
|
3041
2307
|
THUMBNAIL
|
|
3042
2308
|
Thumbnails -- Display files as thumbnails.
|
|
3043
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3044
2309
|
:param sort_method: File sorting mode
|
|
3045
|
-
:type sort_method: str | None
|
|
3046
2310
|
:param global_scale: Scale
|
|
3047
|
-
:type global_scale: float | None
|
|
3048
2311
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
3049
|
-
:type use_scene_unit: bool | None
|
|
3050
2312
|
:param forward_axis: Forward Axis
|
|
3051
2313
|
|
|
3052
2314
|
X
|
|
@@ -3066,7 +2328,6 @@ def ply_import(
|
|
|
3066
2328
|
|
|
3067
2329
|
NEGATIVE_Z
|
|
3068
2330
|
-Z -- Negative Z axis.
|
|
3069
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
3070
2331
|
:param up_axis: Up Axis
|
|
3071
2332
|
|
|
3072
2333
|
X
|
|
@@ -3086,9 +2347,7 @@ def ply_import(
|
|
|
3086
2347
|
|
|
3087
2348
|
NEGATIVE_Z
|
|
3088
2349
|
-Z -- Negative Z axis.
|
|
3089
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
3090
2350
|
:param merge_verts: Merge Vertices, Merges vertices by distance
|
|
3091
|
-
:type merge_verts: bool | None
|
|
3092
2351
|
:param import_colors: Vertex Colors, Import vertex color attributes
|
|
3093
2352
|
|
|
3094
2353
|
NONE
|
|
@@ -3099,11 +2358,8 @@ def ply_import(
|
|
|
3099
2358
|
|
|
3100
2359
|
LINEAR
|
|
3101
2360
|
Linear -- Vertex colors in the file are in linear color space.
|
|
3102
|
-
:type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
3103
2361
|
:param import_attributes: Vertex Attributes, Import custom vertex attributes
|
|
3104
|
-
:type import_attributes: bool | None
|
|
3105
2362
|
:param filter_glob: Extension Filter
|
|
3106
|
-
:type filter_glob: str
|
|
3107
2363
|
"""
|
|
3108
2364
|
|
|
3109
2365
|
def previews_batch_clear(
|
|
@@ -3125,28 +2381,16 @@ def previews_batch_clear(
|
|
|
3125
2381
|
) -> None:
|
|
3126
2382
|
"""Clear selected .blend files previews
|
|
3127
2383
|
|
|
3128
|
-
:type execution_context: int | str | None
|
|
3129
|
-
:type undo: bool | None
|
|
3130
2384
|
:param files: files
|
|
3131
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
3132
2385
|
:param directory: directory
|
|
3133
|
-
:type directory: str
|
|
3134
2386
|
:param filter_blender: filter_blender
|
|
3135
|
-
:type filter_blender: bool | None
|
|
3136
2387
|
:param filter_folder: filter_folder
|
|
3137
|
-
:type filter_folder: bool | None
|
|
3138
2388
|
:param use_scenes: Scenes, Clear scenes previews
|
|
3139
|
-
:type use_scenes: bool | None
|
|
3140
2389
|
:param use_collections: Collections, Clear collections previews
|
|
3141
|
-
:type use_collections: bool | None
|
|
3142
2390
|
:param use_objects: Objects, Clear objects previews
|
|
3143
|
-
:type use_objects: bool | None
|
|
3144
2391
|
:param use_intern_data: Materials & Textures, Clear internal previews (materials, textures, images, etc.)
|
|
3145
|
-
:type use_intern_data: bool | None
|
|
3146
2392
|
:param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
|
|
3147
|
-
:type use_trusted: bool | None
|
|
3148
2393
|
:param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with cleared previews
|
|
3149
|
-
:type use_backups: bool | None
|
|
3150
2394
|
"""
|
|
3151
2395
|
|
|
3152
2396
|
def previews_batch_generate(
|
|
@@ -3168,28 +2412,16 @@ def previews_batch_generate(
|
|
|
3168
2412
|
) -> None:
|
|
3169
2413
|
"""Generate selected .blend files previews
|
|
3170
2414
|
|
|
3171
|
-
:type execution_context: int | str | None
|
|
3172
|
-
:type undo: bool | None
|
|
3173
2415
|
:param files: Collection of file paths with common directory root
|
|
3174
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
3175
2416
|
:param directory: Root path of all files listed in files collection
|
|
3176
|
-
:type directory: str
|
|
3177
2417
|
:param filter_blender: Show Blender files in the File Browser
|
|
3178
|
-
:type filter_blender: bool | None
|
|
3179
2418
|
:param filter_folder: Show folders in the File Browser
|
|
3180
|
-
:type filter_folder: bool | None
|
|
3181
2419
|
:param use_scenes: Scenes, Generate scenes previews
|
|
3182
|
-
:type use_scenes: bool | None
|
|
3183
2420
|
:param use_collections: Collections, Generate collections previews
|
|
3184
|
-
:type use_collections: bool | None
|
|
3185
2421
|
:param use_objects: Objects, Generate objects previews
|
|
3186
|
-
:type use_objects: bool | None
|
|
3187
2422
|
:param use_intern_data: Materials & Textures, Generate internal previews (materials, textures, images, etc.)
|
|
3188
|
-
:type use_intern_data: bool | None
|
|
3189
2423
|
:param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
|
|
3190
|
-
:type use_trusted: bool | None
|
|
3191
2424
|
:param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with generated previews
|
|
3192
|
-
:type use_backups: bool | None
|
|
3193
2425
|
"""
|
|
3194
2426
|
|
|
3195
2427
|
def previews_clear(
|
|
@@ -3216,8 +2448,6 @@ def previews_clear(
|
|
|
3216
2448
|
) -> None:
|
|
3217
2449
|
"""Clear data-block previews (only for some types like objects, materials, textures, etc.)
|
|
3218
2450
|
|
|
3219
|
-
:type execution_context: int | str | None
|
|
3220
|
-
:type undo: bool | None
|
|
3221
2451
|
:param id_type: Data-Block Type, Which data-block previews to clear
|
|
3222
2452
|
|
|
3223
2453
|
ALL
|
|
@@ -3252,7 +2482,6 @@ def previews_clear(
|
|
|
3252
2482
|
|
|
3253
2483
|
IMAGE
|
|
3254
2484
|
Images.
|
|
3255
|
-
:type id_type: set[typing.Literal['ALL','GEOMETRY','SHADING','SCENE','COLLECTION','OBJECT','MATERIAL','LIGHT','WORLD','TEXTURE','IMAGE']] | None
|
|
3256
2485
|
"""
|
|
3257
2486
|
|
|
3258
2487
|
def previews_ensure(
|
|
@@ -3260,11 +2489,7 @@ def previews_ensure(
|
|
|
3260
2489
|
undo: bool | None = None,
|
|
3261
2490
|
/,
|
|
3262
2491
|
) -> None:
|
|
3263
|
-
"""Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)
|
|
3264
|
-
|
|
3265
|
-
:type execution_context: int | str | None
|
|
3266
|
-
:type undo: bool | None
|
|
3267
|
-
"""
|
|
2492
|
+
"""Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)"""
|
|
3268
2493
|
|
|
3269
2494
|
def properties_add(
|
|
3270
2495
|
execution_context: int | str | None = None,
|
|
@@ -3275,10 +2500,7 @@ def properties_add(
|
|
|
3275
2500
|
) -> None:
|
|
3276
2501
|
"""Add your own property to the data-block
|
|
3277
2502
|
|
|
3278
|
-
:type execution_context: int | str | None
|
|
3279
|
-
:type undo: bool | None
|
|
3280
2503
|
:param data_path: Property Edit, Property data_path edit
|
|
3281
|
-
:type data_path: str
|
|
3282
2504
|
"""
|
|
3283
2505
|
|
|
3284
2506
|
def properties_context_change(
|
|
@@ -3290,10 +2512,7 @@ def properties_context_change(
|
|
|
3290
2512
|
) -> None:
|
|
3291
2513
|
"""Jump to a different tab inside the properties editor
|
|
3292
2514
|
|
|
3293
|
-
:type execution_context: int | str | None
|
|
3294
|
-
:type undo: bool | None
|
|
3295
2515
|
:param context: Context
|
|
3296
|
-
:type context: str
|
|
3297
2516
|
"""
|
|
3298
2517
|
|
|
3299
2518
|
def properties_edit(
|
|
@@ -3480,12 +2699,8 @@ def properties_edit(
|
|
|
3480
2699
|
) -> None:
|
|
3481
2700
|
"""Change a custom propertys type, or adjust how it is displayed in the interface
|
|
3482
2701
|
|
|
3483
|
-
:type execution_context: int | str | None
|
|
3484
|
-
:type undo: bool | None
|
|
3485
2702
|
:param data_path: Property Edit, Property data_path edit
|
|
3486
|
-
:type data_path: str
|
|
3487
2703
|
:param property_name: Property Name, Property name edit
|
|
3488
|
-
:type property_name: str
|
|
3489
2704
|
:param property_type: Type
|
|
3490
2705
|
|
|
3491
2706
|
FLOAT
|
|
@@ -3514,51 +2729,28 @@ def properties_edit(
|
|
|
3514
2729
|
|
|
3515
2730
|
PYTHON
|
|
3516
2731
|
Python -- Edit a Python value directly, for unsupported property types.
|
|
3517
|
-
:type property_type: typing.Literal['FLOAT','FLOAT_ARRAY','INT','INT_ARRAY','BOOL','BOOL_ARRAY','STRING','DATA_BLOCK','PYTHON'] | None
|
|
3518
2732
|
:param is_overridable_library: Library Overridable, Allow the property to be overridden when the data-block is linked
|
|
3519
|
-
:type is_overridable_library: bool | None
|
|
3520
2733
|
:param description: Description
|
|
3521
|
-
:type description: str
|
|
3522
2734
|
:param use_soft_limits: Soft Limits, Limits the Property Value slider to a range, values outside the range must be inputted numerically
|
|
3523
|
-
:type use_soft_limits: bool | None
|
|
3524
2735
|
:param array_length: Array Length
|
|
3525
|
-
:type array_length: int | None
|
|
3526
2736
|
:param default_int: Default Value
|
|
3527
|
-
:type default_int: collections.abc.Iterable[int] | None
|
|
3528
2737
|
:param min_int: Min
|
|
3529
|
-
:type min_int: int | None
|
|
3530
2738
|
:param max_int: Max
|
|
3531
|
-
:type max_int: int | None
|
|
3532
2739
|
:param soft_min_int: Soft Min
|
|
3533
|
-
:type soft_min_int: int | None
|
|
3534
2740
|
:param soft_max_int: Soft Max
|
|
3535
|
-
:type soft_max_int: int | None
|
|
3536
2741
|
:param step_int: Step
|
|
3537
|
-
:type step_int: int | None
|
|
3538
2742
|
:param default_bool: Default Value
|
|
3539
|
-
:type default_bool: collections.abc.Iterable[bool] | None
|
|
3540
2743
|
:param default_float: Default Value
|
|
3541
|
-
:type default_float: collections.abc.Iterable[float] | None
|
|
3542
2744
|
:param min_float: Min
|
|
3543
|
-
:type min_float: float | None
|
|
3544
2745
|
:param max_float: Max
|
|
3545
|
-
:type max_float: float | None
|
|
3546
2746
|
:param soft_min_float: Soft Min
|
|
3547
|
-
:type soft_min_float: float | None
|
|
3548
2747
|
:param soft_max_float: Soft Max
|
|
3549
|
-
:type soft_max_float: float | None
|
|
3550
2748
|
:param precision: Precision
|
|
3551
|
-
:type precision: int | None
|
|
3552
2749
|
:param step_float: Step
|
|
3553
|
-
:type step_float: float | None
|
|
3554
2750
|
:param subtype: Subtype
|
|
3555
|
-
:type subtype: str | None
|
|
3556
2751
|
:param default_string: Default Value
|
|
3557
|
-
:type default_string: str
|
|
3558
2752
|
:param id_type: ID Type
|
|
3559
|
-
:type id_type: typing.Literal['ACTION','ARMATURE','BRUSH','CACHEFILE','CAMERA','COLLECTION','CURVE','CURVES','FONT','GREASEPENCIL','GREASEPENCIL_V3','IMAGE','KEY','LATTICE','LIBRARY','LIGHT','LIGHT_PROBE','LINESTYLE','MASK','MATERIAL','MESH','META','MOVIECLIP','NODETREE','OBJECT','PAINTCURVE','PALETTE','PARTICLE','POINTCLOUD','SCENE','SCREEN','SOUND','SPEAKER','TEXT','TEXTURE','VOLUME','WINDOWMANAGER','WORKSPACE','WORLD'] | None
|
|
3560
2753
|
:param eval_string: Value, Python value for unsupported custom property types
|
|
3561
|
-
:type eval_string: str
|
|
3562
2754
|
"""
|
|
3563
2755
|
|
|
3564
2756
|
def properties_edit_value(
|
|
@@ -3572,14 +2764,9 @@ def properties_edit_value(
|
|
|
3572
2764
|
) -> None:
|
|
3573
2765
|
"""Edit the value of a custom property
|
|
3574
2766
|
|
|
3575
|
-
:type execution_context: int | str | None
|
|
3576
|
-
:type undo: bool | None
|
|
3577
2767
|
:param data_path: Property Edit, Property data_path edit
|
|
3578
|
-
:type data_path: str
|
|
3579
2768
|
:param property_name: Property Name, Property name edit
|
|
3580
|
-
:type property_name: str
|
|
3581
2769
|
:param eval_string: Value, Value for custom property types that can only be edited as a Python expression
|
|
3582
|
-
:type eval_string: str
|
|
3583
2770
|
"""
|
|
3584
2771
|
|
|
3585
2772
|
def properties_remove(
|
|
@@ -3592,12 +2779,8 @@ def properties_remove(
|
|
|
3592
2779
|
) -> None:
|
|
3593
2780
|
"""Internal use (edit a property data_path)
|
|
3594
2781
|
|
|
3595
|
-
:type execution_context: int | str | None
|
|
3596
|
-
:type undo: bool | None
|
|
3597
2782
|
:param data_path: Property Edit, Property data_path edit
|
|
3598
|
-
:type data_path: str
|
|
3599
2783
|
:param property_name: Property Name, Property name edit
|
|
3600
|
-
:type property_name: str
|
|
3601
2784
|
"""
|
|
3602
2785
|
|
|
3603
2786
|
def quit_blender(
|
|
@@ -3605,11 +2788,7 @@ def quit_blender(
|
|
|
3605
2788
|
undo: bool | None = None,
|
|
3606
2789
|
/,
|
|
3607
2790
|
) -> None:
|
|
3608
|
-
"""Quit Blender
|
|
3609
|
-
|
|
3610
|
-
:type execution_context: int | str | None
|
|
3611
|
-
:type undo: bool | None
|
|
3612
|
-
"""
|
|
2791
|
+
"""Quit Blender"""
|
|
3613
2792
|
|
|
3614
2793
|
def radial_control(
|
|
3615
2794
|
execution_context: int | str | None = None,
|
|
@@ -3631,32 +2810,18 @@ def radial_control(
|
|
|
3631
2810
|
) -> None:
|
|
3632
2811
|
"""Set some size property (e.g. brush size) with mouse wheel
|
|
3633
2812
|
|
|
3634
|
-
:type execution_context: int | str | None
|
|
3635
|
-
:type undo: bool | None
|
|
3636
2813
|
:param data_path_primary: Primary Data Path, Primary path of property to be set by the radial control
|
|
3637
|
-
:type data_path_primary: str
|
|
3638
2814
|
:param data_path_secondary: Secondary Data Path, Secondary path of property to be set by the radial control
|
|
3639
|
-
:type data_path_secondary: str
|
|
3640
2815
|
:param use_secondary: Use Secondary, Path of property to select between the primary and secondary data paths
|
|
3641
|
-
:type use_secondary: str
|
|
3642
2816
|
:param rotation_path: Rotation Path, Path of property used to rotate the texture display
|
|
3643
|
-
:type rotation_path: str
|
|
3644
2817
|
:param color_path: Color Path, Path of property used to set the color of the control
|
|
3645
|
-
:type color_path: str
|
|
3646
2818
|
:param fill_color_path: Fill Color Path, Path of property used to set the fill color of the control
|
|
3647
|
-
:type fill_color_path: str
|
|
3648
2819
|
:param fill_color_override_path: Fill Color Override Path
|
|
3649
|
-
:type fill_color_override_path: str
|
|
3650
2820
|
:param fill_color_override_test_path: Fill Color Override Test
|
|
3651
|
-
:type fill_color_override_test_path: str
|
|
3652
2821
|
:param zoom_path: Zoom Path, Path of property used to set the zoom level for the control
|
|
3653
|
-
:type zoom_path: str
|
|
3654
2822
|
:param image_id: Image ID, Path of ID that is used to generate an image for the control
|
|
3655
|
-
:type image_id: str
|
|
3656
2823
|
:param secondary_tex: Secondary Texture, Tweak brush secondary/mask texture
|
|
3657
|
-
:type secondary_tex: bool | None
|
|
3658
2824
|
:param release_confirm: Confirm On Release, Finish operation on key release
|
|
3659
|
-
:type release_confirm: bool | None
|
|
3660
2825
|
"""
|
|
3661
2826
|
|
|
3662
2827
|
def read_factory_settings(
|
|
@@ -3670,13 +2835,8 @@ def read_factory_settings(
|
|
|
3670
2835
|
) -> None:
|
|
3671
2836
|
"""Load factory default startup file and preferences. To make changes permanent, use "Save Startup File" and "Save Preferences"
|
|
3672
2837
|
|
|
3673
|
-
:type execution_context: int | str | None
|
|
3674
|
-
:type undo: bool | None
|
|
3675
2838
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3676
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3677
|
-
:type app_template: str
|
|
3678
2839
|
:param use_empty: Empty, After loading, remove everything except scenes, windows, and workspaces. This makes it possible to load the startup file with its scene configuration and window layout intact, but no objects, materials, animations, ...
|
|
3679
|
-
:type use_empty: bool | None
|
|
3680
2840
|
"""
|
|
3681
2841
|
|
|
3682
2842
|
def read_factory_userpref(
|
|
@@ -3688,10 +2848,7 @@ def read_factory_userpref(
|
|
|
3688
2848
|
) -> None:
|
|
3689
2849
|
"""Load factory default preferences. To make changes to preferences permanent, use "Save Preferences"
|
|
3690
2850
|
|
|
3691
|
-
:type execution_context: int | str | None
|
|
3692
|
-
:type undo: bool | None
|
|
3693
2851
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3694
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3695
2852
|
"""
|
|
3696
2853
|
|
|
3697
2854
|
def read_history(
|
|
@@ -3699,11 +2856,7 @@ def read_history(
|
|
|
3699
2856
|
undo: bool | None = None,
|
|
3700
2857
|
/,
|
|
3701
2858
|
) -> None:
|
|
3702
|
-
"""Reloads history and bookmarks
|
|
3703
|
-
|
|
3704
|
-
:type execution_context: int | str | None
|
|
3705
|
-
:type undo: bool | None
|
|
3706
|
-
"""
|
|
2859
|
+
"""Reloads history and bookmarks"""
|
|
3707
2860
|
|
|
3708
2861
|
def read_homefile(
|
|
3709
2862
|
execution_context: int | str | None = None,
|
|
@@ -3720,21 +2873,12 @@ def read_homefile(
|
|
|
3720
2873
|
) -> None:
|
|
3721
2874
|
"""Open the default file
|
|
3722
2875
|
|
|
3723
|
-
:type execution_context: int | str | None
|
|
3724
|
-
:type undo: bool | None
|
|
3725
2876
|
:param filepath: File Path, Path to an alternative start-up file
|
|
3726
|
-
:type filepath: str
|
|
3727
2877
|
:param load_ui: Load UI, Load user interface setup from the .blend file
|
|
3728
|
-
:type load_ui: bool | None
|
|
3729
2878
|
:param use_splash: Splash
|
|
3730
|
-
:type use_splash: bool | None
|
|
3731
2879
|
:param use_factory_startup: Factory Startup, Load the default (factory startup) blend file. This is independent of the normal start-up file that the user can save
|
|
3732
|
-
:type use_factory_startup: bool | None
|
|
3733
2880
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3734
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3735
|
-
:type app_template: str
|
|
3736
2881
|
:param use_empty: Empty, After loading, remove everything except scenes, windows, and workspaces. This makes it possible to load the startup file with its scene configuration and window layout intact, but no objects, materials, animations, ...
|
|
3737
|
-
:type use_empty: bool | None
|
|
3738
2882
|
"""
|
|
3739
2883
|
|
|
3740
2884
|
def read_userpref(
|
|
@@ -3742,11 +2886,7 @@ def read_userpref(
|
|
|
3742
2886
|
undo: bool | None = None,
|
|
3743
2887
|
/,
|
|
3744
2888
|
) -> None:
|
|
3745
|
-
"""Load last saved preferences
|
|
3746
|
-
|
|
3747
|
-
:type execution_context: int | str | None
|
|
3748
|
-
:type undo: bool | None
|
|
3749
|
-
"""
|
|
2889
|
+
"""Load last saved preferences"""
|
|
3750
2890
|
|
|
3751
2891
|
def recover_auto_save(
|
|
3752
2892
|
execution_context: int | str | None = None,
|
|
@@ -3782,48 +2922,26 @@ def recover_auto_save(
|
|
|
3782
2922
|
) -> None:
|
|
3783
2923
|
"""Open an automatically saved file to recover it
|
|
3784
2924
|
|
|
3785
|
-
:type execution_context: int | str | None
|
|
3786
|
-
:type undo: bool | None
|
|
3787
2925
|
:param filepath: File Path, Path to file
|
|
3788
|
-
:type filepath: str
|
|
3789
2926
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
3790
|
-
:type hide_props_region: bool | None
|
|
3791
2927
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
3792
|
-
:type check_existing: bool | None
|
|
3793
2928
|
:param filter_blender: Filter .blend files
|
|
3794
|
-
:type filter_blender: bool | None
|
|
3795
2929
|
:param filter_backup: Filter .blend files
|
|
3796
|
-
:type filter_backup: bool | None
|
|
3797
2930
|
:param filter_image: Filter image files
|
|
3798
|
-
:type filter_image: bool | None
|
|
3799
2931
|
:param filter_movie: Filter movie files
|
|
3800
|
-
:type filter_movie: bool | None
|
|
3801
2932
|
:param filter_python: Filter Python files
|
|
3802
|
-
:type filter_python: bool | None
|
|
3803
2933
|
:param filter_font: Filter font files
|
|
3804
|
-
:type filter_font: bool | None
|
|
3805
2934
|
:param filter_sound: Filter sound files
|
|
3806
|
-
:type filter_sound: bool | None
|
|
3807
2935
|
:param filter_text: Filter text files
|
|
3808
|
-
:type filter_text: bool | None
|
|
3809
2936
|
:param filter_archive: Filter archive files
|
|
3810
|
-
:type filter_archive: bool | None
|
|
3811
2937
|
:param filter_btx: Filter btx files
|
|
3812
|
-
:type filter_btx: bool | None
|
|
3813
2938
|
:param filter_alembic: Filter Alembic files
|
|
3814
|
-
:type filter_alembic: bool | None
|
|
3815
2939
|
:param filter_usd: Filter USD files
|
|
3816
|
-
:type filter_usd: bool | None
|
|
3817
2940
|
:param filter_obj: Filter OBJ files
|
|
3818
|
-
:type filter_obj: bool | None
|
|
3819
2941
|
:param filter_volume: Filter OpenVDB volume files
|
|
3820
|
-
:type filter_volume: bool | None
|
|
3821
2942
|
:param filter_folder: Filter folders
|
|
3822
|
-
:type filter_folder: bool | None
|
|
3823
2943
|
:param filter_blenlib: Filter Blender IDs
|
|
3824
|
-
:type filter_blenlib: bool | None
|
|
3825
2944
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
3826
|
-
:type filemode: int | None
|
|
3827
2945
|
:param display_type: Display Type
|
|
3828
2946
|
|
|
3829
2947
|
DEFAULT
|
|
@@ -3837,11 +2955,8 @@ def recover_auto_save(
|
|
|
3837
2955
|
|
|
3838
2956
|
THUMBNAIL
|
|
3839
2957
|
Thumbnails -- Display files as thumbnails.
|
|
3840
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3841
2958
|
:param sort_method: File sorting mode
|
|
3842
|
-
:type sort_method: str | None
|
|
3843
2959
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3844
|
-
:type use_scripts: bool | None
|
|
3845
2960
|
"""
|
|
3846
2961
|
|
|
3847
2962
|
def recover_last_session(
|
|
@@ -3853,10 +2968,7 @@ def recover_last_session(
|
|
|
3853
2968
|
) -> None:
|
|
3854
2969
|
"""Open the last closed file ("quit.blend")
|
|
3855
2970
|
|
|
3856
|
-
:type execution_context: int | str | None
|
|
3857
|
-
:type undo: bool | None
|
|
3858
2971
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3859
|
-
:type use_scripts: bool | None
|
|
3860
2972
|
"""
|
|
3861
2973
|
|
|
3862
2974
|
def redraw_timer(
|
|
@@ -3879,8 +2991,6 @@ def redraw_timer(
|
|
|
3879
2991
|
) -> None:
|
|
3880
2992
|
"""Simple redraw timer to test the speed of updating the interface
|
|
3881
2993
|
|
|
3882
|
-
:type execution_context: int | str | None
|
|
3883
|
-
:type undo: bool | None
|
|
3884
2994
|
:param type: Type
|
|
3885
2995
|
|
|
3886
2996
|
DRAW
|
|
@@ -3903,11 +3013,8 @@ def redraw_timer(
|
|
|
3903
3013
|
|
|
3904
3014
|
UNDO
|
|
3905
3015
|
Undo/Redo -- Undo and redo.
|
|
3906
|
-
:type type: typing.Literal['DRAW','DRAW_SWAP','DRAW_WIN','DRAW_WIN_SWAP','ANIM_STEP','ANIM_PLAY','UNDO'] | None
|
|
3907
3016
|
:param iterations: Iterations, Number of times to redraw
|
|
3908
|
-
:type iterations: int | None
|
|
3909
3017
|
:param time_limit: Time Limit, Seconds to run the test for (override iterations)
|
|
3910
|
-
:type time_limit: float | None
|
|
3911
3018
|
"""
|
|
3912
3019
|
|
|
3913
3020
|
def revert_mainfile(
|
|
@@ -3919,10 +3026,7 @@ def revert_mainfile(
|
|
|
3919
3026
|
) -> None:
|
|
3920
3027
|
"""Reload the saved file
|
|
3921
3028
|
|
|
3922
|
-
:type execution_context: int | str | None
|
|
3923
|
-
:type undo: bool | None
|
|
3924
3029
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3925
|
-
:type use_scripts: bool | None
|
|
3926
3030
|
"""
|
|
3927
3031
|
|
|
3928
3032
|
def save_as_mainfile(
|
|
@@ -3961,48 +3065,26 @@ def save_as_mainfile(
|
|
|
3961
3065
|
) -> None:
|
|
3962
3066
|
"""Save the current file in the desired location
|
|
3963
3067
|
|
|
3964
|
-
:type execution_context: int | str | None
|
|
3965
|
-
:type undo: bool | None
|
|
3966
3068
|
:param filepath: File Path, Path to file
|
|
3967
|
-
:type filepath: str
|
|
3968
3069
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
3969
|
-
:type hide_props_region: bool | None
|
|
3970
3070
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
3971
|
-
:type check_existing: bool | None
|
|
3972
3071
|
:param filter_blender: Filter .blend files
|
|
3973
|
-
:type filter_blender: bool | None
|
|
3974
3072
|
:param filter_backup: Filter .blend files
|
|
3975
|
-
:type filter_backup: bool | None
|
|
3976
3073
|
:param filter_image: Filter image files
|
|
3977
|
-
:type filter_image: bool | None
|
|
3978
3074
|
:param filter_movie: Filter movie files
|
|
3979
|
-
:type filter_movie: bool | None
|
|
3980
3075
|
:param filter_python: Filter Python files
|
|
3981
|
-
:type filter_python: bool | None
|
|
3982
3076
|
:param filter_font: Filter font files
|
|
3983
|
-
:type filter_font: bool | None
|
|
3984
3077
|
:param filter_sound: Filter sound files
|
|
3985
|
-
:type filter_sound: bool | None
|
|
3986
3078
|
:param filter_text: Filter text files
|
|
3987
|
-
:type filter_text: bool | None
|
|
3988
3079
|
:param filter_archive: Filter archive files
|
|
3989
|
-
:type filter_archive: bool | None
|
|
3990
3080
|
:param filter_btx: Filter btx files
|
|
3991
|
-
:type filter_btx: bool | None
|
|
3992
3081
|
:param filter_alembic: Filter Alembic files
|
|
3993
|
-
:type filter_alembic: bool | None
|
|
3994
3082
|
:param filter_usd: Filter USD files
|
|
3995
|
-
:type filter_usd: bool | None
|
|
3996
3083
|
:param filter_obj: Filter OBJ files
|
|
3997
|
-
:type filter_obj: bool | None
|
|
3998
3084
|
:param filter_volume: Filter OpenVDB volume files
|
|
3999
|
-
:type filter_volume: bool | None
|
|
4000
3085
|
:param filter_folder: Filter folders
|
|
4001
|
-
:type filter_folder: bool | None
|
|
4002
3086
|
:param filter_blenlib: Filter Blender IDs
|
|
4003
|
-
:type filter_blenlib: bool | None
|
|
4004
3087
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4005
|
-
:type filemode: int | None
|
|
4006
3088
|
:param display_type: Display Type
|
|
4007
3089
|
|
|
4008
3090
|
DEFAULT
|
|
@@ -4016,15 +3098,10 @@ def save_as_mainfile(
|
|
|
4016
3098
|
|
|
4017
3099
|
THUMBNAIL
|
|
4018
3100
|
Thumbnails -- Display files as thumbnails.
|
|
4019
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4020
3101
|
:param sort_method: File sorting mode
|
|
4021
|
-
:type sort_method: str | None
|
|
4022
3102
|
:param compress: Compress, Write compressed .blend file
|
|
4023
|
-
:type compress: bool | None
|
|
4024
3103
|
:param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
|
|
4025
|
-
:type relative_remap: bool | None
|
|
4026
3104
|
:param copy: Save Copy, Save a copy of the actual working state but does not make saved file active
|
|
4027
|
-
:type copy: bool | None
|
|
4028
3105
|
"""
|
|
4029
3106
|
|
|
4030
3107
|
def save_homefile(
|
|
@@ -4032,11 +3109,7 @@ def save_homefile(
|
|
|
4032
3109
|
undo: bool | None = None,
|
|
4033
3110
|
/,
|
|
4034
3111
|
) -> None:
|
|
4035
|
-
"""Make the current file the default startup file
|
|
4036
|
-
|
|
4037
|
-
:type execution_context: int | str | None
|
|
4038
|
-
:type undo: bool | None
|
|
4039
|
-
"""
|
|
3112
|
+
"""Make the current file the default startup file"""
|
|
4040
3113
|
|
|
4041
3114
|
def save_mainfile(
|
|
4042
3115
|
execution_context: int | str | None = None,
|
|
@@ -4075,48 +3148,26 @@ def save_mainfile(
|
|
|
4075
3148
|
) -> None:
|
|
4076
3149
|
"""Save the current Blender file
|
|
4077
3150
|
|
|
4078
|
-
:type execution_context: int | str | None
|
|
4079
|
-
:type undo: bool | None
|
|
4080
3151
|
:param filepath: File Path, Path to file
|
|
4081
|
-
:type filepath: str
|
|
4082
3152
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
4083
|
-
:type hide_props_region: bool | None
|
|
4084
3153
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4085
|
-
:type check_existing: bool | None
|
|
4086
3154
|
:param filter_blender: Filter .blend files
|
|
4087
|
-
:type filter_blender: bool | None
|
|
4088
3155
|
:param filter_backup: Filter .blend files
|
|
4089
|
-
:type filter_backup: bool | None
|
|
4090
3156
|
:param filter_image: Filter image files
|
|
4091
|
-
:type filter_image: bool | None
|
|
4092
3157
|
:param filter_movie: Filter movie files
|
|
4093
|
-
:type filter_movie: bool | None
|
|
4094
3158
|
:param filter_python: Filter Python files
|
|
4095
|
-
:type filter_python: bool | None
|
|
4096
3159
|
:param filter_font: Filter font files
|
|
4097
|
-
:type filter_font: bool | None
|
|
4098
3160
|
:param filter_sound: Filter sound files
|
|
4099
|
-
:type filter_sound: bool | None
|
|
4100
3161
|
:param filter_text: Filter text files
|
|
4101
|
-
:type filter_text: bool | None
|
|
4102
3162
|
:param filter_archive: Filter archive files
|
|
4103
|
-
:type filter_archive: bool | None
|
|
4104
3163
|
:param filter_btx: Filter btx files
|
|
4105
|
-
:type filter_btx: bool | None
|
|
4106
3164
|
:param filter_alembic: Filter Alembic files
|
|
4107
|
-
:type filter_alembic: bool | None
|
|
4108
3165
|
:param filter_usd: Filter USD files
|
|
4109
|
-
:type filter_usd: bool | None
|
|
4110
3166
|
:param filter_obj: Filter OBJ files
|
|
4111
|
-
:type filter_obj: bool | None
|
|
4112
3167
|
:param filter_volume: Filter OpenVDB volume files
|
|
4113
|
-
:type filter_volume: bool | None
|
|
4114
3168
|
:param filter_folder: Filter folders
|
|
4115
|
-
:type filter_folder: bool | None
|
|
4116
3169
|
:param filter_blenlib: Filter Blender IDs
|
|
4117
|
-
:type filter_blenlib: bool | None
|
|
4118
3170
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4119
|
-
:type filemode: int | None
|
|
4120
3171
|
:param display_type: Display Type
|
|
4121
3172
|
|
|
4122
3173
|
DEFAULT
|
|
@@ -4130,17 +3181,11 @@ def save_mainfile(
|
|
|
4130
3181
|
|
|
4131
3182
|
THUMBNAIL
|
|
4132
3183
|
Thumbnails -- Display files as thumbnails.
|
|
4133
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4134
3184
|
:param sort_method: File sorting mode
|
|
4135
|
-
:type sort_method: str | None
|
|
4136
3185
|
:param compress: Compress, Write compressed .blend file
|
|
4137
|
-
:type compress: bool | None
|
|
4138
3186
|
:param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
|
|
4139
|
-
:type relative_remap: bool | None
|
|
4140
3187
|
:param exit: Exit, Exit Blender after saving
|
|
4141
|
-
:type exit: bool | None
|
|
4142
3188
|
:param incremental: Incremental, Save the current Blender file with a numerically incremented name that does not overwrite any existing files
|
|
4143
|
-
:type incremental: bool | None
|
|
4144
3189
|
"""
|
|
4145
3190
|
|
|
4146
3191
|
def save_userpref(
|
|
@@ -4148,33 +3193,21 @@ def save_userpref(
|
|
|
4148
3193
|
undo: bool | None = None,
|
|
4149
3194
|
/,
|
|
4150
3195
|
) -> None:
|
|
4151
|
-
"""Make the current preferences default
|
|
4152
|
-
|
|
4153
|
-
:type execution_context: int | str | None
|
|
4154
|
-
:type undo: bool | None
|
|
4155
|
-
"""
|
|
3196
|
+
"""Make the current preferences default"""
|
|
4156
3197
|
|
|
4157
3198
|
def search_menu(
|
|
4158
3199
|
execution_context: int | str | None = None,
|
|
4159
3200
|
undo: bool | None = None,
|
|
4160
3201
|
/,
|
|
4161
3202
|
) -> None:
|
|
4162
|
-
"""Pop-up a search over all menus in the current context
|
|
4163
|
-
|
|
4164
|
-
:type execution_context: int | str | None
|
|
4165
|
-
:type undo: bool | None
|
|
4166
|
-
"""
|
|
3203
|
+
"""Pop-up a search over all menus in the current context"""
|
|
4167
3204
|
|
|
4168
3205
|
def search_operator(
|
|
4169
3206
|
execution_context: int | str | None = None,
|
|
4170
3207
|
undo: bool | None = None,
|
|
4171
3208
|
/,
|
|
4172
3209
|
) -> None:
|
|
4173
|
-
"""Pop-up a search over all available operators in current context
|
|
4174
|
-
|
|
4175
|
-
:type execution_context: int | str | None
|
|
4176
|
-
:type undo: bool | None
|
|
4177
|
-
"""
|
|
3210
|
+
"""Pop-up a search over all available operators in current context"""
|
|
4178
3211
|
|
|
4179
3212
|
def search_single_menu(
|
|
4180
3213
|
execution_context: int | str | None = None,
|
|
@@ -4186,12 +3219,8 @@ def search_single_menu(
|
|
|
4186
3219
|
) -> None:
|
|
4187
3220
|
"""Pop-up a search for a menu in current context
|
|
4188
3221
|
|
|
4189
|
-
:type execution_context: int | str | None
|
|
4190
|
-
:type undo: bool | None
|
|
4191
3222
|
:param menu_idname: Menu Name, Menu to search in
|
|
4192
|
-
:type menu_idname: str
|
|
4193
3223
|
:param initial_query: Initial Query, Query to insert into the search box
|
|
4194
|
-
:type initial_query: str
|
|
4195
3224
|
"""
|
|
4196
3225
|
|
|
4197
3226
|
def set_stereo_3d(
|
|
@@ -4209,41 +3238,40 @@ def set_stereo_3d(
|
|
|
4209
3238
|
) -> None:
|
|
4210
3239
|
"""Toggle 3D stereo support for current window (or change the display mode)
|
|
4211
3240
|
|
|
4212
|
-
:type execution_context: int | str | None
|
|
4213
|
-
:type undo: bool | None
|
|
4214
3241
|
:param display_mode: Display Mode
|
|
4215
|
-
:type display_mode: bpy.stub_internal.rna_enums.Stereo3DDisplayItems | None
|
|
4216
3242
|
:param anaglyph_type: Anaglyph Type
|
|
4217
|
-
:type anaglyph_type: bpy.stub_internal.rna_enums.Stereo3DAnaglyphTypeItems | None
|
|
4218
3243
|
:param interlace_type: Interlace Type
|
|
4219
|
-
:type interlace_type: bpy.stub_internal.rna_enums.Stereo3DInterlaceTypeItems | None
|
|
4220
3244
|
:param use_interlace_swap: Swap Left/Right, Swap left and right stereo channels
|
|
4221
|
-
:type use_interlace_swap: bool | None
|
|
4222
3245
|
:param use_sidebyside_crosseyed: Cross-Eyed, Right eye should see left image and vice versa
|
|
4223
|
-
:type use_sidebyside_crosseyed: bool | None
|
|
4224
3246
|
"""
|
|
4225
3247
|
|
|
4226
|
-
def
|
|
3248
|
+
def set_working_color_space(
|
|
4227
3249
|
execution_context: int | str | None = None,
|
|
4228
3250
|
undo: bool | None = None,
|
|
4229
3251
|
/,
|
|
3252
|
+
*,
|
|
3253
|
+
convert_colors: bool | None = True,
|
|
3254
|
+
working_space: str | None = "",
|
|
4230
3255
|
) -> None:
|
|
4231
|
-
"""
|
|
3256
|
+
"""Change the working color space of all colors in this blend file
|
|
4232
3257
|
|
|
4233
|
-
:
|
|
4234
|
-
:
|
|
3258
|
+
:param convert_colors: Convert Colors in All Data-blocks, Change colors in all data-blocks to the new working space
|
|
3259
|
+
:param working_space: Working Space, Color space to set
|
|
4235
3260
|
"""
|
|
4236
3261
|
|
|
4237
|
-
def
|
|
3262
|
+
def splash(
|
|
4238
3263
|
execution_context: int | str | None = None,
|
|
4239
3264
|
undo: bool | None = None,
|
|
4240
3265
|
/,
|
|
4241
3266
|
) -> None:
|
|
4242
|
-
"""Open
|
|
3267
|
+
"""Open the splash screen with release info"""
|
|
4243
3268
|
|
|
4244
|
-
|
|
4245
|
-
:
|
|
4246
|
-
|
|
3269
|
+
def splash_about(
|
|
3270
|
+
execution_context: int | str | None = None,
|
|
3271
|
+
undo: bool | None = None,
|
|
3272
|
+
/,
|
|
3273
|
+
) -> None:
|
|
3274
|
+
"""Open a window with information about Blender"""
|
|
4247
3275
|
|
|
4248
3276
|
def stl_export(
|
|
4249
3277
|
execution_context: int | str | None = None,
|
|
@@ -4291,46 +3319,25 @@ def stl_export(
|
|
|
4291
3319
|
) -> None:
|
|
4292
3320
|
"""Save the scene to an STL file
|
|
4293
3321
|
|
|
4294
|
-
:type execution_context: int | str | None
|
|
4295
|
-
:type undo: bool | None
|
|
4296
3322
|
:param filepath: File Path, Path to file
|
|
4297
|
-
:type filepath: str
|
|
4298
3323
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4299
|
-
:type check_existing: bool | None
|
|
4300
3324
|
:param filter_blender: Filter .blend files
|
|
4301
|
-
:type filter_blender: bool | None
|
|
4302
3325
|
:param filter_backup: Filter .blend files
|
|
4303
|
-
:type filter_backup: bool | None
|
|
4304
3326
|
:param filter_image: Filter image files
|
|
4305
|
-
:type filter_image: bool | None
|
|
4306
3327
|
:param filter_movie: Filter movie files
|
|
4307
|
-
:type filter_movie: bool | None
|
|
4308
3328
|
:param filter_python: Filter Python files
|
|
4309
|
-
:type filter_python: bool | None
|
|
4310
3329
|
:param filter_font: Filter font files
|
|
4311
|
-
:type filter_font: bool | None
|
|
4312
3330
|
:param filter_sound: Filter sound files
|
|
4313
|
-
:type filter_sound: bool | None
|
|
4314
3331
|
:param filter_text: Filter text files
|
|
4315
|
-
:type filter_text: bool | None
|
|
4316
3332
|
:param filter_archive: Filter archive files
|
|
4317
|
-
:type filter_archive: bool | None
|
|
4318
3333
|
:param filter_btx: Filter btx files
|
|
4319
|
-
:type filter_btx: bool | None
|
|
4320
3334
|
:param filter_alembic: Filter Alembic files
|
|
4321
|
-
:type filter_alembic: bool | None
|
|
4322
3335
|
:param filter_usd: Filter USD files
|
|
4323
|
-
:type filter_usd: bool | None
|
|
4324
3336
|
:param filter_obj: Filter OBJ files
|
|
4325
|
-
:type filter_obj: bool | None
|
|
4326
3337
|
:param filter_volume: Filter OpenVDB volume files
|
|
4327
|
-
:type filter_volume: bool | None
|
|
4328
3338
|
:param filter_folder: Filter folders
|
|
4329
|
-
:type filter_folder: bool | None
|
|
4330
3339
|
:param filter_blenlib: Filter Blender IDs
|
|
4331
|
-
:type filter_blenlib: bool | None
|
|
4332
3340
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4333
|
-
:type filemode: int | None
|
|
4334
3341
|
:param display_type: Display Type
|
|
4335
3342
|
|
|
4336
3343
|
DEFAULT
|
|
@@ -4344,21 +3351,13 @@ def stl_export(
|
|
|
4344
3351
|
|
|
4345
3352
|
THUMBNAIL
|
|
4346
3353
|
Thumbnails -- Display files as thumbnails.
|
|
4347
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4348
3354
|
:param sort_method: File sorting mode
|
|
4349
|
-
:type sort_method: str | None
|
|
4350
3355
|
:param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
|
|
4351
|
-
:type ascii_format: bool | None
|
|
4352
3356
|
:param use_batch: Batch Export, Export each object to a separate file
|
|
4353
|
-
:type use_batch: bool | None
|
|
4354
3357
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
4355
|
-
:type export_selected_objects: bool | None
|
|
4356
3358
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
4357
|
-
:type collection: str
|
|
4358
3359
|
:param global_scale: Scale
|
|
4359
|
-
:type global_scale: float | None
|
|
4360
3360
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to exported data
|
|
4361
|
-
:type use_scene_unit: bool | None
|
|
4362
3361
|
:param forward_axis: Forward Axis
|
|
4363
3362
|
|
|
4364
3363
|
X
|
|
@@ -4378,7 +3377,6 @@ def stl_export(
|
|
|
4378
3377
|
|
|
4379
3378
|
NEGATIVE_Z
|
|
4380
3379
|
-Z -- Negative Z axis.
|
|
4381
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4382
3380
|
:param up_axis: Up Axis
|
|
4383
3381
|
|
|
4384
3382
|
X
|
|
@@ -4398,11 +3396,8 @@ def stl_export(
|
|
|
4398
3396
|
|
|
4399
3397
|
NEGATIVE_Z
|
|
4400
3398
|
-Z -- Negative Z axis.
|
|
4401
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4402
3399
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
4403
|
-
:type apply_modifiers: bool | None
|
|
4404
3400
|
:param filter_glob: Extension Filter
|
|
4405
|
-
:type filter_glob: str
|
|
4406
3401
|
"""
|
|
4407
3402
|
|
|
4408
3403
|
def stl_import(
|
|
@@ -4451,50 +3446,27 @@ def stl_import(
|
|
|
4451
3446
|
) -> None:
|
|
4452
3447
|
"""Import an STL file as an object
|
|
4453
3448
|
|
|
4454
|
-
:type execution_context: int | str | None
|
|
4455
|
-
:type undo: bool | None
|
|
4456
3449
|
:param filepath: File Path, Path to file
|
|
4457
|
-
:type filepath: str
|
|
4458
3450
|
:param directory: Directory, Directory of the file
|
|
4459
|
-
:type directory: str
|
|
4460
3451
|
:param files: Files
|
|
4461
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
4462
3452
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4463
|
-
:type check_existing: bool | None
|
|
4464
3453
|
:param filter_blender: Filter .blend files
|
|
4465
|
-
:type filter_blender: bool | None
|
|
4466
3454
|
:param filter_backup: Filter .blend files
|
|
4467
|
-
:type filter_backup: bool | None
|
|
4468
3455
|
:param filter_image: Filter image files
|
|
4469
|
-
:type filter_image: bool | None
|
|
4470
3456
|
:param filter_movie: Filter movie files
|
|
4471
|
-
:type filter_movie: bool | None
|
|
4472
3457
|
:param filter_python: Filter Python files
|
|
4473
|
-
:type filter_python: bool | None
|
|
4474
3458
|
:param filter_font: Filter font files
|
|
4475
|
-
:type filter_font: bool | None
|
|
4476
3459
|
:param filter_sound: Filter sound files
|
|
4477
|
-
:type filter_sound: bool | None
|
|
4478
3460
|
:param filter_text: Filter text files
|
|
4479
|
-
:type filter_text: bool | None
|
|
4480
3461
|
:param filter_archive: Filter archive files
|
|
4481
|
-
:type filter_archive: bool | None
|
|
4482
3462
|
:param filter_btx: Filter btx files
|
|
4483
|
-
:type filter_btx: bool | None
|
|
4484
3463
|
:param filter_alembic: Filter Alembic files
|
|
4485
|
-
:type filter_alembic: bool | None
|
|
4486
3464
|
:param filter_usd: Filter USD files
|
|
4487
|
-
:type filter_usd: bool | None
|
|
4488
3465
|
:param filter_obj: Filter OBJ files
|
|
4489
|
-
:type filter_obj: bool | None
|
|
4490
3466
|
:param filter_volume: Filter OpenVDB volume files
|
|
4491
|
-
:type filter_volume: bool | None
|
|
4492
3467
|
:param filter_folder: Filter folders
|
|
4493
|
-
:type filter_folder: bool | None
|
|
4494
3468
|
:param filter_blenlib: Filter Blender IDs
|
|
4495
|
-
:type filter_blenlib: bool | None
|
|
4496
3469
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4497
|
-
:type filemode: int | None
|
|
4498
3470
|
:param display_type: Display Type
|
|
4499
3471
|
|
|
4500
3472
|
DEFAULT
|
|
@@ -4508,15 +3480,10 @@ def stl_import(
|
|
|
4508
3480
|
|
|
4509
3481
|
THUMBNAIL
|
|
4510
3482
|
Thumbnails -- Display files as thumbnails.
|
|
4511
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4512
3483
|
:param sort_method: File sorting mode
|
|
4513
|
-
:type sort_method: str | None
|
|
4514
3484
|
:param global_scale: Scale
|
|
4515
|
-
:type global_scale: float | None
|
|
4516
3485
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
4517
|
-
:type use_scene_unit: bool | None
|
|
4518
3486
|
:param use_facet_normal: Facet Normals, Use (import) facet normals (note that this will still give flat shading)
|
|
4519
|
-
:type use_facet_normal: bool | None
|
|
4520
3487
|
:param forward_axis: Forward Axis
|
|
4521
3488
|
|
|
4522
3489
|
X
|
|
@@ -4536,7 +3503,6 @@ def stl_import(
|
|
|
4536
3503
|
|
|
4537
3504
|
NEGATIVE_Z
|
|
4538
3505
|
-Z -- Negative Z axis.
|
|
4539
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4540
3506
|
:param up_axis: Up Axis
|
|
4541
3507
|
|
|
4542
3508
|
X
|
|
@@ -4556,11 +3522,8 @@ def stl_import(
|
|
|
4556
3522
|
|
|
4557
3523
|
NEGATIVE_Z
|
|
4558
3524
|
-Z -- Negative Z axis.
|
|
4559
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4560
3525
|
:param use_mesh_validate: Validate Mesh, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
4561
|
-
:type use_mesh_validate: bool | None
|
|
4562
3526
|
:param filter_glob: Extension Filter
|
|
4563
|
-
:type filter_glob: str
|
|
4564
3527
|
"""
|
|
4565
3528
|
|
|
4566
3529
|
def sysinfo(
|
|
@@ -4572,10 +3535,7 @@ def sysinfo(
|
|
|
4572
3535
|
) -> None:
|
|
4573
3536
|
"""Generate system information, saved into a text file
|
|
4574
3537
|
|
|
4575
|
-
:type execution_context: int | str | None
|
|
4576
|
-
:type undo: bool | None
|
|
4577
3538
|
:param filepath: filepath
|
|
4578
|
-
:type filepath: str
|
|
4579
3539
|
"""
|
|
4580
3540
|
|
|
4581
3541
|
def tool_set_by_brush_type(
|
|
@@ -4609,12 +3569,8 @@ def tool_set_by_brush_type(
|
|
|
4609
3569
|
) -> None:
|
|
4610
3570
|
"""Look up the most appropriate tool for the given brush type and activate that
|
|
4611
3571
|
|
|
4612
|
-
:type execution_context: int | str | None
|
|
4613
|
-
:type undo: bool | None
|
|
4614
3572
|
:param brush_type: Brush Type, Brush type identifier for which the most appropriate tool will be looked up
|
|
4615
|
-
:type brush_type: str
|
|
4616
3573
|
:param space_type: Type
|
|
4617
|
-
:type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
|
|
4618
3574
|
"""
|
|
4619
3575
|
|
|
4620
3576
|
def tool_set_by_id(
|
|
@@ -4650,16 +3606,10 @@ def tool_set_by_id(
|
|
|
4650
3606
|
) -> None:
|
|
4651
3607
|
"""Set the tool by name (for key-maps)
|
|
4652
3608
|
|
|
4653
|
-
:type execution_context: int | str | None
|
|
4654
|
-
:type undo: bool | None
|
|
4655
3609
|
:param name: Identifier, Identifier of the tool
|
|
4656
|
-
:type name: str
|
|
4657
3610
|
:param cycle: Cycle, Cycle through tools in this group
|
|
4658
|
-
:type cycle: bool | None
|
|
4659
3611
|
:param as_fallback: Set Fallback, Set the fallback tool instead of the primary tool
|
|
4660
|
-
:type as_fallback: bool | None
|
|
4661
3612
|
:param space_type: Type
|
|
4662
|
-
:type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
|
|
4663
3613
|
"""
|
|
4664
3614
|
|
|
4665
3615
|
def tool_set_by_index(
|
|
@@ -4696,18 +3646,11 @@ def tool_set_by_index(
|
|
|
4696
3646
|
) -> None:
|
|
4697
3647
|
"""Set the tool by index (for key-maps)
|
|
4698
3648
|
|
|
4699
|
-
:type execution_context: int | str | None
|
|
4700
|
-
:type undo: bool | None
|
|
4701
3649
|
:param index: Index in Toolbar
|
|
4702
|
-
:type index: int | None
|
|
4703
3650
|
:param cycle: Cycle, Cycle through tools in this group
|
|
4704
|
-
:type cycle: bool | None
|
|
4705
3651
|
:param expand: expand, Include tool subgroups
|
|
4706
|
-
:type expand: bool | None
|
|
4707
3652
|
:param as_fallback: Set Fallback, Set the fallback tool instead of the primary
|
|
4708
|
-
:type as_fallback: bool | None
|
|
4709
3653
|
:param space_type: Type
|
|
4710
|
-
:type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
|
|
4711
3654
|
"""
|
|
4712
3655
|
|
|
4713
3656
|
def toolbar(
|
|
@@ -4715,33 +3658,21 @@ def toolbar(
|
|
|
4715
3658
|
undo: bool | None = None,
|
|
4716
3659
|
/,
|
|
4717
3660
|
) -> None:
|
|
4718
|
-
"""Undocumented, consider contributing.
|
|
4719
|
-
|
|
4720
|
-
:type execution_context: int | str | None
|
|
4721
|
-
:type undo: bool | None
|
|
4722
|
-
"""
|
|
3661
|
+
"""Undocumented, consider contributing."""
|
|
4723
3662
|
|
|
4724
3663
|
def toolbar_fallback_pie(
|
|
4725
3664
|
execution_context: int | str | None = None,
|
|
4726
3665
|
undo: bool | None = None,
|
|
4727
3666
|
/,
|
|
4728
3667
|
) -> None:
|
|
4729
|
-
"""Undocumented, consider contributing.
|
|
4730
|
-
|
|
4731
|
-
:type execution_context: int | str | None
|
|
4732
|
-
:type undo: bool | None
|
|
4733
|
-
"""
|
|
3668
|
+
"""Undocumented, consider contributing."""
|
|
4734
3669
|
|
|
4735
3670
|
def toolbar_prompt(
|
|
4736
3671
|
execution_context: int | str | None = None,
|
|
4737
3672
|
undo: bool | None = None,
|
|
4738
3673
|
/,
|
|
4739
3674
|
) -> None:
|
|
4740
|
-
"""Leader key like functionality for accessing tools
|
|
4741
|
-
|
|
4742
|
-
:type execution_context: int | str | None
|
|
4743
|
-
:type undo: bool | None
|
|
4744
|
-
"""
|
|
3675
|
+
"""Leader key like functionality for accessing tools"""
|
|
4745
3676
|
|
|
4746
3677
|
def url_open(
|
|
4747
3678
|
execution_context: int | str | None = None,
|
|
@@ -4752,10 +3683,7 @@ def url_open(
|
|
|
4752
3683
|
) -> None:
|
|
4753
3684
|
"""Open a website in the web browser
|
|
4754
3685
|
|
|
4755
|
-
:type execution_context: int | str | None
|
|
4756
|
-
:type undo: bool | None
|
|
4757
3686
|
:param url: URL, URL to open
|
|
4758
|
-
:type url: str
|
|
4759
3687
|
"""
|
|
4760
3688
|
|
|
4761
3689
|
def url_open_preset(
|
|
@@ -4767,10 +3695,7 @@ def url_open_preset(
|
|
|
4767
3695
|
) -> None:
|
|
4768
3696
|
"""Open a preset website in the web browser
|
|
4769
3697
|
|
|
4770
|
-
:type execution_context: int | str | None
|
|
4771
|
-
:type undo: bool | None
|
|
4772
3698
|
:param type: Site
|
|
4773
|
-
:type type: str | None
|
|
4774
3699
|
"""
|
|
4775
3700
|
|
|
4776
3701
|
def usd_export(
|
|
@@ -4804,7 +3729,6 @@ def usd_export(
|
|
|
4804
3729
|
sort_method: str | None = "",
|
|
4805
3730
|
filter_glob: str = "*.usd",
|
|
4806
3731
|
selected_objects_only: bool | None = False,
|
|
4807
|
-
visible_objects_only: bool | None = True,
|
|
4808
3732
|
collection: str = "",
|
|
4809
3733
|
export_animation: bool | None = False,
|
|
4810
3734
|
export_hair: bool | None = False,
|
|
@@ -4838,6 +3762,8 @@ def usd_export(
|
|
|
4838
3762
|
root_prim_path: str = "/root",
|
|
4839
3763
|
export_custom_properties: bool | None = True,
|
|
4840
3764
|
custom_properties_namespace: str = "userProperties",
|
|
3765
|
+
accessibility_label: str = "",
|
|
3766
|
+
accessibility_description: str = "",
|
|
4841
3767
|
author_blender_name: bool | None = True,
|
|
4842
3768
|
convert_world_material: bool | None = True,
|
|
4843
3769
|
allow_unicode: bool | None = True,
|
|
@@ -4873,46 +3799,25 @@ def usd_export(
|
|
|
4873
3799
|
) -> None:
|
|
4874
3800
|
"""Export current scene in a USD archive
|
|
4875
3801
|
|
|
4876
|
-
:type execution_context: int | str | None
|
|
4877
|
-
:type undo: bool | None
|
|
4878
3802
|
:param filepath: File Path, Path to file
|
|
4879
|
-
:type filepath: str
|
|
4880
3803
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4881
|
-
:type check_existing: bool | None
|
|
4882
3804
|
:param filter_blender: Filter .blend files
|
|
4883
|
-
:type filter_blender: bool | None
|
|
4884
3805
|
:param filter_backup: Filter .blend files
|
|
4885
|
-
:type filter_backup: bool | None
|
|
4886
3806
|
:param filter_image: Filter image files
|
|
4887
|
-
:type filter_image: bool | None
|
|
4888
3807
|
:param filter_movie: Filter movie files
|
|
4889
|
-
:type filter_movie: bool | None
|
|
4890
3808
|
:param filter_python: Filter Python files
|
|
4891
|
-
:type filter_python: bool | None
|
|
4892
3809
|
:param filter_font: Filter font files
|
|
4893
|
-
:type filter_font: bool | None
|
|
4894
3810
|
:param filter_sound: Filter sound files
|
|
4895
|
-
:type filter_sound: bool | None
|
|
4896
3811
|
:param filter_text: Filter text files
|
|
4897
|
-
:type filter_text: bool | None
|
|
4898
3812
|
:param filter_archive: Filter archive files
|
|
4899
|
-
:type filter_archive: bool | None
|
|
4900
3813
|
:param filter_btx: Filter btx files
|
|
4901
|
-
:type filter_btx: bool | None
|
|
4902
3814
|
:param filter_alembic: Filter Alembic files
|
|
4903
|
-
:type filter_alembic: bool | None
|
|
4904
3815
|
:param filter_usd: Filter USD files
|
|
4905
|
-
:type filter_usd: bool | None
|
|
4906
3816
|
:param filter_obj: Filter OBJ files
|
|
4907
|
-
:type filter_obj: bool | None
|
|
4908
3817
|
:param filter_volume: Filter OpenVDB volume files
|
|
4909
|
-
:type filter_volume: bool | None
|
|
4910
3818
|
:param filter_folder: Filter folders
|
|
4911
|
-
:type filter_folder: bool | None
|
|
4912
3819
|
:param filter_blenlib: Filter Blender IDs
|
|
4913
|
-
:type filter_blenlib: bool | None
|
|
4914
3820
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4915
|
-
:type filemode: int | None
|
|
4916
3821
|
:param display_type: Display Type
|
|
4917
3822
|
|
|
4918
3823
|
DEFAULT
|
|
@@ -4926,30 +3831,16 @@ def usd_export(
|
|
|
4926
3831
|
|
|
4927
3832
|
THUMBNAIL
|
|
4928
3833
|
Thumbnails -- Display files as thumbnails.
|
|
4929
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4930
3834
|
:param sort_method: File sorting mode
|
|
4931
|
-
:type sort_method: str | None
|
|
4932
|
-
:type filter_glob: str
|
|
4933
3835
|
:param selected_objects_only: Selection Only, Only export selected objects. Unselected parents of selected objects are exported as empty transform
|
|
4934
|
-
:type selected_objects_only: bool | None
|
|
4935
|
-
:param visible_objects_only: Visible Only, Only export visible objects. Invisible parents of exported objects are exported as empty transforms
|
|
4936
|
-
:type visible_objects_only: bool | None
|
|
4937
3836
|
:param collection: Collection
|
|
4938
|
-
:type collection: str
|
|
4939
3837
|
:param export_animation: Animation, Export all frames in the render frame range, rather than only the current frame
|
|
4940
|
-
:type export_animation: bool | None
|
|
4941
3838
|
:param export_hair: Hair, Export hair particle systems as USD curves
|
|
4942
|
-
:type export_hair: bool | None
|
|
4943
3839
|
:param export_uvmaps: UV Maps, Include all mesh UV maps in the export
|
|
4944
|
-
:type export_uvmaps: bool | None
|
|
4945
3840
|
:param rename_uvmaps: Rename UV Maps, Rename active render UV map to "st" to match USD conventions
|
|
4946
|
-
:type rename_uvmaps: bool | None
|
|
4947
3841
|
:param export_mesh_colors: Color Attributes, Include mesh color attributes in the export
|
|
4948
|
-
:type export_mesh_colors: bool | None
|
|
4949
3842
|
:param export_normals: Normals, Include normals of exported meshes in the export
|
|
4950
|
-
:type export_normals: bool | None
|
|
4951
3843
|
:param export_materials: Materials, Export viewport settings of materials as USD preview materials, and export material assignments as geometry subsets
|
|
4952
|
-
:type export_materials: bool | None
|
|
4953
3844
|
:param export_subdivision: Subdivision, Choose how subdivision modifiers will be mapped to the USD subdivision scheme during export
|
|
4954
3845
|
|
|
4955
3846
|
IGNORE
|
|
@@ -4960,15 +3851,10 @@ def usd_export(
|
|
|
4960
3851
|
|
|
4961
3852
|
BEST_MATCH
|
|
4962
3853
|
Best Match -- Scheme = Catmull-Clark, when possible. Reverts to exporting the subdivided mesh for the Simple subdivision type.
|
|
4963
|
-
:type export_subdivision: typing.Literal['IGNORE','TESSELLATE','BEST_MATCH'] | None
|
|
4964
3854
|
:param export_armatures: Armatures, Export armatures and meshes with armature modifiers as USD skeletons and skinned meshes
|
|
4965
|
-
:type export_armatures: bool | None
|
|
4966
3855
|
:param only_deform_bones: Only Deform Bones, Only export deform bones and their parents
|
|
4967
|
-
:type only_deform_bones: bool | None
|
|
4968
3856
|
:param export_shapekeys: Shape Keys, Export shape keys as USD blend shapes
|
|
4969
|
-
:type export_shapekeys: bool | None
|
|
4970
3857
|
:param use_instancing: Instancing, Export instanced objects as references in USD rather than real objects
|
|
4971
|
-
:type use_instancing: bool | None
|
|
4972
3858
|
:param evaluation_mode: Use Settings for, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering
|
|
4973
3859
|
|
|
4974
3860
|
RENDER
|
|
@@ -4976,13 +3862,9 @@ def usd_export(
|
|
|
4976
3862
|
|
|
4977
3863
|
VIEWPORT
|
|
4978
3864
|
Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
|
|
4979
|
-
:type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
|
|
4980
3865
|
:param generate_preview_surface: USD Preview Surface Network, Generate an approximate USD Preview Surface shader representation of a Principled BSDF node network
|
|
4981
|
-
:type generate_preview_surface: bool | None
|
|
4982
3866
|
:param generate_materialx_network: MaterialX Network, Generate a MaterialX network representation of the materials
|
|
4983
|
-
:type generate_materialx_network: bool | None
|
|
4984
3867
|
:param convert_orientation: Convert Orientation, Convert orientation axis to a different convention to match other applications
|
|
4985
|
-
:type convert_orientation: bool | None
|
|
4986
3868
|
:param export_global_forward_selection: Forward Axis
|
|
4987
3869
|
|
|
4988
3870
|
X
|
|
@@ -5002,7 +3884,6 @@ def usd_export(
|
|
|
5002
3884
|
|
|
5003
3885
|
NEGATIVE_Z
|
|
5004
3886
|
-Z -- Negative Z axis.
|
|
5005
|
-
:type export_global_forward_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
5006
3887
|
:param export_global_up_selection: Up Axis
|
|
5007
3888
|
|
|
5008
3889
|
X
|
|
@@ -5022,7 +3903,6 @@ def usd_export(
|
|
|
5022
3903
|
|
|
5023
3904
|
NEGATIVE_Z
|
|
5024
3905
|
-Z -- Negative Z axis.
|
|
5025
|
-
:type export_global_up_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
5026
3906
|
:param export_textures_mode: Export Textures, Texture export method
|
|
5027
3907
|
|
|
5028
3908
|
KEEP
|
|
@@ -5034,11 +3914,8 @@ def usd_export(
|
|
|
5034
3914
|
|
|
5035
3915
|
NEW
|
|
5036
3916
|
New Path -- Export textures to a textures folder next to the USD file.
|
|
5037
|
-
:type export_textures_mode: typing.Literal['KEEP','PRESERVE','NEW'] | None
|
|
5038
3917
|
:param overwrite_textures: Overwrite Textures, Overwrite existing files when exporting textures
|
|
5039
|
-
:type overwrite_textures: bool | None
|
|
5040
3918
|
:param relative_paths: Relative Paths, Use relative paths to reference external files (i.e. textures, volumes) in USD, otherwise use absolute paths
|
|
5041
|
-
:type relative_paths: bool | None
|
|
5042
3919
|
:param xform_op_mode: Xform Ops, The type of transform operators to write
|
|
5043
3920
|
|
|
5044
3921
|
TRS
|
|
@@ -5049,37 +3926,23 @@ def usd_export(
|
|
|
5049
3926
|
|
|
5050
3927
|
MAT
|
|
5051
3928
|
Matrix -- Export matrix operator.
|
|
5052
|
-
:type xform_op_mode: typing.Literal['TRS','TOS','MAT'] | None
|
|
5053
3929
|
:param root_prim_path: Root Prim, If set, add a transform primitive with the given path to the stage as the parent of all exported data
|
|
5054
|
-
:type root_prim_path: str
|
|
5055
3930
|
:param export_custom_properties: Custom Properties, Export custom properties as USD attributes
|
|
5056
|
-
:type export_custom_properties: bool | None
|
|
5057
3931
|
:param custom_properties_namespace: Namespace, If set, add the given namespace as a prefix to exported custom property names. This only applies to property names that do not already have a prefix (e.g., it would apply to name bar but not foo:bar) and does not apply to blender object and data names which are always exported in the userProperties:blender namespace
|
|
5058
|
-
:
|
|
3932
|
+
:param accessibility_label: Label, Set the accessibility label for the exported stages default prim
|
|
3933
|
+
:param accessibility_description: Description, Set the accessibility description for the exported stages default prim
|
|
5059
3934
|
:param author_blender_name: Blender Names, Author USD custom attributes containing the original Blender object and object data names
|
|
5060
|
-
:type author_blender_name: bool | None
|
|
5061
3935
|
:param convert_world_material: World Dome Light, Convert the world material to a USD dome light. Currently works for simple materials, consisting of an environment texture connected to a background shader, with an optional vector multiply of the texture color
|
|
5062
|
-
:type convert_world_material: bool | None
|
|
5063
3936
|
:param allow_unicode: Allow Unicode, Preserve UTF-8 encoded characters when writing USD prim and property names (requires software utilizing USD 24.03 or greater when opening the resulting files)
|
|
5064
|
-
:type allow_unicode: bool | None
|
|
5065
3937
|
:param export_meshes: Meshes, Export all meshes
|
|
5066
|
-
:type export_meshes: bool | None
|
|
5067
3938
|
:param export_lights: Lights, Export all lights
|
|
5068
|
-
:type export_lights: bool | None
|
|
5069
3939
|
:param export_cameras: Cameras, Export all cameras
|
|
5070
|
-
:type export_cameras: bool | None
|
|
5071
3940
|
:param export_curves: Curves, Export all curves
|
|
5072
|
-
:type export_curves: bool | None
|
|
5073
3941
|
:param export_points: Point Clouds, Export all point clouds
|
|
5074
|
-
:type export_points: bool | None
|
|
5075
3942
|
:param export_volumes: Volumes, Export all volumes
|
|
5076
|
-
:type export_volumes: bool | None
|
|
5077
3943
|
:param triangulate_meshes: Triangulate Meshes, Triangulate meshes during export
|
|
5078
|
-
:type triangulate_meshes: bool | None
|
|
5079
3944
|
:param quad_method: Quad Method, Method for splitting the quads into triangles
|
|
5080
|
-
:type quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems | None
|
|
5081
3945
|
:param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
|
|
5082
|
-
:type ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems | None
|
|
5083
3946
|
:param usdz_downscale_size: USDZ Texture Downsampling, Choose a maximum size for all exported textures
|
|
5084
3947
|
|
|
5085
3948
|
KEEP
|
|
@@ -5102,11 +3965,8 @@ def usd_export(
|
|
|
5102
3965
|
|
|
5103
3966
|
CUSTOM
|
|
5104
3967
|
Custom -- Specify a custom size.
|
|
5105
|
-
:type usdz_downscale_size: typing.Literal['KEEP','256','512','1024','2048','4096','CUSTOM'] | None
|
|
5106
3968
|
:param usdz_downscale_custom_size: USDZ Custom Downscale Size, Custom size for downscaling exported textures
|
|
5107
|
-
:type usdz_downscale_custom_size: int | None
|
|
5108
3969
|
:param merge_parent_xform: Merge parent Xform, Merge USD primitives with their Xform parent if possible. USD does not allow nested UsdGeomGprims, intermediary Xform prims will be defined to keep the USD file valid when encountering object hierarchies.
|
|
5109
|
-
:type merge_parent_xform: bool | None
|
|
5110
3970
|
:param convert_scene_units: Units, Set the USD Stage meters per unit to the chosen measurement, or a custom value
|
|
5111
3971
|
|
|
5112
3972
|
METERS
|
|
@@ -5132,9 +3992,7 @@ def usd_export(
|
|
|
5132
3992
|
|
|
5133
3993
|
CUSTOM
|
|
5134
3994
|
Custom -- Specify a custom scene meters per unit value.
|
|
5135
|
-
:type convert_scene_units: typing.Literal['METERS','KILOMETERS','CENTIMETERS','MILLIMETERS','INCHES','FEET','YARDS','CUSTOM'] | None
|
|
5136
3995
|
:param meters_per_unit: Meters Per Unit, Custom value for meters per unit in the USD Stage
|
|
5137
|
-
:type meters_per_unit: float | None
|
|
5138
3996
|
"""
|
|
5139
3997
|
|
|
5140
3998
|
def usd_import(
|
|
@@ -5213,48 +4071,26 @@ def usd_import(
|
|
|
5213
4071
|
) -> None:
|
|
5214
4072
|
"""Import USD stage into current scene
|
|
5215
4073
|
|
|
5216
|
-
:type execution_context: int | str | None
|
|
5217
|
-
:type undo: bool | None
|
|
5218
4074
|
:param filepath: File Path, Path to file
|
|
5219
|
-
:type filepath: str
|
|
5220
4075
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
5221
|
-
:type check_existing: bool | None
|
|
5222
4076
|
:param filter_blender: Filter .blend files
|
|
5223
|
-
:type filter_blender: bool | None
|
|
5224
4077
|
:param filter_backup: Filter .blend files
|
|
5225
|
-
:type filter_backup: bool | None
|
|
5226
4078
|
:param filter_image: Filter image files
|
|
5227
|
-
:type filter_image: bool | None
|
|
5228
4079
|
:param filter_movie: Filter movie files
|
|
5229
|
-
:type filter_movie: bool | None
|
|
5230
4080
|
:param filter_python: Filter Python files
|
|
5231
|
-
:type filter_python: bool | None
|
|
5232
4081
|
:param filter_font: Filter font files
|
|
5233
|
-
:type filter_font: bool | None
|
|
5234
4082
|
:param filter_sound: Filter sound files
|
|
5235
|
-
:type filter_sound: bool | None
|
|
5236
4083
|
:param filter_text: Filter text files
|
|
5237
|
-
:type filter_text: bool | None
|
|
5238
4084
|
:param filter_archive: Filter archive files
|
|
5239
|
-
:type filter_archive: bool | None
|
|
5240
4085
|
:param filter_btx: Filter btx files
|
|
5241
|
-
:type filter_btx: bool | None
|
|
5242
4086
|
:param filter_alembic: Filter Alembic files
|
|
5243
|
-
:type filter_alembic: bool | None
|
|
5244
4087
|
:param filter_usd: Filter USD files
|
|
5245
|
-
:type filter_usd: bool | None
|
|
5246
4088
|
:param filter_obj: Filter OBJ files
|
|
5247
|
-
:type filter_obj: bool | None
|
|
5248
4089
|
:param filter_volume: Filter OpenVDB volume files
|
|
5249
|
-
:type filter_volume: bool | None
|
|
5250
4090
|
:param filter_folder: Filter folders
|
|
5251
|
-
:type filter_folder: bool | None
|
|
5252
4091
|
:param filter_blenlib: Filter Blender IDs
|
|
5253
|
-
:type filter_blenlib: bool | None
|
|
5254
4092
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
5255
|
-
:type filemode: int | None
|
|
5256
4093
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
5257
|
-
:type relative_path: bool | None
|
|
5258
4094
|
:param display_type: Display Type
|
|
5259
4095
|
|
|
5260
4096
|
DEFAULT
|
|
@@ -5268,64 +4104,34 @@ def usd_import(
|
|
|
5268
4104
|
|
|
5269
4105
|
THUMBNAIL
|
|
5270
4106
|
Thumbnails -- Display files as thumbnails.
|
|
5271
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
5272
4107
|
:param sort_method: File sorting mode
|
|
5273
|
-
:type sort_method: str | None
|
|
5274
|
-
:type filter_glob: str
|
|
5275
4108
|
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
5276
|
-
:type scale: float | None
|
|
5277
4109
|
:param set_frame_range: Set Frame Range, Update the scenes start and end frame to match those of the USD archive
|
|
5278
|
-
:type set_frame_range: bool | None
|
|
5279
4110
|
:param import_cameras: Cameras
|
|
5280
|
-
:type import_cameras: bool | None
|
|
5281
4111
|
:param import_curves: Curves
|
|
5282
|
-
:type import_curves: bool | None
|
|
5283
4112
|
:param import_lights: Lights
|
|
5284
|
-
:type import_lights: bool | None
|
|
5285
4113
|
:param import_materials: Materials
|
|
5286
|
-
:type import_materials: bool | None
|
|
5287
4114
|
:param import_meshes: Meshes
|
|
5288
|
-
:type import_meshes: bool | None
|
|
5289
4115
|
:param import_volumes: Volumes
|
|
5290
|
-
:type import_volumes: bool | None
|
|
5291
4116
|
:param import_shapes: USD Shapes
|
|
5292
|
-
:type import_shapes: bool | None
|
|
5293
4117
|
:param import_skeletons: Armatures
|
|
5294
|
-
:type import_skeletons: bool | None
|
|
5295
4118
|
:param import_blendshapes: Shape Keys
|
|
5296
|
-
:type import_blendshapes: bool | None
|
|
5297
4119
|
:param import_points: Point Clouds
|
|
5298
|
-
:type import_points: bool | None
|
|
5299
4120
|
:param import_subdivision: Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute
|
|
5300
|
-
:type import_subdivision: bool | None
|
|
5301
4121
|
:param support_scene_instancing: Scene Instancing, Import USD scene graph instances as collection instances
|
|
5302
|
-
:type support_scene_instancing: bool | None
|
|
5303
4122
|
:param import_visible_only: Visible Primitives Only, Do not import invisible USD primitives. Only applies to primitives with a non-animated visibility attribute. Primitives with animated visibility will always be imported
|
|
5304
|
-
:type import_visible_only: bool | None
|
|
5305
4123
|
:param create_collection: Create Collection, Add all imported objects to a new collection
|
|
5306
|
-
:type create_collection: bool | None
|
|
5307
4124
|
:param read_mesh_uvs: UV Coordinates, Read mesh UV coordinates
|
|
5308
|
-
:type read_mesh_uvs: bool | None
|
|
5309
4125
|
:param read_mesh_colors: Color Attributes, Read mesh color attributes
|
|
5310
|
-
:type read_mesh_colors: bool | None
|
|
5311
4126
|
:param read_mesh_attributes: Mesh Attributes, Read USD Primvars as mesh attributes
|
|
5312
|
-
:type read_mesh_attributes: bool | None
|
|
5313
4127
|
:param prim_path_mask: Path Mask, Import only the primitive at the given path and its descendants. Multiple paths may be specified in a list delimited by commas or semicolons
|
|
5314
|
-
:type prim_path_mask: str
|
|
5315
4128
|
:param import_guide: Guide, Import guide geometry
|
|
5316
|
-
:type import_guide: bool | None
|
|
5317
4129
|
:param import_proxy: Proxy, Import proxy geometry
|
|
5318
|
-
:type import_proxy: bool | None
|
|
5319
4130
|
:param import_render: Render, Import final render geometry
|
|
5320
|
-
:type import_render: bool | None
|
|
5321
4131
|
:param import_all_materials: Import All Materials, Also import materials that are not used by any geometry. Note that when this option is false, materials referenced by geometry will still be imported
|
|
5322
|
-
:type import_all_materials: bool | None
|
|
5323
4132
|
:param import_usd_preview: Import USD Preview, Convert UsdPreviewSurface shaders to Principled BSDF shader networks
|
|
5324
|
-
:type import_usd_preview: bool | None
|
|
5325
4133
|
:param set_material_blend: Set Material Blend, If the Import USD Preview option is enabled, the material blend method will automatically be set based on the shaders opacity and opacityThreshold inputs
|
|
5326
|
-
:type set_material_blend: bool | None
|
|
5327
4134
|
:param light_intensity_scale: Light Intensity Scale, Scale for the intensity of imported lights
|
|
5328
|
-
:type light_intensity_scale: float | None
|
|
5329
4135
|
:param mtl_purpose: Material Purpose, Attempt to import materials with the given purpose. If no material with this purpose is bound to the primitive, fall back on loading any other bound material
|
|
5330
4136
|
|
|
5331
4137
|
MTL_ALL_PURPOSE
|
|
@@ -5336,7 +4142,6 @@ def usd_import(
|
|
|
5336
4142
|
|
|
5337
4143
|
MTL_FULL
|
|
5338
4144
|
Full -- Attempt to import full materials. Load allPurpose or preview materials, in that order, as a fallback.
|
|
5339
|
-
:type mtl_purpose: typing.Literal['MTL_ALL_PURPOSE','MTL_PREVIEW','MTL_FULL'] | None
|
|
5340
4145
|
:param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
|
|
5341
4146
|
|
|
5342
4147
|
MAKE_UNIQUE
|
|
@@ -5344,7 +4149,6 @@ def usd_import(
|
|
|
5344
4149
|
|
|
5345
4150
|
REFERENCE_EXISTING
|
|
5346
4151
|
Reference Existing -- If a material with the same name already exists, reference that instead of importing.
|
|
5347
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
5348
4152
|
:param import_textures_mode: Import Textures, Behavior when importing textures from a USDZ archive
|
|
5349
4153
|
|
|
5350
4154
|
IMPORT_NONE
|
|
@@ -5355,9 +4159,7 @@ def usd_import(
|
|
|
5355
4159
|
|
|
5356
4160
|
IMPORT_COPY
|
|
5357
4161
|
Copy -- Copy files to textures directory.
|
|
5358
|
-
:type import_textures_mode: typing.Literal['IMPORT_NONE','IMPORT_PACK','IMPORT_COPY'] | None
|
|
5359
4162
|
:param import_textures_dir: Textures Directory, Path to the directory where imported textures will be copied
|
|
5360
|
-
:type import_textures_dir: str
|
|
5361
4163
|
:param tex_name_collision_mode: File Name Collision, Behavior when the name of an imported texture file conflicts with an existing file
|
|
5362
4164
|
|
|
5363
4165
|
USE_EXISTING
|
|
@@ -5365,7 +4167,6 @@ def usd_import(
|
|
|
5365
4167
|
|
|
5366
4168
|
OVERWRITE
|
|
5367
4169
|
Overwrite -- Overwrite existing files.
|
|
5368
|
-
:type tex_name_collision_mode: typing.Literal['USE_EXISTING','OVERWRITE'] | None
|
|
5369
4170
|
:param property_import_mode: Custom Properties, Behavior when importing USD attributes as Blender custom properties
|
|
5370
4171
|
|
|
5371
4172
|
NONE
|
|
@@ -5376,17 +4177,11 @@ def usd_import(
|
|
|
5376
4177
|
|
|
5377
4178
|
ALL
|
|
5378
4179
|
All Custom -- Import all USD custom attributes as Blender custom properties. Namespaces will be retained in the property names.
|
|
5379
|
-
:type property_import_mode: typing.Literal['NONE','USER','ALL'] | None
|
|
5380
4180
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
5381
|
-
:type validate_meshes: bool | None
|
|
5382
4181
|
:param create_world_material: World Dome Light, Convert the first discovered USD dome light to a world background shader
|
|
5383
|
-
:type create_world_material: bool | None
|
|
5384
4182
|
:param import_defined_only: Defined Primitives Only, Import only defined USD primitives. When disabled this allows importing USD primitives which are not defined, such as those with an override specifier
|
|
5385
|
-
:type import_defined_only: bool | None
|
|
5386
4183
|
:param merge_parent_xform: Merge parent Xform, Allow USD primitives to merge with their Xform parent if they are the only child in the hierarchy
|
|
5387
|
-
:type merge_parent_xform: bool | None
|
|
5388
4184
|
:param apply_unit_conversion_scale: Apply Unit Conversion Scale, Scale the scene objects by the USD stages meters per unit value. This scaling is applied in addition to the value specified in the Scale option
|
|
5389
|
-
:type apply_unit_conversion_scale: bool | None
|
|
5390
4185
|
"""
|
|
5391
4186
|
|
|
5392
4187
|
def window_close(
|
|
@@ -5394,44 +4189,28 @@ def window_close(
|
|
|
5394
4189
|
undo: bool | None = None,
|
|
5395
4190
|
/,
|
|
5396
4191
|
) -> None:
|
|
5397
|
-
"""Close the current window
|
|
5398
|
-
|
|
5399
|
-
:type execution_context: int | str | None
|
|
5400
|
-
:type undo: bool | None
|
|
5401
|
-
"""
|
|
4192
|
+
"""Close the current window"""
|
|
5402
4193
|
|
|
5403
4194
|
def window_fullscreen_toggle(
|
|
5404
4195
|
execution_context: int | str | None = None,
|
|
5405
4196
|
undo: bool | None = None,
|
|
5406
4197
|
/,
|
|
5407
4198
|
) -> None:
|
|
5408
|
-
"""Toggle the current window full-screen
|
|
5409
|
-
|
|
5410
|
-
:type execution_context: int | str | None
|
|
5411
|
-
:type undo: bool | None
|
|
5412
|
-
"""
|
|
4199
|
+
"""Toggle the current window full-screen"""
|
|
5413
4200
|
|
|
5414
4201
|
def window_new(
|
|
5415
4202
|
execution_context: int | str | None = None,
|
|
5416
4203
|
undo: bool | None = None,
|
|
5417
4204
|
/,
|
|
5418
4205
|
) -> None:
|
|
5419
|
-
"""Create a new window
|
|
5420
|
-
|
|
5421
|
-
:type execution_context: int | str | None
|
|
5422
|
-
:type undo: bool | None
|
|
5423
|
-
"""
|
|
4206
|
+
"""Create a new window"""
|
|
5424
4207
|
|
|
5425
4208
|
def window_new_main(
|
|
5426
4209
|
execution_context: int | str | None = None,
|
|
5427
4210
|
undo: bool | None = None,
|
|
5428
4211
|
/,
|
|
5429
4212
|
) -> None:
|
|
5430
|
-
"""Create a new main window with its own workspace and scene selection
|
|
5431
|
-
|
|
5432
|
-
:type execution_context: int | str | None
|
|
5433
|
-
:type undo: bool | None
|
|
5434
|
-
"""
|
|
4213
|
+
"""Create a new main window with its own workspace and scene selection"""
|
|
5435
4214
|
|
|
5436
4215
|
def xr_navigation_fly(
|
|
5437
4216
|
execution_context: int | str | None = None,
|
|
@@ -5454,11 +4233,12 @@ def xr_navigation_fly(
|
|
|
5454
4233
|
"CONTROLLER_FORWARD",
|
|
5455
4234
|
]
|
|
5456
4235
|
| None = "VIEWER_FORWARD",
|
|
4236
|
+
snap_turn_threshold: float | None = 0.95,
|
|
5457
4237
|
lock_location_z: bool | None = False,
|
|
5458
4238
|
lock_direction: bool | None = False,
|
|
5459
|
-
speed_frame_based: bool | None =
|
|
5460
|
-
|
|
5461
|
-
|
|
4239
|
+
speed_frame_based: bool | None = False,
|
|
4240
|
+
turn_speed_factor: float | None = 0.333333,
|
|
4241
|
+
fly_speed_factor: float | None = 0.333333,
|
|
5462
4242
|
speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
5463
4243
|
0.0,
|
|
5464
4244
|
0.0,
|
|
@@ -5467,11 +4247,27 @@ def xr_navigation_fly(
|
|
|
5467
4247
|
1.0,
|
|
5468
4248
|
1.0,
|
|
5469
4249
|
),
|
|
4250
|
+
alt_mode: typing.Literal[
|
|
4251
|
+
"FORWARD",
|
|
4252
|
+
"BACK",
|
|
4253
|
+
"LEFT",
|
|
4254
|
+
"RIGHT",
|
|
4255
|
+
"UP",
|
|
4256
|
+
"DOWN",
|
|
4257
|
+
"TURNLEFT",
|
|
4258
|
+
"TURNRIGHT",
|
|
4259
|
+
"VIEWER_FORWARD",
|
|
4260
|
+
"VIEWER_BACK",
|
|
4261
|
+
"VIEWER_LEFT",
|
|
4262
|
+
"VIEWER_RIGHT",
|
|
4263
|
+
"CONTROLLER_FORWARD",
|
|
4264
|
+
]
|
|
4265
|
+
| None = "VIEWER_FORWARD",
|
|
4266
|
+
alt_lock_location_z: bool | None = False,
|
|
4267
|
+
alt_lock_direction: bool | None = False,
|
|
5470
4268
|
) -> None:
|
|
5471
4269
|
"""Move/turn relative to the VR viewer or controller
|
|
5472
4270
|
|
|
5473
|
-
:type execution_context: int | str | None
|
|
5474
|
-
:type undo: bool | None
|
|
5475
4271
|
:param mode: Mode, Fly mode
|
|
5476
4272
|
|
|
5477
4273
|
FORWARD
|
|
@@ -5512,21 +4308,56 @@ def xr_navigation_fly(
|
|
|
5512
4308
|
|
|
5513
4309
|
CONTROLLER_FORWARD
|
|
5514
4310
|
Controller Forward -- Move along controllers forward axis.
|
|
5515
|
-
:
|
|
4311
|
+
:param snap_turn_threshold: Snap Turn Threshold, Input state threshold when using snap turn
|
|
5516
4312
|
:param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
|
|
5517
|
-
:type lock_location_z: bool | None
|
|
5518
4313
|
:param lock_direction: Lock Direction, Limit movement to viewers initial direction
|
|
5519
|
-
:type lock_direction: bool | None
|
|
5520
4314
|
:param speed_frame_based: Frame Based Speed, Apply fixed movement deltas every update
|
|
5521
|
-
:
|
|
5522
|
-
:param
|
|
5523
|
-
:type speed_min: float | None
|
|
5524
|
-
:param speed_max: Maximum Speed, Maximum move (turn) speed in meters (radians) per second or frame
|
|
5525
|
-
:type speed_max: float | None
|
|
4315
|
+
:param turn_speed_factor: Turn Speed Factor, Ratio between the min and max turn speed
|
|
4316
|
+
:param fly_speed_factor: Fly Speed Factor, Ratio between the min and max fly speed
|
|
5526
4317
|
:param speed_interpolation0: Speed Interpolation 0, First cubic spline control point between min/max speeds
|
|
5527
|
-
:type speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
5528
4318
|
:param speed_interpolation1: Speed Interpolation 1, Second cubic spline control point between min/max speeds
|
|
5529
|
-
:
|
|
4319
|
+
:param alt_mode: Mode (Alt), Fly mode when hands are swapped
|
|
4320
|
+
|
|
4321
|
+
FORWARD
|
|
4322
|
+
Forward -- Move along navigation forward axis.
|
|
4323
|
+
|
|
4324
|
+
BACK
|
|
4325
|
+
Back -- Move along navigation back axis.
|
|
4326
|
+
|
|
4327
|
+
LEFT
|
|
4328
|
+
Left -- Move along navigation left axis.
|
|
4329
|
+
|
|
4330
|
+
RIGHT
|
|
4331
|
+
Right -- Move along navigation right axis.
|
|
4332
|
+
|
|
4333
|
+
UP
|
|
4334
|
+
Up -- Move along navigation up axis.
|
|
4335
|
+
|
|
4336
|
+
DOWN
|
|
4337
|
+
Down -- Move along navigation down axis.
|
|
4338
|
+
|
|
4339
|
+
TURNLEFT
|
|
4340
|
+
Turn Left -- Turn counter-clockwise around navigation up axis.
|
|
4341
|
+
|
|
4342
|
+
TURNRIGHT
|
|
4343
|
+
Turn Right -- Turn clockwise around navigation up axis.
|
|
4344
|
+
|
|
4345
|
+
VIEWER_FORWARD
|
|
4346
|
+
Viewer Forward -- Move along viewers forward axis.
|
|
4347
|
+
|
|
4348
|
+
VIEWER_BACK
|
|
4349
|
+
Viewer Back -- Move along viewers back axis.
|
|
4350
|
+
|
|
4351
|
+
VIEWER_LEFT
|
|
4352
|
+
Viewer Left -- Move along viewers left axis.
|
|
4353
|
+
|
|
4354
|
+
VIEWER_RIGHT
|
|
4355
|
+
Viewer Right -- Move along viewers right axis.
|
|
4356
|
+
|
|
4357
|
+
CONTROLLER_FORWARD
|
|
4358
|
+
Controller Forward -- Move along controllers forward axis.
|
|
4359
|
+
:param alt_lock_location_z: Lock Elevation (Alt), When hands are swapped, prevent changes to viewer elevation
|
|
4360
|
+
:param alt_lock_direction: Lock Direction (Alt), When hands are swapped, limit movement to viewers initial direction
|
|
5530
4361
|
"""
|
|
5531
4362
|
|
|
5532
4363
|
def xr_navigation_grab(
|
|
@@ -5542,18 +4373,11 @@ def xr_navigation_grab(
|
|
|
5542
4373
|
) -> None:
|
|
5543
4374
|
"""Navigate the VR scene by grabbing with controllers
|
|
5544
4375
|
|
|
5545
|
-
:type execution_context: int | str | None
|
|
5546
|
-
:type undo: bool | None
|
|
5547
4376
|
:param lock_location: Lock Location, Prevent changes to viewer location
|
|
5548
|
-
:type lock_location: bool | None
|
|
5549
4377
|
:param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
|
|
5550
|
-
:type lock_location_z: bool | None
|
|
5551
4378
|
:param lock_rotation: Lock Rotation, Prevent changes to viewer rotation
|
|
5552
|
-
:type lock_rotation: bool | None
|
|
5553
4379
|
:param lock_rotation_z: Lock Up Orientation, Prevent changes to viewer up orientation
|
|
5554
|
-
:type lock_rotation_z: bool | None
|
|
5555
4380
|
:param lock_scale: Lock Scale, Prevent changes to viewer scale
|
|
5556
|
-
:type lock_scale: bool | None
|
|
5557
4381
|
"""
|
|
5558
4382
|
|
|
5559
4383
|
def xr_navigation_reset(
|
|
@@ -5567,50 +4391,42 @@ def xr_navigation_reset(
|
|
|
5567
4391
|
) -> None:
|
|
5568
4392
|
"""Reset VR navigation deltas relative to session base pose
|
|
5569
4393
|
|
|
5570
|
-
:type execution_context: int | str | None
|
|
5571
|
-
:type undo: bool | None
|
|
5572
4394
|
:param location: Location, Reset location deltas
|
|
5573
|
-
:type location: bool | None
|
|
5574
4395
|
:param rotation: Rotation, Reset rotation deltas
|
|
5575
|
-
:type rotation: bool | None
|
|
5576
4396
|
:param scale: Scale, Reset scale deltas
|
|
5577
|
-
:type scale: bool | None
|
|
5578
4397
|
"""
|
|
5579
4398
|
|
|
4399
|
+
def xr_navigation_swap_hands(
|
|
4400
|
+
execution_context: int | str | None = None,
|
|
4401
|
+
undo: bool | None = None,
|
|
4402
|
+
/,
|
|
4403
|
+
) -> None:
|
|
4404
|
+
"""Swap VR navigation controls between left / right controllers"""
|
|
4405
|
+
|
|
5580
4406
|
def xr_navigation_teleport(
|
|
5581
4407
|
execution_context: int | str | None = None,
|
|
5582
4408
|
undo: bool | None = None,
|
|
5583
4409
|
/,
|
|
5584
4410
|
*,
|
|
5585
|
-
teleport_axes: collections.abc.Iterable[bool] | None = (True, True, True),
|
|
5586
|
-
interpolation: float | None = 1.0,
|
|
5587
|
-
offset: float | None = 0.0,
|
|
5588
4411
|
selectable_only: bool | None = True,
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
4412
|
+
force: float | None = 8.5,
|
|
4413
|
+
range: float | None = 0.15,
|
|
4414
|
+
ray_line_width: float | None = 6.0,
|
|
4415
|
+
destination_indicator_width: float | None = 0.18,
|
|
4416
|
+
hit_color: collections.abc.Iterable[float] | None = (0.4, 0.6, 0.9, 1.0),
|
|
4417
|
+
miss_color: collections.abc.Iterable[float] | None = (1.0, 0.35, 0.35, 1.0),
|
|
4418
|
+
fallback_color: collections.abc.Iterable[float] | None = (0.5, 0.45, 0.8, 1.0),
|
|
5593
4419
|
) -> None:
|
|
5594
4420
|
"""Set VR viewer location to controller raycast hit location
|
|
5595
4421
|
|
|
5596
|
-
:type execution_context: int | str | None
|
|
5597
|
-
:type undo: bool | None
|
|
5598
|
-
:param teleport_axes: Teleport Axes, Enabled teleport axes in navigation space
|
|
5599
|
-
:type teleport_axes: collections.abc.Iterable[bool] | None
|
|
5600
|
-
:param interpolation: Interpolation, Interpolation factor between viewer and hit locations
|
|
5601
|
-
:type interpolation: float | None
|
|
5602
|
-
:param offset: Offset, Offset along hit normal to subtract from final location
|
|
5603
|
-
:type offset: float | None
|
|
5604
4422
|
:param selectable_only: Selectable Only, Only allow selectable objects to influence raycast result
|
|
5605
|
-
:
|
|
5606
|
-
:param
|
|
5607
|
-
:
|
|
5608
|
-
:param
|
|
5609
|
-
:
|
|
5610
|
-
:param
|
|
5611
|
-
:
|
|
5612
|
-
:param color: Color, Raycast color
|
|
5613
|
-
:type color: collections.abc.Iterable[float] | None
|
|
4423
|
+
:param force: Force, Velocity force controlling the teleportation arc parabola in m/s
|
|
4424
|
+
:param range: Range, Time step range controlling the teleportation arc parabola
|
|
4425
|
+
:param ray_line_width: Ray Line Width, Visual width of the teleportation ray line
|
|
4426
|
+
:param destination_indicator_width: Destination Indicator Width, Visual width of the hit destination indicator
|
|
4427
|
+
:param hit_color: Hit Color, Color of raycast when it succeeds
|
|
4428
|
+
:param miss_color: Miss Color, Color of raycast when it misses
|
|
4429
|
+
:param fallback_color: Fallback Color, Color of raycast when a fallback case succeeds
|
|
5614
4430
|
"""
|
|
5615
4431
|
|
|
5616
4432
|
def xr_session_toggle(
|
|
@@ -5618,8 +4434,4 @@ def xr_session_toggle(
|
|
|
5618
4434
|
undo: bool | None = None,
|
|
5619
4435
|
/,
|
|
5620
4436
|
) -> None:
|
|
5621
|
-
"""Open a view for use with virtual reality headsets, or close it if already opened
|
|
5622
|
-
|
|
5623
|
-
:type execution_context: int | str | None
|
|
5624
|
-
:type undo: bool | None
|
|
5625
|
-
"""
|
|
4437
|
+
"""Open a view for use with virtual reality headsets, or close it if already opened"""
|