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

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

Potentially problematic release.


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

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