fake-bpy-module 20250612__py3-none-any.whl → 20260118__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 +3 -1
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +4 -4
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- _blendfile_header/__init__.pyi +48 -0
- _bpy_internal/__init__.pyi +4 -1
- _bpy_internal/assets/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/blender_asset_library_openapi/__init__.pyi +13 -0
- _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/extensions/wheel_manager/__init__.pyi +1 -1
- _bpy_internal/filesystem/__init__.pyi +5 -0
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/grease_pencil/stroke/__init__.pyi +2 -2
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_types/__init__.pyi +1592 -0
- {keyingsets_utils → _keyingsets_utils}/__init__.pyi +2 -0
- {rna_info → _rna_info}/__init__.pyi +4 -2
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +122 -145
- 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 +3 -13
- bl_operators/__init__.pyi +1 -0
- bl_operators/add_mesh_torus/__init__.pyi +2 -3
- bl_operators/anim/__init__.pyi +62 -38
- bl_operators/assets/__init__.pyi +4 -9
- bl_operators/bone_selection_sets/__init__.pyi +15 -42
- bl_operators/clip/__init__.pyi +12 -31
- bl_operators/connect_to_output/__init__.pyi +2 -3
- bl_operators/console/__init__.pyi +6 -15
- bl_operators/constraint/__init__.pyi +6 -13
- bl_operators/copy_global_transform/__init__.pyi +261 -0
- bl_operators/file/__init__.pyi +6 -11
- bl_operators/freestyle/__init__.pyi +5 -12
- bl_operators/geometry_nodes/__init__.pyi +5 -12
- bl_operators/grease_pencil/__init__.pyi +2 -3
- bl_operators/image/__init__.pyi +6 -15
- bl_operators/image_as_planes/__init__.pyi +3 -10
- bl_operators/mesh/__init__.pyi +3 -49
- bl_operators/node/__init__.pyi +294 -73
- bl_operators/object/__init__.pyi +17 -53
- bl_operators/object_align/__init__.pyi +2 -3
- bl_operators/object_quick_effects/__init__.pyi +5 -12
- bl_operators/object_randomize_transform/__init__.pyi +2 -3
- bl_operators/presets/__init__.pyi +27 -76
- bl_operators/rigidbody/__init__.pyi +4 -9
- bl_operators/screen_play_rendered_anim/__init__.pyi +2 -3
- bl_operators/sequencer/__init__.pyi +12 -27
- bl_operators/spreadsheet/__init__.pyi +2 -3
- bl_operators/userpref/__init__.pyi +26 -75
- bl_operators/uvcalc_follow_active/__init__.pyi +3 -4
- bl_operators/uvcalc_lightmap/__init__.pyi +3 -4
- bl_operators/uvcalc_transform/__init__.pyi +26 -16
- bl_operators/vertexpaint_dirt/__init__.pyi +2 -3
- bl_operators/view3d/__init__.pyi +9 -24
- bl_operators/wm/__init__.pyi +48 -139
- bl_operators/world/__init__.pyi +3 -4
- bl_ui/__init__.pyi +7 -7
- bl_ui/anim/__init__.pyi +2 -3
- bl_ui/asset_shelf/__init__.pyi +2 -3
- bl_ui/generic_ui_list/__init__.pyi +4 -19
- bl_ui/node_add_menu/__init__.pyi +263 -7
- bl_ui/node_add_menu_compositor/__init__.pyi +96 -79
- bl_ui/node_add_menu_geometry/__init__.pyi +309 -270
- bl_ui/node_add_menu_shader/__init__.pyi +49 -49
- bl_ui/node_add_menu_texture/__init__.pyi +17 -62
- bl_ui/properties_collection/__init__.pyi +9 -22
- bl_ui/properties_constraint/__init__.pyi +129 -282
- bl_ui/properties_data_armature/__init__.pyi +22 -57
- bl_ui/properties_data_bone/__init__.pyi +12 -31
- bl_ui/properties_data_camera/__init__.pyi +18 -47
- bl_ui/properties_data_curve/__init__.pyi +18 -47
- bl_ui/properties_data_curves/__init__.pyi +11 -26
- bl_ui/properties_data_empty/__init__.pyi +3 -6
- bl_ui/properties_data_grease_pencil/__init__.pyi +23 -62
- bl_ui/properties_data_lattice/__init__.pyi +7 -14
- bl_ui/properties_data_light/__init__.pyi +13 -32
- bl_ui/properties_data_lightprobe/__init__.pyi +16 -43
- bl_ui/properties_data_mesh/__init__.pyi +47 -62
- bl_ui/properties_data_metaball/__init__.pyi +9 -20
- bl_ui/properties_data_modifier/__init__.pyi +22 -28
- bl_ui/properties_data_pointcloud/__init__.pyi +8 -19
- bl_ui/properties_data_shaderfx/__init__.pyi +2 -3
- bl_ui/properties_data_speaker/__init__.pyi +9 -20
- bl_ui/properties_data_volume/__init__.pyi +12 -29
- bl_ui/properties_freestyle/__init__.pyi +27 -76
- bl_ui/properties_grease_pencil_common/__init__.pyi +10 -168
- bl_ui/properties_mask_common/__init__.pyi +8 -21
- bl_ui/properties_material/__init__.pyi +26 -86
- bl_ui/properties_material_gpencil/__init__.pyi +36 -57
- bl_ui/properties_object/__init__.pyi +59 -65
- bl_ui/properties_output/__init__.pyi +21 -60
- bl_ui/properties_paint_common/__init__.pyi +30 -22
- bl_ui/properties_particle/__init__.pyi +58 -161
- bl_ui/properties_physics_cloth/__init__.pyi +15 -42
- bl_ui/properties_physics_common/__init__.pyi +2 -3
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +23 -66
- bl_ui/properties_physics_field/__init__.pyi +11 -30
- bl_ui/properties_physics_fluid/__init__.pyi +29 -84
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +2 -3
- bl_ui/properties_physics_rigidbody/__init__.pyi +9 -24
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +14 -39
- bl_ui/properties_physics_softbody/__init__.pyi +16 -45
- bl_ui/properties_render/__init__.pyi +139 -197
- bl_ui/properties_scene/__init__.pyi +46 -50
- bl_ui/properties_strip/__init__.pyi +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +30 -83
- bl_ui/properties_view_layer/__init__.pyi +84 -39
- bl_ui/properties_workspace/__init__.pyi +6 -13
- bl_ui/properties_world/__init__.pyi +14 -35
- bl_ui/space_clip/__init__.pyi +150 -231
- bl_ui/space_console/__init__.pyi +7 -18
- bl_ui/space_dopesheet/__init__.pyi +143 -100
- bl_ui/space_filebrowser/__init__.pyi +33 -90
- bl_ui/space_graph/__init__.pyi +48 -85
- bl_ui/space_image/__init__.pyi +111 -229
- bl_ui/space_info/__init__.pyi +7 -18
- bl_ui/space_nla/__init__.pyi +44 -73
- bl_ui/space_node/__init__.pyi +161 -123
- bl_ui/space_outliner/__init__.pyi +16 -45
- bl_ui/space_properties/__init__.pyi +34 -10
- bl_ui/space_sequencer/__init__.pyi +164 -901
- bl_ui/space_spreadsheet/__init__.pyi +4 -9
- bl_ui/space_statusbar/__init__.pyi +2 -3
- bl_ui/space_text/__init__.pyi +17 -48
- bl_ui/space_time/__init__.pyi +25 -71
- bl_ui/space_toolsystem_common/__init__.pyi +2 -2
- bl_ui/space_toolsystem_toolbar/__init__.pyi +30 -7
- bl_ui/space_topbar/__init__.pyi +35 -79
- bl_ui/space_userpref/__init__.pyi +185 -321
- bl_ui/space_view3d/__init__.pyi +337 -817
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +110 -880
- bl_ui/utils/__init__.pyi +0 -17
- blend_render_info/__init__.pyi +1 -0
- blf/__init__.pyi +8 -54
- bmesh/__init__.pyi +2 -9
- bmesh/geometry/__init__.pyi +1 -4
- bmesh/ops/__init__.pyi +125 -508
- bmesh/types/__init__.pyi +318 -664
- bmesh/utils/__init__.pyi +17 -43
- bpy/__init__.pyi +1 -1
- bpy/app/__init__.pyi +93 -88
- bpy/app/handlers/__init__.pyi +19 -19
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +2 -7
- bpy/app/translations/__init__.pyi +8 -23
- bpy/msgbus/__init__.pyi +4 -6
- bpy/ops/action/__init__.pyi +68 -199
- bpy/ops/anim/__init__.pyi +142 -299
- bpy/ops/armature/__init__.pyi +78 -209
- bpy/ops/asset/__init__.pyi +46 -108
- bpy/ops/boid/__init__.pyi +28 -45
- bpy/ops/brush/__init__.pyi +13 -108
- bpy/ops/buttons/__init__.pyi +16 -75
- bpy/ops/cachefile/__init__.pyi +8 -65
- bpy/ops/camera/__init__.pyi +0 -11
- bpy/ops/clip/__init__.pyi +173 -471
- bpy/ops/cloth/__init__.pyi +0 -5
- bpy/ops/collection/__init__.pyi +23 -36
- bpy/ops/console/__init__.pyi +40 -98
- bpy/ops/constraint/__init__.pyi +14 -85
- bpy/ops/curve/__init__.pyi +94 -277
- bpy/ops/curves/__init__.pyi +119 -166
- bpy/ops/cycles/__init__.pyi +4 -15
- bpy/ops/dpaint/__init__.pyi +14 -24
- bpy/ops/ed/__init__.pyi +44 -92
- bpy/ops/export_anim/__init__.pyi +2 -10
- bpy/ops/export_scene/__init__.pyi +16 -170
- bpy/ops/extensions/__init__.pyi +60 -165
- bpy/ops/file/__init__.pyi +110 -246
- bpy/ops/fluid/__init__.pyi +52 -83
- bpy/ops/font/__init__.pyi +40 -144
- bpy/ops/geometry/__init__.pyi +12 -127
- bpy/ops/gizmogroup/__init__.pyi +4 -13
- bpy/ops/gpencil/__init__.pyi +22 -54
- bpy/ops/graph/__init__.pyi +92 -343
- bpy/ops/grease_pencil/__init__.pyi +218 -550
- bpy/ops/image/__init__.pyi +85 -435
- bpy/ops/import_anim/__init__.pyi +3 -17
- bpy/ops/import_curve/__init__.pyi +2 -5
- bpy/ops/import_scene/__init__.pyi +15 -49
- bpy/ops/info/__init__.pyi +16 -39
- bpy/ops/lattice/__init__.pyi +12 -36
- bpy/ops/marker/__init__.pyi +12 -51
- bpy/ops/mask/__init__.pyi +68 -193
- bpy/ops/material/__init__.pyi +18 -18
- bpy/ops/mball/__init__.pyi +4 -31
- bpy/ops/mesh/__init__.pyi +140 -967
- bpy/ops/nla/__init__.pyi +87 -206
- bpy/ops/node/__init__.pyi +714 -744
- bpy/ops/object/__init__.pyi +461 -1341
- bpy/ops/outliner/__init__.pyi +192 -376
- bpy/ops/paint/__init__.pyi +94 -319
- bpy/ops/paintcurve/__init__.pyi +20 -40
- bpy/ops/palette/__init__.pyi +14 -30
- bpy/ops/particle/__init__.pyi +86 -184
- bpy/ops/pointcloud/__init__.pyi +12 -38
- bpy/ops/pose/__init__.pyi +108 -261
- bpy/ops/poselib/__init__.pyi +32 -67
- bpy/ops/preferences/__init__.pyi +37 -187
- bpy/ops/ptcache/__init__.pyi +22 -36
- bpy/ops/render/__init__.pyi +20 -72
- bpy/ops/rigidbody/__init__.pyi +25 -63
- bpy/ops/scene/__init__.pyi +122 -181
- bpy/ops/screen/__init__.pyi +93 -221
- bpy/ops/script/__init__.pyi +4 -13
- bpy/ops/sculpt/__init__.pyi +69 -324
- bpy/ops/sculpt_curves/__init__.pyi +10 -23
- bpy/ops/sequencer/__init__.pyi +410 -730
- bpy/ops/sound/__init__.pyi +16 -114
- bpy/ops/spreadsheet/__init__.pyi +20 -37
- bpy/ops/surface/__init__.pyi +0 -48
- bpy/ops/text/__init__.pyi +112 -250
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +14 -21
- bpy/ops/transform/__init__.pyi +18 -386
- bpy/ops/ui/__init__.pyi +117 -188
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +238 -305
- bpy/ops/view2d/__init__.pyi +16 -76
- bpy/ops/view3d/__init__.pyi +153 -377
- bpy/ops/wm/__init__.pyi +277 -1397
- bpy/ops/workspace/__init__.pyi +32 -39
- bpy/ops/world/__init__.pyi +10 -12
- bpy/path/__init__.pyi +1 -35
- bpy/props/__init__.pyi +347 -218
- bpy/stub_internal/rna_enums/__init__.pyi +142 -108
- bpy/types/__init__.pyi +77367 -101305
- bpy/utils/__init__.pyi +11 -82
- bpy/utils/previews/__init__.pyi +2 -11
- bpy/utils/units/__init__.pyi +5 -15
- 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 +2 -11
- bpy_extras/io_utils/__init__.pyi +8 -27
- bpy_extras/keyconfig_utils/__init__.pyi +1 -1
- bpy_extras/mesh_utils/__init__.pyi +0 -12
- bpy_extras/node_shader_utils/__init__.pyi +1 -9
- bpy_extras/object_utils/__init__.pyi +1 -15
- bpy_extras/view3d_utils/__init__.pyi +0 -18
- bpy_extras/wm_utils/progress_report/__init__.pyi +1 -1
- {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/METADATA +4 -1
- fake_bpy_module-20260118.dist-info/RECORD +385 -0
- {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/top_level.txt +17 -16
- freestyle/chainingiterators/__init__.pyi +5 -27
- freestyle/functions/__init__.pyi +0 -139
- freestyle/predicates/__init__.pyi +2 -53
- freestyle/shaders/__init__.pyi +15 -81
- freestyle/types/__init__.pyi +159 -799
- freestyle/utils/ContextFunctions/__init__.pyi +0 -23
- freestyle/utils/__init__.pyi +5 -11
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +1 -10
- gpu/platform/__init__.pyi +2 -7
- gpu/shader/__init__.pyi +26 -9
- gpu/state/__init__.pyi +60 -39
- gpu/texture/__init__.pyi +3 -5
- gpu/types/__init__.pyi +116 -184
- gpu_extras/batch/__init__.pyi +1 -5
- gpu_extras/presets/__init__.pyi +6 -8
- idprop/types/__init__.pyi +6 -6
- imbuf/__init__.pyi +3 -10
- imbuf/types/__init__.pyi +7 -21
- keyingsets_builtins/__init__.pyi +24 -67
- mathutils/__init__.pyi +241 -2207
- mathutils/bvhtree/__init__.pyi +18 -26
- mathutils/geometry/__init__.pyi +82 -132
- mathutils/interpolate/__init__.pyi +6 -5
- mathutils/kdtree/__init__.pyi +1 -11
- mathutils/noise/__init__.pyi +61 -106
- rna_prop_ui/__init__.pyi +1 -1
- bgl/__init__.pyi +0 -4256
- bpy_types/__init__.pyi +0 -30
- fake_bpy_module-20250612.dist-info/RECORD +0 -367
- {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
- {bgl → _bl_console_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
- {bl_console_utils → _bl_i18n_utils}/py.typed +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_i18n_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_previews_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_rna_utils → _bl_text_utils}/py.typed +0 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
- {bl_text_utils → _bl_ui_utils}/py.typed +0 -0
- {bl_ui_utils → _blendfile_header}/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
- {bpy_types → _bpy_types}/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}/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-20250612.dist-info → fake_bpy_module-20260118.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
|
-
:
|
|
146
|
-
:param visible_objects_only: Visible Objects Only, Export only objects that are visible
|
|
147
|
-
:type visible_objects_only: bool | None
|
|
148
|
-
:param flatten: Flatten Hierarchy, Do not preserve objects' parent/children relationship
|
|
149
|
-
:type flatten: bool | None
|
|
114
|
+
:param flatten: Flatten Hierarchy, Do not preserve objects parent/children relationship
|
|
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
|
-
:
|
|
164
|
-
:param subdiv_schema: Use Subdivision Schema, Export meshes using Alembic's subdivision schema
|
|
165
|
-
:type subdiv_schema: bool | None
|
|
122
|
+
:param subdiv_schema: Use Subdivision Schema, Export meshes using Alembics subdivision schema
|
|
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
|
-
:
|
|
172
|
-
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
|
|
173
|
-
:type global_scale: float | None
|
|
126
|
+
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
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
|
-
:
|
|
304
|
-
:
|
|
305
|
-
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
|
|
306
|
-
:type scale: float | None
|
|
307
|
-
:param set_frame_range: Set Frame Range, If checked, update scene's start and end frame to match those of the Alembic archive
|
|
308
|
-
:type set_frame_range: bool | None
|
|
222
|
+
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
223
|
+
:param set_frame_range: Set Frame Range, If checked, update scenes start and end frame to match those of the Alembic archive
|
|
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
|
-
:
|
|
430
|
-
:param clear_asset_data: Clear Asset Data, Don't add asset meta-data or tags from the original data-block
|
|
431
|
-
:type clear_asset_data: bool | None
|
|
313
|
+
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
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(
|
|
@@ -456,7 +332,7 @@ def batch_rename(
|
|
|
456
332
|
"CURVE",
|
|
457
333
|
"META",
|
|
458
334
|
"VOLUME",
|
|
459
|
-
"
|
|
335
|
+
"GREASEPENCIL",
|
|
460
336
|
"ARMATURE",
|
|
461
337
|
"LATTICE",
|
|
462
338
|
"LIGHT",
|
|
@@ -477,24 +353,17 @@ 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','GPENCIL','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(
|
|
491
|
-
execution_context: int | str | None = None,
|
|
362
|
+
execution_context: int | str | None = None,
|
|
363
|
+
undo: bool | None = None,
|
|
364
|
+
/,
|
|
492
365
|
) -> None:
|
|
493
|
-
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)
|
|
494
|
-
|
|
495
|
-
:type execution_context: int | str | None
|
|
496
|
-
:type undo: bool | None
|
|
497
|
-
"""
|
|
366
|
+
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)"""
|
|
498
367
|
|
|
499
368
|
def call_asset_shelf_popover(
|
|
500
369
|
execution_context: int | str | None = None,
|
|
@@ -505,10 +374,7 @@ def call_asset_shelf_popover(
|
|
|
505
374
|
) -> None:
|
|
506
375
|
"""Open a predefined asset shelf in a popup
|
|
507
376
|
|
|
508
|
-
:type execution_context: int | str | None
|
|
509
|
-
:type undo: bool | None
|
|
510
377
|
:param name: Asset Shelf Name, Identifier of the asset shelf to display
|
|
511
|
-
:type name: str
|
|
512
378
|
"""
|
|
513
379
|
|
|
514
380
|
def call_menu(
|
|
@@ -520,10 +386,7 @@ def call_menu(
|
|
|
520
386
|
) -> None:
|
|
521
387
|
"""Open a predefined menu
|
|
522
388
|
|
|
523
|
-
:type execution_context: int | str | None
|
|
524
|
-
:type undo: bool | None
|
|
525
389
|
:param name: Name, Name of the menu
|
|
526
|
-
:type name: str
|
|
527
390
|
"""
|
|
528
391
|
|
|
529
392
|
def call_menu_pie(
|
|
@@ -535,10 +398,7 @@ def call_menu_pie(
|
|
|
535
398
|
) -> None:
|
|
536
399
|
"""Open a predefined pie menu
|
|
537
400
|
|
|
538
|
-
:type execution_context: int | str | None
|
|
539
|
-
:type undo: bool | None
|
|
540
401
|
:param name: Name, Name of the pie menu
|
|
541
|
-
:type name: str
|
|
542
402
|
"""
|
|
543
403
|
|
|
544
404
|
def call_panel(
|
|
@@ -551,12 +411,8 @@ def call_panel(
|
|
|
551
411
|
) -> None:
|
|
552
412
|
"""Open a predefined panel
|
|
553
413
|
|
|
554
|
-
:type execution_context: int | str | None
|
|
555
|
-
:type undo: bool | None
|
|
556
414
|
:param name: Name, Name of the menu
|
|
557
|
-
:type name: str
|
|
558
415
|
:param keep_open: Keep Open
|
|
559
|
-
:type keep_open: bool | None
|
|
560
416
|
"""
|
|
561
417
|
|
|
562
418
|
def clear_recent_files(
|
|
@@ -568,20 +424,15 @@ def clear_recent_files(
|
|
|
568
424
|
) -> None:
|
|
569
425
|
"""Clear the recent files list
|
|
570
426
|
|
|
571
|
-
:type execution_context: int | str | None
|
|
572
|
-
:type undo: bool | None
|
|
573
427
|
:param remove: Remove
|
|
574
|
-
:type remove: typing.Literal['ALL','MISSING'] | None
|
|
575
428
|
"""
|
|
576
429
|
|
|
577
430
|
def collection_export_all(
|
|
578
|
-
execution_context: int | str | None = None,
|
|
431
|
+
execution_context: int | str | None = None,
|
|
432
|
+
undo: bool | None = None,
|
|
433
|
+
/,
|
|
579
434
|
) -> None:
|
|
580
|
-
"""Invoke all configured exporters for all collections
|
|
581
|
-
|
|
582
|
-
:type execution_context: int | str | None
|
|
583
|
-
:type undo: bool | None
|
|
584
|
-
"""
|
|
435
|
+
"""Invoke all configured exporters for all collections"""
|
|
585
436
|
|
|
586
437
|
def context_collection_boolean_set(
|
|
587
438
|
execution_context: int | str | None = None,
|
|
@@ -594,14 +445,9 @@ def context_collection_boolean_set(
|
|
|
594
445
|
) -> None:
|
|
595
446
|
"""Set boolean values for a collection of items
|
|
596
447
|
|
|
597
|
-
:type execution_context: int | str | None
|
|
598
|
-
:type undo: bool | None
|
|
599
448
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
600
|
-
:type data_path_iter: str
|
|
601
449
|
:param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
|
|
602
|
-
:type data_path_item: str
|
|
603
450
|
:param type: Type
|
|
604
|
-
:type type: typing.Literal['TOGGLE','ENABLE','DISABLE'] | None
|
|
605
451
|
"""
|
|
606
452
|
|
|
607
453
|
def context_cycle_array(
|
|
@@ -614,12 +460,8 @@ def context_cycle_array(
|
|
|
614
460
|
) -> None:
|
|
615
461
|
"""Set a context array value (useful for cycling the active mesh edit mode)
|
|
616
462
|
|
|
617
|
-
:type execution_context: int | str | None
|
|
618
|
-
:type undo: bool | None
|
|
619
463
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
620
|
-
:type data_path: str
|
|
621
464
|
:param reverse: Reverse, Cycle backwards
|
|
622
|
-
:type reverse: bool | None
|
|
623
465
|
"""
|
|
624
466
|
|
|
625
467
|
def context_cycle_enum(
|
|
@@ -633,14 +475,9 @@ def context_cycle_enum(
|
|
|
633
475
|
) -> None:
|
|
634
476
|
"""Toggle a context value
|
|
635
477
|
|
|
636
|
-
:type execution_context: int | str | None
|
|
637
|
-
:type undo: bool | None
|
|
638
478
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
639
|
-
:type data_path: str
|
|
640
479
|
:param reverse: Reverse, Cycle backwards
|
|
641
|
-
:type reverse: bool | None
|
|
642
480
|
:param wrap: Wrap, Wrap back to the first/last values
|
|
643
|
-
:type wrap: bool | None
|
|
644
481
|
"""
|
|
645
482
|
|
|
646
483
|
def context_cycle_int(
|
|
@@ -654,14 +491,9 @@ def context_cycle_int(
|
|
|
654
491
|
) -> None:
|
|
655
492
|
"""Set a context value (useful for cycling active material, shape keys, groups, etc.)
|
|
656
493
|
|
|
657
|
-
:type execution_context: int | str | None
|
|
658
|
-
:type undo: bool | None
|
|
659
494
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
660
|
-
:type data_path: str
|
|
661
495
|
:param reverse: Reverse, Cycle backwards
|
|
662
|
-
:type reverse: bool | None
|
|
663
496
|
:param wrap: Wrap, Wrap back to the first/last values
|
|
664
|
-
:type wrap: bool | None
|
|
665
497
|
"""
|
|
666
498
|
|
|
667
499
|
def context_menu_enum(
|
|
@@ -673,10 +505,7 @@ def context_menu_enum(
|
|
|
673
505
|
) -> None:
|
|
674
506
|
"""Undocumented, consider contributing.
|
|
675
507
|
|
|
676
|
-
:type execution_context: int | str | None
|
|
677
|
-
:type undo: bool | None
|
|
678
508
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
679
|
-
:type data_path: str
|
|
680
509
|
"""
|
|
681
510
|
|
|
682
511
|
def context_modal_mouse(
|
|
@@ -693,20 +522,12 @@ def context_modal_mouse(
|
|
|
693
522
|
) -> None:
|
|
694
523
|
"""Adjust arbitrary values with mouse input
|
|
695
524
|
|
|
696
|
-
:type execution_context: int | str | None
|
|
697
|
-
:type undo: bool | None
|
|
698
525
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
699
|
-
:type data_path_iter: str
|
|
700
526
|
:param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
|
|
701
|
-
:type data_path_item: str
|
|
702
527
|
:param header_text: Header Text, Text to display in header during scale
|
|
703
|
-
:type header_text: str
|
|
704
528
|
:param input_scale: input_scale, Scale the mouse movement by this value before applying the delta
|
|
705
|
-
:type input_scale: float | None
|
|
706
529
|
:param invert: invert, Invert the mouse input
|
|
707
|
-
:type invert: bool | None
|
|
708
530
|
:param initial_x: initial_x
|
|
709
|
-
:type initial_x: int | None
|
|
710
531
|
"""
|
|
711
532
|
|
|
712
533
|
def context_pie_enum(
|
|
@@ -718,10 +539,7 @@ def context_pie_enum(
|
|
|
718
539
|
) -> None:
|
|
719
540
|
"""Undocumented, consider contributing.
|
|
720
541
|
|
|
721
|
-
:type execution_context: int | str | None
|
|
722
|
-
:type undo: bool | None
|
|
723
542
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
724
|
-
:type data_path: str
|
|
725
543
|
"""
|
|
726
544
|
|
|
727
545
|
def context_scale_float(
|
|
@@ -734,12 +552,8 @@ def context_scale_float(
|
|
|
734
552
|
) -> None:
|
|
735
553
|
"""Scale a float context value
|
|
736
554
|
|
|
737
|
-
:type execution_context: int | str | None
|
|
738
|
-
:type undo: bool | None
|
|
739
555
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
740
|
-
:type data_path: str
|
|
741
556
|
:param value: Value, Assign value
|
|
742
|
-
:type value: float | None
|
|
743
557
|
"""
|
|
744
558
|
|
|
745
559
|
def context_scale_int(
|
|
@@ -753,14 +567,9 @@ def context_scale_int(
|
|
|
753
567
|
) -> None:
|
|
754
568
|
"""Scale an int context value
|
|
755
569
|
|
|
756
|
-
:type execution_context: int | str | None
|
|
757
|
-
:type undo: bool | None
|
|
758
570
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
759
|
-
:type data_path: str
|
|
760
571
|
:param value: Value, Assign value
|
|
761
|
-
:
|
|
762
|
-
:param always_step: Always Step, Always adjust the value by a minimum of 1 when 'value' is not 1.0
|
|
763
|
-
:type always_step: bool | None
|
|
572
|
+
:param always_step: Always Step, Always adjust the value by a minimum of 1 when value is not 1.0
|
|
764
573
|
"""
|
|
765
574
|
|
|
766
575
|
def context_set_boolean(
|
|
@@ -773,12 +582,8 @@ def context_set_boolean(
|
|
|
773
582
|
) -> None:
|
|
774
583
|
"""Set a context value
|
|
775
584
|
|
|
776
|
-
:type execution_context: int | str | None
|
|
777
|
-
:type undo: bool | None
|
|
778
585
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
779
|
-
:type data_path: str
|
|
780
586
|
:param value: Value, Assignment value
|
|
781
|
-
:type value: bool | None
|
|
782
587
|
"""
|
|
783
588
|
|
|
784
589
|
def context_set_enum(
|
|
@@ -791,12 +596,8 @@ def context_set_enum(
|
|
|
791
596
|
) -> None:
|
|
792
597
|
"""Set a context value
|
|
793
598
|
|
|
794
|
-
:type execution_context: int | str | None
|
|
795
|
-
:type undo: bool | None
|
|
796
599
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
797
|
-
:type data_path: str
|
|
798
600
|
:param value: Value, Assignment value (as a string)
|
|
799
|
-
:type value: str
|
|
800
601
|
"""
|
|
801
602
|
|
|
802
603
|
def context_set_float(
|
|
@@ -810,14 +611,9 @@ def context_set_float(
|
|
|
810
611
|
) -> None:
|
|
811
612
|
"""Set a context value
|
|
812
613
|
|
|
813
|
-
:type execution_context: int | str | None
|
|
814
|
-
:type undo: bool | None
|
|
815
614
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
816
|
-
:type data_path: str
|
|
817
615
|
:param value: Value, Assignment value
|
|
818
|
-
:type value: float | None
|
|
819
616
|
:param relative: Relative, Apply relative to the current value (delta)
|
|
820
|
-
:type relative: bool | None
|
|
821
617
|
"""
|
|
822
618
|
|
|
823
619
|
def context_set_id(
|
|
@@ -830,12 +626,8 @@ def context_set_id(
|
|
|
830
626
|
) -> None:
|
|
831
627
|
"""Set a context value to an ID data-block
|
|
832
628
|
|
|
833
|
-
:type execution_context: int | str | None
|
|
834
|
-
:type undo: bool | None
|
|
835
629
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
836
|
-
:type data_path: str
|
|
837
630
|
:param value: Value, Assign value
|
|
838
|
-
:type value: str
|
|
839
631
|
"""
|
|
840
632
|
|
|
841
633
|
def context_set_int(
|
|
@@ -849,14 +641,9 @@ def context_set_int(
|
|
|
849
641
|
) -> None:
|
|
850
642
|
"""Set a context value
|
|
851
643
|
|
|
852
|
-
:type execution_context: int | str | None
|
|
853
|
-
:type undo: bool | None
|
|
854
644
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
855
|
-
:type data_path: str
|
|
856
645
|
:param value: Value, Assign value
|
|
857
|
-
:type value: int | None
|
|
858
646
|
:param relative: Relative, Apply relative to the current value (delta)
|
|
859
|
-
:type relative: bool | None
|
|
860
647
|
"""
|
|
861
648
|
|
|
862
649
|
def context_set_string(
|
|
@@ -869,12 +656,8 @@ def context_set_string(
|
|
|
869
656
|
) -> None:
|
|
870
657
|
"""Set a context value
|
|
871
658
|
|
|
872
|
-
:type execution_context: int | str | None
|
|
873
|
-
:type undo: bool | None
|
|
874
659
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
875
|
-
:type data_path: str
|
|
876
660
|
:param value: Value, Assign value
|
|
877
|
-
:type value: str
|
|
878
661
|
"""
|
|
879
662
|
|
|
880
663
|
def context_set_value(
|
|
@@ -887,12 +670,8 @@ def context_set_value(
|
|
|
887
670
|
) -> None:
|
|
888
671
|
"""Set a context value
|
|
889
672
|
|
|
890
|
-
:type execution_context: int | str | None
|
|
891
|
-
:type undo: bool | None
|
|
892
673
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
893
|
-
:type data_path: str
|
|
894
674
|
:param value: Value, Assignment value (as a string)
|
|
895
|
-
:type value: str
|
|
896
675
|
"""
|
|
897
676
|
|
|
898
677
|
def context_toggle(
|
|
@@ -905,12 +684,8 @@ def context_toggle(
|
|
|
905
684
|
) -> None:
|
|
906
685
|
"""Toggle a context value
|
|
907
686
|
|
|
908
|
-
:type execution_context: int | str | None
|
|
909
|
-
:type undo: bool | None
|
|
910
687
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
911
|
-
:type data_path: str
|
|
912
688
|
:param module: Module, Optionally override the context with a module
|
|
913
|
-
:type module: str
|
|
914
689
|
"""
|
|
915
690
|
|
|
916
691
|
def context_toggle_enum(
|
|
@@ -924,14 +699,9 @@ def context_toggle_enum(
|
|
|
924
699
|
) -> None:
|
|
925
700
|
"""Toggle a context value
|
|
926
701
|
|
|
927
|
-
:type execution_context: int | str | None
|
|
928
|
-
:type undo: bool | None
|
|
929
702
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
930
|
-
:type data_path: str
|
|
931
703
|
:param value_1: Value, Toggle enum
|
|
932
|
-
:type value_1: str
|
|
933
704
|
:param value_2: Value, Toggle enum
|
|
934
|
-
:type value_2: str
|
|
935
705
|
"""
|
|
936
706
|
|
|
937
707
|
def debug_menu(
|
|
@@ -943,10 +713,7 @@ def debug_menu(
|
|
|
943
713
|
) -> None:
|
|
944
714
|
"""Open a popup to set the debug level
|
|
945
715
|
|
|
946
|
-
:type execution_context: int | str | None
|
|
947
|
-
:type undo: bool | None
|
|
948
716
|
:param debug_value: Debug Value
|
|
949
|
-
:type debug_value: int | None
|
|
950
717
|
"""
|
|
951
718
|
|
|
952
719
|
def doc_view(
|
|
@@ -958,10 +725,7 @@ def doc_view(
|
|
|
958
725
|
) -> None:
|
|
959
726
|
"""Open online reference docs in a web browser
|
|
960
727
|
|
|
961
|
-
:type execution_context: int | str | None
|
|
962
|
-
:type undo: bool | None
|
|
963
728
|
:param doc_id: Doc ID
|
|
964
|
-
:type doc_id: str
|
|
965
729
|
"""
|
|
966
730
|
|
|
967
731
|
def doc_view_manual(
|
|
@@ -973,20 +737,15 @@ def doc_view_manual(
|
|
|
973
737
|
) -> None:
|
|
974
738
|
"""Load online manual
|
|
975
739
|
|
|
976
|
-
:type execution_context: int | str | None
|
|
977
|
-
:type undo: bool | None
|
|
978
740
|
:param doc_id: Doc ID
|
|
979
|
-
:type doc_id: str
|
|
980
741
|
"""
|
|
981
742
|
|
|
982
743
|
def doc_view_manual_ui_context(
|
|
983
|
-
execution_context: int | str | None = None,
|
|
744
|
+
execution_context: int | str | None = None,
|
|
745
|
+
undo: bool | None = None,
|
|
746
|
+
/,
|
|
984
747
|
) -> None:
|
|
985
|
-
"""View a context based online manual in a web browser
|
|
986
|
-
|
|
987
|
-
:type execution_context: int | str | None
|
|
988
|
-
:type undo: bool | None
|
|
989
|
-
"""
|
|
748
|
+
"""View a context based online manual in a web browser"""
|
|
990
749
|
|
|
991
750
|
def drop_blend_file(
|
|
992
751
|
execution_context: int | str | None = None,
|
|
@@ -997,10 +756,7 @@ def drop_blend_file(
|
|
|
997
756
|
) -> None:
|
|
998
757
|
"""Undocumented, consider contributing.
|
|
999
758
|
|
|
1000
|
-
:type execution_context: int | str | None
|
|
1001
|
-
:type undo: bool | None
|
|
1002
759
|
:param filepath: filepath
|
|
1003
|
-
:type filepath: str
|
|
1004
760
|
"""
|
|
1005
761
|
|
|
1006
762
|
def drop_import_file(
|
|
@@ -1014,12 +770,8 @@ def drop_import_file(
|
|
|
1014
770
|
) -> None:
|
|
1015
771
|
"""Operator that allows file handlers to receive file drops
|
|
1016
772
|
|
|
1017
|
-
:type execution_context: int | str | None
|
|
1018
|
-
:type undo: bool | None
|
|
1019
773
|
:param directory: Directory, Directory of the file
|
|
1020
|
-
:type directory: str
|
|
1021
774
|
:param files: Files
|
|
1022
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1023
775
|
"""
|
|
1024
776
|
|
|
1025
777
|
def fbx_import(
|
|
@@ -1055,6 +807,8 @@ def fbx_import(
|
|
|
1055
807
|
| None = "DEFAULT",
|
|
1056
808
|
sort_method: str | None = "",
|
|
1057
809
|
global_scale: float | None = 1.0,
|
|
810
|
+
mtl_name_collision_mode: typing.Literal["MAKE_UNIQUE", "REFERENCE_EXISTING"]
|
|
811
|
+
| None = "MAKE_UNIQUE",
|
|
1058
812
|
import_colors: typing.Literal["NONE", "SRGB", "LINEAR"] | None = "SRGB",
|
|
1059
813
|
use_custom_normals: bool | None = True,
|
|
1060
814
|
use_custom_props: bool | None = True,
|
|
@@ -1068,50 +822,27 @@ def fbx_import(
|
|
|
1068
822
|
) -> None:
|
|
1069
823
|
"""Import FBX file into current scene
|
|
1070
824
|
|
|
1071
|
-
:type execution_context: int | str | None
|
|
1072
|
-
:type undo: bool | None
|
|
1073
825
|
:param filepath: File Path, Path to file
|
|
1074
|
-
:type filepath: str
|
|
1075
826
|
:param directory: Directory, Directory of the file
|
|
1076
|
-
:type directory: str
|
|
1077
827
|
:param files: Files
|
|
1078
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1079
828
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1080
|
-
:type check_existing: bool | None
|
|
1081
829
|
:param filter_blender: Filter .blend files
|
|
1082
|
-
:type filter_blender: bool | None
|
|
1083
830
|
:param filter_backup: Filter .blend files
|
|
1084
|
-
:type filter_backup: bool | None
|
|
1085
831
|
:param filter_image: Filter image files
|
|
1086
|
-
:type filter_image: bool | None
|
|
1087
832
|
:param filter_movie: Filter movie files
|
|
1088
|
-
:type filter_movie: bool | None
|
|
1089
833
|
:param filter_python: Filter Python files
|
|
1090
|
-
:type filter_python: bool | None
|
|
1091
834
|
:param filter_font: Filter font files
|
|
1092
|
-
:type filter_font: bool | None
|
|
1093
835
|
:param filter_sound: Filter sound files
|
|
1094
|
-
:type filter_sound: bool | None
|
|
1095
836
|
:param filter_text: Filter text files
|
|
1096
|
-
:type filter_text: bool | None
|
|
1097
837
|
:param filter_archive: Filter archive files
|
|
1098
|
-
:type filter_archive: bool | None
|
|
1099
838
|
:param filter_btx: Filter btx files
|
|
1100
|
-
:type filter_btx: bool | None
|
|
1101
839
|
:param filter_alembic: Filter Alembic files
|
|
1102
|
-
:type filter_alembic: bool | None
|
|
1103
840
|
:param filter_usd: Filter USD files
|
|
1104
|
-
:type filter_usd: bool | None
|
|
1105
841
|
:param filter_obj: Filter OBJ files
|
|
1106
|
-
:type filter_obj: bool | None
|
|
1107
842
|
:param filter_volume: Filter OpenVDB volume files
|
|
1108
|
-
:type filter_volume: bool | None
|
|
1109
843
|
:param filter_folder: Filter folders
|
|
1110
|
-
:type filter_folder: bool | None
|
|
1111
844
|
:param filter_blenlib: Filter Blender IDs
|
|
1112
|
-
:type filter_blenlib: bool | None
|
|
1113
845
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1114
|
-
:type filemode: int | None
|
|
1115
846
|
:param display_type: Display Type
|
|
1116
847
|
|
|
1117
848
|
DEFAULT
|
|
@@ -1125,11 +856,15 @@ def fbx_import(
|
|
|
1125
856
|
|
|
1126
857
|
THUMBNAIL
|
|
1127
858
|
Thumbnails -- Display files as thumbnails.
|
|
1128
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1129
859
|
:param sort_method: File sorting mode
|
|
1130
|
-
:type sort_method: str | None
|
|
1131
860
|
:param global_scale: Scale
|
|
1132
|
-
:
|
|
861
|
+
:param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
|
|
862
|
+
|
|
863
|
+
MAKE_UNIQUE
|
|
864
|
+
Make Unique -- Import each FBX material as a unique Blender material.
|
|
865
|
+
|
|
866
|
+
REFERENCE_EXISTING
|
|
867
|
+
Reference Existing -- If a material with the same name already exists, reference that instead of importing.
|
|
1133
868
|
:param import_colors: Vertex Colors, Import vertex color attributes
|
|
1134
869
|
|
|
1135
870
|
NONE
|
|
@@ -1140,25 +875,15 @@ def fbx_import(
|
|
|
1140
875
|
|
|
1141
876
|
LINEAR
|
|
1142
877
|
Linear -- Vertex colors in the file are in linear color space.
|
|
1143
|
-
:type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
1144
878
|
:param use_custom_normals: Custom Normals, Import custom normals, if available (otherwise Blender will compute them)
|
|
1145
|
-
:type use_custom_normals: bool | None
|
|
1146
879
|
:param use_custom_props: Custom Properties, Import user properties as custom properties
|
|
1147
|
-
:type use_custom_props: bool | None
|
|
1148
880
|
:param use_custom_props_enum_as_string: Enums As Strings, Store custom property enumeration values as strings
|
|
1149
|
-
:type use_custom_props_enum_as_string: bool | None
|
|
1150
881
|
:param import_subdivision: Subdivision Data, Import FBX subdivision information as subdivision surface modifiers
|
|
1151
|
-
:type import_subdivision: bool | None
|
|
1152
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)
|
|
1153
|
-
:type ignore_leaf_bones: bool | None
|
|
1154
883
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
1155
|
-
:type validate_meshes: bool | None
|
|
1156
884
|
:param use_anim: Import Animation, Import FBX animation
|
|
1157
|
-
:type use_anim: bool | None
|
|
1158
885
|
:param anim_offset: Offset, Offset to apply to animation timestamps, in frames
|
|
1159
|
-
:type anim_offset: float | None
|
|
1160
886
|
:param filter_glob: Extension Filter
|
|
1161
|
-
:type filter_glob: str
|
|
1162
887
|
"""
|
|
1163
888
|
|
|
1164
889
|
def grease_pencil_export_pdf(
|
|
@@ -1199,46 +924,25 @@ def grease_pencil_export_pdf(
|
|
|
1199
924
|
) -> None:
|
|
1200
925
|
"""Export Grease Pencil to PDF
|
|
1201
926
|
|
|
1202
|
-
:type execution_context: int | str | None
|
|
1203
|
-
:type undo: bool | None
|
|
1204
927
|
:param filepath: File Path, Path to file
|
|
1205
|
-
:type filepath: str
|
|
1206
928
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1207
|
-
:type check_existing: bool | None
|
|
1208
929
|
:param filter_blender: Filter .blend files
|
|
1209
|
-
:type filter_blender: bool | None
|
|
1210
930
|
:param filter_backup: Filter .blend files
|
|
1211
|
-
:type filter_backup: bool | None
|
|
1212
931
|
:param filter_image: Filter image files
|
|
1213
|
-
:type filter_image: bool | None
|
|
1214
932
|
:param filter_movie: Filter movie files
|
|
1215
|
-
:type filter_movie: bool | None
|
|
1216
933
|
:param filter_python: Filter Python files
|
|
1217
|
-
:type filter_python: bool | None
|
|
1218
934
|
:param filter_font: Filter font files
|
|
1219
|
-
:type filter_font: bool | None
|
|
1220
935
|
:param filter_sound: Filter sound files
|
|
1221
|
-
:type filter_sound: bool | None
|
|
1222
936
|
:param filter_text: Filter text files
|
|
1223
|
-
:type filter_text: bool | None
|
|
1224
937
|
:param filter_archive: Filter archive files
|
|
1225
|
-
:type filter_archive: bool | None
|
|
1226
938
|
:param filter_btx: Filter btx files
|
|
1227
|
-
:type filter_btx: bool | None
|
|
1228
939
|
:param filter_alembic: Filter Alembic files
|
|
1229
|
-
:type filter_alembic: bool | None
|
|
1230
940
|
:param filter_usd: Filter USD files
|
|
1231
|
-
:type filter_usd: bool | None
|
|
1232
941
|
:param filter_obj: Filter OBJ files
|
|
1233
|
-
:type filter_obj: bool | None
|
|
1234
942
|
:param filter_volume: Filter OpenVDB volume files
|
|
1235
|
-
:type filter_volume: bool | None
|
|
1236
943
|
:param filter_folder: Filter folders
|
|
1237
|
-
:type filter_folder: bool | None
|
|
1238
944
|
:param filter_blenlib: Filter Blender IDs
|
|
1239
|
-
:type filter_blenlib: bool | None
|
|
1240
945
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1241
|
-
:type filemode: int | None
|
|
1242
946
|
:param display_type: Display Type
|
|
1243
947
|
|
|
1244
948
|
DEFAULT
|
|
@@ -1252,11 +956,8 @@ def grease_pencil_export_pdf(
|
|
|
1252
956
|
|
|
1253
957
|
THUMBNAIL
|
|
1254
958
|
Thumbnails -- Display files as thumbnails.
|
|
1255
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1256
959
|
:param sort_method: File sorting mode
|
|
1257
|
-
:type sort_method: str | None
|
|
1258
960
|
:param use_fill: Fill, Export strokes with fill enabled
|
|
1259
|
-
:type use_fill: bool | None
|
|
1260
961
|
:param selected_object_type: Object, Which objects to include in the export
|
|
1261
962
|
|
|
1262
963
|
ACTIVE
|
|
@@ -1267,7 +968,6 @@ def grease_pencil_export_pdf(
|
|
|
1267
968
|
|
|
1268
969
|
VISIBLE
|
|
1269
970
|
Visible -- Include all visible objects.
|
|
1270
|
-
:type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
|
|
1271
971
|
:param frame_mode: Frames, Which frames to include in the export
|
|
1272
972
|
|
|
1273
973
|
ACTIVE
|
|
@@ -1278,11 +978,8 @@ def grease_pencil_export_pdf(
|
|
|
1278
978
|
|
|
1279
979
|
SCENE
|
|
1280
980
|
Scene -- Include all scene frames.
|
|
1281
|
-
:type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
|
|
1282
981
|
:param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
|
|
1283
|
-
:type stroke_sample: float | None
|
|
1284
982
|
:param use_uniform_width: Uniform Width, Export strokes with uniform width
|
|
1285
|
-
:type use_uniform_width: bool | None
|
|
1286
983
|
"""
|
|
1287
984
|
|
|
1288
985
|
def grease_pencil_export_svg(
|
|
@@ -1324,46 +1021,25 @@ def grease_pencil_export_svg(
|
|
|
1324
1021
|
) -> None:
|
|
1325
1022
|
"""Export Grease Pencil to SVG
|
|
1326
1023
|
|
|
1327
|
-
:type execution_context: int | str | None
|
|
1328
|
-
:type undo: bool | None
|
|
1329
1024
|
:param filepath: File Path, Path to file
|
|
1330
|
-
:type filepath: str
|
|
1331
1025
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1332
|
-
:type check_existing: bool | None
|
|
1333
1026
|
:param filter_blender: Filter .blend files
|
|
1334
|
-
:type filter_blender: bool | None
|
|
1335
1027
|
:param filter_backup: Filter .blend files
|
|
1336
|
-
:type filter_backup: bool | None
|
|
1337
1028
|
:param filter_image: Filter image files
|
|
1338
|
-
:type filter_image: bool | None
|
|
1339
1029
|
:param filter_movie: Filter movie files
|
|
1340
|
-
:type filter_movie: bool | None
|
|
1341
1030
|
:param filter_python: Filter Python files
|
|
1342
|
-
:type filter_python: bool | None
|
|
1343
1031
|
:param filter_font: Filter font files
|
|
1344
|
-
:type filter_font: bool | None
|
|
1345
1032
|
:param filter_sound: Filter sound files
|
|
1346
|
-
:type filter_sound: bool | None
|
|
1347
1033
|
:param filter_text: Filter text files
|
|
1348
|
-
:type filter_text: bool | None
|
|
1349
1034
|
:param filter_archive: Filter archive files
|
|
1350
|
-
:type filter_archive: bool | None
|
|
1351
1035
|
:param filter_btx: Filter btx files
|
|
1352
|
-
:type filter_btx: bool | None
|
|
1353
1036
|
:param filter_alembic: Filter Alembic files
|
|
1354
|
-
:type filter_alembic: bool | None
|
|
1355
1037
|
:param filter_usd: Filter USD files
|
|
1356
|
-
:type filter_usd: bool | None
|
|
1357
1038
|
:param filter_obj: Filter OBJ files
|
|
1358
|
-
:type filter_obj: bool | None
|
|
1359
1039
|
:param filter_volume: Filter OpenVDB volume files
|
|
1360
|
-
:type filter_volume: bool | None
|
|
1361
1040
|
:param filter_folder: Filter folders
|
|
1362
|
-
:type filter_folder: bool | None
|
|
1363
1041
|
:param filter_blenlib: Filter Blender IDs
|
|
1364
|
-
:type filter_blenlib: bool | None
|
|
1365
1042
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1366
|
-
:type filemode: int | None
|
|
1367
1043
|
:param display_type: Display Type
|
|
1368
1044
|
|
|
1369
1045
|
DEFAULT
|
|
@@ -1377,11 +1053,8 @@ def grease_pencil_export_svg(
|
|
|
1377
1053
|
|
|
1378
1054
|
THUMBNAIL
|
|
1379
1055
|
Thumbnails -- Display files as thumbnails.
|
|
1380
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1381
1056
|
:param sort_method: File sorting mode
|
|
1382
|
-
:type sort_method: str | None
|
|
1383
1057
|
:param use_fill: Fill, Export strokes with fill enabled
|
|
1384
|
-
:type use_fill: bool | None
|
|
1385
1058
|
:param selected_object_type: Object, Which objects to include in the export
|
|
1386
1059
|
|
|
1387
1060
|
ACTIVE
|
|
@@ -1392,7 +1065,6 @@ def grease_pencil_export_svg(
|
|
|
1392
1065
|
|
|
1393
1066
|
VISIBLE
|
|
1394
1067
|
Visible -- Include all visible objects.
|
|
1395
|
-
:type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
|
|
1396
1068
|
:param frame_mode: Frames, Which frames to include in the export
|
|
1397
1069
|
|
|
1398
1070
|
ACTIVE
|
|
@@ -1403,13 +1075,9 @@ def grease_pencil_export_svg(
|
|
|
1403
1075
|
|
|
1404
1076
|
SCENE
|
|
1405
1077
|
Scene -- Include all scene frames.
|
|
1406
|
-
:type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
|
|
1407
1078
|
:param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
|
|
1408
|
-
:type stroke_sample: float | None
|
|
1409
1079
|
:param use_uniform_width: Uniform Width, Export strokes with uniform width
|
|
1410
|
-
:type use_uniform_width: bool | None
|
|
1411
1080
|
:param use_clip_camera: Clip Camera, Clip drawings to camera size when exporting in camera view
|
|
1412
|
-
:type use_clip_camera: bool | None
|
|
1413
1081
|
"""
|
|
1414
1082
|
|
|
1415
1083
|
def grease_pencil_import_svg(
|
|
@@ -1451,52 +1119,28 @@ def grease_pencil_import_svg(
|
|
|
1451
1119
|
) -> None:
|
|
1452
1120
|
"""Import SVG into Grease Pencil
|
|
1453
1121
|
|
|
1454
|
-
:type execution_context: int | str | None
|
|
1455
|
-
:type undo: bool | None
|
|
1456
1122
|
:param filepath: File Path, Path to file
|
|
1457
|
-
:type filepath: str
|
|
1458
1123
|
:param directory: Directory, Directory of the file
|
|
1459
|
-
:type directory: str
|
|
1460
1124
|
:param files: Files
|
|
1461
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1462
1125
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1463
|
-
:type check_existing: bool | None
|
|
1464
1126
|
:param filter_blender: Filter .blend files
|
|
1465
|
-
:type filter_blender: bool | None
|
|
1466
1127
|
:param filter_backup: Filter .blend files
|
|
1467
|
-
:type filter_backup: bool | None
|
|
1468
1128
|
:param filter_image: Filter image files
|
|
1469
|
-
:type filter_image: bool | None
|
|
1470
1129
|
:param filter_movie: Filter movie files
|
|
1471
|
-
:type filter_movie: bool | None
|
|
1472
1130
|
:param filter_python: Filter Python files
|
|
1473
|
-
:type filter_python: bool | None
|
|
1474
1131
|
:param filter_font: Filter font files
|
|
1475
|
-
:type filter_font: bool | None
|
|
1476
1132
|
:param filter_sound: Filter sound files
|
|
1477
|
-
:type filter_sound: bool | None
|
|
1478
1133
|
:param filter_text: Filter text files
|
|
1479
|
-
:type filter_text: bool | None
|
|
1480
1134
|
:param filter_archive: Filter archive files
|
|
1481
|
-
:type filter_archive: bool | None
|
|
1482
1135
|
:param filter_btx: Filter btx files
|
|
1483
|
-
:type filter_btx: bool | None
|
|
1484
1136
|
:param filter_alembic: Filter Alembic files
|
|
1485
|
-
:type filter_alembic: bool | None
|
|
1486
1137
|
:param filter_usd: Filter USD files
|
|
1487
|
-
:type filter_usd: bool | None
|
|
1488
1138
|
:param filter_obj: Filter OBJ files
|
|
1489
|
-
:type filter_obj: bool | None
|
|
1490
1139
|
:param filter_volume: Filter OpenVDB volume files
|
|
1491
|
-
:type filter_volume: bool | None
|
|
1492
1140
|
:param filter_folder: Filter folders
|
|
1493
|
-
:type filter_folder: bool | None
|
|
1494
1141
|
:param filter_blenlib: Filter Blender IDs
|
|
1495
|
-
:type filter_blenlib: bool | None
|
|
1496
1142
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1497
|
-
:type filemode: int | None
|
|
1498
1143
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1499
|
-
:type relative_path: bool | None
|
|
1500
1144
|
:param display_type: Display Type
|
|
1501
1145
|
|
|
1502
1146
|
DEFAULT
|
|
@@ -1510,15 +1154,10 @@ def grease_pencil_import_svg(
|
|
|
1510
1154
|
|
|
1511
1155
|
THUMBNAIL
|
|
1512
1156
|
Thumbnails -- Display files as thumbnails.
|
|
1513
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1514
1157
|
:param sort_method: File sorting mode
|
|
1515
|
-
:type sort_method: str | None
|
|
1516
1158
|
:param resolution: Resolution, Resolution of the generated strokes
|
|
1517
|
-
:type resolution: int | None
|
|
1518
1159
|
:param scale: Scale, Scale of the final strokes
|
|
1519
|
-
:
|
|
1520
|
-
:param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to imported data
|
|
1521
|
-
:type use_scene_unit: bool | None
|
|
1160
|
+
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
1522
1161
|
"""
|
|
1523
1162
|
|
|
1524
1163
|
def id_linked_relocate(
|
|
@@ -1564,54 +1203,29 @@ def id_linked_relocate(
|
|
|
1564
1203
|
) -> None:
|
|
1565
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
|
|
1566
1205
|
|
|
1567
|
-
:type execution_context: int | str | None
|
|
1568
|
-
:type undo: bool | None
|
|
1569
1206
|
:param id_session_uid: Linked ID Session UID, Unique runtime identifier for the linked ID to relocate
|
|
1570
|
-
:type id_session_uid: int | None
|
|
1571
1207
|
:param filepath: File Path, Path to file
|
|
1572
|
-
:type filepath: str
|
|
1573
1208
|
:param directory: Directory, Directory of the file
|
|
1574
|
-
:type directory: str
|
|
1575
1209
|
:param filename: File Name, Name of the file
|
|
1576
|
-
:type filename: str
|
|
1577
1210
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1578
|
-
:type check_existing: bool | None
|
|
1579
1211
|
:param filter_blender: Filter .blend files
|
|
1580
|
-
:type filter_blender: bool | None
|
|
1581
1212
|
:param filter_backup: Filter .blend files
|
|
1582
|
-
:type filter_backup: bool | None
|
|
1583
1213
|
:param filter_image: Filter image files
|
|
1584
|
-
:type filter_image: bool | None
|
|
1585
1214
|
:param filter_movie: Filter movie files
|
|
1586
|
-
:type filter_movie: bool | None
|
|
1587
1215
|
:param filter_python: Filter Python files
|
|
1588
|
-
:type filter_python: bool | None
|
|
1589
1216
|
:param filter_font: Filter font files
|
|
1590
|
-
:type filter_font: bool | None
|
|
1591
1217
|
:param filter_sound: Filter sound files
|
|
1592
|
-
:type filter_sound: bool | None
|
|
1593
1218
|
:param filter_text: Filter text files
|
|
1594
|
-
:type filter_text: bool | None
|
|
1595
1219
|
:param filter_archive: Filter archive files
|
|
1596
|
-
:type filter_archive: bool | None
|
|
1597
1220
|
:param filter_btx: Filter btx files
|
|
1598
|
-
:type filter_btx: bool | None
|
|
1599
1221
|
:param filter_alembic: Filter Alembic files
|
|
1600
|
-
:type filter_alembic: bool | None
|
|
1601
1222
|
:param filter_usd: Filter USD files
|
|
1602
|
-
:type filter_usd: bool | None
|
|
1603
1223
|
:param filter_obj: Filter OBJ files
|
|
1604
|
-
:type filter_obj: bool | None
|
|
1605
1224
|
:param filter_volume: Filter OpenVDB volume files
|
|
1606
|
-
:type filter_volume: bool | None
|
|
1607
1225
|
:param filter_folder: Filter folders
|
|
1608
|
-
:type filter_folder: bool | None
|
|
1609
1226
|
:param filter_blenlib: Filter Blender IDs
|
|
1610
|
-
:type filter_blenlib: bool | None
|
|
1611
1227
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1612
|
-
:type filemode: int | None
|
|
1613
1228
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1614
|
-
:type relative_path: bool | None
|
|
1615
1229
|
:param display_type: Display Type
|
|
1616
1230
|
|
|
1617
1231
|
DEFAULT
|
|
@@ -1625,23 +1239,14 @@ def id_linked_relocate(
|
|
|
1625
1239
|
|
|
1626
1240
|
THUMBNAIL
|
|
1627
1241
|
Thumbnails -- Display files as thumbnails.
|
|
1628
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1629
1242
|
:param sort_method: File sorting mode
|
|
1630
|
-
:type sort_method: str | None
|
|
1631
1243
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
1632
|
-
:type link: bool | None
|
|
1633
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
|
|
1634
|
-
:
|
|
1635
|
-
:param clear_asset_data: Clear Asset Data, Don't add asset meta-data or tags from the original data-block
|
|
1636
|
-
:type clear_asset_data: bool | None
|
|
1245
|
+
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
1637
1246
|
:param autoselect: Select, Select new objects
|
|
1638
|
-
:type autoselect: bool | None
|
|
1639
1247
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
1640
|
-
:type active_collection: bool | None
|
|
1641
1248
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
1642
|
-
:type instance_collections: bool | None
|
|
1643
1249
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
1644
|
-
:type instance_object_data: bool | None
|
|
1645
1250
|
"""
|
|
1646
1251
|
|
|
1647
1252
|
def interface_theme_preset_add(
|
|
@@ -1655,14 +1260,9 @@ def interface_theme_preset_add(
|
|
|
1655
1260
|
) -> None:
|
|
1656
1261
|
"""Add a custom theme to the preset list
|
|
1657
1262
|
|
|
1658
|
-
:type execution_context: int | str | None
|
|
1659
|
-
:type undo: bool | None
|
|
1660
1263
|
:param name: Name, Name of the preset, used to make the path name
|
|
1661
|
-
:type name: str
|
|
1662
1264
|
:param remove_name: remove_name
|
|
1663
|
-
:type remove_name: bool | None
|
|
1664
1265
|
:param remove_active: remove_active
|
|
1665
|
-
:type remove_active: bool | None
|
|
1666
1266
|
"""
|
|
1667
1267
|
|
|
1668
1268
|
def interface_theme_preset_remove(
|
|
@@ -1676,14 +1276,9 @@ def interface_theme_preset_remove(
|
|
|
1676
1276
|
) -> None:
|
|
1677
1277
|
"""Remove a custom theme from the preset list
|
|
1678
1278
|
|
|
1679
|
-
:type execution_context: int | str | None
|
|
1680
|
-
:type undo: bool | None
|
|
1681
1279
|
:param name: Name, Name of the preset, used to make the path name
|
|
1682
|
-
:type name: str
|
|
1683
1280
|
:param remove_name: remove_name
|
|
1684
|
-
:type remove_name: bool | None
|
|
1685
1281
|
:param remove_active: remove_active
|
|
1686
|
-
:type remove_active: bool | None
|
|
1687
1282
|
"""
|
|
1688
1283
|
|
|
1689
1284
|
def interface_theme_preset_save(
|
|
@@ -1697,14 +1292,9 @@ def interface_theme_preset_save(
|
|
|
1697
1292
|
) -> None:
|
|
1698
1293
|
"""Save a custom theme in the preset list
|
|
1699
1294
|
|
|
1700
|
-
:type execution_context: int | str | None
|
|
1701
|
-
:type undo: bool | None
|
|
1702
1295
|
:param name: Name, Name of the preset, used to make the path name
|
|
1703
|
-
:type name: str
|
|
1704
1296
|
:param remove_name: remove_name
|
|
1705
|
-
:type remove_name: bool | None
|
|
1706
1297
|
:param remove_active: remove_active
|
|
1707
|
-
:type remove_active: bool | None
|
|
1708
1298
|
"""
|
|
1709
1299
|
|
|
1710
1300
|
def keyconfig_preset_add(
|
|
@@ -1718,14 +1308,9 @@ def keyconfig_preset_add(
|
|
|
1718
1308
|
) -> None:
|
|
1719
1309
|
"""Add a custom keymap configuration to the preset list
|
|
1720
1310
|
|
|
1721
|
-
:type execution_context: int | str | None
|
|
1722
|
-
:type undo: bool | None
|
|
1723
1311
|
:param name: Name, Name of the preset, used to make the path name
|
|
1724
|
-
:type name: str
|
|
1725
1312
|
:param remove_name: remove_name
|
|
1726
|
-
:type remove_name: bool | None
|
|
1727
1313
|
:param remove_active: remove_active
|
|
1728
|
-
:type remove_active: bool | None
|
|
1729
1314
|
"""
|
|
1730
1315
|
|
|
1731
1316
|
def keyconfig_preset_remove(
|
|
@@ -1739,14 +1324,9 @@ def keyconfig_preset_remove(
|
|
|
1739
1324
|
) -> None:
|
|
1740
1325
|
"""Remove a custom keymap configuration from the preset list
|
|
1741
1326
|
|
|
1742
|
-
:type execution_context: int | str | None
|
|
1743
|
-
:type undo: bool | None
|
|
1744
1327
|
:param name: Name, Name of the preset, used to make the path name
|
|
1745
|
-
:type name: str
|
|
1746
1328
|
:param remove_name: remove_name
|
|
1747
|
-
:type remove_name: bool | None
|
|
1748
1329
|
:param remove_active: remove_active
|
|
1749
|
-
:type remove_active: bool | None
|
|
1750
1330
|
"""
|
|
1751
1331
|
|
|
1752
1332
|
def lib_reload(
|
|
@@ -1786,56 +1366,30 @@ def lib_reload(
|
|
|
1786
1366
|
) -> None:
|
|
1787
1367
|
"""Reload the given library
|
|
1788
1368
|
|
|
1789
|
-
:type execution_context: int | str | None
|
|
1790
|
-
:type undo: bool | None
|
|
1791
1369
|
:param library: Library, Library to reload
|
|
1792
|
-
:type library: str
|
|
1793
1370
|
:param filepath: File Path, Path to file
|
|
1794
|
-
:type filepath: str
|
|
1795
1371
|
:param directory: Directory, Directory of the file
|
|
1796
|
-
:type directory: str
|
|
1797
1372
|
:param filename: File Name, Name of the file
|
|
1798
|
-
:type filename: str
|
|
1799
1373
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1800
|
-
:type hide_props_region: bool | None
|
|
1801
1374
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1802
|
-
:type check_existing: bool | None
|
|
1803
1375
|
:param filter_blender: Filter .blend files
|
|
1804
|
-
:type filter_blender: bool | None
|
|
1805
1376
|
:param filter_backup: Filter .blend files
|
|
1806
|
-
:type filter_backup: bool | None
|
|
1807
1377
|
:param filter_image: Filter image files
|
|
1808
|
-
:type filter_image: bool | None
|
|
1809
1378
|
:param filter_movie: Filter movie files
|
|
1810
|
-
:type filter_movie: bool | None
|
|
1811
1379
|
:param filter_python: Filter Python files
|
|
1812
|
-
:type filter_python: bool | None
|
|
1813
1380
|
:param filter_font: Filter font files
|
|
1814
|
-
:type filter_font: bool | None
|
|
1815
1381
|
:param filter_sound: Filter sound files
|
|
1816
|
-
:type filter_sound: bool | None
|
|
1817
1382
|
:param filter_text: Filter text files
|
|
1818
|
-
:type filter_text: bool | None
|
|
1819
1383
|
:param filter_archive: Filter archive files
|
|
1820
|
-
:type filter_archive: bool | None
|
|
1821
1384
|
:param filter_btx: Filter btx files
|
|
1822
|
-
:type filter_btx: bool | None
|
|
1823
1385
|
:param filter_alembic: Filter Alembic files
|
|
1824
|
-
:type filter_alembic: bool | None
|
|
1825
1386
|
:param filter_usd: Filter USD files
|
|
1826
|
-
:type filter_usd: bool | None
|
|
1827
1387
|
:param filter_obj: Filter OBJ files
|
|
1828
|
-
:type filter_obj: bool | None
|
|
1829
1388
|
:param filter_volume: Filter OpenVDB volume files
|
|
1830
|
-
:type filter_volume: bool | None
|
|
1831
1389
|
:param filter_folder: Filter folders
|
|
1832
|
-
:type filter_folder: bool | None
|
|
1833
1390
|
:param filter_blenlib: Filter Blender IDs
|
|
1834
|
-
:type filter_blenlib: bool | None
|
|
1835
1391
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1836
|
-
:type filemode: int | None
|
|
1837
1392
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1838
|
-
:type relative_path: bool | None
|
|
1839
1393
|
:param display_type: Display Type
|
|
1840
1394
|
|
|
1841
1395
|
DEFAULT
|
|
@@ -1849,9 +1403,7 @@ def lib_reload(
|
|
|
1849
1403
|
|
|
1850
1404
|
THUMBNAIL
|
|
1851
1405
|
Thumbnails -- Display files as thumbnails.
|
|
1852
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1853
1406
|
:param sort_method: File sorting mode
|
|
1854
|
-
:type sort_method: str | None
|
|
1855
1407
|
"""
|
|
1856
1408
|
|
|
1857
1409
|
def lib_relocate(
|
|
@@ -1893,58 +1445,31 @@ def lib_relocate(
|
|
|
1893
1445
|
) -> None:
|
|
1894
1446
|
"""Relocate the given library to one or several others
|
|
1895
1447
|
|
|
1896
|
-
:type execution_context: int | str | None
|
|
1897
|
-
:type undo: bool | None
|
|
1898
1448
|
:param library: Library, Library to relocate
|
|
1899
|
-
:type library: str
|
|
1900
1449
|
:param filepath: File Path, Path to file
|
|
1901
|
-
:type filepath: str
|
|
1902
1450
|
:param directory: Directory, Directory of the file
|
|
1903
|
-
:type directory: str
|
|
1904
1451
|
:param filename: File Name, Name of the file
|
|
1905
|
-
:type filename: str
|
|
1906
1452
|
:param files: Files
|
|
1907
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1908
1453
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1909
|
-
:type hide_props_region: bool | None
|
|
1910
1454
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1911
|
-
:type check_existing: bool | None
|
|
1912
1455
|
:param filter_blender: Filter .blend files
|
|
1913
|
-
:type filter_blender: bool | None
|
|
1914
1456
|
:param filter_backup: Filter .blend files
|
|
1915
|
-
:type filter_backup: bool | None
|
|
1916
1457
|
:param filter_image: Filter image files
|
|
1917
|
-
:type filter_image: bool | None
|
|
1918
1458
|
:param filter_movie: Filter movie files
|
|
1919
|
-
:type filter_movie: bool | None
|
|
1920
1459
|
:param filter_python: Filter Python files
|
|
1921
|
-
:type filter_python: bool | None
|
|
1922
1460
|
:param filter_font: Filter font files
|
|
1923
|
-
:type filter_font: bool | None
|
|
1924
1461
|
:param filter_sound: Filter sound files
|
|
1925
|
-
:type filter_sound: bool | None
|
|
1926
1462
|
:param filter_text: Filter text files
|
|
1927
|
-
:type filter_text: bool | None
|
|
1928
1463
|
:param filter_archive: Filter archive files
|
|
1929
|
-
:type filter_archive: bool | None
|
|
1930
1464
|
:param filter_btx: Filter btx files
|
|
1931
|
-
:type filter_btx: bool | None
|
|
1932
1465
|
:param filter_alembic: Filter Alembic files
|
|
1933
|
-
:type filter_alembic: bool | None
|
|
1934
1466
|
:param filter_usd: Filter USD files
|
|
1935
|
-
:type filter_usd: bool | None
|
|
1936
1467
|
:param filter_obj: Filter OBJ files
|
|
1937
|
-
:type filter_obj: bool | None
|
|
1938
1468
|
:param filter_volume: Filter OpenVDB volume files
|
|
1939
|
-
:type filter_volume: bool | None
|
|
1940
1469
|
:param filter_folder: Filter folders
|
|
1941
|
-
:type filter_folder: bool | None
|
|
1942
1470
|
:param filter_blenlib: Filter Blender IDs
|
|
1943
|
-
:type filter_blenlib: bool | None
|
|
1944
1471
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1945
|
-
:type filemode: int | None
|
|
1946
1472
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1947
|
-
:type relative_path: bool | None
|
|
1948
1473
|
:param display_type: Display Type
|
|
1949
1474
|
|
|
1950
1475
|
DEFAULT
|
|
@@ -1958,9 +1483,7 @@ def lib_relocate(
|
|
|
1958
1483
|
|
|
1959
1484
|
THUMBNAIL
|
|
1960
1485
|
Thumbnails -- Display files as thumbnails.
|
|
1961
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1962
1486
|
:param sort_method: File sorting mode
|
|
1963
|
-
:type sort_method: str | None
|
|
1964
1487
|
"""
|
|
1965
1488
|
|
|
1966
1489
|
def link(
|
|
@@ -2007,54 +1530,29 @@ def link(
|
|
|
2007
1530
|
) -> None:
|
|
2008
1531
|
"""Link from a Library .blend file
|
|
2009
1532
|
|
|
2010
|
-
:type execution_context: int | str | None
|
|
2011
|
-
:type undo: bool | None
|
|
2012
1533
|
:param filepath: File Path, Path to file
|
|
2013
|
-
:type filepath: str
|
|
2014
1534
|
:param directory: Directory, Directory of the file
|
|
2015
|
-
:type directory: str
|
|
2016
1535
|
:param filename: File Name, Name of the file
|
|
2017
|
-
:type filename: str
|
|
2018
1536
|
:param files: Files
|
|
2019
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2020
1537
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2021
|
-
:type check_existing: bool | None
|
|
2022
1538
|
:param filter_blender: Filter .blend files
|
|
2023
|
-
:type filter_blender: bool | None
|
|
2024
1539
|
:param filter_backup: Filter .blend files
|
|
2025
|
-
:type filter_backup: bool | None
|
|
2026
1540
|
:param filter_image: Filter image files
|
|
2027
|
-
:type filter_image: bool | None
|
|
2028
1541
|
:param filter_movie: Filter movie files
|
|
2029
|
-
:type filter_movie: bool | None
|
|
2030
1542
|
:param filter_python: Filter Python files
|
|
2031
|
-
:type filter_python: bool | None
|
|
2032
1543
|
:param filter_font: Filter font files
|
|
2033
|
-
:type filter_font: bool | None
|
|
2034
1544
|
:param filter_sound: Filter sound files
|
|
2035
|
-
:type filter_sound: bool | None
|
|
2036
1545
|
:param filter_text: Filter text files
|
|
2037
|
-
:type filter_text: bool | None
|
|
2038
1546
|
:param filter_archive: Filter archive files
|
|
2039
|
-
:type filter_archive: bool | None
|
|
2040
1547
|
:param filter_btx: Filter btx files
|
|
2041
|
-
:type filter_btx: bool | None
|
|
2042
1548
|
:param filter_alembic: Filter Alembic files
|
|
2043
|
-
:type filter_alembic: bool | None
|
|
2044
1549
|
:param filter_usd: Filter USD files
|
|
2045
|
-
:type filter_usd: bool | None
|
|
2046
1550
|
:param filter_obj: Filter OBJ files
|
|
2047
|
-
:type filter_obj: bool | None
|
|
2048
1551
|
:param filter_volume: Filter OpenVDB volume files
|
|
2049
|
-
:type filter_volume: bool | None
|
|
2050
1552
|
:param filter_folder: Filter folders
|
|
2051
|
-
:type filter_folder: bool | None
|
|
2052
1553
|
:param filter_blenlib: Filter Blender IDs
|
|
2053
|
-
:type filter_blenlib: bool | None
|
|
2054
1554
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2055
|
-
:type filemode: int | None
|
|
2056
1555
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
2057
|
-
:type relative_path: bool | None
|
|
2058
1556
|
:param display_type: Display Type
|
|
2059
1557
|
|
|
2060
1558
|
DEFAULT
|
|
@@ -2068,33 +1566,22 @@ def link(
|
|
|
2068
1566
|
|
|
2069
1567
|
THUMBNAIL
|
|
2070
1568
|
Thumbnails -- Display files as thumbnails.
|
|
2071
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2072
1569
|
:param sort_method: File sorting mode
|
|
2073
|
-
:type sort_method: str | None
|
|
2074
1570
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
2075
|
-
:type link: bool | None
|
|
2076
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
|
|
2077
|
-
:
|
|
2078
|
-
:param clear_asset_data: Clear Asset Data, Don't add asset meta-data or tags from the original data-block
|
|
2079
|
-
:type clear_asset_data: bool | None
|
|
1572
|
+
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
2080
1573
|
:param autoselect: Select, Select new objects
|
|
2081
|
-
:type autoselect: bool | None
|
|
2082
1574
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
2083
|
-
:type active_collection: bool | None
|
|
2084
1575
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
2085
|
-
:type instance_collections: bool | None
|
|
2086
1576
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
2087
|
-
:type instance_object_data: bool | None
|
|
2088
1577
|
"""
|
|
2089
1578
|
|
|
2090
1579
|
def memory_statistics(
|
|
2091
|
-
execution_context: int | str | None = None,
|
|
1580
|
+
execution_context: int | str | None = None,
|
|
1581
|
+
undo: bool | None = None,
|
|
1582
|
+
/,
|
|
2092
1583
|
) -> None:
|
|
2093
|
-
"""Print memory statistics to the console
|
|
2094
|
-
|
|
2095
|
-
:type execution_context: int | str | None
|
|
2096
|
-
:type undo: bool | None
|
|
2097
|
-
"""
|
|
1584
|
+
"""Print memory statistics to the console"""
|
|
2098
1585
|
|
|
2099
1586
|
def obj_export(
|
|
2100
1587
|
execution_context: int | str | None = None,
|
|
@@ -2136,6 +1623,7 @@ def obj_export(
|
|
|
2136
1623
|
| None = "Y",
|
|
2137
1624
|
global_scale: float | None = 1.0,
|
|
2138
1625
|
apply_modifiers: bool | None = True,
|
|
1626
|
+
apply_transform: bool | None = True,
|
|
2139
1627
|
export_eval_mode: typing.Literal["DAG_EVAL_RENDER", "DAG_EVAL_VIEWPORT"]
|
|
2140
1628
|
| None = "DAG_EVAL_VIEWPORT",
|
|
2141
1629
|
export_selected_objects: bool | None = False,
|
|
@@ -2158,46 +1646,25 @@ def obj_export(
|
|
|
2158
1646
|
) -> None:
|
|
2159
1647
|
"""Save the scene to a Wavefront OBJ file
|
|
2160
1648
|
|
|
2161
|
-
:type execution_context: int | str | None
|
|
2162
|
-
:type undo: bool | None
|
|
2163
1649
|
:param filepath: File Path, Path to file
|
|
2164
|
-
:type filepath: str
|
|
2165
1650
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2166
|
-
:type check_existing: bool | None
|
|
2167
1651
|
:param filter_blender: Filter .blend files
|
|
2168
|
-
:type filter_blender: bool | None
|
|
2169
1652
|
:param filter_backup: Filter .blend files
|
|
2170
|
-
:type filter_backup: bool | None
|
|
2171
1653
|
:param filter_image: Filter image files
|
|
2172
|
-
:type filter_image: bool | None
|
|
2173
1654
|
:param filter_movie: Filter movie files
|
|
2174
|
-
:type filter_movie: bool | None
|
|
2175
1655
|
:param filter_python: Filter Python files
|
|
2176
|
-
:type filter_python: bool | None
|
|
2177
1656
|
:param filter_font: Filter font files
|
|
2178
|
-
:type filter_font: bool | None
|
|
2179
1657
|
:param filter_sound: Filter sound files
|
|
2180
|
-
:type filter_sound: bool | None
|
|
2181
1658
|
:param filter_text: Filter text files
|
|
2182
|
-
:type filter_text: bool | None
|
|
2183
1659
|
:param filter_archive: Filter archive files
|
|
2184
|
-
:type filter_archive: bool | None
|
|
2185
1660
|
:param filter_btx: Filter btx files
|
|
2186
|
-
:type filter_btx: bool | None
|
|
2187
1661
|
:param filter_alembic: Filter Alembic files
|
|
2188
|
-
:type filter_alembic: bool | None
|
|
2189
1662
|
:param filter_usd: Filter USD files
|
|
2190
|
-
:type filter_usd: bool | None
|
|
2191
1663
|
:param filter_obj: Filter OBJ files
|
|
2192
|
-
:type filter_obj: bool | None
|
|
2193
1664
|
:param filter_volume: Filter OpenVDB volume files
|
|
2194
|
-
:type filter_volume: bool | None
|
|
2195
1665
|
:param filter_folder: Filter folders
|
|
2196
|
-
:type filter_folder: bool | None
|
|
2197
1666
|
:param filter_blenlib: Filter Blender IDs
|
|
2198
|
-
:type filter_blenlib: bool | None
|
|
2199
1667
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2200
|
-
:type filemode: int | None
|
|
2201
1668
|
:param display_type: Display Type
|
|
2202
1669
|
|
|
2203
1670
|
DEFAULT
|
|
@@ -2211,15 +1678,10 @@ def obj_export(
|
|
|
2211
1678
|
|
|
2212
1679
|
THUMBNAIL
|
|
2213
1680
|
Thumbnails -- Display files as thumbnails.
|
|
2214
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2215
1681
|
:param sort_method: File sorting mode
|
|
2216
|
-
:type sort_method: str | None
|
|
2217
1682
|
:param export_animation: Export Animation, Export multiple frames instead of the current frame only
|
|
2218
|
-
:type export_animation: bool | None
|
|
2219
1683
|
:param start_frame: Start Frame, The first frame to be exported
|
|
2220
|
-
:type start_frame: int | None
|
|
2221
1684
|
:param end_frame: End Frame, The last frame to be exported
|
|
2222
|
-
:type end_frame: int | None
|
|
2223
1685
|
:param forward_axis: Forward Axis
|
|
2224
1686
|
|
|
2225
1687
|
X
|
|
@@ -2239,7 +1701,6 @@ def obj_export(
|
|
|
2239
1701
|
|
|
2240
1702
|
NEGATIVE_Z
|
|
2241
1703
|
-Z -- Negative Z axis.
|
|
2242
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2243
1704
|
:param up_axis: Up Axis
|
|
2244
1705
|
|
|
2245
1706
|
X
|
|
@@ -2259,11 +1720,9 @@ def obj_export(
|
|
|
2259
1720
|
|
|
2260
1721
|
NEGATIVE_Z
|
|
2261
1722
|
-Z -- Negative Z axis.
|
|
2262
|
-
:
|
|
2263
|
-
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
|
|
2264
|
-
:type global_scale: float | None
|
|
1723
|
+
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2265
1724
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
2266
|
-
:
|
|
1725
|
+
:param apply_transform: Apply Transform, Apply object transforms to exported vertices
|
|
2267
1726
|
:param export_eval_mode: Object Properties, Determines properties like object visibility, modifiers etc., where they differ for Render and Viewport
|
|
2268
1727
|
|
|
2269
1728
|
DAG_EVAL_RENDER
|
|
@@ -2271,19 +1730,12 @@ def obj_export(
|
|
|
2271
1730
|
|
|
2272
1731
|
DAG_EVAL_VIEWPORT
|
|
2273
1732
|
Viewport -- Export objects as they appear in the viewport.
|
|
2274
|
-
:type export_eval_mode: typing.Literal['DAG_EVAL_RENDER','DAG_EVAL_VIEWPORT'] | None
|
|
2275
1733
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
2276
|
-
:type export_selected_objects: bool | None
|
|
2277
1734
|
:param export_uv: Export UVs
|
|
2278
|
-
:type export_uv: bool | None
|
|
2279
1735
|
:param export_normals: Export Normals, Export per-face normals if the face is flat-shaded, per-face-corner normals if smooth-shaded
|
|
2280
|
-
:type export_normals: bool | None
|
|
2281
1736
|
:param export_colors: Export Colors, Export per-vertex colors
|
|
2282
|
-
:type export_colors: bool | None
|
|
2283
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
|
|
2284
|
-
:type export_materials: bool | None
|
|
2285
1738
|
:param export_pbr_extensions: Export Materials with PBR Extensions, Export MTL library using PBR extensions (roughness, metallic, sheen, coat, anisotropy, transmission)
|
|
2286
|
-
:type export_pbr_extensions: bool | None
|
|
2287
1739
|
:param path_mode: Path Mode, Method used to reference paths
|
|
2288
1740
|
|
|
2289
1741
|
AUTO
|
|
@@ -2303,25 +1755,15 @@ def obj_export(
|
|
|
2303
1755
|
|
|
2304
1756
|
COPY
|
|
2305
1757
|
Copy -- Copy the file to the destination path.
|
|
2306
|
-
:type path_mode: typing.Literal['AUTO','ABSOLUTE','RELATIVE','MATCH','STRIP','COPY'] | None
|
|
2307
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
|
|
2308
|
-
:type export_triangulated_mesh: bool | None
|
|
2309
1759
|
:param export_curves_as_nurbs: Export Curves as NURBS, Export curves in parametric form instead of exporting as mesh
|
|
2310
|
-
:
|
|
2311
|
-
:param export_object_groups: Export Object Groups, Append mesh name to object name, separated by a '_'
|
|
2312
|
-
:type export_object_groups: bool | None
|
|
1760
|
+
:param export_object_groups: Export Object Groups, Append mesh name to object name, separated by a _
|
|
2313
1761
|
:param export_material_groups: Export Material Groups, Generate an OBJ group for each part of a geometry using a different material
|
|
2314
|
-
:type export_material_groups: bool | None
|
|
2315
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
|
|
2316
|
-
:type export_vertex_groups: bool | None
|
|
2317
1763
|
:param export_smooth_groups: Export Smooth Groups, Generate smooth groups identifiers for each group of smooth faces, as unique integer values by default
|
|
2318
|
-
:
|
|
2319
|
-
: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
|
|
2320
|
-
:type smooth_group_bitflags: bool | None
|
|
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
|
|
2321
1765
|
:param filter_glob: Extension Filter
|
|
2322
|
-
:type filter_glob: str
|
|
2323
1766
|
:param collection: Collection
|
|
2324
|
-
:type collection: str
|
|
2325
1767
|
"""
|
|
2326
1768
|
|
|
2327
1769
|
def obj_import(
|
|
@@ -2370,54 +1812,33 @@ def obj_import(
|
|
|
2370
1812
|
validate_meshes: bool | None = True,
|
|
2371
1813
|
close_spline_loops: bool | None = True,
|
|
2372
1814
|
collection_separator: str = "",
|
|
1815
|
+
mtl_name_collision_mode: typing.Literal["MAKE_UNIQUE", "REFERENCE_EXISTING"]
|
|
1816
|
+
| None = "MAKE_UNIQUE",
|
|
2373
1817
|
filter_glob: str = "*.obj;*.mtl",
|
|
2374
1818
|
) -> None:
|
|
2375
1819
|
"""Load a Wavefront OBJ scene
|
|
2376
1820
|
|
|
2377
|
-
:type execution_context: int | str | None
|
|
2378
|
-
:type undo: bool | None
|
|
2379
1821
|
:param filepath: File Path, Path to file
|
|
2380
|
-
:type filepath: str
|
|
2381
1822
|
:param directory: Directory, Directory of the file
|
|
2382
|
-
:type directory: str
|
|
2383
1823
|
:param files: Files
|
|
2384
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2385
1824
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2386
|
-
:type check_existing: bool | None
|
|
2387
1825
|
:param filter_blender: Filter .blend files
|
|
2388
|
-
:type filter_blender: bool | None
|
|
2389
1826
|
:param filter_backup: Filter .blend files
|
|
2390
|
-
:type filter_backup: bool | None
|
|
2391
1827
|
:param filter_image: Filter image files
|
|
2392
|
-
:type filter_image: bool | None
|
|
2393
1828
|
:param filter_movie: Filter movie files
|
|
2394
|
-
:type filter_movie: bool | None
|
|
2395
1829
|
:param filter_python: Filter Python files
|
|
2396
|
-
:type filter_python: bool | None
|
|
2397
1830
|
:param filter_font: Filter font files
|
|
2398
|
-
:type filter_font: bool | None
|
|
2399
1831
|
:param filter_sound: Filter sound files
|
|
2400
|
-
:type filter_sound: bool | None
|
|
2401
1832
|
:param filter_text: Filter text files
|
|
2402
|
-
:type filter_text: bool | None
|
|
2403
1833
|
:param filter_archive: Filter archive files
|
|
2404
|
-
:type filter_archive: bool | None
|
|
2405
1834
|
:param filter_btx: Filter btx files
|
|
2406
|
-
:type filter_btx: bool | None
|
|
2407
1835
|
:param filter_alembic: Filter Alembic files
|
|
2408
|
-
:type filter_alembic: bool | None
|
|
2409
1836
|
:param filter_usd: Filter USD files
|
|
2410
|
-
:type filter_usd: bool | None
|
|
2411
1837
|
:param filter_obj: Filter OBJ files
|
|
2412
|
-
:type filter_obj: bool | None
|
|
2413
1838
|
:param filter_volume: Filter OpenVDB volume files
|
|
2414
|
-
:type filter_volume: bool | None
|
|
2415
1839
|
:param filter_folder: Filter folders
|
|
2416
|
-
:type filter_folder: bool | None
|
|
2417
1840
|
:param filter_blenlib: Filter Blender IDs
|
|
2418
|
-
:type filter_blenlib: bool | None
|
|
2419
1841
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2420
|
-
:type filemode: int | None
|
|
2421
1842
|
:param display_type: Display Type
|
|
2422
1843
|
|
|
2423
1844
|
DEFAULT
|
|
@@ -2431,13 +1852,9 @@ def obj_import(
|
|
|
2431
1852
|
|
|
2432
1853
|
THUMBNAIL
|
|
2433
1854
|
Thumbnails -- Display files as thumbnails.
|
|
2434
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2435
1855
|
:param sort_method: File sorting mode
|
|
2436
|
-
:
|
|
2437
|
-
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
|
|
2438
|
-
:type global_scale: float | None
|
|
1856
|
+
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2439
1857
|
:param clamp_size: Clamp Bounding Box, Resize the objects to keep bounding box under this value. Value 0 disables clamping
|
|
2440
|
-
:type clamp_size: float | None
|
|
2441
1858
|
:param forward_axis: Forward Axis
|
|
2442
1859
|
|
|
2443
1860
|
X
|
|
@@ -2457,7 +1874,6 @@ def obj_import(
|
|
|
2457
1874
|
|
|
2458
1875
|
NEGATIVE_Z
|
|
2459
1876
|
-Z -- Negative Z axis.
|
|
2460
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2461
1877
|
:param up_axis: Up Axis
|
|
2462
1878
|
|
|
2463
1879
|
X
|
|
@@ -2477,21 +1893,20 @@ def obj_import(
|
|
|
2477
1893
|
|
|
2478
1894
|
NEGATIVE_Z
|
|
2479
1895
|
-Z -- Negative Z axis.
|
|
2480
|
-
:
|
|
2481
|
-
:param
|
|
2482
|
-
:type use_split_objects: bool | None
|
|
2483
|
-
:param use_split_groups: Split By Group, Import each OBJ 'g' as a separate object
|
|
2484
|
-
:type use_split_groups: bool | None
|
|
1896
|
+
:param use_split_objects: Split By Object, Import each OBJ o as a separate object
|
|
1897
|
+
:param use_split_groups: Split By Group, Import each OBJ g as a separate object
|
|
2485
1898
|
:param import_vertex_groups: Vertex Groups, Import OBJ groups as vertex groups
|
|
2486
|
-
:type import_vertex_groups: bool | None
|
|
2487
1899
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
2488
|
-
:type validate_meshes: bool | None
|
|
2489
1900
|
:param close_spline_loops: Detect Cyclic Curves, Join curve endpoints if overlapping control points are detected (if disabled, no curves will be cyclic)
|
|
2490
|
-
:type close_spline_loops: bool | None
|
|
2491
1901
|
:param collection_separator: Path Separator, Character used to separate objects name into hierarchical structure
|
|
2492
|
-
:
|
|
1902
|
+
:param mtl_name_collision_mode: Material Name Collision, How to handle naming collisions when importing materials
|
|
1903
|
+
|
|
1904
|
+
MAKE_UNIQUE
|
|
1905
|
+
Make Unique -- Create new materials with unique names for each OBJ file.
|
|
1906
|
+
|
|
1907
|
+
REFERENCE_EXISTING
|
|
1908
|
+
Reference Existing -- Use existing materials with same name instead of creating new ones.
|
|
2493
1909
|
:param filter_glob: Extension Filter
|
|
2494
|
-
:type filter_glob: str
|
|
2495
1910
|
"""
|
|
2496
1911
|
|
|
2497
1912
|
def open_mainfile(
|
|
@@ -2531,48 +1946,26 @@ def open_mainfile(
|
|
|
2531
1946
|
) -> None:
|
|
2532
1947
|
"""Open a Blender file
|
|
2533
1948
|
|
|
2534
|
-
:type execution_context: int | str | None
|
|
2535
|
-
:type undo: bool | None
|
|
2536
1949
|
:param filepath: File Path, Path to file
|
|
2537
|
-
:type filepath: str
|
|
2538
1950
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
2539
|
-
:type hide_props_region: bool | None
|
|
2540
1951
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2541
|
-
:type check_existing: bool | None
|
|
2542
1952
|
:param filter_blender: Filter .blend files
|
|
2543
|
-
:type filter_blender: bool | None
|
|
2544
1953
|
:param filter_backup: Filter .blend files
|
|
2545
|
-
:type filter_backup: bool | None
|
|
2546
1954
|
:param filter_image: Filter image files
|
|
2547
|
-
:type filter_image: bool | None
|
|
2548
1955
|
:param filter_movie: Filter movie files
|
|
2549
|
-
:type filter_movie: bool | None
|
|
2550
1956
|
:param filter_python: Filter Python files
|
|
2551
|
-
:type filter_python: bool | None
|
|
2552
1957
|
:param filter_font: Filter font files
|
|
2553
|
-
:type filter_font: bool | None
|
|
2554
1958
|
:param filter_sound: Filter sound files
|
|
2555
|
-
:type filter_sound: bool | None
|
|
2556
1959
|
:param filter_text: Filter text files
|
|
2557
|
-
:type filter_text: bool | None
|
|
2558
1960
|
:param filter_archive: Filter archive files
|
|
2559
|
-
:type filter_archive: bool | None
|
|
2560
1961
|
:param filter_btx: Filter btx files
|
|
2561
|
-
:type filter_btx: bool | None
|
|
2562
1962
|
:param filter_alembic: Filter Alembic files
|
|
2563
|
-
:type filter_alembic: bool | None
|
|
2564
1963
|
:param filter_usd: Filter USD files
|
|
2565
|
-
:type filter_usd: bool | None
|
|
2566
1964
|
:param filter_obj: Filter OBJ files
|
|
2567
|
-
:type filter_obj: bool | None
|
|
2568
1965
|
:param filter_volume: Filter OpenVDB volume files
|
|
2569
|
-
:type filter_volume: bool | None
|
|
2570
1966
|
:param filter_folder: Filter folders
|
|
2571
|
-
:type filter_folder: bool | None
|
|
2572
1967
|
:param filter_blenlib: Filter Blender IDs
|
|
2573
|
-
:type filter_blenlib: bool | None
|
|
2574
1968
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2575
|
-
:type filemode: int | None
|
|
2576
1969
|
:param display_type: Display Type
|
|
2577
1970
|
|
|
2578
1971
|
DEFAULT
|
|
@@ -2586,36 +1979,26 @@ def open_mainfile(
|
|
|
2586
1979
|
|
|
2587
1980
|
THUMBNAIL
|
|
2588
1981
|
Thumbnails -- Display files as thumbnails.
|
|
2589
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2590
1982
|
:param sort_method: File sorting mode
|
|
2591
|
-
:type sort_method: str | None
|
|
2592
1983
|
:param load_ui: Load UI, Load user interface setup in the .blend file
|
|
2593
|
-
:type load_ui: bool | None
|
|
2594
1984
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
2595
|
-
:type use_scripts: bool | None
|
|
2596
1985
|
:param display_file_selector: Display File Selector
|
|
2597
|
-
:type display_file_selector: bool | None
|
|
2598
1986
|
:param state: State
|
|
2599
|
-
:type state: int | None
|
|
2600
1987
|
"""
|
|
2601
1988
|
|
|
2602
1989
|
def operator_cheat_sheet(
|
|
2603
|
-
execution_context: int | str | None = None,
|
|
1990
|
+
execution_context: int | str | None = None,
|
|
1991
|
+
undo: bool | None = None,
|
|
1992
|
+
/,
|
|
2604
1993
|
) -> None:
|
|
2605
|
-
"""List all the operators in a text-block, useful for scripting
|
|
2606
|
-
|
|
2607
|
-
:type execution_context: int | str | None
|
|
2608
|
-
:type undo: bool | None
|
|
2609
|
-
"""
|
|
1994
|
+
"""List all the operators in a text-block, useful for scripting"""
|
|
2610
1995
|
|
|
2611
1996
|
def operator_defaults(
|
|
2612
|
-
execution_context: int | str | None = None,
|
|
1997
|
+
execution_context: int | str | None = None,
|
|
1998
|
+
undo: bool | None = None,
|
|
1999
|
+
/,
|
|
2613
2000
|
) -> None:
|
|
2614
|
-
"""Set the active operator to its default values
|
|
2615
|
-
|
|
2616
|
-
:type execution_context: int | str | None
|
|
2617
|
-
:type undo: bool | None
|
|
2618
|
-
"""
|
|
2001
|
+
"""Set the active operator to its default values"""
|
|
2619
2002
|
|
|
2620
2003
|
def operator_pie_enum(
|
|
2621
2004
|
execution_context: int | str | None = None,
|
|
@@ -2627,12 +2010,8 @@ def operator_pie_enum(
|
|
|
2627
2010
|
) -> None:
|
|
2628
2011
|
"""Undocumented, consider contributing.
|
|
2629
2012
|
|
|
2630
|
-
:type execution_context: int | str | None
|
|
2631
|
-
:type undo: bool | None
|
|
2632
2013
|
:param data_path: Operator, Operator name (in Python as string)
|
|
2633
|
-
:type data_path: str
|
|
2634
2014
|
:param prop_string: Property, Property name (as a string)
|
|
2635
|
-
:type prop_string: str
|
|
2636
2015
|
"""
|
|
2637
2016
|
|
|
2638
2017
|
def operator_preset_add(
|
|
@@ -2647,16 +2026,10 @@ def operator_preset_add(
|
|
|
2647
2026
|
) -> None:
|
|
2648
2027
|
"""Add or remove an Operator Preset
|
|
2649
2028
|
|
|
2650
|
-
:type execution_context: int | str | None
|
|
2651
|
-
:type undo: bool | None
|
|
2652
2029
|
:param name: Name, Name of the preset, used to make the path name
|
|
2653
|
-
:type name: str
|
|
2654
2030
|
:param remove_name: remove_name
|
|
2655
|
-
:type remove_name: bool | None
|
|
2656
2031
|
:param remove_active: remove_active
|
|
2657
|
-
:type remove_active: bool | None
|
|
2658
2032
|
:param operator: Operator
|
|
2659
|
-
:type operator: str
|
|
2660
2033
|
"""
|
|
2661
2034
|
|
|
2662
2035
|
def operator_presets_cleanup(
|
|
@@ -2670,12 +2043,8 @@ def operator_presets_cleanup(
|
|
|
2670
2043
|
) -> None:
|
|
2671
2044
|
"""Remove outdated operator properties from presets that may cause problems
|
|
2672
2045
|
|
|
2673
|
-
:type execution_context: int | str | None
|
|
2674
|
-
:type undo: bool | None
|
|
2675
2046
|
:param operator: operator
|
|
2676
|
-
:type operator: str
|
|
2677
2047
|
:param properties: properties
|
|
2678
|
-
:type properties: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2679
2048
|
"""
|
|
2680
2049
|
|
|
2681
2050
|
def owner_disable(
|
|
@@ -2687,10 +2056,7 @@ def owner_disable(
|
|
|
2687
2056
|
) -> None:
|
|
2688
2057
|
"""Disable add-on for workspace
|
|
2689
2058
|
|
|
2690
|
-
:type execution_context: int | str | None
|
|
2691
|
-
:type undo: bool | None
|
|
2692
2059
|
:param owner_id: UI Tag
|
|
2693
|
-
:type owner_id: str
|
|
2694
2060
|
"""
|
|
2695
2061
|
|
|
2696
2062
|
def owner_enable(
|
|
@@ -2702,10 +2068,7 @@ def owner_enable(
|
|
|
2702
2068
|
) -> None:
|
|
2703
2069
|
"""Enable add-on for workspace
|
|
2704
2070
|
|
|
2705
|
-
:type execution_context: int | str | None
|
|
2706
|
-
:type undo: bool | None
|
|
2707
2071
|
:param owner_id: UI Tag
|
|
2708
|
-
:type owner_id: str
|
|
2709
2072
|
"""
|
|
2710
2073
|
|
|
2711
2074
|
def path_open(
|
|
@@ -2717,10 +2080,7 @@ def path_open(
|
|
|
2717
2080
|
) -> None:
|
|
2718
2081
|
"""Open a path in a file browser
|
|
2719
2082
|
|
|
2720
|
-
:type execution_context: int | str | None
|
|
2721
|
-
:type undo: bool | None
|
|
2722
2083
|
:param filepath: filepath
|
|
2723
|
-
:type filepath: str
|
|
2724
2084
|
"""
|
|
2725
2085
|
|
|
2726
2086
|
def ply_export(
|
|
@@ -2772,46 +2132,25 @@ def ply_export(
|
|
|
2772
2132
|
) -> None:
|
|
2773
2133
|
"""Save the scene to a PLY file
|
|
2774
2134
|
|
|
2775
|
-
:type execution_context: int | str | None
|
|
2776
|
-
:type undo: bool | None
|
|
2777
2135
|
:param filepath: File Path, Path to file
|
|
2778
|
-
:type filepath: str
|
|
2779
2136
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2780
|
-
:type check_existing: bool | None
|
|
2781
2137
|
:param filter_blender: Filter .blend files
|
|
2782
|
-
:type filter_blender: bool | None
|
|
2783
2138
|
:param filter_backup: Filter .blend files
|
|
2784
|
-
:type filter_backup: bool | None
|
|
2785
2139
|
:param filter_image: Filter image files
|
|
2786
|
-
:type filter_image: bool | None
|
|
2787
2140
|
:param filter_movie: Filter movie files
|
|
2788
|
-
:type filter_movie: bool | None
|
|
2789
2141
|
:param filter_python: Filter Python files
|
|
2790
|
-
:type filter_python: bool | None
|
|
2791
2142
|
:param filter_font: Filter font files
|
|
2792
|
-
:type filter_font: bool | None
|
|
2793
2143
|
:param filter_sound: Filter sound files
|
|
2794
|
-
:type filter_sound: bool | None
|
|
2795
2144
|
:param filter_text: Filter text files
|
|
2796
|
-
:type filter_text: bool | None
|
|
2797
2145
|
:param filter_archive: Filter archive files
|
|
2798
|
-
:type filter_archive: bool | None
|
|
2799
2146
|
:param filter_btx: Filter btx files
|
|
2800
|
-
:type filter_btx: bool | None
|
|
2801
2147
|
:param filter_alembic: Filter Alembic files
|
|
2802
|
-
:type filter_alembic: bool | None
|
|
2803
2148
|
:param filter_usd: Filter USD files
|
|
2804
|
-
:type filter_usd: bool | None
|
|
2805
2149
|
:param filter_obj: Filter OBJ files
|
|
2806
|
-
:type filter_obj: bool | None
|
|
2807
2150
|
:param filter_volume: Filter OpenVDB volume files
|
|
2808
|
-
:type filter_volume: bool | None
|
|
2809
2151
|
:param filter_folder: Filter folders
|
|
2810
|
-
:type filter_folder: bool | None
|
|
2811
2152
|
:param filter_blenlib: Filter Blender IDs
|
|
2812
|
-
:type filter_blenlib: bool | None
|
|
2813
2153
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2814
|
-
:type filemode: int | None
|
|
2815
2154
|
:param display_type: Display Type
|
|
2816
2155
|
|
|
2817
2156
|
DEFAULT
|
|
@@ -2825,9 +2164,7 @@ def ply_export(
|
|
|
2825
2164
|
|
|
2826
2165
|
THUMBNAIL
|
|
2827
2166
|
Thumbnails -- Display files as thumbnails.
|
|
2828
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2829
2167
|
:param sort_method: File sorting mode
|
|
2830
|
-
:type sort_method: str | None
|
|
2831
2168
|
:param forward_axis: Forward Axis
|
|
2832
2169
|
|
|
2833
2170
|
X
|
|
@@ -2847,7 +2184,6 @@ def ply_export(
|
|
|
2847
2184
|
|
|
2848
2185
|
NEGATIVE_Z
|
|
2849
2186
|
-Z -- Negative Z axis.
|
|
2850
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2851
2187
|
:param up_axis: Up Axis
|
|
2852
2188
|
|
|
2853
2189
|
X
|
|
@@ -2867,19 +2203,12 @@ def ply_export(
|
|
|
2867
2203
|
|
|
2868
2204
|
NEGATIVE_Z
|
|
2869
2205
|
-Z -- Negative Z axis.
|
|
2870
|
-
:
|
|
2871
|
-
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
|
|
2872
|
-
:type global_scale: float | None
|
|
2206
|
+
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2873
2207
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
2874
|
-
:type apply_modifiers: bool | None
|
|
2875
2208
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
2876
|
-
:type export_selected_objects: bool | None
|
|
2877
2209
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
2878
|
-
:type collection: str
|
|
2879
2210
|
:param export_uv: Export UVs
|
|
2880
|
-
:type export_uv: bool | None
|
|
2881
2211
|
:param export_normals: Export Vertex Normals, Export specific vertex normals if available, export calculated normals otherwise
|
|
2882
|
-
:type export_normals: bool | None
|
|
2883
2212
|
:param export_colors: Export Vertex Colors, Export vertex color attributes
|
|
2884
2213
|
|
|
2885
2214
|
NONE
|
|
@@ -2890,15 +2219,10 @@ def ply_export(
|
|
|
2890
2219
|
|
|
2891
2220
|
LINEAR
|
|
2892
2221
|
Linear -- Vertex colors in the file are in linear color space.
|
|
2893
|
-
:type export_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
2894
2222
|
:param export_attributes: Export Vertex Attributes, Export custom vertex attributes
|
|
2895
|
-
:type export_attributes: bool | None
|
|
2896
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
|
|
2897
|
-
:type export_triangulated_mesh: bool | None
|
|
2898
2224
|
:param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
|
|
2899
|
-
:type ascii_format: bool | None
|
|
2900
2225
|
:param filter_glob: Extension Filter
|
|
2901
|
-
:type filter_glob: str
|
|
2902
2226
|
"""
|
|
2903
2227
|
|
|
2904
2228
|
def ply_import(
|
|
@@ -2948,50 +2272,27 @@ def ply_import(
|
|
|
2948
2272
|
) -> None:
|
|
2949
2273
|
"""Import an PLY file as an object
|
|
2950
2274
|
|
|
2951
|
-
:type execution_context: int | str | None
|
|
2952
|
-
:type undo: bool | None
|
|
2953
2275
|
:param filepath: File Path, Path to file
|
|
2954
|
-
:type filepath: str
|
|
2955
2276
|
:param directory: Directory, Directory of the file
|
|
2956
|
-
:type directory: str
|
|
2957
2277
|
:param files: Files
|
|
2958
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2959
2278
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2960
|
-
:type check_existing: bool | None
|
|
2961
2279
|
:param filter_blender: Filter .blend files
|
|
2962
|
-
:type filter_blender: bool | None
|
|
2963
2280
|
:param filter_backup: Filter .blend files
|
|
2964
|
-
:type filter_backup: bool | None
|
|
2965
2281
|
:param filter_image: Filter image files
|
|
2966
|
-
:type filter_image: bool | None
|
|
2967
2282
|
:param filter_movie: Filter movie files
|
|
2968
|
-
:type filter_movie: bool | None
|
|
2969
2283
|
:param filter_python: Filter Python files
|
|
2970
|
-
:type filter_python: bool | None
|
|
2971
2284
|
:param filter_font: Filter font files
|
|
2972
|
-
:type filter_font: bool | None
|
|
2973
2285
|
:param filter_sound: Filter sound files
|
|
2974
|
-
:type filter_sound: bool | None
|
|
2975
2286
|
:param filter_text: Filter text files
|
|
2976
|
-
:type filter_text: bool | None
|
|
2977
2287
|
:param filter_archive: Filter archive files
|
|
2978
|
-
:type filter_archive: bool | None
|
|
2979
2288
|
:param filter_btx: Filter btx files
|
|
2980
|
-
:type filter_btx: bool | None
|
|
2981
2289
|
:param filter_alembic: Filter Alembic files
|
|
2982
|
-
:type filter_alembic: bool | None
|
|
2983
2290
|
:param filter_usd: Filter USD files
|
|
2984
|
-
:type filter_usd: bool | None
|
|
2985
2291
|
:param filter_obj: Filter OBJ files
|
|
2986
|
-
:type filter_obj: bool | None
|
|
2987
2292
|
:param filter_volume: Filter OpenVDB volume files
|
|
2988
|
-
:type filter_volume: bool | None
|
|
2989
2293
|
:param filter_folder: Filter folders
|
|
2990
|
-
:type filter_folder: bool | None
|
|
2991
2294
|
:param filter_blenlib: Filter Blender IDs
|
|
2992
|
-
:type filter_blenlib: bool | None
|
|
2993
2295
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2994
|
-
:type filemode: int | None
|
|
2995
2296
|
:param display_type: Display Type
|
|
2996
2297
|
|
|
2997
2298
|
DEFAULT
|
|
@@ -3005,13 +2306,9 @@ def ply_import(
|
|
|
3005
2306
|
|
|
3006
2307
|
THUMBNAIL
|
|
3007
2308
|
Thumbnails -- Display files as thumbnails.
|
|
3008
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3009
2309
|
:param sort_method: File sorting mode
|
|
3010
|
-
:type sort_method: str | None
|
|
3011
2310
|
:param global_scale: Scale
|
|
3012
|
-
:
|
|
3013
|
-
:param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to imported data
|
|
3014
|
-
:type use_scene_unit: bool | None
|
|
2311
|
+
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
3015
2312
|
:param forward_axis: Forward Axis
|
|
3016
2313
|
|
|
3017
2314
|
X
|
|
@@ -3031,7 +2328,6 @@ def ply_import(
|
|
|
3031
2328
|
|
|
3032
2329
|
NEGATIVE_Z
|
|
3033
2330
|
-Z -- Negative Z axis.
|
|
3034
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
3035
2331
|
:param up_axis: Up Axis
|
|
3036
2332
|
|
|
3037
2333
|
X
|
|
@@ -3051,9 +2347,7 @@ def ply_import(
|
|
|
3051
2347
|
|
|
3052
2348
|
NEGATIVE_Z
|
|
3053
2349
|
-Z -- Negative Z axis.
|
|
3054
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
3055
2350
|
:param merge_verts: Merge Vertices, Merges vertices by distance
|
|
3056
|
-
:type merge_verts: bool | None
|
|
3057
2351
|
:param import_colors: Vertex Colors, Import vertex color attributes
|
|
3058
2352
|
|
|
3059
2353
|
NONE
|
|
@@ -3064,11 +2358,8 @@ def ply_import(
|
|
|
3064
2358
|
|
|
3065
2359
|
LINEAR
|
|
3066
2360
|
Linear -- Vertex colors in the file are in linear color space.
|
|
3067
|
-
:type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
3068
2361
|
:param import_attributes: Vertex Attributes, Import custom vertex attributes
|
|
3069
|
-
:type import_attributes: bool | None
|
|
3070
2362
|
:param filter_glob: Extension Filter
|
|
3071
|
-
:type filter_glob: str
|
|
3072
2363
|
"""
|
|
3073
2364
|
|
|
3074
2365
|
def previews_batch_clear(
|
|
@@ -3088,30 +2379,18 @@ def previews_batch_clear(
|
|
|
3088
2379
|
use_trusted: bool | None = False,
|
|
3089
2380
|
use_backups: bool | None = True,
|
|
3090
2381
|
) -> None:
|
|
3091
|
-
"""Clear selected .blend
|
|
2382
|
+
"""Clear selected .blend files previews
|
|
3092
2383
|
|
|
3093
|
-
:type execution_context: int | str | None
|
|
3094
|
-
:type undo: bool | None
|
|
3095
2384
|
:param files: files
|
|
3096
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
3097
2385
|
:param directory: directory
|
|
3098
|
-
:type directory: str
|
|
3099
2386
|
:param filter_blender: filter_blender
|
|
3100
|
-
:type filter_blender: bool | None
|
|
3101
2387
|
:param filter_folder: filter_folder
|
|
3102
|
-
:
|
|
3103
|
-
:param
|
|
3104
|
-
:
|
|
3105
|
-
:param
|
|
3106
|
-
:type use_collections: bool | None
|
|
3107
|
-
:param use_objects: Objects, Clear objects' previews
|
|
3108
|
-
:type use_objects: bool | None
|
|
3109
|
-
:param use_intern_data: Materials & Textures, Clear 'internal' previews (materials, textures, images, etc.)
|
|
3110
|
-
:type use_intern_data: bool | None
|
|
2388
|
+
:param use_scenes: Scenes, Clear scenes previews
|
|
2389
|
+
:param use_collections: Collections, Clear collections previews
|
|
2390
|
+
:param use_objects: Objects, Clear objects previews
|
|
2391
|
+
:param use_intern_data: Materials & Textures, Clear internal previews (materials, textures, images, etc.)
|
|
3111
2392
|
:param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
|
|
3112
|
-
:type use_trusted: bool | None
|
|
3113
2393
|
:param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with cleared previews
|
|
3114
|
-
:type use_backups: bool | None
|
|
3115
2394
|
"""
|
|
3116
2395
|
|
|
3117
2396
|
def previews_batch_generate(
|
|
@@ -3131,30 +2410,18 @@ def previews_batch_generate(
|
|
|
3131
2410
|
use_trusted: bool | None = False,
|
|
3132
2411
|
use_backups: bool | None = True,
|
|
3133
2412
|
) -> None:
|
|
3134
|
-
"""Generate selected .blend
|
|
2413
|
+
"""Generate selected .blend files previews
|
|
3135
2414
|
|
|
3136
|
-
:type execution_context: int | str | None
|
|
3137
|
-
:type undo: bool | None
|
|
3138
2415
|
:param files: Collection of file paths with common directory root
|
|
3139
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
3140
2416
|
:param directory: Root path of all files listed in files collection
|
|
3141
|
-
:type directory: str
|
|
3142
2417
|
:param filter_blender: Show Blender files in the File Browser
|
|
3143
|
-
:type filter_blender: bool | None
|
|
3144
2418
|
:param filter_folder: Show folders in the File Browser
|
|
3145
|
-
:
|
|
3146
|
-
:param
|
|
3147
|
-
:
|
|
3148
|
-
:param
|
|
3149
|
-
:type use_collections: bool | None
|
|
3150
|
-
:param use_objects: Objects, Generate objects' previews
|
|
3151
|
-
:type use_objects: bool | None
|
|
3152
|
-
:param use_intern_data: Materials & Textures, Generate 'internal' previews (materials, textures, images, etc.)
|
|
3153
|
-
:type use_intern_data: bool | None
|
|
2419
|
+
:param use_scenes: Scenes, Generate scenes previews
|
|
2420
|
+
:param use_collections: Collections, Generate collections previews
|
|
2421
|
+
:param use_objects: Objects, Generate objects previews
|
|
2422
|
+
:param use_intern_data: Materials & Textures, Generate internal previews (materials, textures, images, etc.)
|
|
3154
2423
|
:param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
|
|
3155
|
-
:type use_trusted: bool | None
|
|
3156
2424
|
:param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with generated previews
|
|
3157
|
-
:type use_backups: bool | None
|
|
3158
2425
|
"""
|
|
3159
2426
|
|
|
3160
2427
|
def previews_clear(
|
|
@@ -3181,8 +2448,6 @@ def previews_clear(
|
|
|
3181
2448
|
) -> None:
|
|
3182
2449
|
"""Clear data-block previews (only for some types like objects, materials, textures, etc.)
|
|
3183
2450
|
|
|
3184
|
-
:type execution_context: int | str | None
|
|
3185
|
-
:type undo: bool | None
|
|
3186
2451
|
:param id_type: Data-Block Type, Which data-block previews to clear
|
|
3187
2452
|
|
|
3188
2453
|
ALL
|
|
@@ -3217,17 +2482,14 @@ def previews_clear(
|
|
|
3217
2482
|
|
|
3218
2483
|
IMAGE
|
|
3219
2484
|
Images.
|
|
3220
|
-
:type id_type: set[typing.Literal['ALL','GEOMETRY','SHADING','SCENE','COLLECTION','OBJECT','MATERIAL','LIGHT','WORLD','TEXTURE','IMAGE']] | None
|
|
3221
2485
|
"""
|
|
3222
2486
|
|
|
3223
2487
|
def previews_ensure(
|
|
3224
|
-
execution_context: int | str | None = None,
|
|
2488
|
+
execution_context: int | str | None = None,
|
|
2489
|
+
undo: bool | None = None,
|
|
2490
|
+
/,
|
|
3225
2491
|
) -> None:
|
|
3226
|
-
"""Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)
|
|
3227
|
-
|
|
3228
|
-
:type execution_context: int | str | None
|
|
3229
|
-
:type undo: bool | None
|
|
3230
|
-
"""
|
|
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.)"""
|
|
3231
2493
|
|
|
3232
2494
|
def properties_add(
|
|
3233
2495
|
execution_context: int | str | None = None,
|
|
@@ -3238,10 +2500,7 @@ def properties_add(
|
|
|
3238
2500
|
) -> None:
|
|
3239
2501
|
"""Add your own property to the data-block
|
|
3240
2502
|
|
|
3241
|
-
:type execution_context: int | str | None
|
|
3242
|
-
:type undo: bool | None
|
|
3243
2503
|
:param data_path: Property Edit, Property data_path edit
|
|
3244
|
-
:type data_path: str
|
|
3245
2504
|
"""
|
|
3246
2505
|
|
|
3247
2506
|
def properties_context_change(
|
|
@@ -3253,10 +2512,7 @@ def properties_context_change(
|
|
|
3253
2512
|
) -> None:
|
|
3254
2513
|
"""Jump to a different tab inside the properties editor
|
|
3255
2514
|
|
|
3256
|
-
:type execution_context: int | str | None
|
|
3257
|
-
:type undo: bool | None
|
|
3258
2515
|
:param context: Context
|
|
3259
|
-
:type context: str
|
|
3260
2516
|
"""
|
|
3261
2517
|
|
|
3262
2518
|
def properties_edit(
|
|
@@ -3441,14 +2697,10 @@ def properties_edit(
|
|
|
3441
2697
|
| None = "OBJECT",
|
|
3442
2698
|
eval_string: str = "",
|
|
3443
2699
|
) -> None:
|
|
3444
|
-
"""Change a custom
|
|
2700
|
+
"""Change a custom propertys type, or adjust how it is displayed in the interface
|
|
3445
2701
|
|
|
3446
|
-
:type execution_context: int | str | None
|
|
3447
|
-
:type undo: bool | None
|
|
3448
2702
|
:param data_path: Property Edit, Property data_path edit
|
|
3449
|
-
:type data_path: str
|
|
3450
2703
|
:param property_name: Property Name, Property name edit
|
|
3451
|
-
:type property_name: str
|
|
3452
2704
|
:param property_type: Type
|
|
3453
2705
|
|
|
3454
2706
|
FLOAT
|
|
@@ -3477,51 +2729,28 @@ def properties_edit(
|
|
|
3477
2729
|
|
|
3478
2730
|
PYTHON
|
|
3479
2731
|
Python -- Edit a Python value directly, for unsupported property types.
|
|
3480
|
-
:type property_type: typing.Literal['FLOAT','FLOAT_ARRAY','INT','INT_ARRAY','BOOL','BOOL_ARRAY','STRING','DATA_BLOCK','PYTHON'] | None
|
|
3481
2732
|
:param is_overridable_library: Library Overridable, Allow the property to be overridden when the data-block is linked
|
|
3482
|
-
:type is_overridable_library: bool | None
|
|
3483
2733
|
:param description: Description
|
|
3484
|
-
:type description: str
|
|
3485
2734
|
:param use_soft_limits: Soft Limits, Limits the Property Value slider to a range, values outside the range must be inputted numerically
|
|
3486
|
-
:type use_soft_limits: bool | None
|
|
3487
2735
|
:param array_length: Array Length
|
|
3488
|
-
:type array_length: int | None
|
|
3489
2736
|
:param default_int: Default Value
|
|
3490
|
-
:type default_int: collections.abc.Iterable[int] | None
|
|
3491
2737
|
:param min_int: Min
|
|
3492
|
-
:type min_int: int | None
|
|
3493
2738
|
:param max_int: Max
|
|
3494
|
-
:type max_int: int | None
|
|
3495
2739
|
:param soft_min_int: Soft Min
|
|
3496
|
-
:type soft_min_int: int | None
|
|
3497
2740
|
:param soft_max_int: Soft Max
|
|
3498
|
-
:type soft_max_int: int | None
|
|
3499
2741
|
:param step_int: Step
|
|
3500
|
-
:type step_int: int | None
|
|
3501
2742
|
:param default_bool: Default Value
|
|
3502
|
-
:type default_bool: collections.abc.Iterable[bool] | None
|
|
3503
2743
|
:param default_float: Default Value
|
|
3504
|
-
:type default_float: collections.abc.Iterable[float] | None
|
|
3505
2744
|
:param min_float: Min
|
|
3506
|
-
:type min_float: float | None
|
|
3507
2745
|
:param max_float: Max
|
|
3508
|
-
:type max_float: float | None
|
|
3509
2746
|
:param soft_min_float: Soft Min
|
|
3510
|
-
:type soft_min_float: float | None
|
|
3511
2747
|
:param soft_max_float: Soft Max
|
|
3512
|
-
:type soft_max_float: float | None
|
|
3513
2748
|
:param precision: Precision
|
|
3514
|
-
:type precision: int | None
|
|
3515
2749
|
:param step_float: Step
|
|
3516
|
-
:type step_float: float | None
|
|
3517
2750
|
:param subtype: Subtype
|
|
3518
|
-
:type subtype: str | None
|
|
3519
2751
|
:param default_string: Default Value
|
|
3520
|
-
:type default_string: str
|
|
3521
2752
|
:param id_type: ID Type
|
|
3522
|
-
: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
|
|
3523
2753
|
:param eval_string: Value, Python value for unsupported custom property types
|
|
3524
|
-
:type eval_string: str
|
|
3525
2754
|
"""
|
|
3526
2755
|
|
|
3527
2756
|
def properties_edit_value(
|
|
@@ -3535,14 +2764,9 @@ def properties_edit_value(
|
|
|
3535
2764
|
) -> None:
|
|
3536
2765
|
"""Edit the value of a custom property
|
|
3537
2766
|
|
|
3538
|
-
:type execution_context: int | str | None
|
|
3539
|
-
:type undo: bool | None
|
|
3540
2767
|
:param data_path: Property Edit, Property data_path edit
|
|
3541
|
-
:type data_path: str
|
|
3542
2768
|
:param property_name: Property Name, Property name edit
|
|
3543
|
-
:type property_name: str
|
|
3544
2769
|
:param eval_string: Value, Value for custom property types that can only be edited as a Python expression
|
|
3545
|
-
:type eval_string: str
|
|
3546
2770
|
"""
|
|
3547
2771
|
|
|
3548
2772
|
def properties_remove(
|
|
@@ -3555,22 +2779,16 @@ def properties_remove(
|
|
|
3555
2779
|
) -> None:
|
|
3556
2780
|
"""Internal use (edit a property data_path)
|
|
3557
2781
|
|
|
3558
|
-
:type execution_context: int | str | None
|
|
3559
|
-
:type undo: bool | None
|
|
3560
2782
|
:param data_path: Property Edit, Property data_path edit
|
|
3561
|
-
:type data_path: str
|
|
3562
2783
|
:param property_name: Property Name, Property name edit
|
|
3563
|
-
:type property_name: str
|
|
3564
2784
|
"""
|
|
3565
2785
|
|
|
3566
2786
|
def quit_blender(
|
|
3567
|
-
execution_context: int | str | None = None,
|
|
2787
|
+
execution_context: int | str | None = None,
|
|
2788
|
+
undo: bool | None = None,
|
|
2789
|
+
/,
|
|
3568
2790
|
) -> None:
|
|
3569
|
-
"""Quit Blender
|
|
3570
|
-
|
|
3571
|
-
:type execution_context: int | str | None
|
|
3572
|
-
:type undo: bool | None
|
|
3573
|
-
"""
|
|
2791
|
+
"""Quit Blender"""
|
|
3574
2792
|
|
|
3575
2793
|
def radial_control(
|
|
3576
2794
|
execution_context: int | str | None = None,
|
|
@@ -3592,32 +2810,18 @@ def radial_control(
|
|
|
3592
2810
|
) -> None:
|
|
3593
2811
|
"""Set some size property (e.g. brush size) with mouse wheel
|
|
3594
2812
|
|
|
3595
|
-
:type execution_context: int | str | None
|
|
3596
|
-
:type undo: bool | None
|
|
3597
2813
|
:param data_path_primary: Primary Data Path, Primary path of property to be set by the radial control
|
|
3598
|
-
:type data_path_primary: str
|
|
3599
2814
|
:param data_path_secondary: Secondary Data Path, Secondary path of property to be set by the radial control
|
|
3600
|
-
:type data_path_secondary: str
|
|
3601
2815
|
:param use_secondary: Use Secondary, Path of property to select between the primary and secondary data paths
|
|
3602
|
-
:type use_secondary: str
|
|
3603
2816
|
:param rotation_path: Rotation Path, Path of property used to rotate the texture display
|
|
3604
|
-
:type rotation_path: str
|
|
3605
2817
|
:param color_path: Color Path, Path of property used to set the color of the control
|
|
3606
|
-
:type color_path: str
|
|
3607
2818
|
:param fill_color_path: Fill Color Path, Path of property used to set the fill color of the control
|
|
3608
|
-
:type fill_color_path: str
|
|
3609
2819
|
:param fill_color_override_path: Fill Color Override Path
|
|
3610
|
-
:type fill_color_override_path: str
|
|
3611
2820
|
:param fill_color_override_test_path: Fill Color Override Test
|
|
3612
|
-
:type fill_color_override_test_path: str
|
|
3613
2821
|
:param zoom_path: Zoom Path, Path of property used to set the zoom level for the control
|
|
3614
|
-
:type zoom_path: str
|
|
3615
2822
|
:param image_id: Image ID, Path of ID that is used to generate an image for the control
|
|
3616
|
-
:type image_id: str
|
|
3617
2823
|
:param secondary_tex: Secondary Texture, Tweak brush secondary/mask texture
|
|
3618
|
-
:type secondary_tex: bool | None
|
|
3619
2824
|
:param release_confirm: Confirm On Release, Finish operation on key release
|
|
3620
|
-
:type release_confirm: bool | None
|
|
3621
2825
|
"""
|
|
3622
2826
|
|
|
3623
2827
|
def read_factory_settings(
|
|
@@ -3631,13 +2835,8 @@ def read_factory_settings(
|
|
|
3631
2835
|
) -> None:
|
|
3632
2836
|
"""Load factory default startup file and preferences. To make changes permanent, use "Save Startup File" and "Save Preferences"
|
|
3633
2837
|
|
|
3634
|
-
:type execution_context: int | str | None
|
|
3635
|
-
:type undo: bool | None
|
|
3636
2838
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3637
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3638
|
-
:type app_template: str
|
|
3639
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, ...
|
|
3640
|
-
:type use_empty: bool | None
|
|
3641
2840
|
"""
|
|
3642
2841
|
|
|
3643
2842
|
def read_factory_userpref(
|
|
@@ -3649,20 +2848,15 @@ def read_factory_userpref(
|
|
|
3649
2848
|
) -> None:
|
|
3650
2849
|
"""Load factory default preferences. To make changes to preferences permanent, use "Save Preferences"
|
|
3651
2850
|
|
|
3652
|
-
:type execution_context: int | str | None
|
|
3653
|
-
:type undo: bool | None
|
|
3654
2851
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3655
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3656
2852
|
"""
|
|
3657
2853
|
|
|
3658
2854
|
def read_history(
|
|
3659
|
-
execution_context: int | str | None = None,
|
|
2855
|
+
execution_context: int | str | None = None,
|
|
2856
|
+
undo: bool | None = None,
|
|
2857
|
+
/,
|
|
3660
2858
|
) -> None:
|
|
3661
|
-
"""Reloads history and bookmarks
|
|
3662
|
-
|
|
3663
|
-
:type execution_context: int | str | None
|
|
3664
|
-
:type undo: bool | None
|
|
3665
|
-
"""
|
|
2859
|
+
"""Reloads history and bookmarks"""
|
|
3666
2860
|
|
|
3667
2861
|
def read_homefile(
|
|
3668
2862
|
execution_context: int | str | None = None,
|
|
@@ -3679,31 +2873,20 @@ def read_homefile(
|
|
|
3679
2873
|
) -> None:
|
|
3680
2874
|
"""Open the default file
|
|
3681
2875
|
|
|
3682
|
-
:type execution_context: int | str | None
|
|
3683
|
-
:type undo: bool | None
|
|
3684
2876
|
:param filepath: File Path, Path to an alternative start-up file
|
|
3685
|
-
:type filepath: str
|
|
3686
2877
|
:param load_ui: Load UI, Load user interface setup from the .blend file
|
|
3687
|
-
:type load_ui: bool | None
|
|
3688
2878
|
:param use_splash: Splash
|
|
3689
|
-
:
|
|
3690
|
-
: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
|
|
3691
|
-
:type use_factory_startup: bool | None
|
|
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
|
|
3692
2880
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3693
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3694
|
-
:type app_template: str
|
|
3695
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, ...
|
|
3696
|
-
:type use_empty: bool | None
|
|
3697
2882
|
"""
|
|
3698
2883
|
|
|
3699
2884
|
def read_userpref(
|
|
3700
|
-
execution_context: int | str | None = None,
|
|
2885
|
+
execution_context: int | str | None = None,
|
|
2886
|
+
undo: bool | None = None,
|
|
2887
|
+
/,
|
|
3701
2888
|
) -> None:
|
|
3702
|
-
"""Load last saved preferences
|
|
3703
|
-
|
|
3704
|
-
:type execution_context: int | str | None
|
|
3705
|
-
:type undo: bool | None
|
|
3706
|
-
"""
|
|
2889
|
+
"""Load last saved preferences"""
|
|
3707
2890
|
|
|
3708
2891
|
def recover_auto_save(
|
|
3709
2892
|
execution_context: int | str | None = None,
|
|
@@ -3739,48 +2922,26 @@ def recover_auto_save(
|
|
|
3739
2922
|
) -> None:
|
|
3740
2923
|
"""Open an automatically saved file to recover it
|
|
3741
2924
|
|
|
3742
|
-
:type execution_context: int | str | None
|
|
3743
|
-
:type undo: bool | None
|
|
3744
2925
|
:param filepath: File Path, Path to file
|
|
3745
|
-
:type filepath: str
|
|
3746
2926
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
3747
|
-
:type hide_props_region: bool | None
|
|
3748
2927
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
3749
|
-
:type check_existing: bool | None
|
|
3750
2928
|
:param filter_blender: Filter .blend files
|
|
3751
|
-
:type filter_blender: bool | None
|
|
3752
2929
|
:param filter_backup: Filter .blend files
|
|
3753
|
-
:type filter_backup: bool | None
|
|
3754
2930
|
:param filter_image: Filter image files
|
|
3755
|
-
:type filter_image: bool | None
|
|
3756
2931
|
:param filter_movie: Filter movie files
|
|
3757
|
-
:type filter_movie: bool | None
|
|
3758
2932
|
:param filter_python: Filter Python files
|
|
3759
|
-
:type filter_python: bool | None
|
|
3760
2933
|
:param filter_font: Filter font files
|
|
3761
|
-
:type filter_font: bool | None
|
|
3762
2934
|
:param filter_sound: Filter sound files
|
|
3763
|
-
:type filter_sound: bool | None
|
|
3764
2935
|
:param filter_text: Filter text files
|
|
3765
|
-
:type filter_text: bool | None
|
|
3766
2936
|
:param filter_archive: Filter archive files
|
|
3767
|
-
:type filter_archive: bool | None
|
|
3768
2937
|
:param filter_btx: Filter btx files
|
|
3769
|
-
:type filter_btx: bool | None
|
|
3770
2938
|
:param filter_alembic: Filter Alembic files
|
|
3771
|
-
:type filter_alembic: bool | None
|
|
3772
2939
|
:param filter_usd: Filter USD files
|
|
3773
|
-
:type filter_usd: bool | None
|
|
3774
2940
|
:param filter_obj: Filter OBJ files
|
|
3775
|
-
:type filter_obj: bool | None
|
|
3776
2941
|
:param filter_volume: Filter OpenVDB volume files
|
|
3777
|
-
:type filter_volume: bool | None
|
|
3778
2942
|
:param filter_folder: Filter folders
|
|
3779
|
-
:type filter_folder: bool | None
|
|
3780
2943
|
:param filter_blenlib: Filter Blender IDs
|
|
3781
|
-
:type filter_blenlib: bool | None
|
|
3782
2944
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
3783
|
-
:type filemode: int | None
|
|
3784
2945
|
:param display_type: Display Type
|
|
3785
2946
|
|
|
3786
2947
|
DEFAULT
|
|
@@ -3794,11 +2955,8 @@ def recover_auto_save(
|
|
|
3794
2955
|
|
|
3795
2956
|
THUMBNAIL
|
|
3796
2957
|
Thumbnails -- Display files as thumbnails.
|
|
3797
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3798
2958
|
:param sort_method: File sorting mode
|
|
3799
|
-
:type sort_method: str | None
|
|
3800
2959
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3801
|
-
:type use_scripts: bool | None
|
|
3802
2960
|
"""
|
|
3803
2961
|
|
|
3804
2962
|
def recover_last_session(
|
|
@@ -3810,10 +2968,7 @@ def recover_last_session(
|
|
|
3810
2968
|
) -> None:
|
|
3811
2969
|
"""Open the last closed file ("quit.blend")
|
|
3812
2970
|
|
|
3813
|
-
:type execution_context: int | str | None
|
|
3814
|
-
:type undo: bool | None
|
|
3815
2971
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3816
|
-
:type use_scripts: bool | None
|
|
3817
2972
|
"""
|
|
3818
2973
|
|
|
3819
2974
|
def redraw_timer(
|
|
@@ -3836,8 +2991,6 @@ def redraw_timer(
|
|
|
3836
2991
|
) -> None:
|
|
3837
2992
|
"""Simple redraw timer to test the speed of updating the interface
|
|
3838
2993
|
|
|
3839
|
-
:type execution_context: int | str | None
|
|
3840
|
-
:type undo: bool | None
|
|
3841
2994
|
:param type: Type
|
|
3842
2995
|
|
|
3843
2996
|
DRAW
|
|
@@ -3860,11 +3013,8 @@ def redraw_timer(
|
|
|
3860
3013
|
|
|
3861
3014
|
UNDO
|
|
3862
3015
|
Undo/Redo -- Undo and redo.
|
|
3863
|
-
:type type: typing.Literal['DRAW','DRAW_SWAP','DRAW_WIN','DRAW_WIN_SWAP','ANIM_STEP','ANIM_PLAY','UNDO'] | None
|
|
3864
3016
|
:param iterations: Iterations, Number of times to redraw
|
|
3865
|
-
:type iterations: int | None
|
|
3866
3017
|
:param time_limit: Time Limit, Seconds to run the test for (override iterations)
|
|
3867
|
-
:type time_limit: float | None
|
|
3868
3018
|
"""
|
|
3869
3019
|
|
|
3870
3020
|
def revert_mainfile(
|
|
@@ -3876,10 +3026,7 @@ def revert_mainfile(
|
|
|
3876
3026
|
) -> None:
|
|
3877
3027
|
"""Reload the saved file
|
|
3878
3028
|
|
|
3879
|
-
:type execution_context: int | str | None
|
|
3880
|
-
:type undo: bool | None
|
|
3881
3029
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3882
|
-
:type use_scripts: bool | None
|
|
3883
3030
|
"""
|
|
3884
3031
|
|
|
3885
3032
|
def save_as_mainfile(
|
|
@@ -3918,48 +3065,26 @@ def save_as_mainfile(
|
|
|
3918
3065
|
) -> None:
|
|
3919
3066
|
"""Save the current file in the desired location
|
|
3920
3067
|
|
|
3921
|
-
:type execution_context: int | str | None
|
|
3922
|
-
:type undo: bool | None
|
|
3923
3068
|
:param filepath: File Path, Path to file
|
|
3924
|
-
:type filepath: str
|
|
3925
3069
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
3926
|
-
:type hide_props_region: bool | None
|
|
3927
3070
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
3928
|
-
:type check_existing: bool | None
|
|
3929
3071
|
:param filter_blender: Filter .blend files
|
|
3930
|
-
:type filter_blender: bool | None
|
|
3931
3072
|
:param filter_backup: Filter .blend files
|
|
3932
|
-
:type filter_backup: bool | None
|
|
3933
3073
|
:param filter_image: Filter image files
|
|
3934
|
-
:type filter_image: bool | None
|
|
3935
3074
|
:param filter_movie: Filter movie files
|
|
3936
|
-
:type filter_movie: bool | None
|
|
3937
3075
|
:param filter_python: Filter Python files
|
|
3938
|
-
:type filter_python: bool | None
|
|
3939
3076
|
:param filter_font: Filter font files
|
|
3940
|
-
:type filter_font: bool | None
|
|
3941
3077
|
:param filter_sound: Filter sound files
|
|
3942
|
-
:type filter_sound: bool | None
|
|
3943
3078
|
:param filter_text: Filter text files
|
|
3944
|
-
:type filter_text: bool | None
|
|
3945
3079
|
:param filter_archive: Filter archive files
|
|
3946
|
-
:type filter_archive: bool | None
|
|
3947
3080
|
:param filter_btx: Filter btx files
|
|
3948
|
-
:type filter_btx: bool | None
|
|
3949
3081
|
:param filter_alembic: Filter Alembic files
|
|
3950
|
-
:type filter_alembic: bool | None
|
|
3951
3082
|
:param filter_usd: Filter USD files
|
|
3952
|
-
:type filter_usd: bool | None
|
|
3953
3083
|
:param filter_obj: Filter OBJ files
|
|
3954
|
-
:type filter_obj: bool | None
|
|
3955
3084
|
:param filter_volume: Filter OpenVDB volume files
|
|
3956
|
-
:type filter_volume: bool | None
|
|
3957
3085
|
:param filter_folder: Filter folders
|
|
3958
|
-
:type filter_folder: bool | None
|
|
3959
3086
|
:param filter_blenlib: Filter Blender IDs
|
|
3960
|
-
:type filter_blenlib: bool | None
|
|
3961
3087
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
3962
|
-
:type filemode: int | None
|
|
3963
3088
|
:param display_type: Display Type
|
|
3964
3089
|
|
|
3965
3090
|
DEFAULT
|
|
@@ -3973,25 +3098,18 @@ def save_as_mainfile(
|
|
|
3973
3098
|
|
|
3974
3099
|
THUMBNAIL
|
|
3975
3100
|
Thumbnails -- Display files as thumbnails.
|
|
3976
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3977
3101
|
:param sort_method: File sorting mode
|
|
3978
|
-
:type sort_method: str | None
|
|
3979
3102
|
:param compress: Compress, Write compressed .blend file
|
|
3980
|
-
:type compress: bool | None
|
|
3981
3103
|
:param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
|
|
3982
|
-
:type relative_remap: bool | None
|
|
3983
3104
|
:param copy: Save Copy, Save a copy of the actual working state but does not make saved file active
|
|
3984
|
-
:type copy: bool | None
|
|
3985
3105
|
"""
|
|
3986
3106
|
|
|
3987
3107
|
def save_homefile(
|
|
3988
|
-
execution_context: int | str | None = None,
|
|
3108
|
+
execution_context: int | str | None = None,
|
|
3109
|
+
undo: bool | None = None,
|
|
3110
|
+
/,
|
|
3989
3111
|
) -> None:
|
|
3990
|
-
"""Make the current file the default startup file
|
|
3991
|
-
|
|
3992
|
-
:type execution_context: int | str | None
|
|
3993
|
-
:type undo: bool | None
|
|
3994
|
-
"""
|
|
3112
|
+
"""Make the current file the default startup file"""
|
|
3995
3113
|
|
|
3996
3114
|
def save_mainfile(
|
|
3997
3115
|
execution_context: int | str | None = None,
|
|
@@ -4030,48 +3148,26 @@ def save_mainfile(
|
|
|
4030
3148
|
) -> None:
|
|
4031
3149
|
"""Save the current Blender file
|
|
4032
3150
|
|
|
4033
|
-
:type execution_context: int | str | None
|
|
4034
|
-
:type undo: bool | None
|
|
4035
3151
|
:param filepath: File Path, Path to file
|
|
4036
|
-
:type filepath: str
|
|
4037
3152
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
4038
|
-
:type hide_props_region: bool | None
|
|
4039
3153
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4040
|
-
:type check_existing: bool | None
|
|
4041
3154
|
:param filter_blender: Filter .blend files
|
|
4042
|
-
:type filter_blender: bool | None
|
|
4043
3155
|
:param filter_backup: Filter .blend files
|
|
4044
|
-
:type filter_backup: bool | None
|
|
4045
3156
|
:param filter_image: Filter image files
|
|
4046
|
-
:type filter_image: bool | None
|
|
4047
3157
|
:param filter_movie: Filter movie files
|
|
4048
|
-
:type filter_movie: bool | None
|
|
4049
3158
|
:param filter_python: Filter Python files
|
|
4050
|
-
:type filter_python: bool | None
|
|
4051
3159
|
:param filter_font: Filter font files
|
|
4052
|
-
:type filter_font: bool | None
|
|
4053
3160
|
:param filter_sound: Filter sound files
|
|
4054
|
-
:type filter_sound: bool | None
|
|
4055
3161
|
:param filter_text: Filter text files
|
|
4056
|
-
:type filter_text: bool | None
|
|
4057
3162
|
:param filter_archive: Filter archive files
|
|
4058
|
-
:type filter_archive: bool | None
|
|
4059
3163
|
:param filter_btx: Filter btx files
|
|
4060
|
-
:type filter_btx: bool | None
|
|
4061
3164
|
:param filter_alembic: Filter Alembic files
|
|
4062
|
-
:type filter_alembic: bool | None
|
|
4063
3165
|
:param filter_usd: Filter USD files
|
|
4064
|
-
:type filter_usd: bool | None
|
|
4065
3166
|
:param filter_obj: Filter OBJ files
|
|
4066
|
-
:type filter_obj: bool | None
|
|
4067
3167
|
:param filter_volume: Filter OpenVDB volume files
|
|
4068
|
-
:type filter_volume: bool | None
|
|
4069
3168
|
:param filter_folder: Filter folders
|
|
4070
|
-
:type filter_folder: bool | None
|
|
4071
3169
|
:param filter_blenlib: Filter Blender IDs
|
|
4072
|
-
:type filter_blenlib: bool | None
|
|
4073
3170
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4074
|
-
:type filemode: int | None
|
|
4075
3171
|
:param display_type: Display Type
|
|
4076
3172
|
|
|
4077
3173
|
DEFAULT
|
|
@@ -4085,45 +3181,33 @@ def save_mainfile(
|
|
|
4085
3181
|
|
|
4086
3182
|
THUMBNAIL
|
|
4087
3183
|
Thumbnails -- Display files as thumbnails.
|
|
4088
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4089
3184
|
:param sort_method: File sorting mode
|
|
4090
|
-
:type sort_method: str | None
|
|
4091
3185
|
:param compress: Compress, Write compressed .blend file
|
|
4092
|
-
:type compress: bool | None
|
|
4093
3186
|
:param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
|
|
4094
|
-
:type relative_remap: bool | None
|
|
4095
3187
|
:param exit: Exit, Exit Blender after saving
|
|
4096
|
-
:type exit: bool | None
|
|
4097
3188
|
:param incremental: Incremental, Save the current Blender file with a numerically incremented name that does not overwrite any existing files
|
|
4098
|
-
:type incremental: bool | None
|
|
4099
3189
|
"""
|
|
4100
3190
|
|
|
4101
3191
|
def save_userpref(
|
|
4102
|
-
execution_context: int | str | None = None,
|
|
3192
|
+
execution_context: int | str | None = None,
|
|
3193
|
+
undo: bool | None = None,
|
|
3194
|
+
/,
|
|
4103
3195
|
) -> None:
|
|
4104
|
-
"""Make the current preferences default
|
|
4105
|
-
|
|
4106
|
-
:type execution_context: int | str | None
|
|
4107
|
-
:type undo: bool | None
|
|
4108
|
-
"""
|
|
3196
|
+
"""Make the current preferences default"""
|
|
4109
3197
|
|
|
4110
3198
|
def search_menu(
|
|
4111
|
-
execution_context: int | str | None = None,
|
|
3199
|
+
execution_context: int | str | None = None,
|
|
3200
|
+
undo: bool | None = None,
|
|
3201
|
+
/,
|
|
4112
3202
|
) -> None:
|
|
4113
|
-
"""Pop-up a search over all menus in the current context
|
|
4114
|
-
|
|
4115
|
-
:type execution_context: int | str | None
|
|
4116
|
-
:type undo: bool | None
|
|
4117
|
-
"""
|
|
3203
|
+
"""Pop-up a search over all menus in the current context"""
|
|
4118
3204
|
|
|
4119
3205
|
def search_operator(
|
|
4120
|
-
execution_context: int | str | None = None,
|
|
3206
|
+
execution_context: int | str | None = None,
|
|
3207
|
+
undo: bool | None = None,
|
|
3208
|
+
/,
|
|
4121
3209
|
) -> None:
|
|
4122
|
-
"""Pop-up a search over all available operators in current context
|
|
4123
|
-
|
|
4124
|
-
:type execution_context: int | str | None
|
|
4125
|
-
:type undo: bool | None
|
|
4126
|
-
"""
|
|
3210
|
+
"""Pop-up a search over all available operators in current context"""
|
|
4127
3211
|
|
|
4128
3212
|
def search_single_menu(
|
|
4129
3213
|
execution_context: int | str | None = None,
|
|
@@ -4135,12 +3219,8 @@ def search_single_menu(
|
|
|
4135
3219
|
) -> None:
|
|
4136
3220
|
"""Pop-up a search for a menu in current context
|
|
4137
3221
|
|
|
4138
|
-
:type execution_context: int | str | None
|
|
4139
|
-
:type undo: bool | None
|
|
4140
3222
|
:param menu_idname: Menu Name, Menu to search in
|
|
4141
|
-
:type menu_idname: str
|
|
4142
3223
|
:param initial_query: Initial Query, Query to insert into the search box
|
|
4143
|
-
:type initial_query: str
|
|
4144
3224
|
"""
|
|
4145
3225
|
|
|
4146
3226
|
def set_stereo_3d(
|
|
@@ -4158,37 +3238,40 @@ def set_stereo_3d(
|
|
|
4158
3238
|
) -> None:
|
|
4159
3239
|
"""Toggle 3D stereo support for current window (or change the display mode)
|
|
4160
3240
|
|
|
4161
|
-
:type execution_context: int | str | None
|
|
4162
|
-
:type undo: bool | None
|
|
4163
3241
|
:param display_mode: Display Mode
|
|
4164
|
-
:type display_mode: bpy.stub_internal.rna_enums.Stereo3DDisplayItems | None
|
|
4165
3242
|
:param anaglyph_type: Anaglyph Type
|
|
4166
|
-
:type anaglyph_type: bpy.stub_internal.rna_enums.Stereo3DAnaglyphTypeItems | None
|
|
4167
3243
|
:param interlace_type: Interlace Type
|
|
4168
|
-
:type interlace_type: bpy.stub_internal.rna_enums.Stereo3DInterlaceTypeItems | None
|
|
4169
3244
|
:param use_interlace_swap: Swap Left/Right, Swap left and right stereo channels
|
|
4170
|
-
:type use_interlace_swap: bool | None
|
|
4171
3245
|
:param use_sidebyside_crosseyed: Cross-Eyed, Right eye should see left image and vice versa
|
|
4172
|
-
:type use_sidebyside_crosseyed: bool | None
|
|
4173
3246
|
"""
|
|
4174
3247
|
|
|
4175
|
-
def
|
|
4176
|
-
execution_context: int | str | None = None,
|
|
3248
|
+
def set_working_color_space(
|
|
3249
|
+
execution_context: int | str | None = None,
|
|
3250
|
+
undo: bool | None = None,
|
|
3251
|
+
/,
|
|
3252
|
+
*,
|
|
3253
|
+
convert_colors: bool | None = True,
|
|
3254
|
+
working_space: str | None = "",
|
|
4177
3255
|
) -> None:
|
|
4178
|
-
"""
|
|
3256
|
+
"""Change the working color space of all colors in this blend file
|
|
4179
3257
|
|
|
4180
|
-
:
|
|
4181
|
-
:
|
|
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
|
|
4182
3260
|
"""
|
|
4183
3261
|
|
|
4184
|
-
def
|
|
4185
|
-
execution_context: int | str | None = None,
|
|
3262
|
+
def splash(
|
|
3263
|
+
execution_context: int | str | None = None,
|
|
3264
|
+
undo: bool | None = None,
|
|
3265
|
+
/,
|
|
4186
3266
|
) -> None:
|
|
4187
|
-
"""Open
|
|
3267
|
+
"""Open the splash screen with release info"""
|
|
4188
3268
|
|
|
4189
|
-
|
|
4190
|
-
:
|
|
4191
|
-
|
|
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"""
|
|
4192
3275
|
|
|
4193
3276
|
def stl_export(
|
|
4194
3277
|
execution_context: int | str | None = None,
|
|
@@ -4236,46 +3319,25 @@ def stl_export(
|
|
|
4236
3319
|
) -> None:
|
|
4237
3320
|
"""Save the scene to an STL file
|
|
4238
3321
|
|
|
4239
|
-
:type execution_context: int | str | None
|
|
4240
|
-
:type undo: bool | None
|
|
4241
3322
|
:param filepath: File Path, Path to file
|
|
4242
|
-
:type filepath: str
|
|
4243
3323
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4244
|
-
:type check_existing: bool | None
|
|
4245
3324
|
:param filter_blender: Filter .blend files
|
|
4246
|
-
:type filter_blender: bool | None
|
|
4247
3325
|
:param filter_backup: Filter .blend files
|
|
4248
|
-
:type filter_backup: bool | None
|
|
4249
3326
|
:param filter_image: Filter image files
|
|
4250
|
-
:type filter_image: bool | None
|
|
4251
3327
|
:param filter_movie: Filter movie files
|
|
4252
|
-
:type filter_movie: bool | None
|
|
4253
3328
|
:param filter_python: Filter Python files
|
|
4254
|
-
:type filter_python: bool | None
|
|
4255
3329
|
:param filter_font: Filter font files
|
|
4256
|
-
:type filter_font: bool | None
|
|
4257
3330
|
:param filter_sound: Filter sound files
|
|
4258
|
-
:type filter_sound: bool | None
|
|
4259
3331
|
:param filter_text: Filter text files
|
|
4260
|
-
:type filter_text: bool | None
|
|
4261
3332
|
:param filter_archive: Filter archive files
|
|
4262
|
-
:type filter_archive: bool | None
|
|
4263
3333
|
:param filter_btx: Filter btx files
|
|
4264
|
-
:type filter_btx: bool | None
|
|
4265
3334
|
:param filter_alembic: Filter Alembic files
|
|
4266
|
-
:type filter_alembic: bool | None
|
|
4267
3335
|
:param filter_usd: Filter USD files
|
|
4268
|
-
:type filter_usd: bool | None
|
|
4269
3336
|
:param filter_obj: Filter OBJ files
|
|
4270
|
-
:type filter_obj: bool | None
|
|
4271
3337
|
:param filter_volume: Filter OpenVDB volume files
|
|
4272
|
-
:type filter_volume: bool | None
|
|
4273
3338
|
:param filter_folder: Filter folders
|
|
4274
|
-
:type filter_folder: bool | None
|
|
4275
3339
|
:param filter_blenlib: Filter Blender IDs
|
|
4276
|
-
:type filter_blenlib: bool | None
|
|
4277
3340
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4278
|
-
:type filemode: int | None
|
|
4279
3341
|
:param display_type: Display Type
|
|
4280
3342
|
|
|
4281
3343
|
DEFAULT
|
|
@@ -4289,21 +3351,13 @@ def stl_export(
|
|
|
4289
3351
|
|
|
4290
3352
|
THUMBNAIL
|
|
4291
3353
|
Thumbnails -- Display files as thumbnails.
|
|
4292
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4293
3354
|
:param sort_method: File sorting mode
|
|
4294
|
-
:type sort_method: str | None
|
|
4295
3355
|
:param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
|
|
4296
|
-
:type ascii_format: bool | None
|
|
4297
3356
|
:param use_batch: Batch Export, Export each object to a separate file
|
|
4298
|
-
:type use_batch: bool | None
|
|
4299
3357
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
4300
|
-
:type export_selected_objects: bool | None
|
|
4301
3358
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
4302
|
-
:type collection: str
|
|
4303
3359
|
:param global_scale: Scale
|
|
4304
|
-
:
|
|
4305
|
-
:param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to exported data
|
|
4306
|
-
:type use_scene_unit: bool | None
|
|
3360
|
+
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to exported data
|
|
4307
3361
|
:param forward_axis: Forward Axis
|
|
4308
3362
|
|
|
4309
3363
|
X
|
|
@@ -4323,7 +3377,6 @@ def stl_export(
|
|
|
4323
3377
|
|
|
4324
3378
|
NEGATIVE_Z
|
|
4325
3379
|
-Z -- Negative Z axis.
|
|
4326
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4327
3380
|
:param up_axis: Up Axis
|
|
4328
3381
|
|
|
4329
3382
|
X
|
|
@@ -4343,11 +3396,8 @@ def stl_export(
|
|
|
4343
3396
|
|
|
4344
3397
|
NEGATIVE_Z
|
|
4345
3398
|
-Z -- Negative Z axis.
|
|
4346
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4347
3399
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
4348
|
-
:type apply_modifiers: bool | None
|
|
4349
3400
|
:param filter_glob: Extension Filter
|
|
4350
|
-
:type filter_glob: str
|
|
4351
3401
|
"""
|
|
4352
3402
|
|
|
4353
3403
|
def stl_import(
|
|
@@ -4396,50 +3446,27 @@ def stl_import(
|
|
|
4396
3446
|
) -> None:
|
|
4397
3447
|
"""Import an STL file as an object
|
|
4398
3448
|
|
|
4399
|
-
:type execution_context: int | str | None
|
|
4400
|
-
:type undo: bool | None
|
|
4401
3449
|
:param filepath: File Path, Path to file
|
|
4402
|
-
:type filepath: str
|
|
4403
3450
|
:param directory: Directory, Directory of the file
|
|
4404
|
-
:type directory: str
|
|
4405
3451
|
:param files: Files
|
|
4406
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
4407
3452
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4408
|
-
:type check_existing: bool | None
|
|
4409
3453
|
:param filter_blender: Filter .blend files
|
|
4410
|
-
:type filter_blender: bool | None
|
|
4411
3454
|
:param filter_backup: Filter .blend files
|
|
4412
|
-
:type filter_backup: bool | None
|
|
4413
3455
|
:param filter_image: Filter image files
|
|
4414
|
-
:type filter_image: bool | None
|
|
4415
3456
|
:param filter_movie: Filter movie files
|
|
4416
|
-
:type filter_movie: bool | None
|
|
4417
3457
|
:param filter_python: Filter Python files
|
|
4418
|
-
:type filter_python: bool | None
|
|
4419
3458
|
:param filter_font: Filter font files
|
|
4420
|
-
:type filter_font: bool | None
|
|
4421
3459
|
:param filter_sound: Filter sound files
|
|
4422
|
-
:type filter_sound: bool | None
|
|
4423
3460
|
:param filter_text: Filter text files
|
|
4424
|
-
:type filter_text: bool | None
|
|
4425
3461
|
:param filter_archive: Filter archive files
|
|
4426
|
-
:type filter_archive: bool | None
|
|
4427
3462
|
:param filter_btx: Filter btx files
|
|
4428
|
-
:type filter_btx: bool | None
|
|
4429
3463
|
:param filter_alembic: Filter Alembic files
|
|
4430
|
-
:type filter_alembic: bool | None
|
|
4431
3464
|
:param filter_usd: Filter USD files
|
|
4432
|
-
:type filter_usd: bool | None
|
|
4433
3465
|
:param filter_obj: Filter OBJ files
|
|
4434
|
-
:type filter_obj: bool | None
|
|
4435
3466
|
:param filter_volume: Filter OpenVDB volume files
|
|
4436
|
-
:type filter_volume: bool | None
|
|
4437
3467
|
:param filter_folder: Filter folders
|
|
4438
|
-
:type filter_folder: bool | None
|
|
4439
3468
|
:param filter_blenlib: Filter Blender IDs
|
|
4440
|
-
:type filter_blenlib: bool | None
|
|
4441
3469
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4442
|
-
:type filemode: int | None
|
|
4443
3470
|
:param display_type: Display Type
|
|
4444
3471
|
|
|
4445
3472
|
DEFAULT
|
|
@@ -4453,15 +3480,10 @@ def stl_import(
|
|
|
4453
3480
|
|
|
4454
3481
|
THUMBNAIL
|
|
4455
3482
|
Thumbnails -- Display files as thumbnails.
|
|
4456
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4457
3483
|
:param sort_method: File sorting mode
|
|
4458
|
-
:type sort_method: str | None
|
|
4459
3484
|
:param global_scale: Scale
|
|
4460
|
-
:
|
|
4461
|
-
:param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to imported data
|
|
4462
|
-
:type use_scene_unit: bool | None
|
|
3485
|
+
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
4463
3486
|
:param use_facet_normal: Facet Normals, Use (import) facet normals (note that this will still give flat shading)
|
|
4464
|
-
:type use_facet_normal: bool | None
|
|
4465
3487
|
:param forward_axis: Forward Axis
|
|
4466
3488
|
|
|
4467
3489
|
X
|
|
@@ -4481,7 +3503,6 @@ def stl_import(
|
|
|
4481
3503
|
|
|
4482
3504
|
NEGATIVE_Z
|
|
4483
3505
|
-Z -- Negative Z axis.
|
|
4484
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4485
3506
|
:param up_axis: Up Axis
|
|
4486
3507
|
|
|
4487
3508
|
X
|
|
@@ -4501,11 +3522,8 @@ def stl_import(
|
|
|
4501
3522
|
|
|
4502
3523
|
NEGATIVE_Z
|
|
4503
3524
|
-Z -- Negative Z axis.
|
|
4504
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4505
3525
|
:param use_mesh_validate: Validate Mesh, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
4506
|
-
:type use_mesh_validate: bool | None
|
|
4507
3526
|
:param filter_glob: Extension Filter
|
|
4508
|
-
:type filter_glob: str
|
|
4509
3527
|
"""
|
|
4510
3528
|
|
|
4511
3529
|
def sysinfo(
|
|
@@ -4517,10 +3535,7 @@ def sysinfo(
|
|
|
4517
3535
|
) -> None:
|
|
4518
3536
|
"""Generate system information, saved into a text file
|
|
4519
3537
|
|
|
4520
|
-
:type execution_context: int | str | None
|
|
4521
|
-
:type undo: bool | None
|
|
4522
3538
|
:param filepath: filepath
|
|
4523
|
-
:type filepath: str
|
|
4524
3539
|
"""
|
|
4525
3540
|
|
|
4526
3541
|
def tool_set_by_brush_type(
|
|
@@ -4554,12 +3569,8 @@ def tool_set_by_brush_type(
|
|
|
4554
3569
|
) -> None:
|
|
4555
3570
|
"""Look up the most appropriate tool for the given brush type and activate that
|
|
4556
3571
|
|
|
4557
|
-
:type execution_context: int | str | None
|
|
4558
|
-
:type undo: bool | None
|
|
4559
3572
|
:param brush_type: Brush Type, Brush type identifier for which the most appropriate tool will be looked up
|
|
4560
|
-
:type brush_type: str
|
|
4561
3573
|
:param space_type: Type
|
|
4562
|
-
: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
|
|
4563
3574
|
"""
|
|
4564
3575
|
|
|
4565
3576
|
def tool_set_by_id(
|
|
@@ -4595,16 +3606,10 @@ def tool_set_by_id(
|
|
|
4595
3606
|
) -> None:
|
|
4596
3607
|
"""Set the tool by name (for key-maps)
|
|
4597
3608
|
|
|
4598
|
-
:type execution_context: int | str | None
|
|
4599
|
-
:type undo: bool | None
|
|
4600
3609
|
:param name: Identifier, Identifier of the tool
|
|
4601
|
-
:type name: str
|
|
4602
3610
|
:param cycle: Cycle, Cycle through tools in this group
|
|
4603
|
-
:type cycle: bool | None
|
|
4604
3611
|
:param as_fallback: Set Fallback, Set the fallback tool instead of the primary tool
|
|
4605
|
-
:type as_fallback: bool | None
|
|
4606
3612
|
:param space_type: Type
|
|
4607
|
-
: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
|
|
4608
3613
|
"""
|
|
4609
3614
|
|
|
4610
3615
|
def tool_set_by_index(
|
|
@@ -4641,46 +3646,33 @@ def tool_set_by_index(
|
|
|
4641
3646
|
) -> None:
|
|
4642
3647
|
"""Set the tool by index (for key-maps)
|
|
4643
3648
|
|
|
4644
|
-
:type execution_context: int | str | None
|
|
4645
|
-
:type undo: bool | None
|
|
4646
3649
|
:param index: Index in Toolbar
|
|
4647
|
-
:type index: int | None
|
|
4648
3650
|
:param cycle: Cycle, Cycle through tools in this group
|
|
4649
|
-
:type cycle: bool | None
|
|
4650
3651
|
:param expand: expand, Include tool subgroups
|
|
4651
|
-
:type expand: bool | None
|
|
4652
3652
|
:param as_fallback: Set Fallback, Set the fallback tool instead of the primary
|
|
4653
|
-
:type as_fallback: bool | None
|
|
4654
3653
|
:param space_type: Type
|
|
4655
|
-
: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
|
|
4656
3654
|
"""
|
|
4657
3655
|
|
|
4658
3656
|
def toolbar(
|
|
4659
|
-
execution_context: int | str | None = None,
|
|
3657
|
+
execution_context: int | str | None = None,
|
|
3658
|
+
undo: bool | None = None,
|
|
3659
|
+
/,
|
|
4660
3660
|
) -> None:
|
|
4661
|
-
"""Undocumented, consider contributing.
|
|
4662
|
-
|
|
4663
|
-
:type execution_context: int | str | None
|
|
4664
|
-
:type undo: bool | None
|
|
4665
|
-
"""
|
|
3661
|
+
"""Undocumented, consider contributing."""
|
|
4666
3662
|
|
|
4667
3663
|
def toolbar_fallback_pie(
|
|
4668
|
-
execution_context: int | str | None = None,
|
|
3664
|
+
execution_context: int | str | None = None,
|
|
3665
|
+
undo: bool | None = None,
|
|
3666
|
+
/,
|
|
4669
3667
|
) -> None:
|
|
4670
|
-
"""Undocumented, consider contributing.
|
|
4671
|
-
|
|
4672
|
-
:type execution_context: int | str | None
|
|
4673
|
-
:type undo: bool | None
|
|
4674
|
-
"""
|
|
3668
|
+
"""Undocumented, consider contributing."""
|
|
4675
3669
|
|
|
4676
3670
|
def toolbar_prompt(
|
|
4677
|
-
execution_context: int | str | None = None,
|
|
3671
|
+
execution_context: int | str | None = None,
|
|
3672
|
+
undo: bool | None = None,
|
|
3673
|
+
/,
|
|
4678
3674
|
) -> None:
|
|
4679
|
-
"""Leader key like functionality for accessing tools
|
|
4680
|
-
|
|
4681
|
-
:type execution_context: int | str | None
|
|
4682
|
-
:type undo: bool | None
|
|
4683
|
-
"""
|
|
3675
|
+
"""Leader key like functionality for accessing tools"""
|
|
4684
3676
|
|
|
4685
3677
|
def url_open(
|
|
4686
3678
|
execution_context: int | str | None = None,
|
|
@@ -4691,10 +3683,7 @@ def url_open(
|
|
|
4691
3683
|
) -> None:
|
|
4692
3684
|
"""Open a website in the web browser
|
|
4693
3685
|
|
|
4694
|
-
:type execution_context: int | str | None
|
|
4695
|
-
:type undo: bool | None
|
|
4696
3686
|
:param url: URL, URL to open
|
|
4697
|
-
:type url: str
|
|
4698
3687
|
"""
|
|
4699
3688
|
|
|
4700
3689
|
def url_open_preset(
|
|
@@ -4706,10 +3695,7 @@ def url_open_preset(
|
|
|
4706
3695
|
) -> None:
|
|
4707
3696
|
"""Open a preset website in the web browser
|
|
4708
3697
|
|
|
4709
|
-
:type execution_context: int | str | None
|
|
4710
|
-
:type undo: bool | None
|
|
4711
3698
|
:param type: Site
|
|
4712
|
-
:type type: str | None
|
|
4713
3699
|
"""
|
|
4714
3700
|
|
|
4715
3701
|
def usd_export(
|
|
@@ -4743,7 +3729,6 @@ def usd_export(
|
|
|
4743
3729
|
sort_method: str | None = "",
|
|
4744
3730
|
filter_glob: str = "*.usd",
|
|
4745
3731
|
selected_objects_only: bool | None = False,
|
|
4746
|
-
visible_objects_only: bool | None = True,
|
|
4747
3732
|
collection: str = "",
|
|
4748
3733
|
export_animation: bool | None = False,
|
|
4749
3734
|
export_hair: bool | None = False,
|
|
@@ -4770,7 +3755,6 @@ def usd_export(
|
|
|
4770
3755
|
"X", "Y", "Z", "NEGATIVE_X", "NEGATIVE_Y", "NEGATIVE_Z"
|
|
4771
3756
|
]
|
|
4772
3757
|
| None = "Y",
|
|
4773
|
-
export_textures: bool | None = False,
|
|
4774
3758
|
export_textures_mode: typing.Literal["KEEP", "PRESERVE", "NEW"] | None = "NEW",
|
|
4775
3759
|
overwrite_textures: bool | None = False,
|
|
4776
3760
|
relative_paths: bool | None = True,
|
|
@@ -4778,9 +3762,11 @@ def usd_export(
|
|
|
4778
3762
|
root_prim_path: str = "/root",
|
|
4779
3763
|
export_custom_properties: bool | None = True,
|
|
4780
3764
|
custom_properties_namespace: str = "userProperties",
|
|
3765
|
+
accessibility_label: str = "",
|
|
3766
|
+
accessibility_description: str = "",
|
|
4781
3767
|
author_blender_name: bool | None = True,
|
|
4782
3768
|
convert_world_material: bool | None = True,
|
|
4783
|
-
allow_unicode: bool | None =
|
|
3769
|
+
allow_unicode: bool | None = True,
|
|
4784
3770
|
export_meshes: bool | None = True,
|
|
4785
3771
|
export_lights: bool | None = True,
|
|
4786
3772
|
export_cameras: bool | None = True,
|
|
@@ -4813,46 +3799,25 @@ def usd_export(
|
|
|
4813
3799
|
) -> None:
|
|
4814
3800
|
"""Export current scene in a USD archive
|
|
4815
3801
|
|
|
4816
|
-
:type execution_context: int | str | None
|
|
4817
|
-
:type undo: bool | None
|
|
4818
3802
|
:param filepath: File Path, Path to file
|
|
4819
|
-
:type filepath: str
|
|
4820
3803
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4821
|
-
:type check_existing: bool | None
|
|
4822
3804
|
:param filter_blender: Filter .blend files
|
|
4823
|
-
:type filter_blender: bool | None
|
|
4824
3805
|
:param filter_backup: Filter .blend files
|
|
4825
|
-
:type filter_backup: bool | None
|
|
4826
3806
|
:param filter_image: Filter image files
|
|
4827
|
-
:type filter_image: bool | None
|
|
4828
3807
|
:param filter_movie: Filter movie files
|
|
4829
|
-
:type filter_movie: bool | None
|
|
4830
3808
|
:param filter_python: Filter Python files
|
|
4831
|
-
:type filter_python: bool | None
|
|
4832
3809
|
:param filter_font: Filter font files
|
|
4833
|
-
:type filter_font: bool | None
|
|
4834
3810
|
:param filter_sound: Filter sound files
|
|
4835
|
-
:type filter_sound: bool | None
|
|
4836
3811
|
:param filter_text: Filter text files
|
|
4837
|
-
:type filter_text: bool | None
|
|
4838
3812
|
:param filter_archive: Filter archive files
|
|
4839
|
-
:type filter_archive: bool | None
|
|
4840
3813
|
:param filter_btx: Filter btx files
|
|
4841
|
-
:type filter_btx: bool | None
|
|
4842
3814
|
:param filter_alembic: Filter Alembic files
|
|
4843
|
-
:type filter_alembic: bool | None
|
|
4844
3815
|
:param filter_usd: Filter USD files
|
|
4845
|
-
:type filter_usd: bool | None
|
|
4846
3816
|
:param filter_obj: Filter OBJ files
|
|
4847
|
-
:type filter_obj: bool | None
|
|
4848
3817
|
:param filter_volume: Filter OpenVDB volume files
|
|
4849
|
-
:type filter_volume: bool | None
|
|
4850
3818
|
:param filter_folder: Filter folders
|
|
4851
|
-
:type filter_folder: bool | None
|
|
4852
3819
|
:param filter_blenlib: Filter Blender IDs
|
|
4853
|
-
:type filter_blenlib: bool | None
|
|
4854
3820
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4855
|
-
:type filemode: int | None
|
|
4856
3821
|
:param display_type: Display Type
|
|
4857
3822
|
|
|
4858
3823
|
DEFAULT
|
|
@@ -4866,30 +3831,16 @@ def usd_export(
|
|
|
4866
3831
|
|
|
4867
3832
|
THUMBNAIL
|
|
4868
3833
|
Thumbnails -- Display files as thumbnails.
|
|
4869
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4870
3834
|
:param sort_method: File sorting mode
|
|
4871
|
-
:type sort_method: str | None
|
|
4872
|
-
:type filter_glob: str
|
|
4873
3835
|
:param selected_objects_only: Selection Only, Only export selected objects. Unselected parents of selected objects are exported as empty transform
|
|
4874
|
-
:type selected_objects_only: bool | None
|
|
4875
|
-
:param visible_objects_only: Visible Only, Only export visible objects. Invisible parents of exported objects are exported as empty transforms
|
|
4876
|
-
:type visible_objects_only: bool | None
|
|
4877
3836
|
:param collection: Collection
|
|
4878
|
-
:type collection: str
|
|
4879
3837
|
:param export_animation: Animation, Export all frames in the render frame range, rather than only the current frame
|
|
4880
|
-
:type export_animation: bool | None
|
|
4881
3838
|
:param export_hair: Hair, Export hair particle systems as USD curves
|
|
4882
|
-
:type export_hair: bool | None
|
|
4883
3839
|
:param export_uvmaps: UV Maps, Include all mesh UV maps in the export
|
|
4884
|
-
:type export_uvmaps: bool | None
|
|
4885
3840
|
:param rename_uvmaps: Rename UV Maps, Rename active render UV map to "st" to match USD conventions
|
|
4886
|
-
:type rename_uvmaps: bool | None
|
|
4887
3841
|
:param export_mesh_colors: Color Attributes, Include mesh color attributes in the export
|
|
4888
|
-
:type export_mesh_colors: bool | None
|
|
4889
3842
|
:param export_normals: Normals, Include normals of exported meshes in the export
|
|
4890
|
-
:type export_normals: bool | None
|
|
4891
3843
|
:param export_materials: Materials, Export viewport settings of materials as USD preview materials, and export material assignments as geometry subsets
|
|
4892
|
-
:type export_materials: bool | None
|
|
4893
3844
|
:param export_subdivision: Subdivision, Choose how subdivision modifiers will be mapped to the USD subdivision scheme during export
|
|
4894
3845
|
|
|
4895
3846
|
IGNORE
|
|
@@ -4900,15 +3851,10 @@ def usd_export(
|
|
|
4900
3851
|
|
|
4901
3852
|
BEST_MATCH
|
|
4902
3853
|
Best Match -- Scheme = Catmull-Clark, when possible. Reverts to exporting the subdivided mesh for the Simple subdivision type.
|
|
4903
|
-
:type export_subdivision: typing.Literal['IGNORE','TESSELLATE','BEST_MATCH'] | None
|
|
4904
3854
|
:param export_armatures: Armatures, Export armatures and meshes with armature modifiers as USD skeletons and skinned meshes
|
|
4905
|
-
:type export_armatures: bool | None
|
|
4906
3855
|
:param only_deform_bones: Only Deform Bones, Only export deform bones and their parents
|
|
4907
|
-
:type only_deform_bones: bool | None
|
|
4908
3856
|
:param export_shapekeys: Shape Keys, Export shape keys as USD blend shapes
|
|
4909
|
-
:type export_shapekeys: bool | None
|
|
4910
3857
|
:param use_instancing: Instancing, Export instanced objects as references in USD rather than real objects
|
|
4911
|
-
:type use_instancing: bool | None
|
|
4912
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
|
|
4913
3859
|
|
|
4914
3860
|
RENDER
|
|
@@ -4916,13 +3862,9 @@ def usd_export(
|
|
|
4916
3862
|
|
|
4917
3863
|
VIEWPORT
|
|
4918
3864
|
Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
|
|
4919
|
-
:type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
|
|
4920
3865
|
:param generate_preview_surface: USD Preview Surface Network, Generate an approximate USD Preview Surface shader representation of a Principled BSDF node network
|
|
4921
|
-
:type generate_preview_surface: bool | None
|
|
4922
3866
|
:param generate_materialx_network: MaterialX Network, Generate a MaterialX network representation of the materials
|
|
4923
|
-
:type generate_materialx_network: bool | None
|
|
4924
3867
|
:param convert_orientation: Convert Orientation, Convert orientation axis to a different convention to match other applications
|
|
4925
|
-
:type convert_orientation: bool | None
|
|
4926
3868
|
:param export_global_forward_selection: Forward Axis
|
|
4927
3869
|
|
|
4928
3870
|
X
|
|
@@ -4942,7 +3884,6 @@ def usd_export(
|
|
|
4942
3884
|
|
|
4943
3885
|
NEGATIVE_Z
|
|
4944
3886
|
-Z -- Negative Z axis.
|
|
4945
|
-
:type export_global_forward_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4946
3887
|
:param export_global_up_selection: Up Axis
|
|
4947
3888
|
|
|
4948
3889
|
X
|
|
@@ -4962,9 +3903,6 @@ def usd_export(
|
|
|
4962
3903
|
|
|
4963
3904
|
NEGATIVE_Z
|
|
4964
3905
|
-Z -- Negative Z axis.
|
|
4965
|
-
:type export_global_up_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4966
|
-
:param export_textures: Export Textures, If exporting materials, export textures referenced by material nodes to a 'textures' directory in the same directory as the USD file
|
|
4967
|
-
:type export_textures: bool | None
|
|
4968
3906
|
:param export_textures_mode: Export Textures, Texture export method
|
|
4969
3907
|
|
|
4970
3908
|
KEEP
|
|
@@ -4972,15 +3910,12 @@ def usd_export(
|
|
|
4972
3910
|
|
|
4973
3911
|
PRESERVE
|
|
4974
3912
|
Preserve -- Preserve file paths of textures from already imported USD files.
|
|
4975
|
-
Export remaining textures to a
|
|
3913
|
+
Export remaining textures to a textures folder next to the USD file.
|
|
4976
3914
|
|
|
4977
3915
|
NEW
|
|
4978
|
-
New Path -- Export textures to a
|
|
4979
|
-
:type export_textures_mode: typing.Literal['KEEP','PRESERVE','NEW'] | None
|
|
3916
|
+
New Path -- Export textures to a textures folder next to the USD file.
|
|
4980
3917
|
:param overwrite_textures: Overwrite Textures, Overwrite existing files when exporting textures
|
|
4981
|
-
:type overwrite_textures: bool | None
|
|
4982
3918
|
:param relative_paths: Relative Paths, Use relative paths to reference external files (i.e. textures, volumes) in USD, otherwise use absolute paths
|
|
4983
|
-
:type relative_paths: bool | None
|
|
4984
3919
|
:param xform_op_mode: Xform Ops, The type of transform operators to write
|
|
4985
3920
|
|
|
4986
3921
|
TRS
|
|
@@ -4991,37 +3926,23 @@ def usd_export(
|
|
|
4991
3926
|
|
|
4992
3927
|
MAT
|
|
4993
3928
|
Matrix -- Export matrix operator.
|
|
4994
|
-
:type xform_op_mode: typing.Literal['TRS','TOS','MAT'] | None
|
|
4995
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
|
|
4996
|
-
:type root_prim_path: str
|
|
4997
3930
|
:param export_custom_properties: Custom Properties, Export custom properties as USD attributes
|
|
4998
|
-
:
|
|
4999
|
-
:param
|
|
5000
|
-
:
|
|
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
|
|
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
|
|
5001
3934
|
:param author_blender_name: Blender Names, Author USD custom attributes containing the original Blender object and object data names
|
|
5002
|
-
:type author_blender_name: bool | None
|
|
5003
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
|
|
5004
|
-
:type convert_world_material: bool | None
|
|
5005
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)
|
|
5006
|
-
:type allow_unicode: bool | None
|
|
5007
3937
|
:param export_meshes: Meshes, Export all meshes
|
|
5008
|
-
:type export_meshes: bool | None
|
|
5009
3938
|
:param export_lights: Lights, Export all lights
|
|
5010
|
-
:type export_lights: bool | None
|
|
5011
3939
|
:param export_cameras: Cameras, Export all cameras
|
|
5012
|
-
:type export_cameras: bool | None
|
|
5013
3940
|
:param export_curves: Curves, Export all curves
|
|
5014
|
-
:type export_curves: bool | None
|
|
5015
3941
|
:param export_points: Point Clouds, Export all point clouds
|
|
5016
|
-
:type export_points: bool | None
|
|
5017
3942
|
:param export_volumes: Volumes, Export all volumes
|
|
5018
|
-
:type export_volumes: bool | None
|
|
5019
3943
|
:param triangulate_meshes: Triangulate Meshes, Triangulate meshes during export
|
|
5020
|
-
:type triangulate_meshes: bool | None
|
|
5021
3944
|
:param quad_method: Quad Method, Method for splitting the quads into triangles
|
|
5022
|
-
:type quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems | None
|
|
5023
3945
|
:param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
|
|
5024
|
-
:type ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems | None
|
|
5025
3946
|
:param usdz_downscale_size: USDZ Texture Downsampling, Choose a maximum size for all exported textures
|
|
5026
3947
|
|
|
5027
3948
|
KEEP
|
|
@@ -5044,11 +3965,8 @@ def usd_export(
|
|
|
5044
3965
|
|
|
5045
3966
|
CUSTOM
|
|
5046
3967
|
Custom -- Specify a custom size.
|
|
5047
|
-
:type usdz_downscale_size: typing.Literal['KEEP','256','512','1024','2048','4096','CUSTOM'] | None
|
|
5048
3968
|
:param usdz_downscale_custom_size: USDZ Custom Downscale Size, Custom size for downscaling exported textures
|
|
5049
|
-
:type usdz_downscale_custom_size: int | None
|
|
5050
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.
|
|
5051
|
-
:type merge_parent_xform: bool | None
|
|
5052
3970
|
:param convert_scene_units: Units, Set the USD Stage meters per unit to the chosen measurement, or a custom value
|
|
5053
3971
|
|
|
5054
3972
|
METERS
|
|
@@ -5074,9 +3992,7 @@ def usd_export(
|
|
|
5074
3992
|
|
|
5075
3993
|
CUSTOM
|
|
5076
3994
|
Custom -- Specify a custom scene meters per unit value.
|
|
5077
|
-
:type convert_scene_units: typing.Literal['METERS','KILOMETERS','CENTIMETERS','MILLIMETERS','INCHES','FEET','YARDS','CUSTOM'] | None
|
|
5078
3995
|
:param meters_per_unit: Meters Per Unit, Custom value for meters per unit in the USD Stage
|
|
5079
|
-
:type meters_per_unit: float | None
|
|
5080
3996
|
"""
|
|
5081
3997
|
|
|
5082
3998
|
def usd_import(
|
|
@@ -5122,7 +4038,7 @@ def usd_import(
|
|
|
5122
4038
|
import_skeletons: bool | None = True,
|
|
5123
4039
|
import_blendshapes: bool | None = True,
|
|
5124
4040
|
import_points: bool | None = True,
|
|
5125
|
-
|
|
4041
|
+
import_subdivision: bool | None = False,
|
|
5126
4042
|
support_scene_instancing: bool | None = True,
|
|
5127
4043
|
import_visible_only: bool | None = True,
|
|
5128
4044
|
create_collection: bool | None = False,
|
|
@@ -5146,7 +4062,7 @@ def usd_import(
|
|
|
5146
4062
|
import_textures_dir: str = "//textures/",
|
|
5147
4063
|
tex_name_collision_mode: typing.Literal["USE_EXISTING", "OVERWRITE"]
|
|
5148
4064
|
| None = "USE_EXISTING",
|
|
5149
|
-
|
|
4065
|
+
property_import_mode: typing.Literal["NONE", "USER", "ALL"] | None = "ALL",
|
|
5150
4066
|
validate_meshes: bool | None = False,
|
|
5151
4067
|
create_world_material: bool | None = True,
|
|
5152
4068
|
import_defined_only: bool | None = True,
|
|
@@ -5155,48 +4071,26 @@ def usd_import(
|
|
|
5155
4071
|
) -> None:
|
|
5156
4072
|
"""Import USD stage into current scene
|
|
5157
4073
|
|
|
5158
|
-
:type execution_context: int | str | None
|
|
5159
|
-
:type undo: bool | None
|
|
5160
4074
|
:param filepath: File Path, Path to file
|
|
5161
|
-
:type filepath: str
|
|
5162
4075
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
5163
|
-
:type check_existing: bool | None
|
|
5164
4076
|
:param filter_blender: Filter .blend files
|
|
5165
|
-
:type filter_blender: bool | None
|
|
5166
4077
|
:param filter_backup: Filter .blend files
|
|
5167
|
-
:type filter_backup: bool | None
|
|
5168
4078
|
:param filter_image: Filter image files
|
|
5169
|
-
:type filter_image: bool | None
|
|
5170
4079
|
:param filter_movie: Filter movie files
|
|
5171
|
-
:type filter_movie: bool | None
|
|
5172
4080
|
:param filter_python: Filter Python files
|
|
5173
|
-
:type filter_python: bool | None
|
|
5174
4081
|
:param filter_font: Filter font files
|
|
5175
|
-
:type filter_font: bool | None
|
|
5176
4082
|
:param filter_sound: Filter sound files
|
|
5177
|
-
:type filter_sound: bool | None
|
|
5178
4083
|
:param filter_text: Filter text files
|
|
5179
|
-
:type filter_text: bool | None
|
|
5180
4084
|
:param filter_archive: Filter archive files
|
|
5181
|
-
:type filter_archive: bool | None
|
|
5182
4085
|
:param filter_btx: Filter btx files
|
|
5183
|
-
:type filter_btx: bool | None
|
|
5184
4086
|
:param filter_alembic: Filter Alembic files
|
|
5185
|
-
:type filter_alembic: bool | None
|
|
5186
4087
|
:param filter_usd: Filter USD files
|
|
5187
|
-
:type filter_usd: bool | None
|
|
5188
4088
|
:param filter_obj: Filter OBJ files
|
|
5189
|
-
:type filter_obj: bool | None
|
|
5190
4089
|
:param filter_volume: Filter OpenVDB volume files
|
|
5191
|
-
:type filter_volume: bool | None
|
|
5192
4090
|
:param filter_folder: Filter folders
|
|
5193
|
-
:type filter_folder: bool | None
|
|
5194
4091
|
:param filter_blenlib: Filter Blender IDs
|
|
5195
|
-
:type filter_blenlib: bool | None
|
|
5196
4092
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
5197
|
-
:type filemode: int | None
|
|
5198
4093
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
5199
|
-
:type relative_path: bool | None
|
|
5200
4094
|
:param display_type: Display Type
|
|
5201
4095
|
|
|
5202
4096
|
DEFAULT
|
|
@@ -5210,75 +4104,44 @@ def usd_import(
|
|
|
5210
4104
|
|
|
5211
4105
|
THUMBNAIL
|
|
5212
4106
|
Thumbnails -- Display files as thumbnails.
|
|
5213
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
5214
4107
|
:param sort_method: File sorting mode
|
|
5215
|
-
:
|
|
5216
|
-
:
|
|
5217
|
-
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
|
|
5218
|
-
:type scale: float | None
|
|
5219
|
-
:param set_frame_range: Set Frame Range, Update the scene's start and end frame to match those of the USD archive
|
|
5220
|
-
:type set_frame_range: bool | None
|
|
4108
|
+
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
4109
|
+
:param set_frame_range: Set Frame Range, Update the scenes start and end frame to match those of the USD archive
|
|
5221
4110
|
:param import_cameras: Cameras
|
|
5222
|
-
:type import_cameras: bool | None
|
|
5223
4111
|
:param import_curves: Curves
|
|
5224
|
-
:type import_curves: bool | None
|
|
5225
4112
|
:param import_lights: Lights
|
|
5226
|
-
:type import_lights: bool | None
|
|
5227
4113
|
:param import_materials: Materials
|
|
5228
|
-
:type import_materials: bool | None
|
|
5229
4114
|
:param import_meshes: Meshes
|
|
5230
|
-
:type import_meshes: bool | None
|
|
5231
4115
|
:param import_volumes: Volumes
|
|
5232
|
-
:type import_volumes: bool | None
|
|
5233
4116
|
:param import_shapes: USD Shapes
|
|
5234
|
-
:type import_shapes: bool | None
|
|
5235
4117
|
:param import_skeletons: Armatures
|
|
5236
|
-
:type import_skeletons: bool | None
|
|
5237
4118
|
:param import_blendshapes: Shape Keys
|
|
5238
|
-
:type import_blendshapes: bool | None
|
|
5239
4119
|
:param import_points: Point Clouds
|
|
5240
|
-
:
|
|
5241
|
-
:param import_subdiv: Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute
|
|
5242
|
-
:type import_subdiv: bool | None
|
|
4120
|
+
:param import_subdivision: Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute
|
|
5243
4121
|
:param support_scene_instancing: Scene Instancing, Import USD scene graph instances as collection instances
|
|
5244
|
-
:type support_scene_instancing: bool | None
|
|
5245
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
|
|
5246
|
-
:type import_visible_only: bool | None
|
|
5247
4123
|
:param create_collection: Create Collection, Add all imported objects to a new collection
|
|
5248
|
-
:type create_collection: bool | None
|
|
5249
4124
|
:param read_mesh_uvs: UV Coordinates, Read mesh UV coordinates
|
|
5250
|
-
:type read_mesh_uvs: bool | None
|
|
5251
4125
|
:param read_mesh_colors: Color Attributes, Read mesh color attributes
|
|
5252
|
-
:type read_mesh_colors: bool | None
|
|
5253
4126
|
:param read_mesh_attributes: Mesh Attributes, Read USD Primvars as mesh attributes
|
|
5254
|
-
:type read_mesh_attributes: bool | None
|
|
5255
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
|
|
5256
|
-
:type prim_path_mask: str
|
|
5257
4128
|
:param import_guide: Guide, Import guide geometry
|
|
5258
|
-
:type import_guide: bool | None
|
|
5259
4129
|
:param import_proxy: Proxy, Import proxy geometry
|
|
5260
|
-
:type import_proxy: bool | None
|
|
5261
4130
|
:param import_render: Render, Import final render geometry
|
|
5262
|
-
:type import_render: bool | None
|
|
5263
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
|
|
5264
|
-
:type import_all_materials: bool | None
|
|
5265
4132
|
:param import_usd_preview: Import USD Preview, Convert UsdPreviewSurface shaders to Principled BSDF shader networks
|
|
5266
|
-
:
|
|
5267
|
-
: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 shader's opacity and opacityThreshold inputs
|
|
5268
|
-
:type set_material_blend: bool | None
|
|
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
|
|
5269
4134
|
:param light_intensity_scale: Light Intensity Scale, Scale for the intensity of imported lights
|
|
5270
|
-
:type light_intensity_scale: float | None
|
|
5271
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
|
|
5272
4136
|
|
|
5273
4137
|
MTL_ALL_PURPOSE
|
|
5274
|
-
All Purpose -- Attempt to import
|
|
4138
|
+
All Purpose -- Attempt to import allPurpose materials..
|
|
5275
4139
|
|
|
5276
4140
|
MTL_PREVIEW
|
|
5277
|
-
Preview -- Attempt to import
|
|
4141
|
+
Preview -- Attempt to import preview materials. Load allPurpose materials as a fallback.
|
|
5278
4142
|
|
|
5279
4143
|
MTL_FULL
|
|
5280
|
-
Full -- Attempt to import
|
|
5281
|
-
:type mtl_purpose: typing.Literal['MTL_ALL_PURPOSE','MTL_PREVIEW','MTL_FULL'] | None
|
|
4144
|
+
Full -- Attempt to import full materials. Load allPurpose or preview materials, in that order, as a fallback.
|
|
5282
4145
|
:param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
|
|
5283
4146
|
|
|
5284
4147
|
MAKE_UNIQUE
|
|
@@ -5286,20 +4149,17 @@ def usd_import(
|
|
|
5286
4149
|
|
|
5287
4150
|
REFERENCE_EXISTING
|
|
5288
4151
|
Reference Existing -- If a material with the same name already exists, reference that instead of importing.
|
|
5289
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
5290
4152
|
:param import_textures_mode: Import Textures, Behavior when importing textures from a USDZ archive
|
|
5291
4153
|
|
|
5292
4154
|
IMPORT_NONE
|
|
5293
|
-
None --
|
|
4155
|
+
None -- Dont import textures.
|
|
5294
4156
|
|
|
5295
4157
|
IMPORT_PACK
|
|
5296
4158
|
Packed -- Import textures as packed data.
|
|
5297
4159
|
|
|
5298
4160
|
IMPORT_COPY
|
|
5299
4161
|
Copy -- Copy files to textures directory.
|
|
5300
|
-
:type import_textures_mode: typing.Literal['IMPORT_NONE','IMPORT_PACK','IMPORT_COPY'] | None
|
|
5301
4162
|
:param import_textures_dir: Textures Directory, Path to the directory where imported textures will be copied
|
|
5302
|
-
:type import_textures_dir: str
|
|
5303
4163
|
:param tex_name_collision_mode: File Name Collision, Behavior when the name of an imported texture file conflicts with an existing file
|
|
5304
4164
|
|
|
5305
4165
|
USE_EXISTING
|
|
@@ -5307,65 +4167,50 @@ def usd_import(
|
|
|
5307
4167
|
|
|
5308
4168
|
OVERWRITE
|
|
5309
4169
|
Overwrite -- Overwrite existing files.
|
|
5310
|
-
:
|
|
5311
|
-
:param attr_import_mode: Custom Properties, Behavior when importing USD attributes as Blender custom properties
|
|
4170
|
+
:param property_import_mode: Custom Properties, Behavior when importing USD attributes as Blender custom properties
|
|
5312
4171
|
|
|
5313
4172
|
NONE
|
|
5314
4173
|
None -- Do not import USD custom attributes.
|
|
5315
4174
|
|
|
5316
4175
|
USER
|
|
5317
|
-
User -- Import USD attributes in the
|
|
4176
|
+
User -- Import USD attributes in the userProperties namespace as Blender custom properties. The namespace will be stripped from the property names.
|
|
5318
4177
|
|
|
5319
4178
|
ALL
|
|
5320
4179
|
All Custom -- Import all USD custom attributes as Blender custom properties. Namespaces will be retained in the property names.
|
|
5321
|
-
:type attr_import_mode: typing.Literal['NONE','USER','ALL'] | None
|
|
5322
4180
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
5323
|
-
:type validate_meshes: bool | None
|
|
5324
4181
|
:param create_world_material: World Dome Light, Convert the first discovered USD dome light to a world background shader
|
|
5325
|
-
:type create_world_material: bool | None
|
|
5326
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
|
|
5327
|
-
:type import_defined_only: bool | None
|
|
5328
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
|
|
5329
|
-
:
|
|
5330
|
-
:param apply_unit_conversion_scale: Apply Unit Conversion Scale, Scale the scene objects by the USD stage's meters per unit value. This scaling is applied in addition to the value specified in the Scale option
|
|
5331
|
-
:type apply_unit_conversion_scale: bool | None
|
|
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
|
|
5332
4185
|
"""
|
|
5333
4186
|
|
|
5334
4187
|
def window_close(
|
|
5335
|
-
execution_context: int | str | None = None,
|
|
4188
|
+
execution_context: int | str | None = None,
|
|
4189
|
+
undo: bool | None = None,
|
|
4190
|
+
/,
|
|
5336
4191
|
) -> None:
|
|
5337
|
-
"""Close the current window
|
|
5338
|
-
|
|
5339
|
-
:type execution_context: int | str | None
|
|
5340
|
-
:type undo: bool | None
|
|
5341
|
-
"""
|
|
4192
|
+
"""Close the current window"""
|
|
5342
4193
|
|
|
5343
4194
|
def window_fullscreen_toggle(
|
|
5344
|
-
execution_context: int | str | None = None,
|
|
4195
|
+
execution_context: int | str | None = None,
|
|
4196
|
+
undo: bool | None = None,
|
|
4197
|
+
/,
|
|
5345
4198
|
) -> None:
|
|
5346
|
-
"""Toggle the current window full-screen
|
|
5347
|
-
|
|
5348
|
-
:type execution_context: int | str | None
|
|
5349
|
-
:type undo: bool | None
|
|
5350
|
-
"""
|
|
4199
|
+
"""Toggle the current window full-screen"""
|
|
5351
4200
|
|
|
5352
4201
|
def window_new(
|
|
5353
|
-
execution_context: int | str | None = None,
|
|
4202
|
+
execution_context: int | str | None = None,
|
|
4203
|
+
undo: bool | None = None,
|
|
4204
|
+
/,
|
|
5354
4205
|
) -> None:
|
|
5355
|
-
"""Create a new window
|
|
5356
|
-
|
|
5357
|
-
:type execution_context: int | str | None
|
|
5358
|
-
:type undo: bool | None
|
|
5359
|
-
"""
|
|
4206
|
+
"""Create a new window"""
|
|
5360
4207
|
|
|
5361
4208
|
def window_new_main(
|
|
5362
|
-
execution_context: int | str | None = None,
|
|
4209
|
+
execution_context: int | str | None = None,
|
|
4210
|
+
undo: bool | None = None,
|
|
4211
|
+
/,
|
|
5363
4212
|
) -> None:
|
|
5364
|
-
"""Create a new main window with its own workspace and scene selection
|
|
5365
|
-
|
|
5366
|
-
:type execution_context: int | str | None
|
|
5367
|
-
:type undo: bool | None
|
|
5368
|
-
"""
|
|
4213
|
+
"""Create a new main window with its own workspace and scene selection"""
|
|
5369
4214
|
|
|
5370
4215
|
def xr_navigation_fly(
|
|
5371
4216
|
execution_context: int | str | None = None,
|
|
@@ -5388,11 +4233,12 @@ def xr_navigation_fly(
|
|
|
5388
4233
|
"CONTROLLER_FORWARD",
|
|
5389
4234
|
]
|
|
5390
4235
|
| None = "VIEWER_FORWARD",
|
|
4236
|
+
snap_turn_threshold: float | None = 0.95,
|
|
5391
4237
|
lock_location_z: bool | None = False,
|
|
5392
4238
|
lock_direction: bool | None = False,
|
|
5393
|
-
speed_frame_based: bool | None =
|
|
5394
|
-
|
|
5395
|
-
|
|
4239
|
+
speed_frame_based: bool | None = False,
|
|
4240
|
+
turn_speed_factor: float | None = 0.333333,
|
|
4241
|
+
fly_speed_factor: float | None = 0.333333,
|
|
5396
4242
|
speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None = (
|
|
5397
4243
|
0.0,
|
|
5398
4244
|
0.0,
|
|
@@ -5401,11 +4247,27 @@ def xr_navigation_fly(
|
|
|
5401
4247
|
1.0,
|
|
5402
4248
|
1.0,
|
|
5403
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,
|
|
5404
4268
|
) -> None:
|
|
5405
4269
|
"""Move/turn relative to the VR viewer or controller
|
|
5406
4270
|
|
|
5407
|
-
:type execution_context: int | str | None
|
|
5408
|
-
:type undo: bool | None
|
|
5409
4271
|
:param mode: Mode, Fly mode
|
|
5410
4272
|
|
|
5411
4273
|
FORWARD
|
|
@@ -5433,34 +4295,69 @@ def xr_navigation_fly(
|
|
|
5433
4295
|
Turn Right -- Turn clockwise around navigation up axis.
|
|
5434
4296
|
|
|
5435
4297
|
VIEWER_FORWARD
|
|
5436
|
-
Viewer Forward -- Move along
|
|
4298
|
+
Viewer Forward -- Move along viewers forward axis.
|
|
5437
4299
|
|
|
5438
4300
|
VIEWER_BACK
|
|
5439
|
-
Viewer Back -- Move along
|
|
4301
|
+
Viewer Back -- Move along viewers back axis.
|
|
5440
4302
|
|
|
5441
4303
|
VIEWER_LEFT
|
|
5442
|
-
Viewer Left -- Move along
|
|
4304
|
+
Viewer Left -- Move along viewers left axis.
|
|
5443
4305
|
|
|
5444
4306
|
VIEWER_RIGHT
|
|
5445
|
-
Viewer Right -- Move along
|
|
4307
|
+
Viewer Right -- Move along viewers right axis.
|
|
5446
4308
|
|
|
5447
4309
|
CONTROLLER_FORWARD
|
|
5448
|
-
Controller Forward -- Move along
|
|
5449
|
-
:
|
|
4310
|
+
Controller Forward -- Move along controllers forward axis.
|
|
4311
|
+
:param snap_turn_threshold: Snap Turn Threshold, Input state threshold when using snap turn
|
|
5450
4312
|
:param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
|
|
5451
|
-
:
|
|
5452
|
-
:param lock_direction: Lock Direction, Limit movement to viewer's initial direction
|
|
5453
|
-
:type lock_direction: bool | None
|
|
4313
|
+
:param lock_direction: Lock Direction, Limit movement to viewers initial direction
|
|
5454
4314
|
:param speed_frame_based: Frame Based Speed, Apply fixed movement deltas every update
|
|
5455
|
-
:
|
|
5456
|
-
:param
|
|
5457
|
-
:type speed_min: float | None
|
|
5458
|
-
:param speed_max: Maximum Speed, Maximum move (turn) speed in meters (radians) per second or frame
|
|
5459
|
-
: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
|
|
5460
4317
|
:param speed_interpolation0: Speed Interpolation 0, First cubic spline control point between min/max speeds
|
|
5461
|
-
:type speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
5462
4318
|
:param speed_interpolation1: Speed Interpolation 1, Second cubic spline control point between min/max speeds
|
|
5463
|
-
:
|
|
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
|
|
5464
4361
|
"""
|
|
5465
4362
|
|
|
5466
4363
|
def xr_navigation_grab(
|
|
@@ -5476,18 +4373,11 @@ def xr_navigation_grab(
|
|
|
5476
4373
|
) -> None:
|
|
5477
4374
|
"""Navigate the VR scene by grabbing with controllers
|
|
5478
4375
|
|
|
5479
|
-
:type execution_context: int | str | None
|
|
5480
|
-
:type undo: bool | None
|
|
5481
4376
|
:param lock_location: Lock Location, Prevent changes to viewer location
|
|
5482
|
-
:type lock_location: bool | None
|
|
5483
4377
|
:param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
|
|
5484
|
-
:type lock_location_z: bool | None
|
|
5485
4378
|
:param lock_rotation: Lock Rotation, Prevent changes to viewer rotation
|
|
5486
|
-
:type lock_rotation: bool | None
|
|
5487
4379
|
:param lock_rotation_z: Lock Up Orientation, Prevent changes to viewer up orientation
|
|
5488
|
-
:type lock_rotation_z: bool | None
|
|
5489
4380
|
:param lock_scale: Lock Scale, Prevent changes to viewer scale
|
|
5490
|
-
:type lock_scale: bool | None
|
|
5491
4381
|
"""
|
|
5492
4382
|
|
|
5493
4383
|
def xr_navigation_reset(
|
|
@@ -5501,57 +4391,47 @@ def xr_navigation_reset(
|
|
|
5501
4391
|
) -> None:
|
|
5502
4392
|
"""Reset VR navigation deltas relative to session base pose
|
|
5503
4393
|
|
|
5504
|
-
:type execution_context: int | str | None
|
|
5505
|
-
:type undo: bool | None
|
|
5506
4394
|
:param location: Location, Reset location deltas
|
|
5507
|
-
:type location: bool | None
|
|
5508
4395
|
:param rotation: Rotation, Reset rotation deltas
|
|
5509
|
-
:type rotation: bool | None
|
|
5510
4396
|
:param scale: Scale, Reset scale deltas
|
|
5511
|
-
:type scale: bool | None
|
|
5512
4397
|
"""
|
|
5513
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
|
+
|
|
5514
4406
|
def xr_navigation_teleport(
|
|
5515
4407
|
execution_context: int | str | None = None,
|
|
5516
4408
|
undo: bool | None = None,
|
|
5517
4409
|
/,
|
|
5518
4410
|
*,
|
|
5519
|
-
teleport_axes: collections.abc.Iterable[bool] | None = (True, True, True),
|
|
5520
|
-
interpolation: float | None = 1.0,
|
|
5521
|
-
offset: float | None = 0.0,
|
|
5522
4411
|
selectable_only: bool | None = True,
|
|
5523
|
-
|
|
5524
|
-
|
|
5525
|
-
|
|
5526
|
-
|
|
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),
|
|
5527
4419
|
) -> None:
|
|
5528
4420
|
"""Set VR viewer location to controller raycast hit location
|
|
5529
4421
|
|
|
5530
|
-
:type execution_context: int | str | None
|
|
5531
|
-
:type undo: bool | None
|
|
5532
|
-
:param teleport_axes: Teleport Axes, Enabled teleport axes in navigation space
|
|
5533
|
-
:type teleport_axes: collections.abc.Iterable[bool] | None
|
|
5534
|
-
:param interpolation: Interpolation, Interpolation factor between viewer and hit locations
|
|
5535
|
-
:type interpolation: float | None
|
|
5536
|
-
:param offset: Offset, Offset along hit normal to subtract from final location
|
|
5537
|
-
:type offset: float | None
|
|
5538
4422
|
:param selectable_only: Selectable Only, Only allow selectable objects to influence raycast result
|
|
5539
|
-
:
|
|
5540
|
-
:param
|
|
5541
|
-
:
|
|
5542
|
-
:param
|
|
5543
|
-
:
|
|
5544
|
-
:param
|
|
5545
|
-
:
|
|
5546
|
-
:param color: Color, Raycast color
|
|
5547
|
-
: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
|
|
5548
4430
|
"""
|
|
5549
4431
|
|
|
5550
4432
|
def xr_session_toggle(
|
|
5551
|
-
execution_context: int | str | None = None,
|
|
4433
|
+
execution_context: int | str | None = None,
|
|
4434
|
+
undo: bool | None = None,
|
|
4435
|
+
/,
|
|
5552
4436
|
) -> None:
|
|
5553
|
-
"""Open a view for use with virtual reality headsets, or close it if already opened
|
|
5554
|
-
|
|
5555
|
-
:type execution_context: int | str | None
|
|
5556
|
-
:type undo: bool | None
|
|
5557
|
-
"""
|
|
4437
|
+
"""Open a view for use with virtual reality headsets, or close it if already opened"""
|