fake-bpy-module 20240327__py3-none-any.whl → 20240330__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 (114) hide show
  1. aud/__init__.pyi +34 -96
  2. bgl/__init__.pyi +1265 -2417
  3. bl_math/__init__.pyi +3 -14
  4. bl_ui/space_toolsystem_toolbar/__init__.pyi +6 -0
  5. blf/__init__.pyi +13 -50
  6. bmesh/ops/__init__.pyi +68 -142
  7. bmesh/types/__init__.pyi +18 -44
  8. bmesh/utils/__init__.pyi +2 -6
  9. bpy/app/icons/__init__.pyi +2 -4
  10. bpy/app/timers/__init__.pyi +2 -6
  11. bpy/ops/action/__init__.pyi +92 -93
  12. bpy/ops/anim/__init__.pyi +104 -104
  13. bpy/ops/armature/__init__.pyi +108 -112
  14. bpy/ops/asset/__init__.pyi +32 -32
  15. bpy/ops/boid/__init__.pyi +18 -18
  16. bpy/ops/brush/__init__.pyi +18 -18
  17. bpy/ops/buttons/__init__.pyi +12 -12
  18. bpy/ops/cachefile/__init__.pyi +10 -10
  19. bpy/ops/camera/__init__.pyi +4 -4
  20. bpy/ops/clip/__init__.pyi +194 -195
  21. bpy/ops/cloth/__init__.pyi +2 -2
  22. bpy/ops/collection/__init__.pyi +10 -10
  23. bpy/ops/console/__init__.pyi +42 -42
  24. bpy/ops/constraint/__init__.pyi +36 -36
  25. bpy/ops/curve/__init__.pyi +114 -118
  26. bpy/ops/curves/__init__.pyi +55 -53
  27. bpy/ops/cycles/__init__.pyi +6 -6
  28. bpy/ops/dpaint/__init__.pyi +12 -12
  29. bpy/ops/ed/__init__.pyi +24 -24
  30. bpy/ops/export_anim/__init__.pyi +2 -2
  31. bpy/ops/export_mesh/__init__.pyi +2 -2
  32. bpy/ops/export_scene/__init__.pyi +9 -9
  33. bpy/ops/file/__init__.pyi +80 -83
  34. bpy/ops/fluid/__init__.pyi +28 -28
  35. bpy/ops/font/__init__.pyi +46 -46
  36. bpy/ops/geometry/__init__.pyi +38 -38
  37. bpy/ops/gizmogroup/__init__.pyi +4 -4
  38. bpy/ops/gpencil/__init__.pyi +308 -309
  39. bpy/ops/graph/__init__.pyi +150 -151
  40. bpy/ops/grease_pencil/__init__.pyi +114 -115
  41. bpy/ops/image/__init__.pyi +100 -100
  42. bpy/ops/import_anim/__init__.pyi +2 -2
  43. bpy/ops/import_curve/__init__.pyi +2 -2
  44. bpy/ops/import_mesh/__init__.pyi +2 -2
  45. bpy/ops/import_scene/__init__.pyi +6 -6
  46. bpy/ops/info/__init__.pyi +14 -14
  47. bpy/ops/lattice/__init__.pyi +16 -16
  48. bpy/ops/marker/__init__.pyi +22 -22
  49. bpy/ops/mask/__init__.pyi +90 -91
  50. bpy/ops/material/__init__.pyi +6 -6
  51. bpy/ops/mball/__init__.pyi +20 -21
  52. bpy/ops/mesh/__init__.pyi +431 -429
  53. bpy/ops/nla/__init__.pyi +89 -90
  54. bpy/ops/node/__init__.pyi +242 -243
  55. bpy/ops/object/__init__.pyi +572 -567
  56. bpy/ops/outliner/__init__.pyi +142 -142
  57. bpy/ops/paint/__init__.pyi +182 -126
  58. bpy/ops/paintcurve/__init__.pyi +20 -20
  59. bpy/ops/palette/__init__.pyi +14 -14
  60. bpy/ops/particle/__init__.pyi +72 -72
  61. bpy/ops/pose/__init__.pyi +90 -90
  62. bpy/ops/poselib/__init__.pyi +18 -18
  63. bpy/ops/preferences/__init__.pyi +76 -76
  64. bpy/ops/ptcache/__init__.pyi +14 -14
  65. bpy/ops/render/__init__.pyi +24 -24
  66. bpy/ops/rigidbody/__init__.pyi +34 -34
  67. bpy/ops/scene/__init__.pyi +86 -86
  68. bpy/ops/screen/__init__.pyi +84 -84
  69. bpy/ops/script/__init__.pyi +6 -6
  70. bpy/ops/sculpt/__init__.pyi +62 -62
  71. bpy/ops/sculpt_curves/__init__.pyi +8 -8
  72. bpy/ops/sequencer/__init__.pyi +184 -185
  73. bpy/ops/sound/__init__.pyi +16 -16
  74. bpy/ops/spreadsheet/__init__.pyi +8 -8
  75. bpy/ops/surface/__init__.pyi +12 -12
  76. bpy/ops/text/__init__.pyi +86 -86
  77. bpy/ops/text_editor/__init__.pyi +2 -2
  78. bpy/ops/texture/__init__.pyi +8 -8
  79. bpy/ops/transform/__init__.pyi +112 -112
  80. bpy/ops/ui/__init__.pyi +64 -64
  81. bpy/ops/uilist/__init__.pyi +6 -6
  82. bpy/ops/uv/__init__.pyi +104 -105
  83. bpy/ops/view2d/__init__.pyi +28 -28
  84. bpy/ops/view3d/__init__.pyi +134 -134
  85. bpy/ops/wm/__init__.pyi +232 -232
  86. bpy/ops/workspace/__init__.pyi +14 -14
  87. bpy/ops/world/__init__.pyi +2 -2
  88. bpy/props/__init__.pyi +29 -52
  89. bpy/types/__init__.pyi +5354 -3708
  90. bpy/utils/__init__.pyi +3 -6
  91. bpy/utils/units/__init__.pyi +3 -6
  92. bpy_extras/io_utils/__init__.pyi +8 -0
  93. {fake_bpy_module-20240327.dist-info → fake_bpy_module-20240330.dist-info}/METADATA +1 -1
  94. {fake_bpy_module-20240327.dist-info → fake_bpy_module-20240330.dist-info}/RECORD +114 -114
  95. freestyle/chainingiterators/__init__.pyi +5 -12
  96. freestyle/functions/__init__.pyi +19 -73
  97. freestyle/predicates/__init__.pyi +8 -21
  98. freestyle/shaders/__init__.pyi +32 -81
  99. freestyle/types/__init__.pyi +100 -270
  100. freestyle/utils/ContextFunctions/__init__.pyi +7 -27
  101. freestyle/utils/__init__.pyi +1 -2
  102. gpu/capabilities/__init__.pyi +15 -32
  103. gpu/matrix/__init__.pyi +1 -2
  104. gpu/state/__init__.pyi +4 -10
  105. gpu/types/__init__.pyi +29 -87
  106. gpu_extras/presets/__init__.pyi +4 -16
  107. imbuf/types/__init__.pyi +4 -10
  108. mathutils/__init__.pyi +106 -257
  109. mathutils/bvhtree/__init__.pyi +7 -15
  110. mathutils/geometry/__init__.pyi +9 -18
  111. mathutils/kdtree/__init__.pyi +4 -11
  112. mathutils/noise/__init__.pyi +41 -82
  113. {fake_bpy_module-20240327.dist-info → fake_bpy_module-20240330.dist-info}/WHEEL +0 -0
  114. {fake_bpy_module-20240327.dist-info → fake_bpy_module-20240330.dist-info}/top_level.txt +0 -0
@@ -9,13 +9,12 @@ class BVHTree:
9
9
  """ """
10
10
 
11
11
  @classmethod
12
- def FromBMesh(cls, bmesh: bmesh.types.BMesh, epsilon: float = 0.0):
12
+ def FromBMesh(cls, bmesh: bmesh.types.BMesh, epsilon=0.0):
13
13
  """BVH tree based on `BMesh` data.
14
14
 
15
15
  :param bmesh: BMesh data.
16
16
  :type bmesh: bmesh.types.BMesh
17
17
  :param epsilon: Increase the threshold for detecting overlap and raycast hits.
18
- :type epsilon: float
19
18
  """
20
19
  ...
21
20
 
@@ -27,7 +26,7 @@ class BVHTree:
27
26
  deform: bool = True,
28
27
  render=False,
29
28
  cage: bool = False,
30
- epsilon: float = 0.0,
29
+ epsilon=0.0,
31
30
  ):
32
31
  """BVH tree based on `Object` data.
33
32
 
@@ -41,14 +40,11 @@ class BVHTree:
41
40
  :param cage: Use modifiers cage.
42
41
  :type cage: bool
43
42
  :param epsilon: Increase the threshold for detecting overlap and raycast hits.
44
- :type epsilon: float
45
43
  """
46
44
  ...
47
45
 
48
46
  @classmethod
49
- def FromPolygons(
50
- cls, vertices, polygons, all_triangles: bool = False, epsilon: float = 0.0
51
- ):
47
+ def FromPolygons(cls, vertices, polygons, all_triangles: bool = False, epsilon=0.0):
52
48
  """BVH tree constructed geometry passed in as arguments.
53
49
 
54
50
  :param vertices: float triplets each representing (x, y, z)
@@ -56,16 +52,14 @@ class BVHTree:
56
52
  :param all_triangles: Use when all polygons are triangles for more efficient conversion.
57
53
  :type all_triangles: bool
58
54
  :param epsilon: Increase the threshold for detecting overlap and raycast hits.
59
- :type epsilon: float
60
55
  """
61
56
  ...
62
57
 
63
- def find_nearest(self, origin, distance: float = 1.84467e19) -> float:
58
+ def find_nearest(self, origin, distance=1.84467e19):
64
59
  """Find the nearest element (typically face index) to a point.
65
60
 
66
61
  :param origin:
67
62
  :param distance: Maximum distance threshold.
68
- :type distance: float
69
63
  :return: Returns a tuple
70
64
  (`Vector` location, `Vector` normal, int index, float distance),
71
65
  Values will all be None if no hit is found.
@@ -73,12 +67,11 @@ class BVHTree:
73
67
  """
74
68
  ...
75
69
 
76
- def find_nearest_range(self, origin, distance: float = 1.84467e19) -> float:
70
+ def find_nearest_range(self, origin, distance=1.84467e19):
77
71
  """Find the nearest elements (typically face index) to a point in the distance range.
78
72
 
79
73
  :param origin:
80
74
  :param distance: Maximum distance threshold.
81
- :type distance: float
82
75
  :return: Returns a list of tuples
83
76
  (`Vector` location, `Vector` normal, int index, float distance),
84
77
  :rtype: list
@@ -99,8 +92,8 @@ class BVHTree:
99
92
  self,
100
93
  origin: typing.Union[typing.Sequence[float], mathutils.Vector],
101
94
  direction: typing.Union[typing.Sequence[float], mathutils.Vector],
102
- distance: float = None,
103
- ) -> float:
95
+ distance=None,
96
+ ):
104
97
  """Cast a ray onto the mesh.
105
98
 
106
99
  :param origin: Start location of the ray in object space.
@@ -108,7 +101,6 @@ class BVHTree:
108
101
  :param direction: Direction of the ray in object space.
109
102
  :type direction: typing.Union[typing.Sequence[float], mathutils.Vector]
110
103
  :param distance: Maximum distance threshold.
111
- :type distance: float
112
104
  :return: Returns a tuple
113
105
  (`Vector` location, `Vector` normal, int index, float distance),
114
106
  Values will all be None if no hit is found.
@@ -7,7 +7,7 @@ def area_tri(
7
7
  v1: typing.Union[typing.Sequence[float], mathutils.Vector],
8
8
  v2: typing.Union[typing.Sequence[float], mathutils.Vector],
9
9
  v3: typing.Union[typing.Sequence[float], mathutils.Vector],
10
- ) -> float:
10
+ ):
11
11
  """Returns the area size of the 2D or 3D triangle defined.
12
12
 
13
13
  :param v1: Point1
@@ -16,7 +16,6 @@ def area_tri(
16
16
  :type v2: typing.Union[typing.Sequence[float], mathutils.Vector]
17
17
  :param v3: Point3
18
18
  :type v3: typing.Union[typing.Sequence[float], mathutils.Vector]
19
- :rtype: float
20
19
  """
21
20
 
22
21
  ...
@@ -51,13 +50,12 @@ def barycentric_transform(
51
50
 
52
51
  ...
53
52
 
54
- def box_fit_2d(points: list) -> float:
53
+ def box_fit_2d(points: list):
55
54
  """Returns an angle that best fits the points to an axis aligned rectangle
56
55
 
57
56
  :param points: list of 2d points.
58
57
  :type points: list
59
58
  :return: angle
60
- :rtype: float
61
59
  """
62
60
 
63
61
  ...
@@ -141,7 +139,7 @@ def distance_point_to_plane(
141
139
  pt: typing.Union[typing.Sequence[float], mathutils.Vector],
142
140
  plane_co: typing.Union[typing.Sequence[float], mathutils.Vector],
143
141
  plane_no: typing.Union[typing.Sequence[float], mathutils.Vector],
144
- ) -> float:
142
+ ):
145
143
  """Returns the signed distance between a point and a plane (negative when below the normal).
146
144
 
147
145
  :param pt: Point
@@ -150,7 +148,6 @@ def distance_point_to_plane(
150
148
  :type plane_co: typing.Union[typing.Sequence[float], mathutils.Vector]
151
149
  :param plane_no: The direction the plane is facing
152
150
  :type plane_no: typing.Union[typing.Sequence[float], mathutils.Vector]
153
- :rtype: float
154
151
  """
155
152
 
156
153
  ...
@@ -160,7 +157,7 @@ def interpolate_bezier(
160
157
  handle1: typing.Union[typing.Sequence[float], mathutils.Vector],
161
158
  handle2: typing.Union[typing.Sequence[float], mathutils.Vector],
162
159
  knot2: typing.Union[typing.Sequence[float], mathutils.Vector],
163
- resolution: int,
160
+ resolution,
164
161
  ):
165
162
  """Interpolate a bezier spline segment.
166
163
 
@@ -173,7 +170,6 @@ def interpolate_bezier(
173
170
  :param knot2: Second bezier spline point.
174
171
  :type knot2: typing.Union[typing.Sequence[float], mathutils.Vector]
175
172
  :param resolution: Number of points to return.
176
- :type resolution: int
177
173
  :return: The interpolated points
178
174
  """
179
175
 
@@ -335,7 +331,7 @@ def intersect_point_quad_2d(
335
331
  quad_p2: typing.Union[typing.Sequence[float], mathutils.Vector],
336
332
  quad_p3: typing.Union[typing.Sequence[float], mathutils.Vector],
337
333
  quad_p4: typing.Union[typing.Sequence[float], mathutils.Vector],
338
- ) -> int:
334
+ ):
339
335
  """Takes 5 vectors (using only the x and y coordinates): one is the point and the next 4 define the quad,
340
336
  only the x and y are used from the vectors. Returns 1 if the point is within the quad, otherwise 0.
341
337
  Works only with convex quads without singular edges.
@@ -350,7 +346,6 @@ def intersect_point_quad_2d(
350
346
  :type quad_p3: typing.Union[typing.Sequence[float], mathutils.Vector]
351
347
  :param quad_p4: Fourth point of the quad
352
348
  :type quad_p4: typing.Union[typing.Sequence[float], mathutils.Vector]
353
- :rtype: int
354
349
  """
355
350
 
356
351
  ...
@@ -381,7 +376,7 @@ def intersect_point_tri_2d(
381
376
  tri_p1: typing.Union[typing.Sequence[float], mathutils.Vector],
382
377
  tri_p2: typing.Union[typing.Sequence[float], mathutils.Vector],
383
378
  tri_p3: typing.Union[typing.Sequence[float], mathutils.Vector],
384
- ) -> int:
379
+ ):
385
380
  """Takes 4 vectors (using only the x and y coordinates): one is the point and the next 3 define the triangle. Returns 1 if the point is within the triangle, otherwise 0.
386
381
 
387
382
  :param pt: Point
@@ -392,7 +387,6 @@ def intersect_point_tri_2d(
392
387
  :type tri_p2: typing.Union[typing.Sequence[float], mathutils.Vector]
393
388
  :param tri_p3: Third point of the triangle
394
389
  :type tri_p3: typing.Union[typing.Sequence[float], mathutils.Vector]
395
- :rtype: int
396
390
  """
397
391
 
398
392
  ...
@@ -426,20 +420,18 @@ def intersect_ray_tri(
426
420
 
427
421
  def intersect_sphere_sphere_2d(
428
422
  p_a: typing.Union[typing.Sequence[float], mathutils.Vector],
429
- radius_a: float,
423
+ radius_a,
430
424
  p_b: typing.Union[typing.Sequence[float], mathutils.Vector],
431
- radius_b: float,
425
+ radius_b,
432
426
  ) -> typing.Tuple[mathutils.Vector]:
433
427
  """Returns 2 points on between intersecting circles.
434
428
 
435
429
  :param p_a: Center of the first circle
436
430
  :type p_a: typing.Union[typing.Sequence[float], mathutils.Vector]
437
431
  :param radius_a: Radius of the first circle
438
- :type radius_a: float
439
432
  :param p_b: Center of the second circle
440
433
  :type p_b: typing.Union[typing.Sequence[float], mathutils.Vector]
441
434
  :param radius_b: Radius of the second circle
442
- :type radius_b: float
443
435
  :rtype: typing.Tuple[mathutils.Vector]
444
436
  """
445
437
 
@@ -486,7 +478,7 @@ def volume_tetrahedron(
486
478
  v2: typing.Union[typing.Sequence[float], mathutils.Vector],
487
479
  v3: typing.Union[typing.Sequence[float], mathutils.Vector],
488
480
  v4: typing.Union[typing.Sequence[float], mathutils.Vector],
489
- ) -> float:
481
+ ):
490
482
  """Return the volume formed by a tetrahedron (points can be in any order).
491
483
 
492
484
  :param v1: Point1
@@ -497,7 +489,6 @@ def volume_tetrahedron(
497
489
  :type v3: typing.Union[typing.Sequence[float], mathutils.Vector]
498
490
  :param v4: Point4
499
491
  :type v4: typing.Union[typing.Sequence[float], mathutils.Vector]
500
- :rtype: float
501
492
  """
502
493
 
503
494
  ...
@@ -26,43 +26,36 @@ class KDTree:
26
26
  """
27
27
  ...
28
28
 
29
- def find_n(
30
- self, co: typing.Union[typing.Sequence[float], mathutils.Vector], n: int
31
- ) -> int:
29
+ def find_n(self, co: typing.Union[typing.Sequence[float], mathutils.Vector], n):
32
30
  """Find nearest n points to co.
33
31
 
34
32
  :param co: 3d coordinates.
35
33
  :type co: typing.Union[typing.Sequence[float], mathutils.Vector]
36
34
  :param n: Number of points to find.
37
- :type n: int
38
35
  :return: Returns a list of tuples (`Vector`, index, distance).
39
36
  :rtype: list
40
37
  """
41
38
  ...
42
39
 
43
40
  def find_range(
44
- self, co: typing.Union[typing.Sequence[float], mathutils.Vector], radius: float
45
- ) -> float:
41
+ self, co: typing.Union[typing.Sequence[float], mathutils.Vector], radius
42
+ ):
46
43
  """Find all points within radius of co.
47
44
 
48
45
  :param co: 3d coordinates.
49
46
  :type co: typing.Union[typing.Sequence[float], mathutils.Vector]
50
47
  :param radius: Distance to search for points.
51
- :type radius: float
52
48
  :return: Returns a list of tuples (`Vector`, index, distance).
53
49
  :rtype: list
54
50
  """
55
51
  ...
56
52
 
57
- def insert(
58
- self, co: typing.Union[typing.Sequence[float], mathutils.Vector], index: int
59
- ):
53
+ def insert(self, co: typing.Union[typing.Sequence[float], mathutils.Vector], index):
60
54
  """Insert a point into the KDTree.
61
55
 
62
56
  :param co: Point 3d position.
63
57
  :type co: typing.Union[typing.Sequence[float], mathutils.Vector]
64
58
  :param index: The index of the point.
65
- :type index: int
66
59
  """
67
60
  ...
68
61
 
@@ -3,13 +3,12 @@ import mathutils
3
3
 
4
4
  GenericType = typing.TypeVar("GenericType")
5
5
 
6
- def cell(position: typing.Union[typing.Sequence[float], mathutils.Vector]) -> float:
6
+ def cell(position: typing.Union[typing.Sequence[float], mathutils.Vector]):
7
7
  """Returns cell noise value at the specified position.
8
8
 
9
9
  :param position: The position to evaluate the selected noise function.
10
10
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
11
11
  :return: The cell noise value.
12
- :rtype: float
13
12
  """
14
13
 
15
14
  ...
@@ -29,109 +28,90 @@ def cell_vector(
29
28
 
30
29
  def fractal(
31
30
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
32
- H: float,
33
- lacunarity: float,
34
- octaves: int,
31
+ H,
32
+ lacunarity,
33
+ octaves,
35
34
  noise_basis: str = "PERLIN_ORIGINAL",
36
- ) -> float:
35
+ ):
37
36
  """Returns the fractal Brownian motion (fBm) noise value from the noise basis at the specified position.
38
37
 
39
38
  :param position: The position to evaluate the selected noise function.
40
39
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
41
40
  :param H: The fractal increment factor.
42
- :type H: float
43
41
  :param lacunarity: The gap between successive frequencies.
44
- :type lacunarity: float
45
42
  :param octaves: The number of different noise frequencies used.
46
- :type octaves: int
47
43
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
48
44
  :type noise_basis: str
49
45
  :return: The fractal Brownian motion noise value.
50
- :rtype: float
51
46
  """
52
47
 
53
48
  ...
54
49
 
55
50
  def hetero_terrain(
56
51
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
57
- H: float,
58
- lacunarity: float,
59
- octaves: int,
60
- offset: float,
52
+ H,
53
+ lacunarity,
54
+ octaves,
55
+ offset,
61
56
  noise_basis: str = "PERLIN_ORIGINAL",
62
- ) -> float:
57
+ ):
63
58
  """Returns the heterogeneous terrain value from the noise basis at the specified position.
64
59
 
65
60
  :param position: The position to evaluate the selected noise function.
66
61
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
67
62
  :param H: The fractal dimension of the roughest areas.
68
- :type H: float
69
63
  :param lacunarity: The gap between successive frequencies.
70
- :type lacunarity: float
71
64
  :param octaves: The number of different noise frequencies used.
72
- :type octaves: int
73
65
  :param offset: The height of the terrain above 'sea level'.
74
- :type offset: float
75
66
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
76
67
  :type noise_basis: str
77
68
  :return: The heterogeneous terrain value.
78
- :rtype: float
79
69
  """
80
70
 
81
71
  ...
82
72
 
83
73
  def hybrid_multi_fractal(
84
74
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
85
- H: float,
86
- lacunarity: float,
87
- octaves: int,
88
- offset: float,
89
- gain: float,
75
+ H,
76
+ lacunarity,
77
+ octaves,
78
+ offset,
79
+ gain,
90
80
  noise_basis: str = "PERLIN_ORIGINAL",
91
- ) -> float:
81
+ ):
92
82
  """Returns hybrid multifractal value from the noise basis at the specified position.
93
83
 
94
84
  :param position: The position to evaluate the selected noise function.
95
85
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
96
86
  :param H: The fractal dimension of the roughest areas.
97
- :type H: float
98
87
  :param lacunarity: The gap between successive frequencies.
99
- :type lacunarity: float
100
88
  :param octaves: The number of different noise frequencies used.
101
- :type octaves: int
102
89
  :param offset: The height of the terrain above 'sea level'.
103
- :type offset: float
104
90
  :param gain: Scaling applied to the values.
105
- :type gain: float
106
91
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
107
92
  :type noise_basis: str
108
93
  :return: The hybrid multifractal value.
109
- :rtype: float
110
94
  """
111
95
 
112
96
  ...
113
97
 
114
98
  def multi_fractal(
115
99
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
116
- H: float,
117
- lacunarity: float,
118
- octaves: int,
100
+ H,
101
+ lacunarity,
102
+ octaves,
119
103
  noise_basis: str = "PERLIN_ORIGINAL",
120
- ) -> float:
104
+ ):
121
105
  """Returns multifractal noise value from the noise basis at the specified position.
122
106
 
123
107
  :param position: The position to evaluate the selected noise function.
124
108
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
125
109
  :param H: The fractal increment factor.
126
- :type H: float
127
110
  :param lacunarity: The gap between successive frequencies.
128
- :type lacunarity: float
129
111
  :param octaves: The number of different noise frequencies used.
130
- :type octaves: int
131
112
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
132
113
  :type noise_basis: str
133
114
  :return: The multifractal noise value.
134
- :rtype: float
135
115
  """
136
116
 
137
117
  ...
@@ -139,7 +119,7 @@ def multi_fractal(
139
119
  def noise(
140
120
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
141
121
  noise_basis: str = "PERLIN_ORIGINAL",
142
- ) -> float:
122
+ ):
143
123
  """Returns noise value from the noise basis at the position specified.
144
124
 
145
125
  :param position: The position to evaluate the selected noise function.
@@ -147,7 +127,6 @@ def noise(
147
127
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
148
128
  :type noise_basis: str
149
129
  :return: The noise value.
150
- :rtype: float
151
130
  """
152
131
 
153
132
  ...
@@ -168,31 +147,28 @@ def noise_vector(
168
147
 
169
148
  ...
170
149
 
171
- def random() -> float:
150
+ def random():
172
151
  """Returns a random number in the range [0, 1).
173
152
 
174
153
  :return: The random number.
175
- :rtype: float
176
154
  """
177
155
 
178
156
  ...
179
157
 
180
- def random_unit_vector(size: int = 3) -> mathutils.Vector:
158
+ def random_unit_vector(size=3) -> mathutils.Vector:
181
159
  """Returns a unit vector with random entries.
182
160
 
183
161
  :param size: The size of the vector to be produced, in the range [2, 4].
184
- :type size: int
185
162
  :return: The random unit vector.
186
163
  :rtype: mathutils.Vector
187
164
  """
188
165
 
189
166
  ...
190
167
 
191
- def random_vector(size: int = 3) -> mathutils.Vector:
168
+ def random_vector(size=3) -> mathutils.Vector:
192
169
  """Returns a vector with random entries in the range (-1, 1).
193
170
 
194
171
  :param size: The size of the vector to be produced.
195
- :type size: int
196
172
  :return: The random vector.
197
173
  :rtype: mathutils.Vector
198
174
  """
@@ -201,95 +177,81 @@ def random_vector(size: int = 3) -> mathutils.Vector:
201
177
 
202
178
  def ridged_multi_fractal(
203
179
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
204
- H: float,
205
- lacunarity: float,
206
- octaves: int,
207
- offset: float,
208
- gain: float,
180
+ H,
181
+ lacunarity,
182
+ octaves,
183
+ offset,
184
+ gain,
209
185
  noise_basis: str = "PERLIN_ORIGINAL",
210
- ) -> float:
186
+ ):
211
187
  """Returns ridged multifractal value from the noise basis at the specified position.
212
188
 
213
189
  :param position: The position to evaluate the selected noise function.
214
190
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
215
191
  :param H: The fractal dimension of the roughest areas.
216
- :type H: float
217
192
  :param lacunarity: The gap between successive frequencies.
218
- :type lacunarity: float
219
193
  :param octaves: The number of different noise frequencies used.
220
- :type octaves: int
221
194
  :param offset: The height of the terrain above 'sea level'.
222
- :type offset: float
223
195
  :param gain: Scaling applied to the values.
224
- :type gain: float
225
196
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
226
197
  :type noise_basis: str
227
198
  :return: The ridged multifractal value.
228
- :rtype: float
229
199
  """
230
200
 
231
201
  ...
232
202
 
233
- def seed_set(seed: int):
203
+ def seed_set(seed):
234
204
  """Sets the random seed used for random_unit_vector, and random.
235
205
 
236
206
  :param seed: Seed used for the random generator.
237
207
  When seed is zero, the current time will be used instead.
238
- :type seed: int
239
208
  """
240
209
 
241
210
  ...
242
211
 
243
212
  def turbulence(
244
213
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
245
- octaves: int,
214
+ octaves,
246
215
  hard: bool,
247
216
  noise_basis: str = "PERLIN_ORIGINAL",
248
- amplitude_scale: float = 0.5,
249
- frequency_scale: float = 2.0,
250
- ) -> float:
217
+ amplitude_scale=0.5,
218
+ frequency_scale=2.0,
219
+ ):
251
220
  """Returns the turbulence value from the noise basis at the specified position.
252
221
 
253
222
  :param position: The position to evaluate the selected noise function.
254
223
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
255
224
  :param octaves: The number of different noise frequencies used.
256
- :type octaves: int
257
225
  :param hard: Specifies whether returned turbulence is hard (sharp transitions) or soft (smooth transitions).
258
226
  :type hard: bool
259
227
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
260
228
  :type noise_basis: str
261
229
  :param amplitude_scale: The amplitude scaling factor.
262
- :type amplitude_scale: float
263
230
  :param frequency_scale: The frequency scaling factor
264
- :type frequency_scale: float
265
231
  :return: The turbulence value.
266
- :rtype: float
267
232
  """
268
233
 
269
234
  ...
270
235
 
271
236
  def turbulence_vector(
272
237
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
273
- octaves: int,
238
+ octaves,
274
239
  hard: bool,
275
240
  noise_basis: str = "PERLIN_ORIGINAL",
276
- amplitude_scale: float = 0.5,
277
- frequency_scale: float = 2.0,
241
+ amplitude_scale=0.5,
242
+ frequency_scale=2.0,
278
243
  ) -> mathutils.Vector:
279
244
  """Returns the turbulence vector from the noise basis at the specified position.
280
245
 
281
246
  :param position: The position to evaluate the selected noise function.
282
247
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
283
248
  :param octaves: The number of different noise frequencies used.
284
- :type octaves: int
285
249
  :param hard: Specifies whether returned turbulence is hard (sharp transitions) or soft (smooth transitions).
286
250
  :type hard: bool
287
251
  :param noise_basis: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
288
252
  :type noise_basis: str
289
253
  :param amplitude_scale: The amplitude scaling factor.
290
- :type amplitude_scale: float
291
254
  :param frequency_scale: The frequency scaling factor
292
- :type frequency_scale: float
293
255
  :return: The turbulence vector.
294
256
  :rtype: mathutils.Vector
295
257
  """
@@ -298,22 +260,20 @@ def turbulence_vector(
298
260
 
299
261
  def variable_lacunarity(
300
262
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
301
- distortion: float,
263
+ distortion,
302
264
  noise_type1: str = "PERLIN_ORIGINAL",
303
265
  noise_type2: str = "PERLIN_ORIGINAL",
304
- ) -> float:
266
+ ):
305
267
  """Returns variable lacunarity noise value, a distorted variety of noise, from noise type 1 distorted by noise type 2 at the specified position.
306
268
 
307
269
  :param position: The position to evaluate the selected noise function.
308
270
  :type position: typing.Union[typing.Sequence[float], mathutils.Vector]
309
271
  :param distortion: The amount of distortion.
310
- :type distortion: float
311
272
  :param noise_type1: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
312
273
  :type noise_type1: str
313
274
  :param noise_type2: Enumerator in ['BLENDER', 'PERLIN_ORIGINAL', 'PERLIN_NEW', 'VORONOI_F1', 'VORONOI_F2', 'VORONOI_F3', 'VORONOI_F4', 'VORONOI_F2F1', 'VORONOI_CRACKLE', 'CELLNOISE'].
314
275
  :type noise_type2: str
315
276
  :return: The variable lacunarity noise value.
316
- :rtype: float
317
277
  """
318
278
 
319
279
  ...
@@ -321,7 +281,7 @@ def variable_lacunarity(
321
281
  def voronoi(
322
282
  position: typing.Union[typing.Sequence[float], mathutils.Vector],
323
283
  distance_metric: str = "DISTANCE",
324
- exponent: float = 2.5,
284
+ exponent=2.5,
325
285
  ):
326
286
  """Returns a list of distances to the four closest features and their locations.
327
287
 
@@ -330,7 +290,6 @@ def voronoi(
330
290
  :param distance_metric: Enumerator in ['DISTANCE', 'DISTANCE_SQUARED', 'MANHATTAN', 'CHEBYCHEV', 'MINKOVSKY', 'MINKOVSKY_HALF', 'MINKOVSKY_FOUR'].
331
291
  :type distance_metric: str
332
292
  :param exponent: The exponent for Minkowski distance metric.
333
- :type exponent: float
334
293
  :return: A list of distances to the four closest features and their locations.
335
294
  """
336
295