fake-bpy-module 20250828__py3-none-any.whl → 20260119__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.
Files changed (309) hide show
  1. {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +0 -13
  2. {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +0 -5
  3. {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +0 -11
  4. {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +0 -10
  5. {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +1 -0
  6. {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +1 -0
  7. {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +2 -0
  8. _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
  9. {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
  10. _bpy_internal/__init__.pyi +3 -1
  11. _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
  12. _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
  13. _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
  14. _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
  15. _bpy_internal/filesystem/__init__.pyi +5 -0
  16. _bpy_internal/filesystem/locking/__init__.pyi +28 -0
  17. _bpy_internal/platform/__init__.pyi +5 -0
  18. _bpy_types/__init__.pyi +115 -117
  19. {rna_info → _rna_info}/__init__.pyi +0 -1
  20. addon_utils/__init__.pyi +0 -13
  21. aud/__init__.pyi +66 -142
  22. bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
  23. bl_app_templates_system/__init__.pyi +5 -0
  24. bl_app_templates_system/py.typed +0 -0
  25. bl_math/__init__.pyi +2 -12
  26. bl_operators/__init__.pyi +1 -0
  27. bl_operators/add_mesh_torus/__init__.pyi +0 -2
  28. bl_operators/anim/__init__.pyi +47 -24
  29. bl_operators/assets/__init__.pyi +0 -6
  30. bl_operators/bone_selection_sets/__init__.pyi +0 -28
  31. bl_operators/clip/__init__.pyi +0 -20
  32. bl_operators/connect_to_output/__init__.pyi +0 -2
  33. bl_operators/console/__init__.pyi +0 -10
  34. bl_operators/constraint/__init__.pyi +0 -8
  35. bl_operators/copy_global_transform/__init__.pyi +261 -0
  36. bl_operators/file/__init__.pyi +0 -6
  37. bl_operators/freestyle/__init__.pyi +0 -8
  38. bl_operators/geometry_nodes/__init__.pyi +0 -8
  39. bl_operators/grease_pencil/__init__.pyi +0 -2
  40. bl_operators/image/__init__.pyi +0 -10
  41. bl_operators/image_as_planes/__init__.pyi +0 -4
  42. bl_operators/mesh/__init__.pyi +0 -47
  43. bl_operators/node/__init__.pyi +277 -57
  44. bl_operators/object/__init__.pyi +0 -37
  45. bl_operators/object_align/__init__.pyi +0 -2
  46. bl_operators/object_quick_effects/__init__.pyi +0 -8
  47. bl_operators/object_randomize_transform/__init__.pyi +0 -2
  48. bl_operators/presets/__init__.pyi +1 -51
  49. bl_operators/rigidbody/__init__.pyi +0 -6
  50. bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
  51. bl_operators/sequencer/__init__.pyi +0 -16
  52. bl_operators/spreadsheet/__init__.pyi +0 -2
  53. bl_operators/userpref/__init__.pyi +0 -50
  54. bl_operators/uvcalc_follow_active/__init__.pyi +1 -3
  55. bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
  56. bl_operators/uvcalc_transform/__init__.pyi +21 -12
  57. bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
  58. bl_operators/view3d/__init__.pyi +0 -16
  59. bl_operators/wm/__init__.pyi +0 -92
  60. bl_operators/world/__init__.pyi +0 -2
  61. bl_ui/__init__.pyi +3 -4
  62. bl_ui/anim/__init__.pyi +0 -2
  63. bl_ui/asset_shelf/__init__.pyi +0 -2
  64. bl_ui/generic_ui_list/__init__.pyi +1 -17
  65. bl_ui/node_add_menu/__init__.pyi +261 -6
  66. bl_ui/node_add_menu_compositor/__init__.pyi +96 -80
  67. bl_ui/node_add_menu_geometry/__init__.pyi +266 -306
  68. bl_ui/node_add_menu_shader/__init__.pyi +49 -50
  69. bl_ui/node_add_menu_texture/__init__.pyi +16 -62
  70. bl_ui/properties_collection/__init__.pyi +0 -14
  71. bl_ui/properties_constraint/__init__.pyi +55 -209
  72. bl_ui/properties_data_armature/__init__.pyi +0 -36
  73. bl_ui/properties_data_bone/__init__.pyi +0 -20
  74. bl_ui/properties_data_camera/__init__.pyi +0 -30
  75. bl_ui/properties_data_curve/__init__.pyi +0 -30
  76. bl_ui/properties_data_curves/__init__.pyi +0 -16
  77. bl_ui/properties_data_empty/__init__.pyi +0 -4
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
  79. bl_ui/properties_data_lattice/__init__.pyi +0 -8
  80. bl_ui/properties_data_light/__init__.pyi +0 -20
  81. bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
  82. bl_ui/properties_data_mesh/__init__.pyi +1 -42
  83. bl_ui/properties_data_metaball/__init__.pyi +0 -12
  84. bl_ui/properties_data_modifier/__init__.pyi +12 -19
  85. bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
  86. bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
  87. bl_ui/properties_data_speaker/__init__.pyi +0 -12
  88. bl_ui/properties_data_volume/__init__.pyi +0 -18
  89. bl_ui/properties_freestyle/__init__.pyi +0 -50
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +0 -159
  91. bl_ui/properties_mask_common/__init__.pyi +0 -14
  92. bl_ui/properties_material/__init__.pyi +0 -32
  93. bl_ui/properties_material_gpencil/__init__.pyi +23 -45
  94. bl_ui/properties_object/__init__.pyi +35 -42
  95. bl_ui/properties_output/__init__.pyi +0 -40
  96. bl_ui/properties_paint_common/__init__.pyi +23 -19
  97. bl_ui/properties_particle/__init__.pyi +0 -106
  98. bl_ui/properties_physics_cloth/__init__.pyi +0 -28
  99. bl_ui/properties_physics_common/__init__.pyi +0 -2
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
  101. bl_ui/properties_physics_field/__init__.pyi +0 -20
  102. bl_ui/properties_physics_fluid/__init__.pyi +0 -56
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
  106. bl_ui/properties_physics_softbody/__init__.pyi +0 -30
  107. bl_ui/properties_render/__init__.pyi +58 -86
  108. bl_ui/properties_scene/__init__.pyi +0 -34
  109. bl_ui/properties_strip/__init__.pyi +744 -0
  110. bl_ui/properties_strip_modifier/__init__.pyi +45 -0
  111. bl_ui/properties_texture/__init__.pyi +0 -54
  112. bl_ui/properties_view_layer/__init__.pyi +7 -28
  113. bl_ui/properties_workspace/__init__.pyi +0 -8
  114. bl_ui/properties_world/__init__.pyi +0 -22
  115. bl_ui/space_clip/__init__.pyi +82 -166
  116. bl_ui/space_console/__init__.pyi +0 -12
  117. bl_ui/space_dopesheet/__init__.pyi +67 -76
  118. bl_ui/space_filebrowser/__init__.pyi +0 -60
  119. bl_ui/space_graph/__init__.pyi +0 -66
  120. bl_ui/space_image/__init__.pyi +28 -162
  121. bl_ui/space_info/__init__.pyi +0 -12
  122. bl_ui/space_nla/__init__.pyi +0 -58
  123. bl_ui/space_node/__init__.pyi +99 -132
  124. bl_ui/space_outliner/__init__.pyi +0 -30
  125. bl_ui/space_properties/__init__.pyi +29 -6
  126. bl_ui/space_sequencer/__init__.pyi +159 -987
  127. bl_ui/space_spreadsheet/__init__.pyi +0 -6
  128. bl_ui/space_statusbar/__init__.pyi +0 -2
  129. bl_ui/space_text/__init__.pyi +0 -32
  130. bl_ui/space_time/__init__.pyi +29 -22
  131. bl_ui/space_toolsystem_toolbar/__init__.pyi +7 -2
  132. bl_ui/space_topbar/__init__.pyi +7 -52
  133. bl_ui/space_userpref/__init__.pyi +77 -225
  134. bl_ui/space_view3d/__init__.pyi +69 -551
  135. bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
  136. bl_ui/space_view3d_toolbar/__init__.pyi +22 -799
  137. bl_ui/utils/__init__.pyi +0 -17
  138. blf/__init__.pyi +6 -50
  139. bmesh/__init__.pyi +0 -7
  140. bmesh/geometry/__init__.pyi +0 -3
  141. bmesh/ops/__init__.pyi +5 -450
  142. bmesh/types/__init__.pyi +298 -639
  143. bmesh/utils/__init__.pyi +16 -43
  144. bpy/app/__init__.pyi +66 -58
  145. bpy/app/icons/__init__.pyi +0 -6
  146. bpy/app/timers/__init__.pyi +0 -6
  147. bpy/app/translations/__init__.pyi +1 -16
  148. bpy/msgbus/__init__.pyi +1 -4
  149. bpy/ops/action/__init__.pyi +17 -186
  150. bpy/ops/anim/__init__.pyi +38 -279
  151. bpy/ops/armature/__init__.pyi +20 -191
  152. bpy/ops/asset/__init__.pyi +11 -97
  153. bpy/ops/boid/__init__.pyi +7 -38
  154. bpy/ops/brush/__init__.pyi +3 -104
  155. bpy/ops/buttons/__init__.pyi +4 -71
  156. bpy/ops/cachefile/__init__.pyi +2 -63
  157. bpy/ops/camera/__init__.pyi +0 -11
  158. bpy/ops/clip/__init__.pyi +43 -427
  159. bpy/ops/cloth/__init__.pyi +0 -5
  160. bpy/ops/collection/__init__.pyi +3 -35
  161. bpy/ops/console/__init__.pyi +10 -88
  162. bpy/ops/constraint/__init__.pyi +3 -80
  163. bpy/ops/curve/__init__.pyi +23 -254
  164. bpy/ops/curves/__init__.pyi +54 -149
  165. bpy/ops/cycles/__init__.pyi +1 -14
  166. bpy/ops/dpaint/__init__.pyi +3 -21
  167. bpy/ops/ed/__init__.pyi +10 -82
  168. bpy/ops/export_anim/__init__.pyi +2 -10
  169. bpy/ops/export_scene/__init__.pyi +1 -155
  170. bpy/ops/extensions/__init__.pyi +15 -150
  171. bpy/ops/file/__init__.pyi +29 -216
  172. bpy/ops/fluid/__init__.pyi +13 -70
  173. bpy/ops/font/__init__.pyi +10 -134
  174. bpy/ops/geometry/__init__.pyi +3 -124
  175. bpy/ops/gizmogroup/__init__.pyi +1 -12
  176. bpy/ops/gpencil/__init__.pyi +5 -49
  177. bpy/ops/graph/__init__.pyi +20 -315
  178. bpy/ops/grease_pencil/__init__.pyi +62 -523
  179. bpy/ops/image/__init__.pyi +19 -379
  180. bpy/ops/import_anim/__init__.pyi +2 -16
  181. bpy/ops/import_curve/__init__.pyi +0 -6
  182. bpy/ops/import_scene/__init__.pyi +0 -50
  183. bpy/ops/info/__init__.pyi +4 -35
  184. bpy/ops/lattice/__init__.pyi +3 -33
  185. bpy/ops/marker/__init__.pyi +4 -49
  186. bpy/ops/mask/__init__.pyi +17 -176
  187. bpy/ops/material/__init__.pyi +3 -15
  188. bpy/ops/mball/__init__.pyi +1 -30
  189. bpy/ops/mesh/__init__.pyi +34 -932
  190. bpy/ops/nla/__init__.pyi +22 -183
  191. bpy/ops/node/__init__.pyi +420 -625
  192. bpy/ops/object/__init__.pyi +197 -1239
  193. bpy/ops/outliner/__init__.pyi +47 -327
  194. bpy/ops/paint/__init__.pyi +29 -282
  195. bpy/ops/paintcurve/__init__.pyi +4 -36
  196. bpy/ops/palette/__init__.pyi +3 -27
  197. bpy/ops/particle/__init__.pyi +20 -160
  198. bpy/ops/pointcloud/__init__.pyi +3 -35
  199. bpy/ops/pose/__init__.pyi +29 -234
  200. bpy/ops/poselib/__init__.pyi +19 -66
  201. bpy/ops/preferences/__init__.pyi +9 -177
  202. bpy/ops/ptcache/__init__.pyi +5 -31
  203. bpy/ops/render/__init__.pyi +10 -68
  204. bpy/ops/rigidbody/__init__.pyi +6 -56
  205. bpy/ops/scene/__init__.pyi +23 -168
  206. bpy/ops/screen/__init__.pyi +36 -202
  207. bpy/ops/script/__init__.pyi +1 -12
  208. bpy/ops/sculpt/__init__.pyi +42 -313
  209. bpy/ops/sculpt_curves/__init__.pyi +6 -21
  210. bpy/ops/sequencer/__init__.pyi +187 -644
  211. bpy/ops/sound/__init__.pyi +3 -109
  212. bpy/ops/spreadsheet/__init__.pyi +5 -32
  213. bpy/ops/surface/__init__.pyi +0 -48
  214. bpy/ops/text/__init__.pyi +27 -225
  215. bpy/ops/text_editor/__init__.pyi +0 -5
  216. bpy/ops/texture/__init__.pyi +3 -18
  217. bpy/ops/transform/__init__.pyi +10 -382
  218. bpy/ops/ui/__init__.pyi +29 -154
  219. bpy/ops/uilist/__init__.pyi +0 -13
  220. bpy/ops/uv/__init__.pyi +195 -288
  221. bpy/ops/view2d/__init__.pyi +3 -73
  222. bpy/ops/view3d/__init__.pyi +37 -339
  223. bpy/ops/wm/__init__.pyi +129 -1317
  224. bpy/ops/workspace/__init__.pyi +7 -39
  225. bpy/ops/world/__init__.pyi +2 -10
  226. bpy/path/__init__.pyi +0 -34
  227. bpy/props/__init__.pyi +332 -203
  228. bpy/stub_internal/rna_enums/__init__.pyi +102 -82
  229. bpy/types/__init__.pyi +51712 -89245
  230. bpy/utils/__init__.pyi +4 -75
  231. bpy/utils/previews/__init__.pyi +1 -10
  232. bpy/utils/units/__init__.pyi +0 -12
  233. bpy_extras/anim_utils/__init__.pyi +24 -16
  234. bpy_extras/bmesh_utils/__init__.pyi +0 -1
  235. bpy_extras/id_map_utils/__init__.pyi +14 -6
  236. bpy_extras/image_utils/__init__.pyi +0 -9
  237. bpy_extras/io_utils/__init__.pyi +4 -23
  238. bpy_extras/keyconfig_utils/__init__.pyi +1 -1
  239. bpy_extras/mesh_utils/__init__.pyi +0 -12
  240. bpy_extras/node_shader_utils/__init__.pyi +0 -8
  241. bpy_extras/object_utils/__init__.pyi +0 -14
  242. bpy_extras/view3d_utils/__init__.pyi +0 -18
  243. {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/METADATA +4 -1
  244. fake_bpy_module-20260119.dist-info/RECORD +385 -0
  245. {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/top_level.txt +15 -14
  246. freestyle/chainingiterators/__init__.pyi +0 -22
  247. freestyle/functions/__init__.pyi +0 -139
  248. freestyle/predicates/__init__.pyi +0 -51
  249. freestyle/shaders/__init__.pyi +0 -65
  250. freestyle/types/__init__.pyi +139 -777
  251. freestyle/utils/ContextFunctions/__init__.pyi +0 -23
  252. freestyle/utils/__init__.pyi +0 -6
  253. gpu/capabilities/__init__.pyi +0 -21
  254. gpu/matrix/__init__.pyi +1 -10
  255. gpu/platform/__init__.pyi +0 -5
  256. gpu/shader/__init__.pyi +22 -6
  257. gpu/state/__init__.pyi +59 -38
  258. gpu/texture/__init__.pyi +0 -2
  259. gpu/types/__init__.pyi +84 -152
  260. gpu_extras/batch/__init__.pyi +0 -4
  261. gpu_extras/presets/__init__.pyi +6 -8
  262. idprop/types/__init__.pyi +6 -6
  263. imbuf/__init__.pyi +2 -9
  264. imbuf/types/__init__.pyi +5 -25
  265. keyingsets_builtins/__init__.pyi +1 -45
  266. mathutils/__init__.pyi +106 -2168
  267. mathutils/bvhtree/__init__.pyi +3 -25
  268. mathutils/geometry/__init__.pyi +41 -133
  269. mathutils/interpolate/__init__.pyi +3 -4
  270. mathutils/kdtree/__init__.pyi +0 -11
  271. mathutils/noise/__init__.pyi +0 -62
  272. fake_bpy_module-20250828.dist-info/RECORD +0 -370
  273. {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
  274. {animsys_refactor → _animsys_refactor}/py.typed +0 -0
  275. {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
  276. {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
  277. {bl_console_utils → _bl_console_utils}/py.typed +0 -0
  278. {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
  279. {bl_i18n_utils → _bl_i18n_utils}/py.typed +0 -0
  280. {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +0 -0
  281. {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
  282. {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
  283. {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
  284. {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
  285. {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
  286. {bl_previews_utils → _bl_previews_utils}/py.typed +0 -0
  287. {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
  288. {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
  289. {bl_rna_utils → _bl_rna_utils}/py.typed +0 -0
  290. {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
  291. {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
  292. {bl_text_utils → _bl_text_utils}/py.typed +0 -0
  293. {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
  294. {bl_ui_utils → _bl_ui_utils}/py.typed +0 -0
  295. /_bpy_internal/{freedesktop → platform/freedesktop}/__init__.pyi +0 -0
  296. {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
  297. {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
  298. {console_python → _console_python}/__init__.pyi +0 -0
  299. {console_python → _console_python}/py.typed +0 -0
  300. {console_shell → _console_shell}/__init__.pyi +0 -0
  301. {console_shell → _console_shell}/py.typed +0 -0
  302. {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
  303. {graphviz_export → _graphviz_export}/py.typed +0 -0
  304. {keyingsets_utils → _keyingsets_utils}/__init__.pyi +0 -0
  305. {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
  306. {rna_info → _rna_info}/py.typed +0 -0
  307. {rna_xml → _rna_xml}/__init__.pyi +0 -0
  308. {rna_xml → _rna_xml}/py.typed +0 -0
  309. {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260119.dist-info}/WHEEL +0 -0
@@ -85,16 +85,10 @@ class AdjacencyIterator:
85
85
 
86
86
  is_incoming: bool
87
87
  """ True if the current ViewEdge is coming towards the iteration vertex, and
88
- False otherwise.
89
-
90
- :type: bool
91
- """
88
+ False otherwise."""
92
89
 
93
90
  object: ViewEdge
94
- """ The ViewEdge object currently pointed to by this iterator.
95
-
96
- :type: ViewEdge
97
- """
91
+ """ The ViewEdge object currently pointed to by this iterator."""
98
92
 
99
93
  def __init__(self) -> None:
100
94
  """Builds an `AdjacencyIterator` using the default constructor,
@@ -107,7 +101,6 @@ False otherwise.
107
101
  copy constructor or the overloaded constructor.
108
102
 
109
103
  :param brother: An AdjacencyIterator object.
110
- :type brother: typing_extensions.Self
111
104
  """
112
105
 
113
106
  def __init__(
@@ -120,13 +113,10 @@ False otherwise.
120
113
  copy constructor or the overloaded constructor.
121
114
 
122
115
  :param vertex: The vertex which is the next crossing.
123
- :type vertex: ViewVertex
124
116
  :param restrict_to_selection: Indicates whether to force the chaining
125
117
  to stay within the set of selected ViewEdges or not.
126
- :type restrict_to_selection: bool
127
118
  :param restrict_to_unvisited: Indicates whether a ViewEdge that has
128
119
  already been chained must be ignored ot not.
129
- :type restrict_to_unvisited: bool
130
120
  """
131
121
 
132
122
  class BBox:
@@ -144,10 +134,7 @@ class BinaryPredicate0D:
144
134
  """
145
135
 
146
136
  name: str
147
- """ The name of the binary 0D predicate.
148
-
149
- :type: str
150
- """
137
+ """ The name of the binary 0D predicate."""
151
138
 
152
139
  def __init__(self) -> None:
153
140
  """Default constructor."""
@@ -157,11 +144,8 @@ class BinaryPredicate0D:
157
144
  between two Interface0D objects.
158
145
 
159
146
  :param inter1: The first Interface0D object.
160
- :type inter1: Interface0D
161
147
  :param inter2: The second Interface0D object.
162
- :type inter2: Interface0D
163
148
  :return: True or false.
164
- :rtype: bool
165
149
  """
166
150
 
167
151
  class BinaryPredicate1D:
@@ -173,10 +157,7 @@ class BinaryPredicate1D:
173
157
  """
174
158
 
175
159
  name: str
176
- """ The name of the binary 1D predicate.
177
-
178
- :type: str
179
- """
160
+ """ The name of the binary 1D predicate."""
180
161
 
181
162
  def __init__(self) -> None:
182
163
  """Default constructor."""
@@ -186,11 +167,8 @@ class BinaryPredicate1D:
186
167
  between two Interface1D objects.
187
168
 
188
169
  :param inter1: The first Interface1D object.
189
- :type inter1: Interface1D
190
170
  :param inter2: The second Interface1D object.
191
- :type inter2: Interface1D
192
171
  :return: True or false.
193
- :rtype: bool
194
172
  """
195
173
 
196
174
  class Chain:
@@ -210,7 +188,6 @@ class Chain:
210
188
  copy constructor or from an `Id`.
211
189
 
212
190
  :param brother: A Chain object.
213
- :type brother: typing_extensions.Self
214
191
  """
215
192
 
216
193
  def __init__(self, id: Id) -> None:
@@ -218,26 +195,21 @@ class Chain:
218
195
  copy constructor or from an `Id`.
219
196
 
220
197
  :param id: An Id object.
221
- :type id: Id
222
198
  """
223
199
 
224
200
  def push_viewedge_back(self, viewedge: ViewEdge, orientation: bool) -> None:
225
201
  """Adds a ViewEdge at the end of the Chain.
226
202
 
227
203
  :param viewedge: The ViewEdge that must be added.
228
- :type viewedge: ViewEdge
229
204
  :param orientation: The orientation with which the ViewEdge must be processed.
230
- :type orientation: bool
231
205
  """
232
206
 
233
207
  def push_viewedge_front(self, viewedge: ViewEdge, orientation: bool) -> None:
234
208
  """Adds a ViewEdge at the beginning of the Chain.
235
209
 
236
210
  :param viewedge: The ViewEdge that must be added.
237
- :type viewedge: ViewEdge
238
211
  :param orientation: The orientation with which the ViewEdge must be
239
212
  processed.
240
- :type orientation: bool
241
213
  """
242
214
 
243
215
  class ChainingIterator:
@@ -252,22 +224,13 @@ class ChainingIterator:
252
224
  """
253
225
 
254
226
  is_incrementing: bool
255
- """ True if the current iteration is an incrementation.
256
-
257
- :type: bool
258
- """
227
+ """ True if the current iteration is an incrementation."""
259
228
 
260
229
  next_vertex: ViewVertex
261
- """ The ViewVertex that is the next crossing.
262
-
263
- :type: ViewVertex
264
- """
230
+ """ The ViewVertex that is the next crossing."""
265
231
 
266
232
  object: ViewEdge
267
- """ The ViewEdge object currently pointed by this iterator.
268
-
269
- :type: ViewEdge
270
- """
233
+ """ The ViewEdge object currently pointed by this iterator."""
271
234
 
272
235
  def __init__(
273
236
  self,
@@ -281,15 +244,11 @@ class ChainingIterator:
281
244
 
282
245
  :param restrict_to_selection: Indicates whether to force the chaining
283
246
  to stay within the set of selected ViewEdges or not.
284
- :type restrict_to_selection: bool
285
247
  :param restrict_to_unvisited: Indicates whether a ViewEdge that has
286
248
  already been chained must be ignored ot not.
287
- :type restrict_to_unvisited: bool
288
249
  :param begin: The ViewEdge from which to start the chain.
289
- :type begin: None | ViewEdge | None
290
250
  :param orientation: The direction to follow to explore the graph. If
291
251
  true, the direction indicated by the first ViewEdge is used.
292
- :type orientation: bool
293
252
  """
294
253
 
295
254
  def __init__(self, brother: typing_extensions.Self) -> None:
@@ -297,7 +256,6 @@ class ChainingIterator:
297
256
  iteration and its orientation or by using the copy constructor.
298
257
 
299
258
  :param brother:
300
- :type brother: typing_extensions.Self
301
259
  """
302
260
 
303
261
  def init(self) -> None:
@@ -315,9 +273,7 @@ class ChainingIterator:
315
273
  :param it: The iterator over the ViewEdges adjacent to the end vertex
316
274
  of the current ViewEdge. The adjacency iterator reflects the
317
275
  restriction rules by only iterating over the valid ViewEdges.
318
- :type it: AdjacencyIterator
319
276
  :return: Returns the next ViewEdge to follow, or None if chaining ends.
320
- :rtype: None | ViewEdge
321
277
  """
322
278
 
323
279
  class Curve:
@@ -327,16 +283,10 @@ class Curve:
327
283
  """
328
284
 
329
285
  is_empty: bool
330
- """ True if the Curve doesnt have any Vertex yet.
331
-
332
- :type: bool
333
- """
286
+ """ True if the Curve doesn't have any Vertex yet."""
334
287
 
335
288
  segments_size: int
336
- """ The number of segments in the polyline constituting the Curve.
337
-
338
- :type: int
339
- """
289
+ """ The number of segments in the polyline constituting the Curve."""
340
290
 
341
291
  def __init__(self) -> None:
342
292
  """Builds a `FrsCurve` using a default constructor,
@@ -349,7 +299,6 @@ class Curve:
349
299
  copy constructor or from an `Id`.
350
300
 
351
301
  :param brother: A Curve object.
352
- :type brother: typing_extensions.Self
353
302
  """
354
303
 
355
304
  def __init__(self, id: Id) -> None:
@@ -357,21 +306,18 @@ class Curve:
357
306
  copy constructor or from an `Id`.
358
307
 
359
308
  :param id: An Id object.
360
- :type id: Id
361
309
  """
362
310
 
363
311
  def push_vertex_back(self, vertex: CurvePoint | SVertex) -> None:
364
312
  """Adds a single vertex at the end of the Curve.
365
313
 
366
314
  :param vertex: A vertex object.
367
- :type vertex: CurvePoint | SVertex
368
315
  """
369
316
 
370
317
  def push_vertex_front(self, vertex: CurvePoint | SVertex) -> None:
371
318
  """Adds a single vertex at the front of the Curve.
372
319
 
373
320
  :param vertex: A vertex object.
374
- :type vertex: CurvePoint | SVertex
375
321
  """
376
322
 
377
323
  class CurvePoint:
@@ -387,28 +333,16 @@ class CurvePoint:
387
333
 
388
334
  fedge: FEdge
389
335
  """ Gets the FEdge for the two SVertices that given CurvePoints consists out of.
390
- A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
391
-
392
- :type: FEdge
393
- """
336
+ A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex)."""
394
337
 
395
338
  first_svertex: SVertex
396
- """ The first SVertex upon which the CurvePoint is built.
397
-
398
- :type: SVertex
399
- """
339
+ """ The first SVertex upon which the CurvePoint is built."""
400
340
 
401
341
  second_svertex: SVertex
402
- """ The second SVertex upon which the CurvePoint is built.
403
-
404
- :type: SVertex
405
- """
342
+ """ The second SVertex upon which the CurvePoint is built."""
406
343
 
407
344
  t2d: float
408
- """ The 2D interpolation parameter.
409
-
410
- :type: float
411
- """
345
+ """ The 2D interpolation parameter."""
412
346
 
413
347
  def __init__(self) -> None:
414
348
  """Builds a CurvePoint using the default constructor, copy constructor,
@@ -425,7 +359,6 @@ A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
425
359
  objects and an interpolation parameter
426
360
 
427
361
  :param brother: A CurvePoint object.
428
- :type brother: typing_extensions.Self
429
362
  """
430
363
 
431
364
  def __init__(
@@ -437,12 +370,9 @@ A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
437
370
  objects and an interpolation parameter
438
371
 
439
372
  :param first_vertex: The first SVertex.
440
- :type first_vertex: SVertex
441
373
  :param second_vertex: The second SVertex.
442
- :type second_vertex: SVertex
443
374
  :param t2d: A 2D interpolation parameter used to linearly interpolate
444
375
  first_vertex and second_vertex or first_point and second_point.
445
- :type t2d: float
446
376
  """
447
377
 
448
378
  def __init__(
@@ -457,12 +387,9 @@ A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
457
387
  objects and an interpolation parameter
458
388
 
459
389
  :param first_point: The first CurvePoint.
460
- :type first_point: typing_extensions.Self
461
390
  :param second_point: The second CurvePoint.
462
- :type second_point: typing_extensions.Self
463
391
  :param t2d: A 2D interpolation parameter used to linearly interpolate
464
392
  first_vertex and second_vertex or first_point and second_point.
465
- :type t2d: float
466
393
  """
467
394
 
468
395
  class CurvePointIterator:
@@ -472,22 +399,13 @@ class CurvePointIterator:
472
399
  """
473
400
 
474
401
  object: CurvePoint
475
- """ The CurvePoint object currently pointed by this iterator.
476
-
477
- :type: CurvePoint
478
- """
402
+ """ The CurvePoint object currently pointed by this iterator."""
479
403
 
480
404
  t: float
481
- """ The curvilinear abscissa of the current point.
482
-
483
- :type: float
484
- """
405
+ """ The curvilinear abscissa of the current point."""
485
406
 
486
407
  u: float
487
- """ The point parameter at the current point in the stroke (0 <= u <= 1).
488
-
489
- :type: float
490
- """
408
+ """ The point parameter at the current point in the stroke (0 <= u <= 1)."""
491
409
 
492
410
  def __init__(self) -> None:
493
411
  """Builds a CurvePointIterator object using either the default constructor,
@@ -500,7 +418,6 @@ class CurvePointIterator:
500
418
  copy constructor, or the overloaded constructor.
501
419
 
502
420
  :param brother: A CurvePointIterator object.
503
- :type brother: typing_extensions.Self
504
421
  """
505
422
 
506
423
  def __init__(self, step: float = 0.0) -> None:
@@ -510,7 +427,6 @@ class CurvePointIterator:
510
427
  :param step: A resampling resolution with which the curve is resampled.
511
428
  If zero, no resampling is done (i.e., the iterator iterates over
512
429
  initial vertices).
513
- :type step: float
514
430
  """
515
431
 
516
432
  class FEdge:
@@ -526,54 +442,30 @@ class FEdge:
526
442
  """
527
443
 
528
444
  first_svertex: SVertex
529
- """ The first SVertex constituting this FEdge.
530
-
531
- :type: SVertex
532
- """
445
+ """ The first SVertex constituting this FEdge."""
533
446
 
534
447
  id: Id
535
- """ The Id of this FEdge.
536
-
537
- :type: Id
538
- """
448
+ """ The Id of this FEdge."""
539
449
 
540
450
  is_smooth: bool
541
- """ True if this FEdge is a smooth FEdge.
542
-
543
- :type: bool
544
- """
451
+ """ True if this FEdge is a smooth FEdge."""
545
452
 
546
453
  nature: Nature
547
- """ The nature of this FEdge.
548
-
549
- :type: Nature
550
- """
454
+ """ The nature of this FEdge."""
551
455
 
552
456
  next_fedge: typing_extensions.Self
553
457
  """ The FEdge following this one in the ViewEdge. The value is None if
554
- this FEdge is the last of the ViewEdge.
555
-
556
- :type: typing_extensions.Self
557
- """
458
+ this FEdge is the last of the ViewEdge."""
558
459
 
559
460
  previous_fedge: typing_extensions.Self
560
461
  """ The FEdge preceding this one in the ViewEdge. The value is None if
561
- this FEdge is the first one of the ViewEdge.
562
-
563
- :type: typing_extensions.Self
564
- """
462
+ this FEdge is the first one of the ViewEdge."""
565
463
 
566
464
  second_svertex: SVertex
567
- """ The second SVertex constituting this FEdge.
568
-
569
- :type: SVertex
570
- """
465
+ """ The second SVertex constituting this FEdge."""
571
466
 
572
467
  viewedge: ViewEdge
573
- """ The ViewEdge to which this FEdge belongs to.
574
-
575
- :type: ViewEdge
576
- """
468
+ """ The ViewEdge to which this FEdge belongs to."""
577
469
 
578
470
  def FEdge(self) -> None:
579
471
  """Builds an `FEdge` using the default constructor,
@@ -586,7 +478,6 @@ this FEdge is the first one of the ViewEdge.
586
478
  copy constructor, or between two `SVertex` objects.
587
479
 
588
480
  :param brother: An FEdge object.
589
- :type brother: typing_extensions.Self
590
481
  """
591
482
 
592
483
  class FEdgeSharp:
@@ -599,58 +490,34 @@ class FEdgeSharp:
599
490
  """
600
491
 
601
492
  face_mark_left: bool
602
- """ The face mark of the face lying on the left of the FEdge.
603
-
604
- :type: bool
605
- """
493
+ """ The face mark of the face lying on the left of the FEdge."""
606
494
 
607
495
  face_mark_right: bool
608
496
  """ The face mark of the face lying on the right of the FEdge. If this FEdge
609
497
  is a border, it has no face on the right and thus this property is set to
610
- false.
611
-
612
- :type: bool
613
- """
498
+ false."""
614
499
 
615
500
  material_index_left: int
616
- """ The index of the material of the face lying on the left of the FEdge.
617
-
618
- :type: int
619
- """
501
+ """ The index of the material of the face lying on the left of the FEdge."""
620
502
 
621
503
  material_index_right: int
622
504
  """ The index of the material of the face lying on the right of the FEdge.
623
505
  If this FEdge is a border, it has no Face on its right and therefore
624
- no material.
625
-
626
- :type: int
627
- """
506
+ no material."""
628
507
 
629
508
  material_left: Material
630
- """ The material of the face lying on the left of the FEdge.
631
-
632
- :type: Material
633
- """
509
+ """ The material of the face lying on the left of the FEdge."""
634
510
 
635
511
  material_right: Material
636
512
  """ The material of the face lying on the right of the FEdge. If this FEdge
637
- is a border, it has no Face on its right and therefore no material.
638
-
639
- :type: Material
640
- """
513
+ is a border, it has no Face on its right and therefore no material."""
641
514
 
642
515
  normal_left: mathutils.Vector
643
- """ The normal to the face lying on the left of the FEdge.
644
-
645
- :type: mathutils.Vector
646
- """
516
+ """ The normal to the face lying on the left of the FEdge."""
647
517
 
648
518
  normal_right: mathutils.Vector
649
519
  """ The normal to the face lying on the right of the FEdge. If this FEdge
650
- is a border, it has no Face on its right and therefore no normal.
651
-
652
- :type: mathutils.Vector
653
- """
520
+ is a border, it has no Face on its right and therefore no normal."""
654
521
 
655
522
  def __init__(self) -> None:
656
523
  """Builds an `FEdgeSharp` using the default constructor,
@@ -663,7 +530,6 @@ is a border, it has no Face on its right and therefore no normal.
663
530
  copy constructor, or between two `SVertex` objects.
664
531
 
665
532
  :param brother: An FEdgeSharp object.
666
- :type brother: typing_extensions.Self
667
533
  """
668
534
 
669
535
  def __init__(self, first_vertex: SVertex, second_vertex: SVertex) -> None:
@@ -671,9 +537,7 @@ is a border, it has no Face on its right and therefore no normal.
671
537
  copy constructor, or between two `SVertex` objects.
672
538
 
673
539
  :param first_vertex: The first SVertex object.
674
- :type first_vertex: SVertex
675
540
  :param second_vertex: The second SVertex object.
676
- :type second_vertex: SVertex
677
541
  """
678
542
 
679
543
  class FEdgeSmooth:
@@ -683,28 +547,16 @@ class FEdgeSmooth:
683
547
  """
684
548
 
685
549
  face_mark: bool
686
- """ The face mark of the face that this FEdge is running across.
687
-
688
- :type: bool
689
- """
550
+ """ The face mark of the face that this FEdge is running across."""
690
551
 
691
552
  material: Material
692
- """ The material of the face that this FEdge is running across.
693
-
694
- :type: Material
695
- """
553
+ """ The material of the face that this FEdge is running across."""
696
554
 
697
555
  material_index: int
698
- """ The index of the material of the face that this FEdge is running across.
699
-
700
- :type: int
701
- """
556
+ """ The index of the material of the face that this FEdge is running across."""
702
557
 
703
558
  normal: mathutils.Vector
704
- """ The normal of the face that this FEdge is running across.
705
-
706
- :type: mathutils.Vector
707
- """
559
+ """ The normal of the face that this FEdge is running across."""
708
560
 
709
561
  def __init__(self) -> None:
710
562
  """Builds an `FEdgeSmooth` using the default constructor,
@@ -717,7 +569,6 @@ class FEdgeSmooth:
717
569
  copy constructor, or between two `SVertex`.
718
570
 
719
571
  :param brother: An FEdgeSmooth object.
720
- :type brother: typing_extensions.Self
721
572
  """
722
573
 
723
574
  def __init__(self, first_vertex: SVertex, second_vertex: SVertex) -> None:
@@ -725,25 +576,17 @@ class FEdgeSmooth:
725
576
  copy constructor, or between two `SVertex`.
726
577
 
727
578
  :param first_vertex: The first SVertex object.
728
- :type first_vertex: SVertex
729
579
  :param second_vertex: The second SVertex object.
730
- :type second_vertex: SVertex
731
580
  """
732
581
 
733
582
  class Id:
734
583
  """Class for representing an object Id."""
735
584
 
736
585
  first: int
737
- """ The first number constituting the Id.
738
-
739
- :type: int
740
- """
586
+ """ The first number constituting the Id."""
741
587
 
742
588
  second: int
743
- """ The second number constituting the Id.
744
-
745
- :type: int
746
- """
589
+ """ The second number constituting the Id."""
747
590
 
748
591
  def __init__(self, brother) -> None:
749
592
  """Build the Id from two numbers or another `Id` using the copy constructor.
@@ -755,9 +598,7 @@ class Id:
755
598
  """Build the Id from two numbers or another `Id` using the copy constructor.
756
599
 
757
600
  :param first:
758
- :type first: int
759
601
  :param second: The second number.
760
- :type second: int
761
602
  """
762
603
 
763
604
  class IntegrationType:
@@ -770,52 +611,28 @@ class Interface0D:
770
611
  """Base class for any 0D element."""
771
612
 
772
613
  id: Id
773
- """ The Id of this 0D element.
774
-
775
- :type: Id
776
- """
614
+ """ The Id of this 0D element."""
777
615
 
778
616
  name: str
779
- """ The string of the name of this 0D element.
780
-
781
- :type: str
782
- """
617
+ """ The string of the name of this 0D element."""
783
618
 
784
619
  nature: Nature
785
- """ The nature of this 0D element.
786
-
787
- :type: Nature
788
- """
620
+ """ The nature of this 0D element."""
789
621
 
790
622
  point_2d: mathutils.Vector
791
- """ The 2D point of this 0D element.
792
-
793
- :type: mathutils.Vector
794
- """
623
+ """ The 2D point of this 0D element."""
795
624
 
796
625
  point_3d: mathutils.Vector
797
- """ The 3D point of this 0D element.
798
-
799
- :type: mathutils.Vector
800
- """
626
+ """ The 3D point of this 0D element."""
801
627
 
802
628
  projected_x: float
803
- """ The X coordinate of the projected 3D point of this 0D element.
804
-
805
- :type: float
806
- """
629
+ """ The X coordinate of the projected 3D point of this 0D element."""
807
630
 
808
631
  projected_y: float
809
- """ The Y coordinate of the projected 3D point of this 0D element.
810
-
811
- :type: float
812
- """
632
+ """ The Y coordinate of the projected 3D point of this 0D element."""
813
633
 
814
634
  projected_z: float
815
- """ The Z coordinate of the projected 3D point of this 0D element.
816
-
817
- :type: float
818
- """
635
+ """ The Z coordinate of the projected 3D point of this 0D element."""
819
636
 
820
637
  def __init__(self) -> None:
821
638
  """Default constructor."""
@@ -825,9 +642,7 @@ class Interface0D:
825
642
  element given as the argument.
826
643
 
827
644
  :param inter: A 0D element.
828
- :type inter: typing_extensions.Self
829
645
  :return: The FEdge lying between the two 0D elements.
830
- :rtype: FEdge
831
646
  """
832
647
 
833
648
  class Interface0DIterator:
@@ -837,38 +652,25 @@ class Interface0DIterator:
837
652
 
838
653
  at_last: bool
839
654
  """ True if the iterator points to the last valid element.
840
- For its counterpart (pointing to the first valid element), use it.is_begin.
841
-
842
- :type: bool
843
- """
655
+ For its counterpart (pointing to the first valid element), use it.is_begin."""
844
656
 
845
657
  object: Interface0D
846
658
  """ The 0D object currently pointed to by this iterator. Note that the object
847
659
  may be an instance of an Interface0D subclass. For example if the iterator
848
660
  has been created from the vertices_begin() method of the `Stroke`
849
- class, the .object property refers to a `StrokeVertex` object.
850
-
851
- :type: Interface0D
852
- """
661
+ class, the .object property refers to a `StrokeVertex` object."""
853
662
 
854
663
  t: float
855
- """ The curvilinear abscissa of the current point.
856
-
857
- :type: float
858
- """
664
+ """ The curvilinear abscissa of the current point."""
859
665
 
860
666
  u: float
861
- """ The point parameter at the current point in the 1D element (0 <= u <= 1).
862
-
863
- :type: float
864
- """
667
+ """ The point parameter at the current point in the 1D element (0 <= u <= 1)."""
865
668
 
866
669
  def __init__(self, brother: typing_extensions.Self) -> None:
867
670
  """Construct a nested Interface0DIterator using either the copy constructor
868
671
  or the constructor that takes an argument of a Function0D.
869
672
 
870
673
  :param brother: An Interface0DIterator object.
871
- :type brother: typing_extensions.Self
872
674
  """
873
675
 
874
676
  def __init__(
@@ -878,41 +680,25 @@ class, the .object property refers to a `StrokeVertex` object.
878
680
  or the constructor that takes an argument of a Function0D.
879
681
 
880
682
  :param it: An iterator object to be nested.
881
- :type it: CurvePointIterator | SVertexIterator | StrokeVertexIterator
882
683
  """
883
684
 
884
685
  class Interface1D:
885
686
  """Base class for any 1D element."""
886
687
 
887
688
  id: Id
888
- """ The Id of this Interface1D.
889
-
890
- :type: Id
891
- """
689
+ """ The Id of this Interface1D."""
892
690
 
893
691
  length_2d: float
894
- """ The 2D length of this Interface1D.
895
-
896
- :type: float
897
- """
692
+ """ The 2D length of this Interface1D."""
898
693
 
899
694
  name: str
900
- """ The string of the name of the 1D element.
901
-
902
- :type: str
903
- """
695
+ """ The string of the name of the 1D element."""
904
696
 
905
697
  nature: Nature
906
- """ The nature of this Interface1D.
907
-
908
- :type: Nature
909
- """
698
+ """ The nature of this Interface1D."""
910
699
 
911
700
  time_stamp: int
912
- """ The time stamp of the 1D element, mainly used for selection.
913
-
914
- :type: int
915
- """
701
+ """ The time stamp of the 1D element, mainly used for selection."""
916
702
 
917
703
  def __init__(self) -> None:
918
704
  """Default constructor."""
@@ -925,9 +711,7 @@ class Interface1D:
925
711
 
926
712
  :param t: A sampling with which we want to iterate over points of
927
713
  this 1D element.
928
- :type t: float
929
714
  :return: An Interface0DIterator pointing to the first point.
930
- :rtype: Interface0DIterator
931
715
  """
932
716
 
933
717
  def points_end(self, t: float = 0.0) -> Interface0DIterator:
@@ -938,9 +722,7 @@ class Interface1D:
938
722
 
939
723
  :param t: A sampling with which we want to iterate over points of
940
724
  this 1D element.
941
- :type t: float
942
725
  :return: An Interface0DIterator pointing after the last point.
943
- :rtype: Interface0DIterator
944
726
  """
945
727
 
946
728
  def vertices_begin(self) -> Interface0DIterator:
@@ -948,7 +730,6 @@ class Interface1D:
948
730
  first vertex.
949
731
 
950
732
  :return: An Interface0DIterator pointing to the first vertex.
951
- :rtype: Interface0DIterator
952
733
  """
953
734
 
954
735
  def vertices_end(self) -> Interface0DIterator:
@@ -956,29 +737,19 @@ class Interface1D:
956
737
  the last vertex.
957
738
 
958
739
  :return: An Interface0DIterator pointing after the last vertex.
959
- :rtype: Interface0DIterator
960
740
  """
961
741
 
962
742
  class Iterator:
963
743
  """Base class to define iterators."""
964
744
 
965
745
  is_begin: bool
966
- """ True if the iterator points to the first element.
967
-
968
- :type: bool
969
- """
746
+ """ True if the iterator points to the first element."""
970
747
 
971
748
  is_end: bool
972
- """ True if the iterator points to the last element.
973
-
974
- :type: bool
975
- """
749
+ """ True if the iterator points to the last element."""
976
750
 
977
751
  name: str
978
- """ The string of the name of this iterator.
979
-
980
- :type: str
981
- """
752
+ """ The string of the name of this iterator."""
982
753
 
983
754
  def __init__(self) -> None:
984
755
  """Default constructor."""
@@ -993,46 +764,25 @@ class Material:
993
764
  """Class defining a material."""
994
765
 
995
766
  ambient: mathutils.Color
996
- """ RGBA components of the ambient color of the material.
997
-
998
- :type: mathutils.Color
999
- """
767
+ """ RGBA components of the ambient color of the material."""
1000
768
 
1001
769
  diffuse: mathutils.Vector
1002
- """ RGBA components of the diffuse color of the material.
1003
-
1004
- :type: mathutils.Vector
1005
- """
770
+ """ RGBA components of the diffuse color of the material."""
1006
771
 
1007
772
  emission: mathutils.Color
1008
- """ RGBA components of the emissive color of the material.
1009
-
1010
- :type: mathutils.Color
1011
- """
773
+ """ RGBA components of the emissive color of the material."""
1012
774
 
1013
775
  line: mathutils.Vector
1014
- """ RGBA components of the line color of the material.
1015
-
1016
- :type: mathutils.Vector
1017
- """
776
+ """ RGBA components of the line color of the material."""
1018
777
 
1019
778
  priority: int
1020
- """ Line color priority of the material.
1021
-
1022
- :type: int
1023
- """
779
+ """ Line color priority of the material."""
1024
780
 
1025
781
  shininess: float
1026
- """ Shininess coefficient of the material.
1027
-
1028
- :type: float
1029
- """
782
+ """ Shininess coefficient of the material."""
1030
783
 
1031
784
  specular: mathutils.Vector
1032
- """ RGBA components of the specular color of the material.
1033
-
1034
- :type: mathutils.Vector
1035
- """
785
+ """ RGBA components of the specular color of the material."""
1036
786
 
1037
787
  def __init__(self) -> None:
1038
788
  """Creates a `FrsMaterial` using either default constructor,
@@ -1045,7 +795,6 @@ class Material:
1045
795
  copy constructor, or an overloaded constructor
1046
796
 
1047
797
  :param brother: A Material object to be used as a copy constructor.
1048
- :type brother: typing_extensions.Self
1049
798
  """
1050
799
 
1051
800
  def __init__(
@@ -1074,19 +823,12 @@ class Material:
1074
823
  copy constructor, or an overloaded constructor
1075
824
 
1076
825
  :param line: The line color.
1077
- :type line: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
1078
826
  :param diffuse: The diffuse color.
1079
- :type diffuse: typing.Any
1080
827
  :param ambient: The ambient color.
1081
- :type ambient: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
1082
828
  :param specular: The specular color.
1083
- :type specular: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
1084
829
  :param emission: The emissive color.
1085
- :type emission: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
1086
830
  :param shininess: The shininess coefficient.
1087
- :type shininess: float
1088
831
  :param priority: The line color priority.
1089
- :type priority: int
1090
832
  """
1091
833
 
1092
834
  class MediumType:
@@ -1106,16 +848,13 @@ class Noise:
1106
848
  otherwise, time is used as a seed.
1107
849
 
1108
850
  :param seed: Seed for random number generation.
1109
- :type seed: int
1110
851
  """
1111
852
 
1112
853
  def smoothNoise1(self, v: float) -> float:
1113
854
  """Returns a smooth noise value for a 1D element.
1114
855
 
1115
856
  :param v: One-dimensional sample point.
1116
- :type v: float
1117
857
  :return: A smooth noise value.
1118
- :rtype: float
1119
858
  """
1120
859
 
1121
860
  def smoothNoise2(
@@ -1128,9 +867,7 @@ class Noise:
1128
867
  """Returns a smooth noise value for a 2D element.
1129
868
 
1130
869
  :param v: Two-dimensional sample point.
1131
- :type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float]
1132
870
  :return: A smooth noise value.
1133
- :rtype: float
1134
871
  """
1135
872
 
1136
873
  def smoothNoise3(
@@ -1143,24 +880,17 @@ class Noise:
1143
880
  """Returns a smooth noise value for a 3D element.
1144
881
 
1145
882
  :param v: Three-dimensional sample point.
1146
- :type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
1147
883
  :return: A smooth noise value.
1148
- :rtype: float
1149
884
  """
1150
885
 
1151
886
  def turbulence1(self, v: float, freq: float, amp: float, oct: int = 4) -> float:
1152
887
  """Returns a noise value for a 1D element.
1153
888
 
1154
889
  :param v: One-dimensional sample point.
1155
- :type v: float
1156
890
  :param freq: Noise frequency.
1157
- :type freq: float
1158
891
  :param amp: Amplitude.
1159
- :type amp: float
1160
892
  :param oct: Number of octaves.
1161
- :type oct: int
1162
893
  :return: A noise value.
1163
- :rtype: float
1164
894
  """
1165
895
 
1166
896
  def turbulence2(
@@ -1176,15 +906,10 @@ class Noise:
1176
906
  """Returns a noise value for a 2D element.
1177
907
 
1178
908
  :param v: Two-dimensional sample point.
1179
- :type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float]
1180
909
  :param freq: Noise frequency.
1181
- :type freq: float
1182
910
  :param amp: Amplitude.
1183
- :type amp: float
1184
911
  :param oct: Number of octaves.
1185
- :type oct: int
1186
912
  :return: A noise value.
1187
- :rtype: float
1188
913
  """
1189
914
 
1190
915
  def turbulence3(
@@ -1200,15 +925,10 @@ class Noise:
1200
925
  """Returns a noise value for a 3D element.
1201
926
 
1202
927
  :param v: Three-dimensional sample point.
1203
- :type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
1204
928
  :param freq: Noise frequency.
1205
- :type freq: float
1206
929
  :param amp: Amplitude.
1207
- :type amp: float
1208
930
  :param oct: Number of octaves.
1209
- :type oct: int
1210
931
  :return: A noise value.
1211
- :rtype: float
1212
932
  """
1213
933
 
1214
934
  class NonTVertex:
@@ -1217,10 +937,7 @@ class NonTVertex:
1217
937
  """
1218
938
 
1219
939
  svertex: SVertex
1220
- """ The SVertex on top of which this NonTVertex is built.
1221
-
1222
- :type: SVertex
1223
- """
940
+ """ The SVertex on top of which this NonTVertex is built."""
1224
941
 
1225
942
  def __init__(self) -> None:
1226
943
  """Builds a `NonTVertex` using the default constructor or a `SVertex`."""
@@ -1229,7 +946,6 @@ class NonTVertex:
1229
946
  """Builds a `NonTVertex` using the default constructor or a `SVertex`.
1230
947
 
1231
948
  :param svertex: An SVertex object.
1232
- :type svertex: SVertex
1233
949
  """
1234
950
 
1235
951
  class Operators:
@@ -1255,11 +971,9 @@ class Operators:
1255
971
 
1256
972
  :param it: The ChainingIterator on the ViewEdges of the ViewMap. It
1257
973
  contains the chaining rule.
1258
- :type it: ChainingIterator
1259
974
  :param pred: The predicate on the ViewEdge that expresses the stopping condition.
1260
975
  This parameter is optional, you make not want to pass a stopping criterion
1261
976
  when the stopping criterion is already contained in the iterator definition.
1262
- :type pred: UnaryPredicate1D
1263
977
  """
1264
978
 
1265
979
  @staticmethod
@@ -1278,7 +992,6 @@ class Operators:
1278
992
 
1279
993
  :param it: The ChainingIterator on the ViewEdges of the ViewMap. It
1280
994
  contains the chaining rule.
1281
- :type it: ChainingIterator
1282
995
  """
1283
996
 
1284
997
  @staticmethod
@@ -1293,15 +1006,12 @@ class Operators:
1293
1006
 
1294
1007
  :param it: The iterator on the ViewEdges of the ViewMap. It contains
1295
1008
  the chaining rule.
1296
- :type it: ViewEdgeIterator
1297
1009
  :param pred: The predicate on the ViewEdge that expresses the
1298
1010
  stopping condition.
1299
- :type pred: UnaryPredicate1D
1300
1011
  :param modifier: A function that takes a ViewEdge as argument and
1301
1012
  that is used to modify the processed ViewEdge state (the
1302
1013
  timestamp incrementation is a typical illustration of such a modifier).
1303
1014
  If this argument is not given, the time stamp is automatically managed.
1304
- :type modifier: UnaryFunction1DVoid
1305
1015
  """
1306
1016
 
1307
1017
  @staticmethod
@@ -1314,10 +1024,8 @@ class Operators:
1314
1024
 
1315
1025
  :param it: The iterator on the ViewEdges of the ViewMap. It contains
1316
1026
  the chaining rule.
1317
- :type it: ViewEdgeIterator
1318
1027
  :param pred: The predicate on the ViewEdge that expresses the
1319
1028
  stopping condition.
1320
- :type pred: UnaryPredicate1D
1321
1029
  """
1322
1030
 
1323
1031
  @staticmethod
@@ -1327,9 +1035,7 @@ class Operators:
1327
1035
 
1328
1036
  :param pred: The predicate that a chain must verify in order to be
1329
1037
  transform as a stroke.
1330
- :type pred: UnaryPredicate1D
1331
1038
  :param shaders: The list of shaders used to shade the strokes.
1332
- :type shaders: list[StrokeShader]
1333
1039
  """
1334
1040
 
1335
1041
  @staticmethod
@@ -1337,9 +1043,7 @@ class Operators:
1337
1043
  """Returns the Chain at the index in the current set of Chains.
1338
1044
 
1339
1045
  :param i: index (0 <= i < Operators.get_chains_size()).
1340
- :type i: int
1341
1046
  :return: The Chain object.
1342
- :rtype: Chain
1343
1047
  """
1344
1048
 
1345
1049
  @staticmethod
@@ -1347,7 +1051,6 @@ class Operators:
1347
1051
  """Returns the number of Chains.
1348
1052
 
1349
1053
  :return: The number of Chains.
1350
- :rtype: int
1351
1054
  """
1352
1055
 
1353
1056
  @staticmethod
@@ -1355,9 +1058,7 @@ class Operators:
1355
1058
  """Returns the Stroke at the index in the current set of Strokes.
1356
1059
 
1357
1060
  :param i: index (0 <= i < Operators.get_strokes_size()).
1358
- :type i: int
1359
1061
  :return: The Stroke object.
1360
- :rtype: Stroke
1361
1062
  """
1362
1063
 
1363
1064
  @staticmethod
@@ -1365,7 +1066,6 @@ class Operators:
1365
1066
  """Returns the number of Strokes.
1366
1067
 
1367
1068
  :return: The number of Strokes.
1368
- :rtype: int
1369
1069
  """
1370
1070
 
1371
1071
  @staticmethod
@@ -1373,7 +1073,6 @@ class Operators:
1373
1073
  """Returns the number of ViewEdges.
1374
1074
 
1375
1075
  :return: The number of ViewEdges.
1376
- :rtype: int
1377
1076
  """
1378
1077
 
1379
1078
  @staticmethod
@@ -1381,9 +1080,7 @@ class Operators:
1381
1080
  """Returns the ViewEdge at the index in the current set of ViewEdges.
1382
1081
 
1383
1082
  :param i: index (0 <= i < Operators.get_view_edges_size()).
1384
- :type i: int
1385
1083
  :return: The ViewEdge object.
1386
- :rtype: ViewEdge
1387
1084
  """
1388
1085
 
1389
1086
  @staticmethod
@@ -1401,17 +1098,14 @@ class Operators:
1401
1098
 
1402
1099
  :param func: The Unary Function evaluated at each point of the chain.
1403
1100
  The splitting point is the point minimizing this function.
1404
- :type func: UnaryFunction0DDouble
1405
1101
  :param pred_1d: The Unary Predicate expressing the recursivity stopping
1406
1102
  condition. This predicate is evaluated for each curve before it
1407
1103
  actually gets split. If pred_1d(chain) is true, the curve wont be
1408
1104
  split anymore.
1409
- :type pred_1d: UnaryPredicate1D
1410
1105
  :param sampling: The resolution used to sample the chain for the
1411
1106
  predicates evaluation. (The chain is not actually resampled; a
1412
1107
  virtual point only progresses along the curve using this
1413
1108
  resolution.)
1414
- :type sampling: float
1415
1109
  """
1416
1110
 
1417
1111
  @staticmethod
@@ -1432,23 +1126,19 @@ class Operators:
1432
1126
 
1433
1127
  :param func: The Unary Function evaluated at each point of the chain.
1434
1128
  The splitting point is the point minimizing this function.
1435
- :type func: UnaryFunction0DDouble
1436
1129
  :param pred_0d: The Unary Predicate 0D used to select the candidate
1437
1130
  points where the split can occur. For example, it is very likely
1438
1131
  that would rather have your chain splitting around its middle
1439
1132
  point than around one of its extremities. A 0D predicate working
1440
1133
  on the curvilinear abscissa allows to add this kind of constraints.
1441
- :type pred_0d: UnaryPredicate0D
1442
1134
  :param pred_1d: The Unary Predicate expressing the recursivity stopping
1443
1135
  condition. This predicate is evaluated for each curve before it
1444
1136
  actually gets split. If pred_1d(chain) is true, the curve wont be
1445
1137
  split anymore.
1446
- :type pred_1d: UnaryPredicate1D
1447
1138
  :param sampling: The resolution used to sample the chain for the
1448
1139
  predicates evaluation. (The chain is not actually resampled; a
1449
1140
  virtual point only progresses along the curve using this
1450
1141
  resolution.)
1451
- :type sampling: float
1452
1142
  """
1453
1143
 
1454
1144
  @staticmethod
@@ -1457,7 +1147,6 @@ class Operators:
1457
1147
  stroke creation are accumulated if delete_strokes is set to False.
1458
1148
 
1459
1149
  :param delete_strokes: Delete the strokes that are currently stored.
1460
- :type delete_strokes: bool
1461
1150
  """
1462
1151
 
1463
1152
  @staticmethod
@@ -1466,7 +1155,6 @@ class Operators:
1466
1155
  condition.
1467
1156
 
1468
1157
  :param pred: The predicate expressing this condition.
1469
- :type pred: UnaryPredicate1D
1470
1158
  """
1471
1159
 
1472
1160
  @staticmethod
@@ -1483,15 +1171,12 @@ class Operators:
1483
1171
 
1484
1172
  :param starting_pred: The predicate on a point that expresses the
1485
1173
  starting condition. Each time this condition is verified, a new chain begins
1486
- :type starting_pred: UnaryPredicate0D
1487
1174
  :param stopping_pred: The predicate on a point that expresses the
1488
1175
  stopping condition. The chain ends as soon as this predicate is verified.
1489
- :type stopping_pred: UnaryPredicate0D
1490
1176
  :param sampling: The resolution used to sample the chain for the
1491
1177
  predicates evaluation. (The chain is not actually resampled;
1492
1178
  a virtual point only progresses along the curve using this
1493
1179
  resolution.)
1494
- :type sampling: float
1495
1180
  """
1496
1181
 
1497
1182
  @staticmethod
@@ -1505,12 +1190,10 @@ class Operators:
1505
1190
  :param pred: The predicate on a point that expresses the splitting condition.
1506
1191
  Each time the condition is verified, the chain is split into two chains.
1507
1192
  The resulting set of chains is a partition of the initial chain
1508
- :type pred: UnaryPredicate0D
1509
1193
  :param sampling: The resolution used to sample the chain for the
1510
1194
  predicates evaluation. (The chain is not actually resampled;
1511
1195
  a virtual point only progresses along the curve using this
1512
1196
  resolution.)
1513
- :type sampling: float
1514
1197
  """
1515
1198
 
1516
1199
  @staticmethod
@@ -1519,7 +1202,6 @@ class Operators:
1519
1202
  comparison predicate given as argument.
1520
1203
 
1521
1204
  :param pred: The binary predicate used for the comparison.
1522
- :type pred: BinaryPredicate1D
1523
1205
  """
1524
1206
 
1525
1207
  class SShape:
@@ -1528,34 +1210,19 @@ class SShape:
1528
1210
  """
1529
1211
 
1530
1212
  bbox: BBox
1531
- """ The bounding box of the SShape.
1532
-
1533
- :type: BBox
1534
- """
1213
+ """ The bounding box of the SShape."""
1535
1214
 
1536
1215
  edges: list[FEdge]
1537
- """ The list of edges constituting this SShape.
1538
-
1539
- :type: list[FEdge]
1540
- """
1216
+ """ The list of edges constituting this SShape."""
1541
1217
 
1542
1218
  id: Id
1543
- """ The Id of this SShape.
1544
-
1545
- :type: Id
1546
- """
1219
+ """ The Id of this SShape."""
1547
1220
 
1548
1221
  name: str
1549
- """ The name of the SShape.
1550
-
1551
- :type: str
1552
- """
1222
+ """ The name of the SShape."""
1553
1223
 
1554
1224
  vertices: list[SVertex]
1555
- """ The list of vertices constituting this SShape.
1556
-
1557
- :type: list[SVertex]
1558
- """
1225
+ """ The list of vertices constituting this SShape."""
1559
1226
 
1560
1227
  def __init__(self) -> None:
1561
1228
  """Creates a `SShape` class using either a default constructor or copy constructor."""
@@ -1564,14 +1231,12 @@ class SShape:
1564
1231
  """Creates a `SShape` class using either a default constructor or copy constructor.
1565
1232
 
1566
1233
  :param brother: An SShape object.
1567
- :type brother: typing_extensions.Self
1568
1234
  """
1569
1235
 
1570
1236
  def add_edge(self, edge: FEdge) -> None:
1571
1237
  """Adds an FEdge to the list of FEdges.
1572
1238
 
1573
1239
  :param edge: An FEdge object.
1574
- :type edge: FEdge
1575
1240
  """
1576
1241
 
1577
1242
  def add_vertex(self, vertex: SVertex) -> None:
@@ -1579,7 +1244,6 @@ class SShape:
1579
1244
  attribute of the SVertex is also set to this SShape.
1580
1245
 
1581
1246
  :param vertex: An SVertex object.
1582
- :type vertex: SVertex
1583
1247
  """
1584
1248
 
1585
1249
  def compute_bbox(self) -> None:
@@ -1597,49 +1261,28 @@ three-dimensional vectors representing the first and second principal
1597
1261
  directions, i.e. the directions of the normal plane where the
1598
1262
  curvature takes its maximum and minimum values, respectively; and Kr,
1599
1263
  er and dKr are the radial curvature, radial direction, and the
1600
- derivative of the radial curvature at this SVertex, respectively.
1601
-
1602
- :type: tuple
1603
- """
1264
+ derivative of the radial curvature at this SVertex, respectively."""
1604
1265
 
1605
1266
  id: Id
1606
- """ The Id of this SVertex.
1607
-
1608
- :type: Id
1609
- """
1267
+ """ The Id of this SVertex."""
1610
1268
 
1611
1269
  normals: list[mathutils.Vector]
1612
1270
  """ The normals for this Vertex as a list. In a sharp surface, an SVertex
1613
1271
  has exactly one normal. In a smooth surface, an SVertex can have any
1614
- number of normals.
1615
-
1616
- :type: list[mathutils.Vector]
1617
- """
1272
+ number of normals."""
1618
1273
 
1619
1274
  normals_size: int
1620
- """ The number of different normals for this SVertex.
1621
-
1622
- :type: int
1623
- """
1275
+ """ The number of different normals for this SVertex."""
1624
1276
 
1625
1277
  point_2d: mathutils.Vector
1626
- """ The projected 3D coordinates of the SVertex.
1627
-
1628
- :type: mathutils.Vector
1629
- """
1278
+ """ The projected 3D coordinates of the SVertex."""
1630
1279
 
1631
1280
  point_3d: mathutils.Vector
1632
- """ The 3D coordinates of the SVertex.
1633
-
1634
- :type: mathutils.Vector
1635
- """
1281
+ """ The 3D coordinates of the SVertex."""
1636
1282
 
1637
1283
  viewvertex: ViewVertex
1638
1284
  """ If this SVertex is also a ViewVertex, this property refers to the
1639
- ViewVertex, and None otherwise.
1640
-
1641
- :type: ViewVertex
1642
- """
1285
+ ViewVertex, and None otherwise."""
1643
1286
 
1644
1287
  def __init__(self) -> None:
1645
1288
  """Builds a `SVertex` using the default constructor,
@@ -1652,7 +1295,6 @@ ViewVertex, and None otherwise.
1652
1295
  copy constructor or the overloaded constructor which builds a `SVertex` from 3D coordinates and an Id.
1653
1296
 
1654
1297
  :param brother: A SVertex object.
1655
- :type brother: typing_extensions.Self
1656
1298
  """
1657
1299
 
1658
1300
  def __init__(
@@ -1662,16 +1304,13 @@ ViewVertex, and None otherwise.
1662
1304
  copy constructor or the overloaded constructor which builds a `SVertex` from 3D coordinates and an Id.
1663
1305
 
1664
1306
  :param point_3d: A three-dimensional vector.
1665
- :type point_3d: collections.abc.Sequence[float] | mathutils.Vector
1666
1307
  :param id: An Id object.
1667
- :type id: Id
1668
1308
  """
1669
1309
 
1670
1310
  def add_fedge(self, fedge: FEdge) -> None:
1671
1311
  """Add an FEdge to the list of edges emanating from this SVertex.
1672
1312
 
1673
1313
  :param fedge: An FEdge.
1674
- :type fedge: FEdge
1675
1314
  """
1676
1315
 
1677
1316
  def add_normal(
@@ -1685,7 +1324,6 @@ ViewVertex, and None otherwise.
1685
1324
  is already in the set, nothing changes.
1686
1325
 
1687
1326
  :param normal: A three-dimensional vector.
1688
- :type normal: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
1689
1327
  """
1690
1328
 
1691
1329
  class SVertexIterator:
@@ -1695,22 +1333,13 @@ class SVertexIterator:
1695
1333
  """
1696
1334
 
1697
1335
  object: SVertex
1698
- """ The SVertex object currently pointed by this iterator.
1699
-
1700
- :type: SVertex
1701
- """
1336
+ """ The SVertex object currently pointed by this iterator."""
1702
1337
 
1703
1338
  t: float
1704
- """ The curvilinear abscissa of the current point.
1705
-
1706
- :type: float
1707
- """
1339
+ """ The curvilinear abscissa of the current point."""
1708
1340
 
1709
1341
  u: float
1710
- """ The point parameter at the current point in the 1D element (0 <= u <= 1).
1711
-
1712
- :type: float
1713
- """
1342
+ """ The point parameter at the current point in the 1D element (0 <= u <= 1)."""
1714
1343
 
1715
1344
  def __init__(self) -> None:
1716
1345
  """Build an SVertexIterator using either the default constructor, copy constructor,or the overloaded constructor that starts iteration from an SVertex object vertex."""
@@ -1719,7 +1348,6 @@ class SVertexIterator:
1719
1348
  """Build an SVertexIterator using either the default constructor, copy constructor,or the overloaded constructor that starts iteration from an SVertex object vertex.
1720
1349
 
1721
1350
  :param brother: An SVertexIterator object.
1722
- :type brother: typing_extensions.Self
1723
1351
  """
1724
1352
 
1725
1353
  def __init__(
@@ -1733,15 +1361,10 @@ class SVertexIterator:
1733
1361
  """Build an SVertexIterator using either the default constructor, copy constructor,or the overloaded constructor that starts iteration from an SVertex object vertex.
1734
1362
 
1735
1363
  :param vertex: The SVertex from which the iterator starts iteration.
1736
- :type vertex: SVertex
1737
1364
  :param begin: The first SVertex of a ViewEdge.
1738
- :type begin: SVertex
1739
1365
  :param previous_edge: The previous FEdge coming to vertex.
1740
- :type previous_edge: FEdge
1741
1366
  :param next_edge: The next FEdge going out from vertex.
1742
- :type next_edge: FEdge
1743
1367
  :param t: The curvilinear abscissa at vertex.
1744
- :type t: float
1745
1368
  """
1746
1369
 
1747
1370
  class Stroke:
@@ -1752,34 +1375,19 @@ class Stroke:
1752
1375
  """
1753
1376
 
1754
1377
  id: Id
1755
- """ The Id of this Stroke.
1756
-
1757
- :type: Id
1758
- """
1378
+ """ The Id of this Stroke."""
1759
1379
 
1760
1380
  length_2d: float
1761
- """ The 2D length of the Stroke.
1762
-
1763
- :type: float
1764
- """
1381
+ """ The 2D length of the Stroke."""
1765
1382
 
1766
1383
  medium_type: MediumType
1767
- """ The MediumType used for this Stroke.
1768
-
1769
- :type: MediumType
1770
- """
1384
+ """ The MediumType used for this Stroke."""
1771
1385
 
1772
1386
  texture_id: int
1773
- """ The ID of the texture used to simulate th marks system for this Stroke.
1774
-
1775
- :type: int
1776
- """
1387
+ """ The ID of the texture used to simulate th marks system for this Stroke."""
1777
1388
 
1778
1389
  tips: bool
1779
- """ True if this Stroke uses a texture with tips, and false otherwise.
1780
-
1781
- :type: bool
1782
- """
1390
+ """ True if this Stroke uses a texture with tips, and false otherwise."""
1783
1391
 
1784
1392
  def Stroke(self) -> None:
1785
1393
  """Creates a `Stroke` using the default constructor or copy constructor"""
@@ -1798,10 +1406,8 @@ class Stroke:
1798
1406
 
1799
1407
  :param n: The number of stroke vertices we eventually want
1800
1408
  in our Stroke.
1801
- :type n: int
1802
1409
  :return: The sampling that must be used in the Resample(float)
1803
1410
  method.
1804
- :rtype: float
1805
1411
  """
1806
1412
 
1807
1413
  def insert_vertex(self, vertex: StrokeVertex, next: StrokeVertexIterator) -> None:
@@ -1810,10 +1416,8 @@ class Stroke:
1810
1416
  updated consequently.
1811
1417
 
1812
1418
  :param vertex: The StrokeVertex to insert in the Stroke.
1813
- :type vertex: StrokeVertex
1814
1419
  :param next: A StrokeVertexIterator pointing to the StrokeVertex
1815
1420
  before which vertex must be inserted.
1816
- :type next: StrokeVertexIterator
1817
1421
  """
1818
1422
 
1819
1423
  def remove_all_vertices(self) -> None:
@@ -1824,7 +1428,6 @@ class Stroke:
1824
1428
  and curvilinear abscissa are updated consequently.
1825
1429
 
1826
1430
  :param vertex: the StrokeVertex to remove from the Stroke.
1827
- :type vertex: StrokeVertex
1828
1431
  """
1829
1432
 
1830
1433
  def resample(self, n: int) -> None:
@@ -1835,7 +1438,6 @@ class Stroke:
1835
1438
  it is going to add N-vertices_size, where vertices_size is the
1836
1439
  number of points we already have. If vertices_size >= N, no
1837
1440
  resampling is done.
1838
- :type n: int
1839
1441
  """
1840
1442
 
1841
1443
  def resample(self, sampling: float) -> None:
@@ -1844,7 +1446,6 @@ class Stroke:
1844
1446
 
1845
1447
  :param sampling: Resamples the stroke with a given sampling value. If the
1846
1448
  sampling is smaller than the actual sampling value, no resampling is done.
1847
- :type sampling: float
1848
1449
  """
1849
1450
 
1850
1451
  def stroke_vertices_begin(self, t: float = 0.0) -> StrokeVertexIterator:
@@ -1854,9 +1455,7 @@ class Stroke:
1854
1455
 
1855
1456
  :param t: The resampling value with which we want our Stroke to be
1856
1457
  resampled. If 0 is specified, no resampling is done.
1857
- :type t: float
1858
1458
  :return: A StrokeVertexIterator pointing on the first StrokeVertex.
1859
- :rtype: StrokeVertexIterator
1860
1459
  """
1861
1460
 
1862
1461
  def stroke_vertices_end(self) -> StrokeVertexIterator:
@@ -1864,14 +1463,12 @@ class Stroke:
1864
1463
  of the Stroke.
1865
1464
 
1866
1465
  :return: A StrokeVertexIterator pointing after the last StrokeVertex.
1867
- :rtype: StrokeVertexIterator
1868
1466
  """
1869
1467
 
1870
1468
  def stroke_vertices_size(self) -> int:
1871
1469
  """Returns the number of StrokeVertex constituting the Stroke.
1872
1470
 
1873
1471
  :return: The number of stroke vertices.
1874
- :rtype: int
1875
1472
  """
1876
1473
 
1877
1474
  def update_length(self) -> None:
@@ -1884,30 +1481,18 @@ class StrokeAttribute:
1884
1481
  """
1885
1482
 
1886
1483
  alpha: float
1887
- """ Alpha component of the stroke color.
1888
-
1889
- :type: float
1890
- """
1484
+ """ Alpha component of the stroke color."""
1891
1485
 
1892
1486
  color: mathutils.Color
1893
- """ RGB components of the stroke color.
1894
-
1895
- :type: mathutils.Color
1896
- """
1487
+ """ RGB components of the stroke color."""
1897
1488
 
1898
1489
  thickness: mathutils.Vector
1899
1490
  """ Right and left components of the stroke thickness.
1900
1491
  The right (left) component is the thickness on the right (left) of the vertex
1901
- when following the stroke.
1902
-
1903
- :type: mathutils.Vector
1904
- """
1492
+ when following the stroke."""
1905
1493
 
1906
1494
  visible: bool
1907
- """ The visibility flag. True if the StrokeVertex is visible.
1908
-
1909
- :type: bool
1910
- """
1495
+ """ The visibility flag. True if the StrokeVertex is visible."""
1911
1496
 
1912
1497
  def __init__(self) -> None:
1913
1498
  """Creates a `StrokeAttribute` object using either a default constructor,
@@ -1922,7 +1507,6 @@ when following the stroke.
1922
1507
  to interpolate between two `StrokeAttribute` objects.
1923
1508
 
1924
1509
  :param brother: A StrokeAttribute object to be used as a copy constructor.
1925
- :type brother: typing_extensions.Self
1926
1510
  """
1927
1511
 
1928
1512
  def __init__(
@@ -1939,17 +1523,11 @@ when following the stroke.
1939
1523
  to interpolate between two `StrokeAttribute` objects.
1940
1524
 
1941
1525
  :param red: Red component of a stroke color.
1942
- :type red: float
1943
1526
  :param green: Green component of a stroke color.
1944
- :type green: float
1945
1527
  :param blue: Blue component of a stroke color.
1946
- :type blue: float
1947
1528
  :param alpha: Alpha component of a stroke color.
1948
- :type alpha: float
1949
1529
  :param thickness_right: Stroke thickness on the right.
1950
- :type thickness_right: float
1951
1530
  :param thickness_left: Stroke thickness on the left.
1952
- :type thickness_left: float
1953
1531
  """
1954
1532
 
1955
1533
  def __init__(
@@ -1963,47 +1541,36 @@ when following the stroke.
1963
1541
  to interpolate between two `StrokeAttribute` objects.
1964
1542
 
1965
1543
  :param attribute1: The first StrokeAttribute object.
1966
- :type attribute1: typing_extensions.Self
1967
1544
  :param attribute2: The second StrokeAttribute object.
1968
- :type attribute2: typing_extensions.Self
1969
1545
  :param t: The interpolation parameter (0 <= t <= 1).
1970
- :type t: float
1971
1546
  """
1972
1547
 
1973
1548
  def get_attribute_real(self, name: str) -> float:
1974
1549
  """Returns an attribute of float type.
1975
1550
 
1976
1551
  :param name: The name of the attribute.
1977
- :type name: str
1978
1552
  :return: The attribute value.
1979
- :rtype: float
1980
1553
  """
1981
1554
 
1982
1555
  def get_attribute_vec2(self, name: str) -> mathutils.Vector:
1983
1556
  """Returns an attribute of two-dimensional vector type.
1984
1557
 
1985
1558
  :param name: The name of the attribute.
1986
- :type name: str
1987
1559
  :return: The attribute value.
1988
- :rtype: mathutils.Vector
1989
1560
  """
1990
1561
 
1991
1562
  def get_attribute_vec3(self, name: str) -> mathutils.Vector:
1992
1563
  """Returns an attribute of three-dimensional vector type.
1993
1564
 
1994
1565
  :param name: The name of the attribute.
1995
- :type name: str
1996
1566
  :return: The attribute value.
1997
- :rtype: mathutils.Vector
1998
1567
  """
1999
1568
 
2000
1569
  def has_attribute_real(self, name: str) -> bool:
2001
1570
  """Checks whether the attribute name of float type is available.
2002
1571
 
2003
1572
  :param name: The name of the attribute.
2004
- :type name: str
2005
1573
  :return: True if the attribute is available.
2006
- :rtype: bool
2007
1574
  """
2008
1575
 
2009
1576
  def has_attribute_vec2(self, name: str) -> bool:
@@ -2011,9 +1578,7 @@ when following the stroke.
2011
1578
  is available.
2012
1579
 
2013
1580
  :param name: The name of the attribute.
2014
- :type name: str
2015
1581
  :return: True if the attribute is available.
2016
- :rtype: bool
2017
1582
  """
2018
1583
 
2019
1584
  def has_attribute_vec3(self, name: str) -> bool:
@@ -2021,9 +1586,7 @@ when following the stroke.
2021
1586
  type is available.
2022
1587
 
2023
1588
  :param name: The name of the attribute.
2024
- :type name: str
2025
1589
  :return: True if the attribute is available.
2026
- :rtype: bool
2027
1590
  """
2028
1591
 
2029
1592
  def set_attribute_real(self, name: str, value: float) -> None:
@@ -2032,9 +1595,7 @@ when following the stroke.
2032
1595
  replaces the old one.
2033
1596
 
2034
1597
  :param name: The name of the attribute.
2035
- :type name: str
2036
1598
  :param value: The attribute value.
2037
- :type value: float
2038
1599
  """
2039
1600
 
2040
1601
  def set_attribute_vec2(
@@ -2050,9 +1611,7 @@ when following the stroke.
2050
1611
  the new value replaces the old one.
2051
1612
 
2052
1613
  :param name: The name of the attribute.
2053
- :type name: str
2054
1614
  :param value: The attribute value.
2055
- :type value: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
2056
1615
  """
2057
1616
 
2058
1617
  def set_attribute_vec3(
@@ -2068,9 +1627,7 @@ when following the stroke.
2068
1627
  Otherwise, the new value replaces the old one.
2069
1628
 
2070
1629
  :param name: The name of the attribute.
2071
- :type name: str
2072
1630
  :param value: The attribute value as a 3D vector.
2073
- :type value: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
2074
1631
  """
2075
1632
 
2076
1633
  class StrokeShader:
@@ -2084,10 +1641,7 @@ class StrokeShader:
2084
1641
  """
2085
1642
 
2086
1643
  name: str
2087
- """ The name of the stroke shader.
2088
-
2089
- :type: str
2090
- """
1644
+ """ The name of the stroke shader."""
2091
1645
 
2092
1646
  def __init__(self) -> None:
2093
1647
  """Default constructor."""
@@ -2096,42 +1650,26 @@ class StrokeShader:
2096
1650
  """The shading method. Must be overloaded by inherited classes.
2097
1651
 
2098
1652
  :param stroke: A Stroke object.
2099
- :type stroke: Stroke
2100
1653
  """
2101
1654
 
2102
1655
  class StrokeVertex:
2103
1656
  """Class hierarchy: `Interface0D` > `CurvePoint` > `StrokeVertex`Class to define a stroke vertex."""
2104
1657
 
2105
1658
  attribute: StrokeAttribute
2106
- """ StrokeAttribute for this StrokeVertex.
2107
-
2108
- :type: StrokeAttribute
2109
- """
1659
+ """ StrokeAttribute for this StrokeVertex."""
2110
1660
 
2111
1661
  curvilinear_abscissa: float
2112
- """ Curvilinear abscissa of this StrokeVertex in the Stroke.
2113
-
2114
- :type: float
2115
- """
1662
+ """ Curvilinear abscissa of this StrokeVertex in the Stroke."""
2116
1663
 
2117
1664
  point: mathutils.Vector
2118
- """ 2D point coordinates.
2119
-
2120
- :type: mathutils.Vector
2121
- """
1665
+ """ 2D point coordinates."""
2122
1666
 
2123
1667
  stroke_length: float
2124
1668
  """ Stroke length (it is only a value retained by the StrokeVertex,
2125
- and it wont change the real stroke length).
2126
-
2127
- :type: float
2128
- """
1669
+ and it won't change the real stroke length)."""
2129
1670
 
2130
1671
  u: float
2131
- """ Curvilinear abscissa of this StrokeVertex in the Stroke.
2132
-
2133
- :type: float
2134
- """
1672
+ """ Curvilinear abscissa of this StrokeVertex in the Stroke."""
2135
1673
 
2136
1674
  def __init__(self) -> None:
2137
1675
  """Builds a `StrokeVertex` using the default constructor,
@@ -2146,7 +1684,6 @@ and it wont change the real stroke length).
2146
1684
  from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
2147
1685
 
2148
1686
  :param brother: A StrokeVertex object.
2149
- :type brother: typing_extensions.Self
2150
1687
  """
2151
1688
 
2152
1689
  def __init__(
@@ -2160,11 +1697,8 @@ and it wont change the real stroke length).
2160
1697
  from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
2161
1698
 
2162
1699
  :param first_vertex: The first StrokeVertex.
2163
- :type first_vertex: typing_extensions.Self
2164
1700
  :param second_vertex: The second StrokeVertex.
2165
- :type second_vertex: typing_extensions.Self
2166
1701
  :param t3d: An interpolation parameter.
2167
- :type t3d: float
2168
1702
  """
2169
1703
 
2170
1704
  def __init__(self, point: CurvePoint) -> None:
@@ -2173,7 +1707,6 @@ and it wont change the real stroke length).
2173
1707
  from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
2174
1708
 
2175
1709
  :param point: A CurvePoint object.
2176
- :type point: CurvePoint
2177
1710
  """
2178
1711
 
2179
1712
  def __init__(self, svertex: SVertex) -> None:
@@ -2182,7 +1715,6 @@ and it wont change the real stroke length).
2182
1715
  from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
2183
1716
 
2184
1717
  :param svertex: An SVertex object.An SVertex object.
2185
- :type svertex: SVertex
2186
1718
  """
2187
1719
 
2188
1720
  def __init__(self, svertex: SVertex, attribute: StrokeAttribute) -> None:
@@ -2191,9 +1723,7 @@ and it wont change the real stroke length).
2191
1723
  from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
2192
1724
 
2193
1725
  :param svertex: An SVertex object.An SVertex object.
2194
- :type svertex: SVertex
2195
1726
  :param attribute: A StrokeAttribute object.
2196
- :type attribute: StrokeAttribute
2197
1727
  """
2198
1728
 
2199
1729
  class StrokeVertexIterator:
@@ -2212,28 +1742,16 @@ class StrokeVertexIterator:
2212
1742
 
2213
1743
  at_last: bool
2214
1744
  """ True if the iterator points to the last valid element.
2215
- For its counterpart (pointing to the first valid element), use it.is_begin.
2216
-
2217
- :type: bool
2218
- """
1745
+ For its counterpart (pointing to the first valid element), use it.is_begin."""
2219
1746
 
2220
1747
  object: StrokeVertex
2221
- """ The StrokeVertex object currently pointed to by this iterator.
2222
-
2223
- :type: StrokeVertex
2224
- """
1748
+ """ The StrokeVertex object currently pointed to by this iterator."""
2225
1749
 
2226
1750
  t: float
2227
- """ The curvilinear abscissa of the current point.
2228
-
2229
- :type: float
2230
- """
1751
+ """ The curvilinear abscissa of the current point."""
2231
1752
 
2232
1753
  u: float
2233
- """ The point parameter at the current point in the stroke (0 <= u <= 1).
2234
-
2235
- :type: float
2236
- """
1754
+ """ The point parameter at the current point in the stroke (0 <= u <= 1)."""
2237
1755
 
2238
1756
  def __init__(self) -> None:
2239
1757
  """Creates a `StrokeVertexIterator` using either the
@@ -2246,21 +1764,18 @@ For its counterpart (pointing to the first valid element), use it.is_begin.
2246
1764
  default constructor or the copy constructor.
2247
1765
 
2248
1766
  :param brother: A StrokeVertexIterator object.
2249
- :type brother: typing_extensions.Self
2250
1767
  """
2251
1768
 
2252
1769
  def decremented(self) -> typing_extensions.Self:
2253
1770
  """Returns a copy of a decremented StrokeVertexIterator.
2254
1771
 
2255
1772
  :return: A StrokeVertexIterator pointing the previous StrokeVertex.
2256
- :rtype: typing_extensions.Self
2257
1773
  """
2258
1774
 
2259
1775
  def incremented(self) -> typing_extensions.Self:
2260
1776
  """Returns a copy of an incremented StrokeVertexIterator.
2261
1777
 
2262
1778
  :return: A StrokeVertexIterator pointing the next StrokeVertex.
2263
- :rtype: typing_extensions.Self
2264
1779
  """
2265
1780
 
2266
1781
  def reversed(self) -> typing_extensions.Self:
@@ -2268,7 +1783,6 @@ For its counterpart (pointing to the first valid element), use it.is_begin.
2268
1783
  reversed order.
2269
1784
 
2270
1785
  :return: A StrokeVertexIterator traversing stroke vertices backward.
2271
- :rtype: typing_extensions.Self
2272
1786
  """
2273
1787
 
2274
1788
  class TVertex:
@@ -2280,22 +1794,13 @@ class TVertex:
2280
1794
  """
2281
1795
 
2282
1796
  back_svertex: SVertex
2283
- """ The SVertex that is further away from the viewpoint.
2284
-
2285
- :type: SVertex
2286
- """
1797
+ """ The SVertex that is further away from the viewpoint."""
2287
1798
 
2288
1799
  front_svertex: SVertex
2289
- """ The SVertex that is closer to the viewpoint.
2290
-
2291
- :type: SVertex
2292
- """
1800
+ """ The SVertex that is closer to the viewpoint."""
2293
1801
 
2294
1802
  id: Id
2295
- """ The Id of this TVertex.
2296
-
2297
- :type: Id
2298
- """
1803
+ """ The Id of this TVertex."""
2299
1804
 
2300
1805
  def __init__(self) -> None:
2301
1806
  """Default constructor."""
@@ -2306,18 +1811,14 @@ class TVertex:
2306
1811
  frontEdgeB, frontEdgeA is returned. Same for back edges.
2307
1812
 
2308
1813
  :param viewedge: A ViewEdge object.
2309
- :type viewedge: ViewEdge
2310
1814
  :return: The mate edge of the given ViewEdge.
2311
- :rtype: ViewEdge
2312
1815
  """
2313
1816
 
2314
1817
  def get_svertex(self, fedge: FEdge) -> SVertex:
2315
1818
  """Returns the SVertex (among the 2) belonging to the given FEdge.
2316
1819
 
2317
1820
  :param fedge: An FEdge object.
2318
- :type fedge: FEdge
2319
1821
  :return: The SVertex belonging to the given FEdge.
2320
- :rtype: SVertex
2321
1822
  """
2322
1823
 
2323
1824
  class UnaryFunction0D:
@@ -2331,10 +1832,7 @@ class UnaryFunction0D:
2331
1832
  """
2332
1833
 
2333
1834
  name: str
2334
- """ The name of the unary 0D function.
2335
-
2336
- :type: str
2337
- """
1835
+ """ The name of the unary 0D function."""
2338
1836
 
2339
1837
  class UnaryFunction0DDouble:
2340
1838
  """Class hierarchy: `UnaryFunction0D` > `UnaryFunction0DDouble`Base class for unary functions (functors) that work on
@@ -2428,10 +1926,7 @@ class UnaryFunction1D:
2428
1926
  """
2429
1927
 
2430
1928
  name: str
2431
- """ The name of the unary 1D function.
2432
-
2433
- :type: str
2434
- """
1929
+ """ The name of the unary 1D function."""
2435
1930
 
2436
1931
  class UnaryFunction1DDouble:
2437
1932
  """Class hierarchy: `UnaryFunction1D` > `UnaryFunction1DDouble`Base class for unary functions (functors) that work on
@@ -2439,10 +1934,7 @@ class UnaryFunction1DDouble:
2439
1934
  """
2440
1935
 
2441
1936
  integration_type: IntegrationType
2442
- """ The integration method.
2443
-
2444
- :type: IntegrationType
2445
- """
1937
+ """ The integration method."""
2446
1938
 
2447
1939
  def __init__(self) -> None:
2448
1940
  """Builds a unary 1D function using the default constructor
@@ -2455,7 +1947,6 @@ class UnaryFunction1DDouble:
2455
1947
  or the integration method given as an argument.
2456
1948
 
2457
1949
  :param integration_type: An integration method.
2458
- :type integration_type: IntegrationType
2459
1950
  """
2460
1951
 
2461
1952
  class UnaryFunction1DEdgeNature:
@@ -2464,10 +1955,7 @@ class UnaryFunction1DEdgeNature:
2464
1955
  """
2465
1956
 
2466
1957
  integration_type: IntegrationType
2467
- """ The integration method.
2468
-
2469
- :type: IntegrationType
2470
- """
1958
+ """ The integration method."""
2471
1959
 
2472
1960
  def __init__(self) -> None:
2473
1961
  """Builds a unary 1D function using the default constructor
@@ -2480,7 +1968,6 @@ class UnaryFunction1DEdgeNature:
2480
1968
  or the integration method given as an argument.
2481
1969
 
2482
1970
  :param integration_type: An integration method.
2483
- :type integration_type: IntegrationType
2484
1971
  """
2485
1972
 
2486
1973
  class UnaryFunction1DFloat:
@@ -2489,10 +1976,7 @@ class UnaryFunction1DFloat:
2489
1976
  """
2490
1977
 
2491
1978
  integration_type: IntegrationType
2492
- """ The integration method.
2493
-
2494
- :type: IntegrationType
2495
- """
1979
+ """ The integration method."""
2496
1980
 
2497
1981
  def __init__(self) -> None:
2498
1982
  """Builds a unary 1D function using the default constructor
@@ -2505,7 +1989,6 @@ class UnaryFunction1DFloat:
2505
1989
  or the integration method given as an argument.
2506
1990
 
2507
1991
  :param integration_type: An integration method.
2508
- :type integration_type: IntegrationType
2509
1992
  """
2510
1993
 
2511
1994
  class UnaryFunction1DUnsigned:
@@ -2514,10 +1997,7 @@ class UnaryFunction1DUnsigned:
2514
1997
  """
2515
1998
 
2516
1999
  integration_type: IntegrationType
2517
- """ The integration method.
2518
-
2519
- :type: IntegrationType
2520
- """
2000
+ """ The integration method."""
2521
2001
 
2522
2002
  def __init__(self) -> None:
2523
2003
  """Builds a unary 1D function using the default constructor
@@ -2530,7 +2010,6 @@ class UnaryFunction1DUnsigned:
2530
2010
  or the integration method given as an argument.
2531
2011
 
2532
2012
  :param integration_type: An integration method.
2533
- :type integration_type: IntegrationType
2534
2013
  """
2535
2014
 
2536
2015
  class UnaryFunction1DVec2f:
@@ -2539,10 +2018,7 @@ class UnaryFunction1DVec2f:
2539
2018
  """
2540
2019
 
2541
2020
  integration_type: IntegrationType
2542
- """ The integration method.
2543
-
2544
- :type: IntegrationType
2545
- """
2021
+ """ The integration method."""
2546
2022
 
2547
2023
  def __init__(self) -> None:
2548
2024
  """Builds a unary 1D function using the default constructor
@@ -2555,7 +2031,6 @@ class UnaryFunction1DVec2f:
2555
2031
  or the integration method given as an argument.
2556
2032
 
2557
2033
  :param integration_type: An integration method.
2558
- :type integration_type: IntegrationType
2559
2034
  """
2560
2035
 
2561
2036
  class UnaryFunction1DVec3f:
@@ -2564,10 +2039,7 @@ class UnaryFunction1DVec3f:
2564
2039
  """
2565
2040
 
2566
2041
  integration_type: IntegrationType
2567
- """ The integration method.
2568
-
2569
- :type: IntegrationType
2570
- """
2042
+ """ The integration method."""
2571
2043
 
2572
2044
  def __init__(self) -> None:
2573
2045
  """Builds a unary 1D function using the default constructor
@@ -2580,7 +2052,6 @@ class UnaryFunction1DVec3f:
2580
2052
  or the integration method given as an argument.
2581
2053
 
2582
2054
  :param integration_type: An integration method.
2583
- :type integration_type: IntegrationType
2584
2055
  """
2585
2056
 
2586
2057
  class UnaryFunction1DVectorViewShape:
@@ -2590,10 +2061,7 @@ class UnaryFunction1DVectorViewShape:
2590
2061
  """
2591
2062
 
2592
2063
  integration_type: IntegrationType
2593
- """ The integration method.
2594
-
2595
- :type: IntegrationType
2596
- """
2064
+ """ The integration method."""
2597
2065
 
2598
2066
  def __init__(self) -> None:
2599
2067
  """Builds a unary 1D function using the default constructor
@@ -2606,7 +2074,6 @@ class UnaryFunction1DVectorViewShape:
2606
2074
  or the integration method given as an argument.
2607
2075
 
2608
2076
  :param integration_type: An integration method.
2609
- :type integration_type: IntegrationType
2610
2077
  """
2611
2078
 
2612
2079
  class UnaryFunction1DVoid:
@@ -2615,10 +2082,7 @@ class UnaryFunction1DVoid:
2615
2082
  """
2616
2083
 
2617
2084
  integration_type: IntegrationType
2618
- """ The integration method.
2619
-
2620
- :type: IntegrationType
2621
- """
2085
+ """ The integration method."""
2622
2086
 
2623
2087
  def __init__(self) -> None:
2624
2088
  """Builds a unary 1D function using either a default constructor
@@ -2631,7 +2095,6 @@ class UnaryFunction1DVoid:
2631
2095
  or the integration method given as an argument.
2632
2096
 
2633
2097
  :param integration_type: An integration method.
2634
- :type integration_type: IntegrationType
2635
2098
  """
2636
2099
 
2637
2100
  class UnaryPredicate0D:
@@ -2644,10 +2107,7 @@ class UnaryPredicate0D:
2644
2107
  """
2645
2108
 
2646
2109
  name: str
2647
- """ The name of the unary 0D predicate.
2648
-
2649
- :type: str
2650
- """
2110
+ """ The name of the unary 0D predicate."""
2651
2111
 
2652
2112
  def __init__(self) -> None:
2653
2113
  """Default constructor."""
@@ -2657,9 +2117,7 @@ class UnaryPredicate0D:
2657
2117
 
2658
2118
  :param it: The Interface0DIterator pointing onto the Interface0D at
2659
2119
  which we wish to evaluate the predicate.
2660
- :type it: Interface0DIterator
2661
2120
  :return: True if the condition is satisfied, false otherwise.
2662
- :rtype: bool
2663
2121
  """
2664
2122
 
2665
2123
  class UnaryPredicate1D:
@@ -2672,10 +2130,7 @@ class UnaryPredicate1D:
2672
2130
  """
2673
2131
 
2674
2132
  name: str
2675
- """ The name of the unary 1D predicate.
2676
-
2677
- :type: str
2678
- """
2133
+ """ The name of the unary 1D predicate."""
2679
2134
 
2680
2135
  def __init__(self) -> None:
2681
2136
  """Default constructor."""
@@ -2684,9 +2139,7 @@ class UnaryPredicate1D:
2684
2139
  """Must be overload by inherited classes.
2685
2140
 
2686
2141
  :param inter: The Interface1D on which we wish to evaluate the predicate.
2687
- :type inter: Interface1D
2688
2142
  :return: True if the condition is satisfied, false otherwise.
2689
- :rtype: bool
2690
2143
  """
2691
2144
 
2692
2145
  class ViewEdge:
@@ -2696,71 +2149,38 @@ class ViewEdge:
2696
2149
  """
2697
2150
 
2698
2151
  chaining_time_stamp: int
2699
- """ The time stamp of this ViewEdge.
2700
-
2701
- :type: int
2702
- """
2152
+ """ The time stamp of this ViewEdge."""
2703
2153
 
2704
2154
  first_fedge: FEdge
2705
- """ The first FEdge that constitutes this ViewEdge.
2706
-
2707
- :type: FEdge
2708
- """
2155
+ """ The first FEdge that constitutes this ViewEdge."""
2709
2156
 
2710
2157
  first_viewvertex: ViewVertex
2711
- """ The first ViewVertex.
2712
-
2713
- :type: ViewVertex
2714
- """
2158
+ """ The first ViewVertex."""
2715
2159
 
2716
2160
  id: Id
2717
- """ The Id of this ViewEdge.
2718
-
2719
- :type: Id
2720
- """
2161
+ """ The Id of this ViewEdge."""
2721
2162
 
2722
2163
  is_closed: bool
2723
- """ True if this ViewEdge forms a closed loop.
2724
-
2725
- :type: bool
2726
- """
2164
+ """ True if this ViewEdge forms a closed loop."""
2727
2165
 
2728
2166
  last_fedge: FEdge
2729
- """ The last FEdge that constitutes this ViewEdge.
2730
-
2731
- :type: FEdge
2732
- """
2167
+ """ The last FEdge that constitutes this ViewEdge."""
2733
2168
 
2734
2169
  last_viewvertex: ViewVertex
2735
- """ The second ViewVertex.
2736
-
2737
- :type: ViewVertex
2738
- """
2170
+ """ The second ViewVertex."""
2739
2171
 
2740
2172
  nature: Nature
2741
- """ The nature of this ViewEdge.
2742
-
2743
- :type: Nature
2744
- """
2173
+ """ The nature of this ViewEdge."""
2745
2174
 
2746
2175
  occludee: ViewShape
2747
2176
  """ The shape that is occluded by the ViewShape to which this ViewEdge
2748
- belongs to. If no object is occluded, this property is set to None.
2749
-
2750
- :type: ViewShape
2751
- """
2177
+ belongs to. If no object is occluded, this property is set to None."""
2752
2178
 
2753
2179
  qi: int
2754
- """ The quantitative invisibility.
2755
-
2756
- :type: int
2757
- """
2180
+ """ The quantitative invisibility."""
2758
2181
 
2759
2182
  viewshape: ViewShape
2760
- """ The ViewShape to which this ViewEdge belongs to.
2761
-
2762
- :type: ViewShape
2763
- """
2183
+ """ The ViewShape to which this ViewEdge belongs to."""
2764
2184
 
2765
2185
  def __init__(self) -> None:
2766
2186
  """Builds a `ViewEdge` using the default constructor or the copy constructor."""
@@ -2769,7 +2189,6 @@ belongs to. If no object is occluded, this property is set to None.
2769
2189
  """Builds a `ViewEdge` using the default constructor or the copy constructor.
2770
2190
 
2771
2191
  :param brother: A ViewEdge object.
2772
- :type brother: typing_extensions.Self
2773
2192
  """
2774
2193
 
2775
2194
  def update_fedges(self) -> None:
@@ -2783,32 +2202,20 @@ class ViewEdgeIterator:
2783
2202
  """
2784
2203
 
2785
2204
  begin: ViewEdge
2786
- """ The first ViewEdge used for the iteration.
2787
-
2788
- :type: ViewEdge
2789
- """
2205
+ """ The first ViewEdge used for the iteration."""
2790
2206
 
2791
2207
  current_edge: ViewEdge
2792
- """ The ViewEdge object currently pointed by this iterator.
2793
-
2794
- :type: ViewEdge
2795
- """
2208
+ """ The ViewEdge object currently pointed by this iterator."""
2796
2209
 
2797
2210
  object: ViewEdge
2798
- """ The ViewEdge object currently pointed by this iterator.
2799
-
2800
- :type: ViewEdge
2801
- """
2211
+ """ The ViewEdge object currently pointed by this iterator."""
2802
2212
 
2803
2213
  orientation: bool
2804
2214
  """ The orientation of the pointed ViewEdge in the iteration.
2805
2215
  If true, the iterator looks for the next ViewEdge among those ViewEdges
2806
2216
  that surround the ending ViewVertex of the "begin" ViewEdge. If false,
2807
2217
  the iterator searches over the ViewEdges surrounding the ending ViewVertex
2808
- of the "begin" ViewEdge.
2809
-
2810
- :type: bool
2811
- """
2218
+ of the "begin" ViewEdge."""
2812
2219
 
2813
2220
  def __init__(
2814
2221
  self, begin: None | ViewEdge | None = None, orientation: bool = True
@@ -2817,12 +2224,10 @@ of the "begin" ViewEdge.
2817
2224
  orientation or the copy constructor.
2818
2225
 
2819
2226
  :param begin: The ViewEdge from where to start the iteration.
2820
- :type begin: None | ViewEdge | None
2821
2227
  :param orientation: If true, well look for the next ViewEdge among
2822
2228
  the ViewEdges that surround the ending ViewVertex of begin. If
2823
2229
  false, well search over the ViewEdges surrounding the ending
2824
2230
  ViewVertex of begin.
2825
- :type orientation: bool
2826
2231
  """
2827
2232
 
2828
2233
  def __init__(self, brother: typing_extensions.Self) -> None:
@@ -2830,7 +2235,6 @@ of the "begin" ViewEdge.
2830
2235
  orientation or the copy constructor.
2831
2236
 
2832
2237
  :param brother: A ViewEdgeIterator object.
2833
- :type brother: typing_extensions.Self
2834
2238
  """
2835
2239
 
2836
2240
  def change_orientation(self) -> None:
@@ -2840,10 +2244,7 @@ class ViewMap:
2840
2244
  """Class defining the ViewMap."""
2841
2245
 
2842
2246
  scene_bbox: BBox
2843
- """ The 3D bounding box of the scene.
2844
-
2845
- :type: BBox
2846
- """
2247
+ """ The 3D bounding box of the scene."""
2847
2248
 
2848
2249
  def __init__(self) -> None:
2849
2250
  """Default constructor."""
@@ -2852,22 +2253,16 @@ class ViewMap:
2852
2253
  """Gets the FEdge nearest to the 2D point specified as arguments.
2853
2254
 
2854
2255
  :param x: X coordinate of a 2D point.
2855
- :type x: float
2856
2256
  :param y: Y coordinate of a 2D point.
2857
- :type y: float
2858
2257
  :return: The FEdge nearest to the specified 2D point.
2859
- :rtype: FEdge
2860
2258
  """
2861
2259
 
2862
2260
  def get_closest_viewedge(self, x: float, y: float) -> ViewEdge:
2863
2261
  """Gets the ViewEdge nearest to the 2D point specified as arguments.
2864
2262
 
2865
2263
  :param x: X coordinate of a 2D point.
2866
- :type x: float
2867
2264
  :param y: Y coordinate of a 2D point.
2868
- :type y: float
2869
2265
  :return: The ViewEdge nearest to the specified 2D point.
2870
- :rtype: ViewEdge
2871
2266
  """
2872
2267
 
2873
2268
  class ViewShape:
@@ -2876,40 +2271,22 @@ class ViewShape:
2876
2271
  """
2877
2272
 
2878
2273
  edges: list[ViewEdge]
2879
- """ The list of ViewEdge objects contained in this ViewShape.
2880
-
2881
- :type: list[ViewEdge]
2882
- """
2274
+ """ The list of ViewEdge objects contained in this ViewShape."""
2883
2275
 
2884
2276
  id: Id
2885
- """ The Id of this ViewShape.
2886
-
2887
- :type: Id
2888
- """
2277
+ """ The Id of this ViewShape."""
2889
2278
 
2890
2279
  library_path: str | typing.Any
2891
- """ The library path of the ViewShape.
2892
-
2893
- :type: str | typing.Any
2894
- """
2280
+ """ The library path of the ViewShape."""
2895
2281
 
2896
2282
  name: str
2897
- """ The name of the ViewShape.
2898
-
2899
- :type: str
2900
- """
2283
+ """ The name of the ViewShape."""
2901
2284
 
2902
2285
  sshape: SShape
2903
- """ The SShape on top of which this ViewShape is built.
2904
-
2905
- :type: SShape
2906
- """
2286
+ """ The SShape on top of which this ViewShape is built."""
2907
2287
 
2908
2288
  vertices: list[ViewVertex]
2909
- """ The list of ViewVertex objects contained in this ViewShape.
2910
-
2911
- :type: list[ViewVertex]
2912
- """
2289
+ """ The list of ViewVertex objects contained in this ViewShape."""
2913
2290
 
2914
2291
  def __init__(self) -> None:
2915
2292
  """Builds a `ViewShape` using the default constructor,
@@ -2922,7 +2299,6 @@ class ViewShape:
2922
2299
  copy constructor, or from a `SShape`.
2923
2300
 
2924
2301
  :param brother: A ViewShape object.
2925
- :type brother: typing_extensions.Self
2926
2302
  """
2927
2303
 
2928
2304
  def __init__(self, sshape: SShape) -> None:
@@ -2930,21 +2306,18 @@ class ViewShape:
2930
2306
  copy constructor, or from a `SShape`.
2931
2307
 
2932
2308
  :param sshape: An SShape object.
2933
- :type sshape: SShape
2934
2309
  """
2935
2310
 
2936
2311
  def add_edge(self, edge: ViewEdge) -> None:
2937
2312
  """Adds a ViewEdge to the list of ViewEdge objects.
2938
2313
 
2939
2314
  :param edge: A ViewEdge object.
2940
- :type edge: ViewEdge
2941
2315
  """
2942
2316
 
2943
2317
  def add_vertex(self, vertex: ViewVertex) -> None:
2944
2318
  """Adds a ViewVertex to the list of the ViewVertex objects.
2945
2319
 
2946
2320
  :param vertex: A ViewVertex object.
2947
- :type vertex: ViewVertex
2948
2321
  """
2949
2322
 
2950
2323
  class ViewVertex:
@@ -2960,10 +2333,7 @@ class ViewVertex:
2960
2333
  """
2961
2334
 
2962
2335
  nature: Nature
2963
- """ The nature of this ViewVertex.
2964
-
2965
- :type: Nature
2966
- """
2336
+ """ The nature of this ViewVertex."""
2967
2337
 
2968
2338
  def edges_begin(self) -> orientedViewEdgeIterator:
2969
2339
  """Returns an iterator over the ViewEdges that goes to or comes from
@@ -2973,7 +2343,6 @@ class ViewVertex:
2973
2343
  (incoming/outgoing).
2974
2344
 
2975
2345
  :return: An orientedViewEdgeIterator pointing to the first ViewEdge.
2976
- :rtype: orientedViewEdgeIterator
2977
2346
  """
2978
2347
 
2979
2348
  def edges_end(self) -> orientedViewEdgeIterator:
@@ -2981,7 +2350,6 @@ class ViewVertex:
2981
2350
  ViewVertex, pointing after the last ViewEdge.
2982
2351
 
2983
2352
  :return: An orientedViewEdgeIterator pointing after the last ViewEdge.
2984
- :rtype: orientedViewEdgeIterator
2985
2353
  """
2986
2354
 
2987
2355
  def edges_iterator(self, edge: ViewEdge) -> orientedViewEdgeIterator:
@@ -2989,9 +2357,7 @@ class ViewVertex:
2989
2357
  as argument.
2990
2358
 
2991
2359
  :param edge: A ViewEdge object.
2992
- :type edge: ViewEdge
2993
2360
  :return: An orientedViewEdgeIterator pointing to the given ViewEdge.
2994
- :rtype: orientedViewEdgeIterator
2995
2361
  """
2996
2362
 
2997
2363
  class orientedViewEdgeIterator:
@@ -3004,10 +2370,7 @@ class orientedViewEdgeIterator:
3004
2370
  object: tuple[ViewEdge, bool]
3005
2371
  """ The oriented ViewEdge (i.e., a tuple of the pointed ViewEdge and a boolean
3006
2372
  value) currently pointed to by this iterator. If the boolean value is true,
3007
- the ViewEdge is incoming.
3008
-
3009
- :type: tuple[ViewEdge, bool]
3010
- """
2373
+ the ViewEdge is incoming."""
3011
2374
 
3012
2375
  def __init__(self) -> None:
3013
2376
  """Creates an `orientedViewEdgeIterator` using either the
@@ -3020,5 +2383,4 @@ the ViewEdge is incoming.
3020
2383
  default constructor or the copy constructor.
3021
2384
 
3022
2385
  :param iBrother: An orientedViewEdgeIterator object.
3023
- :type iBrother: typing_extensions.Self
3024
2386
  """