fake-bpy-module 20240516__py3-none-any.whl → 20240518__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.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- _bpy_internal/freedesktop/__init__.pyi +17 -84
- addon_utils/__init__.pyi +44 -38
- animsys_refactor/__init__.pyi +7 -27
- aud/__init__.pyi +8 -11
- bgl/__init__.pyi +121 -1812
- bl_app_override/__init__.pyi +8 -19
- bl_app_override/helpers/__init__.pyi +5 -23
- bl_app_template_utils/__init__.pyi +5 -17
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
- bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
- bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
- bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
- bl_i18n_utils/merge_po/__init__.pyi +1 -4
- bl_i18n_utils/settings/__init__.pyi +6 -24
- bl_i18n_utils/utils/__init__.pyi +93 -122
- bl_i18n_utils/utils_cli/__init__.pyi +6 -29
- bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
- bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
- bl_keymap_utils/io/__init__.pyi +9 -40
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
- bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
- bl_keymap_utils/versioning/__init__.pyi +1 -4
- bl_operators/__init__.pyi +2 -9
- bl_operators/add_mesh_torus/__init__.pyi +128 -59
- bl_operators/anim/__init__.pyi +1001 -398
- bl_operators/assets/__init__.pyi +376 -152
- bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
- bl_operators/clip/__init__.pyi +1264 -532
- bl_operators/console/__init__.pyi +626 -242
- bl_operators/constraint/__init__.pyi +502 -201
- bl_operators/file/__init__.pyi +376 -150
- bl_operators/freestyle/__init__.pyi +501 -200
- bl_operators/geometry_nodes/__init__.pyi +514 -266
- bl_operators/image/__init__.pyi +621 -251
- bl_operators/mesh/__init__.pyi +376 -150
- bl_operators/node/__init__.pyi +1253 -516
- bl_operators/object/__init__.pyi +1879 -755
- bl_operators/object_align/__init__.pyi +129 -64
- bl_operators/object_quick_effects/__init__.pyi +504 -213
- bl_operators/object_randomize_transform/__init__.pyi +129 -54
- bl_operators/presets/__init__.pyi +3072 -1403
- bl_operators/rigidbody/__init__.pyi +376 -150
- bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
- bl_operators/sequencer/__init__.pyi +1010 -434
- bl_operators/spreadsheet/__init__.pyi +126 -50
- bl_operators/userpref/__init__.pyi +3253 -1267
- bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
- bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
- bl_operators/uvcalc_transform/__init__.pyi +297 -159
- bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
- bl_operators/view3d/__init__.pyi +868 -342
- bl_operators/wm/__init__.pyi +5795 -2388
- bl_operators/world/__init__.pyi +126 -50
- bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
- bl_rna_utils/data_path/__init__.pyi +8 -4
- bl_text_utils/external_editor/__init__.pyi +1 -4
- bl_ui/__init__.pyi +366 -269
- bl_ui/anim/__init__.pyi +164 -74
- bl_ui/asset_shelf/__init__.pyi +129 -56
- bl_ui/generic_ui_list/__init__.pyi +412 -163
- bl_ui/node_add_menu/__init__.pyi +171 -94
- bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
- bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
- bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
- bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
- bl_ui/properties_animviz/__init__.pyi +2 -16
- bl_ui/properties_collection/__init__.pyi +807 -379
- bl_ui/properties_constraint/__init__.pyi +10292 -4941
- bl_ui/properties_data_armature/__init__.pyi +1615 -753
- bl_ui/properties_data_bone/__init__.pyi +1284 -608
- bl_ui/properties_data_camera/__init__.pyi +1854 -927
- bl_ui/properties_data_curve/__init__.pyi +1927 -937
- bl_ui/properties_data_curves/__init__.pyi +806 -375
- bl_ui/properties_data_empty/__init__.pyi +257 -125
- bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
- bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
- bl_ui/properties_data_lattice/__init__.pyi +388 -188
- bl_ui/properties_data_light/__init__.pyi +1540 -756
- bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
- bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
- bl_ui/properties_data_metaball/__init__.pyi +644 -308
- bl_ui/properties_data_modifier/__init__.pyi +1353 -671
- bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
- bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
- bl_ui/properties_data_speaker/__init__.pyi +644 -316
- bl_ui/properties_data_volume/__init__.pyi +1028 -484
- bl_ui/properties_freestyle/__init__.pyi +3112 -1619
- bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
- bl_ui/properties_mask_common/__init__.pyi +1102 -523
- bl_ui/properties_material/__init__.pyi +2089 -1009
- bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
- bl_ui/properties_object/__init__.pyi +1832 -873
- bl_ui/properties_output/__init__.pyi +2405 -1173
- bl_ui/properties_paint_common/__init__.pyi +416 -386
- bl_ui/properties_particle/__init__.pyi +6740 -3346
- bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
- bl_ui/properties_physics_common/__init__.pyi +135 -98
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
- bl_ui/properties_physics_field/__init__.pyi +1282 -627
- bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
- bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
- bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
- bl_ui/properties_render/__init__.pyi +6843 -3367
- bl_ui/properties_scene/__init__.pyi +1924 -913
- bl_ui/properties_texture/__init__.pyi +3371 -1667
- bl_ui/properties_view_layer/__init__.pyi +2344 -1107
- bl_ui/properties_workspace/__init__.pyi +516 -244
- bl_ui/properties_world/__init__.pyi +1284 -630
- bl_ui/space_clip/__init__.pyi +10172 -4695
- bl_ui/space_console/__init__.pyi +940 -423
- bl_ui/space_dopesheet/__init__.pyi +4325 -2013
- bl_ui/space_filebrowser/__init__.pyi +4172 -1903
- bl_ui/space_graph/__init__.pyi +3107 -1394
- bl_ui/space_image/__init__.pyi +9764 -4614
- bl_ui/space_info/__init__.pyi +939 -421
- bl_ui/space_nla/__init__.pyi +2623 -1183
- bl_ui/space_node/__init__.pyi +3995 -1840
- bl_ui/space_outliner/__init__.pyi +2203 -991
- bl_ui/space_properties/__init__.pyi +386 -165
- bl_ui/space_sequencer/__init__.pyi +10809 -4978
- bl_ui/space_spreadsheet/__init__.pyi +130 -53
- bl_ui/space_statusbar/__init__.pyi +129 -52
- bl_ui/space_text/__init__.pyi +2457 -1100
- bl_ui/space_time/__init__.pyi +1034 -481
- bl_ui/space_toolsystem_common/__init__.pyi +56 -211
- bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
- bl_ui/space_topbar/__init__.pyi +3982 -1805
- bl_ui/space_userpref/__init__.pyi +11383 -5290
- bl_ui/space_view3d/__init__.pyi +40873 -18532
- bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
- bl_ui/temp_anim_layers/__init__.pyi +130 -62
- bl_ui/utils/__init__.pyi +28 -27
- bl_ui_utils/bug_report_url/__init__.pyi +1 -4
- bl_ui_utils/layout/__init__.pyi +1 -1
- blend_render_info/__init__.pyi +3 -10
- blf/__init__.pyi +4 -4
- bmesh/geometry/__init__.pyi +2 -3
- bmesh/ops/__init__.pyi +372 -419
- bmesh/types/__init__.pyi +39 -56
- bmesh/utils/__init__.pyi +10 -13
- bpy/app/__init__.pyi +4 -4
- bpy/app/handlers/__init__.pyi +36 -36
- bpy/app/icons/__init__.pyi +8 -8
- bpy/app/timers/__init__.pyi +10 -10
- bpy/app/translations/__init__.pyi +20 -22
- bpy/msgbus/__init__.pyi +2 -4
- bpy/ops/action/__init__.pyi +316 -394
- bpy/ops/anim/__init__.pyi +442 -548
- bpy/ops/armature/__init__.pyi +374 -470
- bpy/ops/asset/__init__.pyi +152 -184
- bpy/ops/bl_pkg/__init__.pyi +221 -272
- bpy/ops/boid/__init__.pyi +50 -66
- bpy/ops/brush/__init__.pyi +72 -90
- bpy/ops/buttons/__init__.pyi +132 -144
- bpy/ops/cachefile/__init__.pyi +128 -138
- bpy/ops/camera/__init__.pyi +26 -30
- bpy/ops/clip/__init__.pyi +777 -964
- bpy/ops/cloth/__init__.pyi +12 -14
- bpy/ops/collection/__init__.pyi +68 -86
- bpy/ops/console/__init__.pyi +158 -200
- bpy/ops/constraint/__init__.pyi +178 -214
- bpy/ops/curve/__init__.pyi +473 -576
- bpy/ops/curves/__init__.pyi +247 -302
- bpy/ops/cycles/__init__.pyi +28 -34
- bpy/ops/dpaint/__init__.pyi +34 -44
- bpy/ops/ed/__init__.pyi +126 -150
- bpy/ops/export_anim/__init__.pyi +22 -24
- bpy/ops/export_scene/__init__.pyi +302 -336
- bpy/ops/file/__init__.pyi +352 -432
- bpy/ops/fluid/__init__.pyi +90 -118
- bpy/ops/font/__init__.pyi +258 -304
- bpy/ops/geometry/__init__.pyi +100 -120
- bpy/ops/gizmogroup/__init__.pyi +22 -26
- bpy/ops/gpencil/__init__.pyi +1469 -1778
- bpy/ops/graph/__init__.pyi +644 -776
- bpy/ops/grease_pencil/__init__.pyi +597 -748
- bpy/ops/image/__init__.pyi +648 -744
- bpy/ops/import_anim/__init__.pyi +30 -32
- bpy/ops/import_curve/__init__.pyi +10 -12
- bpy/ops/import_scene/__init__.pyi +88 -96
- bpy/ops/info/__init__.pyi +60 -74
- bpy/ops/lattice/__init__.pyi +64 -80
- bpy/ops/marker/__init__.pyi +108 -130
- bpy/ops/mask/__init__.pyi +322 -402
- bpy/ops/material/__init__.pyi +18 -24
- bpy/ops/mball/__init__.pyi +70 -86
- bpy/ops/mesh/__init__.pyi +1986 -2322
- bpy/ops/nla/__init__.pyi +333 -411
- bpy/ops/node/__init__.pyi +886 -1100
- bpy/ops/object/__init__.pyi +2585 -3078
- bpy/ops/outliner/__init__.pyi +498 -636
- bpy/ops/paint/__init__.pyi +565 -680
- bpy/ops/paintcurve/__init__.pyi +64 -80
- bpy/ops/palette/__init__.pyi +50 -64
- bpy/ops/particle/__init__.pyi +267 -340
- bpy/ops/pose/__init__.pyi +336 -414
- bpy/ops/poselib/__init__.pyi +72 -90
- bpy/ops/preferences/__init__.pyi +386 -463
- bpy/ops/ptcache/__init__.pyi +46 -60
- bpy/ops/render/__init__.pyi +130 -154
- bpy/ops/rigidbody/__init__.pyi +102 -128
- bpy/ops/scene/__init__.pyi +280 -358
- bpy/ops/screen/__init__.pyi +382 -460
- bpy/ops/script/__init__.pyi +24 -30
- bpy/ops/sculpt/__init__.pyi +458 -532
- bpy/ops/sculpt_curves/__init__.pyi +41 -50
- bpy/ops/sequencer/__init__.pyi +1066 -1244
- bpy/ops/sound/__init__.pyi +216 -230
- bpy/ops/spreadsheet/__init__.pyi +30 -38
- bpy/ops/surface/__init__.pyi +108 -120
- bpy/ops/text/__init__.pyi +390 -476
- bpy/ops/text_editor/__init__.pyi +12 -14
- bpy/ops/texture/__init__.pyi +26 -34
- bpy/ops/transform/__init__.pyi +792 -878
- bpy/ops/ui/__init__.pyi +228 -294
- bpy/ops/uilist/__init__.pyi +32 -38
- bpy/ops/uv/__init__.pyi +602 -704
- bpy/ops/view2d/__init__.pyi +156 -184
- bpy/ops/view3d/__init__.pyi +582 -718
- bpy/ops/wm/__init__.pyi +2683 -2928
- bpy/ops/workspace/__init__.pyi +46 -60
- bpy/ops/world/__init__.pyi +12 -16
- bpy/path/__init__.pyi +179 -75
- bpy/props/__init__.pyi +261 -263
- bpy/types/__init__.pyi +17058 -26311
- bpy/utils/__init__.pyi +247 -179
- bpy/utils/previews/__init__.pyi +58 -28
- bpy/utils/units/__init__.pyi +20 -20
- bpy_extras/anim_utils/__init__.pyi +68 -29
- bpy_extras/asset_utils/__init__.pyi +0 -10
- bpy_extras/bmesh_utils/__init__.pyi +9 -6
- bpy_extras/extensions/junction_module/__init__.pyi +6 -8
- bpy_extras/id_map_utils/__init__.pyi +3 -3
- bpy_extras/image_utils/__init__.pyi +44 -11
- bpy_extras/io_utils/__init__.pyi +116 -41
- bpy_extras/keyconfig_utils/__init__.pyi +4 -11
- bpy_extras/mesh_utils/__init__.pyi +71 -19
- bpy_extras/node_shader_utils/__init__.pyi +52 -288
- bpy_extras/node_utils/__init__.pyi +10 -10
- bpy_extras/object_utils/__init__.pyi +71 -14
- bpy_extras/view3d_utils/__init__.pyi +80 -10
- bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
- bpy_restrict_state/__init__.pyi +1 -14
- bpy_types/__init__.pyi +4203 -1605
- console_python/__init__.pyi +12 -37
- console_shell/__init__.pyi +5 -24
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
- fake_bpy_module-20240518.dist-info/RECORD +353 -0
- freestyle/chainingiterators/__init__.pyi +14 -44
- freestyle/functions/__init__.pyi +7 -33
- freestyle/predicates/__init__.pyi +44 -217
- freestyle/shaders/__init__.pyi +2 -12
- freestyle/types/__init__.pyi +84 -96
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +6 -18
- gpu/matrix/__init__.pyi +6 -8
- gpu/state/__init__.pyi +2 -2
- gpu/types/__init__.pyi +12 -12
- gpu_extras/presets/__init__.pyi +2 -5
- graphviz_export/__init__.pyi +4 -9
- idprop/types/__init__.pyi +8 -35
- imbuf/__init__.pyi +4 -4
- imbuf/types/__init__.pyi +0 -2
- keyingsets_builtins/__init__.pyi +2692 -997
- keyingsets_utils/__init__.pyi +14 -69
- mathutils/__init__.pyi +194 -238
- mathutils/bvhtree/__init__.pyi +4 -6
- mathutils/geometry/__init__.pyi +153 -155
- mathutils/kdtree/__init__.pyi +8 -12
- mathutils/noise/__init__.pyi +26 -26
- nodeitems_builtins/__init__.pyi +5 -30
- nodeitems_utils/__init__.pyi +8 -45
- rna_info/__init__.pyi +39 -215
- rna_keymap_ui/__init__.pyi +6 -29
- rna_prop_ui/__init__.pyi +24 -62
- rna_xml/__init__.pyi +16 -39
- sys_info/__init__.pyi +1 -4
- _bpy_internal/freedesktop/py.typed +0 -0
- bl_app_override/helpers/py.typed +0 -0
- bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
- bl_console_utils/autocomplete/complete_import/py.typed +0 -0
- bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
- bl_console_utils/autocomplete/intellisense/py.typed +0 -0
- bl_console_utils/autocomplete/py.typed +0 -0
- bl_i18n_utils/bl_extract_messages/py.typed +0 -0
- bl_i18n_utils/merge_po/py.typed +0 -0
- bl_i18n_utils/settings/py.typed +0 -0
- bl_i18n_utils/utils/py.typed +0 -0
- bl_i18n_utils/utils_cli/py.typed +0 -0
- bl_i18n_utils/utils_languages_menu/py.typed +0 -0
- bl_i18n_utils/utils_rtl/py.typed +0 -0
- bl_keymap_utils/io/py.typed +0 -0
- bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
- bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
- bl_keymap_utils/platform_helpers/py.typed +0 -0
- bl_keymap_utils/versioning/py.typed +0 -0
- bl_operators/add_mesh_torus/py.typed +0 -0
- bl_operators/anim/py.typed +0 -0
- bl_operators/assets/py.typed +0 -0
- bl_operators/bmesh/find_adjacent/py.typed +0 -0
- bl_operators/bmesh/py.typed +0 -0
- bl_operators/clip/py.typed +0 -0
- bl_operators/console/py.typed +0 -0
- bl_operators/constraint/py.typed +0 -0
- bl_operators/file/py.typed +0 -0
- bl_operators/freestyle/py.typed +0 -0
- bl_operators/geometry_nodes/py.typed +0 -0
- bl_operators/image/py.typed +0 -0
- bl_operators/mesh/py.typed +0 -0
- bl_operators/node/py.typed +0 -0
- bl_operators/object/py.typed +0 -0
- bl_operators/object_align/py.typed +0 -0
- bl_operators/object_quick_effects/py.typed +0 -0
- bl_operators/object_randomize_transform/py.typed +0 -0
- bl_operators/presets/py.typed +0 -0
- bl_operators/rigidbody/py.typed +0 -0
- bl_operators/screen_play_rendered_anim/py.typed +0 -0
- bl_operators/sequencer/py.typed +0 -0
- bl_operators/spreadsheet/py.typed +0 -0
- bl_operators/userpref/py.typed +0 -0
- bl_operators/uvcalc_follow_active/py.typed +0 -0
- bl_operators/uvcalc_lightmap/py.typed +0 -0
- bl_operators/uvcalc_transform/py.typed +0 -0
- bl_operators/vertexpaint_dirt/py.typed +0 -0
- bl_operators/view3d/py.typed +0 -0
- bl_operators/wm/py.typed +0 -0
- bl_operators/world/py.typed +0 -0
- bl_previews_utils/bl_previews_render/py.typed +0 -0
- bl_rna_utils/data_path/py.typed +0 -0
- bl_text_utils/external_editor/py.typed +0 -0
- bl_ui/anim/py.typed +0 -0
- bl_ui/asset_shelf/py.typed +0 -0
- bl_ui/generic_ui_list/py.typed +0 -0
- bl_ui/node_add_menu/py.typed +0 -0
- bl_ui/node_add_menu_compositor/py.typed +0 -0
- bl_ui/node_add_menu_geometry/py.typed +0 -0
- bl_ui/node_add_menu_shader/py.typed +0 -0
- bl_ui/node_add_menu_texture/py.typed +0 -0
- bl_ui/properties_animviz/py.typed +0 -0
- bl_ui/properties_collection/py.typed +0 -0
- bl_ui/properties_constraint/py.typed +0 -0
- bl_ui/properties_data_armature/py.typed +0 -0
- bl_ui/properties_data_bone/py.typed +0 -0
- bl_ui/properties_data_camera/py.typed +0 -0
- bl_ui/properties_data_curve/py.typed +0 -0
- bl_ui/properties_data_curves/py.typed +0 -0
- bl_ui/properties_data_empty/py.typed +0 -0
- bl_ui/properties_data_gpencil/py.typed +0 -0
- bl_ui/properties_data_grease_pencil/py.typed +0 -0
- bl_ui/properties_data_lattice/py.typed +0 -0
- bl_ui/properties_data_light/py.typed +0 -0
- bl_ui/properties_data_lightprobe/py.typed +0 -0
- bl_ui/properties_data_mesh/py.typed +0 -0
- bl_ui/properties_data_metaball/py.typed +0 -0
- bl_ui/properties_data_modifier/py.typed +0 -0
- bl_ui/properties_data_pointcloud/py.typed +0 -0
- bl_ui/properties_data_shaderfx/py.typed +0 -0
- bl_ui/properties_data_speaker/py.typed +0 -0
- bl_ui/properties_data_volume/py.typed +0 -0
- bl_ui/properties_freestyle/py.typed +0 -0
- bl_ui/properties_grease_pencil_common/py.typed +0 -0
- bl_ui/properties_mask_common/py.typed +0 -0
- bl_ui/properties_material/py.typed +0 -0
- bl_ui/properties_material_gpencil/py.typed +0 -0
- bl_ui/properties_object/py.typed +0 -0
- bl_ui/properties_output/py.typed +0 -0
- bl_ui/properties_paint_common/py.typed +0 -0
- bl_ui/properties_particle/py.typed +0 -0
- bl_ui/properties_physics_cloth/py.typed +0 -0
- bl_ui/properties_physics_common/py.typed +0 -0
- bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
- bl_ui/properties_physics_field/py.typed +0 -0
- bl_ui/properties_physics_fluid/py.typed +0 -0
- bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
- bl_ui/properties_physics_rigidbody/py.typed +0 -0
- bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
- bl_ui/properties_physics_softbody/py.typed +0 -0
- bl_ui/properties_render/py.typed +0 -0
- bl_ui/properties_scene/py.typed +0 -0
- bl_ui/properties_texture/py.typed +0 -0
- bl_ui/properties_view_layer/py.typed +0 -0
- bl_ui/properties_workspace/py.typed +0 -0
- bl_ui/properties_world/py.typed +0 -0
- bl_ui/space_clip/py.typed +0 -0
- bl_ui/space_console/py.typed +0 -0
- bl_ui/space_dopesheet/py.typed +0 -0
- bl_ui/space_filebrowser/py.typed +0 -0
- bl_ui/space_graph/py.typed +0 -0
- bl_ui/space_image/py.typed +0 -0
- bl_ui/space_info/py.typed +0 -0
- bl_ui/space_nla/py.typed +0 -0
- bl_ui/space_node/py.typed +0 -0
- bl_ui/space_outliner/py.typed +0 -0
- bl_ui/space_properties/py.typed +0 -0
- bl_ui/space_sequencer/py.typed +0 -0
- bl_ui/space_spreadsheet/py.typed +0 -0
- bl_ui/space_statusbar/py.typed +0 -0
- bl_ui/space_text/py.typed +0 -0
- bl_ui/space_time/py.typed +0 -0
- bl_ui/space_toolsystem_common/py.typed +0 -0
- bl_ui/space_toolsystem_toolbar/py.typed +0 -0
- bl_ui/space_topbar/py.typed +0 -0
- bl_ui/space_userpref/py.typed +0 -0
- bl_ui/space_view3d/py.typed +0 -0
- bl_ui/space_view3d_toolbar/py.typed +0 -0
- bl_ui/temp_anim_layers/py.typed +0 -0
- bl_ui/utils/py.typed +0 -0
- bl_ui_utils/bug_report_url/py.typed +0 -0
- bl_ui_utils/layout/py.typed +0 -0
- bmesh/geometry/py.typed +0 -0
- bmesh/ops/py.typed +0 -0
- bmesh/types/py.typed +0 -0
- bmesh/utils/py.typed +0 -0
- bpy/app/handlers/py.typed +0 -0
- bpy/app/icons/py.typed +0 -0
- bpy/app/py.typed +0 -0
- bpy/app/timers/py.typed +0 -0
- bpy/app/translations/py.typed +0 -0
- bpy/msgbus/py.typed +0 -0
- bpy/ops/action/py.typed +0 -0
- bpy/ops/anim/py.typed +0 -0
- bpy/ops/armature/py.typed +0 -0
- bpy/ops/asset/py.typed +0 -0
- bpy/ops/bl_pkg/py.typed +0 -0
- bpy/ops/boid/py.typed +0 -0
- bpy/ops/brush/py.typed +0 -0
- bpy/ops/buttons/py.typed +0 -0
- bpy/ops/cachefile/py.typed +0 -0
- bpy/ops/camera/py.typed +0 -0
- bpy/ops/clip/py.typed +0 -0
- bpy/ops/cloth/py.typed +0 -0
- bpy/ops/collection/py.typed +0 -0
- bpy/ops/console/py.typed +0 -0
- bpy/ops/constraint/py.typed +0 -0
- bpy/ops/curve/py.typed +0 -0
- bpy/ops/curves/py.typed +0 -0
- bpy/ops/cycles/py.typed +0 -0
- bpy/ops/dpaint/py.typed +0 -0
- bpy/ops/ed/py.typed +0 -0
- bpy/ops/export_anim/py.typed +0 -0
- bpy/ops/export_scene/py.typed +0 -0
- bpy/ops/file/py.typed +0 -0
- bpy/ops/fluid/py.typed +0 -0
- bpy/ops/font/py.typed +0 -0
- bpy/ops/geometry/py.typed +0 -0
- bpy/ops/gizmogroup/py.typed +0 -0
- bpy/ops/gpencil/py.typed +0 -0
- bpy/ops/graph/py.typed +0 -0
- bpy/ops/grease_pencil/py.typed +0 -0
- bpy/ops/image/py.typed +0 -0
- bpy/ops/import_anim/py.typed +0 -0
- bpy/ops/import_curve/py.typed +0 -0
- bpy/ops/import_scene/py.typed +0 -0
- bpy/ops/info/py.typed +0 -0
- bpy/ops/lattice/py.typed +0 -0
- bpy/ops/marker/py.typed +0 -0
- bpy/ops/mask/py.typed +0 -0
- bpy/ops/material/py.typed +0 -0
- bpy/ops/mball/py.typed +0 -0
- bpy/ops/mesh/py.typed +0 -0
- bpy/ops/nla/py.typed +0 -0
- bpy/ops/node/py.typed +0 -0
- bpy/ops/object/py.typed +0 -0
- bpy/ops/outliner/py.typed +0 -0
- bpy/ops/paint/py.typed +0 -0
- bpy/ops/paintcurve/py.typed +0 -0
- bpy/ops/palette/py.typed +0 -0
- bpy/ops/particle/py.typed +0 -0
- bpy/ops/pose/py.typed +0 -0
- bpy/ops/poselib/py.typed +0 -0
- bpy/ops/preferences/py.typed +0 -0
- bpy/ops/ptcache/py.typed +0 -0
- bpy/ops/py.typed +0 -0
- bpy/ops/render/py.typed +0 -0
- bpy/ops/rigidbody/py.typed +0 -0
- bpy/ops/scene/py.typed +0 -0
- bpy/ops/screen/py.typed +0 -0
- bpy/ops/script/py.typed +0 -0
- bpy/ops/sculpt/py.typed +0 -0
- bpy/ops/sculpt_curves/py.typed +0 -0
- bpy/ops/sequencer/py.typed +0 -0
- bpy/ops/sound/py.typed +0 -0
- bpy/ops/spreadsheet/py.typed +0 -0
- bpy/ops/surface/py.typed +0 -0
- bpy/ops/text/py.typed +0 -0
- bpy/ops/text_editor/py.typed +0 -0
- bpy/ops/texture/py.typed +0 -0
- bpy/ops/transform/py.typed +0 -0
- bpy/ops/ui/py.typed +0 -0
- bpy/ops/uilist/py.typed +0 -0
- bpy/ops/uv/py.typed +0 -0
- bpy/ops/view2d/py.typed +0 -0
- bpy/ops/view3d/py.typed +0 -0
- bpy/ops/wm/py.typed +0 -0
- bpy/ops/workspace/py.typed +0 -0
- bpy/ops/world/py.typed +0 -0
- bpy/path/py.typed +0 -0
- bpy/props/py.typed +0 -0
- bpy/types/py.typed +0 -0
- bpy/utils/previews/py.typed +0 -0
- bpy/utils/py.typed +0 -0
- bpy/utils/units/py.typed +0 -0
- bpy_extras/anim_utils/py.typed +0 -0
- bpy_extras/asset_utils/py.typed +0 -0
- bpy_extras/bmesh_utils/py.typed +0 -0
- bpy_extras/extensions/junction_module/py.typed +0 -0
- bpy_extras/extensions/py.typed +0 -0
- bpy_extras/id_map_utils/py.typed +0 -0
- bpy_extras/image_utils/py.typed +0 -0
- bpy_extras/io_utils/py.typed +0 -0
- bpy_extras/keyconfig_utils/py.typed +0 -0
- bpy_extras/mesh_utils/py.typed +0 -0
- bpy_extras/node_shader_utils/py.typed +0 -0
- bpy_extras/node_utils/py.typed +0 -0
- bpy_extras/object_utils/py.typed +0 -0
- bpy_extras/view3d_utils/py.typed +0 -0
- bpy_extras/wm_utils/progress_report/py.typed +0 -0
- bpy_extras/wm_utils/py.typed +0 -0
- fake_bpy_module-20240516.dist-info/RECORD +0 -618
- freestyle/chainingiterators/py.typed +0 -0
- freestyle/functions/py.typed +0 -0
- freestyle/predicates/py.typed +0 -0
- freestyle/shaders/py.typed +0 -0
- freestyle/types/py.typed +0 -0
- freestyle/utils/ContextFunctions/py.typed +0 -0
- freestyle/utils/py.typed +0 -0
- gpu/capabilities/py.typed +0 -0
- gpu/matrix/py.typed +0 -0
- gpu/platform/py.typed +0 -0
- gpu/select/py.typed +0 -0
- gpu/shader/py.typed +0 -0
- gpu/state/py.typed +0 -0
- gpu/texture/py.typed +0 -0
- gpu/types/py.typed +0 -0
- gpu_extras/batch/py.typed +0 -0
- gpu_extras/presets/py.typed +0 -0
- idprop/types/py.typed +0 -0
- imbuf/types/py.typed +0 -0
- mathutils/bvhtree/py.typed +0 -0
- mathutils/geometry/py.typed +0 -0
- mathutils/interpolate/py.typed +0 -0
- mathutils/kdtree/py.typed +0 -0
- mathutils/noise/py.typed +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
|
@@ -1,37 +1,44 @@
|
|
|
1
1
|
import typing
|
|
2
|
+
import bpy.types
|
|
2
3
|
import bpy_types
|
|
3
4
|
|
|
4
5
|
GenericType = typing.TypeVar("GenericType")
|
|
5
6
|
|
|
6
7
|
class OUTLINER_HT_header(bpy_types.Header, bpy_types._GenericUI):
|
|
7
|
-
""" """
|
|
8
|
-
|
|
9
8
|
bl_rna: typing.Any
|
|
10
|
-
""" """
|
|
11
|
-
|
|
12
9
|
bl_space_type: typing.Any
|
|
13
|
-
""" """
|
|
14
|
-
|
|
15
10
|
id_data: typing.Any
|
|
16
|
-
""" """
|
|
17
11
|
|
|
18
12
|
def append(self, draw_func):
|
|
19
|
-
"""
|
|
13
|
+
"""Append a draw function to this menu,
|
|
14
|
+
takes the same arguments as the menus draw function
|
|
20
15
|
|
|
21
|
-
|
|
16
|
+
:param draw_func:
|
|
22
17
|
"""
|
|
23
18
|
...
|
|
24
19
|
|
|
25
|
-
def as_pointer(self):
|
|
26
|
-
"""
|
|
20
|
+
def as_pointer(self) -> int:
|
|
21
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
22
|
+
|
|
23
|
+
:return: int (memory address).
|
|
24
|
+
:rtype: int
|
|
25
|
+
"""
|
|
27
26
|
...
|
|
28
27
|
|
|
29
|
-
def bl_rna_get_subclass(self):
|
|
30
|
-
"""
|
|
28
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
29
|
+
"""
|
|
30
|
+
|
|
31
|
+
:return: The RNA type or default when not found.
|
|
32
|
+
:rtype: bpy.types.Struct
|
|
33
|
+
"""
|
|
31
34
|
...
|
|
32
35
|
|
|
33
|
-
def bl_rna_get_subclass_py(self):
|
|
34
|
-
"""
|
|
36
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
:return: The class or default when not found.
|
|
40
|
+
:rtype: typing.Any
|
|
41
|
+
"""
|
|
35
42
|
...
|
|
36
43
|
|
|
37
44
|
def draw(self, context):
|
|
@@ -41,137 +48,213 @@ class OUTLINER_HT_header(bpy_types.Header, bpy_types._GenericUI):
|
|
|
41
48
|
"""
|
|
42
49
|
...
|
|
43
50
|
|
|
44
|
-
def driver_add(self):
|
|
45
|
-
"""
|
|
51
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
52
|
+
"""Adds driver(s) to the given property
|
|
53
|
+
|
|
54
|
+
:return: The driver(s) added.
|
|
55
|
+
:rtype: bpy.types.FCurve
|
|
56
|
+
"""
|
|
46
57
|
...
|
|
47
58
|
|
|
48
|
-
def driver_remove(self):
|
|
49
|
-
"""
|
|
59
|
+
def driver_remove(self) -> bool:
|
|
60
|
+
"""Remove driver(s) from the given property
|
|
61
|
+
|
|
62
|
+
:return: Success of driver removal.
|
|
63
|
+
:rtype: bool
|
|
64
|
+
"""
|
|
50
65
|
...
|
|
51
66
|
|
|
52
67
|
def get(self):
|
|
53
|
-
"""
|
|
68
|
+
"""Returns the value of the custom property assigned to key or default
|
|
69
|
+
when not found (matches Python's dictionary function of the same name).
|
|
70
|
+
|
|
71
|
+
"""
|
|
54
72
|
...
|
|
55
73
|
|
|
56
74
|
def id_properties_clear(self):
|
|
57
|
-
"""
|
|
75
|
+
"""
|
|
76
|
+
|
|
77
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
78
|
+
"""
|
|
58
79
|
...
|
|
59
80
|
|
|
60
81
|
def id_properties_ensure(self):
|
|
61
|
-
"""
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
85
|
+
"""
|
|
62
86
|
...
|
|
63
87
|
|
|
64
88
|
def id_properties_ui(self):
|
|
65
|
-
"""
|
|
66
|
-
...
|
|
89
|
+
"""
|
|
67
90
|
|
|
68
|
-
|
|
69
|
-
"""
|
|
91
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
92
|
+
"""
|
|
70
93
|
...
|
|
71
94
|
|
|
72
|
-
def
|
|
73
|
-
|
|
95
|
+
def is_extended(self): ...
|
|
96
|
+
def is_property_hidden(self) -> bool:
|
|
97
|
+
"""Check if a property is hidden.
|
|
98
|
+
|
|
99
|
+
:return: True when the property is hidden.
|
|
100
|
+
:rtype: bool
|
|
101
|
+
"""
|
|
74
102
|
...
|
|
75
103
|
|
|
76
|
-
def is_property_overridable_library(self):
|
|
77
|
-
"""
|
|
104
|
+
def is_property_overridable_library(self) -> bool:
|
|
105
|
+
"""Check if a property is overridable.
|
|
106
|
+
|
|
107
|
+
:return: True when the property is overridable.
|
|
108
|
+
:rtype: bool
|
|
109
|
+
"""
|
|
78
110
|
...
|
|
79
111
|
|
|
80
|
-
def is_property_readonly(self):
|
|
81
|
-
"""
|
|
112
|
+
def is_property_readonly(self) -> bool:
|
|
113
|
+
"""Check if a property is readonly.
|
|
114
|
+
|
|
115
|
+
:return: True when the property is readonly (not writable).
|
|
116
|
+
:rtype: bool
|
|
117
|
+
"""
|
|
82
118
|
...
|
|
83
119
|
|
|
84
|
-
def is_property_set(self):
|
|
85
|
-
"""
|
|
120
|
+
def is_property_set(self) -> bool:
|
|
121
|
+
"""Check if a property is set, use for testing operator properties.
|
|
122
|
+
|
|
123
|
+
:return: True when the property has been set.
|
|
124
|
+
:rtype: bool
|
|
125
|
+
"""
|
|
86
126
|
...
|
|
87
127
|
|
|
88
128
|
def items(self):
|
|
89
|
-
"""
|
|
129
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
130
|
+
dictionary function of the same name).
|
|
131
|
+
|
|
132
|
+
:return: custom property key, value pairs.
|
|
133
|
+
"""
|
|
90
134
|
...
|
|
91
135
|
|
|
92
|
-
def keyframe_delete(self):
|
|
93
|
-
"""
|
|
136
|
+
def keyframe_delete(self) -> bool:
|
|
137
|
+
"""Remove a keyframe from this properties fcurve.
|
|
138
|
+
|
|
139
|
+
:return: Success of keyframe deletion.
|
|
140
|
+
:rtype: bool
|
|
141
|
+
"""
|
|
94
142
|
...
|
|
95
143
|
|
|
96
|
-
def keyframe_insert(self):
|
|
97
|
-
"""
|
|
144
|
+
def keyframe_insert(self) -> bool:
|
|
145
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
146
|
+
|
|
147
|
+
:return: Success of keyframe insertion.
|
|
148
|
+
:rtype: bool
|
|
149
|
+
"""
|
|
98
150
|
...
|
|
99
151
|
|
|
100
152
|
def keys(self):
|
|
101
|
-
"""
|
|
153
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
154
|
+
dictionary function of the same name).
|
|
155
|
+
|
|
156
|
+
:return: custom property keys.
|
|
157
|
+
"""
|
|
102
158
|
...
|
|
103
159
|
|
|
104
|
-
def path_from_id(self):
|
|
105
|
-
"""
|
|
160
|
+
def path_from_id(self) -> str:
|
|
161
|
+
"""Returns the data path from the ID to this object (string).
|
|
162
|
+
|
|
163
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
164
|
+
to this struct and property (when given).
|
|
165
|
+
:rtype: str
|
|
166
|
+
"""
|
|
106
167
|
...
|
|
107
168
|
|
|
108
169
|
def path_resolve(self):
|
|
109
|
-
""" """
|
|
170
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
110
171
|
...
|
|
111
172
|
|
|
112
173
|
def pop(self):
|
|
113
|
-
"""
|
|
174
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
175
|
+
when not found (matches Python's dictionary function of the same name).
|
|
176
|
+
|
|
177
|
+
"""
|
|
114
178
|
...
|
|
115
179
|
|
|
116
180
|
def prepend(self, draw_func):
|
|
117
|
-
"""
|
|
181
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
182
|
+
the menus draw function
|
|
118
183
|
|
|
119
|
-
|
|
184
|
+
:param draw_func:
|
|
120
185
|
"""
|
|
121
186
|
...
|
|
122
187
|
|
|
123
|
-
def property_overridable_library_set(self):
|
|
124
|
-
"""
|
|
188
|
+
def property_overridable_library_set(self) -> bool:
|
|
189
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
190
|
+
|
|
191
|
+
:return: True when the overridable status of the property was successfully set.
|
|
192
|
+
:rtype: bool
|
|
193
|
+
"""
|
|
125
194
|
...
|
|
126
195
|
|
|
127
196
|
def property_unset(self):
|
|
128
|
-
""" """
|
|
197
|
+
"""Unset a property, will use default value afterward."""
|
|
129
198
|
...
|
|
130
199
|
|
|
131
200
|
def remove(self, draw_func):
|
|
132
|
-
"""
|
|
201
|
+
"""Remove a draw function that has been added to this menu
|
|
133
202
|
|
|
134
203
|
:param draw_func:
|
|
135
204
|
"""
|
|
136
205
|
...
|
|
137
206
|
|
|
138
207
|
def type_recast(self):
|
|
139
|
-
"""
|
|
208
|
+
"""Return a new instance, this is needed because types
|
|
209
|
+
such as textures can be changed at runtime.
|
|
210
|
+
|
|
211
|
+
:return: a new instance of this object with the type initialized again.
|
|
212
|
+
"""
|
|
140
213
|
...
|
|
141
214
|
|
|
142
215
|
def values(self):
|
|
143
|
-
"""
|
|
216
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
217
|
+
dictionary function of the same name).
|
|
218
|
+
|
|
219
|
+
:return: custom property values.
|
|
220
|
+
"""
|
|
144
221
|
...
|
|
145
222
|
|
|
146
223
|
class OUTLINER_MT_asset(bpy_types.Menu, bpy_types._GenericUI):
|
|
147
|
-
""" """
|
|
148
|
-
|
|
149
224
|
bl_label: typing.Any
|
|
150
|
-
""" """
|
|
151
|
-
|
|
152
225
|
bl_rna: typing.Any
|
|
153
|
-
""" """
|
|
154
|
-
|
|
155
226
|
id_data: typing.Any
|
|
156
|
-
""" """
|
|
157
227
|
|
|
158
228
|
def append(self, draw_func):
|
|
159
|
-
"""
|
|
229
|
+
"""Append a draw function to this menu,
|
|
230
|
+
takes the same arguments as the menus draw function
|
|
160
231
|
|
|
161
|
-
|
|
232
|
+
:param draw_func:
|
|
162
233
|
"""
|
|
163
234
|
...
|
|
164
235
|
|
|
165
|
-
def as_pointer(self):
|
|
166
|
-
"""
|
|
236
|
+
def as_pointer(self) -> int:
|
|
237
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
238
|
+
|
|
239
|
+
:return: int (memory address).
|
|
240
|
+
:rtype: int
|
|
241
|
+
"""
|
|
167
242
|
...
|
|
168
243
|
|
|
169
|
-
def bl_rna_get_subclass(self):
|
|
170
|
-
"""
|
|
244
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
245
|
+
"""
|
|
246
|
+
|
|
247
|
+
:return: The RNA type or default when not found.
|
|
248
|
+
:rtype: bpy.types.Struct
|
|
249
|
+
"""
|
|
171
250
|
...
|
|
172
251
|
|
|
173
|
-
def bl_rna_get_subclass_py(self):
|
|
174
|
-
"""
|
|
252
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
253
|
+
"""
|
|
254
|
+
|
|
255
|
+
:return: The class or default when not found.
|
|
256
|
+
:rtype: typing.Any
|
|
257
|
+
"""
|
|
175
258
|
...
|
|
176
259
|
|
|
177
260
|
def draw(self, _context):
|
|
@@ -190,104 +273,171 @@ class OUTLINER_MT_asset(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
190
273
|
...
|
|
191
274
|
|
|
192
275
|
def draw_preset(self, _context):
|
|
193
|
-
"""
|
|
276
|
+
"""Define these on the subclass:
|
|
277
|
+
- preset_operator (string)
|
|
278
|
+
- preset_subdir (string)Optionally:
|
|
279
|
+
- preset_add_operator (string)
|
|
280
|
+
- preset_extensions (set of strings)
|
|
281
|
+
- preset_operator_defaults (dict of keyword args)
|
|
194
282
|
|
|
195
|
-
|
|
283
|
+
:param _context:
|
|
196
284
|
"""
|
|
197
285
|
...
|
|
198
286
|
|
|
199
|
-
def driver_add(self):
|
|
200
|
-
"""
|
|
287
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
288
|
+
"""Adds driver(s) to the given property
|
|
289
|
+
|
|
290
|
+
:return: The driver(s) added.
|
|
291
|
+
:rtype: bpy.types.FCurve
|
|
292
|
+
"""
|
|
201
293
|
...
|
|
202
294
|
|
|
203
|
-
def driver_remove(self):
|
|
204
|
-
"""
|
|
295
|
+
def driver_remove(self) -> bool:
|
|
296
|
+
"""Remove driver(s) from the given property
|
|
297
|
+
|
|
298
|
+
:return: Success of driver removal.
|
|
299
|
+
:rtype: bool
|
|
300
|
+
"""
|
|
205
301
|
...
|
|
206
302
|
|
|
207
303
|
def get(self):
|
|
208
|
-
"""
|
|
304
|
+
"""Returns the value of the custom property assigned to key or default
|
|
305
|
+
when not found (matches Python's dictionary function of the same name).
|
|
306
|
+
|
|
307
|
+
"""
|
|
209
308
|
...
|
|
210
309
|
|
|
211
310
|
def id_properties_clear(self):
|
|
212
|
-
"""
|
|
311
|
+
"""
|
|
312
|
+
|
|
313
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
314
|
+
"""
|
|
213
315
|
...
|
|
214
316
|
|
|
215
317
|
def id_properties_ensure(self):
|
|
216
|
-
"""
|
|
318
|
+
"""
|
|
319
|
+
|
|
320
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
321
|
+
"""
|
|
217
322
|
...
|
|
218
323
|
|
|
219
324
|
def id_properties_ui(self):
|
|
220
|
-
"""
|
|
221
|
-
...
|
|
325
|
+
"""
|
|
222
326
|
|
|
223
|
-
|
|
224
|
-
"""
|
|
327
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
328
|
+
"""
|
|
225
329
|
...
|
|
226
330
|
|
|
227
|
-
def
|
|
228
|
-
|
|
331
|
+
def is_extended(self): ...
|
|
332
|
+
def is_property_hidden(self) -> bool:
|
|
333
|
+
"""Check if a property is hidden.
|
|
334
|
+
|
|
335
|
+
:return: True when the property is hidden.
|
|
336
|
+
:rtype: bool
|
|
337
|
+
"""
|
|
229
338
|
...
|
|
230
339
|
|
|
231
|
-
def is_property_overridable_library(self):
|
|
232
|
-
"""
|
|
340
|
+
def is_property_overridable_library(self) -> bool:
|
|
341
|
+
"""Check if a property is overridable.
|
|
342
|
+
|
|
343
|
+
:return: True when the property is overridable.
|
|
344
|
+
:rtype: bool
|
|
345
|
+
"""
|
|
233
346
|
...
|
|
234
347
|
|
|
235
|
-
def is_property_readonly(self):
|
|
236
|
-
"""
|
|
348
|
+
def is_property_readonly(self) -> bool:
|
|
349
|
+
"""Check if a property is readonly.
|
|
350
|
+
|
|
351
|
+
:return: True when the property is readonly (not writable).
|
|
352
|
+
:rtype: bool
|
|
353
|
+
"""
|
|
237
354
|
...
|
|
238
355
|
|
|
239
|
-
def is_property_set(self):
|
|
240
|
-
"""
|
|
356
|
+
def is_property_set(self) -> bool:
|
|
357
|
+
"""Check if a property is set, use for testing operator properties.
|
|
358
|
+
|
|
359
|
+
:return: True when the property has been set.
|
|
360
|
+
:rtype: bool
|
|
361
|
+
"""
|
|
241
362
|
...
|
|
242
363
|
|
|
243
364
|
def items(self):
|
|
244
|
-
"""
|
|
365
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
366
|
+
dictionary function of the same name).
|
|
367
|
+
|
|
368
|
+
:return: custom property key, value pairs.
|
|
369
|
+
"""
|
|
245
370
|
...
|
|
246
371
|
|
|
247
|
-
def keyframe_delete(self):
|
|
248
|
-
"""
|
|
372
|
+
def keyframe_delete(self) -> bool:
|
|
373
|
+
"""Remove a keyframe from this properties fcurve.
|
|
374
|
+
|
|
375
|
+
:return: Success of keyframe deletion.
|
|
376
|
+
:rtype: bool
|
|
377
|
+
"""
|
|
249
378
|
...
|
|
250
379
|
|
|
251
|
-
def keyframe_insert(self):
|
|
252
|
-
"""
|
|
380
|
+
def keyframe_insert(self) -> bool:
|
|
381
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
382
|
+
|
|
383
|
+
:return: Success of keyframe insertion.
|
|
384
|
+
:rtype: bool
|
|
385
|
+
"""
|
|
253
386
|
...
|
|
254
387
|
|
|
255
388
|
def keys(self):
|
|
256
|
-
"""
|
|
389
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
390
|
+
dictionary function of the same name).
|
|
391
|
+
|
|
392
|
+
:return: custom property keys.
|
|
393
|
+
"""
|
|
257
394
|
...
|
|
258
395
|
|
|
259
|
-
def path_from_id(self):
|
|
260
|
-
"""
|
|
396
|
+
def path_from_id(self) -> str:
|
|
397
|
+
"""Returns the data path from the ID to this object (string).
|
|
398
|
+
|
|
399
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
400
|
+
to this struct and property (when given).
|
|
401
|
+
:rtype: str
|
|
402
|
+
"""
|
|
261
403
|
...
|
|
262
404
|
|
|
263
405
|
def path_menu(
|
|
264
406
|
self,
|
|
265
|
-
searchpaths,
|
|
266
|
-
operator,
|
|
267
|
-
props_default,
|
|
268
|
-
prop_filepath,
|
|
269
|
-
filter_ext,
|
|
270
|
-
filter_path,
|
|
271
|
-
display_name,
|
|
272
|
-
add_operator,
|
|
273
|
-
add_operator_props,
|
|
407
|
+
searchpaths: list[str],
|
|
408
|
+
operator: str,
|
|
409
|
+
props_default: dict = None,
|
|
410
|
+
prop_filepath: str = "filepath",
|
|
411
|
+
filter_ext: typing.Callable = None,
|
|
412
|
+
filter_path=None,
|
|
413
|
+
display_name: typing.Callable = None,
|
|
414
|
+
add_operator=None,
|
|
415
|
+
add_operator_props=None,
|
|
274
416
|
):
|
|
275
|
-
"""
|
|
417
|
+
"""Populate a menu from a list of paths.
|
|
276
418
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
419
|
+
:param searchpaths: Paths to scan.
|
|
420
|
+
:type searchpaths: list[str]
|
|
421
|
+
:param operator: The operator id to use with each file.
|
|
422
|
+
:type operator: str
|
|
423
|
+
:param props_default: Properties to assign to each operator.
|
|
424
|
+
:type props_default: dict
|
|
425
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
426
|
+
:type prop_filepath: str
|
|
427
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
428
|
+
|
|
429
|
+
Returning false excludes the file from the list.
|
|
430
|
+
:type filter_ext: typing.Callable
|
|
431
|
+
:param filter_path:
|
|
432
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
433
|
+
:type display_name: typing.Callable
|
|
434
|
+
:param add_operator:
|
|
435
|
+
:param add_operator_props:
|
|
286
436
|
"""
|
|
287
437
|
...
|
|
288
438
|
|
|
289
439
|
def path_resolve(self):
|
|
290
|
-
""" """
|
|
440
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
291
441
|
...
|
|
292
442
|
|
|
293
443
|
def poll(self, context):
|
|
@@ -298,68 +448,90 @@ class OUTLINER_MT_asset(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
298
448
|
...
|
|
299
449
|
|
|
300
450
|
def pop(self):
|
|
301
|
-
"""
|
|
451
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
452
|
+
when not found (matches Python's dictionary function of the same name).
|
|
453
|
+
|
|
454
|
+
"""
|
|
302
455
|
...
|
|
303
456
|
|
|
304
457
|
def prepend(self, draw_func):
|
|
305
|
-
"""
|
|
458
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
459
|
+
the menus draw function
|
|
306
460
|
|
|
307
|
-
|
|
461
|
+
:param draw_func:
|
|
308
462
|
"""
|
|
309
463
|
...
|
|
310
464
|
|
|
311
|
-
def property_overridable_library_set(self):
|
|
312
|
-
"""
|
|
465
|
+
def property_overridable_library_set(self) -> bool:
|
|
466
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
467
|
+
|
|
468
|
+
:return: True when the overridable status of the property was successfully set.
|
|
469
|
+
:rtype: bool
|
|
470
|
+
"""
|
|
313
471
|
...
|
|
314
472
|
|
|
315
473
|
def property_unset(self):
|
|
316
|
-
""" """
|
|
474
|
+
"""Unset a property, will use default value afterward."""
|
|
317
475
|
...
|
|
318
476
|
|
|
319
477
|
def remove(self, draw_func):
|
|
320
|
-
"""
|
|
478
|
+
"""Remove a draw function that has been added to this menu
|
|
321
479
|
|
|
322
480
|
:param draw_func:
|
|
323
481
|
"""
|
|
324
482
|
...
|
|
325
483
|
|
|
326
484
|
def type_recast(self):
|
|
327
|
-
"""
|
|
485
|
+
"""Return a new instance, this is needed because types
|
|
486
|
+
such as textures can be changed at runtime.
|
|
487
|
+
|
|
488
|
+
:return: a new instance of this object with the type initialized again.
|
|
489
|
+
"""
|
|
328
490
|
...
|
|
329
491
|
|
|
330
492
|
def values(self):
|
|
331
|
-
"""
|
|
493
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
494
|
+
dictionary function of the same name).
|
|
495
|
+
|
|
496
|
+
:return: custom property values.
|
|
497
|
+
"""
|
|
332
498
|
...
|
|
333
499
|
|
|
334
500
|
class OUTLINER_MT_collection(bpy_types.Menu, bpy_types._GenericUI):
|
|
335
|
-
""" """
|
|
336
|
-
|
|
337
501
|
bl_label: typing.Any
|
|
338
|
-
""" """
|
|
339
|
-
|
|
340
502
|
bl_rna: typing.Any
|
|
341
|
-
""" """
|
|
342
|
-
|
|
343
503
|
id_data: typing.Any
|
|
344
|
-
""" """
|
|
345
504
|
|
|
346
505
|
def append(self, draw_func):
|
|
347
|
-
"""
|
|
506
|
+
"""Append a draw function to this menu,
|
|
507
|
+
takes the same arguments as the menus draw function
|
|
348
508
|
|
|
349
|
-
|
|
509
|
+
:param draw_func:
|
|
350
510
|
"""
|
|
351
511
|
...
|
|
352
512
|
|
|
353
|
-
def as_pointer(self):
|
|
354
|
-
"""
|
|
513
|
+
def as_pointer(self) -> int:
|
|
514
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
515
|
+
|
|
516
|
+
:return: int (memory address).
|
|
517
|
+
:rtype: int
|
|
518
|
+
"""
|
|
355
519
|
...
|
|
356
520
|
|
|
357
|
-
def bl_rna_get_subclass(self):
|
|
358
|
-
"""
|
|
521
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
522
|
+
"""
|
|
523
|
+
|
|
524
|
+
:return: The RNA type or default when not found.
|
|
525
|
+
:rtype: bpy.types.Struct
|
|
526
|
+
"""
|
|
359
527
|
...
|
|
360
528
|
|
|
361
|
-
def bl_rna_get_subclass_py(self):
|
|
362
|
-
"""
|
|
529
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
530
|
+
"""
|
|
531
|
+
|
|
532
|
+
:return: The class or default when not found.
|
|
533
|
+
:rtype: typing.Any
|
|
534
|
+
"""
|
|
363
535
|
...
|
|
364
536
|
|
|
365
537
|
def draw(self, context):
|
|
@@ -378,169 +550,258 @@ class OUTLINER_MT_collection(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
378
550
|
...
|
|
379
551
|
|
|
380
552
|
def draw_preset(self, _context):
|
|
381
|
-
"""
|
|
553
|
+
"""Define these on the subclass:
|
|
554
|
+
- preset_operator (string)
|
|
555
|
+
- preset_subdir (string)Optionally:
|
|
556
|
+
- preset_add_operator (string)
|
|
557
|
+
- preset_extensions (set of strings)
|
|
558
|
+
- preset_operator_defaults (dict of keyword args)
|
|
382
559
|
|
|
383
|
-
|
|
560
|
+
:param _context:
|
|
384
561
|
"""
|
|
385
562
|
...
|
|
386
563
|
|
|
387
|
-
def driver_add(self):
|
|
388
|
-
"""
|
|
564
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
565
|
+
"""Adds driver(s) to the given property
|
|
566
|
+
|
|
567
|
+
:return: The driver(s) added.
|
|
568
|
+
:rtype: bpy.types.FCurve
|
|
569
|
+
"""
|
|
389
570
|
...
|
|
390
571
|
|
|
391
|
-
def driver_remove(self):
|
|
392
|
-
"""
|
|
572
|
+
def driver_remove(self) -> bool:
|
|
573
|
+
"""Remove driver(s) from the given property
|
|
574
|
+
|
|
575
|
+
:return: Success of driver removal.
|
|
576
|
+
:rtype: bool
|
|
577
|
+
"""
|
|
393
578
|
...
|
|
394
579
|
|
|
395
580
|
def get(self):
|
|
396
|
-
"""
|
|
581
|
+
"""Returns the value of the custom property assigned to key or default
|
|
582
|
+
when not found (matches Python's dictionary function of the same name).
|
|
583
|
+
|
|
584
|
+
"""
|
|
397
585
|
...
|
|
398
586
|
|
|
399
587
|
def id_properties_clear(self):
|
|
400
|
-
"""
|
|
588
|
+
"""
|
|
589
|
+
|
|
590
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
591
|
+
"""
|
|
401
592
|
...
|
|
402
593
|
|
|
403
594
|
def id_properties_ensure(self):
|
|
404
|
-
"""
|
|
595
|
+
"""
|
|
596
|
+
|
|
597
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
598
|
+
"""
|
|
405
599
|
...
|
|
406
600
|
|
|
407
601
|
def id_properties_ui(self):
|
|
408
|
-
"""
|
|
409
|
-
...
|
|
602
|
+
"""
|
|
410
603
|
|
|
411
|
-
|
|
412
|
-
"""
|
|
604
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
605
|
+
"""
|
|
413
606
|
...
|
|
414
607
|
|
|
415
|
-
def
|
|
416
|
-
|
|
608
|
+
def is_extended(self): ...
|
|
609
|
+
def is_property_hidden(self) -> bool:
|
|
610
|
+
"""Check if a property is hidden.
|
|
611
|
+
|
|
612
|
+
:return: True when the property is hidden.
|
|
613
|
+
:rtype: bool
|
|
614
|
+
"""
|
|
417
615
|
...
|
|
418
616
|
|
|
419
|
-
def is_property_overridable_library(self):
|
|
420
|
-
"""
|
|
617
|
+
def is_property_overridable_library(self) -> bool:
|
|
618
|
+
"""Check if a property is overridable.
|
|
619
|
+
|
|
620
|
+
:return: True when the property is overridable.
|
|
621
|
+
:rtype: bool
|
|
622
|
+
"""
|
|
421
623
|
...
|
|
422
624
|
|
|
423
|
-
def is_property_readonly(self):
|
|
424
|
-
"""
|
|
625
|
+
def is_property_readonly(self) -> bool:
|
|
626
|
+
"""Check if a property is readonly.
|
|
627
|
+
|
|
628
|
+
:return: True when the property is readonly (not writable).
|
|
629
|
+
:rtype: bool
|
|
630
|
+
"""
|
|
425
631
|
...
|
|
426
632
|
|
|
427
|
-
def is_property_set(self):
|
|
428
|
-
"""
|
|
633
|
+
def is_property_set(self) -> bool:
|
|
634
|
+
"""Check if a property is set, use for testing operator properties.
|
|
635
|
+
|
|
636
|
+
:return: True when the property has been set.
|
|
637
|
+
:rtype: bool
|
|
638
|
+
"""
|
|
429
639
|
...
|
|
430
640
|
|
|
431
641
|
def items(self):
|
|
432
|
-
"""
|
|
642
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
643
|
+
dictionary function of the same name).
|
|
644
|
+
|
|
645
|
+
:return: custom property key, value pairs.
|
|
646
|
+
"""
|
|
433
647
|
...
|
|
434
648
|
|
|
435
|
-
def keyframe_delete(self):
|
|
436
|
-
"""
|
|
649
|
+
def keyframe_delete(self) -> bool:
|
|
650
|
+
"""Remove a keyframe from this properties fcurve.
|
|
651
|
+
|
|
652
|
+
:return: Success of keyframe deletion.
|
|
653
|
+
:rtype: bool
|
|
654
|
+
"""
|
|
437
655
|
...
|
|
438
656
|
|
|
439
|
-
def keyframe_insert(self):
|
|
440
|
-
"""
|
|
657
|
+
def keyframe_insert(self) -> bool:
|
|
658
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
659
|
+
|
|
660
|
+
:return: Success of keyframe insertion.
|
|
661
|
+
:rtype: bool
|
|
662
|
+
"""
|
|
441
663
|
...
|
|
442
664
|
|
|
443
665
|
def keys(self):
|
|
444
|
-
"""
|
|
666
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
667
|
+
dictionary function of the same name).
|
|
668
|
+
|
|
669
|
+
:return: custom property keys.
|
|
670
|
+
"""
|
|
445
671
|
...
|
|
446
672
|
|
|
447
|
-
def path_from_id(self):
|
|
448
|
-
"""
|
|
673
|
+
def path_from_id(self) -> str:
|
|
674
|
+
"""Returns the data path from the ID to this object (string).
|
|
675
|
+
|
|
676
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
677
|
+
to this struct and property (when given).
|
|
678
|
+
:rtype: str
|
|
679
|
+
"""
|
|
449
680
|
...
|
|
450
681
|
|
|
451
682
|
def path_menu(
|
|
452
683
|
self,
|
|
453
|
-
searchpaths,
|
|
454
|
-
operator,
|
|
455
|
-
props_default,
|
|
456
|
-
prop_filepath,
|
|
457
|
-
filter_ext,
|
|
458
|
-
filter_path,
|
|
459
|
-
display_name,
|
|
460
|
-
add_operator,
|
|
461
|
-
add_operator_props,
|
|
684
|
+
searchpaths: list[str],
|
|
685
|
+
operator: str,
|
|
686
|
+
props_default: dict = None,
|
|
687
|
+
prop_filepath: str = "filepath",
|
|
688
|
+
filter_ext: typing.Callable = None,
|
|
689
|
+
filter_path=None,
|
|
690
|
+
display_name: typing.Callable = None,
|
|
691
|
+
add_operator=None,
|
|
692
|
+
add_operator_props=None,
|
|
462
693
|
):
|
|
463
|
-
"""
|
|
694
|
+
"""Populate a menu from a list of paths.
|
|
695
|
+
|
|
696
|
+
:param searchpaths: Paths to scan.
|
|
697
|
+
:type searchpaths: list[str]
|
|
698
|
+
:param operator: The operator id to use with each file.
|
|
699
|
+
:type operator: str
|
|
700
|
+
:param props_default: Properties to assign to each operator.
|
|
701
|
+
:type props_default: dict
|
|
702
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
703
|
+
:type prop_filepath: str
|
|
704
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
464
705
|
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
:param add_operator:
|
|
473
|
-
:param add_operator_props:
|
|
706
|
+
Returning false excludes the file from the list.
|
|
707
|
+
:type filter_ext: typing.Callable
|
|
708
|
+
:param filter_path:
|
|
709
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
710
|
+
:type display_name: typing.Callable
|
|
711
|
+
:param add_operator:
|
|
712
|
+
:param add_operator_props:
|
|
474
713
|
"""
|
|
475
714
|
...
|
|
476
715
|
|
|
477
716
|
def path_resolve(self):
|
|
478
|
-
""" """
|
|
717
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
479
718
|
...
|
|
480
719
|
|
|
481
720
|
def pop(self):
|
|
482
|
-
"""
|
|
721
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
722
|
+
when not found (matches Python's dictionary function of the same name).
|
|
723
|
+
|
|
724
|
+
"""
|
|
483
725
|
...
|
|
484
726
|
|
|
485
727
|
def prepend(self, draw_func):
|
|
486
|
-
"""
|
|
728
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
729
|
+
the menus draw function
|
|
487
730
|
|
|
488
|
-
|
|
731
|
+
:param draw_func:
|
|
489
732
|
"""
|
|
490
733
|
...
|
|
491
734
|
|
|
492
|
-
def property_overridable_library_set(self):
|
|
493
|
-
"""
|
|
735
|
+
def property_overridable_library_set(self) -> bool:
|
|
736
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
737
|
+
|
|
738
|
+
:return: True when the overridable status of the property was successfully set.
|
|
739
|
+
:rtype: bool
|
|
740
|
+
"""
|
|
494
741
|
...
|
|
495
742
|
|
|
496
743
|
def property_unset(self):
|
|
497
|
-
""" """
|
|
744
|
+
"""Unset a property, will use default value afterward."""
|
|
498
745
|
...
|
|
499
746
|
|
|
500
747
|
def remove(self, draw_func):
|
|
501
|
-
"""
|
|
748
|
+
"""Remove a draw function that has been added to this menu
|
|
502
749
|
|
|
503
750
|
:param draw_func:
|
|
504
751
|
"""
|
|
505
752
|
...
|
|
506
753
|
|
|
507
754
|
def type_recast(self):
|
|
508
|
-
"""
|
|
755
|
+
"""Return a new instance, this is needed because types
|
|
756
|
+
such as textures can be changed at runtime.
|
|
757
|
+
|
|
758
|
+
:return: a new instance of this object with the type initialized again.
|
|
759
|
+
"""
|
|
509
760
|
...
|
|
510
761
|
|
|
511
762
|
def values(self):
|
|
512
|
-
"""
|
|
763
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
764
|
+
dictionary function of the same name).
|
|
765
|
+
|
|
766
|
+
:return: custom property values.
|
|
767
|
+
"""
|
|
513
768
|
...
|
|
514
769
|
|
|
515
770
|
class OUTLINER_MT_collection_new(bpy_types.Menu, bpy_types._GenericUI):
|
|
516
|
-
""" """
|
|
517
|
-
|
|
518
771
|
bl_label: typing.Any
|
|
519
|
-
""" """
|
|
520
|
-
|
|
521
772
|
bl_rna: typing.Any
|
|
522
|
-
""" """
|
|
523
|
-
|
|
524
773
|
id_data: typing.Any
|
|
525
|
-
""" """
|
|
526
774
|
|
|
527
775
|
def append(self, draw_func):
|
|
528
|
-
"""
|
|
776
|
+
"""Append a draw function to this menu,
|
|
777
|
+
takes the same arguments as the menus draw function
|
|
529
778
|
|
|
530
|
-
|
|
779
|
+
:param draw_func:
|
|
531
780
|
"""
|
|
532
781
|
...
|
|
533
782
|
|
|
534
|
-
def as_pointer(self):
|
|
535
|
-
"""
|
|
783
|
+
def as_pointer(self) -> int:
|
|
784
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
785
|
+
|
|
786
|
+
:return: int (memory address).
|
|
787
|
+
:rtype: int
|
|
788
|
+
"""
|
|
536
789
|
...
|
|
537
790
|
|
|
538
|
-
def bl_rna_get_subclass(self):
|
|
539
|
-
"""
|
|
791
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
792
|
+
"""
|
|
793
|
+
|
|
794
|
+
:return: The RNA type or default when not found.
|
|
795
|
+
:rtype: bpy.types.Struct
|
|
796
|
+
"""
|
|
540
797
|
...
|
|
541
798
|
|
|
542
|
-
def bl_rna_get_subclass_py(self):
|
|
543
|
-
"""
|
|
799
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
800
|
+
"""
|
|
801
|
+
|
|
802
|
+
:return: The class or default when not found.
|
|
803
|
+
:rtype: typing.Any
|
|
804
|
+
"""
|
|
544
805
|
...
|
|
545
806
|
|
|
546
807
|
def draw(self, context):
|
|
@@ -559,9 +820,14 @@ class OUTLINER_MT_collection_new(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
559
820
|
...
|
|
560
821
|
|
|
561
822
|
def draw_preset(self, _context):
|
|
562
|
-
"""
|
|
823
|
+
"""Define these on the subclass:
|
|
824
|
+
- preset_operator (string)
|
|
825
|
+
- preset_subdir (string)Optionally:
|
|
826
|
+
- preset_add_operator (string)
|
|
827
|
+
- preset_extensions (set of strings)
|
|
828
|
+
- preset_operator_defaults (dict of keyword args)
|
|
563
829
|
|
|
564
|
-
|
|
830
|
+
:param _context:
|
|
565
831
|
"""
|
|
566
832
|
...
|
|
567
833
|
|
|
@@ -573,163 +839,247 @@ class OUTLINER_MT_collection_new(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
573
839
|
"""
|
|
574
840
|
...
|
|
575
841
|
|
|
576
|
-
def driver_add(self):
|
|
577
|
-
"""
|
|
842
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
843
|
+
"""Adds driver(s) to the given property
|
|
844
|
+
|
|
845
|
+
:return: The driver(s) added.
|
|
846
|
+
:rtype: bpy.types.FCurve
|
|
847
|
+
"""
|
|
578
848
|
...
|
|
579
849
|
|
|
580
|
-
def driver_remove(self):
|
|
581
|
-
"""
|
|
850
|
+
def driver_remove(self) -> bool:
|
|
851
|
+
"""Remove driver(s) from the given property
|
|
852
|
+
|
|
853
|
+
:return: Success of driver removal.
|
|
854
|
+
:rtype: bool
|
|
855
|
+
"""
|
|
582
856
|
...
|
|
583
857
|
|
|
584
858
|
def get(self):
|
|
585
|
-
"""
|
|
859
|
+
"""Returns the value of the custom property assigned to key or default
|
|
860
|
+
when not found (matches Python's dictionary function of the same name).
|
|
861
|
+
|
|
862
|
+
"""
|
|
586
863
|
...
|
|
587
864
|
|
|
588
865
|
def id_properties_clear(self):
|
|
589
|
-
"""
|
|
866
|
+
"""
|
|
867
|
+
|
|
868
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
869
|
+
"""
|
|
590
870
|
...
|
|
591
871
|
|
|
592
872
|
def id_properties_ensure(self):
|
|
593
|
-
"""
|
|
873
|
+
"""
|
|
874
|
+
|
|
875
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
876
|
+
"""
|
|
594
877
|
...
|
|
595
878
|
|
|
596
879
|
def id_properties_ui(self):
|
|
597
|
-
"""
|
|
598
|
-
...
|
|
880
|
+
"""
|
|
599
881
|
|
|
600
|
-
|
|
601
|
-
"""
|
|
882
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
883
|
+
"""
|
|
602
884
|
...
|
|
603
885
|
|
|
604
|
-
def
|
|
605
|
-
|
|
886
|
+
def is_extended(self): ...
|
|
887
|
+
def is_property_hidden(self) -> bool:
|
|
888
|
+
"""Check if a property is hidden.
|
|
889
|
+
|
|
890
|
+
:return: True when the property is hidden.
|
|
891
|
+
:rtype: bool
|
|
892
|
+
"""
|
|
606
893
|
...
|
|
607
894
|
|
|
608
|
-
def is_property_overridable_library(self):
|
|
609
|
-
"""
|
|
895
|
+
def is_property_overridable_library(self) -> bool:
|
|
896
|
+
"""Check if a property is overridable.
|
|
897
|
+
|
|
898
|
+
:return: True when the property is overridable.
|
|
899
|
+
:rtype: bool
|
|
900
|
+
"""
|
|
610
901
|
...
|
|
611
902
|
|
|
612
|
-
def is_property_readonly(self):
|
|
613
|
-
"""
|
|
903
|
+
def is_property_readonly(self) -> bool:
|
|
904
|
+
"""Check if a property is readonly.
|
|
905
|
+
|
|
906
|
+
:return: True when the property is readonly (not writable).
|
|
907
|
+
:rtype: bool
|
|
908
|
+
"""
|
|
614
909
|
...
|
|
615
910
|
|
|
616
|
-
def is_property_set(self):
|
|
617
|
-
"""
|
|
911
|
+
def is_property_set(self) -> bool:
|
|
912
|
+
"""Check if a property is set, use for testing operator properties.
|
|
913
|
+
|
|
914
|
+
:return: True when the property has been set.
|
|
915
|
+
:rtype: bool
|
|
916
|
+
"""
|
|
618
917
|
...
|
|
619
918
|
|
|
620
919
|
def items(self):
|
|
621
|
-
"""
|
|
920
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
921
|
+
dictionary function of the same name).
|
|
922
|
+
|
|
923
|
+
:return: custom property key, value pairs.
|
|
924
|
+
"""
|
|
622
925
|
...
|
|
623
926
|
|
|
624
|
-
def keyframe_delete(self):
|
|
625
|
-
"""
|
|
927
|
+
def keyframe_delete(self) -> bool:
|
|
928
|
+
"""Remove a keyframe from this properties fcurve.
|
|
929
|
+
|
|
930
|
+
:return: Success of keyframe deletion.
|
|
931
|
+
:rtype: bool
|
|
932
|
+
"""
|
|
626
933
|
...
|
|
627
934
|
|
|
628
|
-
def keyframe_insert(self):
|
|
629
|
-
"""
|
|
935
|
+
def keyframe_insert(self) -> bool:
|
|
936
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
937
|
+
|
|
938
|
+
:return: Success of keyframe insertion.
|
|
939
|
+
:rtype: bool
|
|
940
|
+
"""
|
|
630
941
|
...
|
|
631
942
|
|
|
632
943
|
def keys(self):
|
|
633
|
-
"""
|
|
944
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
945
|
+
dictionary function of the same name).
|
|
946
|
+
|
|
947
|
+
:return: custom property keys.
|
|
948
|
+
"""
|
|
634
949
|
...
|
|
635
950
|
|
|
636
|
-
def path_from_id(self):
|
|
637
|
-
"""
|
|
951
|
+
def path_from_id(self) -> str:
|
|
952
|
+
"""Returns the data path from the ID to this object (string).
|
|
953
|
+
|
|
954
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
955
|
+
to this struct and property (when given).
|
|
956
|
+
:rtype: str
|
|
957
|
+
"""
|
|
638
958
|
...
|
|
639
959
|
|
|
640
960
|
def path_menu(
|
|
641
961
|
self,
|
|
642
|
-
searchpaths,
|
|
643
|
-
operator,
|
|
644
|
-
props_default,
|
|
645
|
-
prop_filepath,
|
|
646
|
-
filter_ext,
|
|
647
|
-
filter_path,
|
|
648
|
-
display_name,
|
|
649
|
-
add_operator,
|
|
650
|
-
add_operator_props,
|
|
962
|
+
searchpaths: list[str],
|
|
963
|
+
operator: str,
|
|
964
|
+
props_default: dict = None,
|
|
965
|
+
prop_filepath: str = "filepath",
|
|
966
|
+
filter_ext: typing.Callable = None,
|
|
967
|
+
filter_path=None,
|
|
968
|
+
display_name: typing.Callable = None,
|
|
969
|
+
add_operator=None,
|
|
970
|
+
add_operator_props=None,
|
|
651
971
|
):
|
|
652
|
-
"""
|
|
972
|
+
"""Populate a menu from a list of paths.
|
|
653
973
|
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
974
|
+
:param searchpaths: Paths to scan.
|
|
975
|
+
:type searchpaths: list[str]
|
|
976
|
+
:param operator: The operator id to use with each file.
|
|
977
|
+
:type operator: str
|
|
978
|
+
:param props_default: Properties to assign to each operator.
|
|
979
|
+
:type props_default: dict
|
|
980
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
981
|
+
:type prop_filepath: str
|
|
982
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
983
|
+
|
|
984
|
+
Returning false excludes the file from the list.
|
|
985
|
+
:type filter_ext: typing.Callable
|
|
986
|
+
:param filter_path:
|
|
987
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
988
|
+
:type display_name: typing.Callable
|
|
989
|
+
:param add_operator:
|
|
990
|
+
:param add_operator_props:
|
|
663
991
|
"""
|
|
664
992
|
...
|
|
665
993
|
|
|
666
994
|
def path_resolve(self):
|
|
667
|
-
""" """
|
|
995
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
668
996
|
...
|
|
669
997
|
|
|
670
998
|
def pop(self):
|
|
671
|
-
"""
|
|
999
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1000
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1001
|
+
|
|
1002
|
+
"""
|
|
672
1003
|
...
|
|
673
1004
|
|
|
674
1005
|
def prepend(self, draw_func):
|
|
675
|
-
"""
|
|
1006
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1007
|
+
the menus draw function
|
|
676
1008
|
|
|
677
|
-
|
|
1009
|
+
:param draw_func:
|
|
678
1010
|
"""
|
|
679
1011
|
...
|
|
680
1012
|
|
|
681
|
-
def property_overridable_library_set(self):
|
|
682
|
-
"""
|
|
1013
|
+
def property_overridable_library_set(self) -> bool:
|
|
1014
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1015
|
+
|
|
1016
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1017
|
+
:rtype: bool
|
|
1018
|
+
"""
|
|
683
1019
|
...
|
|
684
1020
|
|
|
685
1021
|
def property_unset(self):
|
|
686
|
-
""" """
|
|
1022
|
+
"""Unset a property, will use default value afterward."""
|
|
687
1023
|
...
|
|
688
1024
|
|
|
689
1025
|
def remove(self, draw_func):
|
|
690
|
-
"""
|
|
1026
|
+
"""Remove a draw function that has been added to this menu
|
|
691
1027
|
|
|
692
1028
|
:param draw_func:
|
|
693
1029
|
"""
|
|
694
1030
|
...
|
|
695
1031
|
|
|
696
1032
|
def type_recast(self):
|
|
697
|
-
"""
|
|
1033
|
+
"""Return a new instance, this is needed because types
|
|
1034
|
+
such as textures can be changed at runtime.
|
|
1035
|
+
|
|
1036
|
+
:return: a new instance of this object with the type initialized again.
|
|
1037
|
+
"""
|
|
698
1038
|
...
|
|
699
1039
|
|
|
700
1040
|
def values(self):
|
|
701
|
-
"""
|
|
1041
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1042
|
+
dictionary function of the same name).
|
|
1043
|
+
|
|
1044
|
+
:return: custom property values.
|
|
1045
|
+
"""
|
|
702
1046
|
...
|
|
703
1047
|
|
|
704
1048
|
class OUTLINER_MT_collection_view_layer(bpy_types.Menu, bpy_types._GenericUI):
|
|
705
|
-
""" """
|
|
706
|
-
|
|
707
1049
|
bl_label: typing.Any
|
|
708
|
-
""" """
|
|
709
|
-
|
|
710
1050
|
bl_rna: typing.Any
|
|
711
|
-
""" """
|
|
712
|
-
|
|
713
1051
|
id_data: typing.Any
|
|
714
|
-
""" """
|
|
715
1052
|
|
|
716
1053
|
def append(self, draw_func):
|
|
717
|
-
"""
|
|
1054
|
+
"""Append a draw function to this menu,
|
|
1055
|
+
takes the same arguments as the menus draw function
|
|
718
1056
|
|
|
719
|
-
|
|
1057
|
+
:param draw_func:
|
|
720
1058
|
"""
|
|
721
1059
|
...
|
|
722
1060
|
|
|
723
|
-
def as_pointer(self):
|
|
724
|
-
"""
|
|
1061
|
+
def as_pointer(self) -> int:
|
|
1062
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1063
|
+
|
|
1064
|
+
:return: int (memory address).
|
|
1065
|
+
:rtype: int
|
|
1066
|
+
"""
|
|
725
1067
|
...
|
|
726
1068
|
|
|
727
|
-
def bl_rna_get_subclass(self):
|
|
728
|
-
"""
|
|
1069
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1070
|
+
"""
|
|
1071
|
+
|
|
1072
|
+
:return: The RNA type or default when not found.
|
|
1073
|
+
:rtype: bpy.types.Struct
|
|
1074
|
+
"""
|
|
729
1075
|
...
|
|
730
1076
|
|
|
731
|
-
def bl_rna_get_subclass_py(self):
|
|
732
|
-
"""
|
|
1077
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1078
|
+
"""
|
|
1079
|
+
|
|
1080
|
+
:return: The class or default when not found.
|
|
1081
|
+
:rtype: typing.Any
|
|
1082
|
+
"""
|
|
733
1083
|
...
|
|
734
1084
|
|
|
735
1085
|
def draw(self, context):
|
|
@@ -748,169 +1098,258 @@ class OUTLINER_MT_collection_view_layer(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
748
1098
|
...
|
|
749
1099
|
|
|
750
1100
|
def draw_preset(self, _context):
|
|
751
|
-
"""
|
|
1101
|
+
"""Define these on the subclass:
|
|
1102
|
+
- preset_operator (string)
|
|
1103
|
+
- preset_subdir (string)Optionally:
|
|
1104
|
+
- preset_add_operator (string)
|
|
1105
|
+
- preset_extensions (set of strings)
|
|
1106
|
+
- preset_operator_defaults (dict of keyword args)
|
|
752
1107
|
|
|
753
|
-
|
|
1108
|
+
:param _context:
|
|
754
1109
|
"""
|
|
755
1110
|
...
|
|
756
1111
|
|
|
757
|
-
def driver_add(self):
|
|
758
|
-
"""
|
|
759
|
-
...
|
|
1112
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1113
|
+
"""Adds driver(s) to the given property
|
|
760
1114
|
|
|
761
|
-
|
|
762
|
-
|
|
1115
|
+
:return: The driver(s) added.
|
|
1116
|
+
:rtype: bpy.types.FCurve
|
|
1117
|
+
"""
|
|
1118
|
+
...
|
|
1119
|
+
|
|
1120
|
+
def driver_remove(self) -> bool:
|
|
1121
|
+
"""Remove driver(s) from the given property
|
|
1122
|
+
|
|
1123
|
+
:return: Success of driver removal.
|
|
1124
|
+
:rtype: bool
|
|
1125
|
+
"""
|
|
763
1126
|
...
|
|
764
1127
|
|
|
765
1128
|
def get(self):
|
|
766
|
-
"""
|
|
1129
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1130
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1131
|
+
|
|
1132
|
+
"""
|
|
767
1133
|
...
|
|
768
1134
|
|
|
769
1135
|
def id_properties_clear(self):
|
|
770
|
-
"""
|
|
1136
|
+
"""
|
|
1137
|
+
|
|
1138
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1139
|
+
"""
|
|
771
1140
|
...
|
|
772
1141
|
|
|
773
1142
|
def id_properties_ensure(self):
|
|
774
|
-
"""
|
|
1143
|
+
"""
|
|
1144
|
+
|
|
1145
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1146
|
+
"""
|
|
775
1147
|
...
|
|
776
1148
|
|
|
777
1149
|
def id_properties_ui(self):
|
|
778
|
-
"""
|
|
779
|
-
...
|
|
1150
|
+
"""
|
|
780
1151
|
|
|
781
|
-
|
|
782
|
-
"""
|
|
1152
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1153
|
+
"""
|
|
783
1154
|
...
|
|
784
1155
|
|
|
785
|
-
def
|
|
786
|
-
|
|
1156
|
+
def is_extended(self): ...
|
|
1157
|
+
def is_property_hidden(self) -> bool:
|
|
1158
|
+
"""Check if a property is hidden.
|
|
1159
|
+
|
|
1160
|
+
:return: True when the property is hidden.
|
|
1161
|
+
:rtype: bool
|
|
1162
|
+
"""
|
|
787
1163
|
...
|
|
788
1164
|
|
|
789
|
-
def is_property_overridable_library(self):
|
|
790
|
-
"""
|
|
1165
|
+
def is_property_overridable_library(self) -> bool:
|
|
1166
|
+
"""Check if a property is overridable.
|
|
1167
|
+
|
|
1168
|
+
:return: True when the property is overridable.
|
|
1169
|
+
:rtype: bool
|
|
1170
|
+
"""
|
|
791
1171
|
...
|
|
792
1172
|
|
|
793
|
-
def is_property_readonly(self):
|
|
794
|
-
"""
|
|
1173
|
+
def is_property_readonly(self) -> bool:
|
|
1174
|
+
"""Check if a property is readonly.
|
|
1175
|
+
|
|
1176
|
+
:return: True when the property is readonly (not writable).
|
|
1177
|
+
:rtype: bool
|
|
1178
|
+
"""
|
|
795
1179
|
...
|
|
796
1180
|
|
|
797
|
-
def is_property_set(self):
|
|
798
|
-
"""
|
|
1181
|
+
def is_property_set(self) -> bool:
|
|
1182
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1183
|
+
|
|
1184
|
+
:return: True when the property has been set.
|
|
1185
|
+
:rtype: bool
|
|
1186
|
+
"""
|
|
799
1187
|
...
|
|
800
1188
|
|
|
801
1189
|
def items(self):
|
|
802
|
-
"""
|
|
1190
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1191
|
+
dictionary function of the same name).
|
|
1192
|
+
|
|
1193
|
+
:return: custom property key, value pairs.
|
|
1194
|
+
"""
|
|
803
1195
|
...
|
|
804
1196
|
|
|
805
|
-
def keyframe_delete(self):
|
|
806
|
-
"""
|
|
1197
|
+
def keyframe_delete(self) -> bool:
|
|
1198
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1199
|
+
|
|
1200
|
+
:return: Success of keyframe deletion.
|
|
1201
|
+
:rtype: bool
|
|
1202
|
+
"""
|
|
807
1203
|
...
|
|
808
1204
|
|
|
809
|
-
def keyframe_insert(self):
|
|
810
|
-
"""
|
|
1205
|
+
def keyframe_insert(self) -> bool:
|
|
1206
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1207
|
+
|
|
1208
|
+
:return: Success of keyframe insertion.
|
|
1209
|
+
:rtype: bool
|
|
1210
|
+
"""
|
|
811
1211
|
...
|
|
812
1212
|
|
|
813
1213
|
def keys(self):
|
|
814
|
-
"""
|
|
1214
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1215
|
+
dictionary function of the same name).
|
|
1216
|
+
|
|
1217
|
+
:return: custom property keys.
|
|
1218
|
+
"""
|
|
815
1219
|
...
|
|
816
1220
|
|
|
817
|
-
def path_from_id(self):
|
|
818
|
-
"""
|
|
1221
|
+
def path_from_id(self) -> str:
|
|
1222
|
+
"""Returns the data path from the ID to this object (string).
|
|
1223
|
+
|
|
1224
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1225
|
+
to this struct and property (when given).
|
|
1226
|
+
:rtype: str
|
|
1227
|
+
"""
|
|
819
1228
|
...
|
|
820
1229
|
|
|
821
1230
|
def path_menu(
|
|
822
1231
|
self,
|
|
823
|
-
searchpaths,
|
|
824
|
-
operator,
|
|
825
|
-
props_default,
|
|
826
|
-
prop_filepath,
|
|
827
|
-
filter_ext,
|
|
828
|
-
filter_path,
|
|
829
|
-
display_name,
|
|
830
|
-
add_operator,
|
|
831
|
-
add_operator_props,
|
|
1232
|
+
searchpaths: list[str],
|
|
1233
|
+
operator: str,
|
|
1234
|
+
props_default: dict = None,
|
|
1235
|
+
prop_filepath: str = "filepath",
|
|
1236
|
+
filter_ext: typing.Callable = None,
|
|
1237
|
+
filter_path=None,
|
|
1238
|
+
display_name: typing.Callable = None,
|
|
1239
|
+
add_operator=None,
|
|
1240
|
+
add_operator_props=None,
|
|
832
1241
|
):
|
|
833
|
-
"""
|
|
1242
|
+
"""Populate a menu from a list of paths.
|
|
1243
|
+
|
|
1244
|
+
:param searchpaths: Paths to scan.
|
|
1245
|
+
:type searchpaths: list[str]
|
|
1246
|
+
:param operator: The operator id to use with each file.
|
|
1247
|
+
:type operator: str
|
|
1248
|
+
:param props_default: Properties to assign to each operator.
|
|
1249
|
+
:type props_default: dict
|
|
1250
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1251
|
+
:type prop_filepath: str
|
|
1252
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
834
1253
|
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
:param add_operator:
|
|
843
|
-
:param add_operator_props:
|
|
1254
|
+
Returning false excludes the file from the list.
|
|
1255
|
+
:type filter_ext: typing.Callable
|
|
1256
|
+
:param filter_path:
|
|
1257
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1258
|
+
:type display_name: typing.Callable
|
|
1259
|
+
:param add_operator:
|
|
1260
|
+
:param add_operator_props:
|
|
844
1261
|
"""
|
|
845
1262
|
...
|
|
846
1263
|
|
|
847
1264
|
def path_resolve(self):
|
|
848
|
-
""" """
|
|
1265
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
849
1266
|
...
|
|
850
1267
|
|
|
851
1268
|
def pop(self):
|
|
852
|
-
"""
|
|
1269
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1270
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1271
|
+
|
|
1272
|
+
"""
|
|
853
1273
|
...
|
|
854
1274
|
|
|
855
1275
|
def prepend(self, draw_func):
|
|
856
|
-
"""
|
|
1276
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1277
|
+
the menus draw function
|
|
857
1278
|
|
|
858
|
-
|
|
1279
|
+
:param draw_func:
|
|
859
1280
|
"""
|
|
860
1281
|
...
|
|
861
1282
|
|
|
862
|
-
def property_overridable_library_set(self):
|
|
863
|
-
"""
|
|
1283
|
+
def property_overridable_library_set(self) -> bool:
|
|
1284
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1285
|
+
|
|
1286
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1287
|
+
:rtype: bool
|
|
1288
|
+
"""
|
|
864
1289
|
...
|
|
865
1290
|
|
|
866
1291
|
def property_unset(self):
|
|
867
|
-
""" """
|
|
1292
|
+
"""Unset a property, will use default value afterward."""
|
|
868
1293
|
...
|
|
869
1294
|
|
|
870
1295
|
def remove(self, draw_func):
|
|
871
|
-
"""
|
|
1296
|
+
"""Remove a draw function that has been added to this menu
|
|
872
1297
|
|
|
873
1298
|
:param draw_func:
|
|
874
1299
|
"""
|
|
875
1300
|
...
|
|
876
1301
|
|
|
877
1302
|
def type_recast(self):
|
|
878
|
-
"""
|
|
1303
|
+
"""Return a new instance, this is needed because types
|
|
1304
|
+
such as textures can be changed at runtime.
|
|
1305
|
+
|
|
1306
|
+
:return: a new instance of this object with the type initialized again.
|
|
1307
|
+
"""
|
|
879
1308
|
...
|
|
880
1309
|
|
|
881
1310
|
def values(self):
|
|
882
|
-
"""
|
|
1311
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1312
|
+
dictionary function of the same name).
|
|
1313
|
+
|
|
1314
|
+
:return: custom property values.
|
|
1315
|
+
"""
|
|
883
1316
|
...
|
|
884
1317
|
|
|
885
1318
|
class OUTLINER_MT_collection_visibility(bpy_types.Menu, bpy_types._GenericUI):
|
|
886
|
-
""" """
|
|
887
|
-
|
|
888
1319
|
bl_label: typing.Any
|
|
889
|
-
""" """
|
|
890
|
-
|
|
891
1320
|
bl_rna: typing.Any
|
|
892
|
-
""" """
|
|
893
|
-
|
|
894
1321
|
id_data: typing.Any
|
|
895
|
-
""" """
|
|
896
1322
|
|
|
897
1323
|
def append(self, draw_func):
|
|
898
|
-
"""
|
|
1324
|
+
"""Append a draw function to this menu,
|
|
1325
|
+
takes the same arguments as the menus draw function
|
|
899
1326
|
|
|
900
|
-
|
|
1327
|
+
:param draw_func:
|
|
901
1328
|
"""
|
|
902
1329
|
...
|
|
903
1330
|
|
|
904
|
-
def as_pointer(self):
|
|
905
|
-
"""
|
|
1331
|
+
def as_pointer(self) -> int:
|
|
1332
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1333
|
+
|
|
1334
|
+
:return: int (memory address).
|
|
1335
|
+
:rtype: int
|
|
1336
|
+
"""
|
|
906
1337
|
...
|
|
907
1338
|
|
|
908
|
-
def bl_rna_get_subclass(self):
|
|
909
|
-
"""
|
|
1339
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1340
|
+
"""
|
|
1341
|
+
|
|
1342
|
+
:return: The RNA type or default when not found.
|
|
1343
|
+
:rtype: bpy.types.Struct
|
|
1344
|
+
"""
|
|
910
1345
|
...
|
|
911
1346
|
|
|
912
|
-
def bl_rna_get_subclass_py(self):
|
|
913
|
-
"""
|
|
1347
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1348
|
+
"""
|
|
1349
|
+
|
|
1350
|
+
:return: The class or default when not found.
|
|
1351
|
+
:rtype: typing.Any
|
|
1352
|
+
"""
|
|
914
1353
|
...
|
|
915
1354
|
|
|
916
1355
|
def draw(self, _context):
|
|
@@ -929,169 +1368,258 @@ class OUTLINER_MT_collection_visibility(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
929
1368
|
...
|
|
930
1369
|
|
|
931
1370
|
def draw_preset(self, _context):
|
|
932
|
-
"""
|
|
1371
|
+
"""Define these on the subclass:
|
|
1372
|
+
- preset_operator (string)
|
|
1373
|
+
- preset_subdir (string)Optionally:
|
|
1374
|
+
- preset_add_operator (string)
|
|
1375
|
+
- preset_extensions (set of strings)
|
|
1376
|
+
- preset_operator_defaults (dict of keyword args)
|
|
933
1377
|
|
|
934
|
-
|
|
1378
|
+
:param _context:
|
|
935
1379
|
"""
|
|
936
1380
|
...
|
|
937
1381
|
|
|
938
|
-
def driver_add(self):
|
|
939
|
-
"""
|
|
1382
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1383
|
+
"""Adds driver(s) to the given property
|
|
1384
|
+
|
|
1385
|
+
:return: The driver(s) added.
|
|
1386
|
+
:rtype: bpy.types.FCurve
|
|
1387
|
+
"""
|
|
940
1388
|
...
|
|
941
1389
|
|
|
942
|
-
def driver_remove(self):
|
|
943
|
-
"""
|
|
1390
|
+
def driver_remove(self) -> bool:
|
|
1391
|
+
"""Remove driver(s) from the given property
|
|
1392
|
+
|
|
1393
|
+
:return: Success of driver removal.
|
|
1394
|
+
:rtype: bool
|
|
1395
|
+
"""
|
|
944
1396
|
...
|
|
945
1397
|
|
|
946
1398
|
def get(self):
|
|
947
|
-
"""
|
|
1399
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1400
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1401
|
+
|
|
1402
|
+
"""
|
|
948
1403
|
...
|
|
949
1404
|
|
|
950
1405
|
def id_properties_clear(self):
|
|
951
|
-
"""
|
|
1406
|
+
"""
|
|
1407
|
+
|
|
1408
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1409
|
+
"""
|
|
952
1410
|
...
|
|
953
1411
|
|
|
954
1412
|
def id_properties_ensure(self):
|
|
955
|
-
"""
|
|
1413
|
+
"""
|
|
1414
|
+
|
|
1415
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1416
|
+
"""
|
|
956
1417
|
...
|
|
957
1418
|
|
|
958
1419
|
def id_properties_ui(self):
|
|
959
|
-
"""
|
|
960
|
-
...
|
|
1420
|
+
"""
|
|
961
1421
|
|
|
962
|
-
|
|
963
|
-
"""
|
|
1422
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1423
|
+
"""
|
|
964
1424
|
...
|
|
965
1425
|
|
|
966
|
-
def
|
|
967
|
-
|
|
1426
|
+
def is_extended(self): ...
|
|
1427
|
+
def is_property_hidden(self) -> bool:
|
|
1428
|
+
"""Check if a property is hidden.
|
|
1429
|
+
|
|
1430
|
+
:return: True when the property is hidden.
|
|
1431
|
+
:rtype: bool
|
|
1432
|
+
"""
|
|
968
1433
|
...
|
|
969
1434
|
|
|
970
|
-
def is_property_overridable_library(self):
|
|
971
|
-
"""
|
|
1435
|
+
def is_property_overridable_library(self) -> bool:
|
|
1436
|
+
"""Check if a property is overridable.
|
|
1437
|
+
|
|
1438
|
+
:return: True when the property is overridable.
|
|
1439
|
+
:rtype: bool
|
|
1440
|
+
"""
|
|
972
1441
|
...
|
|
973
1442
|
|
|
974
|
-
def is_property_readonly(self):
|
|
975
|
-
"""
|
|
1443
|
+
def is_property_readonly(self) -> bool:
|
|
1444
|
+
"""Check if a property is readonly.
|
|
1445
|
+
|
|
1446
|
+
:return: True when the property is readonly (not writable).
|
|
1447
|
+
:rtype: bool
|
|
1448
|
+
"""
|
|
976
1449
|
...
|
|
977
1450
|
|
|
978
|
-
def is_property_set(self):
|
|
979
|
-
"""
|
|
1451
|
+
def is_property_set(self) -> bool:
|
|
1452
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1453
|
+
|
|
1454
|
+
:return: True when the property has been set.
|
|
1455
|
+
:rtype: bool
|
|
1456
|
+
"""
|
|
980
1457
|
...
|
|
981
1458
|
|
|
982
1459
|
def items(self):
|
|
983
|
-
"""
|
|
1460
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1461
|
+
dictionary function of the same name).
|
|
1462
|
+
|
|
1463
|
+
:return: custom property key, value pairs.
|
|
1464
|
+
"""
|
|
984
1465
|
...
|
|
985
1466
|
|
|
986
|
-
def keyframe_delete(self):
|
|
987
|
-
"""
|
|
1467
|
+
def keyframe_delete(self) -> bool:
|
|
1468
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1469
|
+
|
|
1470
|
+
:return: Success of keyframe deletion.
|
|
1471
|
+
:rtype: bool
|
|
1472
|
+
"""
|
|
988
1473
|
...
|
|
989
1474
|
|
|
990
|
-
def keyframe_insert(self):
|
|
991
|
-
"""
|
|
1475
|
+
def keyframe_insert(self) -> bool:
|
|
1476
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1477
|
+
|
|
1478
|
+
:return: Success of keyframe insertion.
|
|
1479
|
+
:rtype: bool
|
|
1480
|
+
"""
|
|
992
1481
|
...
|
|
993
1482
|
|
|
994
1483
|
def keys(self):
|
|
995
|
-
"""
|
|
1484
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1485
|
+
dictionary function of the same name).
|
|
1486
|
+
|
|
1487
|
+
:return: custom property keys.
|
|
1488
|
+
"""
|
|
996
1489
|
...
|
|
997
1490
|
|
|
998
|
-
def path_from_id(self):
|
|
999
|
-
"""
|
|
1491
|
+
def path_from_id(self) -> str:
|
|
1492
|
+
"""Returns the data path from the ID to this object (string).
|
|
1493
|
+
|
|
1494
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1495
|
+
to this struct and property (when given).
|
|
1496
|
+
:rtype: str
|
|
1497
|
+
"""
|
|
1000
1498
|
...
|
|
1001
1499
|
|
|
1002
1500
|
def path_menu(
|
|
1003
1501
|
self,
|
|
1004
|
-
searchpaths,
|
|
1005
|
-
operator,
|
|
1006
|
-
props_default,
|
|
1007
|
-
prop_filepath,
|
|
1008
|
-
filter_ext,
|
|
1009
|
-
filter_path,
|
|
1010
|
-
display_name,
|
|
1011
|
-
add_operator,
|
|
1012
|
-
add_operator_props,
|
|
1502
|
+
searchpaths: list[str],
|
|
1503
|
+
operator: str,
|
|
1504
|
+
props_default: dict = None,
|
|
1505
|
+
prop_filepath: str = "filepath",
|
|
1506
|
+
filter_ext: typing.Callable = None,
|
|
1507
|
+
filter_path=None,
|
|
1508
|
+
display_name: typing.Callable = None,
|
|
1509
|
+
add_operator=None,
|
|
1510
|
+
add_operator_props=None,
|
|
1013
1511
|
):
|
|
1014
|
-
"""
|
|
1512
|
+
"""Populate a menu from a list of paths.
|
|
1015
1513
|
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1514
|
+
:param searchpaths: Paths to scan.
|
|
1515
|
+
:type searchpaths: list[str]
|
|
1516
|
+
:param operator: The operator id to use with each file.
|
|
1517
|
+
:type operator: str
|
|
1518
|
+
:param props_default: Properties to assign to each operator.
|
|
1519
|
+
:type props_default: dict
|
|
1520
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1521
|
+
:type prop_filepath: str
|
|
1522
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1523
|
+
|
|
1524
|
+
Returning false excludes the file from the list.
|
|
1525
|
+
:type filter_ext: typing.Callable
|
|
1526
|
+
:param filter_path:
|
|
1527
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1528
|
+
:type display_name: typing.Callable
|
|
1529
|
+
:param add_operator:
|
|
1530
|
+
:param add_operator_props:
|
|
1025
1531
|
"""
|
|
1026
1532
|
...
|
|
1027
1533
|
|
|
1028
1534
|
def path_resolve(self):
|
|
1029
|
-
""" """
|
|
1535
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1030
1536
|
...
|
|
1031
1537
|
|
|
1032
1538
|
def pop(self):
|
|
1033
|
-
"""
|
|
1539
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1540
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1541
|
+
|
|
1542
|
+
"""
|
|
1034
1543
|
...
|
|
1035
1544
|
|
|
1036
1545
|
def prepend(self, draw_func):
|
|
1037
|
-
"""
|
|
1546
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1547
|
+
the menus draw function
|
|
1038
1548
|
|
|
1039
|
-
|
|
1549
|
+
:param draw_func:
|
|
1040
1550
|
"""
|
|
1041
1551
|
...
|
|
1042
1552
|
|
|
1043
|
-
def property_overridable_library_set(self):
|
|
1044
|
-
"""
|
|
1553
|
+
def property_overridable_library_set(self) -> bool:
|
|
1554
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1555
|
+
|
|
1556
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1557
|
+
:rtype: bool
|
|
1558
|
+
"""
|
|
1045
1559
|
...
|
|
1046
1560
|
|
|
1047
1561
|
def property_unset(self):
|
|
1048
|
-
""" """
|
|
1562
|
+
"""Unset a property, will use default value afterward."""
|
|
1049
1563
|
...
|
|
1050
1564
|
|
|
1051
1565
|
def remove(self, draw_func):
|
|
1052
|
-
"""
|
|
1566
|
+
"""Remove a draw function that has been added to this menu
|
|
1053
1567
|
|
|
1054
1568
|
:param draw_func:
|
|
1055
1569
|
"""
|
|
1056
1570
|
...
|
|
1057
1571
|
|
|
1058
1572
|
def type_recast(self):
|
|
1059
|
-
"""
|
|
1573
|
+
"""Return a new instance, this is needed because types
|
|
1574
|
+
such as textures can be changed at runtime.
|
|
1575
|
+
|
|
1576
|
+
:return: a new instance of this object with the type initialized again.
|
|
1577
|
+
"""
|
|
1060
1578
|
...
|
|
1061
1579
|
|
|
1062
1580
|
def values(self):
|
|
1063
|
-
"""
|
|
1581
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1582
|
+
dictionary function of the same name).
|
|
1583
|
+
|
|
1584
|
+
:return: custom property values.
|
|
1585
|
+
"""
|
|
1064
1586
|
...
|
|
1065
1587
|
|
|
1066
1588
|
class OUTLINER_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
1067
|
-
""" """
|
|
1068
|
-
|
|
1069
1589
|
bl_label: typing.Any
|
|
1070
|
-
""" """
|
|
1071
|
-
|
|
1072
1590
|
bl_rna: typing.Any
|
|
1073
|
-
""" """
|
|
1074
|
-
|
|
1075
1591
|
id_data: typing.Any
|
|
1076
|
-
""" """
|
|
1077
1592
|
|
|
1078
1593
|
def append(self, draw_func):
|
|
1079
|
-
"""
|
|
1594
|
+
"""Append a draw function to this menu,
|
|
1595
|
+
takes the same arguments as the menus draw function
|
|
1080
1596
|
|
|
1081
|
-
|
|
1597
|
+
:param draw_func:
|
|
1082
1598
|
"""
|
|
1083
1599
|
...
|
|
1084
1600
|
|
|
1085
|
-
def as_pointer(self):
|
|
1086
|
-
"""
|
|
1601
|
+
def as_pointer(self) -> int:
|
|
1602
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1603
|
+
|
|
1604
|
+
:return: int (memory address).
|
|
1605
|
+
:rtype: int
|
|
1606
|
+
"""
|
|
1087
1607
|
...
|
|
1088
1608
|
|
|
1089
|
-
def bl_rna_get_subclass(self):
|
|
1090
|
-
"""
|
|
1609
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1610
|
+
"""
|
|
1611
|
+
|
|
1612
|
+
:return: The RNA type or default when not found.
|
|
1613
|
+
:rtype: bpy.types.Struct
|
|
1614
|
+
"""
|
|
1091
1615
|
...
|
|
1092
1616
|
|
|
1093
|
-
def bl_rna_get_subclass_py(self):
|
|
1094
|
-
"""
|
|
1617
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1618
|
+
"""
|
|
1619
|
+
|
|
1620
|
+
:return: The class or default when not found.
|
|
1621
|
+
:rtype: typing.Any
|
|
1622
|
+
"""
|
|
1095
1623
|
...
|
|
1096
1624
|
|
|
1097
1625
|
def draw(self, context):
|
|
@@ -1117,169 +1645,258 @@ class OUTLINER_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1117
1645
|
...
|
|
1118
1646
|
|
|
1119
1647
|
def draw_preset(self, _context):
|
|
1120
|
-
"""
|
|
1648
|
+
"""Define these on the subclass:
|
|
1649
|
+
- preset_operator (string)
|
|
1650
|
+
- preset_subdir (string)Optionally:
|
|
1651
|
+
- preset_add_operator (string)
|
|
1652
|
+
- preset_extensions (set of strings)
|
|
1653
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1121
1654
|
|
|
1122
|
-
|
|
1655
|
+
:param _context:
|
|
1123
1656
|
"""
|
|
1124
1657
|
...
|
|
1125
1658
|
|
|
1126
|
-
def driver_add(self):
|
|
1127
|
-
"""
|
|
1659
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1660
|
+
"""Adds driver(s) to the given property
|
|
1661
|
+
|
|
1662
|
+
:return: The driver(s) added.
|
|
1663
|
+
:rtype: bpy.types.FCurve
|
|
1664
|
+
"""
|
|
1128
1665
|
...
|
|
1129
1666
|
|
|
1130
|
-
def driver_remove(self):
|
|
1131
|
-
"""
|
|
1667
|
+
def driver_remove(self) -> bool:
|
|
1668
|
+
"""Remove driver(s) from the given property
|
|
1669
|
+
|
|
1670
|
+
:return: Success of driver removal.
|
|
1671
|
+
:rtype: bool
|
|
1672
|
+
"""
|
|
1132
1673
|
...
|
|
1133
1674
|
|
|
1134
1675
|
def get(self):
|
|
1135
|
-
"""
|
|
1676
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1677
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1678
|
+
|
|
1679
|
+
"""
|
|
1136
1680
|
...
|
|
1137
1681
|
|
|
1138
1682
|
def id_properties_clear(self):
|
|
1139
|
-
"""
|
|
1683
|
+
"""
|
|
1684
|
+
|
|
1685
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1686
|
+
"""
|
|
1140
1687
|
...
|
|
1141
1688
|
|
|
1142
1689
|
def id_properties_ensure(self):
|
|
1143
|
-
"""
|
|
1690
|
+
"""
|
|
1691
|
+
|
|
1692
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1693
|
+
"""
|
|
1144
1694
|
...
|
|
1145
1695
|
|
|
1146
1696
|
def id_properties_ui(self):
|
|
1147
|
-
"""
|
|
1148
|
-
...
|
|
1697
|
+
"""
|
|
1149
1698
|
|
|
1150
|
-
|
|
1151
|
-
"""
|
|
1699
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1700
|
+
"""
|
|
1152
1701
|
...
|
|
1153
1702
|
|
|
1154
|
-
def
|
|
1155
|
-
|
|
1703
|
+
def is_extended(self): ...
|
|
1704
|
+
def is_property_hidden(self) -> bool:
|
|
1705
|
+
"""Check if a property is hidden.
|
|
1706
|
+
|
|
1707
|
+
:return: True when the property is hidden.
|
|
1708
|
+
:rtype: bool
|
|
1709
|
+
"""
|
|
1156
1710
|
...
|
|
1157
1711
|
|
|
1158
|
-
def is_property_overridable_library(self):
|
|
1159
|
-
"""
|
|
1712
|
+
def is_property_overridable_library(self) -> bool:
|
|
1713
|
+
"""Check if a property is overridable.
|
|
1714
|
+
|
|
1715
|
+
:return: True when the property is overridable.
|
|
1716
|
+
:rtype: bool
|
|
1717
|
+
"""
|
|
1160
1718
|
...
|
|
1161
1719
|
|
|
1162
|
-
def is_property_readonly(self):
|
|
1163
|
-
"""
|
|
1720
|
+
def is_property_readonly(self) -> bool:
|
|
1721
|
+
"""Check if a property is readonly.
|
|
1722
|
+
|
|
1723
|
+
:return: True when the property is readonly (not writable).
|
|
1724
|
+
:rtype: bool
|
|
1725
|
+
"""
|
|
1164
1726
|
...
|
|
1165
1727
|
|
|
1166
|
-
def is_property_set(self):
|
|
1167
|
-
"""
|
|
1728
|
+
def is_property_set(self) -> bool:
|
|
1729
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1730
|
+
|
|
1731
|
+
:return: True when the property has been set.
|
|
1732
|
+
:rtype: bool
|
|
1733
|
+
"""
|
|
1168
1734
|
...
|
|
1169
1735
|
|
|
1170
1736
|
def items(self):
|
|
1171
|
-
"""
|
|
1737
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1738
|
+
dictionary function of the same name).
|
|
1739
|
+
|
|
1740
|
+
:return: custom property key, value pairs.
|
|
1741
|
+
"""
|
|
1172
1742
|
...
|
|
1173
1743
|
|
|
1174
|
-
def keyframe_delete(self):
|
|
1175
|
-
"""
|
|
1744
|
+
def keyframe_delete(self) -> bool:
|
|
1745
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1746
|
+
|
|
1747
|
+
:return: Success of keyframe deletion.
|
|
1748
|
+
:rtype: bool
|
|
1749
|
+
"""
|
|
1176
1750
|
...
|
|
1177
1751
|
|
|
1178
|
-
def keyframe_insert(self):
|
|
1179
|
-
"""
|
|
1752
|
+
def keyframe_insert(self) -> bool:
|
|
1753
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1754
|
+
|
|
1755
|
+
:return: Success of keyframe insertion.
|
|
1756
|
+
:rtype: bool
|
|
1757
|
+
"""
|
|
1180
1758
|
...
|
|
1181
1759
|
|
|
1182
1760
|
def keys(self):
|
|
1183
|
-
"""
|
|
1761
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1762
|
+
dictionary function of the same name).
|
|
1763
|
+
|
|
1764
|
+
:return: custom property keys.
|
|
1765
|
+
"""
|
|
1184
1766
|
...
|
|
1185
1767
|
|
|
1186
|
-
def path_from_id(self):
|
|
1187
|
-
"""
|
|
1768
|
+
def path_from_id(self) -> str:
|
|
1769
|
+
"""Returns the data path from the ID to this object (string).
|
|
1770
|
+
|
|
1771
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1772
|
+
to this struct and property (when given).
|
|
1773
|
+
:rtype: str
|
|
1774
|
+
"""
|
|
1188
1775
|
...
|
|
1189
1776
|
|
|
1190
1777
|
def path_menu(
|
|
1191
1778
|
self,
|
|
1192
|
-
searchpaths,
|
|
1193
|
-
operator,
|
|
1194
|
-
props_default,
|
|
1195
|
-
prop_filepath,
|
|
1196
|
-
filter_ext,
|
|
1197
|
-
filter_path,
|
|
1198
|
-
display_name,
|
|
1199
|
-
add_operator,
|
|
1200
|
-
add_operator_props,
|
|
1779
|
+
searchpaths: list[str],
|
|
1780
|
+
operator: str,
|
|
1781
|
+
props_default: dict = None,
|
|
1782
|
+
prop_filepath: str = "filepath",
|
|
1783
|
+
filter_ext: typing.Callable = None,
|
|
1784
|
+
filter_path=None,
|
|
1785
|
+
display_name: typing.Callable = None,
|
|
1786
|
+
add_operator=None,
|
|
1787
|
+
add_operator_props=None,
|
|
1201
1788
|
):
|
|
1202
|
-
"""
|
|
1789
|
+
"""Populate a menu from a list of paths.
|
|
1790
|
+
|
|
1791
|
+
:param searchpaths: Paths to scan.
|
|
1792
|
+
:type searchpaths: list[str]
|
|
1793
|
+
:param operator: The operator id to use with each file.
|
|
1794
|
+
:type operator: str
|
|
1795
|
+
:param props_default: Properties to assign to each operator.
|
|
1796
|
+
:type props_default: dict
|
|
1797
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1798
|
+
:type prop_filepath: str
|
|
1799
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1203
1800
|
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
:param add_operator:
|
|
1212
|
-
:param add_operator_props:
|
|
1801
|
+
Returning false excludes the file from the list.
|
|
1802
|
+
:type filter_ext: typing.Callable
|
|
1803
|
+
:param filter_path:
|
|
1804
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1805
|
+
:type display_name: typing.Callable
|
|
1806
|
+
:param add_operator:
|
|
1807
|
+
:param add_operator_props:
|
|
1213
1808
|
"""
|
|
1214
1809
|
...
|
|
1215
1810
|
|
|
1216
1811
|
def path_resolve(self):
|
|
1217
|
-
""" """
|
|
1812
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1218
1813
|
...
|
|
1219
1814
|
|
|
1220
1815
|
def pop(self):
|
|
1221
|
-
"""
|
|
1816
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1817
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1818
|
+
|
|
1819
|
+
"""
|
|
1222
1820
|
...
|
|
1223
1821
|
|
|
1224
1822
|
def prepend(self, draw_func):
|
|
1225
|
-
"""
|
|
1823
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1824
|
+
the menus draw function
|
|
1226
1825
|
|
|
1227
|
-
|
|
1826
|
+
:param draw_func:
|
|
1228
1827
|
"""
|
|
1229
1828
|
...
|
|
1230
1829
|
|
|
1231
|
-
def property_overridable_library_set(self):
|
|
1232
|
-
"""
|
|
1830
|
+
def property_overridable_library_set(self) -> bool:
|
|
1831
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1832
|
+
|
|
1833
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1834
|
+
:rtype: bool
|
|
1835
|
+
"""
|
|
1233
1836
|
...
|
|
1234
1837
|
|
|
1235
1838
|
def property_unset(self):
|
|
1236
|
-
""" """
|
|
1839
|
+
"""Unset a property, will use default value afterward."""
|
|
1237
1840
|
...
|
|
1238
1841
|
|
|
1239
1842
|
def remove(self, draw_func):
|
|
1240
|
-
"""
|
|
1843
|
+
"""Remove a draw function that has been added to this menu
|
|
1241
1844
|
|
|
1242
1845
|
:param draw_func:
|
|
1243
1846
|
"""
|
|
1244
1847
|
...
|
|
1245
1848
|
|
|
1246
1849
|
def type_recast(self):
|
|
1247
|
-
"""
|
|
1850
|
+
"""Return a new instance, this is needed because types
|
|
1851
|
+
such as textures can be changed at runtime.
|
|
1852
|
+
|
|
1853
|
+
:return: a new instance of this object with the type initialized again.
|
|
1854
|
+
"""
|
|
1248
1855
|
...
|
|
1249
1856
|
|
|
1250
1857
|
def values(self):
|
|
1251
|
-
"""
|
|
1858
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1859
|
+
dictionary function of the same name).
|
|
1860
|
+
|
|
1861
|
+
:return: custom property values.
|
|
1862
|
+
"""
|
|
1252
1863
|
...
|
|
1253
1864
|
|
|
1254
1865
|
class OUTLINER_MT_context_menu_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
1255
|
-
""" """
|
|
1256
|
-
|
|
1257
1866
|
bl_label: typing.Any
|
|
1258
|
-
""" """
|
|
1259
|
-
|
|
1260
1867
|
bl_rna: typing.Any
|
|
1261
|
-
""" """
|
|
1262
|
-
|
|
1263
1868
|
id_data: typing.Any
|
|
1264
|
-
""" """
|
|
1265
1869
|
|
|
1266
1870
|
def append(self, draw_func):
|
|
1267
|
-
"""
|
|
1871
|
+
"""Append a draw function to this menu,
|
|
1872
|
+
takes the same arguments as the menus draw function
|
|
1268
1873
|
|
|
1269
|
-
|
|
1874
|
+
:param draw_func:
|
|
1270
1875
|
"""
|
|
1271
1876
|
...
|
|
1272
1877
|
|
|
1273
|
-
def as_pointer(self):
|
|
1274
|
-
"""
|
|
1878
|
+
def as_pointer(self) -> int:
|
|
1879
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1880
|
+
|
|
1881
|
+
:return: int (memory address).
|
|
1882
|
+
:rtype: int
|
|
1883
|
+
"""
|
|
1275
1884
|
...
|
|
1276
1885
|
|
|
1277
|
-
def bl_rna_get_subclass(self):
|
|
1278
|
-
"""
|
|
1886
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1887
|
+
"""
|
|
1888
|
+
|
|
1889
|
+
:return: The RNA type or default when not found.
|
|
1890
|
+
:rtype: bpy.types.Struct
|
|
1891
|
+
"""
|
|
1279
1892
|
...
|
|
1280
1893
|
|
|
1281
|
-
def bl_rna_get_subclass_py(self):
|
|
1282
|
-
"""
|
|
1894
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1895
|
+
"""
|
|
1896
|
+
|
|
1897
|
+
:return: The class or default when not found.
|
|
1898
|
+
:rtype: typing.Any
|
|
1899
|
+
"""
|
|
1283
1900
|
...
|
|
1284
1901
|
|
|
1285
1902
|
def draw(self, _context):
|
|
@@ -1298,169 +1915,258 @@ class OUTLINER_MT_context_menu_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1298
1915
|
...
|
|
1299
1916
|
|
|
1300
1917
|
def draw_preset(self, _context):
|
|
1301
|
-
"""
|
|
1918
|
+
"""Define these on the subclass:
|
|
1919
|
+
- preset_operator (string)
|
|
1920
|
+
- preset_subdir (string)Optionally:
|
|
1921
|
+
- preset_add_operator (string)
|
|
1922
|
+
- preset_extensions (set of strings)
|
|
1923
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1302
1924
|
|
|
1303
|
-
|
|
1925
|
+
:param _context:
|
|
1304
1926
|
"""
|
|
1305
1927
|
...
|
|
1306
1928
|
|
|
1307
|
-
def driver_add(self):
|
|
1308
|
-
"""
|
|
1929
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1930
|
+
"""Adds driver(s) to the given property
|
|
1931
|
+
|
|
1932
|
+
:return: The driver(s) added.
|
|
1933
|
+
:rtype: bpy.types.FCurve
|
|
1934
|
+
"""
|
|
1309
1935
|
...
|
|
1310
1936
|
|
|
1311
|
-
def driver_remove(self):
|
|
1312
|
-
"""
|
|
1937
|
+
def driver_remove(self) -> bool:
|
|
1938
|
+
"""Remove driver(s) from the given property
|
|
1939
|
+
|
|
1940
|
+
:return: Success of driver removal.
|
|
1941
|
+
:rtype: bool
|
|
1942
|
+
"""
|
|
1313
1943
|
...
|
|
1314
1944
|
|
|
1315
1945
|
def get(self):
|
|
1316
|
-
"""
|
|
1946
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1947
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1948
|
+
|
|
1949
|
+
"""
|
|
1317
1950
|
...
|
|
1318
1951
|
|
|
1319
1952
|
def id_properties_clear(self):
|
|
1320
|
-
"""
|
|
1953
|
+
"""
|
|
1954
|
+
|
|
1955
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1956
|
+
"""
|
|
1321
1957
|
...
|
|
1322
1958
|
|
|
1323
1959
|
def id_properties_ensure(self):
|
|
1324
|
-
"""
|
|
1960
|
+
"""
|
|
1961
|
+
|
|
1962
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1963
|
+
"""
|
|
1325
1964
|
...
|
|
1326
1965
|
|
|
1327
1966
|
def id_properties_ui(self):
|
|
1328
|
-
"""
|
|
1329
|
-
...
|
|
1967
|
+
"""
|
|
1330
1968
|
|
|
1331
|
-
|
|
1332
|
-
"""
|
|
1969
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1970
|
+
"""
|
|
1333
1971
|
...
|
|
1334
1972
|
|
|
1335
|
-
def
|
|
1336
|
-
|
|
1973
|
+
def is_extended(self): ...
|
|
1974
|
+
def is_property_hidden(self) -> bool:
|
|
1975
|
+
"""Check if a property is hidden.
|
|
1976
|
+
|
|
1977
|
+
:return: True when the property is hidden.
|
|
1978
|
+
:rtype: bool
|
|
1979
|
+
"""
|
|
1337
1980
|
...
|
|
1338
1981
|
|
|
1339
|
-
def is_property_overridable_library(self):
|
|
1340
|
-
"""
|
|
1982
|
+
def is_property_overridable_library(self) -> bool:
|
|
1983
|
+
"""Check if a property is overridable.
|
|
1984
|
+
|
|
1985
|
+
:return: True when the property is overridable.
|
|
1986
|
+
:rtype: bool
|
|
1987
|
+
"""
|
|
1341
1988
|
...
|
|
1342
1989
|
|
|
1343
|
-
def is_property_readonly(self):
|
|
1344
|
-
"""
|
|
1990
|
+
def is_property_readonly(self) -> bool:
|
|
1991
|
+
"""Check if a property is readonly.
|
|
1992
|
+
|
|
1993
|
+
:return: True when the property is readonly (not writable).
|
|
1994
|
+
:rtype: bool
|
|
1995
|
+
"""
|
|
1345
1996
|
...
|
|
1346
1997
|
|
|
1347
|
-
def is_property_set(self):
|
|
1348
|
-
"""
|
|
1998
|
+
def is_property_set(self) -> bool:
|
|
1999
|
+
"""Check if a property is set, use for testing operator properties.
|
|
2000
|
+
|
|
2001
|
+
:return: True when the property has been set.
|
|
2002
|
+
:rtype: bool
|
|
2003
|
+
"""
|
|
1349
2004
|
...
|
|
1350
2005
|
|
|
1351
2006
|
def items(self):
|
|
1352
|
-
"""
|
|
2007
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
2008
|
+
dictionary function of the same name).
|
|
2009
|
+
|
|
2010
|
+
:return: custom property key, value pairs.
|
|
2011
|
+
"""
|
|
1353
2012
|
...
|
|
1354
2013
|
|
|
1355
|
-
def keyframe_delete(self):
|
|
1356
|
-
"""
|
|
2014
|
+
def keyframe_delete(self) -> bool:
|
|
2015
|
+
"""Remove a keyframe from this properties fcurve.
|
|
2016
|
+
|
|
2017
|
+
:return: Success of keyframe deletion.
|
|
2018
|
+
:rtype: bool
|
|
2019
|
+
"""
|
|
1357
2020
|
...
|
|
1358
2021
|
|
|
1359
|
-
def keyframe_insert(self):
|
|
1360
|
-
"""
|
|
2022
|
+
def keyframe_insert(self) -> bool:
|
|
2023
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2024
|
+
|
|
2025
|
+
:return: Success of keyframe insertion.
|
|
2026
|
+
:rtype: bool
|
|
2027
|
+
"""
|
|
1361
2028
|
...
|
|
1362
2029
|
|
|
1363
2030
|
def keys(self):
|
|
1364
|
-
"""
|
|
2031
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
2032
|
+
dictionary function of the same name).
|
|
2033
|
+
|
|
2034
|
+
:return: custom property keys.
|
|
2035
|
+
"""
|
|
1365
2036
|
...
|
|
1366
2037
|
|
|
1367
|
-
def path_from_id(self):
|
|
1368
|
-
"""
|
|
2038
|
+
def path_from_id(self) -> str:
|
|
2039
|
+
"""Returns the data path from the ID to this object (string).
|
|
2040
|
+
|
|
2041
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2042
|
+
to this struct and property (when given).
|
|
2043
|
+
:rtype: str
|
|
2044
|
+
"""
|
|
1369
2045
|
...
|
|
1370
2046
|
|
|
1371
2047
|
def path_menu(
|
|
1372
2048
|
self,
|
|
1373
|
-
searchpaths,
|
|
1374
|
-
operator,
|
|
1375
|
-
props_default,
|
|
1376
|
-
prop_filepath,
|
|
1377
|
-
filter_ext,
|
|
1378
|
-
filter_path,
|
|
1379
|
-
display_name,
|
|
1380
|
-
add_operator,
|
|
1381
|
-
add_operator_props,
|
|
2049
|
+
searchpaths: list[str],
|
|
2050
|
+
operator: str,
|
|
2051
|
+
props_default: dict = None,
|
|
2052
|
+
prop_filepath: str = "filepath",
|
|
2053
|
+
filter_ext: typing.Callable = None,
|
|
2054
|
+
filter_path=None,
|
|
2055
|
+
display_name: typing.Callable = None,
|
|
2056
|
+
add_operator=None,
|
|
2057
|
+
add_operator_props=None,
|
|
1382
2058
|
):
|
|
1383
|
-
"""
|
|
2059
|
+
"""Populate a menu from a list of paths.
|
|
2060
|
+
|
|
2061
|
+
:param searchpaths: Paths to scan.
|
|
2062
|
+
:type searchpaths: list[str]
|
|
2063
|
+
:param operator: The operator id to use with each file.
|
|
2064
|
+
:type operator: str
|
|
2065
|
+
:param props_default: Properties to assign to each operator.
|
|
2066
|
+
:type props_default: dict
|
|
2067
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2068
|
+
:type prop_filepath: str
|
|
2069
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1384
2070
|
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
:param add_operator:
|
|
1393
|
-
:param add_operator_props:
|
|
2071
|
+
Returning false excludes the file from the list.
|
|
2072
|
+
:type filter_ext: typing.Callable
|
|
2073
|
+
:param filter_path:
|
|
2074
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2075
|
+
:type display_name: typing.Callable
|
|
2076
|
+
:param add_operator:
|
|
2077
|
+
:param add_operator_props:
|
|
1394
2078
|
"""
|
|
1395
2079
|
...
|
|
1396
2080
|
|
|
1397
2081
|
def path_resolve(self):
|
|
1398
|
-
""" """
|
|
2082
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1399
2083
|
...
|
|
1400
2084
|
|
|
1401
2085
|
def pop(self):
|
|
1402
|
-
"""
|
|
2086
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
2087
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2088
|
+
|
|
2089
|
+
"""
|
|
1403
2090
|
...
|
|
1404
2091
|
|
|
1405
2092
|
def prepend(self, draw_func):
|
|
1406
|
-
"""
|
|
2093
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2094
|
+
the menus draw function
|
|
1407
2095
|
|
|
1408
|
-
|
|
2096
|
+
:param draw_func:
|
|
1409
2097
|
"""
|
|
1410
2098
|
...
|
|
1411
2099
|
|
|
1412
|
-
def property_overridable_library_set(self):
|
|
1413
|
-
"""
|
|
2100
|
+
def property_overridable_library_set(self) -> bool:
|
|
2101
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
2102
|
+
|
|
2103
|
+
:return: True when the overridable status of the property was successfully set.
|
|
2104
|
+
:rtype: bool
|
|
2105
|
+
"""
|
|
1414
2106
|
...
|
|
1415
2107
|
|
|
1416
2108
|
def property_unset(self):
|
|
1417
|
-
""" """
|
|
2109
|
+
"""Unset a property, will use default value afterward."""
|
|
1418
2110
|
...
|
|
1419
2111
|
|
|
1420
2112
|
def remove(self, draw_func):
|
|
1421
|
-
"""
|
|
2113
|
+
"""Remove a draw function that has been added to this menu
|
|
1422
2114
|
|
|
1423
2115
|
:param draw_func:
|
|
1424
2116
|
"""
|
|
1425
2117
|
...
|
|
1426
2118
|
|
|
1427
2119
|
def type_recast(self):
|
|
1428
|
-
"""
|
|
2120
|
+
"""Return a new instance, this is needed because types
|
|
2121
|
+
such as textures can be changed at runtime.
|
|
2122
|
+
|
|
2123
|
+
:return: a new instance of this object with the type initialized again.
|
|
2124
|
+
"""
|
|
1429
2125
|
...
|
|
1430
2126
|
|
|
1431
2127
|
def values(self):
|
|
1432
|
-
"""
|
|
2128
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
2129
|
+
dictionary function of the same name).
|
|
2130
|
+
|
|
2131
|
+
:return: custom property values.
|
|
2132
|
+
"""
|
|
1433
2133
|
...
|
|
1434
2134
|
|
|
1435
2135
|
class OUTLINER_MT_edit_datablocks(bpy_types.Menu, bpy_types._GenericUI):
|
|
1436
|
-
""" """
|
|
1437
|
-
|
|
1438
2136
|
bl_label: typing.Any
|
|
1439
|
-
""" """
|
|
1440
|
-
|
|
1441
2137
|
bl_rna: typing.Any
|
|
1442
|
-
""" """
|
|
1443
|
-
|
|
1444
2138
|
id_data: typing.Any
|
|
1445
|
-
""" """
|
|
1446
2139
|
|
|
1447
2140
|
def append(self, draw_func):
|
|
1448
|
-
"""
|
|
2141
|
+
"""Append a draw function to this menu,
|
|
2142
|
+
takes the same arguments as the menus draw function
|
|
1449
2143
|
|
|
1450
|
-
|
|
2144
|
+
:param draw_func:
|
|
1451
2145
|
"""
|
|
1452
2146
|
...
|
|
1453
2147
|
|
|
1454
|
-
def as_pointer(self):
|
|
1455
|
-
"""
|
|
2148
|
+
def as_pointer(self) -> int:
|
|
2149
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2150
|
+
|
|
2151
|
+
:return: int (memory address).
|
|
2152
|
+
:rtype: int
|
|
2153
|
+
"""
|
|
1456
2154
|
...
|
|
1457
2155
|
|
|
1458
|
-
def bl_rna_get_subclass(self):
|
|
1459
|
-
"""
|
|
2156
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2157
|
+
"""
|
|
2158
|
+
|
|
2159
|
+
:return: The RNA type or default when not found.
|
|
2160
|
+
:rtype: bpy.types.Struct
|
|
2161
|
+
"""
|
|
1460
2162
|
...
|
|
1461
2163
|
|
|
1462
|
-
def bl_rna_get_subclass_py(self):
|
|
1463
|
-
"""
|
|
2164
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2165
|
+
"""
|
|
2166
|
+
|
|
2167
|
+
:return: The class or default when not found.
|
|
2168
|
+
:rtype: typing.Any
|
|
2169
|
+
"""
|
|
1464
2170
|
...
|
|
1465
2171
|
|
|
1466
2172
|
def draw(self, _context):
|
|
@@ -1479,172 +2185,259 @@ class OUTLINER_MT_edit_datablocks(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1479
2185
|
...
|
|
1480
2186
|
|
|
1481
2187
|
def draw_preset(self, _context):
|
|
1482
|
-
"""
|
|
2188
|
+
"""Define these on the subclass:
|
|
2189
|
+
- preset_operator (string)
|
|
2190
|
+
- preset_subdir (string)Optionally:
|
|
2191
|
+
- preset_add_operator (string)
|
|
2192
|
+
- preset_extensions (set of strings)
|
|
2193
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1483
2194
|
|
|
1484
|
-
|
|
2195
|
+
:param _context:
|
|
1485
2196
|
"""
|
|
1486
2197
|
...
|
|
1487
2198
|
|
|
1488
|
-
def driver_add(self):
|
|
1489
|
-
"""
|
|
2199
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
2200
|
+
"""Adds driver(s) to the given property
|
|
2201
|
+
|
|
2202
|
+
:return: The driver(s) added.
|
|
2203
|
+
:rtype: bpy.types.FCurve
|
|
2204
|
+
"""
|
|
1490
2205
|
...
|
|
1491
2206
|
|
|
1492
|
-
def driver_remove(self):
|
|
1493
|
-
"""
|
|
2207
|
+
def driver_remove(self) -> bool:
|
|
2208
|
+
"""Remove driver(s) from the given property
|
|
2209
|
+
|
|
2210
|
+
:return: Success of driver removal.
|
|
2211
|
+
:rtype: bool
|
|
2212
|
+
"""
|
|
1494
2213
|
...
|
|
1495
2214
|
|
|
1496
2215
|
def get(self):
|
|
1497
|
-
"""
|
|
2216
|
+
"""Returns the value of the custom property assigned to key or default
|
|
2217
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2218
|
+
|
|
2219
|
+
"""
|
|
1498
2220
|
...
|
|
1499
2221
|
|
|
1500
2222
|
def id_properties_clear(self):
|
|
1501
|
-
"""
|
|
2223
|
+
"""
|
|
2224
|
+
|
|
2225
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2226
|
+
"""
|
|
1502
2227
|
...
|
|
1503
2228
|
|
|
1504
2229
|
def id_properties_ensure(self):
|
|
1505
|
-
"""
|
|
2230
|
+
"""
|
|
2231
|
+
|
|
2232
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2233
|
+
"""
|
|
1506
2234
|
...
|
|
1507
2235
|
|
|
1508
2236
|
def id_properties_ui(self):
|
|
1509
|
-
"""
|
|
1510
|
-
...
|
|
2237
|
+
"""
|
|
1511
2238
|
|
|
1512
|
-
|
|
1513
|
-
"""
|
|
2239
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
2240
|
+
"""
|
|
1514
2241
|
...
|
|
1515
2242
|
|
|
1516
|
-
def
|
|
1517
|
-
|
|
2243
|
+
def is_extended(self): ...
|
|
2244
|
+
def is_property_hidden(self) -> bool:
|
|
2245
|
+
"""Check if a property is hidden.
|
|
2246
|
+
|
|
2247
|
+
:return: True when the property is hidden.
|
|
2248
|
+
:rtype: bool
|
|
2249
|
+
"""
|
|
1518
2250
|
...
|
|
1519
2251
|
|
|
1520
|
-
def is_property_overridable_library(self):
|
|
1521
|
-
"""
|
|
2252
|
+
def is_property_overridable_library(self) -> bool:
|
|
2253
|
+
"""Check if a property is overridable.
|
|
2254
|
+
|
|
2255
|
+
:return: True when the property is overridable.
|
|
2256
|
+
:rtype: bool
|
|
2257
|
+
"""
|
|
1522
2258
|
...
|
|
1523
2259
|
|
|
1524
|
-
def is_property_readonly(self):
|
|
1525
|
-
"""
|
|
2260
|
+
def is_property_readonly(self) -> bool:
|
|
2261
|
+
"""Check if a property is readonly.
|
|
2262
|
+
|
|
2263
|
+
:return: True when the property is readonly (not writable).
|
|
2264
|
+
:rtype: bool
|
|
2265
|
+
"""
|
|
1526
2266
|
...
|
|
1527
2267
|
|
|
1528
|
-
def is_property_set(self):
|
|
1529
|
-
"""
|
|
2268
|
+
def is_property_set(self) -> bool:
|
|
2269
|
+
"""Check if a property is set, use for testing operator properties.
|
|
2270
|
+
|
|
2271
|
+
:return: True when the property has been set.
|
|
2272
|
+
:rtype: bool
|
|
2273
|
+
"""
|
|
1530
2274
|
...
|
|
1531
2275
|
|
|
1532
2276
|
def items(self):
|
|
1533
|
-
"""
|
|
2277
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
2278
|
+
dictionary function of the same name).
|
|
2279
|
+
|
|
2280
|
+
:return: custom property key, value pairs.
|
|
2281
|
+
"""
|
|
1534
2282
|
...
|
|
1535
2283
|
|
|
1536
|
-
def keyframe_delete(self):
|
|
1537
|
-
"""
|
|
2284
|
+
def keyframe_delete(self) -> bool:
|
|
2285
|
+
"""Remove a keyframe from this properties fcurve.
|
|
2286
|
+
|
|
2287
|
+
:return: Success of keyframe deletion.
|
|
2288
|
+
:rtype: bool
|
|
2289
|
+
"""
|
|
1538
2290
|
...
|
|
1539
2291
|
|
|
1540
|
-
def keyframe_insert(self):
|
|
1541
|
-
"""
|
|
2292
|
+
def keyframe_insert(self) -> bool:
|
|
2293
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2294
|
+
|
|
2295
|
+
:return: Success of keyframe insertion.
|
|
2296
|
+
:rtype: bool
|
|
2297
|
+
"""
|
|
1542
2298
|
...
|
|
1543
2299
|
|
|
1544
2300
|
def keys(self):
|
|
1545
|
-
"""
|
|
2301
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
2302
|
+
dictionary function of the same name).
|
|
2303
|
+
|
|
2304
|
+
:return: custom property keys.
|
|
2305
|
+
"""
|
|
1546
2306
|
...
|
|
1547
2307
|
|
|
1548
|
-
def path_from_id(self):
|
|
1549
|
-
"""
|
|
2308
|
+
def path_from_id(self) -> str:
|
|
2309
|
+
"""Returns the data path from the ID to this object (string).
|
|
2310
|
+
|
|
2311
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2312
|
+
to this struct and property (when given).
|
|
2313
|
+
:rtype: str
|
|
2314
|
+
"""
|
|
1550
2315
|
...
|
|
1551
2316
|
|
|
1552
2317
|
def path_menu(
|
|
1553
2318
|
self,
|
|
1554
|
-
searchpaths,
|
|
1555
|
-
operator,
|
|
1556
|
-
props_default,
|
|
1557
|
-
prop_filepath,
|
|
1558
|
-
filter_ext,
|
|
1559
|
-
filter_path,
|
|
1560
|
-
display_name,
|
|
1561
|
-
add_operator,
|
|
1562
|
-
add_operator_props,
|
|
2319
|
+
searchpaths: list[str],
|
|
2320
|
+
operator: str,
|
|
2321
|
+
props_default: dict = None,
|
|
2322
|
+
prop_filepath: str = "filepath",
|
|
2323
|
+
filter_ext: typing.Callable = None,
|
|
2324
|
+
filter_path=None,
|
|
2325
|
+
display_name: typing.Callable = None,
|
|
2326
|
+
add_operator=None,
|
|
2327
|
+
add_operator_props=None,
|
|
1563
2328
|
):
|
|
1564
|
-
"""
|
|
2329
|
+
"""Populate a menu from a list of paths.
|
|
2330
|
+
|
|
2331
|
+
:param searchpaths: Paths to scan.
|
|
2332
|
+
:type searchpaths: list[str]
|
|
2333
|
+
:param operator: The operator id to use with each file.
|
|
2334
|
+
:type operator: str
|
|
2335
|
+
:param props_default: Properties to assign to each operator.
|
|
2336
|
+
:type props_default: dict
|
|
2337
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2338
|
+
:type prop_filepath: str
|
|
2339
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1565
2340
|
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
:param add_operator:
|
|
1574
|
-
:param add_operator_props:
|
|
2341
|
+
Returning false excludes the file from the list.
|
|
2342
|
+
:type filter_ext: typing.Callable
|
|
2343
|
+
:param filter_path:
|
|
2344
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2345
|
+
:type display_name: typing.Callable
|
|
2346
|
+
:param add_operator:
|
|
2347
|
+
:param add_operator_props:
|
|
1575
2348
|
"""
|
|
1576
2349
|
...
|
|
1577
2350
|
|
|
1578
2351
|
def path_resolve(self):
|
|
1579
|
-
""" """
|
|
2352
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1580
2353
|
...
|
|
1581
2354
|
|
|
1582
2355
|
def pop(self):
|
|
1583
|
-
"""
|
|
2356
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
2357
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2358
|
+
|
|
2359
|
+
"""
|
|
1584
2360
|
...
|
|
1585
2361
|
|
|
1586
2362
|
def prepend(self, draw_func):
|
|
1587
|
-
"""
|
|
2363
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2364
|
+
the menus draw function
|
|
1588
2365
|
|
|
1589
|
-
|
|
2366
|
+
:param draw_func:
|
|
1590
2367
|
"""
|
|
1591
2368
|
...
|
|
1592
2369
|
|
|
1593
|
-
def property_overridable_library_set(self):
|
|
1594
|
-
"""
|
|
2370
|
+
def property_overridable_library_set(self) -> bool:
|
|
2371
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
2372
|
+
|
|
2373
|
+
:return: True when the overridable status of the property was successfully set.
|
|
2374
|
+
:rtype: bool
|
|
2375
|
+
"""
|
|
1595
2376
|
...
|
|
1596
2377
|
|
|
1597
2378
|
def property_unset(self):
|
|
1598
|
-
""" """
|
|
2379
|
+
"""Unset a property, will use default value afterward."""
|
|
1599
2380
|
...
|
|
1600
2381
|
|
|
1601
2382
|
def remove(self, draw_func):
|
|
1602
|
-
"""
|
|
2383
|
+
"""Remove a draw function that has been added to this menu
|
|
1603
2384
|
|
|
1604
2385
|
:param draw_func:
|
|
1605
2386
|
"""
|
|
1606
2387
|
...
|
|
1607
2388
|
|
|
1608
2389
|
def type_recast(self):
|
|
1609
|
-
"""
|
|
2390
|
+
"""Return a new instance, this is needed because types
|
|
2391
|
+
such as textures can be changed at runtime.
|
|
2392
|
+
|
|
2393
|
+
:return: a new instance of this object with the type initialized again.
|
|
2394
|
+
"""
|
|
1610
2395
|
...
|
|
1611
2396
|
|
|
1612
2397
|
def values(self):
|
|
1613
|
-
"""
|
|
2398
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
2399
|
+
dictionary function of the same name).
|
|
2400
|
+
|
|
2401
|
+
:return: custom property values.
|
|
2402
|
+
"""
|
|
1614
2403
|
...
|
|
1615
2404
|
|
|
1616
2405
|
class OUTLINER_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
1617
|
-
""" """
|
|
1618
|
-
|
|
1619
2406
|
bl_idname: typing.Any
|
|
1620
|
-
""" """
|
|
1621
|
-
|
|
1622
2407
|
bl_label: typing.Any
|
|
1623
|
-
""" """
|
|
1624
|
-
|
|
1625
2408
|
bl_rna: typing.Any
|
|
1626
|
-
""" """
|
|
1627
|
-
|
|
1628
2409
|
id_data: typing.Any
|
|
1629
|
-
""" """
|
|
1630
2410
|
|
|
1631
2411
|
def append(self, draw_func):
|
|
1632
|
-
"""
|
|
2412
|
+
"""Append a draw function to this menu,
|
|
2413
|
+
takes the same arguments as the menus draw function
|
|
1633
2414
|
|
|
1634
|
-
|
|
2415
|
+
:param draw_func:
|
|
1635
2416
|
"""
|
|
1636
2417
|
...
|
|
1637
2418
|
|
|
1638
|
-
def as_pointer(self):
|
|
1639
|
-
"""
|
|
2419
|
+
def as_pointer(self) -> int:
|
|
2420
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2421
|
+
|
|
2422
|
+
:return: int (memory address).
|
|
2423
|
+
:rtype: int
|
|
2424
|
+
"""
|
|
1640
2425
|
...
|
|
1641
2426
|
|
|
1642
|
-
def bl_rna_get_subclass(self):
|
|
1643
|
-
"""
|
|
2427
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2428
|
+
"""
|
|
2429
|
+
|
|
2430
|
+
:return: The RNA type or default when not found.
|
|
2431
|
+
:rtype: bpy.types.Struct
|
|
2432
|
+
"""
|
|
1644
2433
|
...
|
|
1645
2434
|
|
|
1646
|
-
def bl_rna_get_subclass_py(self):
|
|
1647
|
-
"""
|
|
2435
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2436
|
+
"""
|
|
2437
|
+
|
|
2438
|
+
:return: The class or default when not found.
|
|
2439
|
+
:rtype: typing.Any
|
|
2440
|
+
"""
|
|
1648
2441
|
...
|
|
1649
2442
|
|
|
1650
2443
|
def draw(self, context):
|
|
@@ -1663,169 +2456,258 @@ class OUTLINER_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1663
2456
|
...
|
|
1664
2457
|
|
|
1665
2458
|
def draw_preset(self, _context):
|
|
1666
|
-
"""
|
|
2459
|
+
"""Define these on the subclass:
|
|
2460
|
+
- preset_operator (string)
|
|
2461
|
+
- preset_subdir (string)Optionally:
|
|
2462
|
+
- preset_add_operator (string)
|
|
2463
|
+
- preset_extensions (set of strings)
|
|
2464
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1667
2465
|
|
|
1668
|
-
|
|
2466
|
+
:param _context:
|
|
1669
2467
|
"""
|
|
1670
2468
|
...
|
|
1671
2469
|
|
|
1672
|
-
def driver_add(self):
|
|
1673
|
-
"""
|
|
2470
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
2471
|
+
"""Adds driver(s) to the given property
|
|
2472
|
+
|
|
2473
|
+
:return: The driver(s) added.
|
|
2474
|
+
:rtype: bpy.types.FCurve
|
|
2475
|
+
"""
|
|
1674
2476
|
...
|
|
1675
2477
|
|
|
1676
|
-
def driver_remove(self):
|
|
1677
|
-
"""
|
|
2478
|
+
def driver_remove(self) -> bool:
|
|
2479
|
+
"""Remove driver(s) from the given property
|
|
2480
|
+
|
|
2481
|
+
:return: Success of driver removal.
|
|
2482
|
+
:rtype: bool
|
|
2483
|
+
"""
|
|
1678
2484
|
...
|
|
1679
2485
|
|
|
1680
2486
|
def get(self):
|
|
1681
|
-
"""
|
|
2487
|
+
"""Returns the value of the custom property assigned to key or default
|
|
2488
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2489
|
+
|
|
2490
|
+
"""
|
|
1682
2491
|
...
|
|
1683
2492
|
|
|
1684
2493
|
def id_properties_clear(self):
|
|
1685
|
-
"""
|
|
2494
|
+
"""
|
|
2495
|
+
|
|
2496
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2497
|
+
"""
|
|
1686
2498
|
...
|
|
1687
2499
|
|
|
1688
2500
|
def id_properties_ensure(self):
|
|
1689
|
-
"""
|
|
2501
|
+
"""
|
|
2502
|
+
|
|
2503
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2504
|
+
"""
|
|
1690
2505
|
...
|
|
1691
2506
|
|
|
1692
2507
|
def id_properties_ui(self):
|
|
1693
|
-
"""
|
|
1694
|
-
...
|
|
2508
|
+
"""
|
|
1695
2509
|
|
|
1696
|
-
|
|
1697
|
-
"""
|
|
2510
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
2511
|
+
"""
|
|
1698
2512
|
...
|
|
1699
2513
|
|
|
1700
|
-
def
|
|
1701
|
-
|
|
2514
|
+
def is_extended(self): ...
|
|
2515
|
+
def is_property_hidden(self) -> bool:
|
|
2516
|
+
"""Check if a property is hidden.
|
|
2517
|
+
|
|
2518
|
+
:return: True when the property is hidden.
|
|
2519
|
+
:rtype: bool
|
|
2520
|
+
"""
|
|
1702
2521
|
...
|
|
1703
2522
|
|
|
1704
|
-
def is_property_overridable_library(self):
|
|
1705
|
-
"""
|
|
2523
|
+
def is_property_overridable_library(self) -> bool:
|
|
2524
|
+
"""Check if a property is overridable.
|
|
2525
|
+
|
|
2526
|
+
:return: True when the property is overridable.
|
|
2527
|
+
:rtype: bool
|
|
2528
|
+
"""
|
|
1706
2529
|
...
|
|
1707
2530
|
|
|
1708
|
-
def is_property_readonly(self):
|
|
1709
|
-
"""
|
|
2531
|
+
def is_property_readonly(self) -> bool:
|
|
2532
|
+
"""Check if a property is readonly.
|
|
2533
|
+
|
|
2534
|
+
:return: True when the property is readonly (not writable).
|
|
2535
|
+
:rtype: bool
|
|
2536
|
+
"""
|
|
1710
2537
|
...
|
|
1711
2538
|
|
|
1712
|
-
def is_property_set(self):
|
|
1713
|
-
"""
|
|
2539
|
+
def is_property_set(self) -> bool:
|
|
2540
|
+
"""Check if a property is set, use for testing operator properties.
|
|
2541
|
+
|
|
2542
|
+
:return: True when the property has been set.
|
|
2543
|
+
:rtype: bool
|
|
2544
|
+
"""
|
|
1714
2545
|
...
|
|
1715
2546
|
|
|
1716
2547
|
def items(self):
|
|
1717
|
-
"""
|
|
2548
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
2549
|
+
dictionary function of the same name).
|
|
2550
|
+
|
|
2551
|
+
:return: custom property key, value pairs.
|
|
2552
|
+
"""
|
|
1718
2553
|
...
|
|
1719
2554
|
|
|
1720
|
-
def keyframe_delete(self):
|
|
1721
|
-
"""
|
|
2555
|
+
def keyframe_delete(self) -> bool:
|
|
2556
|
+
"""Remove a keyframe from this properties fcurve.
|
|
2557
|
+
|
|
2558
|
+
:return: Success of keyframe deletion.
|
|
2559
|
+
:rtype: bool
|
|
2560
|
+
"""
|
|
1722
2561
|
...
|
|
1723
2562
|
|
|
1724
|
-
def keyframe_insert(self):
|
|
1725
|
-
"""
|
|
2563
|
+
def keyframe_insert(self) -> bool:
|
|
2564
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2565
|
+
|
|
2566
|
+
:return: Success of keyframe insertion.
|
|
2567
|
+
:rtype: bool
|
|
2568
|
+
"""
|
|
1726
2569
|
...
|
|
1727
2570
|
|
|
1728
2571
|
def keys(self):
|
|
1729
|
-
"""
|
|
2572
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
2573
|
+
dictionary function of the same name).
|
|
2574
|
+
|
|
2575
|
+
:return: custom property keys.
|
|
2576
|
+
"""
|
|
1730
2577
|
...
|
|
1731
2578
|
|
|
1732
|
-
def path_from_id(self):
|
|
1733
|
-
"""
|
|
2579
|
+
def path_from_id(self) -> str:
|
|
2580
|
+
"""Returns the data path from the ID to this object (string).
|
|
2581
|
+
|
|
2582
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2583
|
+
to this struct and property (when given).
|
|
2584
|
+
:rtype: str
|
|
2585
|
+
"""
|
|
1734
2586
|
...
|
|
1735
2587
|
|
|
1736
2588
|
def path_menu(
|
|
1737
2589
|
self,
|
|
1738
|
-
searchpaths,
|
|
1739
|
-
operator,
|
|
1740
|
-
props_default,
|
|
1741
|
-
prop_filepath,
|
|
1742
|
-
filter_ext,
|
|
1743
|
-
filter_path,
|
|
1744
|
-
display_name,
|
|
1745
|
-
add_operator,
|
|
1746
|
-
add_operator_props,
|
|
2590
|
+
searchpaths: list[str],
|
|
2591
|
+
operator: str,
|
|
2592
|
+
props_default: dict = None,
|
|
2593
|
+
prop_filepath: str = "filepath",
|
|
2594
|
+
filter_ext: typing.Callable = None,
|
|
2595
|
+
filter_path=None,
|
|
2596
|
+
display_name: typing.Callable = None,
|
|
2597
|
+
add_operator=None,
|
|
2598
|
+
add_operator_props=None,
|
|
1747
2599
|
):
|
|
1748
|
-
"""
|
|
2600
|
+
"""Populate a menu from a list of paths.
|
|
2601
|
+
|
|
2602
|
+
:param searchpaths: Paths to scan.
|
|
2603
|
+
:type searchpaths: list[str]
|
|
2604
|
+
:param operator: The operator id to use with each file.
|
|
2605
|
+
:type operator: str
|
|
2606
|
+
:param props_default: Properties to assign to each operator.
|
|
2607
|
+
:type props_default: dict
|
|
2608
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2609
|
+
:type prop_filepath: str
|
|
2610
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1749
2611
|
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
:param add_operator:
|
|
1758
|
-
:param add_operator_props:
|
|
2612
|
+
Returning false excludes the file from the list.
|
|
2613
|
+
:type filter_ext: typing.Callable
|
|
2614
|
+
:param filter_path:
|
|
2615
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2616
|
+
:type display_name: typing.Callable
|
|
2617
|
+
:param add_operator:
|
|
2618
|
+
:param add_operator_props:
|
|
1759
2619
|
"""
|
|
1760
2620
|
...
|
|
1761
2621
|
|
|
1762
2622
|
def path_resolve(self):
|
|
1763
|
-
""" """
|
|
2623
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1764
2624
|
...
|
|
1765
2625
|
|
|
1766
2626
|
def pop(self):
|
|
1767
|
-
"""
|
|
2627
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
2628
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2629
|
+
|
|
2630
|
+
"""
|
|
1768
2631
|
...
|
|
1769
2632
|
|
|
1770
2633
|
def prepend(self, draw_func):
|
|
1771
|
-
"""
|
|
2634
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2635
|
+
the menus draw function
|
|
1772
2636
|
|
|
1773
|
-
|
|
2637
|
+
:param draw_func:
|
|
1774
2638
|
"""
|
|
1775
2639
|
...
|
|
1776
2640
|
|
|
1777
|
-
def property_overridable_library_set(self):
|
|
1778
|
-
"""
|
|
2641
|
+
def property_overridable_library_set(self) -> bool:
|
|
2642
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
2643
|
+
|
|
2644
|
+
:return: True when the overridable status of the property was successfully set.
|
|
2645
|
+
:rtype: bool
|
|
2646
|
+
"""
|
|
1779
2647
|
...
|
|
1780
2648
|
|
|
1781
2649
|
def property_unset(self):
|
|
1782
|
-
""" """
|
|
2650
|
+
"""Unset a property, will use default value afterward."""
|
|
1783
2651
|
...
|
|
1784
2652
|
|
|
1785
2653
|
def remove(self, draw_func):
|
|
1786
|
-
"""
|
|
2654
|
+
"""Remove a draw function that has been added to this menu
|
|
1787
2655
|
|
|
1788
2656
|
:param draw_func:
|
|
1789
2657
|
"""
|
|
1790
2658
|
...
|
|
1791
2659
|
|
|
1792
2660
|
def type_recast(self):
|
|
1793
|
-
"""
|
|
2661
|
+
"""Return a new instance, this is needed because types
|
|
2662
|
+
such as textures can be changed at runtime.
|
|
2663
|
+
|
|
2664
|
+
:return: a new instance of this object with the type initialized again.
|
|
2665
|
+
"""
|
|
1794
2666
|
...
|
|
1795
2667
|
|
|
1796
2668
|
def values(self):
|
|
1797
|
-
"""
|
|
2669
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
2670
|
+
dictionary function of the same name).
|
|
2671
|
+
|
|
2672
|
+
:return: custom property values.
|
|
2673
|
+
"""
|
|
1798
2674
|
...
|
|
1799
2675
|
|
|
1800
2676
|
class OUTLINER_MT_liboverride(bpy_types.Menu, bpy_types._GenericUI):
|
|
1801
|
-
""" """
|
|
1802
|
-
|
|
1803
2677
|
bl_label: typing.Any
|
|
1804
|
-
""" """
|
|
1805
|
-
|
|
1806
2678
|
bl_rna: typing.Any
|
|
1807
|
-
""" """
|
|
1808
|
-
|
|
1809
2679
|
id_data: typing.Any
|
|
1810
|
-
""" """
|
|
1811
2680
|
|
|
1812
2681
|
def append(self, draw_func):
|
|
1813
|
-
"""
|
|
2682
|
+
"""Append a draw function to this menu,
|
|
2683
|
+
takes the same arguments as the menus draw function
|
|
1814
2684
|
|
|
1815
|
-
|
|
2685
|
+
:param draw_func:
|
|
1816
2686
|
"""
|
|
1817
2687
|
...
|
|
1818
2688
|
|
|
1819
|
-
def as_pointer(self):
|
|
1820
|
-
"""
|
|
2689
|
+
def as_pointer(self) -> int:
|
|
2690
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2691
|
+
|
|
2692
|
+
:return: int (memory address).
|
|
2693
|
+
:rtype: int
|
|
2694
|
+
"""
|
|
1821
2695
|
...
|
|
1822
2696
|
|
|
1823
|
-
def bl_rna_get_subclass(self):
|
|
1824
|
-
"""
|
|
2697
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2698
|
+
"""
|
|
2699
|
+
|
|
2700
|
+
:return: The RNA type or default when not found.
|
|
2701
|
+
:rtype: bpy.types.Struct
|
|
2702
|
+
"""
|
|
1825
2703
|
...
|
|
1826
2704
|
|
|
1827
|
-
def bl_rna_get_subclass_py(self):
|
|
1828
|
-
"""
|
|
2705
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2706
|
+
"""
|
|
2707
|
+
|
|
2708
|
+
:return: The class or default when not found.
|
|
2709
|
+
:rtype: typing.Any
|
|
2710
|
+
"""
|
|
1829
2711
|
...
|
|
1830
2712
|
|
|
1831
2713
|
def draw(self, _context):
|
|
@@ -1844,104 +2726,171 @@ class OUTLINER_MT_liboverride(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1844
2726
|
...
|
|
1845
2727
|
|
|
1846
2728
|
def draw_preset(self, _context):
|
|
1847
|
-
"""
|
|
2729
|
+
"""Define these on the subclass:
|
|
2730
|
+
- preset_operator (string)
|
|
2731
|
+
- preset_subdir (string)Optionally:
|
|
2732
|
+
- preset_add_operator (string)
|
|
2733
|
+
- preset_extensions (set of strings)
|
|
2734
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1848
2735
|
|
|
1849
|
-
|
|
2736
|
+
:param _context:
|
|
1850
2737
|
"""
|
|
1851
2738
|
...
|
|
1852
2739
|
|
|
1853
|
-
def driver_add(self):
|
|
1854
|
-
"""
|
|
2740
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
2741
|
+
"""Adds driver(s) to the given property
|
|
2742
|
+
|
|
2743
|
+
:return: The driver(s) added.
|
|
2744
|
+
:rtype: bpy.types.FCurve
|
|
2745
|
+
"""
|
|
1855
2746
|
...
|
|
1856
2747
|
|
|
1857
|
-
def driver_remove(self):
|
|
1858
|
-
"""
|
|
2748
|
+
def driver_remove(self) -> bool:
|
|
2749
|
+
"""Remove driver(s) from the given property
|
|
2750
|
+
|
|
2751
|
+
:return: Success of driver removal.
|
|
2752
|
+
:rtype: bool
|
|
2753
|
+
"""
|
|
1859
2754
|
...
|
|
1860
2755
|
|
|
1861
2756
|
def get(self):
|
|
1862
|
-
"""
|
|
2757
|
+
"""Returns the value of the custom property assigned to key or default
|
|
2758
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2759
|
+
|
|
2760
|
+
"""
|
|
1863
2761
|
...
|
|
1864
2762
|
|
|
1865
2763
|
def id_properties_clear(self):
|
|
1866
|
-
"""
|
|
2764
|
+
"""
|
|
2765
|
+
|
|
2766
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2767
|
+
"""
|
|
1867
2768
|
...
|
|
1868
2769
|
|
|
1869
2770
|
def id_properties_ensure(self):
|
|
1870
|
-
"""
|
|
2771
|
+
"""
|
|
2772
|
+
|
|
2773
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2774
|
+
"""
|
|
1871
2775
|
...
|
|
1872
2776
|
|
|
1873
2777
|
def id_properties_ui(self):
|
|
1874
|
-
"""
|
|
1875
|
-
...
|
|
2778
|
+
"""
|
|
1876
2779
|
|
|
1877
|
-
|
|
1878
|
-
"""
|
|
2780
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
2781
|
+
"""
|
|
1879
2782
|
...
|
|
1880
2783
|
|
|
1881
|
-
def
|
|
1882
|
-
|
|
2784
|
+
def is_extended(self): ...
|
|
2785
|
+
def is_property_hidden(self) -> bool:
|
|
2786
|
+
"""Check if a property is hidden.
|
|
2787
|
+
|
|
2788
|
+
:return: True when the property is hidden.
|
|
2789
|
+
:rtype: bool
|
|
2790
|
+
"""
|
|
1883
2791
|
...
|
|
1884
2792
|
|
|
1885
|
-
def is_property_overridable_library(self):
|
|
1886
|
-
"""
|
|
2793
|
+
def is_property_overridable_library(self) -> bool:
|
|
2794
|
+
"""Check if a property is overridable.
|
|
2795
|
+
|
|
2796
|
+
:return: True when the property is overridable.
|
|
2797
|
+
:rtype: bool
|
|
2798
|
+
"""
|
|
1887
2799
|
...
|
|
1888
2800
|
|
|
1889
|
-
def is_property_readonly(self):
|
|
1890
|
-
"""
|
|
2801
|
+
def is_property_readonly(self) -> bool:
|
|
2802
|
+
"""Check if a property is readonly.
|
|
2803
|
+
|
|
2804
|
+
:return: True when the property is readonly (not writable).
|
|
2805
|
+
:rtype: bool
|
|
2806
|
+
"""
|
|
1891
2807
|
...
|
|
1892
2808
|
|
|
1893
|
-
def is_property_set(self):
|
|
1894
|
-
"""
|
|
2809
|
+
def is_property_set(self) -> bool:
|
|
2810
|
+
"""Check if a property is set, use for testing operator properties.
|
|
2811
|
+
|
|
2812
|
+
:return: True when the property has been set.
|
|
2813
|
+
:rtype: bool
|
|
2814
|
+
"""
|
|
1895
2815
|
...
|
|
1896
2816
|
|
|
1897
2817
|
def items(self):
|
|
1898
|
-
"""
|
|
2818
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
2819
|
+
dictionary function of the same name).
|
|
2820
|
+
|
|
2821
|
+
:return: custom property key, value pairs.
|
|
2822
|
+
"""
|
|
1899
2823
|
...
|
|
1900
2824
|
|
|
1901
|
-
def keyframe_delete(self):
|
|
1902
|
-
"""
|
|
2825
|
+
def keyframe_delete(self) -> bool:
|
|
2826
|
+
"""Remove a keyframe from this properties fcurve.
|
|
2827
|
+
|
|
2828
|
+
:return: Success of keyframe deletion.
|
|
2829
|
+
:rtype: bool
|
|
2830
|
+
"""
|
|
1903
2831
|
...
|
|
1904
2832
|
|
|
1905
|
-
def keyframe_insert(self):
|
|
1906
|
-
"""
|
|
2833
|
+
def keyframe_insert(self) -> bool:
|
|
2834
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2835
|
+
|
|
2836
|
+
:return: Success of keyframe insertion.
|
|
2837
|
+
:rtype: bool
|
|
2838
|
+
"""
|
|
1907
2839
|
...
|
|
1908
2840
|
|
|
1909
2841
|
def keys(self):
|
|
1910
|
-
"""
|
|
2842
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
2843
|
+
dictionary function of the same name).
|
|
2844
|
+
|
|
2845
|
+
:return: custom property keys.
|
|
2846
|
+
"""
|
|
1911
2847
|
...
|
|
1912
2848
|
|
|
1913
|
-
def path_from_id(self):
|
|
1914
|
-
"""
|
|
2849
|
+
def path_from_id(self) -> str:
|
|
2850
|
+
"""Returns the data path from the ID to this object (string).
|
|
2851
|
+
|
|
2852
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2853
|
+
to this struct and property (when given).
|
|
2854
|
+
:rtype: str
|
|
2855
|
+
"""
|
|
1915
2856
|
...
|
|
1916
2857
|
|
|
1917
2858
|
def path_menu(
|
|
1918
2859
|
self,
|
|
1919
|
-
searchpaths,
|
|
1920
|
-
operator,
|
|
1921
|
-
props_default,
|
|
1922
|
-
prop_filepath,
|
|
1923
|
-
filter_ext,
|
|
1924
|
-
filter_path,
|
|
1925
|
-
display_name,
|
|
1926
|
-
add_operator,
|
|
1927
|
-
add_operator_props,
|
|
2860
|
+
searchpaths: list[str],
|
|
2861
|
+
operator: str,
|
|
2862
|
+
props_default: dict = None,
|
|
2863
|
+
prop_filepath: str = "filepath",
|
|
2864
|
+
filter_ext: typing.Callable = None,
|
|
2865
|
+
filter_path=None,
|
|
2866
|
+
display_name: typing.Callable = None,
|
|
2867
|
+
add_operator=None,
|
|
2868
|
+
add_operator_props=None,
|
|
1928
2869
|
):
|
|
1929
|
-
"""
|
|
2870
|
+
"""Populate a menu from a list of paths.
|
|
1930
2871
|
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
|
|
2872
|
+
:param searchpaths: Paths to scan.
|
|
2873
|
+
:type searchpaths: list[str]
|
|
2874
|
+
:param operator: The operator id to use with each file.
|
|
2875
|
+
:type operator: str
|
|
2876
|
+
:param props_default: Properties to assign to each operator.
|
|
2877
|
+
:type props_default: dict
|
|
2878
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2879
|
+
:type prop_filepath: str
|
|
2880
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
2881
|
+
|
|
2882
|
+
Returning false excludes the file from the list.
|
|
2883
|
+
:type filter_ext: typing.Callable
|
|
2884
|
+
:param filter_path:
|
|
2885
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2886
|
+
:type display_name: typing.Callable
|
|
2887
|
+
:param add_operator:
|
|
2888
|
+
:param add_operator_props:
|
|
1940
2889
|
"""
|
|
1941
2890
|
...
|
|
1942
2891
|
|
|
1943
2892
|
def path_resolve(self):
|
|
1944
|
-
""" """
|
|
2893
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1945
2894
|
...
|
|
1946
2895
|
|
|
1947
2896
|
def poll(self, context):
|
|
@@ -1952,68 +2901,90 @@ class OUTLINER_MT_liboverride(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1952
2901
|
...
|
|
1953
2902
|
|
|
1954
2903
|
def pop(self):
|
|
1955
|
-
"""
|
|
2904
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
2905
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2906
|
+
|
|
2907
|
+
"""
|
|
1956
2908
|
...
|
|
1957
2909
|
|
|
1958
2910
|
def prepend(self, draw_func):
|
|
1959
|
-
"""
|
|
2911
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2912
|
+
the menus draw function
|
|
1960
2913
|
|
|
1961
|
-
|
|
2914
|
+
:param draw_func:
|
|
1962
2915
|
"""
|
|
1963
2916
|
...
|
|
1964
2917
|
|
|
1965
|
-
def property_overridable_library_set(self):
|
|
1966
|
-
"""
|
|
2918
|
+
def property_overridable_library_set(self) -> bool:
|
|
2919
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
2920
|
+
|
|
2921
|
+
:return: True when the overridable status of the property was successfully set.
|
|
2922
|
+
:rtype: bool
|
|
2923
|
+
"""
|
|
1967
2924
|
...
|
|
1968
2925
|
|
|
1969
2926
|
def property_unset(self):
|
|
1970
|
-
""" """
|
|
2927
|
+
"""Unset a property, will use default value afterward."""
|
|
1971
2928
|
...
|
|
1972
2929
|
|
|
1973
2930
|
def remove(self, draw_func):
|
|
1974
|
-
"""
|
|
2931
|
+
"""Remove a draw function that has been added to this menu
|
|
1975
2932
|
|
|
1976
2933
|
:param draw_func:
|
|
1977
2934
|
"""
|
|
1978
2935
|
...
|
|
1979
2936
|
|
|
1980
2937
|
def type_recast(self):
|
|
1981
|
-
"""
|
|
2938
|
+
"""Return a new instance, this is needed because types
|
|
2939
|
+
such as textures can be changed at runtime.
|
|
2940
|
+
|
|
2941
|
+
:return: a new instance of this object with the type initialized again.
|
|
2942
|
+
"""
|
|
1982
2943
|
...
|
|
1983
2944
|
|
|
1984
2945
|
def values(self):
|
|
1985
|
-
"""
|
|
2946
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
2947
|
+
dictionary function of the same name).
|
|
2948
|
+
|
|
2949
|
+
:return: custom property values.
|
|
2950
|
+
"""
|
|
1986
2951
|
...
|
|
1987
2952
|
|
|
1988
2953
|
class OUTLINER_MT_object(bpy_types.Menu, bpy_types._GenericUI):
|
|
1989
|
-
""" """
|
|
1990
|
-
|
|
1991
2954
|
bl_label: typing.Any
|
|
1992
|
-
""" """
|
|
1993
|
-
|
|
1994
2955
|
bl_rna: typing.Any
|
|
1995
|
-
""" """
|
|
1996
|
-
|
|
1997
2956
|
id_data: typing.Any
|
|
1998
|
-
""" """
|
|
1999
2957
|
|
|
2000
2958
|
def append(self, draw_func):
|
|
2001
|
-
"""
|
|
2959
|
+
"""Append a draw function to this menu,
|
|
2960
|
+
takes the same arguments as the menus draw function
|
|
2002
2961
|
|
|
2003
|
-
|
|
2962
|
+
:param draw_func:
|
|
2004
2963
|
"""
|
|
2005
2964
|
...
|
|
2006
2965
|
|
|
2007
|
-
def as_pointer(self):
|
|
2008
|
-
"""
|
|
2966
|
+
def as_pointer(self) -> int:
|
|
2967
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2968
|
+
|
|
2969
|
+
:return: int (memory address).
|
|
2970
|
+
:rtype: int
|
|
2971
|
+
"""
|
|
2009
2972
|
...
|
|
2010
2973
|
|
|
2011
|
-
def bl_rna_get_subclass(self):
|
|
2012
|
-
"""
|
|
2974
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2975
|
+
"""
|
|
2976
|
+
|
|
2977
|
+
:return: The RNA type or default when not found.
|
|
2978
|
+
:rtype: bpy.types.Struct
|
|
2979
|
+
"""
|
|
2013
2980
|
...
|
|
2014
2981
|
|
|
2015
|
-
def bl_rna_get_subclass_py(self):
|
|
2016
|
-
"""
|
|
2982
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2983
|
+
"""
|
|
2984
|
+
|
|
2985
|
+
:return: The class or default when not found.
|
|
2986
|
+
:rtype: typing.Any
|
|
2987
|
+
"""
|
|
2017
2988
|
...
|
|
2018
2989
|
|
|
2019
2990
|
def draw(self, context):
|
|
@@ -2032,169 +3003,258 @@ class OUTLINER_MT_object(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
2032
3003
|
...
|
|
2033
3004
|
|
|
2034
3005
|
def draw_preset(self, _context):
|
|
2035
|
-
"""
|
|
3006
|
+
"""Define these on the subclass:
|
|
3007
|
+
- preset_operator (string)
|
|
3008
|
+
- preset_subdir (string)Optionally:
|
|
3009
|
+
- preset_add_operator (string)
|
|
3010
|
+
- preset_extensions (set of strings)
|
|
3011
|
+
- preset_operator_defaults (dict of keyword args)
|
|
2036
3012
|
|
|
2037
|
-
|
|
3013
|
+
:param _context:
|
|
2038
3014
|
"""
|
|
2039
3015
|
...
|
|
2040
3016
|
|
|
2041
|
-
def driver_add(self):
|
|
2042
|
-
"""
|
|
3017
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
3018
|
+
"""Adds driver(s) to the given property
|
|
3019
|
+
|
|
3020
|
+
:return: The driver(s) added.
|
|
3021
|
+
:rtype: bpy.types.FCurve
|
|
3022
|
+
"""
|
|
2043
3023
|
...
|
|
2044
3024
|
|
|
2045
|
-
def driver_remove(self):
|
|
2046
|
-
"""
|
|
3025
|
+
def driver_remove(self) -> bool:
|
|
3026
|
+
"""Remove driver(s) from the given property
|
|
3027
|
+
|
|
3028
|
+
:return: Success of driver removal.
|
|
3029
|
+
:rtype: bool
|
|
3030
|
+
"""
|
|
2047
3031
|
...
|
|
2048
3032
|
|
|
2049
3033
|
def get(self):
|
|
2050
|
-
"""
|
|
3034
|
+
"""Returns the value of the custom property assigned to key or default
|
|
3035
|
+
when not found (matches Python's dictionary function of the same name).
|
|
3036
|
+
|
|
3037
|
+
"""
|
|
2051
3038
|
...
|
|
2052
3039
|
|
|
2053
3040
|
def id_properties_clear(self):
|
|
2054
|
-
"""
|
|
3041
|
+
"""
|
|
3042
|
+
|
|
3043
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3044
|
+
"""
|
|
2055
3045
|
...
|
|
2056
3046
|
|
|
2057
3047
|
def id_properties_ensure(self):
|
|
2058
|
-
"""
|
|
3048
|
+
"""
|
|
3049
|
+
|
|
3050
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3051
|
+
"""
|
|
2059
3052
|
...
|
|
2060
3053
|
|
|
2061
3054
|
def id_properties_ui(self):
|
|
2062
|
-
"""
|
|
2063
|
-
...
|
|
3055
|
+
"""
|
|
2064
3056
|
|
|
2065
|
-
|
|
2066
|
-
"""
|
|
3057
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
3058
|
+
"""
|
|
2067
3059
|
...
|
|
2068
3060
|
|
|
2069
|
-
def
|
|
2070
|
-
|
|
3061
|
+
def is_extended(self): ...
|
|
3062
|
+
def is_property_hidden(self) -> bool:
|
|
3063
|
+
"""Check if a property is hidden.
|
|
3064
|
+
|
|
3065
|
+
:return: True when the property is hidden.
|
|
3066
|
+
:rtype: bool
|
|
3067
|
+
"""
|
|
2071
3068
|
...
|
|
2072
3069
|
|
|
2073
|
-
def is_property_overridable_library(self):
|
|
2074
|
-
"""
|
|
3070
|
+
def is_property_overridable_library(self) -> bool:
|
|
3071
|
+
"""Check if a property is overridable.
|
|
3072
|
+
|
|
3073
|
+
:return: True when the property is overridable.
|
|
3074
|
+
:rtype: bool
|
|
3075
|
+
"""
|
|
2075
3076
|
...
|
|
2076
3077
|
|
|
2077
|
-
def is_property_readonly(self):
|
|
2078
|
-
"""
|
|
3078
|
+
def is_property_readonly(self) -> bool:
|
|
3079
|
+
"""Check if a property is readonly.
|
|
3080
|
+
|
|
3081
|
+
:return: True when the property is readonly (not writable).
|
|
3082
|
+
:rtype: bool
|
|
3083
|
+
"""
|
|
2079
3084
|
...
|
|
2080
3085
|
|
|
2081
|
-
def is_property_set(self):
|
|
2082
|
-
"""
|
|
3086
|
+
def is_property_set(self) -> bool:
|
|
3087
|
+
"""Check if a property is set, use for testing operator properties.
|
|
3088
|
+
|
|
3089
|
+
:return: True when the property has been set.
|
|
3090
|
+
:rtype: bool
|
|
3091
|
+
"""
|
|
2083
3092
|
...
|
|
2084
3093
|
|
|
2085
3094
|
def items(self):
|
|
2086
|
-
"""
|
|
3095
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
3096
|
+
dictionary function of the same name).
|
|
3097
|
+
|
|
3098
|
+
:return: custom property key, value pairs.
|
|
3099
|
+
"""
|
|
2087
3100
|
...
|
|
2088
3101
|
|
|
2089
|
-
def keyframe_delete(self):
|
|
2090
|
-
"""
|
|
3102
|
+
def keyframe_delete(self) -> bool:
|
|
3103
|
+
"""Remove a keyframe from this properties fcurve.
|
|
3104
|
+
|
|
3105
|
+
:return: Success of keyframe deletion.
|
|
3106
|
+
:rtype: bool
|
|
3107
|
+
"""
|
|
2091
3108
|
...
|
|
2092
3109
|
|
|
2093
|
-
def keyframe_insert(self):
|
|
2094
|
-
"""
|
|
3110
|
+
def keyframe_insert(self) -> bool:
|
|
3111
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3112
|
+
|
|
3113
|
+
:return: Success of keyframe insertion.
|
|
3114
|
+
:rtype: bool
|
|
3115
|
+
"""
|
|
2095
3116
|
...
|
|
2096
3117
|
|
|
2097
3118
|
def keys(self):
|
|
2098
|
-
"""
|
|
3119
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
3120
|
+
dictionary function of the same name).
|
|
3121
|
+
|
|
3122
|
+
:return: custom property keys.
|
|
3123
|
+
"""
|
|
2099
3124
|
...
|
|
2100
3125
|
|
|
2101
|
-
def path_from_id(self):
|
|
2102
|
-
"""
|
|
3126
|
+
def path_from_id(self) -> str:
|
|
3127
|
+
"""Returns the data path from the ID to this object (string).
|
|
3128
|
+
|
|
3129
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3130
|
+
to this struct and property (when given).
|
|
3131
|
+
:rtype: str
|
|
3132
|
+
"""
|
|
2103
3133
|
...
|
|
2104
3134
|
|
|
2105
3135
|
def path_menu(
|
|
2106
3136
|
self,
|
|
2107
|
-
searchpaths,
|
|
2108
|
-
operator,
|
|
2109
|
-
props_default,
|
|
2110
|
-
prop_filepath,
|
|
2111
|
-
filter_ext,
|
|
2112
|
-
filter_path,
|
|
2113
|
-
display_name,
|
|
2114
|
-
add_operator,
|
|
2115
|
-
add_operator_props,
|
|
3137
|
+
searchpaths: list[str],
|
|
3138
|
+
operator: str,
|
|
3139
|
+
props_default: dict = None,
|
|
3140
|
+
prop_filepath: str = "filepath",
|
|
3141
|
+
filter_ext: typing.Callable = None,
|
|
3142
|
+
filter_path=None,
|
|
3143
|
+
display_name: typing.Callable = None,
|
|
3144
|
+
add_operator=None,
|
|
3145
|
+
add_operator_props=None,
|
|
2116
3146
|
):
|
|
2117
|
-
"""
|
|
3147
|
+
"""Populate a menu from a list of paths.
|
|
3148
|
+
|
|
3149
|
+
:param searchpaths: Paths to scan.
|
|
3150
|
+
:type searchpaths: list[str]
|
|
3151
|
+
:param operator: The operator id to use with each file.
|
|
3152
|
+
:type operator: str
|
|
3153
|
+
:param props_default: Properties to assign to each operator.
|
|
3154
|
+
:type props_default: dict
|
|
3155
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3156
|
+
:type prop_filepath: str
|
|
3157
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
2118
3158
|
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
:param add_operator:
|
|
2127
|
-
:param add_operator_props:
|
|
3159
|
+
Returning false excludes the file from the list.
|
|
3160
|
+
:type filter_ext: typing.Callable
|
|
3161
|
+
:param filter_path:
|
|
3162
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3163
|
+
:type display_name: typing.Callable
|
|
3164
|
+
:param add_operator:
|
|
3165
|
+
:param add_operator_props:
|
|
2128
3166
|
"""
|
|
2129
3167
|
...
|
|
2130
3168
|
|
|
2131
3169
|
def path_resolve(self):
|
|
2132
|
-
""" """
|
|
3170
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
2133
3171
|
...
|
|
2134
3172
|
|
|
2135
3173
|
def pop(self):
|
|
2136
|
-
"""
|
|
3174
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
3175
|
+
when not found (matches Python's dictionary function of the same name).
|
|
3176
|
+
|
|
3177
|
+
"""
|
|
2137
3178
|
...
|
|
2138
3179
|
|
|
2139
3180
|
def prepend(self, draw_func):
|
|
2140
|
-
"""
|
|
3181
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3182
|
+
the menus draw function
|
|
2141
3183
|
|
|
2142
|
-
|
|
3184
|
+
:param draw_func:
|
|
2143
3185
|
"""
|
|
2144
3186
|
...
|
|
2145
3187
|
|
|
2146
|
-
def property_overridable_library_set(self):
|
|
2147
|
-
"""
|
|
3188
|
+
def property_overridable_library_set(self) -> bool:
|
|
3189
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
3190
|
+
|
|
3191
|
+
:return: True when the overridable status of the property was successfully set.
|
|
3192
|
+
:rtype: bool
|
|
3193
|
+
"""
|
|
2148
3194
|
...
|
|
2149
3195
|
|
|
2150
3196
|
def property_unset(self):
|
|
2151
|
-
""" """
|
|
3197
|
+
"""Unset a property, will use default value afterward."""
|
|
2152
3198
|
...
|
|
2153
3199
|
|
|
2154
3200
|
def remove(self, draw_func):
|
|
2155
|
-
"""
|
|
3201
|
+
"""Remove a draw function that has been added to this menu
|
|
2156
3202
|
|
|
2157
3203
|
:param draw_func:
|
|
2158
3204
|
"""
|
|
2159
3205
|
...
|
|
2160
3206
|
|
|
2161
3207
|
def type_recast(self):
|
|
2162
|
-
"""
|
|
3208
|
+
"""Return a new instance, this is needed because types
|
|
3209
|
+
such as textures can be changed at runtime.
|
|
3210
|
+
|
|
3211
|
+
:return: a new instance of this object with the type initialized again.
|
|
3212
|
+
"""
|
|
2163
3213
|
...
|
|
2164
3214
|
|
|
2165
3215
|
def values(self):
|
|
2166
|
-
"""
|
|
3216
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
3217
|
+
dictionary function of the same name).
|
|
3218
|
+
|
|
3219
|
+
:return: custom property values.
|
|
3220
|
+
"""
|
|
2167
3221
|
...
|
|
2168
3222
|
|
|
2169
3223
|
class OUTLINER_MT_view_pie(bpy_types.Menu, bpy_types._GenericUI):
|
|
2170
|
-
""" """
|
|
2171
|
-
|
|
2172
3224
|
bl_label: typing.Any
|
|
2173
|
-
""" """
|
|
2174
|
-
|
|
2175
3225
|
bl_rna: typing.Any
|
|
2176
|
-
""" """
|
|
2177
|
-
|
|
2178
3226
|
id_data: typing.Any
|
|
2179
|
-
""" """
|
|
2180
3227
|
|
|
2181
3228
|
def append(self, draw_func):
|
|
2182
|
-
"""
|
|
3229
|
+
"""Append a draw function to this menu,
|
|
3230
|
+
takes the same arguments as the menus draw function
|
|
2183
3231
|
|
|
2184
|
-
|
|
3232
|
+
:param draw_func:
|
|
2185
3233
|
"""
|
|
2186
3234
|
...
|
|
2187
3235
|
|
|
2188
|
-
def as_pointer(self):
|
|
2189
|
-
"""
|
|
3236
|
+
def as_pointer(self) -> int:
|
|
3237
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3238
|
+
|
|
3239
|
+
:return: int (memory address).
|
|
3240
|
+
:rtype: int
|
|
3241
|
+
"""
|
|
2190
3242
|
...
|
|
2191
3243
|
|
|
2192
|
-
def bl_rna_get_subclass(self):
|
|
2193
|
-
"""
|
|
3244
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3245
|
+
"""
|
|
3246
|
+
|
|
3247
|
+
:return: The RNA type or default when not found.
|
|
3248
|
+
:rtype: bpy.types.Struct
|
|
3249
|
+
"""
|
|
2194
3250
|
...
|
|
2195
3251
|
|
|
2196
|
-
def bl_rna_get_subclass_py(self):
|
|
2197
|
-
"""
|
|
3252
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3253
|
+
"""
|
|
3254
|
+
|
|
3255
|
+
:return: The class or default when not found.
|
|
3256
|
+
:rtype: typing.Any
|
|
3257
|
+
"""
|
|
2198
3258
|
...
|
|
2199
3259
|
|
|
2200
3260
|
def draw(self, _context):
|
|
@@ -2213,175 +3273,260 @@ class OUTLINER_MT_view_pie(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
2213
3273
|
...
|
|
2214
3274
|
|
|
2215
3275
|
def draw_preset(self, _context):
|
|
2216
|
-
"""
|
|
3276
|
+
"""Define these on the subclass:
|
|
3277
|
+
- preset_operator (string)
|
|
3278
|
+
- preset_subdir (string)Optionally:
|
|
3279
|
+
- preset_add_operator (string)
|
|
3280
|
+
- preset_extensions (set of strings)
|
|
3281
|
+
- preset_operator_defaults (dict of keyword args)
|
|
2217
3282
|
|
|
2218
|
-
|
|
3283
|
+
:param _context:
|
|
2219
3284
|
"""
|
|
2220
3285
|
...
|
|
2221
3286
|
|
|
2222
|
-
def driver_add(self):
|
|
2223
|
-
"""
|
|
3287
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
3288
|
+
"""Adds driver(s) to the given property
|
|
3289
|
+
|
|
3290
|
+
:return: The driver(s) added.
|
|
3291
|
+
:rtype: bpy.types.FCurve
|
|
3292
|
+
"""
|
|
2224
3293
|
...
|
|
2225
3294
|
|
|
2226
|
-
def driver_remove(self):
|
|
2227
|
-
"""
|
|
3295
|
+
def driver_remove(self) -> bool:
|
|
3296
|
+
"""Remove driver(s) from the given property
|
|
3297
|
+
|
|
3298
|
+
:return: Success of driver removal.
|
|
3299
|
+
:rtype: bool
|
|
3300
|
+
"""
|
|
2228
3301
|
...
|
|
2229
3302
|
|
|
2230
3303
|
def get(self):
|
|
2231
|
-
"""
|
|
3304
|
+
"""Returns the value of the custom property assigned to key or default
|
|
3305
|
+
when not found (matches Python's dictionary function of the same name).
|
|
3306
|
+
|
|
3307
|
+
"""
|
|
2232
3308
|
...
|
|
2233
3309
|
|
|
2234
3310
|
def id_properties_clear(self):
|
|
2235
|
-
"""
|
|
3311
|
+
"""
|
|
3312
|
+
|
|
3313
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3314
|
+
"""
|
|
2236
3315
|
...
|
|
2237
3316
|
|
|
2238
3317
|
def id_properties_ensure(self):
|
|
2239
|
-
"""
|
|
3318
|
+
"""
|
|
3319
|
+
|
|
3320
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3321
|
+
"""
|
|
2240
3322
|
...
|
|
2241
3323
|
|
|
2242
3324
|
def id_properties_ui(self):
|
|
2243
|
-
"""
|
|
2244
|
-
...
|
|
3325
|
+
"""
|
|
2245
3326
|
|
|
2246
|
-
|
|
2247
|
-
"""
|
|
3327
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
3328
|
+
"""
|
|
2248
3329
|
...
|
|
2249
3330
|
|
|
2250
|
-
def
|
|
2251
|
-
|
|
3331
|
+
def is_extended(self): ...
|
|
3332
|
+
def is_property_hidden(self) -> bool:
|
|
3333
|
+
"""Check if a property is hidden.
|
|
3334
|
+
|
|
3335
|
+
:return: True when the property is hidden.
|
|
3336
|
+
:rtype: bool
|
|
3337
|
+
"""
|
|
2252
3338
|
...
|
|
2253
3339
|
|
|
2254
|
-
def is_property_overridable_library(self):
|
|
2255
|
-
"""
|
|
3340
|
+
def is_property_overridable_library(self) -> bool:
|
|
3341
|
+
"""Check if a property is overridable.
|
|
3342
|
+
|
|
3343
|
+
:return: True when the property is overridable.
|
|
3344
|
+
:rtype: bool
|
|
3345
|
+
"""
|
|
2256
3346
|
...
|
|
2257
3347
|
|
|
2258
|
-
def is_property_readonly(self):
|
|
2259
|
-
"""
|
|
3348
|
+
def is_property_readonly(self) -> bool:
|
|
3349
|
+
"""Check if a property is readonly.
|
|
3350
|
+
|
|
3351
|
+
:return: True when the property is readonly (not writable).
|
|
3352
|
+
:rtype: bool
|
|
3353
|
+
"""
|
|
2260
3354
|
...
|
|
2261
3355
|
|
|
2262
|
-
def is_property_set(self):
|
|
2263
|
-
"""
|
|
3356
|
+
def is_property_set(self) -> bool:
|
|
3357
|
+
"""Check if a property is set, use for testing operator properties.
|
|
3358
|
+
|
|
3359
|
+
:return: True when the property has been set.
|
|
3360
|
+
:rtype: bool
|
|
3361
|
+
"""
|
|
2264
3362
|
...
|
|
2265
3363
|
|
|
2266
3364
|
def items(self):
|
|
2267
|
-
"""
|
|
3365
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
3366
|
+
dictionary function of the same name).
|
|
3367
|
+
|
|
3368
|
+
:return: custom property key, value pairs.
|
|
3369
|
+
"""
|
|
2268
3370
|
...
|
|
2269
3371
|
|
|
2270
|
-
def keyframe_delete(self):
|
|
2271
|
-
"""
|
|
3372
|
+
def keyframe_delete(self) -> bool:
|
|
3373
|
+
"""Remove a keyframe from this properties fcurve.
|
|
3374
|
+
|
|
3375
|
+
:return: Success of keyframe deletion.
|
|
3376
|
+
:rtype: bool
|
|
3377
|
+
"""
|
|
2272
3378
|
...
|
|
2273
3379
|
|
|
2274
|
-
def keyframe_insert(self):
|
|
2275
|
-
"""
|
|
3380
|
+
def keyframe_insert(self) -> bool:
|
|
3381
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3382
|
+
|
|
3383
|
+
:return: Success of keyframe insertion.
|
|
3384
|
+
:rtype: bool
|
|
3385
|
+
"""
|
|
2276
3386
|
...
|
|
2277
3387
|
|
|
2278
3388
|
def keys(self):
|
|
2279
|
-
"""
|
|
3389
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
3390
|
+
dictionary function of the same name).
|
|
3391
|
+
|
|
3392
|
+
:return: custom property keys.
|
|
3393
|
+
"""
|
|
2280
3394
|
...
|
|
2281
3395
|
|
|
2282
|
-
def path_from_id(self):
|
|
2283
|
-
"""
|
|
3396
|
+
def path_from_id(self) -> str:
|
|
3397
|
+
"""Returns the data path from the ID to this object (string).
|
|
3398
|
+
|
|
3399
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3400
|
+
to this struct and property (when given).
|
|
3401
|
+
:rtype: str
|
|
3402
|
+
"""
|
|
2284
3403
|
...
|
|
2285
3404
|
|
|
2286
3405
|
def path_menu(
|
|
2287
3406
|
self,
|
|
2288
|
-
searchpaths,
|
|
2289
|
-
operator,
|
|
2290
|
-
props_default,
|
|
2291
|
-
prop_filepath,
|
|
2292
|
-
filter_ext,
|
|
2293
|
-
filter_path,
|
|
2294
|
-
display_name,
|
|
2295
|
-
add_operator,
|
|
2296
|
-
add_operator_props,
|
|
3407
|
+
searchpaths: list[str],
|
|
3408
|
+
operator: str,
|
|
3409
|
+
props_default: dict = None,
|
|
3410
|
+
prop_filepath: str = "filepath",
|
|
3411
|
+
filter_ext: typing.Callable = None,
|
|
3412
|
+
filter_path=None,
|
|
3413
|
+
display_name: typing.Callable = None,
|
|
3414
|
+
add_operator=None,
|
|
3415
|
+
add_operator_props=None,
|
|
2297
3416
|
):
|
|
2298
|
-
"""
|
|
3417
|
+
"""Populate a menu from a list of paths.
|
|
2299
3418
|
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
3419
|
+
:param searchpaths: Paths to scan.
|
|
3420
|
+
:type searchpaths: list[str]
|
|
3421
|
+
:param operator: The operator id to use with each file.
|
|
3422
|
+
:type operator: str
|
|
3423
|
+
:param props_default: Properties to assign to each operator.
|
|
3424
|
+
:type props_default: dict
|
|
3425
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3426
|
+
:type prop_filepath: str
|
|
3427
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
3428
|
+
|
|
3429
|
+
Returning false excludes the file from the list.
|
|
3430
|
+
:type filter_ext: typing.Callable
|
|
3431
|
+
:param filter_path:
|
|
3432
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3433
|
+
:type display_name: typing.Callable
|
|
3434
|
+
:param add_operator:
|
|
3435
|
+
:param add_operator_props:
|
|
2309
3436
|
"""
|
|
2310
3437
|
...
|
|
2311
3438
|
|
|
2312
3439
|
def path_resolve(self):
|
|
2313
|
-
""" """
|
|
3440
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
2314
3441
|
...
|
|
2315
3442
|
|
|
2316
3443
|
def pop(self):
|
|
2317
|
-
"""
|
|
3444
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
3445
|
+
when not found (matches Python's dictionary function of the same name).
|
|
3446
|
+
|
|
3447
|
+
"""
|
|
2318
3448
|
...
|
|
2319
3449
|
|
|
2320
3450
|
def prepend(self, draw_func):
|
|
2321
|
-
"""
|
|
3451
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3452
|
+
the menus draw function
|
|
2322
3453
|
|
|
2323
|
-
|
|
3454
|
+
:param draw_func:
|
|
2324
3455
|
"""
|
|
2325
3456
|
...
|
|
2326
3457
|
|
|
2327
|
-
def property_overridable_library_set(self):
|
|
2328
|
-
"""
|
|
3458
|
+
def property_overridable_library_set(self) -> bool:
|
|
3459
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
3460
|
+
|
|
3461
|
+
:return: True when the overridable status of the property was successfully set.
|
|
3462
|
+
:rtype: bool
|
|
3463
|
+
"""
|
|
2329
3464
|
...
|
|
2330
3465
|
|
|
2331
3466
|
def property_unset(self):
|
|
2332
|
-
""" """
|
|
3467
|
+
"""Unset a property, will use default value afterward."""
|
|
2333
3468
|
...
|
|
2334
3469
|
|
|
2335
3470
|
def remove(self, draw_func):
|
|
2336
|
-
"""
|
|
3471
|
+
"""Remove a draw function that has been added to this menu
|
|
2337
3472
|
|
|
2338
3473
|
:param draw_func:
|
|
2339
3474
|
"""
|
|
2340
3475
|
...
|
|
2341
3476
|
|
|
2342
3477
|
def type_recast(self):
|
|
2343
|
-
"""
|
|
3478
|
+
"""Return a new instance, this is needed because types
|
|
3479
|
+
such as textures can be changed at runtime.
|
|
3480
|
+
|
|
3481
|
+
:return: a new instance of this object with the type initialized again.
|
|
3482
|
+
"""
|
|
2344
3483
|
...
|
|
2345
3484
|
|
|
2346
3485
|
def values(self):
|
|
2347
|
-
"""
|
|
3486
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
3487
|
+
dictionary function of the same name).
|
|
3488
|
+
|
|
3489
|
+
:return: custom property values.
|
|
3490
|
+
"""
|
|
2348
3491
|
...
|
|
2349
3492
|
|
|
2350
3493
|
class OUTLINER_PT_filter(bpy_types.Panel, bpy_types._GenericUI):
|
|
2351
|
-
""" """
|
|
2352
|
-
|
|
2353
3494
|
bl_label: typing.Any
|
|
2354
|
-
""" """
|
|
2355
|
-
|
|
2356
3495
|
bl_region_type: typing.Any
|
|
2357
|
-
""" """
|
|
2358
|
-
|
|
2359
3496
|
bl_rna: typing.Any
|
|
2360
|
-
""" """
|
|
2361
|
-
|
|
2362
3497
|
bl_space_type: typing.Any
|
|
2363
|
-
""" """
|
|
2364
|
-
|
|
2365
3498
|
id_data: typing.Any
|
|
2366
|
-
""" """
|
|
2367
3499
|
|
|
2368
3500
|
def append(self, draw_func):
|
|
2369
|
-
"""
|
|
3501
|
+
"""Append a draw function to this menu,
|
|
3502
|
+
takes the same arguments as the menus draw function
|
|
2370
3503
|
|
|
2371
|
-
|
|
3504
|
+
:param draw_func:
|
|
2372
3505
|
"""
|
|
2373
3506
|
...
|
|
2374
3507
|
|
|
2375
|
-
def as_pointer(self):
|
|
2376
|
-
"""
|
|
3508
|
+
def as_pointer(self) -> int:
|
|
3509
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3510
|
+
|
|
3511
|
+
:return: int (memory address).
|
|
3512
|
+
:rtype: int
|
|
3513
|
+
"""
|
|
2377
3514
|
...
|
|
2378
3515
|
|
|
2379
|
-
def bl_rna_get_subclass(self):
|
|
2380
|
-
"""
|
|
3516
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3517
|
+
"""
|
|
3518
|
+
|
|
3519
|
+
:return: The RNA type or default when not found.
|
|
3520
|
+
:rtype: bpy.types.Struct
|
|
3521
|
+
"""
|
|
2381
3522
|
...
|
|
2382
3523
|
|
|
2383
|
-
def bl_rna_get_subclass_py(self):
|
|
2384
|
-
"""
|
|
3524
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3525
|
+
"""
|
|
3526
|
+
|
|
3527
|
+
:return: The class or default when not found.
|
|
3528
|
+
:rtype: typing.Any
|
|
3529
|
+
"""
|
|
2385
3530
|
...
|
|
2386
3531
|
|
|
2387
3532
|
def draw(self, context):
|
|
@@ -2391,109 +3536,176 @@ class OUTLINER_PT_filter(bpy_types.Panel, bpy_types._GenericUI):
|
|
|
2391
3536
|
"""
|
|
2392
3537
|
...
|
|
2393
3538
|
|
|
2394
|
-
def driver_add(self):
|
|
2395
|
-
"""
|
|
3539
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
3540
|
+
"""Adds driver(s) to the given property
|
|
3541
|
+
|
|
3542
|
+
:return: The driver(s) added.
|
|
3543
|
+
:rtype: bpy.types.FCurve
|
|
3544
|
+
"""
|
|
2396
3545
|
...
|
|
2397
3546
|
|
|
2398
|
-
def driver_remove(self):
|
|
2399
|
-
"""
|
|
3547
|
+
def driver_remove(self) -> bool:
|
|
3548
|
+
"""Remove driver(s) from the given property
|
|
3549
|
+
|
|
3550
|
+
:return: Success of driver removal.
|
|
3551
|
+
:rtype: bool
|
|
3552
|
+
"""
|
|
2400
3553
|
...
|
|
2401
3554
|
|
|
2402
3555
|
def get(self):
|
|
2403
|
-
"""
|
|
3556
|
+
"""Returns the value of the custom property assigned to key or default
|
|
3557
|
+
when not found (matches Python's dictionary function of the same name).
|
|
3558
|
+
|
|
3559
|
+
"""
|
|
2404
3560
|
...
|
|
2405
3561
|
|
|
2406
3562
|
def id_properties_clear(self):
|
|
2407
|
-
"""
|
|
3563
|
+
"""
|
|
3564
|
+
|
|
3565
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3566
|
+
"""
|
|
2408
3567
|
...
|
|
2409
3568
|
|
|
2410
3569
|
def id_properties_ensure(self):
|
|
2411
|
-
"""
|
|
3570
|
+
"""
|
|
3571
|
+
|
|
3572
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3573
|
+
"""
|
|
2412
3574
|
...
|
|
2413
3575
|
|
|
2414
3576
|
def id_properties_ui(self):
|
|
2415
|
-
"""
|
|
2416
|
-
...
|
|
3577
|
+
"""
|
|
2417
3578
|
|
|
2418
|
-
|
|
2419
|
-
"""
|
|
3579
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
3580
|
+
"""
|
|
2420
3581
|
...
|
|
2421
3582
|
|
|
2422
|
-
def
|
|
2423
|
-
|
|
3583
|
+
def is_extended(self): ...
|
|
3584
|
+
def is_property_hidden(self) -> bool:
|
|
3585
|
+
"""Check if a property is hidden.
|
|
3586
|
+
|
|
3587
|
+
:return: True when the property is hidden.
|
|
3588
|
+
:rtype: bool
|
|
3589
|
+
"""
|
|
2424
3590
|
...
|
|
2425
3591
|
|
|
2426
|
-
def is_property_overridable_library(self):
|
|
2427
|
-
"""
|
|
3592
|
+
def is_property_overridable_library(self) -> bool:
|
|
3593
|
+
"""Check if a property is overridable.
|
|
3594
|
+
|
|
3595
|
+
:return: True when the property is overridable.
|
|
3596
|
+
:rtype: bool
|
|
3597
|
+
"""
|
|
2428
3598
|
...
|
|
2429
3599
|
|
|
2430
|
-
def is_property_readonly(self):
|
|
2431
|
-
"""
|
|
3600
|
+
def is_property_readonly(self) -> bool:
|
|
3601
|
+
"""Check if a property is readonly.
|
|
3602
|
+
|
|
3603
|
+
:return: True when the property is readonly (not writable).
|
|
3604
|
+
:rtype: bool
|
|
3605
|
+
"""
|
|
2432
3606
|
...
|
|
2433
3607
|
|
|
2434
|
-
def is_property_set(self):
|
|
2435
|
-
"""
|
|
3608
|
+
def is_property_set(self) -> bool:
|
|
3609
|
+
"""Check if a property is set, use for testing operator properties.
|
|
3610
|
+
|
|
3611
|
+
:return: True when the property has been set.
|
|
3612
|
+
:rtype: bool
|
|
3613
|
+
"""
|
|
2436
3614
|
...
|
|
2437
3615
|
|
|
2438
3616
|
def items(self):
|
|
2439
|
-
"""
|
|
3617
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
3618
|
+
dictionary function of the same name).
|
|
3619
|
+
|
|
3620
|
+
:return: custom property key, value pairs.
|
|
3621
|
+
"""
|
|
2440
3622
|
...
|
|
2441
3623
|
|
|
2442
|
-
def keyframe_delete(self):
|
|
2443
|
-
"""
|
|
3624
|
+
def keyframe_delete(self) -> bool:
|
|
3625
|
+
"""Remove a keyframe from this properties fcurve.
|
|
3626
|
+
|
|
3627
|
+
:return: Success of keyframe deletion.
|
|
3628
|
+
:rtype: bool
|
|
3629
|
+
"""
|
|
2444
3630
|
...
|
|
2445
3631
|
|
|
2446
|
-
def keyframe_insert(self):
|
|
2447
|
-
"""
|
|
3632
|
+
def keyframe_insert(self) -> bool:
|
|
3633
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3634
|
+
|
|
3635
|
+
:return: Success of keyframe insertion.
|
|
3636
|
+
:rtype: bool
|
|
3637
|
+
"""
|
|
2448
3638
|
...
|
|
2449
3639
|
|
|
2450
3640
|
def keys(self):
|
|
2451
|
-
"""
|
|
3641
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
3642
|
+
dictionary function of the same name).
|
|
3643
|
+
|
|
3644
|
+
:return: custom property keys.
|
|
3645
|
+
"""
|
|
2452
3646
|
...
|
|
2453
3647
|
|
|
2454
|
-
def path_from_id(self):
|
|
2455
|
-
"""
|
|
3648
|
+
def path_from_id(self) -> str:
|
|
3649
|
+
"""Returns the data path from the ID to this object (string).
|
|
3650
|
+
|
|
3651
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3652
|
+
to this struct and property (when given).
|
|
3653
|
+
:rtype: str
|
|
3654
|
+
"""
|
|
2456
3655
|
...
|
|
2457
3656
|
|
|
2458
3657
|
def path_resolve(self):
|
|
2459
|
-
""" """
|
|
3658
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
2460
3659
|
...
|
|
2461
3660
|
|
|
2462
3661
|
def pop(self):
|
|
2463
|
-
"""
|
|
3662
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
3663
|
+
when not found (matches Python's dictionary function of the same name).
|
|
3664
|
+
|
|
3665
|
+
"""
|
|
2464
3666
|
...
|
|
2465
3667
|
|
|
2466
3668
|
def prepend(self, draw_func):
|
|
2467
|
-
"""
|
|
3669
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3670
|
+
the menus draw function
|
|
2468
3671
|
|
|
2469
|
-
|
|
3672
|
+
:param draw_func:
|
|
2470
3673
|
"""
|
|
2471
3674
|
...
|
|
2472
3675
|
|
|
2473
|
-
def property_overridable_library_set(self):
|
|
2474
|
-
"""
|
|
3676
|
+
def property_overridable_library_set(self) -> bool:
|
|
3677
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
3678
|
+
|
|
3679
|
+
:return: True when the overridable status of the property was successfully set.
|
|
3680
|
+
:rtype: bool
|
|
3681
|
+
"""
|
|
2475
3682
|
...
|
|
2476
3683
|
|
|
2477
3684
|
def property_unset(self):
|
|
2478
|
-
""" """
|
|
3685
|
+
"""Unset a property, will use default value afterward."""
|
|
2479
3686
|
...
|
|
2480
3687
|
|
|
2481
3688
|
def remove(self, draw_func):
|
|
2482
|
-
"""
|
|
3689
|
+
"""Remove a draw function that has been added to this menu
|
|
2483
3690
|
|
|
2484
3691
|
:param draw_func:
|
|
2485
3692
|
"""
|
|
2486
3693
|
...
|
|
2487
3694
|
|
|
2488
3695
|
def type_recast(self):
|
|
2489
|
-
"""
|
|
3696
|
+
"""Return a new instance, this is needed because types
|
|
3697
|
+
such as textures can be changed at runtime.
|
|
3698
|
+
|
|
3699
|
+
:return: a new instance of this object with the type initialized again.
|
|
3700
|
+
"""
|
|
2490
3701
|
...
|
|
2491
3702
|
|
|
2492
3703
|
def values(self):
|
|
2493
|
-
"""
|
|
2494
|
-
|
|
3704
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
3705
|
+
dictionary function of the same name).
|
|
2495
3706
|
|
|
2496
|
-
|
|
2497
|
-
|
|
3707
|
+
:return: custom property values.
|
|
3708
|
+
"""
|
|
3709
|
+
...
|
|
2498
3710
|
|
|
2499
|
-
|
|
3711
|
+
def has_selected_ids_in_context(context): ...
|