fake-bpy-module-latest 20260113__py3-none-any.whl → 20260114__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/autocomplete/complete_calltip/__init__.pyi +0 -13
- _bl_console_utils/autocomplete/complete_import/__init__.pyi +0 -5
- _bl_console_utils/autocomplete/complete_namespace/__init__.pyi +0 -11
- _bl_console_utils/autocomplete/intellisense/__init__.pyi +0 -10
- _bpy_types/__init__.pyi +1 -122
- _rna_info/__init__.pyi +0 -1
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +0 -146
- bl_math/__init__.pyi +0 -12
- bl_operators/add_mesh_torus/__init__.pyi +0 -2
- bl_operators/anim/__init__.pyi +0 -26
- bl_operators/assets/__init__.pyi +0 -6
- bl_operators/bone_selection_sets/__init__.pyi +0 -28
- bl_operators/clip/__init__.pyi +0 -20
- bl_operators/connect_to_output/__init__.pyi +0 -2
- bl_operators/console/__init__.pyi +0 -10
- bl_operators/constraint/__init__.pyi +0 -8
- bl_operators/copy_global_transform/__init__.pyi +0 -10
- bl_operators/file/__init__.pyi +0 -6
- bl_operators/freestyle/__init__.pyi +0 -8
- bl_operators/geometry_nodes/__init__.pyi +0 -8
- bl_operators/grease_pencil/__init__.pyi +0 -2
- bl_operators/image/__init__.pyi +0 -10
- bl_operators/image_as_planes/__init__.pyi +0 -4
- bl_operators/mesh/__init__.pyi +0 -4
- bl_operators/node/__init__.pyi +0 -44
- bl_operators/object/__init__.pyi +0 -30
- bl_operators/object_align/__init__.pyi +0 -2
- bl_operators/object_quick_effects/__init__.pyi +0 -8
- bl_operators/object_randomize_transform/__init__.pyi +0 -2
- bl_operators/presets/__init__.pyi +0 -50
- bl_operators/rigidbody/__init__.pyi +0 -6
- bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
- bl_operators/sequencer/__init__.pyi +0 -16
- bl_operators/spreadsheet/__init__.pyi +0 -2
- bl_operators/userpref/__init__.pyi +0 -50
- bl_operators/uvcalc_follow_active/__init__.pyi +0 -2
- bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
- bl_operators/uvcalc_transform/__init__.pyi +0 -4
- bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
- bl_operators/view3d/__init__.pyi +0 -16
- bl_operators/wm/__init__.pyi +0 -92
- bl_operators/world/__init__.pyi +0 -2
- bl_ui/__init__.pyi +0 -4
- bl_ui/anim/__init__.pyi +0 -2
- bl_ui/asset_shelf/__init__.pyi +0 -2
- bl_ui/generic_ui_list/__init__.pyi +1 -17
- bl_ui/node_add_menu/__init__.pyi +0 -10
- bl_ui/node_add_menu_compositor/__init__.pyi +0 -38
- bl_ui/node_add_menu_geometry/__init__.pyi +0 -112
- bl_ui/node_add_menu_shader/__init__.pyi +0 -20
- bl_ui/node_add_menu_texture/__init__.pyi +0 -16
- bl_ui/properties_collection/__init__.pyi +0 -14
- bl_ui/properties_constraint/__init__.pyi +0 -154
- bl_ui/properties_data_armature/__init__.pyi +0 -36
- bl_ui/properties_data_bone/__init__.pyi +0 -20
- bl_ui/properties_data_camera/__init__.pyi +0 -30
- bl_ui/properties_data_curve/__init__.pyi +0 -30
- bl_ui/properties_data_curves/__init__.pyi +0 -16
- bl_ui/properties_data_empty/__init__.pyi +0 -4
- bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
- bl_ui/properties_data_lattice/__init__.pyi +0 -8
- bl_ui/properties_data_light/__init__.pyi +0 -20
- bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
- bl_ui/properties_data_mesh/__init__.pyi +0 -42
- bl_ui/properties_data_metaball/__init__.pyi +0 -12
- bl_ui/properties_data_modifier/__init__.pyi +0 -18
- bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
- bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
- bl_ui/properties_data_speaker/__init__.pyi +0 -12
- bl_ui/properties_data_volume/__init__.pyi +0 -18
- bl_ui/properties_freestyle/__init__.pyi +0 -50
- bl_ui/properties_grease_pencil_common/__init__.pyi +0 -14
- bl_ui/properties_mask_common/__init__.pyi +0 -14
- bl_ui/properties_material/__init__.pyi +0 -32
- bl_ui/properties_material_gpencil/__init__.pyi +0 -22
- bl_ui/properties_object/__init__.pyi +0 -44
- bl_ui/properties_output/__init__.pyi +0 -40
- bl_ui/properties_paint_common/__init__.pyi +0 -4
- bl_ui/properties_particle/__init__.pyi +0 -106
- bl_ui/properties_physics_cloth/__init__.pyi +0 -28
- bl_ui/properties_physics_common/__init__.pyi +0 -2
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
- bl_ui/properties_physics_field/__init__.pyi +0 -20
- bl_ui/properties_physics_fluid/__init__.pyi +0 -56
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
- bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
- bl_ui/properties_physics_softbody/__init__.pyi +0 -30
- bl_ui/properties_render/__init__.pyi +0 -90
- bl_ui/properties_scene/__init__.pyi +0 -34
- bl_ui/properties_strip/__init__.pyi +0 -42
- bl_ui/properties_strip_modifier/__init__.pyi +0 -2
- bl_ui/properties_texture/__init__.pyi +0 -54
- bl_ui/properties_view_layer/__init__.pyi +0 -28
- bl_ui/properties_workspace/__init__.pyi +0 -8
- bl_ui/properties_world/__init__.pyi +0 -22
- bl_ui/space_clip/__init__.pyi +0 -150
- bl_ui/space_console/__init__.pyi +0 -12
- bl_ui/space_dopesheet/__init__.pyi +0 -64
- bl_ui/space_filebrowser/__init__.pyi +0 -60
- bl_ui/space_graph/__init__.pyi +0 -44
- bl_ui/space_image/__init__.pyi +0 -142
- bl_ui/space_info/__init__.pyi +0 -12
- bl_ui/space_nla/__init__.pyi +0 -36
- bl_ui/space_node/__init__.pyi +0 -66
- bl_ui/space_outliner/__init__.pyi +0 -30
- bl_ui/space_properties/__init__.pyi +0 -8
- bl_ui/space_sequencer/__init__.pyi +0 -136
- bl_ui/space_spreadsheet/__init__.pyi +0 -6
- bl_ui/space_statusbar/__init__.pyi +0 -2
- bl_ui/space_text/__init__.pyi +0 -32
- bl_ui/space_time/__init__.pyi +0 -12
- bl_ui/space_topbar/__init__.pyi +0 -52
- bl_ui/space_userpref/__init__.pyi +0 -186
- bl_ui/space_view3d/__init__.pyi +0 -536
- bl_ui/space_view3d_sidebar/__init__.pyi +0 -8
- bl_ui/space_view3d_toolbar/__init__.pyi +0 -162
- blf/__init__.pyi +0 -47
- bmesh/__init__.pyi +0 -7
- bmesh/geometry/__init__.pyi +0 -3
- bmesh/ops/__init__.pyi +0 -451
- bmesh/types/__init__.pyi +65 -427
- bmesh/utils/__init__.pyi +0 -44
- bpy/app/__init__.pyi +0 -5
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +0 -6
- bpy/app/translations/__init__.pyi +0 -15
- bpy/msgbus/__init__.pyi +1 -4
- bpy/ops/action/__init__.pyi +15 -165
- bpy/ops/anim/__init__.pyi +27 -274
- bpy/ops/armature/__init__.pyi +17 -191
- bpy/ops/asset/__init__.pyi +11 -97
- bpy/ops/boid/__init__.pyi +7 -38
- bpy/ops/brush/__init__.pyi +3 -72
- bpy/ops/buttons/__init__.pyi +4 -71
- bpy/ops/cachefile/__init__.pyi +2 -63
- bpy/ops/camera/__init__.pyi +0 -11
- bpy/ops/clip/__init__.pyi +43 -427
- bpy/ops/cloth/__init__.pyi +0 -5
- bpy/ops/collection/__init__.pyi +2 -34
- bpy/ops/console/__init__.pyi +10 -88
- bpy/ops/constraint/__init__.pyi +3 -80
- bpy/ops/curve/__init__.pyi +23 -254
- bpy/ops/curves/__init__.pyi +15 -164
- bpy/ops/cycles/__init__.pyi +1 -14
- bpy/ops/dpaint/__init__.pyi +3 -21
- bpy/ops/ed/__init__.pyi +10 -82
- bpy/ops/export_anim/__init__.pyi +0 -11
- bpy/ops/export_scene/__init__.pyi +0 -154
- bpy/ops/extensions/__init__.pyi +15 -150
- bpy/ops/file/__init__.pyi +27 -217
- bpy/ops/fluid/__init__.pyi +13 -70
- bpy/ops/font/__init__.pyi +10 -134
- bpy/ops/geometry/__init__.pyi +3 -41
- bpy/ops/gizmogroup/__init__.pyi +1 -12
- bpy/ops/gpencil/__init__.pyi +5 -38
- bpy/ops/graph/__init__.pyi +18 -316
- bpy/ops/grease_pencil/__init__.pyi +27 -522
- bpy/ops/image/__init__.pyi +19 -379
- bpy/ops/import_anim/__init__.pyi +0 -14
- bpy/ops/import_curve/__init__.pyi +0 -6
- bpy/ops/import_scene/__init__.pyi +0 -50
- bpy/ops/info/__init__.pyi +4 -35
- bpy/ops/lattice/__init__.pyi +3 -33
- bpy/ops/marker/__init__.pyi +2 -50
- bpy/ops/mask/__init__.pyi +17 -176
- bpy/ops/material/__init__.pyi +3 -15
- bpy/ops/mball/__init__.pyi +1 -30
- bpy/ops/mesh/__init__.pyi +30 -913
- bpy/ops/nla/__init__.pyi +19 -183
- bpy/ops/node/__init__.pyi +53 -745
- bpy/ops/object/__init__.pyi +75 -1285
- bpy/ops/outliner/__init__.pyi +47 -327
- bpy/ops/paint/__init__.pyi +14 -279
- bpy/ops/paintcurve/__init__.pyi +4 -36
- bpy/ops/palette/__init__.pyi +3 -27
- bpy/ops/particle/__init__.pyi +20 -160
- bpy/ops/pointcloud/__init__.pyi +3 -35
- bpy/ops/pose/__init__.pyi +25 -230
- bpy/ops/poselib/__init__.pyi +4 -47
- bpy/ops/preferences/__init__.pyi +9 -177
- bpy/ops/ptcache/__init__.pyi +5 -31
- bpy/ops/render/__init__.pyi +3 -70
- bpy/ops/rigidbody/__init__.pyi +6 -56
- bpy/ops/scene/__init__.pyi +22 -167
- bpy/ops/screen/__init__.pyi +19 -214
- bpy/ops/script/__init__.pyi +1 -12
- bpy/ops/sculpt/__init__.pyi +7 -271
- bpy/ops/sculpt_curves/__init__.pyi +1 -20
- bpy/ops/sequencer/__init__.pyi +36 -672
- bpy/ops/sound/__init__.pyi +3 -109
- bpy/ops/spreadsheet/__init__.pyi +5 -32
- bpy/ops/surface/__init__.pyi +0 -48
- bpy/ops/text/__init__.pyi +25 -226
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +3 -18
- bpy/ops/transform/__init__.pyi +2 -381
- bpy/ops/ui/__init__.pyi +21 -158
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +9 -316
- bpy/ops/view2d/__init__.pyi +3 -73
- bpy/ops/view3d/__init__.pyi +37 -339
- bpy/ops/wm/__init__.pyi +25 -1308
- bpy/ops/workspace/__init__.pyi +7 -39
- bpy/ops/world/__init__.pyi +2 -10
- bpy/path/__init__.pyi +0 -34
- bpy/props/__init__.pyi +12 -148
- bpy/types/__init__.pyi +9867 -55713
- bpy/utils/__init__.pyi +2 -73
- bpy/utils/previews/__init__.pyi +0 -9
- bpy/utils/units/__init__.pyi +0 -12
- bpy_extras/anim_utils/__init__.pyi +0 -8
- bpy_extras/bmesh_utils/__init__.pyi +0 -1
- bpy_extras/id_map_utils/__init__.pyi +4 -5
- bpy_extras/image_utils/__init__.pyi +0 -9
- bpy_extras/io_utils/__init__.pyi +2 -22
- bpy_extras/mesh_utils/__init__.pyi +0 -12
- bpy_extras/object_utils/__init__.pyi +0 -14
- bpy_extras/view3d_utils/__init__.pyi +0 -18
- {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/METADATA +2 -1
- fake_bpy_module_latest-20260114.dist-info/RECORD +382 -0
- freestyle/chainingiterators/__init__.pyi +0 -22
- freestyle/functions/__init__.pyi +0 -139
- freestyle/predicates/__init__.pyi +0 -51
- freestyle/shaders/__init__.pyi +0 -65
- freestyle/types/__init__.pyi +139 -777
- freestyle/utils/ContextFunctions/__init__.pyi +0 -23
- freestyle/utils/__init__.pyi +0 -6
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +0 -9
- gpu/platform/__init__.pyi +0 -5
- gpu/shader/__init__.pyi +0 -5
- gpu/state/__init__.pyi +0 -29
- gpu/texture/__init__.pyi +0 -2
- gpu/types/__init__.pyi +10 -149
- gpu_extras/batch/__init__.pyi +0 -4
- gpu_extras/presets/__init__.pyi +0 -9
- idprop/types/__init__.pyi +0 -4
- imbuf/__init__.pyi +0 -7
- imbuf/types/__init__.pyi +5 -25
- keyingsets_builtins/__init__.pyi +0 -44
- mathutils/__init__.pyi +46 -2160
- mathutils/bvhtree/__init__.pyi +1 -24
- mathutils/geometry/__init__.pyi +0 -129
- mathutils/interpolate/__init__.pyi +0 -3
- mathutils/kdtree/__init__.pyi +0 -11
- mathutils/noise/__init__.pyi +0 -62
- fake_bpy_module_latest-20260113.dist-info/RECORD +0 -382
- {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/WHEEL +0 -0
- {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/top_level.txt +0 -0
bpy/ops/wm/__init__.pyi
CHANGED
|
@@ -71,46 +71,25 @@ def alembic_export(
|
|
|
71
71
|
) -> None:
|
|
72
72
|
"""Export current scene in an Alembic archive
|
|
73
73
|
|
|
74
|
-
:type execution_context: int | str | None
|
|
75
|
-
:type undo: bool | None
|
|
76
74
|
:param filepath: File Path, Path to file
|
|
77
|
-
:type filepath: str
|
|
78
75
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
79
|
-
:type check_existing: bool | None
|
|
80
76
|
:param filter_blender: Filter .blend files
|
|
81
|
-
:type filter_blender: bool | None
|
|
82
77
|
:param filter_backup: Filter .blend files
|
|
83
|
-
:type filter_backup: bool | None
|
|
84
78
|
:param filter_image: Filter image files
|
|
85
|
-
:type filter_image: bool | None
|
|
86
79
|
:param filter_movie: Filter movie files
|
|
87
|
-
:type filter_movie: bool | None
|
|
88
80
|
:param filter_python: Filter Python files
|
|
89
|
-
:type filter_python: bool | None
|
|
90
81
|
:param filter_font: Filter font files
|
|
91
|
-
:type filter_font: bool | None
|
|
92
82
|
:param filter_sound: Filter sound files
|
|
93
|
-
:type filter_sound: bool | None
|
|
94
83
|
:param filter_text: Filter text files
|
|
95
|
-
:type filter_text: bool | None
|
|
96
84
|
:param filter_archive: Filter archive files
|
|
97
|
-
:type filter_archive: bool | None
|
|
98
85
|
:param filter_btx: Filter btx files
|
|
99
|
-
:type filter_btx: bool | None
|
|
100
86
|
:param filter_alembic: Filter Alembic files
|
|
101
|
-
:type filter_alembic: bool | None
|
|
102
87
|
:param filter_usd: Filter USD files
|
|
103
|
-
:type filter_usd: bool | None
|
|
104
88
|
:param filter_obj: Filter OBJ files
|
|
105
|
-
:type filter_obj: bool | None
|
|
106
89
|
:param filter_volume: Filter OpenVDB volume files
|
|
107
|
-
:type filter_volume: bool | None
|
|
108
90
|
:param filter_folder: Filter folders
|
|
109
|
-
:type filter_folder: bool | None
|
|
110
91
|
:param filter_blenlib: Filter Blender IDs
|
|
111
|
-
:type filter_blenlib: bool | None
|
|
112
92
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
113
|
-
:type filemode: int | None
|
|
114
93
|
:param display_type: Display Type
|
|
115
94
|
|
|
116
95
|
DEFAULT
|
|
@@ -124,64 +103,34 @@ def alembic_export(
|
|
|
124
103
|
|
|
125
104
|
THUMBNAIL
|
|
126
105
|
Thumbnails -- Display files as thumbnails.
|
|
127
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
128
106
|
:param sort_method: File sorting mode
|
|
129
|
-
:type sort_method: str | None
|
|
130
|
-
:type filter_glob: str
|
|
131
107
|
:param start: Start Frame, Start frame of the export, use the default value to take the start frame of the current scene
|
|
132
|
-
:type start: int | None
|
|
133
108
|
:param end: End Frame, End frame of the export, use the default value to take the end frame of the current scene
|
|
134
|
-
:type end: int | None
|
|
135
109
|
:param xsamples: Transform Samples, Number of times per frame transformations are sampled
|
|
136
|
-
:type xsamples: int | None
|
|
137
110
|
:param gsamples: Geometry Samples, Number of times per frame object data are sampled
|
|
138
|
-
:type gsamples: int | None
|
|
139
111
|
:param sh_open: Shutter Open, Time at which the shutter is open
|
|
140
|
-
:type sh_open: float | None
|
|
141
112
|
:param sh_close: Shutter Close, Time at which the shutter is closed
|
|
142
|
-
:type sh_close: float | None
|
|
143
113
|
:param selected: Selected Objects Only, Export only selected objects
|
|
144
|
-
:type selected: bool | None
|
|
145
114
|
:param flatten: Flatten Hierarchy, Do not preserve objects parent/children relationship
|
|
146
|
-
:type flatten: bool | None
|
|
147
115
|
:param collection: Collection
|
|
148
|
-
:type collection: str
|
|
149
116
|
:param uvs: UV Coordinates, Export UV coordinates
|
|
150
|
-
:type uvs: bool | None
|
|
151
117
|
:param packuv: Merge UVs
|
|
152
|
-
:type packuv: bool | None
|
|
153
118
|
:param normals: Normals, Export normals
|
|
154
|
-
:type normals: bool | None
|
|
155
119
|
:param vcolors: Color Attributes, Export color attributes
|
|
156
|
-
:type vcolors: bool | None
|
|
157
120
|
:param orcos: Generated Coordinates, Export undeformed mesh vertex coordinates
|
|
158
|
-
:type orcos: bool | None
|
|
159
121
|
:param face_sets: Face Sets, Export per face shading group assignments
|
|
160
|
-
:type face_sets: bool | None
|
|
161
122
|
:param subdiv_schema: Use Subdivision Schema, Export meshes using Alembics subdivision schema
|
|
162
|
-
:type subdiv_schema: bool | None
|
|
163
123
|
:param apply_subdiv: Apply Subdivision Surface, Export subdivision surfaces as meshes
|
|
164
|
-
:type apply_subdiv: bool | None
|
|
165
124
|
:param curves_as_mesh: Curves as Mesh, Export curves and NURBS surfaces as meshes
|
|
166
|
-
:type curves_as_mesh: bool | None
|
|
167
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
|
|
168
|
-
:type use_instancing: bool | None
|
|
169
126
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
170
|
-
:type global_scale: float | None
|
|
171
127
|
:param triangulate: Triangulate, Export polygons (quads and n-gons) as triangles
|
|
172
|
-
:type triangulate: bool | None
|
|
173
128
|
:param quad_method: Quad Method, Method for splitting the quads into triangles
|
|
174
|
-
:type quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems | None
|
|
175
129
|
:param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
|
|
176
|
-
:type ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems | None
|
|
177
130
|
:param export_hair: Export Hair, Exports hair particle systems as animated curves
|
|
178
|
-
:type export_hair: bool | None
|
|
179
131
|
:param export_particles: Export Particles, Exports non-hair particle systems
|
|
180
|
-
:type export_particles: bool | None
|
|
181
132
|
:param export_custom_properties: Export Custom Properties, Export custom properties to Alembic .userProperties
|
|
182
|
-
:type export_custom_properties: bool | None
|
|
183
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
|
|
184
|
-
:type as_background_job: bool | None
|
|
185
134
|
:param evaluation_mode: Settings, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering
|
|
186
135
|
|
|
187
136
|
RENDER
|
|
@@ -189,8 +138,6 @@ def alembic_export(
|
|
|
189
138
|
|
|
190
139
|
VIEWPORT
|
|
191
140
|
Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
|
|
192
|
-
:type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
|
|
193
|
-
:type init_scene_frame_range: bool | None
|
|
194
141
|
"""
|
|
195
142
|
|
|
196
143
|
def alembic_import(
|
|
@@ -236,52 +183,28 @@ def alembic_import(
|
|
|
236
183
|
) -> None:
|
|
237
184
|
"""Load an Alembic archive
|
|
238
185
|
|
|
239
|
-
:type execution_context: int | str | None
|
|
240
|
-
:type undo: bool | None
|
|
241
186
|
:param filepath: File Path, Path to file
|
|
242
|
-
:type filepath: str
|
|
243
187
|
:param directory: Directory, Directory of the file
|
|
244
|
-
:type directory: str
|
|
245
188
|
:param files: Files
|
|
246
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
247
189
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
248
|
-
:type check_existing: bool | None
|
|
249
190
|
:param filter_blender: Filter .blend files
|
|
250
|
-
:type filter_blender: bool | None
|
|
251
191
|
:param filter_backup: Filter .blend files
|
|
252
|
-
:type filter_backup: bool | None
|
|
253
192
|
:param filter_image: Filter image files
|
|
254
|
-
:type filter_image: bool | None
|
|
255
193
|
:param filter_movie: Filter movie files
|
|
256
|
-
:type filter_movie: bool | None
|
|
257
194
|
:param filter_python: Filter Python files
|
|
258
|
-
:type filter_python: bool | None
|
|
259
195
|
:param filter_font: Filter font files
|
|
260
|
-
:type filter_font: bool | None
|
|
261
196
|
:param filter_sound: Filter sound files
|
|
262
|
-
:type filter_sound: bool | None
|
|
263
197
|
:param filter_text: Filter text files
|
|
264
|
-
:type filter_text: bool | None
|
|
265
198
|
:param filter_archive: Filter archive files
|
|
266
|
-
:type filter_archive: bool | None
|
|
267
199
|
:param filter_btx: Filter btx files
|
|
268
|
-
:type filter_btx: bool | None
|
|
269
200
|
:param filter_alembic: Filter Alembic files
|
|
270
|
-
:type filter_alembic: bool | None
|
|
271
201
|
:param filter_usd: Filter USD files
|
|
272
|
-
:type filter_usd: bool | None
|
|
273
202
|
:param filter_obj: Filter OBJ files
|
|
274
|
-
:type filter_obj: bool | None
|
|
275
203
|
:param filter_volume: Filter OpenVDB volume files
|
|
276
|
-
:type filter_volume: bool | None
|
|
277
204
|
:param filter_folder: Filter folders
|
|
278
|
-
:type filter_folder: bool | None
|
|
279
205
|
:param filter_blenlib: Filter Blender IDs
|
|
280
|
-
:type filter_blenlib: bool | None
|
|
281
206
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
282
|
-
:type filemode: int | None
|
|
283
207
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
284
|
-
:type relative_path: bool | None
|
|
285
208
|
:param display_type: Display Type
|
|
286
209
|
|
|
287
210
|
DEFAULT
|
|
@@ -295,22 +218,13 @@ def alembic_import(
|
|
|
295
218
|
|
|
296
219
|
THUMBNAIL
|
|
297
220
|
Thumbnails -- Display files as thumbnails.
|
|
298
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
299
221
|
:param sort_method: File sorting mode
|
|
300
|
-
:type sort_method: str | None
|
|
301
|
-
:type filter_glob: str
|
|
302
222
|
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
303
|
-
:type scale: float | None
|
|
304
223
|
:param set_frame_range: Set Frame Range, If checked, update scenes start and end frame to match those of the Alembic archive
|
|
305
|
-
:type set_frame_range: bool | None
|
|
306
224
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
307
|
-
:type validate_meshes: bool | None
|
|
308
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
|
|
309
|
-
:type always_add_cache_reader: bool | None
|
|
310
226
|
:param is_sequence: Is Sequence, Set to true if the cache is split into separate files
|
|
311
|
-
:type is_sequence: bool | None
|
|
312
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
|
|
313
|
-
:type as_background_job: bool | None
|
|
314
228
|
"""
|
|
315
229
|
|
|
316
230
|
def append(
|
|
@@ -358,52 +272,28 @@ def append(
|
|
|
358
272
|
) -> None:
|
|
359
273
|
"""Append from a Library .blend file
|
|
360
274
|
|
|
361
|
-
:type execution_context: int | str | None
|
|
362
|
-
:type undo: bool | None
|
|
363
275
|
:param filepath: File Path, Path to file
|
|
364
|
-
:type filepath: str
|
|
365
276
|
:param directory: Directory, Directory of the file
|
|
366
|
-
:type directory: str
|
|
367
277
|
:param filename: File Name, Name of the file
|
|
368
|
-
:type filename: str
|
|
369
278
|
:param files: Files
|
|
370
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
371
279
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
372
|
-
:type check_existing: bool | None
|
|
373
280
|
:param filter_blender: Filter .blend files
|
|
374
|
-
:type filter_blender: bool | None
|
|
375
281
|
:param filter_backup: Filter .blend files
|
|
376
|
-
:type filter_backup: bool | None
|
|
377
282
|
:param filter_image: Filter image files
|
|
378
|
-
:type filter_image: bool | None
|
|
379
283
|
:param filter_movie: Filter movie files
|
|
380
|
-
:type filter_movie: bool | None
|
|
381
284
|
:param filter_python: Filter Python files
|
|
382
|
-
:type filter_python: bool | None
|
|
383
285
|
:param filter_font: Filter font files
|
|
384
|
-
:type filter_font: bool | None
|
|
385
286
|
:param filter_sound: Filter sound files
|
|
386
|
-
:type filter_sound: bool | None
|
|
387
287
|
:param filter_text: Filter text files
|
|
388
|
-
:type filter_text: bool | None
|
|
389
288
|
:param filter_archive: Filter archive files
|
|
390
|
-
:type filter_archive: bool | None
|
|
391
289
|
:param filter_btx: Filter btx files
|
|
392
|
-
:type filter_btx: bool | None
|
|
393
290
|
:param filter_alembic: Filter Alembic files
|
|
394
|
-
:type filter_alembic: bool | None
|
|
395
291
|
:param filter_usd: Filter USD files
|
|
396
|
-
:type filter_usd: bool | None
|
|
397
292
|
:param filter_obj: Filter OBJ files
|
|
398
|
-
:type filter_obj: bool | None
|
|
399
293
|
:param filter_volume: Filter OpenVDB volume files
|
|
400
|
-
:type filter_volume: bool | None
|
|
401
294
|
:param filter_folder: Filter folders
|
|
402
|
-
:type filter_folder: bool | None
|
|
403
295
|
:param filter_blenlib: Filter Blender IDs
|
|
404
|
-
:type filter_blenlib: bool | None
|
|
405
296
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
406
|
-
:type filemode: int | None
|
|
407
297
|
:param display_type: Display Type
|
|
408
298
|
|
|
409
299
|
DEFAULT
|
|
@@ -417,27 +307,16 @@ def append(
|
|
|
417
307
|
|
|
418
308
|
THUMBNAIL
|
|
419
309
|
Thumbnails -- Display files as thumbnails.
|
|
420
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
421
310
|
:param sort_method: File sorting mode
|
|
422
|
-
:type sort_method: str | None
|
|
423
311
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
424
|
-
:type link: bool | None
|
|
425
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
|
|
426
|
-
:type do_reuse_local_id: bool | None
|
|
427
313
|
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
428
|
-
:type clear_asset_data: bool | None
|
|
429
314
|
:param autoselect: Select, Select new objects
|
|
430
|
-
:type autoselect: bool | None
|
|
431
315
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
432
|
-
:type active_collection: bool | None
|
|
433
316
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
434
|
-
:type instance_collections: bool | None
|
|
435
317
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
436
|
-
:type instance_object_data: bool | None
|
|
437
318
|
:param set_fake: Fake User, Set "Fake User" for appended items (except objects and collections)
|
|
438
|
-
:type set_fake: bool | None
|
|
439
319
|
:param use_recursive: Localize All, Localize all appended data, including those indirectly linked from other libraries
|
|
440
|
-
:type use_recursive: bool | None
|
|
441
320
|
"""
|
|
442
321
|
|
|
443
322
|
def batch_rename(
|
|
@@ -474,14 +353,9 @@ def batch_rename(
|
|
|
474
353
|
) -> None:
|
|
475
354
|
"""Rename multiple items at once
|
|
476
355
|
|
|
477
|
-
:type execution_context: int | str | None
|
|
478
|
-
:type undo: bool | None
|
|
479
356
|
:param data_type: Type, Type of data to rename
|
|
480
|
-
:type data_type: typing.Literal['OBJECT','COLLECTION','MATERIAL','MESH','CURVE','META','VOLUME','GREASEPENCIL','ARMATURE','LATTICE','LIGHT','LIGHT_PROBE','CAMERA','SPEAKER','BONE','NODE','SEQUENCE_STRIP','ACTION_CLIP','SCENE','BRUSH'] | None
|
|
481
357
|
:param data_source: Source
|
|
482
|
-
:type data_source: typing.Literal['SELECT','ALL'] | None
|
|
483
358
|
:param actions: actions
|
|
484
|
-
:type actions: bpy.types.bpy_prop_collection[bl_operators.wm.BatchRenameAction] | None
|
|
485
359
|
"""
|
|
486
360
|
|
|
487
361
|
def blend_strings_utf8_validate(
|
|
@@ -489,11 +363,7 @@ def blend_strings_utf8_validate(
|
|
|
489
363
|
undo: bool | None = None,
|
|
490
364
|
/,
|
|
491
365
|
) -> None:
|
|
492
|
-
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)
|
|
493
|
-
|
|
494
|
-
:type execution_context: int | str | None
|
|
495
|
-
:type undo: bool | None
|
|
496
|
-
"""
|
|
366
|
+
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)"""
|
|
497
367
|
|
|
498
368
|
def call_asset_shelf_popover(
|
|
499
369
|
execution_context: int | str | None = None,
|
|
@@ -504,10 +374,7 @@ def call_asset_shelf_popover(
|
|
|
504
374
|
) -> None:
|
|
505
375
|
"""Open a predefined asset shelf in a popup
|
|
506
376
|
|
|
507
|
-
:type execution_context: int | str | None
|
|
508
|
-
:type undo: bool | None
|
|
509
377
|
:param name: Asset Shelf Name, Identifier of the asset shelf to display
|
|
510
|
-
:type name: str
|
|
511
378
|
"""
|
|
512
379
|
|
|
513
380
|
def call_menu(
|
|
@@ -519,10 +386,7 @@ def call_menu(
|
|
|
519
386
|
) -> None:
|
|
520
387
|
"""Open a predefined menu
|
|
521
388
|
|
|
522
|
-
:type execution_context: int | str | None
|
|
523
|
-
:type undo: bool | None
|
|
524
389
|
:param name: Name, Name of the menu
|
|
525
|
-
:type name: str
|
|
526
390
|
"""
|
|
527
391
|
|
|
528
392
|
def call_menu_pie(
|
|
@@ -534,10 +398,7 @@ def call_menu_pie(
|
|
|
534
398
|
) -> None:
|
|
535
399
|
"""Open a predefined pie menu
|
|
536
400
|
|
|
537
|
-
:type execution_context: int | str | None
|
|
538
|
-
:type undo: bool | None
|
|
539
401
|
:param name: Name, Name of the pie menu
|
|
540
|
-
:type name: str
|
|
541
402
|
"""
|
|
542
403
|
|
|
543
404
|
def call_panel(
|
|
@@ -550,12 +411,8 @@ def call_panel(
|
|
|
550
411
|
) -> None:
|
|
551
412
|
"""Open a predefined panel
|
|
552
413
|
|
|
553
|
-
:type execution_context: int | str | None
|
|
554
|
-
:type undo: bool | None
|
|
555
414
|
:param name: Name, Name of the menu
|
|
556
|
-
:type name: str
|
|
557
415
|
:param keep_open: Keep Open
|
|
558
|
-
:type keep_open: bool | None
|
|
559
416
|
"""
|
|
560
417
|
|
|
561
418
|
def clear_recent_files(
|
|
@@ -567,10 +424,7 @@ def clear_recent_files(
|
|
|
567
424
|
) -> None:
|
|
568
425
|
"""Clear the recent files list
|
|
569
426
|
|
|
570
|
-
:type execution_context: int | str | None
|
|
571
|
-
:type undo: bool | None
|
|
572
427
|
:param remove: Remove
|
|
573
|
-
:type remove: typing.Literal['ALL','MISSING'] | None
|
|
574
428
|
"""
|
|
575
429
|
|
|
576
430
|
def collection_export_all(
|
|
@@ -578,11 +432,7 @@ def collection_export_all(
|
|
|
578
432
|
undo: bool | None = None,
|
|
579
433
|
/,
|
|
580
434
|
) -> None:
|
|
581
|
-
"""Invoke all configured exporters for all collections
|
|
582
|
-
|
|
583
|
-
:type execution_context: int | str | None
|
|
584
|
-
:type undo: bool | None
|
|
585
|
-
"""
|
|
435
|
+
"""Invoke all configured exporters for all collections"""
|
|
586
436
|
|
|
587
437
|
def context_collection_boolean_set(
|
|
588
438
|
execution_context: int | str | None = None,
|
|
@@ -595,14 +445,9 @@ def context_collection_boolean_set(
|
|
|
595
445
|
) -> None:
|
|
596
446
|
"""Set boolean values for a collection of items
|
|
597
447
|
|
|
598
|
-
:type execution_context: int | str | None
|
|
599
|
-
:type undo: bool | None
|
|
600
448
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
601
|
-
:type data_path_iter: str
|
|
602
449
|
:param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
|
|
603
|
-
:type data_path_item: str
|
|
604
450
|
:param type: Type
|
|
605
|
-
:type type: typing.Literal['TOGGLE','ENABLE','DISABLE'] | None
|
|
606
451
|
"""
|
|
607
452
|
|
|
608
453
|
def context_cycle_array(
|
|
@@ -615,12 +460,8 @@ def context_cycle_array(
|
|
|
615
460
|
) -> None:
|
|
616
461
|
"""Set a context array value (useful for cycling the active mesh edit mode)
|
|
617
462
|
|
|
618
|
-
:type execution_context: int | str | None
|
|
619
|
-
:type undo: bool | None
|
|
620
463
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
621
|
-
:type data_path: str
|
|
622
464
|
:param reverse: Reverse, Cycle backwards
|
|
623
|
-
:type reverse: bool | None
|
|
624
465
|
"""
|
|
625
466
|
|
|
626
467
|
def context_cycle_enum(
|
|
@@ -634,14 +475,9 @@ def context_cycle_enum(
|
|
|
634
475
|
) -> None:
|
|
635
476
|
"""Toggle a context value
|
|
636
477
|
|
|
637
|
-
:type execution_context: int | str | None
|
|
638
|
-
:type undo: bool | None
|
|
639
478
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
640
|
-
:type data_path: str
|
|
641
479
|
:param reverse: Reverse, Cycle backwards
|
|
642
|
-
:type reverse: bool | None
|
|
643
480
|
:param wrap: Wrap, Wrap back to the first/last values
|
|
644
|
-
:type wrap: bool | None
|
|
645
481
|
"""
|
|
646
482
|
|
|
647
483
|
def context_cycle_int(
|
|
@@ -655,14 +491,9 @@ def context_cycle_int(
|
|
|
655
491
|
) -> None:
|
|
656
492
|
"""Set a context value (useful for cycling active material, shape keys, groups, etc.)
|
|
657
493
|
|
|
658
|
-
:type execution_context: int | str | None
|
|
659
|
-
:type undo: bool | None
|
|
660
494
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
661
|
-
:type data_path: str
|
|
662
495
|
:param reverse: Reverse, Cycle backwards
|
|
663
|
-
:type reverse: bool | None
|
|
664
496
|
:param wrap: Wrap, Wrap back to the first/last values
|
|
665
|
-
:type wrap: bool | None
|
|
666
497
|
"""
|
|
667
498
|
|
|
668
499
|
def context_menu_enum(
|
|
@@ -674,10 +505,7 @@ def context_menu_enum(
|
|
|
674
505
|
) -> None:
|
|
675
506
|
"""Undocumented, consider contributing.
|
|
676
507
|
|
|
677
|
-
:type execution_context: int | str | None
|
|
678
|
-
:type undo: bool | None
|
|
679
508
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
680
|
-
:type data_path: str
|
|
681
509
|
"""
|
|
682
510
|
|
|
683
511
|
def context_modal_mouse(
|
|
@@ -694,20 +522,12 @@ def context_modal_mouse(
|
|
|
694
522
|
) -> None:
|
|
695
523
|
"""Adjust arbitrary values with mouse input
|
|
696
524
|
|
|
697
|
-
:type execution_context: int | str | None
|
|
698
|
-
:type undo: bool | None
|
|
699
525
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
700
|
-
:type data_path_iter: str
|
|
701
526
|
:param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
|
|
702
|
-
:type data_path_item: str
|
|
703
527
|
:param header_text: Header Text, Text to display in header during scale
|
|
704
|
-
:type header_text: str
|
|
705
528
|
:param input_scale: input_scale, Scale the mouse movement by this value before applying the delta
|
|
706
|
-
:type input_scale: float | None
|
|
707
529
|
:param invert: invert, Invert the mouse input
|
|
708
|
-
:type invert: bool | None
|
|
709
530
|
:param initial_x: initial_x
|
|
710
|
-
:type initial_x: int | None
|
|
711
531
|
"""
|
|
712
532
|
|
|
713
533
|
def context_pie_enum(
|
|
@@ -719,10 +539,7 @@ def context_pie_enum(
|
|
|
719
539
|
) -> None:
|
|
720
540
|
"""Undocumented, consider contributing.
|
|
721
541
|
|
|
722
|
-
:type execution_context: int | str | None
|
|
723
|
-
:type undo: bool | None
|
|
724
542
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
725
|
-
:type data_path: str
|
|
726
543
|
"""
|
|
727
544
|
|
|
728
545
|
def context_scale_float(
|
|
@@ -735,12 +552,8 @@ def context_scale_float(
|
|
|
735
552
|
) -> None:
|
|
736
553
|
"""Scale a float context value
|
|
737
554
|
|
|
738
|
-
:type execution_context: int | str | None
|
|
739
|
-
:type undo: bool | None
|
|
740
555
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
741
|
-
:type data_path: str
|
|
742
556
|
:param value: Value, Assign value
|
|
743
|
-
:type value: float | None
|
|
744
557
|
"""
|
|
745
558
|
|
|
746
559
|
def context_scale_int(
|
|
@@ -754,14 +567,9 @@ def context_scale_int(
|
|
|
754
567
|
) -> None:
|
|
755
568
|
"""Scale an int context value
|
|
756
569
|
|
|
757
|
-
:type execution_context: int | str | None
|
|
758
|
-
:type undo: bool | None
|
|
759
570
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
760
|
-
:type data_path: str
|
|
761
571
|
:param value: Value, Assign value
|
|
762
|
-
:type value: float | None
|
|
763
572
|
:param always_step: Always Step, Always adjust the value by a minimum of 1 when value is not 1.0
|
|
764
|
-
:type always_step: bool | None
|
|
765
573
|
"""
|
|
766
574
|
|
|
767
575
|
def context_set_boolean(
|
|
@@ -774,12 +582,8 @@ def context_set_boolean(
|
|
|
774
582
|
) -> None:
|
|
775
583
|
"""Set a context value
|
|
776
584
|
|
|
777
|
-
:type execution_context: int | str | None
|
|
778
|
-
:type undo: bool | None
|
|
779
585
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
780
|
-
:type data_path: str
|
|
781
586
|
:param value: Value, Assignment value
|
|
782
|
-
:type value: bool | None
|
|
783
587
|
"""
|
|
784
588
|
|
|
785
589
|
def context_set_enum(
|
|
@@ -792,12 +596,8 @@ def context_set_enum(
|
|
|
792
596
|
) -> None:
|
|
793
597
|
"""Set a context value
|
|
794
598
|
|
|
795
|
-
:type execution_context: int | str | None
|
|
796
|
-
:type undo: bool | None
|
|
797
599
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
798
|
-
:type data_path: str
|
|
799
600
|
:param value: Value, Assignment value (as a string)
|
|
800
|
-
:type value: str
|
|
801
601
|
"""
|
|
802
602
|
|
|
803
603
|
def context_set_float(
|
|
@@ -811,14 +611,9 @@ def context_set_float(
|
|
|
811
611
|
) -> None:
|
|
812
612
|
"""Set a context value
|
|
813
613
|
|
|
814
|
-
:type execution_context: int | str | None
|
|
815
|
-
:type undo: bool | None
|
|
816
614
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
817
|
-
:type data_path: str
|
|
818
615
|
:param value: Value, Assignment value
|
|
819
|
-
:type value: float | None
|
|
820
616
|
:param relative: Relative, Apply relative to the current value (delta)
|
|
821
|
-
:type relative: bool | None
|
|
822
617
|
"""
|
|
823
618
|
|
|
824
619
|
def context_set_id(
|
|
@@ -831,12 +626,8 @@ def context_set_id(
|
|
|
831
626
|
) -> None:
|
|
832
627
|
"""Set a context value to an ID data-block
|
|
833
628
|
|
|
834
|
-
:type execution_context: int | str | None
|
|
835
|
-
:type undo: bool | None
|
|
836
629
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
837
|
-
:type data_path: str
|
|
838
630
|
:param value: Value, Assign value
|
|
839
|
-
:type value: str
|
|
840
631
|
"""
|
|
841
632
|
|
|
842
633
|
def context_set_int(
|
|
@@ -850,14 +641,9 @@ def context_set_int(
|
|
|
850
641
|
) -> None:
|
|
851
642
|
"""Set a context value
|
|
852
643
|
|
|
853
|
-
:type execution_context: int | str | None
|
|
854
|
-
:type undo: bool | None
|
|
855
644
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
856
|
-
:type data_path: str
|
|
857
645
|
:param value: Value, Assign value
|
|
858
|
-
:type value: int | None
|
|
859
646
|
:param relative: Relative, Apply relative to the current value (delta)
|
|
860
|
-
:type relative: bool | None
|
|
861
647
|
"""
|
|
862
648
|
|
|
863
649
|
def context_set_string(
|
|
@@ -870,12 +656,8 @@ def context_set_string(
|
|
|
870
656
|
) -> None:
|
|
871
657
|
"""Set a context value
|
|
872
658
|
|
|
873
|
-
:type execution_context: int | str | None
|
|
874
|
-
:type undo: bool | None
|
|
875
659
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
876
|
-
:type data_path: str
|
|
877
660
|
:param value: Value, Assign value
|
|
878
|
-
:type value: str
|
|
879
661
|
"""
|
|
880
662
|
|
|
881
663
|
def context_set_value(
|
|
@@ -888,12 +670,8 @@ def context_set_value(
|
|
|
888
670
|
) -> None:
|
|
889
671
|
"""Set a context value
|
|
890
672
|
|
|
891
|
-
:type execution_context: int | str | None
|
|
892
|
-
:type undo: bool | None
|
|
893
673
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
894
|
-
:type data_path: str
|
|
895
674
|
:param value: Value, Assignment value (as a string)
|
|
896
|
-
:type value: str
|
|
897
675
|
"""
|
|
898
676
|
|
|
899
677
|
def context_toggle(
|
|
@@ -906,12 +684,8 @@ def context_toggle(
|
|
|
906
684
|
) -> None:
|
|
907
685
|
"""Toggle a context value
|
|
908
686
|
|
|
909
|
-
:type execution_context: int | str | None
|
|
910
|
-
:type undo: bool | None
|
|
911
687
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
912
|
-
:type data_path: str
|
|
913
688
|
:param module: Module, Optionally override the context with a module
|
|
914
|
-
:type module: str
|
|
915
689
|
"""
|
|
916
690
|
|
|
917
691
|
def context_toggle_enum(
|
|
@@ -925,14 +699,9 @@ def context_toggle_enum(
|
|
|
925
699
|
) -> None:
|
|
926
700
|
"""Toggle a context value
|
|
927
701
|
|
|
928
|
-
:type execution_context: int | str | None
|
|
929
|
-
:type undo: bool | None
|
|
930
702
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
931
|
-
:type data_path: str
|
|
932
703
|
:param value_1: Value, Toggle enum
|
|
933
|
-
:type value_1: str
|
|
934
704
|
:param value_2: Value, Toggle enum
|
|
935
|
-
:type value_2: str
|
|
936
705
|
"""
|
|
937
706
|
|
|
938
707
|
def debug_menu(
|
|
@@ -944,10 +713,7 @@ def debug_menu(
|
|
|
944
713
|
) -> None:
|
|
945
714
|
"""Open a popup to set the debug level
|
|
946
715
|
|
|
947
|
-
:type execution_context: int | str | None
|
|
948
|
-
:type undo: bool | None
|
|
949
716
|
:param debug_value: Debug Value
|
|
950
|
-
:type debug_value: int | None
|
|
951
717
|
"""
|
|
952
718
|
|
|
953
719
|
def doc_view(
|
|
@@ -959,10 +725,7 @@ def doc_view(
|
|
|
959
725
|
) -> None:
|
|
960
726
|
"""Open online reference docs in a web browser
|
|
961
727
|
|
|
962
|
-
:type execution_context: int | str | None
|
|
963
|
-
:type undo: bool | None
|
|
964
728
|
:param doc_id: Doc ID
|
|
965
|
-
:type doc_id: str
|
|
966
729
|
"""
|
|
967
730
|
|
|
968
731
|
def doc_view_manual(
|
|
@@ -974,10 +737,7 @@ def doc_view_manual(
|
|
|
974
737
|
) -> None:
|
|
975
738
|
"""Load online manual
|
|
976
739
|
|
|
977
|
-
:type execution_context: int | str | None
|
|
978
|
-
:type undo: bool | None
|
|
979
740
|
:param doc_id: Doc ID
|
|
980
|
-
:type doc_id: str
|
|
981
741
|
"""
|
|
982
742
|
|
|
983
743
|
def doc_view_manual_ui_context(
|
|
@@ -985,11 +745,7 @@ def doc_view_manual_ui_context(
|
|
|
985
745
|
undo: bool | None = None,
|
|
986
746
|
/,
|
|
987
747
|
) -> None:
|
|
988
|
-
"""View a context based online manual in a web browser
|
|
989
|
-
|
|
990
|
-
:type execution_context: int | str | None
|
|
991
|
-
:type undo: bool | None
|
|
992
|
-
"""
|
|
748
|
+
"""View a context based online manual in a web browser"""
|
|
993
749
|
|
|
994
750
|
def drop_blend_file(
|
|
995
751
|
execution_context: int | str | None = None,
|
|
@@ -1000,10 +756,7 @@ def drop_blend_file(
|
|
|
1000
756
|
) -> None:
|
|
1001
757
|
"""Undocumented, consider contributing.
|
|
1002
758
|
|
|
1003
|
-
:type execution_context: int | str | None
|
|
1004
|
-
:type undo: bool | None
|
|
1005
759
|
:param filepath: filepath
|
|
1006
|
-
:type filepath: str
|
|
1007
760
|
"""
|
|
1008
761
|
|
|
1009
762
|
def drop_import_file(
|
|
@@ -1017,12 +770,8 @@ def drop_import_file(
|
|
|
1017
770
|
) -> None:
|
|
1018
771
|
"""Operator that allows file handlers to receive file drops
|
|
1019
772
|
|
|
1020
|
-
:type execution_context: int | str | None
|
|
1021
|
-
:type undo: bool | None
|
|
1022
773
|
:param directory: Directory, Directory of the file
|
|
1023
|
-
:type directory: str
|
|
1024
774
|
:param files: Files
|
|
1025
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1026
775
|
"""
|
|
1027
776
|
|
|
1028
777
|
def fbx_import(
|
|
@@ -1073,50 +822,27 @@ def fbx_import(
|
|
|
1073
822
|
) -> None:
|
|
1074
823
|
"""Import FBX file into current scene
|
|
1075
824
|
|
|
1076
|
-
:type execution_context: int | str | None
|
|
1077
|
-
:type undo: bool | None
|
|
1078
825
|
:param filepath: File Path, Path to file
|
|
1079
|
-
:type filepath: str
|
|
1080
826
|
:param directory: Directory, Directory of the file
|
|
1081
|
-
:type directory: str
|
|
1082
827
|
:param files: Files
|
|
1083
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1084
828
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1085
|
-
:type check_existing: bool | None
|
|
1086
829
|
:param filter_blender: Filter .blend files
|
|
1087
|
-
:type filter_blender: bool | None
|
|
1088
830
|
:param filter_backup: Filter .blend files
|
|
1089
|
-
:type filter_backup: bool | None
|
|
1090
831
|
:param filter_image: Filter image files
|
|
1091
|
-
:type filter_image: bool | None
|
|
1092
832
|
:param filter_movie: Filter movie files
|
|
1093
|
-
:type filter_movie: bool | None
|
|
1094
833
|
:param filter_python: Filter Python files
|
|
1095
|
-
:type filter_python: bool | None
|
|
1096
834
|
:param filter_font: Filter font files
|
|
1097
|
-
:type filter_font: bool | None
|
|
1098
835
|
:param filter_sound: Filter sound files
|
|
1099
|
-
:type filter_sound: bool | None
|
|
1100
836
|
:param filter_text: Filter text files
|
|
1101
|
-
:type filter_text: bool | None
|
|
1102
837
|
:param filter_archive: Filter archive files
|
|
1103
|
-
:type filter_archive: bool | None
|
|
1104
838
|
:param filter_btx: Filter btx files
|
|
1105
|
-
:type filter_btx: bool | None
|
|
1106
839
|
:param filter_alembic: Filter Alembic files
|
|
1107
|
-
:type filter_alembic: bool | None
|
|
1108
840
|
:param filter_usd: Filter USD files
|
|
1109
|
-
:type filter_usd: bool | None
|
|
1110
841
|
:param filter_obj: Filter OBJ files
|
|
1111
|
-
:type filter_obj: bool | None
|
|
1112
842
|
:param filter_volume: Filter OpenVDB volume files
|
|
1113
|
-
:type filter_volume: bool | None
|
|
1114
843
|
:param filter_folder: Filter folders
|
|
1115
|
-
:type filter_folder: bool | None
|
|
1116
844
|
:param filter_blenlib: Filter Blender IDs
|
|
1117
|
-
:type filter_blenlib: bool | None
|
|
1118
845
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1119
|
-
:type filemode: int | None
|
|
1120
846
|
:param display_type: Display Type
|
|
1121
847
|
|
|
1122
848
|
DEFAULT
|
|
@@ -1130,11 +856,8 @@ def fbx_import(
|
|
|
1130
856
|
|
|
1131
857
|
THUMBNAIL
|
|
1132
858
|
Thumbnails -- Display files as thumbnails.
|
|
1133
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1134
859
|
:param sort_method: File sorting mode
|
|
1135
|
-
:type sort_method: str | None
|
|
1136
860
|
:param global_scale: Scale
|
|
1137
|
-
:type global_scale: float | None
|
|
1138
861
|
:param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
|
|
1139
862
|
|
|
1140
863
|
MAKE_UNIQUE
|
|
@@ -1142,7 +865,6 @@ def fbx_import(
|
|
|
1142
865
|
|
|
1143
866
|
REFERENCE_EXISTING
|
|
1144
867
|
Reference Existing -- If a material with the same name already exists, reference that instead of importing.
|
|
1145
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
1146
868
|
:param import_colors: Vertex Colors, Import vertex color attributes
|
|
1147
869
|
|
|
1148
870
|
NONE
|
|
@@ -1153,25 +875,15 @@ def fbx_import(
|
|
|
1153
875
|
|
|
1154
876
|
LINEAR
|
|
1155
877
|
Linear -- Vertex colors in the file are in linear color space.
|
|
1156
|
-
:type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
1157
878
|
:param use_custom_normals: Custom Normals, Import custom normals, if available (otherwise Blender will compute them)
|
|
1158
|
-
:type use_custom_normals: bool | None
|
|
1159
879
|
:param use_custom_props: Custom Properties, Import user properties as custom properties
|
|
1160
|
-
:type use_custom_props: bool | None
|
|
1161
880
|
:param use_custom_props_enum_as_string: Enums As Strings, Store custom property enumeration values as strings
|
|
1162
|
-
:type use_custom_props_enum_as_string: bool | None
|
|
1163
881
|
:param import_subdivision: Subdivision Data, Import FBX subdivision information as subdivision surface modifiers
|
|
1164
|
-
:type import_subdivision: bool | None
|
|
1165
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)
|
|
1166
|
-
:type ignore_leaf_bones: bool | None
|
|
1167
883
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
1168
|
-
:type validate_meshes: bool | None
|
|
1169
884
|
:param use_anim: Import Animation, Import FBX animation
|
|
1170
|
-
:type use_anim: bool | None
|
|
1171
885
|
:param anim_offset: Offset, Offset to apply to animation timestamps, in frames
|
|
1172
|
-
:type anim_offset: float | None
|
|
1173
886
|
:param filter_glob: Extension Filter
|
|
1174
|
-
:type filter_glob: str
|
|
1175
887
|
"""
|
|
1176
888
|
|
|
1177
889
|
def grease_pencil_export_pdf(
|
|
@@ -1212,46 +924,25 @@ def grease_pencil_export_pdf(
|
|
|
1212
924
|
) -> None:
|
|
1213
925
|
"""Export Grease Pencil to PDF
|
|
1214
926
|
|
|
1215
|
-
:type execution_context: int | str | None
|
|
1216
|
-
:type undo: bool | None
|
|
1217
927
|
:param filepath: File Path, Path to file
|
|
1218
|
-
:type filepath: str
|
|
1219
928
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1220
|
-
:type check_existing: bool | None
|
|
1221
929
|
:param filter_blender: Filter .blend files
|
|
1222
|
-
:type filter_blender: bool | None
|
|
1223
930
|
:param filter_backup: Filter .blend files
|
|
1224
|
-
:type filter_backup: bool | None
|
|
1225
931
|
:param filter_image: Filter image files
|
|
1226
|
-
:type filter_image: bool | None
|
|
1227
932
|
:param filter_movie: Filter movie files
|
|
1228
|
-
:type filter_movie: bool | None
|
|
1229
933
|
:param filter_python: Filter Python files
|
|
1230
|
-
:type filter_python: bool | None
|
|
1231
934
|
:param filter_font: Filter font files
|
|
1232
|
-
:type filter_font: bool | None
|
|
1233
935
|
:param filter_sound: Filter sound files
|
|
1234
|
-
:type filter_sound: bool | None
|
|
1235
936
|
:param filter_text: Filter text files
|
|
1236
|
-
:type filter_text: bool | None
|
|
1237
937
|
:param filter_archive: Filter archive files
|
|
1238
|
-
:type filter_archive: bool | None
|
|
1239
938
|
:param filter_btx: Filter btx files
|
|
1240
|
-
:type filter_btx: bool | None
|
|
1241
939
|
:param filter_alembic: Filter Alembic files
|
|
1242
|
-
:type filter_alembic: bool | None
|
|
1243
940
|
:param filter_usd: Filter USD files
|
|
1244
|
-
:type filter_usd: bool | None
|
|
1245
941
|
:param filter_obj: Filter OBJ files
|
|
1246
|
-
:type filter_obj: bool | None
|
|
1247
942
|
:param filter_volume: Filter OpenVDB volume files
|
|
1248
|
-
:type filter_volume: bool | None
|
|
1249
943
|
:param filter_folder: Filter folders
|
|
1250
|
-
:type filter_folder: bool | None
|
|
1251
944
|
:param filter_blenlib: Filter Blender IDs
|
|
1252
|
-
:type filter_blenlib: bool | None
|
|
1253
945
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1254
|
-
:type filemode: int | None
|
|
1255
946
|
:param display_type: Display Type
|
|
1256
947
|
|
|
1257
948
|
DEFAULT
|
|
@@ -1265,11 +956,8 @@ def grease_pencil_export_pdf(
|
|
|
1265
956
|
|
|
1266
957
|
THUMBNAIL
|
|
1267
958
|
Thumbnails -- Display files as thumbnails.
|
|
1268
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1269
959
|
:param sort_method: File sorting mode
|
|
1270
|
-
:type sort_method: str | None
|
|
1271
960
|
:param use_fill: Fill, Export strokes with fill enabled
|
|
1272
|
-
:type use_fill: bool | None
|
|
1273
961
|
:param selected_object_type: Object, Which objects to include in the export
|
|
1274
962
|
|
|
1275
963
|
ACTIVE
|
|
@@ -1280,7 +968,6 @@ def grease_pencil_export_pdf(
|
|
|
1280
968
|
|
|
1281
969
|
VISIBLE
|
|
1282
970
|
Visible -- Include all visible objects.
|
|
1283
|
-
:type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
|
|
1284
971
|
:param frame_mode: Frames, Which frames to include in the export
|
|
1285
972
|
|
|
1286
973
|
ACTIVE
|
|
@@ -1291,11 +978,8 @@ def grease_pencil_export_pdf(
|
|
|
1291
978
|
|
|
1292
979
|
SCENE
|
|
1293
980
|
Scene -- Include all scene frames.
|
|
1294
|
-
:type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
|
|
1295
981
|
:param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
|
|
1296
|
-
:type stroke_sample: float | None
|
|
1297
982
|
:param use_uniform_width: Uniform Width, Export strokes with uniform width
|
|
1298
|
-
:type use_uniform_width: bool | None
|
|
1299
983
|
"""
|
|
1300
984
|
|
|
1301
985
|
def grease_pencil_export_svg(
|
|
@@ -1337,46 +1021,25 @@ def grease_pencil_export_svg(
|
|
|
1337
1021
|
) -> None:
|
|
1338
1022
|
"""Export Grease Pencil to SVG
|
|
1339
1023
|
|
|
1340
|
-
:type execution_context: int | str | None
|
|
1341
|
-
:type undo: bool | None
|
|
1342
1024
|
:param filepath: File Path, Path to file
|
|
1343
|
-
:type filepath: str
|
|
1344
1025
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1345
|
-
:type check_existing: bool | None
|
|
1346
1026
|
:param filter_blender: Filter .blend files
|
|
1347
|
-
:type filter_blender: bool | None
|
|
1348
1027
|
:param filter_backup: Filter .blend files
|
|
1349
|
-
:type filter_backup: bool | None
|
|
1350
1028
|
:param filter_image: Filter image files
|
|
1351
|
-
:type filter_image: bool | None
|
|
1352
1029
|
:param filter_movie: Filter movie files
|
|
1353
|
-
:type filter_movie: bool | None
|
|
1354
1030
|
:param filter_python: Filter Python files
|
|
1355
|
-
:type filter_python: bool | None
|
|
1356
1031
|
:param filter_font: Filter font files
|
|
1357
|
-
:type filter_font: bool | None
|
|
1358
1032
|
:param filter_sound: Filter sound files
|
|
1359
|
-
:type filter_sound: bool | None
|
|
1360
1033
|
:param filter_text: Filter text files
|
|
1361
|
-
:type filter_text: bool | None
|
|
1362
1034
|
:param filter_archive: Filter archive files
|
|
1363
|
-
:type filter_archive: bool | None
|
|
1364
1035
|
:param filter_btx: Filter btx files
|
|
1365
|
-
:type filter_btx: bool | None
|
|
1366
1036
|
:param filter_alembic: Filter Alembic files
|
|
1367
|
-
:type filter_alembic: bool | None
|
|
1368
1037
|
:param filter_usd: Filter USD files
|
|
1369
|
-
:type filter_usd: bool | None
|
|
1370
1038
|
:param filter_obj: Filter OBJ files
|
|
1371
|
-
:type filter_obj: bool | None
|
|
1372
1039
|
:param filter_volume: Filter OpenVDB volume files
|
|
1373
|
-
:type filter_volume: bool | None
|
|
1374
1040
|
:param filter_folder: Filter folders
|
|
1375
|
-
:type filter_folder: bool | None
|
|
1376
1041
|
:param filter_blenlib: Filter Blender IDs
|
|
1377
|
-
:type filter_blenlib: bool | None
|
|
1378
1042
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1379
|
-
:type filemode: int | None
|
|
1380
1043
|
:param display_type: Display Type
|
|
1381
1044
|
|
|
1382
1045
|
DEFAULT
|
|
@@ -1390,11 +1053,8 @@ def grease_pencil_export_svg(
|
|
|
1390
1053
|
|
|
1391
1054
|
THUMBNAIL
|
|
1392
1055
|
Thumbnails -- Display files as thumbnails.
|
|
1393
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1394
1056
|
:param sort_method: File sorting mode
|
|
1395
|
-
:type sort_method: str | None
|
|
1396
1057
|
:param use_fill: Fill, Export strokes with fill enabled
|
|
1397
|
-
:type use_fill: bool | None
|
|
1398
1058
|
:param selected_object_type: Object, Which objects to include in the export
|
|
1399
1059
|
|
|
1400
1060
|
ACTIVE
|
|
@@ -1405,7 +1065,6 @@ def grease_pencil_export_svg(
|
|
|
1405
1065
|
|
|
1406
1066
|
VISIBLE
|
|
1407
1067
|
Visible -- Include all visible objects.
|
|
1408
|
-
:type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
|
|
1409
1068
|
:param frame_mode: Frames, Which frames to include in the export
|
|
1410
1069
|
|
|
1411
1070
|
ACTIVE
|
|
@@ -1416,13 +1075,9 @@ def grease_pencil_export_svg(
|
|
|
1416
1075
|
|
|
1417
1076
|
SCENE
|
|
1418
1077
|
Scene -- Include all scene frames.
|
|
1419
|
-
:type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
|
|
1420
1078
|
:param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
|
|
1421
|
-
:type stroke_sample: float | None
|
|
1422
1079
|
:param use_uniform_width: Uniform Width, Export strokes with uniform width
|
|
1423
|
-
:type use_uniform_width: bool | None
|
|
1424
1080
|
:param use_clip_camera: Clip Camera, Clip drawings to camera size when exporting in camera view
|
|
1425
|
-
:type use_clip_camera: bool | None
|
|
1426
1081
|
"""
|
|
1427
1082
|
|
|
1428
1083
|
def grease_pencil_import_svg(
|
|
@@ -1464,52 +1119,28 @@ def grease_pencil_import_svg(
|
|
|
1464
1119
|
) -> None:
|
|
1465
1120
|
"""Import SVG into Grease Pencil
|
|
1466
1121
|
|
|
1467
|
-
:type execution_context: int | str | None
|
|
1468
|
-
:type undo: bool | None
|
|
1469
1122
|
:param filepath: File Path, Path to file
|
|
1470
|
-
:type filepath: str
|
|
1471
1123
|
:param directory: Directory, Directory of the file
|
|
1472
|
-
:type directory: str
|
|
1473
1124
|
:param files: Files
|
|
1474
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1475
1125
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1476
|
-
:type check_existing: bool | None
|
|
1477
1126
|
:param filter_blender: Filter .blend files
|
|
1478
|
-
:type filter_blender: bool | None
|
|
1479
1127
|
:param filter_backup: Filter .blend files
|
|
1480
|
-
:type filter_backup: bool | None
|
|
1481
1128
|
:param filter_image: Filter image files
|
|
1482
|
-
:type filter_image: bool | None
|
|
1483
1129
|
:param filter_movie: Filter movie files
|
|
1484
|
-
:type filter_movie: bool | None
|
|
1485
1130
|
:param filter_python: Filter Python files
|
|
1486
|
-
:type filter_python: bool | None
|
|
1487
1131
|
:param filter_font: Filter font files
|
|
1488
|
-
:type filter_font: bool | None
|
|
1489
1132
|
:param filter_sound: Filter sound files
|
|
1490
|
-
:type filter_sound: bool | None
|
|
1491
1133
|
:param filter_text: Filter text files
|
|
1492
|
-
:type filter_text: bool | None
|
|
1493
1134
|
:param filter_archive: Filter archive files
|
|
1494
|
-
:type filter_archive: bool | None
|
|
1495
1135
|
:param filter_btx: Filter btx files
|
|
1496
|
-
:type filter_btx: bool | None
|
|
1497
1136
|
:param filter_alembic: Filter Alembic files
|
|
1498
|
-
:type filter_alembic: bool | None
|
|
1499
1137
|
:param filter_usd: Filter USD files
|
|
1500
|
-
:type filter_usd: bool | None
|
|
1501
1138
|
:param filter_obj: Filter OBJ files
|
|
1502
|
-
:type filter_obj: bool | None
|
|
1503
1139
|
:param filter_volume: Filter OpenVDB volume files
|
|
1504
|
-
:type filter_volume: bool | None
|
|
1505
1140
|
:param filter_folder: Filter folders
|
|
1506
|
-
:type filter_folder: bool | None
|
|
1507
1141
|
:param filter_blenlib: Filter Blender IDs
|
|
1508
|
-
:type filter_blenlib: bool | None
|
|
1509
1142
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1510
|
-
:type filemode: int | None
|
|
1511
1143
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1512
|
-
:type relative_path: bool | None
|
|
1513
1144
|
:param display_type: Display Type
|
|
1514
1145
|
|
|
1515
1146
|
DEFAULT
|
|
@@ -1523,15 +1154,10 @@ def grease_pencil_import_svg(
|
|
|
1523
1154
|
|
|
1524
1155
|
THUMBNAIL
|
|
1525
1156
|
Thumbnails -- Display files as thumbnails.
|
|
1526
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1527
1157
|
:param sort_method: File sorting mode
|
|
1528
|
-
:type sort_method: str | None
|
|
1529
1158
|
:param resolution: Resolution, Resolution of the generated strokes
|
|
1530
|
-
:type resolution: int | None
|
|
1531
1159
|
:param scale: Scale, Scale of the final strokes
|
|
1532
|
-
:type scale: float | None
|
|
1533
1160
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
1534
|
-
:type use_scene_unit: bool | None
|
|
1535
1161
|
"""
|
|
1536
1162
|
|
|
1537
1163
|
def id_linked_relocate(
|
|
@@ -1577,54 +1203,29 @@ def id_linked_relocate(
|
|
|
1577
1203
|
) -> None:
|
|
1578
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
|
|
1579
1205
|
|
|
1580
|
-
:type execution_context: int | str | None
|
|
1581
|
-
:type undo: bool | None
|
|
1582
1206
|
:param id_session_uid: Linked ID Session UID, Unique runtime identifier for the linked ID to relocate
|
|
1583
|
-
:type id_session_uid: int | None
|
|
1584
1207
|
:param filepath: File Path, Path to file
|
|
1585
|
-
:type filepath: str
|
|
1586
1208
|
:param directory: Directory, Directory of the file
|
|
1587
|
-
:type directory: str
|
|
1588
1209
|
:param filename: File Name, Name of the file
|
|
1589
|
-
:type filename: str
|
|
1590
1210
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1591
|
-
:type check_existing: bool | None
|
|
1592
1211
|
:param filter_blender: Filter .blend files
|
|
1593
|
-
:type filter_blender: bool | None
|
|
1594
1212
|
:param filter_backup: Filter .blend files
|
|
1595
|
-
:type filter_backup: bool | None
|
|
1596
1213
|
:param filter_image: Filter image files
|
|
1597
|
-
:type filter_image: bool | None
|
|
1598
1214
|
:param filter_movie: Filter movie files
|
|
1599
|
-
:type filter_movie: bool | None
|
|
1600
1215
|
:param filter_python: Filter Python files
|
|
1601
|
-
:type filter_python: bool | None
|
|
1602
1216
|
:param filter_font: Filter font files
|
|
1603
|
-
:type filter_font: bool | None
|
|
1604
1217
|
:param filter_sound: Filter sound files
|
|
1605
|
-
:type filter_sound: bool | None
|
|
1606
1218
|
:param filter_text: Filter text files
|
|
1607
|
-
:type filter_text: bool | None
|
|
1608
1219
|
:param filter_archive: Filter archive files
|
|
1609
|
-
:type filter_archive: bool | None
|
|
1610
1220
|
:param filter_btx: Filter btx files
|
|
1611
|
-
:type filter_btx: bool | None
|
|
1612
1221
|
:param filter_alembic: Filter Alembic files
|
|
1613
|
-
:type filter_alembic: bool | None
|
|
1614
1222
|
:param filter_usd: Filter USD files
|
|
1615
|
-
:type filter_usd: bool | None
|
|
1616
1223
|
:param filter_obj: Filter OBJ files
|
|
1617
|
-
:type filter_obj: bool | None
|
|
1618
1224
|
:param filter_volume: Filter OpenVDB volume files
|
|
1619
|
-
:type filter_volume: bool | None
|
|
1620
1225
|
:param filter_folder: Filter folders
|
|
1621
|
-
:type filter_folder: bool | None
|
|
1622
1226
|
:param filter_blenlib: Filter Blender IDs
|
|
1623
|
-
:type filter_blenlib: bool | None
|
|
1624
1227
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1625
|
-
:type filemode: int | None
|
|
1626
1228
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1627
|
-
:type relative_path: bool | None
|
|
1628
1229
|
:param display_type: Display Type
|
|
1629
1230
|
|
|
1630
1231
|
DEFAULT
|
|
@@ -1638,23 +1239,14 @@ def id_linked_relocate(
|
|
|
1638
1239
|
|
|
1639
1240
|
THUMBNAIL
|
|
1640
1241
|
Thumbnails -- Display files as thumbnails.
|
|
1641
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1642
1242
|
:param sort_method: File sorting mode
|
|
1643
|
-
:type sort_method: str | None
|
|
1644
1243
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
1645
|
-
:type link: bool | None
|
|
1646
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
|
|
1647
|
-
:type do_reuse_local_id: bool | None
|
|
1648
1245
|
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
1649
|
-
:type clear_asset_data: bool | None
|
|
1650
1246
|
:param autoselect: Select, Select new objects
|
|
1651
|
-
:type autoselect: bool | None
|
|
1652
1247
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
1653
|
-
:type active_collection: bool | None
|
|
1654
1248
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
1655
|
-
:type instance_collections: bool | None
|
|
1656
1249
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
1657
|
-
:type instance_object_data: bool | None
|
|
1658
1250
|
"""
|
|
1659
1251
|
|
|
1660
1252
|
def interface_theme_preset_add(
|
|
@@ -1668,14 +1260,9 @@ def interface_theme_preset_add(
|
|
|
1668
1260
|
) -> None:
|
|
1669
1261
|
"""Add a custom theme to the preset list
|
|
1670
1262
|
|
|
1671
|
-
:type execution_context: int | str | None
|
|
1672
|
-
:type undo: bool | None
|
|
1673
1263
|
:param name: Name, Name of the preset, used to make the path name
|
|
1674
|
-
:type name: str
|
|
1675
1264
|
:param remove_name: remove_name
|
|
1676
|
-
:type remove_name: bool | None
|
|
1677
1265
|
:param remove_active: remove_active
|
|
1678
|
-
:type remove_active: bool | None
|
|
1679
1266
|
"""
|
|
1680
1267
|
|
|
1681
1268
|
def interface_theme_preset_remove(
|
|
@@ -1689,14 +1276,9 @@ def interface_theme_preset_remove(
|
|
|
1689
1276
|
) -> None:
|
|
1690
1277
|
"""Remove a custom theme from the preset list
|
|
1691
1278
|
|
|
1692
|
-
:type execution_context: int | str | None
|
|
1693
|
-
:type undo: bool | None
|
|
1694
1279
|
:param name: Name, Name of the preset, used to make the path name
|
|
1695
|
-
:type name: str
|
|
1696
1280
|
:param remove_name: remove_name
|
|
1697
|
-
:type remove_name: bool | None
|
|
1698
1281
|
:param remove_active: remove_active
|
|
1699
|
-
:type remove_active: bool | None
|
|
1700
1282
|
"""
|
|
1701
1283
|
|
|
1702
1284
|
def interface_theme_preset_save(
|
|
@@ -1710,14 +1292,9 @@ def interface_theme_preset_save(
|
|
|
1710
1292
|
) -> None:
|
|
1711
1293
|
"""Save a custom theme in the preset list
|
|
1712
1294
|
|
|
1713
|
-
:type execution_context: int | str | None
|
|
1714
|
-
:type undo: bool | None
|
|
1715
1295
|
:param name: Name, Name of the preset, used to make the path name
|
|
1716
|
-
:type name: str
|
|
1717
1296
|
:param remove_name: remove_name
|
|
1718
|
-
:type remove_name: bool | None
|
|
1719
1297
|
:param remove_active: remove_active
|
|
1720
|
-
:type remove_active: bool | None
|
|
1721
1298
|
"""
|
|
1722
1299
|
|
|
1723
1300
|
def keyconfig_preset_add(
|
|
@@ -1731,14 +1308,9 @@ def keyconfig_preset_add(
|
|
|
1731
1308
|
) -> None:
|
|
1732
1309
|
"""Add a custom keymap configuration to the preset list
|
|
1733
1310
|
|
|
1734
|
-
:type execution_context: int | str | None
|
|
1735
|
-
:type undo: bool | None
|
|
1736
1311
|
:param name: Name, Name of the preset, used to make the path name
|
|
1737
|
-
:type name: str
|
|
1738
1312
|
:param remove_name: remove_name
|
|
1739
|
-
:type remove_name: bool | None
|
|
1740
1313
|
:param remove_active: remove_active
|
|
1741
|
-
:type remove_active: bool | None
|
|
1742
1314
|
"""
|
|
1743
1315
|
|
|
1744
1316
|
def keyconfig_preset_remove(
|
|
@@ -1752,14 +1324,9 @@ def keyconfig_preset_remove(
|
|
|
1752
1324
|
) -> None:
|
|
1753
1325
|
"""Remove a custom keymap configuration from the preset list
|
|
1754
1326
|
|
|
1755
|
-
:type execution_context: int | str | None
|
|
1756
|
-
:type undo: bool | None
|
|
1757
1327
|
:param name: Name, Name of the preset, used to make the path name
|
|
1758
|
-
:type name: str
|
|
1759
1328
|
:param remove_name: remove_name
|
|
1760
|
-
:type remove_name: bool | None
|
|
1761
1329
|
:param remove_active: remove_active
|
|
1762
|
-
:type remove_active: bool | None
|
|
1763
1330
|
"""
|
|
1764
1331
|
|
|
1765
1332
|
def lib_reload(
|
|
@@ -1799,56 +1366,30 @@ def lib_reload(
|
|
|
1799
1366
|
) -> None:
|
|
1800
1367
|
"""Reload the given library
|
|
1801
1368
|
|
|
1802
|
-
:type execution_context: int | str | None
|
|
1803
|
-
:type undo: bool | None
|
|
1804
1369
|
:param library: Library, Library to reload
|
|
1805
|
-
:type library: str
|
|
1806
1370
|
:param filepath: File Path, Path to file
|
|
1807
|
-
:type filepath: str
|
|
1808
1371
|
:param directory: Directory, Directory of the file
|
|
1809
|
-
:type directory: str
|
|
1810
1372
|
:param filename: File Name, Name of the file
|
|
1811
|
-
:type filename: str
|
|
1812
1373
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1813
|
-
:type hide_props_region: bool | None
|
|
1814
1374
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1815
|
-
:type check_existing: bool | None
|
|
1816
1375
|
:param filter_blender: Filter .blend files
|
|
1817
|
-
:type filter_blender: bool | None
|
|
1818
1376
|
:param filter_backup: Filter .blend files
|
|
1819
|
-
:type filter_backup: bool | None
|
|
1820
1377
|
:param filter_image: Filter image files
|
|
1821
|
-
:type filter_image: bool | None
|
|
1822
1378
|
:param filter_movie: Filter movie files
|
|
1823
|
-
:type filter_movie: bool | None
|
|
1824
1379
|
:param filter_python: Filter Python files
|
|
1825
|
-
:type filter_python: bool | None
|
|
1826
1380
|
:param filter_font: Filter font files
|
|
1827
|
-
:type filter_font: bool | None
|
|
1828
1381
|
:param filter_sound: Filter sound files
|
|
1829
|
-
:type filter_sound: bool | None
|
|
1830
1382
|
:param filter_text: Filter text files
|
|
1831
|
-
:type filter_text: bool | None
|
|
1832
1383
|
:param filter_archive: Filter archive files
|
|
1833
|
-
:type filter_archive: bool | None
|
|
1834
1384
|
:param filter_btx: Filter btx files
|
|
1835
|
-
:type filter_btx: bool | None
|
|
1836
1385
|
:param filter_alembic: Filter Alembic files
|
|
1837
|
-
:type filter_alembic: bool | None
|
|
1838
1386
|
:param filter_usd: Filter USD files
|
|
1839
|
-
:type filter_usd: bool | None
|
|
1840
1387
|
:param filter_obj: Filter OBJ files
|
|
1841
|
-
:type filter_obj: bool | None
|
|
1842
1388
|
:param filter_volume: Filter OpenVDB volume files
|
|
1843
|
-
:type filter_volume: bool | None
|
|
1844
1389
|
:param filter_folder: Filter folders
|
|
1845
|
-
:type filter_folder: bool | None
|
|
1846
1390
|
:param filter_blenlib: Filter Blender IDs
|
|
1847
|
-
:type filter_blenlib: bool | None
|
|
1848
1391
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1849
|
-
:type filemode: int | None
|
|
1850
1392
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1851
|
-
:type relative_path: bool | None
|
|
1852
1393
|
:param display_type: Display Type
|
|
1853
1394
|
|
|
1854
1395
|
DEFAULT
|
|
@@ -1862,9 +1403,7 @@ def lib_reload(
|
|
|
1862
1403
|
|
|
1863
1404
|
THUMBNAIL
|
|
1864
1405
|
Thumbnails -- Display files as thumbnails.
|
|
1865
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1866
1406
|
:param sort_method: File sorting mode
|
|
1867
|
-
:type sort_method: str | None
|
|
1868
1407
|
"""
|
|
1869
1408
|
|
|
1870
1409
|
def lib_relocate(
|
|
@@ -1906,58 +1445,31 @@ def lib_relocate(
|
|
|
1906
1445
|
) -> None:
|
|
1907
1446
|
"""Relocate the given library to one or several others
|
|
1908
1447
|
|
|
1909
|
-
:type execution_context: int | str | None
|
|
1910
|
-
:type undo: bool | None
|
|
1911
1448
|
:param library: Library, Library to relocate
|
|
1912
|
-
:type library: str
|
|
1913
1449
|
:param filepath: File Path, Path to file
|
|
1914
|
-
:type filepath: str
|
|
1915
1450
|
:param directory: Directory, Directory of the file
|
|
1916
|
-
:type directory: str
|
|
1917
1451
|
:param filename: File Name, Name of the file
|
|
1918
|
-
:type filename: str
|
|
1919
1452
|
:param files: Files
|
|
1920
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
1921
1453
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
1922
|
-
:type hide_props_region: bool | None
|
|
1923
1454
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
1924
|
-
:type check_existing: bool | None
|
|
1925
1455
|
:param filter_blender: Filter .blend files
|
|
1926
|
-
:type filter_blender: bool | None
|
|
1927
1456
|
:param filter_backup: Filter .blend files
|
|
1928
|
-
:type filter_backup: bool | None
|
|
1929
1457
|
:param filter_image: Filter image files
|
|
1930
|
-
:type filter_image: bool | None
|
|
1931
1458
|
:param filter_movie: Filter movie files
|
|
1932
|
-
:type filter_movie: bool | None
|
|
1933
1459
|
:param filter_python: Filter Python files
|
|
1934
|
-
:type filter_python: bool | None
|
|
1935
1460
|
:param filter_font: Filter font files
|
|
1936
|
-
:type filter_font: bool | None
|
|
1937
1461
|
:param filter_sound: Filter sound files
|
|
1938
|
-
:type filter_sound: bool | None
|
|
1939
1462
|
:param filter_text: Filter text files
|
|
1940
|
-
:type filter_text: bool | None
|
|
1941
1463
|
:param filter_archive: Filter archive files
|
|
1942
|
-
:type filter_archive: bool | None
|
|
1943
1464
|
:param filter_btx: Filter btx files
|
|
1944
|
-
:type filter_btx: bool | None
|
|
1945
1465
|
:param filter_alembic: Filter Alembic files
|
|
1946
|
-
:type filter_alembic: bool | None
|
|
1947
1466
|
:param filter_usd: Filter USD files
|
|
1948
|
-
:type filter_usd: bool | None
|
|
1949
1467
|
:param filter_obj: Filter OBJ files
|
|
1950
|
-
:type filter_obj: bool | None
|
|
1951
1468
|
:param filter_volume: Filter OpenVDB volume files
|
|
1952
|
-
:type filter_volume: bool | None
|
|
1953
1469
|
:param filter_folder: Filter folders
|
|
1954
|
-
:type filter_folder: bool | None
|
|
1955
1470
|
:param filter_blenlib: Filter Blender IDs
|
|
1956
|
-
:type filter_blenlib: bool | None
|
|
1957
1471
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
1958
|
-
:type filemode: int | None
|
|
1959
1472
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
1960
|
-
:type relative_path: bool | None
|
|
1961
1473
|
:param display_type: Display Type
|
|
1962
1474
|
|
|
1963
1475
|
DEFAULT
|
|
@@ -1971,9 +1483,7 @@ def lib_relocate(
|
|
|
1971
1483
|
|
|
1972
1484
|
THUMBNAIL
|
|
1973
1485
|
Thumbnails -- Display files as thumbnails.
|
|
1974
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
1975
1486
|
:param sort_method: File sorting mode
|
|
1976
|
-
:type sort_method: str | None
|
|
1977
1487
|
"""
|
|
1978
1488
|
|
|
1979
1489
|
def link(
|
|
@@ -2020,54 +1530,29 @@ def link(
|
|
|
2020
1530
|
) -> None:
|
|
2021
1531
|
"""Link from a Library .blend file
|
|
2022
1532
|
|
|
2023
|
-
:type execution_context: int | str | None
|
|
2024
|
-
:type undo: bool | None
|
|
2025
1533
|
:param filepath: File Path, Path to file
|
|
2026
|
-
:type filepath: str
|
|
2027
1534
|
:param directory: Directory, Directory of the file
|
|
2028
|
-
:type directory: str
|
|
2029
1535
|
:param filename: File Name, Name of the file
|
|
2030
|
-
:type filename: str
|
|
2031
1536
|
:param files: Files
|
|
2032
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2033
1537
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2034
|
-
:type check_existing: bool | None
|
|
2035
1538
|
:param filter_blender: Filter .blend files
|
|
2036
|
-
:type filter_blender: bool | None
|
|
2037
1539
|
:param filter_backup: Filter .blend files
|
|
2038
|
-
:type filter_backup: bool | None
|
|
2039
1540
|
:param filter_image: Filter image files
|
|
2040
|
-
:type filter_image: bool | None
|
|
2041
1541
|
:param filter_movie: Filter movie files
|
|
2042
|
-
:type filter_movie: bool | None
|
|
2043
1542
|
:param filter_python: Filter Python files
|
|
2044
|
-
:type filter_python: bool | None
|
|
2045
1543
|
:param filter_font: Filter font files
|
|
2046
|
-
:type filter_font: bool | None
|
|
2047
1544
|
:param filter_sound: Filter sound files
|
|
2048
|
-
:type filter_sound: bool | None
|
|
2049
1545
|
:param filter_text: Filter text files
|
|
2050
|
-
:type filter_text: bool | None
|
|
2051
1546
|
:param filter_archive: Filter archive files
|
|
2052
|
-
:type filter_archive: bool | None
|
|
2053
1547
|
:param filter_btx: Filter btx files
|
|
2054
|
-
:type filter_btx: bool | None
|
|
2055
1548
|
:param filter_alembic: Filter Alembic files
|
|
2056
|
-
:type filter_alembic: bool | None
|
|
2057
1549
|
:param filter_usd: Filter USD files
|
|
2058
|
-
:type filter_usd: bool | None
|
|
2059
1550
|
:param filter_obj: Filter OBJ files
|
|
2060
|
-
:type filter_obj: bool | None
|
|
2061
1551
|
:param filter_volume: Filter OpenVDB volume files
|
|
2062
|
-
:type filter_volume: bool | None
|
|
2063
1552
|
:param filter_folder: Filter folders
|
|
2064
|
-
:type filter_folder: bool | None
|
|
2065
1553
|
:param filter_blenlib: Filter Blender IDs
|
|
2066
|
-
:type filter_blenlib: bool | None
|
|
2067
1554
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2068
|
-
:type filemode: int | None
|
|
2069
1555
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
2070
|
-
:type relative_path: bool | None
|
|
2071
1556
|
:param display_type: Display Type
|
|
2072
1557
|
|
|
2073
1558
|
DEFAULT
|
|
@@ -2081,23 +1566,14 @@ def link(
|
|
|
2081
1566
|
|
|
2082
1567
|
THUMBNAIL
|
|
2083
1568
|
Thumbnails -- Display files as thumbnails.
|
|
2084
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2085
1569
|
:param sort_method: File sorting mode
|
|
2086
|
-
:type sort_method: str | None
|
|
2087
1570
|
:param link: Link, Link the objects or data-blocks rather than appending
|
|
2088
|
-
:type link: bool | None
|
|
2089
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
|
|
2090
|
-
:type do_reuse_local_id: bool | None
|
|
2091
1572
|
:param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
|
|
2092
|
-
:type clear_asset_data: bool | None
|
|
2093
1573
|
:param autoselect: Select, Select new objects
|
|
2094
|
-
:type autoselect: bool | None
|
|
2095
1574
|
:param active_collection: Active Collection, Put new objects on the active collection
|
|
2096
|
-
:type active_collection: bool | None
|
|
2097
1575
|
:param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
|
|
2098
|
-
:type instance_collections: bool | None
|
|
2099
1576
|
:param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
|
|
2100
|
-
:type instance_object_data: bool | None
|
|
2101
1577
|
"""
|
|
2102
1578
|
|
|
2103
1579
|
def memory_statistics(
|
|
@@ -2105,11 +1581,7 @@ def memory_statistics(
|
|
|
2105
1581
|
undo: bool | None = None,
|
|
2106
1582
|
/,
|
|
2107
1583
|
) -> None:
|
|
2108
|
-
"""Print memory statistics to the console
|
|
2109
|
-
|
|
2110
|
-
:type execution_context: int | str | None
|
|
2111
|
-
:type undo: bool | None
|
|
2112
|
-
"""
|
|
1584
|
+
"""Print memory statistics to the console"""
|
|
2113
1585
|
|
|
2114
1586
|
def obj_export(
|
|
2115
1587
|
execution_context: int | str | None = None,
|
|
@@ -2174,46 +1646,25 @@ def obj_export(
|
|
|
2174
1646
|
) -> None:
|
|
2175
1647
|
"""Save the scene to a Wavefront OBJ file
|
|
2176
1648
|
|
|
2177
|
-
:type execution_context: int | str | None
|
|
2178
|
-
:type undo: bool | None
|
|
2179
1649
|
:param filepath: File Path, Path to file
|
|
2180
|
-
:type filepath: str
|
|
2181
1650
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2182
|
-
:type check_existing: bool | None
|
|
2183
1651
|
:param filter_blender: Filter .blend files
|
|
2184
|
-
:type filter_blender: bool | None
|
|
2185
1652
|
:param filter_backup: Filter .blend files
|
|
2186
|
-
:type filter_backup: bool | None
|
|
2187
1653
|
:param filter_image: Filter image files
|
|
2188
|
-
:type filter_image: bool | None
|
|
2189
1654
|
:param filter_movie: Filter movie files
|
|
2190
|
-
:type filter_movie: bool | None
|
|
2191
1655
|
:param filter_python: Filter Python files
|
|
2192
|
-
:type filter_python: bool | None
|
|
2193
1656
|
:param filter_font: Filter font files
|
|
2194
|
-
:type filter_font: bool | None
|
|
2195
1657
|
:param filter_sound: Filter sound files
|
|
2196
|
-
:type filter_sound: bool | None
|
|
2197
1658
|
:param filter_text: Filter text files
|
|
2198
|
-
:type filter_text: bool | None
|
|
2199
1659
|
:param filter_archive: Filter archive files
|
|
2200
|
-
:type filter_archive: bool | None
|
|
2201
1660
|
:param filter_btx: Filter btx files
|
|
2202
|
-
:type filter_btx: bool | None
|
|
2203
1661
|
:param filter_alembic: Filter Alembic files
|
|
2204
|
-
:type filter_alembic: bool | None
|
|
2205
1662
|
:param filter_usd: Filter USD files
|
|
2206
|
-
:type filter_usd: bool | None
|
|
2207
1663
|
:param filter_obj: Filter OBJ files
|
|
2208
|
-
:type filter_obj: bool | None
|
|
2209
1664
|
:param filter_volume: Filter OpenVDB volume files
|
|
2210
|
-
:type filter_volume: bool | None
|
|
2211
1665
|
:param filter_folder: Filter folders
|
|
2212
|
-
:type filter_folder: bool | None
|
|
2213
1666
|
:param filter_blenlib: Filter Blender IDs
|
|
2214
|
-
:type filter_blenlib: bool | None
|
|
2215
1667
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2216
|
-
:type filemode: int | None
|
|
2217
1668
|
:param display_type: Display Type
|
|
2218
1669
|
|
|
2219
1670
|
DEFAULT
|
|
@@ -2227,15 +1678,10 @@ def obj_export(
|
|
|
2227
1678
|
|
|
2228
1679
|
THUMBNAIL
|
|
2229
1680
|
Thumbnails -- Display files as thumbnails.
|
|
2230
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2231
1681
|
:param sort_method: File sorting mode
|
|
2232
|
-
:type sort_method: str | None
|
|
2233
1682
|
:param export_animation: Export Animation, Export multiple frames instead of the current frame only
|
|
2234
|
-
:type export_animation: bool | None
|
|
2235
1683
|
:param start_frame: Start Frame, The first frame to be exported
|
|
2236
|
-
:type start_frame: int | None
|
|
2237
1684
|
:param end_frame: End Frame, The last frame to be exported
|
|
2238
|
-
:type end_frame: int | None
|
|
2239
1685
|
:param forward_axis: Forward Axis
|
|
2240
1686
|
|
|
2241
1687
|
X
|
|
@@ -2255,7 +1701,6 @@ def obj_export(
|
|
|
2255
1701
|
|
|
2256
1702
|
NEGATIVE_Z
|
|
2257
1703
|
-Z -- Negative Z axis.
|
|
2258
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2259
1704
|
:param up_axis: Up Axis
|
|
2260
1705
|
|
|
2261
1706
|
X
|
|
@@ -2275,13 +1720,9 @@ def obj_export(
|
|
|
2275
1720
|
|
|
2276
1721
|
NEGATIVE_Z
|
|
2277
1722
|
-Z -- Negative Z axis.
|
|
2278
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2279
1723
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2280
|
-
:type global_scale: float | None
|
|
2281
1724
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
2282
|
-
:type apply_modifiers: bool | None
|
|
2283
1725
|
:param apply_transform: Apply Transform, Apply object transforms to exported vertices
|
|
2284
|
-
:type apply_transform: bool | None
|
|
2285
1726
|
:param export_eval_mode: Object Properties, Determines properties like object visibility, modifiers etc., where they differ for Render and Viewport
|
|
2286
1727
|
|
|
2287
1728
|
DAG_EVAL_RENDER
|
|
@@ -2289,19 +1730,12 @@ def obj_export(
|
|
|
2289
1730
|
|
|
2290
1731
|
DAG_EVAL_VIEWPORT
|
|
2291
1732
|
Viewport -- Export objects as they appear in the viewport.
|
|
2292
|
-
:type export_eval_mode: typing.Literal['DAG_EVAL_RENDER','DAG_EVAL_VIEWPORT'] | None
|
|
2293
1733
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
2294
|
-
:type export_selected_objects: bool | None
|
|
2295
1734
|
:param export_uv: Export UVs
|
|
2296
|
-
:type export_uv: bool | None
|
|
2297
1735
|
:param export_normals: Export Normals, Export per-face normals if the face is flat-shaded, per-face-corner normals if smooth-shaded
|
|
2298
|
-
:type export_normals: bool | None
|
|
2299
1736
|
:param export_colors: Export Colors, Export per-vertex colors
|
|
2300
|
-
:type export_colors: bool | None
|
|
2301
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
|
|
2302
|
-
:type export_materials: bool | None
|
|
2303
1738
|
:param export_pbr_extensions: Export Materials with PBR Extensions, Export MTL library using PBR extensions (roughness, metallic, sheen, coat, anisotropy, transmission)
|
|
2304
|
-
:type export_pbr_extensions: bool | None
|
|
2305
1739
|
:param path_mode: Path Mode, Method used to reference paths
|
|
2306
1740
|
|
|
2307
1741
|
AUTO
|
|
@@ -2321,25 +1755,15 @@ def obj_export(
|
|
|
2321
1755
|
|
|
2322
1756
|
COPY
|
|
2323
1757
|
Copy -- Copy the file to the destination path.
|
|
2324
|
-
:type path_mode: typing.Literal['AUTO','ABSOLUTE','RELATIVE','MATCH','STRIP','COPY'] | None
|
|
2325
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
|
|
2326
|
-
:type export_triangulated_mesh: bool | None
|
|
2327
1759
|
:param export_curves_as_nurbs: Export Curves as NURBS, Export curves in parametric form instead of exporting as mesh
|
|
2328
|
-
:type export_curves_as_nurbs: bool | None
|
|
2329
1760
|
:param export_object_groups: Export Object Groups, Append mesh name to object name, separated by a _
|
|
2330
|
-
:type export_object_groups: bool | None
|
|
2331
1761
|
:param export_material_groups: Export Material Groups, Generate an OBJ group for each part of a geometry using a different material
|
|
2332
|
-
:type export_material_groups: bool | None
|
|
2333
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
|
|
2334
|
-
:type export_vertex_groups: bool | None
|
|
2335
1763
|
:param export_smooth_groups: Export Smooth Groups, Generate smooth groups identifiers for each group of smooth faces, as unique integer values by default
|
|
2336
|
-
:type export_smooth_groups: bool | None
|
|
2337
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
|
|
2338
|
-
:type smooth_group_bitflags: bool | None
|
|
2339
1765
|
:param filter_glob: Extension Filter
|
|
2340
|
-
:type filter_glob: str
|
|
2341
1766
|
:param collection: Collection
|
|
2342
|
-
:type collection: str
|
|
2343
1767
|
"""
|
|
2344
1768
|
|
|
2345
1769
|
def obj_import(
|
|
@@ -2394,50 +1818,27 @@ def obj_import(
|
|
|
2394
1818
|
) -> None:
|
|
2395
1819
|
"""Load a Wavefront OBJ scene
|
|
2396
1820
|
|
|
2397
|
-
:type execution_context: int | str | None
|
|
2398
|
-
:type undo: bool | None
|
|
2399
1821
|
:param filepath: File Path, Path to file
|
|
2400
|
-
:type filepath: str
|
|
2401
1822
|
:param directory: Directory, Directory of the file
|
|
2402
|
-
:type directory: str
|
|
2403
1823
|
:param files: Files
|
|
2404
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2405
1824
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2406
|
-
:type check_existing: bool | None
|
|
2407
1825
|
:param filter_blender: Filter .blend files
|
|
2408
|
-
:type filter_blender: bool | None
|
|
2409
1826
|
:param filter_backup: Filter .blend files
|
|
2410
|
-
:type filter_backup: bool | None
|
|
2411
1827
|
:param filter_image: Filter image files
|
|
2412
|
-
:type filter_image: bool | None
|
|
2413
1828
|
:param filter_movie: Filter movie files
|
|
2414
|
-
:type filter_movie: bool | None
|
|
2415
1829
|
:param filter_python: Filter Python files
|
|
2416
|
-
:type filter_python: bool | None
|
|
2417
1830
|
:param filter_font: Filter font files
|
|
2418
|
-
:type filter_font: bool | None
|
|
2419
1831
|
:param filter_sound: Filter sound files
|
|
2420
|
-
:type filter_sound: bool | None
|
|
2421
1832
|
:param filter_text: Filter text files
|
|
2422
|
-
:type filter_text: bool | None
|
|
2423
1833
|
:param filter_archive: Filter archive files
|
|
2424
|
-
:type filter_archive: bool | None
|
|
2425
1834
|
:param filter_btx: Filter btx files
|
|
2426
|
-
:type filter_btx: bool | None
|
|
2427
1835
|
:param filter_alembic: Filter Alembic files
|
|
2428
|
-
:type filter_alembic: bool | None
|
|
2429
1836
|
:param filter_usd: Filter USD files
|
|
2430
|
-
:type filter_usd: bool | None
|
|
2431
1837
|
:param filter_obj: Filter OBJ files
|
|
2432
|
-
:type filter_obj: bool | None
|
|
2433
1838
|
:param filter_volume: Filter OpenVDB volume files
|
|
2434
|
-
:type filter_volume: bool | None
|
|
2435
1839
|
:param filter_folder: Filter folders
|
|
2436
|
-
:type filter_folder: bool | None
|
|
2437
1840
|
:param filter_blenlib: Filter Blender IDs
|
|
2438
|
-
:type filter_blenlib: bool | None
|
|
2439
1841
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2440
|
-
:type filemode: int | None
|
|
2441
1842
|
:param display_type: Display Type
|
|
2442
1843
|
|
|
2443
1844
|
DEFAULT
|
|
@@ -2451,13 +1852,9 @@ def obj_import(
|
|
|
2451
1852
|
|
|
2452
1853
|
THUMBNAIL
|
|
2453
1854
|
Thumbnails -- Display files as thumbnails.
|
|
2454
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2455
1855
|
:param sort_method: File sorting mode
|
|
2456
|
-
:type sort_method: str | None
|
|
2457
1856
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2458
|
-
:type global_scale: float | None
|
|
2459
1857
|
:param clamp_size: Clamp Bounding Box, Resize the objects to keep bounding box under this value. Value 0 disables clamping
|
|
2460
|
-
:type clamp_size: float | None
|
|
2461
1858
|
:param forward_axis: Forward Axis
|
|
2462
1859
|
|
|
2463
1860
|
X
|
|
@@ -2477,7 +1874,6 @@ def obj_import(
|
|
|
2477
1874
|
|
|
2478
1875
|
NEGATIVE_Z
|
|
2479
1876
|
-Z -- Negative Z axis.
|
|
2480
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2481
1877
|
:param up_axis: Up Axis
|
|
2482
1878
|
|
|
2483
1879
|
X
|
|
@@ -2497,19 +1893,12 @@ def obj_import(
|
|
|
2497
1893
|
|
|
2498
1894
|
NEGATIVE_Z
|
|
2499
1895
|
-Z -- Negative Z axis.
|
|
2500
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2501
1896
|
:param use_split_objects: Split By Object, Import each OBJ o as a separate object
|
|
2502
|
-
:type use_split_objects: bool | None
|
|
2503
1897
|
:param use_split_groups: Split By Group, Import each OBJ g as a separate object
|
|
2504
|
-
:type use_split_groups: bool | None
|
|
2505
1898
|
:param import_vertex_groups: Vertex Groups, Import OBJ groups as vertex groups
|
|
2506
|
-
:type import_vertex_groups: bool | None
|
|
2507
1899
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
2508
|
-
:type validate_meshes: bool | None
|
|
2509
1900
|
:param close_spline_loops: Detect Cyclic Curves, Join curve endpoints if overlapping control points are detected (if disabled, no curves will be cyclic)
|
|
2510
|
-
:type close_spline_loops: bool | None
|
|
2511
1901
|
:param collection_separator: Path Separator, Character used to separate objects name into hierarchical structure
|
|
2512
|
-
:type collection_separator: str
|
|
2513
1902
|
:param mtl_name_collision_mode: Material Name Collision, How to handle naming collisions when importing materials
|
|
2514
1903
|
|
|
2515
1904
|
MAKE_UNIQUE
|
|
@@ -2517,9 +1906,7 @@ def obj_import(
|
|
|
2517
1906
|
|
|
2518
1907
|
REFERENCE_EXISTING
|
|
2519
1908
|
Reference Existing -- Use existing materials with same name instead of creating new ones.
|
|
2520
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
2521
1909
|
:param filter_glob: Extension Filter
|
|
2522
|
-
:type filter_glob: str
|
|
2523
1910
|
"""
|
|
2524
1911
|
|
|
2525
1912
|
def open_mainfile(
|
|
@@ -2559,48 +1946,26 @@ def open_mainfile(
|
|
|
2559
1946
|
) -> None:
|
|
2560
1947
|
"""Open a Blender file
|
|
2561
1948
|
|
|
2562
|
-
:type execution_context: int | str | None
|
|
2563
|
-
:type undo: bool | None
|
|
2564
1949
|
:param filepath: File Path, Path to file
|
|
2565
|
-
:type filepath: str
|
|
2566
1950
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
2567
|
-
:type hide_props_region: bool | None
|
|
2568
1951
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2569
|
-
:type check_existing: bool | None
|
|
2570
1952
|
:param filter_blender: Filter .blend files
|
|
2571
|
-
:type filter_blender: bool | None
|
|
2572
1953
|
:param filter_backup: Filter .blend files
|
|
2573
|
-
:type filter_backup: bool | None
|
|
2574
1954
|
:param filter_image: Filter image files
|
|
2575
|
-
:type filter_image: bool | None
|
|
2576
1955
|
:param filter_movie: Filter movie files
|
|
2577
|
-
:type filter_movie: bool | None
|
|
2578
1956
|
:param filter_python: Filter Python files
|
|
2579
|
-
:type filter_python: bool | None
|
|
2580
1957
|
:param filter_font: Filter font files
|
|
2581
|
-
:type filter_font: bool | None
|
|
2582
1958
|
:param filter_sound: Filter sound files
|
|
2583
|
-
:type filter_sound: bool | None
|
|
2584
1959
|
:param filter_text: Filter text files
|
|
2585
|
-
:type filter_text: bool | None
|
|
2586
1960
|
:param filter_archive: Filter archive files
|
|
2587
|
-
:type filter_archive: bool | None
|
|
2588
1961
|
:param filter_btx: Filter btx files
|
|
2589
|
-
:type filter_btx: bool | None
|
|
2590
1962
|
:param filter_alembic: Filter Alembic files
|
|
2591
|
-
:type filter_alembic: bool | None
|
|
2592
1963
|
:param filter_usd: Filter USD files
|
|
2593
|
-
:type filter_usd: bool | None
|
|
2594
1964
|
:param filter_obj: Filter OBJ files
|
|
2595
|
-
:type filter_obj: bool | None
|
|
2596
1965
|
:param filter_volume: Filter OpenVDB volume files
|
|
2597
|
-
:type filter_volume: bool | None
|
|
2598
1966
|
:param filter_folder: Filter folders
|
|
2599
|
-
:type filter_folder: bool | None
|
|
2600
1967
|
:param filter_blenlib: Filter Blender IDs
|
|
2601
|
-
:type filter_blenlib: bool | None
|
|
2602
1968
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2603
|
-
:type filemode: int | None
|
|
2604
1969
|
:param display_type: Display Type
|
|
2605
1970
|
|
|
2606
1971
|
DEFAULT
|
|
@@ -2614,17 +1979,11 @@ def open_mainfile(
|
|
|
2614
1979
|
|
|
2615
1980
|
THUMBNAIL
|
|
2616
1981
|
Thumbnails -- Display files as thumbnails.
|
|
2617
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2618
1982
|
:param sort_method: File sorting mode
|
|
2619
|
-
:type sort_method: str | None
|
|
2620
1983
|
:param load_ui: Load UI, Load user interface setup in the .blend file
|
|
2621
|
-
:type load_ui: bool | None
|
|
2622
1984
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
2623
|
-
:type use_scripts: bool | None
|
|
2624
1985
|
:param display_file_selector: Display File Selector
|
|
2625
|
-
:type display_file_selector: bool | None
|
|
2626
1986
|
:param state: State
|
|
2627
|
-
:type state: int | None
|
|
2628
1987
|
"""
|
|
2629
1988
|
|
|
2630
1989
|
def operator_cheat_sheet(
|
|
@@ -2632,22 +1991,14 @@ def operator_cheat_sheet(
|
|
|
2632
1991
|
undo: bool | None = None,
|
|
2633
1992
|
/,
|
|
2634
1993
|
) -> None:
|
|
2635
|
-
"""List all the operators in a text-block, useful for scripting
|
|
2636
|
-
|
|
2637
|
-
:type execution_context: int | str | None
|
|
2638
|
-
:type undo: bool | None
|
|
2639
|
-
"""
|
|
1994
|
+
"""List all the operators in a text-block, useful for scripting"""
|
|
2640
1995
|
|
|
2641
1996
|
def operator_defaults(
|
|
2642
1997
|
execution_context: int | str | None = None,
|
|
2643
1998
|
undo: bool | None = None,
|
|
2644
1999
|
/,
|
|
2645
2000
|
) -> None:
|
|
2646
|
-
"""Set the active operator to its default values
|
|
2647
|
-
|
|
2648
|
-
:type execution_context: int | str | None
|
|
2649
|
-
:type undo: bool | None
|
|
2650
|
-
"""
|
|
2001
|
+
"""Set the active operator to its default values"""
|
|
2651
2002
|
|
|
2652
2003
|
def operator_pie_enum(
|
|
2653
2004
|
execution_context: int | str | None = None,
|
|
@@ -2659,12 +2010,8 @@ def operator_pie_enum(
|
|
|
2659
2010
|
) -> None:
|
|
2660
2011
|
"""Undocumented, consider contributing.
|
|
2661
2012
|
|
|
2662
|
-
:type execution_context: int | str | None
|
|
2663
|
-
:type undo: bool | None
|
|
2664
2013
|
:param data_path: Operator, Operator name (in Python as string)
|
|
2665
|
-
:type data_path: str
|
|
2666
2014
|
:param prop_string: Property, Property name (as a string)
|
|
2667
|
-
:type prop_string: str
|
|
2668
2015
|
"""
|
|
2669
2016
|
|
|
2670
2017
|
def operator_preset_add(
|
|
@@ -2679,16 +2026,10 @@ def operator_preset_add(
|
|
|
2679
2026
|
) -> None:
|
|
2680
2027
|
"""Add or remove an Operator Preset
|
|
2681
2028
|
|
|
2682
|
-
:type execution_context: int | str | None
|
|
2683
|
-
:type undo: bool | None
|
|
2684
2029
|
:param name: Name, Name of the preset, used to make the path name
|
|
2685
|
-
:type name: str
|
|
2686
2030
|
:param remove_name: remove_name
|
|
2687
|
-
:type remove_name: bool | None
|
|
2688
2031
|
:param remove_active: remove_active
|
|
2689
|
-
:type remove_active: bool | None
|
|
2690
2032
|
:param operator: Operator
|
|
2691
|
-
:type operator: str
|
|
2692
2033
|
"""
|
|
2693
2034
|
|
|
2694
2035
|
def operator_presets_cleanup(
|
|
@@ -2702,12 +2043,8 @@ def operator_presets_cleanup(
|
|
|
2702
2043
|
) -> None:
|
|
2703
2044
|
"""Remove outdated operator properties from presets that may cause problems
|
|
2704
2045
|
|
|
2705
|
-
:type execution_context: int | str | None
|
|
2706
|
-
:type undo: bool | None
|
|
2707
2046
|
:param operator: operator
|
|
2708
|
-
:type operator: str
|
|
2709
2047
|
:param properties: properties
|
|
2710
|
-
:type properties: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2711
2048
|
"""
|
|
2712
2049
|
|
|
2713
2050
|
def owner_disable(
|
|
@@ -2719,10 +2056,7 @@ def owner_disable(
|
|
|
2719
2056
|
) -> None:
|
|
2720
2057
|
"""Disable add-on for workspace
|
|
2721
2058
|
|
|
2722
|
-
:type execution_context: int | str | None
|
|
2723
|
-
:type undo: bool | None
|
|
2724
2059
|
:param owner_id: UI Tag
|
|
2725
|
-
:type owner_id: str
|
|
2726
2060
|
"""
|
|
2727
2061
|
|
|
2728
2062
|
def owner_enable(
|
|
@@ -2734,10 +2068,7 @@ def owner_enable(
|
|
|
2734
2068
|
) -> None:
|
|
2735
2069
|
"""Enable add-on for workspace
|
|
2736
2070
|
|
|
2737
|
-
:type execution_context: int | str | None
|
|
2738
|
-
:type undo: bool | None
|
|
2739
2071
|
:param owner_id: UI Tag
|
|
2740
|
-
:type owner_id: str
|
|
2741
2072
|
"""
|
|
2742
2073
|
|
|
2743
2074
|
def path_open(
|
|
@@ -2749,10 +2080,7 @@ def path_open(
|
|
|
2749
2080
|
) -> None:
|
|
2750
2081
|
"""Open a path in a file browser
|
|
2751
2082
|
|
|
2752
|
-
:type execution_context: int | str | None
|
|
2753
|
-
:type undo: bool | None
|
|
2754
2083
|
:param filepath: filepath
|
|
2755
|
-
:type filepath: str
|
|
2756
2084
|
"""
|
|
2757
2085
|
|
|
2758
2086
|
def ply_export(
|
|
@@ -2804,46 +2132,25 @@ def ply_export(
|
|
|
2804
2132
|
) -> None:
|
|
2805
2133
|
"""Save the scene to a PLY file
|
|
2806
2134
|
|
|
2807
|
-
:type execution_context: int | str | None
|
|
2808
|
-
:type undo: bool | None
|
|
2809
2135
|
:param filepath: File Path, Path to file
|
|
2810
|
-
:type filepath: str
|
|
2811
2136
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2812
|
-
:type check_existing: bool | None
|
|
2813
2137
|
:param filter_blender: Filter .blend files
|
|
2814
|
-
:type filter_blender: bool | None
|
|
2815
2138
|
:param filter_backup: Filter .blend files
|
|
2816
|
-
:type filter_backup: bool | None
|
|
2817
2139
|
:param filter_image: Filter image files
|
|
2818
|
-
:type filter_image: bool | None
|
|
2819
2140
|
:param filter_movie: Filter movie files
|
|
2820
|
-
:type filter_movie: bool | None
|
|
2821
2141
|
:param filter_python: Filter Python files
|
|
2822
|
-
:type filter_python: bool | None
|
|
2823
2142
|
:param filter_font: Filter font files
|
|
2824
|
-
:type filter_font: bool | None
|
|
2825
2143
|
:param filter_sound: Filter sound files
|
|
2826
|
-
:type filter_sound: bool | None
|
|
2827
2144
|
:param filter_text: Filter text files
|
|
2828
|
-
:type filter_text: bool | None
|
|
2829
2145
|
:param filter_archive: Filter archive files
|
|
2830
|
-
:type filter_archive: bool | None
|
|
2831
2146
|
:param filter_btx: Filter btx files
|
|
2832
|
-
:type filter_btx: bool | None
|
|
2833
2147
|
:param filter_alembic: Filter Alembic files
|
|
2834
|
-
:type filter_alembic: bool | None
|
|
2835
2148
|
:param filter_usd: Filter USD files
|
|
2836
|
-
:type filter_usd: bool | None
|
|
2837
2149
|
:param filter_obj: Filter OBJ files
|
|
2838
|
-
:type filter_obj: bool | None
|
|
2839
2150
|
:param filter_volume: Filter OpenVDB volume files
|
|
2840
|
-
:type filter_volume: bool | None
|
|
2841
2151
|
:param filter_folder: Filter folders
|
|
2842
|
-
:type filter_folder: bool | None
|
|
2843
2152
|
:param filter_blenlib: Filter Blender IDs
|
|
2844
|
-
:type filter_blenlib: bool | None
|
|
2845
2153
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
2846
|
-
:type filemode: int | None
|
|
2847
2154
|
:param display_type: Display Type
|
|
2848
2155
|
|
|
2849
2156
|
DEFAULT
|
|
@@ -2857,9 +2164,7 @@ def ply_export(
|
|
|
2857
2164
|
|
|
2858
2165
|
THUMBNAIL
|
|
2859
2166
|
Thumbnails -- Display files as thumbnails.
|
|
2860
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
2861
2167
|
:param sort_method: File sorting mode
|
|
2862
|
-
:type sort_method: str | None
|
|
2863
2168
|
:param forward_axis: Forward Axis
|
|
2864
2169
|
|
|
2865
2170
|
X
|
|
@@ -2879,7 +2184,6 @@ def ply_export(
|
|
|
2879
2184
|
|
|
2880
2185
|
NEGATIVE_Z
|
|
2881
2186
|
-Z -- Negative Z axis.
|
|
2882
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2883
2187
|
:param up_axis: Up Axis
|
|
2884
2188
|
|
|
2885
2189
|
X
|
|
@@ -2899,19 +2203,12 @@ def ply_export(
|
|
|
2899
2203
|
|
|
2900
2204
|
NEGATIVE_Z
|
|
2901
2205
|
-Z -- Negative Z axis.
|
|
2902
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
2903
2206
|
:param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
2904
|
-
:type global_scale: float | None
|
|
2905
2207
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
2906
|
-
:type apply_modifiers: bool | None
|
|
2907
2208
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
2908
|
-
:type export_selected_objects: bool | None
|
|
2909
2209
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
2910
|
-
:type collection: str
|
|
2911
2210
|
:param export_uv: Export UVs
|
|
2912
|
-
:type export_uv: bool | None
|
|
2913
2211
|
:param export_normals: Export Vertex Normals, Export specific vertex normals if available, export calculated normals otherwise
|
|
2914
|
-
:type export_normals: bool | None
|
|
2915
2212
|
:param export_colors: Export Vertex Colors, Export vertex color attributes
|
|
2916
2213
|
|
|
2917
2214
|
NONE
|
|
@@ -2922,15 +2219,10 @@ def ply_export(
|
|
|
2922
2219
|
|
|
2923
2220
|
LINEAR
|
|
2924
2221
|
Linear -- Vertex colors in the file are in linear color space.
|
|
2925
|
-
:type export_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
2926
2222
|
:param export_attributes: Export Vertex Attributes, Export custom vertex attributes
|
|
2927
|
-
:type export_attributes: bool | None
|
|
2928
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
|
|
2929
|
-
:type export_triangulated_mesh: bool | None
|
|
2930
2224
|
:param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
|
|
2931
|
-
:type ascii_format: bool | None
|
|
2932
2225
|
:param filter_glob: Extension Filter
|
|
2933
|
-
:type filter_glob: str
|
|
2934
2226
|
"""
|
|
2935
2227
|
|
|
2936
2228
|
def ply_import(
|
|
@@ -2980,50 +2272,27 @@ def ply_import(
|
|
|
2980
2272
|
) -> None:
|
|
2981
2273
|
"""Import an PLY file as an object
|
|
2982
2274
|
|
|
2983
|
-
:type execution_context: int | str | None
|
|
2984
|
-
:type undo: bool | None
|
|
2985
2275
|
:param filepath: File Path, Path to file
|
|
2986
|
-
:type filepath: str
|
|
2987
2276
|
:param directory: Directory, Directory of the file
|
|
2988
|
-
:type directory: str
|
|
2989
2277
|
:param files: Files
|
|
2990
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
2991
2278
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
2992
|
-
:type check_existing: bool | None
|
|
2993
2279
|
:param filter_blender: Filter .blend files
|
|
2994
|
-
:type filter_blender: bool | None
|
|
2995
2280
|
:param filter_backup: Filter .blend files
|
|
2996
|
-
:type filter_backup: bool | None
|
|
2997
2281
|
:param filter_image: Filter image files
|
|
2998
|
-
:type filter_image: bool | None
|
|
2999
2282
|
:param filter_movie: Filter movie files
|
|
3000
|
-
:type filter_movie: bool | None
|
|
3001
2283
|
:param filter_python: Filter Python files
|
|
3002
|
-
:type filter_python: bool | None
|
|
3003
2284
|
:param filter_font: Filter font files
|
|
3004
|
-
:type filter_font: bool | None
|
|
3005
2285
|
:param filter_sound: Filter sound files
|
|
3006
|
-
:type filter_sound: bool | None
|
|
3007
2286
|
:param filter_text: Filter text files
|
|
3008
|
-
:type filter_text: bool | None
|
|
3009
2287
|
:param filter_archive: Filter archive files
|
|
3010
|
-
:type filter_archive: bool | None
|
|
3011
2288
|
:param filter_btx: Filter btx files
|
|
3012
|
-
:type filter_btx: bool | None
|
|
3013
2289
|
:param filter_alembic: Filter Alembic files
|
|
3014
|
-
:type filter_alembic: bool | None
|
|
3015
2290
|
:param filter_usd: Filter USD files
|
|
3016
|
-
:type filter_usd: bool | None
|
|
3017
2291
|
:param filter_obj: Filter OBJ files
|
|
3018
|
-
:type filter_obj: bool | None
|
|
3019
2292
|
:param filter_volume: Filter OpenVDB volume files
|
|
3020
|
-
:type filter_volume: bool | None
|
|
3021
2293
|
:param filter_folder: Filter folders
|
|
3022
|
-
:type filter_folder: bool | None
|
|
3023
2294
|
:param filter_blenlib: Filter Blender IDs
|
|
3024
|
-
:type filter_blenlib: bool | None
|
|
3025
2295
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
3026
|
-
:type filemode: int | None
|
|
3027
2296
|
:param display_type: Display Type
|
|
3028
2297
|
|
|
3029
2298
|
DEFAULT
|
|
@@ -3037,13 +2306,9 @@ def ply_import(
|
|
|
3037
2306
|
|
|
3038
2307
|
THUMBNAIL
|
|
3039
2308
|
Thumbnails -- Display files as thumbnails.
|
|
3040
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3041
2309
|
:param sort_method: File sorting mode
|
|
3042
|
-
:type sort_method: str | None
|
|
3043
2310
|
:param global_scale: Scale
|
|
3044
|
-
:type global_scale: float | None
|
|
3045
2311
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
3046
|
-
:type use_scene_unit: bool | None
|
|
3047
2312
|
:param forward_axis: Forward Axis
|
|
3048
2313
|
|
|
3049
2314
|
X
|
|
@@ -3063,7 +2328,6 @@ def ply_import(
|
|
|
3063
2328
|
|
|
3064
2329
|
NEGATIVE_Z
|
|
3065
2330
|
-Z -- Negative Z axis.
|
|
3066
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
3067
2331
|
:param up_axis: Up Axis
|
|
3068
2332
|
|
|
3069
2333
|
X
|
|
@@ -3083,9 +2347,7 @@ def ply_import(
|
|
|
3083
2347
|
|
|
3084
2348
|
NEGATIVE_Z
|
|
3085
2349
|
-Z -- Negative Z axis.
|
|
3086
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
3087
2350
|
:param merge_verts: Merge Vertices, Merges vertices by distance
|
|
3088
|
-
:type merge_verts: bool | None
|
|
3089
2351
|
:param import_colors: Vertex Colors, Import vertex color attributes
|
|
3090
2352
|
|
|
3091
2353
|
NONE
|
|
@@ -3096,11 +2358,8 @@ def ply_import(
|
|
|
3096
2358
|
|
|
3097
2359
|
LINEAR
|
|
3098
2360
|
Linear -- Vertex colors in the file are in linear color space.
|
|
3099
|
-
:type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
|
|
3100
2361
|
:param import_attributes: Vertex Attributes, Import custom vertex attributes
|
|
3101
|
-
:type import_attributes: bool | None
|
|
3102
2362
|
:param filter_glob: Extension Filter
|
|
3103
|
-
:type filter_glob: str
|
|
3104
2363
|
"""
|
|
3105
2364
|
|
|
3106
2365
|
def previews_batch_clear(
|
|
@@ -3122,28 +2381,16 @@ def previews_batch_clear(
|
|
|
3122
2381
|
) -> None:
|
|
3123
2382
|
"""Clear selected .blend files previews
|
|
3124
2383
|
|
|
3125
|
-
:type execution_context: int | str | None
|
|
3126
|
-
:type undo: bool | None
|
|
3127
2384
|
:param files: files
|
|
3128
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
3129
2385
|
:param directory: directory
|
|
3130
|
-
:type directory: str
|
|
3131
2386
|
:param filter_blender: filter_blender
|
|
3132
|
-
:type filter_blender: bool | None
|
|
3133
2387
|
:param filter_folder: filter_folder
|
|
3134
|
-
:type filter_folder: bool | None
|
|
3135
2388
|
:param use_scenes: Scenes, Clear scenes previews
|
|
3136
|
-
:type use_scenes: bool | None
|
|
3137
2389
|
:param use_collections: Collections, Clear collections previews
|
|
3138
|
-
:type use_collections: bool | None
|
|
3139
2390
|
:param use_objects: Objects, Clear objects previews
|
|
3140
|
-
:type use_objects: bool | None
|
|
3141
2391
|
:param use_intern_data: Materials & Textures, Clear internal previews (materials, textures, images, etc.)
|
|
3142
|
-
:type use_intern_data: bool | None
|
|
3143
2392
|
:param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
|
|
3144
|
-
:type use_trusted: bool | None
|
|
3145
2393
|
:param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with cleared previews
|
|
3146
|
-
:type use_backups: bool | None
|
|
3147
2394
|
"""
|
|
3148
2395
|
|
|
3149
2396
|
def previews_batch_generate(
|
|
@@ -3165,28 +2412,16 @@ def previews_batch_generate(
|
|
|
3165
2412
|
) -> None:
|
|
3166
2413
|
"""Generate selected .blend files previews
|
|
3167
2414
|
|
|
3168
|
-
:type execution_context: int | str | None
|
|
3169
|
-
:type undo: bool | None
|
|
3170
2415
|
:param files: Collection of file paths with common directory root
|
|
3171
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
3172
2416
|
:param directory: Root path of all files listed in files collection
|
|
3173
|
-
:type directory: str
|
|
3174
2417
|
:param filter_blender: Show Blender files in the File Browser
|
|
3175
|
-
:type filter_blender: bool | None
|
|
3176
2418
|
:param filter_folder: Show folders in the File Browser
|
|
3177
|
-
:type filter_folder: bool | None
|
|
3178
2419
|
:param use_scenes: Scenes, Generate scenes previews
|
|
3179
|
-
:type use_scenes: bool | None
|
|
3180
2420
|
:param use_collections: Collections, Generate collections previews
|
|
3181
|
-
:type use_collections: bool | None
|
|
3182
2421
|
:param use_objects: Objects, Generate objects previews
|
|
3183
|
-
:type use_objects: bool | None
|
|
3184
2422
|
:param use_intern_data: Materials & Textures, Generate internal previews (materials, textures, images, etc.)
|
|
3185
|
-
:type use_intern_data: bool | None
|
|
3186
2423
|
:param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
|
|
3187
|
-
:type use_trusted: bool | None
|
|
3188
2424
|
:param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with generated previews
|
|
3189
|
-
:type use_backups: bool | None
|
|
3190
2425
|
"""
|
|
3191
2426
|
|
|
3192
2427
|
def previews_clear(
|
|
@@ -3213,8 +2448,6 @@ def previews_clear(
|
|
|
3213
2448
|
) -> None:
|
|
3214
2449
|
"""Clear data-block previews (only for some types like objects, materials, textures, etc.)
|
|
3215
2450
|
|
|
3216
|
-
:type execution_context: int | str | None
|
|
3217
|
-
:type undo: bool | None
|
|
3218
2451
|
:param id_type: Data-Block Type, Which data-block previews to clear
|
|
3219
2452
|
|
|
3220
2453
|
ALL
|
|
@@ -3249,7 +2482,6 @@ def previews_clear(
|
|
|
3249
2482
|
|
|
3250
2483
|
IMAGE
|
|
3251
2484
|
Images.
|
|
3252
|
-
:type id_type: set[typing.Literal['ALL','GEOMETRY','SHADING','SCENE','COLLECTION','OBJECT','MATERIAL','LIGHT','WORLD','TEXTURE','IMAGE']] | None
|
|
3253
2485
|
"""
|
|
3254
2486
|
|
|
3255
2487
|
def previews_ensure(
|
|
@@ -3257,11 +2489,7 @@ def previews_ensure(
|
|
|
3257
2489
|
undo: bool | None = None,
|
|
3258
2490
|
/,
|
|
3259
2491
|
) -> None:
|
|
3260
|
-
"""Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)
|
|
3261
|
-
|
|
3262
|
-
:type execution_context: int | str | None
|
|
3263
|
-
:type undo: bool | None
|
|
3264
|
-
"""
|
|
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.)"""
|
|
3265
2493
|
|
|
3266
2494
|
def properties_add(
|
|
3267
2495
|
execution_context: int | str | None = None,
|
|
@@ -3272,10 +2500,7 @@ def properties_add(
|
|
|
3272
2500
|
) -> None:
|
|
3273
2501
|
"""Add your own property to the data-block
|
|
3274
2502
|
|
|
3275
|
-
:type execution_context: int | str | None
|
|
3276
|
-
:type undo: bool | None
|
|
3277
2503
|
:param data_path: Property Edit, Property data_path edit
|
|
3278
|
-
:type data_path: str
|
|
3279
2504
|
"""
|
|
3280
2505
|
|
|
3281
2506
|
def properties_context_change(
|
|
@@ -3287,10 +2512,7 @@ def properties_context_change(
|
|
|
3287
2512
|
) -> None:
|
|
3288
2513
|
"""Jump to a different tab inside the properties editor
|
|
3289
2514
|
|
|
3290
|
-
:type execution_context: int | str | None
|
|
3291
|
-
:type undo: bool | None
|
|
3292
2515
|
:param context: Context
|
|
3293
|
-
:type context: str
|
|
3294
2516
|
"""
|
|
3295
2517
|
|
|
3296
2518
|
def properties_edit(
|
|
@@ -3477,12 +2699,8 @@ def properties_edit(
|
|
|
3477
2699
|
) -> None:
|
|
3478
2700
|
"""Change a custom propertys type, or adjust how it is displayed in the interface
|
|
3479
2701
|
|
|
3480
|
-
:type execution_context: int | str | None
|
|
3481
|
-
:type undo: bool | None
|
|
3482
2702
|
:param data_path: Property Edit, Property data_path edit
|
|
3483
|
-
:type data_path: str
|
|
3484
2703
|
:param property_name: Property Name, Property name edit
|
|
3485
|
-
:type property_name: str
|
|
3486
2704
|
:param property_type: Type
|
|
3487
2705
|
|
|
3488
2706
|
FLOAT
|
|
@@ -3511,51 +2729,28 @@ def properties_edit(
|
|
|
3511
2729
|
|
|
3512
2730
|
PYTHON
|
|
3513
2731
|
Python -- Edit a Python value directly, for unsupported property types.
|
|
3514
|
-
:type property_type: typing.Literal['FLOAT','FLOAT_ARRAY','INT','INT_ARRAY','BOOL','BOOL_ARRAY','STRING','DATA_BLOCK','PYTHON'] | None
|
|
3515
2732
|
:param is_overridable_library: Library Overridable, Allow the property to be overridden when the data-block is linked
|
|
3516
|
-
:type is_overridable_library: bool | None
|
|
3517
2733
|
:param description: Description
|
|
3518
|
-
:type description: str
|
|
3519
2734
|
:param use_soft_limits: Soft Limits, Limits the Property Value slider to a range, values outside the range must be inputted numerically
|
|
3520
|
-
:type use_soft_limits: bool | None
|
|
3521
2735
|
:param array_length: Array Length
|
|
3522
|
-
:type array_length: int | None
|
|
3523
2736
|
:param default_int: Default Value
|
|
3524
|
-
:type default_int: collections.abc.Iterable[int] | None
|
|
3525
2737
|
:param min_int: Min
|
|
3526
|
-
:type min_int: int | None
|
|
3527
2738
|
:param max_int: Max
|
|
3528
|
-
:type max_int: int | None
|
|
3529
2739
|
:param soft_min_int: Soft Min
|
|
3530
|
-
:type soft_min_int: int | None
|
|
3531
2740
|
:param soft_max_int: Soft Max
|
|
3532
|
-
:type soft_max_int: int | None
|
|
3533
2741
|
:param step_int: Step
|
|
3534
|
-
:type step_int: int | None
|
|
3535
2742
|
:param default_bool: Default Value
|
|
3536
|
-
:type default_bool: collections.abc.Iterable[bool] | None
|
|
3537
2743
|
:param default_float: Default Value
|
|
3538
|
-
:type default_float: collections.abc.Iterable[float] | None
|
|
3539
2744
|
:param min_float: Min
|
|
3540
|
-
:type min_float: float | None
|
|
3541
2745
|
:param max_float: Max
|
|
3542
|
-
:type max_float: float | None
|
|
3543
2746
|
:param soft_min_float: Soft Min
|
|
3544
|
-
:type soft_min_float: float | None
|
|
3545
2747
|
:param soft_max_float: Soft Max
|
|
3546
|
-
:type soft_max_float: float | None
|
|
3547
2748
|
:param precision: Precision
|
|
3548
|
-
:type precision: int | None
|
|
3549
2749
|
:param step_float: Step
|
|
3550
|
-
:type step_float: float | None
|
|
3551
2750
|
:param subtype: Subtype
|
|
3552
|
-
:type subtype: str | None
|
|
3553
2751
|
:param default_string: Default Value
|
|
3554
|
-
:type default_string: str
|
|
3555
2752
|
:param id_type: ID Type
|
|
3556
|
-
: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
|
|
3557
2753
|
:param eval_string: Value, Python value for unsupported custom property types
|
|
3558
|
-
:type eval_string: str
|
|
3559
2754
|
"""
|
|
3560
2755
|
|
|
3561
2756
|
def properties_edit_value(
|
|
@@ -3569,14 +2764,9 @@ def properties_edit_value(
|
|
|
3569
2764
|
) -> None:
|
|
3570
2765
|
"""Edit the value of a custom property
|
|
3571
2766
|
|
|
3572
|
-
:type execution_context: int | str | None
|
|
3573
|
-
:type undo: bool | None
|
|
3574
2767
|
:param data_path: Property Edit, Property data_path edit
|
|
3575
|
-
:type data_path: str
|
|
3576
2768
|
:param property_name: Property Name, Property name edit
|
|
3577
|
-
:type property_name: str
|
|
3578
2769
|
:param eval_string: Value, Value for custom property types that can only be edited as a Python expression
|
|
3579
|
-
:type eval_string: str
|
|
3580
2770
|
"""
|
|
3581
2771
|
|
|
3582
2772
|
def properties_remove(
|
|
@@ -3589,12 +2779,8 @@ def properties_remove(
|
|
|
3589
2779
|
) -> None:
|
|
3590
2780
|
"""Internal use (edit a property data_path)
|
|
3591
2781
|
|
|
3592
|
-
:type execution_context: int | str | None
|
|
3593
|
-
:type undo: bool | None
|
|
3594
2782
|
:param data_path: Property Edit, Property data_path edit
|
|
3595
|
-
:type data_path: str
|
|
3596
2783
|
:param property_name: Property Name, Property name edit
|
|
3597
|
-
:type property_name: str
|
|
3598
2784
|
"""
|
|
3599
2785
|
|
|
3600
2786
|
def quit_blender(
|
|
@@ -3602,11 +2788,7 @@ def quit_blender(
|
|
|
3602
2788
|
undo: bool | None = None,
|
|
3603
2789
|
/,
|
|
3604
2790
|
) -> None:
|
|
3605
|
-
"""Quit Blender
|
|
3606
|
-
|
|
3607
|
-
:type execution_context: int | str | None
|
|
3608
|
-
:type undo: bool | None
|
|
3609
|
-
"""
|
|
2791
|
+
"""Quit Blender"""
|
|
3610
2792
|
|
|
3611
2793
|
def radial_control(
|
|
3612
2794
|
execution_context: int | str | None = None,
|
|
@@ -3628,32 +2810,18 @@ def radial_control(
|
|
|
3628
2810
|
) -> None:
|
|
3629
2811
|
"""Set some size property (e.g. brush size) with mouse wheel
|
|
3630
2812
|
|
|
3631
|
-
:type execution_context: int | str | None
|
|
3632
|
-
:type undo: bool | None
|
|
3633
2813
|
:param data_path_primary: Primary Data Path, Primary path of property to be set by the radial control
|
|
3634
|
-
:type data_path_primary: str
|
|
3635
2814
|
:param data_path_secondary: Secondary Data Path, Secondary path of property to be set by the radial control
|
|
3636
|
-
:type data_path_secondary: str
|
|
3637
2815
|
:param use_secondary: Use Secondary, Path of property to select between the primary and secondary data paths
|
|
3638
|
-
:type use_secondary: str
|
|
3639
2816
|
:param rotation_path: Rotation Path, Path of property used to rotate the texture display
|
|
3640
|
-
:type rotation_path: str
|
|
3641
2817
|
:param color_path: Color Path, Path of property used to set the color of the control
|
|
3642
|
-
:type color_path: str
|
|
3643
2818
|
:param fill_color_path: Fill Color Path, Path of property used to set the fill color of the control
|
|
3644
|
-
:type fill_color_path: str
|
|
3645
2819
|
:param fill_color_override_path: Fill Color Override Path
|
|
3646
|
-
:type fill_color_override_path: str
|
|
3647
2820
|
:param fill_color_override_test_path: Fill Color Override Test
|
|
3648
|
-
:type fill_color_override_test_path: str
|
|
3649
2821
|
:param zoom_path: Zoom Path, Path of property used to set the zoom level for the control
|
|
3650
|
-
:type zoom_path: str
|
|
3651
2822
|
:param image_id: Image ID, Path of ID that is used to generate an image for the control
|
|
3652
|
-
:type image_id: str
|
|
3653
2823
|
:param secondary_tex: Secondary Texture, Tweak brush secondary/mask texture
|
|
3654
|
-
:type secondary_tex: bool | None
|
|
3655
2824
|
:param release_confirm: Confirm On Release, Finish operation on key release
|
|
3656
|
-
:type release_confirm: bool | None
|
|
3657
2825
|
"""
|
|
3658
2826
|
|
|
3659
2827
|
def read_factory_settings(
|
|
@@ -3667,13 +2835,8 @@ def read_factory_settings(
|
|
|
3667
2835
|
) -> None:
|
|
3668
2836
|
"""Load factory default startup file and preferences. To make changes permanent, use "Save Startup File" and "Save Preferences"
|
|
3669
2837
|
|
|
3670
|
-
:type execution_context: int | str | None
|
|
3671
|
-
:type undo: bool | None
|
|
3672
2838
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3673
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3674
|
-
:type app_template: str
|
|
3675
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, ...
|
|
3676
|
-
:type use_empty: bool | None
|
|
3677
2840
|
"""
|
|
3678
2841
|
|
|
3679
2842
|
def read_factory_userpref(
|
|
@@ -3685,10 +2848,7 @@ def read_factory_userpref(
|
|
|
3685
2848
|
) -> None:
|
|
3686
2849
|
"""Load factory default preferences. To make changes to preferences permanent, use "Save Preferences"
|
|
3687
2850
|
|
|
3688
|
-
:type execution_context: int | str | None
|
|
3689
|
-
:type undo: bool | None
|
|
3690
2851
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3691
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3692
2852
|
"""
|
|
3693
2853
|
|
|
3694
2854
|
def read_history(
|
|
@@ -3696,11 +2856,7 @@ def read_history(
|
|
|
3696
2856
|
undo: bool | None = None,
|
|
3697
2857
|
/,
|
|
3698
2858
|
) -> None:
|
|
3699
|
-
"""Reloads history and bookmarks
|
|
3700
|
-
|
|
3701
|
-
:type execution_context: int | str | None
|
|
3702
|
-
:type undo: bool | None
|
|
3703
|
-
"""
|
|
2859
|
+
"""Reloads history and bookmarks"""
|
|
3704
2860
|
|
|
3705
2861
|
def read_homefile(
|
|
3706
2862
|
execution_context: int | str | None = None,
|
|
@@ -3717,21 +2873,12 @@ def read_homefile(
|
|
|
3717
2873
|
) -> None:
|
|
3718
2874
|
"""Open the default file
|
|
3719
2875
|
|
|
3720
|
-
:type execution_context: int | str | None
|
|
3721
|
-
:type undo: bool | None
|
|
3722
2876
|
:param filepath: File Path, Path to an alternative start-up file
|
|
3723
|
-
:type filepath: str
|
|
3724
2877
|
:param load_ui: Load UI, Load user interface setup from the .blend file
|
|
3725
|
-
:type load_ui: bool | None
|
|
3726
2878
|
:param use_splash: Splash
|
|
3727
|
-
:type use_splash: bool | None
|
|
3728
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
|
|
3729
|
-
:type use_factory_startup: bool | None
|
|
3730
2880
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3731
|
-
:type use_factory_startup_app_template_only: bool | None
|
|
3732
|
-
:type app_template: str
|
|
3733
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, ...
|
|
3734
|
-
:type use_empty: bool | None
|
|
3735
2882
|
"""
|
|
3736
2883
|
|
|
3737
2884
|
def read_userpref(
|
|
@@ -3739,11 +2886,7 @@ def read_userpref(
|
|
|
3739
2886
|
undo: bool | None = None,
|
|
3740
2887
|
/,
|
|
3741
2888
|
) -> None:
|
|
3742
|
-
"""Load last saved preferences
|
|
3743
|
-
|
|
3744
|
-
:type execution_context: int | str | None
|
|
3745
|
-
:type undo: bool | None
|
|
3746
|
-
"""
|
|
2889
|
+
"""Load last saved preferences"""
|
|
3747
2890
|
|
|
3748
2891
|
def recover_auto_save(
|
|
3749
2892
|
execution_context: int | str | None = None,
|
|
@@ -3779,48 +2922,26 @@ def recover_auto_save(
|
|
|
3779
2922
|
) -> None:
|
|
3780
2923
|
"""Open an automatically saved file to recover it
|
|
3781
2924
|
|
|
3782
|
-
:type execution_context: int | str | None
|
|
3783
|
-
:type undo: bool | None
|
|
3784
2925
|
:param filepath: File Path, Path to file
|
|
3785
|
-
:type filepath: str
|
|
3786
2926
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
3787
|
-
:type hide_props_region: bool | None
|
|
3788
2927
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
3789
|
-
:type check_existing: bool | None
|
|
3790
2928
|
:param filter_blender: Filter .blend files
|
|
3791
|
-
:type filter_blender: bool | None
|
|
3792
2929
|
:param filter_backup: Filter .blend files
|
|
3793
|
-
:type filter_backup: bool | None
|
|
3794
2930
|
:param filter_image: Filter image files
|
|
3795
|
-
:type filter_image: bool | None
|
|
3796
2931
|
:param filter_movie: Filter movie files
|
|
3797
|
-
:type filter_movie: bool | None
|
|
3798
2932
|
:param filter_python: Filter Python files
|
|
3799
|
-
:type filter_python: bool | None
|
|
3800
2933
|
:param filter_font: Filter font files
|
|
3801
|
-
:type filter_font: bool | None
|
|
3802
2934
|
:param filter_sound: Filter sound files
|
|
3803
|
-
:type filter_sound: bool | None
|
|
3804
2935
|
:param filter_text: Filter text files
|
|
3805
|
-
:type filter_text: bool | None
|
|
3806
2936
|
:param filter_archive: Filter archive files
|
|
3807
|
-
:type filter_archive: bool | None
|
|
3808
2937
|
:param filter_btx: Filter btx files
|
|
3809
|
-
:type filter_btx: bool | None
|
|
3810
2938
|
:param filter_alembic: Filter Alembic files
|
|
3811
|
-
:type filter_alembic: bool | None
|
|
3812
2939
|
:param filter_usd: Filter USD files
|
|
3813
|
-
:type filter_usd: bool | None
|
|
3814
2940
|
:param filter_obj: Filter OBJ files
|
|
3815
|
-
:type filter_obj: bool | None
|
|
3816
2941
|
:param filter_volume: Filter OpenVDB volume files
|
|
3817
|
-
:type filter_volume: bool | None
|
|
3818
2942
|
:param filter_folder: Filter folders
|
|
3819
|
-
:type filter_folder: bool | None
|
|
3820
2943
|
:param filter_blenlib: Filter Blender IDs
|
|
3821
|
-
:type filter_blenlib: bool | None
|
|
3822
2944
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
3823
|
-
:type filemode: int | None
|
|
3824
2945
|
:param display_type: Display Type
|
|
3825
2946
|
|
|
3826
2947
|
DEFAULT
|
|
@@ -3834,11 +2955,8 @@ def recover_auto_save(
|
|
|
3834
2955
|
|
|
3835
2956
|
THUMBNAIL
|
|
3836
2957
|
Thumbnails -- Display files as thumbnails.
|
|
3837
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
3838
2958
|
:param sort_method: File sorting mode
|
|
3839
|
-
:type sort_method: str | None
|
|
3840
2959
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3841
|
-
:type use_scripts: bool | None
|
|
3842
2960
|
"""
|
|
3843
2961
|
|
|
3844
2962
|
def recover_last_session(
|
|
@@ -3850,10 +2968,7 @@ def recover_last_session(
|
|
|
3850
2968
|
) -> None:
|
|
3851
2969
|
"""Open the last closed file ("quit.blend")
|
|
3852
2970
|
|
|
3853
|
-
:type execution_context: int | str | None
|
|
3854
|
-
:type undo: bool | None
|
|
3855
2971
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3856
|
-
:type use_scripts: bool | None
|
|
3857
2972
|
"""
|
|
3858
2973
|
|
|
3859
2974
|
def redraw_timer(
|
|
@@ -3876,8 +2991,6 @@ def redraw_timer(
|
|
|
3876
2991
|
) -> None:
|
|
3877
2992
|
"""Simple redraw timer to test the speed of updating the interface
|
|
3878
2993
|
|
|
3879
|
-
:type execution_context: int | str | None
|
|
3880
|
-
:type undo: bool | None
|
|
3881
2994
|
:param type: Type
|
|
3882
2995
|
|
|
3883
2996
|
DRAW
|
|
@@ -3900,11 +3013,8 @@ def redraw_timer(
|
|
|
3900
3013
|
|
|
3901
3014
|
UNDO
|
|
3902
3015
|
Undo/Redo -- Undo and redo.
|
|
3903
|
-
:type type: typing.Literal['DRAW','DRAW_SWAP','DRAW_WIN','DRAW_WIN_SWAP','ANIM_STEP','ANIM_PLAY','UNDO'] | None
|
|
3904
3016
|
:param iterations: Iterations, Number of times to redraw
|
|
3905
|
-
:type iterations: int | None
|
|
3906
3017
|
:param time_limit: Time Limit, Seconds to run the test for (override iterations)
|
|
3907
|
-
:type time_limit: float | None
|
|
3908
3018
|
"""
|
|
3909
3019
|
|
|
3910
3020
|
def revert_mainfile(
|
|
@@ -3916,10 +3026,7 @@ def revert_mainfile(
|
|
|
3916
3026
|
) -> None:
|
|
3917
3027
|
"""Reload the saved file
|
|
3918
3028
|
|
|
3919
|
-
:type execution_context: int | str | None
|
|
3920
|
-
:type undo: bool | None
|
|
3921
3029
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
3922
|
-
:type use_scripts: bool | None
|
|
3923
3030
|
"""
|
|
3924
3031
|
|
|
3925
3032
|
def save_as_mainfile(
|
|
@@ -3958,48 +3065,26 @@ def save_as_mainfile(
|
|
|
3958
3065
|
) -> None:
|
|
3959
3066
|
"""Save the current file in the desired location
|
|
3960
3067
|
|
|
3961
|
-
:type execution_context: int | str | None
|
|
3962
|
-
:type undo: bool | None
|
|
3963
3068
|
:param filepath: File Path, Path to file
|
|
3964
|
-
:type filepath: str
|
|
3965
3069
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
3966
|
-
:type hide_props_region: bool | None
|
|
3967
3070
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
3968
|
-
:type check_existing: bool | None
|
|
3969
3071
|
:param filter_blender: Filter .blend files
|
|
3970
|
-
:type filter_blender: bool | None
|
|
3971
3072
|
:param filter_backup: Filter .blend files
|
|
3972
|
-
:type filter_backup: bool | None
|
|
3973
3073
|
:param filter_image: Filter image files
|
|
3974
|
-
:type filter_image: bool | None
|
|
3975
3074
|
:param filter_movie: Filter movie files
|
|
3976
|
-
:type filter_movie: bool | None
|
|
3977
3075
|
:param filter_python: Filter Python files
|
|
3978
|
-
:type filter_python: bool | None
|
|
3979
3076
|
:param filter_font: Filter font files
|
|
3980
|
-
:type filter_font: bool | None
|
|
3981
3077
|
:param filter_sound: Filter sound files
|
|
3982
|
-
:type filter_sound: bool | None
|
|
3983
3078
|
:param filter_text: Filter text files
|
|
3984
|
-
:type filter_text: bool | None
|
|
3985
3079
|
:param filter_archive: Filter archive files
|
|
3986
|
-
:type filter_archive: bool | None
|
|
3987
3080
|
:param filter_btx: Filter btx files
|
|
3988
|
-
:type filter_btx: bool | None
|
|
3989
3081
|
:param filter_alembic: Filter Alembic files
|
|
3990
|
-
:type filter_alembic: bool | None
|
|
3991
3082
|
:param filter_usd: Filter USD files
|
|
3992
|
-
:type filter_usd: bool | None
|
|
3993
3083
|
:param filter_obj: Filter OBJ files
|
|
3994
|
-
:type filter_obj: bool | None
|
|
3995
3084
|
:param filter_volume: Filter OpenVDB volume files
|
|
3996
|
-
:type filter_volume: bool | None
|
|
3997
3085
|
:param filter_folder: Filter folders
|
|
3998
|
-
:type filter_folder: bool | None
|
|
3999
3086
|
:param filter_blenlib: Filter Blender IDs
|
|
4000
|
-
:type filter_blenlib: bool | None
|
|
4001
3087
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4002
|
-
:type filemode: int | None
|
|
4003
3088
|
:param display_type: Display Type
|
|
4004
3089
|
|
|
4005
3090
|
DEFAULT
|
|
@@ -4013,15 +3098,10 @@ def save_as_mainfile(
|
|
|
4013
3098
|
|
|
4014
3099
|
THUMBNAIL
|
|
4015
3100
|
Thumbnails -- Display files as thumbnails.
|
|
4016
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4017
3101
|
:param sort_method: File sorting mode
|
|
4018
|
-
:type sort_method: str | None
|
|
4019
3102
|
:param compress: Compress, Write compressed .blend file
|
|
4020
|
-
:type compress: bool | None
|
|
4021
3103
|
:param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
|
|
4022
|
-
:type relative_remap: bool | None
|
|
4023
3104
|
:param copy: Save Copy, Save a copy of the actual working state but does not make saved file active
|
|
4024
|
-
:type copy: bool | None
|
|
4025
3105
|
"""
|
|
4026
3106
|
|
|
4027
3107
|
def save_homefile(
|
|
@@ -4029,11 +3109,7 @@ def save_homefile(
|
|
|
4029
3109
|
undo: bool | None = None,
|
|
4030
3110
|
/,
|
|
4031
3111
|
) -> None:
|
|
4032
|
-
"""Make the current file the default startup file
|
|
4033
|
-
|
|
4034
|
-
:type execution_context: int | str | None
|
|
4035
|
-
:type undo: bool | None
|
|
4036
|
-
"""
|
|
3112
|
+
"""Make the current file the default startup file"""
|
|
4037
3113
|
|
|
4038
3114
|
def save_mainfile(
|
|
4039
3115
|
execution_context: int | str | None = None,
|
|
@@ -4072,48 +3148,26 @@ def save_mainfile(
|
|
|
4072
3148
|
) -> None:
|
|
4073
3149
|
"""Save the current Blender file
|
|
4074
3150
|
|
|
4075
|
-
:type execution_context: int | str | None
|
|
4076
|
-
:type undo: bool | None
|
|
4077
3151
|
:param filepath: File Path, Path to file
|
|
4078
|
-
:type filepath: str
|
|
4079
3152
|
:param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
|
|
4080
|
-
:type hide_props_region: bool | None
|
|
4081
3153
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4082
|
-
:type check_existing: bool | None
|
|
4083
3154
|
:param filter_blender: Filter .blend files
|
|
4084
|
-
:type filter_blender: bool | None
|
|
4085
3155
|
:param filter_backup: Filter .blend files
|
|
4086
|
-
:type filter_backup: bool | None
|
|
4087
3156
|
:param filter_image: Filter image files
|
|
4088
|
-
:type filter_image: bool | None
|
|
4089
3157
|
:param filter_movie: Filter movie files
|
|
4090
|
-
:type filter_movie: bool | None
|
|
4091
3158
|
:param filter_python: Filter Python files
|
|
4092
|
-
:type filter_python: bool | None
|
|
4093
3159
|
:param filter_font: Filter font files
|
|
4094
|
-
:type filter_font: bool | None
|
|
4095
3160
|
:param filter_sound: Filter sound files
|
|
4096
|
-
:type filter_sound: bool | None
|
|
4097
3161
|
:param filter_text: Filter text files
|
|
4098
|
-
:type filter_text: bool | None
|
|
4099
3162
|
:param filter_archive: Filter archive files
|
|
4100
|
-
:type filter_archive: bool | None
|
|
4101
3163
|
:param filter_btx: Filter btx files
|
|
4102
|
-
:type filter_btx: bool | None
|
|
4103
3164
|
:param filter_alembic: Filter Alembic files
|
|
4104
|
-
:type filter_alembic: bool | None
|
|
4105
3165
|
:param filter_usd: Filter USD files
|
|
4106
|
-
:type filter_usd: bool | None
|
|
4107
3166
|
:param filter_obj: Filter OBJ files
|
|
4108
|
-
:type filter_obj: bool | None
|
|
4109
3167
|
:param filter_volume: Filter OpenVDB volume files
|
|
4110
|
-
:type filter_volume: bool | None
|
|
4111
3168
|
:param filter_folder: Filter folders
|
|
4112
|
-
:type filter_folder: bool | None
|
|
4113
3169
|
:param filter_blenlib: Filter Blender IDs
|
|
4114
|
-
:type filter_blenlib: bool | None
|
|
4115
3170
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4116
|
-
:type filemode: int | None
|
|
4117
3171
|
:param display_type: Display Type
|
|
4118
3172
|
|
|
4119
3173
|
DEFAULT
|
|
@@ -4127,17 +3181,11 @@ def save_mainfile(
|
|
|
4127
3181
|
|
|
4128
3182
|
THUMBNAIL
|
|
4129
3183
|
Thumbnails -- Display files as thumbnails.
|
|
4130
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4131
3184
|
:param sort_method: File sorting mode
|
|
4132
|
-
:type sort_method: str | None
|
|
4133
3185
|
:param compress: Compress, Write compressed .blend file
|
|
4134
|
-
:type compress: bool | None
|
|
4135
3186
|
:param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
|
|
4136
|
-
:type relative_remap: bool | None
|
|
4137
3187
|
:param exit: Exit, Exit Blender after saving
|
|
4138
|
-
:type exit: bool | None
|
|
4139
3188
|
:param incremental: Incremental, Save the current Blender file with a numerically incremented name that does not overwrite any existing files
|
|
4140
|
-
:type incremental: bool | None
|
|
4141
3189
|
"""
|
|
4142
3190
|
|
|
4143
3191
|
def save_userpref(
|
|
@@ -4145,33 +3193,21 @@ def save_userpref(
|
|
|
4145
3193
|
undo: bool | None = None,
|
|
4146
3194
|
/,
|
|
4147
3195
|
) -> None:
|
|
4148
|
-
"""Make the current preferences default
|
|
4149
|
-
|
|
4150
|
-
:type execution_context: int | str | None
|
|
4151
|
-
:type undo: bool | None
|
|
4152
|
-
"""
|
|
3196
|
+
"""Make the current preferences default"""
|
|
4153
3197
|
|
|
4154
3198
|
def search_menu(
|
|
4155
3199
|
execution_context: int | str | None = None,
|
|
4156
3200
|
undo: bool | None = None,
|
|
4157
3201
|
/,
|
|
4158
3202
|
) -> None:
|
|
4159
|
-
"""Pop-up a search over all menus in the current context
|
|
4160
|
-
|
|
4161
|
-
:type execution_context: int | str | None
|
|
4162
|
-
:type undo: bool | None
|
|
4163
|
-
"""
|
|
3203
|
+
"""Pop-up a search over all menus in the current context"""
|
|
4164
3204
|
|
|
4165
3205
|
def search_operator(
|
|
4166
3206
|
execution_context: int | str | None = None,
|
|
4167
3207
|
undo: bool | None = None,
|
|
4168
3208
|
/,
|
|
4169
3209
|
) -> None:
|
|
4170
|
-
"""Pop-up a search over all available operators in current context
|
|
4171
|
-
|
|
4172
|
-
:type execution_context: int | str | None
|
|
4173
|
-
:type undo: bool | None
|
|
4174
|
-
"""
|
|
3210
|
+
"""Pop-up a search over all available operators in current context"""
|
|
4175
3211
|
|
|
4176
3212
|
def search_single_menu(
|
|
4177
3213
|
execution_context: int | str | None = None,
|
|
@@ -4183,12 +3219,8 @@ def search_single_menu(
|
|
|
4183
3219
|
) -> None:
|
|
4184
3220
|
"""Pop-up a search for a menu in current context
|
|
4185
3221
|
|
|
4186
|
-
:type execution_context: int | str | None
|
|
4187
|
-
:type undo: bool | None
|
|
4188
3222
|
:param menu_idname: Menu Name, Menu to search in
|
|
4189
|
-
:type menu_idname: str
|
|
4190
3223
|
:param initial_query: Initial Query, Query to insert into the search box
|
|
4191
|
-
:type initial_query: str
|
|
4192
3224
|
"""
|
|
4193
3225
|
|
|
4194
3226
|
def set_stereo_3d(
|
|
@@ -4206,18 +3238,11 @@ def set_stereo_3d(
|
|
|
4206
3238
|
) -> None:
|
|
4207
3239
|
"""Toggle 3D stereo support for current window (or change the display mode)
|
|
4208
3240
|
|
|
4209
|
-
:type execution_context: int | str | None
|
|
4210
|
-
:type undo: bool | None
|
|
4211
3241
|
:param display_mode: Display Mode
|
|
4212
|
-
:type display_mode: bpy.stub_internal.rna_enums.Stereo3DDisplayItems | None
|
|
4213
3242
|
:param anaglyph_type: Anaglyph Type
|
|
4214
|
-
:type anaglyph_type: bpy.stub_internal.rna_enums.Stereo3DAnaglyphTypeItems | None
|
|
4215
3243
|
:param interlace_type: Interlace Type
|
|
4216
|
-
:type interlace_type: bpy.stub_internal.rna_enums.Stereo3DInterlaceTypeItems | None
|
|
4217
3244
|
:param use_interlace_swap: Swap Left/Right, Swap left and right stereo channels
|
|
4218
|
-
:type use_interlace_swap: bool | None
|
|
4219
3245
|
:param use_sidebyside_crosseyed: Cross-Eyed, Right eye should see left image and vice versa
|
|
4220
|
-
:type use_sidebyside_crosseyed: bool | None
|
|
4221
3246
|
"""
|
|
4222
3247
|
|
|
4223
3248
|
def set_working_color_space(
|
|
@@ -4230,12 +3255,8 @@ def set_working_color_space(
|
|
|
4230
3255
|
) -> None:
|
|
4231
3256
|
"""Change the working color space of all colors in this blend file
|
|
4232
3257
|
|
|
4233
|
-
:type execution_context: int | str | None
|
|
4234
|
-
:type undo: bool | None
|
|
4235
3258
|
:param convert_colors: Convert Colors in All Data-blocks, Change colors in all data-blocks to the new working space
|
|
4236
|
-
:type convert_colors: bool | None
|
|
4237
3259
|
:param working_space: Working Space, Color space to set
|
|
4238
|
-
:type working_space: str | None
|
|
4239
3260
|
"""
|
|
4240
3261
|
|
|
4241
3262
|
def splash(
|
|
@@ -4243,22 +3264,14 @@ def splash(
|
|
|
4243
3264
|
undo: bool | None = None,
|
|
4244
3265
|
/,
|
|
4245
3266
|
) -> None:
|
|
4246
|
-
"""Open the splash screen with release info
|
|
4247
|
-
|
|
4248
|
-
:type execution_context: int | str | None
|
|
4249
|
-
:type undo: bool | None
|
|
4250
|
-
"""
|
|
3267
|
+
"""Open the splash screen with release info"""
|
|
4251
3268
|
|
|
4252
3269
|
def splash_about(
|
|
4253
3270
|
execution_context: int | str | None = None,
|
|
4254
3271
|
undo: bool | None = None,
|
|
4255
3272
|
/,
|
|
4256
3273
|
) -> None:
|
|
4257
|
-
"""Open a window with information about Blender
|
|
4258
|
-
|
|
4259
|
-
:type execution_context: int | str | None
|
|
4260
|
-
:type undo: bool | None
|
|
4261
|
-
"""
|
|
3274
|
+
"""Open a window with information about Blender"""
|
|
4262
3275
|
|
|
4263
3276
|
def stl_export(
|
|
4264
3277
|
execution_context: int | str | None = None,
|
|
@@ -4306,46 +3319,25 @@ def stl_export(
|
|
|
4306
3319
|
) -> None:
|
|
4307
3320
|
"""Save the scene to an STL file
|
|
4308
3321
|
|
|
4309
|
-
:type execution_context: int | str | None
|
|
4310
|
-
:type undo: bool | None
|
|
4311
3322
|
:param filepath: File Path, Path to file
|
|
4312
|
-
:type filepath: str
|
|
4313
3323
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4314
|
-
:type check_existing: bool | None
|
|
4315
3324
|
:param filter_blender: Filter .blend files
|
|
4316
|
-
:type filter_blender: bool | None
|
|
4317
3325
|
:param filter_backup: Filter .blend files
|
|
4318
|
-
:type filter_backup: bool | None
|
|
4319
3326
|
:param filter_image: Filter image files
|
|
4320
|
-
:type filter_image: bool | None
|
|
4321
3327
|
:param filter_movie: Filter movie files
|
|
4322
|
-
:type filter_movie: bool | None
|
|
4323
3328
|
:param filter_python: Filter Python files
|
|
4324
|
-
:type filter_python: bool | None
|
|
4325
3329
|
:param filter_font: Filter font files
|
|
4326
|
-
:type filter_font: bool | None
|
|
4327
3330
|
:param filter_sound: Filter sound files
|
|
4328
|
-
:type filter_sound: bool | None
|
|
4329
3331
|
:param filter_text: Filter text files
|
|
4330
|
-
:type filter_text: bool | None
|
|
4331
3332
|
:param filter_archive: Filter archive files
|
|
4332
|
-
:type filter_archive: bool | None
|
|
4333
3333
|
:param filter_btx: Filter btx files
|
|
4334
|
-
:type filter_btx: bool | None
|
|
4335
3334
|
:param filter_alembic: Filter Alembic files
|
|
4336
|
-
:type filter_alembic: bool | None
|
|
4337
3335
|
:param filter_usd: Filter USD files
|
|
4338
|
-
:type filter_usd: bool | None
|
|
4339
3336
|
:param filter_obj: Filter OBJ files
|
|
4340
|
-
:type filter_obj: bool | None
|
|
4341
3337
|
:param filter_volume: Filter OpenVDB volume files
|
|
4342
|
-
:type filter_volume: bool | None
|
|
4343
3338
|
:param filter_folder: Filter folders
|
|
4344
|
-
:type filter_folder: bool | None
|
|
4345
3339
|
:param filter_blenlib: Filter Blender IDs
|
|
4346
|
-
:type filter_blenlib: bool | None
|
|
4347
3340
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4348
|
-
:type filemode: int | None
|
|
4349
3341
|
:param display_type: Display Type
|
|
4350
3342
|
|
|
4351
3343
|
DEFAULT
|
|
@@ -4359,21 +3351,13 @@ def stl_export(
|
|
|
4359
3351
|
|
|
4360
3352
|
THUMBNAIL
|
|
4361
3353
|
Thumbnails -- Display files as thumbnails.
|
|
4362
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4363
3354
|
:param sort_method: File sorting mode
|
|
4364
|
-
:type sort_method: str | None
|
|
4365
3355
|
:param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
|
|
4366
|
-
:type ascii_format: bool | None
|
|
4367
3356
|
:param use_batch: Batch Export, Export each object to a separate file
|
|
4368
|
-
:type use_batch: bool | None
|
|
4369
3357
|
:param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
|
|
4370
|
-
:type export_selected_objects: bool | None
|
|
4371
3358
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
4372
|
-
:type collection: str
|
|
4373
3359
|
:param global_scale: Scale
|
|
4374
|
-
:type global_scale: float | None
|
|
4375
3360
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to exported data
|
|
4376
|
-
:type use_scene_unit: bool | None
|
|
4377
3361
|
:param forward_axis: Forward Axis
|
|
4378
3362
|
|
|
4379
3363
|
X
|
|
@@ -4393,7 +3377,6 @@ def stl_export(
|
|
|
4393
3377
|
|
|
4394
3378
|
NEGATIVE_Z
|
|
4395
3379
|
-Z -- Negative Z axis.
|
|
4396
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4397
3380
|
:param up_axis: Up Axis
|
|
4398
3381
|
|
|
4399
3382
|
X
|
|
@@ -4413,11 +3396,8 @@ def stl_export(
|
|
|
4413
3396
|
|
|
4414
3397
|
NEGATIVE_Z
|
|
4415
3398
|
-Z -- Negative Z axis.
|
|
4416
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4417
3399
|
:param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
|
|
4418
|
-
:type apply_modifiers: bool | None
|
|
4419
3400
|
:param filter_glob: Extension Filter
|
|
4420
|
-
:type filter_glob: str
|
|
4421
3401
|
"""
|
|
4422
3402
|
|
|
4423
3403
|
def stl_import(
|
|
@@ -4466,50 +3446,27 @@ def stl_import(
|
|
|
4466
3446
|
) -> None:
|
|
4467
3447
|
"""Import an STL file as an object
|
|
4468
3448
|
|
|
4469
|
-
:type execution_context: int | str | None
|
|
4470
|
-
:type undo: bool | None
|
|
4471
3449
|
:param filepath: File Path, Path to file
|
|
4472
|
-
:type filepath: str
|
|
4473
3450
|
:param directory: Directory, Directory of the file
|
|
4474
|
-
:type directory: str
|
|
4475
3451
|
:param files: Files
|
|
4476
|
-
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
4477
3452
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4478
|
-
:type check_existing: bool | None
|
|
4479
3453
|
:param filter_blender: Filter .blend files
|
|
4480
|
-
:type filter_blender: bool | None
|
|
4481
3454
|
:param filter_backup: Filter .blend files
|
|
4482
|
-
:type filter_backup: bool | None
|
|
4483
3455
|
:param filter_image: Filter image files
|
|
4484
|
-
:type filter_image: bool | None
|
|
4485
3456
|
:param filter_movie: Filter movie files
|
|
4486
|
-
:type filter_movie: bool | None
|
|
4487
3457
|
:param filter_python: Filter Python files
|
|
4488
|
-
:type filter_python: bool | None
|
|
4489
3458
|
:param filter_font: Filter font files
|
|
4490
|
-
:type filter_font: bool | None
|
|
4491
3459
|
:param filter_sound: Filter sound files
|
|
4492
|
-
:type filter_sound: bool | None
|
|
4493
3460
|
:param filter_text: Filter text files
|
|
4494
|
-
:type filter_text: bool | None
|
|
4495
3461
|
:param filter_archive: Filter archive files
|
|
4496
|
-
:type filter_archive: bool | None
|
|
4497
3462
|
:param filter_btx: Filter btx files
|
|
4498
|
-
:type filter_btx: bool | None
|
|
4499
3463
|
:param filter_alembic: Filter Alembic files
|
|
4500
|
-
:type filter_alembic: bool | None
|
|
4501
3464
|
:param filter_usd: Filter USD files
|
|
4502
|
-
:type filter_usd: bool | None
|
|
4503
3465
|
:param filter_obj: Filter OBJ files
|
|
4504
|
-
:type filter_obj: bool | None
|
|
4505
3466
|
:param filter_volume: Filter OpenVDB volume files
|
|
4506
|
-
:type filter_volume: bool | None
|
|
4507
3467
|
:param filter_folder: Filter folders
|
|
4508
|
-
:type filter_folder: bool | None
|
|
4509
3468
|
:param filter_blenlib: Filter Blender IDs
|
|
4510
|
-
:type filter_blenlib: bool | None
|
|
4511
3469
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4512
|
-
:type filemode: int | None
|
|
4513
3470
|
:param display_type: Display Type
|
|
4514
3471
|
|
|
4515
3472
|
DEFAULT
|
|
@@ -4523,15 +3480,10 @@ def stl_import(
|
|
|
4523
3480
|
|
|
4524
3481
|
THUMBNAIL
|
|
4525
3482
|
Thumbnails -- Display files as thumbnails.
|
|
4526
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4527
3483
|
:param sort_method: File sorting mode
|
|
4528
|
-
:type sort_method: str | None
|
|
4529
3484
|
:param global_scale: Scale
|
|
4530
|
-
:type global_scale: float | None
|
|
4531
3485
|
:param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
|
|
4532
|
-
:type use_scene_unit: bool | None
|
|
4533
3486
|
:param use_facet_normal: Facet Normals, Use (import) facet normals (note that this will still give flat shading)
|
|
4534
|
-
:type use_facet_normal: bool | None
|
|
4535
3487
|
:param forward_axis: Forward Axis
|
|
4536
3488
|
|
|
4537
3489
|
X
|
|
@@ -4551,7 +3503,6 @@ def stl_import(
|
|
|
4551
3503
|
|
|
4552
3504
|
NEGATIVE_Z
|
|
4553
3505
|
-Z -- Negative Z axis.
|
|
4554
|
-
:type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4555
3506
|
:param up_axis: Up Axis
|
|
4556
3507
|
|
|
4557
3508
|
X
|
|
@@ -4571,11 +3522,8 @@ def stl_import(
|
|
|
4571
3522
|
|
|
4572
3523
|
NEGATIVE_Z
|
|
4573
3524
|
-Z -- Negative Z axis.
|
|
4574
|
-
:type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
4575
3525
|
:param use_mesh_validate: Validate Mesh, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
4576
|
-
:type use_mesh_validate: bool | None
|
|
4577
3526
|
:param filter_glob: Extension Filter
|
|
4578
|
-
:type filter_glob: str
|
|
4579
3527
|
"""
|
|
4580
3528
|
|
|
4581
3529
|
def sysinfo(
|
|
@@ -4587,10 +3535,7 @@ def sysinfo(
|
|
|
4587
3535
|
) -> None:
|
|
4588
3536
|
"""Generate system information, saved into a text file
|
|
4589
3537
|
|
|
4590
|
-
:type execution_context: int | str | None
|
|
4591
|
-
:type undo: bool | None
|
|
4592
3538
|
:param filepath: filepath
|
|
4593
|
-
:type filepath: str
|
|
4594
3539
|
"""
|
|
4595
3540
|
|
|
4596
3541
|
def tool_set_by_brush_type(
|
|
@@ -4624,12 +3569,8 @@ def tool_set_by_brush_type(
|
|
|
4624
3569
|
) -> None:
|
|
4625
3570
|
"""Look up the most appropriate tool for the given brush type and activate that
|
|
4626
3571
|
|
|
4627
|
-
:type execution_context: int | str | None
|
|
4628
|
-
:type undo: bool | None
|
|
4629
3572
|
:param brush_type: Brush Type, Brush type identifier for which the most appropriate tool will be looked up
|
|
4630
|
-
:type brush_type: str
|
|
4631
3573
|
:param space_type: Type
|
|
4632
|
-
: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
|
|
4633
3574
|
"""
|
|
4634
3575
|
|
|
4635
3576
|
def tool_set_by_id(
|
|
@@ -4665,16 +3606,10 @@ def tool_set_by_id(
|
|
|
4665
3606
|
) -> None:
|
|
4666
3607
|
"""Set the tool by name (for key-maps)
|
|
4667
3608
|
|
|
4668
|
-
:type execution_context: int | str | None
|
|
4669
|
-
:type undo: bool | None
|
|
4670
3609
|
:param name: Identifier, Identifier of the tool
|
|
4671
|
-
:type name: str
|
|
4672
3610
|
:param cycle: Cycle, Cycle through tools in this group
|
|
4673
|
-
:type cycle: bool | None
|
|
4674
3611
|
:param as_fallback: Set Fallback, Set the fallback tool instead of the primary tool
|
|
4675
|
-
:type as_fallback: bool | None
|
|
4676
3612
|
:param space_type: Type
|
|
4677
|
-
: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
|
|
4678
3613
|
"""
|
|
4679
3614
|
|
|
4680
3615
|
def tool_set_by_index(
|
|
@@ -4711,18 +3646,11 @@ def tool_set_by_index(
|
|
|
4711
3646
|
) -> None:
|
|
4712
3647
|
"""Set the tool by index (for key-maps)
|
|
4713
3648
|
|
|
4714
|
-
:type execution_context: int | str | None
|
|
4715
|
-
:type undo: bool | None
|
|
4716
3649
|
:param index: Index in Toolbar
|
|
4717
|
-
:type index: int | None
|
|
4718
3650
|
:param cycle: Cycle, Cycle through tools in this group
|
|
4719
|
-
:type cycle: bool | None
|
|
4720
3651
|
:param expand: expand, Include tool subgroups
|
|
4721
|
-
:type expand: bool | None
|
|
4722
3652
|
:param as_fallback: Set Fallback, Set the fallback tool instead of the primary
|
|
4723
|
-
:type as_fallback: bool | None
|
|
4724
3653
|
:param space_type: Type
|
|
4725
|
-
: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
|
|
4726
3654
|
"""
|
|
4727
3655
|
|
|
4728
3656
|
def toolbar(
|
|
@@ -4730,33 +3658,21 @@ def toolbar(
|
|
|
4730
3658
|
undo: bool | None = None,
|
|
4731
3659
|
/,
|
|
4732
3660
|
) -> None:
|
|
4733
|
-
"""Undocumented, consider contributing.
|
|
4734
|
-
|
|
4735
|
-
:type execution_context: int | str | None
|
|
4736
|
-
:type undo: bool | None
|
|
4737
|
-
"""
|
|
3661
|
+
"""Undocumented, consider contributing."""
|
|
4738
3662
|
|
|
4739
3663
|
def toolbar_fallback_pie(
|
|
4740
3664
|
execution_context: int | str | None = None,
|
|
4741
3665
|
undo: bool | None = None,
|
|
4742
3666
|
/,
|
|
4743
3667
|
) -> None:
|
|
4744
|
-
"""Undocumented, consider contributing.
|
|
4745
|
-
|
|
4746
|
-
:type execution_context: int | str | None
|
|
4747
|
-
:type undo: bool | None
|
|
4748
|
-
"""
|
|
3668
|
+
"""Undocumented, consider contributing."""
|
|
4749
3669
|
|
|
4750
3670
|
def toolbar_prompt(
|
|
4751
3671
|
execution_context: int | str | None = None,
|
|
4752
3672
|
undo: bool | None = None,
|
|
4753
3673
|
/,
|
|
4754
3674
|
) -> None:
|
|
4755
|
-
"""Leader key like functionality for accessing tools
|
|
4756
|
-
|
|
4757
|
-
:type execution_context: int | str | None
|
|
4758
|
-
:type undo: bool | None
|
|
4759
|
-
"""
|
|
3675
|
+
"""Leader key like functionality for accessing tools"""
|
|
4760
3676
|
|
|
4761
3677
|
def url_open(
|
|
4762
3678
|
execution_context: int | str | None = None,
|
|
@@ -4767,10 +3683,7 @@ def url_open(
|
|
|
4767
3683
|
) -> None:
|
|
4768
3684
|
"""Open a website in the web browser
|
|
4769
3685
|
|
|
4770
|
-
:type execution_context: int | str | None
|
|
4771
|
-
:type undo: bool | None
|
|
4772
3686
|
:param url: URL, URL to open
|
|
4773
|
-
:type url: str
|
|
4774
3687
|
"""
|
|
4775
3688
|
|
|
4776
3689
|
def url_open_preset(
|
|
@@ -4782,10 +3695,7 @@ def url_open_preset(
|
|
|
4782
3695
|
) -> None:
|
|
4783
3696
|
"""Open a preset website in the web browser
|
|
4784
3697
|
|
|
4785
|
-
:type execution_context: int | str | None
|
|
4786
|
-
:type undo: bool | None
|
|
4787
3698
|
:param type: Site
|
|
4788
|
-
:type type: str | None
|
|
4789
3699
|
"""
|
|
4790
3700
|
|
|
4791
3701
|
def usd_export(
|
|
@@ -4889,46 +3799,25 @@ def usd_export(
|
|
|
4889
3799
|
) -> None:
|
|
4890
3800
|
"""Export current scene in a USD archive
|
|
4891
3801
|
|
|
4892
|
-
:type execution_context: int | str | None
|
|
4893
|
-
:type undo: bool | None
|
|
4894
3802
|
:param filepath: File Path, Path to file
|
|
4895
|
-
:type filepath: str
|
|
4896
3803
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
4897
|
-
:type check_existing: bool | None
|
|
4898
3804
|
:param filter_blender: Filter .blend files
|
|
4899
|
-
:type filter_blender: bool | None
|
|
4900
3805
|
:param filter_backup: Filter .blend files
|
|
4901
|
-
:type filter_backup: bool | None
|
|
4902
3806
|
:param filter_image: Filter image files
|
|
4903
|
-
:type filter_image: bool | None
|
|
4904
3807
|
:param filter_movie: Filter movie files
|
|
4905
|
-
:type filter_movie: bool | None
|
|
4906
3808
|
:param filter_python: Filter Python files
|
|
4907
|
-
:type filter_python: bool | None
|
|
4908
3809
|
:param filter_font: Filter font files
|
|
4909
|
-
:type filter_font: bool | None
|
|
4910
3810
|
:param filter_sound: Filter sound files
|
|
4911
|
-
:type filter_sound: bool | None
|
|
4912
3811
|
:param filter_text: Filter text files
|
|
4913
|
-
:type filter_text: bool | None
|
|
4914
3812
|
:param filter_archive: Filter archive files
|
|
4915
|
-
:type filter_archive: bool | None
|
|
4916
3813
|
:param filter_btx: Filter btx files
|
|
4917
|
-
:type filter_btx: bool | None
|
|
4918
3814
|
:param filter_alembic: Filter Alembic files
|
|
4919
|
-
:type filter_alembic: bool | None
|
|
4920
3815
|
:param filter_usd: Filter USD files
|
|
4921
|
-
:type filter_usd: bool | None
|
|
4922
3816
|
:param filter_obj: Filter OBJ files
|
|
4923
|
-
:type filter_obj: bool | None
|
|
4924
3817
|
:param filter_volume: Filter OpenVDB volume files
|
|
4925
|
-
:type filter_volume: bool | None
|
|
4926
3818
|
:param filter_folder: Filter folders
|
|
4927
|
-
:type filter_folder: bool | None
|
|
4928
3819
|
:param filter_blenlib: Filter Blender IDs
|
|
4929
|
-
:type filter_blenlib: bool | None
|
|
4930
3820
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
4931
|
-
:type filemode: int | None
|
|
4932
3821
|
:param display_type: Display Type
|
|
4933
3822
|
|
|
4934
3823
|
DEFAULT
|
|
@@ -4942,28 +3831,16 @@ def usd_export(
|
|
|
4942
3831
|
|
|
4943
3832
|
THUMBNAIL
|
|
4944
3833
|
Thumbnails -- Display files as thumbnails.
|
|
4945
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
4946
3834
|
:param sort_method: File sorting mode
|
|
4947
|
-
:type sort_method: str | None
|
|
4948
|
-
:type filter_glob: str
|
|
4949
3835
|
:param selected_objects_only: Selection Only, Only export selected objects. Unselected parents of selected objects are exported as empty transform
|
|
4950
|
-
:type selected_objects_only: bool | None
|
|
4951
3836
|
:param collection: Collection
|
|
4952
|
-
:type collection: str
|
|
4953
3837
|
:param export_animation: Animation, Export all frames in the render frame range, rather than only the current frame
|
|
4954
|
-
:type export_animation: bool | None
|
|
4955
3838
|
:param export_hair: Hair, Export hair particle systems as USD curves
|
|
4956
|
-
:type export_hair: bool | None
|
|
4957
3839
|
:param export_uvmaps: UV Maps, Include all mesh UV maps in the export
|
|
4958
|
-
:type export_uvmaps: bool | None
|
|
4959
3840
|
:param rename_uvmaps: Rename UV Maps, Rename active render UV map to "st" to match USD conventions
|
|
4960
|
-
:type rename_uvmaps: bool | None
|
|
4961
3841
|
:param export_mesh_colors: Color Attributes, Include mesh color attributes in the export
|
|
4962
|
-
:type export_mesh_colors: bool | None
|
|
4963
3842
|
:param export_normals: Normals, Include normals of exported meshes in the export
|
|
4964
|
-
:type export_normals: bool | None
|
|
4965
3843
|
:param export_materials: Materials, Export viewport settings of materials as USD preview materials, and export material assignments as geometry subsets
|
|
4966
|
-
:type export_materials: bool | None
|
|
4967
3844
|
:param export_subdivision: Subdivision, Choose how subdivision modifiers will be mapped to the USD subdivision scheme during export
|
|
4968
3845
|
|
|
4969
3846
|
IGNORE
|
|
@@ -4974,15 +3851,10 @@ def usd_export(
|
|
|
4974
3851
|
|
|
4975
3852
|
BEST_MATCH
|
|
4976
3853
|
Best Match -- Scheme = Catmull-Clark, when possible. Reverts to exporting the subdivided mesh for the Simple subdivision type.
|
|
4977
|
-
:type export_subdivision: typing.Literal['IGNORE','TESSELLATE','BEST_MATCH'] | None
|
|
4978
3854
|
:param export_armatures: Armatures, Export armatures and meshes with armature modifiers as USD skeletons and skinned meshes
|
|
4979
|
-
:type export_armatures: bool | None
|
|
4980
3855
|
:param only_deform_bones: Only Deform Bones, Only export deform bones and their parents
|
|
4981
|
-
:type only_deform_bones: bool | None
|
|
4982
3856
|
:param export_shapekeys: Shape Keys, Export shape keys as USD blend shapes
|
|
4983
|
-
:type export_shapekeys: bool | None
|
|
4984
3857
|
:param use_instancing: Instancing, Export instanced objects as references in USD rather than real objects
|
|
4985
|
-
:type use_instancing: bool | None
|
|
4986
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
|
|
4987
3859
|
|
|
4988
3860
|
RENDER
|
|
@@ -4990,13 +3862,9 @@ def usd_export(
|
|
|
4990
3862
|
|
|
4991
3863
|
VIEWPORT
|
|
4992
3864
|
Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
|
|
4993
|
-
:type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
|
|
4994
3865
|
:param generate_preview_surface: USD Preview Surface Network, Generate an approximate USD Preview Surface shader representation of a Principled BSDF node network
|
|
4995
|
-
:type generate_preview_surface: bool | None
|
|
4996
3866
|
:param generate_materialx_network: MaterialX Network, Generate a MaterialX network representation of the materials
|
|
4997
|
-
:type generate_materialx_network: bool | None
|
|
4998
3867
|
:param convert_orientation: Convert Orientation, Convert orientation axis to a different convention to match other applications
|
|
4999
|
-
:type convert_orientation: bool | None
|
|
5000
3868
|
:param export_global_forward_selection: Forward Axis
|
|
5001
3869
|
|
|
5002
3870
|
X
|
|
@@ -5016,7 +3884,6 @@ def usd_export(
|
|
|
5016
3884
|
|
|
5017
3885
|
NEGATIVE_Z
|
|
5018
3886
|
-Z -- Negative Z axis.
|
|
5019
|
-
:type export_global_forward_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
5020
3887
|
:param export_global_up_selection: Up Axis
|
|
5021
3888
|
|
|
5022
3889
|
X
|
|
@@ -5036,7 +3903,6 @@ def usd_export(
|
|
|
5036
3903
|
|
|
5037
3904
|
NEGATIVE_Z
|
|
5038
3905
|
-Z -- Negative Z axis.
|
|
5039
|
-
:type export_global_up_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
|
|
5040
3906
|
:param export_textures_mode: Export Textures, Texture export method
|
|
5041
3907
|
|
|
5042
3908
|
KEEP
|
|
@@ -5048,11 +3914,8 @@ def usd_export(
|
|
|
5048
3914
|
|
|
5049
3915
|
NEW
|
|
5050
3916
|
New Path -- Export textures to a textures folder next to the USD file.
|
|
5051
|
-
:type export_textures_mode: typing.Literal['KEEP','PRESERVE','NEW'] | None
|
|
5052
3917
|
:param overwrite_textures: Overwrite Textures, Overwrite existing files when exporting textures
|
|
5053
|
-
:type overwrite_textures: bool | None
|
|
5054
3918
|
:param relative_paths: Relative Paths, Use relative paths to reference external files (i.e. textures, volumes) in USD, otherwise use absolute paths
|
|
5055
|
-
:type relative_paths: bool | None
|
|
5056
3919
|
:param xform_op_mode: Xform Ops, The type of transform operators to write
|
|
5057
3920
|
|
|
5058
3921
|
TRS
|
|
@@ -5063,41 +3926,23 @@ def usd_export(
|
|
|
5063
3926
|
|
|
5064
3927
|
MAT
|
|
5065
3928
|
Matrix -- Export matrix operator.
|
|
5066
|
-
:type xform_op_mode: typing.Literal['TRS','TOS','MAT'] | None
|
|
5067
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
|
|
5068
|
-
:type root_prim_path: str
|
|
5069
3930
|
:param export_custom_properties: Custom Properties, Export custom properties as USD attributes
|
|
5070
|
-
:type export_custom_properties: bool | None
|
|
5071
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
|
|
5072
|
-
:type custom_properties_namespace: str
|
|
5073
3932
|
:param accessibility_label: Label, Set the accessibility label for the exported stages default prim
|
|
5074
|
-
:type accessibility_label: str
|
|
5075
3933
|
:param accessibility_description: Description, Set the accessibility description for the exported stages default prim
|
|
5076
|
-
:type accessibility_description: str
|
|
5077
3934
|
:param author_blender_name: Blender Names, Author USD custom attributes containing the original Blender object and object data names
|
|
5078
|
-
:type author_blender_name: bool | None
|
|
5079
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
|
|
5080
|
-
:type convert_world_material: bool | None
|
|
5081
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)
|
|
5082
|
-
:type allow_unicode: bool | None
|
|
5083
3937
|
:param export_meshes: Meshes, Export all meshes
|
|
5084
|
-
:type export_meshes: bool | None
|
|
5085
3938
|
:param export_lights: Lights, Export all lights
|
|
5086
|
-
:type export_lights: bool | None
|
|
5087
3939
|
:param export_cameras: Cameras, Export all cameras
|
|
5088
|
-
:type export_cameras: bool | None
|
|
5089
3940
|
:param export_curves: Curves, Export all curves
|
|
5090
|
-
:type export_curves: bool | None
|
|
5091
3941
|
:param export_points: Point Clouds, Export all point clouds
|
|
5092
|
-
:type export_points: bool | None
|
|
5093
3942
|
:param export_volumes: Volumes, Export all volumes
|
|
5094
|
-
:type export_volumes: bool | None
|
|
5095
3943
|
:param triangulate_meshes: Triangulate Meshes, Triangulate meshes during export
|
|
5096
|
-
:type triangulate_meshes: bool | None
|
|
5097
3944
|
:param quad_method: Quad Method, Method for splitting the quads into triangles
|
|
5098
|
-
:type quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems | None
|
|
5099
3945
|
:param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
|
|
5100
|
-
:type ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems | None
|
|
5101
3946
|
:param usdz_downscale_size: USDZ Texture Downsampling, Choose a maximum size for all exported textures
|
|
5102
3947
|
|
|
5103
3948
|
KEEP
|
|
@@ -5120,11 +3965,8 @@ def usd_export(
|
|
|
5120
3965
|
|
|
5121
3966
|
CUSTOM
|
|
5122
3967
|
Custom -- Specify a custom size.
|
|
5123
|
-
:type usdz_downscale_size: typing.Literal['KEEP','256','512','1024','2048','4096','CUSTOM'] | None
|
|
5124
3968
|
:param usdz_downscale_custom_size: USDZ Custom Downscale Size, Custom size for downscaling exported textures
|
|
5125
|
-
:type usdz_downscale_custom_size: int | None
|
|
5126
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.
|
|
5127
|
-
:type merge_parent_xform: bool | None
|
|
5128
3970
|
:param convert_scene_units: Units, Set the USD Stage meters per unit to the chosen measurement, or a custom value
|
|
5129
3971
|
|
|
5130
3972
|
METERS
|
|
@@ -5150,9 +3992,7 @@ def usd_export(
|
|
|
5150
3992
|
|
|
5151
3993
|
CUSTOM
|
|
5152
3994
|
Custom -- Specify a custom scene meters per unit value.
|
|
5153
|
-
:type convert_scene_units: typing.Literal['METERS','KILOMETERS','CENTIMETERS','MILLIMETERS','INCHES','FEET','YARDS','CUSTOM'] | None
|
|
5154
3995
|
:param meters_per_unit: Meters Per Unit, Custom value for meters per unit in the USD Stage
|
|
5155
|
-
:type meters_per_unit: float | None
|
|
5156
3996
|
"""
|
|
5157
3997
|
|
|
5158
3998
|
def usd_import(
|
|
@@ -5231,48 +4071,26 @@ def usd_import(
|
|
|
5231
4071
|
) -> None:
|
|
5232
4072
|
"""Import USD stage into current scene
|
|
5233
4073
|
|
|
5234
|
-
:type execution_context: int | str | None
|
|
5235
|
-
:type undo: bool | None
|
|
5236
4074
|
:param filepath: File Path, Path to file
|
|
5237
|
-
:type filepath: str
|
|
5238
4075
|
:param check_existing: Check Existing, Check and warn on overwriting existing files
|
|
5239
|
-
:type check_existing: bool | None
|
|
5240
4076
|
:param filter_blender: Filter .blend files
|
|
5241
|
-
:type filter_blender: bool | None
|
|
5242
4077
|
:param filter_backup: Filter .blend files
|
|
5243
|
-
:type filter_backup: bool | None
|
|
5244
4078
|
:param filter_image: Filter image files
|
|
5245
|
-
:type filter_image: bool | None
|
|
5246
4079
|
:param filter_movie: Filter movie files
|
|
5247
|
-
:type filter_movie: bool | None
|
|
5248
4080
|
:param filter_python: Filter Python files
|
|
5249
|
-
:type filter_python: bool | None
|
|
5250
4081
|
:param filter_font: Filter font files
|
|
5251
|
-
:type filter_font: bool | None
|
|
5252
4082
|
:param filter_sound: Filter sound files
|
|
5253
|
-
:type filter_sound: bool | None
|
|
5254
4083
|
:param filter_text: Filter text files
|
|
5255
|
-
:type filter_text: bool | None
|
|
5256
4084
|
:param filter_archive: Filter archive files
|
|
5257
|
-
:type filter_archive: bool | None
|
|
5258
4085
|
:param filter_btx: Filter btx files
|
|
5259
|
-
:type filter_btx: bool | None
|
|
5260
4086
|
:param filter_alembic: Filter Alembic files
|
|
5261
|
-
:type filter_alembic: bool | None
|
|
5262
4087
|
:param filter_usd: Filter USD files
|
|
5263
|
-
:type filter_usd: bool | None
|
|
5264
4088
|
:param filter_obj: Filter OBJ files
|
|
5265
|
-
:type filter_obj: bool | None
|
|
5266
4089
|
:param filter_volume: Filter OpenVDB volume files
|
|
5267
|
-
:type filter_volume: bool | None
|
|
5268
4090
|
:param filter_folder: Filter folders
|
|
5269
|
-
:type filter_folder: bool | None
|
|
5270
4091
|
:param filter_blenlib: Filter Blender IDs
|
|
5271
|
-
:type filter_blenlib: bool | None
|
|
5272
4092
|
:param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
|
|
5273
|
-
:type filemode: int | None
|
|
5274
4093
|
:param relative_path: Relative Path, Select the file relative to the blend file
|
|
5275
|
-
:type relative_path: bool | None
|
|
5276
4094
|
:param display_type: Display Type
|
|
5277
4095
|
|
|
5278
4096
|
DEFAULT
|
|
@@ -5286,64 +4104,34 @@ def usd_import(
|
|
|
5286
4104
|
|
|
5287
4105
|
THUMBNAIL
|
|
5288
4106
|
Thumbnails -- Display files as thumbnails.
|
|
5289
|
-
:type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
|
|
5290
4107
|
:param sort_method: File sorting mode
|
|
5291
|
-
:type sort_method: str | None
|
|
5292
|
-
:type filter_glob: str
|
|
5293
4108
|
:param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
|
|
5294
|
-
:type scale: float | None
|
|
5295
4109
|
:param set_frame_range: Set Frame Range, Update the scenes start and end frame to match those of the USD archive
|
|
5296
|
-
:type set_frame_range: bool | None
|
|
5297
4110
|
:param import_cameras: Cameras
|
|
5298
|
-
:type import_cameras: bool | None
|
|
5299
4111
|
:param import_curves: Curves
|
|
5300
|
-
:type import_curves: bool | None
|
|
5301
4112
|
:param import_lights: Lights
|
|
5302
|
-
:type import_lights: bool | None
|
|
5303
4113
|
:param import_materials: Materials
|
|
5304
|
-
:type import_materials: bool | None
|
|
5305
4114
|
:param import_meshes: Meshes
|
|
5306
|
-
:type import_meshes: bool | None
|
|
5307
4115
|
:param import_volumes: Volumes
|
|
5308
|
-
:type import_volumes: bool | None
|
|
5309
4116
|
:param import_shapes: USD Shapes
|
|
5310
|
-
:type import_shapes: bool | None
|
|
5311
4117
|
:param import_skeletons: Armatures
|
|
5312
|
-
:type import_skeletons: bool | None
|
|
5313
4118
|
:param import_blendshapes: Shape Keys
|
|
5314
|
-
:type import_blendshapes: bool | None
|
|
5315
4119
|
:param import_points: Point Clouds
|
|
5316
|
-
:type import_points: bool | None
|
|
5317
4120
|
:param import_subdivision: Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute
|
|
5318
|
-
:type import_subdivision: bool | None
|
|
5319
4121
|
:param support_scene_instancing: Scene Instancing, Import USD scene graph instances as collection instances
|
|
5320
|
-
:type support_scene_instancing: bool | None
|
|
5321
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
|
|
5322
|
-
:type import_visible_only: bool | None
|
|
5323
4123
|
:param create_collection: Create Collection, Add all imported objects to a new collection
|
|
5324
|
-
:type create_collection: bool | None
|
|
5325
4124
|
:param read_mesh_uvs: UV Coordinates, Read mesh UV coordinates
|
|
5326
|
-
:type read_mesh_uvs: bool | None
|
|
5327
4125
|
:param read_mesh_colors: Color Attributes, Read mesh color attributes
|
|
5328
|
-
:type read_mesh_colors: bool | None
|
|
5329
4126
|
:param read_mesh_attributes: Mesh Attributes, Read USD Primvars as mesh attributes
|
|
5330
|
-
:type read_mesh_attributes: bool | None
|
|
5331
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
|
|
5332
|
-
:type prim_path_mask: str
|
|
5333
4128
|
:param import_guide: Guide, Import guide geometry
|
|
5334
|
-
:type import_guide: bool | None
|
|
5335
4129
|
:param import_proxy: Proxy, Import proxy geometry
|
|
5336
|
-
:type import_proxy: bool | None
|
|
5337
4130
|
:param import_render: Render, Import final render geometry
|
|
5338
|
-
:type import_render: bool | None
|
|
5339
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
|
|
5340
|
-
:type import_all_materials: bool | None
|
|
5341
4132
|
:param import_usd_preview: Import USD Preview, Convert UsdPreviewSurface shaders to Principled BSDF shader networks
|
|
5342
|
-
:type import_usd_preview: bool | None
|
|
5343
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
|
|
5344
|
-
:type set_material_blend: bool | None
|
|
5345
4134
|
:param light_intensity_scale: Light Intensity Scale, Scale for the intensity of imported lights
|
|
5346
|
-
:type light_intensity_scale: float | None
|
|
5347
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
|
|
5348
4136
|
|
|
5349
4137
|
MTL_ALL_PURPOSE
|
|
@@ -5354,7 +4142,6 @@ def usd_import(
|
|
|
5354
4142
|
|
|
5355
4143
|
MTL_FULL
|
|
5356
4144
|
Full -- Attempt to import full materials. Load allPurpose or preview materials, in that order, as a fallback.
|
|
5357
|
-
:type mtl_purpose: typing.Literal['MTL_ALL_PURPOSE','MTL_PREVIEW','MTL_FULL'] | None
|
|
5358
4145
|
:param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
|
|
5359
4146
|
|
|
5360
4147
|
MAKE_UNIQUE
|
|
@@ -5362,7 +4149,6 @@ def usd_import(
|
|
|
5362
4149
|
|
|
5363
4150
|
REFERENCE_EXISTING
|
|
5364
4151
|
Reference Existing -- If a material with the same name already exists, reference that instead of importing.
|
|
5365
|
-
:type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
|
|
5366
4152
|
:param import_textures_mode: Import Textures, Behavior when importing textures from a USDZ archive
|
|
5367
4153
|
|
|
5368
4154
|
IMPORT_NONE
|
|
@@ -5373,9 +4159,7 @@ def usd_import(
|
|
|
5373
4159
|
|
|
5374
4160
|
IMPORT_COPY
|
|
5375
4161
|
Copy -- Copy files to textures directory.
|
|
5376
|
-
:type import_textures_mode: typing.Literal['IMPORT_NONE','IMPORT_PACK','IMPORT_COPY'] | None
|
|
5377
4162
|
:param import_textures_dir: Textures Directory, Path to the directory where imported textures will be copied
|
|
5378
|
-
:type import_textures_dir: str
|
|
5379
4163
|
:param tex_name_collision_mode: File Name Collision, Behavior when the name of an imported texture file conflicts with an existing file
|
|
5380
4164
|
|
|
5381
4165
|
USE_EXISTING
|
|
@@ -5383,7 +4167,6 @@ def usd_import(
|
|
|
5383
4167
|
|
|
5384
4168
|
OVERWRITE
|
|
5385
4169
|
Overwrite -- Overwrite existing files.
|
|
5386
|
-
:type tex_name_collision_mode: typing.Literal['USE_EXISTING','OVERWRITE'] | None
|
|
5387
4170
|
:param property_import_mode: Custom Properties, Behavior when importing USD attributes as Blender custom properties
|
|
5388
4171
|
|
|
5389
4172
|
NONE
|
|
@@ -5394,17 +4177,11 @@ def usd_import(
|
|
|
5394
4177
|
|
|
5395
4178
|
ALL
|
|
5396
4179
|
All Custom -- Import all USD custom attributes as Blender custom properties. Namespaces will be retained in the property names.
|
|
5397
|
-
:type property_import_mode: typing.Literal['NONE','USER','ALL'] | None
|
|
5398
4180
|
:param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
|
|
5399
|
-
:type validate_meshes: bool | None
|
|
5400
4181
|
:param create_world_material: World Dome Light, Convert the first discovered USD dome light to a world background shader
|
|
5401
|
-
:type create_world_material: bool | None
|
|
5402
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
|
|
5403
|
-
:type import_defined_only: bool | None
|
|
5404
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
|
|
5405
|
-
:type merge_parent_xform: bool | None
|
|
5406
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
|
|
5407
|
-
:type apply_unit_conversion_scale: bool | None
|
|
5408
4185
|
"""
|
|
5409
4186
|
|
|
5410
4187
|
def window_close(
|
|
@@ -5412,44 +4189,28 @@ def window_close(
|
|
|
5412
4189
|
undo: bool | None = None,
|
|
5413
4190
|
/,
|
|
5414
4191
|
) -> None:
|
|
5415
|
-
"""Close the current window
|
|
5416
|
-
|
|
5417
|
-
:type execution_context: int | str | None
|
|
5418
|
-
:type undo: bool | None
|
|
5419
|
-
"""
|
|
4192
|
+
"""Close the current window"""
|
|
5420
4193
|
|
|
5421
4194
|
def window_fullscreen_toggle(
|
|
5422
4195
|
execution_context: int | str | None = None,
|
|
5423
4196
|
undo: bool | None = None,
|
|
5424
4197
|
/,
|
|
5425
4198
|
) -> None:
|
|
5426
|
-
"""Toggle the current window full-screen
|
|
5427
|
-
|
|
5428
|
-
:type execution_context: int | str | None
|
|
5429
|
-
:type undo: bool | None
|
|
5430
|
-
"""
|
|
4199
|
+
"""Toggle the current window full-screen"""
|
|
5431
4200
|
|
|
5432
4201
|
def window_new(
|
|
5433
4202
|
execution_context: int | str | None = None,
|
|
5434
4203
|
undo: bool | None = None,
|
|
5435
4204
|
/,
|
|
5436
4205
|
) -> None:
|
|
5437
|
-
"""Create a new window
|
|
5438
|
-
|
|
5439
|
-
:type execution_context: int | str | None
|
|
5440
|
-
:type undo: bool | None
|
|
5441
|
-
"""
|
|
4206
|
+
"""Create a new window"""
|
|
5442
4207
|
|
|
5443
4208
|
def window_new_main(
|
|
5444
4209
|
execution_context: int | str | None = None,
|
|
5445
4210
|
undo: bool | None = None,
|
|
5446
4211
|
/,
|
|
5447
4212
|
) -> None:
|
|
5448
|
-
"""Create a new main window with its own workspace and scene selection
|
|
5449
|
-
|
|
5450
|
-
:type execution_context: int | str | None
|
|
5451
|
-
:type undo: bool | None
|
|
5452
|
-
"""
|
|
4213
|
+
"""Create a new main window with its own workspace and scene selection"""
|
|
5453
4214
|
|
|
5454
4215
|
def xr_navigation_fly(
|
|
5455
4216
|
execution_context: int | str | None = None,
|
|
@@ -5507,8 +4268,6 @@ def xr_navigation_fly(
|
|
|
5507
4268
|
) -> None:
|
|
5508
4269
|
"""Move/turn relative to the VR viewer or controller
|
|
5509
4270
|
|
|
5510
|
-
:type execution_context: int | str | None
|
|
5511
|
-
:type undo: bool | None
|
|
5512
4271
|
:param mode: Mode, Fly mode
|
|
5513
4272
|
|
|
5514
4273
|
FORWARD
|
|
@@ -5549,23 +4308,14 @@ def xr_navigation_fly(
|
|
|
5549
4308
|
|
|
5550
4309
|
CONTROLLER_FORWARD
|
|
5551
4310
|
Controller Forward -- Move along controllers forward axis.
|
|
5552
|
-
:type mode: typing.Literal['FORWARD','BACK','LEFT','RIGHT','UP','DOWN','TURNLEFT','TURNRIGHT','VIEWER_FORWARD','VIEWER_BACK','VIEWER_LEFT','VIEWER_RIGHT','CONTROLLER_FORWARD'] | None
|
|
5553
4311
|
:param snap_turn_threshold: Snap Turn Threshold, Input state threshold when using snap turn
|
|
5554
|
-
:type snap_turn_threshold: float | None
|
|
5555
4312
|
:param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
|
|
5556
|
-
:type lock_location_z: bool | None
|
|
5557
4313
|
:param lock_direction: Lock Direction, Limit movement to viewers initial direction
|
|
5558
|
-
:type lock_direction: bool | None
|
|
5559
4314
|
:param speed_frame_based: Frame Based Speed, Apply fixed movement deltas every update
|
|
5560
|
-
:type speed_frame_based: bool | None
|
|
5561
4315
|
:param turn_speed_factor: Turn Speed Factor, Ratio between the min and max turn speed
|
|
5562
|
-
:type turn_speed_factor: float | None
|
|
5563
4316
|
:param fly_speed_factor: Fly Speed Factor, Ratio between the min and max fly speed
|
|
5564
|
-
:type fly_speed_factor: float | None
|
|
5565
4317
|
:param speed_interpolation0: Speed Interpolation 0, First cubic spline control point between min/max speeds
|
|
5566
|
-
:type speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
5567
4318
|
:param speed_interpolation1: Speed Interpolation 1, Second cubic spline control point between min/max speeds
|
|
5568
|
-
:type speed_interpolation1: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
5569
4319
|
:param alt_mode: Mode (Alt), Fly mode when hands are swapped
|
|
5570
4320
|
|
|
5571
4321
|
FORWARD
|
|
@@ -5606,11 +4356,8 @@ def xr_navigation_fly(
|
|
|
5606
4356
|
|
|
5607
4357
|
CONTROLLER_FORWARD
|
|
5608
4358
|
Controller Forward -- Move along controllers forward axis.
|
|
5609
|
-
:type alt_mode: typing.Literal['FORWARD','BACK','LEFT','RIGHT','UP','DOWN','TURNLEFT','TURNRIGHT','VIEWER_FORWARD','VIEWER_BACK','VIEWER_LEFT','VIEWER_RIGHT','CONTROLLER_FORWARD'] | None
|
|
5610
4359
|
:param alt_lock_location_z: Lock Elevation (Alt), When hands are swapped, prevent changes to viewer elevation
|
|
5611
|
-
:type alt_lock_location_z: bool | None
|
|
5612
4360
|
:param alt_lock_direction: Lock Direction (Alt), When hands are swapped, limit movement to viewers initial direction
|
|
5613
|
-
:type alt_lock_direction: bool | None
|
|
5614
4361
|
"""
|
|
5615
4362
|
|
|
5616
4363
|
def xr_navigation_grab(
|
|
@@ -5626,18 +4373,11 @@ def xr_navigation_grab(
|
|
|
5626
4373
|
) -> None:
|
|
5627
4374
|
"""Navigate the VR scene by grabbing with controllers
|
|
5628
4375
|
|
|
5629
|
-
:type execution_context: int | str | None
|
|
5630
|
-
:type undo: bool | None
|
|
5631
4376
|
:param lock_location: Lock Location, Prevent changes to viewer location
|
|
5632
|
-
:type lock_location: bool | None
|
|
5633
4377
|
:param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
|
|
5634
|
-
:type lock_location_z: bool | None
|
|
5635
4378
|
:param lock_rotation: Lock Rotation, Prevent changes to viewer rotation
|
|
5636
|
-
:type lock_rotation: bool | None
|
|
5637
4379
|
:param lock_rotation_z: Lock Up Orientation, Prevent changes to viewer up orientation
|
|
5638
|
-
:type lock_rotation_z: bool | None
|
|
5639
4380
|
:param lock_scale: Lock Scale, Prevent changes to viewer scale
|
|
5640
|
-
:type lock_scale: bool | None
|
|
5641
4381
|
"""
|
|
5642
4382
|
|
|
5643
4383
|
def xr_navigation_reset(
|
|
@@ -5651,14 +4391,9 @@ def xr_navigation_reset(
|
|
|
5651
4391
|
) -> None:
|
|
5652
4392
|
"""Reset VR navigation deltas relative to session base pose
|
|
5653
4393
|
|
|
5654
|
-
:type execution_context: int | str | None
|
|
5655
|
-
:type undo: bool | None
|
|
5656
4394
|
:param location: Location, Reset location deltas
|
|
5657
|
-
:type location: bool | None
|
|
5658
4395
|
:param rotation: Rotation, Reset rotation deltas
|
|
5659
|
-
:type rotation: bool | None
|
|
5660
4396
|
:param scale: Scale, Reset scale deltas
|
|
5661
|
-
:type scale: bool | None
|
|
5662
4397
|
"""
|
|
5663
4398
|
|
|
5664
4399
|
def xr_navigation_swap_hands(
|
|
@@ -5666,11 +4401,7 @@ def xr_navigation_swap_hands(
|
|
|
5666
4401
|
undo: bool | None = None,
|
|
5667
4402
|
/,
|
|
5668
4403
|
) -> None:
|
|
5669
|
-
"""Swap VR navigation controls between left / right controllers
|
|
5670
|
-
|
|
5671
|
-
:type execution_context: int | str | None
|
|
5672
|
-
:type undo: bool | None
|
|
5673
|
-
"""
|
|
4404
|
+
"""Swap VR navigation controls between left / right controllers"""
|
|
5674
4405
|
|
|
5675
4406
|
def xr_navigation_teleport(
|
|
5676
4407
|
execution_context: int | str | None = None,
|
|
@@ -5688,24 +4419,14 @@ def xr_navigation_teleport(
|
|
|
5688
4419
|
) -> None:
|
|
5689
4420
|
"""Set VR viewer location to controller raycast hit location
|
|
5690
4421
|
|
|
5691
|
-
:type execution_context: int | str | None
|
|
5692
|
-
:type undo: bool | None
|
|
5693
4422
|
:param selectable_only: Selectable Only, Only allow selectable objects to influence raycast result
|
|
5694
|
-
:type selectable_only: bool | None
|
|
5695
4423
|
:param force: Force, Velocity force controlling the teleportation arc parabola in m/s
|
|
5696
|
-
:type force: float | None
|
|
5697
4424
|
:param range: Range, Time step range controlling the teleportation arc parabola
|
|
5698
|
-
:type range: float | None
|
|
5699
4425
|
:param ray_line_width: Ray Line Width, Visual width of the teleportation ray line
|
|
5700
|
-
:type ray_line_width: float | None
|
|
5701
4426
|
:param destination_indicator_width: Destination Indicator Width, Visual width of the hit destination indicator
|
|
5702
|
-
:type destination_indicator_width: float | None
|
|
5703
4427
|
:param hit_color: Hit Color, Color of raycast when it succeeds
|
|
5704
|
-
:type hit_color: collections.abc.Iterable[float] | None
|
|
5705
4428
|
:param miss_color: Miss Color, Color of raycast when it misses
|
|
5706
|
-
:type miss_color: collections.abc.Iterable[float] | None
|
|
5707
4429
|
:param fallback_color: Fallback Color, Color of raycast when a fallback case succeeds
|
|
5708
|
-
:type fallback_color: collections.abc.Iterable[float] | None
|
|
5709
4430
|
"""
|
|
5710
4431
|
|
|
5711
4432
|
def xr_session_toggle(
|
|
@@ -5713,8 +4434,4 @@ def xr_session_toggle(
|
|
|
5713
4434
|
undo: bool | None = None,
|
|
5714
4435
|
/,
|
|
5715
4436
|
) -> None:
|
|
5716
|
-
"""Open a view for use with virtual reality headsets, or close it if already opened
|
|
5717
|
-
|
|
5718
|
-
:type execution_context: int | str | None
|
|
5719
|
-
:type undo: bool | None
|
|
5720
|
-
"""
|
|
4437
|
+
"""Open a view for use with virtual reality headsets, or close it if already opened"""
|