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