fake-bpy-module 20240516__py3-none-any.whl → 20240517__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 +2 -2
- addon_utils/__init__.pyi +43 -12
- animsys_refactor/__init__.pyi +4 -4
- aud/__init__.pyi +7 -7
- bgl/__init__.pyi +121 -183
- bl_app_override/__init__.pyi +5 -5
- bl_app_override/helpers/__init__.pyi +3 -1
- bl_app_template_utils/__init__.pyi +5 -5
- 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 +5 -5
- bl_i18n_utils/settings/__init__.pyi +4 -2
- bl_i18n_utils/utils/__init__.pyi +86 -58
- bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
- bl_keymap_utils/io/__init__.pyi +4 -4
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
- bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
- bl_operators/add_mesh_torus/__init__.pyi +126 -41
- bl_operators/anim/__init__.pyi +1001 -328
- bl_operators/assets/__init__.pyi +376 -123
- bl_operators/bmesh/find_adjacent/__init__.pyi +3 -3
- bl_operators/clip/__init__.pyi +1250 -409
- bl_operators/console/__init__.pyi +626 -205
- bl_operators/constraint/__init__.pyi +502 -165
- bl_operators/file/__init__.pyi +376 -123
- bl_operators/freestyle/__init__.pyi +501 -164
- bl_operators/geometry_nodes/__init__.pyi +501 -164
- bl_operators/image/__init__.pyi +621 -200
- bl_operators/mesh/__init__.pyi +376 -123
- bl_operators/node/__init__.pyi +1243 -402
- bl_operators/object/__init__.pyi +1876 -615
- bl_operators/object_align/__init__.pyi +126 -41
- bl_operators/object_quick_effects/__init__.pyi +502 -165
- bl_operators/object_randomize_transform/__init__.pyi +126 -41
- bl_operators/presets/__init__.pyi +3069 -1027
- bl_operators/rigidbody/__init__.pyi +376 -123
- bl_operators/screen_play_rendered_anim/__init__.pyi +126 -41
- bl_operators/sequencer/__init__.pyi +1009 -331
- bl_operators/spreadsheet/__init__.pyi +126 -41
- bl_operators/userpref/__init__.pyi +3263 -1078
- bl_operators/uvcalc_follow_active/__init__.pyi +126 -41
- bl_operators/uvcalc_lightmap/__init__.pyi +137 -47
- bl_operators/uvcalc_transform/__init__.pyi +289 -90
- bl_operators/vertexpaint_dirt/__init__.pyi +126 -41
- bl_operators/view3d/__init__.pyi +868 -279
- bl_operators/wm/__init__.pyi +5777 -1934
- bl_operators/world/__init__.pyi +126 -41
- bl_previews_utils/bl_previews_render/__init__.pyi +1 -1
- bl_rna_utils/data_path/__init__.pyi +8 -3
- bl_ui/__init__.pyi +338 -131
- bl_ui/anim/__init__.pyi +164 -64
- bl_ui/asset_shelf/__init__.pyi +129 -42
- bl_ui/generic_ui_list/__init__.pyi +412 -135
- bl_ui/node_add_menu/__init__.pyi +168 -68
- bl_ui/node_add_menu_compositor/__init__.pyi +2921 -1138
- bl_ui/node_add_menu_geometry/__init__.pyi +7785 -3032
- bl_ui/node_add_menu_shader/__init__.pyi +1621 -630
- bl_ui/node_add_menu_texture/__init__.pyi +1459 -567
- bl_ui/properties_animviz/__init__.pyi +2 -2
- bl_ui/properties_collection/__init__.pyi +806 -274
- bl_ui/properties_constraint/__init__.pyi +10253 -3458
- bl_ui/properties_data_armature/__init__.pyi +1615 -552
- bl_ui/properties_data_bone/__init__.pyi +1288 -425
- bl_ui/properties_data_camera/__init__.pyi +1854 -631
- bl_ui/properties_data_curve/__init__.pyi +1929 -636
- bl_ui/properties_data_curves/__init__.pyi +806 -274
- bl_ui/properties_data_empty/__init__.pyi +257 -84
- bl_ui/properties_data_gpencil/__init__.pyi +2380 -803
- bl_ui/properties_data_grease_pencil/__init__.pyi +1902 -656
- bl_ui/properties_data_lattice/__init__.pyi +388 -127
- bl_ui/properties_data_light/__init__.pyi +1541 -506
- bl_ui/properties_data_lightprobe/__init__.pyi +1667 -548
- bl_ui/properties_data_mesh/__init__.pyi +2704 -929
- bl_ui/properties_data_metaball/__init__.pyi +644 -211
- bl_ui/properties_data_modifier/__init__.pyi +1353 -502
- bl_ui/properties_data_pointcloud/__init__.pyi +679 -233
- bl_ui/properties_data_shaderfx/__init__.pyi +129 -42
- bl_ui/properties_data_speaker/__init__.pyi +644 -211
- bl_ui/properties_data_volume/__init__.pyi +1030 -339
- bl_ui/properties_freestyle/__init__.pyi +3113 -1035
- bl_ui/properties_grease_pencil_common/__init__.pyi +2464 -933
- bl_ui/properties_mask_common/__init__.pyi +1101 -420
- bl_ui/properties_material/__init__.pyi +2091 -699
- bl_ui/properties_material_gpencil/__init__.pyi +1350 -466
- bl_ui/properties_object/__init__.pyi +1838 -618
- bl_ui/properties_output/__init__.pyi +2414 -831
- bl_ui/properties_paint_common/__init__.pyi +412 -289
- bl_ui/properties_particle/__init__.pyi +6737 -2241
- bl_ui/properties_physics_cloth/__init__.pyi +1825 -612
- bl_ui/properties_physics_common/__init__.pyi +129 -42
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +2821 -928
- bl_ui/properties_physics_field/__init__.pyi +1283 -422
- bl_ui/properties_physics_fluid/__init__.pyi +3620 -1203
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -42
- bl_ui/properties_physics_rigidbody/__init__.pyi +1027 -338
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1667 -548
- bl_ui/properties_physics_softbody/__init__.pyi +1924 -633
- bl_ui/properties_render/__init__.pyi +6830 -2263
- bl_ui/properties_scene/__init__.pyi +1929 -636
- bl_ui/properties_texture/__init__.pyi +3370 -1118
- bl_ui/properties_view_layer/__init__.pyi +2346 -782
- bl_ui/properties_workspace/__init__.pyi +516 -169
- bl_ui/properties_world/__init__.pyi +1284 -421
- bl_ui/space_clip/__init__.pyi +10134 -3639
- bl_ui/space_console/__init__.pyi +939 -357
- bl_ui/space_dopesheet/__init__.pyi +4327 -1562
- bl_ui/space_filebrowser/__init__.pyi +4164 -1499
- bl_ui/space_graph/__init__.pyi +3108 -1179
- bl_ui/space_image/__init__.pyi +9766 -3596
- bl_ui/space_info/__init__.pyi +939 -357
- bl_ui/space_nla/__init__.pyi +2620 -988
- bl_ui/space_node/__init__.pyi +3994 -1434
- bl_ui/space_outliner/__init__.pyi +2203 -842
- bl_ui/space_properties/__init__.pyi +386 -127
- bl_ui/space_sequencer/__init__.pyi +10773 -3878
- bl_ui/space_spreadsheet/__init__.pyi +130 -43
- bl_ui/space_statusbar/__init__.pyi +129 -42
- bl_ui/space_text/__init__.pyi +2458 -925
- bl_ui/space_time/__init__.pyi +1033 -378
- bl_ui/space_toolsystem_common/__init__.pyi +20 -16
- bl_ui/space_toolsystem_toolbar/__init__.pyi +37 -21
- bl_ui/space_topbar/__init__.pyi +3980 -1496
- bl_ui/space_userpref/__init__.pyi +11373 -3797
- bl_ui/space_view3d/__init__.pyi +40865 -15356
- bl_ui/space_view3d_toolbar/__init__.pyi +12520 -4647
- bl_ui/temp_anim_layers/__init__.pyi +129 -42
- bl_ui/utils/__init__.pyi +28 -20
- bl_ui_utils/bug_report_url/__init__.pyi +1 -1
- bl_ui_utils/layout/__init__.pyi +1 -1
- blend_render_info/__init__.pyi +1 -1
- blf/__init__.pyi +4 -4
- bmesh/geometry/__init__.pyi +2 -3
- bmesh/ops/__init__.pyi +372 -419
- bmesh/types/__init__.pyi +38 -38
- 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 +2680 -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 +17056 -21951
- bpy/utils/__init__.pyi +242 -118
- bpy/utils/previews/__init__.pyi +58 -28
- bpy/utils/units/__init__.pyi +20 -20
- bpy_extras/anim_utils/__init__.pyi +68 -28
- bpy_extras/bmesh_utils/__init__.pyi +8 -2
- bpy_extras/extensions/junction_module/__init__.pyi +5 -2
- bpy_extras/id_map_utils/__init__.pyi +3 -3
- bpy_extras/image_utils/__init__.pyi +44 -11
- bpy_extras/io_utils/__init__.pyi +113 -18
- bpy_extras/keyconfig_utils/__init__.pyi +2 -2
- bpy_extras/mesh_utils/__init__.pyi +71 -19
- bpy_extras/node_shader_utils/__init__.pyi +9 -4
- bpy_extras/node_utils/__init__.pyi +9 -2
- bpy_extras/object_utils/__init__.pyi +71 -12
- bpy_extras/view3d_utils/__init__.pyi +80 -10
- bpy_extras/wm_utils/progress_report/__init__.pyi +13 -10
- bpy_types/__init__.pyi +4197 -1333
- console_python/__init__.pyi +6 -1
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/METADATA +1 -1
- fake_bpy_module-20240517.dist-info/RECORD +353 -0
- freestyle/chainingiterators/__init__.pyi +4 -4
- freestyle/shaders/__init__.pyi +2 -2
- freestyle/types/__init__.pyi +84 -96
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +3 -3
- 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 -2
- idprop/types/__init__.pyi +2 -2
- imbuf/__init__.pyi +4 -4
- keyingsets_builtins/__init__.pyi +2688 -839
- mathutils/__init__.pyi +194 -238
- mathutils/bvhtree/__init__.pyi +4 -4
- mathutils/geometry/__init__.pyi +153 -155
- mathutils/kdtree/__init__.pyi +8 -12
- mathutils/noise/__init__.pyi +26 -26
- nodeitems_utils/__init__.pyi +1 -1
- rna_info/__init__.pyi +17 -15
- rna_keymap_ui/__init__.pyi +1 -1
- rna_prop_ui/__init__.pyi +16 -14
- rna_xml/__init__.pyi +12 -12
- _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-20240517.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/top_level.txt +0 -0
bl_ui/space_console/__init__.pyi
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import typing
|
|
2
|
+
import bpy.types
|
|
2
3
|
import bpy_types
|
|
3
4
|
|
|
4
5
|
GenericType = typing.TypeVar("GenericType")
|
|
@@ -16,22 +17,35 @@ class CONSOLE_HT_header(bpy_types.Header, bpy_types._GenericUI):
|
|
|
16
17
|
""" """
|
|
17
18
|
|
|
18
19
|
def append(self, draw_func):
|
|
19
|
-
"""
|
|
20
|
+
"""Append a draw function to this menu,
|
|
21
|
+
takes the same arguments as the menus draw function
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
:param draw_func:
|
|
22
24
|
"""
|
|
23
25
|
...
|
|
24
26
|
|
|
25
|
-
def as_pointer(self):
|
|
26
|
-
"""
|
|
27
|
+
def as_pointer(self) -> int:
|
|
28
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
29
|
+
|
|
30
|
+
:return: int (memory address).
|
|
31
|
+
:rtype: int
|
|
32
|
+
"""
|
|
27
33
|
...
|
|
28
34
|
|
|
29
|
-
def bl_rna_get_subclass(self):
|
|
30
|
-
"""
|
|
35
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
36
|
+
"""
|
|
37
|
+
|
|
38
|
+
:return: The RNA type or default when not found.
|
|
39
|
+
:rtype: bpy.types.Struct
|
|
40
|
+
"""
|
|
31
41
|
...
|
|
32
42
|
|
|
33
|
-
def bl_rna_get_subclass_py(self):
|
|
34
|
-
"""
|
|
43
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
44
|
+
"""
|
|
45
|
+
|
|
46
|
+
:return: The class or default when not found.
|
|
47
|
+
:rtype: typing.Any
|
|
48
|
+
"""
|
|
35
49
|
...
|
|
36
50
|
|
|
37
51
|
def draw(self, context):
|
|
@@ -41,106 +55,179 @@ class CONSOLE_HT_header(bpy_types.Header, bpy_types._GenericUI):
|
|
|
41
55
|
"""
|
|
42
56
|
...
|
|
43
57
|
|
|
44
|
-
def driver_add(self):
|
|
45
|
-
"""
|
|
58
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
59
|
+
"""Adds driver(s) to the given property
|
|
60
|
+
|
|
61
|
+
:return: The driver(s) added.
|
|
62
|
+
:rtype: bpy.types.FCurve
|
|
63
|
+
"""
|
|
46
64
|
...
|
|
47
65
|
|
|
48
|
-
def driver_remove(self):
|
|
49
|
-
"""
|
|
66
|
+
def driver_remove(self) -> bool:
|
|
67
|
+
"""Remove driver(s) from the given property
|
|
68
|
+
|
|
69
|
+
:return: Success of driver removal.
|
|
70
|
+
:rtype: bool
|
|
71
|
+
"""
|
|
50
72
|
...
|
|
51
73
|
|
|
52
74
|
def get(self):
|
|
53
|
-
"""
|
|
75
|
+
"""Returns the value of the custom property assigned to key or default
|
|
76
|
+
when not found (matches Python's dictionary function of the same name).
|
|
77
|
+
|
|
78
|
+
"""
|
|
54
79
|
...
|
|
55
80
|
|
|
56
81
|
def id_properties_clear(self):
|
|
57
|
-
"""
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
85
|
+
"""
|
|
58
86
|
...
|
|
59
87
|
|
|
60
88
|
def id_properties_ensure(self):
|
|
61
|
-
"""
|
|
89
|
+
"""
|
|
90
|
+
|
|
91
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
92
|
+
"""
|
|
62
93
|
...
|
|
63
94
|
|
|
64
95
|
def id_properties_ui(self):
|
|
65
|
-
"""
|
|
96
|
+
"""
|
|
97
|
+
|
|
98
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
99
|
+
"""
|
|
66
100
|
...
|
|
67
101
|
|
|
68
102
|
def is_extended(self):
|
|
69
103
|
""" """
|
|
70
104
|
...
|
|
71
105
|
|
|
72
|
-
def is_property_hidden(self):
|
|
73
|
-
"""
|
|
106
|
+
def is_property_hidden(self) -> bool:
|
|
107
|
+
"""Check if a property is hidden.
|
|
108
|
+
|
|
109
|
+
:return: True when the property is hidden.
|
|
110
|
+
:rtype: bool
|
|
111
|
+
"""
|
|
74
112
|
...
|
|
75
113
|
|
|
76
|
-
def is_property_overridable_library(self):
|
|
77
|
-
"""
|
|
114
|
+
def is_property_overridable_library(self) -> bool:
|
|
115
|
+
"""Check if a property is overridable.
|
|
116
|
+
|
|
117
|
+
:return: True when the property is overridable.
|
|
118
|
+
:rtype: bool
|
|
119
|
+
"""
|
|
78
120
|
...
|
|
79
121
|
|
|
80
|
-
def is_property_readonly(self):
|
|
81
|
-
"""
|
|
122
|
+
def is_property_readonly(self) -> bool:
|
|
123
|
+
"""Check if a property is readonly.
|
|
124
|
+
|
|
125
|
+
:return: True when the property is readonly (not writable).
|
|
126
|
+
:rtype: bool
|
|
127
|
+
"""
|
|
82
128
|
...
|
|
83
129
|
|
|
84
|
-
def is_property_set(self):
|
|
85
|
-
"""
|
|
130
|
+
def is_property_set(self) -> bool:
|
|
131
|
+
"""Check if a property is set, use for testing operator properties.
|
|
132
|
+
|
|
133
|
+
:return: True when the property has been set.
|
|
134
|
+
:rtype: bool
|
|
135
|
+
"""
|
|
86
136
|
...
|
|
87
137
|
|
|
88
138
|
def items(self):
|
|
89
|
-
"""
|
|
139
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
140
|
+
dictionary function of the same name).
|
|
141
|
+
|
|
142
|
+
:return: custom property key, value pairs.
|
|
143
|
+
"""
|
|
90
144
|
...
|
|
91
145
|
|
|
92
|
-
def keyframe_delete(self):
|
|
93
|
-
"""
|
|
146
|
+
def keyframe_delete(self) -> bool:
|
|
147
|
+
"""Remove a keyframe from this properties fcurve.
|
|
148
|
+
|
|
149
|
+
:return: Success of keyframe deletion.
|
|
150
|
+
:rtype: bool
|
|
151
|
+
"""
|
|
94
152
|
...
|
|
95
153
|
|
|
96
|
-
def keyframe_insert(self):
|
|
97
|
-
"""
|
|
154
|
+
def keyframe_insert(self) -> bool:
|
|
155
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
156
|
+
|
|
157
|
+
:return: Success of keyframe insertion.
|
|
158
|
+
:rtype: bool
|
|
159
|
+
"""
|
|
98
160
|
...
|
|
99
161
|
|
|
100
162
|
def keys(self):
|
|
101
|
-
"""
|
|
163
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
164
|
+
dictionary function of the same name).
|
|
165
|
+
|
|
166
|
+
:return: custom property keys.
|
|
167
|
+
"""
|
|
102
168
|
...
|
|
103
169
|
|
|
104
|
-
def path_from_id(self):
|
|
105
|
-
"""
|
|
170
|
+
def path_from_id(self) -> str:
|
|
171
|
+
"""Returns the data path from the ID to this object (string).
|
|
172
|
+
|
|
173
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
174
|
+
to this struct and property (when given).
|
|
175
|
+
:rtype: str
|
|
176
|
+
"""
|
|
106
177
|
...
|
|
107
178
|
|
|
108
179
|
def path_resolve(self):
|
|
109
|
-
""" """
|
|
180
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
110
181
|
...
|
|
111
182
|
|
|
112
183
|
def pop(self):
|
|
113
|
-
"""
|
|
184
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
185
|
+
when not found (matches Python's dictionary function of the same name).
|
|
186
|
+
|
|
187
|
+
"""
|
|
114
188
|
...
|
|
115
189
|
|
|
116
190
|
def prepend(self, draw_func):
|
|
117
|
-
"""
|
|
191
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
192
|
+
the menus draw function
|
|
118
193
|
|
|
119
|
-
|
|
194
|
+
:param draw_func:
|
|
120
195
|
"""
|
|
121
196
|
...
|
|
122
197
|
|
|
123
|
-
def property_overridable_library_set(self):
|
|
124
|
-
"""
|
|
198
|
+
def property_overridable_library_set(self) -> bool:
|
|
199
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
200
|
+
|
|
201
|
+
:return: True when the overridable status of the property was successfully set.
|
|
202
|
+
:rtype: bool
|
|
203
|
+
"""
|
|
125
204
|
...
|
|
126
205
|
|
|
127
206
|
def property_unset(self):
|
|
128
|
-
""" """
|
|
207
|
+
"""Unset a property, will use default value afterward."""
|
|
129
208
|
...
|
|
130
209
|
|
|
131
210
|
def remove(self, draw_func):
|
|
132
|
-
"""
|
|
211
|
+
"""Remove a draw function that has been added to this menu
|
|
133
212
|
|
|
134
213
|
:param draw_func:
|
|
135
214
|
"""
|
|
136
215
|
...
|
|
137
216
|
|
|
138
217
|
def type_recast(self):
|
|
139
|
-
"""
|
|
218
|
+
"""Return a new instance, this is needed because types
|
|
219
|
+
such as textures can be changed at runtime.
|
|
220
|
+
|
|
221
|
+
:return: a new instance of this object with the type initialized again.
|
|
222
|
+
"""
|
|
140
223
|
...
|
|
141
224
|
|
|
142
225
|
def values(self):
|
|
143
|
-
"""
|
|
226
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
227
|
+
dictionary function of the same name).
|
|
228
|
+
|
|
229
|
+
:return: custom property values.
|
|
230
|
+
"""
|
|
144
231
|
...
|
|
145
232
|
|
|
146
233
|
class CONSOLE_MT_console(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -156,22 +243,35 @@ class CONSOLE_MT_console(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
156
243
|
""" """
|
|
157
244
|
|
|
158
245
|
def append(self, draw_func):
|
|
159
|
-
"""
|
|
246
|
+
"""Append a draw function to this menu,
|
|
247
|
+
takes the same arguments as the menus draw function
|
|
160
248
|
|
|
161
|
-
|
|
249
|
+
:param draw_func:
|
|
162
250
|
"""
|
|
163
251
|
...
|
|
164
252
|
|
|
165
|
-
def as_pointer(self):
|
|
166
|
-
"""
|
|
253
|
+
def as_pointer(self) -> int:
|
|
254
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
255
|
+
|
|
256
|
+
:return: int (memory address).
|
|
257
|
+
:rtype: int
|
|
258
|
+
"""
|
|
167
259
|
...
|
|
168
260
|
|
|
169
|
-
def bl_rna_get_subclass(self):
|
|
170
|
-
"""
|
|
261
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
262
|
+
"""
|
|
263
|
+
|
|
264
|
+
:return: The RNA type or default when not found.
|
|
265
|
+
:rtype: bpy.types.Struct
|
|
266
|
+
"""
|
|
171
267
|
...
|
|
172
268
|
|
|
173
|
-
def bl_rna_get_subclass_py(self):
|
|
174
|
-
"""
|
|
269
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
270
|
+
"""
|
|
271
|
+
|
|
272
|
+
:return: The class or default when not found.
|
|
273
|
+
:rtype: typing.Any
|
|
274
|
+
"""
|
|
175
275
|
...
|
|
176
276
|
|
|
177
277
|
def draw(self, _context):
|
|
@@ -190,138 +290,224 @@ class CONSOLE_MT_console(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
190
290
|
...
|
|
191
291
|
|
|
192
292
|
def draw_preset(self, _context):
|
|
193
|
-
"""
|
|
293
|
+
"""Define these on the subclass:
|
|
294
|
+
- preset_operator (string)
|
|
295
|
+
- preset_subdir (string)Optionally:
|
|
296
|
+
- preset_add_operator (string)
|
|
297
|
+
- preset_extensions (set of strings)
|
|
298
|
+
- preset_operator_defaults (dict of keyword args)
|
|
194
299
|
|
|
195
|
-
|
|
300
|
+
:param _context:
|
|
196
301
|
"""
|
|
197
302
|
...
|
|
198
303
|
|
|
199
|
-
def driver_add(self):
|
|
200
|
-
"""
|
|
304
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
305
|
+
"""Adds driver(s) to the given property
|
|
306
|
+
|
|
307
|
+
:return: The driver(s) added.
|
|
308
|
+
:rtype: bpy.types.FCurve
|
|
309
|
+
"""
|
|
201
310
|
...
|
|
202
311
|
|
|
203
|
-
def driver_remove(self):
|
|
204
|
-
"""
|
|
312
|
+
def driver_remove(self) -> bool:
|
|
313
|
+
"""Remove driver(s) from the given property
|
|
314
|
+
|
|
315
|
+
:return: Success of driver removal.
|
|
316
|
+
:rtype: bool
|
|
317
|
+
"""
|
|
205
318
|
...
|
|
206
319
|
|
|
207
320
|
def get(self):
|
|
208
|
-
"""
|
|
321
|
+
"""Returns the value of the custom property assigned to key or default
|
|
322
|
+
when not found (matches Python's dictionary function of the same name).
|
|
323
|
+
|
|
324
|
+
"""
|
|
209
325
|
...
|
|
210
326
|
|
|
211
327
|
def id_properties_clear(self):
|
|
212
|
-
"""
|
|
328
|
+
"""
|
|
329
|
+
|
|
330
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
331
|
+
"""
|
|
213
332
|
...
|
|
214
333
|
|
|
215
334
|
def id_properties_ensure(self):
|
|
216
|
-
"""
|
|
335
|
+
"""
|
|
336
|
+
|
|
337
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
338
|
+
"""
|
|
217
339
|
...
|
|
218
340
|
|
|
219
341
|
def id_properties_ui(self):
|
|
220
|
-
"""
|
|
342
|
+
"""
|
|
343
|
+
|
|
344
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
345
|
+
"""
|
|
221
346
|
...
|
|
222
347
|
|
|
223
348
|
def is_extended(self):
|
|
224
349
|
""" """
|
|
225
350
|
...
|
|
226
351
|
|
|
227
|
-
def is_property_hidden(self):
|
|
228
|
-
"""
|
|
352
|
+
def is_property_hidden(self) -> bool:
|
|
353
|
+
"""Check if a property is hidden.
|
|
354
|
+
|
|
355
|
+
:return: True when the property is hidden.
|
|
356
|
+
:rtype: bool
|
|
357
|
+
"""
|
|
229
358
|
...
|
|
230
359
|
|
|
231
|
-
def is_property_overridable_library(self):
|
|
232
|
-
"""
|
|
360
|
+
def is_property_overridable_library(self) -> bool:
|
|
361
|
+
"""Check if a property is overridable.
|
|
362
|
+
|
|
363
|
+
:return: True when the property is overridable.
|
|
364
|
+
:rtype: bool
|
|
365
|
+
"""
|
|
233
366
|
...
|
|
234
367
|
|
|
235
|
-
def is_property_readonly(self):
|
|
236
|
-
"""
|
|
368
|
+
def is_property_readonly(self) -> bool:
|
|
369
|
+
"""Check if a property is readonly.
|
|
370
|
+
|
|
371
|
+
:return: True when the property is readonly (not writable).
|
|
372
|
+
:rtype: bool
|
|
373
|
+
"""
|
|
237
374
|
...
|
|
238
375
|
|
|
239
|
-
def is_property_set(self):
|
|
240
|
-
"""
|
|
376
|
+
def is_property_set(self) -> bool:
|
|
377
|
+
"""Check if a property is set, use for testing operator properties.
|
|
378
|
+
|
|
379
|
+
:return: True when the property has been set.
|
|
380
|
+
:rtype: bool
|
|
381
|
+
"""
|
|
241
382
|
...
|
|
242
383
|
|
|
243
384
|
def items(self):
|
|
244
|
-
"""
|
|
385
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
386
|
+
dictionary function of the same name).
|
|
387
|
+
|
|
388
|
+
:return: custom property key, value pairs.
|
|
389
|
+
"""
|
|
245
390
|
...
|
|
246
391
|
|
|
247
|
-
def keyframe_delete(self):
|
|
248
|
-
"""
|
|
392
|
+
def keyframe_delete(self) -> bool:
|
|
393
|
+
"""Remove a keyframe from this properties fcurve.
|
|
394
|
+
|
|
395
|
+
:return: Success of keyframe deletion.
|
|
396
|
+
:rtype: bool
|
|
397
|
+
"""
|
|
249
398
|
...
|
|
250
399
|
|
|
251
|
-
def keyframe_insert(self):
|
|
252
|
-
"""
|
|
400
|
+
def keyframe_insert(self) -> bool:
|
|
401
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
402
|
+
|
|
403
|
+
:return: Success of keyframe insertion.
|
|
404
|
+
:rtype: bool
|
|
405
|
+
"""
|
|
253
406
|
...
|
|
254
407
|
|
|
255
408
|
def keys(self):
|
|
256
|
-
"""
|
|
409
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
410
|
+
dictionary function of the same name).
|
|
411
|
+
|
|
412
|
+
:return: custom property keys.
|
|
413
|
+
"""
|
|
257
414
|
...
|
|
258
415
|
|
|
259
|
-
def path_from_id(self):
|
|
260
|
-
"""
|
|
416
|
+
def path_from_id(self) -> str:
|
|
417
|
+
"""Returns the data path from the ID to this object (string).
|
|
418
|
+
|
|
419
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
420
|
+
to this struct and property (when given).
|
|
421
|
+
:rtype: str
|
|
422
|
+
"""
|
|
261
423
|
...
|
|
262
424
|
|
|
263
425
|
def path_menu(
|
|
264
426
|
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,
|
|
427
|
+
searchpaths: list[str],
|
|
428
|
+
operator: str,
|
|
429
|
+
props_default: dict = None,
|
|
430
|
+
prop_filepath: str = "filepath",
|
|
431
|
+
filter_ext: typing.Callable = None,
|
|
432
|
+
filter_path=None,
|
|
433
|
+
display_name: typing.Callable = None,
|
|
434
|
+
add_operator=None,
|
|
435
|
+
add_operator_props=None,
|
|
274
436
|
):
|
|
275
|
-
"""
|
|
437
|
+
"""Populate a menu from a list of paths.
|
|
276
438
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
439
|
+
:param searchpaths: Paths to scan.
|
|
440
|
+
:type searchpaths: list[str]
|
|
441
|
+
:param operator: The operator id to use with each file.
|
|
442
|
+
:type operator: str
|
|
443
|
+
:param props_default: Properties to assign to each operator.
|
|
444
|
+
:type props_default: dict
|
|
445
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
446
|
+
:type prop_filepath: str
|
|
447
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
448
|
+
|
|
449
|
+
Returning false excludes the file from the list.
|
|
450
|
+
:type filter_ext: typing.Callable
|
|
451
|
+
:param filter_path:
|
|
452
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
453
|
+
:type display_name: typing.Callable
|
|
454
|
+
:param add_operator:
|
|
455
|
+
:param add_operator_props:
|
|
286
456
|
"""
|
|
287
457
|
...
|
|
288
458
|
|
|
289
459
|
def path_resolve(self):
|
|
290
|
-
""" """
|
|
460
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
291
461
|
...
|
|
292
462
|
|
|
293
463
|
def pop(self):
|
|
294
|
-
"""
|
|
464
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
465
|
+
when not found (matches Python's dictionary function of the same name).
|
|
466
|
+
|
|
467
|
+
"""
|
|
295
468
|
...
|
|
296
469
|
|
|
297
470
|
def prepend(self, draw_func):
|
|
298
|
-
"""
|
|
471
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
472
|
+
the menus draw function
|
|
299
473
|
|
|
300
|
-
|
|
474
|
+
:param draw_func:
|
|
301
475
|
"""
|
|
302
476
|
...
|
|
303
477
|
|
|
304
|
-
def property_overridable_library_set(self):
|
|
305
|
-
"""
|
|
478
|
+
def property_overridable_library_set(self) -> bool:
|
|
479
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
480
|
+
|
|
481
|
+
:return: True when the overridable status of the property was successfully set.
|
|
482
|
+
:rtype: bool
|
|
483
|
+
"""
|
|
306
484
|
...
|
|
307
485
|
|
|
308
486
|
def property_unset(self):
|
|
309
|
-
""" """
|
|
487
|
+
"""Unset a property, will use default value afterward."""
|
|
310
488
|
...
|
|
311
489
|
|
|
312
490
|
def remove(self, draw_func):
|
|
313
|
-
"""
|
|
491
|
+
"""Remove a draw function that has been added to this menu
|
|
314
492
|
|
|
315
493
|
:param draw_func:
|
|
316
494
|
"""
|
|
317
495
|
...
|
|
318
496
|
|
|
319
497
|
def type_recast(self):
|
|
320
|
-
"""
|
|
498
|
+
"""Return a new instance, this is needed because types
|
|
499
|
+
such as textures can be changed at runtime.
|
|
500
|
+
|
|
501
|
+
:return: a new instance of this object with the type initialized again.
|
|
502
|
+
"""
|
|
321
503
|
...
|
|
322
504
|
|
|
323
505
|
def values(self):
|
|
324
|
-
"""
|
|
506
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
507
|
+
dictionary function of the same name).
|
|
508
|
+
|
|
509
|
+
:return: custom property values.
|
|
510
|
+
"""
|
|
325
511
|
...
|
|
326
512
|
|
|
327
513
|
class CONSOLE_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -337,22 +523,35 @@ class CONSOLE_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
337
523
|
""" """
|
|
338
524
|
|
|
339
525
|
def append(self, draw_func):
|
|
340
|
-
"""
|
|
526
|
+
"""Append a draw function to this menu,
|
|
527
|
+
takes the same arguments as the menus draw function
|
|
341
528
|
|
|
342
|
-
|
|
529
|
+
:param draw_func:
|
|
343
530
|
"""
|
|
344
531
|
...
|
|
345
532
|
|
|
346
|
-
def as_pointer(self):
|
|
347
|
-
"""
|
|
533
|
+
def as_pointer(self) -> int:
|
|
534
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
535
|
+
|
|
536
|
+
:return: int (memory address).
|
|
537
|
+
:rtype: int
|
|
538
|
+
"""
|
|
348
539
|
...
|
|
349
540
|
|
|
350
|
-
def bl_rna_get_subclass(self):
|
|
351
|
-
"""
|
|
541
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
542
|
+
"""
|
|
543
|
+
|
|
544
|
+
:return: The RNA type or default when not found.
|
|
545
|
+
:rtype: bpy.types.Struct
|
|
546
|
+
"""
|
|
352
547
|
...
|
|
353
548
|
|
|
354
|
-
def bl_rna_get_subclass_py(self):
|
|
355
|
-
"""
|
|
549
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
550
|
+
"""
|
|
551
|
+
|
|
552
|
+
:return: The class or default when not found.
|
|
553
|
+
:rtype: typing.Any
|
|
554
|
+
"""
|
|
356
555
|
...
|
|
357
556
|
|
|
358
557
|
def draw(self, _context):
|
|
@@ -371,138 +570,224 @@ class CONSOLE_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
371
570
|
...
|
|
372
571
|
|
|
373
572
|
def draw_preset(self, _context):
|
|
374
|
-
"""
|
|
573
|
+
"""Define these on the subclass:
|
|
574
|
+
- preset_operator (string)
|
|
575
|
+
- preset_subdir (string)Optionally:
|
|
576
|
+
- preset_add_operator (string)
|
|
577
|
+
- preset_extensions (set of strings)
|
|
578
|
+
- preset_operator_defaults (dict of keyword args)
|
|
375
579
|
|
|
376
|
-
|
|
580
|
+
:param _context:
|
|
377
581
|
"""
|
|
378
582
|
...
|
|
379
583
|
|
|
380
|
-
def driver_add(self):
|
|
381
|
-
"""
|
|
584
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
585
|
+
"""Adds driver(s) to the given property
|
|
586
|
+
|
|
587
|
+
:return: The driver(s) added.
|
|
588
|
+
:rtype: bpy.types.FCurve
|
|
589
|
+
"""
|
|
382
590
|
...
|
|
383
591
|
|
|
384
|
-
def driver_remove(self):
|
|
385
|
-
"""
|
|
592
|
+
def driver_remove(self) -> bool:
|
|
593
|
+
"""Remove driver(s) from the given property
|
|
594
|
+
|
|
595
|
+
:return: Success of driver removal.
|
|
596
|
+
:rtype: bool
|
|
597
|
+
"""
|
|
386
598
|
...
|
|
387
599
|
|
|
388
600
|
def get(self):
|
|
389
|
-
"""
|
|
601
|
+
"""Returns the value of the custom property assigned to key or default
|
|
602
|
+
when not found (matches Python's dictionary function of the same name).
|
|
603
|
+
|
|
604
|
+
"""
|
|
390
605
|
...
|
|
391
606
|
|
|
392
607
|
def id_properties_clear(self):
|
|
393
|
-
"""
|
|
608
|
+
"""
|
|
609
|
+
|
|
610
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
611
|
+
"""
|
|
394
612
|
...
|
|
395
613
|
|
|
396
614
|
def id_properties_ensure(self):
|
|
397
|
-
"""
|
|
615
|
+
"""
|
|
616
|
+
|
|
617
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
618
|
+
"""
|
|
398
619
|
...
|
|
399
620
|
|
|
400
621
|
def id_properties_ui(self):
|
|
401
|
-
"""
|
|
622
|
+
"""
|
|
623
|
+
|
|
624
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
625
|
+
"""
|
|
402
626
|
...
|
|
403
627
|
|
|
404
628
|
def is_extended(self):
|
|
405
629
|
""" """
|
|
406
630
|
...
|
|
407
631
|
|
|
408
|
-
def is_property_hidden(self):
|
|
409
|
-
"""
|
|
632
|
+
def is_property_hidden(self) -> bool:
|
|
633
|
+
"""Check if a property is hidden.
|
|
634
|
+
|
|
635
|
+
:return: True when the property is hidden.
|
|
636
|
+
:rtype: bool
|
|
637
|
+
"""
|
|
410
638
|
...
|
|
411
639
|
|
|
412
|
-
def is_property_overridable_library(self):
|
|
413
|
-
"""
|
|
640
|
+
def is_property_overridable_library(self) -> bool:
|
|
641
|
+
"""Check if a property is overridable.
|
|
642
|
+
|
|
643
|
+
:return: True when the property is overridable.
|
|
644
|
+
:rtype: bool
|
|
645
|
+
"""
|
|
414
646
|
...
|
|
415
647
|
|
|
416
|
-
def is_property_readonly(self):
|
|
417
|
-
"""
|
|
648
|
+
def is_property_readonly(self) -> bool:
|
|
649
|
+
"""Check if a property is readonly.
|
|
650
|
+
|
|
651
|
+
:return: True when the property is readonly (not writable).
|
|
652
|
+
:rtype: bool
|
|
653
|
+
"""
|
|
418
654
|
...
|
|
419
655
|
|
|
420
|
-
def is_property_set(self):
|
|
421
|
-
"""
|
|
656
|
+
def is_property_set(self) -> bool:
|
|
657
|
+
"""Check if a property is set, use for testing operator properties.
|
|
658
|
+
|
|
659
|
+
:return: True when the property has been set.
|
|
660
|
+
:rtype: bool
|
|
661
|
+
"""
|
|
422
662
|
...
|
|
423
663
|
|
|
424
664
|
def items(self):
|
|
425
|
-
"""
|
|
665
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
666
|
+
dictionary function of the same name).
|
|
667
|
+
|
|
668
|
+
:return: custom property key, value pairs.
|
|
669
|
+
"""
|
|
426
670
|
...
|
|
427
671
|
|
|
428
|
-
def keyframe_delete(self):
|
|
429
|
-
"""
|
|
672
|
+
def keyframe_delete(self) -> bool:
|
|
673
|
+
"""Remove a keyframe from this properties fcurve.
|
|
674
|
+
|
|
675
|
+
:return: Success of keyframe deletion.
|
|
676
|
+
:rtype: bool
|
|
677
|
+
"""
|
|
430
678
|
...
|
|
431
679
|
|
|
432
|
-
def keyframe_insert(self):
|
|
433
|
-
"""
|
|
680
|
+
def keyframe_insert(self) -> bool:
|
|
681
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
682
|
+
|
|
683
|
+
:return: Success of keyframe insertion.
|
|
684
|
+
:rtype: bool
|
|
685
|
+
"""
|
|
434
686
|
...
|
|
435
687
|
|
|
436
688
|
def keys(self):
|
|
437
|
-
"""
|
|
689
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
690
|
+
dictionary function of the same name).
|
|
691
|
+
|
|
692
|
+
:return: custom property keys.
|
|
693
|
+
"""
|
|
438
694
|
...
|
|
439
695
|
|
|
440
|
-
def path_from_id(self):
|
|
441
|
-
"""
|
|
696
|
+
def path_from_id(self) -> str:
|
|
697
|
+
"""Returns the data path from the ID to this object (string).
|
|
698
|
+
|
|
699
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
700
|
+
to this struct and property (when given).
|
|
701
|
+
:rtype: str
|
|
702
|
+
"""
|
|
442
703
|
...
|
|
443
704
|
|
|
444
705
|
def path_menu(
|
|
445
706
|
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,
|
|
707
|
+
searchpaths: list[str],
|
|
708
|
+
operator: str,
|
|
709
|
+
props_default: dict = None,
|
|
710
|
+
prop_filepath: str = "filepath",
|
|
711
|
+
filter_ext: typing.Callable = None,
|
|
712
|
+
filter_path=None,
|
|
713
|
+
display_name: typing.Callable = None,
|
|
714
|
+
add_operator=None,
|
|
715
|
+
add_operator_props=None,
|
|
455
716
|
):
|
|
456
|
-
"""
|
|
717
|
+
"""Populate a menu from a list of paths.
|
|
457
718
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
719
|
+
:param searchpaths: Paths to scan.
|
|
720
|
+
:type searchpaths: list[str]
|
|
721
|
+
:param operator: The operator id to use with each file.
|
|
722
|
+
:type operator: str
|
|
723
|
+
:param props_default: Properties to assign to each operator.
|
|
724
|
+
:type props_default: dict
|
|
725
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
726
|
+
:type prop_filepath: str
|
|
727
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
728
|
+
|
|
729
|
+
Returning false excludes the file from the list.
|
|
730
|
+
:type filter_ext: typing.Callable
|
|
731
|
+
:param filter_path:
|
|
732
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
733
|
+
:type display_name: typing.Callable
|
|
734
|
+
:param add_operator:
|
|
735
|
+
:param add_operator_props:
|
|
467
736
|
"""
|
|
468
737
|
...
|
|
469
738
|
|
|
470
739
|
def path_resolve(self):
|
|
471
|
-
""" """
|
|
740
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
472
741
|
...
|
|
473
742
|
|
|
474
743
|
def pop(self):
|
|
475
|
-
"""
|
|
744
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
745
|
+
when not found (matches Python's dictionary function of the same name).
|
|
746
|
+
|
|
747
|
+
"""
|
|
476
748
|
...
|
|
477
749
|
|
|
478
750
|
def prepend(self, draw_func):
|
|
479
|
-
"""
|
|
751
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
752
|
+
the menus draw function
|
|
480
753
|
|
|
481
|
-
|
|
754
|
+
:param draw_func:
|
|
482
755
|
"""
|
|
483
756
|
...
|
|
484
757
|
|
|
485
|
-
def property_overridable_library_set(self):
|
|
486
|
-
"""
|
|
758
|
+
def property_overridable_library_set(self) -> bool:
|
|
759
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
760
|
+
|
|
761
|
+
:return: True when the overridable status of the property was successfully set.
|
|
762
|
+
:rtype: bool
|
|
763
|
+
"""
|
|
487
764
|
...
|
|
488
765
|
|
|
489
766
|
def property_unset(self):
|
|
490
|
-
""" """
|
|
767
|
+
"""Unset a property, will use default value afterward."""
|
|
491
768
|
...
|
|
492
769
|
|
|
493
770
|
def remove(self, draw_func):
|
|
494
|
-
"""
|
|
771
|
+
"""Remove a draw function that has been added to this menu
|
|
495
772
|
|
|
496
773
|
:param draw_func:
|
|
497
774
|
"""
|
|
498
775
|
...
|
|
499
776
|
|
|
500
777
|
def type_recast(self):
|
|
501
|
-
"""
|
|
778
|
+
"""Return a new instance, this is needed because types
|
|
779
|
+
such as textures can be changed at runtime.
|
|
780
|
+
|
|
781
|
+
:return: a new instance of this object with the type initialized again.
|
|
782
|
+
"""
|
|
502
783
|
...
|
|
503
784
|
|
|
504
785
|
def values(self):
|
|
505
|
-
"""
|
|
786
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
787
|
+
dictionary function of the same name).
|
|
788
|
+
|
|
789
|
+
:return: custom property values.
|
|
790
|
+
"""
|
|
506
791
|
...
|
|
507
792
|
|
|
508
793
|
class CONSOLE_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -521,22 +806,35 @@ class CONSOLE_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
521
806
|
""" """
|
|
522
807
|
|
|
523
808
|
def append(self, draw_func):
|
|
524
|
-
"""
|
|
809
|
+
"""Append a draw function to this menu,
|
|
810
|
+
takes the same arguments as the menus draw function
|
|
525
811
|
|
|
526
|
-
|
|
812
|
+
:param draw_func:
|
|
527
813
|
"""
|
|
528
814
|
...
|
|
529
815
|
|
|
530
|
-
def as_pointer(self):
|
|
531
|
-
"""
|
|
816
|
+
def as_pointer(self) -> int:
|
|
817
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
818
|
+
|
|
819
|
+
:return: int (memory address).
|
|
820
|
+
:rtype: int
|
|
821
|
+
"""
|
|
532
822
|
...
|
|
533
823
|
|
|
534
|
-
def bl_rna_get_subclass(self):
|
|
535
|
-
"""
|
|
824
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
825
|
+
"""
|
|
826
|
+
|
|
827
|
+
:return: The RNA type or default when not found.
|
|
828
|
+
:rtype: bpy.types.Struct
|
|
829
|
+
"""
|
|
536
830
|
...
|
|
537
831
|
|
|
538
|
-
def bl_rna_get_subclass_py(self):
|
|
539
|
-
"""
|
|
832
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
833
|
+
"""
|
|
834
|
+
|
|
835
|
+
:return: The class or default when not found.
|
|
836
|
+
:rtype: typing.Any
|
|
837
|
+
"""
|
|
540
838
|
...
|
|
541
839
|
|
|
542
840
|
def draw(self, _context):
|
|
@@ -555,138 +853,224 @@ class CONSOLE_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
555
853
|
...
|
|
556
854
|
|
|
557
855
|
def draw_preset(self, _context):
|
|
558
|
-
"""
|
|
856
|
+
"""Define these on the subclass:
|
|
857
|
+
- preset_operator (string)
|
|
858
|
+
- preset_subdir (string)Optionally:
|
|
859
|
+
- preset_add_operator (string)
|
|
860
|
+
- preset_extensions (set of strings)
|
|
861
|
+
- preset_operator_defaults (dict of keyword args)
|
|
559
862
|
|
|
560
|
-
|
|
863
|
+
:param _context:
|
|
561
864
|
"""
|
|
562
865
|
...
|
|
563
866
|
|
|
564
|
-
def driver_add(self):
|
|
565
|
-
"""
|
|
867
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
868
|
+
"""Adds driver(s) to the given property
|
|
869
|
+
|
|
870
|
+
:return: The driver(s) added.
|
|
871
|
+
:rtype: bpy.types.FCurve
|
|
872
|
+
"""
|
|
566
873
|
...
|
|
567
874
|
|
|
568
|
-
def driver_remove(self):
|
|
569
|
-
"""
|
|
875
|
+
def driver_remove(self) -> bool:
|
|
876
|
+
"""Remove driver(s) from the given property
|
|
877
|
+
|
|
878
|
+
:return: Success of driver removal.
|
|
879
|
+
:rtype: bool
|
|
880
|
+
"""
|
|
570
881
|
...
|
|
571
882
|
|
|
572
883
|
def get(self):
|
|
573
|
-
"""
|
|
884
|
+
"""Returns the value of the custom property assigned to key or default
|
|
885
|
+
when not found (matches Python's dictionary function of the same name).
|
|
886
|
+
|
|
887
|
+
"""
|
|
574
888
|
...
|
|
575
889
|
|
|
576
890
|
def id_properties_clear(self):
|
|
577
|
-
"""
|
|
891
|
+
"""
|
|
892
|
+
|
|
893
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
894
|
+
"""
|
|
578
895
|
...
|
|
579
896
|
|
|
580
897
|
def id_properties_ensure(self):
|
|
581
|
-
"""
|
|
898
|
+
"""
|
|
899
|
+
|
|
900
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
901
|
+
"""
|
|
582
902
|
...
|
|
583
903
|
|
|
584
904
|
def id_properties_ui(self):
|
|
585
|
-
"""
|
|
905
|
+
"""
|
|
906
|
+
|
|
907
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
908
|
+
"""
|
|
586
909
|
...
|
|
587
910
|
|
|
588
911
|
def is_extended(self):
|
|
589
912
|
""" """
|
|
590
913
|
...
|
|
591
914
|
|
|
592
|
-
def is_property_hidden(self):
|
|
593
|
-
"""
|
|
915
|
+
def is_property_hidden(self) -> bool:
|
|
916
|
+
"""Check if a property is hidden.
|
|
917
|
+
|
|
918
|
+
:return: True when the property is hidden.
|
|
919
|
+
:rtype: bool
|
|
920
|
+
"""
|
|
594
921
|
...
|
|
595
922
|
|
|
596
|
-
def is_property_overridable_library(self):
|
|
597
|
-
"""
|
|
923
|
+
def is_property_overridable_library(self) -> bool:
|
|
924
|
+
"""Check if a property is overridable.
|
|
925
|
+
|
|
926
|
+
:return: True when the property is overridable.
|
|
927
|
+
:rtype: bool
|
|
928
|
+
"""
|
|
598
929
|
...
|
|
599
930
|
|
|
600
|
-
def is_property_readonly(self):
|
|
601
|
-
"""
|
|
931
|
+
def is_property_readonly(self) -> bool:
|
|
932
|
+
"""Check if a property is readonly.
|
|
933
|
+
|
|
934
|
+
:return: True when the property is readonly (not writable).
|
|
935
|
+
:rtype: bool
|
|
936
|
+
"""
|
|
602
937
|
...
|
|
603
938
|
|
|
604
|
-
def is_property_set(self):
|
|
605
|
-
"""
|
|
939
|
+
def is_property_set(self) -> bool:
|
|
940
|
+
"""Check if a property is set, use for testing operator properties.
|
|
941
|
+
|
|
942
|
+
:return: True when the property has been set.
|
|
943
|
+
:rtype: bool
|
|
944
|
+
"""
|
|
606
945
|
...
|
|
607
946
|
|
|
608
947
|
def items(self):
|
|
609
|
-
"""
|
|
948
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
949
|
+
dictionary function of the same name).
|
|
950
|
+
|
|
951
|
+
:return: custom property key, value pairs.
|
|
952
|
+
"""
|
|
610
953
|
...
|
|
611
954
|
|
|
612
|
-
def keyframe_delete(self):
|
|
613
|
-
"""
|
|
955
|
+
def keyframe_delete(self) -> bool:
|
|
956
|
+
"""Remove a keyframe from this properties fcurve.
|
|
957
|
+
|
|
958
|
+
:return: Success of keyframe deletion.
|
|
959
|
+
:rtype: bool
|
|
960
|
+
"""
|
|
614
961
|
...
|
|
615
962
|
|
|
616
|
-
def keyframe_insert(self):
|
|
617
|
-
"""
|
|
963
|
+
def keyframe_insert(self) -> bool:
|
|
964
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
965
|
+
|
|
966
|
+
:return: Success of keyframe insertion.
|
|
967
|
+
:rtype: bool
|
|
968
|
+
"""
|
|
618
969
|
...
|
|
619
970
|
|
|
620
971
|
def keys(self):
|
|
621
|
-
"""
|
|
972
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
973
|
+
dictionary function of the same name).
|
|
974
|
+
|
|
975
|
+
:return: custom property keys.
|
|
976
|
+
"""
|
|
622
977
|
...
|
|
623
978
|
|
|
624
|
-
def path_from_id(self):
|
|
625
|
-
"""
|
|
979
|
+
def path_from_id(self) -> str:
|
|
980
|
+
"""Returns the data path from the ID to this object (string).
|
|
981
|
+
|
|
982
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
983
|
+
to this struct and property (when given).
|
|
984
|
+
:rtype: str
|
|
985
|
+
"""
|
|
626
986
|
...
|
|
627
987
|
|
|
628
988
|
def path_menu(
|
|
629
989
|
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,
|
|
990
|
+
searchpaths: list[str],
|
|
991
|
+
operator: str,
|
|
992
|
+
props_default: dict = None,
|
|
993
|
+
prop_filepath: str = "filepath",
|
|
994
|
+
filter_ext: typing.Callable = None,
|
|
995
|
+
filter_path=None,
|
|
996
|
+
display_name: typing.Callable = None,
|
|
997
|
+
add_operator=None,
|
|
998
|
+
add_operator_props=None,
|
|
639
999
|
):
|
|
640
|
-
"""
|
|
1000
|
+
"""Populate a menu from a list of paths.
|
|
1001
|
+
|
|
1002
|
+
:param searchpaths: Paths to scan.
|
|
1003
|
+
:type searchpaths: list[str]
|
|
1004
|
+
:param operator: The operator id to use with each file.
|
|
1005
|
+
:type operator: str
|
|
1006
|
+
:param props_default: Properties to assign to each operator.
|
|
1007
|
+
:type props_default: dict
|
|
1008
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1009
|
+
:type prop_filepath: str
|
|
1010
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
641
1011
|
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
:param add_operator:
|
|
650
|
-
:param add_operator_props:
|
|
1012
|
+
Returning false excludes the file from the list.
|
|
1013
|
+
:type filter_ext: typing.Callable
|
|
1014
|
+
:param filter_path:
|
|
1015
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1016
|
+
:type display_name: typing.Callable
|
|
1017
|
+
:param add_operator:
|
|
1018
|
+
:param add_operator_props:
|
|
651
1019
|
"""
|
|
652
1020
|
...
|
|
653
1021
|
|
|
654
1022
|
def path_resolve(self):
|
|
655
|
-
""" """
|
|
1023
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
656
1024
|
...
|
|
657
1025
|
|
|
658
1026
|
def pop(self):
|
|
659
|
-
"""
|
|
1027
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1028
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1029
|
+
|
|
1030
|
+
"""
|
|
660
1031
|
...
|
|
661
1032
|
|
|
662
1033
|
def prepend(self, draw_func):
|
|
663
|
-
"""
|
|
1034
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1035
|
+
the menus draw function
|
|
664
1036
|
|
|
665
|
-
|
|
1037
|
+
:param draw_func:
|
|
666
1038
|
"""
|
|
667
1039
|
...
|
|
668
1040
|
|
|
669
|
-
def property_overridable_library_set(self):
|
|
670
|
-
"""
|
|
1041
|
+
def property_overridable_library_set(self) -> bool:
|
|
1042
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1043
|
+
|
|
1044
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1045
|
+
:rtype: bool
|
|
1046
|
+
"""
|
|
671
1047
|
...
|
|
672
1048
|
|
|
673
1049
|
def property_unset(self):
|
|
674
|
-
""" """
|
|
1050
|
+
"""Unset a property, will use default value afterward."""
|
|
675
1051
|
...
|
|
676
1052
|
|
|
677
1053
|
def remove(self, draw_func):
|
|
678
|
-
"""
|
|
1054
|
+
"""Remove a draw function that has been added to this menu
|
|
679
1055
|
|
|
680
1056
|
:param draw_func:
|
|
681
1057
|
"""
|
|
682
1058
|
...
|
|
683
1059
|
|
|
684
1060
|
def type_recast(self):
|
|
685
|
-
"""
|
|
1061
|
+
"""Return a new instance, this is needed because types
|
|
1062
|
+
such as textures can be changed at runtime.
|
|
1063
|
+
|
|
1064
|
+
:return: a new instance of this object with the type initialized again.
|
|
1065
|
+
"""
|
|
686
1066
|
...
|
|
687
1067
|
|
|
688
1068
|
def values(self):
|
|
689
|
-
"""
|
|
1069
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1070
|
+
dictionary function of the same name).
|
|
1071
|
+
|
|
1072
|
+
:return: custom property values.
|
|
1073
|
+
"""
|
|
690
1074
|
...
|
|
691
1075
|
|
|
692
1076
|
class CONSOLE_MT_language(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -702,22 +1086,35 @@ class CONSOLE_MT_language(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
702
1086
|
""" """
|
|
703
1087
|
|
|
704
1088
|
def append(self, draw_func):
|
|
705
|
-
"""
|
|
1089
|
+
"""Append a draw function to this menu,
|
|
1090
|
+
takes the same arguments as the menus draw function
|
|
706
1091
|
|
|
707
|
-
|
|
1092
|
+
:param draw_func:
|
|
708
1093
|
"""
|
|
709
1094
|
...
|
|
710
1095
|
|
|
711
|
-
def as_pointer(self):
|
|
712
|
-
"""
|
|
1096
|
+
def as_pointer(self) -> int:
|
|
1097
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1098
|
+
|
|
1099
|
+
:return: int (memory address).
|
|
1100
|
+
:rtype: int
|
|
1101
|
+
"""
|
|
713
1102
|
...
|
|
714
1103
|
|
|
715
|
-
def bl_rna_get_subclass(self):
|
|
716
|
-
"""
|
|
1104
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1105
|
+
"""
|
|
1106
|
+
|
|
1107
|
+
:return: The RNA type or default when not found.
|
|
1108
|
+
:rtype: bpy.types.Struct
|
|
1109
|
+
"""
|
|
717
1110
|
...
|
|
718
1111
|
|
|
719
|
-
def bl_rna_get_subclass_py(self):
|
|
720
|
-
"""
|
|
1112
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1113
|
+
"""
|
|
1114
|
+
|
|
1115
|
+
:return: The class or default when not found.
|
|
1116
|
+
:rtype: typing.Any
|
|
1117
|
+
"""
|
|
721
1118
|
...
|
|
722
1119
|
|
|
723
1120
|
def draw(self, _context):
|
|
@@ -736,138 +1133,224 @@ class CONSOLE_MT_language(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
736
1133
|
...
|
|
737
1134
|
|
|
738
1135
|
def draw_preset(self, _context):
|
|
739
|
-
"""
|
|
1136
|
+
"""Define these on the subclass:
|
|
1137
|
+
- preset_operator (string)
|
|
1138
|
+
- preset_subdir (string)Optionally:
|
|
1139
|
+
- preset_add_operator (string)
|
|
1140
|
+
- preset_extensions (set of strings)
|
|
1141
|
+
- preset_operator_defaults (dict of keyword args)
|
|
740
1142
|
|
|
741
|
-
|
|
1143
|
+
:param _context:
|
|
742
1144
|
"""
|
|
743
1145
|
...
|
|
744
1146
|
|
|
745
|
-
def driver_add(self):
|
|
746
|
-
"""
|
|
1147
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1148
|
+
"""Adds driver(s) to the given property
|
|
1149
|
+
|
|
1150
|
+
:return: The driver(s) added.
|
|
1151
|
+
:rtype: bpy.types.FCurve
|
|
1152
|
+
"""
|
|
747
1153
|
...
|
|
748
1154
|
|
|
749
|
-
def driver_remove(self):
|
|
750
|
-
"""
|
|
1155
|
+
def driver_remove(self) -> bool:
|
|
1156
|
+
"""Remove driver(s) from the given property
|
|
1157
|
+
|
|
1158
|
+
:return: Success of driver removal.
|
|
1159
|
+
:rtype: bool
|
|
1160
|
+
"""
|
|
751
1161
|
...
|
|
752
1162
|
|
|
753
1163
|
def get(self):
|
|
754
|
-
"""
|
|
1164
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1165
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1166
|
+
|
|
1167
|
+
"""
|
|
755
1168
|
...
|
|
756
1169
|
|
|
757
1170
|
def id_properties_clear(self):
|
|
758
|
-
"""
|
|
1171
|
+
"""
|
|
1172
|
+
|
|
1173
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1174
|
+
"""
|
|
759
1175
|
...
|
|
760
1176
|
|
|
761
1177
|
def id_properties_ensure(self):
|
|
762
|
-
"""
|
|
1178
|
+
"""
|
|
1179
|
+
|
|
1180
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1181
|
+
"""
|
|
763
1182
|
...
|
|
764
1183
|
|
|
765
1184
|
def id_properties_ui(self):
|
|
766
|
-
"""
|
|
1185
|
+
"""
|
|
1186
|
+
|
|
1187
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1188
|
+
"""
|
|
767
1189
|
...
|
|
768
1190
|
|
|
769
1191
|
def is_extended(self):
|
|
770
1192
|
""" """
|
|
771
1193
|
...
|
|
772
1194
|
|
|
773
|
-
def is_property_hidden(self):
|
|
774
|
-
"""
|
|
1195
|
+
def is_property_hidden(self) -> bool:
|
|
1196
|
+
"""Check if a property is hidden.
|
|
1197
|
+
|
|
1198
|
+
:return: True when the property is hidden.
|
|
1199
|
+
:rtype: bool
|
|
1200
|
+
"""
|
|
775
1201
|
...
|
|
776
1202
|
|
|
777
|
-
def is_property_overridable_library(self):
|
|
778
|
-
"""
|
|
1203
|
+
def is_property_overridable_library(self) -> bool:
|
|
1204
|
+
"""Check if a property is overridable.
|
|
1205
|
+
|
|
1206
|
+
:return: True when the property is overridable.
|
|
1207
|
+
:rtype: bool
|
|
1208
|
+
"""
|
|
779
1209
|
...
|
|
780
1210
|
|
|
781
|
-
def is_property_readonly(self):
|
|
782
|
-
"""
|
|
1211
|
+
def is_property_readonly(self) -> bool:
|
|
1212
|
+
"""Check if a property is readonly.
|
|
1213
|
+
|
|
1214
|
+
:return: True when the property is readonly (not writable).
|
|
1215
|
+
:rtype: bool
|
|
1216
|
+
"""
|
|
783
1217
|
...
|
|
784
1218
|
|
|
785
|
-
def is_property_set(self):
|
|
786
|
-
"""
|
|
1219
|
+
def is_property_set(self) -> bool:
|
|
1220
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1221
|
+
|
|
1222
|
+
:return: True when the property has been set.
|
|
1223
|
+
:rtype: bool
|
|
1224
|
+
"""
|
|
787
1225
|
...
|
|
788
1226
|
|
|
789
1227
|
def items(self):
|
|
790
|
-
"""
|
|
1228
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1229
|
+
dictionary function of the same name).
|
|
1230
|
+
|
|
1231
|
+
:return: custom property key, value pairs.
|
|
1232
|
+
"""
|
|
791
1233
|
...
|
|
792
1234
|
|
|
793
|
-
def keyframe_delete(self):
|
|
794
|
-
"""
|
|
1235
|
+
def keyframe_delete(self) -> bool:
|
|
1236
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1237
|
+
|
|
1238
|
+
:return: Success of keyframe deletion.
|
|
1239
|
+
:rtype: bool
|
|
1240
|
+
"""
|
|
795
1241
|
...
|
|
796
1242
|
|
|
797
|
-
def keyframe_insert(self):
|
|
798
|
-
"""
|
|
1243
|
+
def keyframe_insert(self) -> bool:
|
|
1244
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1245
|
+
|
|
1246
|
+
:return: Success of keyframe insertion.
|
|
1247
|
+
:rtype: bool
|
|
1248
|
+
"""
|
|
799
1249
|
...
|
|
800
1250
|
|
|
801
1251
|
def keys(self):
|
|
802
|
-
"""
|
|
1252
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1253
|
+
dictionary function of the same name).
|
|
1254
|
+
|
|
1255
|
+
:return: custom property keys.
|
|
1256
|
+
"""
|
|
803
1257
|
...
|
|
804
1258
|
|
|
805
|
-
def path_from_id(self):
|
|
806
|
-
"""
|
|
1259
|
+
def path_from_id(self) -> str:
|
|
1260
|
+
"""Returns the data path from the ID to this object (string).
|
|
1261
|
+
|
|
1262
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1263
|
+
to this struct and property (when given).
|
|
1264
|
+
:rtype: str
|
|
1265
|
+
"""
|
|
807
1266
|
...
|
|
808
1267
|
|
|
809
1268
|
def path_menu(
|
|
810
1269
|
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,
|
|
1270
|
+
searchpaths: list[str],
|
|
1271
|
+
operator: str,
|
|
1272
|
+
props_default: dict = None,
|
|
1273
|
+
prop_filepath: str = "filepath",
|
|
1274
|
+
filter_ext: typing.Callable = None,
|
|
1275
|
+
filter_path=None,
|
|
1276
|
+
display_name: typing.Callable = None,
|
|
1277
|
+
add_operator=None,
|
|
1278
|
+
add_operator_props=None,
|
|
820
1279
|
):
|
|
821
|
-
"""
|
|
1280
|
+
"""Populate a menu from a list of paths.
|
|
822
1281
|
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
1282
|
+
:param searchpaths: Paths to scan.
|
|
1283
|
+
:type searchpaths: list[str]
|
|
1284
|
+
:param operator: The operator id to use with each file.
|
|
1285
|
+
:type operator: str
|
|
1286
|
+
:param props_default: Properties to assign to each operator.
|
|
1287
|
+
:type props_default: dict
|
|
1288
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1289
|
+
:type prop_filepath: str
|
|
1290
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1291
|
+
|
|
1292
|
+
Returning false excludes the file from the list.
|
|
1293
|
+
:type filter_ext: typing.Callable
|
|
1294
|
+
:param filter_path:
|
|
1295
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1296
|
+
:type display_name: typing.Callable
|
|
1297
|
+
:param add_operator:
|
|
1298
|
+
:param add_operator_props:
|
|
832
1299
|
"""
|
|
833
1300
|
...
|
|
834
1301
|
|
|
835
1302
|
def path_resolve(self):
|
|
836
|
-
""" """
|
|
1303
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
837
1304
|
...
|
|
838
1305
|
|
|
839
1306
|
def pop(self):
|
|
840
|
-
"""
|
|
1307
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1308
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1309
|
+
|
|
1310
|
+
"""
|
|
841
1311
|
...
|
|
842
1312
|
|
|
843
1313
|
def prepend(self, draw_func):
|
|
844
|
-
"""
|
|
1314
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1315
|
+
the menus draw function
|
|
845
1316
|
|
|
846
|
-
|
|
1317
|
+
:param draw_func:
|
|
847
1318
|
"""
|
|
848
1319
|
...
|
|
849
1320
|
|
|
850
|
-
def property_overridable_library_set(self):
|
|
851
|
-
"""
|
|
1321
|
+
def property_overridable_library_set(self) -> bool:
|
|
1322
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1323
|
+
|
|
1324
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1325
|
+
:rtype: bool
|
|
1326
|
+
"""
|
|
852
1327
|
...
|
|
853
1328
|
|
|
854
1329
|
def property_unset(self):
|
|
855
|
-
""" """
|
|
1330
|
+
"""Unset a property, will use default value afterward."""
|
|
856
1331
|
...
|
|
857
1332
|
|
|
858
1333
|
def remove(self, draw_func):
|
|
859
|
-
"""
|
|
1334
|
+
"""Remove a draw function that has been added to this menu
|
|
860
1335
|
|
|
861
1336
|
:param draw_func:
|
|
862
1337
|
"""
|
|
863
1338
|
...
|
|
864
1339
|
|
|
865
1340
|
def type_recast(self):
|
|
866
|
-
"""
|
|
1341
|
+
"""Return a new instance, this is needed because types
|
|
1342
|
+
such as textures can be changed at runtime.
|
|
1343
|
+
|
|
1344
|
+
:return: a new instance of this object with the type initialized again.
|
|
1345
|
+
"""
|
|
867
1346
|
...
|
|
868
1347
|
|
|
869
1348
|
def values(self):
|
|
870
|
-
"""
|
|
1349
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1350
|
+
dictionary function of the same name).
|
|
1351
|
+
|
|
1352
|
+
:return: custom property values.
|
|
1353
|
+
"""
|
|
871
1354
|
...
|
|
872
1355
|
|
|
873
1356
|
class CONSOLE_MT_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -883,22 +1366,35 @@ class CONSOLE_MT_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
883
1366
|
""" """
|
|
884
1367
|
|
|
885
1368
|
def append(self, draw_func):
|
|
886
|
-
"""
|
|
1369
|
+
"""Append a draw function to this menu,
|
|
1370
|
+
takes the same arguments as the menus draw function
|
|
887
1371
|
|
|
888
|
-
|
|
1372
|
+
:param draw_func:
|
|
889
1373
|
"""
|
|
890
1374
|
...
|
|
891
1375
|
|
|
892
|
-
def as_pointer(self):
|
|
893
|
-
"""
|
|
1376
|
+
def as_pointer(self) -> int:
|
|
1377
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1378
|
+
|
|
1379
|
+
:return: int (memory address).
|
|
1380
|
+
:rtype: int
|
|
1381
|
+
"""
|
|
894
1382
|
...
|
|
895
1383
|
|
|
896
|
-
def bl_rna_get_subclass(self):
|
|
897
|
-
"""
|
|
1384
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1385
|
+
"""
|
|
1386
|
+
|
|
1387
|
+
:return: The RNA type or default when not found.
|
|
1388
|
+
:rtype: bpy.types.Struct
|
|
1389
|
+
"""
|
|
898
1390
|
...
|
|
899
1391
|
|
|
900
|
-
def bl_rna_get_subclass_py(self):
|
|
901
|
-
"""
|
|
1392
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1393
|
+
"""
|
|
1394
|
+
|
|
1395
|
+
:return: The class or default when not found.
|
|
1396
|
+
:rtype: typing.Any
|
|
1397
|
+
"""
|
|
902
1398
|
...
|
|
903
1399
|
|
|
904
1400
|
def draw(self, _context):
|
|
@@ -917,138 +1413,224 @@ class CONSOLE_MT_view(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
917
1413
|
...
|
|
918
1414
|
|
|
919
1415
|
def draw_preset(self, _context):
|
|
920
|
-
"""
|
|
1416
|
+
"""Define these on the subclass:
|
|
1417
|
+
- preset_operator (string)
|
|
1418
|
+
- preset_subdir (string)Optionally:
|
|
1419
|
+
- preset_add_operator (string)
|
|
1420
|
+
- preset_extensions (set of strings)
|
|
1421
|
+
- preset_operator_defaults (dict of keyword args)
|
|
921
1422
|
|
|
922
|
-
|
|
1423
|
+
:param _context:
|
|
923
1424
|
"""
|
|
924
1425
|
...
|
|
925
1426
|
|
|
926
|
-
def driver_add(self):
|
|
927
|
-
"""
|
|
1427
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1428
|
+
"""Adds driver(s) to the given property
|
|
1429
|
+
|
|
1430
|
+
:return: The driver(s) added.
|
|
1431
|
+
:rtype: bpy.types.FCurve
|
|
1432
|
+
"""
|
|
928
1433
|
...
|
|
929
1434
|
|
|
930
|
-
def driver_remove(self):
|
|
931
|
-
"""
|
|
1435
|
+
def driver_remove(self) -> bool:
|
|
1436
|
+
"""Remove driver(s) from the given property
|
|
1437
|
+
|
|
1438
|
+
:return: Success of driver removal.
|
|
1439
|
+
:rtype: bool
|
|
1440
|
+
"""
|
|
932
1441
|
...
|
|
933
1442
|
|
|
934
1443
|
def get(self):
|
|
935
|
-
"""
|
|
1444
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1445
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1446
|
+
|
|
1447
|
+
"""
|
|
936
1448
|
...
|
|
937
1449
|
|
|
938
1450
|
def id_properties_clear(self):
|
|
939
|
-
"""
|
|
1451
|
+
"""
|
|
1452
|
+
|
|
1453
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1454
|
+
"""
|
|
940
1455
|
...
|
|
941
1456
|
|
|
942
1457
|
def id_properties_ensure(self):
|
|
943
|
-
"""
|
|
1458
|
+
"""
|
|
1459
|
+
|
|
1460
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1461
|
+
"""
|
|
944
1462
|
...
|
|
945
1463
|
|
|
946
1464
|
def id_properties_ui(self):
|
|
947
|
-
"""
|
|
1465
|
+
"""
|
|
1466
|
+
|
|
1467
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1468
|
+
"""
|
|
948
1469
|
...
|
|
949
1470
|
|
|
950
1471
|
def is_extended(self):
|
|
951
1472
|
""" """
|
|
952
1473
|
...
|
|
953
1474
|
|
|
954
|
-
def is_property_hidden(self):
|
|
955
|
-
"""
|
|
1475
|
+
def is_property_hidden(self) -> bool:
|
|
1476
|
+
"""Check if a property is hidden.
|
|
1477
|
+
|
|
1478
|
+
:return: True when the property is hidden.
|
|
1479
|
+
:rtype: bool
|
|
1480
|
+
"""
|
|
956
1481
|
...
|
|
957
1482
|
|
|
958
|
-
def is_property_overridable_library(self):
|
|
959
|
-
"""
|
|
1483
|
+
def is_property_overridable_library(self) -> bool:
|
|
1484
|
+
"""Check if a property is overridable.
|
|
1485
|
+
|
|
1486
|
+
:return: True when the property is overridable.
|
|
1487
|
+
:rtype: bool
|
|
1488
|
+
"""
|
|
960
1489
|
...
|
|
961
1490
|
|
|
962
|
-
def is_property_readonly(self):
|
|
963
|
-
"""
|
|
1491
|
+
def is_property_readonly(self) -> bool:
|
|
1492
|
+
"""Check if a property is readonly.
|
|
1493
|
+
|
|
1494
|
+
:return: True when the property is readonly (not writable).
|
|
1495
|
+
:rtype: bool
|
|
1496
|
+
"""
|
|
964
1497
|
...
|
|
965
1498
|
|
|
966
|
-
def is_property_set(self):
|
|
967
|
-
"""
|
|
1499
|
+
def is_property_set(self) -> bool:
|
|
1500
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1501
|
+
|
|
1502
|
+
:return: True when the property has been set.
|
|
1503
|
+
:rtype: bool
|
|
1504
|
+
"""
|
|
968
1505
|
...
|
|
969
1506
|
|
|
970
1507
|
def items(self):
|
|
971
|
-
"""
|
|
1508
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1509
|
+
dictionary function of the same name).
|
|
1510
|
+
|
|
1511
|
+
:return: custom property key, value pairs.
|
|
1512
|
+
"""
|
|
972
1513
|
...
|
|
973
1514
|
|
|
974
|
-
def keyframe_delete(self):
|
|
975
|
-
"""
|
|
1515
|
+
def keyframe_delete(self) -> bool:
|
|
1516
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1517
|
+
|
|
1518
|
+
:return: Success of keyframe deletion.
|
|
1519
|
+
:rtype: bool
|
|
1520
|
+
"""
|
|
976
1521
|
...
|
|
977
1522
|
|
|
978
|
-
def keyframe_insert(self):
|
|
979
|
-
"""
|
|
1523
|
+
def keyframe_insert(self) -> bool:
|
|
1524
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1525
|
+
|
|
1526
|
+
:return: Success of keyframe insertion.
|
|
1527
|
+
:rtype: bool
|
|
1528
|
+
"""
|
|
980
1529
|
...
|
|
981
1530
|
|
|
982
1531
|
def keys(self):
|
|
983
|
-
"""
|
|
1532
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1533
|
+
dictionary function of the same name).
|
|
1534
|
+
|
|
1535
|
+
:return: custom property keys.
|
|
1536
|
+
"""
|
|
984
1537
|
...
|
|
985
1538
|
|
|
986
|
-
def path_from_id(self):
|
|
987
|
-
"""
|
|
1539
|
+
def path_from_id(self) -> str:
|
|
1540
|
+
"""Returns the data path from the ID to this object (string).
|
|
1541
|
+
|
|
1542
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1543
|
+
to this struct and property (when given).
|
|
1544
|
+
:rtype: str
|
|
1545
|
+
"""
|
|
988
1546
|
...
|
|
989
1547
|
|
|
990
1548
|
def path_menu(
|
|
991
1549
|
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,
|
|
1550
|
+
searchpaths: list[str],
|
|
1551
|
+
operator: str,
|
|
1552
|
+
props_default: dict = None,
|
|
1553
|
+
prop_filepath: str = "filepath",
|
|
1554
|
+
filter_ext: typing.Callable = None,
|
|
1555
|
+
filter_path=None,
|
|
1556
|
+
display_name: typing.Callable = None,
|
|
1557
|
+
add_operator=None,
|
|
1558
|
+
add_operator_props=None,
|
|
1001
1559
|
):
|
|
1002
|
-
"""
|
|
1560
|
+
"""Populate a menu from a list of paths.
|
|
1003
1561
|
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1562
|
+
:param searchpaths: Paths to scan.
|
|
1563
|
+
:type searchpaths: list[str]
|
|
1564
|
+
:param operator: The operator id to use with each file.
|
|
1565
|
+
:type operator: str
|
|
1566
|
+
:param props_default: Properties to assign to each operator.
|
|
1567
|
+
:type props_default: dict
|
|
1568
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1569
|
+
:type prop_filepath: str
|
|
1570
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1571
|
+
|
|
1572
|
+
Returning false excludes the file from the list.
|
|
1573
|
+
:type filter_ext: typing.Callable
|
|
1574
|
+
:param filter_path:
|
|
1575
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1576
|
+
:type display_name: typing.Callable
|
|
1577
|
+
:param add_operator:
|
|
1578
|
+
:param add_operator_props:
|
|
1013
1579
|
"""
|
|
1014
1580
|
...
|
|
1015
1581
|
|
|
1016
1582
|
def path_resolve(self):
|
|
1017
|
-
""" """
|
|
1583
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1018
1584
|
...
|
|
1019
1585
|
|
|
1020
1586
|
def pop(self):
|
|
1021
|
-
"""
|
|
1587
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1588
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1589
|
+
|
|
1590
|
+
"""
|
|
1022
1591
|
...
|
|
1023
1592
|
|
|
1024
1593
|
def prepend(self, draw_func):
|
|
1025
|
-
"""
|
|
1594
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1595
|
+
the menus draw function
|
|
1026
1596
|
|
|
1027
|
-
|
|
1597
|
+
:param draw_func:
|
|
1028
1598
|
"""
|
|
1029
1599
|
...
|
|
1030
1600
|
|
|
1031
|
-
def property_overridable_library_set(self):
|
|
1032
|
-
"""
|
|
1601
|
+
def property_overridable_library_set(self) -> bool:
|
|
1602
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1603
|
+
|
|
1604
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1605
|
+
:rtype: bool
|
|
1606
|
+
"""
|
|
1033
1607
|
...
|
|
1034
1608
|
|
|
1035
1609
|
def property_unset(self):
|
|
1036
|
-
""" """
|
|
1610
|
+
"""Unset a property, will use default value afterward."""
|
|
1037
1611
|
...
|
|
1038
1612
|
|
|
1039
1613
|
def remove(self, draw_func):
|
|
1040
|
-
"""
|
|
1614
|
+
"""Remove a draw function that has been added to this menu
|
|
1041
1615
|
|
|
1042
1616
|
:param draw_func:
|
|
1043
1617
|
"""
|
|
1044
1618
|
...
|
|
1045
1619
|
|
|
1046
1620
|
def type_recast(self):
|
|
1047
|
-
"""
|
|
1621
|
+
"""Return a new instance, this is needed because types
|
|
1622
|
+
such as textures can be changed at runtime.
|
|
1623
|
+
|
|
1624
|
+
:return: a new instance of this object with the type initialized again.
|
|
1625
|
+
"""
|
|
1048
1626
|
...
|
|
1049
1627
|
|
|
1050
1628
|
def values(self):
|
|
1051
|
-
"""
|
|
1629
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1630
|
+
dictionary function of the same name).
|
|
1631
|
+
|
|
1632
|
+
:return: custom property values.
|
|
1633
|
+
"""
|
|
1052
1634
|
...
|
|
1053
1635
|
|
|
1054
1636
|
def add_scrollback(text, text_type):
|