fake-bpy-module 20240516__py3-none-any.whl → 20240518__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

Files changed (549) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +17 -84
  2. addon_utils/__init__.pyi +44 -38
  3. animsys_refactor/__init__.pyi +7 -27
  4. aud/__init__.pyi +8 -11
  5. bgl/__init__.pyi +121 -1812
  6. bl_app_override/__init__.pyi +8 -19
  7. bl_app_override/helpers/__init__.pyi +5 -23
  8. bl_app_template_utils/__init__.pyi +5 -17
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
  14. bl_i18n_utils/merge_po/__init__.pyi +1 -4
  15. bl_i18n_utils/settings/__init__.pyi +6 -24
  16. bl_i18n_utils/utils/__init__.pyi +93 -122
  17. bl_i18n_utils/utils_cli/__init__.pyi +6 -29
  18. bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
  19. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  20. bl_keymap_utils/io/__init__.pyi +9 -40
  21. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  22. bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
  23. bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
  24. bl_keymap_utils/versioning/__init__.pyi +1 -4
  25. bl_operators/__init__.pyi +2 -9
  26. bl_operators/add_mesh_torus/__init__.pyi +128 -59
  27. bl_operators/anim/__init__.pyi +1001 -398
  28. bl_operators/assets/__init__.pyi +376 -152
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
  30. bl_operators/clip/__init__.pyi +1264 -532
  31. bl_operators/console/__init__.pyi +626 -242
  32. bl_operators/constraint/__init__.pyi +502 -201
  33. bl_operators/file/__init__.pyi +376 -150
  34. bl_operators/freestyle/__init__.pyi +501 -200
  35. bl_operators/geometry_nodes/__init__.pyi +514 -266
  36. bl_operators/image/__init__.pyi +621 -251
  37. bl_operators/mesh/__init__.pyi +376 -150
  38. bl_operators/node/__init__.pyi +1253 -516
  39. bl_operators/object/__init__.pyi +1879 -755
  40. bl_operators/object_align/__init__.pyi +129 -64
  41. bl_operators/object_quick_effects/__init__.pyi +504 -213
  42. bl_operators/object_randomize_transform/__init__.pyi +129 -54
  43. bl_operators/presets/__init__.pyi +3072 -1403
  44. bl_operators/rigidbody/__init__.pyi +376 -150
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
  46. bl_operators/sequencer/__init__.pyi +1010 -434
  47. bl_operators/spreadsheet/__init__.pyi +126 -50
  48. bl_operators/userpref/__init__.pyi +3253 -1267
  49. bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
  50. bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
  51. bl_operators/uvcalc_transform/__init__.pyi +297 -159
  52. bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
  53. bl_operators/view3d/__init__.pyi +868 -342
  54. bl_operators/wm/__init__.pyi +5795 -2388
  55. bl_operators/world/__init__.pyi +126 -50
  56. bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
  57. bl_rna_utils/data_path/__init__.pyi +8 -4
  58. bl_text_utils/external_editor/__init__.pyi +1 -4
  59. bl_ui/__init__.pyi +366 -269
  60. bl_ui/anim/__init__.pyi +164 -74
  61. bl_ui/asset_shelf/__init__.pyi +129 -56
  62. bl_ui/generic_ui_list/__init__.pyi +412 -163
  63. bl_ui/node_add_menu/__init__.pyi +171 -94
  64. bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
  65. bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
  66. bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
  67. bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
  68. bl_ui/properties_animviz/__init__.pyi +2 -16
  69. bl_ui/properties_collection/__init__.pyi +807 -379
  70. bl_ui/properties_constraint/__init__.pyi +10292 -4941
  71. bl_ui/properties_data_armature/__init__.pyi +1615 -753
  72. bl_ui/properties_data_bone/__init__.pyi +1284 -608
  73. bl_ui/properties_data_camera/__init__.pyi +1854 -927
  74. bl_ui/properties_data_curve/__init__.pyi +1927 -937
  75. bl_ui/properties_data_curves/__init__.pyi +806 -375
  76. bl_ui/properties_data_empty/__init__.pyi +257 -125
  77. bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
  79. bl_ui/properties_data_lattice/__init__.pyi +388 -188
  80. bl_ui/properties_data_light/__init__.pyi +1540 -756
  81. bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
  82. bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
  83. bl_ui/properties_data_metaball/__init__.pyi +644 -308
  84. bl_ui/properties_data_modifier/__init__.pyi +1353 -671
  85. bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
  86. bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
  87. bl_ui/properties_data_speaker/__init__.pyi +644 -316
  88. bl_ui/properties_data_volume/__init__.pyi +1028 -484
  89. bl_ui/properties_freestyle/__init__.pyi +3112 -1619
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
  91. bl_ui/properties_mask_common/__init__.pyi +1102 -523
  92. bl_ui/properties_material/__init__.pyi +2089 -1009
  93. bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
  94. bl_ui/properties_object/__init__.pyi +1832 -873
  95. bl_ui/properties_output/__init__.pyi +2405 -1173
  96. bl_ui/properties_paint_common/__init__.pyi +416 -386
  97. bl_ui/properties_particle/__init__.pyi +6740 -3346
  98. bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
  99. bl_ui/properties_physics_common/__init__.pyi +135 -98
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
  101. bl_ui/properties_physics_field/__init__.pyi +1282 -627
  102. bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
  106. bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
  107. bl_ui/properties_render/__init__.pyi +6843 -3367
  108. bl_ui/properties_scene/__init__.pyi +1924 -913
  109. bl_ui/properties_texture/__init__.pyi +3371 -1667
  110. bl_ui/properties_view_layer/__init__.pyi +2344 -1107
  111. bl_ui/properties_workspace/__init__.pyi +516 -244
  112. bl_ui/properties_world/__init__.pyi +1284 -630
  113. bl_ui/space_clip/__init__.pyi +10172 -4695
  114. bl_ui/space_console/__init__.pyi +940 -423
  115. bl_ui/space_dopesheet/__init__.pyi +4325 -2013
  116. bl_ui/space_filebrowser/__init__.pyi +4172 -1903
  117. bl_ui/space_graph/__init__.pyi +3107 -1394
  118. bl_ui/space_image/__init__.pyi +9764 -4614
  119. bl_ui/space_info/__init__.pyi +939 -421
  120. bl_ui/space_nla/__init__.pyi +2623 -1183
  121. bl_ui/space_node/__init__.pyi +3995 -1840
  122. bl_ui/space_outliner/__init__.pyi +2203 -991
  123. bl_ui/space_properties/__init__.pyi +386 -165
  124. bl_ui/space_sequencer/__init__.pyi +10809 -4978
  125. bl_ui/space_spreadsheet/__init__.pyi +130 -53
  126. bl_ui/space_statusbar/__init__.pyi +129 -52
  127. bl_ui/space_text/__init__.pyi +2457 -1100
  128. bl_ui/space_time/__init__.pyi +1034 -481
  129. bl_ui/space_toolsystem_common/__init__.pyi +56 -211
  130. bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
  131. bl_ui/space_topbar/__init__.pyi +3982 -1805
  132. bl_ui/space_userpref/__init__.pyi +11383 -5290
  133. bl_ui/space_view3d/__init__.pyi +40873 -18532
  134. bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
  135. bl_ui/temp_anim_layers/__init__.pyi +130 -62
  136. bl_ui/utils/__init__.pyi +28 -27
  137. bl_ui_utils/bug_report_url/__init__.pyi +1 -4
  138. bl_ui_utils/layout/__init__.pyi +1 -1
  139. blend_render_info/__init__.pyi +3 -10
  140. blf/__init__.pyi +4 -4
  141. bmesh/geometry/__init__.pyi +2 -3
  142. bmesh/ops/__init__.pyi +372 -419
  143. bmesh/types/__init__.pyi +39 -56
  144. bmesh/utils/__init__.pyi +10 -13
  145. bpy/app/__init__.pyi +4 -4
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -8
  148. bpy/app/timers/__init__.pyi +10 -10
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +2 -4
  151. bpy/ops/action/__init__.pyi +316 -394
  152. bpy/ops/anim/__init__.pyi +442 -548
  153. bpy/ops/armature/__init__.pyi +374 -470
  154. bpy/ops/asset/__init__.pyi +152 -184
  155. bpy/ops/bl_pkg/__init__.pyi +221 -272
  156. bpy/ops/boid/__init__.pyi +50 -66
  157. bpy/ops/brush/__init__.pyi +72 -90
  158. bpy/ops/buttons/__init__.pyi +132 -144
  159. bpy/ops/cachefile/__init__.pyi +128 -138
  160. bpy/ops/camera/__init__.pyi +26 -30
  161. bpy/ops/clip/__init__.pyi +777 -964
  162. bpy/ops/cloth/__init__.pyi +12 -14
  163. bpy/ops/collection/__init__.pyi +68 -86
  164. bpy/ops/console/__init__.pyi +158 -200
  165. bpy/ops/constraint/__init__.pyi +178 -214
  166. bpy/ops/curve/__init__.pyi +473 -576
  167. bpy/ops/curves/__init__.pyi +247 -302
  168. bpy/ops/cycles/__init__.pyi +28 -34
  169. bpy/ops/dpaint/__init__.pyi +34 -44
  170. bpy/ops/ed/__init__.pyi +126 -150
  171. bpy/ops/export_anim/__init__.pyi +22 -24
  172. bpy/ops/export_scene/__init__.pyi +302 -336
  173. bpy/ops/file/__init__.pyi +352 -432
  174. bpy/ops/fluid/__init__.pyi +90 -118
  175. bpy/ops/font/__init__.pyi +258 -304
  176. bpy/ops/geometry/__init__.pyi +100 -120
  177. bpy/ops/gizmogroup/__init__.pyi +22 -26
  178. bpy/ops/gpencil/__init__.pyi +1469 -1778
  179. bpy/ops/graph/__init__.pyi +644 -776
  180. bpy/ops/grease_pencil/__init__.pyi +597 -748
  181. bpy/ops/image/__init__.pyi +648 -744
  182. bpy/ops/import_anim/__init__.pyi +30 -32
  183. bpy/ops/import_curve/__init__.pyi +10 -12
  184. bpy/ops/import_scene/__init__.pyi +88 -96
  185. bpy/ops/info/__init__.pyi +60 -74
  186. bpy/ops/lattice/__init__.pyi +64 -80
  187. bpy/ops/marker/__init__.pyi +108 -130
  188. bpy/ops/mask/__init__.pyi +322 -402
  189. bpy/ops/material/__init__.pyi +18 -24
  190. bpy/ops/mball/__init__.pyi +70 -86
  191. bpy/ops/mesh/__init__.pyi +1986 -2322
  192. bpy/ops/nla/__init__.pyi +333 -411
  193. bpy/ops/node/__init__.pyi +886 -1100
  194. bpy/ops/object/__init__.pyi +2585 -3078
  195. bpy/ops/outliner/__init__.pyi +498 -636
  196. bpy/ops/paint/__init__.pyi +565 -680
  197. bpy/ops/paintcurve/__init__.pyi +64 -80
  198. bpy/ops/palette/__init__.pyi +50 -64
  199. bpy/ops/particle/__init__.pyi +267 -340
  200. bpy/ops/pose/__init__.pyi +336 -414
  201. bpy/ops/poselib/__init__.pyi +72 -90
  202. bpy/ops/preferences/__init__.pyi +386 -463
  203. bpy/ops/ptcache/__init__.pyi +46 -60
  204. bpy/ops/render/__init__.pyi +130 -154
  205. bpy/ops/rigidbody/__init__.pyi +102 -128
  206. bpy/ops/scene/__init__.pyi +280 -358
  207. bpy/ops/screen/__init__.pyi +382 -460
  208. bpy/ops/script/__init__.pyi +24 -30
  209. bpy/ops/sculpt/__init__.pyi +458 -532
  210. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  211. bpy/ops/sequencer/__init__.pyi +1066 -1244
  212. bpy/ops/sound/__init__.pyi +216 -230
  213. bpy/ops/spreadsheet/__init__.pyi +30 -38
  214. bpy/ops/surface/__init__.pyi +108 -120
  215. bpy/ops/text/__init__.pyi +390 -476
  216. bpy/ops/text_editor/__init__.pyi +12 -14
  217. bpy/ops/texture/__init__.pyi +26 -34
  218. bpy/ops/transform/__init__.pyi +792 -878
  219. bpy/ops/ui/__init__.pyi +228 -294
  220. bpy/ops/uilist/__init__.pyi +32 -38
  221. bpy/ops/uv/__init__.pyi +602 -704
  222. bpy/ops/view2d/__init__.pyi +156 -184
  223. bpy/ops/view3d/__init__.pyi +582 -718
  224. bpy/ops/wm/__init__.pyi +2683 -2928
  225. bpy/ops/workspace/__init__.pyi +46 -60
  226. bpy/ops/world/__init__.pyi +12 -16
  227. bpy/path/__init__.pyi +179 -75
  228. bpy/props/__init__.pyi +261 -263
  229. bpy/types/__init__.pyi +17058 -26311
  230. bpy/utils/__init__.pyi +247 -179
  231. bpy/utils/previews/__init__.pyi +58 -28
  232. bpy/utils/units/__init__.pyi +20 -20
  233. bpy_extras/anim_utils/__init__.pyi +68 -29
  234. bpy_extras/asset_utils/__init__.pyi +0 -10
  235. bpy_extras/bmesh_utils/__init__.pyi +9 -6
  236. bpy_extras/extensions/junction_module/__init__.pyi +6 -8
  237. bpy_extras/id_map_utils/__init__.pyi +3 -3
  238. bpy_extras/image_utils/__init__.pyi +44 -11
  239. bpy_extras/io_utils/__init__.pyi +116 -41
  240. bpy_extras/keyconfig_utils/__init__.pyi +4 -11
  241. bpy_extras/mesh_utils/__init__.pyi +71 -19
  242. bpy_extras/node_shader_utils/__init__.pyi +52 -288
  243. bpy_extras/node_utils/__init__.pyi +10 -10
  244. bpy_extras/object_utils/__init__.pyi +71 -14
  245. bpy_extras/view3d_utils/__init__.pyi +80 -10
  246. bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
  247. bpy_restrict_state/__init__.pyi +1 -14
  248. bpy_types/__init__.pyi +4203 -1605
  249. console_python/__init__.pyi +12 -37
  250. console_shell/__init__.pyi +5 -24
  251. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
  252. fake_bpy_module-20240518.dist-info/RECORD +353 -0
  253. freestyle/chainingiterators/__init__.pyi +14 -44
  254. freestyle/functions/__init__.pyi +7 -33
  255. freestyle/predicates/__init__.pyi +44 -217
  256. freestyle/shaders/__init__.pyi +2 -12
  257. freestyle/types/__init__.pyi +84 -96
  258. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  259. freestyle/utils/__init__.pyi +6 -18
  260. gpu/matrix/__init__.pyi +6 -8
  261. gpu/state/__init__.pyi +2 -2
  262. gpu/types/__init__.pyi +12 -12
  263. gpu_extras/presets/__init__.pyi +2 -5
  264. graphviz_export/__init__.pyi +4 -9
  265. idprop/types/__init__.pyi +8 -35
  266. imbuf/__init__.pyi +4 -4
  267. imbuf/types/__init__.pyi +0 -2
  268. keyingsets_builtins/__init__.pyi +2692 -997
  269. keyingsets_utils/__init__.pyi +14 -69
  270. mathutils/__init__.pyi +194 -238
  271. mathutils/bvhtree/__init__.pyi +4 -6
  272. mathutils/geometry/__init__.pyi +153 -155
  273. mathutils/kdtree/__init__.pyi +8 -12
  274. mathutils/noise/__init__.pyi +26 -26
  275. nodeitems_builtins/__init__.pyi +5 -30
  276. nodeitems_utils/__init__.pyi +8 -45
  277. rna_info/__init__.pyi +39 -215
  278. rna_keymap_ui/__init__.pyi +6 -29
  279. rna_prop_ui/__init__.pyi +24 -62
  280. rna_xml/__init__.pyi +16 -39
  281. sys_info/__init__.pyi +1 -4
  282. _bpy_internal/freedesktop/py.typed +0 -0
  283. bl_app_override/helpers/py.typed +0 -0
  284. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  285. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  286. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  287. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  288. bl_console_utils/autocomplete/py.typed +0 -0
  289. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  290. bl_i18n_utils/merge_po/py.typed +0 -0
  291. bl_i18n_utils/settings/py.typed +0 -0
  292. bl_i18n_utils/utils/py.typed +0 -0
  293. bl_i18n_utils/utils_cli/py.typed +0 -0
  294. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  295. bl_i18n_utils/utils_rtl/py.typed +0 -0
  296. bl_keymap_utils/io/py.typed +0 -0
  297. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  298. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  299. bl_keymap_utils/platform_helpers/py.typed +0 -0
  300. bl_keymap_utils/versioning/py.typed +0 -0
  301. bl_operators/add_mesh_torus/py.typed +0 -0
  302. bl_operators/anim/py.typed +0 -0
  303. bl_operators/assets/py.typed +0 -0
  304. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  305. bl_operators/bmesh/py.typed +0 -0
  306. bl_operators/clip/py.typed +0 -0
  307. bl_operators/console/py.typed +0 -0
  308. bl_operators/constraint/py.typed +0 -0
  309. bl_operators/file/py.typed +0 -0
  310. bl_operators/freestyle/py.typed +0 -0
  311. bl_operators/geometry_nodes/py.typed +0 -0
  312. bl_operators/image/py.typed +0 -0
  313. bl_operators/mesh/py.typed +0 -0
  314. bl_operators/node/py.typed +0 -0
  315. bl_operators/object/py.typed +0 -0
  316. bl_operators/object_align/py.typed +0 -0
  317. bl_operators/object_quick_effects/py.typed +0 -0
  318. bl_operators/object_randomize_transform/py.typed +0 -0
  319. bl_operators/presets/py.typed +0 -0
  320. bl_operators/rigidbody/py.typed +0 -0
  321. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  322. bl_operators/sequencer/py.typed +0 -0
  323. bl_operators/spreadsheet/py.typed +0 -0
  324. bl_operators/userpref/py.typed +0 -0
  325. bl_operators/uvcalc_follow_active/py.typed +0 -0
  326. bl_operators/uvcalc_lightmap/py.typed +0 -0
  327. bl_operators/uvcalc_transform/py.typed +0 -0
  328. bl_operators/vertexpaint_dirt/py.typed +0 -0
  329. bl_operators/view3d/py.typed +0 -0
  330. bl_operators/wm/py.typed +0 -0
  331. bl_operators/world/py.typed +0 -0
  332. bl_previews_utils/bl_previews_render/py.typed +0 -0
  333. bl_rna_utils/data_path/py.typed +0 -0
  334. bl_text_utils/external_editor/py.typed +0 -0
  335. bl_ui/anim/py.typed +0 -0
  336. bl_ui/asset_shelf/py.typed +0 -0
  337. bl_ui/generic_ui_list/py.typed +0 -0
  338. bl_ui/node_add_menu/py.typed +0 -0
  339. bl_ui/node_add_menu_compositor/py.typed +0 -0
  340. bl_ui/node_add_menu_geometry/py.typed +0 -0
  341. bl_ui/node_add_menu_shader/py.typed +0 -0
  342. bl_ui/node_add_menu_texture/py.typed +0 -0
  343. bl_ui/properties_animviz/py.typed +0 -0
  344. bl_ui/properties_collection/py.typed +0 -0
  345. bl_ui/properties_constraint/py.typed +0 -0
  346. bl_ui/properties_data_armature/py.typed +0 -0
  347. bl_ui/properties_data_bone/py.typed +0 -0
  348. bl_ui/properties_data_camera/py.typed +0 -0
  349. bl_ui/properties_data_curve/py.typed +0 -0
  350. bl_ui/properties_data_curves/py.typed +0 -0
  351. bl_ui/properties_data_empty/py.typed +0 -0
  352. bl_ui/properties_data_gpencil/py.typed +0 -0
  353. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  354. bl_ui/properties_data_lattice/py.typed +0 -0
  355. bl_ui/properties_data_light/py.typed +0 -0
  356. bl_ui/properties_data_lightprobe/py.typed +0 -0
  357. bl_ui/properties_data_mesh/py.typed +0 -0
  358. bl_ui/properties_data_metaball/py.typed +0 -0
  359. bl_ui/properties_data_modifier/py.typed +0 -0
  360. bl_ui/properties_data_pointcloud/py.typed +0 -0
  361. bl_ui/properties_data_shaderfx/py.typed +0 -0
  362. bl_ui/properties_data_speaker/py.typed +0 -0
  363. bl_ui/properties_data_volume/py.typed +0 -0
  364. bl_ui/properties_freestyle/py.typed +0 -0
  365. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  366. bl_ui/properties_mask_common/py.typed +0 -0
  367. bl_ui/properties_material/py.typed +0 -0
  368. bl_ui/properties_material_gpencil/py.typed +0 -0
  369. bl_ui/properties_object/py.typed +0 -0
  370. bl_ui/properties_output/py.typed +0 -0
  371. bl_ui/properties_paint_common/py.typed +0 -0
  372. bl_ui/properties_particle/py.typed +0 -0
  373. bl_ui/properties_physics_cloth/py.typed +0 -0
  374. bl_ui/properties_physics_common/py.typed +0 -0
  375. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  376. bl_ui/properties_physics_field/py.typed +0 -0
  377. bl_ui/properties_physics_fluid/py.typed +0 -0
  378. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  379. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  380. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  381. bl_ui/properties_physics_softbody/py.typed +0 -0
  382. bl_ui/properties_render/py.typed +0 -0
  383. bl_ui/properties_scene/py.typed +0 -0
  384. bl_ui/properties_texture/py.typed +0 -0
  385. bl_ui/properties_view_layer/py.typed +0 -0
  386. bl_ui/properties_workspace/py.typed +0 -0
  387. bl_ui/properties_world/py.typed +0 -0
  388. bl_ui/space_clip/py.typed +0 -0
  389. bl_ui/space_console/py.typed +0 -0
  390. bl_ui/space_dopesheet/py.typed +0 -0
  391. bl_ui/space_filebrowser/py.typed +0 -0
  392. bl_ui/space_graph/py.typed +0 -0
  393. bl_ui/space_image/py.typed +0 -0
  394. bl_ui/space_info/py.typed +0 -0
  395. bl_ui/space_nla/py.typed +0 -0
  396. bl_ui/space_node/py.typed +0 -0
  397. bl_ui/space_outliner/py.typed +0 -0
  398. bl_ui/space_properties/py.typed +0 -0
  399. bl_ui/space_sequencer/py.typed +0 -0
  400. bl_ui/space_spreadsheet/py.typed +0 -0
  401. bl_ui/space_statusbar/py.typed +0 -0
  402. bl_ui/space_text/py.typed +0 -0
  403. bl_ui/space_time/py.typed +0 -0
  404. bl_ui/space_toolsystem_common/py.typed +0 -0
  405. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  406. bl_ui/space_topbar/py.typed +0 -0
  407. bl_ui/space_userpref/py.typed +0 -0
  408. bl_ui/space_view3d/py.typed +0 -0
  409. bl_ui/space_view3d_toolbar/py.typed +0 -0
  410. bl_ui/temp_anim_layers/py.typed +0 -0
  411. bl_ui/utils/py.typed +0 -0
  412. bl_ui_utils/bug_report_url/py.typed +0 -0
  413. bl_ui_utils/layout/py.typed +0 -0
  414. bmesh/geometry/py.typed +0 -0
  415. bmesh/ops/py.typed +0 -0
  416. bmesh/types/py.typed +0 -0
  417. bmesh/utils/py.typed +0 -0
  418. bpy/app/handlers/py.typed +0 -0
  419. bpy/app/icons/py.typed +0 -0
  420. bpy/app/py.typed +0 -0
  421. bpy/app/timers/py.typed +0 -0
  422. bpy/app/translations/py.typed +0 -0
  423. bpy/msgbus/py.typed +0 -0
  424. bpy/ops/action/py.typed +0 -0
  425. bpy/ops/anim/py.typed +0 -0
  426. bpy/ops/armature/py.typed +0 -0
  427. bpy/ops/asset/py.typed +0 -0
  428. bpy/ops/bl_pkg/py.typed +0 -0
  429. bpy/ops/boid/py.typed +0 -0
  430. bpy/ops/brush/py.typed +0 -0
  431. bpy/ops/buttons/py.typed +0 -0
  432. bpy/ops/cachefile/py.typed +0 -0
  433. bpy/ops/camera/py.typed +0 -0
  434. bpy/ops/clip/py.typed +0 -0
  435. bpy/ops/cloth/py.typed +0 -0
  436. bpy/ops/collection/py.typed +0 -0
  437. bpy/ops/console/py.typed +0 -0
  438. bpy/ops/constraint/py.typed +0 -0
  439. bpy/ops/curve/py.typed +0 -0
  440. bpy/ops/curves/py.typed +0 -0
  441. bpy/ops/cycles/py.typed +0 -0
  442. bpy/ops/dpaint/py.typed +0 -0
  443. bpy/ops/ed/py.typed +0 -0
  444. bpy/ops/export_anim/py.typed +0 -0
  445. bpy/ops/export_scene/py.typed +0 -0
  446. bpy/ops/file/py.typed +0 -0
  447. bpy/ops/fluid/py.typed +0 -0
  448. bpy/ops/font/py.typed +0 -0
  449. bpy/ops/geometry/py.typed +0 -0
  450. bpy/ops/gizmogroup/py.typed +0 -0
  451. bpy/ops/gpencil/py.typed +0 -0
  452. bpy/ops/graph/py.typed +0 -0
  453. bpy/ops/grease_pencil/py.typed +0 -0
  454. bpy/ops/image/py.typed +0 -0
  455. bpy/ops/import_anim/py.typed +0 -0
  456. bpy/ops/import_curve/py.typed +0 -0
  457. bpy/ops/import_scene/py.typed +0 -0
  458. bpy/ops/info/py.typed +0 -0
  459. bpy/ops/lattice/py.typed +0 -0
  460. bpy/ops/marker/py.typed +0 -0
  461. bpy/ops/mask/py.typed +0 -0
  462. bpy/ops/material/py.typed +0 -0
  463. bpy/ops/mball/py.typed +0 -0
  464. bpy/ops/mesh/py.typed +0 -0
  465. bpy/ops/nla/py.typed +0 -0
  466. bpy/ops/node/py.typed +0 -0
  467. bpy/ops/object/py.typed +0 -0
  468. bpy/ops/outliner/py.typed +0 -0
  469. bpy/ops/paint/py.typed +0 -0
  470. bpy/ops/paintcurve/py.typed +0 -0
  471. bpy/ops/palette/py.typed +0 -0
  472. bpy/ops/particle/py.typed +0 -0
  473. bpy/ops/pose/py.typed +0 -0
  474. bpy/ops/poselib/py.typed +0 -0
  475. bpy/ops/preferences/py.typed +0 -0
  476. bpy/ops/ptcache/py.typed +0 -0
  477. bpy/ops/py.typed +0 -0
  478. bpy/ops/render/py.typed +0 -0
  479. bpy/ops/rigidbody/py.typed +0 -0
  480. bpy/ops/scene/py.typed +0 -0
  481. bpy/ops/screen/py.typed +0 -0
  482. bpy/ops/script/py.typed +0 -0
  483. bpy/ops/sculpt/py.typed +0 -0
  484. bpy/ops/sculpt_curves/py.typed +0 -0
  485. bpy/ops/sequencer/py.typed +0 -0
  486. bpy/ops/sound/py.typed +0 -0
  487. bpy/ops/spreadsheet/py.typed +0 -0
  488. bpy/ops/surface/py.typed +0 -0
  489. bpy/ops/text/py.typed +0 -0
  490. bpy/ops/text_editor/py.typed +0 -0
  491. bpy/ops/texture/py.typed +0 -0
  492. bpy/ops/transform/py.typed +0 -0
  493. bpy/ops/ui/py.typed +0 -0
  494. bpy/ops/uilist/py.typed +0 -0
  495. bpy/ops/uv/py.typed +0 -0
  496. bpy/ops/view2d/py.typed +0 -0
  497. bpy/ops/view3d/py.typed +0 -0
  498. bpy/ops/wm/py.typed +0 -0
  499. bpy/ops/workspace/py.typed +0 -0
  500. bpy/ops/world/py.typed +0 -0
  501. bpy/path/py.typed +0 -0
  502. bpy/props/py.typed +0 -0
  503. bpy/types/py.typed +0 -0
  504. bpy/utils/previews/py.typed +0 -0
  505. bpy/utils/py.typed +0 -0
  506. bpy/utils/units/py.typed +0 -0
  507. bpy_extras/anim_utils/py.typed +0 -0
  508. bpy_extras/asset_utils/py.typed +0 -0
  509. bpy_extras/bmesh_utils/py.typed +0 -0
  510. bpy_extras/extensions/junction_module/py.typed +0 -0
  511. bpy_extras/extensions/py.typed +0 -0
  512. bpy_extras/id_map_utils/py.typed +0 -0
  513. bpy_extras/image_utils/py.typed +0 -0
  514. bpy_extras/io_utils/py.typed +0 -0
  515. bpy_extras/keyconfig_utils/py.typed +0 -0
  516. bpy_extras/mesh_utils/py.typed +0 -0
  517. bpy_extras/node_shader_utils/py.typed +0 -0
  518. bpy_extras/node_utils/py.typed +0 -0
  519. bpy_extras/object_utils/py.typed +0 -0
  520. bpy_extras/view3d_utils/py.typed +0 -0
  521. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  522. bpy_extras/wm_utils/py.typed +0 -0
  523. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  524. freestyle/chainingiterators/py.typed +0 -0
  525. freestyle/functions/py.typed +0 -0
  526. freestyle/predicates/py.typed +0 -0
  527. freestyle/shaders/py.typed +0 -0
  528. freestyle/types/py.typed +0 -0
  529. freestyle/utils/ContextFunctions/py.typed +0 -0
  530. freestyle/utils/py.typed +0 -0
  531. gpu/capabilities/py.typed +0 -0
  532. gpu/matrix/py.typed +0 -0
  533. gpu/platform/py.typed +0 -0
  534. gpu/select/py.typed +0 -0
  535. gpu/shader/py.typed +0 -0
  536. gpu/state/py.typed +0 -0
  537. gpu/texture/py.typed +0 -0
  538. gpu/types/py.typed +0 -0
  539. gpu_extras/batch/py.typed +0 -0
  540. gpu_extras/presets/py.typed +0 -0
  541. idprop/types/py.typed +0 -0
  542. imbuf/types/py.typed +0 -0
  543. mathutils/bvhtree/py.typed +0 -0
  544. mathutils/geometry/py.typed +0 -0
  545. mathutils/interpolate/py.typed +0 -0
  546. mathutils/kdtree/py.typed +0 -0
  547. mathutils/noise/py.typed +0 -0
  548. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
  549. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
@@ -1,57 +1,52 @@
1
1
  import typing
2
2
  import bl_ui.utils
3
+ import bpy.types
3
4
  import bpy_types
4
5
  import rna_prop_ui
5
6
 
6
7
  GenericType = typing.TypeVar("GenericType")
7
8
 
8
9
  class CAMERA_PT_presets(bpy_types.Panel, bl_ui.utils.PresetPanel, bpy_types._GenericUI):
9
- """ """
10
-
11
10
  COMPAT_ENGINES: typing.Any
12
- """ """
13
-
14
11
  bl_label: typing.Any
15
- """ """
16
-
17
12
  bl_region_type: typing.Any
18
- """ """
19
-
20
13
  bl_rna: typing.Any
21
- """ """
22
-
23
14
  bl_space_type: typing.Any
24
- """ """
25
-
26
15
  id_data: typing.Any
27
- """ """
28
-
29
16
  preset_add_operator: typing.Any
30
- """ """
31
-
32
17
  preset_operator: typing.Any
33
- """ """
34
-
35
18
  preset_subdir: typing.Any
36
- """ """
37
19
 
38
20
  def append(self, draw_func):
39
- """
21
+ """Append a draw function to this menu,
22
+ takes the same arguments as the menus draw function
40
23
 
41
- :param draw_func:
24
+ :param draw_func:
42
25
  """
43
26
  ...
44
27
 
45
- def as_pointer(self):
46
- """ """
28
+ def as_pointer(self) -> int:
29
+ """Returns the memory address which holds a pointer to Blender's internal data
30
+
31
+ :return: int (memory address).
32
+ :rtype: int
33
+ """
47
34
  ...
48
35
 
49
- def bl_rna_get_subclass(self):
50
- """ """
36
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
37
+ """
38
+
39
+ :return: The RNA type or default when not found.
40
+ :rtype: bpy.types.Struct
41
+ """
51
42
  ...
52
43
 
53
- def bl_rna_get_subclass_py(self):
54
- """ """
44
+ def bl_rna_get_subclass_py(self) -> typing.Any:
45
+ """
46
+
47
+ :return: The class or default when not found.
48
+ :rtype: typing.Any
49
+ """
55
50
  ...
56
51
 
57
52
  def draw(self, context):
@@ -61,7 +56,7 @@ class CAMERA_PT_presets(bpy_types.Panel, bl_ui.utils.PresetPanel, bpy_types._Gen
61
56
  """
62
57
  ...
63
58
 
64
- def draw_menu(self, layout, text):
59
+ def draw_menu(self, layout, text=None):
65
60
  """
66
61
 
67
62
  :param layout:
@@ -76,183 +71,255 @@ class CAMERA_PT_presets(bpy_types.Panel, bl_ui.utils.PresetPanel, bpy_types._Gen
76
71
  """
77
72
  ...
78
73
 
79
- def driver_add(self):
80
- """ """
74
+ def driver_add(self) -> bpy.types.FCurve:
75
+ """Adds driver(s) to the given property
76
+
77
+ :return: The driver(s) added.
78
+ :rtype: bpy.types.FCurve
79
+ """
81
80
  ...
82
81
 
83
- def driver_remove(self):
84
- """ """
82
+ def driver_remove(self) -> bool:
83
+ """Remove driver(s) from the given property
84
+
85
+ :return: Success of driver removal.
86
+ :rtype: bool
87
+ """
85
88
  ...
86
89
 
87
90
  def get(self):
88
- """ """
91
+ """Returns the value of the custom property assigned to key or default
92
+ when not found (matches Python's dictionary function of the same name).
93
+
94
+ """
89
95
  ...
90
96
 
91
97
  def id_properties_clear(self):
92
- """ """
98
+ """
99
+
100
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
101
+ """
93
102
  ...
94
103
 
95
104
  def id_properties_ensure(self):
96
- """ """
105
+ """
106
+
107
+ :return: the parent group for an RNA struct's custom IDProperties.
108
+ """
97
109
  ...
98
110
 
99
111
  def id_properties_ui(self):
100
- """ """
101
- ...
112
+ """
102
113
 
103
- def is_extended(self):
104
- """ """
114
+ :return: Return an object used to manage an IDProperty's UI data.
115
+ """
105
116
  ...
106
117
 
107
- def is_property_hidden(self):
108
- """ """
118
+ def is_extended(self): ...
119
+ def is_property_hidden(self) -> bool:
120
+ """Check if a property is hidden.
121
+
122
+ :return: True when the property is hidden.
123
+ :rtype: bool
124
+ """
109
125
  ...
110
126
 
111
- def is_property_overridable_library(self):
112
- """ """
127
+ def is_property_overridable_library(self) -> bool:
128
+ """Check if a property is overridable.
129
+
130
+ :return: True when the property is overridable.
131
+ :rtype: bool
132
+ """
113
133
  ...
114
134
 
115
- def is_property_readonly(self):
116
- """ """
135
+ def is_property_readonly(self) -> bool:
136
+ """Check if a property is readonly.
137
+
138
+ :return: True when the property is readonly (not writable).
139
+ :rtype: bool
140
+ """
117
141
  ...
118
142
 
119
- def is_property_set(self):
120
- """ """
143
+ def is_property_set(self) -> bool:
144
+ """Check if a property is set, use for testing operator properties.
145
+
146
+ :return: True when the property has been set.
147
+ :rtype: bool
148
+ """
121
149
  ...
122
150
 
123
151
  def items(self):
124
- """ """
152
+ """Returns the items of this objects custom properties (matches Python's
153
+ dictionary function of the same name).
154
+
155
+ :return: custom property key, value pairs.
156
+ """
125
157
  ...
126
158
 
127
- def keyframe_delete(self):
128
- """ """
159
+ def keyframe_delete(self) -> bool:
160
+ """Remove a keyframe from this properties fcurve.
161
+
162
+ :return: Success of keyframe deletion.
163
+ :rtype: bool
164
+ """
129
165
  ...
130
166
 
131
- def keyframe_insert(self):
132
- """ """
167
+ def keyframe_insert(self) -> bool:
168
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
169
+
170
+ :return: Success of keyframe insertion.
171
+ :rtype: bool
172
+ """
133
173
  ...
134
174
 
135
175
  def keys(self):
136
- """ """
176
+ """Returns the keys of this objects custom properties (matches Python's
177
+ dictionary function of the same name).
178
+
179
+ :return: custom property keys.
180
+ """
137
181
  ...
138
182
 
139
- def path_from_id(self):
140
- """ """
183
+ def path_from_id(self) -> str:
184
+ """Returns the data path from the ID to this object (string).
185
+
186
+ :return: The path from `bpy.types.bpy_struct.id_data`
187
+ to this struct and property (when given).
188
+ :rtype: str
189
+ """
141
190
  ...
142
191
 
143
192
  def path_menu(
144
193
  self,
145
- searchpaths,
146
- operator,
147
- props_default,
148
- prop_filepath,
149
- filter_ext,
150
- filter_path,
151
- display_name,
152
- add_operator,
153
- add_operator_props,
194
+ searchpaths: list[str],
195
+ operator: str,
196
+ props_default: dict = None,
197
+ prop_filepath: str = "filepath",
198
+ filter_ext: typing.Callable = None,
199
+ filter_path=None,
200
+ display_name: typing.Callable = None,
201
+ add_operator=None,
202
+ add_operator_props=None,
154
203
  ):
155
- """
204
+ """Populate a menu from a list of paths.
205
+
206
+ :param searchpaths: Paths to scan.
207
+ :type searchpaths: list[str]
208
+ :param operator: The operator id to use with each file.
209
+ :type operator: str
210
+ :param props_default: Properties to assign to each operator.
211
+ :type props_default: dict
212
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
213
+ :type prop_filepath: str
214
+ :param filter_ext: Optional callback that takes the file extensions.
156
215
 
157
- :param searchpaths:
158
- :param operator:
159
- :param props_default:
160
- :param prop_filepath:
161
- :param filter_ext:
162
- :param filter_path:
163
- :param display_name:
164
- :param add_operator:
165
- :param add_operator_props:
216
+ Returning false excludes the file from the list.
217
+ :type filter_ext: typing.Callable
218
+ :param filter_path:
219
+ :param display_name: Optional callback that takes the full path, returns the name to display.
220
+ :type display_name: typing.Callable
221
+ :param add_operator:
222
+ :param add_operator_props:
166
223
  """
167
224
  ...
168
225
 
169
226
  def path_resolve(self):
170
- """ """
227
+ """Returns the property from the path, raise an exception when not found."""
171
228
  ...
172
229
 
173
230
  def pop(self):
174
- """ """
231
+ """Remove and return the value of the custom property assigned to key or default
232
+ when not found (matches Python's dictionary function of the same name).
233
+
234
+ """
175
235
  ...
176
236
 
177
237
  def prepend(self, draw_func):
178
- """
238
+ """Prepend a draw function to this menu, takes the same arguments as
239
+ the menus draw function
179
240
 
180
- :param draw_func:
241
+ :param draw_func:
181
242
  """
182
243
  ...
183
244
 
184
- def property_overridable_library_set(self):
185
- """ """
245
+ def property_overridable_library_set(self) -> bool:
246
+ """Define a property as overridable or not (only for custom properties!).
247
+
248
+ :return: True when the overridable status of the property was successfully set.
249
+ :rtype: bool
250
+ """
186
251
  ...
187
252
 
188
253
  def property_unset(self):
189
- """ """
254
+ """Unset a property, will use default value afterward."""
190
255
  ...
191
256
 
192
257
  def remove(self, draw_func):
193
- """
258
+ """Remove a draw function that has been added to this menu
194
259
 
195
260
  :param draw_func:
196
261
  """
197
262
  ...
198
263
 
199
264
  def type_recast(self):
200
- """ """
265
+ """Return a new instance, this is needed because types
266
+ such as textures can be changed at runtime.
267
+
268
+ :return: a new instance of this object with the type initialized again.
269
+ """
201
270
  ...
202
271
 
203
272
  def values(self):
204
- """ """
273
+ """Returns the values of this objects custom properties (matches Python's
274
+ dictionary function of the same name).
275
+
276
+ :return: custom property values.
277
+ """
205
278
  ...
206
279
 
207
280
  class CAMERA_PT_safe_areas_presets(
208
281
  bpy_types.Panel, bl_ui.utils.PresetPanel, bpy_types._GenericUI
209
282
  ):
210
- """ """
211
-
212
283
  COMPAT_ENGINES: typing.Any
213
- """ """
214
-
215
284
  bl_label: typing.Any
216
- """ """
217
-
218
285
  bl_region_type: typing.Any
219
- """ """
220
-
221
286
  bl_rna: typing.Any
222
- """ """
223
-
224
287
  bl_space_type: typing.Any
225
- """ """
226
-
227
288
  id_data: typing.Any
228
- """ """
229
-
230
289
  preset_add_operator: typing.Any
231
- """ """
232
-
233
290
  preset_operator: typing.Any
234
- """ """
235
-
236
291
  preset_subdir: typing.Any
237
- """ """
238
292
 
239
293
  def append(self, draw_func):
240
- """
294
+ """Append a draw function to this menu,
295
+ takes the same arguments as the menus draw function
241
296
 
242
- :param draw_func:
297
+ :param draw_func:
243
298
  """
244
299
  ...
245
300
 
246
- def as_pointer(self):
247
- """ """
301
+ def as_pointer(self) -> int:
302
+ """Returns the memory address which holds a pointer to Blender's internal data
303
+
304
+ :return: int (memory address).
305
+ :rtype: int
306
+ """
248
307
  ...
249
308
 
250
- def bl_rna_get_subclass(self):
251
- """ """
309
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
310
+ """
311
+
312
+ :return: The RNA type or default when not found.
313
+ :rtype: bpy.types.Struct
314
+ """
252
315
  ...
253
316
 
254
- def bl_rna_get_subclass_py(self):
255
- """ """
317
+ def bl_rna_get_subclass_py(self) -> typing.Any:
318
+ """
319
+
320
+ :return: The class or default when not found.
321
+ :rtype: typing.Any
322
+ """
256
323
  ...
257
324
 
258
325
  def draw(self, context):
@@ -262,7 +329,7 @@ class CAMERA_PT_safe_areas_presets(
262
329
  """
263
330
  ...
264
331
 
265
- def draw_menu(self, layout, text):
332
+ def draw_menu(self, layout, text=None):
266
333
  """
267
334
 
268
335
  :param layout:
@@ -277,145 +344,216 @@ class CAMERA_PT_safe_areas_presets(
277
344
  """
278
345
  ...
279
346
 
280
- def driver_add(self):
281
- """ """
347
+ def driver_add(self) -> bpy.types.FCurve:
348
+ """Adds driver(s) to the given property
349
+
350
+ :return: The driver(s) added.
351
+ :rtype: bpy.types.FCurve
352
+ """
282
353
  ...
283
354
 
284
- def driver_remove(self):
285
- """ """
355
+ def driver_remove(self) -> bool:
356
+ """Remove driver(s) from the given property
357
+
358
+ :return: Success of driver removal.
359
+ :rtype: bool
360
+ """
286
361
  ...
287
362
 
288
363
  def get(self):
289
- """ """
364
+ """Returns the value of the custom property assigned to key or default
365
+ when not found (matches Python's dictionary function of the same name).
366
+
367
+ """
290
368
  ...
291
369
 
292
370
  def id_properties_clear(self):
293
- """ """
371
+ """
372
+
373
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
374
+ """
294
375
  ...
295
376
 
296
377
  def id_properties_ensure(self):
297
- """ """
378
+ """
379
+
380
+ :return: the parent group for an RNA struct's custom IDProperties.
381
+ """
298
382
  ...
299
383
 
300
384
  def id_properties_ui(self):
301
- """ """
302
- ...
385
+ """
303
386
 
304
- def is_extended(self):
305
- """ """
387
+ :return: Return an object used to manage an IDProperty's UI data.
388
+ """
306
389
  ...
307
390
 
308
- def is_property_hidden(self):
309
- """ """
391
+ def is_extended(self): ...
392
+ def is_property_hidden(self) -> bool:
393
+ """Check if a property is hidden.
394
+
395
+ :return: True when the property is hidden.
396
+ :rtype: bool
397
+ """
310
398
  ...
311
399
 
312
- def is_property_overridable_library(self):
313
- """ """
400
+ def is_property_overridable_library(self) -> bool:
401
+ """Check if a property is overridable.
402
+
403
+ :return: True when the property is overridable.
404
+ :rtype: bool
405
+ """
314
406
  ...
315
407
 
316
- def is_property_readonly(self):
317
- """ """
408
+ def is_property_readonly(self) -> bool:
409
+ """Check if a property is readonly.
410
+
411
+ :return: True when the property is readonly (not writable).
412
+ :rtype: bool
413
+ """
318
414
  ...
319
415
 
320
- def is_property_set(self):
321
- """ """
416
+ def is_property_set(self) -> bool:
417
+ """Check if a property is set, use for testing operator properties.
418
+
419
+ :return: True when the property has been set.
420
+ :rtype: bool
421
+ """
322
422
  ...
323
423
 
324
424
  def items(self):
325
- """ """
425
+ """Returns the items of this objects custom properties (matches Python's
426
+ dictionary function of the same name).
427
+
428
+ :return: custom property key, value pairs.
429
+ """
326
430
  ...
327
431
 
328
- def keyframe_delete(self):
329
- """ """
432
+ def keyframe_delete(self) -> bool:
433
+ """Remove a keyframe from this properties fcurve.
434
+
435
+ :return: Success of keyframe deletion.
436
+ :rtype: bool
437
+ """
330
438
  ...
331
439
 
332
- def keyframe_insert(self):
333
- """ """
440
+ def keyframe_insert(self) -> bool:
441
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
442
+
443
+ :return: Success of keyframe insertion.
444
+ :rtype: bool
445
+ """
334
446
  ...
335
447
 
336
448
  def keys(self):
337
- """ """
449
+ """Returns the keys of this objects custom properties (matches Python's
450
+ dictionary function of the same name).
451
+
452
+ :return: custom property keys.
453
+ """
338
454
  ...
339
455
 
340
- def path_from_id(self):
341
- """ """
456
+ def path_from_id(self) -> str:
457
+ """Returns the data path from the ID to this object (string).
458
+
459
+ :return: The path from `bpy.types.bpy_struct.id_data`
460
+ to this struct and property (when given).
461
+ :rtype: str
462
+ """
342
463
  ...
343
464
 
344
465
  def path_menu(
345
466
  self,
346
- searchpaths,
347
- operator,
348
- props_default,
349
- prop_filepath,
350
- filter_ext,
351
- filter_path,
352
- display_name,
353
- add_operator,
354
- add_operator_props,
467
+ searchpaths: list[str],
468
+ operator: str,
469
+ props_default: dict = None,
470
+ prop_filepath: str = "filepath",
471
+ filter_ext: typing.Callable = None,
472
+ filter_path=None,
473
+ display_name: typing.Callable = None,
474
+ add_operator=None,
475
+ add_operator_props=None,
355
476
  ):
356
- """
477
+ """Populate a menu from a list of paths.
357
478
 
358
- :param searchpaths:
359
- :param operator:
360
- :param props_default:
361
- :param prop_filepath:
362
- :param filter_ext:
363
- :param filter_path:
364
- :param display_name:
365
- :param add_operator:
366
- :param add_operator_props:
479
+ :param searchpaths: Paths to scan.
480
+ :type searchpaths: list[str]
481
+ :param operator: The operator id to use with each file.
482
+ :type operator: str
483
+ :param props_default: Properties to assign to each operator.
484
+ :type props_default: dict
485
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
486
+ :type prop_filepath: str
487
+ :param filter_ext: Optional callback that takes the file extensions.
488
+
489
+ Returning false excludes the file from the list.
490
+ :type filter_ext: typing.Callable
491
+ :param filter_path:
492
+ :param display_name: Optional callback that takes the full path, returns the name to display.
493
+ :type display_name: typing.Callable
494
+ :param add_operator:
495
+ :param add_operator_props:
367
496
  """
368
497
  ...
369
498
 
370
499
  def path_resolve(self):
371
- """ """
500
+ """Returns the property from the path, raise an exception when not found."""
372
501
  ...
373
502
 
374
503
  def pop(self):
375
- """ """
504
+ """Remove and return the value of the custom property assigned to key or default
505
+ when not found (matches Python's dictionary function of the same name).
506
+
507
+ """
376
508
  ...
377
509
 
378
510
  def prepend(self, draw_func):
379
- """
511
+ """Prepend a draw function to this menu, takes the same arguments as
512
+ the menus draw function
380
513
 
381
- :param draw_func:
514
+ :param draw_func:
382
515
  """
383
516
  ...
384
517
 
385
- def property_overridable_library_set(self):
386
- """ """
518
+ def property_overridable_library_set(self) -> bool:
519
+ """Define a property as overridable or not (only for custom properties!).
520
+
521
+ :return: True when the overridable status of the property was successfully set.
522
+ :rtype: bool
523
+ """
387
524
  ...
388
525
 
389
526
  def property_unset(self):
390
- """ """
527
+ """Unset a property, will use default value afterward."""
391
528
  ...
392
529
 
393
530
  def remove(self, draw_func):
394
- """
531
+ """Remove a draw function that has been added to this menu
395
532
 
396
533
  :param draw_func:
397
534
  """
398
535
  ...
399
536
 
400
537
  def type_recast(self):
401
- """ """
538
+ """Return a new instance, this is needed because types
539
+ such as textures can be changed at runtime.
540
+
541
+ :return: a new instance of this object with the type initialized again.
542
+ """
402
543
  ...
403
544
 
404
545
  def values(self):
405
- """ """
546
+ """Returns the values of this objects custom properties (matches Python's
547
+ dictionary function of the same name).
548
+
549
+ :return: custom property values.
550
+ """
406
551
  ...
407
552
 
408
553
  class CameraButtonsPanel:
409
- """ """
410
-
411
554
  bl_context: typing.Any
412
- """ """
413
-
414
555
  bl_region_type: typing.Any
415
- """ """
416
-
417
556
  bl_space_type: typing.Any
418
- """ """
419
557
 
420
558
  def poll(self, context):
421
559
  """
@@ -425,49 +563,45 @@ class CameraButtonsPanel:
425
563
  ...
426
564
 
427
565
  class DATA_PT_camera(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
428
- """ """
429
-
430
566
  COMPAT_ENGINES: typing.Any
431
- """ """
432
-
433
567
  bl_context: typing.Any
434
- """ """
435
-
436
568
  bl_label: typing.Any
437
- """ """
438
-
439
569
  bl_options: typing.Any
440
- """ """
441
-
442
570
  bl_region_type: typing.Any
443
- """ """
444
-
445
571
  bl_rna: typing.Any
446
- """ """
447
-
448
572
  bl_space_type: typing.Any
449
- """ """
450
-
451
573
  id_data: typing.Any
452
- """ """
453
574
 
454
575
  def append(self, draw_func):
455
- """
576
+ """Append a draw function to this menu,
577
+ takes the same arguments as the menus draw function
456
578
 
457
- :param draw_func:
579
+ :param draw_func:
458
580
  """
459
581
  ...
460
582
 
461
- def as_pointer(self):
462
- """ """
583
+ def as_pointer(self) -> int:
584
+ """Returns the memory address which holds a pointer to Blender's internal data
585
+
586
+ :return: int (memory address).
587
+ :rtype: int
588
+ """
463
589
  ...
464
590
 
465
- def bl_rna_get_subclass(self):
466
- """ """
591
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
592
+ """
593
+
594
+ :return: The RNA type or default when not found.
595
+ :rtype: bpy.types.Struct
596
+ """
467
597
  ...
468
598
 
469
- def bl_rna_get_subclass_py(self):
470
- """ """
599
+ def bl_rna_get_subclass_py(self) -> typing.Any:
600
+ """
601
+
602
+ :return: The class or default when not found.
603
+ :rtype: typing.Any
604
+ """
471
605
  ...
472
606
 
473
607
  def draw(self, context):
@@ -484,72 +618,126 @@ class DATA_PT_camera(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
484
618
  """
485
619
  ...
486
620
 
487
- def driver_add(self):
488
- """ """
621
+ def driver_add(self) -> bpy.types.FCurve:
622
+ """Adds driver(s) to the given property
623
+
624
+ :return: The driver(s) added.
625
+ :rtype: bpy.types.FCurve
626
+ """
489
627
  ...
490
628
 
491
- def driver_remove(self):
492
- """ """
629
+ def driver_remove(self) -> bool:
630
+ """Remove driver(s) from the given property
631
+
632
+ :return: Success of driver removal.
633
+ :rtype: bool
634
+ """
493
635
  ...
494
636
 
495
637
  def get(self):
496
- """ """
638
+ """Returns the value of the custom property assigned to key or default
639
+ when not found (matches Python's dictionary function of the same name).
640
+
641
+ """
497
642
  ...
498
643
 
499
644
  def id_properties_clear(self):
500
- """ """
645
+ """
646
+
647
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
648
+ """
501
649
  ...
502
650
 
503
651
  def id_properties_ensure(self):
504
- """ """
652
+ """
653
+
654
+ :return: the parent group for an RNA struct's custom IDProperties.
655
+ """
505
656
  ...
506
657
 
507
658
  def id_properties_ui(self):
508
- """ """
509
- ...
659
+ """
510
660
 
511
- def is_extended(self):
512
- """ """
661
+ :return: Return an object used to manage an IDProperty's UI data.
662
+ """
513
663
  ...
514
664
 
515
- def is_property_hidden(self):
516
- """ """
665
+ def is_extended(self): ...
666
+ def is_property_hidden(self) -> bool:
667
+ """Check if a property is hidden.
668
+
669
+ :return: True when the property is hidden.
670
+ :rtype: bool
671
+ """
517
672
  ...
518
673
 
519
- def is_property_overridable_library(self):
520
- """ """
674
+ def is_property_overridable_library(self) -> bool:
675
+ """Check if a property is overridable.
676
+
677
+ :return: True when the property is overridable.
678
+ :rtype: bool
679
+ """
521
680
  ...
522
681
 
523
- def is_property_readonly(self):
524
- """ """
682
+ def is_property_readonly(self) -> bool:
683
+ """Check if a property is readonly.
684
+
685
+ :return: True when the property is readonly (not writable).
686
+ :rtype: bool
687
+ """
525
688
  ...
526
689
 
527
- def is_property_set(self):
528
- """ """
690
+ def is_property_set(self) -> bool:
691
+ """Check if a property is set, use for testing operator properties.
692
+
693
+ :return: True when the property has been set.
694
+ :rtype: bool
695
+ """
529
696
  ...
530
697
 
531
698
  def items(self):
532
- """ """
699
+ """Returns the items of this objects custom properties (matches Python's
700
+ dictionary function of the same name).
701
+
702
+ :return: custom property key, value pairs.
703
+ """
533
704
  ...
534
705
 
535
- def keyframe_delete(self):
536
- """ """
706
+ def keyframe_delete(self) -> bool:
707
+ """Remove a keyframe from this properties fcurve.
708
+
709
+ :return: Success of keyframe deletion.
710
+ :rtype: bool
711
+ """
537
712
  ...
538
713
 
539
- def keyframe_insert(self):
540
- """ """
714
+ def keyframe_insert(self) -> bool:
715
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
716
+
717
+ :return: Success of keyframe insertion.
718
+ :rtype: bool
719
+ """
541
720
  ...
542
721
 
543
722
  def keys(self):
544
- """ """
723
+ """Returns the keys of this objects custom properties (matches Python's
724
+ dictionary function of the same name).
725
+
726
+ :return: custom property keys.
727
+ """
545
728
  ...
546
729
 
547
- def path_from_id(self):
548
- """ """
730
+ def path_from_id(self) -> str:
731
+ """Returns the data path from the ID to this object (string).
732
+
733
+ :return: The path from `bpy.types.bpy_struct.id_data`
734
+ to this struct and property (when given).
735
+ :rtype: str
736
+ """
549
737
  ...
550
738
 
551
739
  def path_resolve(self):
552
- """ """
740
+ """Returns the property from the path, raise an exception when not found."""
553
741
  ...
554
742
 
555
743
  def poll(self, context):
@@ -560,85 +748,97 @@ class DATA_PT_camera(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
560
748
  ...
561
749
 
562
750
  def pop(self):
563
- """ """
751
+ """Remove and return the value of the custom property assigned to key or default
752
+ when not found (matches Python's dictionary function of the same name).
753
+
754
+ """
564
755
  ...
565
756
 
566
757
  def prepend(self, draw_func):
567
- """
758
+ """Prepend a draw function to this menu, takes the same arguments as
759
+ the menus draw function
568
760
 
569
- :param draw_func:
761
+ :param draw_func:
570
762
  """
571
763
  ...
572
764
 
573
- def property_overridable_library_set(self):
574
- """ """
765
+ def property_overridable_library_set(self) -> bool:
766
+ """Define a property as overridable or not (only for custom properties!).
767
+
768
+ :return: True when the overridable status of the property was successfully set.
769
+ :rtype: bool
770
+ """
575
771
  ...
576
772
 
577
773
  def property_unset(self):
578
- """ """
774
+ """Unset a property, will use default value afterward."""
579
775
  ...
580
776
 
581
777
  def remove(self, draw_func):
582
- """
778
+ """Remove a draw function that has been added to this menu
583
779
 
584
780
  :param draw_func:
585
781
  """
586
782
  ...
587
783
 
588
784
  def type_recast(self):
589
- """ """
785
+ """Return a new instance, this is needed because types
786
+ such as textures can be changed at runtime.
787
+
788
+ :return: a new instance of this object with the type initialized again.
789
+ """
590
790
  ...
591
791
 
592
792
  def values(self):
593
- """ """
793
+ """Returns the values of this objects custom properties (matches Python's
794
+ dictionary function of the same name).
795
+
796
+ :return: custom property values.
797
+ """
594
798
  ...
595
799
 
596
800
  class DATA_PT_camera_background_image(
597
801
  bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI
598
802
  ):
599
- """ """
600
-
601
803
  COMPAT_ENGINES: typing.Any
602
- """ """
603
-
604
804
  bl_context: typing.Any
605
- """ """
606
-
607
805
  bl_label: typing.Any
608
- """ """
609
-
610
806
  bl_options: typing.Any
611
- """ """
612
-
613
807
  bl_region_type: typing.Any
614
- """ """
615
-
616
808
  bl_rna: typing.Any
617
- """ """
618
-
619
809
  bl_space_type: typing.Any
620
- """ """
621
-
622
810
  id_data: typing.Any
623
- """ """
624
811
 
625
812
  def append(self, draw_func):
626
- """
813
+ """Append a draw function to this menu,
814
+ takes the same arguments as the menus draw function
627
815
 
628
- :param draw_func:
816
+ :param draw_func:
629
817
  """
630
818
  ...
631
819
 
632
- def as_pointer(self):
633
- """ """
820
+ def as_pointer(self) -> int:
821
+ """Returns the memory address which holds a pointer to Blender's internal data
822
+
823
+ :return: int (memory address).
824
+ :rtype: int
825
+ """
634
826
  ...
635
827
 
636
- def bl_rna_get_subclass(self):
637
- """ """
828
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
829
+ """
830
+
831
+ :return: The RNA type or default when not found.
832
+ :rtype: bpy.types.Struct
833
+ """
638
834
  ...
639
835
 
640
- def bl_rna_get_subclass_py(self):
641
- """ """
836
+ def bl_rna_get_subclass_py(self) -> typing.Any:
837
+ """
838
+
839
+ :return: The class or default when not found.
840
+ :rtype: typing.Any
841
+ """
642
842
  ...
643
843
 
644
844
  def draw(self, context):
@@ -655,72 +855,126 @@ class DATA_PT_camera_background_image(
655
855
  """
656
856
  ...
657
857
 
658
- def driver_add(self):
659
- """ """
858
+ def driver_add(self) -> bpy.types.FCurve:
859
+ """Adds driver(s) to the given property
860
+
861
+ :return: The driver(s) added.
862
+ :rtype: bpy.types.FCurve
863
+ """
660
864
  ...
661
865
 
662
- def driver_remove(self):
663
- """ """
866
+ def driver_remove(self) -> bool:
867
+ """Remove driver(s) from the given property
868
+
869
+ :return: Success of driver removal.
870
+ :rtype: bool
871
+ """
664
872
  ...
665
873
 
666
874
  def get(self):
667
- """ """
875
+ """Returns the value of the custom property assigned to key or default
876
+ when not found (matches Python's dictionary function of the same name).
877
+
878
+ """
668
879
  ...
669
880
 
670
881
  def id_properties_clear(self):
671
- """ """
882
+ """
883
+
884
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
885
+ """
672
886
  ...
673
887
 
674
888
  def id_properties_ensure(self):
675
- """ """
889
+ """
890
+
891
+ :return: the parent group for an RNA struct's custom IDProperties.
892
+ """
676
893
  ...
677
894
 
678
895
  def id_properties_ui(self):
679
- """ """
680
- ...
896
+ """
681
897
 
682
- def is_extended(self):
683
- """ """
898
+ :return: Return an object used to manage an IDProperty's UI data.
899
+ """
684
900
  ...
685
901
 
686
- def is_property_hidden(self):
687
- """ """
902
+ def is_extended(self): ...
903
+ def is_property_hidden(self) -> bool:
904
+ """Check if a property is hidden.
905
+
906
+ :return: True when the property is hidden.
907
+ :rtype: bool
908
+ """
688
909
  ...
689
910
 
690
- def is_property_overridable_library(self):
691
- """ """
911
+ def is_property_overridable_library(self) -> bool:
912
+ """Check if a property is overridable.
913
+
914
+ :return: True when the property is overridable.
915
+ :rtype: bool
916
+ """
692
917
  ...
693
918
 
694
- def is_property_readonly(self):
695
- """ """
919
+ def is_property_readonly(self) -> bool:
920
+ """Check if a property is readonly.
921
+
922
+ :return: True when the property is readonly (not writable).
923
+ :rtype: bool
924
+ """
696
925
  ...
697
926
 
698
- def is_property_set(self):
699
- """ """
927
+ def is_property_set(self) -> bool:
928
+ """Check if a property is set, use for testing operator properties.
929
+
930
+ :return: True when the property has been set.
931
+ :rtype: bool
932
+ """
700
933
  ...
701
934
 
702
935
  def items(self):
703
- """ """
936
+ """Returns the items of this objects custom properties (matches Python's
937
+ dictionary function of the same name).
938
+
939
+ :return: custom property key, value pairs.
940
+ """
704
941
  ...
705
942
 
706
- def keyframe_delete(self):
707
- """ """
943
+ def keyframe_delete(self) -> bool:
944
+ """Remove a keyframe from this properties fcurve.
945
+
946
+ :return: Success of keyframe deletion.
947
+ :rtype: bool
948
+ """
708
949
  ...
709
950
 
710
- def keyframe_insert(self):
711
- """ """
951
+ def keyframe_insert(self) -> bool:
952
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
953
+
954
+ :return: Success of keyframe insertion.
955
+ :rtype: bool
956
+ """
712
957
  ...
713
958
 
714
959
  def keys(self):
715
- """ """
960
+ """Returns the keys of this objects custom properties (matches Python's
961
+ dictionary function of the same name).
962
+
963
+ :return: custom property keys.
964
+ """
716
965
  ...
717
966
 
718
- def path_from_id(self):
719
- """ """
967
+ def path_from_id(self) -> str:
968
+ """Returns the data path from the ID to this object (string).
969
+
970
+ :return: The path from `bpy.types.bpy_struct.id_data`
971
+ to this struct and property (when given).
972
+ :rtype: str
973
+ """
720
974
  ...
721
975
 
722
976
  def path_resolve(self):
723
- """ """
977
+ """Returns the property from the path, raise an exception when not found."""
724
978
  ...
725
979
 
726
980
  def poll(self, context):
@@ -731,83 +985,95 @@ class DATA_PT_camera_background_image(
731
985
  ...
732
986
 
733
987
  def pop(self):
734
- """ """
988
+ """Remove and return the value of the custom property assigned to key or default
989
+ when not found (matches Python's dictionary function of the same name).
990
+
991
+ """
735
992
  ...
736
993
 
737
994
  def prepend(self, draw_func):
738
- """
995
+ """Prepend a draw function to this menu, takes the same arguments as
996
+ the menus draw function
739
997
 
740
- :param draw_func:
998
+ :param draw_func:
741
999
  """
742
1000
  ...
743
1001
 
744
- def property_overridable_library_set(self):
745
- """ """
1002
+ def property_overridable_library_set(self) -> bool:
1003
+ """Define a property as overridable or not (only for custom properties!).
1004
+
1005
+ :return: True when the overridable status of the property was successfully set.
1006
+ :rtype: bool
1007
+ """
746
1008
  ...
747
1009
 
748
1010
  def property_unset(self):
749
- """ """
1011
+ """Unset a property, will use default value afterward."""
750
1012
  ...
751
1013
 
752
1014
  def remove(self, draw_func):
753
- """
1015
+ """Remove a draw function that has been added to this menu
754
1016
 
755
1017
  :param draw_func:
756
1018
  """
757
1019
  ...
758
1020
 
759
1021
  def type_recast(self):
760
- """ """
1022
+ """Return a new instance, this is needed because types
1023
+ such as textures can be changed at runtime.
1024
+
1025
+ :return: a new instance of this object with the type initialized again.
1026
+ """
761
1027
  ...
762
1028
 
763
1029
  def values(self):
764
- """ """
765
- ...
1030
+ """Returns the values of this objects custom properties (matches Python's
1031
+ dictionary function of the same name).
766
1032
 
767
- class DATA_PT_camera_display(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
768
- """ """
1033
+ :return: custom property values.
1034
+ """
1035
+ ...
769
1036
 
1037
+ class DATA_PT_camera_display(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
770
1038
  COMPAT_ENGINES: typing.Any
771
- """ """
772
-
773
1039
  bl_context: typing.Any
774
- """ """
775
-
776
1040
  bl_label: typing.Any
777
- """ """
778
-
779
1041
  bl_options: typing.Any
780
- """ """
781
-
782
1042
  bl_region_type: typing.Any
783
- """ """
784
-
785
1043
  bl_rna: typing.Any
786
- """ """
787
-
788
1044
  bl_space_type: typing.Any
789
- """ """
790
-
791
1045
  id_data: typing.Any
792
- """ """
793
1046
 
794
1047
  def append(self, draw_func):
795
- """
1048
+ """Append a draw function to this menu,
1049
+ takes the same arguments as the menus draw function
796
1050
 
797
- :param draw_func:
1051
+ :param draw_func:
798
1052
  """
799
1053
  ...
800
1054
 
801
- def as_pointer(self):
802
- """ """
1055
+ def as_pointer(self) -> int:
1056
+ """Returns the memory address which holds a pointer to Blender's internal data
1057
+
1058
+ :return: int (memory address).
1059
+ :rtype: int
1060
+ """
803
1061
  ...
804
1062
 
805
- def bl_rna_get_subclass(self):
806
- """ """
1063
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1064
+ """
1065
+
1066
+ :return: The RNA type or default when not found.
1067
+ :rtype: bpy.types.Struct
1068
+ """
807
1069
  ...
808
1070
 
809
- def bl_rna_get_subclass_py(self):
810
- """ """
1071
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1072
+ """
1073
+
1074
+ :return: The class or default when not found.
1075
+ :rtype: typing.Any
1076
+ """
811
1077
  ...
812
1078
 
813
1079
  def draw(self, context):
@@ -817,72 +1083,126 @@ class DATA_PT_camera_display(bpy_types.Panel, CameraButtonsPanel, bpy_types._Gen
817
1083
  """
818
1084
  ...
819
1085
 
820
- def driver_add(self):
821
- """ """
1086
+ def driver_add(self) -> bpy.types.FCurve:
1087
+ """Adds driver(s) to the given property
1088
+
1089
+ :return: The driver(s) added.
1090
+ :rtype: bpy.types.FCurve
1091
+ """
822
1092
  ...
823
1093
 
824
- def driver_remove(self):
825
- """ """
1094
+ def driver_remove(self) -> bool:
1095
+ """Remove driver(s) from the given property
1096
+
1097
+ :return: Success of driver removal.
1098
+ :rtype: bool
1099
+ """
826
1100
  ...
827
1101
 
828
1102
  def get(self):
829
- """ """
1103
+ """Returns the value of the custom property assigned to key or default
1104
+ when not found (matches Python's dictionary function of the same name).
1105
+
1106
+ """
830
1107
  ...
831
1108
 
832
1109
  def id_properties_clear(self):
833
- """ """
1110
+ """
1111
+
1112
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1113
+ """
834
1114
  ...
835
1115
 
836
1116
  def id_properties_ensure(self):
837
- """ """
1117
+ """
1118
+
1119
+ :return: the parent group for an RNA struct's custom IDProperties.
1120
+ """
838
1121
  ...
839
1122
 
840
1123
  def id_properties_ui(self):
841
- """ """
842
- ...
1124
+ """
843
1125
 
844
- def is_extended(self):
845
- """ """
1126
+ :return: Return an object used to manage an IDProperty's UI data.
1127
+ """
846
1128
  ...
847
1129
 
848
- def is_property_hidden(self):
849
- """ """
1130
+ def is_extended(self): ...
1131
+ def is_property_hidden(self) -> bool:
1132
+ """Check if a property is hidden.
1133
+
1134
+ :return: True when the property is hidden.
1135
+ :rtype: bool
1136
+ """
850
1137
  ...
851
1138
 
852
- def is_property_overridable_library(self):
853
- """ """
1139
+ def is_property_overridable_library(self) -> bool:
1140
+ """Check if a property is overridable.
1141
+
1142
+ :return: True when the property is overridable.
1143
+ :rtype: bool
1144
+ """
854
1145
  ...
855
1146
 
856
- def is_property_readonly(self):
857
- """ """
1147
+ def is_property_readonly(self) -> bool:
1148
+ """Check if a property is readonly.
1149
+
1150
+ :return: True when the property is readonly (not writable).
1151
+ :rtype: bool
1152
+ """
858
1153
  ...
859
1154
 
860
- def is_property_set(self):
861
- """ """
1155
+ def is_property_set(self) -> bool:
1156
+ """Check if a property is set, use for testing operator properties.
1157
+
1158
+ :return: True when the property has been set.
1159
+ :rtype: bool
1160
+ """
862
1161
  ...
863
1162
 
864
1163
  def items(self):
865
- """ """
1164
+ """Returns the items of this objects custom properties (matches Python's
1165
+ dictionary function of the same name).
1166
+
1167
+ :return: custom property key, value pairs.
1168
+ """
866
1169
  ...
867
1170
 
868
- def keyframe_delete(self):
869
- """ """
1171
+ def keyframe_delete(self) -> bool:
1172
+ """Remove a keyframe from this properties fcurve.
1173
+
1174
+ :return: Success of keyframe deletion.
1175
+ :rtype: bool
1176
+ """
870
1177
  ...
871
1178
 
872
- def keyframe_insert(self):
873
- """ """
1179
+ def keyframe_insert(self) -> bool:
1180
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1181
+
1182
+ :return: Success of keyframe insertion.
1183
+ :rtype: bool
1184
+ """
874
1185
  ...
875
1186
 
876
1187
  def keys(self):
877
- """ """
1188
+ """Returns the keys of this objects custom properties (matches Python's
1189
+ dictionary function of the same name).
1190
+
1191
+ :return: custom property keys.
1192
+ """
878
1193
  ...
879
1194
 
880
- def path_from_id(self):
881
- """ """
1195
+ def path_from_id(self) -> str:
1196
+ """Returns the data path from the ID to this object (string).
1197
+
1198
+ :return: The path from `bpy.types.bpy_struct.id_data`
1199
+ to this struct and property (when given).
1200
+ :rtype: str
1201
+ """
882
1202
  ...
883
1203
 
884
1204
  def path_resolve(self):
885
- """ """
1205
+ """Returns the property from the path, raise an exception when not found."""
886
1206
  ...
887
1207
 
888
1208
  def poll(self, context):
@@ -893,88 +1213,98 @@ class DATA_PT_camera_display(bpy_types.Panel, CameraButtonsPanel, bpy_types._Gen
893
1213
  ...
894
1214
 
895
1215
  def pop(self):
896
- """ """
1216
+ """Remove and return the value of the custom property assigned to key or default
1217
+ when not found (matches Python's dictionary function of the same name).
1218
+
1219
+ """
897
1220
  ...
898
1221
 
899
1222
  def prepend(self, draw_func):
900
- """
1223
+ """Prepend a draw function to this menu, takes the same arguments as
1224
+ the menus draw function
901
1225
 
902
- :param draw_func:
1226
+ :param draw_func:
903
1227
  """
904
1228
  ...
905
1229
 
906
- def property_overridable_library_set(self):
907
- """ """
1230
+ def property_overridable_library_set(self) -> bool:
1231
+ """Define a property as overridable or not (only for custom properties!).
1232
+
1233
+ :return: True when the overridable status of the property was successfully set.
1234
+ :rtype: bool
1235
+ """
908
1236
  ...
909
1237
 
910
1238
  def property_unset(self):
911
- """ """
1239
+ """Unset a property, will use default value afterward."""
912
1240
  ...
913
1241
 
914
1242
  def remove(self, draw_func):
915
- """
1243
+ """Remove a draw function that has been added to this menu
916
1244
 
917
1245
  :param draw_func:
918
1246
  """
919
1247
  ...
920
1248
 
921
1249
  def type_recast(self):
922
- """ """
1250
+ """Return a new instance, this is needed because types
1251
+ such as textures can be changed at runtime.
1252
+
1253
+ :return: a new instance of this object with the type initialized again.
1254
+ """
923
1255
  ...
924
1256
 
925
1257
  def values(self):
926
- """ """
1258
+ """Returns the values of this objects custom properties (matches Python's
1259
+ dictionary function of the same name).
1260
+
1261
+ :return: custom property values.
1262
+ """
927
1263
  ...
928
1264
 
929
1265
  class DATA_PT_camera_display_composition_guides(
930
1266
  bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI
931
1267
  ):
932
- """ """
933
-
934
1268
  COMPAT_ENGINES: typing.Any
935
- """ """
936
-
937
1269
  bl_context: typing.Any
938
- """ """
939
-
940
1270
  bl_label: typing.Any
941
- """ """
942
-
943
1271
  bl_options: typing.Any
944
- """ """
945
-
946
1272
  bl_parent_id: typing.Any
947
- """ """
948
-
949
1273
  bl_region_type: typing.Any
950
- """ """
951
-
952
1274
  bl_rna: typing.Any
953
- """ """
954
-
955
1275
  bl_space_type: typing.Any
956
- """ """
957
-
958
1276
  id_data: typing.Any
959
- """ """
960
1277
 
961
1278
  def append(self, draw_func):
962
- """
1279
+ """Append a draw function to this menu,
1280
+ takes the same arguments as the menus draw function
963
1281
 
964
- :param draw_func:
1282
+ :param draw_func:
965
1283
  """
966
1284
  ...
967
1285
 
968
- def as_pointer(self):
969
- """ """
1286
+ def as_pointer(self) -> int:
1287
+ """Returns the memory address which holds a pointer to Blender's internal data
1288
+
1289
+ :return: int (memory address).
1290
+ :rtype: int
1291
+ """
970
1292
  ...
971
1293
 
972
- def bl_rna_get_subclass(self):
973
- """ """
1294
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1295
+ """
1296
+
1297
+ :return: The RNA type or default when not found.
1298
+ :rtype: bpy.types.Struct
1299
+ """
974
1300
  ...
975
1301
 
976
- def bl_rna_get_subclass_py(self):
977
- """ """
1302
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1303
+ """
1304
+
1305
+ :return: The class or default when not found.
1306
+ :rtype: typing.Any
1307
+ """
978
1308
  ...
979
1309
 
980
1310
  def draw(self, context):
@@ -984,72 +1314,126 @@ class DATA_PT_camera_display_composition_guides(
984
1314
  """
985
1315
  ...
986
1316
 
987
- def driver_add(self):
988
- """ """
1317
+ def driver_add(self) -> bpy.types.FCurve:
1318
+ """Adds driver(s) to the given property
1319
+
1320
+ :return: The driver(s) added.
1321
+ :rtype: bpy.types.FCurve
1322
+ """
989
1323
  ...
990
1324
 
991
- def driver_remove(self):
992
- """ """
1325
+ def driver_remove(self) -> bool:
1326
+ """Remove driver(s) from the given property
1327
+
1328
+ :return: Success of driver removal.
1329
+ :rtype: bool
1330
+ """
993
1331
  ...
994
1332
 
995
1333
  def get(self):
996
- """ """
1334
+ """Returns the value of the custom property assigned to key or default
1335
+ when not found (matches Python's dictionary function of the same name).
1336
+
1337
+ """
997
1338
  ...
998
1339
 
999
1340
  def id_properties_clear(self):
1000
- """ """
1341
+ """
1342
+
1343
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1344
+ """
1001
1345
  ...
1002
1346
 
1003
1347
  def id_properties_ensure(self):
1004
- """ """
1348
+ """
1349
+
1350
+ :return: the parent group for an RNA struct's custom IDProperties.
1351
+ """
1005
1352
  ...
1006
1353
 
1007
1354
  def id_properties_ui(self):
1008
- """ """
1009
- ...
1355
+ """
1010
1356
 
1011
- def is_extended(self):
1012
- """ """
1357
+ :return: Return an object used to manage an IDProperty's UI data.
1358
+ """
1013
1359
  ...
1014
1360
 
1015
- def is_property_hidden(self):
1016
- """ """
1361
+ def is_extended(self): ...
1362
+ def is_property_hidden(self) -> bool:
1363
+ """Check if a property is hidden.
1364
+
1365
+ :return: True when the property is hidden.
1366
+ :rtype: bool
1367
+ """
1017
1368
  ...
1018
1369
 
1019
- def is_property_overridable_library(self):
1020
- """ """
1370
+ def is_property_overridable_library(self) -> bool:
1371
+ """Check if a property is overridable.
1372
+
1373
+ :return: True when the property is overridable.
1374
+ :rtype: bool
1375
+ """
1021
1376
  ...
1022
1377
 
1023
- def is_property_readonly(self):
1024
- """ """
1378
+ def is_property_readonly(self) -> bool:
1379
+ """Check if a property is readonly.
1380
+
1381
+ :return: True when the property is readonly (not writable).
1382
+ :rtype: bool
1383
+ """
1025
1384
  ...
1026
1385
 
1027
- def is_property_set(self):
1028
- """ """
1386
+ def is_property_set(self) -> bool:
1387
+ """Check if a property is set, use for testing operator properties.
1388
+
1389
+ :return: True when the property has been set.
1390
+ :rtype: bool
1391
+ """
1029
1392
  ...
1030
1393
 
1031
1394
  def items(self):
1032
- """ """
1395
+ """Returns the items of this objects custom properties (matches Python's
1396
+ dictionary function of the same name).
1397
+
1398
+ :return: custom property key, value pairs.
1399
+ """
1033
1400
  ...
1034
1401
 
1035
- def keyframe_delete(self):
1036
- """ """
1402
+ def keyframe_delete(self) -> bool:
1403
+ """Remove a keyframe from this properties fcurve.
1404
+
1405
+ :return: Success of keyframe deletion.
1406
+ :rtype: bool
1407
+ """
1037
1408
  ...
1038
1409
 
1039
- def keyframe_insert(self):
1040
- """ """
1410
+ def keyframe_insert(self) -> bool:
1411
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1412
+
1413
+ :return: Success of keyframe insertion.
1414
+ :rtype: bool
1415
+ """
1041
1416
  ...
1042
1417
 
1043
1418
  def keys(self):
1044
- """ """
1419
+ """Returns the keys of this objects custom properties (matches Python's
1420
+ dictionary function of the same name).
1421
+
1422
+ :return: custom property keys.
1423
+ """
1045
1424
  ...
1046
1425
 
1047
- def path_from_id(self):
1048
- """ """
1426
+ def path_from_id(self) -> str:
1427
+ """Returns the data path from the ID to this object (string).
1428
+
1429
+ :return: The path from `bpy.types.bpy_struct.id_data`
1430
+ to this struct and property (when given).
1431
+ :rtype: str
1432
+ """
1049
1433
  ...
1050
1434
 
1051
1435
  def path_resolve(self):
1052
- """ """
1436
+ """Returns the property from the path, raise an exception when not found."""
1053
1437
  ...
1054
1438
 
1055
1439
  def poll(self, context):
@@ -1060,83 +1444,95 @@ class DATA_PT_camera_display_composition_guides(
1060
1444
  ...
1061
1445
 
1062
1446
  def pop(self):
1063
- """ """
1447
+ """Remove and return the value of the custom property assigned to key or default
1448
+ when not found (matches Python's dictionary function of the same name).
1449
+
1450
+ """
1064
1451
  ...
1065
1452
 
1066
1453
  def prepend(self, draw_func):
1067
- """
1454
+ """Prepend a draw function to this menu, takes the same arguments as
1455
+ the menus draw function
1068
1456
 
1069
- :param draw_func:
1457
+ :param draw_func:
1070
1458
  """
1071
1459
  ...
1072
1460
 
1073
- def property_overridable_library_set(self):
1074
- """ """
1461
+ def property_overridable_library_set(self) -> bool:
1462
+ """Define a property as overridable or not (only for custom properties!).
1463
+
1464
+ :return: True when the overridable status of the property was successfully set.
1465
+ :rtype: bool
1466
+ """
1075
1467
  ...
1076
1468
 
1077
1469
  def property_unset(self):
1078
- """ """
1470
+ """Unset a property, will use default value afterward."""
1079
1471
  ...
1080
1472
 
1081
1473
  def remove(self, draw_func):
1082
- """
1474
+ """Remove a draw function that has been added to this menu
1083
1475
 
1084
1476
  :param draw_func:
1085
1477
  """
1086
1478
  ...
1087
1479
 
1088
1480
  def type_recast(self):
1089
- """ """
1481
+ """Return a new instance, this is needed because types
1482
+ such as textures can be changed at runtime.
1483
+
1484
+ :return: a new instance of this object with the type initialized again.
1485
+ """
1090
1486
  ...
1091
1487
 
1092
1488
  def values(self):
1093
- """ """
1489
+ """Returns the values of this objects custom properties (matches Python's
1490
+ dictionary function of the same name).
1491
+
1492
+ :return: custom property values.
1493
+ """
1094
1494
  ...
1095
1495
 
1096
1496
  class DATA_PT_camera_dof(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
1097
- """ """
1098
-
1099
1497
  COMPAT_ENGINES: typing.Any
1100
- """ """
1101
-
1102
1498
  bl_context: typing.Any
1103
- """ """
1104
-
1105
1499
  bl_label: typing.Any
1106
- """ """
1107
-
1108
1500
  bl_options: typing.Any
1109
- """ """
1110
-
1111
1501
  bl_region_type: typing.Any
1112
- """ """
1113
-
1114
1502
  bl_rna: typing.Any
1115
- """ """
1116
-
1117
1503
  bl_space_type: typing.Any
1118
- """ """
1119
-
1120
1504
  id_data: typing.Any
1121
- """ """
1122
1505
 
1123
1506
  def append(self, draw_func):
1124
- """
1507
+ """Append a draw function to this menu,
1508
+ takes the same arguments as the menus draw function
1125
1509
 
1126
- :param draw_func:
1510
+ :param draw_func:
1127
1511
  """
1128
1512
  ...
1129
1513
 
1130
- def as_pointer(self):
1131
- """ """
1514
+ def as_pointer(self) -> int:
1515
+ """Returns the memory address which holds a pointer to Blender's internal data
1516
+
1517
+ :return: int (memory address).
1518
+ :rtype: int
1519
+ """
1132
1520
  ...
1133
1521
 
1134
- def bl_rna_get_subclass(self):
1135
- """ """
1522
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1523
+ """
1524
+
1525
+ :return: The RNA type or default when not found.
1526
+ :rtype: bpy.types.Struct
1527
+ """
1136
1528
  ...
1137
1529
 
1138
- def bl_rna_get_subclass_py(self):
1139
- """ """
1530
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1531
+ """
1532
+
1533
+ :return: The class or default when not found.
1534
+ :rtype: typing.Any
1535
+ """
1140
1536
  ...
1141
1537
 
1142
1538
  def draw(self, context):
@@ -1153,72 +1549,126 @@ class DATA_PT_camera_dof(bpy_types.Panel, CameraButtonsPanel, bpy_types._Generic
1153
1549
  """
1154
1550
  ...
1155
1551
 
1156
- def driver_add(self):
1157
- """ """
1552
+ def driver_add(self) -> bpy.types.FCurve:
1553
+ """Adds driver(s) to the given property
1554
+
1555
+ :return: The driver(s) added.
1556
+ :rtype: bpy.types.FCurve
1557
+ """
1158
1558
  ...
1159
1559
 
1160
- def driver_remove(self):
1161
- """ """
1560
+ def driver_remove(self) -> bool:
1561
+ """Remove driver(s) from the given property
1562
+
1563
+ :return: Success of driver removal.
1564
+ :rtype: bool
1565
+ """
1162
1566
  ...
1163
1567
 
1164
1568
  def get(self):
1165
- """ """
1569
+ """Returns the value of the custom property assigned to key or default
1570
+ when not found (matches Python's dictionary function of the same name).
1571
+
1572
+ """
1166
1573
  ...
1167
1574
 
1168
1575
  def id_properties_clear(self):
1169
- """ """
1576
+ """
1577
+
1578
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1579
+ """
1170
1580
  ...
1171
1581
 
1172
1582
  def id_properties_ensure(self):
1173
- """ """
1583
+ """
1584
+
1585
+ :return: the parent group for an RNA struct's custom IDProperties.
1586
+ """
1174
1587
  ...
1175
1588
 
1176
1589
  def id_properties_ui(self):
1177
- """ """
1178
- ...
1590
+ """
1179
1591
 
1180
- def is_extended(self):
1181
- """ """
1592
+ :return: Return an object used to manage an IDProperty's UI data.
1593
+ """
1182
1594
  ...
1183
1595
 
1184
- def is_property_hidden(self):
1185
- """ """
1596
+ def is_extended(self): ...
1597
+ def is_property_hidden(self) -> bool:
1598
+ """Check if a property is hidden.
1599
+
1600
+ :return: True when the property is hidden.
1601
+ :rtype: bool
1602
+ """
1186
1603
  ...
1187
1604
 
1188
- def is_property_overridable_library(self):
1189
- """ """
1605
+ def is_property_overridable_library(self) -> bool:
1606
+ """Check if a property is overridable.
1607
+
1608
+ :return: True when the property is overridable.
1609
+ :rtype: bool
1610
+ """
1190
1611
  ...
1191
1612
 
1192
- def is_property_readonly(self):
1193
- """ """
1613
+ def is_property_readonly(self) -> bool:
1614
+ """Check if a property is readonly.
1615
+
1616
+ :return: True when the property is readonly (not writable).
1617
+ :rtype: bool
1618
+ """
1194
1619
  ...
1195
1620
 
1196
- def is_property_set(self):
1197
- """ """
1621
+ def is_property_set(self) -> bool:
1622
+ """Check if a property is set, use for testing operator properties.
1623
+
1624
+ :return: True when the property has been set.
1625
+ :rtype: bool
1626
+ """
1198
1627
  ...
1199
1628
 
1200
1629
  def items(self):
1201
- """ """
1630
+ """Returns the items of this objects custom properties (matches Python's
1631
+ dictionary function of the same name).
1632
+
1633
+ :return: custom property key, value pairs.
1634
+ """
1202
1635
  ...
1203
1636
 
1204
- def keyframe_delete(self):
1205
- """ """
1637
+ def keyframe_delete(self) -> bool:
1638
+ """Remove a keyframe from this properties fcurve.
1639
+
1640
+ :return: Success of keyframe deletion.
1641
+ :rtype: bool
1642
+ """
1206
1643
  ...
1207
1644
 
1208
- def keyframe_insert(self):
1209
- """ """
1645
+ def keyframe_insert(self) -> bool:
1646
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1647
+
1648
+ :return: Success of keyframe insertion.
1649
+ :rtype: bool
1650
+ """
1210
1651
  ...
1211
1652
 
1212
1653
  def keys(self):
1213
- """ """
1654
+ """Returns the keys of this objects custom properties (matches Python's
1655
+ dictionary function of the same name).
1656
+
1657
+ :return: custom property keys.
1658
+ """
1214
1659
  ...
1215
1660
 
1216
- def path_from_id(self):
1217
- """ """
1661
+ def path_from_id(self) -> str:
1662
+ """Returns the data path from the ID to this object (string).
1663
+
1664
+ :return: The path from `bpy.types.bpy_struct.id_data`
1665
+ to this struct and property (when given).
1666
+ :rtype: str
1667
+ """
1218
1668
  ...
1219
1669
 
1220
1670
  def path_resolve(self):
1221
- """ """
1671
+ """Returns the property from the path, raise an exception when not found."""
1222
1672
  ...
1223
1673
 
1224
1674
  def poll(self, context):
@@ -1229,85 +1679,97 @@ class DATA_PT_camera_dof(bpy_types.Panel, CameraButtonsPanel, bpy_types._Generic
1229
1679
  ...
1230
1680
 
1231
1681
  def pop(self):
1232
- """ """
1682
+ """Remove and return the value of the custom property assigned to key or default
1683
+ when not found (matches Python's dictionary function of the same name).
1684
+
1685
+ """
1233
1686
  ...
1234
1687
 
1235
1688
  def prepend(self, draw_func):
1236
- """
1689
+ """Prepend a draw function to this menu, takes the same arguments as
1690
+ the menus draw function
1237
1691
 
1238
- :param draw_func:
1692
+ :param draw_func:
1239
1693
  """
1240
1694
  ...
1241
1695
 
1242
- def property_overridable_library_set(self):
1243
- """ """
1696
+ def property_overridable_library_set(self) -> bool:
1697
+ """Define a property as overridable or not (only for custom properties!).
1698
+
1699
+ :return: True when the overridable status of the property was successfully set.
1700
+ :rtype: bool
1701
+ """
1244
1702
  ...
1245
1703
 
1246
1704
  def property_unset(self):
1247
- """ """
1705
+ """Unset a property, will use default value afterward."""
1248
1706
  ...
1249
1707
 
1250
1708
  def remove(self, draw_func):
1251
- """
1709
+ """Remove a draw function that has been added to this menu
1252
1710
 
1253
1711
  :param draw_func:
1254
1712
  """
1255
1713
  ...
1256
1714
 
1257
1715
  def type_recast(self):
1258
- """ """
1716
+ """Return a new instance, this is needed because types
1717
+ such as textures can be changed at runtime.
1718
+
1719
+ :return: a new instance of this object with the type initialized again.
1720
+ """
1259
1721
  ...
1260
1722
 
1261
1723
  def values(self):
1262
- """ """
1724
+ """Returns the values of this objects custom properties (matches Python's
1725
+ dictionary function of the same name).
1726
+
1727
+ :return: custom property values.
1728
+ """
1263
1729
  ...
1264
1730
 
1265
1731
  class DATA_PT_camera_dof_aperture(
1266
1732
  bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI
1267
1733
  ):
1268
- """ """
1269
-
1270
1734
  COMPAT_ENGINES: typing.Any
1271
- """ """
1272
-
1273
1735
  bl_context: typing.Any
1274
- """ """
1275
-
1276
1736
  bl_label: typing.Any
1277
- """ """
1278
-
1279
1737
  bl_parent_id: typing.Any
1280
- """ """
1281
-
1282
1738
  bl_region_type: typing.Any
1283
- """ """
1284
-
1285
1739
  bl_rna: typing.Any
1286
- """ """
1287
-
1288
1740
  bl_space_type: typing.Any
1289
- """ """
1290
-
1291
1741
  id_data: typing.Any
1292
- """ """
1293
1742
 
1294
1743
  def append(self, draw_func):
1295
- """
1744
+ """Append a draw function to this menu,
1745
+ takes the same arguments as the menus draw function
1296
1746
 
1297
- :param draw_func:
1747
+ :param draw_func:
1298
1748
  """
1299
1749
  ...
1300
1750
 
1301
- def as_pointer(self):
1302
- """ """
1751
+ def as_pointer(self) -> int:
1752
+ """Returns the memory address which holds a pointer to Blender's internal data
1753
+
1754
+ :return: int (memory address).
1755
+ :rtype: int
1756
+ """
1303
1757
  ...
1304
1758
 
1305
- def bl_rna_get_subclass(self):
1306
- """ """
1759
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1760
+ """
1761
+
1762
+ :return: The RNA type or default when not found.
1763
+ :rtype: bpy.types.Struct
1764
+ """
1307
1765
  ...
1308
1766
 
1309
- def bl_rna_get_subclass_py(self):
1310
- """ """
1767
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1768
+ """
1769
+
1770
+ :return: The class or default when not found.
1771
+ :rtype: typing.Any
1772
+ """
1311
1773
  ...
1312
1774
 
1313
1775
  def draw(self, context):
@@ -1317,72 +1779,126 @@ class DATA_PT_camera_dof_aperture(
1317
1779
  """
1318
1780
  ...
1319
1781
 
1320
- def driver_add(self):
1321
- """ """
1782
+ def driver_add(self) -> bpy.types.FCurve:
1783
+ """Adds driver(s) to the given property
1784
+
1785
+ :return: The driver(s) added.
1786
+ :rtype: bpy.types.FCurve
1787
+ """
1322
1788
  ...
1323
1789
 
1324
- def driver_remove(self):
1325
- """ """
1790
+ def driver_remove(self) -> bool:
1791
+ """Remove driver(s) from the given property
1792
+
1793
+ :return: Success of driver removal.
1794
+ :rtype: bool
1795
+ """
1326
1796
  ...
1327
1797
 
1328
1798
  def get(self):
1329
- """ """
1799
+ """Returns the value of the custom property assigned to key or default
1800
+ when not found (matches Python's dictionary function of the same name).
1801
+
1802
+ """
1330
1803
  ...
1331
1804
 
1332
1805
  def id_properties_clear(self):
1333
- """ """
1806
+ """
1807
+
1808
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1809
+ """
1334
1810
  ...
1335
1811
 
1336
1812
  def id_properties_ensure(self):
1337
- """ """
1813
+ """
1814
+
1815
+ :return: the parent group for an RNA struct's custom IDProperties.
1816
+ """
1338
1817
  ...
1339
1818
 
1340
1819
  def id_properties_ui(self):
1341
- """ """
1342
- ...
1820
+ """
1343
1821
 
1344
- def is_extended(self):
1345
- """ """
1822
+ :return: Return an object used to manage an IDProperty's UI data.
1823
+ """
1346
1824
  ...
1347
1825
 
1348
- def is_property_hidden(self):
1349
- """ """
1826
+ def is_extended(self): ...
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
+ """
1350
1833
  ...
1351
1834
 
1352
- def is_property_overridable_library(self):
1353
- """ """
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
+ """
1354
1841
  ...
1355
1842
 
1356
- def is_property_readonly(self):
1357
- """ """
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
+ """
1358
1849
  ...
1359
1850
 
1360
- def is_property_set(self):
1361
- """ """
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
+ """
1362
1857
  ...
1363
1858
 
1364
1859
  def items(self):
1365
- """ """
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
+ """
1366
1865
  ...
1367
1866
 
1368
- def keyframe_delete(self):
1369
- """ """
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
+ """
1370
1873
  ...
1371
1874
 
1372
- def keyframe_insert(self):
1373
- """ """
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
+ """
1374
1881
  ...
1375
1882
 
1376
1883
  def keys(self):
1377
- """ """
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
+ """
1378
1889
  ...
1379
1890
 
1380
- def path_from_id(self):
1381
- """ """
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
+ """
1382
1898
  ...
1383
1899
 
1384
1900
  def path_resolve(self):
1385
- """ """
1901
+ """Returns the property from the path, raise an exception when not found."""
1386
1902
  ...
1387
1903
 
1388
1904
  def poll(self, context):
@@ -1393,85 +1909,97 @@ class DATA_PT_camera_dof_aperture(
1393
1909
  ...
1394
1910
 
1395
1911
  def pop(self):
1396
- """ """
1912
+ """Remove and return the value of the custom property assigned to key or default
1913
+ when not found (matches Python's dictionary function of the same name).
1914
+
1915
+ """
1397
1916
  ...
1398
1917
 
1399
1918
  def prepend(self, draw_func):
1400
- """
1919
+ """Prepend a draw function to this menu, takes the same arguments as
1920
+ the menus draw function
1401
1921
 
1402
- :param draw_func:
1922
+ :param draw_func:
1403
1923
  """
1404
1924
  ...
1405
1925
 
1406
- def property_overridable_library_set(self):
1407
- """ """
1926
+ def property_overridable_library_set(self) -> bool:
1927
+ """Define a property as overridable or not (only for custom properties!).
1928
+
1929
+ :return: True when the overridable status of the property was successfully set.
1930
+ :rtype: bool
1931
+ """
1408
1932
  ...
1409
1933
 
1410
1934
  def property_unset(self):
1411
- """ """
1935
+ """Unset a property, will use default value afterward."""
1412
1936
  ...
1413
1937
 
1414
1938
  def remove(self, draw_func):
1415
- """
1939
+ """Remove a draw function that has been added to this menu
1416
1940
 
1417
1941
  :param draw_func:
1418
1942
  """
1419
1943
  ...
1420
1944
 
1421
1945
  def type_recast(self):
1422
- """ """
1946
+ """Return a new instance, this is needed because types
1947
+ such as textures can be changed at runtime.
1948
+
1949
+ :return: a new instance of this object with the type initialized again.
1950
+ """
1423
1951
  ...
1424
1952
 
1425
1953
  def values(self):
1426
- """ """
1954
+ """Returns the values of this objects custom properties (matches Python's
1955
+ dictionary function of the same name).
1956
+
1957
+ :return: custom property values.
1958
+ """
1427
1959
  ...
1428
1960
 
1429
1961
  class DATA_PT_camera_safe_areas(
1430
1962
  bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI
1431
1963
  ):
1432
- """ """
1433
-
1434
1964
  COMPAT_ENGINES: typing.Any
1435
- """ """
1436
-
1437
1965
  bl_context: typing.Any
1438
- """ """
1439
-
1440
1966
  bl_label: typing.Any
1441
- """ """
1442
-
1443
1967
  bl_options: typing.Any
1444
- """ """
1445
-
1446
1968
  bl_region_type: typing.Any
1447
- """ """
1448
-
1449
1969
  bl_rna: typing.Any
1450
- """ """
1451
-
1452
1970
  bl_space_type: typing.Any
1453
- """ """
1454
-
1455
1971
  id_data: typing.Any
1456
- """ """
1457
1972
 
1458
1973
  def append(self, draw_func):
1459
- """
1974
+ """Append a draw function to this menu,
1975
+ takes the same arguments as the menus draw function
1460
1976
 
1461
- :param draw_func:
1977
+ :param draw_func:
1462
1978
  """
1463
1979
  ...
1464
1980
 
1465
- def as_pointer(self):
1466
- """ """
1981
+ def as_pointer(self) -> int:
1982
+ """Returns the memory address which holds a pointer to Blender's internal data
1983
+
1984
+ :return: int (memory address).
1985
+ :rtype: int
1986
+ """
1467
1987
  ...
1468
1988
 
1469
- def bl_rna_get_subclass(self):
1470
- """ """
1989
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1990
+ """
1991
+
1992
+ :return: The RNA type or default when not found.
1993
+ :rtype: bpy.types.Struct
1994
+ """
1471
1995
  ...
1472
1996
 
1473
- def bl_rna_get_subclass_py(self):
1474
- """ """
1997
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1998
+ """
1999
+
2000
+ :return: The class or default when not found.
2001
+ :rtype: typing.Any
2002
+ """
1475
2003
  ...
1476
2004
 
1477
2005
  def draw(self, context):
@@ -1495,72 +2023,126 @@ class DATA_PT_camera_safe_areas(
1495
2023
  """
1496
2024
  ...
1497
2025
 
1498
- def driver_add(self):
1499
- """ """
2026
+ def driver_add(self) -> bpy.types.FCurve:
2027
+ """Adds driver(s) to the given property
2028
+
2029
+ :return: The driver(s) added.
2030
+ :rtype: bpy.types.FCurve
2031
+ """
1500
2032
  ...
1501
2033
 
1502
- def driver_remove(self):
1503
- """ """
2034
+ def driver_remove(self) -> bool:
2035
+ """Remove driver(s) from the given property
2036
+
2037
+ :return: Success of driver removal.
2038
+ :rtype: bool
2039
+ """
1504
2040
  ...
1505
2041
 
1506
2042
  def get(self):
1507
- """ """
2043
+ """Returns the value of the custom property assigned to key or default
2044
+ when not found (matches Python's dictionary function of the same name).
2045
+
2046
+ """
1508
2047
  ...
1509
2048
 
1510
2049
  def id_properties_clear(self):
1511
- """ """
2050
+ """
2051
+
2052
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2053
+ """
1512
2054
  ...
1513
2055
 
1514
2056
  def id_properties_ensure(self):
1515
- """ """
2057
+ """
2058
+
2059
+ :return: the parent group for an RNA struct's custom IDProperties.
2060
+ """
1516
2061
  ...
1517
2062
 
1518
2063
  def id_properties_ui(self):
1519
- """ """
1520
- ...
2064
+ """
1521
2065
 
1522
- def is_extended(self):
1523
- """ """
2066
+ :return: Return an object used to manage an IDProperty's UI data.
2067
+ """
1524
2068
  ...
1525
2069
 
1526
- def is_property_hidden(self):
1527
- """ """
2070
+ def is_extended(self): ...
2071
+ def is_property_hidden(self) -> bool:
2072
+ """Check if a property is hidden.
2073
+
2074
+ :return: True when the property is hidden.
2075
+ :rtype: bool
2076
+ """
1528
2077
  ...
1529
2078
 
1530
- def is_property_overridable_library(self):
1531
- """ """
2079
+ def is_property_overridable_library(self) -> bool:
2080
+ """Check if a property is overridable.
2081
+
2082
+ :return: True when the property is overridable.
2083
+ :rtype: bool
2084
+ """
1532
2085
  ...
1533
2086
 
1534
- def is_property_readonly(self):
1535
- """ """
2087
+ def is_property_readonly(self) -> bool:
2088
+ """Check if a property is readonly.
2089
+
2090
+ :return: True when the property is readonly (not writable).
2091
+ :rtype: bool
2092
+ """
1536
2093
  ...
1537
2094
 
1538
- def is_property_set(self):
1539
- """ """
2095
+ def is_property_set(self) -> bool:
2096
+ """Check if a property is set, use for testing operator properties.
2097
+
2098
+ :return: True when the property has been set.
2099
+ :rtype: bool
2100
+ """
1540
2101
  ...
1541
2102
 
1542
2103
  def items(self):
1543
- """ """
2104
+ """Returns the items of this objects custom properties (matches Python's
2105
+ dictionary function of the same name).
2106
+
2107
+ :return: custom property key, value pairs.
2108
+ """
1544
2109
  ...
1545
2110
 
1546
- def keyframe_delete(self):
1547
- """ """
2111
+ def keyframe_delete(self) -> bool:
2112
+ """Remove a keyframe from this properties fcurve.
2113
+
2114
+ :return: Success of keyframe deletion.
2115
+ :rtype: bool
2116
+ """
1548
2117
  ...
1549
2118
 
1550
- def keyframe_insert(self):
1551
- """ """
2119
+ def keyframe_insert(self) -> bool:
2120
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2121
+
2122
+ :return: Success of keyframe insertion.
2123
+ :rtype: bool
2124
+ """
1552
2125
  ...
1553
2126
 
1554
2127
  def keys(self):
1555
- """ """
2128
+ """Returns the keys of this objects custom properties (matches Python's
2129
+ dictionary function of the same name).
2130
+
2131
+ :return: custom property keys.
2132
+ """
1556
2133
  ...
1557
2134
 
1558
- def path_from_id(self):
1559
- """ """
2135
+ def path_from_id(self) -> str:
2136
+ """Returns the data path from the ID to this object (string).
2137
+
2138
+ :return: The path from `bpy.types.bpy_struct.id_data`
2139
+ to this struct and property (when given).
2140
+ :rtype: str
2141
+ """
1560
2142
  ...
1561
2143
 
1562
2144
  def path_resolve(self):
1563
- """ """
2145
+ """Returns the property from the path, raise an exception when not found."""
1564
2146
  ...
1565
2147
 
1566
2148
  def poll(self, context):
@@ -1571,88 +2153,98 @@ class DATA_PT_camera_safe_areas(
1571
2153
  ...
1572
2154
 
1573
2155
  def pop(self):
1574
- """ """
2156
+ """Remove and return the value of the custom property assigned to key or default
2157
+ when not found (matches Python's dictionary function of the same name).
2158
+
2159
+ """
1575
2160
  ...
1576
2161
 
1577
2162
  def prepend(self, draw_func):
1578
- """
2163
+ """Prepend a draw function to this menu, takes the same arguments as
2164
+ the menus draw function
1579
2165
 
1580
- :param draw_func:
2166
+ :param draw_func:
1581
2167
  """
1582
2168
  ...
1583
2169
 
1584
- def property_overridable_library_set(self):
1585
- """ """
2170
+ def property_overridable_library_set(self) -> bool:
2171
+ """Define a property as overridable or not (only for custom properties!).
2172
+
2173
+ :return: True when the overridable status of the property was successfully set.
2174
+ :rtype: bool
2175
+ """
1586
2176
  ...
1587
2177
 
1588
2178
  def property_unset(self):
1589
- """ """
2179
+ """Unset a property, will use default value afterward."""
1590
2180
  ...
1591
2181
 
1592
2182
  def remove(self, draw_func):
1593
- """
2183
+ """Remove a draw function that has been added to this menu
1594
2184
 
1595
2185
  :param draw_func:
1596
2186
  """
1597
2187
  ...
1598
2188
 
1599
2189
  def type_recast(self):
1600
- """ """
2190
+ """Return a new instance, this is needed because types
2191
+ such as textures can be changed at runtime.
2192
+
2193
+ :return: a new instance of this object with the type initialized again.
2194
+ """
1601
2195
  ...
1602
2196
 
1603
2197
  def values(self):
1604
- """ """
2198
+ """Returns the values of this objects custom properties (matches Python's
2199
+ dictionary function of the same name).
2200
+
2201
+ :return: custom property values.
2202
+ """
1605
2203
  ...
1606
2204
 
1607
2205
  class DATA_PT_camera_safe_areas_center_cut(
1608
2206
  bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI
1609
2207
  ):
1610
- """ """
1611
-
1612
2208
  COMPAT_ENGINES: typing.Any
1613
- """ """
1614
-
1615
2209
  bl_context: typing.Any
1616
- """ """
1617
-
1618
2210
  bl_label: typing.Any
1619
- """ """
1620
-
1621
2211
  bl_options: typing.Any
1622
- """ """
1623
-
1624
2212
  bl_parent_id: typing.Any
1625
- """ """
1626
-
1627
2213
  bl_region_type: typing.Any
1628
- """ """
1629
-
1630
2214
  bl_rna: typing.Any
1631
- """ """
1632
-
1633
2215
  bl_space_type: typing.Any
1634
- """ """
1635
-
1636
2216
  id_data: typing.Any
1637
- """ """
1638
2217
 
1639
2218
  def append(self, draw_func):
1640
- """
2219
+ """Append a draw function to this menu,
2220
+ takes the same arguments as the menus draw function
1641
2221
 
1642
- :param draw_func:
2222
+ :param draw_func:
1643
2223
  """
1644
2224
  ...
1645
2225
 
1646
- def as_pointer(self):
1647
- """ """
2226
+ def as_pointer(self) -> int:
2227
+ """Returns the memory address which holds a pointer to Blender's internal data
2228
+
2229
+ :return: int (memory address).
2230
+ :rtype: int
2231
+ """
1648
2232
  ...
1649
2233
 
1650
- def bl_rna_get_subclass(self):
1651
- """ """
2234
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2235
+ """
2236
+
2237
+ :return: The RNA type or default when not found.
2238
+ :rtype: bpy.types.Struct
2239
+ """
1652
2240
  ...
1653
2241
 
1654
- def bl_rna_get_subclass_py(self):
1655
- """ """
2242
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2243
+ """
2244
+
2245
+ :return: The class or default when not found.
2246
+ :rtype: typing.Any
2247
+ """
1656
2248
  ...
1657
2249
 
1658
2250
  def draw(self, context):
@@ -1669,72 +2261,126 @@ class DATA_PT_camera_safe_areas_center_cut(
1669
2261
  """
1670
2262
  ...
1671
2263
 
1672
- def driver_add(self):
1673
- """ """
2264
+ def driver_add(self) -> bpy.types.FCurve:
2265
+ """Adds driver(s) to the given property
2266
+
2267
+ :return: The driver(s) added.
2268
+ :rtype: bpy.types.FCurve
2269
+ """
1674
2270
  ...
1675
2271
 
1676
- def driver_remove(self):
1677
- """ """
2272
+ def driver_remove(self) -> bool:
2273
+ """Remove driver(s) from the given property
2274
+
2275
+ :return: Success of driver removal.
2276
+ :rtype: bool
2277
+ """
1678
2278
  ...
1679
2279
 
1680
2280
  def get(self):
1681
- """ """
2281
+ """Returns the value of the custom property assigned to key or default
2282
+ when not found (matches Python's dictionary function of the same name).
2283
+
2284
+ """
1682
2285
  ...
1683
2286
 
1684
2287
  def id_properties_clear(self):
1685
- """ """
2288
+ """
2289
+
2290
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2291
+ """
1686
2292
  ...
1687
2293
 
1688
2294
  def id_properties_ensure(self):
1689
- """ """
2295
+ """
2296
+
2297
+ :return: the parent group for an RNA struct's custom IDProperties.
2298
+ """
1690
2299
  ...
1691
2300
 
1692
2301
  def id_properties_ui(self):
1693
- """ """
1694
- ...
2302
+ """
1695
2303
 
1696
- def is_extended(self):
1697
- """ """
2304
+ :return: Return an object used to manage an IDProperty's UI data.
2305
+ """
1698
2306
  ...
1699
2307
 
1700
- def is_property_hidden(self):
1701
- """ """
2308
+ def is_extended(self): ...
2309
+ def is_property_hidden(self) -> bool:
2310
+ """Check if a property is hidden.
2311
+
2312
+ :return: True when the property is hidden.
2313
+ :rtype: bool
2314
+ """
1702
2315
  ...
1703
2316
 
1704
- def is_property_overridable_library(self):
1705
- """ """
2317
+ def is_property_overridable_library(self) -> bool:
2318
+ """Check if a property is overridable.
2319
+
2320
+ :return: True when the property is overridable.
2321
+ :rtype: bool
2322
+ """
1706
2323
  ...
1707
2324
 
1708
- def is_property_readonly(self):
1709
- """ """
2325
+ def is_property_readonly(self) -> bool:
2326
+ """Check if a property is readonly.
2327
+
2328
+ :return: True when the property is readonly (not writable).
2329
+ :rtype: bool
2330
+ """
1710
2331
  ...
1711
2332
 
1712
- def is_property_set(self):
1713
- """ """
2333
+ def is_property_set(self) -> bool:
2334
+ """Check if a property is set, use for testing operator properties.
2335
+
2336
+ :return: True when the property has been set.
2337
+ :rtype: bool
2338
+ """
1714
2339
  ...
1715
2340
 
1716
2341
  def items(self):
1717
- """ """
2342
+ """Returns the items of this objects custom properties (matches Python's
2343
+ dictionary function of the same name).
2344
+
2345
+ :return: custom property key, value pairs.
2346
+ """
1718
2347
  ...
1719
2348
 
1720
- def keyframe_delete(self):
1721
- """ """
2349
+ def keyframe_delete(self) -> bool:
2350
+ """Remove a keyframe from this properties fcurve.
2351
+
2352
+ :return: Success of keyframe deletion.
2353
+ :rtype: bool
2354
+ """
1722
2355
  ...
1723
2356
 
1724
- def keyframe_insert(self):
1725
- """ """
2357
+ def keyframe_insert(self) -> bool:
2358
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2359
+
2360
+ :return: Success of keyframe insertion.
2361
+ :rtype: bool
2362
+ """
1726
2363
  ...
1727
2364
 
1728
2365
  def keys(self):
1729
- """ """
2366
+ """Returns the keys of this objects custom properties (matches Python's
2367
+ dictionary function of the same name).
2368
+
2369
+ :return: custom property keys.
2370
+ """
1730
2371
  ...
1731
2372
 
1732
- def path_from_id(self):
1733
- """ """
2373
+ def path_from_id(self) -> str:
2374
+ """Returns the data path from the ID to this object (string).
2375
+
2376
+ :return: The path from `bpy.types.bpy_struct.id_data`
2377
+ to this struct and property (when given).
2378
+ :rtype: str
2379
+ """
1734
2380
  ...
1735
2381
 
1736
2382
  def path_resolve(self):
1737
- """ """
2383
+ """Returns the property from the path, raise an exception when not found."""
1738
2384
  ...
1739
2385
 
1740
2386
  def poll(self, context):
@@ -1745,82 +2391,96 @@ class DATA_PT_camera_safe_areas_center_cut(
1745
2391
  ...
1746
2392
 
1747
2393
  def pop(self):
1748
- """ """
2394
+ """Remove and return the value of the custom property assigned to key or default
2395
+ when not found (matches Python's dictionary function of the same name).
2396
+
2397
+ """
1749
2398
  ...
1750
2399
 
1751
2400
  def prepend(self, draw_func):
1752
- """
2401
+ """Prepend a draw function to this menu, takes the same arguments as
2402
+ the menus draw function
1753
2403
 
1754
- :param draw_func:
2404
+ :param draw_func:
1755
2405
  """
1756
2406
  ...
1757
2407
 
1758
- def property_overridable_library_set(self):
1759
- """ """
2408
+ def property_overridable_library_set(self) -> bool:
2409
+ """Define a property as overridable or not (only for custom properties!).
2410
+
2411
+ :return: True when the overridable status of the property was successfully set.
2412
+ :rtype: bool
2413
+ """
1760
2414
  ...
1761
2415
 
1762
2416
  def property_unset(self):
1763
- """ """
2417
+ """Unset a property, will use default value afterward."""
1764
2418
  ...
1765
2419
 
1766
2420
  def remove(self, draw_func):
1767
- """
2421
+ """Remove a draw function that has been added to this menu
1768
2422
 
1769
2423
  :param draw_func:
1770
2424
  """
1771
2425
  ...
1772
2426
 
1773
2427
  def type_recast(self):
1774
- """ """
2428
+ """Return a new instance, this is needed because types
2429
+ such as textures can be changed at runtime.
2430
+
2431
+ :return: a new instance of this object with the type initialized again.
2432
+ """
1775
2433
  ...
1776
2434
 
1777
2435
  def values(self):
1778
- """ """
2436
+ """Returns the values of this objects custom properties (matches Python's
2437
+ dictionary function of the same name).
2438
+
2439
+ :return: custom property values.
2440
+ """
1779
2441
  ...
1780
2442
 
1781
2443
  class DATA_PT_camera_stereoscopy(
1782
2444
  bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI
1783
2445
  ):
1784
- """ """
1785
-
1786
2446
  COMPAT_ENGINES: typing.Any
1787
- """ """
1788
-
1789
2447
  bl_context: typing.Any
1790
- """ """
1791
-
1792
2448
  bl_label: typing.Any
1793
- """ """
1794
-
1795
2449
  bl_region_type: typing.Any
1796
- """ """
1797
-
1798
2450
  bl_rna: typing.Any
1799
- """ """
1800
-
1801
2451
  bl_space_type: typing.Any
1802
- """ """
1803
-
1804
2452
  id_data: typing.Any
1805
- """ """
1806
2453
 
1807
2454
  def append(self, draw_func):
1808
- """
2455
+ """Append a draw function to this menu,
2456
+ takes the same arguments as the menus draw function
1809
2457
 
1810
- :param draw_func:
2458
+ :param draw_func:
1811
2459
  """
1812
2460
  ...
1813
2461
 
1814
- def as_pointer(self):
1815
- """ """
2462
+ def as_pointer(self) -> int:
2463
+ """Returns the memory address which holds a pointer to Blender's internal data
2464
+
2465
+ :return: int (memory address).
2466
+ :rtype: int
2467
+ """
1816
2468
  ...
1817
2469
 
1818
- def bl_rna_get_subclass(self):
1819
- """ """
2470
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2471
+ """
2472
+
2473
+ :return: The RNA type or default when not found.
2474
+ :rtype: bpy.types.Struct
2475
+ """
1820
2476
  ...
1821
2477
 
1822
- def bl_rna_get_subclass_py(self):
1823
- """ """
2478
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2479
+ """
2480
+
2481
+ :return: The class or default when not found.
2482
+ :rtype: typing.Any
2483
+ """
1824
2484
  ...
1825
2485
 
1826
2486
  def draw(self, context):
@@ -1830,72 +2490,126 @@ class DATA_PT_camera_stereoscopy(
1830
2490
  """
1831
2491
  ...
1832
2492
 
1833
- def driver_add(self):
1834
- """ """
2493
+ def driver_add(self) -> bpy.types.FCurve:
2494
+ """Adds driver(s) to the given property
2495
+
2496
+ :return: The driver(s) added.
2497
+ :rtype: bpy.types.FCurve
2498
+ """
1835
2499
  ...
1836
2500
 
1837
- def driver_remove(self):
1838
- """ """
2501
+ def driver_remove(self) -> bool:
2502
+ """Remove driver(s) from the given property
2503
+
2504
+ :return: Success of driver removal.
2505
+ :rtype: bool
2506
+ """
1839
2507
  ...
1840
2508
 
1841
2509
  def get(self):
1842
- """ """
2510
+ """Returns the value of the custom property assigned to key or default
2511
+ when not found (matches Python's dictionary function of the same name).
2512
+
2513
+ """
1843
2514
  ...
1844
2515
 
1845
2516
  def id_properties_clear(self):
1846
- """ """
2517
+ """
2518
+
2519
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2520
+ """
1847
2521
  ...
1848
2522
 
1849
2523
  def id_properties_ensure(self):
1850
- """ """
2524
+ """
2525
+
2526
+ :return: the parent group for an RNA struct's custom IDProperties.
2527
+ """
1851
2528
  ...
1852
2529
 
1853
2530
  def id_properties_ui(self):
1854
- """ """
1855
- ...
2531
+ """
1856
2532
 
1857
- def is_extended(self):
1858
- """ """
2533
+ :return: Return an object used to manage an IDProperty's UI data.
2534
+ """
1859
2535
  ...
1860
2536
 
1861
- def is_property_hidden(self):
1862
- """ """
2537
+ def is_extended(self): ...
2538
+ def is_property_hidden(self) -> bool:
2539
+ """Check if a property is hidden.
2540
+
2541
+ :return: True when the property is hidden.
2542
+ :rtype: bool
2543
+ """
1863
2544
  ...
1864
2545
 
1865
- def is_property_overridable_library(self):
1866
- """ """
2546
+ def is_property_overridable_library(self) -> bool:
2547
+ """Check if a property is overridable.
2548
+
2549
+ :return: True when the property is overridable.
2550
+ :rtype: bool
2551
+ """
1867
2552
  ...
1868
2553
 
1869
- def is_property_readonly(self):
1870
- """ """
2554
+ def is_property_readonly(self) -> bool:
2555
+ """Check if a property is readonly.
2556
+
2557
+ :return: True when the property is readonly (not writable).
2558
+ :rtype: bool
2559
+ """
1871
2560
  ...
1872
2561
 
1873
- def is_property_set(self):
1874
- """ """
2562
+ def is_property_set(self) -> bool:
2563
+ """Check if a property is set, use for testing operator properties.
2564
+
2565
+ :return: True when the property has been set.
2566
+ :rtype: bool
2567
+ """
1875
2568
  ...
1876
2569
 
1877
2570
  def items(self):
1878
- """ """
2571
+ """Returns the items of this objects custom properties (matches Python's
2572
+ dictionary function of the same name).
2573
+
2574
+ :return: custom property key, value pairs.
2575
+ """
1879
2576
  ...
1880
2577
 
1881
- def keyframe_delete(self):
1882
- """ """
2578
+ def keyframe_delete(self) -> bool:
2579
+ """Remove a keyframe from this properties fcurve.
2580
+
2581
+ :return: Success of keyframe deletion.
2582
+ :rtype: bool
2583
+ """
1883
2584
  ...
1884
2585
 
1885
- def keyframe_insert(self):
1886
- """ """
2586
+ def keyframe_insert(self) -> bool:
2587
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2588
+
2589
+ :return: Success of keyframe insertion.
2590
+ :rtype: bool
2591
+ """
1887
2592
  ...
1888
2593
 
1889
2594
  def keys(self):
1890
- """ """
2595
+ """Returns the keys of this objects custom properties (matches Python's
2596
+ dictionary function of the same name).
2597
+
2598
+ :return: custom property keys.
2599
+ """
1891
2600
  ...
1892
2601
 
1893
- def path_from_id(self):
1894
- """ """
2602
+ def path_from_id(self) -> str:
2603
+ """Returns the data path from the ID to this object (string).
2604
+
2605
+ :return: The path from `bpy.types.bpy_struct.id_data`
2606
+ to this struct and property (when given).
2607
+ :rtype: str
2608
+ """
1895
2609
  ...
1896
2610
 
1897
2611
  def path_resolve(self):
1898
- """ """
2612
+ """Returns the property from the path, raise an exception when not found."""
1899
2613
  ...
1900
2614
 
1901
2615
  def poll(self, context):
@@ -1906,83 +2620,95 @@ class DATA_PT_camera_stereoscopy(
1906
2620
  ...
1907
2621
 
1908
2622
  def pop(self):
1909
- """ """
2623
+ """Remove and return the value of the custom property assigned to key or default
2624
+ when not found (matches Python's dictionary function of the same name).
2625
+
2626
+ """
1910
2627
  ...
1911
2628
 
1912
2629
  def prepend(self, draw_func):
1913
- """
2630
+ """Prepend a draw function to this menu, takes the same arguments as
2631
+ the menus draw function
1914
2632
 
1915
- :param draw_func:
2633
+ :param draw_func:
1916
2634
  """
1917
2635
  ...
1918
2636
 
1919
- def property_overridable_library_set(self):
1920
- """ """
2637
+ def property_overridable_library_set(self) -> bool:
2638
+ """Define a property as overridable or not (only for custom properties!).
2639
+
2640
+ :return: True when the overridable status of the property was successfully set.
2641
+ :rtype: bool
2642
+ """
1921
2643
  ...
1922
2644
 
1923
2645
  def property_unset(self):
1924
- """ """
2646
+ """Unset a property, will use default value afterward."""
1925
2647
  ...
1926
2648
 
1927
2649
  def remove(self, draw_func):
1928
- """
2650
+ """Remove a draw function that has been added to this menu
1929
2651
 
1930
2652
  :param draw_func:
1931
2653
  """
1932
2654
  ...
1933
2655
 
1934
2656
  def type_recast(self):
1935
- """ """
2657
+ """Return a new instance, this is needed because types
2658
+ such as textures can be changed at runtime.
2659
+
2660
+ :return: a new instance of this object with the type initialized again.
2661
+ """
1936
2662
  ...
1937
2663
 
1938
2664
  def values(self):
1939
- """ """
2665
+ """Returns the values of this objects custom properties (matches Python's
2666
+ dictionary function of the same name).
2667
+
2668
+ :return: custom property values.
2669
+ """
1940
2670
  ...
1941
2671
 
1942
2672
  class DATA_PT_context_camera(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
1943
- """ """
1944
-
1945
2673
  COMPAT_ENGINES: typing.Any
1946
- """ """
1947
-
1948
2674
  bl_context: typing.Any
1949
- """ """
1950
-
1951
2675
  bl_label: typing.Any
1952
- """ """
1953
-
1954
2676
  bl_options: typing.Any
1955
- """ """
1956
-
1957
2677
  bl_region_type: typing.Any
1958
- """ """
1959
-
1960
2678
  bl_rna: typing.Any
1961
- """ """
1962
-
1963
2679
  bl_space_type: typing.Any
1964
- """ """
1965
-
1966
2680
  id_data: typing.Any
1967
- """ """
1968
2681
 
1969
2682
  def append(self, draw_func):
1970
- """
2683
+ """Append a draw function to this menu,
2684
+ takes the same arguments as the menus draw function
1971
2685
 
1972
- :param draw_func:
2686
+ :param draw_func:
1973
2687
  """
1974
2688
  ...
1975
2689
 
1976
- def as_pointer(self):
1977
- """ """
2690
+ def as_pointer(self) -> int:
2691
+ """Returns the memory address which holds a pointer to Blender's internal data
2692
+
2693
+ :return: int (memory address).
2694
+ :rtype: int
2695
+ """
1978
2696
  ...
1979
2697
 
1980
- def bl_rna_get_subclass(self):
1981
- """ """
2698
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2699
+ """
2700
+
2701
+ :return: The RNA type or default when not found.
2702
+ :rtype: bpy.types.Struct
2703
+ """
1982
2704
  ...
1983
2705
 
1984
- def bl_rna_get_subclass_py(self):
1985
- """ """
2706
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2707
+ """
2708
+
2709
+ :return: The class or default when not found.
2710
+ :rtype: typing.Any
2711
+ """
1986
2712
  ...
1987
2713
 
1988
2714
  def draw(self, context):
@@ -1992,72 +2718,126 @@ class DATA_PT_context_camera(bpy_types.Panel, CameraButtonsPanel, bpy_types._Gen
1992
2718
  """
1993
2719
  ...
1994
2720
 
1995
- def driver_add(self):
1996
- """ """
2721
+ def driver_add(self) -> bpy.types.FCurve:
2722
+ """Adds driver(s) to the given property
2723
+
2724
+ :return: The driver(s) added.
2725
+ :rtype: bpy.types.FCurve
2726
+ """
1997
2727
  ...
1998
2728
 
1999
- def driver_remove(self):
2000
- """ """
2729
+ def driver_remove(self) -> bool:
2730
+ """Remove driver(s) from the given property
2731
+
2732
+ :return: Success of driver removal.
2733
+ :rtype: bool
2734
+ """
2001
2735
  ...
2002
2736
 
2003
2737
  def get(self):
2004
- """ """
2738
+ """Returns the value of the custom property assigned to key or default
2739
+ when not found (matches Python's dictionary function of the same name).
2740
+
2741
+ """
2005
2742
  ...
2006
2743
 
2007
2744
  def id_properties_clear(self):
2008
- """ """
2745
+ """
2746
+
2747
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2748
+ """
2009
2749
  ...
2010
2750
 
2011
2751
  def id_properties_ensure(self):
2012
- """ """
2752
+ """
2753
+
2754
+ :return: the parent group for an RNA struct's custom IDProperties.
2755
+ """
2013
2756
  ...
2014
2757
 
2015
2758
  def id_properties_ui(self):
2016
- """ """
2017
- ...
2759
+ """
2018
2760
 
2019
- def is_extended(self):
2020
- """ """
2761
+ :return: Return an object used to manage an IDProperty's UI data.
2762
+ """
2021
2763
  ...
2022
2764
 
2023
- def is_property_hidden(self):
2024
- """ """
2765
+ def is_extended(self): ...
2766
+ def is_property_hidden(self) -> bool:
2767
+ """Check if a property is hidden.
2768
+
2769
+ :return: True when the property is hidden.
2770
+ :rtype: bool
2771
+ """
2025
2772
  ...
2026
2773
 
2027
- def is_property_overridable_library(self):
2028
- """ """
2774
+ def is_property_overridable_library(self) -> bool:
2775
+ """Check if a property is overridable.
2776
+
2777
+ :return: True when the property is overridable.
2778
+ :rtype: bool
2779
+ """
2029
2780
  ...
2030
2781
 
2031
- def is_property_readonly(self):
2032
- """ """
2782
+ def is_property_readonly(self) -> bool:
2783
+ """Check if a property is readonly.
2784
+
2785
+ :return: True when the property is readonly (not writable).
2786
+ :rtype: bool
2787
+ """
2033
2788
  ...
2034
2789
 
2035
- def is_property_set(self):
2036
- """ """
2790
+ def is_property_set(self) -> bool:
2791
+ """Check if a property is set, use for testing operator properties.
2792
+
2793
+ :return: True when the property has been set.
2794
+ :rtype: bool
2795
+ """
2037
2796
  ...
2038
2797
 
2039
2798
  def items(self):
2040
- """ """
2799
+ """Returns the items of this objects custom properties (matches Python's
2800
+ dictionary function of the same name).
2801
+
2802
+ :return: custom property key, value pairs.
2803
+ """
2041
2804
  ...
2042
2805
 
2043
- def keyframe_delete(self):
2044
- """ """
2806
+ def keyframe_delete(self) -> bool:
2807
+ """Remove a keyframe from this properties fcurve.
2808
+
2809
+ :return: Success of keyframe deletion.
2810
+ :rtype: bool
2811
+ """
2045
2812
  ...
2046
2813
 
2047
- def keyframe_insert(self):
2048
- """ """
2814
+ def keyframe_insert(self) -> bool:
2815
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2816
+
2817
+ :return: Success of keyframe insertion.
2818
+ :rtype: bool
2819
+ """
2049
2820
  ...
2050
2821
 
2051
2822
  def keys(self):
2052
- """ """
2823
+ """Returns the keys of this objects custom properties (matches Python's
2824
+ dictionary function of the same name).
2825
+
2826
+ :return: custom property keys.
2827
+ """
2053
2828
  ...
2054
2829
 
2055
- def path_from_id(self):
2056
- """ """
2830
+ def path_from_id(self) -> str:
2831
+ """Returns the data path from the ID to this object (string).
2832
+
2833
+ :return: The path from `bpy.types.bpy_struct.id_data`
2834
+ to this struct and property (when given).
2835
+ :rtype: str
2836
+ """
2057
2837
  ...
2058
2838
 
2059
2839
  def path_resolve(self):
2060
- """ """
2840
+ """Returns the property from the path, raise an exception when not found."""
2061
2841
  ...
2062
2842
 
2063
2843
  def poll(self, context):
@@ -2068,88 +2848,102 @@ class DATA_PT_context_camera(bpy_types.Panel, CameraButtonsPanel, bpy_types._Gen
2068
2848
  ...
2069
2849
 
2070
2850
  def pop(self):
2071
- """ """
2851
+ """Remove and return the value of the custom property assigned to key or default
2852
+ when not found (matches Python's dictionary function of the same name).
2853
+
2854
+ """
2072
2855
  ...
2073
2856
 
2074
2857
  def prepend(self, draw_func):
2075
- """
2858
+ """Prepend a draw function to this menu, takes the same arguments as
2859
+ the menus draw function
2076
2860
 
2077
- :param draw_func:
2861
+ :param draw_func:
2078
2862
  """
2079
2863
  ...
2080
2864
 
2081
- def property_overridable_library_set(self):
2082
- """ """
2865
+ def property_overridable_library_set(self) -> bool:
2866
+ """Define a property as overridable or not (only for custom properties!).
2867
+
2868
+ :return: True when the overridable status of the property was successfully set.
2869
+ :rtype: bool
2870
+ """
2083
2871
  ...
2084
2872
 
2085
2873
  def property_unset(self):
2086
- """ """
2874
+ """Unset a property, will use default value afterward."""
2087
2875
  ...
2088
2876
 
2089
2877
  def remove(self, draw_func):
2090
- """
2878
+ """Remove a draw function that has been added to this menu
2091
2879
 
2092
2880
  :param draw_func:
2093
2881
  """
2094
2882
  ...
2095
2883
 
2096
2884
  def type_recast(self):
2097
- """ """
2885
+ """Return a new instance, this is needed because types
2886
+ such as textures can be changed at runtime.
2887
+
2888
+ :return: a new instance of this object with the type initialized again.
2889
+ """
2098
2890
  ...
2099
2891
 
2100
2892
  def values(self):
2101
- """ """
2893
+ """Returns the values of this objects custom properties (matches Python's
2894
+ dictionary function of the same name).
2895
+
2896
+ :return: custom property values.
2897
+ """
2102
2898
  ...
2103
2899
 
2104
2900
  class DATA_PT_custom_props_camera(
2105
2901
  bpy_types.Panel, CameraButtonsPanel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
2106
2902
  ):
2107
- """ """
2903
+ """The subclass should have its own poll function
2904
+ and the variable '_context_path' MUST be set.
2905
+ """
2108
2906
 
2109
2907
  COMPAT_ENGINES: typing.Any
2110
- """ """
2111
-
2112
2908
  bl_context: typing.Any
2113
- """ """
2114
-
2115
2909
  bl_label: typing.Any
2116
- """ """
2117
-
2118
2910
  bl_options: typing.Any
2119
- """ """
2120
-
2121
2911
  bl_order: typing.Any
2122
- """ """
2123
-
2124
2912
  bl_region_type: typing.Any
2125
- """ """
2126
-
2127
2913
  bl_rna: typing.Any
2128
- """ """
2129
-
2130
2914
  bl_space_type: typing.Any
2131
- """ """
2132
-
2133
2915
  id_data: typing.Any
2134
- """ """
2135
2916
 
2136
2917
  def append(self, draw_func):
2137
- """
2918
+ """Append a draw function to this menu,
2919
+ takes the same arguments as the menus draw function
2138
2920
 
2139
- :param draw_func:
2921
+ :param draw_func:
2140
2922
  """
2141
2923
  ...
2142
2924
 
2143
- def as_pointer(self):
2144
- """ """
2925
+ def as_pointer(self) -> int:
2926
+ """Returns the memory address which holds a pointer to Blender's internal data
2927
+
2928
+ :return: int (memory address).
2929
+ :rtype: int
2930
+ """
2145
2931
  ...
2146
2932
 
2147
- def bl_rna_get_subclass(self):
2148
- """ """
2933
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2934
+ """
2935
+
2936
+ :return: The RNA type or default when not found.
2937
+ :rtype: bpy.types.Struct
2938
+ """
2149
2939
  ...
2150
2940
 
2151
- def bl_rna_get_subclass_py(self):
2152
- """ """
2941
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2942
+ """
2943
+
2944
+ :return: The class or default when not found.
2945
+ :rtype: typing.Any
2946
+ """
2153
2947
  ...
2154
2948
 
2155
2949
  def draw(self, context):
@@ -2159,72 +2953,126 @@ class DATA_PT_custom_props_camera(
2159
2953
  """
2160
2954
  ...
2161
2955
 
2162
- def driver_add(self):
2163
- """ """
2956
+ def driver_add(self) -> bpy.types.FCurve:
2957
+ """Adds driver(s) to the given property
2958
+
2959
+ :return: The driver(s) added.
2960
+ :rtype: bpy.types.FCurve
2961
+ """
2164
2962
  ...
2165
2963
 
2166
- def driver_remove(self):
2167
- """ """
2964
+ def driver_remove(self) -> bool:
2965
+ """Remove driver(s) from the given property
2966
+
2967
+ :return: Success of driver removal.
2968
+ :rtype: bool
2969
+ """
2168
2970
  ...
2169
2971
 
2170
2972
  def get(self):
2171
- """ """
2973
+ """Returns the value of the custom property assigned to key or default
2974
+ when not found (matches Python's dictionary function of the same name).
2975
+
2976
+ """
2172
2977
  ...
2173
2978
 
2174
2979
  def id_properties_clear(self):
2175
- """ """
2980
+ """
2981
+
2982
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2983
+ """
2176
2984
  ...
2177
2985
 
2178
2986
  def id_properties_ensure(self):
2179
- """ """
2987
+ """
2988
+
2989
+ :return: the parent group for an RNA struct's custom IDProperties.
2990
+ """
2180
2991
  ...
2181
2992
 
2182
2993
  def id_properties_ui(self):
2183
- """ """
2184
- ...
2994
+ """
2185
2995
 
2186
- def is_extended(self):
2187
- """ """
2996
+ :return: Return an object used to manage an IDProperty's UI data.
2997
+ """
2188
2998
  ...
2189
2999
 
2190
- def is_property_hidden(self):
2191
- """ """
3000
+ def is_extended(self): ...
3001
+ def is_property_hidden(self) -> bool:
3002
+ """Check if a property is hidden.
3003
+
3004
+ :return: True when the property is hidden.
3005
+ :rtype: bool
3006
+ """
2192
3007
  ...
2193
3008
 
2194
- def is_property_overridable_library(self):
2195
- """ """
3009
+ def is_property_overridable_library(self) -> bool:
3010
+ """Check if a property is overridable.
3011
+
3012
+ :return: True when the property is overridable.
3013
+ :rtype: bool
3014
+ """
2196
3015
  ...
2197
3016
 
2198
- def is_property_readonly(self):
2199
- """ """
3017
+ def is_property_readonly(self) -> bool:
3018
+ """Check if a property is readonly.
3019
+
3020
+ :return: True when the property is readonly (not writable).
3021
+ :rtype: bool
3022
+ """
2200
3023
  ...
2201
3024
 
2202
- def is_property_set(self):
2203
- """ """
3025
+ def is_property_set(self) -> bool:
3026
+ """Check if a property is set, use for testing operator properties.
3027
+
3028
+ :return: True when the property has been set.
3029
+ :rtype: bool
3030
+ """
2204
3031
  ...
2205
3032
 
2206
3033
  def items(self):
2207
- """ """
3034
+ """Returns the items of this objects custom properties (matches Python's
3035
+ dictionary function of the same name).
3036
+
3037
+ :return: custom property key, value pairs.
3038
+ """
2208
3039
  ...
2209
3040
 
2210
- def keyframe_delete(self):
2211
- """ """
3041
+ def keyframe_delete(self) -> bool:
3042
+ """Remove a keyframe from this properties fcurve.
3043
+
3044
+ :return: Success of keyframe deletion.
3045
+ :rtype: bool
3046
+ """
2212
3047
  ...
2213
3048
 
2214
- def keyframe_insert(self):
2215
- """ """
3049
+ def keyframe_insert(self) -> bool:
3050
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3051
+
3052
+ :return: Success of keyframe insertion.
3053
+ :rtype: bool
3054
+ """
2216
3055
  ...
2217
3056
 
2218
3057
  def keys(self):
2219
- """ """
3058
+ """Returns the keys of this objects custom properties (matches Python's
3059
+ dictionary function of the same name).
3060
+
3061
+ :return: custom property keys.
3062
+ """
2220
3063
  ...
2221
3064
 
2222
- def path_from_id(self):
2223
- """ """
3065
+ def path_from_id(self) -> str:
3066
+ """Returns the data path from the ID to this object (string).
3067
+
3068
+ :return: The path from `bpy.types.bpy_struct.id_data`
3069
+ to this struct and property (when given).
3070
+ :rtype: str
3071
+ """
2224
3072
  ...
2225
3073
 
2226
3074
  def path_resolve(self):
2227
- """ """
3075
+ """Returns the property from the path, raise an exception when not found."""
2228
3076
  ...
2229
3077
 
2230
3078
  def poll(self, context):
@@ -2235,83 +3083,95 @@ class DATA_PT_custom_props_camera(
2235
3083
  ...
2236
3084
 
2237
3085
  def pop(self):
2238
- """ """
3086
+ """Remove and return the value of the custom property assigned to key or default
3087
+ when not found (matches Python's dictionary function of the same name).
3088
+
3089
+ """
2239
3090
  ...
2240
3091
 
2241
3092
  def prepend(self, draw_func):
2242
- """
3093
+ """Prepend a draw function to this menu, takes the same arguments as
3094
+ the menus draw function
2243
3095
 
2244
- :param draw_func:
3096
+ :param draw_func:
2245
3097
  """
2246
3098
  ...
2247
3099
 
2248
- def property_overridable_library_set(self):
2249
- """ """
3100
+ def property_overridable_library_set(self) -> bool:
3101
+ """Define a property as overridable or not (only for custom properties!).
3102
+
3103
+ :return: True when the overridable status of the property was successfully set.
3104
+ :rtype: bool
3105
+ """
2250
3106
  ...
2251
3107
 
2252
3108
  def property_unset(self):
2253
- """ """
3109
+ """Unset a property, will use default value afterward."""
2254
3110
  ...
2255
3111
 
2256
3112
  def remove(self, draw_func):
2257
- """
3113
+ """Remove a draw function that has been added to this menu
2258
3114
 
2259
3115
  :param draw_func:
2260
3116
  """
2261
3117
  ...
2262
3118
 
2263
3119
  def type_recast(self):
2264
- """ """
3120
+ """Return a new instance, this is needed because types
3121
+ such as textures can be changed at runtime.
3122
+
3123
+ :return: a new instance of this object with the type initialized again.
3124
+ """
2265
3125
  ...
2266
3126
 
2267
3127
  def values(self):
2268
- """ """
3128
+ """Returns the values of this objects custom properties (matches Python's
3129
+ dictionary function of the same name).
3130
+
3131
+ :return: custom property values.
3132
+ """
2269
3133
  ...
2270
3134
 
2271
3135
  class DATA_PT_lens(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
2272
- """ """
2273
-
2274
3136
  COMPAT_ENGINES: typing.Any
2275
- """ """
2276
-
2277
3137
  bl_context: typing.Any
2278
- """ """
2279
-
2280
3138
  bl_label: typing.Any
2281
- """ """
2282
-
2283
3139
  bl_region_type: typing.Any
2284
- """ """
2285
-
2286
3140
  bl_rna: typing.Any
2287
- """ """
2288
-
2289
3141
  bl_space_type: typing.Any
2290
- """ """
2291
-
2292
3142
  bl_translation_context: typing.Any
2293
- """ """
2294
-
2295
3143
  id_data: typing.Any
2296
- """ """
2297
3144
 
2298
3145
  def append(self, draw_func):
2299
- """
3146
+ """Append a draw function to this menu,
3147
+ takes the same arguments as the menus draw function
2300
3148
 
2301
- :param draw_func:
3149
+ :param draw_func:
2302
3150
  """
2303
3151
  ...
2304
3152
 
2305
- def as_pointer(self):
2306
- """ """
3153
+ def as_pointer(self) -> int:
3154
+ """Returns the memory address which holds a pointer to Blender's internal data
3155
+
3156
+ :return: int (memory address).
3157
+ :rtype: int
3158
+ """
2307
3159
  ...
2308
3160
 
2309
- def bl_rna_get_subclass(self):
2310
- """ """
3161
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3162
+ """
3163
+
3164
+ :return: The RNA type or default when not found.
3165
+ :rtype: bpy.types.Struct
3166
+ """
2311
3167
  ...
2312
3168
 
2313
- def bl_rna_get_subclass_py(self):
2314
- """ """
3169
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3170
+ """
3171
+
3172
+ :return: The class or default when not found.
3173
+ :rtype: typing.Any
3174
+ """
2315
3175
  ...
2316
3176
 
2317
3177
  def draw(self, context):
@@ -2321,72 +3181,126 @@ class DATA_PT_lens(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
2321
3181
  """
2322
3182
  ...
2323
3183
 
2324
- def driver_add(self):
2325
- """ """
3184
+ def driver_add(self) -> bpy.types.FCurve:
3185
+ """Adds driver(s) to the given property
3186
+
3187
+ :return: The driver(s) added.
3188
+ :rtype: bpy.types.FCurve
3189
+ """
2326
3190
  ...
2327
3191
 
2328
- def driver_remove(self):
2329
- """ """
3192
+ def driver_remove(self) -> bool:
3193
+ """Remove driver(s) from the given property
3194
+
3195
+ :return: Success of driver removal.
3196
+ :rtype: bool
3197
+ """
2330
3198
  ...
2331
3199
 
2332
3200
  def get(self):
2333
- """ """
3201
+ """Returns the value of the custom property assigned to key or default
3202
+ when not found (matches Python's dictionary function of the same name).
3203
+
3204
+ """
2334
3205
  ...
2335
3206
 
2336
3207
  def id_properties_clear(self):
2337
- """ """
3208
+ """
3209
+
3210
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3211
+ """
2338
3212
  ...
2339
3213
 
2340
3214
  def id_properties_ensure(self):
2341
- """ """
3215
+ """
3216
+
3217
+ :return: the parent group for an RNA struct's custom IDProperties.
3218
+ """
2342
3219
  ...
2343
3220
 
2344
3221
  def id_properties_ui(self):
2345
- """ """
2346
- ...
3222
+ """
2347
3223
 
2348
- def is_extended(self):
2349
- """ """
3224
+ :return: Return an object used to manage an IDProperty's UI data.
3225
+ """
2350
3226
  ...
2351
3227
 
2352
- def is_property_hidden(self):
2353
- """ """
3228
+ def is_extended(self): ...
3229
+ def is_property_hidden(self) -> bool:
3230
+ """Check if a property is hidden.
3231
+
3232
+ :return: True when the property is hidden.
3233
+ :rtype: bool
3234
+ """
2354
3235
  ...
2355
3236
 
2356
- def is_property_overridable_library(self):
2357
- """ """
3237
+ def is_property_overridable_library(self) -> bool:
3238
+ """Check if a property is overridable.
3239
+
3240
+ :return: True when the property is overridable.
3241
+ :rtype: bool
3242
+ """
2358
3243
  ...
2359
3244
 
2360
- def is_property_readonly(self):
2361
- """ """
3245
+ def is_property_readonly(self) -> bool:
3246
+ """Check if a property is readonly.
3247
+
3248
+ :return: True when the property is readonly (not writable).
3249
+ :rtype: bool
3250
+ """
2362
3251
  ...
2363
3252
 
2364
- def is_property_set(self):
2365
- """ """
3253
+ def is_property_set(self) -> bool:
3254
+ """Check if a property is set, use for testing operator properties.
3255
+
3256
+ :return: True when the property has been set.
3257
+ :rtype: bool
3258
+ """
2366
3259
  ...
2367
3260
 
2368
3261
  def items(self):
2369
- """ """
3262
+ """Returns the items of this objects custom properties (matches Python's
3263
+ dictionary function of the same name).
3264
+
3265
+ :return: custom property key, value pairs.
3266
+ """
2370
3267
  ...
2371
3268
 
2372
- def keyframe_delete(self):
2373
- """ """
3269
+ def keyframe_delete(self) -> bool:
3270
+ """Remove a keyframe from this properties fcurve.
3271
+
3272
+ :return: Success of keyframe deletion.
3273
+ :rtype: bool
3274
+ """
2374
3275
  ...
2375
3276
 
2376
- def keyframe_insert(self):
2377
- """ """
3277
+ def keyframe_insert(self) -> bool:
3278
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3279
+
3280
+ :return: Success of keyframe insertion.
3281
+ :rtype: bool
3282
+ """
2378
3283
  ...
2379
3284
 
2380
3285
  def keys(self):
2381
- """ """
3286
+ """Returns the keys of this objects custom properties (matches Python's
3287
+ dictionary function of the same name).
3288
+
3289
+ :return: custom property keys.
3290
+ """
2382
3291
  ...
2383
3292
 
2384
- def path_from_id(self):
2385
- """ """
3293
+ def path_from_id(self) -> str:
3294
+ """Returns the data path from the ID to this object (string).
3295
+
3296
+ :return: The path from `bpy.types.bpy_struct.id_data`
3297
+ to this struct and property (when given).
3298
+ :rtype: str
3299
+ """
2386
3300
  ...
2387
3301
 
2388
3302
  def path_resolve(self):
2389
- """ """
3303
+ """Returns the property from the path, raise an exception when not found."""
2390
3304
  ...
2391
3305
 
2392
3306
  def poll(self, context):
@@ -2397,40 +3311,53 @@ class DATA_PT_lens(bpy_types.Panel, CameraButtonsPanel, bpy_types._GenericUI):
2397
3311
  ...
2398
3312
 
2399
3313
  def pop(self):
2400
- """ """
3314
+ """Remove and return the value of the custom property assigned to key or default
3315
+ when not found (matches Python's dictionary function of the same name).
3316
+
3317
+ """
2401
3318
  ...
2402
3319
 
2403
3320
  def prepend(self, draw_func):
2404
- """
3321
+ """Prepend a draw function to this menu, takes the same arguments as
3322
+ the menus draw function
2405
3323
 
2406
- :param draw_func:
3324
+ :param draw_func:
2407
3325
  """
2408
3326
  ...
2409
3327
 
2410
- def property_overridable_library_set(self):
2411
- """ """
3328
+ def property_overridable_library_set(self) -> bool:
3329
+ """Define a property as overridable or not (only for custom properties!).
3330
+
3331
+ :return: True when the overridable status of the property was successfully set.
3332
+ :rtype: bool
3333
+ """
2412
3334
  ...
2413
3335
 
2414
3336
  def property_unset(self):
2415
- """ """
3337
+ """Unset a property, will use default value afterward."""
2416
3338
  ...
2417
3339
 
2418
3340
  def remove(self, draw_func):
2419
- """
3341
+ """Remove a draw function that has been added to this menu
2420
3342
 
2421
3343
  :param draw_func:
2422
3344
  """
2423
3345
  ...
2424
3346
 
2425
3347
  def type_recast(self):
2426
- """ """
3348
+ """Return a new instance, this is needed because types
3349
+ such as textures can be changed at runtime.
3350
+
3351
+ :return: a new instance of this object with the type initialized again.
3352
+ """
2427
3353
  ...
2428
3354
 
2429
3355
  def values(self):
2430
- """ """
2431
- ...
3356
+ """Returns the values of this objects custom properties (matches Python's
3357
+ dictionary function of the same name).
2432
3358
 
2433
- def draw_display_safe_settings(layout, safe_data, settings):
2434
- """ """
3359
+ :return: custom property values.
3360
+ """
3361
+ ...
2435
3362
 
2436
- ...
3363
+ def draw_display_safe_settings(layout, safe_data, settings): ...