fake-bpy-module 20240516__py3-none-any.whl → 20240517__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- _bpy_internal/freedesktop/__init__.pyi +2 -2
- addon_utils/__init__.pyi +43 -12
- animsys_refactor/__init__.pyi +4 -4
- aud/__init__.pyi +7 -7
- bgl/__init__.pyi +121 -183
- bl_app_override/__init__.pyi +5 -5
- bl_app_override/helpers/__init__.pyi +3 -1
- bl_app_template_utils/__init__.pyi +5 -5
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
- bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
- bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
- bl_i18n_utils/bl_extract_messages/__init__.pyi +5 -5
- bl_i18n_utils/settings/__init__.pyi +4 -2
- bl_i18n_utils/utils/__init__.pyi +86 -58
- bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
- bl_keymap_utils/io/__init__.pyi +4 -4
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
- bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
- bl_operators/add_mesh_torus/__init__.pyi +126 -41
- bl_operators/anim/__init__.pyi +1001 -328
- bl_operators/assets/__init__.pyi +376 -123
- bl_operators/bmesh/find_adjacent/__init__.pyi +3 -3
- bl_operators/clip/__init__.pyi +1250 -409
- bl_operators/console/__init__.pyi +626 -205
- bl_operators/constraint/__init__.pyi +502 -165
- bl_operators/file/__init__.pyi +376 -123
- bl_operators/freestyle/__init__.pyi +501 -164
- bl_operators/geometry_nodes/__init__.pyi +501 -164
- bl_operators/image/__init__.pyi +621 -200
- bl_operators/mesh/__init__.pyi +376 -123
- bl_operators/node/__init__.pyi +1243 -402
- bl_operators/object/__init__.pyi +1876 -615
- bl_operators/object_align/__init__.pyi +126 -41
- bl_operators/object_quick_effects/__init__.pyi +502 -165
- bl_operators/object_randomize_transform/__init__.pyi +126 -41
- bl_operators/presets/__init__.pyi +3069 -1027
- bl_operators/rigidbody/__init__.pyi +376 -123
- bl_operators/screen_play_rendered_anim/__init__.pyi +126 -41
- bl_operators/sequencer/__init__.pyi +1009 -331
- bl_operators/spreadsheet/__init__.pyi +126 -41
- bl_operators/userpref/__init__.pyi +3263 -1078
- bl_operators/uvcalc_follow_active/__init__.pyi +126 -41
- bl_operators/uvcalc_lightmap/__init__.pyi +137 -47
- bl_operators/uvcalc_transform/__init__.pyi +289 -90
- bl_operators/vertexpaint_dirt/__init__.pyi +126 -41
- bl_operators/view3d/__init__.pyi +868 -279
- bl_operators/wm/__init__.pyi +5777 -1934
- bl_operators/world/__init__.pyi +126 -41
- bl_previews_utils/bl_previews_render/__init__.pyi +1 -1
- bl_rna_utils/data_path/__init__.pyi +8 -3
- bl_ui/__init__.pyi +338 -131
- bl_ui/anim/__init__.pyi +164 -64
- bl_ui/asset_shelf/__init__.pyi +129 -42
- bl_ui/generic_ui_list/__init__.pyi +412 -135
- bl_ui/node_add_menu/__init__.pyi +168 -68
- bl_ui/node_add_menu_compositor/__init__.pyi +2921 -1138
- bl_ui/node_add_menu_geometry/__init__.pyi +7785 -3032
- bl_ui/node_add_menu_shader/__init__.pyi +1621 -630
- bl_ui/node_add_menu_texture/__init__.pyi +1459 -567
- bl_ui/properties_animviz/__init__.pyi +2 -2
- bl_ui/properties_collection/__init__.pyi +806 -274
- bl_ui/properties_constraint/__init__.pyi +10253 -3458
- bl_ui/properties_data_armature/__init__.pyi +1615 -552
- bl_ui/properties_data_bone/__init__.pyi +1288 -425
- bl_ui/properties_data_camera/__init__.pyi +1854 -631
- bl_ui/properties_data_curve/__init__.pyi +1929 -636
- bl_ui/properties_data_curves/__init__.pyi +806 -274
- bl_ui/properties_data_empty/__init__.pyi +257 -84
- bl_ui/properties_data_gpencil/__init__.pyi +2380 -803
- bl_ui/properties_data_grease_pencil/__init__.pyi +1902 -656
- bl_ui/properties_data_lattice/__init__.pyi +388 -127
- bl_ui/properties_data_light/__init__.pyi +1541 -506
- bl_ui/properties_data_lightprobe/__init__.pyi +1667 -548
- bl_ui/properties_data_mesh/__init__.pyi +2704 -929
- bl_ui/properties_data_metaball/__init__.pyi +644 -211
- bl_ui/properties_data_modifier/__init__.pyi +1353 -502
- bl_ui/properties_data_pointcloud/__init__.pyi +679 -233
- bl_ui/properties_data_shaderfx/__init__.pyi +129 -42
- bl_ui/properties_data_speaker/__init__.pyi +644 -211
- bl_ui/properties_data_volume/__init__.pyi +1030 -339
- bl_ui/properties_freestyle/__init__.pyi +3113 -1035
- bl_ui/properties_grease_pencil_common/__init__.pyi +2464 -933
- bl_ui/properties_mask_common/__init__.pyi +1101 -420
- bl_ui/properties_material/__init__.pyi +2091 -699
- bl_ui/properties_material_gpencil/__init__.pyi +1350 -466
- bl_ui/properties_object/__init__.pyi +1838 -618
- bl_ui/properties_output/__init__.pyi +2414 -831
- bl_ui/properties_paint_common/__init__.pyi +412 -289
- bl_ui/properties_particle/__init__.pyi +6737 -2241
- bl_ui/properties_physics_cloth/__init__.pyi +1825 -612
- bl_ui/properties_physics_common/__init__.pyi +129 -42
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +2821 -928
- bl_ui/properties_physics_field/__init__.pyi +1283 -422
- bl_ui/properties_physics_fluid/__init__.pyi +3620 -1203
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -42
- bl_ui/properties_physics_rigidbody/__init__.pyi +1027 -338
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1667 -548
- bl_ui/properties_physics_softbody/__init__.pyi +1924 -633
- bl_ui/properties_render/__init__.pyi +6830 -2263
- bl_ui/properties_scene/__init__.pyi +1929 -636
- bl_ui/properties_texture/__init__.pyi +3370 -1118
- bl_ui/properties_view_layer/__init__.pyi +2346 -782
- bl_ui/properties_workspace/__init__.pyi +516 -169
- bl_ui/properties_world/__init__.pyi +1284 -421
- bl_ui/space_clip/__init__.pyi +10134 -3639
- bl_ui/space_console/__init__.pyi +939 -357
- bl_ui/space_dopesheet/__init__.pyi +4327 -1562
- bl_ui/space_filebrowser/__init__.pyi +4164 -1499
- bl_ui/space_graph/__init__.pyi +3108 -1179
- bl_ui/space_image/__init__.pyi +9766 -3596
- bl_ui/space_info/__init__.pyi +939 -357
- bl_ui/space_nla/__init__.pyi +2620 -988
- bl_ui/space_node/__init__.pyi +3994 -1434
- bl_ui/space_outliner/__init__.pyi +2203 -842
- bl_ui/space_properties/__init__.pyi +386 -127
- bl_ui/space_sequencer/__init__.pyi +10773 -3878
- bl_ui/space_spreadsheet/__init__.pyi +130 -43
- bl_ui/space_statusbar/__init__.pyi +129 -42
- bl_ui/space_text/__init__.pyi +2458 -925
- bl_ui/space_time/__init__.pyi +1033 -378
- bl_ui/space_toolsystem_common/__init__.pyi +20 -16
- bl_ui/space_toolsystem_toolbar/__init__.pyi +37 -21
- bl_ui/space_topbar/__init__.pyi +3980 -1496
- bl_ui/space_userpref/__init__.pyi +11373 -3797
- bl_ui/space_view3d/__init__.pyi +40865 -15356
- bl_ui/space_view3d_toolbar/__init__.pyi +12520 -4647
- bl_ui/temp_anim_layers/__init__.pyi +129 -42
- bl_ui/utils/__init__.pyi +28 -20
- bl_ui_utils/bug_report_url/__init__.pyi +1 -1
- bl_ui_utils/layout/__init__.pyi +1 -1
- blend_render_info/__init__.pyi +1 -1
- blf/__init__.pyi +4 -4
- bmesh/geometry/__init__.pyi +2 -3
- bmesh/ops/__init__.pyi +372 -419
- bmesh/types/__init__.pyi +38 -38
- bmesh/utils/__init__.pyi +10 -13
- bpy/app/__init__.pyi +4 -4
- bpy/app/handlers/__init__.pyi +36 -36
- bpy/app/icons/__init__.pyi +8 -8
- bpy/app/timers/__init__.pyi +10 -10
- bpy/app/translations/__init__.pyi +20 -22
- bpy/msgbus/__init__.pyi +2 -4
- bpy/ops/action/__init__.pyi +316 -394
- bpy/ops/anim/__init__.pyi +442 -548
- bpy/ops/armature/__init__.pyi +374 -470
- bpy/ops/asset/__init__.pyi +152 -184
- bpy/ops/bl_pkg/__init__.pyi +221 -272
- bpy/ops/boid/__init__.pyi +50 -66
- bpy/ops/brush/__init__.pyi +72 -90
- bpy/ops/buttons/__init__.pyi +132 -144
- bpy/ops/cachefile/__init__.pyi +128 -138
- bpy/ops/camera/__init__.pyi +26 -30
- bpy/ops/clip/__init__.pyi +777 -964
- bpy/ops/cloth/__init__.pyi +12 -14
- bpy/ops/collection/__init__.pyi +68 -86
- bpy/ops/console/__init__.pyi +158 -200
- bpy/ops/constraint/__init__.pyi +178 -214
- bpy/ops/curve/__init__.pyi +473 -576
- bpy/ops/curves/__init__.pyi +247 -302
- bpy/ops/cycles/__init__.pyi +28 -34
- bpy/ops/dpaint/__init__.pyi +34 -44
- bpy/ops/ed/__init__.pyi +126 -150
- bpy/ops/export_anim/__init__.pyi +22 -24
- bpy/ops/export_scene/__init__.pyi +302 -336
- bpy/ops/file/__init__.pyi +352 -432
- bpy/ops/fluid/__init__.pyi +90 -118
- bpy/ops/font/__init__.pyi +258 -304
- bpy/ops/geometry/__init__.pyi +100 -120
- bpy/ops/gizmogroup/__init__.pyi +22 -26
- bpy/ops/gpencil/__init__.pyi +1469 -1778
- bpy/ops/graph/__init__.pyi +644 -776
- bpy/ops/grease_pencil/__init__.pyi +597 -748
- bpy/ops/image/__init__.pyi +648 -744
- bpy/ops/import_anim/__init__.pyi +30 -32
- bpy/ops/import_curve/__init__.pyi +10 -12
- bpy/ops/import_scene/__init__.pyi +88 -96
- bpy/ops/info/__init__.pyi +60 -74
- bpy/ops/lattice/__init__.pyi +64 -80
- bpy/ops/marker/__init__.pyi +108 -130
- bpy/ops/mask/__init__.pyi +322 -402
- bpy/ops/material/__init__.pyi +18 -24
- bpy/ops/mball/__init__.pyi +70 -86
- bpy/ops/mesh/__init__.pyi +1986 -2322
- bpy/ops/nla/__init__.pyi +333 -411
- bpy/ops/node/__init__.pyi +886 -1100
- bpy/ops/object/__init__.pyi +2585 -3078
- bpy/ops/outliner/__init__.pyi +498 -636
- bpy/ops/paint/__init__.pyi +565 -680
- bpy/ops/paintcurve/__init__.pyi +64 -80
- bpy/ops/palette/__init__.pyi +50 -64
- bpy/ops/particle/__init__.pyi +267 -340
- bpy/ops/pose/__init__.pyi +336 -414
- bpy/ops/poselib/__init__.pyi +72 -90
- bpy/ops/preferences/__init__.pyi +386 -463
- bpy/ops/ptcache/__init__.pyi +46 -60
- bpy/ops/render/__init__.pyi +130 -154
- bpy/ops/rigidbody/__init__.pyi +102 -128
- bpy/ops/scene/__init__.pyi +280 -358
- bpy/ops/screen/__init__.pyi +382 -460
- bpy/ops/script/__init__.pyi +24 -30
- bpy/ops/sculpt/__init__.pyi +458 -532
- bpy/ops/sculpt_curves/__init__.pyi +41 -50
- bpy/ops/sequencer/__init__.pyi +1066 -1244
- bpy/ops/sound/__init__.pyi +216 -230
- bpy/ops/spreadsheet/__init__.pyi +30 -38
- bpy/ops/surface/__init__.pyi +108 -120
- bpy/ops/text/__init__.pyi +390 -476
- bpy/ops/text_editor/__init__.pyi +12 -14
- bpy/ops/texture/__init__.pyi +26 -34
- bpy/ops/transform/__init__.pyi +792 -878
- bpy/ops/ui/__init__.pyi +228 -294
- bpy/ops/uilist/__init__.pyi +32 -38
- bpy/ops/uv/__init__.pyi +602 -704
- bpy/ops/view2d/__init__.pyi +156 -184
- bpy/ops/view3d/__init__.pyi +582 -718
- bpy/ops/wm/__init__.pyi +2680 -2928
- bpy/ops/workspace/__init__.pyi +46 -60
- bpy/ops/world/__init__.pyi +12 -16
- bpy/path/__init__.pyi +179 -75
- bpy/props/__init__.pyi +261 -263
- bpy/types/__init__.pyi +17056 -21951
- bpy/utils/__init__.pyi +242 -118
- bpy/utils/previews/__init__.pyi +58 -28
- bpy/utils/units/__init__.pyi +20 -20
- bpy_extras/anim_utils/__init__.pyi +68 -28
- bpy_extras/bmesh_utils/__init__.pyi +8 -2
- bpy_extras/extensions/junction_module/__init__.pyi +5 -2
- bpy_extras/id_map_utils/__init__.pyi +3 -3
- bpy_extras/image_utils/__init__.pyi +44 -11
- bpy_extras/io_utils/__init__.pyi +113 -18
- bpy_extras/keyconfig_utils/__init__.pyi +2 -2
- bpy_extras/mesh_utils/__init__.pyi +71 -19
- bpy_extras/node_shader_utils/__init__.pyi +9 -4
- bpy_extras/node_utils/__init__.pyi +9 -2
- bpy_extras/object_utils/__init__.pyi +71 -12
- bpy_extras/view3d_utils/__init__.pyi +80 -10
- bpy_extras/wm_utils/progress_report/__init__.pyi +13 -10
- bpy_types/__init__.pyi +4197 -1333
- console_python/__init__.pyi +6 -1
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/METADATA +1 -1
- fake_bpy_module-20240517.dist-info/RECORD +353 -0
- freestyle/chainingiterators/__init__.pyi +4 -4
- freestyle/shaders/__init__.pyi +2 -2
- freestyle/types/__init__.pyi +84 -96
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +3 -3
- gpu/matrix/__init__.pyi +6 -8
- gpu/state/__init__.pyi +2 -2
- gpu/types/__init__.pyi +12 -12
- gpu_extras/presets/__init__.pyi +2 -5
- graphviz_export/__init__.pyi +4 -2
- idprop/types/__init__.pyi +2 -2
- imbuf/__init__.pyi +4 -4
- keyingsets_builtins/__init__.pyi +2688 -839
- mathutils/__init__.pyi +194 -238
- mathutils/bvhtree/__init__.pyi +4 -4
- mathutils/geometry/__init__.pyi +153 -155
- mathutils/kdtree/__init__.pyi +8 -12
- mathutils/noise/__init__.pyi +26 -26
- nodeitems_utils/__init__.pyi +1 -1
- rna_info/__init__.pyi +17 -15
- rna_keymap_ui/__init__.pyi +1 -1
- rna_prop_ui/__init__.pyi +16 -14
- rna_xml/__init__.pyi +12 -12
- _bpy_internal/freedesktop/py.typed +0 -0
- bl_app_override/helpers/py.typed +0 -0
- bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
- bl_console_utils/autocomplete/complete_import/py.typed +0 -0
- bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
- bl_console_utils/autocomplete/intellisense/py.typed +0 -0
- bl_console_utils/autocomplete/py.typed +0 -0
- bl_i18n_utils/bl_extract_messages/py.typed +0 -0
- bl_i18n_utils/merge_po/py.typed +0 -0
- bl_i18n_utils/settings/py.typed +0 -0
- bl_i18n_utils/utils/py.typed +0 -0
- bl_i18n_utils/utils_cli/py.typed +0 -0
- bl_i18n_utils/utils_languages_menu/py.typed +0 -0
- bl_i18n_utils/utils_rtl/py.typed +0 -0
- bl_keymap_utils/io/py.typed +0 -0
- bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
- bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
- bl_keymap_utils/platform_helpers/py.typed +0 -0
- bl_keymap_utils/versioning/py.typed +0 -0
- bl_operators/add_mesh_torus/py.typed +0 -0
- bl_operators/anim/py.typed +0 -0
- bl_operators/assets/py.typed +0 -0
- bl_operators/bmesh/find_adjacent/py.typed +0 -0
- bl_operators/bmesh/py.typed +0 -0
- bl_operators/clip/py.typed +0 -0
- bl_operators/console/py.typed +0 -0
- bl_operators/constraint/py.typed +0 -0
- bl_operators/file/py.typed +0 -0
- bl_operators/freestyle/py.typed +0 -0
- bl_operators/geometry_nodes/py.typed +0 -0
- bl_operators/image/py.typed +0 -0
- bl_operators/mesh/py.typed +0 -0
- bl_operators/node/py.typed +0 -0
- bl_operators/object/py.typed +0 -0
- bl_operators/object_align/py.typed +0 -0
- bl_operators/object_quick_effects/py.typed +0 -0
- bl_operators/object_randomize_transform/py.typed +0 -0
- bl_operators/presets/py.typed +0 -0
- bl_operators/rigidbody/py.typed +0 -0
- bl_operators/screen_play_rendered_anim/py.typed +0 -0
- bl_operators/sequencer/py.typed +0 -0
- bl_operators/spreadsheet/py.typed +0 -0
- bl_operators/userpref/py.typed +0 -0
- bl_operators/uvcalc_follow_active/py.typed +0 -0
- bl_operators/uvcalc_lightmap/py.typed +0 -0
- bl_operators/uvcalc_transform/py.typed +0 -0
- bl_operators/vertexpaint_dirt/py.typed +0 -0
- bl_operators/view3d/py.typed +0 -0
- bl_operators/wm/py.typed +0 -0
- bl_operators/world/py.typed +0 -0
- bl_previews_utils/bl_previews_render/py.typed +0 -0
- bl_rna_utils/data_path/py.typed +0 -0
- bl_text_utils/external_editor/py.typed +0 -0
- bl_ui/anim/py.typed +0 -0
- bl_ui/asset_shelf/py.typed +0 -0
- bl_ui/generic_ui_list/py.typed +0 -0
- bl_ui/node_add_menu/py.typed +0 -0
- bl_ui/node_add_menu_compositor/py.typed +0 -0
- bl_ui/node_add_menu_geometry/py.typed +0 -0
- bl_ui/node_add_menu_shader/py.typed +0 -0
- bl_ui/node_add_menu_texture/py.typed +0 -0
- bl_ui/properties_animviz/py.typed +0 -0
- bl_ui/properties_collection/py.typed +0 -0
- bl_ui/properties_constraint/py.typed +0 -0
- bl_ui/properties_data_armature/py.typed +0 -0
- bl_ui/properties_data_bone/py.typed +0 -0
- bl_ui/properties_data_camera/py.typed +0 -0
- bl_ui/properties_data_curve/py.typed +0 -0
- bl_ui/properties_data_curves/py.typed +0 -0
- bl_ui/properties_data_empty/py.typed +0 -0
- bl_ui/properties_data_gpencil/py.typed +0 -0
- bl_ui/properties_data_grease_pencil/py.typed +0 -0
- bl_ui/properties_data_lattice/py.typed +0 -0
- bl_ui/properties_data_light/py.typed +0 -0
- bl_ui/properties_data_lightprobe/py.typed +0 -0
- bl_ui/properties_data_mesh/py.typed +0 -0
- bl_ui/properties_data_metaball/py.typed +0 -0
- bl_ui/properties_data_modifier/py.typed +0 -0
- bl_ui/properties_data_pointcloud/py.typed +0 -0
- bl_ui/properties_data_shaderfx/py.typed +0 -0
- bl_ui/properties_data_speaker/py.typed +0 -0
- bl_ui/properties_data_volume/py.typed +0 -0
- bl_ui/properties_freestyle/py.typed +0 -0
- bl_ui/properties_grease_pencil_common/py.typed +0 -0
- bl_ui/properties_mask_common/py.typed +0 -0
- bl_ui/properties_material/py.typed +0 -0
- bl_ui/properties_material_gpencil/py.typed +0 -0
- bl_ui/properties_object/py.typed +0 -0
- bl_ui/properties_output/py.typed +0 -0
- bl_ui/properties_paint_common/py.typed +0 -0
- bl_ui/properties_particle/py.typed +0 -0
- bl_ui/properties_physics_cloth/py.typed +0 -0
- bl_ui/properties_physics_common/py.typed +0 -0
- bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
- bl_ui/properties_physics_field/py.typed +0 -0
- bl_ui/properties_physics_fluid/py.typed +0 -0
- bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
- bl_ui/properties_physics_rigidbody/py.typed +0 -0
- bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
- bl_ui/properties_physics_softbody/py.typed +0 -0
- bl_ui/properties_render/py.typed +0 -0
- bl_ui/properties_scene/py.typed +0 -0
- bl_ui/properties_texture/py.typed +0 -0
- bl_ui/properties_view_layer/py.typed +0 -0
- bl_ui/properties_workspace/py.typed +0 -0
- bl_ui/properties_world/py.typed +0 -0
- bl_ui/space_clip/py.typed +0 -0
- bl_ui/space_console/py.typed +0 -0
- bl_ui/space_dopesheet/py.typed +0 -0
- bl_ui/space_filebrowser/py.typed +0 -0
- bl_ui/space_graph/py.typed +0 -0
- bl_ui/space_image/py.typed +0 -0
- bl_ui/space_info/py.typed +0 -0
- bl_ui/space_nla/py.typed +0 -0
- bl_ui/space_node/py.typed +0 -0
- bl_ui/space_outliner/py.typed +0 -0
- bl_ui/space_properties/py.typed +0 -0
- bl_ui/space_sequencer/py.typed +0 -0
- bl_ui/space_spreadsheet/py.typed +0 -0
- bl_ui/space_statusbar/py.typed +0 -0
- bl_ui/space_text/py.typed +0 -0
- bl_ui/space_time/py.typed +0 -0
- bl_ui/space_toolsystem_common/py.typed +0 -0
- bl_ui/space_toolsystem_toolbar/py.typed +0 -0
- bl_ui/space_topbar/py.typed +0 -0
- bl_ui/space_userpref/py.typed +0 -0
- bl_ui/space_view3d/py.typed +0 -0
- bl_ui/space_view3d_toolbar/py.typed +0 -0
- bl_ui/temp_anim_layers/py.typed +0 -0
- bl_ui/utils/py.typed +0 -0
- bl_ui_utils/bug_report_url/py.typed +0 -0
- bl_ui_utils/layout/py.typed +0 -0
- bmesh/geometry/py.typed +0 -0
- bmesh/ops/py.typed +0 -0
- bmesh/types/py.typed +0 -0
- bmesh/utils/py.typed +0 -0
- bpy/app/handlers/py.typed +0 -0
- bpy/app/icons/py.typed +0 -0
- bpy/app/py.typed +0 -0
- bpy/app/timers/py.typed +0 -0
- bpy/app/translations/py.typed +0 -0
- bpy/msgbus/py.typed +0 -0
- bpy/ops/action/py.typed +0 -0
- bpy/ops/anim/py.typed +0 -0
- bpy/ops/armature/py.typed +0 -0
- bpy/ops/asset/py.typed +0 -0
- bpy/ops/bl_pkg/py.typed +0 -0
- bpy/ops/boid/py.typed +0 -0
- bpy/ops/brush/py.typed +0 -0
- bpy/ops/buttons/py.typed +0 -0
- bpy/ops/cachefile/py.typed +0 -0
- bpy/ops/camera/py.typed +0 -0
- bpy/ops/clip/py.typed +0 -0
- bpy/ops/cloth/py.typed +0 -0
- bpy/ops/collection/py.typed +0 -0
- bpy/ops/console/py.typed +0 -0
- bpy/ops/constraint/py.typed +0 -0
- bpy/ops/curve/py.typed +0 -0
- bpy/ops/curves/py.typed +0 -0
- bpy/ops/cycles/py.typed +0 -0
- bpy/ops/dpaint/py.typed +0 -0
- bpy/ops/ed/py.typed +0 -0
- bpy/ops/export_anim/py.typed +0 -0
- bpy/ops/export_scene/py.typed +0 -0
- bpy/ops/file/py.typed +0 -0
- bpy/ops/fluid/py.typed +0 -0
- bpy/ops/font/py.typed +0 -0
- bpy/ops/geometry/py.typed +0 -0
- bpy/ops/gizmogroup/py.typed +0 -0
- bpy/ops/gpencil/py.typed +0 -0
- bpy/ops/graph/py.typed +0 -0
- bpy/ops/grease_pencil/py.typed +0 -0
- bpy/ops/image/py.typed +0 -0
- bpy/ops/import_anim/py.typed +0 -0
- bpy/ops/import_curve/py.typed +0 -0
- bpy/ops/import_scene/py.typed +0 -0
- bpy/ops/info/py.typed +0 -0
- bpy/ops/lattice/py.typed +0 -0
- bpy/ops/marker/py.typed +0 -0
- bpy/ops/mask/py.typed +0 -0
- bpy/ops/material/py.typed +0 -0
- bpy/ops/mball/py.typed +0 -0
- bpy/ops/mesh/py.typed +0 -0
- bpy/ops/nla/py.typed +0 -0
- bpy/ops/node/py.typed +0 -0
- bpy/ops/object/py.typed +0 -0
- bpy/ops/outliner/py.typed +0 -0
- bpy/ops/paint/py.typed +0 -0
- bpy/ops/paintcurve/py.typed +0 -0
- bpy/ops/palette/py.typed +0 -0
- bpy/ops/particle/py.typed +0 -0
- bpy/ops/pose/py.typed +0 -0
- bpy/ops/poselib/py.typed +0 -0
- bpy/ops/preferences/py.typed +0 -0
- bpy/ops/ptcache/py.typed +0 -0
- bpy/ops/py.typed +0 -0
- bpy/ops/render/py.typed +0 -0
- bpy/ops/rigidbody/py.typed +0 -0
- bpy/ops/scene/py.typed +0 -0
- bpy/ops/screen/py.typed +0 -0
- bpy/ops/script/py.typed +0 -0
- bpy/ops/sculpt/py.typed +0 -0
- bpy/ops/sculpt_curves/py.typed +0 -0
- bpy/ops/sequencer/py.typed +0 -0
- bpy/ops/sound/py.typed +0 -0
- bpy/ops/spreadsheet/py.typed +0 -0
- bpy/ops/surface/py.typed +0 -0
- bpy/ops/text/py.typed +0 -0
- bpy/ops/text_editor/py.typed +0 -0
- bpy/ops/texture/py.typed +0 -0
- bpy/ops/transform/py.typed +0 -0
- bpy/ops/ui/py.typed +0 -0
- bpy/ops/uilist/py.typed +0 -0
- bpy/ops/uv/py.typed +0 -0
- bpy/ops/view2d/py.typed +0 -0
- bpy/ops/view3d/py.typed +0 -0
- bpy/ops/wm/py.typed +0 -0
- bpy/ops/workspace/py.typed +0 -0
- bpy/ops/world/py.typed +0 -0
- bpy/path/py.typed +0 -0
- bpy/props/py.typed +0 -0
- bpy/types/py.typed +0 -0
- bpy/utils/previews/py.typed +0 -0
- bpy/utils/py.typed +0 -0
- bpy/utils/units/py.typed +0 -0
- bpy_extras/anim_utils/py.typed +0 -0
- bpy_extras/asset_utils/py.typed +0 -0
- bpy_extras/bmesh_utils/py.typed +0 -0
- bpy_extras/extensions/junction_module/py.typed +0 -0
- bpy_extras/extensions/py.typed +0 -0
- bpy_extras/id_map_utils/py.typed +0 -0
- bpy_extras/image_utils/py.typed +0 -0
- bpy_extras/io_utils/py.typed +0 -0
- bpy_extras/keyconfig_utils/py.typed +0 -0
- bpy_extras/mesh_utils/py.typed +0 -0
- bpy_extras/node_shader_utils/py.typed +0 -0
- bpy_extras/node_utils/py.typed +0 -0
- bpy_extras/object_utils/py.typed +0 -0
- bpy_extras/view3d_utils/py.typed +0 -0
- bpy_extras/wm_utils/progress_report/py.typed +0 -0
- bpy_extras/wm_utils/py.typed +0 -0
- fake_bpy_module-20240516.dist-info/RECORD +0 -618
- freestyle/chainingiterators/py.typed +0 -0
- freestyle/functions/py.typed +0 -0
- freestyle/predicates/py.typed +0 -0
- freestyle/shaders/py.typed +0 -0
- freestyle/types/py.typed +0 -0
- freestyle/utils/ContextFunctions/py.typed +0 -0
- freestyle/utils/py.typed +0 -0
- gpu/capabilities/py.typed +0 -0
- gpu/matrix/py.typed +0 -0
- gpu/platform/py.typed +0 -0
- gpu/select/py.typed +0 -0
- gpu/shader/py.typed +0 -0
- gpu/state/py.typed +0 -0
- gpu/texture/py.typed +0 -0
- gpu/types/py.typed +0 -0
- gpu_extras/batch/py.typed +0 -0
- gpu_extras/presets/py.typed +0 -0
- idprop/types/py.typed +0 -0
- imbuf/types/py.typed +0 -0
- mathutils/bvhtree/py.typed +0 -0
- mathutils/geometry/py.typed +0 -0
- mathutils/interpolate/py.typed +0 -0
- mathutils/kdtree/py.typed +0 -0
- mathutils/noise/py.typed +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/top_level.txt +0 -0
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import typing
|
|
2
|
+
import bpy.types
|
|
2
3
|
import bpy_types
|
|
3
4
|
|
|
4
5
|
GenericType = typing.TypeVar("GenericType")
|
|
@@ -19,22 +20,35 @@ class NODE_MT_category_texture_color(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
19
20
|
""" """
|
|
20
21
|
|
|
21
22
|
def append(self, draw_func):
|
|
22
|
-
"""
|
|
23
|
+
"""Append a draw function to this menu,
|
|
24
|
+
takes the same arguments as the menus draw function
|
|
23
25
|
|
|
24
|
-
|
|
26
|
+
:param draw_func:
|
|
25
27
|
"""
|
|
26
28
|
...
|
|
27
29
|
|
|
28
|
-
def as_pointer(self):
|
|
29
|
-
"""
|
|
30
|
+
def as_pointer(self) -> int:
|
|
31
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
32
|
+
|
|
33
|
+
:return: int (memory address).
|
|
34
|
+
:rtype: int
|
|
35
|
+
"""
|
|
30
36
|
...
|
|
31
37
|
|
|
32
|
-
def bl_rna_get_subclass(self):
|
|
33
|
-
"""
|
|
38
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
39
|
+
"""
|
|
40
|
+
|
|
41
|
+
:return: The RNA type or default when not found.
|
|
42
|
+
:rtype: bpy.types.Struct
|
|
43
|
+
"""
|
|
34
44
|
...
|
|
35
45
|
|
|
36
|
-
def bl_rna_get_subclass_py(self):
|
|
37
|
-
"""
|
|
46
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
47
|
+
"""
|
|
48
|
+
|
|
49
|
+
:return: The class or default when not found.
|
|
50
|
+
:rtype: typing.Any
|
|
51
|
+
"""
|
|
38
52
|
...
|
|
39
53
|
|
|
40
54
|
def draw(self, _context):
|
|
@@ -53,138 +67,224 @@ class NODE_MT_category_texture_color(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
53
67
|
...
|
|
54
68
|
|
|
55
69
|
def draw_preset(self, _context):
|
|
56
|
-
"""
|
|
70
|
+
"""Define these on the subclass:
|
|
71
|
+
- preset_operator (string)
|
|
72
|
+
- preset_subdir (string)Optionally:
|
|
73
|
+
- preset_add_operator (string)
|
|
74
|
+
- preset_extensions (set of strings)
|
|
75
|
+
- preset_operator_defaults (dict of keyword args)
|
|
57
76
|
|
|
58
|
-
|
|
77
|
+
:param _context:
|
|
59
78
|
"""
|
|
60
79
|
...
|
|
61
80
|
|
|
62
|
-
def driver_add(self):
|
|
63
|
-
"""
|
|
81
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
82
|
+
"""Adds driver(s) to the given property
|
|
83
|
+
|
|
84
|
+
:return: The driver(s) added.
|
|
85
|
+
:rtype: bpy.types.FCurve
|
|
86
|
+
"""
|
|
64
87
|
...
|
|
65
88
|
|
|
66
|
-
def driver_remove(self):
|
|
67
|
-
"""
|
|
89
|
+
def driver_remove(self) -> bool:
|
|
90
|
+
"""Remove driver(s) from the given property
|
|
91
|
+
|
|
92
|
+
:return: Success of driver removal.
|
|
93
|
+
:rtype: bool
|
|
94
|
+
"""
|
|
68
95
|
...
|
|
69
96
|
|
|
70
97
|
def get(self):
|
|
71
|
-
"""
|
|
98
|
+
"""Returns the value of the custom property assigned to key or default
|
|
99
|
+
when not found (matches Python's dictionary function of the same name).
|
|
100
|
+
|
|
101
|
+
"""
|
|
72
102
|
...
|
|
73
103
|
|
|
74
104
|
def id_properties_clear(self):
|
|
75
|
-
"""
|
|
105
|
+
"""
|
|
106
|
+
|
|
107
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
108
|
+
"""
|
|
76
109
|
...
|
|
77
110
|
|
|
78
111
|
def id_properties_ensure(self):
|
|
79
|
-
"""
|
|
112
|
+
"""
|
|
113
|
+
|
|
114
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
115
|
+
"""
|
|
80
116
|
...
|
|
81
117
|
|
|
82
118
|
def id_properties_ui(self):
|
|
83
|
-
"""
|
|
119
|
+
"""
|
|
120
|
+
|
|
121
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
122
|
+
"""
|
|
84
123
|
...
|
|
85
124
|
|
|
86
125
|
def is_extended(self):
|
|
87
126
|
""" """
|
|
88
127
|
...
|
|
89
128
|
|
|
90
|
-
def is_property_hidden(self):
|
|
91
|
-
"""
|
|
129
|
+
def is_property_hidden(self) -> bool:
|
|
130
|
+
"""Check if a property is hidden.
|
|
131
|
+
|
|
132
|
+
:return: True when the property is hidden.
|
|
133
|
+
:rtype: bool
|
|
134
|
+
"""
|
|
92
135
|
...
|
|
93
136
|
|
|
94
|
-
def is_property_overridable_library(self):
|
|
95
|
-
"""
|
|
137
|
+
def is_property_overridable_library(self) -> bool:
|
|
138
|
+
"""Check if a property is overridable.
|
|
139
|
+
|
|
140
|
+
:return: True when the property is overridable.
|
|
141
|
+
:rtype: bool
|
|
142
|
+
"""
|
|
96
143
|
...
|
|
97
144
|
|
|
98
|
-
def is_property_readonly(self):
|
|
99
|
-
"""
|
|
145
|
+
def is_property_readonly(self) -> bool:
|
|
146
|
+
"""Check if a property is readonly.
|
|
147
|
+
|
|
148
|
+
:return: True when the property is readonly (not writable).
|
|
149
|
+
:rtype: bool
|
|
150
|
+
"""
|
|
100
151
|
...
|
|
101
152
|
|
|
102
|
-
def is_property_set(self):
|
|
103
|
-
"""
|
|
153
|
+
def is_property_set(self) -> bool:
|
|
154
|
+
"""Check if a property is set, use for testing operator properties.
|
|
155
|
+
|
|
156
|
+
:return: True when the property has been set.
|
|
157
|
+
:rtype: bool
|
|
158
|
+
"""
|
|
104
159
|
...
|
|
105
160
|
|
|
106
161
|
def items(self):
|
|
107
|
-
"""
|
|
162
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
163
|
+
dictionary function of the same name).
|
|
164
|
+
|
|
165
|
+
:return: custom property key, value pairs.
|
|
166
|
+
"""
|
|
108
167
|
...
|
|
109
168
|
|
|
110
|
-
def keyframe_delete(self):
|
|
111
|
-
"""
|
|
169
|
+
def keyframe_delete(self) -> bool:
|
|
170
|
+
"""Remove a keyframe from this properties fcurve.
|
|
171
|
+
|
|
172
|
+
:return: Success of keyframe deletion.
|
|
173
|
+
:rtype: bool
|
|
174
|
+
"""
|
|
112
175
|
...
|
|
113
176
|
|
|
114
|
-
def keyframe_insert(self):
|
|
115
|
-
"""
|
|
177
|
+
def keyframe_insert(self) -> bool:
|
|
178
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
179
|
+
|
|
180
|
+
:return: Success of keyframe insertion.
|
|
181
|
+
:rtype: bool
|
|
182
|
+
"""
|
|
116
183
|
...
|
|
117
184
|
|
|
118
185
|
def keys(self):
|
|
119
|
-
"""
|
|
186
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
187
|
+
dictionary function of the same name).
|
|
188
|
+
|
|
189
|
+
:return: custom property keys.
|
|
190
|
+
"""
|
|
120
191
|
...
|
|
121
192
|
|
|
122
|
-
def path_from_id(self):
|
|
123
|
-
"""
|
|
193
|
+
def path_from_id(self) -> str:
|
|
194
|
+
"""Returns the data path from the ID to this object (string).
|
|
195
|
+
|
|
196
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
197
|
+
to this struct and property (when given).
|
|
198
|
+
:rtype: str
|
|
199
|
+
"""
|
|
124
200
|
...
|
|
125
201
|
|
|
126
202
|
def path_menu(
|
|
127
203
|
self,
|
|
128
|
-
searchpaths,
|
|
129
|
-
operator,
|
|
130
|
-
props_default,
|
|
131
|
-
prop_filepath,
|
|
132
|
-
filter_ext,
|
|
133
|
-
filter_path,
|
|
134
|
-
display_name,
|
|
135
|
-
add_operator,
|
|
136
|
-
add_operator_props,
|
|
204
|
+
searchpaths: list[str],
|
|
205
|
+
operator: str,
|
|
206
|
+
props_default: dict = None,
|
|
207
|
+
prop_filepath: str = "filepath",
|
|
208
|
+
filter_ext: typing.Callable = None,
|
|
209
|
+
filter_path=None,
|
|
210
|
+
display_name: typing.Callable = None,
|
|
211
|
+
add_operator=None,
|
|
212
|
+
add_operator_props=None,
|
|
137
213
|
):
|
|
138
|
-
"""
|
|
214
|
+
"""Populate a menu from a list of paths.
|
|
215
|
+
|
|
216
|
+
:param searchpaths: Paths to scan.
|
|
217
|
+
:type searchpaths: list[str]
|
|
218
|
+
:param operator: The operator id to use with each file.
|
|
219
|
+
:type operator: str
|
|
220
|
+
:param props_default: Properties to assign to each operator.
|
|
221
|
+
:type props_default: dict
|
|
222
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
223
|
+
:type prop_filepath: str
|
|
224
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
139
225
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
:param add_operator:
|
|
148
|
-
:param add_operator_props:
|
|
226
|
+
Returning false excludes the file from the list.
|
|
227
|
+
:type filter_ext: typing.Callable
|
|
228
|
+
:param filter_path:
|
|
229
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
230
|
+
:type display_name: typing.Callable
|
|
231
|
+
:param add_operator:
|
|
232
|
+
:param add_operator_props:
|
|
149
233
|
"""
|
|
150
234
|
...
|
|
151
235
|
|
|
152
236
|
def path_resolve(self):
|
|
153
|
-
""" """
|
|
237
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
154
238
|
...
|
|
155
239
|
|
|
156
240
|
def pop(self):
|
|
157
|
-
"""
|
|
241
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
242
|
+
when not found (matches Python's dictionary function of the same name).
|
|
243
|
+
|
|
244
|
+
"""
|
|
158
245
|
...
|
|
159
246
|
|
|
160
247
|
def prepend(self, draw_func):
|
|
161
|
-
"""
|
|
248
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
249
|
+
the menus draw function
|
|
162
250
|
|
|
163
|
-
|
|
251
|
+
:param draw_func:
|
|
164
252
|
"""
|
|
165
253
|
...
|
|
166
254
|
|
|
167
|
-
def property_overridable_library_set(self):
|
|
168
|
-
"""
|
|
255
|
+
def property_overridable_library_set(self) -> bool:
|
|
256
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
257
|
+
|
|
258
|
+
:return: True when the overridable status of the property was successfully set.
|
|
259
|
+
:rtype: bool
|
|
260
|
+
"""
|
|
169
261
|
...
|
|
170
262
|
|
|
171
263
|
def property_unset(self):
|
|
172
|
-
""" """
|
|
264
|
+
"""Unset a property, will use default value afterward."""
|
|
173
265
|
...
|
|
174
266
|
|
|
175
267
|
def remove(self, draw_func):
|
|
176
|
-
"""
|
|
268
|
+
"""Remove a draw function that has been added to this menu
|
|
177
269
|
|
|
178
270
|
:param draw_func:
|
|
179
271
|
"""
|
|
180
272
|
...
|
|
181
273
|
|
|
182
274
|
def type_recast(self):
|
|
183
|
-
"""
|
|
275
|
+
"""Return a new instance, this is needed because types
|
|
276
|
+
such as textures can be changed at runtime.
|
|
277
|
+
|
|
278
|
+
:return: a new instance of this object with the type initialized again.
|
|
279
|
+
"""
|
|
184
280
|
...
|
|
185
281
|
|
|
186
282
|
def values(self):
|
|
187
|
-
"""
|
|
283
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
284
|
+
dictionary function of the same name).
|
|
285
|
+
|
|
286
|
+
:return: custom property values.
|
|
287
|
+
"""
|
|
188
288
|
...
|
|
189
289
|
|
|
190
290
|
class NODE_MT_category_texture_converter(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -203,22 +303,35 @@ class NODE_MT_category_texture_converter(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
203
303
|
""" """
|
|
204
304
|
|
|
205
305
|
def append(self, draw_func):
|
|
206
|
-
"""
|
|
306
|
+
"""Append a draw function to this menu,
|
|
307
|
+
takes the same arguments as the menus draw function
|
|
207
308
|
|
|
208
|
-
|
|
309
|
+
:param draw_func:
|
|
209
310
|
"""
|
|
210
311
|
...
|
|
211
312
|
|
|
212
|
-
def as_pointer(self):
|
|
213
|
-
"""
|
|
313
|
+
def as_pointer(self) -> int:
|
|
314
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
315
|
+
|
|
316
|
+
:return: int (memory address).
|
|
317
|
+
:rtype: int
|
|
318
|
+
"""
|
|
214
319
|
...
|
|
215
320
|
|
|
216
|
-
def bl_rna_get_subclass(self):
|
|
217
|
-
"""
|
|
321
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
322
|
+
"""
|
|
323
|
+
|
|
324
|
+
:return: The RNA type or default when not found.
|
|
325
|
+
:rtype: bpy.types.Struct
|
|
326
|
+
"""
|
|
218
327
|
...
|
|
219
328
|
|
|
220
|
-
def bl_rna_get_subclass_py(self):
|
|
221
|
-
"""
|
|
329
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
330
|
+
"""
|
|
331
|
+
|
|
332
|
+
:return: The class or default when not found.
|
|
333
|
+
:rtype: typing.Any
|
|
334
|
+
"""
|
|
222
335
|
...
|
|
223
336
|
|
|
224
337
|
def draw(self, _context):
|
|
@@ -237,138 +350,224 @@ class NODE_MT_category_texture_converter(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
237
350
|
...
|
|
238
351
|
|
|
239
352
|
def draw_preset(self, _context):
|
|
240
|
-
"""
|
|
353
|
+
"""Define these on the subclass:
|
|
354
|
+
- preset_operator (string)
|
|
355
|
+
- preset_subdir (string)Optionally:
|
|
356
|
+
- preset_add_operator (string)
|
|
357
|
+
- preset_extensions (set of strings)
|
|
358
|
+
- preset_operator_defaults (dict of keyword args)
|
|
241
359
|
|
|
242
|
-
|
|
360
|
+
:param _context:
|
|
243
361
|
"""
|
|
244
362
|
...
|
|
245
363
|
|
|
246
|
-
def driver_add(self):
|
|
247
|
-
"""
|
|
364
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
365
|
+
"""Adds driver(s) to the given property
|
|
366
|
+
|
|
367
|
+
:return: The driver(s) added.
|
|
368
|
+
:rtype: bpy.types.FCurve
|
|
369
|
+
"""
|
|
248
370
|
...
|
|
249
371
|
|
|
250
|
-
def driver_remove(self):
|
|
251
|
-
"""
|
|
372
|
+
def driver_remove(self) -> bool:
|
|
373
|
+
"""Remove driver(s) from the given property
|
|
374
|
+
|
|
375
|
+
:return: Success of driver removal.
|
|
376
|
+
:rtype: bool
|
|
377
|
+
"""
|
|
252
378
|
...
|
|
253
379
|
|
|
254
380
|
def get(self):
|
|
255
|
-
"""
|
|
381
|
+
"""Returns the value of the custom property assigned to key or default
|
|
382
|
+
when not found (matches Python's dictionary function of the same name).
|
|
383
|
+
|
|
384
|
+
"""
|
|
256
385
|
...
|
|
257
386
|
|
|
258
387
|
def id_properties_clear(self):
|
|
259
|
-
"""
|
|
388
|
+
"""
|
|
389
|
+
|
|
390
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
391
|
+
"""
|
|
260
392
|
...
|
|
261
393
|
|
|
262
394
|
def id_properties_ensure(self):
|
|
263
|
-
"""
|
|
395
|
+
"""
|
|
396
|
+
|
|
397
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
398
|
+
"""
|
|
264
399
|
...
|
|
265
400
|
|
|
266
401
|
def id_properties_ui(self):
|
|
267
|
-
"""
|
|
402
|
+
"""
|
|
403
|
+
|
|
404
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
405
|
+
"""
|
|
268
406
|
...
|
|
269
407
|
|
|
270
408
|
def is_extended(self):
|
|
271
409
|
""" """
|
|
272
410
|
...
|
|
273
411
|
|
|
274
|
-
def is_property_hidden(self):
|
|
275
|
-
"""
|
|
412
|
+
def is_property_hidden(self) -> bool:
|
|
413
|
+
"""Check if a property is hidden.
|
|
414
|
+
|
|
415
|
+
:return: True when the property is hidden.
|
|
416
|
+
:rtype: bool
|
|
417
|
+
"""
|
|
276
418
|
...
|
|
277
419
|
|
|
278
|
-
def is_property_overridable_library(self):
|
|
279
|
-
"""
|
|
420
|
+
def is_property_overridable_library(self) -> bool:
|
|
421
|
+
"""Check if a property is overridable.
|
|
422
|
+
|
|
423
|
+
:return: True when the property is overridable.
|
|
424
|
+
:rtype: bool
|
|
425
|
+
"""
|
|
280
426
|
...
|
|
281
427
|
|
|
282
|
-
def is_property_readonly(self):
|
|
283
|
-
"""
|
|
428
|
+
def is_property_readonly(self) -> bool:
|
|
429
|
+
"""Check if a property is readonly.
|
|
430
|
+
|
|
431
|
+
:return: True when the property is readonly (not writable).
|
|
432
|
+
:rtype: bool
|
|
433
|
+
"""
|
|
284
434
|
...
|
|
285
435
|
|
|
286
|
-
def is_property_set(self):
|
|
287
|
-
"""
|
|
436
|
+
def is_property_set(self) -> bool:
|
|
437
|
+
"""Check if a property is set, use for testing operator properties.
|
|
438
|
+
|
|
439
|
+
:return: True when the property has been set.
|
|
440
|
+
:rtype: bool
|
|
441
|
+
"""
|
|
288
442
|
...
|
|
289
443
|
|
|
290
444
|
def items(self):
|
|
291
|
-
"""
|
|
445
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
446
|
+
dictionary function of the same name).
|
|
447
|
+
|
|
448
|
+
:return: custom property key, value pairs.
|
|
449
|
+
"""
|
|
292
450
|
...
|
|
293
451
|
|
|
294
|
-
def keyframe_delete(self):
|
|
295
|
-
"""
|
|
452
|
+
def keyframe_delete(self) -> bool:
|
|
453
|
+
"""Remove a keyframe from this properties fcurve.
|
|
454
|
+
|
|
455
|
+
:return: Success of keyframe deletion.
|
|
456
|
+
:rtype: bool
|
|
457
|
+
"""
|
|
296
458
|
...
|
|
297
459
|
|
|
298
|
-
def keyframe_insert(self):
|
|
299
|
-
"""
|
|
460
|
+
def keyframe_insert(self) -> bool:
|
|
461
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
462
|
+
|
|
463
|
+
:return: Success of keyframe insertion.
|
|
464
|
+
:rtype: bool
|
|
465
|
+
"""
|
|
300
466
|
...
|
|
301
467
|
|
|
302
468
|
def keys(self):
|
|
303
|
-
"""
|
|
469
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
470
|
+
dictionary function of the same name).
|
|
471
|
+
|
|
472
|
+
:return: custom property keys.
|
|
473
|
+
"""
|
|
304
474
|
...
|
|
305
475
|
|
|
306
|
-
def path_from_id(self):
|
|
307
|
-
"""
|
|
476
|
+
def path_from_id(self) -> str:
|
|
477
|
+
"""Returns the data path from the ID to this object (string).
|
|
478
|
+
|
|
479
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
480
|
+
to this struct and property (when given).
|
|
481
|
+
:rtype: str
|
|
482
|
+
"""
|
|
308
483
|
...
|
|
309
484
|
|
|
310
485
|
def path_menu(
|
|
311
486
|
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,
|
|
487
|
+
searchpaths: list[str],
|
|
488
|
+
operator: str,
|
|
489
|
+
props_default: dict = None,
|
|
490
|
+
prop_filepath: str = "filepath",
|
|
491
|
+
filter_ext: typing.Callable = None,
|
|
492
|
+
filter_path=None,
|
|
493
|
+
display_name: typing.Callable = None,
|
|
494
|
+
add_operator=None,
|
|
495
|
+
add_operator_props=None,
|
|
321
496
|
):
|
|
322
|
-
"""
|
|
497
|
+
"""Populate a menu from a list of paths.
|
|
323
498
|
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
499
|
+
:param searchpaths: Paths to scan.
|
|
500
|
+
:type searchpaths: list[str]
|
|
501
|
+
:param operator: The operator id to use with each file.
|
|
502
|
+
:type operator: str
|
|
503
|
+
:param props_default: Properties to assign to each operator.
|
|
504
|
+
:type props_default: dict
|
|
505
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
506
|
+
:type prop_filepath: str
|
|
507
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
508
|
+
|
|
509
|
+
Returning false excludes the file from the list.
|
|
510
|
+
:type filter_ext: typing.Callable
|
|
511
|
+
:param filter_path:
|
|
512
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
513
|
+
:type display_name: typing.Callable
|
|
514
|
+
:param add_operator:
|
|
515
|
+
:param add_operator_props:
|
|
333
516
|
"""
|
|
334
517
|
...
|
|
335
518
|
|
|
336
519
|
def path_resolve(self):
|
|
337
|
-
""" """
|
|
520
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
338
521
|
...
|
|
339
522
|
|
|
340
523
|
def pop(self):
|
|
341
|
-
"""
|
|
524
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
525
|
+
when not found (matches Python's dictionary function of the same name).
|
|
526
|
+
|
|
527
|
+
"""
|
|
342
528
|
...
|
|
343
529
|
|
|
344
530
|
def prepend(self, draw_func):
|
|
345
|
-
"""
|
|
531
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
532
|
+
the menus draw function
|
|
346
533
|
|
|
347
|
-
|
|
534
|
+
:param draw_func:
|
|
348
535
|
"""
|
|
349
536
|
...
|
|
350
537
|
|
|
351
|
-
def property_overridable_library_set(self):
|
|
352
|
-
"""
|
|
538
|
+
def property_overridable_library_set(self) -> bool:
|
|
539
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
540
|
+
|
|
541
|
+
:return: True when the overridable status of the property was successfully set.
|
|
542
|
+
:rtype: bool
|
|
543
|
+
"""
|
|
353
544
|
...
|
|
354
545
|
|
|
355
546
|
def property_unset(self):
|
|
356
|
-
""" """
|
|
547
|
+
"""Unset a property, will use default value afterward."""
|
|
357
548
|
...
|
|
358
549
|
|
|
359
550
|
def remove(self, draw_func):
|
|
360
|
-
"""
|
|
551
|
+
"""Remove a draw function that has been added to this menu
|
|
361
552
|
|
|
362
553
|
:param draw_func:
|
|
363
554
|
"""
|
|
364
555
|
...
|
|
365
556
|
|
|
366
557
|
def type_recast(self):
|
|
367
|
-
"""
|
|
558
|
+
"""Return a new instance, this is needed because types
|
|
559
|
+
such as textures can be changed at runtime.
|
|
560
|
+
|
|
561
|
+
:return: a new instance of this object with the type initialized again.
|
|
562
|
+
"""
|
|
368
563
|
...
|
|
369
564
|
|
|
370
565
|
def values(self):
|
|
371
|
-
"""
|
|
566
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
567
|
+
dictionary function of the same name).
|
|
568
|
+
|
|
569
|
+
:return: custom property values.
|
|
570
|
+
"""
|
|
372
571
|
...
|
|
373
572
|
|
|
374
573
|
class NODE_MT_category_texture_distort(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -387,22 +586,35 @@ class NODE_MT_category_texture_distort(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
387
586
|
""" """
|
|
388
587
|
|
|
389
588
|
def append(self, draw_func):
|
|
390
|
-
"""
|
|
589
|
+
"""Append a draw function to this menu,
|
|
590
|
+
takes the same arguments as the menus draw function
|
|
391
591
|
|
|
392
|
-
|
|
592
|
+
:param draw_func:
|
|
393
593
|
"""
|
|
394
594
|
...
|
|
395
595
|
|
|
396
|
-
def as_pointer(self):
|
|
397
|
-
"""
|
|
596
|
+
def as_pointer(self) -> int:
|
|
597
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
598
|
+
|
|
599
|
+
:return: int (memory address).
|
|
600
|
+
:rtype: int
|
|
601
|
+
"""
|
|
398
602
|
...
|
|
399
603
|
|
|
400
|
-
def bl_rna_get_subclass(self):
|
|
401
|
-
"""
|
|
604
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
605
|
+
"""
|
|
606
|
+
|
|
607
|
+
:return: The RNA type or default when not found.
|
|
608
|
+
:rtype: bpy.types.Struct
|
|
609
|
+
"""
|
|
402
610
|
...
|
|
403
611
|
|
|
404
|
-
def bl_rna_get_subclass_py(self):
|
|
405
|
-
"""
|
|
612
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
613
|
+
"""
|
|
614
|
+
|
|
615
|
+
:return: The class or default when not found.
|
|
616
|
+
:rtype: typing.Any
|
|
617
|
+
"""
|
|
406
618
|
...
|
|
407
619
|
|
|
408
620
|
def draw(self, _context):
|
|
@@ -421,138 +633,224 @@ class NODE_MT_category_texture_distort(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
421
633
|
...
|
|
422
634
|
|
|
423
635
|
def draw_preset(self, _context):
|
|
424
|
-
"""
|
|
636
|
+
"""Define these on the subclass:
|
|
637
|
+
- preset_operator (string)
|
|
638
|
+
- preset_subdir (string)Optionally:
|
|
639
|
+
- preset_add_operator (string)
|
|
640
|
+
- preset_extensions (set of strings)
|
|
641
|
+
- preset_operator_defaults (dict of keyword args)
|
|
425
642
|
|
|
426
|
-
|
|
643
|
+
:param _context:
|
|
427
644
|
"""
|
|
428
645
|
...
|
|
429
646
|
|
|
430
|
-
def driver_add(self):
|
|
431
|
-
"""
|
|
647
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
648
|
+
"""Adds driver(s) to the given property
|
|
649
|
+
|
|
650
|
+
:return: The driver(s) added.
|
|
651
|
+
:rtype: bpy.types.FCurve
|
|
652
|
+
"""
|
|
432
653
|
...
|
|
433
654
|
|
|
434
|
-
def driver_remove(self):
|
|
435
|
-
"""
|
|
655
|
+
def driver_remove(self) -> bool:
|
|
656
|
+
"""Remove driver(s) from the given property
|
|
657
|
+
|
|
658
|
+
:return: Success of driver removal.
|
|
659
|
+
:rtype: bool
|
|
660
|
+
"""
|
|
436
661
|
...
|
|
437
662
|
|
|
438
663
|
def get(self):
|
|
439
|
-
"""
|
|
664
|
+
"""Returns the value of the custom property assigned to key or default
|
|
665
|
+
when not found (matches Python's dictionary function of the same name).
|
|
666
|
+
|
|
667
|
+
"""
|
|
440
668
|
...
|
|
441
669
|
|
|
442
670
|
def id_properties_clear(self):
|
|
443
|
-
"""
|
|
671
|
+
"""
|
|
672
|
+
|
|
673
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
674
|
+
"""
|
|
444
675
|
...
|
|
445
676
|
|
|
446
677
|
def id_properties_ensure(self):
|
|
447
|
-
"""
|
|
678
|
+
"""
|
|
679
|
+
|
|
680
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
681
|
+
"""
|
|
448
682
|
...
|
|
449
683
|
|
|
450
684
|
def id_properties_ui(self):
|
|
451
|
-
"""
|
|
685
|
+
"""
|
|
686
|
+
|
|
687
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
688
|
+
"""
|
|
452
689
|
...
|
|
453
690
|
|
|
454
691
|
def is_extended(self):
|
|
455
692
|
""" """
|
|
456
693
|
...
|
|
457
694
|
|
|
458
|
-
def is_property_hidden(self):
|
|
459
|
-
"""
|
|
695
|
+
def is_property_hidden(self) -> bool:
|
|
696
|
+
"""Check if a property is hidden.
|
|
697
|
+
|
|
698
|
+
:return: True when the property is hidden.
|
|
699
|
+
:rtype: bool
|
|
700
|
+
"""
|
|
460
701
|
...
|
|
461
702
|
|
|
462
|
-
def is_property_overridable_library(self):
|
|
463
|
-
"""
|
|
703
|
+
def is_property_overridable_library(self) -> bool:
|
|
704
|
+
"""Check if a property is overridable.
|
|
705
|
+
|
|
706
|
+
:return: True when the property is overridable.
|
|
707
|
+
:rtype: bool
|
|
708
|
+
"""
|
|
464
709
|
...
|
|
465
710
|
|
|
466
|
-
def is_property_readonly(self):
|
|
467
|
-
"""
|
|
711
|
+
def is_property_readonly(self) -> bool:
|
|
712
|
+
"""Check if a property is readonly.
|
|
713
|
+
|
|
714
|
+
:return: True when the property is readonly (not writable).
|
|
715
|
+
:rtype: bool
|
|
716
|
+
"""
|
|
468
717
|
...
|
|
469
718
|
|
|
470
|
-
def is_property_set(self):
|
|
471
|
-
"""
|
|
719
|
+
def is_property_set(self) -> bool:
|
|
720
|
+
"""Check if a property is set, use for testing operator properties.
|
|
721
|
+
|
|
722
|
+
:return: True when the property has been set.
|
|
723
|
+
:rtype: bool
|
|
724
|
+
"""
|
|
472
725
|
...
|
|
473
726
|
|
|
474
727
|
def items(self):
|
|
475
|
-
"""
|
|
728
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
729
|
+
dictionary function of the same name).
|
|
730
|
+
|
|
731
|
+
:return: custom property key, value pairs.
|
|
732
|
+
"""
|
|
476
733
|
...
|
|
477
734
|
|
|
478
|
-
def keyframe_delete(self):
|
|
479
|
-
"""
|
|
735
|
+
def keyframe_delete(self) -> bool:
|
|
736
|
+
"""Remove a keyframe from this properties fcurve.
|
|
737
|
+
|
|
738
|
+
:return: Success of keyframe deletion.
|
|
739
|
+
:rtype: bool
|
|
740
|
+
"""
|
|
480
741
|
...
|
|
481
742
|
|
|
482
|
-
def keyframe_insert(self):
|
|
483
|
-
"""
|
|
743
|
+
def keyframe_insert(self) -> bool:
|
|
744
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
745
|
+
|
|
746
|
+
:return: Success of keyframe insertion.
|
|
747
|
+
:rtype: bool
|
|
748
|
+
"""
|
|
484
749
|
...
|
|
485
750
|
|
|
486
751
|
def keys(self):
|
|
487
|
-
"""
|
|
752
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
753
|
+
dictionary function of the same name).
|
|
754
|
+
|
|
755
|
+
:return: custom property keys.
|
|
756
|
+
"""
|
|
488
757
|
...
|
|
489
758
|
|
|
490
|
-
def path_from_id(self):
|
|
491
|
-
"""
|
|
759
|
+
def path_from_id(self) -> str:
|
|
760
|
+
"""Returns the data path from the ID to this object (string).
|
|
761
|
+
|
|
762
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
763
|
+
to this struct and property (when given).
|
|
764
|
+
:rtype: str
|
|
765
|
+
"""
|
|
492
766
|
...
|
|
493
767
|
|
|
494
768
|
def path_menu(
|
|
495
769
|
self,
|
|
496
|
-
searchpaths,
|
|
497
|
-
operator,
|
|
498
|
-
props_default,
|
|
499
|
-
prop_filepath,
|
|
500
|
-
filter_ext,
|
|
501
|
-
filter_path,
|
|
502
|
-
display_name,
|
|
503
|
-
add_operator,
|
|
504
|
-
add_operator_props,
|
|
770
|
+
searchpaths: list[str],
|
|
771
|
+
operator: str,
|
|
772
|
+
props_default: dict = None,
|
|
773
|
+
prop_filepath: str = "filepath",
|
|
774
|
+
filter_ext: typing.Callable = None,
|
|
775
|
+
filter_path=None,
|
|
776
|
+
display_name: typing.Callable = None,
|
|
777
|
+
add_operator=None,
|
|
778
|
+
add_operator_props=None,
|
|
505
779
|
):
|
|
506
|
-
"""
|
|
780
|
+
"""Populate a menu from a list of paths.
|
|
507
781
|
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
782
|
+
:param searchpaths: Paths to scan.
|
|
783
|
+
:type searchpaths: list[str]
|
|
784
|
+
:param operator: The operator id to use with each file.
|
|
785
|
+
:type operator: str
|
|
786
|
+
:param props_default: Properties to assign to each operator.
|
|
787
|
+
:type props_default: dict
|
|
788
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
789
|
+
:type prop_filepath: str
|
|
790
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
791
|
+
|
|
792
|
+
Returning false excludes the file from the list.
|
|
793
|
+
:type filter_ext: typing.Callable
|
|
794
|
+
:param filter_path:
|
|
795
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
796
|
+
:type display_name: typing.Callable
|
|
797
|
+
:param add_operator:
|
|
798
|
+
:param add_operator_props:
|
|
517
799
|
"""
|
|
518
800
|
...
|
|
519
801
|
|
|
520
802
|
def path_resolve(self):
|
|
521
|
-
""" """
|
|
803
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
522
804
|
...
|
|
523
805
|
|
|
524
806
|
def pop(self):
|
|
525
|
-
"""
|
|
807
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
808
|
+
when not found (matches Python's dictionary function of the same name).
|
|
809
|
+
|
|
810
|
+
"""
|
|
526
811
|
...
|
|
527
812
|
|
|
528
813
|
def prepend(self, draw_func):
|
|
529
|
-
"""
|
|
814
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
815
|
+
the menus draw function
|
|
530
816
|
|
|
531
|
-
|
|
817
|
+
:param draw_func:
|
|
532
818
|
"""
|
|
533
819
|
...
|
|
534
820
|
|
|
535
|
-
def property_overridable_library_set(self):
|
|
536
|
-
"""
|
|
821
|
+
def property_overridable_library_set(self) -> bool:
|
|
822
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
823
|
+
|
|
824
|
+
:return: True when the overridable status of the property was successfully set.
|
|
825
|
+
:rtype: bool
|
|
826
|
+
"""
|
|
537
827
|
...
|
|
538
828
|
|
|
539
829
|
def property_unset(self):
|
|
540
|
-
""" """
|
|
830
|
+
"""Unset a property, will use default value afterward."""
|
|
541
831
|
...
|
|
542
832
|
|
|
543
833
|
def remove(self, draw_func):
|
|
544
|
-
"""
|
|
834
|
+
"""Remove a draw function that has been added to this menu
|
|
545
835
|
|
|
546
836
|
:param draw_func:
|
|
547
837
|
"""
|
|
548
838
|
...
|
|
549
839
|
|
|
550
840
|
def type_recast(self):
|
|
551
|
-
"""
|
|
841
|
+
"""Return a new instance, this is needed because types
|
|
842
|
+
such as textures can be changed at runtime.
|
|
843
|
+
|
|
844
|
+
:return: a new instance of this object with the type initialized again.
|
|
845
|
+
"""
|
|
552
846
|
...
|
|
553
847
|
|
|
554
848
|
def values(self):
|
|
555
|
-
"""
|
|
849
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
850
|
+
dictionary function of the same name).
|
|
851
|
+
|
|
852
|
+
:return: custom property values.
|
|
853
|
+
"""
|
|
556
854
|
...
|
|
557
855
|
|
|
558
856
|
class NODE_MT_category_texture_group(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -571,22 +869,35 @@ class NODE_MT_category_texture_group(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
571
869
|
""" """
|
|
572
870
|
|
|
573
871
|
def append(self, draw_func):
|
|
574
|
-
"""
|
|
872
|
+
"""Append a draw function to this menu,
|
|
873
|
+
takes the same arguments as the menus draw function
|
|
575
874
|
|
|
576
|
-
|
|
875
|
+
:param draw_func:
|
|
577
876
|
"""
|
|
578
877
|
...
|
|
579
878
|
|
|
580
|
-
def as_pointer(self):
|
|
581
|
-
"""
|
|
879
|
+
def as_pointer(self) -> int:
|
|
880
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
881
|
+
|
|
882
|
+
:return: int (memory address).
|
|
883
|
+
:rtype: int
|
|
884
|
+
"""
|
|
582
885
|
...
|
|
583
886
|
|
|
584
|
-
def bl_rna_get_subclass(self):
|
|
585
|
-
"""
|
|
887
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
888
|
+
"""
|
|
889
|
+
|
|
890
|
+
:return: The RNA type or default when not found.
|
|
891
|
+
:rtype: bpy.types.Struct
|
|
892
|
+
"""
|
|
586
893
|
...
|
|
587
894
|
|
|
588
|
-
def bl_rna_get_subclass_py(self):
|
|
589
|
-
"""
|
|
895
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
896
|
+
"""
|
|
897
|
+
|
|
898
|
+
:return: The class or default when not found.
|
|
899
|
+
:rtype: typing.Any
|
|
900
|
+
"""
|
|
590
901
|
...
|
|
591
902
|
|
|
592
903
|
def draw(self, context):
|
|
@@ -605,138 +916,224 @@ class NODE_MT_category_texture_group(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
605
916
|
...
|
|
606
917
|
|
|
607
918
|
def draw_preset(self, _context):
|
|
608
|
-
"""
|
|
919
|
+
"""Define these on the subclass:
|
|
920
|
+
- preset_operator (string)
|
|
921
|
+
- preset_subdir (string)Optionally:
|
|
922
|
+
- preset_add_operator (string)
|
|
923
|
+
- preset_extensions (set of strings)
|
|
924
|
+
- preset_operator_defaults (dict of keyword args)
|
|
609
925
|
|
|
610
|
-
|
|
926
|
+
:param _context:
|
|
611
927
|
"""
|
|
612
928
|
...
|
|
613
929
|
|
|
614
|
-
def driver_add(self):
|
|
615
|
-
"""
|
|
930
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
931
|
+
"""Adds driver(s) to the given property
|
|
932
|
+
|
|
933
|
+
:return: The driver(s) added.
|
|
934
|
+
:rtype: bpy.types.FCurve
|
|
935
|
+
"""
|
|
616
936
|
...
|
|
617
937
|
|
|
618
|
-
def driver_remove(self):
|
|
619
|
-
"""
|
|
938
|
+
def driver_remove(self) -> bool:
|
|
939
|
+
"""Remove driver(s) from the given property
|
|
940
|
+
|
|
941
|
+
:return: Success of driver removal.
|
|
942
|
+
:rtype: bool
|
|
943
|
+
"""
|
|
620
944
|
...
|
|
621
945
|
|
|
622
946
|
def get(self):
|
|
623
|
-
"""
|
|
947
|
+
"""Returns the value of the custom property assigned to key or default
|
|
948
|
+
when not found (matches Python's dictionary function of the same name).
|
|
949
|
+
|
|
950
|
+
"""
|
|
624
951
|
...
|
|
625
952
|
|
|
626
953
|
def id_properties_clear(self):
|
|
627
|
-
"""
|
|
954
|
+
"""
|
|
955
|
+
|
|
956
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
957
|
+
"""
|
|
628
958
|
...
|
|
629
959
|
|
|
630
960
|
def id_properties_ensure(self):
|
|
631
|
-
"""
|
|
961
|
+
"""
|
|
962
|
+
|
|
963
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
964
|
+
"""
|
|
632
965
|
...
|
|
633
966
|
|
|
634
967
|
def id_properties_ui(self):
|
|
635
|
-
"""
|
|
968
|
+
"""
|
|
969
|
+
|
|
970
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
971
|
+
"""
|
|
636
972
|
...
|
|
637
973
|
|
|
638
974
|
def is_extended(self):
|
|
639
975
|
""" """
|
|
640
976
|
...
|
|
641
977
|
|
|
642
|
-
def is_property_hidden(self):
|
|
643
|
-
"""
|
|
978
|
+
def is_property_hidden(self) -> bool:
|
|
979
|
+
"""Check if a property is hidden.
|
|
980
|
+
|
|
981
|
+
:return: True when the property is hidden.
|
|
982
|
+
:rtype: bool
|
|
983
|
+
"""
|
|
644
984
|
...
|
|
645
985
|
|
|
646
|
-
def is_property_overridable_library(self):
|
|
647
|
-
"""
|
|
986
|
+
def is_property_overridable_library(self) -> bool:
|
|
987
|
+
"""Check if a property is overridable.
|
|
988
|
+
|
|
989
|
+
:return: True when the property is overridable.
|
|
990
|
+
:rtype: bool
|
|
991
|
+
"""
|
|
648
992
|
...
|
|
649
993
|
|
|
650
|
-
def is_property_readonly(self):
|
|
651
|
-
"""
|
|
994
|
+
def is_property_readonly(self) -> bool:
|
|
995
|
+
"""Check if a property is readonly.
|
|
996
|
+
|
|
997
|
+
:return: True when the property is readonly (not writable).
|
|
998
|
+
:rtype: bool
|
|
999
|
+
"""
|
|
652
1000
|
...
|
|
653
1001
|
|
|
654
|
-
def is_property_set(self):
|
|
655
|
-
"""
|
|
1002
|
+
def is_property_set(self) -> bool:
|
|
1003
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1004
|
+
|
|
1005
|
+
:return: True when the property has been set.
|
|
1006
|
+
:rtype: bool
|
|
1007
|
+
"""
|
|
656
1008
|
...
|
|
657
1009
|
|
|
658
1010
|
def items(self):
|
|
659
|
-
"""
|
|
1011
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1012
|
+
dictionary function of the same name).
|
|
1013
|
+
|
|
1014
|
+
:return: custom property key, value pairs.
|
|
1015
|
+
"""
|
|
660
1016
|
...
|
|
661
1017
|
|
|
662
|
-
def keyframe_delete(self):
|
|
663
|
-
"""
|
|
1018
|
+
def keyframe_delete(self) -> bool:
|
|
1019
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1020
|
+
|
|
1021
|
+
:return: Success of keyframe deletion.
|
|
1022
|
+
:rtype: bool
|
|
1023
|
+
"""
|
|
664
1024
|
...
|
|
665
1025
|
|
|
666
|
-
def keyframe_insert(self):
|
|
667
|
-
"""
|
|
1026
|
+
def keyframe_insert(self) -> bool:
|
|
1027
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1028
|
+
|
|
1029
|
+
:return: Success of keyframe insertion.
|
|
1030
|
+
:rtype: bool
|
|
1031
|
+
"""
|
|
668
1032
|
...
|
|
669
1033
|
|
|
670
1034
|
def keys(self):
|
|
671
|
-
"""
|
|
1035
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1036
|
+
dictionary function of the same name).
|
|
1037
|
+
|
|
1038
|
+
:return: custom property keys.
|
|
1039
|
+
"""
|
|
672
1040
|
...
|
|
673
1041
|
|
|
674
|
-
def path_from_id(self):
|
|
675
|
-
"""
|
|
1042
|
+
def path_from_id(self) -> str:
|
|
1043
|
+
"""Returns the data path from the ID to this object (string).
|
|
1044
|
+
|
|
1045
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1046
|
+
to this struct and property (when given).
|
|
1047
|
+
:rtype: str
|
|
1048
|
+
"""
|
|
676
1049
|
...
|
|
677
1050
|
|
|
678
1051
|
def path_menu(
|
|
679
1052
|
self,
|
|
680
|
-
searchpaths,
|
|
681
|
-
operator,
|
|
682
|
-
props_default,
|
|
683
|
-
prop_filepath,
|
|
684
|
-
filter_ext,
|
|
685
|
-
filter_path,
|
|
686
|
-
display_name,
|
|
687
|
-
add_operator,
|
|
688
|
-
add_operator_props,
|
|
1053
|
+
searchpaths: list[str],
|
|
1054
|
+
operator: str,
|
|
1055
|
+
props_default: dict = None,
|
|
1056
|
+
prop_filepath: str = "filepath",
|
|
1057
|
+
filter_ext: typing.Callable = None,
|
|
1058
|
+
filter_path=None,
|
|
1059
|
+
display_name: typing.Callable = None,
|
|
1060
|
+
add_operator=None,
|
|
1061
|
+
add_operator_props=None,
|
|
689
1062
|
):
|
|
690
|
-
"""
|
|
1063
|
+
"""Populate a menu from a list of paths.
|
|
691
1064
|
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
1065
|
+
:param searchpaths: Paths to scan.
|
|
1066
|
+
:type searchpaths: list[str]
|
|
1067
|
+
:param operator: The operator id to use with each file.
|
|
1068
|
+
:type operator: str
|
|
1069
|
+
:param props_default: Properties to assign to each operator.
|
|
1070
|
+
:type props_default: dict
|
|
1071
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1072
|
+
:type prop_filepath: str
|
|
1073
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1074
|
+
|
|
1075
|
+
Returning false excludes the file from the list.
|
|
1076
|
+
:type filter_ext: typing.Callable
|
|
1077
|
+
:param filter_path:
|
|
1078
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1079
|
+
:type display_name: typing.Callable
|
|
1080
|
+
:param add_operator:
|
|
1081
|
+
:param add_operator_props:
|
|
701
1082
|
"""
|
|
702
1083
|
...
|
|
703
1084
|
|
|
704
1085
|
def path_resolve(self):
|
|
705
|
-
""" """
|
|
1086
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
706
1087
|
...
|
|
707
1088
|
|
|
708
1089
|
def pop(self):
|
|
709
|
-
"""
|
|
1090
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1091
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1092
|
+
|
|
1093
|
+
"""
|
|
710
1094
|
...
|
|
711
1095
|
|
|
712
1096
|
def prepend(self, draw_func):
|
|
713
|
-
"""
|
|
1097
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1098
|
+
the menus draw function
|
|
714
1099
|
|
|
715
|
-
|
|
1100
|
+
:param draw_func:
|
|
716
1101
|
"""
|
|
717
1102
|
...
|
|
718
1103
|
|
|
719
|
-
def property_overridable_library_set(self):
|
|
720
|
-
"""
|
|
1104
|
+
def property_overridable_library_set(self) -> bool:
|
|
1105
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1106
|
+
|
|
1107
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1108
|
+
:rtype: bool
|
|
1109
|
+
"""
|
|
721
1110
|
...
|
|
722
1111
|
|
|
723
1112
|
def property_unset(self):
|
|
724
|
-
""" """
|
|
1113
|
+
"""Unset a property, will use default value afterward."""
|
|
725
1114
|
...
|
|
726
1115
|
|
|
727
1116
|
def remove(self, draw_func):
|
|
728
|
-
"""
|
|
1117
|
+
"""Remove a draw function that has been added to this menu
|
|
729
1118
|
|
|
730
1119
|
:param draw_func:
|
|
731
1120
|
"""
|
|
732
1121
|
...
|
|
733
1122
|
|
|
734
1123
|
def type_recast(self):
|
|
735
|
-
"""
|
|
1124
|
+
"""Return a new instance, this is needed because types
|
|
1125
|
+
such as textures can be changed at runtime.
|
|
1126
|
+
|
|
1127
|
+
:return: a new instance of this object with the type initialized again.
|
|
1128
|
+
"""
|
|
736
1129
|
...
|
|
737
1130
|
|
|
738
1131
|
def values(self):
|
|
739
|
-
"""
|
|
1132
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1133
|
+
dictionary function of the same name).
|
|
1134
|
+
|
|
1135
|
+
:return: custom property values.
|
|
1136
|
+
"""
|
|
740
1137
|
...
|
|
741
1138
|
|
|
742
1139
|
class NODE_MT_category_texture_input(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -755,22 +1152,35 @@ class NODE_MT_category_texture_input(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
755
1152
|
""" """
|
|
756
1153
|
|
|
757
1154
|
def append(self, draw_func):
|
|
758
|
-
"""
|
|
1155
|
+
"""Append a draw function to this menu,
|
|
1156
|
+
takes the same arguments as the menus draw function
|
|
759
1157
|
|
|
760
|
-
|
|
1158
|
+
:param draw_func:
|
|
761
1159
|
"""
|
|
762
1160
|
...
|
|
763
1161
|
|
|
764
|
-
def as_pointer(self):
|
|
765
|
-
"""
|
|
1162
|
+
def as_pointer(self) -> int:
|
|
1163
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1164
|
+
|
|
1165
|
+
:return: int (memory address).
|
|
1166
|
+
:rtype: int
|
|
1167
|
+
"""
|
|
766
1168
|
...
|
|
767
1169
|
|
|
768
|
-
def bl_rna_get_subclass(self):
|
|
769
|
-
"""
|
|
1170
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1171
|
+
"""
|
|
1172
|
+
|
|
1173
|
+
:return: The RNA type or default when not found.
|
|
1174
|
+
:rtype: bpy.types.Struct
|
|
1175
|
+
"""
|
|
770
1176
|
...
|
|
771
1177
|
|
|
772
|
-
def bl_rna_get_subclass_py(self):
|
|
773
|
-
"""
|
|
1178
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1179
|
+
"""
|
|
1180
|
+
|
|
1181
|
+
:return: The class or default when not found.
|
|
1182
|
+
:rtype: typing.Any
|
|
1183
|
+
"""
|
|
774
1184
|
...
|
|
775
1185
|
|
|
776
1186
|
def draw(self, _context):
|
|
@@ -789,138 +1199,224 @@ class NODE_MT_category_texture_input(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
789
1199
|
...
|
|
790
1200
|
|
|
791
1201
|
def draw_preset(self, _context):
|
|
792
|
-
"""
|
|
1202
|
+
"""Define these on the subclass:
|
|
1203
|
+
- preset_operator (string)
|
|
1204
|
+
- preset_subdir (string)Optionally:
|
|
1205
|
+
- preset_add_operator (string)
|
|
1206
|
+
- preset_extensions (set of strings)
|
|
1207
|
+
- preset_operator_defaults (dict of keyword args)
|
|
793
1208
|
|
|
794
|
-
|
|
1209
|
+
:param _context:
|
|
795
1210
|
"""
|
|
796
1211
|
...
|
|
797
1212
|
|
|
798
|
-
def driver_add(self):
|
|
799
|
-
"""
|
|
1213
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1214
|
+
"""Adds driver(s) to the given property
|
|
1215
|
+
|
|
1216
|
+
:return: The driver(s) added.
|
|
1217
|
+
:rtype: bpy.types.FCurve
|
|
1218
|
+
"""
|
|
800
1219
|
...
|
|
801
1220
|
|
|
802
|
-
def driver_remove(self):
|
|
803
|
-
"""
|
|
1221
|
+
def driver_remove(self) -> bool:
|
|
1222
|
+
"""Remove driver(s) from the given property
|
|
1223
|
+
|
|
1224
|
+
:return: Success of driver removal.
|
|
1225
|
+
:rtype: bool
|
|
1226
|
+
"""
|
|
804
1227
|
...
|
|
805
1228
|
|
|
806
1229
|
def get(self):
|
|
807
|
-
"""
|
|
1230
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1231
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1232
|
+
|
|
1233
|
+
"""
|
|
808
1234
|
...
|
|
809
1235
|
|
|
810
1236
|
def id_properties_clear(self):
|
|
811
|
-
"""
|
|
1237
|
+
"""
|
|
1238
|
+
|
|
1239
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1240
|
+
"""
|
|
812
1241
|
...
|
|
813
1242
|
|
|
814
1243
|
def id_properties_ensure(self):
|
|
815
|
-
"""
|
|
1244
|
+
"""
|
|
1245
|
+
|
|
1246
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1247
|
+
"""
|
|
816
1248
|
...
|
|
817
1249
|
|
|
818
1250
|
def id_properties_ui(self):
|
|
819
|
-
"""
|
|
1251
|
+
"""
|
|
1252
|
+
|
|
1253
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1254
|
+
"""
|
|
820
1255
|
...
|
|
821
1256
|
|
|
822
1257
|
def is_extended(self):
|
|
823
1258
|
""" """
|
|
824
1259
|
...
|
|
825
1260
|
|
|
826
|
-
def is_property_hidden(self):
|
|
827
|
-
"""
|
|
1261
|
+
def is_property_hidden(self) -> bool:
|
|
1262
|
+
"""Check if a property is hidden.
|
|
1263
|
+
|
|
1264
|
+
:return: True when the property is hidden.
|
|
1265
|
+
:rtype: bool
|
|
1266
|
+
"""
|
|
828
1267
|
...
|
|
829
1268
|
|
|
830
|
-
def is_property_overridable_library(self):
|
|
831
|
-
"""
|
|
1269
|
+
def is_property_overridable_library(self) -> bool:
|
|
1270
|
+
"""Check if a property is overridable.
|
|
1271
|
+
|
|
1272
|
+
:return: True when the property is overridable.
|
|
1273
|
+
:rtype: bool
|
|
1274
|
+
"""
|
|
832
1275
|
...
|
|
833
1276
|
|
|
834
|
-
def is_property_readonly(self):
|
|
835
|
-
"""
|
|
1277
|
+
def is_property_readonly(self) -> bool:
|
|
1278
|
+
"""Check if a property is readonly.
|
|
1279
|
+
|
|
1280
|
+
:return: True when the property is readonly (not writable).
|
|
1281
|
+
:rtype: bool
|
|
1282
|
+
"""
|
|
836
1283
|
...
|
|
837
1284
|
|
|
838
|
-
def is_property_set(self):
|
|
839
|
-
"""
|
|
1285
|
+
def is_property_set(self) -> bool:
|
|
1286
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1287
|
+
|
|
1288
|
+
:return: True when the property has been set.
|
|
1289
|
+
:rtype: bool
|
|
1290
|
+
"""
|
|
840
1291
|
...
|
|
841
1292
|
|
|
842
1293
|
def items(self):
|
|
843
|
-
"""
|
|
1294
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1295
|
+
dictionary function of the same name).
|
|
1296
|
+
|
|
1297
|
+
:return: custom property key, value pairs.
|
|
1298
|
+
"""
|
|
844
1299
|
...
|
|
845
1300
|
|
|
846
|
-
def keyframe_delete(self):
|
|
847
|
-
"""
|
|
1301
|
+
def keyframe_delete(self) -> bool:
|
|
1302
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1303
|
+
|
|
1304
|
+
:return: Success of keyframe deletion.
|
|
1305
|
+
:rtype: bool
|
|
1306
|
+
"""
|
|
848
1307
|
...
|
|
849
1308
|
|
|
850
|
-
def keyframe_insert(self):
|
|
851
|
-
"""
|
|
1309
|
+
def keyframe_insert(self) -> bool:
|
|
1310
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1311
|
+
|
|
1312
|
+
:return: Success of keyframe insertion.
|
|
1313
|
+
:rtype: bool
|
|
1314
|
+
"""
|
|
852
1315
|
...
|
|
853
1316
|
|
|
854
1317
|
def keys(self):
|
|
855
|
-
"""
|
|
1318
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1319
|
+
dictionary function of the same name).
|
|
1320
|
+
|
|
1321
|
+
:return: custom property keys.
|
|
1322
|
+
"""
|
|
856
1323
|
...
|
|
857
1324
|
|
|
858
|
-
def path_from_id(self):
|
|
859
|
-
"""
|
|
1325
|
+
def path_from_id(self) -> str:
|
|
1326
|
+
"""Returns the data path from the ID to this object (string).
|
|
1327
|
+
|
|
1328
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1329
|
+
to this struct and property (when given).
|
|
1330
|
+
:rtype: str
|
|
1331
|
+
"""
|
|
860
1332
|
...
|
|
861
1333
|
|
|
862
1334
|
def path_menu(
|
|
863
1335
|
self,
|
|
864
|
-
searchpaths,
|
|
865
|
-
operator,
|
|
866
|
-
props_default,
|
|
867
|
-
prop_filepath,
|
|
868
|
-
filter_ext,
|
|
869
|
-
filter_path,
|
|
870
|
-
display_name,
|
|
871
|
-
add_operator,
|
|
872
|
-
add_operator_props,
|
|
1336
|
+
searchpaths: list[str],
|
|
1337
|
+
operator: str,
|
|
1338
|
+
props_default: dict = None,
|
|
1339
|
+
prop_filepath: str = "filepath",
|
|
1340
|
+
filter_ext: typing.Callable = None,
|
|
1341
|
+
filter_path=None,
|
|
1342
|
+
display_name: typing.Callable = None,
|
|
1343
|
+
add_operator=None,
|
|
1344
|
+
add_operator_props=None,
|
|
873
1345
|
):
|
|
874
|
-
"""
|
|
1346
|
+
"""Populate a menu from a list of paths.
|
|
875
1347
|
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
1348
|
+
:param searchpaths: Paths to scan.
|
|
1349
|
+
:type searchpaths: list[str]
|
|
1350
|
+
:param operator: The operator id to use with each file.
|
|
1351
|
+
:type operator: str
|
|
1352
|
+
:param props_default: Properties to assign to each operator.
|
|
1353
|
+
:type props_default: dict
|
|
1354
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1355
|
+
:type prop_filepath: str
|
|
1356
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1357
|
+
|
|
1358
|
+
Returning false excludes the file from the list.
|
|
1359
|
+
:type filter_ext: typing.Callable
|
|
1360
|
+
:param filter_path:
|
|
1361
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1362
|
+
:type display_name: typing.Callable
|
|
1363
|
+
:param add_operator:
|
|
1364
|
+
:param add_operator_props:
|
|
885
1365
|
"""
|
|
886
1366
|
...
|
|
887
1367
|
|
|
888
1368
|
def path_resolve(self):
|
|
889
|
-
""" """
|
|
1369
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
890
1370
|
...
|
|
891
1371
|
|
|
892
1372
|
def pop(self):
|
|
893
|
-
"""
|
|
1373
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1374
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1375
|
+
|
|
1376
|
+
"""
|
|
894
1377
|
...
|
|
895
1378
|
|
|
896
1379
|
def prepend(self, draw_func):
|
|
897
|
-
"""
|
|
1380
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1381
|
+
the menus draw function
|
|
898
1382
|
|
|
899
|
-
|
|
1383
|
+
:param draw_func:
|
|
900
1384
|
"""
|
|
901
1385
|
...
|
|
902
1386
|
|
|
903
|
-
def property_overridable_library_set(self):
|
|
904
|
-
"""
|
|
1387
|
+
def property_overridable_library_set(self) -> bool:
|
|
1388
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1389
|
+
|
|
1390
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1391
|
+
:rtype: bool
|
|
1392
|
+
"""
|
|
905
1393
|
...
|
|
906
1394
|
|
|
907
1395
|
def property_unset(self):
|
|
908
|
-
""" """
|
|
1396
|
+
"""Unset a property, will use default value afterward."""
|
|
909
1397
|
...
|
|
910
1398
|
|
|
911
1399
|
def remove(self, draw_func):
|
|
912
|
-
"""
|
|
1400
|
+
"""Remove a draw function that has been added to this menu
|
|
913
1401
|
|
|
914
1402
|
:param draw_func:
|
|
915
1403
|
"""
|
|
916
1404
|
...
|
|
917
1405
|
|
|
918
1406
|
def type_recast(self):
|
|
919
|
-
"""
|
|
1407
|
+
"""Return a new instance, this is needed because types
|
|
1408
|
+
such as textures can be changed at runtime.
|
|
1409
|
+
|
|
1410
|
+
:return: a new instance of this object with the type initialized again.
|
|
1411
|
+
"""
|
|
920
1412
|
...
|
|
921
1413
|
|
|
922
1414
|
def values(self):
|
|
923
|
-
"""
|
|
1415
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1416
|
+
dictionary function of the same name).
|
|
1417
|
+
|
|
1418
|
+
:return: custom property values.
|
|
1419
|
+
"""
|
|
924
1420
|
...
|
|
925
1421
|
|
|
926
1422
|
class NODE_MT_category_texture_output(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -939,22 +1435,35 @@ class NODE_MT_category_texture_output(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
939
1435
|
""" """
|
|
940
1436
|
|
|
941
1437
|
def append(self, draw_func):
|
|
942
|
-
"""
|
|
1438
|
+
"""Append a draw function to this menu,
|
|
1439
|
+
takes the same arguments as the menus draw function
|
|
943
1440
|
|
|
944
|
-
|
|
1441
|
+
:param draw_func:
|
|
945
1442
|
"""
|
|
946
1443
|
...
|
|
947
1444
|
|
|
948
|
-
def as_pointer(self):
|
|
949
|
-
"""
|
|
1445
|
+
def as_pointer(self) -> int:
|
|
1446
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1447
|
+
|
|
1448
|
+
:return: int (memory address).
|
|
1449
|
+
:rtype: int
|
|
1450
|
+
"""
|
|
950
1451
|
...
|
|
951
1452
|
|
|
952
|
-
def bl_rna_get_subclass(self):
|
|
953
|
-
"""
|
|
1453
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1454
|
+
"""
|
|
1455
|
+
|
|
1456
|
+
:return: The RNA type or default when not found.
|
|
1457
|
+
:rtype: bpy.types.Struct
|
|
1458
|
+
"""
|
|
954
1459
|
...
|
|
955
1460
|
|
|
956
|
-
def bl_rna_get_subclass_py(self):
|
|
957
|
-
"""
|
|
1461
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1462
|
+
"""
|
|
1463
|
+
|
|
1464
|
+
:return: The class or default when not found.
|
|
1465
|
+
:rtype: typing.Any
|
|
1466
|
+
"""
|
|
958
1467
|
...
|
|
959
1468
|
|
|
960
1469
|
def draw(self, _context):
|
|
@@ -973,138 +1482,224 @@ class NODE_MT_category_texture_output(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
973
1482
|
...
|
|
974
1483
|
|
|
975
1484
|
def draw_preset(self, _context):
|
|
976
|
-
"""
|
|
1485
|
+
"""Define these on the subclass:
|
|
1486
|
+
- preset_operator (string)
|
|
1487
|
+
- preset_subdir (string)Optionally:
|
|
1488
|
+
- preset_add_operator (string)
|
|
1489
|
+
- preset_extensions (set of strings)
|
|
1490
|
+
- preset_operator_defaults (dict of keyword args)
|
|
977
1491
|
|
|
978
|
-
|
|
1492
|
+
:param _context:
|
|
979
1493
|
"""
|
|
980
1494
|
...
|
|
981
1495
|
|
|
982
|
-
def driver_add(self):
|
|
983
|
-
"""
|
|
1496
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1497
|
+
"""Adds driver(s) to the given property
|
|
1498
|
+
|
|
1499
|
+
:return: The driver(s) added.
|
|
1500
|
+
:rtype: bpy.types.FCurve
|
|
1501
|
+
"""
|
|
984
1502
|
...
|
|
985
1503
|
|
|
986
|
-
def driver_remove(self):
|
|
987
|
-
"""
|
|
1504
|
+
def driver_remove(self) -> bool:
|
|
1505
|
+
"""Remove driver(s) from the given property
|
|
1506
|
+
|
|
1507
|
+
:return: Success of driver removal.
|
|
1508
|
+
:rtype: bool
|
|
1509
|
+
"""
|
|
988
1510
|
...
|
|
989
1511
|
|
|
990
1512
|
def get(self):
|
|
991
|
-
"""
|
|
1513
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1514
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1515
|
+
|
|
1516
|
+
"""
|
|
992
1517
|
...
|
|
993
1518
|
|
|
994
1519
|
def id_properties_clear(self):
|
|
995
|
-
"""
|
|
1520
|
+
"""
|
|
1521
|
+
|
|
1522
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1523
|
+
"""
|
|
996
1524
|
...
|
|
997
1525
|
|
|
998
1526
|
def id_properties_ensure(self):
|
|
999
|
-
"""
|
|
1527
|
+
"""
|
|
1528
|
+
|
|
1529
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1530
|
+
"""
|
|
1000
1531
|
...
|
|
1001
1532
|
|
|
1002
1533
|
def id_properties_ui(self):
|
|
1003
|
-
"""
|
|
1534
|
+
"""
|
|
1535
|
+
|
|
1536
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1537
|
+
"""
|
|
1004
1538
|
...
|
|
1005
1539
|
|
|
1006
1540
|
def is_extended(self):
|
|
1007
1541
|
""" """
|
|
1008
1542
|
...
|
|
1009
1543
|
|
|
1010
|
-
def is_property_hidden(self):
|
|
1011
|
-
"""
|
|
1544
|
+
def is_property_hidden(self) -> bool:
|
|
1545
|
+
"""Check if a property is hidden.
|
|
1546
|
+
|
|
1547
|
+
:return: True when the property is hidden.
|
|
1548
|
+
:rtype: bool
|
|
1549
|
+
"""
|
|
1012
1550
|
...
|
|
1013
1551
|
|
|
1014
|
-
def is_property_overridable_library(self):
|
|
1015
|
-
"""
|
|
1552
|
+
def is_property_overridable_library(self) -> bool:
|
|
1553
|
+
"""Check if a property is overridable.
|
|
1554
|
+
|
|
1555
|
+
:return: True when the property is overridable.
|
|
1556
|
+
:rtype: bool
|
|
1557
|
+
"""
|
|
1016
1558
|
...
|
|
1017
1559
|
|
|
1018
|
-
def is_property_readonly(self):
|
|
1019
|
-
"""
|
|
1560
|
+
def is_property_readonly(self) -> bool:
|
|
1561
|
+
"""Check if a property is readonly.
|
|
1562
|
+
|
|
1563
|
+
:return: True when the property is readonly (not writable).
|
|
1564
|
+
:rtype: bool
|
|
1565
|
+
"""
|
|
1020
1566
|
...
|
|
1021
1567
|
|
|
1022
|
-
def is_property_set(self):
|
|
1023
|
-
"""
|
|
1568
|
+
def is_property_set(self) -> bool:
|
|
1569
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1570
|
+
|
|
1571
|
+
:return: True when the property has been set.
|
|
1572
|
+
:rtype: bool
|
|
1573
|
+
"""
|
|
1024
1574
|
...
|
|
1025
1575
|
|
|
1026
1576
|
def items(self):
|
|
1027
|
-
"""
|
|
1577
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1578
|
+
dictionary function of the same name).
|
|
1579
|
+
|
|
1580
|
+
:return: custom property key, value pairs.
|
|
1581
|
+
"""
|
|
1028
1582
|
...
|
|
1029
1583
|
|
|
1030
|
-
def keyframe_delete(self):
|
|
1031
|
-
"""
|
|
1584
|
+
def keyframe_delete(self) -> bool:
|
|
1585
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1586
|
+
|
|
1587
|
+
:return: Success of keyframe deletion.
|
|
1588
|
+
:rtype: bool
|
|
1589
|
+
"""
|
|
1032
1590
|
...
|
|
1033
1591
|
|
|
1034
|
-
def keyframe_insert(self):
|
|
1035
|
-
"""
|
|
1592
|
+
def keyframe_insert(self) -> bool:
|
|
1593
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1594
|
+
|
|
1595
|
+
:return: Success of keyframe insertion.
|
|
1596
|
+
:rtype: bool
|
|
1597
|
+
"""
|
|
1036
1598
|
...
|
|
1037
1599
|
|
|
1038
1600
|
def keys(self):
|
|
1039
|
-
"""
|
|
1601
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1602
|
+
dictionary function of the same name).
|
|
1603
|
+
|
|
1604
|
+
:return: custom property keys.
|
|
1605
|
+
"""
|
|
1040
1606
|
...
|
|
1041
1607
|
|
|
1042
|
-
def path_from_id(self):
|
|
1043
|
-
"""
|
|
1608
|
+
def path_from_id(self) -> str:
|
|
1609
|
+
"""Returns the data path from the ID to this object (string).
|
|
1610
|
+
|
|
1611
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1612
|
+
to this struct and property (when given).
|
|
1613
|
+
:rtype: str
|
|
1614
|
+
"""
|
|
1044
1615
|
...
|
|
1045
1616
|
|
|
1046
1617
|
def path_menu(
|
|
1047
1618
|
self,
|
|
1048
|
-
searchpaths,
|
|
1049
|
-
operator,
|
|
1050
|
-
props_default,
|
|
1051
|
-
prop_filepath,
|
|
1052
|
-
filter_ext,
|
|
1053
|
-
filter_path,
|
|
1054
|
-
display_name,
|
|
1055
|
-
add_operator,
|
|
1056
|
-
add_operator_props,
|
|
1619
|
+
searchpaths: list[str],
|
|
1620
|
+
operator: str,
|
|
1621
|
+
props_default: dict = None,
|
|
1622
|
+
prop_filepath: str = "filepath",
|
|
1623
|
+
filter_ext: typing.Callable = None,
|
|
1624
|
+
filter_path=None,
|
|
1625
|
+
display_name: typing.Callable = None,
|
|
1626
|
+
add_operator=None,
|
|
1627
|
+
add_operator_props=None,
|
|
1057
1628
|
):
|
|
1058
|
-
"""
|
|
1629
|
+
"""Populate a menu from a list of paths.
|
|
1630
|
+
|
|
1631
|
+
:param searchpaths: Paths to scan.
|
|
1632
|
+
:type searchpaths: list[str]
|
|
1633
|
+
:param operator: The operator id to use with each file.
|
|
1634
|
+
:type operator: str
|
|
1635
|
+
:param props_default: Properties to assign to each operator.
|
|
1636
|
+
:type props_default: dict
|
|
1637
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1638
|
+
:type prop_filepath: str
|
|
1639
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1059
1640
|
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
:param add_operator:
|
|
1068
|
-
:param add_operator_props:
|
|
1641
|
+
Returning false excludes the file from the list.
|
|
1642
|
+
:type filter_ext: typing.Callable
|
|
1643
|
+
:param filter_path:
|
|
1644
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1645
|
+
:type display_name: typing.Callable
|
|
1646
|
+
:param add_operator:
|
|
1647
|
+
:param add_operator_props:
|
|
1069
1648
|
"""
|
|
1070
1649
|
...
|
|
1071
1650
|
|
|
1072
1651
|
def path_resolve(self):
|
|
1073
|
-
""" """
|
|
1652
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1074
1653
|
...
|
|
1075
1654
|
|
|
1076
1655
|
def pop(self):
|
|
1077
|
-
"""
|
|
1656
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1657
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1658
|
+
|
|
1659
|
+
"""
|
|
1078
1660
|
...
|
|
1079
1661
|
|
|
1080
1662
|
def prepend(self, draw_func):
|
|
1081
|
-
"""
|
|
1663
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1664
|
+
the menus draw function
|
|
1082
1665
|
|
|
1083
|
-
|
|
1666
|
+
:param draw_func:
|
|
1084
1667
|
"""
|
|
1085
1668
|
...
|
|
1086
1669
|
|
|
1087
|
-
def property_overridable_library_set(self):
|
|
1088
|
-
"""
|
|
1670
|
+
def property_overridable_library_set(self) -> bool:
|
|
1671
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1672
|
+
|
|
1673
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1674
|
+
:rtype: bool
|
|
1675
|
+
"""
|
|
1089
1676
|
...
|
|
1090
1677
|
|
|
1091
1678
|
def property_unset(self):
|
|
1092
|
-
""" """
|
|
1679
|
+
"""Unset a property, will use default value afterward."""
|
|
1093
1680
|
...
|
|
1094
1681
|
|
|
1095
1682
|
def remove(self, draw_func):
|
|
1096
|
-
"""
|
|
1683
|
+
"""Remove a draw function that has been added to this menu
|
|
1097
1684
|
|
|
1098
1685
|
:param draw_func:
|
|
1099
1686
|
"""
|
|
1100
1687
|
...
|
|
1101
1688
|
|
|
1102
1689
|
def type_recast(self):
|
|
1103
|
-
"""
|
|
1690
|
+
"""Return a new instance, this is needed because types
|
|
1691
|
+
such as textures can be changed at runtime.
|
|
1692
|
+
|
|
1693
|
+
:return: a new instance of this object with the type initialized again.
|
|
1694
|
+
"""
|
|
1104
1695
|
...
|
|
1105
1696
|
|
|
1106
1697
|
def values(self):
|
|
1107
|
-
"""
|
|
1698
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1699
|
+
dictionary function of the same name).
|
|
1700
|
+
|
|
1701
|
+
:return: custom property values.
|
|
1702
|
+
"""
|
|
1108
1703
|
...
|
|
1109
1704
|
|
|
1110
1705
|
class NODE_MT_category_texture_pattern(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -1123,22 +1718,35 @@ class NODE_MT_category_texture_pattern(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1123
1718
|
""" """
|
|
1124
1719
|
|
|
1125
1720
|
def append(self, draw_func):
|
|
1126
|
-
"""
|
|
1721
|
+
"""Append a draw function to this menu,
|
|
1722
|
+
takes the same arguments as the menus draw function
|
|
1127
1723
|
|
|
1128
|
-
|
|
1724
|
+
:param draw_func:
|
|
1129
1725
|
"""
|
|
1130
1726
|
...
|
|
1131
1727
|
|
|
1132
|
-
def as_pointer(self):
|
|
1133
|
-
"""
|
|
1728
|
+
def as_pointer(self) -> int:
|
|
1729
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1730
|
+
|
|
1731
|
+
:return: int (memory address).
|
|
1732
|
+
:rtype: int
|
|
1733
|
+
"""
|
|
1134
1734
|
...
|
|
1135
1735
|
|
|
1136
|
-
def bl_rna_get_subclass(self):
|
|
1137
|
-
"""
|
|
1736
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1737
|
+
"""
|
|
1738
|
+
|
|
1739
|
+
:return: The RNA type or default when not found.
|
|
1740
|
+
:rtype: bpy.types.Struct
|
|
1741
|
+
"""
|
|
1138
1742
|
...
|
|
1139
1743
|
|
|
1140
|
-
def bl_rna_get_subclass_py(self):
|
|
1141
|
-
"""
|
|
1744
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1745
|
+
"""
|
|
1746
|
+
|
|
1747
|
+
:return: The class or default when not found.
|
|
1748
|
+
:rtype: typing.Any
|
|
1749
|
+
"""
|
|
1142
1750
|
...
|
|
1143
1751
|
|
|
1144
1752
|
def draw(self, _context):
|
|
@@ -1157,138 +1765,224 @@ class NODE_MT_category_texture_pattern(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1157
1765
|
...
|
|
1158
1766
|
|
|
1159
1767
|
def draw_preset(self, _context):
|
|
1160
|
-
"""
|
|
1768
|
+
"""Define these on the subclass:
|
|
1769
|
+
- preset_operator (string)
|
|
1770
|
+
- preset_subdir (string)Optionally:
|
|
1771
|
+
- preset_add_operator (string)
|
|
1772
|
+
- preset_extensions (set of strings)
|
|
1773
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1161
1774
|
|
|
1162
|
-
|
|
1775
|
+
:param _context:
|
|
1163
1776
|
"""
|
|
1164
1777
|
...
|
|
1165
1778
|
|
|
1166
|
-
def driver_add(self):
|
|
1167
|
-
"""
|
|
1779
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
1780
|
+
"""Adds driver(s) to the given property
|
|
1781
|
+
|
|
1782
|
+
:return: The driver(s) added.
|
|
1783
|
+
:rtype: bpy.types.FCurve
|
|
1784
|
+
"""
|
|
1168
1785
|
...
|
|
1169
1786
|
|
|
1170
|
-
def driver_remove(self):
|
|
1171
|
-
"""
|
|
1787
|
+
def driver_remove(self) -> bool:
|
|
1788
|
+
"""Remove driver(s) from the given property
|
|
1789
|
+
|
|
1790
|
+
:return: Success of driver removal.
|
|
1791
|
+
:rtype: bool
|
|
1792
|
+
"""
|
|
1172
1793
|
...
|
|
1173
1794
|
|
|
1174
1795
|
def get(self):
|
|
1175
|
-
"""
|
|
1796
|
+
"""Returns the value of the custom property assigned to key or default
|
|
1797
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1798
|
+
|
|
1799
|
+
"""
|
|
1176
1800
|
...
|
|
1177
1801
|
|
|
1178
1802
|
def id_properties_clear(self):
|
|
1179
|
-
"""
|
|
1803
|
+
"""
|
|
1804
|
+
|
|
1805
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1806
|
+
"""
|
|
1180
1807
|
...
|
|
1181
1808
|
|
|
1182
1809
|
def id_properties_ensure(self):
|
|
1183
|
-
"""
|
|
1810
|
+
"""
|
|
1811
|
+
|
|
1812
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1813
|
+
"""
|
|
1184
1814
|
...
|
|
1185
1815
|
|
|
1186
1816
|
def id_properties_ui(self):
|
|
1187
|
-
"""
|
|
1817
|
+
"""
|
|
1818
|
+
|
|
1819
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
1820
|
+
"""
|
|
1188
1821
|
...
|
|
1189
1822
|
|
|
1190
1823
|
def is_extended(self):
|
|
1191
1824
|
""" """
|
|
1192
1825
|
...
|
|
1193
1826
|
|
|
1194
|
-
def is_property_hidden(self):
|
|
1195
|
-
"""
|
|
1827
|
+
def is_property_hidden(self) -> bool:
|
|
1828
|
+
"""Check if a property is hidden.
|
|
1829
|
+
|
|
1830
|
+
:return: True when the property is hidden.
|
|
1831
|
+
:rtype: bool
|
|
1832
|
+
"""
|
|
1196
1833
|
...
|
|
1197
1834
|
|
|
1198
|
-
def is_property_overridable_library(self):
|
|
1199
|
-
"""
|
|
1835
|
+
def is_property_overridable_library(self) -> bool:
|
|
1836
|
+
"""Check if a property is overridable.
|
|
1837
|
+
|
|
1838
|
+
:return: True when the property is overridable.
|
|
1839
|
+
:rtype: bool
|
|
1840
|
+
"""
|
|
1200
1841
|
...
|
|
1201
1842
|
|
|
1202
|
-
def is_property_readonly(self):
|
|
1203
|
-
"""
|
|
1843
|
+
def is_property_readonly(self) -> bool:
|
|
1844
|
+
"""Check if a property is readonly.
|
|
1845
|
+
|
|
1846
|
+
:return: True when the property is readonly (not writable).
|
|
1847
|
+
:rtype: bool
|
|
1848
|
+
"""
|
|
1204
1849
|
...
|
|
1205
1850
|
|
|
1206
|
-
def is_property_set(self):
|
|
1207
|
-
"""
|
|
1851
|
+
def is_property_set(self) -> bool:
|
|
1852
|
+
"""Check if a property is set, use for testing operator properties.
|
|
1853
|
+
|
|
1854
|
+
:return: True when the property has been set.
|
|
1855
|
+
:rtype: bool
|
|
1856
|
+
"""
|
|
1208
1857
|
...
|
|
1209
1858
|
|
|
1210
1859
|
def items(self):
|
|
1211
|
-
"""
|
|
1860
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
1861
|
+
dictionary function of the same name).
|
|
1862
|
+
|
|
1863
|
+
:return: custom property key, value pairs.
|
|
1864
|
+
"""
|
|
1212
1865
|
...
|
|
1213
1866
|
|
|
1214
|
-
def keyframe_delete(self):
|
|
1215
|
-
"""
|
|
1867
|
+
def keyframe_delete(self) -> bool:
|
|
1868
|
+
"""Remove a keyframe from this properties fcurve.
|
|
1869
|
+
|
|
1870
|
+
:return: Success of keyframe deletion.
|
|
1871
|
+
:rtype: bool
|
|
1872
|
+
"""
|
|
1216
1873
|
...
|
|
1217
1874
|
|
|
1218
|
-
def keyframe_insert(self):
|
|
1219
|
-
"""
|
|
1875
|
+
def keyframe_insert(self) -> bool:
|
|
1876
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1877
|
+
|
|
1878
|
+
:return: Success of keyframe insertion.
|
|
1879
|
+
:rtype: bool
|
|
1880
|
+
"""
|
|
1220
1881
|
...
|
|
1221
1882
|
|
|
1222
1883
|
def keys(self):
|
|
1223
|
-
"""
|
|
1884
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
1885
|
+
dictionary function of the same name).
|
|
1886
|
+
|
|
1887
|
+
:return: custom property keys.
|
|
1888
|
+
"""
|
|
1224
1889
|
...
|
|
1225
1890
|
|
|
1226
|
-
def path_from_id(self):
|
|
1227
|
-
"""
|
|
1891
|
+
def path_from_id(self) -> str:
|
|
1892
|
+
"""Returns the data path from the ID to this object (string).
|
|
1893
|
+
|
|
1894
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1895
|
+
to this struct and property (when given).
|
|
1896
|
+
:rtype: str
|
|
1897
|
+
"""
|
|
1228
1898
|
...
|
|
1229
1899
|
|
|
1230
1900
|
def path_menu(
|
|
1231
1901
|
self,
|
|
1232
|
-
searchpaths,
|
|
1233
|
-
operator,
|
|
1234
|
-
props_default,
|
|
1235
|
-
prop_filepath,
|
|
1236
|
-
filter_ext,
|
|
1237
|
-
filter_path,
|
|
1238
|
-
display_name,
|
|
1239
|
-
add_operator,
|
|
1240
|
-
add_operator_props,
|
|
1902
|
+
searchpaths: list[str],
|
|
1903
|
+
operator: str,
|
|
1904
|
+
props_default: dict = None,
|
|
1905
|
+
prop_filepath: str = "filepath",
|
|
1906
|
+
filter_ext: typing.Callable = None,
|
|
1907
|
+
filter_path=None,
|
|
1908
|
+
display_name: typing.Callable = None,
|
|
1909
|
+
add_operator=None,
|
|
1910
|
+
add_operator_props=None,
|
|
1241
1911
|
):
|
|
1242
|
-
"""
|
|
1912
|
+
"""Populate a menu from a list of paths.
|
|
1243
1913
|
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1914
|
+
:param searchpaths: Paths to scan.
|
|
1915
|
+
:type searchpaths: list[str]
|
|
1916
|
+
:param operator: The operator id to use with each file.
|
|
1917
|
+
:type operator: str
|
|
1918
|
+
:param props_default: Properties to assign to each operator.
|
|
1919
|
+
:type props_default: dict
|
|
1920
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1921
|
+
:type prop_filepath: str
|
|
1922
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
1923
|
+
|
|
1924
|
+
Returning false excludes the file from the list.
|
|
1925
|
+
:type filter_ext: typing.Callable
|
|
1926
|
+
:param filter_path:
|
|
1927
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1928
|
+
:type display_name: typing.Callable
|
|
1929
|
+
:param add_operator:
|
|
1930
|
+
:param add_operator_props:
|
|
1253
1931
|
"""
|
|
1254
1932
|
...
|
|
1255
1933
|
|
|
1256
1934
|
def path_resolve(self):
|
|
1257
|
-
""" """
|
|
1935
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1258
1936
|
...
|
|
1259
1937
|
|
|
1260
1938
|
def pop(self):
|
|
1261
|
-
"""
|
|
1939
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
1940
|
+
when not found (matches Python's dictionary function of the same name).
|
|
1941
|
+
|
|
1942
|
+
"""
|
|
1262
1943
|
...
|
|
1263
1944
|
|
|
1264
1945
|
def prepend(self, draw_func):
|
|
1265
|
-
"""
|
|
1946
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1947
|
+
the menus draw function
|
|
1266
1948
|
|
|
1267
|
-
|
|
1949
|
+
:param draw_func:
|
|
1268
1950
|
"""
|
|
1269
1951
|
...
|
|
1270
1952
|
|
|
1271
|
-
def property_overridable_library_set(self):
|
|
1272
|
-
"""
|
|
1953
|
+
def property_overridable_library_set(self) -> bool:
|
|
1954
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
1955
|
+
|
|
1956
|
+
:return: True when the overridable status of the property was successfully set.
|
|
1957
|
+
:rtype: bool
|
|
1958
|
+
"""
|
|
1273
1959
|
...
|
|
1274
1960
|
|
|
1275
1961
|
def property_unset(self):
|
|
1276
|
-
""" """
|
|
1962
|
+
"""Unset a property, will use default value afterward."""
|
|
1277
1963
|
...
|
|
1278
1964
|
|
|
1279
1965
|
def remove(self, draw_func):
|
|
1280
|
-
"""
|
|
1966
|
+
"""Remove a draw function that has been added to this menu
|
|
1281
1967
|
|
|
1282
1968
|
:param draw_func:
|
|
1283
1969
|
"""
|
|
1284
1970
|
...
|
|
1285
1971
|
|
|
1286
1972
|
def type_recast(self):
|
|
1287
|
-
"""
|
|
1973
|
+
"""Return a new instance, this is needed because types
|
|
1974
|
+
such as textures can be changed at runtime.
|
|
1975
|
+
|
|
1976
|
+
:return: a new instance of this object with the type initialized again.
|
|
1977
|
+
"""
|
|
1288
1978
|
...
|
|
1289
1979
|
|
|
1290
1980
|
def values(self):
|
|
1291
|
-
"""
|
|
1981
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
1982
|
+
dictionary function of the same name).
|
|
1983
|
+
|
|
1984
|
+
:return: custom property values.
|
|
1985
|
+
"""
|
|
1292
1986
|
...
|
|
1293
1987
|
|
|
1294
1988
|
class NODE_MT_category_texture_texture(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -1307,22 +2001,35 @@ class NODE_MT_category_texture_texture(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1307
2001
|
""" """
|
|
1308
2002
|
|
|
1309
2003
|
def append(self, draw_func):
|
|
1310
|
-
"""
|
|
2004
|
+
"""Append a draw function to this menu,
|
|
2005
|
+
takes the same arguments as the menus draw function
|
|
1311
2006
|
|
|
1312
|
-
|
|
2007
|
+
:param draw_func:
|
|
1313
2008
|
"""
|
|
1314
2009
|
...
|
|
1315
2010
|
|
|
1316
|
-
def as_pointer(self):
|
|
1317
|
-
"""
|
|
2011
|
+
def as_pointer(self) -> int:
|
|
2012
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2013
|
+
|
|
2014
|
+
:return: int (memory address).
|
|
2015
|
+
:rtype: int
|
|
2016
|
+
"""
|
|
1318
2017
|
...
|
|
1319
2018
|
|
|
1320
|
-
def bl_rna_get_subclass(self):
|
|
1321
|
-
"""
|
|
2019
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2020
|
+
"""
|
|
2021
|
+
|
|
2022
|
+
:return: The RNA type or default when not found.
|
|
2023
|
+
:rtype: bpy.types.Struct
|
|
2024
|
+
"""
|
|
1322
2025
|
...
|
|
1323
2026
|
|
|
1324
|
-
def bl_rna_get_subclass_py(self):
|
|
1325
|
-
"""
|
|
2027
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2028
|
+
"""
|
|
2029
|
+
|
|
2030
|
+
:return: The class or default when not found.
|
|
2031
|
+
:rtype: typing.Any
|
|
2032
|
+
"""
|
|
1326
2033
|
...
|
|
1327
2034
|
|
|
1328
2035
|
def draw(self, _context):
|
|
@@ -1341,138 +2048,224 @@ class NODE_MT_category_texture_texture(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1341
2048
|
...
|
|
1342
2049
|
|
|
1343
2050
|
def draw_preset(self, _context):
|
|
1344
|
-
"""
|
|
2051
|
+
"""Define these on the subclass:
|
|
2052
|
+
- preset_operator (string)
|
|
2053
|
+
- preset_subdir (string)Optionally:
|
|
2054
|
+
- preset_add_operator (string)
|
|
2055
|
+
- preset_extensions (set of strings)
|
|
2056
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1345
2057
|
|
|
1346
|
-
|
|
2058
|
+
:param _context:
|
|
1347
2059
|
"""
|
|
1348
2060
|
...
|
|
1349
2061
|
|
|
1350
|
-
def driver_add(self):
|
|
1351
|
-
"""
|
|
2062
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
2063
|
+
"""Adds driver(s) to the given property
|
|
2064
|
+
|
|
2065
|
+
:return: The driver(s) added.
|
|
2066
|
+
:rtype: bpy.types.FCurve
|
|
2067
|
+
"""
|
|
1352
2068
|
...
|
|
1353
2069
|
|
|
1354
|
-
def driver_remove(self):
|
|
1355
|
-
"""
|
|
2070
|
+
def driver_remove(self) -> bool:
|
|
2071
|
+
"""Remove driver(s) from the given property
|
|
2072
|
+
|
|
2073
|
+
:return: Success of driver removal.
|
|
2074
|
+
:rtype: bool
|
|
2075
|
+
"""
|
|
1356
2076
|
...
|
|
1357
2077
|
|
|
1358
2078
|
def get(self):
|
|
1359
|
-
"""
|
|
2079
|
+
"""Returns the value of the custom property assigned to key or default
|
|
2080
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2081
|
+
|
|
2082
|
+
"""
|
|
1360
2083
|
...
|
|
1361
2084
|
|
|
1362
2085
|
def id_properties_clear(self):
|
|
1363
|
-
"""
|
|
2086
|
+
"""
|
|
2087
|
+
|
|
2088
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2089
|
+
"""
|
|
1364
2090
|
...
|
|
1365
2091
|
|
|
1366
2092
|
def id_properties_ensure(self):
|
|
1367
|
-
"""
|
|
2093
|
+
"""
|
|
2094
|
+
|
|
2095
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2096
|
+
"""
|
|
1368
2097
|
...
|
|
1369
2098
|
|
|
1370
2099
|
def id_properties_ui(self):
|
|
1371
|
-
"""
|
|
2100
|
+
"""
|
|
2101
|
+
|
|
2102
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
2103
|
+
"""
|
|
1372
2104
|
...
|
|
1373
2105
|
|
|
1374
2106
|
def is_extended(self):
|
|
1375
2107
|
""" """
|
|
1376
2108
|
...
|
|
1377
2109
|
|
|
1378
|
-
def is_property_hidden(self):
|
|
1379
|
-
"""
|
|
2110
|
+
def is_property_hidden(self) -> bool:
|
|
2111
|
+
"""Check if a property is hidden.
|
|
2112
|
+
|
|
2113
|
+
:return: True when the property is hidden.
|
|
2114
|
+
:rtype: bool
|
|
2115
|
+
"""
|
|
1380
2116
|
...
|
|
1381
2117
|
|
|
1382
|
-
def is_property_overridable_library(self):
|
|
1383
|
-
"""
|
|
2118
|
+
def is_property_overridable_library(self) -> bool:
|
|
2119
|
+
"""Check if a property is overridable.
|
|
2120
|
+
|
|
2121
|
+
:return: True when the property is overridable.
|
|
2122
|
+
:rtype: bool
|
|
2123
|
+
"""
|
|
1384
2124
|
...
|
|
1385
2125
|
|
|
1386
|
-
def is_property_readonly(self):
|
|
1387
|
-
"""
|
|
2126
|
+
def is_property_readonly(self) -> bool:
|
|
2127
|
+
"""Check if a property is readonly.
|
|
2128
|
+
|
|
2129
|
+
:return: True when the property is readonly (not writable).
|
|
2130
|
+
:rtype: bool
|
|
2131
|
+
"""
|
|
1388
2132
|
...
|
|
1389
2133
|
|
|
1390
|
-
def is_property_set(self):
|
|
1391
|
-
"""
|
|
2134
|
+
def is_property_set(self) -> bool:
|
|
2135
|
+
"""Check if a property is set, use for testing operator properties.
|
|
2136
|
+
|
|
2137
|
+
:return: True when the property has been set.
|
|
2138
|
+
:rtype: bool
|
|
2139
|
+
"""
|
|
1392
2140
|
...
|
|
1393
2141
|
|
|
1394
2142
|
def items(self):
|
|
1395
|
-
"""
|
|
2143
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
2144
|
+
dictionary function of the same name).
|
|
2145
|
+
|
|
2146
|
+
:return: custom property key, value pairs.
|
|
2147
|
+
"""
|
|
1396
2148
|
...
|
|
1397
2149
|
|
|
1398
|
-
def keyframe_delete(self):
|
|
1399
|
-
"""
|
|
2150
|
+
def keyframe_delete(self) -> bool:
|
|
2151
|
+
"""Remove a keyframe from this properties fcurve.
|
|
2152
|
+
|
|
2153
|
+
:return: Success of keyframe deletion.
|
|
2154
|
+
:rtype: bool
|
|
2155
|
+
"""
|
|
1400
2156
|
...
|
|
1401
2157
|
|
|
1402
|
-
def keyframe_insert(self):
|
|
1403
|
-
"""
|
|
2158
|
+
def keyframe_insert(self) -> bool:
|
|
2159
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2160
|
+
|
|
2161
|
+
:return: Success of keyframe insertion.
|
|
2162
|
+
:rtype: bool
|
|
2163
|
+
"""
|
|
1404
2164
|
...
|
|
1405
2165
|
|
|
1406
2166
|
def keys(self):
|
|
1407
|
-
"""
|
|
2167
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
2168
|
+
dictionary function of the same name).
|
|
2169
|
+
|
|
2170
|
+
:return: custom property keys.
|
|
2171
|
+
"""
|
|
1408
2172
|
...
|
|
1409
2173
|
|
|
1410
|
-
def path_from_id(self):
|
|
1411
|
-
"""
|
|
2174
|
+
def path_from_id(self) -> str:
|
|
2175
|
+
"""Returns the data path from the ID to this object (string).
|
|
2176
|
+
|
|
2177
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2178
|
+
to this struct and property (when given).
|
|
2179
|
+
:rtype: str
|
|
2180
|
+
"""
|
|
1412
2181
|
...
|
|
1413
2182
|
|
|
1414
2183
|
def path_menu(
|
|
1415
2184
|
self,
|
|
1416
|
-
searchpaths,
|
|
1417
|
-
operator,
|
|
1418
|
-
props_default,
|
|
1419
|
-
prop_filepath,
|
|
1420
|
-
filter_ext,
|
|
1421
|
-
filter_path,
|
|
1422
|
-
display_name,
|
|
1423
|
-
add_operator,
|
|
1424
|
-
add_operator_props,
|
|
2185
|
+
searchpaths: list[str],
|
|
2186
|
+
operator: str,
|
|
2187
|
+
props_default: dict = None,
|
|
2188
|
+
prop_filepath: str = "filepath",
|
|
2189
|
+
filter_ext: typing.Callable = None,
|
|
2190
|
+
filter_path=None,
|
|
2191
|
+
display_name: typing.Callable = None,
|
|
2192
|
+
add_operator=None,
|
|
2193
|
+
add_operator_props=None,
|
|
1425
2194
|
):
|
|
1426
|
-
"""
|
|
2195
|
+
"""Populate a menu from a list of paths.
|
|
1427
2196
|
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
2197
|
+
:param searchpaths: Paths to scan.
|
|
2198
|
+
:type searchpaths: list[str]
|
|
2199
|
+
:param operator: The operator id to use with each file.
|
|
2200
|
+
:type operator: str
|
|
2201
|
+
:param props_default: Properties to assign to each operator.
|
|
2202
|
+
:type props_default: dict
|
|
2203
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2204
|
+
:type prop_filepath: str
|
|
2205
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
2206
|
+
|
|
2207
|
+
Returning false excludes the file from the list.
|
|
2208
|
+
:type filter_ext: typing.Callable
|
|
2209
|
+
:param filter_path:
|
|
2210
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2211
|
+
:type display_name: typing.Callable
|
|
2212
|
+
:param add_operator:
|
|
2213
|
+
:param add_operator_props:
|
|
1437
2214
|
"""
|
|
1438
2215
|
...
|
|
1439
2216
|
|
|
1440
2217
|
def path_resolve(self):
|
|
1441
|
-
""" """
|
|
2218
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1442
2219
|
...
|
|
1443
2220
|
|
|
1444
2221
|
def pop(self):
|
|
1445
|
-
"""
|
|
2222
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
2223
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2224
|
+
|
|
2225
|
+
"""
|
|
1446
2226
|
...
|
|
1447
2227
|
|
|
1448
2228
|
def prepend(self, draw_func):
|
|
1449
|
-
"""
|
|
2229
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2230
|
+
the menus draw function
|
|
1450
2231
|
|
|
1451
|
-
|
|
2232
|
+
:param draw_func:
|
|
1452
2233
|
"""
|
|
1453
2234
|
...
|
|
1454
2235
|
|
|
1455
|
-
def property_overridable_library_set(self):
|
|
1456
|
-
"""
|
|
2236
|
+
def property_overridable_library_set(self) -> bool:
|
|
2237
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
2238
|
+
|
|
2239
|
+
:return: True when the overridable status of the property was successfully set.
|
|
2240
|
+
:rtype: bool
|
|
2241
|
+
"""
|
|
1457
2242
|
...
|
|
1458
2243
|
|
|
1459
2244
|
def property_unset(self):
|
|
1460
|
-
""" """
|
|
2245
|
+
"""Unset a property, will use default value afterward."""
|
|
1461
2246
|
...
|
|
1462
2247
|
|
|
1463
2248
|
def remove(self, draw_func):
|
|
1464
|
-
"""
|
|
2249
|
+
"""Remove a draw function that has been added to this menu
|
|
1465
2250
|
|
|
1466
2251
|
:param draw_func:
|
|
1467
2252
|
"""
|
|
1468
2253
|
...
|
|
1469
2254
|
|
|
1470
2255
|
def type_recast(self):
|
|
1471
|
-
"""
|
|
2256
|
+
"""Return a new instance, this is needed because types
|
|
2257
|
+
such as textures can be changed at runtime.
|
|
2258
|
+
|
|
2259
|
+
:return: a new instance of this object with the type initialized again.
|
|
2260
|
+
"""
|
|
1472
2261
|
...
|
|
1473
2262
|
|
|
1474
2263
|
def values(self):
|
|
1475
|
-
"""
|
|
2264
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
2265
|
+
dictionary function of the same name).
|
|
2266
|
+
|
|
2267
|
+
:return: custom property values.
|
|
2268
|
+
"""
|
|
1476
2269
|
...
|
|
1477
2270
|
|
|
1478
2271
|
class NODE_MT_texture_node_add_all(bpy_types.Menu, bpy_types._GenericUI):
|
|
@@ -1491,22 +2284,35 @@ class NODE_MT_texture_node_add_all(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1491
2284
|
""" """
|
|
1492
2285
|
|
|
1493
2286
|
def append(self, draw_func):
|
|
1494
|
-
"""
|
|
2287
|
+
"""Append a draw function to this menu,
|
|
2288
|
+
takes the same arguments as the menus draw function
|
|
1495
2289
|
|
|
1496
|
-
|
|
2290
|
+
:param draw_func:
|
|
1497
2291
|
"""
|
|
1498
2292
|
...
|
|
1499
2293
|
|
|
1500
|
-
def as_pointer(self):
|
|
1501
|
-
"""
|
|
2294
|
+
def as_pointer(self) -> int:
|
|
2295
|
+
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2296
|
+
|
|
2297
|
+
:return: int (memory address).
|
|
2298
|
+
:rtype: int
|
|
2299
|
+
"""
|
|
1502
2300
|
...
|
|
1503
2301
|
|
|
1504
|
-
def bl_rna_get_subclass(self):
|
|
1505
|
-
"""
|
|
2302
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2303
|
+
"""
|
|
2304
|
+
|
|
2305
|
+
:return: The RNA type or default when not found.
|
|
2306
|
+
:rtype: bpy.types.Struct
|
|
2307
|
+
"""
|
|
1506
2308
|
...
|
|
1507
2309
|
|
|
1508
|
-
def bl_rna_get_subclass_py(self):
|
|
1509
|
-
"""
|
|
2310
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2311
|
+
"""
|
|
2312
|
+
|
|
2313
|
+
:return: The class or default when not found.
|
|
2314
|
+
:rtype: typing.Any
|
|
2315
|
+
"""
|
|
1510
2316
|
...
|
|
1511
2317
|
|
|
1512
2318
|
def draw(self, _context):
|
|
@@ -1525,136 +2331,222 @@ class NODE_MT_texture_node_add_all(bpy_types.Menu, bpy_types._GenericUI):
|
|
|
1525
2331
|
...
|
|
1526
2332
|
|
|
1527
2333
|
def draw_preset(self, _context):
|
|
1528
|
-
"""
|
|
2334
|
+
"""Define these on the subclass:
|
|
2335
|
+
- preset_operator (string)
|
|
2336
|
+
- preset_subdir (string)Optionally:
|
|
2337
|
+
- preset_add_operator (string)
|
|
2338
|
+
- preset_extensions (set of strings)
|
|
2339
|
+
- preset_operator_defaults (dict of keyword args)
|
|
1529
2340
|
|
|
1530
|
-
|
|
2341
|
+
:param _context:
|
|
1531
2342
|
"""
|
|
1532
2343
|
...
|
|
1533
2344
|
|
|
1534
|
-
def driver_add(self):
|
|
1535
|
-
"""
|
|
2345
|
+
def driver_add(self) -> bpy.types.FCurve:
|
|
2346
|
+
"""Adds driver(s) to the given property
|
|
2347
|
+
|
|
2348
|
+
:return: The driver(s) added.
|
|
2349
|
+
:rtype: bpy.types.FCurve
|
|
2350
|
+
"""
|
|
1536
2351
|
...
|
|
1537
2352
|
|
|
1538
|
-
def driver_remove(self):
|
|
1539
|
-
"""
|
|
2353
|
+
def driver_remove(self) -> bool:
|
|
2354
|
+
"""Remove driver(s) from the given property
|
|
2355
|
+
|
|
2356
|
+
:return: Success of driver removal.
|
|
2357
|
+
:rtype: bool
|
|
2358
|
+
"""
|
|
1540
2359
|
...
|
|
1541
2360
|
|
|
1542
2361
|
def get(self):
|
|
1543
|
-
"""
|
|
2362
|
+
"""Returns the value of the custom property assigned to key or default
|
|
2363
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2364
|
+
|
|
2365
|
+
"""
|
|
1544
2366
|
...
|
|
1545
2367
|
|
|
1546
2368
|
def id_properties_clear(self):
|
|
1547
|
-
"""
|
|
2369
|
+
"""
|
|
2370
|
+
|
|
2371
|
+
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2372
|
+
"""
|
|
1548
2373
|
...
|
|
1549
2374
|
|
|
1550
2375
|
def id_properties_ensure(self):
|
|
1551
|
-
"""
|
|
2376
|
+
"""
|
|
2377
|
+
|
|
2378
|
+
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2379
|
+
"""
|
|
1552
2380
|
...
|
|
1553
2381
|
|
|
1554
2382
|
def id_properties_ui(self):
|
|
1555
|
-
"""
|
|
2383
|
+
"""
|
|
2384
|
+
|
|
2385
|
+
:return: Return an object used to manage an IDProperty's UI data.
|
|
2386
|
+
"""
|
|
1556
2387
|
...
|
|
1557
2388
|
|
|
1558
2389
|
def is_extended(self):
|
|
1559
2390
|
""" """
|
|
1560
2391
|
...
|
|
1561
2392
|
|
|
1562
|
-
def is_property_hidden(self):
|
|
1563
|
-
"""
|
|
2393
|
+
def is_property_hidden(self) -> bool:
|
|
2394
|
+
"""Check if a property is hidden.
|
|
2395
|
+
|
|
2396
|
+
:return: True when the property is hidden.
|
|
2397
|
+
:rtype: bool
|
|
2398
|
+
"""
|
|
1564
2399
|
...
|
|
1565
2400
|
|
|
1566
|
-
def is_property_overridable_library(self):
|
|
1567
|
-
"""
|
|
2401
|
+
def is_property_overridable_library(self) -> bool:
|
|
2402
|
+
"""Check if a property is overridable.
|
|
2403
|
+
|
|
2404
|
+
:return: True when the property is overridable.
|
|
2405
|
+
:rtype: bool
|
|
2406
|
+
"""
|
|
1568
2407
|
...
|
|
1569
2408
|
|
|
1570
|
-
def is_property_readonly(self):
|
|
1571
|
-
"""
|
|
2409
|
+
def is_property_readonly(self) -> bool:
|
|
2410
|
+
"""Check if a property is readonly.
|
|
2411
|
+
|
|
2412
|
+
:return: True when the property is readonly (not writable).
|
|
2413
|
+
:rtype: bool
|
|
2414
|
+
"""
|
|
1572
2415
|
...
|
|
1573
2416
|
|
|
1574
|
-
def is_property_set(self):
|
|
1575
|
-
"""
|
|
2417
|
+
def is_property_set(self) -> bool:
|
|
2418
|
+
"""Check if a property is set, use for testing operator properties.
|
|
2419
|
+
|
|
2420
|
+
:return: True when the property has been set.
|
|
2421
|
+
:rtype: bool
|
|
2422
|
+
"""
|
|
1576
2423
|
...
|
|
1577
2424
|
|
|
1578
2425
|
def items(self):
|
|
1579
|
-
"""
|
|
2426
|
+
"""Returns the items of this objects custom properties (matches Python's
|
|
2427
|
+
dictionary function of the same name).
|
|
2428
|
+
|
|
2429
|
+
:return: custom property key, value pairs.
|
|
2430
|
+
"""
|
|
1580
2431
|
...
|
|
1581
2432
|
|
|
1582
|
-
def keyframe_delete(self):
|
|
1583
|
-
"""
|
|
2433
|
+
def keyframe_delete(self) -> bool:
|
|
2434
|
+
"""Remove a keyframe from this properties fcurve.
|
|
2435
|
+
|
|
2436
|
+
:return: Success of keyframe deletion.
|
|
2437
|
+
:rtype: bool
|
|
2438
|
+
"""
|
|
1584
2439
|
...
|
|
1585
2440
|
|
|
1586
|
-
def keyframe_insert(self):
|
|
1587
|
-
"""
|
|
2441
|
+
def keyframe_insert(self) -> bool:
|
|
2442
|
+
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2443
|
+
|
|
2444
|
+
:return: Success of keyframe insertion.
|
|
2445
|
+
:rtype: bool
|
|
2446
|
+
"""
|
|
1588
2447
|
...
|
|
1589
2448
|
|
|
1590
2449
|
def keys(self):
|
|
1591
|
-
"""
|
|
2450
|
+
"""Returns the keys of this objects custom properties (matches Python's
|
|
2451
|
+
dictionary function of the same name).
|
|
2452
|
+
|
|
2453
|
+
:return: custom property keys.
|
|
2454
|
+
"""
|
|
1592
2455
|
...
|
|
1593
2456
|
|
|
1594
|
-
def path_from_id(self):
|
|
1595
|
-
"""
|
|
2457
|
+
def path_from_id(self) -> str:
|
|
2458
|
+
"""Returns the data path from the ID to this object (string).
|
|
2459
|
+
|
|
2460
|
+
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2461
|
+
to this struct and property (when given).
|
|
2462
|
+
:rtype: str
|
|
2463
|
+
"""
|
|
1596
2464
|
...
|
|
1597
2465
|
|
|
1598
2466
|
def path_menu(
|
|
1599
2467
|
self,
|
|
1600
|
-
searchpaths,
|
|
1601
|
-
operator,
|
|
1602
|
-
props_default,
|
|
1603
|
-
prop_filepath,
|
|
1604
|
-
filter_ext,
|
|
1605
|
-
filter_path,
|
|
1606
|
-
display_name,
|
|
1607
|
-
add_operator,
|
|
1608
|
-
add_operator_props,
|
|
2468
|
+
searchpaths: list[str],
|
|
2469
|
+
operator: str,
|
|
2470
|
+
props_default: dict = None,
|
|
2471
|
+
prop_filepath: str = "filepath",
|
|
2472
|
+
filter_ext: typing.Callable = None,
|
|
2473
|
+
filter_path=None,
|
|
2474
|
+
display_name: typing.Callable = None,
|
|
2475
|
+
add_operator=None,
|
|
2476
|
+
add_operator_props=None,
|
|
1609
2477
|
):
|
|
1610
|
-
"""
|
|
2478
|
+
"""Populate a menu from a list of paths.
|
|
1611
2479
|
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
2480
|
+
:param searchpaths: Paths to scan.
|
|
2481
|
+
:type searchpaths: list[str]
|
|
2482
|
+
:param operator: The operator id to use with each file.
|
|
2483
|
+
:type operator: str
|
|
2484
|
+
:param props_default: Properties to assign to each operator.
|
|
2485
|
+
:type props_default: dict
|
|
2486
|
+
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2487
|
+
:type prop_filepath: str
|
|
2488
|
+
:param filter_ext: Optional callback that takes the file extensions.
|
|
2489
|
+
|
|
2490
|
+
Returning false excludes the file from the list.
|
|
2491
|
+
:type filter_ext: typing.Callable
|
|
2492
|
+
:param filter_path:
|
|
2493
|
+
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2494
|
+
:type display_name: typing.Callable
|
|
2495
|
+
:param add_operator:
|
|
2496
|
+
:param add_operator_props:
|
|
1621
2497
|
"""
|
|
1622
2498
|
...
|
|
1623
2499
|
|
|
1624
2500
|
def path_resolve(self):
|
|
1625
|
-
""" """
|
|
2501
|
+
"""Returns the property from the path, raise an exception when not found."""
|
|
1626
2502
|
...
|
|
1627
2503
|
|
|
1628
2504
|
def pop(self):
|
|
1629
|
-
"""
|
|
2505
|
+
"""Remove and return the value of the custom property assigned to key or default
|
|
2506
|
+
when not found (matches Python's dictionary function of the same name).
|
|
2507
|
+
|
|
2508
|
+
"""
|
|
1630
2509
|
...
|
|
1631
2510
|
|
|
1632
2511
|
def prepend(self, draw_func):
|
|
1633
|
-
"""
|
|
2512
|
+
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2513
|
+
the menus draw function
|
|
1634
2514
|
|
|
1635
|
-
|
|
2515
|
+
:param draw_func:
|
|
1636
2516
|
"""
|
|
1637
2517
|
...
|
|
1638
2518
|
|
|
1639
|
-
def property_overridable_library_set(self):
|
|
1640
|
-
"""
|
|
2519
|
+
def property_overridable_library_set(self) -> bool:
|
|
2520
|
+
"""Define a property as overridable or not (only for custom properties!).
|
|
2521
|
+
|
|
2522
|
+
:return: True when the overridable status of the property was successfully set.
|
|
2523
|
+
:rtype: bool
|
|
2524
|
+
"""
|
|
1641
2525
|
...
|
|
1642
2526
|
|
|
1643
2527
|
def property_unset(self):
|
|
1644
|
-
""" """
|
|
2528
|
+
"""Unset a property, will use default value afterward."""
|
|
1645
2529
|
...
|
|
1646
2530
|
|
|
1647
2531
|
def remove(self, draw_func):
|
|
1648
|
-
"""
|
|
2532
|
+
"""Remove a draw function that has been added to this menu
|
|
1649
2533
|
|
|
1650
2534
|
:param draw_func:
|
|
1651
2535
|
"""
|
|
1652
2536
|
...
|
|
1653
2537
|
|
|
1654
2538
|
def type_recast(self):
|
|
1655
|
-
"""
|
|
2539
|
+
"""Return a new instance, this is needed because types
|
|
2540
|
+
such as textures can be changed at runtime.
|
|
2541
|
+
|
|
2542
|
+
:return: a new instance of this object with the type initialized again.
|
|
2543
|
+
"""
|
|
1656
2544
|
...
|
|
1657
2545
|
|
|
1658
2546
|
def values(self):
|
|
1659
|
-
"""
|
|
2547
|
+
"""Returns the values of this objects custom properties (matches Python's
|
|
2548
|
+
dictionary function of the same name).
|
|
2549
|
+
|
|
2550
|
+
:return: custom property values.
|
|
2551
|
+
"""
|
|
1660
2552
|
...
|