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,51 +1,63 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
 
4
5
  GenericType = typing.TypeVar("GenericType")
5
6
 
6
7
  class CLIP_OT_bundles_to_mesh(bpy_types.Operator):
7
- """ """
8
+ """Create vertex cloud using coordinates of reconstructed tracks"""
8
9
 
9
10
  bl_idname: typing.Any
10
- """ """
11
-
12
11
  bl_label: typing.Any
13
- """ """
14
-
15
12
  bl_options: typing.Any
16
- """ """
17
-
18
13
  bl_rna: typing.Any
19
- """ """
20
-
21
14
  id_data: typing.Any
22
- """ """
23
15
 
24
- def as_keywords(self, ignore):
25
- """
16
+ def as_keywords(self, ignore=()):
17
+ """Return a copy of the properties as a dictionary
26
18
 
27
19
  :param ignore:
28
20
  """
29
21
  ...
30
22
 
31
- def as_pointer(self):
32
- """ """
23
+ def as_pointer(self) -> int:
24
+ """Returns the memory address which holds a pointer to Blender's internal data
25
+
26
+ :return: int (memory address).
27
+ :rtype: int
28
+ """
33
29
  ...
34
30
 
35
- def bl_rna_get_subclass(self):
36
- """ """
31
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
32
+ """
33
+
34
+ :return: The RNA type or default when not found.
35
+ :rtype: bpy.types.Struct
36
+ """
37
37
  ...
38
38
 
39
- def bl_rna_get_subclass_py(self):
40
- """ """
39
+ def bl_rna_get_subclass_py(self) -> typing.Any:
40
+ """
41
+
42
+ :return: The class or default when not found.
43
+ :rtype: typing.Any
44
+ """
41
45
  ...
42
46
 
43
- def driver_add(self):
44
- """ """
47
+ def driver_add(self) -> bpy.types.FCurve:
48
+ """Adds driver(s) to the given property
49
+
50
+ :return: The driver(s) added.
51
+ :rtype: bpy.types.FCurve
52
+ """
45
53
  ...
46
54
 
47
- def driver_remove(self):
48
- """ """
55
+ def driver_remove(self) -> bool:
56
+ """Remove driver(s) from the given property
57
+
58
+ :return: Success of driver removal.
59
+ :rtype: bool
60
+ """
49
61
  ...
50
62
 
51
63
  def execute(self, context):
@@ -56,59 +68,108 @@ class CLIP_OT_bundles_to_mesh(bpy_types.Operator):
56
68
  ...
57
69
 
58
70
  def get(self):
59
- """ """
71
+ """Returns the value of the custom property assigned to key or default
72
+ when not found (matches Python's dictionary function of the same name).
73
+
74
+ """
60
75
  ...
61
76
 
62
77
  def id_properties_clear(self):
63
- """ """
78
+ """
79
+
80
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
81
+ """
64
82
  ...
65
83
 
66
84
  def id_properties_ensure(self):
67
- """ """
85
+ """
86
+
87
+ :return: the parent group for an RNA struct's custom IDProperties.
88
+ """
68
89
  ...
69
90
 
70
91
  def id_properties_ui(self):
71
- """ """
92
+ """
93
+
94
+ :return: Return an object used to manage an IDProperty's UI data.
95
+ """
72
96
  ...
73
97
 
74
- def is_property_hidden(self):
75
- """ """
98
+ def is_property_hidden(self) -> bool:
99
+ """Check if a property is hidden.
100
+
101
+ :return: True when the property is hidden.
102
+ :rtype: bool
103
+ """
76
104
  ...
77
105
 
78
- def is_property_overridable_library(self):
79
- """ """
106
+ def is_property_overridable_library(self) -> bool:
107
+ """Check if a property is overridable.
108
+
109
+ :return: True when the property is overridable.
110
+ :rtype: bool
111
+ """
80
112
  ...
81
113
 
82
- def is_property_readonly(self):
83
- """ """
114
+ def is_property_readonly(self) -> bool:
115
+ """Check if a property is readonly.
116
+
117
+ :return: True when the property is readonly (not writable).
118
+ :rtype: bool
119
+ """
84
120
  ...
85
121
 
86
- def is_property_set(self):
87
- """ """
122
+ def is_property_set(self) -> bool:
123
+ """Check if a property is set, use for testing operator properties.
124
+
125
+ :return: True when the property has been set.
126
+ :rtype: bool
127
+ """
88
128
  ...
89
129
 
90
130
  def items(self):
91
- """ """
131
+ """Returns the items of this objects custom properties (matches Python's
132
+ dictionary function of the same name).
133
+
134
+ :return: custom property key, value pairs.
135
+ """
92
136
  ...
93
137
 
94
- def keyframe_delete(self):
95
- """ """
138
+ def keyframe_delete(self) -> bool:
139
+ """Remove a keyframe from this properties fcurve.
140
+
141
+ :return: Success of keyframe deletion.
142
+ :rtype: bool
143
+ """
96
144
  ...
97
145
 
98
- def keyframe_insert(self):
99
- """ """
146
+ def keyframe_insert(self) -> bool:
147
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
148
+
149
+ :return: Success of keyframe insertion.
150
+ :rtype: bool
151
+ """
100
152
  ...
101
153
 
102
154
  def keys(self):
103
- """ """
155
+ """Returns the keys of this objects custom properties (matches Python's
156
+ dictionary function of the same name).
157
+
158
+ :return: custom property keys.
159
+ """
104
160
  ...
105
161
 
106
- def path_from_id(self):
107
- """ """
162
+ def path_from_id(self) -> str:
163
+ """Returns the data path from the ID to this object (string).
164
+
165
+ :return: The path from `bpy.types.bpy_struct.id_data`
166
+ to this struct and property (when given).
167
+ :rtype: str
168
+ """
108
169
  ...
109
170
 
110
171
  def path_resolve(self):
111
- """ """
172
+ """Returns the property from the path, raise an exception when not found."""
112
173
  ...
113
174
 
114
175
  def poll(self, context):
@@ -119,72 +180,98 @@ class CLIP_OT_bundles_to_mesh(bpy_types.Operator):
119
180
  ...
120
181
 
121
182
  def poll_message_set(self):
122
- """ """
183
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
123
184
  ...
124
185
 
125
186
  def pop(self):
126
- """ """
187
+ """Remove and return the value of the custom property assigned to key or default
188
+ when not found (matches Python's dictionary function of the same name).
189
+
190
+ """
127
191
  ...
128
192
 
129
- def property_overridable_library_set(self):
130
- """ """
193
+ def property_overridable_library_set(self) -> bool:
194
+ """Define a property as overridable or not (only for custom properties!).
195
+
196
+ :return: True when the overridable status of the property was successfully set.
197
+ :rtype: bool
198
+ """
131
199
  ...
132
200
 
133
201
  def property_unset(self):
134
- """ """
202
+ """Unset a property, will use default value afterward."""
135
203
  ...
136
204
 
137
205
  def type_recast(self):
138
- """ """
206
+ """Return a new instance, this is needed because types
207
+ such as textures can be changed at runtime.
208
+
209
+ :return: a new instance of this object with the type initialized again.
210
+ """
139
211
  ...
140
212
 
141
213
  def values(self):
142
- """ """
214
+ """Returns the values of this objects custom properties (matches Python's
215
+ dictionary function of the same name).
216
+
217
+ :return: custom property values.
218
+ """
143
219
  ...
144
220
 
145
221
  class CLIP_OT_constraint_to_fcurve(bpy_types.Operator):
146
- """ """
222
+ """Create F-Curves for object which will copy object's movement caused by this constraint"""
147
223
 
148
224
  bl_idname: typing.Any
149
- """ """
150
-
151
225
  bl_label: typing.Any
152
- """ """
153
-
154
226
  bl_options: typing.Any
155
- """ """
156
-
157
227
  bl_rna: typing.Any
158
- """ """
159
-
160
228
  id_data: typing.Any
161
- """ """
162
229
 
163
- def as_keywords(self, ignore):
164
- """
230
+ def as_keywords(self, ignore=()):
231
+ """Return a copy of the properties as a dictionary
165
232
 
166
233
  :param ignore:
167
234
  """
168
235
  ...
169
236
 
170
- def as_pointer(self):
171
- """ """
237
+ def as_pointer(self) -> int:
238
+ """Returns the memory address which holds a pointer to Blender's internal data
239
+
240
+ :return: int (memory address).
241
+ :rtype: int
242
+ """
172
243
  ...
173
244
 
174
- def bl_rna_get_subclass(self):
175
- """ """
245
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
246
+ """
247
+
248
+ :return: The RNA type or default when not found.
249
+ :rtype: bpy.types.Struct
250
+ """
176
251
  ...
177
252
 
178
- def bl_rna_get_subclass_py(self):
179
- """ """
253
+ def bl_rna_get_subclass_py(self) -> typing.Any:
254
+ """
255
+
256
+ :return: The class or default when not found.
257
+ :rtype: typing.Any
258
+ """
180
259
  ...
181
260
 
182
- def driver_add(self):
183
- """ """
261
+ def driver_add(self) -> bpy.types.FCurve:
262
+ """Adds driver(s) to the given property
263
+
264
+ :return: The driver(s) added.
265
+ :rtype: bpy.types.FCurve
266
+ """
184
267
  ...
185
268
 
186
- def driver_remove(self):
187
- """ """
269
+ def driver_remove(self) -> bool:
270
+ """Remove driver(s) from the given property
271
+
272
+ :return: Success of driver removal.
273
+ :rtype: bool
274
+ """
188
275
  ...
189
276
 
190
277
  def execute(self, context):
@@ -195,128 +282,203 @@ class CLIP_OT_constraint_to_fcurve(bpy_types.Operator):
195
282
  ...
196
283
 
197
284
  def get(self):
198
- """ """
285
+ """Returns the value of the custom property assigned to key or default
286
+ when not found (matches Python's dictionary function of the same name).
287
+
288
+ """
199
289
  ...
200
290
 
201
291
  def id_properties_clear(self):
202
- """ """
292
+ """
293
+
294
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
295
+ """
203
296
  ...
204
297
 
205
298
  def id_properties_ensure(self):
206
- """ """
299
+ """
300
+
301
+ :return: the parent group for an RNA struct's custom IDProperties.
302
+ """
207
303
  ...
208
304
 
209
305
  def id_properties_ui(self):
210
- """ """
306
+ """
307
+
308
+ :return: Return an object used to manage an IDProperty's UI data.
309
+ """
211
310
  ...
212
311
 
213
- def is_property_hidden(self):
214
- """ """
312
+ def is_property_hidden(self) -> bool:
313
+ """Check if a property is hidden.
314
+
315
+ :return: True when the property is hidden.
316
+ :rtype: bool
317
+ """
215
318
  ...
216
319
 
217
- def is_property_overridable_library(self):
218
- """ """
320
+ def is_property_overridable_library(self) -> bool:
321
+ """Check if a property is overridable.
322
+
323
+ :return: True when the property is overridable.
324
+ :rtype: bool
325
+ """
219
326
  ...
220
327
 
221
- def is_property_readonly(self):
222
- """ """
328
+ def is_property_readonly(self) -> bool:
329
+ """Check if a property is readonly.
330
+
331
+ :return: True when the property is readonly (not writable).
332
+ :rtype: bool
333
+ """
223
334
  ...
224
335
 
225
- def is_property_set(self):
226
- """ """
336
+ def is_property_set(self) -> bool:
337
+ """Check if a property is set, use for testing operator properties.
338
+
339
+ :return: True when the property has been set.
340
+ :rtype: bool
341
+ """
227
342
  ...
228
343
 
229
344
  def items(self):
230
- """ """
345
+ """Returns the items of this objects custom properties (matches Python's
346
+ dictionary function of the same name).
347
+
348
+ :return: custom property key, value pairs.
349
+ """
231
350
  ...
232
351
 
233
- def keyframe_delete(self):
234
- """ """
352
+ def keyframe_delete(self) -> bool:
353
+ """Remove a keyframe from this properties fcurve.
354
+
355
+ :return: Success of keyframe deletion.
356
+ :rtype: bool
357
+ """
235
358
  ...
236
359
 
237
- def keyframe_insert(self):
238
- """ """
360
+ def keyframe_insert(self) -> bool:
361
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
362
+
363
+ :return: Success of keyframe insertion.
364
+ :rtype: bool
365
+ """
239
366
  ...
240
367
 
241
368
  def keys(self):
242
- """ """
369
+ """Returns the keys of this objects custom properties (matches Python's
370
+ dictionary function of the same name).
371
+
372
+ :return: custom property keys.
373
+ """
243
374
  ...
244
375
 
245
- def path_from_id(self):
246
- """ """
376
+ def path_from_id(self) -> str:
377
+ """Returns the data path from the ID to this object (string).
378
+
379
+ :return: The path from `bpy.types.bpy_struct.id_data`
380
+ to this struct and property (when given).
381
+ :rtype: str
382
+ """
247
383
  ...
248
384
 
249
385
  def path_resolve(self):
250
- """ """
386
+ """Returns the property from the path, raise an exception when not found."""
251
387
  ...
252
388
 
253
389
  def poll_message_set(self):
254
- """ """
390
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
255
391
  ...
256
392
 
257
393
  def pop(self):
258
- """ """
394
+ """Remove and return the value of the custom property assigned to key or default
395
+ when not found (matches Python's dictionary function of the same name).
396
+
397
+ """
259
398
  ...
260
399
 
261
- def property_overridable_library_set(self):
262
- """ """
400
+ def property_overridable_library_set(self) -> bool:
401
+ """Define a property as overridable or not (only for custom properties!).
402
+
403
+ :return: True when the overridable status of the property was successfully set.
404
+ :rtype: bool
405
+ """
263
406
  ...
264
407
 
265
408
  def property_unset(self):
266
- """ """
409
+ """Unset a property, will use default value afterward."""
267
410
  ...
268
411
 
269
412
  def type_recast(self):
270
- """ """
413
+ """Return a new instance, this is needed because types
414
+ such as textures can be changed at runtime.
415
+
416
+ :return: a new instance of this object with the type initialized again.
417
+ """
271
418
  ...
272
419
 
273
420
  def values(self):
274
- """ """
421
+ """Returns the values of this objects custom properties (matches Python's
422
+ dictionary function of the same name).
423
+
424
+ :return: custom property values.
425
+ """
275
426
  ...
276
427
 
277
428
  class CLIP_OT_delete_proxy(bpy_types.Operator):
278
- """ """
429
+ """Delete movie clip proxy files from the hard drive"""
279
430
 
280
431
  bl_idname: typing.Any
281
- """ """
282
-
283
432
  bl_label: typing.Any
284
- """ """
285
-
286
433
  bl_options: typing.Any
287
- """ """
288
-
289
434
  bl_rna: typing.Any
290
- """ """
291
-
292
435
  id_data: typing.Any
293
- """ """
294
436
 
295
- def as_keywords(self, ignore):
296
- """
437
+ def as_keywords(self, ignore=()):
438
+ """Return a copy of the properties as a dictionary
297
439
 
298
440
  :param ignore:
299
441
  """
300
442
  ...
301
443
 
302
- def as_pointer(self):
303
- """ """
444
+ def as_pointer(self) -> int:
445
+ """Returns the memory address which holds a pointer to Blender's internal data
446
+
447
+ :return: int (memory address).
448
+ :rtype: int
449
+ """
304
450
  ...
305
451
 
306
- def bl_rna_get_subclass(self):
307
- """ """
452
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
453
+ """
454
+
455
+ :return: The RNA type or default when not found.
456
+ :rtype: bpy.types.Struct
457
+ """
308
458
  ...
309
459
 
310
- def bl_rna_get_subclass_py(self):
311
- """ """
460
+ def bl_rna_get_subclass_py(self) -> typing.Any:
461
+ """
462
+
463
+ :return: The class or default when not found.
464
+ :rtype: typing.Any
465
+ """
312
466
  ...
313
467
 
314
- def driver_add(self):
315
- """ """
468
+ def driver_add(self) -> bpy.types.FCurve:
469
+ """Adds driver(s) to the given property
470
+
471
+ :return: The driver(s) added.
472
+ :rtype: bpy.types.FCurve
473
+ """
316
474
  ...
317
475
 
318
- def driver_remove(self):
319
- """ """
476
+ def driver_remove(self) -> bool:
477
+ """Remove driver(s) from the given property
478
+
479
+ :return: Success of driver removal.
480
+ :rtype: bool
481
+ """
320
482
  ...
321
483
 
322
484
  def execute(self, context):
@@ -327,19 +489,31 @@ class CLIP_OT_delete_proxy(bpy_types.Operator):
327
489
  ...
328
490
 
329
491
  def get(self):
330
- """ """
492
+ """Returns the value of the custom property assigned to key or default
493
+ when not found (matches Python's dictionary function of the same name).
494
+
495
+ """
331
496
  ...
332
497
 
333
498
  def id_properties_clear(self):
334
- """ """
499
+ """
500
+
501
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
502
+ """
335
503
  ...
336
504
 
337
505
  def id_properties_ensure(self):
338
- """ """
506
+ """
507
+
508
+ :return: the parent group for an RNA struct's custom IDProperties.
509
+ """
339
510
  ...
340
511
 
341
512
  def id_properties_ui(self):
342
- """ """
513
+ """
514
+
515
+ :return: Return an object used to manage an IDProperty's UI data.
516
+ """
343
517
  ...
344
518
 
345
519
  def invoke(self, context, event):
@@ -350,44 +524,81 @@ class CLIP_OT_delete_proxy(bpy_types.Operator):
350
524
  """
351
525
  ...
352
526
 
353
- def is_property_hidden(self):
354
- """ """
527
+ def is_property_hidden(self) -> bool:
528
+ """Check if a property is hidden.
529
+
530
+ :return: True when the property is hidden.
531
+ :rtype: bool
532
+ """
355
533
  ...
356
534
 
357
- def is_property_overridable_library(self):
358
- """ """
535
+ def is_property_overridable_library(self) -> bool:
536
+ """Check if a property is overridable.
537
+
538
+ :return: True when the property is overridable.
539
+ :rtype: bool
540
+ """
359
541
  ...
360
542
 
361
- def is_property_readonly(self):
362
- """ """
543
+ def is_property_readonly(self) -> bool:
544
+ """Check if a property is readonly.
545
+
546
+ :return: True when the property is readonly (not writable).
547
+ :rtype: bool
548
+ """
363
549
  ...
364
550
 
365
- def is_property_set(self):
366
- """ """
551
+ def is_property_set(self) -> bool:
552
+ """Check if a property is set, use for testing operator properties.
553
+
554
+ :return: True when the property has been set.
555
+ :rtype: bool
556
+ """
367
557
  ...
368
558
 
369
559
  def items(self):
370
- """ """
560
+ """Returns the items of this objects custom properties (matches Python's
561
+ dictionary function of the same name).
562
+
563
+ :return: custom property key, value pairs.
564
+ """
371
565
  ...
372
566
 
373
- def keyframe_delete(self):
374
- """ """
567
+ def keyframe_delete(self) -> bool:
568
+ """Remove a keyframe from this properties fcurve.
569
+
570
+ :return: Success of keyframe deletion.
571
+ :rtype: bool
572
+ """
375
573
  ...
376
574
 
377
- def keyframe_insert(self):
378
- """ """
575
+ def keyframe_insert(self) -> bool:
576
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
577
+
578
+ :return: Success of keyframe insertion.
579
+ :rtype: bool
580
+ """
379
581
  ...
380
582
 
381
583
  def keys(self):
382
- """ """
584
+ """Returns the keys of this objects custom properties (matches Python's
585
+ dictionary function of the same name).
586
+
587
+ :return: custom property keys.
588
+ """
383
589
  ...
384
590
 
385
- def path_from_id(self):
386
- """ """
591
+ def path_from_id(self) -> str:
592
+ """Returns the data path from the ID to this object (string).
593
+
594
+ :return: The path from `bpy.types.bpy_struct.id_data`
595
+ to this struct and property (when given).
596
+ :rtype: str
597
+ """
387
598
  ...
388
599
 
389
600
  def path_resolve(self):
390
- """ """
601
+ """Returns the property from the path, raise an exception when not found."""
391
602
  ...
392
603
 
393
604
  def poll(self, context):
@@ -398,72 +609,98 @@ class CLIP_OT_delete_proxy(bpy_types.Operator):
398
609
  ...
399
610
 
400
611
  def poll_message_set(self):
401
- """ """
612
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
402
613
  ...
403
614
 
404
615
  def pop(self):
405
- """ """
616
+ """Remove and return the value of the custom property assigned to key or default
617
+ when not found (matches Python's dictionary function of the same name).
618
+
619
+ """
406
620
  ...
407
621
 
408
- def property_overridable_library_set(self):
409
- """ """
622
+ def property_overridable_library_set(self) -> bool:
623
+ """Define a property as overridable or not (only for custom properties!).
624
+
625
+ :return: True when the overridable status of the property was successfully set.
626
+ :rtype: bool
627
+ """
410
628
  ...
411
629
 
412
630
  def property_unset(self):
413
- """ """
631
+ """Unset a property, will use default value afterward."""
414
632
  ...
415
633
 
416
634
  def type_recast(self):
417
- """ """
635
+ """Return a new instance, this is needed because types
636
+ such as textures can be changed at runtime.
637
+
638
+ :return: a new instance of this object with the type initialized again.
639
+ """
418
640
  ...
419
641
 
420
642
  def values(self):
421
- """ """
643
+ """Returns the values of this objects custom properties (matches Python's
644
+ dictionary function of the same name).
645
+
646
+ :return: custom property values.
647
+ """
422
648
  ...
423
649
 
424
650
  class CLIP_OT_filter_tracks(bpy_types.Operator):
425
- """ """
651
+ """Filter tracks which has weirdly looking spikes in motion curves"""
426
652
 
427
653
  bl_idname: typing.Any
428
- """ """
429
-
430
654
  bl_label: typing.Any
431
- """ """
432
-
433
655
  bl_options: typing.Any
434
- """ """
435
-
436
656
  bl_rna: typing.Any
437
- """ """
438
-
439
657
  id_data: typing.Any
440
- """ """
441
658
 
442
- def as_keywords(self, ignore):
443
- """
659
+ def as_keywords(self, ignore=()):
660
+ """Return a copy of the properties as a dictionary
444
661
 
445
662
  :param ignore:
446
663
  """
447
664
  ...
448
665
 
449
- def as_pointer(self):
450
- """ """
666
+ def as_pointer(self) -> int:
667
+ """Returns the memory address which holds a pointer to Blender's internal data
668
+
669
+ :return: int (memory address).
670
+ :rtype: int
671
+ """
451
672
  ...
452
673
 
453
- def bl_rna_get_subclass(self):
454
- """ """
674
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
675
+ """
676
+
677
+ :return: The RNA type or default when not found.
678
+ :rtype: bpy.types.Struct
679
+ """
455
680
  ...
456
681
 
457
- def bl_rna_get_subclass_py(self):
458
- """ """
682
+ def bl_rna_get_subclass_py(self) -> typing.Any:
683
+ """
684
+
685
+ :return: The class or default when not found.
686
+ :rtype: typing.Any
687
+ """
459
688
  ...
460
689
 
461
- def driver_add(self):
462
- """ """
690
+ def driver_add(self) -> bpy.types.FCurve:
691
+ """Adds driver(s) to the given property
692
+
693
+ :return: The driver(s) added.
694
+ :rtype: bpy.types.FCurve
695
+ """
463
696
  ...
464
697
 
465
- def driver_remove(self):
466
- """ """
698
+ def driver_remove(self) -> bool:
699
+ """Remove driver(s) from the given property
700
+
701
+ :return: Success of driver removal.
702
+ :rtype: bool
703
+ """
467
704
  ...
468
705
 
469
706
  def execute(self, context):
@@ -474,59 +711,108 @@ class CLIP_OT_filter_tracks(bpy_types.Operator):
474
711
  ...
475
712
 
476
713
  def get(self):
477
- """ """
714
+ """Returns the value of the custom property assigned to key or default
715
+ when not found (matches Python's dictionary function of the same name).
716
+
717
+ """
478
718
  ...
479
719
 
480
720
  def id_properties_clear(self):
481
- """ """
721
+ """
722
+
723
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
724
+ """
482
725
  ...
483
726
 
484
727
  def id_properties_ensure(self):
485
- """ """
728
+ """
729
+
730
+ :return: the parent group for an RNA struct's custom IDProperties.
731
+ """
486
732
  ...
487
733
 
488
734
  def id_properties_ui(self):
489
- """ """
735
+ """
736
+
737
+ :return: Return an object used to manage an IDProperty's UI data.
738
+ """
490
739
  ...
491
740
 
492
- def is_property_hidden(self):
493
- """ """
741
+ def is_property_hidden(self) -> bool:
742
+ """Check if a property is hidden.
743
+
744
+ :return: True when the property is hidden.
745
+ :rtype: bool
746
+ """
494
747
  ...
495
748
 
496
- def is_property_overridable_library(self):
497
- """ """
749
+ def is_property_overridable_library(self) -> bool:
750
+ """Check if a property is overridable.
751
+
752
+ :return: True when the property is overridable.
753
+ :rtype: bool
754
+ """
498
755
  ...
499
756
 
500
- def is_property_readonly(self):
501
- """ """
757
+ def is_property_readonly(self) -> bool:
758
+ """Check if a property is readonly.
759
+
760
+ :return: True when the property is readonly (not writable).
761
+ :rtype: bool
762
+ """
502
763
  ...
503
764
 
504
- def is_property_set(self):
505
- """ """
765
+ def is_property_set(self) -> bool:
766
+ """Check if a property is set, use for testing operator properties.
767
+
768
+ :return: True when the property has been set.
769
+ :rtype: bool
770
+ """
506
771
  ...
507
772
 
508
773
  def items(self):
509
- """ """
774
+ """Returns the items of this objects custom properties (matches Python's
775
+ dictionary function of the same name).
776
+
777
+ :return: custom property key, value pairs.
778
+ """
510
779
  ...
511
780
 
512
- def keyframe_delete(self):
513
- """ """
781
+ def keyframe_delete(self) -> bool:
782
+ """Remove a keyframe from this properties fcurve.
783
+
784
+ :return: Success of keyframe deletion.
785
+ :rtype: bool
786
+ """
514
787
  ...
515
788
 
516
- def keyframe_insert(self):
517
- """ """
789
+ def keyframe_insert(self) -> bool:
790
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
791
+
792
+ :return: Success of keyframe insertion.
793
+ :rtype: bool
794
+ """
518
795
  ...
519
796
 
520
797
  def keys(self):
521
- """ """
798
+ """Returns the keys of this objects custom properties (matches Python's
799
+ dictionary function of the same name).
800
+
801
+ :return: custom property keys.
802
+ """
522
803
  ...
523
804
 
524
- def path_from_id(self):
525
- """ """
805
+ def path_from_id(self) -> str:
806
+ """Returns the data path from the ID to this object (string).
807
+
808
+ :return: The path from `bpy.types.bpy_struct.id_data`
809
+ to this struct and property (when given).
810
+ :rtype: str
811
+ """
526
812
  ...
527
813
 
528
814
  def path_resolve(self):
529
- """ """
815
+ """Returns the property from the path, raise an exception when not found."""
530
816
  ...
531
817
 
532
818
  def poll(self, context):
@@ -537,69 +823,95 @@ class CLIP_OT_filter_tracks(bpy_types.Operator):
537
823
  ...
538
824
 
539
825
  def poll_message_set(self):
540
- """ """
826
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
541
827
  ...
542
828
 
543
829
  def pop(self):
544
- """ """
830
+ """Remove and return the value of the custom property assigned to key or default
831
+ when not found (matches Python's dictionary function of the same name).
832
+
833
+ """
545
834
  ...
546
835
 
547
- def property_overridable_library_set(self):
548
- """ """
836
+ def property_overridable_library_set(self) -> bool:
837
+ """Define a property as overridable or not (only for custom properties!).
838
+
839
+ :return: True when the overridable status of the property was successfully set.
840
+ :rtype: bool
841
+ """
549
842
  ...
550
843
 
551
844
  def property_unset(self):
552
- """ """
845
+ """Unset a property, will use default value afterward."""
553
846
  ...
554
847
 
555
848
  def type_recast(self):
556
- """ """
849
+ """Return a new instance, this is needed because types
850
+ such as textures can be changed at runtime.
851
+
852
+ :return: a new instance of this object with the type initialized again.
853
+ """
557
854
  ...
558
855
 
559
856
  def values(self):
560
- """ """
857
+ """Returns the values of this objects custom properties (matches Python's
858
+ dictionary function of the same name).
859
+
860
+ :return: custom property values.
861
+ """
561
862
  ...
562
863
 
563
864
  class CLIP_OT_set_active_clip(bpy_types.Operator):
564
- """ """
565
-
566
865
  bl_idname: typing.Any
567
- """ """
568
-
569
866
  bl_label: typing.Any
570
- """ """
571
-
572
867
  bl_rna: typing.Any
573
- """ """
574
-
575
868
  id_data: typing.Any
576
- """ """
577
869
 
578
- def as_keywords(self, ignore):
579
- """
870
+ def as_keywords(self, ignore=()):
871
+ """Return a copy of the properties as a dictionary
580
872
 
581
873
  :param ignore:
582
874
  """
583
875
  ...
584
876
 
585
- def as_pointer(self):
586
- """ """
877
+ def as_pointer(self) -> int:
878
+ """Returns the memory address which holds a pointer to Blender's internal data
879
+
880
+ :return: int (memory address).
881
+ :rtype: int
882
+ """
587
883
  ...
588
884
 
589
- def bl_rna_get_subclass(self):
590
- """ """
885
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
886
+ """
887
+
888
+ :return: The RNA type or default when not found.
889
+ :rtype: bpy.types.Struct
890
+ """
591
891
  ...
592
892
 
593
- def bl_rna_get_subclass_py(self):
594
- """ """
893
+ def bl_rna_get_subclass_py(self) -> typing.Any:
894
+ """
895
+
896
+ :return: The class or default when not found.
897
+ :rtype: typing.Any
898
+ """
595
899
  ...
596
900
 
597
- def driver_add(self):
598
- """ """
901
+ def driver_add(self) -> bpy.types.FCurve:
902
+ """Adds driver(s) to the given property
903
+
904
+ :return: The driver(s) added.
905
+ :rtype: bpy.types.FCurve
906
+ """
599
907
  ...
600
908
 
601
- def driver_remove(self):
602
- """ """
909
+ def driver_remove(self) -> bool:
910
+ """Remove driver(s) from the given property
911
+
912
+ :return: Success of driver removal.
913
+ :rtype: bool
914
+ """
603
915
  ...
604
916
 
605
917
  def execute(self, context):
@@ -610,59 +922,108 @@ class CLIP_OT_set_active_clip(bpy_types.Operator):
610
922
  ...
611
923
 
612
924
  def get(self):
613
- """ """
925
+ """Returns the value of the custom property assigned to key or default
926
+ when not found (matches Python's dictionary function of the same name).
927
+
928
+ """
614
929
  ...
615
930
 
616
931
  def id_properties_clear(self):
617
- """ """
932
+ """
933
+
934
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
935
+ """
618
936
  ...
619
937
 
620
938
  def id_properties_ensure(self):
621
- """ """
939
+ """
940
+
941
+ :return: the parent group for an RNA struct's custom IDProperties.
942
+ """
622
943
  ...
623
944
 
624
945
  def id_properties_ui(self):
625
- """ """
946
+ """
947
+
948
+ :return: Return an object used to manage an IDProperty's UI data.
949
+ """
626
950
  ...
627
951
 
628
- def is_property_hidden(self):
629
- """ """
952
+ def is_property_hidden(self) -> bool:
953
+ """Check if a property is hidden.
954
+
955
+ :return: True when the property is hidden.
956
+ :rtype: bool
957
+ """
630
958
  ...
631
959
 
632
- def is_property_overridable_library(self):
633
- """ """
960
+ def is_property_overridable_library(self) -> bool:
961
+ """Check if a property is overridable.
962
+
963
+ :return: True when the property is overridable.
964
+ :rtype: bool
965
+ """
634
966
  ...
635
967
 
636
- def is_property_readonly(self):
637
- """ """
968
+ def is_property_readonly(self) -> bool:
969
+ """Check if a property is readonly.
970
+
971
+ :return: True when the property is readonly (not writable).
972
+ :rtype: bool
973
+ """
638
974
  ...
639
975
 
640
- def is_property_set(self):
641
- """ """
976
+ def is_property_set(self) -> bool:
977
+ """Check if a property is set, use for testing operator properties.
978
+
979
+ :return: True when the property has been set.
980
+ :rtype: bool
981
+ """
642
982
  ...
643
983
 
644
984
  def items(self):
645
- """ """
985
+ """Returns the items of this objects custom properties (matches Python's
986
+ dictionary function of the same name).
987
+
988
+ :return: custom property key, value pairs.
989
+ """
646
990
  ...
647
991
 
648
- def keyframe_delete(self):
649
- """ """
992
+ def keyframe_delete(self) -> bool:
993
+ """Remove a keyframe from this properties fcurve.
994
+
995
+ :return: Success of keyframe deletion.
996
+ :rtype: bool
997
+ """
650
998
  ...
651
999
 
652
- def keyframe_insert(self):
653
- """ """
1000
+ def keyframe_insert(self) -> bool:
1001
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1002
+
1003
+ :return: Success of keyframe insertion.
1004
+ :rtype: bool
1005
+ """
654
1006
  ...
655
1007
 
656
1008
  def keys(self):
657
- """ """
1009
+ """Returns the keys of this objects custom properties (matches Python's
1010
+ dictionary function of the same name).
1011
+
1012
+ :return: custom property keys.
1013
+ """
658
1014
  ...
659
1015
 
660
- def path_from_id(self):
661
- """ """
1016
+ def path_from_id(self) -> str:
1017
+ """Returns the data path from the ID to this object (string).
1018
+
1019
+ :return: The path from `bpy.types.bpy_struct.id_data`
1020
+ to this struct and property (when given).
1021
+ :rtype: str
1022
+ """
662
1023
  ...
663
1024
 
664
1025
  def path_resolve(self):
665
- """ """
1026
+ """Returns the property from the path, raise an exception when not found."""
666
1027
  ...
667
1028
 
668
1029
  def poll(self, context):
@@ -673,135 +1034,210 @@ class CLIP_OT_set_active_clip(bpy_types.Operator):
673
1034
  ...
674
1035
 
675
1036
  def poll_message_set(self):
676
- """ """
1037
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
677
1038
  ...
678
1039
 
679
1040
  def pop(self):
680
- """ """
1041
+ """Remove and return the value of the custom property assigned to key or default
1042
+ when not found (matches Python's dictionary function of the same name).
1043
+
1044
+ """
681
1045
  ...
682
1046
 
683
- def property_overridable_library_set(self):
684
- """ """
1047
+ def property_overridable_library_set(self) -> bool:
1048
+ """Define a property as overridable or not (only for custom properties!).
1049
+
1050
+ :return: True when the overridable status of the property was successfully set.
1051
+ :rtype: bool
1052
+ """
685
1053
  ...
686
1054
 
687
1055
  def property_unset(self):
688
- """ """
1056
+ """Unset a property, will use default value afterward."""
689
1057
  ...
690
1058
 
691
1059
  def type_recast(self):
692
- """ """
1060
+ """Return a new instance, this is needed because types
1061
+ such as textures can be changed at runtime.
1062
+
1063
+ :return: a new instance of this object with the type initialized again.
1064
+ """
693
1065
  ...
694
1066
 
695
1067
  def values(self):
696
- """ """
1068
+ """Returns the values of this objects custom properties (matches Python's
1069
+ dictionary function of the same name).
1070
+
1071
+ :return: custom property values.
1072
+ """
697
1073
  ...
698
1074
 
699
1075
  class CLIP_OT_set_viewport_background(bpy_types.Operator):
700
- """ """
1076
+ """Set current movie clip as a camera background in 3D Viewport (works only when a 3D Viewport is visible)"""
701
1077
 
702
1078
  bl_idname: typing.Any
703
- """ """
704
-
705
1079
  bl_label: typing.Any
706
- """ """
707
-
708
1080
  bl_options: typing.Any
709
- """ """
710
-
711
1081
  bl_rna: typing.Any
712
- """ """
713
-
714
1082
  id_data: typing.Any
715
- """ """
716
1083
 
717
- def as_keywords(self, ignore):
718
- """
1084
+ def as_keywords(self, ignore=()):
1085
+ """Return a copy of the properties as a dictionary
719
1086
 
720
1087
  :param ignore:
721
1088
  """
722
1089
  ...
723
1090
 
724
- def as_pointer(self):
725
- """ """
1091
+ def as_pointer(self) -> int:
1092
+ """Returns the memory address which holds a pointer to Blender's internal data
1093
+
1094
+ :return: int (memory address).
1095
+ :rtype: int
1096
+ """
726
1097
  ...
727
1098
 
728
- def bl_rna_get_subclass(self):
729
- """ """
1099
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1100
+ """
1101
+
1102
+ :return: The RNA type or default when not found.
1103
+ :rtype: bpy.types.Struct
1104
+ """
730
1105
  ...
731
1106
 
732
- def bl_rna_get_subclass_py(self):
733
- """ """
1107
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1108
+ """
1109
+
1110
+ :return: The class or default when not found.
1111
+ :rtype: typing.Any
1112
+ """
734
1113
  ...
735
1114
 
736
- def driver_add(self):
737
- """ """
1115
+ def driver_add(self) -> bpy.types.FCurve:
1116
+ """Adds driver(s) to the given property
1117
+
1118
+ :return: The driver(s) added.
1119
+ :rtype: bpy.types.FCurve
1120
+ """
738
1121
  ...
739
1122
 
740
- def driver_remove(self):
741
- """ """
1123
+ def driver_remove(self) -> bool:
1124
+ """Remove driver(s) from the given property
1125
+
1126
+ :return: Success of driver removal.
1127
+ :rtype: bool
1128
+ """
742
1129
  ...
743
1130
 
744
1131
  def execute(self, context):
745
1132
  """
746
1133
 
747
- :param context:
1134
+ :param context:
1135
+ """
1136
+ ...
1137
+
1138
+ def get(self):
1139
+ """Returns the value of the custom property assigned to key or default
1140
+ when not found (matches Python's dictionary function of the same name).
1141
+
1142
+ """
1143
+ ...
1144
+
1145
+ def id_properties_clear(self):
1146
+ """
1147
+
1148
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1149
+ """
1150
+ ...
1151
+
1152
+ def id_properties_ensure(self):
1153
+ """
1154
+
1155
+ :return: the parent group for an RNA struct's custom IDProperties.
1156
+ """
1157
+ ...
1158
+
1159
+ def id_properties_ui(self):
1160
+ """
1161
+
1162
+ :return: Return an object used to manage an IDProperty's UI data.
748
1163
  """
749
1164
  ...
750
1165
 
751
- def get(self):
752
- """ """
753
- ...
1166
+ def is_property_hidden(self) -> bool:
1167
+ """Check if a property is hidden.
754
1168
 
755
- def id_properties_clear(self):
756
- """ """
1169
+ :return: True when the property is hidden.
1170
+ :rtype: bool
1171
+ """
757
1172
  ...
758
1173
 
759
- def id_properties_ensure(self):
760
- """ """
761
- ...
1174
+ def is_property_overridable_library(self) -> bool:
1175
+ """Check if a property is overridable.
762
1176
 
763
- def id_properties_ui(self):
764
- """ """
1177
+ :return: True when the property is overridable.
1178
+ :rtype: bool
1179
+ """
765
1180
  ...
766
1181
 
767
- def is_property_hidden(self):
768
- """ """
769
- ...
1182
+ def is_property_readonly(self) -> bool:
1183
+ """Check if a property is readonly.
770
1184
 
771
- def is_property_overridable_library(self):
772
- """ """
1185
+ :return: True when the property is readonly (not writable).
1186
+ :rtype: bool
1187
+ """
773
1188
  ...
774
1189
 
775
- def is_property_readonly(self):
776
- """ """
777
- ...
1190
+ def is_property_set(self) -> bool:
1191
+ """Check if a property is set, use for testing operator properties.
778
1192
 
779
- def is_property_set(self):
780
- """ """
1193
+ :return: True when the property has been set.
1194
+ :rtype: bool
1195
+ """
781
1196
  ...
782
1197
 
783
1198
  def items(self):
784
- """ """
1199
+ """Returns the items of this objects custom properties (matches Python's
1200
+ dictionary function of the same name).
1201
+
1202
+ :return: custom property key, value pairs.
1203
+ """
785
1204
  ...
786
1205
 
787
- def keyframe_delete(self):
788
- """ """
1206
+ def keyframe_delete(self) -> bool:
1207
+ """Remove a keyframe from this properties fcurve.
1208
+
1209
+ :return: Success of keyframe deletion.
1210
+ :rtype: bool
1211
+ """
789
1212
  ...
790
1213
 
791
- def keyframe_insert(self):
792
- """ """
1214
+ def keyframe_insert(self) -> bool:
1215
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1216
+
1217
+ :return: Success of keyframe insertion.
1218
+ :rtype: bool
1219
+ """
793
1220
  ...
794
1221
 
795
1222
  def keys(self):
796
- """ """
1223
+ """Returns the keys of this objects custom properties (matches Python's
1224
+ dictionary function of the same name).
1225
+
1226
+ :return: custom property keys.
1227
+ """
797
1228
  ...
798
1229
 
799
- def path_from_id(self):
800
- """ """
1230
+ def path_from_id(self) -> str:
1231
+ """Returns the data path from the ID to this object (string).
1232
+
1233
+ :return: The path from `bpy.types.bpy_struct.id_data`
1234
+ to this struct and property (when given).
1235
+ :rtype: str
1236
+ """
801
1237
  ...
802
1238
 
803
1239
  def path_resolve(self):
804
- """ """
1240
+ """Returns the property from the path, raise an exception when not found."""
805
1241
  ...
806
1242
 
807
1243
  def poll(self, context):
@@ -812,64 +1248,82 @@ class CLIP_OT_set_viewport_background(bpy_types.Operator):
812
1248
  ...
813
1249
 
814
1250
  def poll_message_set(self):
815
- """ """
1251
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
816
1252
  ...
817
1253
 
818
1254
  def pop(self):
819
- """ """
1255
+ """Remove and return the value of the custom property assigned to key or default
1256
+ when not found (matches Python's dictionary function of the same name).
1257
+
1258
+ """
820
1259
  ...
821
1260
 
822
- def property_overridable_library_set(self):
823
- """ """
1261
+ def property_overridable_library_set(self) -> bool:
1262
+ """Define a property as overridable or not (only for custom properties!).
1263
+
1264
+ :return: True when the overridable status of the property was successfully set.
1265
+ :rtype: bool
1266
+ """
824
1267
  ...
825
1268
 
826
1269
  def property_unset(self):
827
- """ """
1270
+ """Unset a property, will use default value afterward."""
828
1271
  ...
829
1272
 
830
1273
  def type_recast(self):
831
- """ """
1274
+ """Return a new instance, this is needed because types
1275
+ such as textures can be changed at runtime.
1276
+
1277
+ :return: a new instance of this object with the type initialized again.
1278
+ """
832
1279
  ...
833
1280
 
834
1281
  def values(self):
835
- """ """
1282
+ """Returns the values of this objects custom properties (matches Python's
1283
+ dictionary function of the same name).
1284
+
1285
+ :return: custom property values.
1286
+ """
836
1287
  ...
837
1288
 
838
1289
  class CLIP_OT_setup_tracking_scene(bpy_types.Operator):
839
- """ """
1290
+ """Prepare scene for compositing 3D objects into this footage"""
840
1291
 
841
1292
  bl_idname: typing.Any
842
- """ """
843
-
844
1293
  bl_label: typing.Any
845
- """ """
846
-
847
1294
  bl_options: typing.Any
848
- """ """
849
-
850
1295
  bl_rna: typing.Any
851
- """ """
852
-
853
1296
  id_data: typing.Any
854
- """ """
855
1297
 
856
- def as_keywords(self, ignore):
857
- """
1298
+ def as_keywords(self, ignore=()):
1299
+ """Return a copy of the properties as a dictionary
858
1300
 
859
1301
  :param ignore:
860
1302
  """
861
1303
  ...
862
1304
 
863
- def as_pointer(self):
864
- """ """
1305
+ def as_pointer(self) -> int:
1306
+ """Returns the memory address which holds a pointer to Blender's internal data
1307
+
1308
+ :return: int (memory address).
1309
+ :rtype: int
1310
+ """
865
1311
  ...
866
1312
 
867
- def bl_rna_get_subclass(self):
868
- """ """
1313
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1314
+ """
1315
+
1316
+ :return: The RNA type or default when not found.
1317
+ :rtype: bpy.types.Struct
1318
+ """
869
1319
  ...
870
1320
 
871
- def bl_rna_get_subclass_py(self):
872
- """ """
1321
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1322
+ """
1323
+
1324
+ :return: The class or default when not found.
1325
+ :rtype: typing.Any
1326
+ """
873
1327
  ...
874
1328
 
875
1329
  def createCollection(self, context, collection_name):
@@ -880,12 +1334,20 @@ class CLIP_OT_setup_tracking_scene(bpy_types.Operator):
880
1334
  """
881
1335
  ...
882
1336
 
883
- def driver_add(self):
884
- """ """
1337
+ def driver_add(self) -> bpy.types.FCurve:
1338
+ """Adds driver(s) to the given property
1339
+
1340
+ :return: The driver(s) added.
1341
+ :rtype: bpy.types.FCurve
1342
+ """
885
1343
  ...
886
1344
 
887
- def driver_remove(self):
888
- """ """
1345
+ def driver_remove(self) -> bool:
1346
+ """Remove driver(s) from the given property
1347
+
1348
+ :return: Success of driver removal.
1349
+ :rtype: bool
1350
+ """
889
1351
  ...
890
1352
 
891
1353
  def execute(self, context):
@@ -896,59 +1358,108 @@ class CLIP_OT_setup_tracking_scene(bpy_types.Operator):
896
1358
  ...
897
1359
 
898
1360
  def get(self):
899
- """ """
1361
+ """Returns the value of the custom property assigned to key or default
1362
+ when not found (matches Python's dictionary function of the same name).
1363
+
1364
+ """
900
1365
  ...
901
1366
 
902
1367
  def id_properties_clear(self):
903
- """ """
1368
+ """
1369
+
1370
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1371
+ """
904
1372
  ...
905
1373
 
906
1374
  def id_properties_ensure(self):
907
- """ """
1375
+ """
1376
+
1377
+ :return: the parent group for an RNA struct's custom IDProperties.
1378
+ """
908
1379
  ...
909
1380
 
910
1381
  def id_properties_ui(self):
911
- """ """
1382
+ """
1383
+
1384
+ :return: Return an object used to manage an IDProperty's UI data.
1385
+ """
912
1386
  ...
913
1387
 
914
- def is_property_hidden(self):
915
- """ """
1388
+ def is_property_hidden(self) -> bool:
1389
+ """Check if a property is hidden.
1390
+
1391
+ :return: True when the property is hidden.
1392
+ :rtype: bool
1393
+ """
916
1394
  ...
917
1395
 
918
- def is_property_overridable_library(self):
919
- """ """
1396
+ def is_property_overridable_library(self) -> bool:
1397
+ """Check if a property is overridable.
1398
+
1399
+ :return: True when the property is overridable.
1400
+ :rtype: bool
1401
+ """
920
1402
  ...
921
1403
 
922
- def is_property_readonly(self):
923
- """ """
1404
+ def is_property_readonly(self) -> bool:
1405
+ """Check if a property is readonly.
1406
+
1407
+ :return: True when the property is readonly (not writable).
1408
+ :rtype: bool
1409
+ """
924
1410
  ...
925
1411
 
926
- def is_property_set(self):
927
- """ """
1412
+ def is_property_set(self) -> bool:
1413
+ """Check if a property is set, use for testing operator properties.
1414
+
1415
+ :return: True when the property has been set.
1416
+ :rtype: bool
1417
+ """
928
1418
  ...
929
1419
 
930
1420
  def items(self):
931
- """ """
1421
+ """Returns the items of this objects custom properties (matches Python's
1422
+ dictionary function of the same name).
1423
+
1424
+ :return: custom property key, value pairs.
1425
+ """
932
1426
  ...
933
1427
 
934
- def keyframe_delete(self):
935
- """ """
1428
+ def keyframe_delete(self) -> bool:
1429
+ """Remove a keyframe from this properties fcurve.
1430
+
1431
+ :return: Success of keyframe deletion.
1432
+ :rtype: bool
1433
+ """
936
1434
  ...
937
1435
 
938
- def keyframe_insert(self):
939
- """ """
1436
+ def keyframe_insert(self) -> bool:
1437
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1438
+
1439
+ :return: Success of keyframe insertion.
1440
+ :rtype: bool
1441
+ """
940
1442
  ...
941
1443
 
942
1444
  def keys(self):
943
- """ """
1445
+ """Returns the keys of this objects custom properties (matches Python's
1446
+ dictionary function of the same name).
1447
+
1448
+ :return: custom property keys.
1449
+ """
944
1450
  ...
945
1451
 
946
- def path_from_id(self):
947
- """ """
1452
+ def path_from_id(self) -> str:
1453
+ """Returns the data path from the ID to this object (string).
1454
+
1455
+ :return: The path from `bpy.types.bpy_struct.id_data`
1456
+ to this struct and property (when given).
1457
+ :rtype: str
1458
+ """
948
1459
  ...
949
1460
 
950
1461
  def path_resolve(self):
951
- """ """
1462
+ """Returns the property from the path, raise an exception when not found."""
952
1463
  ...
953
1464
 
954
1465
  def poll(self, context):
@@ -959,72 +1470,98 @@ class CLIP_OT_setup_tracking_scene(bpy_types.Operator):
959
1470
  ...
960
1471
 
961
1472
  def poll_message_set(self):
962
- """ """
1473
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
963
1474
  ...
964
1475
 
965
1476
  def pop(self):
966
- """ """
1477
+ """Remove and return the value of the custom property assigned to key or default
1478
+ when not found (matches Python's dictionary function of the same name).
1479
+
1480
+ """
967
1481
  ...
968
1482
 
969
- def property_overridable_library_set(self):
970
- """ """
1483
+ def property_overridable_library_set(self) -> bool:
1484
+ """Define a property as overridable or not (only for custom properties!).
1485
+
1486
+ :return: True when the overridable status of the property was successfully set.
1487
+ :rtype: bool
1488
+ """
971
1489
  ...
972
1490
 
973
1491
  def property_unset(self):
974
- """ """
1492
+ """Unset a property, will use default value afterward."""
975
1493
  ...
976
1494
 
977
1495
  def type_recast(self):
978
- """ """
1496
+ """Return a new instance, this is needed because types
1497
+ such as textures can be changed at runtime.
1498
+
1499
+ :return: a new instance of this object with the type initialized again.
1500
+ """
979
1501
  ...
980
1502
 
981
1503
  def values(self):
982
- """ """
1504
+ """Returns the values of this objects custom properties (matches Python's
1505
+ dictionary function of the same name).
1506
+
1507
+ :return: custom property values.
1508
+ """
983
1509
  ...
984
1510
 
985
1511
  class CLIP_OT_track_settings_as_default(bpy_types.Operator):
986
- """ """
1512
+ """Copy tracking settings from active track to default settings"""
987
1513
 
988
1514
  bl_idname: typing.Any
989
- """ """
990
-
991
1515
  bl_label: typing.Any
992
- """ """
993
-
994
1516
  bl_options: typing.Any
995
- """ """
996
-
997
1517
  bl_rna: typing.Any
998
- """ """
999
-
1000
1518
  id_data: typing.Any
1001
- """ """
1002
1519
 
1003
- def as_keywords(self, ignore):
1004
- """
1520
+ def as_keywords(self, ignore=()):
1521
+ """Return a copy of the properties as a dictionary
1005
1522
 
1006
1523
  :param ignore:
1007
1524
  """
1008
1525
  ...
1009
1526
 
1010
- def as_pointer(self):
1011
- """ """
1527
+ def as_pointer(self) -> int:
1528
+ """Returns the memory address which holds a pointer to Blender's internal data
1529
+
1530
+ :return: int (memory address).
1531
+ :rtype: int
1532
+ """
1012
1533
  ...
1013
1534
 
1014
- def bl_rna_get_subclass(self):
1015
- """ """
1535
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1536
+ """
1537
+
1538
+ :return: The RNA type or default when not found.
1539
+ :rtype: bpy.types.Struct
1540
+ """
1016
1541
  ...
1017
1542
 
1018
- def bl_rna_get_subclass_py(self):
1019
- """ """
1543
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1544
+ """
1545
+
1546
+ :return: The class or default when not found.
1547
+ :rtype: typing.Any
1548
+ """
1020
1549
  ...
1021
1550
 
1022
- def driver_add(self):
1023
- """ """
1551
+ def driver_add(self) -> bpy.types.FCurve:
1552
+ """Adds driver(s) to the given property
1553
+
1554
+ :return: The driver(s) added.
1555
+ :rtype: bpy.types.FCurve
1556
+ """
1024
1557
  ...
1025
1558
 
1026
- def driver_remove(self):
1027
- """ """
1559
+ def driver_remove(self) -> bool:
1560
+ """Remove driver(s) from the given property
1561
+
1562
+ :return: Success of driver removal.
1563
+ :rtype: bool
1564
+ """
1028
1565
  ...
1029
1566
 
1030
1567
  def execute(self, context):
@@ -1035,59 +1572,108 @@ class CLIP_OT_track_settings_as_default(bpy_types.Operator):
1035
1572
  ...
1036
1573
 
1037
1574
  def get(self):
1038
- """ """
1575
+ """Returns the value of the custom property assigned to key or default
1576
+ when not found (matches Python's dictionary function of the same name).
1577
+
1578
+ """
1039
1579
  ...
1040
1580
 
1041
1581
  def id_properties_clear(self):
1042
- """ """
1582
+ """
1583
+
1584
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1585
+ """
1043
1586
  ...
1044
1587
 
1045
1588
  def id_properties_ensure(self):
1046
- """ """
1589
+ """
1590
+
1591
+ :return: the parent group for an RNA struct's custom IDProperties.
1592
+ """
1047
1593
  ...
1048
1594
 
1049
1595
  def id_properties_ui(self):
1050
- """ """
1596
+ """
1597
+
1598
+ :return: Return an object used to manage an IDProperty's UI data.
1599
+ """
1051
1600
  ...
1052
1601
 
1053
- def is_property_hidden(self):
1054
- """ """
1602
+ def is_property_hidden(self) -> bool:
1603
+ """Check if a property is hidden.
1604
+
1605
+ :return: True when the property is hidden.
1606
+ :rtype: bool
1607
+ """
1055
1608
  ...
1056
1609
 
1057
- def is_property_overridable_library(self):
1058
- """ """
1610
+ def is_property_overridable_library(self) -> bool:
1611
+ """Check if a property is overridable.
1612
+
1613
+ :return: True when the property is overridable.
1614
+ :rtype: bool
1615
+ """
1059
1616
  ...
1060
1617
 
1061
- def is_property_readonly(self):
1062
- """ """
1618
+ def is_property_readonly(self) -> bool:
1619
+ """Check if a property is readonly.
1620
+
1621
+ :return: True when the property is readonly (not writable).
1622
+ :rtype: bool
1623
+ """
1063
1624
  ...
1064
1625
 
1065
- def is_property_set(self):
1066
- """ """
1626
+ def is_property_set(self) -> bool:
1627
+ """Check if a property is set, use for testing operator properties.
1628
+
1629
+ :return: True when the property has been set.
1630
+ :rtype: bool
1631
+ """
1067
1632
  ...
1068
1633
 
1069
1634
  def items(self):
1070
- """ """
1635
+ """Returns the items of this objects custom properties (matches Python's
1636
+ dictionary function of the same name).
1637
+
1638
+ :return: custom property key, value pairs.
1639
+ """
1071
1640
  ...
1072
1641
 
1073
- def keyframe_delete(self):
1074
- """ """
1642
+ def keyframe_delete(self) -> bool:
1643
+ """Remove a keyframe from this properties fcurve.
1644
+
1645
+ :return: Success of keyframe deletion.
1646
+ :rtype: bool
1647
+ """
1075
1648
  ...
1076
1649
 
1077
- def keyframe_insert(self):
1078
- """ """
1650
+ def keyframe_insert(self) -> bool:
1651
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1652
+
1653
+ :return: Success of keyframe insertion.
1654
+ :rtype: bool
1655
+ """
1079
1656
  ...
1080
1657
 
1081
1658
  def keys(self):
1082
- """ """
1659
+ """Returns the keys of this objects custom properties (matches Python's
1660
+ dictionary function of the same name).
1661
+
1662
+ :return: custom property keys.
1663
+ """
1083
1664
  ...
1084
1665
 
1085
- def path_from_id(self):
1086
- """ """
1666
+ def path_from_id(self) -> str:
1667
+ """Returns the data path from the ID to this object (string).
1668
+
1669
+ :return: The path from `bpy.types.bpy_struct.id_data`
1670
+ to this struct and property (when given).
1671
+ :rtype: str
1672
+ """
1087
1673
  ...
1088
1674
 
1089
1675
  def path_resolve(self):
1090
- """ """
1676
+ """Returns the property from the path, raise an exception when not found."""
1091
1677
  ...
1092
1678
 
1093
1679
  def poll(self, context):
@@ -1098,72 +1684,98 @@ class CLIP_OT_track_settings_as_default(bpy_types.Operator):
1098
1684
  ...
1099
1685
 
1100
1686
  def poll_message_set(self):
1101
- """ """
1687
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
1102
1688
  ...
1103
1689
 
1104
1690
  def pop(self):
1105
- """ """
1691
+ """Remove and return the value of the custom property assigned to key or default
1692
+ when not found (matches Python's dictionary function of the same name).
1693
+
1694
+ """
1106
1695
  ...
1107
1696
 
1108
- def property_overridable_library_set(self):
1109
- """ """
1697
+ def property_overridable_library_set(self) -> bool:
1698
+ """Define a property as overridable or not (only for custom properties!).
1699
+
1700
+ :return: True when the overridable status of the property was successfully set.
1701
+ :rtype: bool
1702
+ """
1110
1703
  ...
1111
1704
 
1112
1705
  def property_unset(self):
1113
- """ """
1706
+ """Unset a property, will use default value afterward."""
1114
1707
  ...
1115
1708
 
1116
1709
  def type_recast(self):
1117
- """ """
1710
+ """Return a new instance, this is needed because types
1711
+ such as textures can be changed at runtime.
1712
+
1713
+ :return: a new instance of this object with the type initialized again.
1714
+ """
1118
1715
  ...
1119
1716
 
1120
1717
  def values(self):
1121
- """ """
1718
+ """Returns the values of this objects custom properties (matches Python's
1719
+ dictionary function of the same name).
1720
+
1721
+ :return: custom property values.
1722
+ """
1122
1723
  ...
1123
1724
 
1124
1725
  class CLIP_OT_track_settings_to_track(bpy_types.Operator):
1125
- """ """
1726
+ """Copy tracking settings from active track to selected tracks"""
1126
1727
 
1127
1728
  bl_idname: typing.Any
1128
- """ """
1129
-
1130
1729
  bl_label: typing.Any
1131
- """ """
1132
-
1133
1730
  bl_options: typing.Any
1134
- """ """
1135
-
1136
1731
  bl_rna: typing.Any
1137
- """ """
1138
-
1139
1732
  id_data: typing.Any
1140
- """ """
1141
1733
 
1142
- def as_keywords(self, ignore):
1143
- """
1734
+ def as_keywords(self, ignore=()):
1735
+ """Return a copy of the properties as a dictionary
1144
1736
 
1145
1737
  :param ignore:
1146
1738
  """
1147
1739
  ...
1148
1740
 
1149
- def as_pointer(self):
1150
- """ """
1741
+ def as_pointer(self) -> int:
1742
+ """Returns the memory address which holds a pointer to Blender's internal data
1743
+
1744
+ :return: int (memory address).
1745
+ :rtype: int
1746
+ """
1151
1747
  ...
1152
1748
 
1153
- def bl_rna_get_subclass(self):
1154
- """ """
1749
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1750
+ """
1751
+
1752
+ :return: The RNA type or default when not found.
1753
+ :rtype: bpy.types.Struct
1754
+ """
1155
1755
  ...
1156
1756
 
1157
- def bl_rna_get_subclass_py(self):
1158
- """ """
1757
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1758
+ """
1759
+
1760
+ :return: The class or default when not found.
1761
+ :rtype: typing.Any
1762
+ """
1159
1763
  ...
1160
1764
 
1161
- def driver_add(self):
1162
- """ """
1765
+ def driver_add(self) -> bpy.types.FCurve:
1766
+ """Adds driver(s) to the given property
1767
+
1768
+ :return: The driver(s) added.
1769
+ :rtype: bpy.types.FCurve
1770
+ """
1163
1771
  ...
1164
1772
 
1165
- def driver_remove(self):
1166
- """ """
1773
+ def driver_remove(self) -> bool:
1774
+ """Remove driver(s) from the given property
1775
+
1776
+ :return: Success of driver removal.
1777
+ :rtype: bool
1778
+ """
1167
1779
  ...
1168
1780
 
1169
1781
  def execute(self, context):
@@ -1174,59 +1786,108 @@ class CLIP_OT_track_settings_to_track(bpy_types.Operator):
1174
1786
  ...
1175
1787
 
1176
1788
  def get(self):
1177
- """ """
1789
+ """Returns the value of the custom property assigned to key or default
1790
+ when not found (matches Python's dictionary function of the same name).
1791
+
1792
+ """
1178
1793
  ...
1179
1794
 
1180
1795
  def id_properties_clear(self):
1181
- """ """
1796
+ """
1797
+
1798
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1799
+ """
1182
1800
  ...
1183
1801
 
1184
1802
  def id_properties_ensure(self):
1185
- """ """
1803
+ """
1804
+
1805
+ :return: the parent group for an RNA struct's custom IDProperties.
1806
+ """
1186
1807
  ...
1187
1808
 
1188
1809
  def id_properties_ui(self):
1189
- """ """
1810
+ """
1811
+
1812
+ :return: Return an object used to manage an IDProperty's UI data.
1813
+ """
1190
1814
  ...
1191
1815
 
1192
- def is_property_hidden(self):
1193
- """ """
1816
+ def is_property_hidden(self) -> bool:
1817
+ """Check if a property is hidden.
1818
+
1819
+ :return: True when the property is hidden.
1820
+ :rtype: bool
1821
+ """
1194
1822
  ...
1195
1823
 
1196
- def is_property_overridable_library(self):
1197
- """ """
1824
+ def is_property_overridable_library(self) -> bool:
1825
+ """Check if a property is overridable.
1826
+
1827
+ :return: True when the property is overridable.
1828
+ :rtype: bool
1829
+ """
1198
1830
  ...
1199
1831
 
1200
- def is_property_readonly(self):
1201
- """ """
1832
+ def is_property_readonly(self) -> bool:
1833
+ """Check if a property is readonly.
1834
+
1835
+ :return: True when the property is readonly (not writable).
1836
+ :rtype: bool
1837
+ """
1202
1838
  ...
1203
1839
 
1204
- def is_property_set(self):
1205
- """ """
1840
+ def is_property_set(self) -> bool:
1841
+ """Check if a property is set, use for testing operator properties.
1842
+
1843
+ :return: True when the property has been set.
1844
+ :rtype: bool
1845
+ """
1206
1846
  ...
1207
1847
 
1208
1848
  def items(self):
1209
- """ """
1849
+ """Returns the items of this objects custom properties (matches Python's
1850
+ dictionary function of the same name).
1851
+
1852
+ :return: custom property key, value pairs.
1853
+ """
1210
1854
  ...
1211
1855
 
1212
- def keyframe_delete(self):
1213
- """ """
1856
+ def keyframe_delete(self) -> bool:
1857
+ """Remove a keyframe from this properties fcurve.
1858
+
1859
+ :return: Success of keyframe deletion.
1860
+ :rtype: bool
1861
+ """
1214
1862
  ...
1215
1863
 
1216
- def keyframe_insert(self):
1217
- """ """
1864
+ def keyframe_insert(self) -> bool:
1865
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1866
+
1867
+ :return: Success of keyframe insertion.
1868
+ :rtype: bool
1869
+ """
1218
1870
  ...
1219
1871
 
1220
1872
  def keys(self):
1221
- """ """
1873
+ """Returns the keys of this objects custom properties (matches Python's
1874
+ dictionary function of the same name).
1875
+
1876
+ :return: custom property keys.
1877
+ """
1222
1878
  ...
1223
1879
 
1224
- def path_from_id(self):
1225
- """ """
1880
+ def path_from_id(self) -> str:
1881
+ """Returns the data path from the ID to this object (string).
1882
+
1883
+ :return: The path from `bpy.types.bpy_struct.id_data`
1884
+ to this struct and property (when given).
1885
+ :rtype: str
1886
+ """
1226
1887
  ...
1227
1888
 
1228
1889
  def path_resolve(self):
1229
- """ """
1890
+ """Returns the property from the path, raise an exception when not found."""
1230
1891
  ...
1231
1892
 
1232
1893
  def poll(self, context):
@@ -1237,72 +1898,98 @@ class CLIP_OT_track_settings_to_track(bpy_types.Operator):
1237
1898
  ...
1238
1899
 
1239
1900
  def poll_message_set(self):
1240
- """ """
1901
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
1241
1902
  ...
1242
1903
 
1243
1904
  def pop(self):
1244
- """ """
1905
+ """Remove and return the value of the custom property assigned to key or default
1906
+ when not found (matches Python's dictionary function of the same name).
1907
+
1908
+ """
1245
1909
  ...
1246
1910
 
1247
- def property_overridable_library_set(self):
1248
- """ """
1911
+ def property_overridable_library_set(self) -> bool:
1912
+ """Define a property as overridable or not (only for custom properties!).
1913
+
1914
+ :return: True when the overridable status of the property was successfully set.
1915
+ :rtype: bool
1916
+ """
1249
1917
  ...
1250
1918
 
1251
1919
  def property_unset(self):
1252
- """ """
1920
+ """Unset a property, will use default value afterward."""
1253
1921
  ...
1254
1922
 
1255
1923
  def type_recast(self):
1256
- """ """
1924
+ """Return a new instance, this is needed because types
1925
+ such as textures can be changed at runtime.
1926
+
1927
+ :return: a new instance of this object with the type initialized again.
1928
+ """
1257
1929
  ...
1258
1930
 
1259
1931
  def values(self):
1260
- """ """
1932
+ """Returns the values of this objects custom properties (matches Python's
1933
+ dictionary function of the same name).
1934
+
1935
+ :return: custom property values.
1936
+ """
1261
1937
  ...
1262
1938
 
1263
1939
  class CLIP_OT_track_to_empty(bpy_types.Operator):
1264
- """ """
1940
+ """Create an Empty object which will be copying movement of active track"""
1265
1941
 
1266
1942
  bl_idname: typing.Any
1267
- """ """
1268
-
1269
1943
  bl_label: typing.Any
1270
- """ """
1271
-
1272
1944
  bl_options: typing.Any
1273
- """ """
1274
-
1275
1945
  bl_rna: typing.Any
1276
- """ """
1277
-
1278
1946
  id_data: typing.Any
1279
- """ """
1280
1947
 
1281
- def as_keywords(self, ignore):
1282
- """
1948
+ def as_keywords(self, ignore=()):
1949
+ """Return a copy of the properties as a dictionary
1283
1950
 
1284
1951
  :param ignore:
1285
1952
  """
1286
1953
  ...
1287
1954
 
1288
- def as_pointer(self):
1289
- """ """
1955
+ def as_pointer(self) -> int:
1956
+ """Returns the memory address which holds a pointer to Blender's internal data
1957
+
1958
+ :return: int (memory address).
1959
+ :rtype: int
1960
+ """
1290
1961
  ...
1291
1962
 
1292
- def bl_rna_get_subclass(self):
1293
- """ """
1963
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1964
+ """
1965
+
1966
+ :return: The RNA type or default when not found.
1967
+ :rtype: bpy.types.Struct
1968
+ """
1294
1969
  ...
1295
1970
 
1296
- def bl_rna_get_subclass_py(self):
1297
- """ """
1971
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1972
+ """
1973
+
1974
+ :return: The class or default when not found.
1975
+ :rtype: typing.Any
1976
+ """
1298
1977
  ...
1299
1978
 
1300
- def driver_add(self):
1301
- """ """
1979
+ def driver_add(self) -> bpy.types.FCurve:
1980
+ """Adds driver(s) to the given property
1981
+
1982
+ :return: The driver(s) added.
1983
+ :rtype: bpy.types.FCurve
1984
+ """
1302
1985
  ...
1303
1986
 
1304
- def driver_remove(self):
1305
- """ """
1987
+ def driver_remove(self) -> bool:
1988
+ """Remove driver(s) from the given property
1989
+
1990
+ :return: Success of driver removal.
1991
+ :rtype: bool
1992
+ """
1306
1993
  ...
1307
1994
 
1308
1995
  def execute(self, context):
@@ -1313,59 +2000,108 @@ class CLIP_OT_track_to_empty(bpy_types.Operator):
1313
2000
  ...
1314
2001
 
1315
2002
  def get(self):
1316
- """ """
2003
+ """Returns the value of the custom property assigned to key or default
2004
+ when not found (matches Python's dictionary function of the same name).
2005
+
2006
+ """
1317
2007
  ...
1318
2008
 
1319
2009
  def id_properties_clear(self):
1320
- """ """
2010
+ """
2011
+
2012
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2013
+ """
1321
2014
  ...
1322
2015
 
1323
2016
  def id_properties_ensure(self):
1324
- """ """
2017
+ """
2018
+
2019
+ :return: the parent group for an RNA struct's custom IDProperties.
2020
+ """
1325
2021
  ...
1326
2022
 
1327
2023
  def id_properties_ui(self):
1328
- """ """
2024
+ """
2025
+
2026
+ :return: Return an object used to manage an IDProperty's UI data.
2027
+ """
1329
2028
  ...
1330
2029
 
1331
- def is_property_hidden(self):
1332
- """ """
2030
+ def is_property_hidden(self) -> bool:
2031
+ """Check if a property is hidden.
2032
+
2033
+ :return: True when the property is hidden.
2034
+ :rtype: bool
2035
+ """
1333
2036
  ...
1334
2037
 
1335
- def is_property_overridable_library(self):
1336
- """ """
2038
+ def is_property_overridable_library(self) -> bool:
2039
+ """Check if a property is overridable.
2040
+
2041
+ :return: True when the property is overridable.
2042
+ :rtype: bool
2043
+ """
1337
2044
  ...
1338
2045
 
1339
- def is_property_readonly(self):
1340
- """ """
2046
+ def is_property_readonly(self) -> bool:
2047
+ """Check if a property is readonly.
2048
+
2049
+ :return: True when the property is readonly (not writable).
2050
+ :rtype: bool
2051
+ """
1341
2052
  ...
1342
2053
 
1343
- def is_property_set(self):
1344
- """ """
2054
+ def is_property_set(self) -> bool:
2055
+ """Check if a property is set, use for testing operator properties.
2056
+
2057
+ :return: True when the property has been set.
2058
+ :rtype: bool
2059
+ """
1345
2060
  ...
1346
2061
 
1347
2062
  def items(self):
1348
- """ """
2063
+ """Returns the items of this objects custom properties (matches Python's
2064
+ dictionary function of the same name).
2065
+
2066
+ :return: custom property key, value pairs.
2067
+ """
1349
2068
  ...
1350
2069
 
1351
- def keyframe_delete(self):
1352
- """ """
2070
+ def keyframe_delete(self) -> bool:
2071
+ """Remove a keyframe from this properties fcurve.
2072
+
2073
+ :return: Success of keyframe deletion.
2074
+ :rtype: bool
2075
+ """
1353
2076
  ...
1354
2077
 
1355
- def keyframe_insert(self):
1356
- """ """
2078
+ def keyframe_insert(self) -> bool:
2079
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2080
+
2081
+ :return: Success of keyframe insertion.
2082
+ :rtype: bool
2083
+ """
1357
2084
  ...
1358
2085
 
1359
2086
  def keys(self):
1360
- """ """
2087
+ """Returns the keys of this objects custom properties (matches Python's
2088
+ dictionary function of the same name).
2089
+
2090
+ :return: custom property keys.
2091
+ """
1361
2092
  ...
1362
2093
 
1363
- def path_from_id(self):
1364
- """ """
2094
+ def path_from_id(self) -> str:
2095
+ """Returns the data path from the ID to this object (string).
2096
+
2097
+ :return: The path from `bpy.types.bpy_struct.id_data`
2098
+ to this struct and property (when given).
2099
+ :rtype: str
2100
+ """
1365
2101
  ...
1366
2102
 
1367
2103
  def path_resolve(self):
1368
- """ """
2104
+ """Returns the property from the path, raise an exception when not found."""
1369
2105
  ...
1370
2106
 
1371
2107
  def poll(self, context):
@@ -1376,50 +2112,46 @@ class CLIP_OT_track_to_empty(bpy_types.Operator):
1376
2112
  ...
1377
2113
 
1378
2114
  def poll_message_set(self):
1379
- """ """
2115
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
1380
2116
  ...
1381
2117
 
1382
2118
  def pop(self):
1383
- """ """
2119
+ """Remove and return the value of the custom property assigned to key or default
2120
+ when not found (matches Python's dictionary function of the same name).
2121
+
2122
+ """
1384
2123
  ...
1385
2124
 
1386
- def property_overridable_library_set(self):
1387
- """ """
2125
+ def property_overridable_library_set(self) -> bool:
2126
+ """Define a property as overridable or not (only for custom properties!).
2127
+
2128
+ :return: True when the overridable status of the property was successfully set.
2129
+ :rtype: bool
2130
+ """
1388
2131
  ...
1389
2132
 
1390
2133
  def property_unset(self):
1391
- """ """
2134
+ """Unset a property, will use default value afterward."""
1392
2135
  ...
1393
2136
 
1394
2137
  def type_recast(self):
1395
- """ """
1396
- ...
2138
+ """Return a new instance, this is needed because types
2139
+ such as textures can be changed at runtime.
1397
2140
 
1398
- def values(self):
1399
- """ """
2141
+ :return: a new instance of this object with the type initialized again.
2142
+ """
1400
2143
  ...
1401
2144
 
1402
- def CLIP_camera_for_clip(context, clip):
1403
- """ """
1404
-
1405
- ...
1406
-
1407
- def CLIP_default_settings_from_track(clip, track, framenr):
1408
- """ """
1409
-
1410
- ...
1411
-
1412
- def CLIP_set_viewport_background(context, clip, clip_user):
1413
- """ """
1414
-
1415
- ...
1416
-
1417
- def CLIP_spaces_walk(context, all_screens, tarea, tspace, callback, args):
1418
- """ """
1419
-
1420
- ...
2145
+ def values(self):
2146
+ """Returns the values of this objects custom properties (matches Python's
2147
+ dictionary function of the same name).
1421
2148
 
1422
- def CLIP_track_view_selected(sc, track):
1423
- """ """
2149
+ :return: custom property values.
2150
+ """
2151
+ ...
1424
2152
 
1425
- ...
2153
+ def CLIP_camera_for_clip(context, clip): ...
2154
+ def CLIP_default_settings_from_track(clip, track, framenr): ...
2155
+ def CLIP_set_viewport_background(context, clip, clip_user): ...
2156
+ def CLIP_spaces_walk(context, all_screens, tarea, tspace, callback, args): ...
2157
+ def CLIP_track_view_selected(sc, track): ...