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
@@ -12,17 +12,15 @@ def brush_stroke(
12
12
  *,
13
13
  stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
14
14
  | None = None,
15
- mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
15
+ mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
16
+ | None = "NORMAL",
16
17
  pen_flip: bool | None = False,
17
18
  override_location: bool | None = False,
18
19
  ignore_background_click: bool | None = False,
19
20
  ) -> None:
20
21
  """Sculpt a stroke into the geometry
21
22
 
22
- :type execution_context: int | str | None
23
- :type undo: bool | None
24
23
  :param stroke: Stroke
25
- :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
26
24
  :param mode: Stroke Mode, Action taken when a paint stroke is made
27
25
 
28
26
  NORMAL
@@ -36,13 +34,12 @@ def brush_stroke(
36
34
 
37
35
  ERASE
38
36
  Erase -- Switch brush to erase mode for duration of stroke.
39
- :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
37
+
38
+ MASK
39
+ Mask -- Switch brush to mask mode for duration of stroke.
40
40
  :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
41
- :type pen_flip: bool | None
42
41
  :param override_location: Override Location, Override the given "location" array by recalculating object space positions from the provided "mouse_event" positions
43
- :type override_location: bool | None
44
42
  :param ignore_background_click: Ignore Background Click, Clicks on the background do not start the stroke
45
- :type ignore_background_click: bool | None
46
43
  """
47
44
 
48
45
  def cloth_filter(
@@ -67,17 +64,10 @@ def cloth_filter(
67
64
  ) -> None:
68
65
  """Applies a cloth simulation deformation to the entire mesh
69
66
 
70
- :type execution_context: int | str | None
71
- :type undo: bool | None
72
67
  :param start_mouse: Starting Mouse
73
- :type start_mouse: collections.abc.Iterable[int] | None
74
68
  :param area_normal_radius: Normal Radius, Radius used for calculating area normal on initial click,in percentage of brush radius
75
- :type area_normal_radius: float | None
76
69
  :param strength: Strength, Filter strength
77
- :type strength: float | None
78
70
  :param iteration_count: Repeat, How many times to repeat the filter
79
- :type iteration_count: int | None
80
- :type event_history: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
81
71
  :param type: Filter Type, Operation that is going to be applied to the mesh
82
72
 
83
73
  GRAVITY
@@ -94,7 +84,6 @@ def cloth_filter(
94
84
 
95
85
  SCALE
96
86
  Scale -- Scales the mesh as a soft body using the origin of the object as scale.
97
- :type type: typing.Literal['GRAVITY','INFLATE','EXPAND','PINCH','SCALE'] | None
98
87
  :param force_axis: Force Axis, Apply the force in the selected axis
99
88
 
100
89
  X
@@ -105,7 +94,6 @@ def cloth_filter(
105
94
 
106
95
  Z
107
96
  Z -- Apply force in the Z axis.
108
- :type force_axis: set[typing.Literal['X','Y','Z']] | None
109
97
  :param orientation: Orientation, Orientation of the axis to limit the filter force
110
98
 
111
99
  LOCAL
@@ -116,15 +104,10 @@ def cloth_filter(
116
104
 
117
105
  VIEW
118
106
  View -- Use the view axis to limit the force and set the gravity direction.
119
- :type orientation: typing.Literal['LOCAL','WORLD','VIEW'] | None
120
107
  :param cloth_mass: Cloth Mass, Mass of each simulation particle
121
- :type cloth_mass: float | None
122
108
  :param cloth_damping: Cloth Damping, How much the applied forces are propagated through the cloth
123
- :type cloth_damping: float | None
124
- :param use_face_sets: Use Face Sets, Apply the filter only to the Face Set under the cursor
125
- :type use_face_sets: bool | None
109
+ :param use_face_sets: Use Face Sets, Apply the filter only to the face set under the cursor
126
110
  :param use_collisions: Use Collisions, Collide with other collider objects in the scene
127
- :type use_collisions: bool | None
128
111
  """
129
112
 
130
113
  def color_filter(
@@ -159,17 +142,10 @@ def color_filter(
159
142
  ) -> None:
160
143
  """Applies a filter to modify the active color attribute
161
144
 
162
- :type execution_context: int | str | None
163
- :type undo: bool | None
164
145
  :param start_mouse: Starting Mouse
165
- :type start_mouse: collections.abc.Iterable[int] | None
166
146
  :param area_normal_radius: Normal Radius, Radius used for calculating area normal on initial click,in percentage of brush radius
167
- :type area_normal_radius: float | None
168
147
  :param strength: Strength, Filter strength
169
- :type strength: float | None
170
148
  :param iteration_count: Repeat, How many times to repeat the filter
171
- :type iteration_count: int | None
172
- :type event_history: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
173
149
  :param type: Filter Type
174
150
 
175
151
  FILL
@@ -201,9 +177,7 @@ def color_filter(
201
177
 
202
178
  BLUE
203
179
  Blue -- Change blue channel.
204
- :type type: typing.Literal['FILL','HUE','SATURATION','VALUE','BRIGHTNESS','CONTRAST','SMOOTH','RED','GREEN','BLUE'] | None
205
180
  :param fill_color: Fill Color
206
- :type fill_color: collections.abc.Sequence[float] | mathutils.Color | None
207
181
  """
208
182
 
209
183
  def detail_flood_fill(
@@ -211,33 +185,21 @@ def detail_flood_fill(
211
185
  undo: bool | None = None,
212
186
  /,
213
187
  ) -> None:
214
- """Flood fill the mesh with the selected detail setting
215
-
216
- :type execution_context: int | str | None
217
- :type undo: bool | None
218
- """
188
+ """Flood fill the mesh with the selected detail setting"""
219
189
 
220
190
  def dynamic_topology_toggle(
221
191
  execution_context: int | str | None = None,
222
192
  undo: bool | None = None,
223
193
  /,
224
194
  ) -> None:
225
- """Dynamic topology alters the mesh topology while sculpting
226
-
227
- :type execution_context: int | str | None
228
- :type undo: bool | None
229
- """
195
+ """Dynamic topology alters the mesh topology while sculpting"""
230
196
 
231
197
  def dyntopo_detail_size_edit(
232
198
  execution_context: int | str | None = None,
233
199
  undo: bool | None = None,
234
200
  /,
235
201
  ) -> None:
236
- """Modify the detail size of dyntopo interactively
237
-
238
- :type execution_context: int | str | None
239
- :type undo: bool | None
240
- """
202
+ """Modify the detail size of dyntopo interactively"""
241
203
 
242
204
  def expand(
243
205
  execution_context: int | str | None = None,
@@ -267,28 +229,16 @@ def expand(
267
229
  ) -> None:
268
230
  """Generic sculpt expand operator
269
231
 
270
- :type execution_context: int | str | None
271
- :type undo: bool | None
272
232
  :param target: Data Target, Data that is going to be modified in the expand operation
273
- :type target: typing.Literal['MASK','FACE_SETS','COLOR'] | None
274
233
  :param falloff_type: Falloff Type, Initial falloff of the expand operation
275
- :type falloff_type: typing.Literal['GEODESIC','TOPOLOGY','TOPOLOGY_DIAGONALS','NORMALS','SPHERICAL','BOUNDARY_TOPOLOGY','BOUNDARY_FACE_SET','ACTIVE_FACE_SET'] | None
276
234
  :param invert: Invert, Invert the expand active elements
277
- :type invert: bool | None
278
235
  :param use_mask_preserve: Preserve Previous, Preserve the previous state of the target data
279
- :type use_mask_preserve: bool | None
280
236
  :param use_falloff_gradient: Falloff Gradient, Expand Using a linear falloff
281
- :type use_falloff_gradient: bool | None
282
- :param use_modify_active: Modify Active, Modify the active Face Set instead of creating a new one
283
- :type use_modify_active: bool | None
237
+ :param use_modify_active: Modify Active, Modify the active face set instead of creating a new one
284
238
  :param use_reposition_pivot: Reposition Pivot, Reposition the sculpt transform pivot to the boundary of the expand active area
285
- :type use_reposition_pivot: bool | None
286
239
  :param max_geodesic_move_preview: Max Vertex Count for Geodesic Move Preview, Maximum number of vertices in the mesh for using geodesic falloff when moving the origin of expand. If the total number of vertices is greater than this value, the falloff will be set to spherical when moving
287
- :type max_geodesic_move_preview: int | None
288
240
  :param use_auto_mask: Auto Create, Fill in mask if nothing is already masked
289
- :type use_auto_mask: bool | None
290
241
  :param normal_falloff_smooth: Normal Smooth, Blurring steps for normal falloff
291
- :type normal_falloff_smooth: int | None
292
242
  """
293
243
 
294
244
  def face_set_box_gesture(
@@ -305,20 +255,12 @@ def face_set_box_gesture(
305
255
  ) -> None:
306
256
  """Add a face set in a rectangle defined by the cursor
307
257
 
308
- :type execution_context: int | str | None
309
- :type undo: bool | None
310
258
  :param xmin: X Min
311
- :type xmin: int | None
312
259
  :param xmax: X Max
313
- :type xmax: int | None
314
260
  :param ymin: Y Min
315
- :type ymin: int | None
316
261
  :param ymax: Y Max
317
- :type ymax: int | None
318
262
  :param wait_for_input: Wait for Input
319
- :type wait_for_input: bool | None
320
263
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
321
- :type use_front_faces_only: bool | None
322
264
  """
323
265
 
324
266
  def face_set_change_visibility(
@@ -328,21 +270,18 @@ def face_set_change_visibility(
328
270
  *,
329
271
  mode: typing.Literal["TOGGLE", "SHOW_ACTIVE", "HIDE_ACTIVE"] | None = "TOGGLE",
330
272
  ) -> None:
331
- """Change the visibility of the Face Sets of the sculpt
273
+ """Change the visibility of the face sets of the sculpt
332
274
 
333
- :type execution_context: int | str | None
334
- :type undo: bool | None
335
275
  :param mode: Mode
336
276
 
337
277
  TOGGLE
338
- Toggle Visibility -- Hide all Face Sets except for the active one.
278
+ Toggle Visibility -- Hide all face sets except for the active one.
339
279
 
340
280
  SHOW_ACTIVE
341
- Show Active Face Set -- Show Active Face Set.
281
+ Show Active Face Set -- Show the active face set.
342
282
 
343
283
  HIDE_ACTIVE
344
- Hide Active Face Sets -- Hide Active Face Sets.
345
- :type mode: typing.Literal['TOGGLE','SHOW_ACTIVE','HIDE_ACTIVE'] | None
284
+ Hide Active Face Set -- Hide the active face set.
346
285
  """
347
286
 
348
287
  def face_set_edit(
@@ -358,33 +297,27 @@ def face_set_edit(
358
297
  strength: float | None = 1.0,
359
298
  modify_hidden: bool | None = False,
360
299
  ) -> None:
361
- """Edits the current active Face Set
300
+ """Edits the current active face set
362
301
 
363
- :type execution_context: int | str | None
364
- :type undo: bool | None
365
302
  :param active_face_set: Active Face Set
366
- :type active_face_set: int | None
367
303
  :param mode: Mode
368
304
 
369
305
  GROW
370
- Grow Face Set -- Grows the Face Sets boundary by one face based on mesh topology.
306
+ Grow Face Set -- Grows the face set boundary by one face based on mesh topology.
371
307
 
372
308
  SHRINK
373
- Shrink Face Set -- Shrinks the Face Sets boundary by one face based on mesh topology.
309
+ Shrink Face Set -- Shrinks the face set boundary by one face based on mesh topology.
374
310
 
375
311
  DELETE_GEOMETRY
376
- Delete Geometry -- Deletes the faces that are assigned to the Face Set.
312
+ Delete Geometry -- Deletes the faces that are assigned to the face set.
377
313
 
378
314
  FAIR_POSITIONS
379
- Fair Positions -- Creates a smooth as possible geometry patch from the Face Set minimizing changes in vertex positions.
315
+ Fair Positions -- Creates a smooth as possible geometry patch from the face set minimizing changes in vertex positions.
380
316
 
381
317
  FAIR_TANGENCY
382
- Fair Tangency -- Creates a smooth as possible geometry patch from the Face Set minimizing changes in vertex tangents.
383
- :type mode: typing.Literal['GROW','SHRINK','DELETE_GEOMETRY','FAIR_POSITIONS','FAIR_TANGENCY'] | None
318
+ Fair Tangency -- Creates a smooth as possible geometry patch from the face set minimizing changes in vertex tangents.
384
319
  :param strength: Strength
385
- :type strength: float | None
386
320
  :param modify_hidden: Modify Hidden, Apply the edit operation to hidden geometry
387
- :type modify_hidden: bool | None
388
321
  """
389
322
 
390
323
  def face_set_extract(
@@ -397,18 +330,12 @@ def face_set_extract(
397
330
  apply_shrinkwrap: bool | None = True,
398
331
  add_solidify: bool | None = True,
399
332
  ) -> None:
400
- """Create a new mesh object from the selected Face Set
333
+ """Create a new mesh object from the selected face set
401
334
 
402
- :type execution_context: int | str | None
403
- :type undo: bool | None
404
335
  :param add_boundary_loop: Add Boundary Loop, Add an extra edge loop to better preserve the shape when applying a subdivision surface modifier
405
- :type add_boundary_loop: bool | None
406
336
  :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
407
- :type smooth_iterations: int | None
408
337
  :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
409
- :type apply_shrinkwrap: bool | None
410
338
  :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
411
- :type add_solidify: bool | None
412
339
  """
413
340
 
414
341
  def face_set_lasso_gesture(
@@ -424,18 +351,11 @@ def face_set_lasso_gesture(
424
351
  ) -> None:
425
352
  """Add a face set in a shape defined by the cursor
426
353
 
427
- :type execution_context: int | str | None
428
- :type undo: bool | None
429
354
  :param path: Path
430
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
431
355
  :param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
432
- :type use_smooth_stroke: bool | None
433
356
  :param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
434
- :type smooth_stroke_factor: float | None
435
357
  :param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
436
- :type smooth_stroke_radius: int | None
437
358
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
438
- :type use_front_faces_only: bool | None
439
359
  """
440
360
 
441
361
  def face_set_line_gesture(
@@ -454,24 +374,14 @@ def face_set_line_gesture(
454
374
  ) -> None:
455
375
  """Add a face set to one side of a line defined by the cursor
456
376
 
457
- :type execution_context: int | str | None
458
- :type undo: bool | None
459
377
  :param xstart: X Start
460
- :type xstart: int | None
461
378
  :param xend: X End
462
- :type xend: int | None
463
379
  :param ystart: Y Start
464
- :type ystart: int | None
465
380
  :param yend: Y End
466
- :type yend: int | None
467
381
  :param flip: Flip
468
- :type flip: bool | None
469
382
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
470
- :type cursor: int | None
471
383
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
472
- :type use_front_faces_only: bool | None
473
384
  :param use_limit_to_segment: Limit to Segment, Apply the gesture action only to the area that is contained within the segment without extending its effect to the entire line
474
- :type use_limit_to_segment: bool | None
475
385
  """
476
386
 
477
387
  def face_set_polyline_gesture(
@@ -484,12 +394,8 @@ def face_set_polyline_gesture(
484
394
  ) -> None:
485
395
  """Add a face set in a shape defined by the cursor
486
396
 
487
- :type execution_context: int | str | None
488
- :type undo: bool | None
489
397
  :param path: Path
490
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
491
398
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
492
- :type use_front_faces_only: bool | None
493
399
  """
494
400
 
495
401
  def face_sets_create(
@@ -499,24 +405,21 @@ def face_sets_create(
499
405
  *,
500
406
  mode: typing.Literal["MASKED", "VISIBLE", "ALL", "SELECTION"] | None = "MASKED",
501
407
  ) -> None:
502
- """Create a new Face Set
408
+ """Create a new face set
503
409
 
504
- :type execution_context: int | str | None
505
- :type undo: bool | None
506
410
  :param mode: Mode
507
411
 
508
412
  MASKED
509
- Face Set from Masked -- Create a new Face Set from the masked faces.
413
+ Face Set from Masked -- Create a new face set from the masked faces.
510
414
 
511
415
  VISIBLE
512
- Face Set from Visible -- Create a new Face Set from the visible vertices.
416
+ Face Set from Visible -- Create a new face set from the visible vertices.
513
417
 
514
418
  ALL
515
- Face Set Full Mesh -- Create an unique Face Set with all faces in the sculpt.
419
+ Face Set Full Mesh -- Create an unique face set with all faces in the sculpt.
516
420
 
517
421
  SELECTION
518
- Face Set from Edit Mode Selection -- Create an Face Set corresponding to the Edit Mode face selection.
519
- :type mode: typing.Literal['MASKED','VISIBLE','ALL','SELECTION'] | None
422
+ Face Set from Edit Mode Selection -- Create an face set corresponding to the Edit Mode face selection.
520
423
  """
521
424
 
522
425
  def face_sets_init(
@@ -537,38 +440,34 @@ def face_sets_init(
537
440
  | None = "LOOSE_PARTS",
538
441
  threshold: float | None = 0.5,
539
442
  ) -> None:
540
- """Initializes all Face Sets in the mesh
443
+ """Initializes all face sets in the mesh
541
444
 
542
- :type execution_context: int | str | None
543
- :type undo: bool | None
544
445
  :param mode: Mode
545
446
 
546
447
  LOOSE_PARTS
547
- Face Sets from Loose Parts -- Create a Face Set per loose part in the mesh.
448
+ Face Sets from Loose Parts -- Create a face set per loose part in the mesh.
548
449
 
549
450
  MATERIALS
550
- Face Sets from Material Slots -- Create a Face Set per Material Slot.
451
+ Face Sets from Material Slots -- Create a face set per material slot.
551
452
 
552
453
  NORMALS
553
- Face Sets from Mesh Normals -- Create Face Sets for Faces that have similar normal.
454
+ Face Sets from Mesh Normals -- Create face sets for faces that have similar normal.
554
455
 
555
456
  UV_SEAMS
556
- Face Sets from UV Seams -- Create Face Sets using UV Seams as boundaries.
457
+ Face Sets from UV Seams -- Create face sets using UV seams as boundaries.
557
458
 
558
459
  CREASES
559
- Face Sets from Edge Creases -- Create Face Sets using Edge Creases as boundaries.
460
+ Face Sets from Edge Creases -- Create face sets using edge creases as boundaries.
560
461
 
561
462
  BEVEL_WEIGHT
562
- Face Sets from Bevel Weight -- Create Face Sets using Bevel Weights as boundaries.
463
+ Face Sets from Bevel Weight -- Create face sets using bevel weights as boundaries.
563
464
 
564
465
  SHARP_EDGES
565
- Face Sets from Sharp Edges -- Create Face Sets using Sharp Edges as boundaries.
466
+ Face Sets from Sharp Edges -- Create face sets using sharp edges as boundaries.
566
467
 
567
468
  FACE_SET_BOUNDARIES
568
- Face Sets from Face Set Boundaries -- Create a Face Set per isolated Face Set.
569
- :type mode: typing.Literal['LOOSE_PARTS','MATERIALS','NORMALS','UV_SEAMS','CREASES','BEVEL_WEIGHT','SHARP_EDGES','FACE_SET_BOUNDARIES'] | None
570
- :param threshold: Threshold, Minimum value to consider a certain attribute a boundary when creating the Face Sets
571
- :type threshold: float | None
469
+ Face Sets from Face Set Boundaries -- Create a face set per isolated face set.
470
+ :param threshold: Threshold, Minimum value to consider a certain attribute a boundary when creating the face sets
572
471
  """
573
472
 
574
473
  def face_sets_randomize_colors(
@@ -576,11 +475,7 @@ def face_sets_randomize_colors(
576
475
  undo: bool | None = None,
577
476
  /,
578
477
  ) -> None:
579
- """Generates a new set of random colors to render the Face Sets in the viewport
580
-
581
- :type execution_context: int | str | None
582
- :type undo: bool | None
583
- """
478
+ """Generates a new set of random colors to render the face sets in the viewport"""
584
479
 
585
480
  def mask_by_color(
586
481
  execution_context: int | str | None = None,
@@ -595,18 +490,11 @@ def mask_by_color(
595
490
  ) -> None:
596
491
  """Creates a mask based on the active color attribute
597
492
 
598
- :type execution_context: int | str | None
599
- :type undo: bool | None
600
493
  :param contiguous: Contiguous, Mask only contiguous color areas
601
- :type contiguous: bool | None
602
494
  :param invert: Invert, Invert the generated mask
603
- :type invert: bool | None
604
495
  :param preserve_previous_mask: Preserve Previous Mask, Preserve the previous mask and add or subtract the new one generated by the colors
605
- :type preserve_previous_mask: bool | None
606
496
  :param threshold: Threshold, How much changes in color affect the mask generation
607
- :type threshold: float | None
608
497
  :param location: Location, Region coordinates of sampling
609
- :type location: collections.abc.Iterable[int] | None
610
498
  """
611
499
 
612
500
  def mask_filter(
@@ -623,14 +511,9 @@ def mask_filter(
623
511
  ) -> None:
624
512
  """Applies a filter to modify the current mask
625
513
 
626
- :type execution_context: int | str | None
627
- :type undo: bool | None
628
514
  :param filter_type: Type, Filter that is going to be applied to the mask
629
- :type filter_type: typing.Literal['SMOOTH','SHARPEN','GROW','SHRINK','CONTRAST_INCREASE','CONTRAST_DECREASE'] | None
630
515
  :param iterations: Iterations, Number of times that the filter is going to be applied
631
- :type iterations: int | None
632
516
  :param auto_iteration_count: Auto Iteration Count, Use an automatic number of iterations based on the number of vertices of the sculpt
633
- :type auto_iteration_count: bool | None
634
517
  """
635
518
 
636
519
  def mask_from_boundary(
@@ -647,12 +530,8 @@ def mask_from_boundary(
647
530
  ) -> None:
648
531
  """Creates a mask based on the boundaries of the surface
649
532
 
650
- :type execution_context: int | str | None
651
- :type undo: bool | None
652
533
  :param mix_mode: Mode, Mix mode
653
- :type mix_mode: typing.Literal['MIX','MULTIPLY','DIVIDE','ADD','SUBTRACT'] | None
654
534
  :param mix_factor: Mix Factor
655
- :type mix_factor: float | None
656
535
  :param settings_source: Settings, Use settings from here
657
536
 
658
537
  OPERATOR
@@ -663,7 +542,6 @@ def mask_from_boundary(
663
542
 
664
543
  SCENE
665
544
  Scene -- Use settings from scene.
666
- :type settings_source: typing.Literal['OPERATOR','BRUSH','SCENE'] | None
667
545
  :param boundary_mode: Mode, Boundary type to mask
668
546
 
669
547
  MESH
@@ -671,9 +549,7 @@ def mask_from_boundary(
671
549
 
672
550
  FACE_SETS
673
551
  Face Sets -- Calculate the boundary mask between face sets.
674
- :type boundary_mode: typing.Literal['MESH','FACE_SETS'] | None
675
552
  :param propagation_steps: Propagation Steps
676
- :type propagation_steps: int | None
677
553
  """
678
554
 
679
555
  def mask_from_cavity(
@@ -692,12 +568,8 @@ def mask_from_cavity(
692
568
  ) -> None:
693
569
  """Creates a mask based on the curvature of the surface
694
570
 
695
- :type execution_context: int | str | None
696
- :type undo: bool | None
697
571
  :param mix_mode: Mode, Mix mode
698
- :type mix_mode: typing.Literal['MIX','MULTIPLY','DIVIDE','ADD','SUBTRACT'] | None
699
572
  :param mix_factor: Mix Factor
700
- :type mix_factor: float | None
701
573
  :param settings_source: Settings, Use settings from here
702
574
 
703
575
  OPERATOR
@@ -708,15 +580,10 @@ def mask_from_cavity(
708
580
 
709
581
  SCENE
710
582
  Scene -- Use settings from scene.
711
- :type settings_source: typing.Literal['OPERATOR','BRUSH','SCENE'] | None
712
583
  :param factor: Factor, The contrast of the cavity mask
713
- :type factor: float | None
714
584
  :param blur_steps: Blur, The number of times the cavity mask is blurred
715
- :type blur_steps: int | None
716
585
  :param use_curve: Custom Curve
717
- :type use_curve: bool | None
718
586
  :param invert: Cavity (Inverted)
719
- :type invert: bool | None
720
587
  """
721
588
 
722
589
  def mask_init(
@@ -731,10 +598,7 @@ def mask_init(
731
598
  ) -> None:
732
599
  """Creates a new mask for the entire mesh
733
600
 
734
- :type execution_context: int | str | None
735
- :type undo: bool | None
736
601
  :param mode: Mode
737
- :type mode: typing.Literal['RANDOM_PER_VERTEX','RANDOM_PER_FACE_SET','RANDOM_PER_LOOSE_PART'] | None
738
602
  """
739
603
 
740
604
  def mesh_filter(
@@ -772,17 +636,10 @@ def mesh_filter(
772
636
  ) -> None:
773
637
  """Applies a filter to modify the current mesh
774
638
 
775
- :type execution_context: int | str | None
776
- :type undo: bool | None
777
639
  :param start_mouse: Starting Mouse
778
- :type start_mouse: collections.abc.Iterable[int] | None
779
640
  :param area_normal_radius: Normal Radius, Radius used for calculating area normal on initial click,in percentage of brush radius
780
- :type area_normal_radius: float | None
781
641
  :param strength: Strength, Filter strength
782
- :type strength: float | None
783
642
  :param iteration_count: Repeat, How many times to repeat the filter
784
- :type iteration_count: int | None
785
- :type event_history: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
786
643
  :param type: Filter Type, Operation that is going to be applied to the mesh
787
644
 
788
645
  SMOOTH
@@ -804,7 +661,7 @@ def mesh_filter(
804
661
  Relax -- Relax mesh.
805
662
 
806
663
  RELAX_FACE_SETS
807
- Relax Face Sets -- Smooth the edges of all the Face Sets.
664
+ Relax Face Sets -- Smooth the edges of all the face sets.
808
665
 
809
666
  SURFACE_SMOOTH
810
667
  Surface Smooth -- Smooth the surface of the mesh, preserving the volume.
@@ -817,7 +674,6 @@ def mesh_filter(
817
674
 
818
675
  ERASE_DISPLACEMENT
819
676
  Erase Displacement -- Deletes the displacement of the Multires Modifier.
820
- :type type: typing.Literal['SMOOTH','SCALE','INFLATE','SPHERE','RANDOM','RELAX','RELAX_FACE_SETS','SURFACE_SMOOTH','SHARPEN','ENHANCE_DETAILS','ERASE_DISPLACEMENT'] | None
821
677
  :param deform_axis: Deform Axis, Apply the deformation in the selected axis
822
678
 
823
679
  X
@@ -828,7 +684,6 @@ def mesh_filter(
828
684
 
829
685
  Z
830
686
  Z -- Deform in the Z axis.
831
- :type deform_axis: set[typing.Literal['X','Y','Z']] | None
832
687
  :param orientation: Orientation, Orientation of the axis to limit the filter displacement
833
688
 
834
689
  LOCAL
@@ -839,17 +694,11 @@ def mesh_filter(
839
694
 
840
695
  VIEW
841
696
  View -- Use the view axis to limit the displacement.
842
- :type orientation: typing.Literal['LOCAL','WORLD','VIEW'] | None
843
697
  :param surface_smooth_shape_preservation: Shape Preservation, How much of the original shape is preserved when smoothing
844
- :type surface_smooth_shape_preservation: float | None
845
698
  :param surface_smooth_current_vertex: Per Vertex Displacement, How much the position of each individual vertex influences the final result
846
- :type surface_smooth_current_vertex: float | None
847
699
  :param sharpen_smooth_ratio: Smooth Ratio, How much smoothing is applied to polished surfaces
848
- :type sharpen_smooth_ratio: float | None
849
700
  :param sharpen_intensify_detail_strength: Intensify Details, How much creases and valleys are intensified
850
- :type sharpen_intensify_detail_strength: float | None
851
701
  :param sharpen_curvature_smooth_iterations: Curvature Smooth Iterations, How much smooth the resulting shape is, ignoring high frequency details
852
- :type sharpen_curvature_smooth_iterations: int | None
853
702
  """
854
703
 
855
704
  def optimize(
@@ -857,11 +706,7 @@ def optimize(
857
706
  undo: bool | None = None,
858
707
  /,
859
708
  ) -> None:
860
- """Recalculate the sculpt BVH to improve performance
861
-
862
- :type execution_context: int | str | None
863
- :type undo: bool | None
864
- """
709
+ """Recalculate the sculpt BVH to improve performance"""
865
710
 
866
711
  def paint_mask_extract(
867
712
  execution_context: int | str | None = None,
@@ -876,18 +721,11 @@ def paint_mask_extract(
876
721
  ) -> None:
877
722
  """Create a new mesh object from the current paint mask
878
723
 
879
- :type execution_context: int | str | None
880
- :type undo: bool | None
881
724
  :param mask_threshold: Threshold, Minimum mask value to consider the vertex valid to extract a face from the original mesh
882
- :type mask_threshold: float | None
883
725
  :param add_boundary_loop: Add Boundary Loop, Add an extra edge loop to better preserve the shape when applying a subdivision surface modifier
884
- :type add_boundary_loop: bool | None
885
726
  :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
886
- :type smooth_iterations: int | None
887
727
  :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
888
- :type apply_shrinkwrap: bool | None
889
728
  :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
890
- :type add_solidify: bool | None
891
729
  """
892
730
 
893
731
  def paint_mask_slice(
@@ -901,14 +739,9 @@ def paint_mask_slice(
901
739
  ) -> None:
902
740
  """Slices the paint mask from the mesh
903
741
 
904
- :type execution_context: int | str | None
905
- :type undo: bool | None
906
742
  :param mask_threshold: Threshold, Minimum mask value to consider the vertex valid to extract a face from the original mesh
907
- :type mask_threshold: float | None
908
743
  :param fill_holes: Fill Holes, Fill holes after slicing the mask
909
- :type fill_holes: bool | None
910
744
  :param new_object: Slice to New Object, Create a new object from the sliced mask
911
- :type new_object: bool | None
912
745
  """
913
746
 
914
747
  def project_line_gesture(
@@ -927,35 +760,14 @@ def project_line_gesture(
927
760
  ) -> None:
928
761
  """Project the geometry onto a plane defined by a line
929
762
 
930
- :type execution_context: int | str | None
931
- :type undo: bool | None
932
763
  :param xstart: X Start
933
- :type xstart: int | None
934
764
  :param xend: X End
935
- :type xend: int | None
936
765
  :param ystart: Y Start
937
- :type ystart: int | None
938
766
  :param yend: Y End
939
- :type yend: int | None
940
767
  :param flip: Flip
941
- :type flip: bool | None
942
768
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
943
- :type cursor: int | None
944
769
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
945
- :type use_front_faces_only: bool | None
946
770
  :param use_limit_to_segment: Limit to Segment, Apply the gesture action only to the area that is contained within the segment without extending its effect to the entire line
947
- :type use_limit_to_segment: bool | None
948
- """
949
-
950
- def sample_color(
951
- execution_context: int | str | None = None,
952
- undo: bool | None = None,
953
- /,
954
- ) -> None:
955
- """Sample the vertex color of the active vertex
956
-
957
- :type execution_context: int | str | None
958
- :type undo: bool | None
959
771
  """
960
772
 
961
773
  def sample_detail_size(
@@ -968,10 +780,7 @@ def sample_detail_size(
968
780
  ) -> None:
969
781
  """Sample the mesh detail on clicked point
970
782
 
971
- :type execution_context: int | str | None
972
- :type undo: bool | None
973
783
  :param location: Location, Screen coordinates of sampling
974
- :type location: collections.abc.Iterable[int] | None
975
784
  :param mode: Detail Mode, Target sculpting workflow that is going to use the sampled size
976
785
 
977
786
  DYNTOPO
@@ -979,7 +788,6 @@ def sample_detail_size(
979
788
 
980
789
  VOXEL
981
790
  Voxel -- Sample mesh voxel size.
982
- :type mode: typing.Literal['DYNTOPO','VOXEL'] | None
983
791
  """
984
792
 
985
793
  def sculptmode_toggle(
@@ -987,22 +795,14 @@ def sculptmode_toggle(
987
795
  undo: bool | None = None,
988
796
  /,
989
797
  ) -> None:
990
- """Toggle sculpt mode in 3D view
991
-
992
- :type execution_context: int | str | None
993
- :type undo: bool | None
994
- """
798
+ """Toggle sculpt mode in 3D view"""
995
799
 
996
800
  def set_persistent_base(
997
801
  execution_context: int | str | None = None,
998
802
  undo: bool | None = None,
999
803
  /,
1000
804
  ) -> None:
1001
- """Reset the copy of the mesh that is being sculpted on
1002
-
1003
- :type execution_context: int | str | None
1004
- :type undo: bool | None
1005
- """
805
+ """Reset the copy of the mesh that is being sculpted on"""
1006
806
 
1007
807
  def set_pivot_position(
1008
808
  execution_context: int | str | None = None,
@@ -1016,8 +816,6 @@ def set_pivot_position(
1016
816
  ) -> None:
1017
817
  """Sets the sculpt transform pivot position
1018
818
 
1019
- :type execution_context: int | str | None
1020
- :type undo: bool | None
1021
819
  :param mode: Mode
1022
820
 
1023
821
  ORIGIN
@@ -1034,11 +832,8 @@ def set_pivot_position(
1034
832
 
1035
833
  SURFACE
1036
834
  Surface -- Sets the pivot position to the surface under the cursor.
1037
- :type mode: typing.Literal['ORIGIN','UNMASKED','BORDER','ACTIVE','SURFACE'] | None
1038
835
  :param mouse_x: Mouse Position X, Position of the mouse used for "Surface" and "Active Vertex" mode
1039
- :type mouse_x: float | None
1040
836
  :param mouse_y: Mouse Position Y, Position of the mouse used for "Surface" and "Active Vertex" mode
1041
- :type mouse_y: float | None
1042
837
  """
1043
838
 
1044
839
  def symmetrize(
@@ -1050,10 +845,7 @@ def symmetrize(
1050
845
  ) -> None:
1051
846
  """Symmetrize the topology modifications
1052
847
 
1053
- :type execution_context: int | str | None
1054
- :type undo: bool | None
1055
848
  :param merge_tolerance: Merge Distance, Distance within which symmetrical vertices are merged
1056
- :type merge_tolerance: float | None
1057
849
  """
1058
850
 
1059
851
  def trim_box_gesture(
@@ -1076,22 +868,13 @@ def trim_box_gesture(
1076
868
  ) -> None:
1077
869
  """Execute a boolean operation on the mesh and a rectangle defined by the cursor
1078
870
 
1079
- :type execution_context: int | str | None
1080
- :type undo: bool | None
1081
871
  :param xmin: X Min
1082
- :type xmin: int | None
1083
872
  :param xmax: X Max
1084
- :type xmax: int | None
1085
873
  :param ymin: Y Min
1086
- :type ymin: int | None
1087
874
  :param ymax: Y Max
1088
- :type ymax: int | None
1089
875
  :param wait_for_input: Wait for Input
1090
- :type wait_for_input: bool | None
1091
876
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1092
- :type use_front_faces_only: bool | None
1093
877
  :param location: Location, Mouse location
1094
- :type location: collections.abc.Iterable[int] | None
1095
878
  :param trim_mode: Trim Mode
1096
879
 
1097
880
  DIFFERENCE
@@ -1102,9 +885,7 @@ def trim_box_gesture(
1102
885
 
1103
886
  JOIN
1104
887
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1105
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1106
888
  :param use_cursor_depth: Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape
1107
- :type use_cursor_depth: bool | None
1108
889
  :param trim_orientation: Shape Orientation
1109
890
 
1110
891
  VIEW
@@ -1112,7 +893,6 @@ def trim_box_gesture(
1112
893
 
1113
894
  SURFACE
1114
895
  Surface -- Use the surface normal to orientate the trimming shape.
1115
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1116
896
  :param trim_extrude_mode: Extrude Mode
1117
897
 
1118
898
  PROJECT
@@ -1120,7 +900,6 @@ def trim_box_gesture(
1120
900
 
1121
901
  FIXED
1122
902
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1123
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1124
903
  :param trim_solver: Solver
1125
904
 
1126
905
  EXACT
@@ -1131,7 +910,6 @@ def trim_box_gesture(
1131
910
 
1132
911
  MANIFOLD
1133
912
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1134
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1135
913
  """
1136
914
 
1137
915
  def trim_lasso_gesture(
@@ -1153,20 +931,12 @@ def trim_lasso_gesture(
1153
931
  ) -> None:
1154
932
  """Execute a boolean operation on the mesh and a shape defined by the cursor
1155
933
 
1156
- :type execution_context: int | str | None
1157
- :type undo: bool | None
1158
934
  :param path: Path
1159
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
1160
935
  :param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
1161
- :type use_smooth_stroke: bool | None
1162
936
  :param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
1163
- :type smooth_stroke_factor: float | None
1164
937
  :param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
1165
- :type smooth_stroke_radius: int | None
1166
938
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1167
- :type use_front_faces_only: bool | None
1168
939
  :param location: Location, Mouse location
1169
- :type location: collections.abc.Iterable[int] | None
1170
940
  :param trim_mode: Trim Mode
1171
941
 
1172
942
  DIFFERENCE
@@ -1177,9 +947,7 @@ def trim_lasso_gesture(
1177
947
 
1178
948
  JOIN
1179
949
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1180
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1181
950
  :param use_cursor_depth: Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape
1182
- :type use_cursor_depth: bool | None
1183
951
  :param trim_orientation: Shape Orientation
1184
952
 
1185
953
  VIEW
@@ -1187,7 +955,6 @@ def trim_lasso_gesture(
1187
955
 
1188
956
  SURFACE
1189
957
  Surface -- Use the surface normal to orientate the trimming shape.
1190
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1191
958
  :param trim_extrude_mode: Extrude Mode
1192
959
 
1193
960
  PROJECT
@@ -1195,7 +962,6 @@ def trim_lasso_gesture(
1195
962
 
1196
963
  FIXED
1197
964
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1198
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1199
965
  :param trim_solver: Solver
1200
966
 
1201
967
  EXACT
@@ -1206,7 +972,6 @@ def trim_lasso_gesture(
1206
972
 
1207
973
  MANIFOLD
1208
974
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1209
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1210
975
  """
1211
976
 
1212
977
  def trim_line_gesture(
@@ -1231,26 +996,15 @@ def trim_line_gesture(
1231
996
  ) -> None:
1232
997
  """Remove a portion of the mesh on one side of a line
1233
998
 
1234
- :type execution_context: int | str | None
1235
- :type undo: bool | None
1236
999
  :param xstart: X Start
1237
- :type xstart: int | None
1238
1000
  :param xend: X End
1239
- :type xend: int | None
1240
1001
  :param ystart: Y Start
1241
- :type ystart: int | None
1242
1002
  :param yend: Y End
1243
- :type yend: int | None
1244
1003
  :param flip: Flip
1245
- :type flip: bool | None
1246
1004
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
1247
- :type cursor: int | None
1248
1005
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1249
- :type use_front_faces_only: bool | None
1250
1006
  :param use_limit_to_segment: Limit to Segment, Apply the gesture action only to the area that is contained within the segment without extending its effect to the entire line
1251
- :type use_limit_to_segment: bool | None
1252
1007
  :param location: Location, Mouse location
1253
- :type location: collections.abc.Iterable[int] | None
1254
1008
  :param trim_mode: Trim Mode
1255
1009
 
1256
1010
  DIFFERENCE
@@ -1261,9 +1015,7 @@ def trim_line_gesture(
1261
1015
 
1262
1016
  JOIN
1263
1017
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1264
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1265
1018
  :param use_cursor_depth: Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape
1266
- :type use_cursor_depth: bool | None
1267
1019
  :param trim_orientation: Shape Orientation
1268
1020
 
1269
1021
  VIEW
@@ -1271,7 +1023,6 @@ def trim_line_gesture(
1271
1023
 
1272
1024
  SURFACE
1273
1025
  Surface -- Use the surface normal to orientate the trimming shape.
1274
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1275
1026
  :param trim_extrude_mode: Extrude Mode
1276
1027
 
1277
1028
  PROJECT
@@ -1279,7 +1030,6 @@ def trim_line_gesture(
1279
1030
 
1280
1031
  FIXED
1281
1032
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1282
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1283
1033
  :param trim_solver: Solver
1284
1034
 
1285
1035
  EXACT
@@ -1290,7 +1040,6 @@ def trim_line_gesture(
1290
1040
 
1291
1041
  MANIFOLD
1292
1042
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1293
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1294
1043
  """
1295
1044
 
1296
1045
  def trim_polyline_gesture(
@@ -1309,14 +1058,9 @@ def trim_polyline_gesture(
1309
1058
  ) -> None:
1310
1059
  """Execute a boolean operation on the mesh and a polygonal shape defined by the cursor
1311
1060
 
1312
- :type execution_context: int | str | None
1313
- :type undo: bool | None
1314
1061
  :param path: Path
1315
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
1316
1062
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1317
- :type use_front_faces_only: bool | None
1318
1063
  :param location: Location, Mouse location
1319
- :type location: collections.abc.Iterable[int] | None
1320
1064
  :param trim_mode: Trim Mode
1321
1065
 
1322
1066
  DIFFERENCE
@@ -1327,9 +1071,7 @@ def trim_polyline_gesture(
1327
1071
 
1328
1072
  JOIN
1329
1073
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1330
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1331
1074
  :param use_cursor_depth: Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape
1332
- :type use_cursor_depth: bool | None
1333
1075
  :param trim_orientation: Shape Orientation
1334
1076
 
1335
1077
  VIEW
@@ -1337,7 +1079,6 @@ def trim_polyline_gesture(
1337
1079
 
1338
1080
  SURFACE
1339
1081
  Surface -- Use the surface normal to orientate the trimming shape.
1340
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1341
1082
  :param trim_extrude_mode: Extrude Mode
1342
1083
 
1343
1084
  PROJECT
@@ -1345,7 +1086,6 @@ def trim_polyline_gesture(
1345
1086
 
1346
1087
  FIXED
1347
1088
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1348
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1349
1089
  :param trim_solver: Solver
1350
1090
 
1351
1091
  EXACT
@@ -1356,7 +1096,6 @@ def trim_polyline_gesture(
1356
1096
 
1357
1097
  MANIFOLD
1358
1098
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1359
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1360
1099
  """
1361
1100
 
1362
1101
  def uv_sculpt_grab(
@@ -1368,10 +1107,7 @@ def uv_sculpt_grab(
1368
1107
  ) -> None:
1369
1108
  """Grab UVs
1370
1109
 
1371
- :type execution_context: int | str | None
1372
- :type undo: bool | None
1373
1110
  :param use_invert: Invert, Invert action for the duration of the stroke
1374
- :type use_invert: bool | None
1375
1111
  """
1376
1112
 
1377
1113
  def uv_sculpt_pinch(
@@ -1383,10 +1119,7 @@ def uv_sculpt_pinch(
1383
1119
  ) -> None:
1384
1120
  """Pinch UVs
1385
1121
 
1386
- :type execution_context: int | str | None
1387
- :type undo: bool | None
1388
1122
  :param use_invert: Invert, Invert action for the duration of the stroke
1389
- :type use_invert: bool | None
1390
1123
  """
1391
1124
 
1392
1125
  def uv_sculpt_relax(
@@ -1395,14 +1128,11 @@ def uv_sculpt_relax(
1395
1128
  /,
1396
1129
  *,
1397
1130
  use_invert: bool | None = False,
1398
- relax_method: typing.Literal["LAPLACIAN", "HC", "COTAN"] | None = "COTAN",
1131
+ relax_method: typing.Literal["LAPLACIAN", "HC", "COTAN"] | None = "LAPLACIAN",
1399
1132
  ) -> None:
1400
1133
  """Relax UVs
1401
1134
 
1402
- :type execution_context: int | str | None
1403
- :type undo: bool | None
1404
1135
  :param use_invert: Invert, Invert action for the duration of the stroke
1405
- :type use_invert: bool | None
1406
1136
  :param relax_method: Relax Method, Algorithm used for UV relaxation
1407
1137
 
1408
1138
  LAPLACIAN
@@ -1413,5 +1143,4 @@ def uv_sculpt_relax(
1413
1143
 
1414
1144
  COTAN
1415
1145
  Geometry -- Use Geometry (cotangent) relaxation, making UVs follow the underlying 3D geometry.
1416
- :type relax_method: typing.Literal['LAPLACIAN','HC','COTAN'] | None
1417
1146
  """