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
bl_ui/space_info/__init__.pyi
CHANGED
|
@@ -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 INFO_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,140 +48,214 @@ class INFO_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 INFO_MT_area(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
|
bl_translation_context: typing.Any
|
|
156
|
-
""" """
|
|
157
|
-
|
|
158
227
|
id_data: typing.Any
|
|
159
|
-
""" """
|
|
160
228
|
|
|
161
229
|
def append(self, draw_func):
|
|
162
|
-
"""
|
|
230
|
+
"""Append a draw function to this menu,
|
|
231
|
+
takes the same arguments as the menus draw function
|
|
163
232
|
|
|
164
|
-
|
|
233
|
+
:param draw_func:
|
|
165
234
|
"""
|
|
166
235
|
...
|
|
167
236
|
|
|
168
|
-
def as_pointer(self):
|
|
169
|
-
"""
|
|
237
|
+
def as_pointer(self) -> int:
|
|
238
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
239
|
+
|
|
240
|
+
:return: int (memory address).
|
|
241
|
+
:rtype: int
|
|
242
|
+
"""
|
|
170
243
|
...
|
|
171
244
|
|
|
172
|
-
def bl_rna_get_subclass(self):
|
|
173
|
-
"""
|
|
245
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
246
|
+
"""
|
|
247
|
+
|
|
248
|
+
:return: The RNA type or default when not found.
|
|
249
|
+
:rtype: bpy.types.Struct
|
|
250
|
+
"""
|
|
174
251
|
...
|
|
175
252
|
|
|
176
|
-
def bl_rna_get_subclass_py(self):
|
|
177
|
-
"""
|
|
253
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
254
|
+
"""
|
|
255
|
+
|
|
256
|
+
:return: The class or default when not found.
|
|
257
|
+
:rtype: typing.Any
|
|
258
|
+
"""
|
|
178
259
|
...
|
|
179
260
|
|
|
180
261
|
def draw(self, context):
|
|
@@ -193,169 +274,258 @@ class INFO_MT_area(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
193
274
|
...
|
|
194
275
|
|
|
195
276
|
def draw_preset(self, _context):
|
|
196
|
-
"""
|
|
277
|
+
"""Define these on the subclass:
|
|
278
|
+
- preset_operator (string)
|
|
279
|
+
- preset_subdir (string)Optionally:
|
|
280
|
+
- preset_add_operator (string)
|
|
281
|
+
- preset_extensions (set of strings)
|
|
282
|
+
- preset_operator_defaults (dict of keyword args)
|
|
197
283
|
|
|
198
|
-
|
|
284
|
+
:param _context:
|
|
199
285
|
"""
|
|
200
286
|
...
|
|
201
287
|
|
|
202
|
-
def driver_add(self):
|
|
203
|
-
"""
|
|
288
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
289
|
+
"""Adds driver(s) to the given property
|
|
290
|
+
|
|
291
|
+
:return: The driver(s) added.
|
|
292
|
+
:rtype: bpy.types.FCurve
|
|
293
|
+
"""
|
|
204
294
|
...
|
|
205
295
|
|
|
206
|
-
def driver_remove(self):
|
|
207
|
-
"""
|
|
296
|
+
def driver_remove(self) -> bool:
|
|
297
|
+
"""Remove driver(s) from the given property
|
|
298
|
+
|
|
299
|
+
:return: Success of driver removal.
|
|
300
|
+
:rtype: bool
|
|
301
|
+
"""
|
|
208
302
|
...
|
|
209
303
|
|
|
210
304
|
def get(self):
|
|
211
|
-
"""
|
|
305
|
+
"""Returns the value of the custom property assigned to key or default
|
|
306
|
+
when not found (matches Python's dictionary function of the same name).
|
|
307
|
+
|
|
308
|
+
"""
|
|
212
309
|
...
|
|
213
310
|
|
|
214
311
|
def id_properties_clear(self):
|
|
215
|
-
"""
|
|
312
|
+
"""
|
|
313
|
+
|
|
314
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
315
|
+
"""
|
|
216
316
|
...
|
|
217
317
|
|
|
218
318
|
def id_properties_ensure(self):
|
|
219
|
-
"""
|
|
319
|
+
"""
|
|
320
|
+
|
|
321
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
322
|
+
"""
|
|
220
323
|
...
|
|
221
324
|
|
|
222
325
|
def id_properties_ui(self):
|
|
223
|
-
"""
|
|
224
|
-
...
|
|
326
|
+
"""
|
|
225
327
|
|
|
226
|
-
|
|
227
|
-
"""
|
|
328
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
329
|
+
"""
|
|
228
330
|
...
|
|
229
331
|
|
|
230
|
-
def
|
|
231
|
-
|
|
332
|
+
def is_extended(self): ...
|
|
333
|
+
def is_property_hidden(self) -> bool:
|
|
334
|
+
"""Check if a property is hidden.
|
|
335
|
+
|
|
336
|
+
:return: True when the property is hidden.
|
|
337
|
+
:rtype: bool
|
|
338
|
+
"""
|
|
232
339
|
...
|
|
233
340
|
|
|
234
|
-
def is_property_overridable_library(self):
|
|
235
|
-
"""
|
|
341
|
+
def is_property_overridable_library(self) -> bool:
|
|
342
|
+
"""Check if a property is overridable.
|
|
343
|
+
|
|
344
|
+
:return: True when the property is overridable.
|
|
345
|
+
:rtype: bool
|
|
346
|
+
"""
|
|
236
347
|
...
|
|
237
348
|
|
|
238
|
-
def is_property_readonly(self):
|
|
239
|
-
"""
|
|
349
|
+
def is_property_readonly(self) -> bool:
|
|
350
|
+
"""Check if a property is readonly.
|
|
351
|
+
|
|
352
|
+
:return: True when the property is readonly (not writable).
|
|
353
|
+
:rtype: bool
|
|
354
|
+
"""
|
|
240
355
|
...
|
|
241
356
|
|
|
242
|
-
def is_property_set(self):
|
|
243
|
-
"""
|
|
357
|
+
def is_property_set(self) -> bool:
|
|
358
|
+
"""Check if a property is set, use for testing operator properties.
|
|
359
|
+
|
|
360
|
+
:return: True when the property has been set.
|
|
361
|
+
:rtype: bool
|
|
362
|
+
"""
|
|
244
363
|
...
|
|
245
364
|
|
|
246
365
|
def items(self):
|
|
247
|
-
"""
|
|
366
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
367
|
+
dictionary function of the same name).
|
|
368
|
+
|
|
369
|
+
:return: custom property key, value pairs.
|
|
370
|
+
"""
|
|
248
371
|
...
|
|
249
372
|
|
|
250
|
-
def keyframe_delete(self):
|
|
251
|
-
"""
|
|
373
|
+
def keyframe_delete(self) -> bool:
|
|
374
|
+
"""Remove a keyframe from this properties fcurve.
|
|
375
|
+
|
|
376
|
+
:return: Success of keyframe deletion.
|
|
377
|
+
:rtype: bool
|
|
378
|
+
"""
|
|
252
379
|
...
|
|
253
380
|
|
|
254
|
-
def keyframe_insert(self):
|
|
255
|
-
"""
|
|
381
|
+
def keyframe_insert(self) -> bool:
|
|
382
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
383
|
+
|
|
384
|
+
:return: Success of keyframe insertion.
|
|
385
|
+
:rtype: bool
|
|
386
|
+
"""
|
|
256
387
|
...
|
|
257
388
|
|
|
258
389
|
def keys(self):
|
|
259
|
-
"""
|
|
390
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
391
|
+
dictionary function of the same name).
|
|
392
|
+
|
|
393
|
+
:return: custom property keys.
|
|
394
|
+
"""
|
|
260
395
|
...
|
|
261
396
|
|
|
262
|
-
def path_from_id(self):
|
|
263
|
-
"""
|
|
397
|
+
def path_from_id(self) -> str:
|
|
398
|
+
"""Returns the data path from the ID to this object (string).
|
|
399
|
+
|
|
400
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
401
|
+
to this struct and property (when given).
|
|
402
|
+
:rtype: str
|
|
403
|
+
"""
|
|
264
404
|
...
|
|
265
405
|
|
|
266
406
|
def path_menu(
|
|
267
407
|
self,
|
|
268
|
-
searchpaths,
|
|
269
|
-
operator,
|
|
270
|
-
props_default,
|
|
271
|
-
prop_filepath,
|
|
272
|
-
filter_ext,
|
|
273
|
-
filter_path,
|
|
274
|
-
display_name,
|
|
275
|
-
add_operator,
|
|
276
|
-
add_operator_props,
|
|
408
|
+
searchpaths: list[str],
|
|
409
|
+
operator: str,
|
|
410
|
+
props_default: dict = None,
|
|
411
|
+
prop_filepath: str = "filepath",
|
|
412
|
+
filter_ext: typing.Callable = None,
|
|
413
|
+
filter_path=None,
|
|
414
|
+
display_name: typing.Callable = None,
|
|
415
|
+
add_operator=None,
|
|
416
|
+
add_operator_props=None,
|
|
277
417
|
):
|
|
278
|
-
"""
|
|
418
|
+
"""Populate a menu from a list of paths.
|
|
419
|
+
|
|
420
|
+
:param searchpaths: Paths to scan.
|
|
421
|
+
:type searchpaths: list[str]
|
|
422
|
+
:param operator: The operator id to use with each file.
|
|
423
|
+
:type operator: str
|
|
424
|
+
:param props_default: Properties to assign to each operator.
|
|
425
|
+
:type props_default: dict
|
|
426
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
427
|
+
:type prop_filepath: str
|
|
428
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
279
429
|
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
:param add_operator:
|
|
288
|
-
:param add_operator_props:
|
|
430
|
+
Returning false excludes the file from the list.
|
|
431
|
+
:type filter_ext: typing.Callable
|
|
432
|
+
:param filter_path:
|
|
433
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
434
|
+
:type display_name: typing.Callable
|
|
435
|
+
:param add_operator:
|
|
436
|
+
:param add_operator_props:
|
|
289
437
|
"""
|
|
290
438
|
...
|
|
291
439
|
|
|
292
440
|
def path_resolve(self):
|
|
293
|
-
""" """
|
|
441
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
294
442
|
...
|
|
295
443
|
|
|
296
444
|
def pop(self):
|
|
297
|
-
"""
|
|
445
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
446
|
+
when not found (matches Python's dictionary function of the same name).
|
|
447
|
+
|
|
448
|
+
"""
|
|
298
449
|
...
|
|
299
450
|
|
|
300
451
|
def prepend(self, draw_func):
|
|
301
|
-
"""
|
|
452
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
453
|
+
the menus draw function
|
|
302
454
|
|
|
303
|
-
|
|
455
|
+
:param draw_func:
|
|
304
456
|
"""
|
|
305
457
|
...
|
|
306
458
|
|
|
307
|
-
def property_overridable_library_set(self):
|
|
308
|
-
"""
|
|
459
|
+
def property_overridable_library_set(self) -> bool:
|
|
460
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
461
|
+
|
|
462
|
+
:return: True when the overridable status of the property was successfully set.
|
|
463
|
+
:rtype: bool
|
|
464
|
+
"""
|
|
309
465
|
...
|
|
310
466
|
|
|
311
467
|
def property_unset(self):
|
|
312
|
-
""" """
|
|
468
|
+
"""Unset a property, will use default value afterward."""
|
|
313
469
|
...
|
|
314
470
|
|
|
315
471
|
def remove(self, draw_func):
|
|
316
|
-
"""
|
|
472
|
+
"""Remove a draw function that has been added to this menu
|
|
317
473
|
|
|
318
474
|
:param draw_func:
|
|
319
475
|
"""
|
|
320
476
|
...
|
|
321
477
|
|
|
322
478
|
def type_recast(self):
|
|
323
|
-
"""
|
|
479
|
+
"""Return a new instance, this is needed because types
|
|
480
|
+
such as textures can be changed at runtime.
|
|
481
|
+
|
|
482
|
+
:return: a new instance of this object with the type initialized again.
|
|
483
|
+
"""
|
|
324
484
|
...
|
|
325
485
|
|
|
326
486
|
def values(self):
|
|
327
|
-
"""
|
|
487
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
488
|
+
dictionary function of the same name).
|
|
489
|
+
|
|
490
|
+
:return: custom property values.
|
|
491
|
+
"""
|
|
328
492
|
...
|
|
329
493
|
|
|
330
494
|
class INFO_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
331
|
-
""" """
|
|
332
|
-
|
|
333
495
|
bl_label: typing.Any
|
|
334
|
-
""" """
|
|
335
|
-
|
|
336
496
|
bl_rna: typing.Any
|
|
337
|
-
""" """
|
|
338
|
-
|
|
339
497
|
id_data: typing.Any
|
|
340
|
-
""" """
|
|
341
498
|
|
|
342
499
|
def append(self, draw_func):
|
|
343
|
-
"""
|
|
500
|
+
"""Append a draw function to this menu,
|
|
501
|
+
takes the same arguments as the menus draw function
|
|
344
502
|
|
|
345
|
-
|
|
503
|
+
:param draw_func:
|
|
346
504
|
"""
|
|
347
505
|
...
|
|
348
506
|
|
|
349
|
-
def as_pointer(self):
|
|
350
|
-
"""
|
|
507
|
+
def as_pointer(self) -> int:
|
|
508
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
509
|
+
|
|
510
|
+
:return: int (memory address).
|
|
511
|
+
:rtype: int
|
|
512
|
+
"""
|
|
351
513
|
...
|
|
352
514
|
|
|
353
|
-
def bl_rna_get_subclass(self):
|
|
354
|
-
"""
|
|
515
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
516
|
+
"""
|
|
517
|
+
|
|
518
|
+
:return: The RNA type or default when not found.
|
|
519
|
+
:rtype: bpy.types.Struct
|
|
520
|
+
"""
|
|
355
521
|
...
|
|
356
522
|
|
|
357
|
-
def bl_rna_get_subclass_py(self):
|
|
358
|
-
"""
|
|
523
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
524
|
+
"""
|
|
525
|
+
|
|
526
|
+
:return: The class or default when not found.
|
|
527
|
+
:rtype: typing.Any
|
|
528
|
+
"""
|
|
359
529
|
...
|
|
360
530
|
|
|
361
531
|
def draw(self, _context):
|
|
@@ -374,172 +544,259 @@ class INFO_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
374
544
|
...
|
|
375
545
|
|
|
376
546
|
def draw_preset(self, _context):
|
|
377
|
-
"""
|
|
547
|
+
"""Define these on the subclass:
|
|
548
|
+
- preset_operator (string)
|
|
549
|
+
- preset_subdir (string)Optionally:
|
|
550
|
+
- preset_add_operator (string)
|
|
551
|
+
- preset_extensions (set of strings)
|
|
552
|
+
- preset_operator_defaults (dict of keyword args)
|
|
378
553
|
|
|
379
|
-
|
|
554
|
+
:param _context:
|
|
380
555
|
"""
|
|
381
556
|
...
|
|
382
557
|
|
|
383
|
-
def driver_add(self):
|
|
384
|
-
"""
|
|
558
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
559
|
+
"""Adds driver(s) to the given property
|
|
560
|
+
|
|
561
|
+
:return: The driver(s) added.
|
|
562
|
+
:rtype: bpy.types.FCurve
|
|
563
|
+
"""
|
|
385
564
|
...
|
|
386
565
|
|
|
387
|
-
def driver_remove(self):
|
|
388
|
-
"""
|
|
566
|
+
def driver_remove(self) -> bool:
|
|
567
|
+
"""Remove driver(s) from the given property
|
|
568
|
+
|
|
569
|
+
:return: Success of driver removal.
|
|
570
|
+
:rtype: bool
|
|
571
|
+
"""
|
|
389
572
|
...
|
|
390
573
|
|
|
391
574
|
def get(self):
|
|
392
|
-
"""
|
|
575
|
+
"""Returns the value of the custom property assigned to key or default
|
|
576
|
+
when not found (matches Python's dictionary function of the same name).
|
|
577
|
+
|
|
578
|
+
"""
|
|
393
579
|
...
|
|
394
580
|
|
|
395
581
|
def id_properties_clear(self):
|
|
396
|
-
"""
|
|
582
|
+
"""
|
|
583
|
+
|
|
584
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
585
|
+
"""
|
|
397
586
|
...
|
|
398
587
|
|
|
399
588
|
def id_properties_ensure(self):
|
|
400
|
-
"""
|
|
589
|
+
"""
|
|
590
|
+
|
|
591
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
592
|
+
"""
|
|
401
593
|
...
|
|
402
594
|
|
|
403
595
|
def id_properties_ui(self):
|
|
404
|
-
"""
|
|
405
|
-
...
|
|
596
|
+
"""
|
|
406
597
|
|
|
407
|
-
|
|
408
|
-
"""
|
|
598
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
599
|
+
"""
|
|
409
600
|
...
|
|
410
601
|
|
|
411
|
-
def
|
|
412
|
-
|
|
602
|
+
def is_extended(self): ...
|
|
603
|
+
def is_property_hidden(self) -> bool:
|
|
604
|
+
"""Check if a property is hidden.
|
|
605
|
+
|
|
606
|
+
:return: True when the property is hidden.
|
|
607
|
+
:rtype: bool
|
|
608
|
+
"""
|
|
413
609
|
...
|
|
414
610
|
|
|
415
|
-
def is_property_overridable_library(self):
|
|
416
|
-
"""
|
|
611
|
+
def is_property_overridable_library(self) -> bool:
|
|
612
|
+
"""Check if a property is overridable.
|
|
613
|
+
|
|
614
|
+
:return: True when the property is overridable.
|
|
615
|
+
:rtype: bool
|
|
616
|
+
"""
|
|
417
617
|
...
|
|
418
618
|
|
|
419
|
-
def is_property_readonly(self):
|
|
420
|
-
"""
|
|
619
|
+
def is_property_readonly(self) -> bool:
|
|
620
|
+
"""Check if a property is readonly.
|
|
621
|
+
|
|
622
|
+
:return: True when the property is readonly (not writable).
|
|
623
|
+
:rtype: bool
|
|
624
|
+
"""
|
|
421
625
|
...
|
|
422
626
|
|
|
423
|
-
def is_property_set(self):
|
|
424
|
-
"""
|
|
627
|
+
def is_property_set(self) -> bool:
|
|
628
|
+
"""Check if a property is set, use for testing operator properties.
|
|
629
|
+
|
|
630
|
+
:return: True when the property has been set.
|
|
631
|
+
:rtype: bool
|
|
632
|
+
"""
|
|
425
633
|
...
|
|
426
634
|
|
|
427
635
|
def items(self):
|
|
428
|
-
"""
|
|
636
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
637
|
+
dictionary function of the same name).
|
|
638
|
+
|
|
639
|
+
:return: custom property key, value pairs.
|
|
640
|
+
"""
|
|
429
641
|
...
|
|
430
642
|
|
|
431
|
-
def keyframe_delete(self):
|
|
432
|
-
"""
|
|
643
|
+
def keyframe_delete(self) -> bool:
|
|
644
|
+
"""Remove a keyframe from this properties fcurve.
|
|
645
|
+
|
|
646
|
+
:return: Success of keyframe deletion.
|
|
647
|
+
:rtype: bool
|
|
648
|
+
"""
|
|
433
649
|
...
|
|
434
650
|
|
|
435
|
-
def keyframe_insert(self):
|
|
436
|
-
"""
|
|
651
|
+
def keyframe_insert(self) -> bool:
|
|
652
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
653
|
+
|
|
654
|
+
:return: Success of keyframe insertion.
|
|
655
|
+
:rtype: bool
|
|
656
|
+
"""
|
|
437
657
|
...
|
|
438
658
|
|
|
439
659
|
def keys(self):
|
|
440
|
-
"""
|
|
660
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
661
|
+
dictionary function of the same name).
|
|
662
|
+
|
|
663
|
+
:return: custom property keys.
|
|
664
|
+
"""
|
|
441
665
|
...
|
|
442
666
|
|
|
443
|
-
def path_from_id(self):
|
|
444
|
-
"""
|
|
667
|
+
def path_from_id(self) -> str:
|
|
668
|
+
"""Returns the data path from the ID to this object (string).
|
|
669
|
+
|
|
670
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
671
|
+
to this struct and property (when given).
|
|
672
|
+
:rtype: str
|
|
673
|
+
"""
|
|
445
674
|
...
|
|
446
675
|
|
|
447
676
|
def path_menu(
|
|
448
677
|
self,
|
|
449
|
-
searchpaths,
|
|
450
|
-
operator,
|
|
451
|
-
props_default,
|
|
452
|
-
prop_filepath,
|
|
453
|
-
filter_ext,
|
|
454
|
-
filter_path,
|
|
455
|
-
display_name,
|
|
456
|
-
add_operator,
|
|
457
|
-
add_operator_props,
|
|
678
|
+
searchpaths: list[str],
|
|
679
|
+
operator: str,
|
|
680
|
+
props_default: dict = None,
|
|
681
|
+
prop_filepath: str = "filepath",
|
|
682
|
+
filter_ext: typing.Callable = None,
|
|
683
|
+
filter_path=None,
|
|
684
|
+
display_name: typing.Callable = None,
|
|
685
|
+
add_operator=None,
|
|
686
|
+
add_operator_props=None,
|
|
458
687
|
):
|
|
459
|
-
"""
|
|
688
|
+
"""Populate a menu from a list of paths.
|
|
689
|
+
|
|
690
|
+
:param searchpaths: Paths to scan.
|
|
691
|
+
:type searchpaths: list[str]
|
|
692
|
+
:param operator: The operator id to use with each file.
|
|
693
|
+
:type operator: str
|
|
694
|
+
:param props_default: Properties to assign to each operator.
|
|
695
|
+
:type props_default: dict
|
|
696
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
697
|
+
:type prop_filepath: str
|
|
698
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
460
699
|
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
:param add_operator:
|
|
469
|
-
:param add_operator_props:
|
|
700
|
+
Returning false excludes the file from the list.
|
|
701
|
+
:type filter_ext: typing.Callable
|
|
702
|
+
:param filter_path:
|
|
703
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
704
|
+
:type display_name: typing.Callable
|
|
705
|
+
:param add_operator:
|
|
706
|
+
:param add_operator_props:
|
|
470
707
|
"""
|
|
471
708
|
...
|
|
472
709
|
|
|
473
710
|
def path_resolve(self):
|
|
474
|
-
""" """
|
|
711
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
475
712
|
...
|
|
476
713
|
|
|
477
714
|
def pop(self):
|
|
478
|
-
"""
|
|
715
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
716
|
+
when not found (matches Python's dictionary function of the same name).
|
|
717
|
+
|
|
718
|
+
"""
|
|
479
719
|
...
|
|
480
720
|
|
|
481
721
|
def prepend(self, draw_func):
|
|
482
|
-
"""
|
|
722
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
723
|
+
the menus draw function
|
|
483
724
|
|
|
484
|
-
|
|
725
|
+
:param draw_func:
|
|
485
726
|
"""
|
|
486
727
|
...
|
|
487
728
|
|
|
488
|
-
def property_overridable_library_set(self):
|
|
489
|
-
"""
|
|
729
|
+
def property_overridable_library_set(self) -> bool:
|
|
730
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
731
|
+
|
|
732
|
+
:return: True when the overridable status of the property was successfully set.
|
|
733
|
+
:rtype: bool
|
|
734
|
+
"""
|
|
490
735
|
...
|
|
491
736
|
|
|
492
737
|
def property_unset(self):
|
|
493
|
-
""" """
|
|
738
|
+
"""Unset a property, will use default value afterward."""
|
|
494
739
|
...
|
|
495
740
|
|
|
496
741
|
def remove(self, draw_func):
|
|
497
|
-
"""
|
|
742
|
+
"""Remove a draw function that has been added to this menu
|
|
498
743
|
|
|
499
744
|
:param draw_func:
|
|
500
745
|
"""
|
|
501
746
|
...
|
|
502
747
|
|
|
503
748
|
def type_recast(self):
|
|
504
|
-
"""
|
|
749
|
+
"""Return a new instance, this is needed because types
|
|
750
|
+
such as textures can be changed at runtime.
|
|
751
|
+
|
|
752
|
+
:return: a new instance of this object with the type initialized again.
|
|
753
|
+
"""
|
|
505
754
|
...
|
|
506
755
|
|
|
507
756
|
def values(self):
|
|
508
|
-
"""
|
|
757
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
758
|
+
dictionary function of the same name).
|
|
759
|
+
|
|
760
|
+
:return: custom property values.
|
|
761
|
+
"""
|
|
509
762
|
...
|
|
510
763
|
|
|
511
764
|
class INFO_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
512
|
-
""" """
|
|
513
|
-
|
|
514
765
|
bl_idname: typing.Any
|
|
515
|
-
""" """
|
|
516
|
-
|
|
517
766
|
bl_label: typing.Any
|
|
518
|
-
""" """
|
|
519
|
-
|
|
520
767
|
bl_rna: typing.Any
|
|
521
|
-
""" """
|
|
522
|
-
|
|
523
768
|
id_data: typing.Any
|
|
524
|
-
""" """
|
|
525
769
|
|
|
526
770
|
def append(self, draw_func):
|
|
527
|
-
"""
|
|
771
|
+
"""Append a draw function to this menu,
|
|
772
|
+
takes the same arguments as the menus draw function
|
|
528
773
|
|
|
529
|
-
|
|
774
|
+
:param draw_func:
|
|
530
775
|
"""
|
|
531
776
|
...
|
|
532
777
|
|
|
533
|
-
def as_pointer(self):
|
|
534
|
-
"""
|
|
778
|
+
def as_pointer(self) -> int:
|
|
779
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
780
|
+
|
|
781
|
+
:return: int (memory address).
|
|
782
|
+
:rtype: int
|
|
783
|
+
"""
|
|
535
784
|
...
|
|
536
785
|
|
|
537
|
-
def bl_rna_get_subclass(self):
|
|
538
|
-
"""
|
|
786
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
787
|
+
"""
|
|
788
|
+
|
|
789
|
+
:return: The RNA type or default when not found.
|
|
790
|
+
:rtype: bpy.types.Struct
|
|
791
|
+
"""
|
|
539
792
|
...
|
|
540
793
|
|
|
541
|
-
def bl_rna_get_subclass_py(self):
|
|
542
|
-
"""
|
|
794
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
795
|
+
"""
|
|
796
|
+
|
|
797
|
+
:return: The class or default when not found.
|
|
798
|
+
:rtype: typing.Any
|
|
799
|
+
"""
|
|
543
800
|
...
|
|
544
801
|
|
|
545
802
|
def draw(self, _context):
|
|
@@ -558,169 +815,258 @@ class INFO_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
558
815
|
...
|
|
559
816
|
|
|
560
817
|
def draw_preset(self, _context):
|
|
561
|
-
"""
|
|
818
|
+
"""Define these on the subclass:
|
|
819
|
+
- preset_operator (string)
|
|
820
|
+
- preset_subdir (string)Optionally:
|
|
821
|
+
- preset_add_operator (string)
|
|
822
|
+
- preset_extensions (set of strings)
|
|
823
|
+
- preset_operator_defaults (dict of keyword args)
|
|
562
824
|
|
|
563
|
-
|
|
825
|
+
:param _context:
|
|
564
826
|
"""
|
|
565
827
|
...
|
|
566
828
|
|
|
567
|
-
def driver_add(self):
|
|
568
|
-
"""
|
|
829
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
830
|
+
"""Adds driver(s) to the given property
|
|
831
|
+
|
|
832
|
+
:return: The driver(s) added.
|
|
833
|
+
:rtype: bpy.types.FCurve
|
|
834
|
+
"""
|
|
569
835
|
...
|
|
570
836
|
|
|
571
|
-
def driver_remove(self):
|
|
572
|
-
"""
|
|
837
|
+
def driver_remove(self) -> bool:
|
|
838
|
+
"""Remove driver(s) from the given property
|
|
839
|
+
|
|
840
|
+
:return: Success of driver removal.
|
|
841
|
+
:rtype: bool
|
|
842
|
+
"""
|
|
573
843
|
...
|
|
574
844
|
|
|
575
845
|
def get(self):
|
|
576
|
-
"""
|
|
846
|
+
"""Returns the value of the custom property assigned to key or default
|
|
847
|
+
when not found (matches Python's dictionary function of the same name).
|
|
848
|
+
|
|
849
|
+
"""
|
|
577
850
|
...
|
|
578
851
|
|
|
579
852
|
def id_properties_clear(self):
|
|
580
|
-
"""
|
|
853
|
+
"""
|
|
854
|
+
|
|
855
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
856
|
+
"""
|
|
581
857
|
...
|
|
582
858
|
|
|
583
859
|
def id_properties_ensure(self):
|
|
584
|
-
"""
|
|
860
|
+
"""
|
|
861
|
+
|
|
862
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
863
|
+
"""
|
|
585
864
|
...
|
|
586
865
|
|
|
587
866
|
def id_properties_ui(self):
|
|
588
|
-
"""
|
|
589
|
-
...
|
|
867
|
+
"""
|
|
590
868
|
|
|
591
|
-
|
|
592
|
-
"""
|
|
869
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
870
|
+
"""
|
|
593
871
|
...
|
|
594
872
|
|
|
595
|
-
def
|
|
596
|
-
|
|
873
|
+
def is_extended(self): ...
|
|
874
|
+
def is_property_hidden(self) -> bool:
|
|
875
|
+
"""Check if a property is hidden.
|
|
876
|
+
|
|
877
|
+
:return: True when the property is hidden.
|
|
878
|
+
:rtype: bool
|
|
879
|
+
"""
|
|
597
880
|
...
|
|
598
881
|
|
|
599
|
-
def is_property_overridable_library(self):
|
|
600
|
-
"""
|
|
882
|
+
def is_property_overridable_library(self) -> bool:
|
|
883
|
+
"""Check if a property is overridable.
|
|
884
|
+
|
|
885
|
+
:return: True when the property is overridable.
|
|
886
|
+
:rtype: bool
|
|
887
|
+
"""
|
|
601
888
|
...
|
|
602
889
|
|
|
603
|
-
def is_property_readonly(self):
|
|
604
|
-
"""
|
|
890
|
+
def is_property_readonly(self) -> bool:
|
|
891
|
+
"""Check if a property is readonly.
|
|
892
|
+
|
|
893
|
+
:return: True when the property is readonly (not writable).
|
|
894
|
+
:rtype: bool
|
|
895
|
+
"""
|
|
605
896
|
...
|
|
606
897
|
|
|
607
|
-
def is_property_set(self):
|
|
608
|
-
"""
|
|
898
|
+
def is_property_set(self) -> bool:
|
|
899
|
+
"""Check if a property is set, use for testing operator properties.
|
|
900
|
+
|
|
901
|
+
:return: True when the property has been set.
|
|
902
|
+
:rtype: bool
|
|
903
|
+
"""
|
|
609
904
|
...
|
|
610
905
|
|
|
611
906
|
def items(self):
|
|
612
|
-
"""
|
|
907
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
908
|
+
dictionary function of the same name).
|
|
909
|
+
|
|
910
|
+
:return: custom property key, value pairs.
|
|
911
|
+
"""
|
|
613
912
|
...
|
|
614
913
|
|
|
615
|
-
def keyframe_delete(self):
|
|
616
|
-
"""
|
|
914
|
+
def keyframe_delete(self) -> bool:
|
|
915
|
+
"""Remove a keyframe from this properties fcurve.
|
|
916
|
+
|
|
917
|
+
:return: Success of keyframe deletion.
|
|
918
|
+
:rtype: bool
|
|
919
|
+
"""
|
|
617
920
|
...
|
|
618
921
|
|
|
619
|
-
def keyframe_insert(self):
|
|
620
|
-
"""
|
|
922
|
+
def keyframe_insert(self) -> bool:
|
|
923
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
924
|
+
|
|
925
|
+
:return: Success of keyframe insertion.
|
|
926
|
+
:rtype: bool
|
|
927
|
+
"""
|
|
621
928
|
...
|
|
622
929
|
|
|
623
930
|
def keys(self):
|
|
624
|
-
"""
|
|
931
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
932
|
+
dictionary function of the same name).
|
|
933
|
+
|
|
934
|
+
:return: custom property keys.
|
|
935
|
+
"""
|
|
625
936
|
...
|
|
626
937
|
|
|
627
|
-
def path_from_id(self):
|
|
628
|
-
"""
|
|
938
|
+
def path_from_id(self) -> str:
|
|
939
|
+
"""Returns the data path from the ID to this object (string).
|
|
940
|
+
|
|
941
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
942
|
+
to this struct and property (when given).
|
|
943
|
+
:rtype: str
|
|
944
|
+
"""
|
|
629
945
|
...
|
|
630
946
|
|
|
631
947
|
def path_menu(
|
|
632
948
|
self,
|
|
633
|
-
searchpaths,
|
|
634
|
-
operator,
|
|
635
|
-
props_default,
|
|
636
|
-
prop_filepath,
|
|
637
|
-
filter_ext,
|
|
638
|
-
filter_path,
|
|
639
|
-
display_name,
|
|
640
|
-
add_operator,
|
|
641
|
-
add_operator_props,
|
|
949
|
+
searchpaths: list[str],
|
|
950
|
+
operator: str,
|
|
951
|
+
props_default: dict = None,
|
|
952
|
+
prop_filepath: str = "filepath",
|
|
953
|
+
filter_ext: typing.Callable = None,
|
|
954
|
+
filter_path=None,
|
|
955
|
+
display_name: typing.Callable = None,
|
|
956
|
+
add_operator=None,
|
|
957
|
+
add_operator_props=None,
|
|
642
958
|
):
|
|
643
|
-
"""
|
|
959
|
+
"""Populate a menu from a list of paths.
|
|
960
|
+
|
|
961
|
+
:param searchpaths: Paths to scan.
|
|
962
|
+
:type searchpaths: list[str]
|
|
963
|
+
:param operator: The operator id to use with each file.
|
|
964
|
+
:type operator: str
|
|
965
|
+
:param props_default: Properties to assign to each operator.
|
|
966
|
+
:type props_default: dict
|
|
967
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
968
|
+
:type prop_filepath: str
|
|
969
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
644
970
|
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
:param add_operator:
|
|
653
|
-
:param add_operator_props:
|
|
971
|
+
Returning false excludes the file from the list.
|
|
972
|
+
:type filter_ext: typing.Callable
|
|
973
|
+
:param filter_path:
|
|
974
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
975
|
+
:type display_name: typing.Callable
|
|
976
|
+
:param add_operator:
|
|
977
|
+
:param add_operator_props:
|
|
654
978
|
"""
|
|
655
979
|
...
|
|
656
980
|
|
|
657
981
|
def path_resolve(self):
|
|
658
|
-
""" """
|
|
982
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
659
983
|
...
|
|
660
984
|
|
|
661
985
|
def pop(self):
|
|
662
|
-
"""
|
|
986
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
987
|
+
when not found (matches Python's dictionary function of the same name).
|
|
988
|
+
|
|
989
|
+
"""
|
|
663
990
|
...
|
|
664
991
|
|
|
665
992
|
def prepend(self, draw_func):
|
|
666
|
-
"""
|
|
993
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
994
|
+
the menus draw function
|
|
667
995
|
|
|
668
|
-
|
|
996
|
+
:param draw_func:
|
|
669
997
|
"""
|
|
670
998
|
...
|
|
671
999
|
|
|
672
|
-
def property_overridable_library_set(self):
|
|
673
|
-
"""
|
|
1000
|
+
def property_overridable_library_set(self) -> bool:
|
|
1001
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1002
|
+
|
|
1003
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1004
|
+
:rtype: bool
|
|
1005
|
+
"""
|
|
674
1006
|
...
|
|
675
1007
|
|
|
676
1008
|
def property_unset(self):
|
|
677
|
-
""" """
|
|
1009
|
+
"""Unset a property, will use default value afterward."""
|
|
678
1010
|
...
|
|
679
1011
|
|
|
680
1012
|
def remove(self, draw_func):
|
|
681
|
-
"""
|
|
1013
|
+
"""Remove a draw function that has been added to this menu
|
|
682
1014
|
|
|
683
1015
|
:param draw_func:
|
|
684
1016
|
"""
|
|
685
1017
|
...
|
|
686
1018
|
|
|
687
1019
|
def type_recast(self):
|
|
688
|
-
"""
|
|
1020
|
+
"""Return a new instance, this is needed because types
|
|
1021
|
+
such as textures can be changed at runtime.
|
|
1022
|
+
|
|
1023
|
+
:return: a new instance of this object with the type initialized again.
|
|
1024
|
+
"""
|
|
689
1025
|
...
|
|
690
1026
|
|
|
691
1027
|
def values(self):
|
|
692
|
-
"""
|
|
1028
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1029
|
+
dictionary function of the same name).
|
|
1030
|
+
|
|
1031
|
+
:return: custom property values.
|
|
1032
|
+
"""
|
|
693
1033
|
...
|
|
694
1034
|
|
|
695
1035
|
class INFO_MT_info(bpy_types.Menu, bpy_types._GenericUI):
|
|
696
|
-
""" """
|
|
697
|
-
|
|
698
1036
|
bl_label: typing.Any
|
|
699
|
-
""" """
|
|
700
|
-
|
|
701
1037
|
bl_rna: typing.Any
|
|
702
|
-
""" """
|
|
703
|
-
|
|
704
1038
|
id_data: typing.Any
|
|
705
|
-
""" """
|
|
706
1039
|
|
|
707
1040
|
def append(self, draw_func):
|
|
708
|
-
"""
|
|
1041
|
+
"""Append a draw function to this menu,
|
|
1042
|
+
takes the same arguments as the menus draw function
|
|
709
1043
|
|
|
710
|
-
|
|
1044
|
+
:param draw_func:
|
|
711
1045
|
"""
|
|
712
1046
|
...
|
|
713
1047
|
|
|
714
|
-
def as_pointer(self):
|
|
715
|
-
"""
|
|
1048
|
+
def as_pointer(self) -> int:
|
|
1049
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1050
|
+
|
|
1051
|
+
:return: int (memory address).
|
|
1052
|
+
:rtype: int
|
|
1053
|
+
"""
|
|
716
1054
|
...
|
|
717
1055
|
|
|
718
|
-
def bl_rna_get_subclass(self):
|
|
719
|
-
"""
|
|
1056
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1057
|
+
"""
|
|
1058
|
+
|
|
1059
|
+
:return: The RNA type or default when not found.
|
|
1060
|
+
:rtype: bpy.types.Struct
|
|
1061
|
+
"""
|
|
720
1062
|
...
|
|
721
1063
|
|
|
722
|
-
def bl_rna_get_subclass_py(self):
|
|
723
|
-
"""
|
|
1064
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1065
|
+
"""
|
|
1066
|
+
|
|
1067
|
+
:return: The class or default when not found.
|
|
1068
|
+
:rtype: typing.Any
|
|
1069
|
+
"""
|
|
724
1070
|
...
|
|
725
1071
|
|
|
726
1072
|
def draw(self, _context):
|
|
@@ -739,169 +1085,258 @@ class INFO_MT_info(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
739
1085
|
...
|
|
740
1086
|
|
|
741
1087
|
def draw_preset(self, _context):
|
|
742
|
-
"""
|
|
1088
|
+
"""Define these on the subclass:
|
|
1089
|
+
- preset_operator (string)
|
|
1090
|
+
- preset_subdir (string)Optionally:
|
|
1091
|
+
- preset_add_operator (string)
|
|
1092
|
+
- preset_extensions (set of strings)
|
|
1093
|
+
- preset_operator_defaults (dict of keyword args)
|
|
743
1094
|
|
|
744
|
-
|
|
1095
|
+
:param _context:
|
|
745
1096
|
"""
|
|
746
1097
|
...
|
|
747
1098
|
|
|
748
|
-
def driver_add(self):
|
|
749
|
-
"""
|
|
1099
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1100
|
+
"""Adds driver(s) to the given property
|
|
1101
|
+
|
|
1102
|
+
:return: The driver(s) added.
|
|
1103
|
+
:rtype: bpy.types.FCurve
|
|
1104
|
+
"""
|
|
750
1105
|
...
|
|
751
1106
|
|
|
752
|
-
def driver_remove(self):
|
|
753
|
-
"""
|
|
1107
|
+
def driver_remove(self) -> bool:
|
|
1108
|
+
"""Remove driver(s) from the given property
|
|
1109
|
+
|
|
1110
|
+
:return: Success of driver removal.
|
|
1111
|
+
:rtype: bool
|
|
1112
|
+
"""
|
|
754
1113
|
...
|
|
755
1114
|
|
|
756
1115
|
def get(self):
|
|
757
|
-
"""
|
|
1116
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1117
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1118
|
+
|
|
1119
|
+
"""
|
|
758
1120
|
...
|
|
759
1121
|
|
|
760
1122
|
def id_properties_clear(self):
|
|
761
|
-
"""
|
|
1123
|
+
"""
|
|
1124
|
+
|
|
1125
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1126
|
+
"""
|
|
762
1127
|
...
|
|
763
1128
|
|
|
764
1129
|
def id_properties_ensure(self):
|
|
765
|
-
"""
|
|
1130
|
+
"""
|
|
1131
|
+
|
|
1132
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1133
|
+
"""
|
|
766
1134
|
...
|
|
767
1135
|
|
|
768
1136
|
def id_properties_ui(self):
|
|
769
|
-
"""
|
|
770
|
-
...
|
|
1137
|
+
"""
|
|
771
1138
|
|
|
772
|
-
|
|
773
|
-
"""
|
|
1139
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1140
|
+
"""
|
|
774
1141
|
...
|
|
775
1142
|
|
|
776
|
-
def
|
|
777
|
-
|
|
1143
|
+
def is_extended(self): ...
|
|
1144
|
+
def is_property_hidden(self) -> bool:
|
|
1145
|
+
"""Check if a property is hidden.
|
|
1146
|
+
|
|
1147
|
+
:return: True when the property is hidden.
|
|
1148
|
+
:rtype: bool
|
|
1149
|
+
"""
|
|
778
1150
|
...
|
|
779
1151
|
|
|
780
|
-
def is_property_overridable_library(self):
|
|
781
|
-
"""
|
|
1152
|
+
def is_property_overridable_library(self) -> bool:
|
|
1153
|
+
"""Check if a property is overridable.
|
|
1154
|
+
|
|
1155
|
+
:return: True when the property is overridable.
|
|
1156
|
+
:rtype: bool
|
|
1157
|
+
"""
|
|
782
1158
|
...
|
|
783
1159
|
|
|
784
|
-
def is_property_readonly(self):
|
|
785
|
-
"""
|
|
1160
|
+
def is_property_readonly(self) -> bool:
|
|
1161
|
+
"""Check if a property is readonly.
|
|
1162
|
+
|
|
1163
|
+
:return: True when the property is readonly (not writable).
|
|
1164
|
+
:rtype: bool
|
|
1165
|
+
"""
|
|
786
1166
|
...
|
|
787
1167
|
|
|
788
|
-
def is_property_set(self):
|
|
789
|
-
"""
|
|
1168
|
+
def is_property_set(self) -> bool:
|
|
1169
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1170
|
+
|
|
1171
|
+
:return: True when the property has been set.
|
|
1172
|
+
:rtype: bool
|
|
1173
|
+
"""
|
|
790
1174
|
...
|
|
791
1175
|
|
|
792
1176
|
def items(self):
|
|
793
|
-
"""
|
|
1177
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1178
|
+
dictionary function of the same name).
|
|
1179
|
+
|
|
1180
|
+
:return: custom property key, value pairs.
|
|
1181
|
+
"""
|
|
794
1182
|
...
|
|
795
1183
|
|
|
796
|
-
def keyframe_delete(self):
|
|
797
|
-
"""
|
|
1184
|
+
def keyframe_delete(self) -> bool:
|
|
1185
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1186
|
+
|
|
1187
|
+
:return: Success of keyframe deletion.
|
|
1188
|
+
:rtype: bool
|
|
1189
|
+
"""
|
|
798
1190
|
...
|
|
799
1191
|
|
|
800
|
-
def keyframe_insert(self):
|
|
801
|
-
"""
|
|
1192
|
+
def keyframe_insert(self) -> bool:
|
|
1193
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1194
|
+
|
|
1195
|
+
:return: Success of keyframe insertion.
|
|
1196
|
+
:rtype: bool
|
|
1197
|
+
"""
|
|
802
1198
|
...
|
|
803
1199
|
|
|
804
1200
|
def keys(self):
|
|
805
|
-
"""
|
|
1201
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1202
|
+
dictionary function of the same name).
|
|
1203
|
+
|
|
1204
|
+
:return: custom property keys.
|
|
1205
|
+
"""
|
|
806
1206
|
...
|
|
807
1207
|
|
|
808
|
-
def path_from_id(self):
|
|
809
|
-
"""
|
|
1208
|
+
def path_from_id(self) -> str:
|
|
1209
|
+
"""Returns the data path from the ID to this object (string).
|
|
1210
|
+
|
|
1211
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1212
|
+
to this struct and property (when given).
|
|
1213
|
+
:rtype: str
|
|
1214
|
+
"""
|
|
810
1215
|
...
|
|
811
1216
|
|
|
812
1217
|
def path_menu(
|
|
813
1218
|
self,
|
|
814
|
-
searchpaths,
|
|
815
|
-
operator,
|
|
816
|
-
props_default,
|
|
817
|
-
prop_filepath,
|
|
818
|
-
filter_ext,
|
|
819
|
-
filter_path,
|
|
820
|
-
display_name,
|
|
821
|
-
add_operator,
|
|
822
|
-
add_operator_props,
|
|
1219
|
+
searchpaths: list[str],
|
|
1220
|
+
operator: str,
|
|
1221
|
+
props_default: dict = None,
|
|
1222
|
+
prop_filepath: str = "filepath",
|
|
1223
|
+
filter_ext: typing.Callable = None,
|
|
1224
|
+
filter_path=None,
|
|
1225
|
+
display_name: typing.Callable = None,
|
|
1226
|
+
add_operator=None,
|
|
1227
|
+
add_operator_props=None,
|
|
823
1228
|
):
|
|
824
|
-
"""
|
|
1229
|
+
"""Populate a menu from a list of paths.
|
|
825
1230
|
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
1231
|
+
:param searchpaths: Paths to scan.
|
|
1232
|
+
:type searchpaths: list[str]
|
|
1233
|
+
:param operator: The operator id to use with each file.
|
|
1234
|
+
:type operator: str
|
|
1235
|
+
:param props_default: Properties to assign to each operator.
|
|
1236
|
+
:type props_default: dict
|
|
1237
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1238
|
+
:type prop_filepath: str
|
|
1239
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1240
|
+
|
|
1241
|
+
Returning false excludes the file from the list.
|
|
1242
|
+
:type filter_ext: typing.Callable
|
|
1243
|
+
:param filter_path:
|
|
1244
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1245
|
+
:type display_name: typing.Callable
|
|
1246
|
+
:param add_operator:
|
|
1247
|
+
:param add_operator_props:
|
|
835
1248
|
"""
|
|
836
1249
|
...
|
|
837
1250
|
|
|
838
1251
|
def path_resolve(self):
|
|
839
|
-
""" """
|
|
1252
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
840
1253
|
...
|
|
841
1254
|
|
|
842
1255
|
def pop(self):
|
|
843
|
-
"""
|
|
1256
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1257
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1258
|
+
|
|
1259
|
+
"""
|
|
844
1260
|
...
|
|
845
1261
|
|
|
846
1262
|
def prepend(self, draw_func):
|
|
847
|
-
"""
|
|
1263
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1264
|
+
the menus draw function
|
|
848
1265
|
|
|
849
|
-
|
|
1266
|
+
:param draw_func:
|
|
850
1267
|
"""
|
|
851
1268
|
...
|
|
852
1269
|
|
|
853
|
-
def property_overridable_library_set(self):
|
|
854
|
-
"""
|
|
1270
|
+
def property_overridable_library_set(self) -> bool:
|
|
1271
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1272
|
+
|
|
1273
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1274
|
+
:rtype: bool
|
|
1275
|
+
"""
|
|
855
1276
|
...
|
|
856
1277
|
|
|
857
1278
|
def property_unset(self):
|
|
858
|
-
""" """
|
|
1279
|
+
"""Unset a property, will use default value afterward."""
|
|
859
1280
|
...
|
|
860
1281
|
|
|
861
1282
|
def remove(self, draw_func):
|
|
862
|
-
"""
|
|
1283
|
+
"""Remove a draw function that has been added to this menu
|
|
863
1284
|
|
|
864
1285
|
:param draw_func:
|
|
865
1286
|
"""
|
|
866
1287
|
...
|
|
867
1288
|
|
|
868
1289
|
def type_recast(self):
|
|
869
|
-
"""
|
|
1290
|
+
"""Return a new instance, this is needed because types
|
|
1291
|
+
such as textures can be changed at runtime.
|
|
1292
|
+
|
|
1293
|
+
:return: a new instance of this object with the type initialized again.
|
|
1294
|
+
"""
|
|
870
1295
|
...
|
|
871
1296
|
|
|
872
1297
|
def values(self):
|
|
873
|
-
"""
|
|
1298
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1299
|
+
dictionary function of the same name).
|
|
1300
|
+
|
|
1301
|
+
:return: custom property values.
|
|
1302
|
+
"""
|
|
874
1303
|
...
|
|
875
1304
|
|
|
876
1305
|
class INFO_MT_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
877
|
-
""" """
|
|
878
|
-
|
|
879
1306
|
bl_label: typing.Any
|
|
880
|
-
""" """
|
|
881
|
-
|
|
882
1307
|
bl_rna: typing.Any
|
|
883
|
-
""" """
|
|
884
|
-
|
|
885
1308
|
id_data: typing.Any
|
|
886
|
-
""" """
|
|
887
1309
|
|
|
888
1310
|
def append(self, draw_func):
|
|
889
|
-
"""
|
|
1311
|
+
"""Append a draw function to this menu,
|
|
1312
|
+
takes the same arguments as the menus draw function
|
|
890
1313
|
|
|
891
|
-
|
|
1314
|
+
:param draw_func:
|
|
892
1315
|
"""
|
|
893
1316
|
...
|
|
894
1317
|
|
|
895
|
-
def as_pointer(self):
|
|
896
|
-
"""
|
|
1318
|
+
def as_pointer(self) -> int:
|
|
1319
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1320
|
+
|
|
1321
|
+
:return: int (memory address).
|
|
1322
|
+
:rtype: int
|
|
1323
|
+
"""
|
|
897
1324
|
...
|
|
898
1325
|
|
|
899
|
-
def bl_rna_get_subclass(self):
|
|
900
|
-
"""
|
|
1326
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1327
|
+
"""
|
|
1328
|
+
|
|
1329
|
+
:return: The RNA type or default when not found.
|
|
1330
|
+
:rtype: bpy.types.Struct
|
|
1331
|
+
"""
|
|
901
1332
|
...
|
|
902
1333
|
|
|
903
|
-
def bl_rna_get_subclass_py(self):
|
|
904
|
-
"""
|
|
1334
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1335
|
+
"""
|
|
1336
|
+
|
|
1337
|
+
:return: The class or default when not found.
|
|
1338
|
+
:rtype: typing.Any
|
|
1339
|
+
"""
|
|
905
1340
|
...
|
|
906
1341
|
|
|
907
1342
|
def draw(self, _context):
|
|
@@ -920,136 +1355,219 @@ class INFO_MT_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
920
1355
|
...
|
|
921
1356
|
|
|
922
1357
|
def draw_preset(self, _context):
|
|
923
|
-
"""
|
|
1358
|
+
"""Define these on the subclass:
|
|
1359
|
+
- preset_operator (string)
|
|
1360
|
+
- preset_subdir (string)Optionally:
|
|
1361
|
+
- preset_add_operator (string)
|
|
1362
|
+
- preset_extensions (set of strings)
|
|
1363
|
+
- preset_operator_defaults (dict of keyword args)
|
|
924
1364
|
|
|
925
|
-
|
|
1365
|
+
:param _context:
|
|
926
1366
|
"""
|
|
927
1367
|
...
|
|
928
1368
|
|
|
929
|
-
def driver_add(self):
|
|
930
|
-
"""
|
|
1369
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1370
|
+
"""Adds driver(s) to the given property
|
|
1371
|
+
|
|
1372
|
+
:return: The driver(s) added.
|
|
1373
|
+
:rtype: bpy.types.FCurve
|
|
1374
|
+
"""
|
|
931
1375
|
...
|
|
932
1376
|
|
|
933
|
-
def driver_remove(self):
|
|
934
|
-
"""
|
|
1377
|
+
def driver_remove(self) -> bool:
|
|
1378
|
+
"""Remove driver(s) from the given property
|
|
1379
|
+
|
|
1380
|
+
:return: Success of driver removal.
|
|
1381
|
+
:rtype: bool
|
|
1382
|
+
"""
|
|
935
1383
|
...
|
|
936
1384
|
|
|
937
1385
|
def get(self):
|
|
938
|
-
"""
|
|
1386
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1387
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1388
|
+
|
|
1389
|
+
"""
|
|
939
1390
|
...
|
|
940
1391
|
|
|
941
1392
|
def id_properties_clear(self):
|
|
942
|
-
"""
|
|
1393
|
+
"""
|
|
1394
|
+
|
|
1395
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1396
|
+
"""
|
|
943
1397
|
...
|
|
944
1398
|
|
|
945
1399
|
def id_properties_ensure(self):
|
|
946
|
-
"""
|
|
1400
|
+
"""
|
|
1401
|
+
|
|
1402
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1403
|
+
"""
|
|
947
1404
|
...
|
|
948
1405
|
|
|
949
1406
|
def id_properties_ui(self):
|
|
950
|
-
"""
|
|
951
|
-
...
|
|
1407
|
+
"""
|
|
952
1408
|
|
|
953
|
-
|
|
954
|
-
"""
|
|
1409
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1410
|
+
"""
|
|
955
1411
|
...
|
|
956
1412
|
|
|
957
|
-
def
|
|
958
|
-
|
|
1413
|
+
def is_extended(self): ...
|
|
1414
|
+
def is_property_hidden(self) -> bool:
|
|
1415
|
+
"""Check if a property is hidden.
|
|
1416
|
+
|
|
1417
|
+
:return: True when the property is hidden.
|
|
1418
|
+
:rtype: bool
|
|
1419
|
+
"""
|
|
959
1420
|
...
|
|
960
1421
|
|
|
961
|
-
def is_property_overridable_library(self):
|
|
962
|
-
"""
|
|
1422
|
+
def is_property_overridable_library(self) -> bool:
|
|
1423
|
+
"""Check if a property is overridable.
|
|
1424
|
+
|
|
1425
|
+
:return: True when the property is overridable.
|
|
1426
|
+
:rtype: bool
|
|
1427
|
+
"""
|
|
963
1428
|
...
|
|
964
1429
|
|
|
965
|
-
def is_property_readonly(self):
|
|
966
|
-
"""
|
|
1430
|
+
def is_property_readonly(self) -> bool:
|
|
1431
|
+
"""Check if a property is readonly.
|
|
1432
|
+
|
|
1433
|
+
:return: True when the property is readonly (not writable).
|
|
1434
|
+
:rtype: bool
|
|
1435
|
+
"""
|
|
967
1436
|
...
|
|
968
1437
|
|
|
969
|
-
def is_property_set(self):
|
|
970
|
-
"""
|
|
1438
|
+
def is_property_set(self) -> bool:
|
|
1439
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1440
|
+
|
|
1441
|
+
:return: True when the property has been set.
|
|
1442
|
+
:rtype: bool
|
|
1443
|
+
"""
|
|
971
1444
|
...
|
|
972
1445
|
|
|
973
1446
|
def items(self):
|
|
974
|
-
"""
|
|
1447
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1448
|
+
dictionary function of the same name).
|
|
1449
|
+
|
|
1450
|
+
:return: custom property key, value pairs.
|
|
1451
|
+
"""
|
|
975
1452
|
...
|
|
976
1453
|
|
|
977
|
-
def keyframe_delete(self):
|
|
978
|
-
"""
|
|
1454
|
+
def keyframe_delete(self) -> bool:
|
|
1455
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1456
|
+
|
|
1457
|
+
:return: Success of keyframe deletion.
|
|
1458
|
+
:rtype: bool
|
|
1459
|
+
"""
|
|
979
1460
|
...
|
|
980
1461
|
|
|
981
|
-
def keyframe_insert(self):
|
|
982
|
-
"""
|
|
1462
|
+
def keyframe_insert(self) -> bool:
|
|
1463
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1464
|
+
|
|
1465
|
+
:return: Success of keyframe insertion.
|
|
1466
|
+
:rtype: bool
|
|
1467
|
+
"""
|
|
983
1468
|
...
|
|
984
1469
|
|
|
985
1470
|
def keys(self):
|
|
986
|
-
"""
|
|
1471
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1472
|
+
dictionary function of the same name).
|
|
1473
|
+
|
|
1474
|
+
:return: custom property keys.
|
|
1475
|
+
"""
|
|
987
1476
|
...
|
|
988
1477
|
|
|
989
|
-
def path_from_id(self):
|
|
990
|
-
"""
|
|
1478
|
+
def path_from_id(self) -> str:
|
|
1479
|
+
"""Returns the data path from the ID to this object (string).
|
|
1480
|
+
|
|
1481
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1482
|
+
to this struct and property (when given).
|
|
1483
|
+
:rtype: str
|
|
1484
|
+
"""
|
|
991
1485
|
...
|
|
992
1486
|
|
|
993
1487
|
def path_menu(
|
|
994
1488
|
self,
|
|
995
|
-
searchpaths,
|
|
996
|
-
operator,
|
|
997
|
-
props_default,
|
|
998
|
-
prop_filepath,
|
|
999
|
-
filter_ext,
|
|
1000
|
-
filter_path,
|
|
1001
|
-
display_name,
|
|
1002
|
-
add_operator,
|
|
1003
|
-
add_operator_props,
|
|
1489
|
+
searchpaths: list[str],
|
|
1490
|
+
operator: str,
|
|
1491
|
+
props_default: dict = None,
|
|
1492
|
+
prop_filepath: str = "filepath",
|
|
1493
|
+
filter_ext: typing.Callable = None,
|
|
1494
|
+
filter_path=None,
|
|
1495
|
+
display_name: typing.Callable = None,
|
|
1496
|
+
add_operator=None,
|
|
1497
|
+
add_operator_props=None,
|
|
1004
1498
|
):
|
|
1005
|
-
"""
|
|
1499
|
+
"""Populate a menu from a list of paths.
|
|
1500
|
+
|
|
1501
|
+
:param searchpaths: Paths to scan.
|
|
1502
|
+
:type searchpaths: list[str]
|
|
1503
|
+
:param operator: The operator id to use with each file.
|
|
1504
|
+
:type operator: str
|
|
1505
|
+
:param props_default: Properties to assign to each operator.
|
|
1506
|
+
:type props_default: dict
|
|
1507
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1508
|
+
:type prop_filepath: str
|
|
1509
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1006
1510
|
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
:param add_operator:
|
|
1015
|
-
:param add_operator_props:
|
|
1511
|
+
Returning false excludes the file from the list.
|
|
1512
|
+
:type filter_ext: typing.Callable
|
|
1513
|
+
:param filter_path:
|
|
1514
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1515
|
+
:type display_name: typing.Callable
|
|
1516
|
+
:param add_operator:
|
|
1517
|
+
:param add_operator_props:
|
|
1016
1518
|
"""
|
|
1017
1519
|
...
|
|
1018
1520
|
|
|
1019
1521
|
def path_resolve(self):
|
|
1020
|
-
""" """
|
|
1522
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1021
1523
|
...
|
|
1022
1524
|
|
|
1023
1525
|
def pop(self):
|
|
1024
|
-
"""
|
|
1526
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1527
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1528
|
+
|
|
1529
|
+
"""
|
|
1025
1530
|
...
|
|
1026
1531
|
|
|
1027
1532
|
def prepend(self, draw_func):
|
|
1028
|
-
"""
|
|
1533
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1534
|
+
the menus draw function
|
|
1029
1535
|
|
|
1030
|
-
|
|
1536
|
+
:param draw_func:
|
|
1031
1537
|
"""
|
|
1032
1538
|
...
|
|
1033
1539
|
|
|
1034
|
-
def property_overridable_library_set(self):
|
|
1035
|
-
"""
|
|
1540
|
+
def property_overridable_library_set(self) -> bool:
|
|
1541
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1542
|
+
|
|
1543
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1544
|
+
:rtype: bool
|
|
1545
|
+
"""
|
|
1036
1546
|
...
|
|
1037
1547
|
|
|
1038
1548
|
def property_unset(self):
|
|
1039
|
-
""" """
|
|
1549
|
+
"""Unset a property, will use default value afterward."""
|
|
1040
1550
|
...
|
|
1041
1551
|
|
|
1042
1552
|
def remove(self, draw_func):
|
|
1043
|
-
"""
|
|
1553
|
+
"""Remove a draw function that has been added to this menu
|
|
1044
1554
|
|
|
1045
1555
|
:param draw_func:
|
|
1046
1556
|
"""
|
|
1047
1557
|
...
|
|
1048
1558
|
|
|
1049
1559
|
def type_recast(self):
|
|
1050
|
-
"""
|
|
1560
|
+
"""Return a new instance, this is needed because types
|
|
1561
|
+
such as textures can be changed at runtime.
|
|
1562
|
+
|
|
1563
|
+
:return: a new instance of this object with the type initialized again.
|
|
1564
|
+
"""
|
|
1051
1565
|
...
|
|
1052
1566
|
|
|
1053
1567
|
def values(self):
|
|
1054
|
-
"""
|
|
1568
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1569
|
+
dictionary function of the same name).
|
|
1570
|
+
|
|
1571
|
+
:return: custom property values.
|
|
1572
|
+
"""
|
|
1055
1573
|
...
|