fake-bpy-module 20240708__py3-none-any.whl → 20240709__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.

Files changed (116) hide show
  1. _bpy_internal/__init__.pyi +1 -0
  2. _bpy_internal/addons/__init__.pyi +7 -0
  3. _bpy_internal/addons/cli/__init__.pyi +8 -0
  4. _bpy_internal/extensions/wheel_manager/__init__.pyi +1 -1
  5. _bpy_internal/freedesktop/__init__.pyi +1 -1
  6. addon_utils/__init__.pyi +6 -5
  7. bl_app_override/__init__.pyi +2 -1
  8. bl_app_template_utils/__init__.pyi +4 -4
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +1 -1
  10. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -2
  11. bl_console_utils/autocomplete/intellisense/__init__.pyi +3 -1
  12. bl_keymap_utils/io/__init__.pyi +4 -2
  13. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +1 -1
  14. bl_keymap_utils/platform_helpers/__init__.pyi +1 -1
  15. bl_operators/__init__.pyi +1 -0
  16. bl_operators/add_mesh_torus/__init__.pyi +1 -1
  17. bl_operators/anim/__init__.pyi +8 -8
  18. bl_operators/assets/__init__.pyi +3 -3
  19. bl_operators/bone_selection_sets/__init__.pyi +2986 -0
  20. bl_operators/clip/__init__.pyi +11 -11
  21. bl_operators/connect_to_output/__init__.pyi +1 -1
  22. bl_operators/console/__init__.pyi +5 -5
  23. bl_operators/constraint/__init__.pyi +4 -4
  24. bl_operators/file/__init__.pyi +3 -3
  25. bl_operators/freestyle/__init__.pyi +4 -4
  26. bl_operators/geometry_nodes/__init__.pyi +4 -4
  27. bl_operators/image/__init__.pyi +4 -4
  28. bl_operators/image_as_planes/__init__.pyi +2 -2
  29. bl_operators/mesh/__init__.pyi +3 -3
  30. bl_operators/node/__init__.pyi +8 -8
  31. bl_operators/object/__init__.pyi +15 -15
  32. bl_operators/object_align/__init__.pyi +1 -1
  33. bl_operators/object_quick_effects/__init__.pyi +4 -4
  34. bl_operators/object_randomize_transform/__init__.pyi +1 -1
  35. bl_operators/presets/__init__.pyi +25 -23
  36. bl_operators/rigidbody/__init__.pyi +3 -3
  37. bl_operators/screen_play_rendered_anim/__init__.pyi +1 -1
  38. bl_operators/sequencer/__init__.pyi +5 -5
  39. bl_operators/spreadsheet/__init__.pyi +1 -1
  40. bl_operators/userpref/__init__.pyi +25 -25
  41. bl_operators/uvcalc_follow_active/__init__.pyi +1 -1
  42. bl_operators/uvcalc_lightmap/__init__.pyi +2 -2
  43. bl_operators/uvcalc_transform/__init__.pyi +2 -2
  44. bl_operators/vertexpaint_dirt/__init__.pyi +1 -1
  45. bl_operators/view3d/__init__.pyi +5 -5
  46. bl_operators/wm/__init__.pyi +46 -42
  47. bl_operators/world/__init__.pyi +1 -1
  48. bl_ui/__init__.pyi +2 -0
  49. bl_ui/anim/__init__.pyi +1 -0
  50. bl_ui/generic_ui_list/__init__.pyi +5 -4
  51. bl_ui/node_add_menu/__init__.pyi +2 -1
  52. bl_ui/node_add_menu_compositor/__init__.pyi +18 -0
  53. bl_ui/node_add_menu_geometry/__init__.pyi +49 -0
  54. bl_ui/node_add_menu_shader/__init__.pyi +10 -0
  55. bl_ui/node_add_menu_texture/__init__.pyi +9 -0
  56. bl_ui/properties_collection/__init__.pyi +1 -0
  57. bl_ui/properties_data_armature/__init__.pyi +1273 -0
  58. bl_ui/properties_data_camera/__init__.pyi +2 -0
  59. bl_ui/properties_data_curves/__init__.pyi +1 -0
  60. bl_ui/properties_data_gpencil/__init__.pyi +2 -0
  61. bl_ui/properties_data_grease_pencil/__init__.pyi +3 -0
  62. bl_ui/properties_data_mesh/__init__.pyi +4 -0
  63. bl_ui/properties_data_modifier/__init__.pyi +8 -1
  64. bl_ui/properties_data_pointcloud/__init__.pyi +1 -0
  65. bl_ui/properties_freestyle/__init__.pyi +1 -0
  66. bl_ui/properties_grease_pencil_common/__init__.pyi +13 -1
  67. bl_ui/properties_mask_common/__init__.pyi +6 -0
  68. bl_ui/properties_material/__init__.pyi +1 -0
  69. bl_ui/properties_material_gpencil/__init__.pyi +2 -0
  70. bl_ui/properties_object/__init__.pyi +1 -0
  71. bl_ui/properties_output/__init__.pyi +3 -0
  72. bl_ui/properties_paint_common/__init__.pyi +48 -17
  73. bl_ui/properties_particle/__init__.pyi +2 -0
  74. bl_ui/properties_physics_cloth/__init__.pyi +1 -0
  75. bl_ui/properties_physics_fluid/__init__.pyi +1 -0
  76. bl_ui/properties_render/__init__.pyi +2 -0
  77. bl_ui/properties_texture/__init__.pyi +1 -0
  78. bl_ui/properties_view_layer/__init__.pyi +1 -0
  79. bl_ui/space_clip/__init__.pyi +31 -0
  80. bl_ui/space_console/__init__.pyi +5 -0
  81. bl_ui/space_dopesheet/__init__.pyi +14 -0
  82. bl_ui/space_filebrowser/__init__.pyi +13 -0
  83. bl_ui/space_graph/__init__.pyi +16 -0
  84. bl_ui/space_image/__init__.pyi +313 -11
  85. bl_ui/space_info/__init__.pyi +5 -0
  86. bl_ui/space_nla/__init__.pyi +13 -0
  87. bl_ui/space_node/__init__.pyi +12 -0
  88. bl_ui/space_outliner/__init__.pyi +12 -0
  89. bl_ui/space_sequencer/__init__.pyi +34 -0
  90. bl_ui/space_text/__init__.pyi +12 -0
  91. bl_ui/space_time/__init__.pyi +4 -0
  92. bl_ui/space_toolsystem_common/__init__.pyi +7 -6
  93. bl_ui/space_toolsystem_toolbar/__init__.pyi +18 -13
  94. bl_ui/space_topbar/__init__.pyi +20 -1
  95. bl_ui/space_userpref/__init__.pyi +8 -0
  96. bl_ui/space_view3d/__init__.pyi +3477 -1372
  97. bl_ui/space_view3d_toolbar/__init__.pyi +1706 -880
  98. bl_ui/utils/__init__.pyi +1 -0
  99. bl_ui_utils/bug_report_url/__init__.pyi +1 -1
  100. bpy/ops/brush/__init__.pyi +185 -11
  101. bpy/ops/gpencil/__init__.pyi +0 -28
  102. bpy/ops/paint/__init__.pyi +0 -48
  103. bpy/ops/pose/__init__.pyi +176 -0
  104. bpy/ops/wm/__init__.pyi +18 -0
  105. bpy/path/__init__.pyi +6 -6
  106. bpy/types/__init__.pyi +2607 -1090
  107. bpy/utils/__init__.pyi +14 -12
  108. bpy_extras/anim_utils/__init__.pyi +3 -3
  109. bpy_extras/view3d_utils/__init__.pyi +2 -0
  110. {fake_bpy_module-20240708.dist-info → fake_bpy_module-20240709.dist-info}/METADATA +1 -1
  111. {fake_bpy_module-20240708.dist-info → fake_bpy_module-20240709.dist-info}/RECORD +116 -113
  112. rna_info/__init__.pyi +1 -0
  113. rna_prop_ui/__init__.pyi +2 -1
  114. rna_xml/__init__.pyi +2 -2
  115. {fake_bpy_module-20240708.dist-info → fake_bpy_module-20240709.dist-info}/WHEEL +0 -0
  116. {fake_bpy_module-20240708.dist-info → fake_bpy_module-20240709.dist-info}/top_level.txt +0 -0
@@ -195,6 +195,7 @@ class ARMATURE_MT_collection_context_menu(bpy_types._GenericUI):
195
195
  self,
196
196
  searchpaths: list[str],
197
197
  operator: str,
198
+ *,
198
199
  props_default: dict = None,
199
200
  prop_filepath: str | None = "filepath",
200
201
  filter_ext: collections.abc.Callable | None = None,
@@ -465,6 +466,7 @@ class ARMATURE_MT_collection_tree_context_menu(bpy_types._GenericUI):
465
466
  self,
466
467
  searchpaths: list[str],
467
468
  operator: str,
469
+ *,
468
470
  props_default: dict = None,
469
471
  prop_filepath: str | None = "filepath",
470
472
  filter_ext: collections.abc.Callable | None = None,
@@ -2875,3 +2877,1274 @@ class DATA_UL_bone_collections(bpy_types._GenericUI):
2875
2877
  :return: custom property values.
2876
2878
  """
2877
2879
  ...
2880
+
2881
+ class POSE_MT_selection_set_create(bpy_types._GenericUI):
2882
+ bl_label: typing.Any
2883
+ bl_rna: typing.Any
2884
+ id_data: typing.Any
2885
+
2886
+ def append(self, draw_func):
2887
+ """Append a draw function to this menu,
2888
+ takes the same arguments as the menus draw function
2889
+
2890
+ :param draw_func:
2891
+ """
2892
+ ...
2893
+
2894
+ def as_pointer(self) -> int:
2895
+ """Returns the memory address which holds a pointer to Blender's internal data
2896
+
2897
+ :return: int (memory address).
2898
+ :rtype: int
2899
+ """
2900
+ ...
2901
+
2902
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2903
+ """
2904
+
2905
+ :return: The RNA type or default when not found.
2906
+ :rtype: bpy.types.Struct
2907
+ """
2908
+ ...
2909
+
2910
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2911
+ """
2912
+
2913
+ :return: The class or default when not found.
2914
+ :rtype: typing.Any
2915
+ """
2916
+ ...
2917
+
2918
+ def draw(self, context):
2919
+ """
2920
+
2921
+ :param context:
2922
+ """
2923
+ ...
2924
+
2925
+ def draw_collapsible(self, context, layout):
2926
+ """
2927
+
2928
+ :param context:
2929
+ :param layout:
2930
+ """
2931
+ ...
2932
+
2933
+ def draw_preset(self, _context):
2934
+ """Define these on the subclass:
2935
+ - preset_operator (string)
2936
+ - preset_subdir (string)Optionally:
2937
+ - preset_add_operator (string)
2938
+ - preset_extensions (set of strings)
2939
+ - preset_operator_defaults (dict of keyword args)
2940
+
2941
+ :param _context:
2942
+ """
2943
+ ...
2944
+
2945
+ def driver_add(self) -> bpy.types.FCurve:
2946
+ """Adds driver(s) to the given property
2947
+
2948
+ :return: The driver(s) added.
2949
+ :rtype: bpy.types.FCurve
2950
+ """
2951
+ ...
2952
+
2953
+ def driver_remove(self) -> bool:
2954
+ """Remove driver(s) from the given property
2955
+
2956
+ :return: Success of driver removal.
2957
+ :rtype: bool
2958
+ """
2959
+ ...
2960
+
2961
+ def get(self):
2962
+ """Returns the value of the custom property assigned to key or default
2963
+ when not found (matches Python's dictionary function of the same name).
2964
+
2965
+ """
2966
+ ...
2967
+
2968
+ def id_properties_clear(self):
2969
+ """
2970
+
2971
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2972
+ """
2973
+ ...
2974
+
2975
+ def id_properties_ensure(self):
2976
+ """
2977
+
2978
+ :return: the parent group for an RNA struct's custom IDProperties.
2979
+ """
2980
+ ...
2981
+
2982
+ def id_properties_ui(self):
2983
+ """
2984
+
2985
+ :return: Return an object used to manage an IDProperty's UI data.
2986
+ """
2987
+ ...
2988
+
2989
+ def is_extended(self): ...
2990
+ def is_property_hidden(self) -> bool:
2991
+ """Check if a property is hidden.
2992
+
2993
+ :return: True when the property is hidden.
2994
+ :rtype: bool
2995
+ """
2996
+ ...
2997
+
2998
+ def is_property_overridable_library(self) -> bool:
2999
+ """Check if a property is overridable.
3000
+
3001
+ :return: True when the property is overridable.
3002
+ :rtype: bool
3003
+ """
3004
+ ...
3005
+
3006
+ def is_property_readonly(self) -> bool:
3007
+ """Check if a property is readonly.
3008
+
3009
+ :return: True when the property is readonly (not writable).
3010
+ :rtype: bool
3011
+ """
3012
+ ...
3013
+
3014
+ def is_property_set(self) -> bool:
3015
+ """Check if a property is set, use for testing operator properties.
3016
+
3017
+ :return: True when the property has been set.
3018
+ :rtype: bool
3019
+ """
3020
+ ...
3021
+
3022
+ def items(self):
3023
+ """Returns the items of this objects custom properties (matches Python's
3024
+ dictionary function of the same name).
3025
+
3026
+ :return: custom property key, value pairs.
3027
+ """
3028
+ ...
3029
+
3030
+ def keyframe_delete(self) -> bool:
3031
+ """Remove a keyframe from this properties fcurve.
3032
+
3033
+ :return: Success of keyframe deletion.
3034
+ :rtype: bool
3035
+ """
3036
+ ...
3037
+
3038
+ def keyframe_insert(self) -> bool:
3039
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3040
+
3041
+ :return: Success of keyframe insertion.
3042
+ :rtype: bool
3043
+ """
3044
+ ...
3045
+
3046
+ def keys(self):
3047
+ """Returns the keys of this objects custom properties (matches Python's
3048
+ dictionary function of the same name).
3049
+
3050
+ :return: custom property keys.
3051
+ """
3052
+ ...
3053
+
3054
+ def path_from_id(self) -> str:
3055
+ """Returns the data path from the ID to this object (string).
3056
+
3057
+ :return: The path from `bpy.types.bpy_struct.id_data`
3058
+ to this struct and property (when given).
3059
+ :rtype: str
3060
+ """
3061
+ ...
3062
+
3063
+ def path_menu(
3064
+ self,
3065
+ searchpaths: list[str],
3066
+ operator: str,
3067
+ *,
3068
+ props_default: dict = None,
3069
+ prop_filepath: str | None = "filepath",
3070
+ filter_ext: collections.abc.Callable | None = None,
3071
+ filter_path=None,
3072
+ display_name: collections.abc.Callable | None = None,
3073
+ add_operator=None,
3074
+ add_operator_props=None,
3075
+ ):
3076
+ """Populate a menu from a list of paths.
3077
+
3078
+ :param searchpaths: Paths to scan.
3079
+ :type searchpaths: list[str]
3080
+ :param operator: The operator id to use with each file.
3081
+ :type operator: str
3082
+ :param props_default: Properties to assign to each operator.
3083
+ :type props_default: dict
3084
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
3085
+ :type prop_filepath: str | None
3086
+ :param filter_ext: Optional callback that takes the file extensions.
3087
+
3088
+ Returning false excludes the file from the list.
3089
+ :type filter_ext: collections.abc.Callable | None
3090
+ :param filter_path:
3091
+ :param display_name: Optional callback that takes the full path, returns the name to display.
3092
+ :type display_name: collections.abc.Callable | None
3093
+ :param add_operator:
3094
+ :param add_operator_props:
3095
+ """
3096
+ ...
3097
+
3098
+ def path_resolve(self):
3099
+ """Returns the property from the path, raise an exception when not found."""
3100
+ ...
3101
+
3102
+ def pop(self):
3103
+ """Remove and return the value of the custom property assigned to key or default
3104
+ when not found (matches Python's dictionary function of the same name).
3105
+
3106
+ """
3107
+ ...
3108
+
3109
+ def prepend(self, draw_func):
3110
+ """Prepend a draw function to this menu, takes the same arguments as
3111
+ the menus draw function
3112
+
3113
+ :param draw_func:
3114
+ """
3115
+ ...
3116
+
3117
+ def property_overridable_library_set(self) -> bool:
3118
+ """Define a property as overridable or not (only for custom properties!).
3119
+
3120
+ :return: True when the overridable status of the property was successfully set.
3121
+ :rtype: bool
3122
+ """
3123
+ ...
3124
+
3125
+ def property_unset(self):
3126
+ """Unset a property, will use default value afterward."""
3127
+ ...
3128
+
3129
+ def remove(self, draw_func):
3130
+ """Remove a draw function that has been added to this menu
3131
+
3132
+ :param draw_func:
3133
+ """
3134
+ ...
3135
+
3136
+ def type_recast(self):
3137
+ """Return a new instance, this is needed because types
3138
+ such as textures can be changed at runtime.
3139
+
3140
+ :return: a new instance of this object with the type initialized again.
3141
+ """
3142
+ ...
3143
+
3144
+ def values(self):
3145
+ """Returns the values of this objects custom properties (matches Python's
3146
+ dictionary function of the same name).
3147
+
3148
+ :return: custom property values.
3149
+ """
3150
+ ...
3151
+
3152
+ class POSE_MT_selection_sets_context_menu(bpy_types._GenericUI):
3153
+ bl_label: typing.Any
3154
+ bl_rna: typing.Any
3155
+ id_data: typing.Any
3156
+
3157
+ def append(self, draw_func):
3158
+ """Append a draw function to this menu,
3159
+ takes the same arguments as the menus draw function
3160
+
3161
+ :param draw_func:
3162
+ """
3163
+ ...
3164
+
3165
+ def as_pointer(self) -> int:
3166
+ """Returns the memory address which holds a pointer to Blender's internal data
3167
+
3168
+ :return: int (memory address).
3169
+ :rtype: int
3170
+ """
3171
+ ...
3172
+
3173
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3174
+ """
3175
+
3176
+ :return: The RNA type or default when not found.
3177
+ :rtype: bpy.types.Struct
3178
+ """
3179
+ ...
3180
+
3181
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3182
+ """
3183
+
3184
+ :return: The class or default when not found.
3185
+ :rtype: typing.Any
3186
+ """
3187
+ ...
3188
+
3189
+ def draw(self, context):
3190
+ """
3191
+
3192
+ :param context:
3193
+ """
3194
+ ...
3195
+
3196
+ def draw_collapsible(self, context, layout):
3197
+ """
3198
+
3199
+ :param context:
3200
+ :param layout:
3201
+ """
3202
+ ...
3203
+
3204
+ def draw_preset(self, _context):
3205
+ """Define these on the subclass:
3206
+ - preset_operator (string)
3207
+ - preset_subdir (string)Optionally:
3208
+ - preset_add_operator (string)
3209
+ - preset_extensions (set of strings)
3210
+ - preset_operator_defaults (dict of keyword args)
3211
+
3212
+ :param _context:
3213
+ """
3214
+ ...
3215
+
3216
+ def driver_add(self) -> bpy.types.FCurve:
3217
+ """Adds driver(s) to the given property
3218
+
3219
+ :return: The driver(s) added.
3220
+ :rtype: bpy.types.FCurve
3221
+ """
3222
+ ...
3223
+
3224
+ def driver_remove(self) -> bool:
3225
+ """Remove driver(s) from the given property
3226
+
3227
+ :return: Success of driver removal.
3228
+ :rtype: bool
3229
+ """
3230
+ ...
3231
+
3232
+ def get(self):
3233
+ """Returns the value of the custom property assigned to key or default
3234
+ when not found (matches Python's dictionary function of the same name).
3235
+
3236
+ """
3237
+ ...
3238
+
3239
+ def id_properties_clear(self):
3240
+ """
3241
+
3242
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3243
+ """
3244
+ ...
3245
+
3246
+ def id_properties_ensure(self):
3247
+ """
3248
+
3249
+ :return: the parent group for an RNA struct's custom IDProperties.
3250
+ """
3251
+ ...
3252
+
3253
+ def id_properties_ui(self):
3254
+ """
3255
+
3256
+ :return: Return an object used to manage an IDProperty's UI data.
3257
+ """
3258
+ ...
3259
+
3260
+ def is_extended(self): ...
3261
+ def is_property_hidden(self) -> bool:
3262
+ """Check if a property is hidden.
3263
+
3264
+ :return: True when the property is hidden.
3265
+ :rtype: bool
3266
+ """
3267
+ ...
3268
+
3269
+ def is_property_overridable_library(self) -> bool:
3270
+ """Check if a property is overridable.
3271
+
3272
+ :return: True when the property is overridable.
3273
+ :rtype: bool
3274
+ """
3275
+ ...
3276
+
3277
+ def is_property_readonly(self) -> bool:
3278
+ """Check if a property is readonly.
3279
+
3280
+ :return: True when the property is readonly (not writable).
3281
+ :rtype: bool
3282
+ """
3283
+ ...
3284
+
3285
+ def is_property_set(self) -> bool:
3286
+ """Check if a property is set, use for testing operator properties.
3287
+
3288
+ :return: True when the property has been set.
3289
+ :rtype: bool
3290
+ """
3291
+ ...
3292
+
3293
+ def items(self):
3294
+ """Returns the items of this objects custom properties (matches Python's
3295
+ dictionary function of the same name).
3296
+
3297
+ :return: custom property key, value pairs.
3298
+ """
3299
+ ...
3300
+
3301
+ def keyframe_delete(self) -> bool:
3302
+ """Remove a keyframe from this properties fcurve.
3303
+
3304
+ :return: Success of keyframe deletion.
3305
+ :rtype: bool
3306
+ """
3307
+ ...
3308
+
3309
+ def keyframe_insert(self) -> bool:
3310
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3311
+
3312
+ :return: Success of keyframe insertion.
3313
+ :rtype: bool
3314
+ """
3315
+ ...
3316
+
3317
+ def keys(self):
3318
+ """Returns the keys of this objects custom properties (matches Python's
3319
+ dictionary function of the same name).
3320
+
3321
+ :return: custom property keys.
3322
+ """
3323
+ ...
3324
+
3325
+ def path_from_id(self) -> str:
3326
+ """Returns the data path from the ID to this object (string).
3327
+
3328
+ :return: The path from `bpy.types.bpy_struct.id_data`
3329
+ to this struct and property (when given).
3330
+ :rtype: str
3331
+ """
3332
+ ...
3333
+
3334
+ def path_menu(
3335
+ self,
3336
+ searchpaths: list[str],
3337
+ operator: str,
3338
+ *,
3339
+ props_default: dict = None,
3340
+ prop_filepath: str | None = "filepath",
3341
+ filter_ext: collections.abc.Callable | None = None,
3342
+ filter_path=None,
3343
+ display_name: collections.abc.Callable | None = None,
3344
+ add_operator=None,
3345
+ add_operator_props=None,
3346
+ ):
3347
+ """Populate a menu from a list of paths.
3348
+
3349
+ :param searchpaths: Paths to scan.
3350
+ :type searchpaths: list[str]
3351
+ :param operator: The operator id to use with each file.
3352
+ :type operator: str
3353
+ :param props_default: Properties to assign to each operator.
3354
+ :type props_default: dict
3355
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
3356
+ :type prop_filepath: str | None
3357
+ :param filter_ext: Optional callback that takes the file extensions.
3358
+
3359
+ Returning false excludes the file from the list.
3360
+ :type filter_ext: collections.abc.Callable | None
3361
+ :param filter_path:
3362
+ :param display_name: Optional callback that takes the full path, returns the name to display.
3363
+ :type display_name: collections.abc.Callable | None
3364
+ :param add_operator:
3365
+ :param add_operator_props:
3366
+ """
3367
+ ...
3368
+
3369
+ def path_resolve(self):
3370
+ """Returns the property from the path, raise an exception when not found."""
3371
+ ...
3372
+
3373
+ def pop(self):
3374
+ """Remove and return the value of the custom property assigned to key or default
3375
+ when not found (matches Python's dictionary function of the same name).
3376
+
3377
+ """
3378
+ ...
3379
+
3380
+ def prepend(self, draw_func):
3381
+ """Prepend a draw function to this menu, takes the same arguments as
3382
+ the menus draw function
3383
+
3384
+ :param draw_func:
3385
+ """
3386
+ ...
3387
+
3388
+ def property_overridable_library_set(self) -> bool:
3389
+ """Define a property as overridable or not (only for custom properties!).
3390
+
3391
+ :return: True when the overridable status of the property was successfully set.
3392
+ :rtype: bool
3393
+ """
3394
+ ...
3395
+
3396
+ def property_unset(self):
3397
+ """Unset a property, will use default value afterward."""
3398
+ ...
3399
+
3400
+ def remove(self, draw_func):
3401
+ """Remove a draw function that has been added to this menu
3402
+
3403
+ :param draw_func:
3404
+ """
3405
+ ...
3406
+
3407
+ def type_recast(self):
3408
+ """Return a new instance, this is needed because types
3409
+ such as textures can be changed at runtime.
3410
+
3411
+ :return: a new instance of this object with the type initialized again.
3412
+ """
3413
+ ...
3414
+
3415
+ def values(self):
3416
+ """Returns the values of this objects custom properties (matches Python's
3417
+ dictionary function of the same name).
3418
+
3419
+ :return: custom property values.
3420
+ """
3421
+ ...
3422
+
3423
+ class POSE_MT_selection_sets_select(bpy_types._GenericUI):
3424
+ bl_label: typing.Any
3425
+ bl_rna: typing.Any
3426
+ id_data: typing.Any
3427
+
3428
+ def append(self, draw_func):
3429
+ """Append a draw function to this menu,
3430
+ takes the same arguments as the menus draw function
3431
+
3432
+ :param draw_func:
3433
+ """
3434
+ ...
3435
+
3436
+ def as_pointer(self) -> int:
3437
+ """Returns the memory address which holds a pointer to Blender's internal data
3438
+
3439
+ :return: int (memory address).
3440
+ :rtype: int
3441
+ """
3442
+ ...
3443
+
3444
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3445
+ """
3446
+
3447
+ :return: The RNA type or default when not found.
3448
+ :rtype: bpy.types.Struct
3449
+ """
3450
+ ...
3451
+
3452
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3453
+ """
3454
+
3455
+ :return: The class or default when not found.
3456
+ :rtype: typing.Any
3457
+ """
3458
+ ...
3459
+
3460
+ def draw(self, context):
3461
+ """
3462
+
3463
+ :param context:
3464
+ """
3465
+ ...
3466
+
3467
+ def draw_collapsible(self, context, layout):
3468
+ """
3469
+
3470
+ :param context:
3471
+ :param layout:
3472
+ """
3473
+ ...
3474
+
3475
+ def draw_preset(self, _context):
3476
+ """Define these on the subclass:
3477
+ - preset_operator (string)
3478
+ - preset_subdir (string)Optionally:
3479
+ - preset_add_operator (string)
3480
+ - preset_extensions (set of strings)
3481
+ - preset_operator_defaults (dict of keyword args)
3482
+
3483
+ :param _context:
3484
+ """
3485
+ ...
3486
+
3487
+ def driver_add(self) -> bpy.types.FCurve:
3488
+ """Adds driver(s) to the given property
3489
+
3490
+ :return: The driver(s) added.
3491
+ :rtype: bpy.types.FCurve
3492
+ """
3493
+ ...
3494
+
3495
+ def driver_remove(self) -> bool:
3496
+ """Remove driver(s) from the given property
3497
+
3498
+ :return: Success of driver removal.
3499
+ :rtype: bool
3500
+ """
3501
+ ...
3502
+
3503
+ def get(self):
3504
+ """Returns the value of the custom property assigned to key or default
3505
+ when not found (matches Python's dictionary function of the same name).
3506
+
3507
+ """
3508
+ ...
3509
+
3510
+ def id_properties_clear(self):
3511
+ """
3512
+
3513
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3514
+ """
3515
+ ...
3516
+
3517
+ def id_properties_ensure(self):
3518
+ """
3519
+
3520
+ :return: the parent group for an RNA struct's custom IDProperties.
3521
+ """
3522
+ ...
3523
+
3524
+ def id_properties_ui(self):
3525
+ """
3526
+
3527
+ :return: Return an object used to manage an IDProperty's UI data.
3528
+ """
3529
+ ...
3530
+
3531
+ def is_extended(self): ...
3532
+ def is_property_hidden(self) -> bool:
3533
+ """Check if a property is hidden.
3534
+
3535
+ :return: True when the property is hidden.
3536
+ :rtype: bool
3537
+ """
3538
+ ...
3539
+
3540
+ def is_property_overridable_library(self) -> bool:
3541
+ """Check if a property is overridable.
3542
+
3543
+ :return: True when the property is overridable.
3544
+ :rtype: bool
3545
+ """
3546
+ ...
3547
+
3548
+ def is_property_readonly(self) -> bool:
3549
+ """Check if a property is readonly.
3550
+
3551
+ :return: True when the property is readonly (not writable).
3552
+ :rtype: bool
3553
+ """
3554
+ ...
3555
+
3556
+ def is_property_set(self) -> bool:
3557
+ """Check if a property is set, use for testing operator properties.
3558
+
3559
+ :return: True when the property has been set.
3560
+ :rtype: bool
3561
+ """
3562
+ ...
3563
+
3564
+ def items(self):
3565
+ """Returns the items of this objects custom properties (matches Python's
3566
+ dictionary function of the same name).
3567
+
3568
+ :return: custom property key, value pairs.
3569
+ """
3570
+ ...
3571
+
3572
+ def keyframe_delete(self) -> bool:
3573
+ """Remove a keyframe from this properties fcurve.
3574
+
3575
+ :return: Success of keyframe deletion.
3576
+ :rtype: bool
3577
+ """
3578
+ ...
3579
+
3580
+ def keyframe_insert(self) -> bool:
3581
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3582
+
3583
+ :return: Success of keyframe insertion.
3584
+ :rtype: bool
3585
+ """
3586
+ ...
3587
+
3588
+ def keys(self):
3589
+ """Returns the keys of this objects custom properties (matches Python's
3590
+ dictionary function of the same name).
3591
+
3592
+ :return: custom property keys.
3593
+ """
3594
+ ...
3595
+
3596
+ def path_from_id(self) -> str:
3597
+ """Returns the data path from the ID to this object (string).
3598
+
3599
+ :return: The path from `bpy.types.bpy_struct.id_data`
3600
+ to this struct and property (when given).
3601
+ :rtype: str
3602
+ """
3603
+ ...
3604
+
3605
+ def path_menu(
3606
+ self,
3607
+ searchpaths: list[str],
3608
+ operator: str,
3609
+ *,
3610
+ props_default: dict = None,
3611
+ prop_filepath: str | None = "filepath",
3612
+ filter_ext: collections.abc.Callable | None = None,
3613
+ filter_path=None,
3614
+ display_name: collections.abc.Callable | None = None,
3615
+ add_operator=None,
3616
+ add_operator_props=None,
3617
+ ):
3618
+ """Populate a menu from a list of paths.
3619
+
3620
+ :param searchpaths: Paths to scan.
3621
+ :type searchpaths: list[str]
3622
+ :param operator: The operator id to use with each file.
3623
+ :type operator: str
3624
+ :param props_default: Properties to assign to each operator.
3625
+ :type props_default: dict
3626
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
3627
+ :type prop_filepath: str | None
3628
+ :param filter_ext: Optional callback that takes the file extensions.
3629
+
3630
+ Returning false excludes the file from the list.
3631
+ :type filter_ext: collections.abc.Callable | None
3632
+ :param filter_path:
3633
+ :param display_name: Optional callback that takes the full path, returns the name to display.
3634
+ :type display_name: collections.abc.Callable | None
3635
+ :param add_operator:
3636
+ :param add_operator_props:
3637
+ """
3638
+ ...
3639
+
3640
+ def path_resolve(self):
3641
+ """Returns the property from the path, raise an exception when not found."""
3642
+ ...
3643
+
3644
+ def poll(self, context):
3645
+ """
3646
+
3647
+ :param context:
3648
+ """
3649
+ ...
3650
+
3651
+ def pop(self):
3652
+ """Remove and return the value of the custom property assigned to key or default
3653
+ when not found (matches Python's dictionary function of the same name).
3654
+
3655
+ """
3656
+ ...
3657
+
3658
+ def prepend(self, draw_func):
3659
+ """Prepend a draw function to this menu, takes the same arguments as
3660
+ the menus draw function
3661
+
3662
+ :param draw_func:
3663
+ """
3664
+ ...
3665
+
3666
+ def property_overridable_library_set(self) -> bool:
3667
+ """Define a property as overridable or not (only for custom properties!).
3668
+
3669
+ :return: True when the overridable status of the property was successfully set.
3670
+ :rtype: bool
3671
+ """
3672
+ ...
3673
+
3674
+ def property_unset(self):
3675
+ """Unset a property, will use default value afterward."""
3676
+ ...
3677
+
3678
+ def remove(self, draw_func):
3679
+ """Remove a draw function that has been added to this menu
3680
+
3681
+ :param draw_func:
3682
+ """
3683
+ ...
3684
+
3685
+ def type_recast(self):
3686
+ """Return a new instance, this is needed because types
3687
+ such as textures can be changed at runtime.
3688
+
3689
+ :return: a new instance of this object with the type initialized again.
3690
+ """
3691
+ ...
3692
+
3693
+ def values(self):
3694
+ """Returns the values of this objects custom properties (matches Python's
3695
+ dictionary function of the same name).
3696
+
3697
+ :return: custom property values.
3698
+ """
3699
+ ...
3700
+
3701
+ class POSE_PT_selection_sets(bpy_types._GenericUI):
3702
+ bl_context: typing.Any
3703
+ bl_label: typing.Any
3704
+ bl_options: typing.Any
3705
+ bl_region_type: typing.Any
3706
+ bl_rna: typing.Any
3707
+ bl_space_type: typing.Any
3708
+ id_data: typing.Any
3709
+
3710
+ def append(self, draw_func):
3711
+ """Append a draw function to this menu,
3712
+ takes the same arguments as the menus draw function
3713
+
3714
+ :param draw_func:
3715
+ """
3716
+ ...
3717
+
3718
+ def as_pointer(self) -> int:
3719
+ """Returns the memory address which holds a pointer to Blender's internal data
3720
+
3721
+ :return: int (memory address).
3722
+ :rtype: int
3723
+ """
3724
+ ...
3725
+
3726
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3727
+ """
3728
+
3729
+ :return: The RNA type or default when not found.
3730
+ :rtype: bpy.types.Struct
3731
+ """
3732
+ ...
3733
+
3734
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3735
+ """
3736
+
3737
+ :return: The class or default when not found.
3738
+ :rtype: typing.Any
3739
+ """
3740
+ ...
3741
+
3742
+ def draw(self, context):
3743
+ """
3744
+
3745
+ :param context:
3746
+ """
3747
+ ...
3748
+
3749
+ def driver_add(self) -> bpy.types.FCurve:
3750
+ """Adds driver(s) to the given property
3751
+
3752
+ :return: The driver(s) added.
3753
+ :rtype: bpy.types.FCurve
3754
+ """
3755
+ ...
3756
+
3757
+ def driver_remove(self) -> bool:
3758
+ """Remove driver(s) from the given property
3759
+
3760
+ :return: Success of driver removal.
3761
+ :rtype: bool
3762
+ """
3763
+ ...
3764
+
3765
+ def get(self):
3766
+ """Returns the value of the custom property assigned to key or default
3767
+ when not found (matches Python's dictionary function of the same name).
3768
+
3769
+ """
3770
+ ...
3771
+
3772
+ def id_properties_clear(self):
3773
+ """
3774
+
3775
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3776
+ """
3777
+ ...
3778
+
3779
+ def id_properties_ensure(self):
3780
+ """
3781
+
3782
+ :return: the parent group for an RNA struct's custom IDProperties.
3783
+ """
3784
+ ...
3785
+
3786
+ def id_properties_ui(self):
3787
+ """
3788
+
3789
+ :return: Return an object used to manage an IDProperty's UI data.
3790
+ """
3791
+ ...
3792
+
3793
+ def is_extended(self): ...
3794
+ def is_property_hidden(self) -> bool:
3795
+ """Check if a property is hidden.
3796
+
3797
+ :return: True when the property is hidden.
3798
+ :rtype: bool
3799
+ """
3800
+ ...
3801
+
3802
+ def is_property_overridable_library(self) -> bool:
3803
+ """Check if a property is overridable.
3804
+
3805
+ :return: True when the property is overridable.
3806
+ :rtype: bool
3807
+ """
3808
+ ...
3809
+
3810
+ def is_property_readonly(self) -> bool:
3811
+ """Check if a property is readonly.
3812
+
3813
+ :return: True when the property is readonly (not writable).
3814
+ :rtype: bool
3815
+ """
3816
+ ...
3817
+
3818
+ def is_property_set(self) -> bool:
3819
+ """Check if a property is set, use for testing operator properties.
3820
+
3821
+ :return: True when the property has been set.
3822
+ :rtype: bool
3823
+ """
3824
+ ...
3825
+
3826
+ def items(self):
3827
+ """Returns the items of this objects custom properties (matches Python's
3828
+ dictionary function of the same name).
3829
+
3830
+ :return: custom property key, value pairs.
3831
+ """
3832
+ ...
3833
+
3834
+ def keyframe_delete(self) -> bool:
3835
+ """Remove a keyframe from this properties fcurve.
3836
+
3837
+ :return: Success of keyframe deletion.
3838
+ :rtype: bool
3839
+ """
3840
+ ...
3841
+
3842
+ def keyframe_insert(self) -> bool:
3843
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3844
+
3845
+ :return: Success of keyframe insertion.
3846
+ :rtype: bool
3847
+ """
3848
+ ...
3849
+
3850
+ def keys(self):
3851
+ """Returns the keys of this objects custom properties (matches Python's
3852
+ dictionary function of the same name).
3853
+
3854
+ :return: custom property keys.
3855
+ """
3856
+ ...
3857
+
3858
+ def path_from_id(self) -> str:
3859
+ """Returns the data path from the ID to this object (string).
3860
+
3861
+ :return: The path from `bpy.types.bpy_struct.id_data`
3862
+ to this struct and property (when given).
3863
+ :rtype: str
3864
+ """
3865
+ ...
3866
+
3867
+ def path_resolve(self):
3868
+ """Returns the property from the path, raise an exception when not found."""
3869
+ ...
3870
+
3871
+ def poll(self, context):
3872
+ """
3873
+
3874
+ :param context:
3875
+ """
3876
+ ...
3877
+
3878
+ def pop(self):
3879
+ """Remove and return the value of the custom property assigned to key or default
3880
+ when not found (matches Python's dictionary function of the same name).
3881
+
3882
+ """
3883
+ ...
3884
+
3885
+ def prepend(self, draw_func):
3886
+ """Prepend a draw function to this menu, takes the same arguments as
3887
+ the menus draw function
3888
+
3889
+ :param draw_func:
3890
+ """
3891
+ ...
3892
+
3893
+ def property_overridable_library_set(self) -> bool:
3894
+ """Define a property as overridable or not (only for custom properties!).
3895
+
3896
+ :return: True when the overridable status of the property was successfully set.
3897
+ :rtype: bool
3898
+ """
3899
+ ...
3900
+
3901
+ def property_unset(self):
3902
+ """Unset a property, will use default value afterward."""
3903
+ ...
3904
+
3905
+ def remove(self, draw_func):
3906
+ """Remove a draw function that has been added to this menu
3907
+
3908
+ :param draw_func:
3909
+ """
3910
+ ...
3911
+
3912
+ def type_recast(self):
3913
+ """Return a new instance, this is needed because types
3914
+ such as textures can be changed at runtime.
3915
+
3916
+ :return: a new instance of this object with the type initialized again.
3917
+ """
3918
+ ...
3919
+
3920
+ def values(self):
3921
+ """Returns the values of this objects custom properties (matches Python's
3922
+ dictionary function of the same name).
3923
+
3924
+ :return: custom property values.
3925
+ """
3926
+ ...
3927
+
3928
+ class POSE_UL_selection_set(bpy_types._GenericUI):
3929
+ bl_rna: typing.Any
3930
+ id_data: typing.Any
3931
+
3932
+ def append(self, draw_func):
3933
+ """Append a draw function to this menu,
3934
+ takes the same arguments as the menus draw function
3935
+
3936
+ :param draw_func:
3937
+ """
3938
+ ...
3939
+
3940
+ def as_pointer(self) -> int:
3941
+ """Returns the memory address which holds a pointer to Blender's internal data
3942
+
3943
+ :return: int (memory address).
3944
+ :rtype: int
3945
+ """
3946
+ ...
3947
+
3948
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3949
+ """
3950
+
3951
+ :return: The RNA type or default when not found.
3952
+ :rtype: bpy.types.Struct
3953
+ """
3954
+ ...
3955
+
3956
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3957
+ """
3958
+
3959
+ :return: The class or default when not found.
3960
+ :rtype: typing.Any
3961
+ """
3962
+ ...
3963
+
3964
+ def draw_item(
3965
+ self, context, layout, data, item, icon, active_data, active_propname, index
3966
+ ):
3967
+ """
3968
+
3969
+ :param context:
3970
+ :param layout:
3971
+ :param data:
3972
+ :param item:
3973
+ :param icon:
3974
+ :param active_data:
3975
+ :param active_propname:
3976
+ :param index:
3977
+ """
3978
+ ...
3979
+
3980
+ def driver_add(self) -> bpy.types.FCurve:
3981
+ """Adds driver(s) to the given property
3982
+
3983
+ :return: The driver(s) added.
3984
+ :rtype: bpy.types.FCurve
3985
+ """
3986
+ ...
3987
+
3988
+ def driver_remove(self) -> bool:
3989
+ """Remove driver(s) from the given property
3990
+
3991
+ :return: Success of driver removal.
3992
+ :rtype: bool
3993
+ """
3994
+ ...
3995
+
3996
+ def get(self):
3997
+ """Returns the value of the custom property assigned to key or default
3998
+ when not found (matches Python's dictionary function of the same name).
3999
+
4000
+ """
4001
+ ...
4002
+
4003
+ def id_properties_clear(self):
4004
+ """
4005
+
4006
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4007
+ """
4008
+ ...
4009
+
4010
+ def id_properties_ensure(self):
4011
+ """
4012
+
4013
+ :return: the parent group for an RNA struct's custom IDProperties.
4014
+ """
4015
+ ...
4016
+
4017
+ def id_properties_ui(self):
4018
+ """
4019
+
4020
+ :return: Return an object used to manage an IDProperty's UI data.
4021
+ """
4022
+ ...
4023
+
4024
+ def is_extended(self): ...
4025
+ def is_property_hidden(self) -> bool:
4026
+ """Check if a property is hidden.
4027
+
4028
+ :return: True when the property is hidden.
4029
+ :rtype: bool
4030
+ """
4031
+ ...
4032
+
4033
+ def is_property_overridable_library(self) -> bool:
4034
+ """Check if a property is overridable.
4035
+
4036
+ :return: True when the property is overridable.
4037
+ :rtype: bool
4038
+ """
4039
+ ...
4040
+
4041
+ def is_property_readonly(self) -> bool:
4042
+ """Check if a property is readonly.
4043
+
4044
+ :return: True when the property is readonly (not writable).
4045
+ :rtype: bool
4046
+ """
4047
+ ...
4048
+
4049
+ def is_property_set(self) -> bool:
4050
+ """Check if a property is set, use for testing operator properties.
4051
+
4052
+ :return: True when the property has been set.
4053
+ :rtype: bool
4054
+ """
4055
+ ...
4056
+
4057
+ def items(self):
4058
+ """Returns the items of this objects custom properties (matches Python's
4059
+ dictionary function of the same name).
4060
+
4061
+ :return: custom property key, value pairs.
4062
+ """
4063
+ ...
4064
+
4065
+ def keyframe_delete(self) -> bool:
4066
+ """Remove a keyframe from this properties fcurve.
4067
+
4068
+ :return: Success of keyframe deletion.
4069
+ :rtype: bool
4070
+ """
4071
+ ...
4072
+
4073
+ def keyframe_insert(self) -> bool:
4074
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4075
+
4076
+ :return: Success of keyframe insertion.
4077
+ :rtype: bool
4078
+ """
4079
+ ...
4080
+
4081
+ def keys(self):
4082
+ """Returns the keys of this objects custom properties (matches Python's
4083
+ dictionary function of the same name).
4084
+
4085
+ :return: custom property keys.
4086
+ """
4087
+ ...
4088
+
4089
+ def path_from_id(self) -> str:
4090
+ """Returns the data path from the ID to this object (string).
4091
+
4092
+ :return: The path from `bpy.types.bpy_struct.id_data`
4093
+ to this struct and property (when given).
4094
+ :rtype: str
4095
+ """
4096
+ ...
4097
+
4098
+ def path_resolve(self):
4099
+ """Returns the property from the path, raise an exception when not found."""
4100
+ ...
4101
+
4102
+ def pop(self):
4103
+ """Remove and return the value of the custom property assigned to key or default
4104
+ when not found (matches Python's dictionary function of the same name).
4105
+
4106
+ """
4107
+ ...
4108
+
4109
+ def prepend(self, draw_func):
4110
+ """Prepend a draw function to this menu, takes the same arguments as
4111
+ the menus draw function
4112
+
4113
+ :param draw_func:
4114
+ """
4115
+ ...
4116
+
4117
+ def property_overridable_library_set(self) -> bool:
4118
+ """Define a property as overridable or not (only for custom properties!).
4119
+
4120
+ :return: True when the overridable status of the property was successfully set.
4121
+ :rtype: bool
4122
+ """
4123
+ ...
4124
+
4125
+ def property_unset(self):
4126
+ """Unset a property, will use default value afterward."""
4127
+ ...
4128
+
4129
+ def remove(self, draw_func):
4130
+ """Remove a draw function that has been added to this menu
4131
+
4132
+ :param draw_func:
4133
+ """
4134
+ ...
4135
+
4136
+ def type_recast(self):
4137
+ """Return a new instance, this is needed because types
4138
+ such as textures can be changed at runtime.
4139
+
4140
+ :return: a new instance of this object with the type initialized again.
4141
+ """
4142
+ ...
4143
+
4144
+ def values(self):
4145
+ """Returns the values of this objects custom properties (matches Python's
4146
+ dictionary function of the same name).
4147
+
4148
+ :return: custom property values.
4149
+ """
4150
+ ...