fake-bpy-module 20240210__py3-none-any.whl → 20240326__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 (309) hide show
  1. addon_utils/__init__.pyi +54 -11
  2. animsys_refactor/__init__.pyi +36 -7
  3. aud/__init__.pyi +307 -321
  4. bgl/__init__.pyi +2926 -865
  5. bl_app_override/__init__.pyi +14 -4
  6. bl_app_override/helpers/__init__.pyi +24 -3
  7. bl_app_template_utils/__init__.pyi +19 -5
  8. bl_console_utils/__init__.pyi +0 -1
  9. bl_console_utils/autocomplete/__init__.pyi +2 -3
  10. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -6
  11. bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -4
  12. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -6
  13. bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -3
  14. bl_i18n_utils/__init__.pyi +2 -3
  15. bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -16
  16. bl_i18n_utils/merge_po/__init__.pyi +4 -2
  17. bl_i18n_utils/settings/__init__.pyi +53 -7
  18. bl_i18n_utils/utils/__init__.pyi +332 -45
  19. bl_i18n_utils/utils_cli/__init__.pyi +29 -7
  20. bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -2
  21. bl_i18n_utils/utils_rtl/__init__.pyi +9 -3
  22. bl_keymap_utils/__init__.pyi +2 -3
  23. bl_keymap_utils/io/__init__.pyi +44 -10
  24. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -2
  25. bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -2
  26. bl_keymap_utils/platform_helpers/__init__.pyi +9 -3
  27. bl_keymap_utils/versioning/__init__.pyi +4 -2
  28. bl_math/__init__.pyi +21 -22
  29. bl_operators/__init__.pyi +30 -24
  30. bl_operators/add_mesh_torus/__init__.pyi +171 -38
  31. bl_operators/anim/__init__.pyi +1065 -227
  32. bl_operators/assets/__init__.pyi +427 -93
  33. bl_operators/bmesh/__init__.pyi +0 -1
  34. bl_operators/bmesh/find_adjacent/__init__.pyi +44 -10
  35. bl_operators/clip/__init__.pyi +1342 -288
  36. bl_operators/console/__init__.pyi +647 -141
  37. bl_operators/constraint/__init__.pyi +524 -113
  38. bl_operators/file/__init__.pyi +396 -85
  39. bl_operators/freestyle/__init__.pyi +532 -114
  40. bl_operators/geometry_nodes/__init__.pyi +2412 -597
  41. bl_operators/image/__init__.pyi +380 -83
  42. bl_operators/mesh/__init__.pyi +401 -86
  43. bl_operators/node/__init__.pyi +1756 -385
  44. bl_operators/object/__init__.pyi +2022 -553
  45. bl_operators/object_align/__init__.pyi +145 -32
  46. bl_operators/object_quick_effects/__init__.pyi +555 -125
  47. bl_operators/object_randomize_transform/__init__.pyi +136 -33
  48. bl_operators/presets/__init__.pyi +3516 -709
  49. bl_operators/rigidbody/__init__.pyi +401 -86
  50. bl_operators/screen_play_rendered_anim/__init__.pyi +129 -30
  51. bl_operators/sequencer/__init__.pyi +731 -150
  52. bl_operators/spreadsheet/__init__.pyi +145 -31
  53. bl_operators/userpref/__init__.pyi +3416 -825
  54. bl_operators/uvcalc_follow_active/__init__.pyi +149 -33
  55. bl_operators/uvcalc_lightmap/__init__.pyi +187 -35
  56. bl_operators/uvcalc_transform/__init__.pyi +344 -74
  57. bl_operators/vertexpaint_dirt/__init__.pyi +140 -31
  58. bl_operators/view3d/__init__.pyi +697 -147
  59. bl_operators/wm/__init__.pyi +6287 -1534
  60. bl_previews_utils/__init__.pyi +0 -1
  61. bl_previews_utils/bl_previews_render/__init__.pyi +34 -8
  62. bl_rna_utils/__init__.pyi +0 -1
  63. bl_rna_utils/data_path/__init__.pyi +12 -3
  64. bl_text_utils/__init__.pyi +0 -1
  65. bl_text_utils/external_editor/__init__.pyi +4 -2
  66. bl_ui/__init__.pyi +567 -170
  67. bl_ui/anim/__init__.pyi +164 -34
  68. bl_ui/asset_shelf/__init__.pyi +146 -32
  69. bl_ui/generic_ui_list/__init__.pyi +471 -100
  70. bl_ui/node_add_menu/__init__.pyi +196 -41
  71. bl_ui/node_add_menu_compositor/__init__.pyi +3017 -622
  72. bl_ui/node_add_menu_geometry/__init__.pyi +8075 -1592
  73. bl_ui/node_add_menu_shader/__init__.pyi +1709 -349
  74. bl_ui/node_add_menu_texture/__init__.pyi +1502 -306
  75. bl_ui/properties_animviz/__init__.pyi +32 -3
  76. bl_ui/properties_collection/__init__.pyi +787 -180
  77. bl_ui/properties_constraint/__init__.pyi +28635 -5524
  78. bl_ui/properties_data_armature/__init__.pyi +1905 -449
  79. bl_ui/properties_data_bone/__init__.pyi +1560 -337
  80. bl_ui/properties_data_camera/__init__.pyi +2269 -495
  81. bl_ui/properties_data_curve/__init__.pyi +2362 -535
  82. bl_ui/properties_data_curves/__init__.pyi +951 -204
  83. bl_ui/properties_data_empty/__init__.pyi +317 -70
  84. bl_ui/properties_data_gpencil/__init__.pyi +2924 -735
  85. bl_ui/properties_data_grease_pencil/__init__.pyi +1631 -189
  86. bl_ui/properties_data_lattice/__init__.pyi +472 -105
  87. bl_ui/properties_data_light/__init__.pyi +1570 -338
  88. bl_ui/properties_data_lightprobe/__init__.pyi +938 -209
  89. bl_ui/properties_data_mesh/__init__.pyi +3205 -768
  90. bl_ui/properties_data_metaball/__init__.pyi +774 -171
  91. bl_ui/properties_data_modifier/__init__.pyi +1554 -329
  92. bl_ui/properties_data_pointcloud/__init__.pyi +821 -195
  93. bl_ui/properties_data_shaderfx/__init__.pyi +154 -35
  94. bl_ui/properties_data_speaker/__init__.pyi +782 -169
  95. bl_ui/properties_data_volume/__init__.pyi +1243 -282
  96. bl_ui/properties_freestyle/__init__.pyi +4071 -1031
  97. bl_ui/properties_grease_pencil_common/__init__.pyi +2399 -484
  98. bl_ui/properties_mask_common/__init__.pyi +1256 -250
  99. bl_ui/properties_material/__init__.pyi +2351 -543
  100. bl_ui/properties_material_gpencil/__init__.pyi +1590 -366
  101. bl_ui/properties_object/__init__.pyi +2179 -513
  102. bl_ui/properties_output/__init__.pyi +2956 -706
  103. bl_ui/properties_paint_common/__init__.pyi +947 -141
  104. bl_ui/properties_particle/__init__.pyi +8322 -1971
  105. bl_ui/properties_physics_cloth/__init__.pyi +2254 -509
  106. bl_ui/properties_physics_common/__init__.pyi +200 -45
  107. bl_ui/properties_physics_dynamicpaint/__init__.pyi +4454 -966
  108. bl_ui/properties_physics_field/__init__.pyi +1695 -365
  109. bl_ui/properties_physics_fluid/__init__.pyi +6127 -1281
  110. bl_ui/properties_physics_geometry_nodes/__init__.pyi +157 -33
  111. bl_ui/properties_physics_rigidbody/__init__.pyi +1254 -279
  112. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +2053 -484
  113. bl_ui/properties_physics_softbody/__init__.pyi +2394 -543
  114. bl_ui/properties_render/__init__.pyi +8312 -1934
  115. bl_ui/properties_scene/__init__.pyi +2211 -540
  116. bl_ui/properties_texture/__init__.pyi +4185 -1014
  117. bl_ui/properties_view_layer/__init__.pyi +2803 -665
  118. bl_ui/properties_workspace/__init__.pyi +626 -149
  119. bl_ui/properties_world/__init__.pyi +1092 -235
  120. bl_ui/space_clip/__init__.pyi +11475 -2806
  121. bl_ui/space_console/__init__.pyi +967 -203
  122. bl_ui/space_dopesheet/__init__.pyi +4260 -967
  123. bl_ui/space_filebrowser/__init__.pyi +4852 -1188
  124. bl_ui/space_graph/__init__.pyi +3251 -703
  125. bl_ui/space_image/__init__.pyi +12218 -2968
  126. bl_ui/space_info/__init__.pyi +964 -201
  127. bl_ui/space_nla/__init__.pyi +2756 -585
  128. bl_ui/space_node/__init__.pyi +5661 -1266
  129. bl_ui/space_outliner/__init__.pyi +2294 -479
  130. bl_ui/space_properties/__init__.pyi +417 -93
  131. bl_ui/space_sequencer/__init__.pyi +12436 -3010
  132. bl_ui/space_spreadsheet/__init__.pyi +184 -37
  133. bl_ui/space_statusbar/__init__.pyi +135 -31
  134. bl_ui/space_text/__init__.pyi +2556 -543
  135. bl_ui/space_time/__init__.pyi +1151 -244
  136. bl_ui/space_toolsystem_common/__init__.pyi +368 -67
  137. bl_ui/space_toolsystem_toolbar/__init__.pyi +1378 -229
  138. bl_ui/space_topbar/__init__.pyi +4214 -888
  139. bl_ui/space_userpref/__init__.pyi +13920 -3468
  140. bl_ui/space_view3d/__init__.pyi +42751 -9613
  141. bl_ui/space_view3d_toolbar/__init__.pyi +16379 -3860
  142. bl_ui/utils/__init__.pyi +42 -5
  143. bl_ui_utils/__init__.pyi +0 -1
  144. bl_ui_utils/bug_report_url/__init__.pyi +4 -2
  145. bl_ui_utils/layout/__init__.pyi +4 -2
  146. blend_render_info/__init__.pyi +13 -4
  147. blf/__init__.pyi +15 -18
  148. bmesh/__init__.pyi +18 -18
  149. bmesh/geometry/__init__.pyi +5 -6
  150. bmesh/ops/__init__.pyi +1337 -1158
  151. bmesh/types/__init__.pyi +464 -374
  152. bmesh/utils/__init__.pyi +64 -70
  153. bpy/__init__.pyi +6 -7
  154. bpy/app/__init__.pyi +36 -38
  155. bpy/app/handlers/__init__.pyi +37 -38
  156. bpy/app/icons/__init__.pyi +8 -11
  157. bpy/app/timers/__init__.pyi +18 -17
  158. bpy/app/translations/__init__.pyi +32 -30
  159. bpy/msgbus/__init__.pyi +25 -20
  160. bpy/ops/__init__.pyi +63 -64
  161. bpy/ops/action/__init__.pyi +408 -436
  162. bpy/ops/anim/__init__.pyi +459 -577
  163. bpy/ops/armature/__init__.pyi +396 -498
  164. bpy/ops/asset/__init__.pyi +187 -213
  165. bpy/ops/boid/__init__.pyi +50 -68
  166. bpy/ops/brush/__init__.pyi +72 -97
  167. bpy/ops/buttons/__init__.pyi +202 -193
  168. bpy/ops/cachefile/__init__.pyi +198 -188
  169. bpy/ops/camera/__init__.pyi +24 -31
  170. bpy/ops/clip/__init__.pyi +1021 -1082
  171. bpy/ops/cloth/__init__.pyi +11 -15
  172. bpy/ops/collection/__init__.pyi +36 -51
  173. bpy/ops/console/__init__.pyi +155 -209
  174. bpy/ops/constraint/__init__.pyi +286 -254
  175. bpy/ops/curve/__init__.pyi +597 -659
  176. bpy/ops/curves/__init__.pyi +191 -225
  177. bpy/ops/cycles/__init__.pyi +21 -30
  178. bpy/ops/dpaint/__init__.pyi +34 -47
  179. bpy/ops/ed/__init__.pyi +160 -176
  180. bpy/ops/export_anim/__init__.pyi +51 -34
  181. bpy/ops/export_mesh/__init__.pyi +47 -45
  182. bpy/ops/export_scene/__init__.pyi +659 -504
  183. bpy/ops/file/__init__.pyi +469 -474
  184. bpy/ops/fluid/__init__.pyi +89 -119
  185. bpy/ops/font/__init__.pyi +325 -361
  186. bpy/ops/geometry/__init__.pyi +86 -114
  187. bpy/ops/gizmogroup/__init__.pyi +22 -28
  188. bpy/ops/gpencil/__init__.pyi +1900 -1976
  189. bpy/ops/graph/__init__.pyi +875 -894
  190. bpy/ops/grease_pencil/__init__.pyi +572 -508
  191. bpy/ops/image/__init__.pyi +805 -855
  192. bpy/ops/import_anim/__init__.pyi +66 -46
  193. bpy/ops/import_curve/__init__.pyi +7 -11
  194. bpy/ops/import_mesh/__init__.pyi +19 -25
  195. bpy/ops/import_scene/__init__.pyi +164 -147
  196. bpy/ops/info/__init__.pyi +88 -85
  197. bpy/ops/lattice/__init__.pyi +86 -90
  198. bpy/ops/marker/__init__.pyi +135 -146
  199. bpy/ops/mask/__init__.pyi +372 -436
  200. bpy/ops/material/__init__.pyi +18 -25
  201. bpy/ops/mball/__init__.pyi +93 -99
  202. bpy/ops/mesh/__init__.pyi +2525 -2664
  203. bpy/ops/nla/__init__.pyi +398 -455
  204. bpy/ops/node/__init__.pyi +1015 -1207
  205. bpy/ops/object/__init__.pyi +3423 -3390
  206. bpy/ops/outliner/__init__.pyi +667 -685
  207. bpy/ops/paint/__init__.pyi +719 -672
  208. bpy/ops/paintcurve/__init__.pyi +64 -85
  209. bpy/ops/palette/__init__.pyi +48 -67
  210. bpy/ops/particle/__init__.pyi +323 -367
  211. bpy/ops/pose/__init__.pyi +569 -474
  212. bpy/ops/poselib/__init__.pyi +77 -100
  213. bpy/ops/preferences/__init__.pyi +460 -512
  214. bpy/ops/ptcache/__init__.pyi +46 -63
  215. bpy/ops/render/__init__.pyi +121 -155
  216. bpy/ops/rigidbody/__init__.pyi +148 -143
  217. bpy/ops/scene/__init__.pyi +336 -380
  218. bpy/ops/screen/__init__.pyi +454 -530
  219. bpy/ops/script/__init__.pyi +19 -28
  220. bpy/ops/sculpt/__init__.pyi +734 -587
  221. bpy/ops/sculpt_curves/__init__.pyi +51 -56
  222. bpy/ops/sequencer/__init__.pyi +1617 -1500
  223. bpy/ops/sound/__init__.pyi +392 -315
  224. bpy/ops/spreadsheet/__init__.pyi +31 -42
  225. bpy/ops/surface/__init__.pyi +198 -163
  226. bpy/ops/text/__init__.pyi +479 -545
  227. bpy/ops/text_editor/__init__.pyi +11 -15
  228. bpy/ops/texture/__init__.pyi +26 -36
  229. bpy/ops/transform/__init__.pyi +825 -941
  230. bpy/ops/ui/__init__.pyi +246 -295
  231. bpy/ops/uilist/__init__.pyi +34 -38
  232. bpy/ops/uv/__init__.pyi +912 -824
  233. bpy/ops/view2d/__init__.pyi +157 -197
  234. bpy/ops/view3d/__init__.pyi +777 -878
  235. bpy/ops/wm/__init__.pyi +4102 -3595
  236. bpy/ops/workspace/__init__.pyi +42 -58
  237. bpy/ops/world/__init__.pyi +6 -9
  238. bpy/path/__init__.pyi +166 -109
  239. bpy/props/__init__.pyi +478 -395
  240. bpy/types/__init__.pyi +87194 -81467
  241. bpy/utils/__init__.pyi +325 -169
  242. bpy/utils/previews/__init__.pyi +108 -21
  243. bpy/utils/units/__init__.pyi +37 -39
  244. bpy_extras/__init__.pyi +4 -9
  245. bpy_extras/anim_utils/__init__.pyi +25 -55
  246. bpy_extras/asset_utils/__init__.pyi +3 -13
  247. bpy_extras/id_map_utils/__init__.pyi +1 -4
  248. bpy_extras/image_utils/__init__.pyi +33 -23
  249. bpy_extras/io_utils/__init__.pyi +116 -66
  250. bpy_extras/keyconfig_utils/__init__.pyi +5 -3
  251. bpy_extras/mesh_utils/__init__.pyi +42 -34
  252. bpy_extras/node_utils/__init__.pyi +4 -4
  253. bpy_extras/object_utils/__init__.pyi +58 -43
  254. bpy_extras/view3d_utils/__init__.pyi +64 -63
  255. bpy_restrict_state/__init__.pyi +14 -2
  256. bpy_types/__init__.pyi +3873 -998
  257. console_python/__init__.pyi +41 -8
  258. console_shell/__init__.pyi +24 -6
  259. {fake_bpy_module-20240210.dist-info → fake_bpy_module-20240326.dist-info}/METADATA +1 -1
  260. fake_bpy_module-20240326.dist-info/RECORD +343 -0
  261. {fake_bpy_module-20240210.dist-info → fake_bpy_module-20240326.dist-info}/WHEEL +1 -1
  262. freestyle/__init__.pyi +4 -5
  263. freestyle/chainingiterators/__init__.pyi +229 -73
  264. freestyle/functions/__init__.pyi +624 -402
  265. freestyle/predicates/__init__.pyi +381 -169
  266. freestyle/shaders/__init__.pyi +424 -155
  267. freestyle/types/__init__.pyi +1572 -726
  268. freestyle/utils/ContextFunctions/__init__.pyi +54 -43
  269. freestyle/utils/__init__.pyi +67 -31
  270. gpu/__init__.pyi +3 -4
  271. gpu/capabilities/__init__.pyi +57 -37
  272. gpu/matrix/__init__.pyi +14 -17
  273. gpu/platform/__init__.pyi +5 -6
  274. gpu/select/__init__.pyi +2 -5
  275. gpu/shader/__init__.pyi +14 -12
  276. gpu/state/__init__.pyi +48 -62
  277. gpu/texture/__init__.pyi +7 -7
  278. gpu/types/__init__.pyi +670 -229
  279. gpu_extras/__init__.pyi +1 -2
  280. gpu_extras/batch/__init__.pyi +27 -6
  281. gpu_extras/presets/__init__.pyi +67 -27
  282. graphviz_export/__init__.pyi +9 -3
  283. idprop/__init__.pyi +0 -1
  284. idprop/types/__init__.pyi +42 -13
  285. imbuf/__init__.pyi +6 -10
  286. imbuf/types/__init__.pyi +8 -16
  287. keyingsets_builtins/__init__.pyi +3149 -702
  288. keyingsets_utils/__init__.pyi +69 -15
  289. mathutils/__init__.pyi +951 -876
  290. mathutils/bvhtree/__init__.pyi +47 -48
  291. mathutils/geometry/__init__.pyi +237 -242
  292. mathutils/interpolate/__init__.pyi +3 -6
  293. mathutils/kdtree/__init__.pyi +23 -26
  294. mathutils/noise/__init__.pyi +50 -51
  295. nodeitems_builtins/__init__.pyi +50 -11
  296. nodeitems_utils/__init__.pyi +58 -11
  297. rna_info/__init__.pyi +230 -27
  298. rna_keymap_ui/__init__.pyi +29 -7
  299. rna_prop_ui/__init__.pyi +69 -13
  300. rna_xml/__init__.pyi +29 -7
  301. sys_info/__init__.pyi +4 -2
  302. bpy_extras/bmesh_utils/__init__.pyi +0 -7
  303. bpy_extras/extensions/__init__.pyi +0 -5
  304. bpy_extras/extensions/junction_module/__init__.pyi +0 -13
  305. bpy_extras/node_shader_utils/__init__.pyi +0 -132
  306. bpy_extras/wm_utils/__init__.pyi +0 -5
  307. bpy_extras/wm_utils/progress_report/__init__.pyi +0 -30
  308. fake_bpy_module-20240210.dist-info/RECORD +0 -349
  309. {fake_bpy_module-20240210.dist-info → fake_bpy_module-20240326.dist-info}/top_level.txt +0 -0
@@ -1,4 +1,3 @@
1
- import sys
2
1
  import typing
3
2
  import freestyle.types
4
3
  import mathutils
@@ -12,11 +11,11 @@ class ChainingTimeStampF1D:
12
11
  """Builds a ChainingTimeStampF1D object."""
13
12
  ...
14
13
 
15
- def __call__(self, inter: "freestyle.types.Interface1D"):
14
+ def __call__(self, inter: freestyle.types.Interface1D):
16
15
  """Sets the chaining time stamp of the Interface1D.
17
16
 
18
17
  :param inter: An Interface1D object.
19
- :type inter: 'freestyle.types.Interface1D'
18
+ :type inter: freestyle.types.Interface1D
20
19
  """
21
20
  ...
22
21
 
@@ -27,42 +26,52 @@ class Curvature2DAngleF0D:
27
26
  """Builds a Curvature2DAngleF0D object."""
28
27
  ...
29
28
 
30
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
31
- """Returns a real value giving the 2D curvature (as an angle) of the 1D element to which the `freestyle.types.Interface0D` pointed by the Interface0DIterator belongs. The 2D curvature is evaluated at the Interface0D.
29
+ def __call__(
30
+ self, it: freestyle.types.Interface0DIterator
31
+ ) -> freestyle.types.Interface0DIterator:
32
+ """Returns a real value giving the 2D curvature (as an angle) of the 1D
33
+ element to which the `freestyle.types.Interface0D` pointed by
34
+ the Interface0DIterator belongs. The 2D curvature is evaluated at the
35
+ Interface0D.
32
36
 
33
- :param it: An Interface0DIterator object.
34
- :type it: 'freestyle.types.Interface0DIterator'
35
- :rtype: float
36
- :return: The 2D curvature of the 1D element evaluated at the pointed Interface0D.
37
+ :param it: An Interface0DIterator object.
38
+ :type it: freestyle.types.Interface0DIterator
39
+ :return: The 2D curvature of the 1D element evaluated at the
40
+ pointed Interface0D.
41
+ :rtype: float
37
42
  """
38
43
  ...
39
44
 
40
45
  class Curvature2DAngleF1D:
41
46
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `Curvature2DAngleF1D`"""
42
47
 
43
- def __init__(
44
- self,
45
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
46
- ):
48
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
47
49
  """Builds a Curvature2DAngleF1D object.
48
50
 
49
- :param integration_type: The integration method used to compute a single value from a set of values.
50
- :type integration_type: 'freestyle.types.IntegrationType'
51
+ :param integration_type: The integration method used to compute a single value
52
+ from a set of values.
53
+ :type integration_type: freestyle.types.IntegrationType
51
54
  """
52
55
  ...
53
56
 
54
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
57
+ def __call__(
58
+ self, inter: freestyle.types.Interface1D
59
+ ) -> freestyle.types.Interface1D:
55
60
  """Returns the 2D curvature as an angle for an Interface1D.
56
61
 
57
62
  :param inter: An Interface1D object.
58
- :type inter: 'freestyle.types.Interface1D'
59
- :rtype: float
63
+ :type inter: freestyle.types.Interface1D
60
64
  :return: The 2D curvature as an angle.
65
+ :rtype: float
61
66
  """
62
67
  ...
63
68
 
64
69
  class CurveMaterialF0D:
65
- """A replacement of the built-in MaterialF0D for stroke creation. MaterialF0D does not work with Curves and Strokes. Line color priority is used to pick one of the two materials at material boundaries. Notes: expects instances of CurvePoint to be iterated over can return None if no fedge can be found"""
70
+ """A replacement of the built-in MaterialF0D for stroke creation.
71
+ MaterialF0D does not work with Curves and Strokes. Line color
72
+ priority is used to pick one of the two materials at material
73
+ boundaries.
74
+ """
66
75
 
67
76
  ...
68
77
 
@@ -74,40 +83,46 @@ class CurveNatureF0D:
74
83
  ...
75
84
 
76
85
  def __call__(
77
- self, it: "freestyle.types.Interface0DIterator"
78
- ) -> "freestyle.types.Nature":
79
- """Returns the `freestyle.types.Nature` of the 1D element the Interface0D pointed by the Interface0DIterator belongs to.
86
+ self, it: freestyle.types.Interface0DIterator
87
+ ) -> freestyle.types.Interface0DIterator:
88
+ """Returns the `freestyle.types.Nature` of the 1D element the
89
+ Interface0D pointed by the Interface0DIterator belongs to.
80
90
 
81
- :param it: An Interface0DIterator object.
82
- :type it: 'freestyle.types.Interface0DIterator'
83
- :rtype: 'freestyle.types.Nature'
84
- :return: The nature of the 1D element to which the pointed Interface0D belongs.
91
+ :param it: An Interface0DIterator object.
92
+ :type it: freestyle.types.Interface0DIterator
93
+ :return: The nature of the 1D element to which the pointed Interface0D
94
+ belongs.
95
+ :rtype: freestyle.types.Nature
85
96
  """
86
97
  ...
87
98
 
88
99
  class CurveNatureF1D:
89
100
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DEdgeNature` > `CurveNatureF1D`"""
90
101
 
91
- def __init__(
92
- self,
93
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
94
- ):
102
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
95
103
  """Builds a CurveNatureF1D object.
96
104
 
97
- :param integration_type: The integration method used to compute a single value from a set of values.
98
- :type integration_type: 'freestyle.types.IntegrationType'
105
+ :param integration_type: The integration method used to compute a single value
106
+ from a set of values.
107
+ :type integration_type: freestyle.types.IntegrationType
99
108
  """
100
109
  ...
101
110
 
102
111
  def __call__(
103
- self, inter: "freestyle.types.Interface1D"
104
- ) -> "freestyle.types.Nature":
105
- """Returns the nature of the Interface1D (silhouette, ridge, crease, and so on). Except if the Interface1D is a `freestyle.types.ViewEdge`, this result might be ambiguous. Indeed, the Interface1D might result from the gathering of several 1D elements, each one being of a different nature. An integration method, such as the MEAN, might give, in this case, irrelevant results.
112
+ self, inter: freestyle.types.Interface1D
113
+ ) -> freestyle.types.Interface1D:
114
+ """Returns the nature of the Interface1D (silhouette, ridge, crease, and
115
+ so on). Except if the Interface1D is a
116
+ `freestyle.types.ViewEdge`, this result might be ambiguous.
117
+ Indeed, the Interface1D might result from the gathering of several 1D
118
+ elements, each one being of a different nature. An integration
119
+ method, such as the MEAN, might give, in this case, irrelevant
120
+ results.
106
121
 
107
- :param inter: An Interface1D object.
108
- :type inter: 'freestyle.types.Interface1D'
109
- :rtype: 'freestyle.types.Nature'
110
- :return: The nature of the Interface1D.
122
+ :param inter: An Interface1D object.
123
+ :type inter: freestyle.types.Interface1D
124
+ :return: The nature of the Interface1D.
125
+ :rtype: freestyle.types.Nature
111
126
  """
112
127
  ...
113
128
 
@@ -117,18 +132,27 @@ class DensityF0D:
117
132
  def __init__(self, sigma: float = 2.0):
118
133
  """Builds a DensityF0D object.
119
134
 
120
- :param sigma: The gaussian sigma value indicating the X value for which the gaussian function is 0.5. It leads to the window size value (the larger, the smoother).
121
- :type sigma: float
135
+ :param sigma: The gaussian sigma value indicating the X value for
136
+ which the gaussian function is 0.5. It leads to the window size
137
+ value (the larger, the smoother).
138
+ :type sigma: float
122
139
  """
123
140
  ...
124
141
 
125
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
126
- """Returns the density of the (result) image evaluated at the `freestyle.types.Interface0D` pointed by the Interface0DIterator. This density is evaluated using a pixels square window around the evaluation point and integrating these values using a gaussian.
142
+ def __call__(
143
+ self, it: freestyle.types.Interface0DIterator
144
+ ) -> freestyle.types.Interface0DIterator:
145
+ """Returns the density of the (result) image evaluated at the
146
+ `freestyle.types.Interface0D` pointed by the
147
+ Interface0DIterator. This density is evaluated using a pixels square
148
+ window around the evaluation point and integrating these values using
149
+ a gaussian.
127
150
 
128
- :param it: An Interface0DIterator object.
129
- :type it: 'freestyle.types.Interface0DIterator'
130
- :rtype: float
131
- :return: The density of the image evaluated at the pointed Interface0D.
151
+ :param it: An Interface0DIterator object.
152
+ :type it: freestyle.types.Interface0DIterator
153
+ :return: The density of the image evaluated at the pointed
154
+ Interface0D.
155
+ :rtype: float
132
156
  """
133
157
  ...
134
158
 
@@ -138,27 +162,38 @@ class DensityF1D:
138
162
  def __init__(
139
163
  self,
140
164
  sigma: float = 2.0,
141
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
165
+ integration_type: freestyle.types.IntegrationType = None,
142
166
  sampling: float = 2.0,
143
167
  ):
144
168
  """Builds a DensityF1D object.
145
169
 
146
- :param sigma: The sigma used in DensityF0D and determining the window size used in each density query.
147
- :type sigma: float
148
- :param integration_type: The integration method used to compute a single value from a set of values.
149
- :type integration_type: 'freestyle.types.IntegrationType'
150
- :param sampling: the corresponding 0D function is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by integration_type.
151
- :type sampling: float
170
+ :param sigma: The sigma used in DensityF0D and determining the window size
171
+ used in each density query.
172
+ :type sigma: float
173
+ :param integration_type: The integration method used to compute a single value
174
+ from a set of values.
175
+ :type integration_type: freestyle.types.IntegrationType
176
+ :param sampling: The resolution used to sample the chain: the
177
+ corresponding 0D function is evaluated at each sample point and
178
+ the result is obtained by combining the resulting values into a
179
+ single one, following the method specified by integration_type.
180
+ :type sampling: float
152
181
  """
153
182
  ...
154
183
 
155
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
156
- """Returns the density evaluated for an Interface1D. The density is evaluated for a set of points along the Interface1D (using the `freestyle.functions.DensityF0D` functor) with a user-defined sampling and then integrated into a single value using a user-defined integration method.
184
+ def __call__(
185
+ self, inter: freestyle.types.Interface1D
186
+ ) -> freestyle.types.Interface1D:
187
+ """Returns the density evaluated for an Interface1D. The density is
188
+ evaluated for a set of points along the Interface1D (using the
189
+ `freestyle.functions.DensityF0D` functor) with a user-defined
190
+ sampling and then integrated into a single value using a user-defined
191
+ integration method.
157
192
 
158
- :param inter: An Interface1D object.
159
- :type inter: 'freestyle.types.Interface1D'
160
- :rtype: float
161
- :return: The density evaluated for an Interface1D.
193
+ :param inter: An Interface1D object.
194
+ :type inter: freestyle.types.Interface1D
195
+ :return: The density evaluated for an Interface1D.
196
+ :rtype: float
162
197
  """
163
198
  ...
164
199
 
@@ -168,27 +203,40 @@ class GetCompleteViewMapDensityF1D:
168
203
  def __init__(
169
204
  self,
170
205
  level: int,
171
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
206
+ integration_type: freestyle.types.IntegrationType = None,
172
207
  sampling: float = 2.0,
173
208
  ):
174
209
  """Builds a GetCompleteViewMapDensityF1D object.
175
210
 
176
- :param level: The level of the pyramid from which the pixel must be read.
177
- :type level: int
178
- :param integration_type: The integration method used to compute a single value from a set of values.
179
- :type integration_type: 'freestyle.types.IntegrationType'
180
- :param sampling: the corresponding 0D function is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by integration_type.
181
- :type sampling: float
211
+ :param level: The level of the pyramid from which the pixel must be
212
+ read.
213
+ :type level: int
214
+ :param integration_type: The integration method used to compute a single value
215
+ from a set of values.
216
+ :type integration_type: freestyle.types.IntegrationType
217
+ :param sampling: The resolution used to sample the chain: the
218
+ corresponding 0D function is evaluated at each sample point and
219
+ the result is obtained by combining the resulting values into a
220
+ single one, following the method specified by integration_type.
221
+ :type sampling: float
182
222
  """
183
223
  ...
184
224
 
185
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
186
- """Returns the density evaluated for an Interface1D in the complete viewmap image. The density is evaluated for a set of points along the Interface1D (using the `freestyle.functions.ReadCompleteViewMapPixelF0D` functor) and then integrated into a single value using a user-defined integration method.
225
+ def __call__(
226
+ self, inter: freestyle.types.Interface1D
227
+ ) -> freestyle.types.Interface1D:
228
+ """Returns the density evaluated for an Interface1D in the complete
229
+ viewmap image. The density is evaluated for a set of points along the
230
+ Interface1D (using the
231
+ `freestyle.functions.ReadCompleteViewMapPixelF0D` functor) and
232
+ then integrated into a single value using a user-defined integration
233
+ method.
187
234
 
188
- :param inter: An Interface1D object.
189
- :type inter: 'freestyle.types.Interface1D'
190
- :rtype: float
191
- :return: The density evaluated for the Interface1D in the complete viewmap image.
235
+ :param inter: An Interface1D object.
236
+ :type inter: freestyle.types.Interface1D
237
+ :return: The density evaluated for the Interface1D in the complete
238
+ viewmap image.
239
+ :rtype: float
192
240
  """
193
241
  ...
194
242
 
@@ -199,13 +247,17 @@ class GetCurvilinearAbscissaF0D:
199
247
  """Builds a GetCurvilinearAbscissaF0D object."""
200
248
  ...
201
249
 
202
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
203
- """Returns the curvilinear abscissa of the `freestyle.types.Interface0D` pointed by the Interface0DIterator in the context of its 1D element.
250
+ def __call__(
251
+ self, it: freestyle.types.Interface0DIterator
252
+ ) -> freestyle.types.Interface0DIterator:
253
+ """Returns the curvilinear abscissa of the
254
+ `freestyle.types.Interface0D` pointed by the
255
+ Interface0DIterator in the context of its 1D element.
204
256
 
205
- :param it: An Interface0DIterator object.
206
- :type it: 'freestyle.types.Interface0DIterator'
207
- :rtype: float
208
- :return: The curvilinear abscissa of the pointed Interface0D.
257
+ :param it: An Interface0DIterator object.
258
+ :type it: freestyle.types.Interface0DIterator
259
+ :return: The curvilinear abscissa of the pointed Interface0D.
260
+ :rtype: float
209
261
  """
210
262
  ...
211
263
 
@@ -216,29 +268,44 @@ class GetDirectionalViewMapDensityF1D:
216
268
  self,
217
269
  orientation: int,
218
270
  level: int,
219
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
271
+ integration_type: freestyle.types.IntegrationType = None,
220
272
  sampling: float = 2.0,
221
273
  ):
222
274
  """Builds a GetDirectionalViewMapDensityF1D object.
223
275
 
224
- :param orientation: The number of the directional map we must work with.
225
- :type orientation: int
226
- :param level: The level of the pyramid from which the pixel must be read.
227
- :type level: int
228
- :param integration_type: The integration method used to compute a single value from a set of values.
229
- :type integration_type: 'freestyle.types.IntegrationType'
230
- :param sampling: the corresponding 0D function is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by integration_type.
231
- :type sampling: float
276
+ :param orientation: The number of the directional map we must work
277
+ with.
278
+ :type orientation: int
279
+ :param level: The level of the pyramid from which the pixel must be
280
+ read.
281
+ :type level: int
282
+ :param integration_type: The integration method used to compute a single value
283
+ from a set of values.
284
+ :type integration_type: freestyle.types.IntegrationType
285
+ :param sampling: The resolution used to sample the chain: the
286
+ corresponding 0D function is evaluated at each sample point and
287
+ the result is obtained by combining the resulting values into a
288
+ single one, following the method specified by integration_type.
289
+ :type sampling: float
232
290
  """
233
291
  ...
234
292
 
235
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
236
- """Returns the density evaluated for an Interface1D in of the steerable viewmaps image. The direction telling which Directional map to choose is explicitly specified by the user. The density is evaluated for a set of points along the Interface1D (using the `freestyle.functions.ReadSteerableViewMapPixelF0D` functor) and then integrated into a single value using a user-defined integration method.
293
+ def __call__(
294
+ self, inter: freestyle.types.Interface1D
295
+ ) -> freestyle.types.Interface1D:
296
+ """Returns the density evaluated for an Interface1D in of the steerable
297
+ viewmaps image. The direction telling which Directional map to choose
298
+ is explicitly specified by the user. The density is evaluated for a
299
+ set of points along the Interface1D (using the
300
+ `freestyle.functions.ReadSteerableViewMapPixelF0D` functor) and
301
+ then integrated into a single value using a user-defined integration
302
+ method.
237
303
 
238
- :param inter: An Interface1D object.
239
- :type inter: 'freestyle.types.Interface1D'
240
- :rtype: float
241
- :return: the density evaluated for an Interface1D in of the steerable viewmaps image.
304
+ :param inter: An Interface1D object.
305
+ :type inter: freestyle.types.Interface1D
306
+ :return: the density evaluated for an Interface1D in of the
307
+ steerable viewmaps image.
308
+ :rtype: float
242
309
  """
243
310
  ...
244
311
 
@@ -250,14 +317,15 @@ class GetOccludeeF0D:
250
317
  ...
251
318
 
252
319
  def __call__(
253
- self, it: "freestyle.types.Interface0DIterator"
254
- ) -> "freestyle.types.ViewShape":
255
- """Returns the `freestyle.types.ViewShape` that the Interface0D pointed by the Interface0DIterator occludes.
320
+ self, it: freestyle.types.Interface0DIterator
321
+ ) -> freestyle.types.Interface0DIterator:
322
+ """Returns the `freestyle.types.ViewShape` that the Interface0D
323
+ pointed by the Interface0DIterator occludes.
256
324
 
257
- :param it: An Interface0DIterator object.
258
- :type it: 'freestyle.types.Interface0DIterator'
259
- :rtype: 'freestyle.types.ViewShape'
260
- :return: The ViewShape occluded by the pointed Interface0D.
325
+ :param it: An Interface0DIterator object.
326
+ :type it: freestyle.types.Interface0DIterator
327
+ :return: The ViewShape occluded by the pointed Interface0D.
328
+ :rtype: freestyle.types.ViewShape
261
329
  """
262
330
  ...
263
331
 
@@ -269,13 +337,12 @@ class GetOccludeeF1D:
269
337
  ...
270
338
 
271
339
  def __call__(
272
- self, inter: "freestyle.types.Interface1D"
273
- ) -> typing.List["freestyle.types.ViewShape"]:
340
+ self, inter: freestyle.types.Interface1D
341
+ ) -> freestyle.types.Interface1D:
274
342
  """Returns a list of occluded shapes covered by this Interface1D.
275
343
 
276
344
  :param inter: An Interface1D object.
277
- :type inter: 'freestyle.types.Interface1D'
278
- :rtype: typing.List['freestyle.types.ViewShape']
345
+ :type inter: freestyle.types.Interface1D
279
346
  :return: A list of occluded shapes covered by the Interface1D.
280
347
  """
281
348
  ...
@@ -288,14 +355,15 @@ class GetOccludersF0D:
288
355
  ...
289
356
 
290
357
  def __call__(
291
- self, it: "freestyle.types.Interface0DIterator"
292
- ) -> typing.List["freestyle.types.ViewShape"]:
293
- """Returns a list of `freestyle.types.ViewShape` objects occluding the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
358
+ self, it: freestyle.types.Interface0DIterator
359
+ ) -> freestyle.types.Interface0DIterator:
360
+ """Returns a list of `freestyle.types.ViewShape` objects occluding the
361
+ `freestyle.types.Interface0D` pointed by the Interface0DIterator.
294
362
 
295
- :param it: An Interface0DIterator object.
296
- :type it: 'freestyle.types.Interface0DIterator'
297
- :rtype: typing.List['freestyle.types.ViewShape']
298
- :return: A list of ViewShape objects occluding the pointed Interface0D.
363
+ :param it: An Interface0DIterator object.
364
+ :type it: freestyle.types.Interface0DIterator
365
+ :return: A list of ViewShape objects occluding the pointed
366
+ Interface0D.
299
367
  """
300
368
  ...
301
369
 
@@ -307,13 +375,12 @@ class GetOccludersF1D:
307
375
  ...
308
376
 
309
377
  def __call__(
310
- self, inter: "freestyle.types.Interface1D"
311
- ) -> typing.List["freestyle.types.ViewShape"]:
378
+ self, inter: freestyle.types.Interface1D
379
+ ) -> freestyle.types.Interface1D:
312
380
  """Returns a list of occluding shapes that cover this Interface1D.
313
381
 
314
382
  :param inter: An Interface1D object.
315
- :type inter: 'freestyle.types.Interface1D'
316
- :rtype: typing.List['freestyle.types.ViewShape']
383
+ :type inter: freestyle.types.Interface1D
317
384
  :return: A list of occluding shapes that cover the Interface1D.
318
385
  """
319
386
  ...
@@ -325,13 +392,16 @@ class GetParameterF0D:
325
392
  """Builds a GetParameterF0D object."""
326
393
  ...
327
394
 
328
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
329
- """Returns the parameter of the `freestyle.types.Interface0D` pointed by the Interface0DIterator in the context of its 1D element.
395
+ def __call__(
396
+ self, it: freestyle.types.Interface0DIterator
397
+ ) -> freestyle.types.Interface0DIterator:
398
+ """Returns the parameter of the `freestyle.types.Interface0D`
399
+ pointed by the Interface0DIterator in the context of its 1D element.
330
400
 
331
- :param it: An Interface0DIterator object.
332
- :type it: 'freestyle.types.Interface0DIterator'
333
- :rtype: float
334
- :return: The parameter of an Interface0D.
401
+ :param it: An Interface0DIterator object.
402
+ :type it: freestyle.types.Interface0DIterator
403
+ :return: The parameter of an Interface0D.
404
+ :rtype: float
335
405
  """
336
406
  ...
337
407
 
@@ -342,37 +412,40 @@ class GetProjectedXF0D:
342
412
  """Builds a GetProjectedXF0D object."""
343
413
  ...
344
414
 
345
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
346
- """Returns the X 3D projected coordinate of the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
415
+ def __call__(
416
+ self, it: freestyle.types.Interface0DIterator
417
+ ) -> freestyle.types.Interface0DIterator:
418
+ """Returns the X 3D projected coordinate of the `freestyle.types.Interface0D`
419
+ pointed by the Interface0DIterator.
347
420
 
348
- :param it: An Interface0DIterator object.
349
- :type it: 'freestyle.types.Interface0DIterator'
350
- :rtype: float
351
- :return: The X 3D projected coordinate of the pointed Interface0D.
421
+ :param it: An Interface0DIterator object.
422
+ :type it: freestyle.types.Interface0DIterator
423
+ :return: The X 3D projected coordinate of the pointed Interface0D.
424
+ :rtype: float
352
425
  """
353
426
  ...
354
427
 
355
428
  class GetProjectedXF1D:
356
429
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `GetProjectedXF1D`"""
357
430
 
358
- def __init__(
359
- self,
360
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
361
- ):
431
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
362
432
  """Builds a GetProjectedXF1D object.
363
433
 
364
- :param integration_type: The integration method used to compute a single value from a set of values.
365
- :type integration_type: 'freestyle.types.IntegrationType'
434
+ :param integration_type: The integration method used to compute a single value
435
+ from a set of values.
436
+ :type integration_type: freestyle.types.IntegrationType
366
437
  """
367
438
  ...
368
439
 
369
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
440
+ def __call__(
441
+ self, inter: freestyle.types.Interface1D
442
+ ) -> freestyle.types.Interface1D:
370
443
  """Returns the projected X 3D coordinate of an Interface1D.
371
444
 
372
445
  :param inter: An Interface1D object.
373
- :type inter: 'freestyle.types.Interface1D'
374
- :rtype: float
446
+ :type inter: freestyle.types.Interface1D
375
447
  :return: The projected X 3D coordinate of an Interface1D.
448
+ :rtype: float
376
449
  """
377
450
  ...
378
451
 
@@ -383,37 +456,40 @@ class GetProjectedYF0D:
383
456
  """Builds a GetProjectedYF0D object."""
384
457
  ...
385
458
 
386
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
387
- """Returns the Y 3D projected coordinate of the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
459
+ def __call__(
460
+ self, it: freestyle.types.Interface0DIterator
461
+ ) -> freestyle.types.Interface0DIterator:
462
+ """Returns the Y 3D projected coordinate of the `freestyle.types.Interface0D`
463
+ pointed by the Interface0DIterator.
388
464
 
389
- :param it: An Interface0DIterator object.
390
- :type it: 'freestyle.types.Interface0DIterator'
391
- :rtype: float
392
- :return: The Y 3D projected coordinate of the pointed Interface0D.
465
+ :param it: An Interface0DIterator object.
466
+ :type it: freestyle.types.Interface0DIterator
467
+ :return: The Y 3D projected coordinate of the pointed Interface0D.
468
+ :rtype: float
393
469
  """
394
470
  ...
395
471
 
396
472
  class GetProjectedYF1D:
397
473
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `GetProjectedYF1D`"""
398
474
 
399
- def __init__(
400
- self,
401
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
402
- ):
475
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
403
476
  """Builds a GetProjectedYF1D object.
404
477
 
405
- :param integration_type: The integration method used to compute a single value from a set of values.
406
- :type integration_type: 'freestyle.types.IntegrationType'
478
+ :param integration_type: The integration method used to compute a single value
479
+ from a set of values.
480
+ :type integration_type: freestyle.types.IntegrationType
407
481
  """
408
482
  ...
409
483
 
410
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
484
+ def __call__(
485
+ self, inter: freestyle.types.Interface1D
486
+ ) -> freestyle.types.Interface1D:
411
487
  """Returns the projected Y 3D coordinate of an Interface1D.
412
488
 
413
489
  :param inter: An Interface1D object.
414
- :type inter: 'freestyle.types.Interface1D'
415
- :rtype: float
490
+ :type inter: freestyle.types.Interface1D
416
491
  :return: The projected Y 3D coordinate of an Interface1D.
492
+ :rtype: float
417
493
  """
418
494
  ...
419
495
 
@@ -424,37 +500,40 @@ class GetProjectedZF0D:
424
500
  """Builds a GetProjectedZF0D object."""
425
501
  ...
426
502
 
427
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
428
- """Returns the Z 3D projected coordinate of the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
503
+ def __call__(
504
+ self, it: freestyle.types.Interface0DIterator
505
+ ) -> freestyle.types.Interface0DIterator:
506
+ """Returns the Z 3D projected coordinate of the `freestyle.types.Interface0D`
507
+ pointed by the Interface0DIterator.
429
508
 
430
- :param it: An Interface0DIterator object.
431
- :type it: 'freestyle.types.Interface0DIterator'
432
- :rtype: float
433
- :return: The Z 3D projected coordinate of the pointed Interface0D.
509
+ :param it: An Interface0DIterator object.
510
+ :type it: freestyle.types.Interface0DIterator
511
+ :return: The Z 3D projected coordinate of the pointed Interface0D.
512
+ :rtype: float
434
513
  """
435
514
  ...
436
515
 
437
516
  class GetProjectedZF1D:
438
517
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `GetProjectedZF1D`"""
439
518
 
440
- def __init__(
441
- self,
442
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
443
- ):
519
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
444
520
  """Builds a GetProjectedZF1D object.
445
521
 
446
- :param integration_type: The integration method used to compute a single value from a set of values.
447
- :type integration_type: 'freestyle.types.IntegrationType'
522
+ :param integration_type: The integration method used to compute a single value
523
+ from a set of values.
524
+ :type integration_type: freestyle.types.IntegrationType
448
525
  """
449
526
  ...
450
527
 
451
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
528
+ def __call__(
529
+ self, inter: freestyle.types.Interface1D
530
+ ) -> freestyle.types.Interface1D:
452
531
  """Returns the projected Z 3D coordinate of an Interface1D.
453
532
 
454
533
  :param inter: An Interface1D object.
455
- :type inter: 'freestyle.types.Interface1D'
456
- :rtype: float
534
+ :type inter: freestyle.types.Interface1D
457
535
  :return: The projected Z 3D coordinate of an Interface1D.
536
+ :rtype: float
458
537
  """
459
538
  ...
460
539
 
@@ -466,14 +545,15 @@ class GetShapeF0D:
466
545
  ...
467
546
 
468
547
  def __call__(
469
- self, it: "freestyle.types.Interface0DIterator"
470
- ) -> "freestyle.types.ViewShape":
471
- """Returns the `freestyle.types.ViewShape` containing the Interface0D pointed by the Interface0DIterator.
548
+ self, it: freestyle.types.Interface0DIterator
549
+ ) -> freestyle.types.Interface0DIterator:
550
+ """Returns the `freestyle.types.ViewShape` containing the
551
+ Interface0D pointed by the Interface0DIterator.
472
552
 
473
- :param it: An Interface0DIterator object.
474
- :type it: 'freestyle.types.Interface0DIterator'
475
- :rtype: 'freestyle.types.ViewShape'
476
- :return: The ViewShape containing the pointed Interface0D.
553
+ :param it: An Interface0DIterator object.
554
+ :type it: freestyle.types.Interface0DIterator
555
+ :return: The ViewShape containing the pointed Interface0D.
556
+ :rtype: freestyle.types.ViewShape
477
557
  """
478
558
  ...
479
559
 
@@ -485,13 +565,12 @@ class GetShapeF1D:
485
565
  ...
486
566
 
487
567
  def __call__(
488
- self, inter: "freestyle.types.Interface1D"
489
- ) -> typing.List["freestyle.types.ViewShape"]:
568
+ self, inter: freestyle.types.Interface1D
569
+ ) -> freestyle.types.Interface1D:
490
570
  """Returns a list of shapes covered by this Interface1D.
491
571
 
492
572
  :param inter: An Interface1D object.
493
- :type inter: 'freestyle.types.Interface1D'
494
- :rtype: typing.List['freestyle.types.ViewShape']
573
+ :type inter: freestyle.types.Interface1D
495
574
  :return: A list of shapes covered by the Interface1D.
496
575
  """
497
576
  ...
@@ -502,27 +581,37 @@ class GetSteerableViewMapDensityF1D:
502
581
  def __init__(
503
582
  self,
504
583
  level: int,
505
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
584
+ integration_type: freestyle.types.IntegrationType = None,
506
585
  sampling: float = 2.0,
507
586
  ):
508
587
  """Builds a GetSteerableViewMapDensityF1D object.
509
588
 
510
- :param level: The level of the pyramid from which the pixel must be read.
511
- :type level: int
512
- :param integration_type: The integration method used to compute a single value from a set of values.
513
- :type integration_type: 'freestyle.types.IntegrationType'
514
- :param sampling: the corresponding 0D function is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by integration_type.
515
- :type sampling: float
589
+ :param level: The level of the pyramid from which the pixel must be
590
+ read.
591
+ :type level: int
592
+ :param integration_type: The integration method used to compute a single value
593
+ from a set of values.
594
+ :type integration_type: freestyle.types.IntegrationType
595
+ :param sampling: The resolution used to sample the chain: the
596
+ corresponding 0D function is evaluated at each sample point and
597
+ the result is obtained by combining the resulting values into a
598
+ single one, following the method specified by integration_type.
599
+ :type sampling: float
516
600
  """
517
601
  ...
518
602
 
519
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
520
- """Returns the density of the ViewMap for a given Interface1D. The density of each `freestyle.types.FEdge` is evaluated in the proper steerable `freestyle.types.ViewMap` depending on its orientation.
603
+ def __call__(
604
+ self, inter: freestyle.types.Interface1D
605
+ ) -> freestyle.types.Interface1D:
606
+ """Returns the density of the ViewMap for a given Interface1D. The
607
+ density of each `freestyle.types.FEdge` is evaluated in the
608
+ proper steerable `freestyle.types.ViewMap` depending on its
609
+ orientation.
521
610
 
522
- :param inter: An Interface1D object.
523
- :type inter: 'freestyle.types.Interface1D'
524
- :rtype: float
525
- :return: The density of the ViewMap for a given Interface1D.
611
+ :param inter: An Interface1D object.
612
+ :type inter: freestyle.types.Interface1D
613
+ :return: The density of the ViewMap for a given Interface1D.
614
+ :rtype: float
526
615
  """
527
616
  ...
528
617
 
@@ -532,18 +621,23 @@ class GetViewMapGradientNormF0D:
532
621
  def __init__(self, level: int):
533
622
  """Builds a GetViewMapGradientNormF0D object.
534
623
 
535
- :param level: The level of the pyramid from which the pixel must be read.
536
- :type level: int
624
+ :param level: The level of the pyramid from which the pixel must be
625
+ read.
626
+ :type level: int
537
627
  """
538
628
  ...
539
629
 
540
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
541
- """Returns the norm of the gradient of the global viewmap density image.
630
+ def __call__(
631
+ self, it: freestyle.types.Interface0DIterator
632
+ ) -> freestyle.types.Interface0DIterator:
633
+ """Returns the norm of the gradient of the global viewmap density
634
+ image.
542
635
 
543
- :param it: An Interface0DIterator object.
544
- :type it: 'freestyle.types.Interface0DIterator'
545
- :rtype: float
546
- :return: The norm of the gradient of the global viewmap density image.
636
+ :param it: An Interface0DIterator object.
637
+ :type it: freestyle.types.Interface0DIterator
638
+ :return: The norm of the gradient of the global viewmap density
639
+ image.
640
+ :rtype: float
547
641
  """
548
642
  ...
549
643
 
@@ -553,27 +647,37 @@ class GetViewMapGradientNormF1D:
553
647
  def __init__(
554
648
  self,
555
649
  level: int,
556
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
650
+ integration_type: freestyle.types.IntegrationType = None,
557
651
  sampling: float = 2.0,
558
652
  ):
559
653
  """Builds a GetViewMapGradientNormF1D object.
560
654
 
561
- :param level: The level of the pyramid from which the pixel must be read.
562
- :type level: int
563
- :param integration_type: The integration method used to compute a single value from a set of values.
564
- :type integration_type: 'freestyle.types.IntegrationType'
565
- :param sampling: the corresponding 0D function is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by integration_type.
566
- :type sampling: float
655
+ :param level: The level of the pyramid from which the pixel must be
656
+ read.
657
+ :type level: int
658
+ :param integration_type: The integration method used to compute a single value
659
+ from a set of values.
660
+ :type integration_type: freestyle.types.IntegrationType
661
+ :param sampling: The resolution used to sample the chain: the
662
+ corresponding 0D function is evaluated at each sample point and
663
+ the result is obtained by combining the resulting values into a
664
+ single one, following the method specified by integration_type.
665
+ :type sampling: float
567
666
  """
568
667
  ...
569
668
 
570
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
571
- """Returns the density of the ViewMap for a given Interface1D. The density of each `freestyle.types.FEdge` is evaluated in the proper steerable `freestyle.types.ViewMap` depending on its orientation.
669
+ def __call__(
670
+ self, inter: freestyle.types.Interface1D
671
+ ) -> freestyle.types.Interface1D:
672
+ """Returns the density of the ViewMap for a given Interface1D. The
673
+ density of each `freestyle.types.FEdge` is evaluated in the
674
+ proper steerable `freestyle.types.ViewMap` depending on its
675
+ orientation.
572
676
 
573
- :param inter: An Interface1D object.
574
- :type inter: 'freestyle.types.Interface1D'
575
- :rtype: float
576
- :return: The density of the ViewMap for a given Interface1D.
677
+ :param inter: An Interface1D object.
678
+ :type inter: freestyle.types.Interface1D
679
+ :return: The density of the ViewMap for a given Interface1D.
680
+ :rtype: float
577
681
  """
578
682
  ...
579
683
 
@@ -584,37 +688,40 @@ class GetXF0D:
584
688
  """Builds a GetXF0D object."""
585
689
  ...
586
690
 
587
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
588
- """Returns the X 3D coordinate of the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
691
+ def __call__(
692
+ self, it: freestyle.types.Interface0DIterator
693
+ ) -> freestyle.types.Interface0DIterator:
694
+ """Returns the X 3D coordinate of the `freestyle.types.Interface0D` pointed by
695
+ the Interface0DIterator.
589
696
 
590
- :param it: An Interface0DIterator object.
591
- :type it: 'freestyle.types.Interface0DIterator'
592
- :rtype: float
593
- :return: The X 3D coordinate of the pointed Interface0D.
697
+ :param it: An Interface0DIterator object.
698
+ :type it: freestyle.types.Interface0DIterator
699
+ :return: The X 3D coordinate of the pointed Interface0D.
700
+ :rtype: float
594
701
  """
595
702
  ...
596
703
 
597
704
  class GetXF1D:
598
705
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `GetXF1D`"""
599
706
 
600
- def __init__(
601
- self,
602
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
603
- ):
707
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
604
708
  """Builds a GetXF1D object.
605
709
 
606
- :param integration_type: The integration method used to compute a single value from a set of values.
607
- :type integration_type: 'freestyle.types.IntegrationType'
710
+ :param integration_type: The integration method used to compute a single value
711
+ from a set of values.
712
+ :type integration_type: freestyle.types.IntegrationType
608
713
  """
609
714
  ...
610
715
 
611
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
716
+ def __call__(
717
+ self, inter: freestyle.types.Interface1D
718
+ ) -> freestyle.types.Interface1D:
612
719
  """Returns the X 3D coordinate of an Interface1D.
613
720
 
614
721
  :param inter: An Interface1D object.
615
- :type inter: 'freestyle.types.Interface1D'
616
- :rtype: float
722
+ :type inter: freestyle.types.Interface1D
617
723
  :return: The X 3D coordinate of the Interface1D.
724
+ :rtype: float
618
725
  """
619
726
  ...
620
727
 
@@ -625,37 +732,40 @@ class GetYF0D:
625
732
  """Builds a GetYF0D object."""
626
733
  ...
627
734
 
628
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
629
- """Returns the Y 3D coordinate of the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
735
+ def __call__(
736
+ self, it: freestyle.types.Interface0DIterator
737
+ ) -> freestyle.types.Interface0DIterator:
738
+ """Returns the Y 3D coordinate of the `freestyle.types.Interface0D` pointed by
739
+ the Interface0DIterator.
630
740
 
631
- :param it: An Interface0DIterator object.
632
- :type it: 'freestyle.types.Interface0DIterator'
633
- :rtype: float
634
- :return: The Y 3D coordinate of the pointed Interface0D.
741
+ :param it: An Interface0DIterator object.
742
+ :type it: freestyle.types.Interface0DIterator
743
+ :return: The Y 3D coordinate of the pointed Interface0D.
744
+ :rtype: float
635
745
  """
636
746
  ...
637
747
 
638
748
  class GetYF1D:
639
749
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `GetYF1D`"""
640
750
 
641
- def __init__(
642
- self,
643
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
644
- ):
751
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
645
752
  """Builds a GetYF1D object.
646
753
 
647
- :param integration_type: The integration method used to compute a single value from a set of values.
648
- :type integration_type: 'freestyle.types.IntegrationType'
754
+ :param integration_type: The integration method used to compute a single value
755
+ from a set of values.
756
+ :type integration_type: freestyle.types.IntegrationType
649
757
  """
650
758
  ...
651
759
 
652
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
760
+ def __call__(
761
+ self, inter: freestyle.types.Interface1D
762
+ ) -> freestyle.types.Interface1D:
653
763
  """Returns the Y 3D coordinate of an Interface1D.
654
764
 
655
765
  :param inter: An Interface1D object.
656
- :type inter: 'freestyle.types.Interface1D'
657
- :rtype: float
766
+ :type inter: freestyle.types.Interface1D
658
767
  :return: The Y 3D coordinate of the Interface1D.
768
+ :rtype: float
659
769
  """
660
770
  ...
661
771
 
@@ -666,37 +776,40 @@ class GetZF0D:
666
776
  """Builds a GetZF0D object."""
667
777
  ...
668
778
 
669
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
670
- """Returns the Z 3D coordinate of the `freestyle.types.Interface0D` pointed by the Interface0DIterator.
779
+ def __call__(
780
+ self, it: freestyle.types.Interface0DIterator
781
+ ) -> freestyle.types.Interface0DIterator:
782
+ """Returns the Z 3D coordinate of the `freestyle.types.Interface0D` pointed by
783
+ the Interface0DIterator.
671
784
 
672
- :param it: An Interface0DIterator object.
673
- :type it: 'freestyle.types.Interface0DIterator'
674
- :rtype: float
675
- :return: The Z 3D coordinate of the pointed Interface0D.
785
+ :param it: An Interface0DIterator object.
786
+ :type it: freestyle.types.Interface0DIterator
787
+ :return: The Z 3D coordinate of the pointed Interface0D.
788
+ :rtype: float
676
789
  """
677
790
  ...
678
791
 
679
792
  class GetZF1D:
680
793
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `GetZF1D`"""
681
794
 
682
- def __init__(
683
- self,
684
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
685
- ):
795
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
686
796
  """Builds a GetZF1D object.
687
797
 
688
- :param integration_type: The integration method used to compute a single value from a set of values.
689
- :type integration_type: 'freestyle.types.IntegrationType'
798
+ :param integration_type: The integration method used to compute a single value
799
+ from a set of values.
800
+ :type integration_type: freestyle.types.IntegrationType
690
801
  """
691
802
  ...
692
803
 
693
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
804
+ def __call__(
805
+ self, inter: freestyle.types.Interface1D
806
+ ) -> freestyle.types.Interface1D:
694
807
  """Returns the Z 3D coordinate of an Interface1D.
695
808
 
696
809
  :param inter: An Interface1D object.
697
- :type inter: 'freestyle.types.Interface1D'
698
- :rtype: float
810
+ :type inter: freestyle.types.Interface1D
699
811
  :return: The Z 3D coordinate of the Interface1D.
812
+ :rtype: float
700
813
  """
701
814
  ...
702
815
 
@@ -707,11 +820,11 @@ class IncrementChainingTimeStampF1D:
707
820
  """Builds an IncrementChainingTimeStampF1D object."""
708
821
  ...
709
822
 
710
- def __call__(self, inter: "freestyle.types.Interface1D"):
823
+ def __call__(self, inter: freestyle.types.Interface1D):
711
824
  """Increments the chaining time stamp of the Interface1D.
712
825
 
713
826
  :param inter: An Interface1D object.
714
- :type inter: 'freestyle.types.Interface1D'
827
+ :type inter: freestyle.types.Interface1D
715
828
  """
716
829
  ...
717
830
 
@@ -726,13 +839,18 @@ class LocalAverageDepthF0D:
726
839
  """
727
840
  ...
728
841
 
729
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
730
- """Returns the average depth around the `freestyle.types.Interface0D` pointed by the Interface0DIterator. The result is obtained by querying the depth buffer on a window around that point.
842
+ def __call__(
843
+ self, it: freestyle.types.Interface0DIterator
844
+ ) -> freestyle.types.Interface0DIterator:
845
+ """Returns the average depth around the
846
+ `freestyle.types.Interface0D` pointed by the
847
+ Interface0DIterator. The result is obtained by querying the depth
848
+ buffer on a window around that point.
731
849
 
732
- :param it: An Interface0DIterator object.
733
- :type it: 'freestyle.types.Interface0DIterator'
734
- :rtype: float
735
- :return: The average depth around the pointed Interface0D.
850
+ :param it: An Interface0DIterator object.
851
+ :type it: freestyle.types.Interface0DIterator
852
+ :return: The average depth around the pointed Interface0D.
853
+ :rtype: float
736
854
  """
737
855
  ...
738
856
 
@@ -740,26 +858,32 @@ class LocalAverageDepthF1D:
740
858
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `LocalAverageDepthF1D`"""
741
859
 
742
860
  def __init__(
743
- self,
744
- sigma: float,
745
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
861
+ self, sigma: float, integration_type: freestyle.types.IntegrationType = None
746
862
  ):
747
863
  """Builds a LocalAverageDepthF1D object.
748
864
 
749
- :param sigma: The sigma used in DensityF0D and determining the window size used in each density query.
750
- :type sigma: float
751
- :param integration_type: The integration method used to compute a single value from a set of values.
752
- :type integration_type: 'freestyle.types.IntegrationType'
865
+ :param sigma: The sigma used in DensityF0D and determining the window
866
+ size used in each density query.
867
+ :type sigma: float
868
+ :param integration_type: The integration method used to compute a single value
869
+ from a set of values.
870
+ :type integration_type: freestyle.types.IntegrationType
753
871
  """
754
872
  ...
755
873
 
756
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
757
- """Returns the average depth evaluated for an Interface1D. The average depth is evaluated for a set of points along the Interface1D (using the `freestyle.functions.LocalAverageDepthF0D` functor) with a user-defined sampling and then integrated into a single value using a user-defined integration method.
874
+ def __call__(
875
+ self, inter: freestyle.types.Interface1D
876
+ ) -> freestyle.types.Interface1D:
877
+ """Returns the average depth evaluated for an Interface1D. The average
878
+ depth is evaluated for a set of points along the Interface1D (using
879
+ the `freestyle.functions.LocalAverageDepthF0D` functor) with a
880
+ user-defined sampling and then integrated into a single value using a
881
+ user-defined integration method.
758
882
 
759
- :param inter: An Interface1D object.
760
- :type inter: 'freestyle.types.Interface1D'
761
- :rtype: float
762
- :return: The average depth evaluated for the Interface1D.
883
+ :param inter: An Interface1D object.
884
+ :type inter: freestyle.types.Interface1D
885
+ :return: The average depth evaluated for the Interface1D.
886
+ :rtype: float
763
887
  """
764
888
  ...
765
889
 
@@ -771,14 +895,25 @@ class MaterialF0D:
771
895
  ...
772
896
 
773
897
  def __call__(
774
- self, it: "freestyle.types.Interface0DIterator"
775
- ) -> "freestyle.types.Material":
776
- """Returns the material of the object evaluated at the `freestyle.types.Interface0D` pointed by the Interface0DIterator. This evaluation can be ambiguous (in the case of a `freestyle.types.TVertex` for example. This functor tries to remove this ambiguity using the context offered by the 1D element to which the Interface0DIterator belongs to and by arbitrary choosing the material of the face that lies on its left when following the 1D element if there are two different materials on each side of the point. However, there still can be problematic cases, and the user willing to deal with this cases in a specific way should implement its own getMaterial functor.
777
-
778
- :param it: An Interface0DIterator object.
779
- :type it: 'freestyle.types.Interface0DIterator'
780
- :rtype: 'freestyle.types.Material'
781
- :return: The material of the object evaluated at the pointed Interface0D.
898
+ self, it: freestyle.types.Interface0DIterator
899
+ ) -> freestyle.types.Interface0DIterator:
900
+ """Returns the material of the object evaluated at the
901
+ `freestyle.types.Interface0D` pointed by the
902
+ Interface0DIterator. This evaluation can be ambiguous (in the case of
903
+ a `freestyle.types.TVertex` for example. This functor tries to
904
+ remove this ambiguity using the context offered by the 1D element to
905
+ which the Interface0DIterator belongs to and by arbitrary choosing the
906
+ material of the face that lies on its left when following the 1D
907
+ element if there are two different materials on each side of the
908
+ point. However, there still can be problematic cases, and the user
909
+ willing to deal with this cases in a specific way should implement its
910
+ own getMaterial functor.
911
+
912
+ :param it: An Interface0DIterator object.
913
+ :type it: freestyle.types.Interface0DIterator
914
+ :return: The material of the object evaluated at the pointed
915
+ Interface0D.
916
+ :rtype: freestyle.types.Material
782
917
  """
783
918
  ...
784
919
 
@@ -789,85 +924,91 @@ class Normal2DF0D:
789
924
  """Builds a Normal2DF0D object."""
790
925
  ...
791
926
 
792
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> "mathutils.Vector":
793
- """Returns a two-dimensional vector giving the normalized 2D normal to the 1D element to which the `freestyle.types.Interface0D` pointed by the Interface0DIterator belongs. The normal is evaluated at the pointed Interface0D.
927
+ def __call__(
928
+ self, it: freestyle.types.Interface0DIterator
929
+ ) -> freestyle.types.Interface0DIterator:
930
+ """Returns a two-dimensional vector giving the normalized 2D normal to
931
+ the 1D element to which the `freestyle.types.Interface0D`
932
+ pointed by the Interface0DIterator belongs. The normal is evaluated
933
+ at the pointed Interface0D.
794
934
 
795
- :param it: An Interface0DIterator object.
796
- :type it: 'freestyle.types.Interface0DIterator'
797
- :rtype: 'mathutils.Vector'
798
- :return: The 2D normal of the 1D element evaluated at the pointed Interface0D.
935
+ :param it: An Interface0DIterator object.
936
+ :type it: freestyle.types.Interface0DIterator
937
+ :return: The 2D normal of the 1D element evaluated at the pointed
938
+ Interface0D.
939
+ :rtype: mathutils.Vector
799
940
  """
800
941
  ...
801
942
 
802
943
  class Normal2DF1D:
803
944
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DVec2f` > `Normal2DF1D`"""
804
945
 
805
- def __init__(
806
- self,
807
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
808
- ):
946
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
809
947
  """Builds a Normal2DF1D object.
810
948
 
811
- :param integration_type: The integration method used to compute a single value from a set of values.
812
- :type integration_type: 'freestyle.types.IntegrationType'
949
+ :param integration_type: The integration method used to compute a single value
950
+ from a set of values.
951
+ :type integration_type: freestyle.types.IntegrationType
813
952
  """
814
953
  ...
815
954
 
816
- def __call__(self, inter: "freestyle.types.Interface1D") -> "mathutils.Vector":
955
+ def __call__(
956
+ self, inter: freestyle.types.Interface1D
957
+ ) -> freestyle.types.Interface1D:
817
958
  """Returns the 2D normal for the Interface1D.
818
959
 
819
960
  :param inter: An Interface1D object.
820
- :type inter: 'freestyle.types.Interface1D'
821
- :rtype: 'mathutils.Vector'
961
+ :type inter: freestyle.types.Interface1D
822
962
  :return: The 2D normal for the Interface1D.
963
+ :rtype: mathutils.Vector
823
964
  """
824
965
  ...
825
966
 
826
967
  class Orientation2DF1D:
827
968
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DVec2f` > `Orientation2DF1D`"""
828
969
 
829
- def __init__(
830
- self,
831
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
832
- ):
970
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
833
971
  """Builds an Orientation2DF1D object.
834
972
 
835
- :param integration_type: The integration method used to compute a single value from a set of values.
836
- :type integration_type: 'freestyle.types.IntegrationType'
973
+ :param integration_type: The integration method used to compute a single value
974
+ from a set of values.
975
+ :type integration_type: freestyle.types.IntegrationType
837
976
  """
838
977
  ...
839
978
 
840
- def __call__(self, inter: "freestyle.types.Interface1D") -> "mathutils.Vector":
979
+ def __call__(
980
+ self, inter: freestyle.types.Interface1D
981
+ ) -> freestyle.types.Interface1D:
841
982
  """Returns the 2D orientation of the Interface1D.
842
983
 
843
984
  :param inter: An Interface1D object.
844
- :type inter: 'freestyle.types.Interface1D'
845
- :rtype: 'mathutils.Vector'
985
+ :type inter: freestyle.types.Interface1D
846
986
  :return: The 2D orientation of the Interface1D.
987
+ :rtype: mathutils.Vector
847
988
  """
848
989
  ...
849
990
 
850
991
  class Orientation3DF1D:
851
992
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DVec3f` > `Orientation3DF1D`"""
852
993
 
853
- def __init__(
854
- self,
855
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
856
- ):
994
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
857
995
  """Builds an Orientation3DF1D object.
858
996
 
859
- :param integration_type: The integration method used to compute a single value from a set of values.
860
- :type integration_type: 'freestyle.types.IntegrationType'
997
+ :param integration_type: The integration method used to compute a single value
998
+ from a set of values.
999
+ :type integration_type: freestyle.types.IntegrationType
861
1000
  """
862
1001
  ...
863
1002
 
864
- def __call__(self, inter: "freestyle.types.Interface1D") -> "mathutils.Vector":
1003
+ def __call__(
1004
+ self, inter: freestyle.types.Interface1D
1005
+ ) -> freestyle.types.Interface1D:
865
1006
  """Returns the 3D orientation of the Interface1D.
866
1007
 
867
1008
  :param inter: An Interface1D object.
868
- :type inter: 'freestyle.types.Interface1D'
869
- :rtype: 'mathutils.Vector'
1009
+ :type inter: freestyle.types.Interface1D
870
1010
  :return: The 3D orientation of the Interface1D.
1011
+ :rtype: mathutils.Vector
871
1012
  """
872
1013
  ...
873
1014
 
@@ -878,37 +1019,50 @@ class QuantitativeInvisibilityF0D:
878
1019
  """Builds a QuantitativeInvisibilityF0D object."""
879
1020
  ...
880
1021
 
881
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> int:
882
- """Returns the quantitative invisibility of the `freestyle.types.Interface0D` pointed by the Interface0DIterator. This evaluation can be ambiguous (in the case of a `freestyle.types.TVertex` for example). This functor tries to remove this ambiguity using the context offered by the 1D element to which the Interface0D belongs to. However, there still can be problematic cases, and the user willing to deal with this cases in a specific way should implement its own getQIF0D functor.
1022
+ def __call__(
1023
+ self, it: freestyle.types.Interface0DIterator
1024
+ ) -> freestyle.types.Interface0DIterator:
1025
+ """Returns the quantitative invisibility of the
1026
+ `freestyle.types.Interface0D` pointed by the
1027
+ Interface0DIterator. This evaluation can be ambiguous (in the case of
1028
+ a `freestyle.types.TVertex` for example). This functor tries
1029
+ to remove this ambiguity using the context offered by the 1D element
1030
+ to which the Interface0D belongs to. However, there still can be
1031
+ problematic cases, and the user willing to deal with this cases in a
1032
+ specific way should implement its own getQIF0D functor.
883
1033
 
884
- :param it: An Interface0DIterator object.
885
- :type it: 'freestyle.types.Interface0DIterator'
886
- :rtype: int
887
- :return: The quantitative invisibility of the pointed Interface0D.
1034
+ :param it: An Interface0DIterator object.
1035
+ :type it: freestyle.types.Interface0DIterator
1036
+ :return: The quantitative invisibility of the pointed Interface0D.
1037
+ :rtype: int
888
1038
  """
889
1039
  ...
890
1040
 
891
1041
  class QuantitativeInvisibilityF1D:
892
1042
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DUnsigned` > `QuantitativeInvisibilityF1D`"""
893
1043
 
894
- def __init__(
895
- self,
896
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
897
- ):
1044
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
898
1045
  """Builds a QuantitativeInvisibilityF1D object.
899
1046
 
900
- :param integration_type: The integration method used to compute a single value from a set of values.
901
- :type integration_type: 'freestyle.types.IntegrationType'
1047
+ :param integration_type: The integration method used to compute a single value
1048
+ from a set of values.
1049
+ :type integration_type: freestyle.types.IntegrationType
902
1050
  """
903
1051
  ...
904
1052
 
905
- def __call__(self, inter: "freestyle.types.Interface1D") -> int:
906
- """Returns the Quantitative Invisibility of an Interface1D element. If the Interface1D is a `freestyle.types.ViewEdge`, then there is no ambiguity concerning the result. But, if the Interface1D results of a chaining (chain, stroke), then it might be made of several 1D elements of different Quantitative Invisibilities.
1053
+ def __call__(
1054
+ self, inter: freestyle.types.Interface1D
1055
+ ) -> freestyle.types.Interface1D:
1056
+ """Returns the Quantitative Invisibility of an Interface1D element. If
1057
+ the Interface1D is a `freestyle.types.ViewEdge`, then there is
1058
+ no ambiguity concerning the result. But, if the Interface1D results
1059
+ of a chaining (chain, stroke), then it might be made of several 1D
1060
+ elements of different Quantitative Invisibilities.
907
1061
 
908
- :param inter: An Interface1D object.
909
- :type inter: 'freestyle.types.Interface1D'
910
- :rtype: int
911
- :return: The Quantitative Invisibility of the Interface1D.
1062
+ :param inter: An Interface1D object.
1063
+ :type inter: freestyle.types.Interface1D
1064
+ :return: The Quantitative Invisibility of the Interface1D.
1065
+ :rtype: int
912
1066
  """
913
1067
  ...
914
1068
 
@@ -918,18 +1072,21 @@ class ReadCompleteViewMapPixelF0D:
918
1072
  def __init__(self, level: int):
919
1073
  """Builds a ReadCompleteViewMapPixelF0D object.
920
1074
 
921
- :param level: The level of the pyramid from which the pixel must be read.
922
- :type level: int
1075
+ :param level: The level of the pyramid from which the pixel must be
1076
+ read.
1077
+ :type level: int
923
1078
  """
924
1079
  ...
925
1080
 
926
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
1081
+ def __call__(
1082
+ self, it: freestyle.types.Interface0DIterator
1083
+ ) -> freestyle.types.Interface0DIterator:
927
1084
  """Reads a pixel in one of the level of the complete viewmap.
928
1085
 
929
1086
  :param it: An Interface0DIterator object.
930
- :type it: 'freestyle.types.Interface0DIterator'
931
- :rtype: float
1087
+ :type it: freestyle.types.Interface0DIterator
932
1088
  :return: A pixel in one of the level of the complete viewmap.
1089
+ :rtype: float
933
1090
  """
934
1091
  ...
935
1092
 
@@ -939,20 +1096,23 @@ class ReadMapPixelF0D:
939
1096
  def __init__(self, map_name: str, level: int):
940
1097
  """Builds a ReadMapPixelF0D object.
941
1098
 
942
- :param map_name: The name of the map to be read.
943
- :type map_name: str
944
- :param level: The level of the pyramid from which the pixel must be read.
945
- :type level: int
1099
+ :param map_name: The name of the map to be read.
1100
+ :type map_name: str
1101
+ :param level: The level of the pyramid from which the pixel must be
1102
+ read.
1103
+ :type level: int
946
1104
  """
947
1105
  ...
948
1106
 
949
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
1107
+ def __call__(
1108
+ self, it: freestyle.types.Interface0DIterator
1109
+ ) -> freestyle.types.Interface0DIterator:
950
1110
  """Reads a pixel in a map.
951
1111
 
952
1112
  :param it: An Interface0DIterator object.
953
- :type it: 'freestyle.types.Interface0DIterator'
954
- :rtype: float
1113
+ :type it: freestyle.types.Interface0DIterator
955
1114
  :return: A pixel in a map.
1115
+ :rtype: float
956
1116
  """
957
1117
  ...
958
1118
 
@@ -962,20 +1122,24 @@ class ReadSteerableViewMapPixelF0D:
962
1122
  def __init__(self, orientation: int, level: int):
963
1123
  """Builds a ReadSteerableViewMapPixelF0D object.
964
1124
 
965
- :param orientation: The integer belonging to [0, 4] indicating the orientation (E, NE, N, NW) we are interested in.
966
- :type orientation: int
967
- :param level: The level of the pyramid from which the pixel must be read.
968
- :type level: int
1125
+ :param orientation: The integer belonging to [0, 4] indicating the
1126
+ orientation (E, NE, N, NW) we are interested in.
1127
+ :type orientation: int
1128
+ :param level: The level of the pyramid from which the pixel must be
1129
+ read.
1130
+ :type level: int
969
1131
  """
970
1132
  ...
971
1133
 
972
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
1134
+ def __call__(
1135
+ self, it: freestyle.types.Interface0DIterator
1136
+ ) -> freestyle.types.Interface0DIterator:
973
1137
  """Reads a pixel in one of the level of one of the steerable viewmaps.
974
1138
 
975
1139
  :param it: An Interface0DIterator object.
976
- :type it: 'freestyle.types.Interface0DIterator'
977
- :rtype: float
1140
+ :type it: freestyle.types.Interface0DIterator
978
1141
  :return: A pixel in one of the level of one of the steerable viewmaps.
1142
+ :rtype: float
979
1143
  """
980
1144
  ...
981
1145
 
@@ -987,14 +1151,22 @@ class ShapeIdF0D:
987
1151
  ...
988
1152
 
989
1153
  def __call__(
990
- self, it: "freestyle.types.Interface0DIterator"
991
- ) -> "freestyle.types.Id":
992
- """Returns the `freestyle.types.Id` of the Shape the `freestyle.types.Interface0D` pointed by the Interface0DIterator belongs to. This evaluation can be ambiguous (in the case of a `freestyle.types.TVertex` for example). This functor tries to remove this ambiguity using the context offered by the 1D element to which the Interface0DIterator belongs to. However, there still can be problematic cases, and the user willing to deal with this cases in a specific way should implement its own getShapeIdF0D functor.
1154
+ self, it: freestyle.types.Interface0DIterator
1155
+ ) -> freestyle.types.Interface0DIterator:
1156
+ """Returns the `freestyle.types.Id` of the Shape the
1157
+ `freestyle.types.Interface0D` pointed by the
1158
+ Interface0DIterator belongs to. This evaluation can be ambiguous (in
1159
+ the case of a `freestyle.types.TVertex` for example). This
1160
+ functor tries to remove this ambiguity using the context offered by
1161
+ the 1D element to which the Interface0DIterator belongs to. However,
1162
+ there still can be problematic cases, and the user willing to deal
1163
+ with this cases in a specific way should implement its own
1164
+ getShapeIdF0D functor.
993
1165
 
994
- :param it: An Interface0DIterator object.
995
- :type it: 'freestyle.types.Interface0DIterator'
996
- :rtype: 'freestyle.types.Id'
997
- :return: The Id of the Shape the pointed Interface0D belongs to.
1166
+ :param it: An Interface0DIterator object.
1167
+ :type it: freestyle.types.Interface0DIterator
1168
+ :return: The Id of the Shape the pointed Interface0D belongs to.
1169
+ :rtype: freestyle.types.Id
998
1170
  """
999
1171
  ...
1000
1172
 
@@ -1005,11 +1177,11 @@ class TimeStampF1D:
1005
1177
  """Builds a TimeStampF1D object."""
1006
1178
  ...
1007
1179
 
1008
- def __call__(self, inter: "freestyle.types.Interface1D"):
1180
+ def __call__(self, inter: freestyle.types.Interface1D):
1009
1181
  """Returns the time stamp of the Interface1D.
1010
1182
 
1011
1183
  :param inter: An Interface1D object.
1012
- :type inter: 'freestyle.types.Interface1D'
1184
+ :type inter: freestyle.types.Interface1D
1013
1185
  """
1014
1186
  ...
1015
1187
 
@@ -1020,13 +1192,19 @@ class VertexOrientation2DF0D:
1020
1192
  """Builds a VertexOrientation2DF0D object."""
1021
1193
  ...
1022
1194
 
1023
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> "mathutils.Vector":
1024
- """Returns a two-dimensional vector giving the 2D oriented tangent to the 1D element to which the `freestyle.types.Interface0D` pointed by the Interface0DIterator belongs. The 2D oriented tangent is evaluated at the pointed Interface0D.
1195
+ def __call__(
1196
+ self, it: freestyle.types.Interface0DIterator
1197
+ ) -> freestyle.types.Interface0DIterator:
1198
+ """Returns a two-dimensional vector giving the 2D oriented tangent to the
1199
+ 1D element to which the `freestyle.types.Interface0D` pointed
1200
+ by the Interface0DIterator belongs. The 2D oriented tangent is
1201
+ evaluated at the pointed Interface0D.
1025
1202
 
1026
- :param it: An Interface0DIterator object.
1027
- :type it: 'freestyle.types.Interface0DIterator'
1028
- :rtype: 'mathutils.Vector'
1029
- :return: The 2D oriented tangent to the 1D element evaluated at the pointed Interface0D.
1203
+ :param it: An Interface0DIterator object.
1204
+ :type it: freestyle.types.Interface0DIterator
1205
+ :return: The 2D oriented tangent to the 1D element evaluated at the
1206
+ pointed Interface0D.
1207
+ :rtype: mathutils.Vector
1030
1208
  """
1031
1209
  ...
1032
1210
 
@@ -1037,13 +1215,19 @@ class VertexOrientation3DF0D:
1037
1215
  """Builds a VertexOrientation3DF0D object."""
1038
1216
  ...
1039
1217
 
1040
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> "mathutils.Vector":
1041
- """Returns a three-dimensional vector giving the 3D oriented tangent to the 1D element to which the `freestyle.types.Interface0D` pointed by the Interface0DIterator belongs. The 3D oriented tangent is evaluated at the pointed Interface0D.
1218
+ def __call__(
1219
+ self, it: freestyle.types.Interface0DIterator
1220
+ ) -> freestyle.types.Interface0DIterator:
1221
+ """Returns a three-dimensional vector giving the 3D oriented tangent to
1222
+ the 1D element to which the `freestyle.types.Interface0D`
1223
+ pointed by the Interface0DIterator belongs. The 3D oriented tangent
1224
+ is evaluated at the pointed Interface0D.
1042
1225
 
1043
- :param it: An Interface0DIterator object.
1044
- :type it: 'freestyle.types.Interface0DIterator'
1045
- :rtype: 'mathutils.Vector'
1046
- :return: The 3D oriented tangent to the 1D element evaluated at the pointed Interface0D.
1226
+ :param it: An Interface0DIterator object.
1227
+ :type it: freestyle.types.Interface0DIterator
1228
+ :return: The 3D oriented tangent to the 1D element evaluated at the
1229
+ pointed Interface0D.
1230
+ :rtype: mathutils.Vector
1047
1231
  """
1048
1232
  ...
1049
1233
 
@@ -1054,53 +1238,91 @@ class ZDiscontinuityF0D:
1054
1238
  """Builds a ZDiscontinuityF0D object."""
1055
1239
  ...
1056
1240
 
1057
- def __call__(self, it: "freestyle.types.Interface0DIterator") -> float:
1058
- """Returns a real value giving the distance between the `freestyle.types.Interface0D` pointed by the Interface0DIterator and the shape that lies behind (occludee). This distance is evaluated in the camera space and normalized between 0 and 1. Therefore, if no object is occluded by the shape to which the Interface0D belongs to, 1 is returned.
1241
+ def __call__(
1242
+ self, it: freestyle.types.Interface0DIterator
1243
+ ) -> freestyle.types.Interface0DIterator:
1244
+ """Returns a real value giving the distance between the
1245
+ `freestyle.types.Interface0D` pointed by the
1246
+ Interface0DIterator and the shape that lies behind (occludee). This
1247
+ distance is evaluated in the camera space and normalized between 0 and
1248
+ 1. Therefore, if no object is occluded by the shape to which the
1249
+ Interface0D belongs to, 1 is returned.
1059
1250
 
1060
- :param it: An Interface0DIterator object.
1061
- :type it: 'freestyle.types.Interface0DIterator'
1062
- :rtype: float
1063
- :return: The normalized distance between the pointed Interface0D and the occludee.
1251
+ :param it: An Interface0DIterator object.
1252
+ :type it: freestyle.types.Interface0DIterator
1253
+ :return: The normalized distance between the pointed Interface0D
1254
+ and the occludee.
1255
+ :rtype: float
1064
1256
  """
1065
1257
  ...
1066
1258
 
1067
1259
  class ZDiscontinuityF1D:
1068
1260
  """Class hierarchy: `freestyle.types.UnaryFunction1D` > `freestyle.types.UnaryFunction1DDouble` > `ZDiscontinuityF1D`"""
1069
1261
 
1070
- def __init__(
1071
- self,
1072
- integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
1073
- ):
1262
+ def __init__(self, integration_type: freestyle.types.IntegrationType = None):
1074
1263
  """Builds a ZDiscontinuityF1D object.
1075
1264
 
1076
- :param integration_type: The integration method used to compute a single value from a set of values.
1077
- :type integration_type: 'freestyle.types.IntegrationType'
1265
+ :param integration_type: The integration method used to compute a single value
1266
+ from a set of values.
1267
+ :type integration_type: freestyle.types.IntegrationType
1078
1268
  """
1079
1269
  ...
1080
1270
 
1081
- def __call__(self, inter: "freestyle.types.Interface1D") -> float:
1082
- """Returns a real value giving the distance between an Interface1D and the shape that lies behind (occludee). This distance is evaluated in the camera space and normalized between 0 and 1. Therefore, if no object is occluded by the shape to which the Interface1D belongs to, 1 is returned.
1271
+ def __call__(
1272
+ self, inter: freestyle.types.Interface1D
1273
+ ) -> freestyle.types.Interface1D:
1274
+ """Returns a real value giving the distance between an Interface1D
1275
+ and the shape that lies behind (occludee). This distance is
1276
+ evaluated in the camera space and normalized between 0 and 1.
1277
+ Therefore, if no object is occluded by the shape to which the
1278
+ Interface1D belongs to, 1 is returned.
1083
1279
 
1084
- :param inter: An Interface1D object.
1085
- :type inter: 'freestyle.types.Interface1D'
1086
- :rtype: float
1087
- :return: The normalized distance between the Interface1D and the occludee.
1280
+ :param inter: An Interface1D object.
1281
+ :type inter: freestyle.types.Interface1D
1282
+ :return: The normalized distance between the Interface1D and the occludee.
1283
+ :rtype: float
1088
1284
  """
1089
1285
  ...
1090
1286
 
1091
- class pyCurvilinearLengthF0D: ...
1287
+ class pyCurvilinearLengthF0D:
1288
+ """ """
1289
+
1290
+ ...
1092
1291
 
1093
1292
  class pyDensityAnisotropyF0D:
1094
1293
  """Estimates the anisotropy of density."""
1095
1294
 
1096
1295
  ...
1097
1296
 
1098
- class pyDensityAnisotropyF1D: ...
1099
- class pyGetInverseProjectedZF1D: ...
1100
- class pyGetSquareInverseProjectedZF1D: ...
1101
- class pyInverseCurvature2DAngleF0D: ...
1102
- class pyViewMapGradientNormF0D: ...
1103
- class pyViewMapGradientNormF1D: ...
1297
+ class pyDensityAnisotropyF1D:
1298
+ """ """
1299
+
1300
+ ...
1301
+
1302
+ class pyGetInverseProjectedZF1D:
1303
+ """ """
1304
+
1305
+ ...
1306
+
1307
+ class pyGetSquareInverseProjectedZF1D:
1308
+ """ """
1309
+
1310
+ ...
1311
+
1312
+ class pyInverseCurvature2DAngleF0D:
1313
+ """ """
1314
+
1315
+ ...
1316
+
1317
+ class pyViewMapGradientNormF0D:
1318
+ """ """
1319
+
1320
+ ...
1321
+
1322
+ class pyViewMapGradientNormF1D:
1323
+ """ """
1324
+
1325
+ ...
1104
1326
 
1105
1327
  class pyViewMapGradientVectorF0D:
1106
1328
  """Returns the gradient vector for a pixel."""