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

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

Potentially problematic release.


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

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