fake-bpy-module 20241207__py3-none-any.whl → 20241209__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 (115) hide show
  1. addon_utils/__init__.pyi +2 -1
  2. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +5 -2
  3. bl_console_utils/autocomplete/complete_import/__init__.pyi +6 -3
  4. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -1
  5. bl_console_utils/autocomplete/intellisense/__init__.pyi +8 -2
  6. blf/__init__.pyi +2 -1
  7. bmesh/ops/__init__.pyi +110 -53
  8. bmesh/types/__init__.pyi +18 -10
  9. bmesh/utils/__init__.pyi +14 -4
  10. bpy/app/icons/__init__.pyi +4 -1
  11. bpy/app/translations/__init__.pyi +4 -1
  12. bpy/msgbus/__init__.pyi +8 -5
  13. bpy/ops/action/__init__.pyi +38 -138
  14. bpy/ops/anim/__init__.pyi +61 -179
  15. bpy/ops/armature/__init__.pyi +48 -147
  16. bpy/ops/asset/__init__.pyi +16 -71
  17. bpy/ops/boid/__init__.pyi +8 -41
  18. bpy/ops/brush/__init__.pyi +13 -39
  19. bpy/ops/buttons/__init__.pyi +6 -29
  20. bpy/ops/cachefile/__init__.pyi +5 -19
  21. bpy/ops/camera/__init__.pyi +2 -5
  22. bpy/ops/clip/__init__.pyi +92 -290
  23. bpy/ops/cloth/__init__.pyi +1 -3
  24. bpy/ops/collection/__init__.pyi +9 -25
  25. bpy/ops/console/__init__.pyi +21 -79
  26. bpy/ops/constraint/__init__.pyi +18 -45
  27. bpy/ops/curve/__init__.pyi +51 -180
  28. bpy/ops/curves/__init__.pyi +28 -100
  29. bpy/ops/cycles/__init__.pyi +3 -9
  30. bpy/ops/dpaint/__init__.pyi +5 -19
  31. bpy/ops/ed/__init__.pyi +12 -53
  32. bpy/ops/export_anim/__init__.pyi +1 -3
  33. bpy/ops/export_scene/__init__.pyi +2 -5
  34. bpy/ops/extensions/__init__.pyi +34 -110
  35. bpy/ops/file/__init__.pyi +40 -167
  36. bpy/ops/fluid/__init__.pyi +14 -77
  37. bpy/ops/font/__init__.pyi +23 -85
  38. bpy/ops/geometry/__init__.pyi +10 -27
  39. bpy/ops/gizmogroup/__init__.pyi +2 -9
  40. bpy/ops/gpencil/__init__.pyi +8 -32
  41. bpy/ops/graph/__init__.pyi +65 -184
  42. bpy/ops/grease_pencil/__init__.pyi +108 -290
  43. bpy/ops/image/__init__.pyi +49 -154
  44. bpy/ops/import_anim/__init__.pyi +1 -3
  45. bpy/ops/import_curve/__init__.pyi +1 -3
  46. bpy/ops/import_scene/__init__.pyi +2 -4
  47. bpy/ops/info/__init__.pyi +7 -29
  48. bpy/ops/lattice/__init__.pyi +8 -29
  49. bpy/ops/marker/__init__.pyi +11 -31
  50. bpy/ops/mask/__init__.pyi +39 -132
  51. bpy/ops/material/__init__.pyi +3 -19
  52. bpy/ops/mball/__init__.pyi +8 -19
  53. bpy/ops/mesh/__init__.pyi +164 -401
  54. bpy/ops/nla/__init__.pyi +39 -147
  55. bpy/ops/node/__init__.pyi +115 -390
  56. bpy/ops/object/__init__.pyi +237 -630
  57. bpy/ops/outliner/__init__.pyi +71 -263
  58. bpy/ops/paint/__init__.pyi +54 -140
  59. bpy/ops/paintcurve/__init__.pyi +8 -33
  60. bpy/ops/palette/__init__.pyi +7 -27
  61. bpy/ops/particle/__init__.pyi +36 -134
  62. bpy/ops/pose/__init__.pyi +51 -169
  63. bpy/ops/poselib/__init__.pyi +9 -33
  64. bpy/ops/preferences/__init__.pyi +35 -94
  65. bpy/ops/ptcache/__init__.pyi +7 -33
  66. bpy/ops/render/__init__.pyi +13 -37
  67. bpy/ops/rigidbody/__init__.pyi +13 -45
  68. bpy/ops/scene/__init__.pyi +37 -121
  69. bpy/ops/screen/__init__.pyi +39 -137
  70. bpy/ops/script/__init__.pyi +3 -11
  71. bpy/ops/sculpt/__init__.pyi +37 -94
  72. bpy/ops/sculpt_curves/__init__.pyi +4 -10
  73. bpy/ops/sequencer/__init__.pyi +89 -284
  74. bpy/ops/sound/__init__.pyi +7 -23
  75. bpy/ops/spreadsheet/__init__.pyi +4 -15
  76. bpy/ops/surface/__init__.pyi +6 -13
  77. bpy/ops/text/__init__.pyi +43 -175
  78. bpy/ops/text_editor/__init__.pyi +1 -3
  79. bpy/ops/texture/__init__.pyi +4 -21
  80. bpy/ops/transform/__init__.pyi +27 -61
  81. bpy/ops/ui/__init__.pyi +34 -117
  82. bpy/ops/uilist/__init__.pyi +3 -7
  83. bpy/ops/uv/__init__.pyi +49 -134
  84. bpy/ops/view2d/__init__.pyi +14 -39
  85. bpy/ops/view3d/__init__.pyi +67 -232
  86. bpy/ops/wm/__init__.pyi +114 -298
  87. bpy/ops/workspace/__init__.pyi +7 -33
  88. bpy/ops/world/__init__.pyi +2 -11
  89. bpy/path/__init__.pyi +4 -2
  90. bpy/types/__init__.pyi +68 -32
  91. bpy/utils/__init__.pyi +18 -9
  92. bpy_extras/bmesh_utils/__init__.pyi +2 -1
  93. bpy_extras/io_utils/__init__.pyi +7 -2
  94. bpy_extras/mesh_utils/__init__.pyi +19 -7
  95. bpy_extras/view3d_utils/__init__.pyi +2 -2
  96. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/METADATA +1 -1
  97. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/RECORD +115 -115
  98. freestyle/functions/__init__.pyi +16 -4
  99. freestyle/types/__init__.pyi +60 -23
  100. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  101. gpu/capabilities/__init__.pyi +2 -1
  102. gpu/state/__init__.pyi +2 -2
  103. gpu/types/__init__.pyi +2 -2
  104. gpu_extras/batch/__init__.pyi +6 -3
  105. idprop/types/__init__.pyi +4 -3
  106. imbuf/__init__.pyi +2 -1
  107. imbuf/types/__init__.pyi +5 -2
  108. mathutils/__init__.pyi +25 -14
  109. mathutils/bvhtree/__init__.pyi +8 -7
  110. mathutils/geometry/__init__.pyi +38 -17
  111. mathutils/interpolate/__init__.pyi +2 -1
  112. mathutils/kdtree/__init__.pyi +11 -6
  113. mathutils/noise/__init__.pyi +2 -1
  114. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/WHEEL +0 -0
  115. {fake_bpy_module-20241207.dist-info → fake_bpy_module-20241209.dist-info}/top_level.txt +0 -0
bmesh/ops/__init__.pyi CHANGED
@@ -37,7 +37,7 @@ def beautify_fill(
37
37
  edges: list[bmesh.types.BMEdge] = [],
38
38
  use_restrict_tag: bool = False,
39
39
  method: typing.Literal["AREA", "ANGLE"] = "AREA",
40
- ):
40
+ ) -> dict[str, typing.Any]:
41
41
  """Beautify Fill.Rotate edges to create more evenly spaced triangles.
42
42
 
43
43
  :param bm: The bmesh to operate on.
@@ -53,6 +53,7 @@ def beautify_fill(
53
53
  :return: geom: new flipped faces and edges
54
54
 
55
55
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
56
+ :rtype: dict[str, typing.Any]
56
57
  """
57
58
 
58
59
  def bevel(
@@ -80,7 +81,7 @@ def bevel(
80
81
  spread: float = 0,
81
82
  custom_profile: bpy.types.bpy_struct | None = None,
82
83
  vmesh_method: typing.Literal["ADJ", "CUTOFF"] = "ADJ",
83
- ):
84
+ ) -> dict[str, typing.Any]:
84
85
  """Bevel.Bevels edges and vertices
85
86
 
86
87
  :param bm: The bmesh to operate on.
@@ -134,6 +135,7 @@ def bevel(
134
135
  verts: output verts
135
136
 
136
137
  type list of (`bmesh.types.BMVert`)
138
+ :rtype: dict[str, typing.Any]
137
139
  """
138
140
 
139
141
  def bisect_edges(
@@ -141,7 +143,7 @@ def bisect_edges(
141
143
  edges: list[bmesh.types.BMEdge] = [],
142
144
  cuts: int = 0,
143
145
  edge_percents={},
144
- ):
146
+ ) -> dict[str, typing.Any]:
145
147
  """Edge Bisect.Splits input edges (but doesn't do anything else).
146
148
  This creates a 2-valence vert.
147
149
 
@@ -155,6 +157,7 @@ def bisect_edges(
155
157
  :return: geom_split: newly created vertices and edges
156
158
 
157
159
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
160
+ :rtype: dict[str, typing.Any]
158
161
  """
159
162
 
160
163
  def bisect_plane(
@@ -168,7 +171,7 @@ def bisect_plane(
168
171
  use_snap_center: bool = False,
169
172
  clear_outer: bool = False,
170
173
  clear_inner: bool = False,
171
- ):
174
+ ) -> dict[str, typing.Any]:
172
175
  """Bisect Plane.Bisects the mesh by a plane (cut the mesh in half).
173
176
 
174
177
  :param bm: The bmesh to operate on.
@@ -194,6 +197,7 @@ def bisect_plane(
194
197
  geom: input and output geometry (result of cut).
195
198
 
196
199
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
200
+ :rtype: dict[str, typing.Any]
197
201
  """
198
202
 
199
203
  def bmesh_to_mesh(
@@ -217,7 +221,7 @@ def bridge_loops(
217
221
  use_merge: bool = False,
218
222
  merge_factor: float = 0,
219
223
  twist_offset: int = 0,
220
- ):
224
+ ) -> dict[str, typing.Any]:
221
225
  """Bridge edge loops with faces.
222
226
 
223
227
  :param bm: The bmesh to operate on.
@@ -241,6 +245,7 @@ def bridge_loops(
241
245
  edges: new edges
242
246
 
243
247
  type list of (`bmesh.types.BMEdge`)
248
+ :rtype: dict[str, typing.Any]
244
249
  """
245
250
 
246
251
  def collapse(
@@ -270,7 +275,7 @@ def connect_vert_pair(
270
275
  verts: list[bmesh.types.BMVert] = [],
271
276
  verts_exclude: list[bmesh.types.BMVert] = [],
272
277
  faces_exclude: list[bmesh.types.BMFace] = [],
273
- ):
278
+ ) -> dict[str, typing.Any]:
274
279
  """Connect Verts.Split faces by adding edges that connect verts.
275
280
 
276
281
  :param bm: The bmesh to operate on.
@@ -284,6 +289,7 @@ def connect_vert_pair(
284
289
  :return: edges:
285
290
 
286
291
  type list of (`bmesh.types.BMEdge`)
292
+ :rtype: dict[str, typing.Any]
287
293
  """
288
294
 
289
295
  def connect_verts(
@@ -291,7 +297,7 @@ def connect_verts(
291
297
  verts: list[bmesh.types.BMVert] = [],
292
298
  faces_exclude: list[bmesh.types.BMFace] = [],
293
299
  check_degenerate: bool = False,
294
- ):
300
+ ) -> dict[str, typing.Any]:
295
301
  """Connect Verts.Split faces by adding edges that connect verts.
296
302
 
297
303
  :param bm: The bmesh to operate on.
@@ -305,9 +311,12 @@ def connect_verts(
305
311
  :return: edges:
306
312
 
307
313
  type list of (`bmesh.types.BMEdge`)
314
+ :rtype: dict[str, typing.Any]
308
315
  """
309
316
 
310
- def connect_verts_concave(bm: bmesh.types.BMesh, faces: list[bmesh.types.BMFace] = []):
317
+ def connect_verts_concave(
318
+ bm: bmesh.types.BMesh, faces: list[bmesh.types.BMFace] = []
319
+ ) -> dict[str, typing.Any]:
311
320
  """Connect Verts to form Convex Faces.Ensures all faces are convex faces.
312
321
 
313
322
  :param bm: The bmesh to operate on.
@@ -321,11 +330,12 @@ def connect_verts_concave(bm: bmesh.types.BMesh, faces: list[bmesh.types.BMFace]
321
330
  faces:
322
331
 
323
332
  type list of (`bmesh.types.BMFace`)
333
+ :rtype: dict[str, typing.Any]
324
334
  """
325
335
 
326
336
  def connect_verts_nonplanar(
327
337
  bm: bmesh.types.BMesh, angle_limit: float = 0, faces: list[bmesh.types.BMFace] = []
328
- ):
338
+ ) -> dict[str, typing.Any]:
329
339
  """Connect Verts Across non Planer Faces.Split faces by connecting edges along non planer faces.
330
340
 
331
341
  :param bm: The bmesh to operate on.
@@ -341,6 +351,7 @@ def connect_verts_nonplanar(
341
351
  faces:
342
352
 
343
353
  type list of (`bmesh.types.BMFace`)
354
+ :rtype: dict[str, typing.Any]
344
355
  """
345
356
 
346
357
  def contextual_create(
@@ -350,7 +361,7 @@ def contextual_create(
350
361
  | list[bmesh.types.BMVert] = [],
351
362
  mat_nr: int = 0,
352
363
  use_smooth: bool = False,
353
- ):
364
+ ) -> dict[str, typing.Any]:
354
365
  """Contextual Create.This is basically F-key, it creates
355
366
  new faces from vertices, makes stuff from edge nets,
356
367
  makes wire edges, etc. It also dissolves faces.Three verts become a triangle, four become a quad. Two
@@ -371,6 +382,7 @@ def contextual_create(
371
382
  edges: newly-made edge(s)
372
383
 
373
384
  type list of (`bmesh.types.BMEdge`)
385
+ :rtype: dict[str, typing.Any]
374
386
  """
375
387
 
376
388
  def convex_hull(
@@ -379,7 +391,7 @@ def convex_hull(
379
391
  | list[bmesh.types.BMFace]
380
392
  | list[bmesh.types.BMVert] = [],
381
393
  use_existing_faces: bool = False,
382
- ):
394
+ ) -> dict[str, typing.Any]:
383
395
  """Convex HullBuilds a convex hull from the vertices in 'input'.If 'use_existing_faces' is true, the hull will not output triangles
384
396
  that are covered by a pre-existing face.All hull vertices, faces, and edges are added to 'geom.out'. Any
385
397
  input elements that end up inside the hull (i.e. are not used by an
@@ -409,6 +421,7 @@ def convex_hull(
409
421
  geom_holes:
410
422
 
411
423
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
424
+ :rtype: dict[str, typing.Any]
412
425
  """
413
426
 
414
427
  def create_circle(
@@ -420,7 +433,7 @@ def create_circle(
420
433
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
421
434
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
422
435
  calc_uvs: bool = False,
423
- ):
436
+ ) -> dict[str, typing.Any]:
424
437
  """Creates a Circle.
425
438
 
426
439
  :param bm: The bmesh to operate on.
@@ -440,6 +453,7 @@ def create_circle(
440
453
  :return: verts: output verts
441
454
 
442
455
  type list of (`bmesh.types.BMVert`)
456
+ :rtype: dict[str, typing.Any]
443
457
  """
444
458
 
445
459
  def create_cone(
@@ -453,7 +467,7 @@ def create_cone(
453
467
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
454
468
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
455
469
  calc_uvs: bool = False,
456
- ):
470
+ ) -> dict[str, typing.Any]:
457
471
  """Create Cone.Creates a cone with variable depth at both ends
458
472
 
459
473
  :param bm: The bmesh to operate on.
@@ -477,6 +491,7 @@ def create_cone(
477
491
  :return: verts: output verts
478
492
 
479
493
  type list of (`bmesh.types.BMVert`)
494
+ :rtype: dict[str, typing.Any]
480
495
  """
481
496
 
482
497
  def create_cube(
@@ -485,7 +500,7 @@ def create_cube(
485
500
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
486
501
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
487
502
  calc_uvs: bool = False,
488
- ):
503
+ ) -> dict[str, typing.Any]:
489
504
  """Create CubeCreates a cube.
490
505
 
491
506
  :param bm: The bmesh to operate on.
@@ -499,6 +514,7 @@ def create_cube(
499
514
  :return: verts: output verts
500
515
 
501
516
  type list of (`bmesh.types.BMVert`)
517
+ :rtype: dict[str, typing.Any]
502
518
  """
503
519
 
504
520
  def create_grid(
@@ -509,7 +525,7 @@ def create_grid(
509
525
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
510
526
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
511
527
  calc_uvs: bool = False,
512
- ):
528
+ ) -> dict[str, typing.Any]:
513
529
  """Create Grid.Creates a grid with a variable number of subdivisions
514
530
 
515
531
  :param bm: The bmesh to operate on.
@@ -527,6 +543,7 @@ def create_grid(
527
543
  :return: verts: output verts
528
544
 
529
545
  type list of (`bmesh.types.BMVert`)
546
+ :rtype: dict[str, typing.Any]
530
547
  """
531
548
 
532
549
  def create_icosphere(
@@ -536,7 +553,7 @@ def create_icosphere(
536
553
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
537
554
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
538
555
  calc_uvs: bool = False,
539
- ):
556
+ ) -> dict[str, typing.Any]:
540
557
  """Create Ico-Sphere.Creates a grid with a variable number of subdivisions
541
558
 
542
559
  :param bm: The bmesh to operate on.
@@ -552,6 +569,7 @@ def create_icosphere(
552
569
  :return: verts: output verts
553
570
 
554
571
  type list of (`bmesh.types.BMVert`)
572
+ :rtype: dict[str, typing.Any]
555
573
  """
556
574
 
557
575
  def create_monkey(
@@ -559,7 +577,7 @@ def create_monkey(
559
577
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
560
578
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
561
579
  calc_uvs: bool = False,
562
- ):
580
+ ) -> dict[str, typing.Any]:
563
581
  """Create Suzanne.Creates a monkey (standard blender primitive).
564
582
 
565
583
  :param bm: The bmesh to operate on.
@@ -571,6 +589,7 @@ def create_monkey(
571
589
  :return: verts: output verts
572
590
 
573
591
  type list of (`bmesh.types.BMVert`)
592
+ :rtype: dict[str, typing.Any]
574
593
  """
575
594
 
576
595
  def create_uvsphere(
@@ -581,7 +600,7 @@ def create_uvsphere(
581
600
  matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
582
601
  | mathutils.Matrix = mathutils.Matrix.Identity(4),
583
602
  calc_uvs: bool = False,
584
- ):
603
+ ) -> dict[str, typing.Any]:
585
604
  """Create UV Sphere.Creates a grid with a variable number of subdivisions
586
605
 
587
606
  :param bm: The bmesh to operate on.
@@ -599,12 +618,13 @@ def create_uvsphere(
599
618
  :return: verts: output verts
600
619
 
601
620
  type list of (`bmesh.types.BMVert`)
621
+ :rtype: dict[str, typing.Any]
602
622
  """
603
623
 
604
624
  def create_vert(
605
625
  bm: bmesh.types.BMesh,
606
626
  co: collections.abc.Sequence[float] | mathutils.Vector = mathutils.Vector(),
607
- ):
627
+ ) -> dict[str, typing.Any]:
608
628
  """Make Vertex.Creates a single vertex; this BMOP was necessary
609
629
  for click-create-vertex.
610
630
 
@@ -615,6 +635,7 @@ def create_vert(
615
635
  :return: vert: the new vert
616
636
 
617
637
  type list of (`bmesh.types.BMVert`)
638
+ :rtype: dict[str, typing.Any]
618
639
  """
619
640
 
620
641
  def delete(
@@ -660,7 +681,7 @@ def dissolve_edges(
660
681
  edges: list[bmesh.types.BMEdge] = [],
661
682
  use_verts: bool = False,
662
683
  use_face_split: bool = False,
663
- ):
684
+ ) -> dict[str, typing.Any]:
664
685
  """Dissolve Edges.
665
686
 
666
687
  :param bm: The bmesh to operate on.
@@ -674,11 +695,12 @@ def dissolve_edges(
674
695
  :return: region:
675
696
 
676
697
  type list of (`bmesh.types.BMFace`)
698
+ :rtype: dict[str, typing.Any]
677
699
  """
678
700
 
679
701
  def dissolve_faces(
680
702
  bm: bmesh.types.BMesh, faces: list[bmesh.types.BMFace] = [], use_verts: bool = False
681
- ):
703
+ ) -> dict[str, typing.Any]:
682
704
  """Dissolve Faces.
683
705
 
684
706
  :param bm: The bmesh to operate on.
@@ -690,6 +712,7 @@ def dissolve_faces(
690
712
  :return: region:
691
713
 
692
714
  type list of (`bmesh.types.BMFace`)
715
+ :rtype: dict[str, typing.Any]
693
716
  """
694
717
 
695
718
  def dissolve_limit(
@@ -699,7 +722,7 @@ def dissolve_limit(
699
722
  verts: list[bmesh.types.BMVert] = [],
700
723
  edges: list[bmesh.types.BMEdge] = [],
701
724
  delimit=set(),
702
- ):
725
+ ) -> dict[str, typing.Any]:
703
726
  """Limited Dissolve.Dissolve planar faces and co-linear edges.
704
727
 
705
728
  :param bm: The bmesh to operate on.
@@ -716,6 +739,7 @@ def dissolve_limit(
716
739
  :return: region:
717
740
 
718
741
  type list of (`bmesh.types.BMFace`)
742
+ :rtype: dict[str, typing.Any]
719
743
  """
720
744
 
721
745
  def dissolve_verts(
@@ -744,7 +768,7 @@ def duplicate(
744
768
  dest: bmesh.types.BMesh | None = None,
745
769
  use_select_history: bool = False,
746
770
  use_edge_flip_from_face: bool = False,
747
- ):
771
+ ) -> dict[str, typing.Any]:
748
772
  """Duplicate Geometry.Utility operator to duplicate geometry,
749
773
  optionally into a destination mesh.
750
774
 
@@ -785,6 +809,7 @@ def duplicate(
785
809
  isovert_map:
786
810
 
787
811
  type dict mapping vert/edge/face types to `bmesh.types.BMVert`/`bmesh.types.BMEdge`/`bmesh.types.BMFace`
812
+ :rtype: dict[str, typing.Any]
788
813
  """
789
814
 
790
815
  def edgeloop_fill(
@@ -792,7 +817,7 @@ def edgeloop_fill(
792
817
  edges: list[bmesh.types.BMEdge] = [],
793
818
  mat_nr: int = 0,
794
819
  use_smooth: bool = False,
795
- ):
820
+ ) -> dict[str, typing.Any]:
796
821
  """Edge Loop Fill.Create faces defined by one or more non overlapping edge loops.
797
822
 
798
823
  :param bm: The bmesh to operate on.
@@ -806,6 +831,7 @@ def edgeloop_fill(
806
831
  :return: faces: new faces
807
832
 
808
833
  type list of (`bmesh.types.BMFace`)
834
+ :rtype: dict[str, typing.Any]
809
835
  """
810
836
 
811
837
  def edgenet_fill(
@@ -814,7 +840,7 @@ def edgenet_fill(
814
840
  mat_nr: int = 0,
815
841
  use_smooth: bool = False,
816
842
  sides: int = 0,
817
- ):
843
+ ) -> dict[str, typing.Any]:
818
844
  """Edge Net Fill.Create faces defined by enclosed edges.
819
845
 
820
846
  :param bm: The bmesh to operate on.
@@ -830,9 +856,12 @@ def edgenet_fill(
830
856
  :return: faces: new faces
831
857
 
832
858
  type list of (`bmesh.types.BMFace`)
859
+ :rtype: dict[str, typing.Any]
833
860
  """
834
861
 
835
- def edgenet_prepare(bm: bmesh.types.BMesh, edges: list[bmesh.types.BMEdge] = []):
862
+ def edgenet_prepare(
863
+ bm: bmesh.types.BMesh, edges: list[bmesh.types.BMEdge] = []
864
+ ) -> dict[str, typing.Any]:
836
865
  """Edge-net Prepare.Identifies several useful edge loop cases and modifies them so
837
866
  they'll become a face when edgenet_fill is called. The cases covered are:
838
867
 
@@ -843,6 +872,7 @@ def edgenet_prepare(bm: bmesh.types.BMesh, edges: list[bmesh.types.BMEdge] = [])
843
872
  :return: edges: new edges
844
873
 
845
874
  type list of (`bmesh.types.BMEdge`)
875
+ :rtype: dict[str, typing.Any]
846
876
  """
847
877
 
848
878
  def extrude_discrete_faces(
@@ -850,7 +880,7 @@ def extrude_discrete_faces(
850
880
  faces: list[bmesh.types.BMFace] = [],
851
881
  use_normal_flip: bool = False,
852
882
  use_select_history: bool = False,
853
- ):
883
+ ) -> dict[str, typing.Any]:
854
884
  """Individual Face Extrude.Extrudes faces individually.
855
885
 
856
886
  :param bm: The bmesh to operate on.
@@ -864,6 +894,7 @@ def extrude_discrete_faces(
864
894
  :return: faces: output faces
865
895
 
866
896
  type list of (`bmesh.types.BMFace`)
897
+ :rtype: dict[str, typing.Any]
867
898
  """
868
899
 
869
900
  def extrude_edge_only(
@@ -871,7 +902,7 @@ def extrude_edge_only(
871
902
  edges: list[bmesh.types.BMEdge] = [],
872
903
  use_normal_flip: bool = False,
873
904
  use_select_history: bool = False,
874
- ):
905
+ ) -> dict[str, typing.Any]:
875
906
  """Extrude Only Edges.Extrudes Edges into faces, note that this is very simple, there's no fancy
876
907
  winged extrusion.
877
908
 
@@ -886,6 +917,7 @@ def extrude_edge_only(
886
917
  :return: geom: output geometry
887
918
 
888
919
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
920
+ :rtype: dict[str, typing.Any]
889
921
  """
890
922
 
891
923
  def extrude_face_region(
@@ -899,7 +931,7 @@ def extrude_face_region(
899
931
  use_normal_from_adjacent: bool = False,
900
932
  use_dissolve_ortho_edges: bool = False,
901
933
  use_select_history: bool = False,
902
- ):
934
+ ) -> dict[str, typing.Any]:
903
935
  """Extrude Faces.Extrude operator (does not transform)
904
936
 
905
937
  :param bm: The bmesh to operate on.
@@ -920,13 +952,14 @@ def extrude_face_region(
920
952
  :return: geom:
921
953
 
922
954
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
955
+ :rtype: dict[str, typing.Any]
923
956
  """
924
957
 
925
958
  def extrude_vert_indiv(
926
959
  bm: bmesh.types.BMesh,
927
960
  verts: list[bmesh.types.BMVert] = [],
928
961
  use_select_history: bool = False,
929
- ):
962
+ ) -> dict[str, typing.Any]:
930
963
  """Individual Vertex Extrude.Extrudes wire edges from vertices.
931
964
 
932
965
  :param bm: The bmesh to operate on.
@@ -942,6 +975,7 @@ def extrude_vert_indiv(
942
975
  verts: output vertices
943
976
 
944
977
  type list of (`bmesh.types.BMVert`)
978
+ :rtype: dict[str, typing.Any]
945
979
  """
946
980
 
947
981
  def face_attribute_fill(
@@ -949,7 +983,7 @@ def face_attribute_fill(
949
983
  faces: list[bmesh.types.BMFace] = [],
950
984
  use_normals: bool = False,
951
985
  use_data: bool = False,
952
- ):
986
+ ) -> dict[str, typing.Any]:
953
987
  """Face Attribute Fill.Fill in faces with data from adjacent faces.
954
988
 
955
989
  :param bm: The bmesh to operate on.
@@ -963,6 +997,7 @@ def face_attribute_fill(
963
997
  :return: faces_fail: faces that could not be handled
964
998
 
965
999
  type list of (`bmesh.types.BMFace`)
1000
+ :rtype: dict[str, typing.Any]
966
1001
  """
967
1002
 
968
1003
  def find_doubles(
@@ -970,7 +1005,7 @@ def find_doubles(
970
1005
  verts: list[bmesh.types.BMVert] = [],
971
1006
  keep_verts: list[bmesh.types.BMVert] = [],
972
1007
  dist: float = 0,
973
- ):
1008
+ ) -> dict[str, typing.Any]:
974
1009
  """Find Doubles.Takes input verts and find vertices they should weld to.
975
1010
  Outputs a mapping slot suitable for use with the weld verts BMOP.If keep_verts is used, vertices outside that set can only be merged
976
1011
  with vertices in that set.
@@ -986,6 +1021,7 @@ def find_doubles(
986
1021
  :return: targetmap:
987
1022
 
988
1023
  type dict mapping vert/edge/face types to `bmesh.types.BMVert`/`bmesh.types.BMEdge`/`bmesh.types.BMFace`
1024
+ :rtype: dict[str, typing.Any]
989
1025
  """
990
1026
 
991
1027
  def flip_quad_tessellation(bm: bmesh.types.BMesh, faces: list[bmesh.types.BMFace] = []):
@@ -1003,7 +1039,7 @@ def grid_fill(
1003
1039
  mat_nr: int = 0,
1004
1040
  use_smooth: bool = False,
1005
1041
  use_interp_simple: bool = False,
1006
- ):
1042
+ ) -> dict[str, typing.Any]:
1007
1043
  """Grid Fill.Create faces defined by 2 disconnected edge loops (which share edges).
1008
1044
 
1009
1045
  :param bm: The bmesh to operate on.
@@ -1019,11 +1055,12 @@ def grid_fill(
1019
1055
  :return: faces: new faces
1020
1056
 
1021
1057
  type list of (`bmesh.types.BMFace`)
1058
+ :rtype: dict[str, typing.Any]
1022
1059
  """
1023
1060
 
1024
1061
  def holes_fill(
1025
1062
  bm: bmesh.types.BMesh, edges: list[bmesh.types.BMEdge] = [], sides: int = 0
1026
- ):
1063
+ ) -> dict[str, typing.Any]:
1027
1064
  """Fill Holes.Fill boundary edges with faces, copying surrounding customdata.
1028
1065
 
1029
1066
  :param bm: The bmesh to operate on.
@@ -1035,6 +1072,7 @@ def holes_fill(
1035
1072
  :return: faces: new faces
1036
1073
 
1037
1074
  type list of (`bmesh.types.BMFace`)
1075
+ :rtype: dict[str, typing.Any]
1038
1076
  """
1039
1077
 
1040
1078
  def inset_individual(
@@ -1045,7 +1083,7 @@ def inset_individual(
1045
1083
  use_even_offset: bool = False,
1046
1084
  use_interpolate: bool = False,
1047
1085
  use_relative_offset: bool = False,
1048
- ):
1086
+ ) -> dict[str, typing.Any]:
1049
1087
  """Face Inset (Individual).Insets individual faces.
1050
1088
 
1051
1089
  :param bm: The bmesh to operate on.
@@ -1065,6 +1103,7 @@ def inset_individual(
1065
1103
  :return: faces: output faces
1066
1104
 
1067
1105
  type list of (`bmesh.types.BMFace`)
1106
+ :rtype: dict[str, typing.Any]
1068
1107
  """
1069
1108
 
1070
1109
  def inset_region(
@@ -1079,7 +1118,7 @@ def inset_region(
1079
1118
  thickness: float = 0,
1080
1119
  depth: float = 0,
1081
1120
  use_outset: bool = False,
1082
- ):
1121
+ ) -> dict[str, typing.Any]:
1083
1122
  """Face Inset (Regions).Inset or outset face regions.
1084
1123
 
1085
1124
  :param bm: The bmesh to operate on.
@@ -1107,6 +1146,7 @@ def inset_region(
1107
1146
  :return: faces: output faces
1108
1147
 
1109
1148
  type list of (`bmesh.types.BMFace`)
1149
+ :rtype: dict[str, typing.Any]
1110
1150
  """
1111
1151
 
1112
1152
  def join_triangles(
@@ -1123,7 +1163,7 @@ def join_triangles(
1123
1163
  deselect_joined: bool = False,
1124
1164
  merge_limit: int = 0,
1125
1165
  neighbor_debug: int = 0,
1126
- ):
1166
+ ) -> dict[str, typing.Any]:
1127
1167
  """Join Triangles.Tries to intelligently join triangles according
1128
1168
  to angle threshold and delimiters.
1129
1169
 
@@ -1156,6 +1196,7 @@ def join_triangles(
1156
1196
  :return: faces: joined faces
1157
1197
 
1158
1198
  type list of (`bmesh.types.BMFace`)
1199
+ :rtype: dict[str, typing.Any]
1159
1200
  """
1160
1201
 
1161
1202
  def mesh_to_bmesh(
@@ -1190,7 +1231,7 @@ def mirror(
1190
1231
  mirror_v: bool = False,
1191
1232
  mirror_udim: bool = False,
1192
1233
  use_shapekey: bool = False,
1193
- ):
1234
+ ) -> dict[str, typing.Any]:
1194
1235
  """Mirror.Mirrors geometry along an axis. The resulting geometry is welded on using
1195
1236
  merge_dist. Pairs of original/mirrored vertices are welded using the merge_dist
1196
1237
  parameter (which defines the minimum distance for welding to happen).
@@ -1216,6 +1257,7 @@ def mirror(
1216
1257
  :return: geom: output geometry, mirrored
1217
1258
 
1218
1259
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1260
+ :rtype: dict[str, typing.Any]
1219
1261
  """
1220
1262
 
1221
1263
  def object_load_bmesh(
@@ -1236,7 +1278,7 @@ def offset_edgeloops(
1236
1278
  bm: bmesh.types.BMesh,
1237
1279
  edges: list[bmesh.types.BMEdge] = [],
1238
1280
  use_cap_endpoint: bool = False,
1239
- ):
1281
+ ) -> dict[str, typing.Any]:
1240
1282
  """Edge-loop Offset.Creates edge loops based on simple edge-outset method.
1241
1283
 
1242
1284
  :param bm: The bmesh to operate on.
@@ -1248,6 +1290,7 @@ def offset_edgeloops(
1248
1290
  :return: edges: output edges
1249
1291
 
1250
1292
  type list of (`bmesh.types.BMEdge`)
1293
+ :rtype: dict[str, typing.Any]
1251
1294
  """
1252
1295
 
1253
1296
  def planar_faces(
@@ -1255,7 +1298,7 @@ def planar_faces(
1255
1298
  faces: list[bmesh.types.BMFace] = [],
1256
1299
  iterations: int = 0,
1257
1300
  factor: float = 0,
1258
- ):
1301
+ ) -> dict[str, typing.Any]:
1259
1302
  """Planar Faces.Iteratively flatten faces.
1260
1303
 
1261
1304
  :param bm: The bmesh to operate on.
@@ -1269,6 +1312,7 @@ def planar_faces(
1269
1312
  :return: geom: output slot, computed boundary geometry.
1270
1313
 
1271
1314
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1315
+ :rtype: dict[str, typing.Any]
1272
1316
  """
1273
1317
 
1274
1318
  def pointmerge(
@@ -1307,7 +1351,7 @@ def poke(
1307
1351
  offset: float = 0,
1308
1352
  center_mode: typing.Literal["MEAN_WEIGHTED", "MEAN", "BOUNDS"] = "MEAN_WEIGHTED",
1309
1353
  use_relative_offset: bool = False,
1310
- ):
1354
+ ) -> dict[str, typing.Any]:
1311
1355
  """Pokes a face.Splits a face into a triangle fan.
1312
1356
 
1313
1357
  :param bm: The bmesh to operate on.
@@ -1327,6 +1371,7 @@ def poke(
1327
1371
  faces: output faces
1328
1372
 
1329
1373
  type list of (`bmesh.types.BMFace`)
1374
+ :rtype: dict[str, typing.Any]
1330
1375
  """
1331
1376
 
1332
1377
  def recalc_face_normals(bm: bmesh.types.BMesh, faces: list[bmesh.types.BMFace] = []):
@@ -1346,7 +1391,7 @@ def region_extend(
1346
1391
  use_contract: bool = False,
1347
1392
  use_faces: bool = False,
1348
1393
  use_face_step: bool = False,
1349
- ):
1394
+ ) -> dict[str, typing.Any]:
1350
1395
  """Region Extend.used to implement the select more/less tools.
1351
1396
  this puts some geometry surrounding regions of
1352
1397
  geometry in geom into geom.out.if use_faces is 0 then geom.out spits out verts and edges,
@@ -1365,6 +1410,7 @@ def region_extend(
1365
1410
  :return: geom: output slot, computed boundary geometry.
1366
1411
 
1367
1412
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1413
+ :rtype: dict[str, typing.Any]
1368
1414
  """
1369
1415
 
1370
1416
  def remove_doubles(
@@ -1465,7 +1511,7 @@ def rotate_colors(
1465
1511
 
1466
1512
  def rotate_edges(
1467
1513
  bm: bmesh.types.BMesh, edges: list[bmesh.types.BMEdge] = [], use_ccw: bool = False
1468
- ):
1514
+ ) -> dict[str, typing.Any]:
1469
1515
  """Edge Rotate.Rotates edges topologically. Also known as "spin edge" to some people.
1470
1516
  Simple example: [/] becomes [|] then [].
1471
1517
 
@@ -1478,6 +1524,7 @@ def rotate_edges(
1478
1524
  :return: edges: newly spun edges
1479
1525
 
1480
1526
  type list of (`bmesh.types.BMEdge`)
1527
+ :rtype: dict[str, typing.Any]
1481
1528
  """
1482
1529
 
1483
1530
  def rotate_uvs(
@@ -1588,7 +1635,7 @@ def solidify(
1588
1635
  | list[bmesh.types.BMFace]
1589
1636
  | list[bmesh.types.BMVert] = [],
1590
1637
  thickness: float = 0,
1591
- ):
1638
+ ) -> dict[str, typing.Any]:
1592
1639
  """Solidify.Turns a mesh into a shell with thickness
1593
1640
 
1594
1641
  :param bm: The bmesh to operate on.
@@ -1600,6 +1647,7 @@ def solidify(
1600
1647
  :return: geom:
1601
1648
 
1602
1649
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1650
+ :rtype: dict[str, typing.Any]
1603
1651
  """
1604
1652
 
1605
1653
  def spin(
@@ -1617,7 +1665,7 @@ def spin(
1617
1665
  use_merge: bool = False,
1618
1666
  use_normal_flip: bool = False,
1619
1667
  use_duplicate: bool = False,
1620
- ):
1668
+ ) -> dict[str, typing.Any]:
1621
1669
  """Spin.Extrude or duplicate geometry a number of times,
1622
1670
  rotating and possibly translating after each step
1623
1671
 
@@ -1646,6 +1694,7 @@ def spin(
1646
1694
  :return: geom_last: result of last step
1647
1695
 
1648
1696
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1697
+ :rtype: dict[str, typing.Any]
1649
1698
  """
1650
1699
 
1651
1700
  def split(
@@ -1655,7 +1704,7 @@ def split(
1655
1704
  | list[bmesh.types.BMVert] = [],
1656
1705
  dest: bmesh.types.BMesh | None = None,
1657
1706
  use_only_faces: bool = False,
1658
- ):
1707
+ ) -> dict[str, typing.Any]:
1659
1708
  """Split Off Geometry.Disconnect geometry from adjacent edges and faces,
1660
1709
  optionally into a destination mesh.
1661
1710
 
@@ -1678,6 +1727,7 @@ def split(
1678
1727
  isovert_map:
1679
1728
 
1680
1729
  type dict mapping vert/edge/face types to `bmesh.types.BMVert`/`bmesh.types.BMEdge`/`bmesh.types.BMFace`
1730
+ :rtype: dict[str, typing.Any]
1681
1731
  """
1682
1732
 
1683
1733
  def split_edges(
@@ -1685,7 +1735,7 @@ def split_edges(
1685
1735
  edges: list[bmesh.types.BMEdge] = [],
1686
1736
  verts: list[bmesh.types.BMVert] = [],
1687
1737
  use_verts: bool = False,
1688
- ):
1738
+ ) -> dict[str, typing.Any]:
1689
1739
  """Edge Split.Disconnects faces along input edges.
1690
1740
 
1691
1741
  :param bm: The bmesh to operate on.
@@ -1699,6 +1749,7 @@ def split_edges(
1699
1749
  :return: edges: old output disconnected edges
1700
1750
 
1701
1751
  type list of (`bmesh.types.BMEdge`)
1752
+ :rtype: dict[str, typing.Any]
1702
1753
  """
1703
1754
 
1704
1755
  def subdivide_edgering(
@@ -1711,7 +1762,7 @@ def subdivide_edgering(
1711
1762
  "SMOOTH", "SPHERE", "ROOT", "SHARP", "LINEAR", "INVERSE_SQUARE"
1712
1763
  ] = "SMOOTH",
1713
1764
  profile_shape_factor: float = 0,
1714
- ):
1765
+ ) -> dict[str, typing.Any]:
1715
1766
  """Subdivide Edge-Ring.Take an edge-ring, and subdivide with interpolation options.
1716
1767
 
1717
1768
  :param bm: The bmesh to operate on.
@@ -1731,6 +1782,7 @@ def subdivide_edgering(
1731
1782
  :return: faces: output faces
1732
1783
 
1733
1784
  type list of (`bmesh.types.BMFace`)
1785
+ :rtype: dict[str, typing.Any]
1734
1786
  """
1735
1787
 
1736
1788
  def subdivide_edges(
@@ -1754,7 +1806,7 @@ def subdivide_edges(
1754
1806
  use_only_quads: bool = False,
1755
1807
  use_sphere: bool = False,
1756
1808
  use_smooth_even: bool = False,
1757
- ):
1809
+ ) -> dict[str, typing.Any]:
1758
1810
  """Subdivide Edges.Advanced operator for subdividing edges
1759
1811
  with options for face patterns, smoothing and randomization.
1760
1812
 
@@ -1799,6 +1851,7 @@ def subdivide_edges(
1799
1851
  geom: contains all output geometry
1800
1852
 
1801
1853
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1854
+ :rtype: dict[str, typing.Any]
1802
1855
  """
1803
1856
 
1804
1857
  def symmetrize(
@@ -1809,7 +1862,7 @@ def symmetrize(
1809
1862
  direction: typing.Literal["-X", "-Y", "-Z", "X", "Y", "Z"] = "-X",
1810
1863
  dist: float = 0,
1811
1864
  use_shapekey: bool = False,
1812
- ):
1865
+ ) -> dict[str, typing.Any]:
1813
1866
  """Symmetrize.Makes the mesh elements in the "input" slot symmetrical. Unlike
1814
1867
  normal mirroring, it only copies in one direction, as specified by
1815
1868
  the "direction" slot. The edges and faces that cross the plane of
@@ -1828,6 +1881,7 @@ def symmetrize(
1828
1881
  :return: geom:
1829
1882
 
1830
1883
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1884
+ :rtype: dict[str, typing.Any]
1831
1885
  """
1832
1886
 
1833
1887
  def transform(
@@ -1882,7 +1936,7 @@ def triangle_fill(
1882
1936
  use_dissolve: bool = False,
1883
1937
  edges: list[bmesh.types.BMEdge] = [],
1884
1938
  normal: collections.abc.Sequence[float] | mathutils.Vector = mathutils.Vector(),
1885
- ):
1939
+ ) -> dict[str, typing.Any]:
1886
1940
  """Triangle Fill.Fill edges with triangles
1887
1941
 
1888
1942
  :param bm: The bmesh to operate on.
@@ -1898,6 +1952,7 @@ def triangle_fill(
1898
1952
  :return: geom: new faces and edges
1899
1953
 
1900
1954
  type list of (`bmesh.types.BMVert`, `bmesh.types.BMEdge`, `bmesh.types.BMFace`)
1955
+ :rtype: dict[str, typing.Any]
1901
1956
  """
1902
1957
 
1903
1958
  def triangulate(
@@ -1907,7 +1962,7 @@ def triangulate(
1907
1962
  "BEAUTY", "FIXED", "ALTERNATE", "SHORT_EDGE", "LONG_EDGE"
1908
1963
  ] = "BEAUTY",
1909
1964
  ngon_method: typing.Literal["BEAUTY", "EAR_CLIP"] = "BEAUTY",
1910
- ):
1965
+ ) -> dict[str, typing.Any]:
1911
1966
  """Triangulate.
1912
1967
 
1913
1968
  :param bm: The bmesh to operate on.
@@ -1933,6 +1988,7 @@ def triangulate(
1933
1988
  face_map_double: duplicate faces
1934
1989
 
1935
1990
  type dict mapping vert/edge/face types to `bmesh.types.BMVert`/`bmesh.types.BMEdge`/`bmesh.types.BMFace`
1991
+ :rtype: dict[str, typing.Any]
1936
1992
  """
1937
1993
 
1938
1994
  def unsubdivide(
@@ -1970,7 +2026,7 @@ def wireframe(
1970
2026
  crease_weight: float = 0,
1971
2027
  use_relative_offset: bool = False,
1972
2028
  material_offset: int = 0,
1973
- ):
2029
+ ) -> dict[str, typing.Any]:
1974
2030
  """Wire Frame.Makes a wire-frame copy of faces.
1975
2031
 
1976
2032
  :param bm: The bmesh to operate on.
@@ -1998,4 +2054,5 @@ def wireframe(
1998
2054
  :return: faces: output faces
1999
2055
 
2000
2056
  type list of (`bmesh.types.BMFace`)
2057
+ :rtype: dict[str, typing.Any]
2001
2058
  """