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