fake-bpy-module 20250604__py3-none-any.whl → 20250607__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 (284) hide show
  1. _bpy_internal/addons/cli/__init__.pyi +1 -1
  2. _bpy_internal/extensions/junction_module/__init__.pyi +7 -7
  3. _bpy_internal/extensions/stale_file_manager/__init__.pyi +8 -8
  4. _bpy_internal/extensions/wheel_manager/__init__.pyi +3 -3
  5. _bpy_internal/freedesktop/__init__.pyi +16 -16
  6. _bpy_internal/grease_pencil/stroke/__init__.pyi +4 -4
  7. _bpy_internal/system_info/text_generate_runtime/__init__.pyi +1 -1
  8. _bpy_internal/system_info/url_prefill_runtime/__init__.pyi +1 -1
  9. _bpy_internal/system_info/url_prefill_startup/__init__.pyi +2 -2
  10. addon_utils/__init__.pyi +12 -12
  11. animsys_refactor/__init__.pyi +6 -6
  12. aud/__init__.pyi +11 -11
  13. bgl/__init__.pyi +272 -252
  14. bl_app_override/__init__.pyi +3 -3
  15. bl_app_override/helpers/__init__.pyi +2 -2
  16. bl_app_template_utils/__init__.pyi +4 -4
  17. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -2
  18. bl_i18n_utils/bl_extract_messages/__init__.pyi +18 -16
  19. bl_i18n_utils/merge_po/__init__.pyi +1 -1
  20. bl_i18n_utils/settings/__init__.pyi +6 -6
  21. bl_i18n_utils/utils/__init__.pyi +48 -46
  22. bl_i18n_utils/utils_cli/__init__.pyi +6 -6
  23. bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -1
  24. bl_i18n_utils/utils_rtl/__init__.pyi +2 -2
  25. bl_keymap_utils/io/__init__.pyi +9 -9
  26. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +1 -1
  27. bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -1
  28. bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
  29. bl_keymap_utils/versioning/__init__.pyi +1 -1
  30. bl_operators/__init__.pyi +2 -2
  31. bl_operators/add_mesh_torus/__init__.pyi +6 -6
  32. bl_operators/anim/__init__.pyi +24 -24
  33. bl_operators/assets/__init__.pyi +9 -9
  34. bl_operators/bmesh/find_adjacent/__init__.pyi +11 -9
  35. bl_operators/bone_selection_sets/__init__.pyi +18 -18
  36. bl_operators/clip/__init__.pyi +26 -26
  37. bl_operators/connect_to_output/__init__.pyi +17 -15
  38. bl_operators/console/__init__.pyi +10 -10
  39. bl_operators/constraint/__init__.pyi +8 -8
  40. bl_operators/file/__init__.pyi +6 -6
  41. bl_operators/freestyle/__init__.pyi +9 -9
  42. bl_operators/geometry_nodes/__init__.pyi +24 -24
  43. bl_operators/grease_pencil/__init__.pyi +2 -2
  44. bl_operators/image/__init__.pyi +7 -7
  45. bl_operators/image_as_planes/__init__.pyi +32 -32
  46. bl_operators/mesh/__init__.pyi +7 -7
  47. bl_operators/node/__init__.pyi +31 -31
  48. bl_operators/node_editor/node_functions/__init__.pyi +9 -9
  49. bl_operators/object/__init__.pyi +31 -31
  50. bl_operators/object_align/__init__.pyi +5 -5
  51. bl_operators/object_quick_effects/__init__.pyi +9 -9
  52. bl_operators/object_randomize_transform/__init__.pyi +3 -3
  53. bl_operators/presets/__init__.pyi +18 -18
  54. bl_operators/rigidbody/__init__.pyi +7 -7
  55. bl_operators/screen_play_rendered_anim/__init__.pyi +2 -2
  56. bl_operators/sequencer/__init__.pyi +19 -19
  57. bl_operators/spreadsheet/__init__.pyi +4 -4
  58. bl_operators/userpref/__init__.pyi +42 -42
  59. bl_operators/uvcalc_follow_active/__init__.pyi +5 -5
  60. bl_operators/uvcalc_lightmap/__init__.pyi +8 -8
  61. bl_operators/uvcalc_transform/__init__.pyi +20 -20
  62. bl_operators/vertexpaint_dirt/__init__.pyi +4 -4
  63. bl_operators/view3d/__init__.pyi +21 -19
  64. bl_operators/wm/__init__.pyi +88 -88
  65. bl_operators/world/__init__.pyi +2 -2
  66. bl_previews_utils/bl_previews_render/__init__.pyi +9 -7
  67. bl_rna_utils/data_path/__init__.pyi +2 -2
  68. bl_text_utils/external_editor/__init__.pyi +1 -1
  69. bl_ui/__init__.pyi +10 -10
  70. bl_ui/anim/__init__.pyi +2 -2
  71. bl_ui/asset_shelf/__init__.pyi +2 -2
  72. bl_ui/generic_ui_list/__init__.pyi +6 -6
  73. bl_ui/node_add_menu/__init__.pyi +15 -13
  74. bl_ui/node_add_menu_compositor/__init__.pyi +18 -18
  75. bl_ui/node_add_menu_geometry/__init__.pyi +54 -54
  76. bl_ui/node_add_menu_shader/__init__.pyi +16 -16
  77. bl_ui/node_add_menu_texture/__init__.pyi +9 -9
  78. bl_ui/properties_animviz/__init__.pyi +2 -2
  79. bl_ui/properties_collection/__init__.pyi +10 -8
  80. bl_ui/properties_constraint/__init__.pyi +125 -125
  81. bl_ui/properties_data_armature/__init__.pyi +22 -22
  82. bl_ui/properties_data_bone/__init__.pyi +20 -20
  83. bl_ui/properties_data_camera/__init__.pyi +19 -19
  84. bl_ui/properties_data_curve/__init__.pyi +23 -23
  85. bl_ui/properties_data_curves/__init__.pyi +9 -9
  86. bl_ui/properties_data_empty/__init__.pyi +4 -4
  87. bl_ui/properties_data_grease_pencil/__init__.pyi +25 -25
  88. bl_ui/properties_data_lattice/__init__.pyi +4 -4
  89. bl_ui/properties_data_light/__init__.pyi +14 -14
  90. bl_ui/properties_data_lightprobe/__init__.pyi +18 -18
  91. bl_ui/properties_data_mesh/__init__.pyi +25 -58
  92. bl_ui/properties_data_metaball/__init__.pyi +6 -6
  93. bl_ui/properties_data_modifier/__init__.pyi +12 -12
  94. bl_ui/properties_data_pointcloud/__init__.pyi +8 -8
  95. bl_ui/properties_data_shaderfx/__init__.pyi +1 -1
  96. bl_ui/properties_data_speaker/__init__.pyi +5 -5
  97. bl_ui/properties_data_volume/__init__.pyi +9 -9
  98. bl_ui/properties_freestyle/__init__.pyi +51 -51
  99. bl_ui/properties_grease_pencil_common/__init__.pyi +30 -30
  100. bl_ui/properties_mask_common/__init__.pyi +24 -24
  101. bl_ui/properties_material/__init__.pyi +27 -27
  102. bl_ui/properties_material_gpencil/__init__.pyi +12 -12
  103. bl_ui/properties_object/__init__.pyi +29 -29
  104. bl_ui/properties_output/__init__.pyi +29 -29
  105. bl_ui/properties_paint_common/__init__.pyi +59 -50
  106. bl_ui/properties_particle/__init__.pyi +101 -101
  107. bl_ui/properties_physics_cloth/__init__.pyi +20 -20
  108. bl_ui/properties_physics_common/__init__.pyi +8 -8
  109. bl_ui/properties_physics_dynamicpaint/__init__.pyi +57 -57
  110. bl_ui/properties_physics_field/__init__.pyi +23 -23
  111. bl_ui/properties_physics_fluid/__init__.pyi +76 -76
  112. bl_ui/properties_physics_geometry_nodes/__init__.pyi +3 -3
  113. bl_ui/properties_physics_rigidbody/__init__.pyi +18 -18
  114. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +29 -29
  115. bl_ui/properties_physics_softbody/__init__.pyi +21 -21
  116. bl_ui/properties_render/__init__.pyi +81 -81
  117. bl_ui/properties_scene/__init__.pyi +22 -22
  118. bl_ui/properties_texture/__init__.pyi +39 -39
  119. bl_ui/properties_view_layer/__init__.pyi +12 -12
  120. bl_ui/properties_workspace/__init__.pyi +5 -5
  121. bl_ui/properties_world/__init__.pyi +18 -18
  122. bl_ui/space_clip/__init__.pyi +81 -81
  123. bl_ui/space_console/__init__.pyi +6 -6
  124. bl_ui/space_dopesheet/__init__.pyi +32 -32
  125. bl_ui/space_filebrowser/__init__.pyi +45 -45
  126. bl_ui/space_graph/__init__.pyi +21 -21
  127. bl_ui/space_image/__init__.pyi +73 -75
  128. bl_ui/space_info/__init__.pyi +6 -6
  129. bl_ui/space_nla/__init__.pyi +18 -18
  130. bl_ui/space_node/__init__.pyi +42 -42
  131. bl_ui/space_outliner/__init__.pyi +21 -21
  132. bl_ui/space_properties/__init__.pyi +6 -6
  133. bl_ui/space_sequencer/__init__.pyi +133 -133
  134. bl_ui/space_spreadsheet/__init__.pyi +4 -4
  135. bl_ui/space_statusbar/__init__.pyi +1 -1
  136. bl_ui/space_text/__init__.pyi +17 -17
  137. bl_ui/space_time/__init__.pyi +12 -12
  138. bl_ui/space_toolsystem_common/__init__.pyi +28 -26
  139. bl_ui/space_toolsystem_toolbar/__init__.pyi +36 -36
  140. bl_ui/space_topbar/__init__.pyi +32 -32
  141. bl_ui/space_userpref/__init__.pyi +132 -132
  142. bl_ui/space_view3d/__init__.pyi +297 -307
  143. bl_ui/space_view3d_toolbar/__init__.pyi +148 -149
  144. bl_ui/utils/__init__.pyi +5 -5
  145. bl_ui_utils/layout/__init__.pyi +1 -1
  146. blend_render_info/__init__.pyi +2 -2
  147. blf/__init__.pyi +15 -15
  148. bmesh/__init__.pyi +1 -1
  149. bmesh/ops/__init__.pyi +366 -357
  150. bmesh/types/__init__.pyi +59 -57
  151. bmesh/utils/__init__.pyi +2 -2
  152. bpy/app/__init__.pyi +3 -3
  153. bpy/app/icons/__init__.pyi +1 -1
  154. bpy/app/timers/__init__.pyi +2 -2
  155. bpy/app/translations/__init__.pyi +9 -9
  156. bpy/msgbus/__init__.pyi +15 -3
  157. bpy/ops/action/__init__.pyi +62 -38
  158. bpy/ops/anim/__init__.pyi +63 -61
  159. bpy/ops/armature/__init__.pyi +58 -48
  160. bpy/ops/asset/__init__.pyi +31 -20
  161. bpy/ops/boid/__init__.pyi +18 -8
  162. bpy/ops/brush/__init__.pyi +19 -16
  163. bpy/ops/buttons/__init__.pyi +14 -12
  164. bpy/ops/cachefile/__init__.pyi +9 -11
  165. bpy/ops/camera/__init__.pyi +2 -2
  166. bpy/ops/clip/__init__.pyi +112 -95
  167. bpy/ops/cloth/__init__.pyi +1 -1
  168. bpy/ops/collection/__init__.pyi +11 -9
  169. bpy/ops/console/__init__.pyi +37 -21
  170. bpy/ops/constraint/__init__.pyi +20 -18
  171. bpy/ops/curve/__init__.pyi +81 -51
  172. bpy/ops/curves/__init__.pyi +50 -30
  173. bpy/ops/cycles/__init__.pyi +3 -3
  174. bpy/ops/dpaint/__init__.pyi +5 -5
  175. bpy/ops/ed/__init__.pyi +19 -16
  176. bpy/ops/export_anim/__init__.pyi +1 -1
  177. bpy/ops/export_scene/__init__.pyi +2 -2
  178. bpy/ops/extensions/__init__.pyi +38 -32
  179. bpy/ops/file/__init__.pyi +72 -43
  180. bpy/ops/fluid/__init__.pyi +36 -14
  181. bpy/ops/font/__init__.pyi +41 -29
  182. bpy/ops/geometry/__init__.pyi +10 -10
  183. bpy/ops/gizmogroup/__init__.pyi +4 -2
  184. bpy/ops/gpencil/__init__.pyi +12 -8
  185. bpy/ops/graph/__init__.pyi +81 -68
  186. bpy/ops/grease_pencil/__init__.pyi +159 -115
  187. bpy/ops/image/__init__.pyi +63 -61
  188. bpy/ops/import_anim/__init__.pyi +1 -1
  189. bpy/ops/import_curve/__init__.pyi +1 -1
  190. bpy/ops/import_scene/__init__.pyi +2 -2
  191. bpy/ops/info/__init__.pyi +13 -7
  192. bpy/ops/lattice/__init__.pyi +14 -8
  193. bpy/ops/marker/__init__.pyi +13 -11
  194. bpy/ops/mask/__init__.pyi +59 -39
  195. bpy/ops/material/__init__.pyi +3 -3
  196. bpy/ops/mball/__init__.pyi +8 -8
  197. bpy/ops/mesh/__init__.pyi +182 -164
  198. bpy/ops/nla/__init__.pyi +65 -39
  199. bpy/ops/node/__init__.pyi +181 -150
  200. bpy/ops/object/__init__.pyi +262 -251
  201. bpy/ops/outliner/__init__.pyi +98 -72
  202. bpy/ops/paint/__init__.pyi +58 -54
  203. bpy/ops/paintcurve/__init__.pyi +12 -8
  204. bpy/ops/palette/__init__.pyi +11 -7
  205. bpy/ops/particle/__init__.pyi +58 -36
  206. bpy/ops/pointcloud/__init__.pyi +13 -7
  207. bpy/ops/pose/__init__.pyi +65 -51
  208. bpy/ops/poselib/__init__.pyi +17 -11
  209. bpy/ops/preferences/__init__.pyi +41 -38
  210. bpy/ops/ptcache/__init__.pyi +13 -7
  211. bpy/ops/render/__init__.pyi +17 -13
  212. bpy/ops/rigidbody/__init__.pyi +19 -13
  213. bpy/ops/scene/__init__.pyi +39 -37
  214. bpy/ops/screen/__init__.pyi +59 -45
  215. bpy/ops/script/__init__.pyi +5 -3
  216. bpy/ops/sculpt/__init__.pyi +44 -40
  217. bpy/ops/sculpt_curves/__init__.pyi +4 -4
  218. bpy/ops/sequencer/__init__.pyi +142 -115
  219. bpy/ops/sound/__init__.pyi +7 -16
  220. bpy/ops/spreadsheet/__init__.pyi +13 -7
  221. bpy/ops/surface/__init__.pyi +6 -6
  222. bpy/ops/text/__init__.pyi +73 -49
  223. bpy/ops/text_editor/__init__.pyi +1 -1
  224. bpy/ops/texture/__init__.pyi +8 -4
  225. bpy/ops/transform/__init__.pyi +29 -27
  226. bpy/ops/ui/__init__.pyi +42 -34
  227. bpy/ops/uilist/__init__.pyi +3 -3
  228. bpy/ops/uv/__init__.pyi +59 -49
  229. bpy/ops/view2d/__init__.pyi +14 -14
  230. bpy/ops/view3d/__init__.pyi +87 -67
  231. bpy/ops/wm/__init__.pyi +136 -574
  232. bpy/ops/workspace/__init__.pyi +11 -7
  233. bpy/ops/world/__init__.pyi +2 -2
  234. bpy/props/__init__.pyi +16 -13
  235. bpy/types/__init__.pyi +1237 -1281
  236. bpy/utils/__init__.pyi +23 -23
  237. bpy/utils/previews/__init__.pyi +3 -3
  238. bpy_extras/anim_utils/__init__.pyi +7 -7
  239. bpy_extras/bmesh_utils/__init__.pyi +1 -1
  240. bpy_extras/id_map_utils/__init__.pyi +3 -3
  241. bpy_extras/io_utils/__init__.pyi +14 -12
  242. bpy_extras/keyconfig_utils/__init__.pyi +3 -3
  243. bpy_extras/mesh_utils/__init__.pyi +2 -2
  244. bpy_extras/node_shader_utils/__init__.pyi +63 -63
  245. bpy_extras/node_utils/__init__.pyi +3 -3
  246. bpy_extras/object_utils/__init__.pyi +4 -4
  247. bpy_extras/wm_utils/progress_report/__init__.pyi +10 -10
  248. bpy_types/__init__.pyi +4 -4
  249. console_python/__init__.pyi +7 -7
  250. console_shell/__init__.pyi +5 -5
  251. {fake_bpy_module-20250604.dist-info → fake_bpy_module-20250607.dist-info}/METADATA +1 -1
  252. fake_bpy_module-20250607.dist-info/RECORD +367 -0
  253. freestyle/chainingiterators/__init__.pyi +35 -33
  254. freestyle/functions/__init__.pyi +55 -55
  255. freestyle/predicates/__init__.pyi +8 -8
  256. freestyle/shaders/__init__.pyi +79 -75
  257. freestyle/types/__init__.pyi +146 -142
  258. freestyle/utils/ContextFunctions/__init__.pyi +3 -1
  259. freestyle/utils/__init__.pyi +25 -25
  260. gpu/matrix/__init__.pyi +14 -14
  261. gpu/select/__init__.pyi +1 -1
  262. gpu/shader/__init__.pyi +1 -1
  263. gpu/state/__init__.pyi +19 -19
  264. gpu/types/__init__.pyi +50 -44
  265. gpu_extras/presets/__init__.pyi +2 -2
  266. graphviz_export/__init__.pyi +2 -2
  267. idprop/types/__init__.pyi +9 -9
  268. imbuf/__init__.pyi +3 -1
  269. imbuf/types/__init__.pyi +3 -3
  270. keyingsets_builtins/__init__.pyi +26 -26
  271. keyingsets_utils/__init__.pyi +14 -14
  272. mathutils/__init__.pyi +61 -53
  273. mathutils/bvhtree/__init__.pyi +4 -4
  274. mathutils/kdtree/__init__.pyi +3 -3
  275. mathutils/noise/__init__.pyi +1 -1
  276. nodeitems_builtins/__init__.pyi +4 -4
  277. nodeitems_utils/__init__.pyi +9 -9
  278. rna_info/__init__.pyi +25 -25
  279. rna_keymap_ui/__init__.pyi +6 -6
  280. rna_prop_ui/__init__.pyi +12 -12
  281. rna_xml/__init__.pyi +6 -6
  282. fake_bpy_module-20250604.dist-info/RECORD +0 -367
  283. {fake_bpy_module-20250604.dist-info → fake_bpy_module-20250607.dist-info}/WHEEL +0 -0
  284. {fake_bpy_module-20250604.dist-info → fake_bpy_module-20250607.dist-info}/top_level.txt +0 -0
@@ -19,14 +19,14 @@ import mathutils
19
19
  class BackboneStretcherShader:
20
20
  """Class hierarchy: `freestyle.types.StrokeShader` > `BackboneStretcherShader`[Geometry shader]"""
21
21
 
22
- def __init__(self, amount: float = 2.0):
22
+ def __init__(self, amount: float = 2.0) -> None:
23
23
  """Builds a BackboneStretcherShader object.
24
24
 
25
25
  :param amount: The stretching amount value.
26
26
  :type amount: float
27
27
  """
28
28
 
29
- def shade(self, stroke: freestyle.types.Stroke):
29
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
30
30
  """Stretches the stroke at its two extremities and following the
31
31
  respective directions: v(1)v(0) and v(n-1)v(n).
32
32
 
@@ -37,7 +37,7 @@ class BackboneStretcherShader:
37
37
  class BezierCurveShader:
38
38
  """Class hierarchy: `freestyle.types.StrokeShader` > `BezierCurveShader`[Geometry shader]"""
39
39
 
40
- def __init__(self, error: float = 4.0):
40
+ def __init__(self, error: float = 4.0) -> None:
41
41
  """Builds a BezierCurveShader object.
42
42
 
43
43
  :param error: The error we're allowing for the approximation. This
@@ -46,7 +46,7 @@ class BezierCurveShader:
46
46
  :type error: float
47
47
  """
48
48
 
49
- def shade(self, stroke: freestyle.types.Stroke):
49
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
50
50
  """Transforms the stroke backbone geometry so that it corresponds to a
51
51
  Bezier Curve approximation of the original backbone geometry.
52
52
 
@@ -59,7 +59,7 @@ class BlenderTextureShader:
59
59
 
60
60
  def __init__(
61
61
  self, texture: bpy.types.LineStyleTextureSlot | bpy.types.ShaderNodeTree
62
- ):
62
+ ) -> None:
63
63
  """Builds a BlenderTextureShader object.
64
64
 
65
65
  :param texture: A line style texture slot or a shader node tree to define
@@ -67,7 +67,7 @@ class BlenderTextureShader:
67
67
  :type texture: bpy.types.LineStyleTextureSlot | bpy.types.ShaderNodeTree
68
68
  """
69
69
 
70
- def shade(self, stroke: freestyle.types.Stroke):
70
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
71
71
  """Assigns a blender texture slot to the stroke shading in order to
72
72
  simulate marks.
73
73
 
@@ -84,7 +84,7 @@ class CalligraphicShader:
84
84
  thickness_max: float,
85
85
  orientation: collections.abc.Sequence[float] | mathutils.Vector,
86
86
  clamp: bool,
87
- ):
87
+ ) -> None:
88
88
  """Builds a CalligraphicShader object.
89
89
 
90
90
  :param thickness_min: The minimum thickness in the direction
@@ -101,7 +101,7 @@ class CalligraphicShader:
101
101
  :type clamp: bool
102
102
  """
103
103
 
104
- def shade(self, stroke: freestyle.types.Stroke):
104
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
105
105
  """Assigns thicknesses to the stroke vertices so that the stroke looks
106
106
  like made with a calligraphic tool, i.e. the stroke will be the
107
107
  thickest in a main direction, and the thinnest in the direction
@@ -114,7 +114,7 @@ class CalligraphicShader:
114
114
  class ColorNoiseShader:
115
115
  """Class hierarchy: `freestyle.types.StrokeShader` > `ColorNoiseShader`[Color shader]"""
116
116
 
117
- def __init__(self, amplitude: float, period: float):
117
+ def __init__(self, amplitude: float, period: float) -> None:
118
118
  """Builds a ColorNoiseShader object.
119
119
 
120
120
  :param amplitude: The amplitude of the noise signal.
@@ -123,7 +123,7 @@ class ColorNoiseShader:
123
123
  :type period: float
124
124
  """
125
125
 
126
- def shade(self, stroke: freestyle.types.Stroke):
126
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
127
127
  """Shader to add noise to the stroke colors.
128
128
 
129
129
  :param stroke: A Stroke object.
@@ -133,7 +133,9 @@ class ColorNoiseShader:
133
133
  class ConstantColorShader:
134
134
  """Class hierarchy: `freestyle.types.StrokeShader` > `ConstantColorShader`[Color shader]"""
135
135
 
136
- def __init__(self, red: float, green: float, blue: float, alpha: float = 1.0):
136
+ def __init__(
137
+ self, red: float, green: float, blue: float, alpha: float = 1.0
138
+ ) -> None:
137
139
  """Builds a ConstantColorShader object.
138
140
 
139
141
  :param red: The red component.
@@ -146,7 +148,7 @@ class ConstantColorShader:
146
148
  :type alpha: float
147
149
  """
148
150
 
149
- def shade(self, stroke: freestyle.types.Stroke):
151
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
150
152
  """Assigns a constant color to every vertex of the Stroke.
151
153
 
152
154
  :param stroke: A Stroke object.
@@ -156,14 +158,14 @@ class ConstantColorShader:
156
158
  class ConstantThicknessShader:
157
159
  """Class hierarchy: `freestyle.types.StrokeShader` > `ConstantThicknessShader`[Thickness shader]"""
158
160
 
159
- def __init__(self, thickness: float):
161
+ def __init__(self, thickness: float) -> None:
160
162
  """Builds a ConstantThicknessShader object.
161
163
 
162
164
  :param thickness: The thickness that must be assigned to the stroke.
163
165
  :type thickness: float
164
166
  """
165
167
 
166
- def shade(self, stroke: freestyle.types.Stroke):
168
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
167
169
  """Assigns an absolute constant thickness to every vertex of the Stroke.
168
170
 
169
171
  :param stroke: A Stroke object.
@@ -173,7 +175,9 @@ class ConstantThicknessShader:
173
175
  class ConstrainedIncreasingThicknessShader:
174
176
  """Class hierarchy: `freestyle.types.StrokeShader` > `ConstrainedIncreasingThicknessShader`[Thickness shader]"""
175
177
 
176
- def __init__(self, thickness_min: float, thickness_max: float, ratio: float):
178
+ def __init__(
179
+ self, thickness_min: float, thickness_max: float, ratio: float
180
+ ) -> None:
177
181
  """Builds a ConstrainedIncreasingThicknessShader object.
178
182
 
179
183
  :param thickness_min: The minimum thickness.
@@ -184,7 +188,7 @@ class ConstrainedIncreasingThicknessShader:
184
188
  :type ratio: float
185
189
  """
186
190
 
187
- def shade(self, stroke: freestyle.types.Stroke):
191
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
188
192
  """Same as the `IncreasingThicknessShader`, but here we allow
189
193
  the user to control the thickness/length ratio so that we don't get
190
194
  fat short lines.
@@ -196,7 +200,7 @@ class ConstrainedIncreasingThicknessShader:
196
200
  class GuidingLinesShader:
197
201
  """Class hierarchy: `freestyle.types.StrokeShader` > `GuidingLinesShader`[Geometry shader]"""
198
202
 
199
- def __init__(self, offset: float):
203
+ def __init__(self, offset: float) -> None:
200
204
  """Builds a GuidingLinesShader object.
201
205
 
202
206
  :param offset: The line that replaces the stroke is initially in the
@@ -206,7 +210,7 @@ class GuidingLinesShader:
206
210
  :type offset: float
207
211
  """
208
212
 
209
- def shade(self, stroke: freestyle.types.Stroke):
213
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
210
214
  """Shader to modify the Stroke geometry so that it corresponds to its
211
215
  main direction line. This shader must be used together with the
212
216
  splitting operator using the curvature criterion. Indeed, the
@@ -231,7 +235,7 @@ class IncreasingColorShader:
231
235
  green_max: float,
232
236
  blue_max: float,
233
237
  alpha_max: float,
234
- ):
238
+ ) -> None:
235
239
  """Builds an IncreasingColorShader object.
236
240
 
237
241
  :param red_min: The first color red component.
@@ -252,7 +256,7 @@ class IncreasingColorShader:
252
256
  :type alpha_max: float
253
257
  """
254
258
 
255
- def shade(self, stroke: freestyle.types.Stroke):
259
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
256
260
  """Assigns a varying color to the stroke. The user specifies two
257
261
  colors A and B. The stroke color will change linearly from A to B
258
262
  between the first and the last vertex.
@@ -264,7 +268,7 @@ class IncreasingColorShader:
264
268
  class IncreasingThicknessShader:
265
269
  """Class hierarchy: `freestyle.types.StrokeShader` > `IncreasingThicknessShader`[Thickness shader]"""
266
270
 
267
- def __init__(self, thickness_A: float, thickness_B: float):
271
+ def __init__(self, thickness_A: float, thickness_B: float) -> None:
268
272
  """Builds an IncreasingThicknessShader object.
269
273
 
270
274
  :param thickness_A: The first thickness value.
@@ -273,7 +277,7 @@ class IncreasingThicknessShader:
273
277
  :type thickness_B: float
274
278
  """
275
279
 
276
- def shade(self, stroke: freestyle.types.Stroke):
280
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
277
281
  """Assigns thicknesses values such as the thickness increases from a
278
282
  thickness value A to a thickness value B between the first vertex
279
283
  to the midpoint vertex and then decreases from B to a A between
@@ -287,7 +291,7 @@ class IncreasingThicknessShader:
287
291
  class PolygonalizationShader:
288
292
  """Class hierarchy: `freestyle.types.StrokeShader` > `PolygonalizationShader`[Geometry shader]"""
289
293
 
290
- def __init__(self, error: float):
294
+ def __init__(self, error: float) -> None:
291
295
  """Builds a PolygonalizationShader object.
292
296
 
293
297
  :param error: The error we want our polygonal approximation to have
@@ -297,7 +301,7 @@ class PolygonalizationShader:
297
301
  :type error: float
298
302
  """
299
303
 
300
- def shade(self, stroke: freestyle.types.Stroke):
304
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
301
305
  """Modifies the Stroke geometry so that it looks more "polygonal".
302
306
  The basic idea is to start from the minimal stroke approximation
303
307
  consisting in a line joining the first vertex to the last one and
@@ -309,13 +313,13 @@ class PolygonalizationShader:
309
313
  """
310
314
 
311
315
  class RoundCapShader:
312
- def round_cap_thickness(self, x):
316
+ def round_cap_thickness(self, x) -> None:
313
317
  """
314
318
 
315
319
  :param x:
316
320
  """
317
321
 
318
- def shade(self, stroke):
322
+ def shade(self, stroke) -> None:
319
323
  """
320
324
 
321
325
  :param stroke:
@@ -324,14 +328,14 @@ class RoundCapShader:
324
328
  class SamplingShader:
325
329
  """Class hierarchy: `freestyle.types.StrokeShader` > `SamplingShader`[Geometry shader]"""
326
330
 
327
- def __init__(self, sampling: float):
331
+ def __init__(self, sampling: float) -> None:
328
332
  """Builds a SamplingShader object.
329
333
 
330
334
  :param sampling: The sampling to use for the stroke resampling.
331
335
  :type sampling: float
332
336
  """
333
337
 
334
- def shade(self, stroke: freestyle.types.Stroke):
338
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
335
339
  """Resamples the stroke.
336
340
 
337
341
  :param stroke: A Stroke object.
@@ -351,7 +355,7 @@ class SmoothingShader:
351
355
  aniso_normal: float = 0.0,
352
356
  aniso_curvature: float = 0.0,
353
357
  carricature_factor: float = 1.0,
354
- ):
358
+ ) -> None:
355
359
  """Builds a SmoothingShader object.
356
360
 
357
361
  :param num_iterations: The number of iterations.
@@ -372,7 +376,7 @@ class SmoothingShader:
372
376
  :type carricature_factor: float
373
377
  """
374
378
 
375
- def shade(self, stroke: freestyle.types.Stroke):
379
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
376
380
  """Smooths the stroke by moving the vertices to make the stroke
377
381
  smoother. Uses curvature flow to converge towards a curve of
378
382
  constant curvature. The diffusion method we use is anisotropic to
@@ -392,7 +396,7 @@ class SpatialNoiseShader:
392
396
  num_octaves: int,
393
397
  smooth: bool,
394
398
  pure_random: bool,
395
- ):
399
+ ) -> None:
396
400
  """Builds a SpatialNoiseShader object.
397
401
 
398
402
  :param amount: The amplitude of the noise.
@@ -407,7 +411,7 @@ class SpatialNoiseShader:
407
411
  :type pure_random: bool
408
412
  """
409
413
 
410
- def shade(self, stroke: freestyle.types.Stroke):
414
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
411
415
  """Spatial Noise stroke shader. Moves the vertices to make the stroke
412
416
  more noisy.
413
417
 
@@ -416,7 +420,7 @@ class SpatialNoiseShader:
416
420
  """
417
421
 
418
422
  class SquareCapShader:
419
- def shade(self, stroke):
423
+ def shade(self, stroke) -> None:
420
424
  """
421
425
 
422
426
  :param stroke:
@@ -425,14 +429,14 @@ class SquareCapShader:
425
429
  class StrokeTextureStepShader:
426
430
  """Class hierarchy: `freestyle.types.StrokeShader` > `StrokeTextureStepShader`[Texture shader]"""
427
431
 
428
- def __init__(self, step: float):
432
+ def __init__(self, step: float) -> None:
429
433
  """Builds a StrokeTextureStepShader object.
430
434
 
431
435
  :param step: The spacing along the stroke.
432
436
  :type step: float
433
437
  """
434
438
 
435
- def shade(self, stroke: freestyle.types.Stroke):
439
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
436
440
  """Assigns a spacing factor to the texture coordinates of the Stroke.
437
441
 
438
442
  :param stroke: A Stroke object.
@@ -442,7 +446,7 @@ class StrokeTextureStepShader:
442
446
  class ThicknessNoiseShader:
443
447
  """Class hierarchy: `freestyle.types.StrokeShader` > `ThicknessNoiseShader`[Thickness shader]"""
444
448
 
445
- def __init__(self, amplitude: float, period: float):
449
+ def __init__(self, amplitude: float, period: float) -> None:
446
450
  """Builds a ThicknessNoiseShader object.
447
451
 
448
452
  :param amplitude: The amplitude of the noise signal.
@@ -451,7 +455,7 @@ class ThicknessNoiseShader:
451
455
  :type period: float
452
456
  """
453
457
 
454
- def shade(self, stroke: freestyle.types.Stroke):
458
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
455
459
  """Adds some noise to the stroke thickness.
456
460
 
457
461
  :param stroke: A Stroke object.
@@ -461,7 +465,7 @@ class ThicknessNoiseShader:
461
465
  class TipRemoverShader:
462
466
  """Class hierarchy: `freestyle.types.StrokeShader` > `TipRemoverShader`[Geometry shader]"""
463
467
 
464
- def __init__(self, tip_length: float):
468
+ def __init__(self, tip_length: float) -> None:
465
469
  """Builds a TipRemoverShader object.
466
470
 
467
471
  :param tip_length: The length of the piece of stroke we want to remove
@@ -469,7 +473,7 @@ class TipRemoverShader:
469
473
  :type tip_length: float
470
474
  """
471
475
 
472
- def shade(self, stroke: freestyle.types.Stroke):
476
+ def shade(self, stroke: freestyle.types.Stroke) -> None:
473
477
  """Removes the stroke's extremities.
474
478
 
475
479
  :param stroke: A Stroke object.
@@ -481,7 +485,7 @@ class py2DCurvatureColorShader:
481
485
  A higher curvature will yield a brighter color.
482
486
  """
483
487
 
484
- def shade(self, stroke):
488
+ def shade(self, stroke) -> None:
485
489
  """
486
490
 
487
491
  :param stroke:
@@ -490,7 +494,7 @@ class py2DCurvatureColorShader:
490
494
  class pyBackboneStretcherNoCuspShader:
491
495
  """Stretches the stroke's backbone, excluding cusp vertices (end junctions)."""
492
496
 
493
- def shade(self, stroke):
497
+ def shade(self, stroke) -> None:
494
498
  """
495
499
 
496
500
  :param stroke:
@@ -499,7 +503,7 @@ class pyBackboneStretcherNoCuspShader:
499
503
  class pyBackboneStretcherShader:
500
504
  """Stretches the stroke's backbone by a given length (in pixels)."""
501
505
 
502
- def shade(self, stroke):
506
+ def shade(self, stroke) -> None:
503
507
  """
504
508
 
505
509
  :param stroke:
@@ -508,7 +512,7 @@ class pyBackboneStretcherShader:
508
512
  class pyBluePrintCirclesShader:
509
513
  """Draws the silhouette of the object as a circle."""
510
514
 
511
- def shade(self, stroke):
515
+ def shade(self, stroke) -> None:
512
516
  """
513
517
 
514
518
  :param stroke:
@@ -517,21 +521,21 @@ class pyBluePrintCirclesShader:
517
521
  class pyBluePrintDirectedSquaresShader:
518
522
  """Replaces the stroke with a directed square."""
519
523
 
520
- def shade(self, stroke):
524
+ def shade(self, stroke) -> None:
521
525
  """
522
526
 
523
527
  :param stroke:
524
528
  """
525
529
 
526
530
  class pyBluePrintEllipsesShader:
527
- def shade(self, stroke):
531
+ def shade(self, stroke) -> None:
528
532
  """
529
533
 
530
534
  :param stroke:
531
535
  """
532
536
 
533
537
  class pyBluePrintSquaresShader:
534
- def shade(self, stroke):
538
+ def shade(self, stroke) -> None:
535
539
  """
536
540
 
537
541
  :param stroke:
@@ -540,7 +544,7 @@ class pyBluePrintSquaresShader:
540
544
  class pyConstantColorShader:
541
545
  """Assigns a constant color to the stroke."""
542
546
 
543
- def shade(self, stroke):
547
+ def shade(self, stroke) -> None:
544
548
  """
545
549
 
546
550
  :param stroke:
@@ -549,7 +553,7 @@ class pyConstantColorShader:
549
553
  class pyConstantThicknessShader:
550
554
  """Assigns a constant thickness along the stroke."""
551
555
 
552
- def shade(self, stroke):
556
+ def shade(self, stroke) -> None:
553
557
  """
554
558
 
555
559
  :param stroke:
@@ -560,7 +564,7 @@ class pyConstrainedIncreasingThicknessShader:
560
564
  stroke's length.
561
565
  """
562
566
 
563
- def shade(self, stroke):
567
+ def shade(self, stroke) -> None:
564
568
  """
565
569
 
566
570
  :param stroke:
@@ -569,7 +573,7 @@ class pyConstrainedIncreasingThicknessShader:
569
573
  class pyDecreasingThicknessShader:
570
574
  """Inverse of pyIncreasingThicknessShader, decreasingly thickens the stroke."""
571
575
 
572
- def shade(self, stroke):
576
+ def shade(self, stroke) -> None:
573
577
  """
574
578
 
575
579
  :param stroke:
@@ -580,7 +584,7 @@ class pyDepthDiscontinuityThicknessShader:
580
584
  to the camera (Z-value).
581
585
  """
582
586
 
583
- def shade(self, stroke):
587
+ def shade(self, stroke) -> None:
584
588
  """
585
589
 
586
590
  :param stroke:
@@ -593,7 +597,7 @@ class pyDiffusion2Shader:
593
597
  the stroke curve is) at the point.
594
598
  """
595
599
 
596
- def shade(self, stroke):
600
+ def shade(self, stroke) -> None:
597
601
  """
598
602
 
599
603
  :param stroke:
@@ -602,14 +606,14 @@ class pyDiffusion2Shader:
602
606
  class pyFXSVaryingThicknessWithDensityShader:
603
607
  """Assigns thickness to a stroke based on the density of the diffuse map."""
604
608
 
605
- def shade(self, stroke):
609
+ def shade(self, stroke) -> None:
606
610
  """
607
611
 
608
612
  :param stroke:
609
613
  """
610
614
 
611
615
  class pyGuidingLineShader:
612
- def shade(self, stroke):
616
+ def shade(self, stroke) -> None:
613
617
  """
614
618
 
615
619
  :param stroke:
@@ -620,7 +624,7 @@ class pyHLRShader:
620
624
  based on hidden line removal (HLR).
621
625
  """
622
626
 
623
- def shade(self, stroke):
627
+ def shade(self, stroke) -> None:
624
628
  """
625
629
 
626
630
  :param stroke:
@@ -632,7 +636,7 @@ class pyImportance2DThicknessShader:
632
636
  specified point have the lowest thickness.
633
637
  """
634
638
 
635
- def shade(self, stroke):
639
+ def shade(self, stroke) -> None:
636
640
  """
637
641
 
638
642
  :param stroke:
@@ -641,7 +645,7 @@ class pyImportance2DThicknessShader:
641
645
  class pyImportance3DThicknessShader:
642
646
  """Assigns thickness based on distance to a given point in 3D space."""
643
647
 
644
- def shade(self, stroke):
648
+ def shade(self, stroke) -> None:
645
649
  """
646
650
 
647
651
  :param stroke:
@@ -650,7 +654,7 @@ class pyImportance3DThicknessShader:
650
654
  class pyIncreasingColorShader:
651
655
  """Fades from one color to another along the stroke."""
652
656
 
653
- def shade(self, stroke):
657
+ def shade(self, stroke) -> None:
654
658
  """
655
659
 
656
660
  :param stroke:
@@ -659,7 +663,7 @@ class pyIncreasingColorShader:
659
663
  class pyIncreasingThicknessShader:
660
664
  """Increasingly thickens the stroke."""
661
665
 
662
- def shade(self, stroke):
666
+ def shade(self, stroke) -> None:
663
667
  """
664
668
 
665
669
  :param stroke:
@@ -668,7 +672,7 @@ class pyIncreasingThicknessShader:
668
672
  class pyInterpolateColorShader:
669
673
  """Fades from one color to another and back."""
670
674
 
671
- def shade(self, stroke):
675
+ def shade(self, stroke) -> None:
672
676
  """
673
677
 
674
678
  :param stroke:
@@ -680,7 +684,7 @@ class pyLengthDependingBackboneStretcherShader:
680
684
  is too high may yield unexpected results.
681
685
  """
682
686
 
683
- def shade(self, stroke):
687
+ def shade(self, stroke) -> None:
684
688
  """
685
689
 
686
690
  :param stroke:
@@ -689,7 +693,7 @@ class pyLengthDependingBackboneStretcherShader:
689
693
  class pyMaterialColorShader:
690
694
  """Assigns the color of the underlying material to the stroke."""
691
695
 
692
- def shade(self, stroke):
696
+ def shade(self, stroke) -> None:
693
697
  """
694
698
 
695
699
  :param stroke:
@@ -698,7 +702,7 @@ class pyMaterialColorShader:
698
702
  class pyModulateAlphaShader:
699
703
  """Limits the stroke's alpha between a min and max value."""
700
704
 
701
- def shade(self, stroke):
705
+ def shade(self, stroke) -> None:
702
706
  """
703
707
 
704
708
  :param stroke:
@@ -707,7 +711,7 @@ class pyModulateAlphaShader:
707
711
  class pyNonLinearVaryingThicknessShader:
708
712
  """Assigns thickness to a stroke based on an exponential function."""
709
713
 
710
- def shade(self, stroke):
714
+ def shade(self, stroke) -> None:
711
715
  """
712
716
 
713
717
  :param stroke:
@@ -719,7 +723,7 @@ class pyPerlinNoise1DShader:
719
723
  identically distorted.
720
724
  """
721
725
 
722
- def shade(self, stroke):
726
+ def shade(self, stroke) -> None:
723
727
  """
724
728
 
725
729
  :param stroke:
@@ -731,7 +735,7 @@ class pyPerlinNoise2DShader:
731
735
  https://freestyleintegration.wordpress.com/2011/09/25/development-updates-on-september-25/
732
736
  """
733
737
 
734
- def shade(self, stroke):
738
+ def shade(self, stroke) -> None:
735
739
  """
736
740
 
737
741
  :param stroke:
@@ -740,7 +744,7 @@ class pyPerlinNoise2DShader:
740
744
  class pyRandomColorShader:
741
745
  """Assigns a color to the stroke based on given seed."""
742
746
 
743
- def shade(self, stroke):
747
+ def shade(self, stroke) -> None:
744
748
  """
745
749
 
746
750
  :param stroke:
@@ -749,7 +753,7 @@ class pyRandomColorShader:
749
753
  class pySLERPThicknessShader:
750
754
  """Assigns thickness to a stroke based on spherical linear interpolation."""
751
755
 
752
- def shade(self, stroke):
756
+ def shade(self, stroke) -> None:
753
757
  """
754
758
 
755
759
  :param stroke:
@@ -760,7 +764,7 @@ class pySamplingShader:
760
764
  vertices specified.
761
765
  """
762
766
 
763
- def shade(self, stroke):
767
+ def shade(self, stroke) -> None:
764
768
  """
765
769
 
766
770
  :param stroke:
@@ -769,7 +773,7 @@ class pySamplingShader:
769
773
  class pySinusDisplacementShader:
770
774
  """Displaces the stroke in the shape of a sine wave."""
771
775
 
772
- def shade(self, stroke):
776
+ def shade(self, stroke) -> None:
773
777
  """
774
778
 
775
779
  :param stroke:
@@ -778,7 +782,7 @@ class pySinusDisplacementShader:
778
782
  class pyTVertexRemoverShader:
779
783
  """Removes t-vertices from the stroke."""
780
784
 
781
- def shade(self, stroke):
785
+ def shade(self, stroke) -> None:
782
786
  """
783
787
 
784
788
  :param stroke:
@@ -787,7 +791,7 @@ class pyTVertexRemoverShader:
787
791
  class pyTVertexThickenerShader:
788
792
  """Thickens TVertices (visual intersections between two edges)."""
789
793
 
790
- def shade(self, stroke):
794
+ def shade(self, stroke) -> None:
791
795
  """
792
796
 
793
797
  :param stroke:
@@ -798,7 +802,7 @@ class pyTimeColorShader:
798
802
  The brightness will increase along the stroke.
799
803
  """
800
804
 
801
- def shade(self, stroke):
805
+ def shade(self, stroke) -> None:
802
806
  """
803
807
 
804
808
  :param stroke:
@@ -807,7 +811,7 @@ class pyTimeColorShader:
807
811
  class pyTipRemoverShader:
808
812
  """Removes the tips of the stroke.Undocumented"""
809
813
 
810
- def shade(self, stroke):
814
+ def shade(self, stroke) -> None:
811
815
  """
812
816
 
813
817
  :param stroke:
@@ -818,7 +822,7 @@ class pyZDependingThicknessShader:
818
822
  closest to camera is 1, point furthest from camera is zero).
819
823
  """
820
824
 
821
- def shade(self, stroke):
825
+ def shade(self, stroke) -> None:
822
826
  """
823
827
 
824
828
  :param stroke: