fake-bpy-module 20240516__py3-none-any.whl → 20240518__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- _bpy_internal/freedesktop/__init__.pyi +17 -84
- addon_utils/__init__.pyi +44 -38
- animsys_refactor/__init__.pyi +7 -27
- aud/__init__.pyi +8 -11
- bgl/__init__.pyi +121 -1812
- bl_app_override/__init__.pyi +8 -19
- bl_app_override/helpers/__init__.pyi +5 -23
- bl_app_template_utils/__init__.pyi +5 -17
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
- bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
- bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
- bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
- bl_i18n_utils/merge_po/__init__.pyi +1 -4
- bl_i18n_utils/settings/__init__.pyi +6 -24
- bl_i18n_utils/utils/__init__.pyi +93 -122
- bl_i18n_utils/utils_cli/__init__.pyi +6 -29
- bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
- bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
- bl_keymap_utils/io/__init__.pyi +9 -40
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
- bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
- bl_keymap_utils/versioning/__init__.pyi +1 -4
- bl_operators/__init__.pyi +2 -9
- bl_operators/add_mesh_torus/__init__.pyi +128 -59
- bl_operators/anim/__init__.pyi +1001 -398
- bl_operators/assets/__init__.pyi +376 -152
- bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
- bl_operators/clip/__init__.pyi +1264 -532
- bl_operators/console/__init__.pyi +626 -242
- bl_operators/constraint/__init__.pyi +502 -201
- bl_operators/file/__init__.pyi +376 -150
- bl_operators/freestyle/__init__.pyi +501 -200
- bl_operators/geometry_nodes/__init__.pyi +514 -266
- bl_operators/image/__init__.pyi +621 -251
- bl_operators/mesh/__init__.pyi +376 -150
- bl_operators/node/__init__.pyi +1253 -516
- bl_operators/object/__init__.pyi +1879 -755
- bl_operators/object_align/__init__.pyi +129 -64
- bl_operators/object_quick_effects/__init__.pyi +504 -213
- bl_operators/object_randomize_transform/__init__.pyi +129 -54
- bl_operators/presets/__init__.pyi +3072 -1403
- bl_operators/rigidbody/__init__.pyi +376 -150
- bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
- bl_operators/sequencer/__init__.pyi +1010 -434
- bl_operators/spreadsheet/__init__.pyi +126 -50
- bl_operators/userpref/__init__.pyi +3253 -1267
- bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
- bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
- bl_operators/uvcalc_transform/__init__.pyi +297 -159
- bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
- bl_operators/view3d/__init__.pyi +868 -342
- bl_operators/wm/__init__.pyi +5795 -2388
- bl_operators/world/__init__.pyi +126 -50
- bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
- bl_rna_utils/data_path/__init__.pyi +8 -4
- bl_text_utils/external_editor/__init__.pyi +1 -4
- bl_ui/__init__.pyi +366 -269
- bl_ui/anim/__init__.pyi +164 -74
- bl_ui/asset_shelf/__init__.pyi +129 -56
- bl_ui/generic_ui_list/__init__.pyi +412 -163
- bl_ui/node_add_menu/__init__.pyi +171 -94
- bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
- bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
- bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
- bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
- bl_ui/properties_animviz/__init__.pyi +2 -16
- bl_ui/properties_collection/__init__.pyi +807 -379
- bl_ui/properties_constraint/__init__.pyi +10292 -4941
- bl_ui/properties_data_armature/__init__.pyi +1615 -753
- bl_ui/properties_data_bone/__init__.pyi +1284 -608
- bl_ui/properties_data_camera/__init__.pyi +1854 -927
- bl_ui/properties_data_curve/__init__.pyi +1927 -937
- bl_ui/properties_data_curves/__init__.pyi +806 -375
- bl_ui/properties_data_empty/__init__.pyi +257 -125
- bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
- bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
- bl_ui/properties_data_lattice/__init__.pyi +388 -188
- bl_ui/properties_data_light/__init__.pyi +1540 -756
- bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
- bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
- bl_ui/properties_data_metaball/__init__.pyi +644 -308
- bl_ui/properties_data_modifier/__init__.pyi +1353 -671
- bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
- bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
- bl_ui/properties_data_speaker/__init__.pyi +644 -316
- bl_ui/properties_data_volume/__init__.pyi +1028 -484
- bl_ui/properties_freestyle/__init__.pyi +3112 -1619
- bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
- bl_ui/properties_mask_common/__init__.pyi +1102 -523
- bl_ui/properties_material/__init__.pyi +2089 -1009
- bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
- bl_ui/properties_object/__init__.pyi +1832 -873
- bl_ui/properties_output/__init__.pyi +2405 -1173
- bl_ui/properties_paint_common/__init__.pyi +416 -386
- bl_ui/properties_particle/__init__.pyi +6740 -3346
- bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
- bl_ui/properties_physics_common/__init__.pyi +135 -98
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
- bl_ui/properties_physics_field/__init__.pyi +1282 -627
- bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
- bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
- bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
- bl_ui/properties_render/__init__.pyi +6843 -3367
- bl_ui/properties_scene/__init__.pyi +1924 -913
- bl_ui/properties_texture/__init__.pyi +3371 -1667
- bl_ui/properties_view_layer/__init__.pyi +2344 -1107
- bl_ui/properties_workspace/__init__.pyi +516 -244
- bl_ui/properties_world/__init__.pyi +1284 -630
- bl_ui/space_clip/__init__.pyi +10172 -4695
- bl_ui/space_console/__init__.pyi +940 -423
- bl_ui/space_dopesheet/__init__.pyi +4325 -2013
- bl_ui/space_filebrowser/__init__.pyi +4172 -1903
- bl_ui/space_graph/__init__.pyi +3107 -1394
- bl_ui/space_image/__init__.pyi +9764 -4614
- bl_ui/space_info/__init__.pyi +939 -421
- bl_ui/space_nla/__init__.pyi +2623 -1183
- bl_ui/space_node/__init__.pyi +3995 -1840
- bl_ui/space_outliner/__init__.pyi +2203 -991
- bl_ui/space_properties/__init__.pyi +386 -165
- bl_ui/space_sequencer/__init__.pyi +10809 -4978
- bl_ui/space_spreadsheet/__init__.pyi +130 -53
- bl_ui/space_statusbar/__init__.pyi +129 -52
- bl_ui/space_text/__init__.pyi +2457 -1100
- bl_ui/space_time/__init__.pyi +1034 -481
- bl_ui/space_toolsystem_common/__init__.pyi +56 -211
- bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
- bl_ui/space_topbar/__init__.pyi +3982 -1805
- bl_ui/space_userpref/__init__.pyi +11383 -5290
- bl_ui/space_view3d/__init__.pyi +40873 -18532
- bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
- bl_ui/temp_anim_layers/__init__.pyi +130 -62
- bl_ui/utils/__init__.pyi +28 -27
- bl_ui_utils/bug_report_url/__init__.pyi +1 -4
- bl_ui_utils/layout/__init__.pyi +1 -1
- blend_render_info/__init__.pyi +3 -10
- blf/__init__.pyi +4 -4
- bmesh/geometry/__init__.pyi +2 -3
- bmesh/ops/__init__.pyi +372 -419
- bmesh/types/__init__.pyi +39 -56
- bmesh/utils/__init__.pyi +10 -13
- bpy/app/__init__.pyi +4 -4
- bpy/app/handlers/__init__.pyi +36 -36
- bpy/app/icons/__init__.pyi +8 -8
- bpy/app/timers/__init__.pyi +10 -10
- bpy/app/translations/__init__.pyi +20 -22
- bpy/msgbus/__init__.pyi +2 -4
- bpy/ops/action/__init__.pyi +316 -394
- bpy/ops/anim/__init__.pyi +442 -548
- bpy/ops/armature/__init__.pyi +374 -470
- bpy/ops/asset/__init__.pyi +152 -184
- bpy/ops/bl_pkg/__init__.pyi +221 -272
- bpy/ops/boid/__init__.pyi +50 -66
- bpy/ops/brush/__init__.pyi +72 -90
- bpy/ops/buttons/__init__.pyi +132 -144
- bpy/ops/cachefile/__init__.pyi +128 -138
- bpy/ops/camera/__init__.pyi +26 -30
- bpy/ops/clip/__init__.pyi +777 -964
- bpy/ops/cloth/__init__.pyi +12 -14
- bpy/ops/collection/__init__.pyi +68 -86
- bpy/ops/console/__init__.pyi +158 -200
- bpy/ops/constraint/__init__.pyi +178 -214
- bpy/ops/curve/__init__.pyi +473 -576
- bpy/ops/curves/__init__.pyi +247 -302
- bpy/ops/cycles/__init__.pyi +28 -34
- bpy/ops/dpaint/__init__.pyi +34 -44
- bpy/ops/ed/__init__.pyi +126 -150
- bpy/ops/export_anim/__init__.pyi +22 -24
- bpy/ops/export_scene/__init__.pyi +302 -336
- bpy/ops/file/__init__.pyi +352 -432
- bpy/ops/fluid/__init__.pyi +90 -118
- bpy/ops/font/__init__.pyi +258 -304
- bpy/ops/geometry/__init__.pyi +100 -120
- bpy/ops/gizmogroup/__init__.pyi +22 -26
- bpy/ops/gpencil/__init__.pyi +1469 -1778
- bpy/ops/graph/__init__.pyi +644 -776
- bpy/ops/grease_pencil/__init__.pyi +597 -748
- bpy/ops/image/__init__.pyi +648 -744
- bpy/ops/import_anim/__init__.pyi +30 -32
- bpy/ops/import_curve/__init__.pyi +10 -12
- bpy/ops/import_scene/__init__.pyi +88 -96
- bpy/ops/info/__init__.pyi +60 -74
- bpy/ops/lattice/__init__.pyi +64 -80
- bpy/ops/marker/__init__.pyi +108 -130
- bpy/ops/mask/__init__.pyi +322 -402
- bpy/ops/material/__init__.pyi +18 -24
- bpy/ops/mball/__init__.pyi +70 -86
- bpy/ops/mesh/__init__.pyi +1986 -2322
- bpy/ops/nla/__init__.pyi +333 -411
- bpy/ops/node/__init__.pyi +886 -1100
- bpy/ops/object/__init__.pyi +2585 -3078
- bpy/ops/outliner/__init__.pyi +498 -636
- bpy/ops/paint/__init__.pyi +565 -680
- bpy/ops/paintcurve/__init__.pyi +64 -80
- bpy/ops/palette/__init__.pyi +50 -64
- bpy/ops/particle/__init__.pyi +267 -340
- bpy/ops/pose/__init__.pyi +336 -414
- bpy/ops/poselib/__init__.pyi +72 -90
- bpy/ops/preferences/__init__.pyi +386 -463
- bpy/ops/ptcache/__init__.pyi +46 -60
- bpy/ops/render/__init__.pyi +130 -154
- bpy/ops/rigidbody/__init__.pyi +102 -128
- bpy/ops/scene/__init__.pyi +280 -358
- bpy/ops/screen/__init__.pyi +382 -460
- bpy/ops/script/__init__.pyi +24 -30
- bpy/ops/sculpt/__init__.pyi +458 -532
- bpy/ops/sculpt_curves/__init__.pyi +41 -50
- bpy/ops/sequencer/__init__.pyi +1066 -1244
- bpy/ops/sound/__init__.pyi +216 -230
- bpy/ops/spreadsheet/__init__.pyi +30 -38
- bpy/ops/surface/__init__.pyi +108 -120
- bpy/ops/text/__init__.pyi +390 -476
- bpy/ops/text_editor/__init__.pyi +12 -14
- bpy/ops/texture/__init__.pyi +26 -34
- bpy/ops/transform/__init__.pyi +792 -878
- bpy/ops/ui/__init__.pyi +228 -294
- bpy/ops/uilist/__init__.pyi +32 -38
- bpy/ops/uv/__init__.pyi +602 -704
- bpy/ops/view2d/__init__.pyi +156 -184
- bpy/ops/view3d/__init__.pyi +582 -718
- bpy/ops/wm/__init__.pyi +2683 -2928
- bpy/ops/workspace/__init__.pyi +46 -60
- bpy/ops/world/__init__.pyi +12 -16
- bpy/path/__init__.pyi +179 -75
- bpy/props/__init__.pyi +261 -263
- bpy/types/__init__.pyi +17058 -26311
- bpy/utils/__init__.pyi +247 -179
- bpy/utils/previews/__init__.pyi +58 -28
- bpy/utils/units/__init__.pyi +20 -20
- bpy_extras/anim_utils/__init__.pyi +68 -29
- bpy_extras/asset_utils/__init__.pyi +0 -10
- bpy_extras/bmesh_utils/__init__.pyi +9 -6
- bpy_extras/extensions/junction_module/__init__.pyi +6 -8
- bpy_extras/id_map_utils/__init__.pyi +3 -3
- bpy_extras/image_utils/__init__.pyi +44 -11
- bpy_extras/io_utils/__init__.pyi +116 -41
- bpy_extras/keyconfig_utils/__init__.pyi +4 -11
- bpy_extras/mesh_utils/__init__.pyi +71 -19
- bpy_extras/node_shader_utils/__init__.pyi +52 -288
- bpy_extras/node_utils/__init__.pyi +10 -10
- bpy_extras/object_utils/__init__.pyi +71 -14
- bpy_extras/view3d_utils/__init__.pyi +80 -10
- bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
- bpy_restrict_state/__init__.pyi +1 -14
- bpy_types/__init__.pyi +4203 -1605
- console_python/__init__.pyi +12 -37
- console_shell/__init__.pyi +5 -24
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
- fake_bpy_module-20240518.dist-info/RECORD +353 -0
- freestyle/chainingiterators/__init__.pyi +14 -44
- freestyle/functions/__init__.pyi +7 -33
- freestyle/predicates/__init__.pyi +44 -217
- freestyle/shaders/__init__.pyi +2 -12
- freestyle/types/__init__.pyi +84 -96
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +6 -18
- gpu/matrix/__init__.pyi +6 -8
- gpu/state/__init__.pyi +2 -2
- gpu/types/__init__.pyi +12 -12
- gpu_extras/presets/__init__.pyi +2 -5
- graphviz_export/__init__.pyi +4 -9
- idprop/types/__init__.pyi +8 -35
- imbuf/__init__.pyi +4 -4
- imbuf/types/__init__.pyi +0 -2
- keyingsets_builtins/__init__.pyi +2692 -997
- keyingsets_utils/__init__.pyi +14 -69
- mathutils/__init__.pyi +194 -238
- mathutils/bvhtree/__init__.pyi +4 -6
- mathutils/geometry/__init__.pyi +153 -155
- mathutils/kdtree/__init__.pyi +8 -12
- mathutils/noise/__init__.pyi +26 -26
- nodeitems_builtins/__init__.pyi +5 -30
- nodeitems_utils/__init__.pyi +8 -45
- rna_info/__init__.pyi +39 -215
- rna_keymap_ui/__init__.pyi +6 -29
- rna_prop_ui/__init__.pyi +24 -62
- rna_xml/__init__.pyi +16 -39
- sys_info/__init__.pyi +1 -4
- _bpy_internal/freedesktop/py.typed +0 -0
- bl_app_override/helpers/py.typed +0 -0
- bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
- bl_console_utils/autocomplete/complete_import/py.typed +0 -0
- bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
- bl_console_utils/autocomplete/intellisense/py.typed +0 -0
- bl_console_utils/autocomplete/py.typed +0 -0
- bl_i18n_utils/bl_extract_messages/py.typed +0 -0
- bl_i18n_utils/merge_po/py.typed +0 -0
- bl_i18n_utils/settings/py.typed +0 -0
- bl_i18n_utils/utils/py.typed +0 -0
- bl_i18n_utils/utils_cli/py.typed +0 -0
- bl_i18n_utils/utils_languages_menu/py.typed +0 -0
- bl_i18n_utils/utils_rtl/py.typed +0 -0
- bl_keymap_utils/io/py.typed +0 -0
- bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
- bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
- bl_keymap_utils/platform_helpers/py.typed +0 -0
- bl_keymap_utils/versioning/py.typed +0 -0
- bl_operators/add_mesh_torus/py.typed +0 -0
- bl_operators/anim/py.typed +0 -0
- bl_operators/assets/py.typed +0 -0
- bl_operators/bmesh/find_adjacent/py.typed +0 -0
- bl_operators/bmesh/py.typed +0 -0
- bl_operators/clip/py.typed +0 -0
- bl_operators/console/py.typed +0 -0
- bl_operators/constraint/py.typed +0 -0
- bl_operators/file/py.typed +0 -0
- bl_operators/freestyle/py.typed +0 -0
- bl_operators/geometry_nodes/py.typed +0 -0
- bl_operators/image/py.typed +0 -0
- bl_operators/mesh/py.typed +0 -0
- bl_operators/node/py.typed +0 -0
- bl_operators/object/py.typed +0 -0
- bl_operators/object_align/py.typed +0 -0
- bl_operators/object_quick_effects/py.typed +0 -0
- bl_operators/object_randomize_transform/py.typed +0 -0
- bl_operators/presets/py.typed +0 -0
- bl_operators/rigidbody/py.typed +0 -0
- bl_operators/screen_play_rendered_anim/py.typed +0 -0
- bl_operators/sequencer/py.typed +0 -0
- bl_operators/spreadsheet/py.typed +0 -0
- bl_operators/userpref/py.typed +0 -0
- bl_operators/uvcalc_follow_active/py.typed +0 -0
- bl_operators/uvcalc_lightmap/py.typed +0 -0
- bl_operators/uvcalc_transform/py.typed +0 -0
- bl_operators/vertexpaint_dirt/py.typed +0 -0
- bl_operators/view3d/py.typed +0 -0
- bl_operators/wm/py.typed +0 -0
- bl_operators/world/py.typed +0 -0
- bl_previews_utils/bl_previews_render/py.typed +0 -0
- bl_rna_utils/data_path/py.typed +0 -0
- bl_text_utils/external_editor/py.typed +0 -0
- bl_ui/anim/py.typed +0 -0
- bl_ui/asset_shelf/py.typed +0 -0
- bl_ui/generic_ui_list/py.typed +0 -0
- bl_ui/node_add_menu/py.typed +0 -0
- bl_ui/node_add_menu_compositor/py.typed +0 -0
- bl_ui/node_add_menu_geometry/py.typed +0 -0
- bl_ui/node_add_menu_shader/py.typed +0 -0
- bl_ui/node_add_menu_texture/py.typed +0 -0
- bl_ui/properties_animviz/py.typed +0 -0
- bl_ui/properties_collection/py.typed +0 -0
- bl_ui/properties_constraint/py.typed +0 -0
- bl_ui/properties_data_armature/py.typed +0 -0
- bl_ui/properties_data_bone/py.typed +0 -0
- bl_ui/properties_data_camera/py.typed +0 -0
- bl_ui/properties_data_curve/py.typed +0 -0
- bl_ui/properties_data_curves/py.typed +0 -0
- bl_ui/properties_data_empty/py.typed +0 -0
- bl_ui/properties_data_gpencil/py.typed +0 -0
- bl_ui/properties_data_grease_pencil/py.typed +0 -0
- bl_ui/properties_data_lattice/py.typed +0 -0
- bl_ui/properties_data_light/py.typed +0 -0
- bl_ui/properties_data_lightprobe/py.typed +0 -0
- bl_ui/properties_data_mesh/py.typed +0 -0
- bl_ui/properties_data_metaball/py.typed +0 -0
- bl_ui/properties_data_modifier/py.typed +0 -0
- bl_ui/properties_data_pointcloud/py.typed +0 -0
- bl_ui/properties_data_shaderfx/py.typed +0 -0
- bl_ui/properties_data_speaker/py.typed +0 -0
- bl_ui/properties_data_volume/py.typed +0 -0
- bl_ui/properties_freestyle/py.typed +0 -0
- bl_ui/properties_grease_pencil_common/py.typed +0 -0
- bl_ui/properties_mask_common/py.typed +0 -0
- bl_ui/properties_material/py.typed +0 -0
- bl_ui/properties_material_gpencil/py.typed +0 -0
- bl_ui/properties_object/py.typed +0 -0
- bl_ui/properties_output/py.typed +0 -0
- bl_ui/properties_paint_common/py.typed +0 -0
- bl_ui/properties_particle/py.typed +0 -0
- bl_ui/properties_physics_cloth/py.typed +0 -0
- bl_ui/properties_physics_common/py.typed +0 -0
- bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
- bl_ui/properties_physics_field/py.typed +0 -0
- bl_ui/properties_physics_fluid/py.typed +0 -0
- bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
- bl_ui/properties_physics_rigidbody/py.typed +0 -0
- bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
- bl_ui/properties_physics_softbody/py.typed +0 -0
- bl_ui/properties_render/py.typed +0 -0
- bl_ui/properties_scene/py.typed +0 -0
- bl_ui/properties_texture/py.typed +0 -0
- bl_ui/properties_view_layer/py.typed +0 -0
- bl_ui/properties_workspace/py.typed +0 -0
- bl_ui/properties_world/py.typed +0 -0
- bl_ui/space_clip/py.typed +0 -0
- bl_ui/space_console/py.typed +0 -0
- bl_ui/space_dopesheet/py.typed +0 -0
- bl_ui/space_filebrowser/py.typed +0 -0
- bl_ui/space_graph/py.typed +0 -0
- bl_ui/space_image/py.typed +0 -0
- bl_ui/space_info/py.typed +0 -0
- bl_ui/space_nla/py.typed +0 -0
- bl_ui/space_node/py.typed +0 -0
- bl_ui/space_outliner/py.typed +0 -0
- bl_ui/space_properties/py.typed +0 -0
- bl_ui/space_sequencer/py.typed +0 -0
- bl_ui/space_spreadsheet/py.typed +0 -0
- bl_ui/space_statusbar/py.typed +0 -0
- bl_ui/space_text/py.typed +0 -0
- bl_ui/space_time/py.typed +0 -0
- bl_ui/space_toolsystem_common/py.typed +0 -0
- bl_ui/space_toolsystem_toolbar/py.typed +0 -0
- bl_ui/space_topbar/py.typed +0 -0
- bl_ui/space_userpref/py.typed +0 -0
- bl_ui/space_view3d/py.typed +0 -0
- bl_ui/space_view3d_toolbar/py.typed +0 -0
- bl_ui/temp_anim_layers/py.typed +0 -0
- bl_ui/utils/py.typed +0 -0
- bl_ui_utils/bug_report_url/py.typed +0 -0
- bl_ui_utils/layout/py.typed +0 -0
- bmesh/geometry/py.typed +0 -0
- bmesh/ops/py.typed +0 -0
- bmesh/types/py.typed +0 -0
- bmesh/utils/py.typed +0 -0
- bpy/app/handlers/py.typed +0 -0
- bpy/app/icons/py.typed +0 -0
- bpy/app/py.typed +0 -0
- bpy/app/timers/py.typed +0 -0
- bpy/app/translations/py.typed +0 -0
- bpy/msgbus/py.typed +0 -0
- bpy/ops/action/py.typed +0 -0
- bpy/ops/anim/py.typed +0 -0
- bpy/ops/armature/py.typed +0 -0
- bpy/ops/asset/py.typed +0 -0
- bpy/ops/bl_pkg/py.typed +0 -0
- bpy/ops/boid/py.typed +0 -0
- bpy/ops/brush/py.typed +0 -0
- bpy/ops/buttons/py.typed +0 -0
- bpy/ops/cachefile/py.typed +0 -0
- bpy/ops/camera/py.typed +0 -0
- bpy/ops/clip/py.typed +0 -0
- bpy/ops/cloth/py.typed +0 -0
- bpy/ops/collection/py.typed +0 -0
- bpy/ops/console/py.typed +0 -0
- bpy/ops/constraint/py.typed +0 -0
- bpy/ops/curve/py.typed +0 -0
- bpy/ops/curves/py.typed +0 -0
- bpy/ops/cycles/py.typed +0 -0
- bpy/ops/dpaint/py.typed +0 -0
- bpy/ops/ed/py.typed +0 -0
- bpy/ops/export_anim/py.typed +0 -0
- bpy/ops/export_scene/py.typed +0 -0
- bpy/ops/file/py.typed +0 -0
- bpy/ops/fluid/py.typed +0 -0
- bpy/ops/font/py.typed +0 -0
- bpy/ops/geometry/py.typed +0 -0
- bpy/ops/gizmogroup/py.typed +0 -0
- bpy/ops/gpencil/py.typed +0 -0
- bpy/ops/graph/py.typed +0 -0
- bpy/ops/grease_pencil/py.typed +0 -0
- bpy/ops/image/py.typed +0 -0
- bpy/ops/import_anim/py.typed +0 -0
- bpy/ops/import_curve/py.typed +0 -0
- bpy/ops/import_scene/py.typed +0 -0
- bpy/ops/info/py.typed +0 -0
- bpy/ops/lattice/py.typed +0 -0
- bpy/ops/marker/py.typed +0 -0
- bpy/ops/mask/py.typed +0 -0
- bpy/ops/material/py.typed +0 -0
- bpy/ops/mball/py.typed +0 -0
- bpy/ops/mesh/py.typed +0 -0
- bpy/ops/nla/py.typed +0 -0
- bpy/ops/node/py.typed +0 -0
- bpy/ops/object/py.typed +0 -0
- bpy/ops/outliner/py.typed +0 -0
- bpy/ops/paint/py.typed +0 -0
- bpy/ops/paintcurve/py.typed +0 -0
- bpy/ops/palette/py.typed +0 -0
- bpy/ops/particle/py.typed +0 -0
- bpy/ops/pose/py.typed +0 -0
- bpy/ops/poselib/py.typed +0 -0
- bpy/ops/preferences/py.typed +0 -0
- bpy/ops/ptcache/py.typed +0 -0
- bpy/ops/py.typed +0 -0
- bpy/ops/render/py.typed +0 -0
- bpy/ops/rigidbody/py.typed +0 -0
- bpy/ops/scene/py.typed +0 -0
- bpy/ops/screen/py.typed +0 -0
- bpy/ops/script/py.typed +0 -0
- bpy/ops/sculpt/py.typed +0 -0
- bpy/ops/sculpt_curves/py.typed +0 -0
- bpy/ops/sequencer/py.typed +0 -0
- bpy/ops/sound/py.typed +0 -0
- bpy/ops/spreadsheet/py.typed +0 -0
- bpy/ops/surface/py.typed +0 -0
- bpy/ops/text/py.typed +0 -0
- bpy/ops/text_editor/py.typed +0 -0
- bpy/ops/texture/py.typed +0 -0
- bpy/ops/transform/py.typed +0 -0
- bpy/ops/ui/py.typed +0 -0
- bpy/ops/uilist/py.typed +0 -0
- bpy/ops/uv/py.typed +0 -0
- bpy/ops/view2d/py.typed +0 -0
- bpy/ops/view3d/py.typed +0 -0
- bpy/ops/wm/py.typed +0 -0
- bpy/ops/workspace/py.typed +0 -0
- bpy/ops/world/py.typed +0 -0
- bpy/path/py.typed +0 -0
- bpy/props/py.typed +0 -0
- bpy/types/py.typed +0 -0
- bpy/utils/previews/py.typed +0 -0
- bpy/utils/py.typed +0 -0
- bpy/utils/units/py.typed +0 -0
- bpy_extras/anim_utils/py.typed +0 -0
- bpy_extras/asset_utils/py.typed +0 -0
- bpy_extras/bmesh_utils/py.typed +0 -0
- bpy_extras/extensions/junction_module/py.typed +0 -0
- bpy_extras/extensions/py.typed +0 -0
- bpy_extras/id_map_utils/py.typed +0 -0
- bpy_extras/image_utils/py.typed +0 -0
- bpy_extras/io_utils/py.typed +0 -0
- bpy_extras/keyconfig_utils/py.typed +0 -0
- bpy_extras/mesh_utils/py.typed +0 -0
- bpy_extras/node_shader_utils/py.typed +0 -0
- bpy_extras/node_utils/py.typed +0 -0
- bpy_extras/object_utils/py.typed +0 -0
- bpy_extras/view3d_utils/py.typed +0 -0
- bpy_extras/wm_utils/progress_report/py.typed +0 -0
- bpy_extras/wm_utils/py.typed +0 -0
- fake_bpy_module-20240516.dist-info/RECORD +0 -618
- freestyle/chainingiterators/py.typed +0 -0
- freestyle/functions/py.typed +0 -0
- freestyle/predicates/py.typed +0 -0
- freestyle/shaders/py.typed +0 -0
- freestyle/types/py.typed +0 -0
- freestyle/utils/ContextFunctions/py.typed +0 -0
- freestyle/utils/py.typed +0 -0
- gpu/capabilities/py.typed +0 -0
- gpu/matrix/py.typed +0 -0
- gpu/platform/py.typed +0 -0
- gpu/select/py.typed +0 -0
- gpu/shader/py.typed +0 -0
- gpu/state/py.typed +0 -0
- gpu/texture/py.typed +0 -0
- gpu/types/py.typed +0 -0
- gpu_extras/batch/py.typed +0 -0
- gpu_extras/presets/py.typed +0 -0
- idprop/types/py.typed +0 -0
- imbuf/types/py.typed +0 -0
- mathutils/bvhtree/py.typed +0 -0
- mathutils/geometry/py.typed +0 -0
- mathutils/interpolate/py.typed +0 -0
- mathutils/kdtree/py.typed +0 -0
- mathutils/noise/py.typed +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
|
@@ -1,43 +1,46 @@
|
|
|
1
1
|
import typing
|
|
2
|
+
import bpy.types
|
|
2
3
|
import bpy_types
|
|
3
4
|
|
|
4
5
|
GenericType = typing.TypeVar("GenericType")
|
|
5
6
|
|
|
6
7
|
class MASK_MT_add(bpy_types.Menu, bpy_types._GenericUI):
|
|
7
|
-
""" """
|
|
8
|
-
|
|
9
8
|
bl_idname: typing.Any
|
|
10
|
-
""" """
|
|
11
|
-
|
|
12
9
|
bl_label: typing.Any
|
|
13
|
-
""" """
|
|
14
|
-
|
|
15
10
|
bl_rna: typing.Any
|
|
16
|
-
""" """
|
|
17
|
-
|
|
18
11
|
bl_translation_context: typing.Any
|
|
19
|
-
""" """
|
|
20
|
-
|
|
21
12
|
id_data: typing.Any
|
|
22
|
-
""" """
|
|
23
13
|
|
|
24
14
|
def append(self, draw_func):
|
|
25
|
-
"""
|
|
15
|
+
"""Append a draw function to this menu,
|
|
16
|
+
takes the same arguments as the menus draw function
|
|
26
17
|
|
|
27
|
-
|
|
18
|
+
:param draw_func:
|
|
28
19
|
"""
|
|
29
20
|
...
|
|
30
21
|
|
|
31
|
-
def as_pointer(self):
|
|
32
|
-
"""
|
|
22
|
+
def as_pointer(self) -> int:
|
|
23
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
24
|
+
|
|
25
|
+
:return: int (memory address).
|
|
26
|
+
:rtype: int
|
|
27
|
+
"""
|
|
33
28
|
...
|
|
34
29
|
|
|
35
|
-
def bl_rna_get_subclass(self):
|
|
36
|
-
"""
|
|
30
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
:return: The RNA type or default when not found.
|
|
34
|
+
:rtype: bpy.types.Struct
|
|
35
|
+
"""
|
|
37
36
|
...
|
|
38
37
|
|
|
39
|
-
def bl_rna_get_subclass_py(self):
|
|
40
|
-
"""
|
|
38
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
39
|
+
"""
|
|
40
|
+
|
|
41
|
+
:return: The class or default when not found.
|
|
42
|
+
:rtype: typing.Any
|
|
43
|
+
"""
|
|
41
44
|
...
|
|
42
45
|
|
|
43
46
|
def draw(self, _context):
|
|
@@ -56,169 +59,258 @@ class MASK_MT_add(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
56
59
|
...
|
|
57
60
|
|
|
58
61
|
def draw_preset(self, _context):
|
|
59
|
-
"""
|
|
62
|
+
"""Define these on the subclass:
|
|
63
|
+
- preset_operator (string)
|
|
64
|
+
- preset_subdir (string)Optionally:
|
|
65
|
+
- preset_add_operator (string)
|
|
66
|
+
- preset_extensions (set of strings)
|
|
67
|
+
- preset_operator_defaults (dict of keyword args)
|
|
60
68
|
|
|
61
|
-
|
|
69
|
+
:param _context:
|
|
62
70
|
"""
|
|
63
71
|
...
|
|
64
72
|
|
|
65
|
-
def driver_add(self):
|
|
66
|
-
"""
|
|
73
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
74
|
+
"""Adds driver(s) to the given property
|
|
75
|
+
|
|
76
|
+
:return: The driver(s) added.
|
|
77
|
+
:rtype: bpy.types.FCurve
|
|
78
|
+
"""
|
|
67
79
|
...
|
|
68
80
|
|
|
69
|
-
def driver_remove(self):
|
|
70
|
-
"""
|
|
81
|
+
def driver_remove(self) -> bool:
|
|
82
|
+
"""Remove driver(s) from the given property
|
|
83
|
+
|
|
84
|
+
:return: Success of driver removal.
|
|
85
|
+
:rtype: bool
|
|
86
|
+
"""
|
|
71
87
|
...
|
|
72
88
|
|
|
73
89
|
def get(self):
|
|
74
|
-
"""
|
|
90
|
+
"""Returns the value of the custom property assigned to key or default
|
|
91
|
+
when not found (matches Python's dictionary function of the same name).
|
|
92
|
+
|
|
93
|
+
"""
|
|
75
94
|
...
|
|
76
95
|
|
|
77
96
|
def id_properties_clear(self):
|
|
78
|
-
"""
|
|
97
|
+
"""
|
|
98
|
+
|
|
99
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
100
|
+
"""
|
|
79
101
|
...
|
|
80
102
|
|
|
81
103
|
def id_properties_ensure(self):
|
|
82
|
-
"""
|
|
104
|
+
"""
|
|
105
|
+
|
|
106
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
107
|
+
"""
|
|
83
108
|
...
|
|
84
109
|
|
|
85
110
|
def id_properties_ui(self):
|
|
86
|
-
"""
|
|
87
|
-
...
|
|
111
|
+
"""
|
|
88
112
|
|
|
89
|
-
|
|
90
|
-
"""
|
|
113
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
114
|
+
"""
|
|
91
115
|
...
|
|
92
116
|
|
|
93
|
-
def
|
|
94
|
-
|
|
117
|
+
def is_extended(self): ...
|
|
118
|
+
def is_property_hidden(self) -> bool:
|
|
119
|
+
"""Check if a property is hidden.
|
|
120
|
+
|
|
121
|
+
:return: True when the property is hidden.
|
|
122
|
+
:rtype: bool
|
|
123
|
+
"""
|
|
95
124
|
...
|
|
96
125
|
|
|
97
|
-
def is_property_overridable_library(self):
|
|
98
|
-
"""
|
|
126
|
+
def is_property_overridable_library(self) -> bool:
|
|
127
|
+
"""Check if a property is overridable.
|
|
128
|
+
|
|
129
|
+
:return: True when the property is overridable.
|
|
130
|
+
:rtype: bool
|
|
131
|
+
"""
|
|
99
132
|
...
|
|
100
133
|
|
|
101
|
-
def is_property_readonly(self):
|
|
102
|
-
"""
|
|
134
|
+
def is_property_readonly(self) -> bool:
|
|
135
|
+
"""Check if a property is readonly.
|
|
136
|
+
|
|
137
|
+
:return: True when the property is readonly (not writable).
|
|
138
|
+
:rtype: bool
|
|
139
|
+
"""
|
|
103
140
|
...
|
|
104
141
|
|
|
105
|
-
def is_property_set(self):
|
|
106
|
-
"""
|
|
142
|
+
def is_property_set(self) -> bool:
|
|
143
|
+
"""Check if a property is set, use for testing operator properties.
|
|
144
|
+
|
|
145
|
+
:return: True when the property has been set.
|
|
146
|
+
:rtype: bool
|
|
147
|
+
"""
|
|
107
148
|
...
|
|
108
149
|
|
|
109
150
|
def items(self):
|
|
110
|
-
"""
|
|
151
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
152
|
+
dictionary function of the same name).
|
|
153
|
+
|
|
154
|
+
:return: custom property key, value pairs.
|
|
155
|
+
"""
|
|
111
156
|
...
|
|
112
157
|
|
|
113
|
-
def keyframe_delete(self):
|
|
114
|
-
"""
|
|
158
|
+
def keyframe_delete(self) -> bool:
|
|
159
|
+
"""Remove a keyframe from this properties fcurve.
|
|
160
|
+
|
|
161
|
+
:return: Success of keyframe deletion.
|
|
162
|
+
:rtype: bool
|
|
163
|
+
"""
|
|
115
164
|
...
|
|
116
165
|
|
|
117
|
-
def keyframe_insert(self):
|
|
118
|
-
"""
|
|
166
|
+
def keyframe_insert(self) -> bool:
|
|
167
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
168
|
+
|
|
169
|
+
:return: Success of keyframe insertion.
|
|
170
|
+
:rtype: bool
|
|
171
|
+
"""
|
|
119
172
|
...
|
|
120
173
|
|
|
121
174
|
def keys(self):
|
|
122
|
-
"""
|
|
175
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
176
|
+
dictionary function of the same name).
|
|
177
|
+
|
|
178
|
+
:return: custom property keys.
|
|
179
|
+
"""
|
|
123
180
|
...
|
|
124
181
|
|
|
125
|
-
def path_from_id(self):
|
|
126
|
-
"""
|
|
182
|
+
def path_from_id(self) -> str:
|
|
183
|
+
"""Returns the data path from the ID to this object (string).
|
|
184
|
+
|
|
185
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
186
|
+
to this struct and property (when given).
|
|
187
|
+
:rtype: str
|
|
188
|
+
"""
|
|
127
189
|
...
|
|
128
190
|
|
|
129
191
|
def path_menu(
|
|
130
192
|
self,
|
|
131
|
-
searchpaths,
|
|
132
|
-
operator,
|
|
133
|
-
props_default,
|
|
134
|
-
prop_filepath,
|
|
135
|
-
filter_ext,
|
|
136
|
-
filter_path,
|
|
137
|
-
display_name,
|
|
138
|
-
add_operator,
|
|
139
|
-
add_operator_props,
|
|
193
|
+
searchpaths: list[str],
|
|
194
|
+
operator: str,
|
|
195
|
+
props_default: dict = None,
|
|
196
|
+
prop_filepath: str = "filepath",
|
|
197
|
+
filter_ext: typing.Callable = None,
|
|
198
|
+
filter_path=None,
|
|
199
|
+
display_name: typing.Callable = None,
|
|
200
|
+
add_operator=None,
|
|
201
|
+
add_operator_props=None,
|
|
140
202
|
):
|
|
141
|
-
"""
|
|
203
|
+
"""Populate a menu from a list of paths.
|
|
204
|
+
|
|
205
|
+
:param searchpaths: Paths to scan.
|
|
206
|
+
:type searchpaths: list[str]
|
|
207
|
+
:param operator: The operator id to use with each file.
|
|
208
|
+
:type operator: str
|
|
209
|
+
:param props_default: Properties to assign to each operator.
|
|
210
|
+
:type props_default: dict
|
|
211
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
212
|
+
:type prop_filepath: str
|
|
213
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
142
214
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
:param add_operator:
|
|
151
|
-
:param add_operator_props:
|
|
215
|
+
Returning false excludes the file from the list.
|
|
216
|
+
:type filter_ext: typing.Callable
|
|
217
|
+
:param filter_path:
|
|
218
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
219
|
+
:type display_name: typing.Callable
|
|
220
|
+
:param add_operator:
|
|
221
|
+
:param add_operator_props:
|
|
152
222
|
"""
|
|
153
223
|
...
|
|
154
224
|
|
|
155
225
|
def path_resolve(self):
|
|
156
|
-
""" """
|
|
226
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
157
227
|
...
|
|
158
228
|
|
|
159
229
|
def pop(self):
|
|
160
|
-
"""
|
|
230
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
231
|
+
when not found (matches Python's dictionary function of the same name).
|
|
232
|
+
|
|
233
|
+
"""
|
|
161
234
|
...
|
|
162
235
|
|
|
163
236
|
def prepend(self, draw_func):
|
|
164
|
-
"""
|
|
237
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
238
|
+
the menus draw function
|
|
165
239
|
|
|
166
|
-
|
|
240
|
+
:param draw_func:
|
|
167
241
|
"""
|
|
168
242
|
...
|
|
169
243
|
|
|
170
|
-
def property_overridable_library_set(self):
|
|
171
|
-
"""
|
|
244
|
+
def property_overridable_library_set(self) -> bool:
|
|
245
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
246
|
+
|
|
247
|
+
:return: True when the overridable status of the property was successfully set.
|
|
248
|
+
:rtype: bool
|
|
249
|
+
"""
|
|
172
250
|
...
|
|
173
251
|
|
|
174
252
|
def property_unset(self):
|
|
175
|
-
""" """
|
|
253
|
+
"""Unset a property, will use default value afterward."""
|
|
176
254
|
...
|
|
177
255
|
|
|
178
256
|
def remove(self, draw_func):
|
|
179
|
-
"""
|
|
257
|
+
"""Remove a draw function that has been added to this menu
|
|
180
258
|
|
|
181
259
|
:param draw_func:
|
|
182
260
|
"""
|
|
183
261
|
...
|
|
184
262
|
|
|
185
263
|
def type_recast(self):
|
|
186
|
-
"""
|
|
264
|
+
"""Return a new instance, this is needed because types
|
|
265
|
+
such as textures can be changed at runtime.
|
|
266
|
+
|
|
267
|
+
:return: a new instance of this object with the type initialized again.
|
|
268
|
+
"""
|
|
187
269
|
...
|
|
188
270
|
|
|
189
271
|
def values(self):
|
|
190
|
-
"""
|
|
272
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
273
|
+
dictionary function of the same name).
|
|
274
|
+
|
|
275
|
+
:return: custom property values.
|
|
276
|
+
"""
|
|
191
277
|
...
|
|
192
278
|
|
|
193
279
|
class MASK_MT_animation(bpy_types.Menu, bpy_types._GenericUI):
|
|
194
|
-
""" """
|
|
195
|
-
|
|
196
280
|
bl_label: typing.Any
|
|
197
|
-
""" """
|
|
198
|
-
|
|
199
281
|
bl_rna: typing.Any
|
|
200
|
-
""" """
|
|
201
|
-
|
|
202
282
|
id_data: typing.Any
|
|
203
|
-
""" """
|
|
204
283
|
|
|
205
284
|
def append(self, draw_func):
|
|
206
|
-
"""
|
|
285
|
+
"""Append a draw function to this menu,
|
|
286
|
+
takes the same arguments as the menus draw function
|
|
207
287
|
|
|
208
|
-
|
|
288
|
+
:param draw_func:
|
|
209
289
|
"""
|
|
210
290
|
...
|
|
211
291
|
|
|
212
|
-
def as_pointer(self):
|
|
213
|
-
"""
|
|
292
|
+
def as_pointer(self) -> int:
|
|
293
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
294
|
+
|
|
295
|
+
:return: int (memory address).
|
|
296
|
+
:rtype: int
|
|
297
|
+
"""
|
|
214
298
|
...
|
|
215
299
|
|
|
216
|
-
def bl_rna_get_subclass(self):
|
|
217
|
-
"""
|
|
300
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
301
|
+
"""
|
|
302
|
+
|
|
303
|
+
:return: The RNA type or default when not found.
|
|
304
|
+
:rtype: bpy.types.Struct
|
|
305
|
+
"""
|
|
218
306
|
...
|
|
219
307
|
|
|
220
|
-
def bl_rna_get_subclass_py(self):
|
|
221
|
-
"""
|
|
308
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
309
|
+
"""
|
|
310
|
+
|
|
311
|
+
:return: The class or default when not found.
|
|
312
|
+
:rtype: typing.Any
|
|
313
|
+
"""
|
|
222
314
|
...
|
|
223
315
|
|
|
224
316
|
def draw(self, _context):
|
|
@@ -237,169 +329,258 @@ class MASK_MT_animation(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
237
329
|
...
|
|
238
330
|
|
|
239
331
|
def draw_preset(self, _context):
|
|
240
|
-
"""
|
|
332
|
+
"""Define these on the subclass:
|
|
333
|
+
- preset_operator (string)
|
|
334
|
+
- preset_subdir (string)Optionally:
|
|
335
|
+
- preset_add_operator (string)
|
|
336
|
+
- preset_extensions (set of strings)
|
|
337
|
+
- preset_operator_defaults (dict of keyword args)
|
|
241
338
|
|
|
242
|
-
|
|
339
|
+
:param _context:
|
|
243
340
|
"""
|
|
244
341
|
...
|
|
245
342
|
|
|
246
|
-
def driver_add(self):
|
|
247
|
-
"""
|
|
343
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
344
|
+
"""Adds driver(s) to the given property
|
|
345
|
+
|
|
346
|
+
:return: The driver(s) added.
|
|
347
|
+
:rtype: bpy.types.FCurve
|
|
348
|
+
"""
|
|
248
349
|
...
|
|
249
350
|
|
|
250
|
-
def driver_remove(self):
|
|
251
|
-
"""
|
|
351
|
+
def driver_remove(self) -> bool:
|
|
352
|
+
"""Remove driver(s) from the given property
|
|
353
|
+
|
|
354
|
+
:return: Success of driver removal.
|
|
355
|
+
:rtype: bool
|
|
356
|
+
"""
|
|
252
357
|
...
|
|
253
358
|
|
|
254
359
|
def get(self):
|
|
255
|
-
"""
|
|
360
|
+
"""Returns the value of the custom property assigned to key or default
|
|
361
|
+
when not found (matches Python's dictionary function of the same name).
|
|
362
|
+
|
|
363
|
+
"""
|
|
256
364
|
...
|
|
257
365
|
|
|
258
366
|
def id_properties_clear(self):
|
|
259
|
-
"""
|
|
367
|
+
"""
|
|
368
|
+
|
|
369
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
370
|
+
"""
|
|
260
371
|
...
|
|
261
372
|
|
|
262
373
|
def id_properties_ensure(self):
|
|
263
|
-
"""
|
|
374
|
+
"""
|
|
375
|
+
|
|
376
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
377
|
+
"""
|
|
264
378
|
...
|
|
265
379
|
|
|
266
380
|
def id_properties_ui(self):
|
|
267
|
-
"""
|
|
268
|
-
...
|
|
381
|
+
"""
|
|
269
382
|
|
|
270
|
-
|
|
271
|
-
"""
|
|
383
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
384
|
+
"""
|
|
272
385
|
...
|
|
273
386
|
|
|
274
|
-
def
|
|
275
|
-
|
|
387
|
+
def is_extended(self): ...
|
|
388
|
+
def is_property_hidden(self) -> bool:
|
|
389
|
+
"""Check if a property is hidden.
|
|
390
|
+
|
|
391
|
+
:return: True when the property is hidden.
|
|
392
|
+
:rtype: bool
|
|
393
|
+
"""
|
|
276
394
|
...
|
|
277
395
|
|
|
278
|
-
def is_property_overridable_library(self):
|
|
279
|
-
"""
|
|
396
|
+
def is_property_overridable_library(self) -> bool:
|
|
397
|
+
"""Check if a property is overridable.
|
|
398
|
+
|
|
399
|
+
:return: True when the property is overridable.
|
|
400
|
+
:rtype: bool
|
|
401
|
+
"""
|
|
280
402
|
...
|
|
281
403
|
|
|
282
|
-
def is_property_readonly(self):
|
|
283
|
-
"""
|
|
404
|
+
def is_property_readonly(self) -> bool:
|
|
405
|
+
"""Check if a property is readonly.
|
|
406
|
+
|
|
407
|
+
:return: True when the property is readonly (not writable).
|
|
408
|
+
:rtype: bool
|
|
409
|
+
"""
|
|
284
410
|
...
|
|
285
411
|
|
|
286
|
-
def is_property_set(self):
|
|
287
|
-
"""
|
|
412
|
+
def is_property_set(self) -> bool:
|
|
413
|
+
"""Check if a property is set, use for testing operator properties.
|
|
414
|
+
|
|
415
|
+
:return: True when the property has been set.
|
|
416
|
+
:rtype: bool
|
|
417
|
+
"""
|
|
288
418
|
...
|
|
289
419
|
|
|
290
420
|
def items(self):
|
|
291
|
-
"""
|
|
421
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
422
|
+
dictionary function of the same name).
|
|
423
|
+
|
|
424
|
+
:return: custom property key, value pairs.
|
|
425
|
+
"""
|
|
292
426
|
...
|
|
293
427
|
|
|
294
|
-
def keyframe_delete(self):
|
|
295
|
-
"""
|
|
428
|
+
def keyframe_delete(self) -> bool:
|
|
429
|
+
"""Remove a keyframe from this properties fcurve.
|
|
430
|
+
|
|
431
|
+
:return: Success of keyframe deletion.
|
|
432
|
+
:rtype: bool
|
|
433
|
+
"""
|
|
296
434
|
...
|
|
297
435
|
|
|
298
|
-
def keyframe_insert(self):
|
|
299
|
-
"""
|
|
436
|
+
def keyframe_insert(self) -> bool:
|
|
437
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
438
|
+
|
|
439
|
+
:return: Success of keyframe insertion.
|
|
440
|
+
:rtype: bool
|
|
441
|
+
"""
|
|
300
442
|
...
|
|
301
443
|
|
|
302
444
|
def keys(self):
|
|
303
|
-
"""
|
|
445
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
446
|
+
dictionary function of the same name).
|
|
447
|
+
|
|
448
|
+
:return: custom property keys.
|
|
449
|
+
"""
|
|
304
450
|
...
|
|
305
451
|
|
|
306
|
-
def path_from_id(self):
|
|
307
|
-
"""
|
|
452
|
+
def path_from_id(self) -> str:
|
|
453
|
+
"""Returns the data path from the ID to this object (string).
|
|
454
|
+
|
|
455
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
456
|
+
to this struct and property (when given).
|
|
457
|
+
:rtype: str
|
|
458
|
+
"""
|
|
308
459
|
...
|
|
309
460
|
|
|
310
461
|
def path_menu(
|
|
311
462
|
self,
|
|
312
|
-
searchpaths,
|
|
313
|
-
operator,
|
|
314
|
-
props_default,
|
|
315
|
-
prop_filepath,
|
|
316
|
-
filter_ext,
|
|
317
|
-
filter_path,
|
|
318
|
-
display_name,
|
|
319
|
-
add_operator,
|
|
320
|
-
add_operator_props,
|
|
463
|
+
searchpaths: list[str],
|
|
464
|
+
operator: str,
|
|
465
|
+
props_default: dict = None,
|
|
466
|
+
prop_filepath: str = "filepath",
|
|
467
|
+
filter_ext: typing.Callable = None,
|
|
468
|
+
filter_path=None,
|
|
469
|
+
display_name: typing.Callable = None,
|
|
470
|
+
add_operator=None,
|
|
471
|
+
add_operator_props=None,
|
|
321
472
|
):
|
|
322
|
-
"""
|
|
473
|
+
"""Populate a menu from a list of paths.
|
|
474
|
+
|
|
475
|
+
:param searchpaths: Paths to scan.
|
|
476
|
+
:type searchpaths: list[str]
|
|
477
|
+
:param operator: The operator id to use with each file.
|
|
478
|
+
:type operator: str
|
|
479
|
+
:param props_default: Properties to assign to each operator.
|
|
480
|
+
:type props_default: dict
|
|
481
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
482
|
+
:type prop_filepath: str
|
|
483
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
323
484
|
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
:param add_operator:
|
|
332
|
-
:param add_operator_props:
|
|
485
|
+
Returning false excludes the file from the list.
|
|
486
|
+
:type filter_ext: typing.Callable
|
|
487
|
+
:param filter_path:
|
|
488
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
489
|
+
:type display_name: typing.Callable
|
|
490
|
+
:param add_operator:
|
|
491
|
+
:param add_operator_props:
|
|
333
492
|
"""
|
|
334
493
|
...
|
|
335
494
|
|
|
336
495
|
def path_resolve(self):
|
|
337
|
-
""" """
|
|
496
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
338
497
|
...
|
|
339
498
|
|
|
340
499
|
def pop(self):
|
|
341
|
-
"""
|
|
500
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
501
|
+
when not found (matches Python's dictionary function of the same name).
|
|
502
|
+
|
|
503
|
+
"""
|
|
342
504
|
...
|
|
343
505
|
|
|
344
506
|
def prepend(self, draw_func):
|
|
345
|
-
"""
|
|
507
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
508
|
+
the menus draw function
|
|
346
509
|
|
|
347
|
-
|
|
510
|
+
:param draw_func:
|
|
348
511
|
"""
|
|
349
512
|
...
|
|
350
513
|
|
|
351
|
-
def property_overridable_library_set(self):
|
|
352
|
-
"""
|
|
514
|
+
def property_overridable_library_set(self) -> bool:
|
|
515
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
516
|
+
|
|
517
|
+
:return: True when the overridable status of the property was successfully set.
|
|
518
|
+
:rtype: bool
|
|
519
|
+
"""
|
|
353
520
|
...
|
|
354
521
|
|
|
355
522
|
def property_unset(self):
|
|
356
|
-
""" """
|
|
523
|
+
"""Unset a property, will use default value afterward."""
|
|
357
524
|
...
|
|
358
525
|
|
|
359
526
|
def remove(self, draw_func):
|
|
360
|
-
"""
|
|
527
|
+
"""Remove a draw function that has been added to this menu
|
|
361
528
|
|
|
362
529
|
:param draw_func:
|
|
363
530
|
"""
|
|
364
531
|
...
|
|
365
532
|
|
|
366
533
|
def type_recast(self):
|
|
367
|
-
"""
|
|
534
|
+
"""Return a new instance, this is needed because types
|
|
535
|
+
such as textures can be changed at runtime.
|
|
536
|
+
|
|
537
|
+
:return: a new instance of this object with the type initialized again.
|
|
538
|
+
"""
|
|
368
539
|
...
|
|
369
540
|
|
|
370
541
|
def values(self):
|
|
371
|
-
"""
|
|
542
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
543
|
+
dictionary function of the same name).
|
|
544
|
+
|
|
545
|
+
:return: custom property values.
|
|
546
|
+
"""
|
|
372
547
|
...
|
|
373
548
|
|
|
374
549
|
class MASK_MT_mask(bpy_types.Menu, bpy_types._GenericUI):
|
|
375
|
-
""" """
|
|
376
|
-
|
|
377
550
|
bl_label: typing.Any
|
|
378
|
-
""" """
|
|
379
|
-
|
|
380
551
|
bl_rna: typing.Any
|
|
381
|
-
""" """
|
|
382
|
-
|
|
383
552
|
id_data: typing.Any
|
|
384
|
-
""" """
|
|
385
553
|
|
|
386
554
|
def append(self, draw_func):
|
|
387
|
-
"""
|
|
555
|
+
"""Append a draw function to this menu,
|
|
556
|
+
takes the same arguments as the menus draw function
|
|
388
557
|
|
|
389
|
-
|
|
558
|
+
:param draw_func:
|
|
390
559
|
"""
|
|
391
560
|
...
|
|
392
561
|
|
|
393
|
-
def as_pointer(self):
|
|
394
|
-
"""
|
|
562
|
+
def as_pointer(self) -> int:
|
|
563
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
564
|
+
|
|
565
|
+
:return: int (memory address).
|
|
566
|
+
:rtype: int
|
|
567
|
+
"""
|
|
395
568
|
...
|
|
396
569
|
|
|
397
|
-
def bl_rna_get_subclass(self):
|
|
398
|
-
"""
|
|
570
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
571
|
+
"""
|
|
572
|
+
|
|
573
|
+
:return: The RNA type or default when not found.
|
|
574
|
+
:rtype: bpy.types.Struct
|
|
575
|
+
"""
|
|
399
576
|
...
|
|
400
577
|
|
|
401
|
-
def bl_rna_get_subclass_py(self):
|
|
402
|
-
"""
|
|
578
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
579
|
+
"""
|
|
580
|
+
|
|
581
|
+
:return: The class or default when not found.
|
|
582
|
+
:rtype: typing.Any
|
|
583
|
+
"""
|
|
403
584
|
...
|
|
404
585
|
|
|
405
586
|
def draw(self, _context):
|
|
@@ -418,169 +599,258 @@ class MASK_MT_mask(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
418
599
|
...
|
|
419
600
|
|
|
420
601
|
def draw_preset(self, _context):
|
|
421
|
-
"""
|
|
602
|
+
"""Define these on the subclass:
|
|
603
|
+
- preset_operator (string)
|
|
604
|
+
- preset_subdir (string)Optionally:
|
|
605
|
+
- preset_add_operator (string)
|
|
606
|
+
- preset_extensions (set of strings)
|
|
607
|
+
- preset_operator_defaults (dict of keyword args)
|
|
422
608
|
|
|
423
|
-
|
|
609
|
+
:param _context:
|
|
424
610
|
"""
|
|
425
611
|
...
|
|
426
612
|
|
|
427
|
-
def driver_add(self):
|
|
428
|
-
"""
|
|
613
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
614
|
+
"""Adds driver(s) to the given property
|
|
615
|
+
|
|
616
|
+
:return: The driver(s) added.
|
|
617
|
+
:rtype: bpy.types.FCurve
|
|
618
|
+
"""
|
|
429
619
|
...
|
|
430
620
|
|
|
431
|
-
def driver_remove(self):
|
|
432
|
-
"""
|
|
621
|
+
def driver_remove(self) -> bool:
|
|
622
|
+
"""Remove driver(s) from the given property
|
|
623
|
+
|
|
624
|
+
:return: Success of driver removal.
|
|
625
|
+
:rtype: bool
|
|
626
|
+
"""
|
|
433
627
|
...
|
|
434
628
|
|
|
435
629
|
def get(self):
|
|
436
|
-
"""
|
|
630
|
+
"""Returns the value of the custom property assigned to key or default
|
|
631
|
+
when not found (matches Python's dictionary function of the same name).
|
|
632
|
+
|
|
633
|
+
"""
|
|
437
634
|
...
|
|
438
635
|
|
|
439
636
|
def id_properties_clear(self):
|
|
440
|
-
"""
|
|
637
|
+
"""
|
|
638
|
+
|
|
639
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
640
|
+
"""
|
|
441
641
|
...
|
|
442
642
|
|
|
443
643
|
def id_properties_ensure(self):
|
|
444
|
-
"""
|
|
644
|
+
"""
|
|
645
|
+
|
|
646
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
647
|
+
"""
|
|
445
648
|
...
|
|
446
649
|
|
|
447
650
|
def id_properties_ui(self):
|
|
448
|
-
"""
|
|
449
|
-
...
|
|
651
|
+
"""
|
|
450
652
|
|
|
451
|
-
|
|
452
|
-
"""
|
|
653
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
654
|
+
"""
|
|
453
655
|
...
|
|
454
656
|
|
|
455
|
-
def
|
|
456
|
-
|
|
657
|
+
def is_extended(self): ...
|
|
658
|
+
def is_property_hidden(self) -> bool:
|
|
659
|
+
"""Check if a property is hidden.
|
|
660
|
+
|
|
661
|
+
:return: True when the property is hidden.
|
|
662
|
+
:rtype: bool
|
|
663
|
+
"""
|
|
457
664
|
...
|
|
458
665
|
|
|
459
|
-
def is_property_overridable_library(self):
|
|
460
|
-
"""
|
|
666
|
+
def is_property_overridable_library(self) -> bool:
|
|
667
|
+
"""Check if a property is overridable.
|
|
668
|
+
|
|
669
|
+
:return: True when the property is overridable.
|
|
670
|
+
:rtype: bool
|
|
671
|
+
"""
|
|
461
672
|
...
|
|
462
673
|
|
|
463
|
-
def is_property_readonly(self):
|
|
464
|
-
"""
|
|
674
|
+
def is_property_readonly(self) -> bool:
|
|
675
|
+
"""Check if a property is readonly.
|
|
676
|
+
|
|
677
|
+
:return: True when the property is readonly (not writable).
|
|
678
|
+
:rtype: bool
|
|
679
|
+
"""
|
|
465
680
|
...
|
|
466
681
|
|
|
467
|
-
def is_property_set(self):
|
|
468
|
-
"""
|
|
682
|
+
def is_property_set(self) -> bool:
|
|
683
|
+
"""Check if a property is set, use for testing operator properties.
|
|
684
|
+
|
|
685
|
+
:return: True when the property has been set.
|
|
686
|
+
:rtype: bool
|
|
687
|
+
"""
|
|
469
688
|
...
|
|
470
689
|
|
|
471
690
|
def items(self):
|
|
472
|
-
"""
|
|
691
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
692
|
+
dictionary function of the same name).
|
|
693
|
+
|
|
694
|
+
:return: custom property key, value pairs.
|
|
695
|
+
"""
|
|
473
696
|
...
|
|
474
697
|
|
|
475
|
-
def keyframe_delete(self):
|
|
476
|
-
"""
|
|
698
|
+
def keyframe_delete(self) -> bool:
|
|
699
|
+
"""Remove a keyframe from this properties fcurve.
|
|
700
|
+
|
|
701
|
+
:return: Success of keyframe deletion.
|
|
702
|
+
:rtype: bool
|
|
703
|
+
"""
|
|
477
704
|
...
|
|
478
705
|
|
|
479
|
-
def keyframe_insert(self):
|
|
480
|
-
"""
|
|
706
|
+
def keyframe_insert(self) -> bool:
|
|
707
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
708
|
+
|
|
709
|
+
:return: Success of keyframe insertion.
|
|
710
|
+
:rtype: bool
|
|
711
|
+
"""
|
|
481
712
|
...
|
|
482
713
|
|
|
483
714
|
def keys(self):
|
|
484
|
-
"""
|
|
715
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
716
|
+
dictionary function of the same name).
|
|
717
|
+
|
|
718
|
+
:return: custom property keys.
|
|
719
|
+
"""
|
|
485
720
|
...
|
|
486
721
|
|
|
487
|
-
def path_from_id(self):
|
|
488
|
-
"""
|
|
722
|
+
def path_from_id(self) -> str:
|
|
723
|
+
"""Returns the data path from the ID to this object (string).
|
|
724
|
+
|
|
725
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
726
|
+
to this struct and property (when given).
|
|
727
|
+
:rtype: str
|
|
728
|
+
"""
|
|
489
729
|
...
|
|
490
730
|
|
|
491
731
|
def path_menu(
|
|
492
732
|
self,
|
|
493
|
-
searchpaths,
|
|
494
|
-
operator,
|
|
495
|
-
props_default,
|
|
496
|
-
prop_filepath,
|
|
497
|
-
filter_ext,
|
|
498
|
-
filter_path,
|
|
499
|
-
display_name,
|
|
500
|
-
add_operator,
|
|
501
|
-
add_operator_props,
|
|
733
|
+
searchpaths: list[str],
|
|
734
|
+
operator: str,
|
|
735
|
+
props_default: dict = None,
|
|
736
|
+
prop_filepath: str = "filepath",
|
|
737
|
+
filter_ext: typing.Callable = None,
|
|
738
|
+
filter_path=None,
|
|
739
|
+
display_name: typing.Callable = None,
|
|
740
|
+
add_operator=None,
|
|
741
|
+
add_operator_props=None,
|
|
502
742
|
):
|
|
503
|
-
"""
|
|
743
|
+
"""Populate a menu from a list of paths.
|
|
504
744
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
745
|
+
:param searchpaths: Paths to scan.
|
|
746
|
+
:type searchpaths: list[str]
|
|
747
|
+
:param operator: The operator id to use with each file.
|
|
748
|
+
:type operator: str
|
|
749
|
+
:param props_default: Properties to assign to each operator.
|
|
750
|
+
:type props_default: dict
|
|
751
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
752
|
+
:type prop_filepath: str
|
|
753
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
754
|
+
|
|
755
|
+
Returning false excludes the file from the list.
|
|
756
|
+
:type filter_ext: typing.Callable
|
|
757
|
+
:param filter_path:
|
|
758
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
759
|
+
:type display_name: typing.Callable
|
|
760
|
+
:param add_operator:
|
|
761
|
+
:param add_operator_props:
|
|
514
762
|
"""
|
|
515
763
|
...
|
|
516
764
|
|
|
517
765
|
def path_resolve(self):
|
|
518
|
-
""" """
|
|
766
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
519
767
|
...
|
|
520
768
|
|
|
521
769
|
def pop(self):
|
|
522
|
-
"""
|
|
770
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
771
|
+
when not found (matches Python's dictionary function of the same name).
|
|
772
|
+
|
|
773
|
+
"""
|
|
523
774
|
...
|
|
524
775
|
|
|
525
776
|
def prepend(self, draw_func):
|
|
526
|
-
"""
|
|
777
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
778
|
+
the menus draw function
|
|
527
779
|
|
|
528
|
-
|
|
780
|
+
:param draw_func:
|
|
529
781
|
"""
|
|
530
782
|
...
|
|
531
783
|
|
|
532
|
-
def property_overridable_library_set(self):
|
|
533
|
-
"""
|
|
784
|
+
def property_overridable_library_set(self) -> bool:
|
|
785
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
786
|
+
|
|
787
|
+
:return: True when the overridable status of the property was successfully set.
|
|
788
|
+
:rtype: bool
|
|
789
|
+
"""
|
|
534
790
|
...
|
|
535
791
|
|
|
536
792
|
def property_unset(self):
|
|
537
|
-
""" """
|
|
793
|
+
"""Unset a property, will use default value afterward."""
|
|
538
794
|
...
|
|
539
795
|
|
|
540
796
|
def remove(self, draw_func):
|
|
541
|
-
"""
|
|
797
|
+
"""Remove a draw function that has been added to this menu
|
|
542
798
|
|
|
543
799
|
:param draw_func:
|
|
544
800
|
"""
|
|
545
801
|
...
|
|
546
802
|
|
|
547
803
|
def type_recast(self):
|
|
548
|
-
"""
|
|
804
|
+
"""Return a new instance, this is needed because types
|
|
805
|
+
such as textures can be changed at runtime.
|
|
806
|
+
|
|
807
|
+
:return: a new instance of this object with the type initialized again.
|
|
808
|
+
"""
|
|
549
809
|
...
|
|
550
810
|
|
|
551
811
|
def values(self):
|
|
552
|
-
"""
|
|
812
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
813
|
+
dictionary function of the same name).
|
|
814
|
+
|
|
815
|
+
:return: custom property values.
|
|
816
|
+
"""
|
|
553
817
|
...
|
|
554
818
|
|
|
555
819
|
class MASK_MT_select(bpy_types.Menu, bpy_types._GenericUI):
|
|
556
|
-
""" """
|
|
557
|
-
|
|
558
820
|
bl_label: typing.Any
|
|
559
|
-
""" """
|
|
560
|
-
|
|
561
821
|
bl_rna: typing.Any
|
|
562
|
-
""" """
|
|
563
|
-
|
|
564
822
|
id_data: typing.Any
|
|
565
|
-
""" """
|
|
566
823
|
|
|
567
824
|
def append(self, draw_func):
|
|
568
|
-
"""
|
|
825
|
+
"""Append a draw function to this menu,
|
|
826
|
+
takes the same arguments as the menus draw function
|
|
569
827
|
|
|
570
|
-
|
|
828
|
+
:param draw_func:
|
|
571
829
|
"""
|
|
572
830
|
...
|
|
573
831
|
|
|
574
|
-
def as_pointer(self):
|
|
575
|
-
"""
|
|
832
|
+
def as_pointer(self) -> int:
|
|
833
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
834
|
+
|
|
835
|
+
:return: int (memory address).
|
|
836
|
+
:rtype: int
|
|
837
|
+
"""
|
|
576
838
|
...
|
|
577
839
|
|
|
578
|
-
def bl_rna_get_subclass(self):
|
|
579
|
-
"""
|
|
840
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
841
|
+
"""
|
|
842
|
+
|
|
843
|
+
:return: The RNA type or default when not found.
|
|
844
|
+
:rtype: bpy.types.Struct
|
|
845
|
+
"""
|
|
580
846
|
...
|
|
581
847
|
|
|
582
|
-
def bl_rna_get_subclass_py(self):
|
|
583
|
-
"""
|
|
848
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
849
|
+
"""
|
|
850
|
+
|
|
851
|
+
:return: The class or default when not found.
|
|
852
|
+
:rtype: typing.Any
|
|
853
|
+
"""
|
|
584
854
|
...
|
|
585
855
|
|
|
586
856
|
def draw(self, _context):
|
|
@@ -599,169 +869,258 @@ class MASK_MT_select(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
599
869
|
...
|
|
600
870
|
|
|
601
871
|
def draw_preset(self, _context):
|
|
602
|
-
"""
|
|
872
|
+
"""Define these on the subclass:
|
|
873
|
+
- preset_operator (string)
|
|
874
|
+
- preset_subdir (string)Optionally:
|
|
875
|
+
- preset_add_operator (string)
|
|
876
|
+
- preset_extensions (set of strings)
|
|
877
|
+
- preset_operator_defaults (dict of keyword args)
|
|
603
878
|
|
|
604
|
-
|
|
879
|
+
:param _context:
|
|
605
880
|
"""
|
|
606
881
|
...
|
|
607
882
|
|
|
608
|
-
def driver_add(self):
|
|
609
|
-
"""
|
|
883
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
884
|
+
"""Adds driver(s) to the given property
|
|
885
|
+
|
|
886
|
+
:return: The driver(s) added.
|
|
887
|
+
:rtype: bpy.types.FCurve
|
|
888
|
+
"""
|
|
610
889
|
...
|
|
611
890
|
|
|
612
|
-
def driver_remove(self):
|
|
613
|
-
"""
|
|
891
|
+
def driver_remove(self) -> bool:
|
|
892
|
+
"""Remove driver(s) from the given property
|
|
893
|
+
|
|
894
|
+
:return: Success of driver removal.
|
|
895
|
+
:rtype: bool
|
|
896
|
+
"""
|
|
614
897
|
...
|
|
615
898
|
|
|
616
899
|
def get(self):
|
|
617
|
-
"""
|
|
900
|
+
"""Returns the value of the custom property assigned to key or default
|
|
901
|
+
when not found (matches Python's dictionary function of the same name).
|
|
902
|
+
|
|
903
|
+
"""
|
|
618
904
|
...
|
|
619
905
|
|
|
620
906
|
def id_properties_clear(self):
|
|
621
|
-
"""
|
|
907
|
+
"""
|
|
908
|
+
|
|
909
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
910
|
+
"""
|
|
622
911
|
...
|
|
623
912
|
|
|
624
913
|
def id_properties_ensure(self):
|
|
625
|
-
"""
|
|
914
|
+
"""
|
|
915
|
+
|
|
916
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
917
|
+
"""
|
|
626
918
|
...
|
|
627
919
|
|
|
628
920
|
def id_properties_ui(self):
|
|
629
|
-
"""
|
|
630
|
-
...
|
|
921
|
+
"""
|
|
631
922
|
|
|
632
|
-
|
|
633
|
-
"""
|
|
923
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
924
|
+
"""
|
|
634
925
|
...
|
|
635
926
|
|
|
636
|
-
def
|
|
637
|
-
|
|
927
|
+
def is_extended(self): ...
|
|
928
|
+
def is_property_hidden(self) -> bool:
|
|
929
|
+
"""Check if a property is hidden.
|
|
930
|
+
|
|
931
|
+
:return: True when the property is hidden.
|
|
932
|
+
:rtype: bool
|
|
933
|
+
"""
|
|
638
934
|
...
|
|
639
935
|
|
|
640
|
-
def is_property_overridable_library(self):
|
|
641
|
-
"""
|
|
936
|
+
def is_property_overridable_library(self) -> bool:
|
|
937
|
+
"""Check if a property is overridable.
|
|
938
|
+
|
|
939
|
+
:return: True when the property is overridable.
|
|
940
|
+
:rtype: bool
|
|
941
|
+
"""
|
|
642
942
|
...
|
|
643
943
|
|
|
644
|
-
def is_property_readonly(self):
|
|
645
|
-
"""
|
|
944
|
+
def is_property_readonly(self) -> bool:
|
|
945
|
+
"""Check if a property is readonly.
|
|
946
|
+
|
|
947
|
+
:return: True when the property is readonly (not writable).
|
|
948
|
+
:rtype: bool
|
|
949
|
+
"""
|
|
646
950
|
...
|
|
647
951
|
|
|
648
|
-
def is_property_set(self):
|
|
649
|
-
"""
|
|
952
|
+
def is_property_set(self) -> bool:
|
|
953
|
+
"""Check if a property is set, use for testing operator properties.
|
|
954
|
+
|
|
955
|
+
:return: True when the property has been set.
|
|
956
|
+
:rtype: bool
|
|
957
|
+
"""
|
|
650
958
|
...
|
|
651
959
|
|
|
652
960
|
def items(self):
|
|
653
|
-
"""
|
|
961
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
962
|
+
dictionary function of the same name).
|
|
963
|
+
|
|
964
|
+
:return: custom property key, value pairs.
|
|
965
|
+
"""
|
|
654
966
|
...
|
|
655
967
|
|
|
656
|
-
def keyframe_delete(self):
|
|
657
|
-
"""
|
|
968
|
+
def keyframe_delete(self) -> bool:
|
|
969
|
+
"""Remove a keyframe from this properties fcurve.
|
|
970
|
+
|
|
971
|
+
:return: Success of keyframe deletion.
|
|
972
|
+
:rtype: bool
|
|
973
|
+
"""
|
|
658
974
|
...
|
|
659
975
|
|
|
660
|
-
def keyframe_insert(self):
|
|
661
|
-
"""
|
|
976
|
+
def keyframe_insert(self) -> bool:
|
|
977
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
978
|
+
|
|
979
|
+
:return: Success of keyframe insertion.
|
|
980
|
+
:rtype: bool
|
|
981
|
+
"""
|
|
662
982
|
...
|
|
663
983
|
|
|
664
984
|
def keys(self):
|
|
665
|
-
"""
|
|
985
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
986
|
+
dictionary function of the same name).
|
|
987
|
+
|
|
988
|
+
:return: custom property keys.
|
|
989
|
+
"""
|
|
666
990
|
...
|
|
667
991
|
|
|
668
|
-
def path_from_id(self):
|
|
669
|
-
"""
|
|
992
|
+
def path_from_id(self) -> str:
|
|
993
|
+
"""Returns the data path from the ID to this object (string).
|
|
994
|
+
|
|
995
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
996
|
+
to this struct and property (when given).
|
|
997
|
+
:rtype: str
|
|
998
|
+
"""
|
|
670
999
|
...
|
|
671
1000
|
|
|
672
1001
|
def path_menu(
|
|
673
1002
|
self,
|
|
674
|
-
searchpaths,
|
|
675
|
-
operator,
|
|
676
|
-
props_default,
|
|
677
|
-
prop_filepath,
|
|
678
|
-
filter_ext,
|
|
679
|
-
filter_path,
|
|
680
|
-
display_name,
|
|
681
|
-
add_operator,
|
|
682
|
-
add_operator_props,
|
|
1003
|
+
searchpaths: list[str],
|
|
1004
|
+
operator: str,
|
|
1005
|
+
props_default: dict = None,
|
|
1006
|
+
prop_filepath: str = "filepath",
|
|
1007
|
+
filter_ext: typing.Callable = None,
|
|
1008
|
+
filter_path=None,
|
|
1009
|
+
display_name: typing.Callable = None,
|
|
1010
|
+
add_operator=None,
|
|
1011
|
+
add_operator_props=None,
|
|
683
1012
|
):
|
|
684
|
-
"""
|
|
1013
|
+
"""Populate a menu from a list of paths.
|
|
685
1014
|
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
1015
|
+
:param searchpaths: Paths to scan.
|
|
1016
|
+
:type searchpaths: list[str]
|
|
1017
|
+
:param operator: The operator id to use with each file.
|
|
1018
|
+
:type operator: str
|
|
1019
|
+
:param props_default: Properties to assign to each operator.
|
|
1020
|
+
:type props_default: dict
|
|
1021
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1022
|
+
:type prop_filepath: str
|
|
1023
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1024
|
+
|
|
1025
|
+
Returning false excludes the file from the list.
|
|
1026
|
+
:type filter_ext: typing.Callable
|
|
1027
|
+
:param filter_path:
|
|
1028
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1029
|
+
:type display_name: typing.Callable
|
|
1030
|
+
:param add_operator:
|
|
1031
|
+
:param add_operator_props:
|
|
695
1032
|
"""
|
|
696
1033
|
...
|
|
697
1034
|
|
|
698
1035
|
def path_resolve(self):
|
|
699
|
-
""" """
|
|
1036
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
700
1037
|
...
|
|
701
1038
|
|
|
702
1039
|
def pop(self):
|
|
703
|
-
"""
|
|
1040
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1041
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1042
|
+
|
|
1043
|
+
"""
|
|
704
1044
|
...
|
|
705
1045
|
|
|
706
1046
|
def prepend(self, draw_func):
|
|
707
|
-
"""
|
|
1047
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1048
|
+
the menus draw function
|
|
708
1049
|
|
|
709
|
-
|
|
1050
|
+
:param draw_func:
|
|
710
1051
|
"""
|
|
711
1052
|
...
|
|
712
1053
|
|
|
713
|
-
def property_overridable_library_set(self):
|
|
714
|
-
"""
|
|
1054
|
+
def property_overridable_library_set(self) -> bool:
|
|
1055
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1056
|
+
|
|
1057
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1058
|
+
:rtype: bool
|
|
1059
|
+
"""
|
|
715
1060
|
...
|
|
716
1061
|
|
|
717
1062
|
def property_unset(self):
|
|
718
|
-
""" """
|
|
1063
|
+
"""Unset a property, will use default value afterward."""
|
|
719
1064
|
...
|
|
720
1065
|
|
|
721
1066
|
def remove(self, draw_func):
|
|
722
|
-
"""
|
|
1067
|
+
"""Remove a draw function that has been added to this menu
|
|
723
1068
|
|
|
724
1069
|
:param draw_func:
|
|
725
1070
|
"""
|
|
726
1071
|
...
|
|
727
1072
|
|
|
728
1073
|
def type_recast(self):
|
|
729
|
-
"""
|
|
1074
|
+
"""Return a new instance, this is needed because types
|
|
1075
|
+
such as textures can be changed at runtime.
|
|
1076
|
+
|
|
1077
|
+
:return: a new instance of this object with the type initialized again.
|
|
1078
|
+
"""
|
|
730
1079
|
...
|
|
731
1080
|
|
|
732
1081
|
def values(self):
|
|
733
|
-
"""
|
|
1082
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1083
|
+
dictionary function of the same name).
|
|
1084
|
+
|
|
1085
|
+
:return: custom property values.
|
|
1086
|
+
"""
|
|
734
1087
|
...
|
|
735
1088
|
|
|
736
1089
|
class MASK_MT_transform(bpy_types.Menu, bpy_types._GenericUI):
|
|
737
|
-
""" """
|
|
738
|
-
|
|
739
1090
|
bl_label: typing.Any
|
|
740
|
-
""" """
|
|
741
|
-
|
|
742
1091
|
bl_rna: typing.Any
|
|
743
|
-
""" """
|
|
744
|
-
|
|
745
1092
|
id_data: typing.Any
|
|
746
|
-
""" """
|
|
747
1093
|
|
|
748
1094
|
def append(self, draw_func):
|
|
749
|
-
"""
|
|
1095
|
+
"""Append a draw function to this menu,
|
|
1096
|
+
takes the same arguments as the menus draw function
|
|
750
1097
|
|
|
751
|
-
|
|
1098
|
+
:param draw_func:
|
|
752
1099
|
"""
|
|
753
1100
|
...
|
|
754
1101
|
|
|
755
|
-
def as_pointer(self):
|
|
756
|
-
"""
|
|
1102
|
+
def as_pointer(self) -> int:
|
|
1103
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1104
|
+
|
|
1105
|
+
:return: int (memory address).
|
|
1106
|
+
:rtype: int
|
|
1107
|
+
"""
|
|
757
1108
|
...
|
|
758
1109
|
|
|
759
|
-
def bl_rna_get_subclass(self):
|
|
760
|
-
"""
|
|
1110
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1111
|
+
"""
|
|
1112
|
+
|
|
1113
|
+
:return: The RNA type or default when not found.
|
|
1114
|
+
:rtype: bpy.types.Struct
|
|
1115
|
+
"""
|
|
761
1116
|
...
|
|
762
1117
|
|
|
763
|
-
def bl_rna_get_subclass_py(self):
|
|
764
|
-
"""
|
|
1118
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1119
|
+
"""
|
|
1120
|
+
|
|
1121
|
+
:return: The class or default when not found.
|
|
1122
|
+
:rtype: typing.Any
|
|
1123
|
+
"""
|
|
765
1124
|
...
|
|
766
1125
|
|
|
767
1126
|
def draw(self, _context):
|
|
@@ -780,169 +1139,258 @@ class MASK_MT_transform(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
780
1139
|
...
|
|
781
1140
|
|
|
782
1141
|
def draw_preset(self, _context):
|
|
783
|
-
"""
|
|
1142
|
+
"""Define these on the subclass:
|
|
1143
|
+
- preset_operator (string)
|
|
1144
|
+
- preset_subdir (string)Optionally:
|
|
1145
|
+
- preset_add_operator (string)
|
|
1146
|
+
- preset_extensions (set of strings)
|
|
1147
|
+
- preset_operator_defaults (dict of keyword args)
|
|
784
1148
|
|
|
785
|
-
|
|
1149
|
+
:param _context:
|
|
786
1150
|
"""
|
|
787
1151
|
...
|
|
788
1152
|
|
|
789
|
-
def driver_add(self):
|
|
790
|
-
"""
|
|
1153
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1154
|
+
"""Adds driver(s) to the given property
|
|
1155
|
+
|
|
1156
|
+
:return: The driver(s) added.
|
|
1157
|
+
:rtype: bpy.types.FCurve
|
|
1158
|
+
"""
|
|
791
1159
|
...
|
|
792
1160
|
|
|
793
|
-
def driver_remove(self):
|
|
794
|
-
"""
|
|
1161
|
+
def driver_remove(self) -> bool:
|
|
1162
|
+
"""Remove driver(s) from the given property
|
|
1163
|
+
|
|
1164
|
+
:return: Success of driver removal.
|
|
1165
|
+
:rtype: bool
|
|
1166
|
+
"""
|
|
795
1167
|
...
|
|
796
1168
|
|
|
797
1169
|
def get(self):
|
|
798
|
-
"""
|
|
1170
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1171
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1172
|
+
|
|
1173
|
+
"""
|
|
799
1174
|
...
|
|
800
1175
|
|
|
801
1176
|
def id_properties_clear(self):
|
|
802
|
-
"""
|
|
1177
|
+
"""
|
|
1178
|
+
|
|
1179
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1180
|
+
"""
|
|
803
1181
|
...
|
|
804
1182
|
|
|
805
1183
|
def id_properties_ensure(self):
|
|
806
|
-
"""
|
|
1184
|
+
"""
|
|
1185
|
+
|
|
1186
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1187
|
+
"""
|
|
807
1188
|
...
|
|
808
1189
|
|
|
809
1190
|
def id_properties_ui(self):
|
|
810
|
-
"""
|
|
811
|
-
...
|
|
1191
|
+
"""
|
|
812
1192
|
|
|
813
|
-
|
|
814
|
-
"""
|
|
1193
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1194
|
+
"""
|
|
815
1195
|
...
|
|
816
1196
|
|
|
817
|
-
def
|
|
818
|
-
|
|
1197
|
+
def is_extended(self): ...
|
|
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
|
+
"""
|
|
819
1204
|
...
|
|
820
1205
|
|
|
821
|
-
def is_property_overridable_library(self):
|
|
822
|
-
"""
|
|
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
|
+
"""
|
|
823
1212
|
...
|
|
824
1213
|
|
|
825
|
-
def is_property_readonly(self):
|
|
826
|
-
"""
|
|
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
|
+
"""
|
|
827
1220
|
...
|
|
828
1221
|
|
|
829
|
-
def is_property_set(self):
|
|
830
|
-
"""
|
|
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
|
+
"""
|
|
831
1228
|
...
|
|
832
1229
|
|
|
833
1230
|
def items(self):
|
|
834
|
-
"""
|
|
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
|
+
"""
|
|
835
1236
|
...
|
|
836
1237
|
|
|
837
|
-
def keyframe_delete(self):
|
|
838
|
-
"""
|
|
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
|
+
"""
|
|
839
1244
|
...
|
|
840
1245
|
|
|
841
|
-
def keyframe_insert(self):
|
|
842
|
-
"""
|
|
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
|
+
"""
|
|
843
1252
|
...
|
|
844
1253
|
|
|
845
1254
|
def keys(self):
|
|
846
|
-
"""
|
|
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
|
+
"""
|
|
847
1260
|
...
|
|
848
1261
|
|
|
849
|
-
def path_from_id(self):
|
|
850
|
-
"""
|
|
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
|
+
"""
|
|
851
1269
|
...
|
|
852
1270
|
|
|
853
1271
|
def path_menu(
|
|
854
1272
|
self,
|
|
855
|
-
searchpaths,
|
|
856
|
-
operator,
|
|
857
|
-
props_default,
|
|
858
|
-
prop_filepath,
|
|
859
|
-
filter_ext,
|
|
860
|
-
filter_path,
|
|
861
|
-
display_name,
|
|
862
|
-
add_operator,
|
|
863
|
-
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,
|
|
864
1282
|
):
|
|
865
|
-
"""
|
|
1283
|
+
"""Populate a menu from a list of paths.
|
|
1284
|
+
|
|
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.
|
|
866
1294
|
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
:param add_operator:
|
|
875
|
-
:param add_operator_props:
|
|
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:
|
|
876
1302
|
"""
|
|
877
1303
|
...
|
|
878
1304
|
|
|
879
1305
|
def path_resolve(self):
|
|
880
|
-
""" """
|
|
1306
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
881
1307
|
...
|
|
882
1308
|
|
|
883
1309
|
def pop(self):
|
|
884
|
-
"""
|
|
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
|
+
"""
|
|
885
1314
|
...
|
|
886
1315
|
|
|
887
1316
|
def prepend(self, draw_func):
|
|
888
|
-
"""
|
|
1317
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1318
|
+
the menus draw function
|
|
889
1319
|
|
|
890
|
-
|
|
1320
|
+
:param draw_func:
|
|
891
1321
|
"""
|
|
892
1322
|
...
|
|
893
1323
|
|
|
894
|
-
def property_overridable_library_set(self):
|
|
895
|
-
"""
|
|
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
|
+
"""
|
|
896
1330
|
...
|
|
897
1331
|
|
|
898
1332
|
def property_unset(self):
|
|
899
|
-
""" """
|
|
1333
|
+
"""Unset a property, will use default value afterward."""
|
|
900
1334
|
...
|
|
901
1335
|
|
|
902
1336
|
def remove(self, draw_func):
|
|
903
|
-
"""
|
|
1337
|
+
"""Remove a draw function that has been added to this menu
|
|
904
1338
|
|
|
905
1339
|
:param draw_func:
|
|
906
1340
|
"""
|
|
907
1341
|
...
|
|
908
1342
|
|
|
909
1343
|
def type_recast(self):
|
|
910
|
-
"""
|
|
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
|
+
"""
|
|
911
1349
|
...
|
|
912
1350
|
|
|
913
1351
|
def values(self):
|
|
914
|
-
"""
|
|
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
|
+
"""
|
|
915
1357
|
...
|
|
916
1358
|
|
|
917
1359
|
class MASK_MT_visibility(bpy_types.Menu, bpy_types._GenericUI):
|
|
918
|
-
""" """
|
|
919
|
-
|
|
920
1360
|
bl_label: typing.Any
|
|
921
|
-
""" """
|
|
922
|
-
|
|
923
1361
|
bl_rna: typing.Any
|
|
924
|
-
""" """
|
|
925
|
-
|
|
926
1362
|
id_data: typing.Any
|
|
927
|
-
""" """
|
|
928
1363
|
|
|
929
1364
|
def append(self, draw_func):
|
|
930
|
-
"""
|
|
1365
|
+
"""Append a draw function to this menu,
|
|
1366
|
+
takes the same arguments as the menus draw function
|
|
931
1367
|
|
|
932
|
-
|
|
1368
|
+
:param draw_func:
|
|
933
1369
|
"""
|
|
934
1370
|
...
|
|
935
1371
|
|
|
936
|
-
def as_pointer(self):
|
|
937
|
-
"""
|
|
1372
|
+
def as_pointer(self) -> int:
|
|
1373
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1374
|
+
|
|
1375
|
+
:return: int (memory address).
|
|
1376
|
+
:rtype: int
|
|
1377
|
+
"""
|
|
938
1378
|
...
|
|
939
1379
|
|
|
940
|
-
def bl_rna_get_subclass(self):
|
|
941
|
-
"""
|
|
1380
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1381
|
+
"""
|
|
1382
|
+
|
|
1383
|
+
:return: The RNA type or default when not found.
|
|
1384
|
+
:rtype: bpy.types.Struct
|
|
1385
|
+
"""
|
|
942
1386
|
...
|
|
943
1387
|
|
|
944
|
-
def bl_rna_get_subclass_py(self):
|
|
945
|
-
"""
|
|
1388
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1389
|
+
"""
|
|
1390
|
+
|
|
1391
|
+
:return: The class or default when not found.
|
|
1392
|
+
:rtype: typing.Any
|
|
1393
|
+
"""
|
|
946
1394
|
...
|
|
947
1395
|
|
|
948
1396
|
def draw(self, _context):
|
|
@@ -961,145 +1409,225 @@ class MASK_MT_visibility(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
961
1409
|
...
|
|
962
1410
|
|
|
963
1411
|
def draw_preset(self, _context):
|
|
964
|
-
"""
|
|
1412
|
+
"""Define these on the subclass:
|
|
1413
|
+
- preset_operator (string)
|
|
1414
|
+
- preset_subdir (string)Optionally:
|
|
1415
|
+
- preset_add_operator (string)
|
|
1416
|
+
- preset_extensions (set of strings)
|
|
1417
|
+
- preset_operator_defaults (dict of keyword args)
|
|
965
1418
|
|
|
966
|
-
|
|
1419
|
+
:param _context:
|
|
967
1420
|
"""
|
|
968
1421
|
...
|
|
969
1422
|
|
|
970
|
-
def driver_add(self):
|
|
971
|
-
"""
|
|
1423
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1424
|
+
"""Adds driver(s) to the given property
|
|
1425
|
+
|
|
1426
|
+
:return: The driver(s) added.
|
|
1427
|
+
:rtype: bpy.types.FCurve
|
|
1428
|
+
"""
|
|
972
1429
|
...
|
|
973
1430
|
|
|
974
|
-
def driver_remove(self):
|
|
975
|
-
"""
|
|
1431
|
+
def driver_remove(self) -> bool:
|
|
1432
|
+
"""Remove driver(s) from the given property
|
|
1433
|
+
|
|
1434
|
+
:return: Success of driver removal.
|
|
1435
|
+
:rtype: bool
|
|
1436
|
+
"""
|
|
976
1437
|
...
|
|
977
1438
|
|
|
978
1439
|
def get(self):
|
|
979
|
-
"""
|
|
1440
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1441
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1442
|
+
|
|
1443
|
+
"""
|
|
980
1444
|
...
|
|
981
1445
|
|
|
982
1446
|
def id_properties_clear(self):
|
|
983
|
-
"""
|
|
1447
|
+
"""
|
|
1448
|
+
|
|
1449
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1450
|
+
"""
|
|
984
1451
|
...
|
|
985
1452
|
|
|
986
1453
|
def id_properties_ensure(self):
|
|
987
|
-
"""
|
|
1454
|
+
"""
|
|
1455
|
+
|
|
1456
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1457
|
+
"""
|
|
988
1458
|
...
|
|
989
1459
|
|
|
990
1460
|
def id_properties_ui(self):
|
|
991
|
-
"""
|
|
992
|
-
...
|
|
1461
|
+
"""
|
|
993
1462
|
|
|
994
|
-
|
|
995
|
-
"""
|
|
1463
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1464
|
+
"""
|
|
996
1465
|
...
|
|
997
1466
|
|
|
998
|
-
def
|
|
999
|
-
|
|
1467
|
+
def is_extended(self): ...
|
|
1468
|
+
def is_property_hidden(self) -> bool:
|
|
1469
|
+
"""Check if a property is hidden.
|
|
1470
|
+
|
|
1471
|
+
:return: True when the property is hidden.
|
|
1472
|
+
:rtype: bool
|
|
1473
|
+
"""
|
|
1000
1474
|
...
|
|
1001
1475
|
|
|
1002
|
-
def is_property_overridable_library(self):
|
|
1003
|
-
"""
|
|
1476
|
+
def is_property_overridable_library(self) -> bool:
|
|
1477
|
+
"""Check if a property is overridable.
|
|
1478
|
+
|
|
1479
|
+
:return: True when the property is overridable.
|
|
1480
|
+
:rtype: bool
|
|
1481
|
+
"""
|
|
1004
1482
|
...
|
|
1005
1483
|
|
|
1006
|
-
def is_property_readonly(self):
|
|
1007
|
-
"""
|
|
1484
|
+
def is_property_readonly(self) -> bool:
|
|
1485
|
+
"""Check if a property is readonly.
|
|
1486
|
+
|
|
1487
|
+
:return: True when the property is readonly (not writable).
|
|
1488
|
+
:rtype: bool
|
|
1489
|
+
"""
|
|
1008
1490
|
...
|
|
1009
1491
|
|
|
1010
|
-
def is_property_set(self):
|
|
1011
|
-
"""
|
|
1492
|
+
def is_property_set(self) -> bool:
|
|
1493
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1494
|
+
|
|
1495
|
+
:return: True when the property has been set.
|
|
1496
|
+
:rtype: bool
|
|
1497
|
+
"""
|
|
1012
1498
|
...
|
|
1013
1499
|
|
|
1014
1500
|
def items(self):
|
|
1015
|
-
"""
|
|
1501
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1502
|
+
dictionary function of the same name).
|
|
1503
|
+
|
|
1504
|
+
:return: custom property key, value pairs.
|
|
1505
|
+
"""
|
|
1016
1506
|
...
|
|
1017
1507
|
|
|
1018
|
-
def keyframe_delete(self):
|
|
1019
|
-
"""
|
|
1508
|
+
def keyframe_delete(self) -> bool:
|
|
1509
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1510
|
+
|
|
1511
|
+
:return: Success of keyframe deletion.
|
|
1512
|
+
:rtype: bool
|
|
1513
|
+
"""
|
|
1020
1514
|
...
|
|
1021
1515
|
|
|
1022
|
-
def keyframe_insert(self):
|
|
1023
|
-
"""
|
|
1516
|
+
def keyframe_insert(self) -> bool:
|
|
1517
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1518
|
+
|
|
1519
|
+
:return: Success of keyframe insertion.
|
|
1520
|
+
:rtype: bool
|
|
1521
|
+
"""
|
|
1024
1522
|
...
|
|
1025
1523
|
|
|
1026
1524
|
def keys(self):
|
|
1027
|
-
"""
|
|
1525
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1526
|
+
dictionary function of the same name).
|
|
1527
|
+
|
|
1528
|
+
:return: custom property keys.
|
|
1529
|
+
"""
|
|
1028
1530
|
...
|
|
1029
1531
|
|
|
1030
|
-
def path_from_id(self):
|
|
1031
|
-
"""
|
|
1532
|
+
def path_from_id(self) -> str:
|
|
1533
|
+
"""Returns the data path from the ID to this object (string).
|
|
1534
|
+
|
|
1535
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1536
|
+
to this struct and property (when given).
|
|
1537
|
+
:rtype: str
|
|
1538
|
+
"""
|
|
1032
1539
|
...
|
|
1033
1540
|
|
|
1034
1541
|
def path_menu(
|
|
1035
1542
|
self,
|
|
1036
|
-
searchpaths,
|
|
1037
|
-
operator,
|
|
1038
|
-
props_default,
|
|
1039
|
-
prop_filepath,
|
|
1040
|
-
filter_ext,
|
|
1041
|
-
filter_path,
|
|
1042
|
-
display_name,
|
|
1043
|
-
add_operator,
|
|
1044
|
-
add_operator_props,
|
|
1543
|
+
searchpaths: list[str],
|
|
1544
|
+
operator: str,
|
|
1545
|
+
props_default: dict = None,
|
|
1546
|
+
prop_filepath: str = "filepath",
|
|
1547
|
+
filter_ext: typing.Callable = None,
|
|
1548
|
+
filter_path=None,
|
|
1549
|
+
display_name: typing.Callable = None,
|
|
1550
|
+
add_operator=None,
|
|
1551
|
+
add_operator_props=None,
|
|
1045
1552
|
):
|
|
1046
|
-
"""
|
|
1553
|
+
"""Populate a menu from a list of paths.
|
|
1047
1554
|
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1555
|
+
:param searchpaths: Paths to scan.
|
|
1556
|
+
:type searchpaths: list[str]
|
|
1557
|
+
:param operator: The operator id to use with each file.
|
|
1558
|
+
:type operator: str
|
|
1559
|
+
:param props_default: Properties to assign to each operator.
|
|
1560
|
+
:type props_default: dict
|
|
1561
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1562
|
+
:type prop_filepath: str
|
|
1563
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1564
|
+
|
|
1565
|
+
Returning false excludes the file from the list.
|
|
1566
|
+
:type filter_ext: typing.Callable
|
|
1567
|
+
:param filter_path:
|
|
1568
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1569
|
+
:type display_name: typing.Callable
|
|
1570
|
+
:param add_operator:
|
|
1571
|
+
:param add_operator_props:
|
|
1057
1572
|
"""
|
|
1058
1573
|
...
|
|
1059
1574
|
|
|
1060
1575
|
def path_resolve(self):
|
|
1061
|
-
""" """
|
|
1576
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1062
1577
|
...
|
|
1063
1578
|
|
|
1064
1579
|
def pop(self):
|
|
1065
|
-
"""
|
|
1580
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1581
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1582
|
+
|
|
1583
|
+
"""
|
|
1066
1584
|
...
|
|
1067
1585
|
|
|
1068
1586
|
def prepend(self, draw_func):
|
|
1069
|
-
"""
|
|
1587
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1588
|
+
the menus draw function
|
|
1070
1589
|
|
|
1071
|
-
|
|
1590
|
+
:param draw_func:
|
|
1072
1591
|
"""
|
|
1073
1592
|
...
|
|
1074
1593
|
|
|
1075
|
-
def property_overridable_library_set(self):
|
|
1076
|
-
"""
|
|
1594
|
+
def property_overridable_library_set(self) -> bool:
|
|
1595
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1596
|
+
|
|
1597
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1598
|
+
:rtype: bool
|
|
1599
|
+
"""
|
|
1077
1600
|
...
|
|
1078
1601
|
|
|
1079
1602
|
def property_unset(self):
|
|
1080
|
-
""" """
|
|
1603
|
+
"""Unset a property, will use default value afterward."""
|
|
1081
1604
|
...
|
|
1082
1605
|
|
|
1083
1606
|
def remove(self, draw_func):
|
|
1084
|
-
"""
|
|
1607
|
+
"""Remove a draw function that has been added to this menu
|
|
1085
1608
|
|
|
1086
1609
|
:param draw_func:
|
|
1087
1610
|
"""
|
|
1088
1611
|
...
|
|
1089
1612
|
|
|
1090
1613
|
def type_recast(self):
|
|
1091
|
-
"""
|
|
1614
|
+
"""Return a new instance, this is needed because types
|
|
1615
|
+
such as textures can be changed at runtime.
|
|
1616
|
+
|
|
1617
|
+
:return: a new instance of this object with the type initialized again.
|
|
1618
|
+
"""
|
|
1092
1619
|
...
|
|
1093
1620
|
|
|
1094
1621
|
def values(self):
|
|
1095
|
-
"""
|
|
1622
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1623
|
+
dictionary function of the same name).
|
|
1624
|
+
|
|
1625
|
+
:return: custom property values.
|
|
1626
|
+
"""
|
|
1096
1627
|
...
|
|
1097
1628
|
|
|
1098
1629
|
class MASK_PT_display:
|
|
1099
|
-
""" """
|
|
1100
|
-
|
|
1101
1630
|
bl_label: typing.Any
|
|
1102
|
-
""" """
|
|
1103
1631
|
|
|
1104
1632
|
def draw(self, context):
|
|
1105
1633
|
"""
|
|
@@ -1116,10 +1644,7 @@ class MASK_PT_display:
|
|
|
1116
1644
|
...
|
|
1117
1645
|
|
|
1118
1646
|
class MASK_PT_layers:
|
|
1119
|
-
""" """
|
|
1120
|
-
|
|
1121
1647
|
bl_label: typing.Any
|
|
1122
|
-
""" """
|
|
1123
1648
|
|
|
1124
1649
|
def draw(self, context):
|
|
1125
1650
|
"""
|
|
@@ -1136,13 +1661,8 @@ class MASK_PT_layers:
|
|
|
1136
1661
|
...
|
|
1137
1662
|
|
|
1138
1663
|
class MASK_PT_mask:
|
|
1139
|
-
""" """
|
|
1140
|
-
|
|
1141
1664
|
bl_label: typing.Any
|
|
1142
|
-
""" """
|
|
1143
|
-
|
|
1144
1665
|
bl_options: typing.Any
|
|
1145
|
-
""" """
|
|
1146
1666
|
|
|
1147
1667
|
def draw(self, context):
|
|
1148
1668
|
"""
|
|
@@ -1159,10 +1679,7 @@ class MASK_PT_mask:
|
|
|
1159
1679
|
...
|
|
1160
1680
|
|
|
1161
1681
|
class MASK_PT_point:
|
|
1162
|
-
""" """
|
|
1163
|
-
|
|
1164
1682
|
bl_label: typing.Any
|
|
1165
|
-
""" """
|
|
1166
1683
|
|
|
1167
1684
|
def draw(self, context):
|
|
1168
1685
|
"""
|
|
@@ -1179,10 +1696,7 @@ class MASK_PT_point:
|
|
|
1179
1696
|
...
|
|
1180
1697
|
|
|
1181
1698
|
class MASK_PT_spline:
|
|
1182
|
-
""" """
|
|
1183
|
-
|
|
1184
1699
|
bl_label: typing.Any
|
|
1185
|
-
""" """
|
|
1186
1700
|
|
|
1187
1701
|
def draw(self, context):
|
|
1188
1702
|
"""
|
|
@@ -1199,13 +1713,8 @@ class MASK_PT_spline:
|
|
|
1199
1713
|
...
|
|
1200
1714
|
|
|
1201
1715
|
class MASK_PT_tools:
|
|
1202
|
-
""" """
|
|
1203
|
-
|
|
1204
1716
|
bl_category: typing.Any
|
|
1205
|
-
""" """
|
|
1206
|
-
|
|
1207
1717
|
bl_label: typing.Any
|
|
1208
|
-
""" """
|
|
1209
1718
|
|
|
1210
1719
|
def draw(self, _context):
|
|
1211
1720
|
"""
|
|
@@ -1222,13 +1731,8 @@ class MASK_PT_tools:
|
|
|
1222
1731
|
...
|
|
1223
1732
|
|
|
1224
1733
|
class MASK_PT_transforms:
|
|
1225
|
-
""" """
|
|
1226
|
-
|
|
1227
1734
|
bl_category: typing.Any
|
|
1228
|
-
""" """
|
|
1229
|
-
|
|
1230
1735
|
bl_label: typing.Any
|
|
1231
|
-
""" """
|
|
1232
1736
|
|
|
1233
1737
|
def draw(self, _context):
|
|
1234
1738
|
"""
|
|
@@ -1245,31 +1749,39 @@ class MASK_PT_transforms:
|
|
|
1245
1749
|
...
|
|
1246
1750
|
|
|
1247
1751
|
class MASK_UL_layers(bpy_types.UIList, bpy_types._GenericUI):
|
|
1248
|
-
""" """
|
|
1249
|
-
|
|
1250
1752
|
bl_rna: typing.Any
|
|
1251
|
-
""" """
|
|
1252
|
-
|
|
1253
1753
|
id_data: typing.Any
|
|
1254
|
-
""" """
|
|
1255
1754
|
|
|
1256
1755
|
def append(self, draw_func):
|
|
1257
|
-
"""
|
|
1756
|
+
"""Append a draw function to this menu,
|
|
1757
|
+
takes the same arguments as the menus draw function
|
|
1258
1758
|
|
|
1259
|
-
|
|
1759
|
+
:param draw_func:
|
|
1260
1760
|
"""
|
|
1261
1761
|
...
|
|
1262
1762
|
|
|
1263
|
-
def as_pointer(self):
|
|
1264
|
-
"""
|
|
1763
|
+
def as_pointer(self) -> int:
|
|
1764
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1765
|
+
|
|
1766
|
+
:return: int (memory address).
|
|
1767
|
+
:rtype: int
|
|
1768
|
+
"""
|
|
1265
1769
|
...
|
|
1266
1770
|
|
|
1267
|
-
def bl_rna_get_subclass(self):
|
|
1268
|
-
"""
|
|
1771
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1772
|
+
"""
|
|
1773
|
+
|
|
1774
|
+
:return: The RNA type or default when not found.
|
|
1775
|
+
:rtype: bpy.types.Struct
|
|
1776
|
+
"""
|
|
1269
1777
|
...
|
|
1270
1778
|
|
|
1271
|
-
def bl_rna_get_subclass_py(self):
|
|
1272
|
-
"""
|
|
1779
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1780
|
+
"""
|
|
1781
|
+
|
|
1782
|
+
:return: The class or default when not found.
|
|
1783
|
+
:rtype: typing.Any
|
|
1784
|
+
"""
|
|
1273
1785
|
...
|
|
1274
1786
|
|
|
1275
1787
|
def draw_item(
|
|
@@ -1296,109 +1808,176 @@ class MASK_UL_layers(bpy_types.UIList, bpy_types._GenericUI):
|
|
|
1296
1808
|
"""
|
|
1297
1809
|
...
|
|
1298
1810
|
|
|
1299
|
-
def driver_add(self):
|
|
1300
|
-
"""
|
|
1811
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1812
|
+
"""Adds driver(s) to the given property
|
|
1813
|
+
|
|
1814
|
+
:return: The driver(s) added.
|
|
1815
|
+
:rtype: bpy.types.FCurve
|
|
1816
|
+
"""
|
|
1301
1817
|
...
|
|
1302
1818
|
|
|
1303
|
-
def driver_remove(self):
|
|
1304
|
-
"""
|
|
1819
|
+
def driver_remove(self) -> bool:
|
|
1820
|
+
"""Remove driver(s) from the given property
|
|
1821
|
+
|
|
1822
|
+
:return: Success of driver removal.
|
|
1823
|
+
:rtype: bool
|
|
1824
|
+
"""
|
|
1305
1825
|
...
|
|
1306
1826
|
|
|
1307
1827
|
def get(self):
|
|
1308
|
-
"""
|
|
1828
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1829
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1830
|
+
|
|
1831
|
+
"""
|
|
1309
1832
|
...
|
|
1310
1833
|
|
|
1311
1834
|
def id_properties_clear(self):
|
|
1312
|
-
"""
|
|
1835
|
+
"""
|
|
1836
|
+
|
|
1837
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1838
|
+
"""
|
|
1313
1839
|
...
|
|
1314
1840
|
|
|
1315
1841
|
def id_properties_ensure(self):
|
|
1316
|
-
"""
|
|
1842
|
+
"""
|
|
1843
|
+
|
|
1844
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1845
|
+
"""
|
|
1317
1846
|
...
|
|
1318
1847
|
|
|
1319
1848
|
def id_properties_ui(self):
|
|
1320
|
-
"""
|
|
1321
|
-
...
|
|
1849
|
+
"""
|
|
1322
1850
|
|
|
1323
|
-
|
|
1324
|
-
"""
|
|
1851
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1852
|
+
"""
|
|
1325
1853
|
...
|
|
1326
1854
|
|
|
1327
|
-
def
|
|
1328
|
-
|
|
1855
|
+
def is_extended(self): ...
|
|
1856
|
+
def is_property_hidden(self) -> bool:
|
|
1857
|
+
"""Check if a property is hidden.
|
|
1858
|
+
|
|
1859
|
+
:return: True when the property is hidden.
|
|
1860
|
+
:rtype: bool
|
|
1861
|
+
"""
|
|
1329
1862
|
...
|
|
1330
1863
|
|
|
1331
|
-
def is_property_overridable_library(self):
|
|
1332
|
-
"""
|
|
1864
|
+
def is_property_overridable_library(self) -> bool:
|
|
1865
|
+
"""Check if a property is overridable.
|
|
1866
|
+
|
|
1867
|
+
:return: True when the property is overridable.
|
|
1868
|
+
:rtype: bool
|
|
1869
|
+
"""
|
|
1333
1870
|
...
|
|
1334
1871
|
|
|
1335
|
-
def is_property_readonly(self):
|
|
1336
|
-
"""
|
|
1872
|
+
def is_property_readonly(self) -> bool:
|
|
1873
|
+
"""Check if a property is readonly.
|
|
1874
|
+
|
|
1875
|
+
:return: True when the property is readonly (not writable).
|
|
1876
|
+
:rtype: bool
|
|
1877
|
+
"""
|
|
1337
1878
|
...
|
|
1338
1879
|
|
|
1339
|
-
def is_property_set(self):
|
|
1340
|
-
"""
|
|
1880
|
+
def is_property_set(self) -> bool:
|
|
1881
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1882
|
+
|
|
1883
|
+
:return: True when the property has been set.
|
|
1884
|
+
:rtype: bool
|
|
1885
|
+
"""
|
|
1341
1886
|
...
|
|
1342
1887
|
|
|
1343
1888
|
def items(self):
|
|
1344
|
-
"""
|
|
1889
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1890
|
+
dictionary function of the same name).
|
|
1891
|
+
|
|
1892
|
+
:return: custom property key, value pairs.
|
|
1893
|
+
"""
|
|
1345
1894
|
...
|
|
1346
1895
|
|
|
1347
|
-
def keyframe_delete(self):
|
|
1348
|
-
"""
|
|
1896
|
+
def keyframe_delete(self) -> bool:
|
|
1897
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1898
|
+
|
|
1899
|
+
:return: Success of keyframe deletion.
|
|
1900
|
+
:rtype: bool
|
|
1901
|
+
"""
|
|
1349
1902
|
...
|
|
1350
1903
|
|
|
1351
|
-
def keyframe_insert(self):
|
|
1352
|
-
"""
|
|
1904
|
+
def keyframe_insert(self) -> bool:
|
|
1905
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1906
|
+
|
|
1907
|
+
:return: Success of keyframe insertion.
|
|
1908
|
+
:rtype: bool
|
|
1909
|
+
"""
|
|
1353
1910
|
...
|
|
1354
1911
|
|
|
1355
1912
|
def keys(self):
|
|
1356
|
-
"""
|
|
1913
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1914
|
+
dictionary function of the same name).
|
|
1915
|
+
|
|
1916
|
+
:return: custom property keys.
|
|
1917
|
+
"""
|
|
1357
1918
|
...
|
|
1358
1919
|
|
|
1359
|
-
def path_from_id(self):
|
|
1360
|
-
"""
|
|
1920
|
+
def path_from_id(self) -> str:
|
|
1921
|
+
"""Returns the data path from the ID to this object (string).
|
|
1922
|
+
|
|
1923
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1924
|
+
to this struct and property (when given).
|
|
1925
|
+
:rtype: str
|
|
1926
|
+
"""
|
|
1361
1927
|
...
|
|
1362
1928
|
|
|
1363
1929
|
def path_resolve(self):
|
|
1364
|
-
""" """
|
|
1930
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1365
1931
|
...
|
|
1366
1932
|
|
|
1367
1933
|
def pop(self):
|
|
1368
|
-
"""
|
|
1934
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1935
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1936
|
+
|
|
1937
|
+
"""
|
|
1369
1938
|
...
|
|
1370
1939
|
|
|
1371
1940
|
def prepend(self, draw_func):
|
|
1372
|
-
"""
|
|
1941
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1942
|
+
the menus draw function
|
|
1373
1943
|
|
|
1374
|
-
|
|
1944
|
+
:param draw_func:
|
|
1375
1945
|
"""
|
|
1376
1946
|
...
|
|
1377
1947
|
|
|
1378
|
-
def property_overridable_library_set(self):
|
|
1379
|
-
"""
|
|
1948
|
+
def property_overridable_library_set(self) -> bool:
|
|
1949
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1950
|
+
|
|
1951
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1952
|
+
:rtype: bool
|
|
1953
|
+
"""
|
|
1380
1954
|
...
|
|
1381
1955
|
|
|
1382
1956
|
def property_unset(self):
|
|
1383
|
-
""" """
|
|
1957
|
+
"""Unset a property, will use default value afterward."""
|
|
1384
1958
|
...
|
|
1385
1959
|
|
|
1386
1960
|
def remove(self, draw_func):
|
|
1387
|
-
"""
|
|
1961
|
+
"""Remove a draw function that has been added to this menu
|
|
1388
1962
|
|
|
1389
1963
|
:param draw_func:
|
|
1390
1964
|
"""
|
|
1391
1965
|
...
|
|
1392
1966
|
|
|
1393
1967
|
def type_recast(self):
|
|
1394
|
-
"""
|
|
1968
|
+
"""Return a new instance, this is needed because types
|
|
1969
|
+
such as textures can be changed at runtime.
|
|
1970
|
+
|
|
1971
|
+
:return: a new instance of this object with the type initialized again.
|
|
1972
|
+
"""
|
|
1395
1973
|
...
|
|
1396
1974
|
|
|
1397
1975
|
def values(self):
|
|
1398
|
-
"""
|
|
1399
|
-
|
|
1976
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1977
|
+
dictionary function of the same name).
|
|
1400
1978
|
|
|
1401
|
-
|
|
1402
|
-
|
|
1979
|
+
:return: custom property values.
|
|
1980
|
+
"""
|
|
1981
|
+
...
|
|
1403
1982
|
|
|
1404
|
-
|
|
1983
|
+
def draw_mask_context_menu(layout, _context): ...
|