fake-bpy-module-latest 20251003__py3-none-any.whl → 20260114__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 (299) 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}/settings/__init__.pyi +2 -0
  7. _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
  8. {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
  9. _bpy_internal/__init__.pyi +1 -0
  10. _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
  11. _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
  12. _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
  13. _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
  14. _bpy_types/__init__.pyi +18 -123
  15. {rna_info → _rna_info}/__init__.pyi +0 -1
  16. addon_utils/__init__.pyi +0 -13
  17. aud/__init__.pyi +55 -131
  18. bl_math/__init__.pyi +2 -12
  19. bl_operators/__init__.pyi +1 -0
  20. bl_operators/add_mesh_torus/__init__.pyi +0 -2
  21. bl_operators/anim/__init__.pyi +40 -24
  22. bl_operators/assets/__init__.pyi +0 -6
  23. bl_operators/bone_selection_sets/__init__.pyi +0 -28
  24. bl_operators/clip/__init__.pyi +0 -20
  25. bl_operators/connect_to_output/__init__.pyi +0 -2
  26. bl_operators/console/__init__.pyi +0 -10
  27. bl_operators/constraint/__init__.pyi +0 -8
  28. bl_operators/copy_global_transform/__init__.pyi +261 -0
  29. bl_operators/file/__init__.pyi +0 -6
  30. bl_operators/freestyle/__init__.pyi +0 -8
  31. bl_operators/geometry_nodes/__init__.pyi +0 -8
  32. bl_operators/grease_pencil/__init__.pyi +0 -2
  33. bl_operators/image/__init__.pyi +0 -10
  34. bl_operators/image_as_planes/__init__.pyi +0 -4
  35. bl_operators/mesh/__init__.pyi +0 -4
  36. bl_operators/node/__init__.pyi +36 -46
  37. bl_operators/object/__init__.pyi +0 -37
  38. bl_operators/object_align/__init__.pyi +0 -2
  39. bl_operators/object_quick_effects/__init__.pyi +0 -8
  40. bl_operators/object_randomize_transform/__init__.pyi +0 -2
  41. bl_operators/presets/__init__.pyi +0 -50
  42. bl_operators/rigidbody/__init__.pyi +0 -6
  43. bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
  44. bl_operators/sequencer/__init__.pyi +0 -16
  45. bl_operators/spreadsheet/__init__.pyi +0 -2
  46. bl_operators/userpref/__init__.pyi +0 -50
  47. bl_operators/uvcalc_follow_active/__init__.pyi +1 -3
  48. bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
  49. bl_operators/uvcalc_transform/__init__.pyi +21 -12
  50. bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
  51. bl_operators/view3d/__init__.pyi +0 -16
  52. bl_operators/wm/__init__.pyi +0 -92
  53. bl_operators/world/__init__.pyi +0 -2
  54. bl_ui/__init__.pyi +3 -4
  55. bl_ui/anim/__init__.pyi +0 -2
  56. bl_ui/asset_shelf/__init__.pyi +0 -2
  57. bl_ui/generic_ui_list/__init__.pyi +1 -17
  58. bl_ui/node_add_menu/__init__.pyi +13 -16
  59. bl_ui/node_add_menu_compositor/__init__.pyi +19 -57
  60. bl_ui/node_add_menu_geometry/__init__.pyi +56 -168
  61. bl_ui/node_add_menu_shader/__init__.pyi +10 -30
  62. bl_ui/node_add_menu_texture/__init__.pyi +1 -17
  63. bl_ui/properties_collection/__init__.pyi +0 -14
  64. bl_ui/properties_constraint/__init__.pyi +64 -150
  65. bl_ui/properties_data_armature/__init__.pyi +0 -36
  66. bl_ui/properties_data_bone/__init__.pyi +0 -20
  67. bl_ui/properties_data_camera/__init__.pyi +0 -30
  68. bl_ui/properties_data_curve/__init__.pyi +0 -30
  69. bl_ui/properties_data_curves/__init__.pyi +0 -16
  70. bl_ui/properties_data_empty/__init__.pyi +0 -4
  71. bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
  72. bl_ui/properties_data_lattice/__init__.pyi +0 -8
  73. bl_ui/properties_data_light/__init__.pyi +0 -20
  74. bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
  75. bl_ui/properties_data_mesh/__init__.pyi +0 -42
  76. bl_ui/properties_data_metaball/__init__.pyi +0 -12
  77. bl_ui/properties_data_modifier/__init__.pyi +0 -18
  78. bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
  79. bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
  80. bl_ui/properties_data_speaker/__init__.pyi +0 -12
  81. bl_ui/properties_data_volume/__init__.pyi +0 -18
  82. bl_ui/properties_freestyle/__init__.pyi +0 -50
  83. bl_ui/properties_grease_pencil_common/__init__.pyi +0 -14
  84. bl_ui/properties_mask_common/__init__.pyi +0 -14
  85. bl_ui/properties_material/__init__.pyi +0 -32
  86. bl_ui/properties_material_gpencil/__init__.pyi +0 -22
  87. bl_ui/properties_object/__init__.pyi +35 -42
  88. bl_ui/properties_output/__init__.pyi +0 -40
  89. bl_ui/properties_paint_common/__init__.pyi +23 -7
  90. bl_ui/properties_particle/__init__.pyi +0 -106
  91. bl_ui/properties_physics_cloth/__init__.pyi +0 -28
  92. bl_ui/properties_physics_common/__init__.pyi +0 -2
  93. bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
  94. bl_ui/properties_physics_field/__init__.pyi +0 -20
  95. bl_ui/properties_physics_fluid/__init__.pyi +0 -56
  96. bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
  97. bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
  98. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
  99. bl_ui/properties_physics_softbody/__init__.pyi +0 -30
  100. bl_ui/properties_render/__init__.pyi +0 -90
  101. bl_ui/properties_scene/__init__.pyi +0 -34
  102. bl_ui/properties_strip/__init__.pyi +744 -0
  103. bl_ui/properties_strip_modifier/__init__.pyi +45 -0
  104. bl_ui/properties_texture/__init__.pyi +0 -54
  105. bl_ui/properties_view_layer/__init__.pyi +7 -28
  106. bl_ui/properties_workspace/__init__.pyi +0 -8
  107. bl_ui/properties_world/__init__.pyi +0 -22
  108. bl_ui/space_clip/__init__.pyi +1 -150
  109. bl_ui/space_console/__init__.pyi +0 -12
  110. bl_ui/space_dopesheet/__init__.pyi +52 -60
  111. bl_ui/space_filebrowser/__init__.pyi +0 -60
  112. bl_ui/space_graph/__init__.pyi +0 -44
  113. bl_ui/space_image/__init__.pyi +2 -144
  114. bl_ui/space_info/__init__.pyi +0 -12
  115. bl_ui/space_nla/__init__.pyi +0 -36
  116. bl_ui/space_node/__init__.pyi +27 -66
  117. bl_ui/space_outliner/__init__.pyi +0 -30
  118. bl_ui/space_properties/__init__.pyi +29 -6
  119. bl_ui/space_sequencer/__init__.pyi +46 -912
  120. bl_ui/space_spreadsheet/__init__.pyi +0 -6
  121. bl_ui/space_statusbar/__init__.pyi +0 -2
  122. bl_ui/space_text/__init__.pyi +0 -32
  123. bl_ui/space_time/__init__.pyi +50 -8
  124. bl_ui/space_topbar/__init__.pyi +7 -52
  125. bl_ui/space_userpref/__init__.pyi +7 -188
  126. bl_ui/space_view3d/__init__.pyi +36 -544
  127. bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
  128. bl_ui/space_view3d_toolbar/__init__.pyi +2 -163
  129. blf/__init__.pyi +6 -50
  130. bmesh/__init__.pyi +0 -7
  131. bmesh/geometry/__init__.pyi +0 -3
  132. bmesh/ops/__init__.pyi +2 -450
  133. bmesh/types/__init__.pyi +206 -420
  134. bmesh/utils/__init__.pyi +16 -43
  135. bpy/app/__init__.pyi +53 -56
  136. bpy/app/icons/__init__.pyi +0 -6
  137. bpy/app/timers/__init__.pyi +0 -6
  138. bpy/app/translations/__init__.pyi +1 -16
  139. bpy/msgbus/__init__.pyi +1 -4
  140. bpy/ops/action/__init__.pyi +15 -165
  141. bpy/ops/anim/__init__.pyi +38 -279
  142. bpy/ops/armature/__init__.pyi +18 -192
  143. bpy/ops/asset/__init__.pyi +11 -97
  144. bpy/ops/boid/__init__.pyi +7 -38
  145. bpy/ops/brush/__init__.pyi +3 -72
  146. bpy/ops/buttons/__init__.pyi +4 -71
  147. bpy/ops/cachefile/__init__.pyi +2 -63
  148. bpy/ops/camera/__init__.pyi +0 -11
  149. bpy/ops/clip/__init__.pyi +43 -427
  150. bpy/ops/cloth/__init__.pyi +0 -5
  151. bpy/ops/collection/__init__.pyi +2 -34
  152. bpy/ops/console/__init__.pyi +10 -88
  153. bpy/ops/constraint/__init__.pyi +3 -80
  154. bpy/ops/curve/__init__.pyi +23 -254
  155. bpy/ops/curves/__init__.pyi +17 -166
  156. bpy/ops/cycles/__init__.pyi +1 -14
  157. bpy/ops/dpaint/__init__.pyi +3 -21
  158. bpy/ops/ed/__init__.pyi +10 -82
  159. bpy/ops/export_anim/__init__.pyi +2 -10
  160. bpy/ops/export_scene/__init__.pyi +1 -155
  161. bpy/ops/extensions/__init__.pyi +15 -150
  162. bpy/ops/file/__init__.pyi +27 -217
  163. bpy/ops/fluid/__init__.pyi +13 -70
  164. bpy/ops/font/__init__.pyi +10 -134
  165. bpy/ops/geometry/__init__.pyi +3 -124
  166. bpy/ops/gizmogroup/__init__.pyi +1 -12
  167. bpy/ops/gpencil/__init__.pyi +5 -38
  168. bpy/ops/graph/__init__.pyi +18 -316
  169. bpy/ops/grease_pencil/__init__.pyi +29 -524
  170. bpy/ops/image/__init__.pyi +19 -379
  171. bpy/ops/import_anim/__init__.pyi +2 -16
  172. bpy/ops/import_curve/__init__.pyi +0 -6
  173. bpy/ops/import_scene/__init__.pyi +0 -50
  174. bpy/ops/info/__init__.pyi +4 -35
  175. bpy/ops/lattice/__init__.pyi +3 -33
  176. bpy/ops/marker/__init__.pyi +2 -50
  177. bpy/ops/mask/__init__.pyi +17 -176
  178. bpy/ops/material/__init__.pyi +3 -15
  179. bpy/ops/mball/__init__.pyi +1 -30
  180. bpy/ops/mesh/__init__.pyi +32 -915
  181. bpy/ops/nla/__init__.pyi +20 -184
  182. bpy/ops/node/__init__.pyi +71 -741
  183. bpy/ops/object/__init__.pyi +137 -1254
  184. bpy/ops/outliner/__init__.pyi +47 -327
  185. bpy/ops/paint/__init__.pyi +14 -279
  186. bpy/ops/paintcurve/__init__.pyi +4 -36
  187. bpy/ops/palette/__init__.pyi +3 -27
  188. bpy/ops/particle/__init__.pyi +20 -160
  189. bpy/ops/pointcloud/__init__.pyi +3 -35
  190. bpy/ops/pose/__init__.pyi +28 -233
  191. bpy/ops/poselib/__init__.pyi +4 -47
  192. bpy/ops/preferences/__init__.pyi +9 -177
  193. bpy/ops/ptcache/__init__.pyi +5 -31
  194. bpy/ops/render/__init__.pyi +6 -70
  195. bpy/ops/rigidbody/__init__.pyi +6 -56
  196. bpy/ops/scene/__init__.pyi +22 -167
  197. bpy/ops/screen/__init__.pyi +36 -202
  198. bpy/ops/script/__init__.pyi +1 -12
  199. bpy/ops/sculpt/__init__.pyi +36 -311
  200. bpy/ops/sculpt_curves/__init__.pyi +1 -20
  201. bpy/ops/sequencer/__init__.pyi +90 -662
  202. bpy/ops/sound/__init__.pyi +3 -109
  203. bpy/ops/spreadsheet/__init__.pyi +5 -32
  204. bpy/ops/surface/__init__.pyi +0 -48
  205. bpy/ops/text/__init__.pyi +27 -225
  206. bpy/ops/text_editor/__init__.pyi +0 -5
  207. bpy/ops/texture/__init__.pyi +3 -18
  208. bpy/ops/transform/__init__.pyi +10 -382
  209. bpy/ops/ui/__init__.pyi +21 -158
  210. bpy/ops/uilist/__init__.pyi +0 -13
  211. bpy/ops/uv/__init__.pyi +52 -305
  212. bpy/ops/view2d/__init__.pyi +3 -73
  213. bpy/ops/view3d/__init__.pyi +37 -339
  214. bpy/ops/wm/__init__.pyi +39 -1334
  215. bpy/ops/workspace/__init__.pyi +7 -39
  216. bpy/ops/world/__init__.pyi +2 -10
  217. bpy/path/__init__.pyi +0 -34
  218. bpy/props/__init__.pyi +15 -157
  219. bpy/stub_internal/rna_enums/__init__.pyi +52 -20
  220. bpy/types/__init__.pyi +15386 -56984
  221. bpy/utils/__init__.pyi +4 -75
  222. bpy/utils/previews/__init__.pyi +1 -10
  223. bpy/utils/units/__init__.pyi +0 -12
  224. bpy_extras/anim_utils/__init__.pyi +9 -8
  225. bpy_extras/bmesh_utils/__init__.pyi +0 -1
  226. bpy_extras/id_map_utils/__init__.pyi +14 -6
  227. bpy_extras/image_utils/__init__.pyi +0 -9
  228. bpy_extras/io_utils/__init__.pyi +2 -22
  229. bpy_extras/keyconfig_utils/__init__.pyi +1 -1
  230. bpy_extras/mesh_utils/__init__.pyi +0 -12
  231. bpy_extras/object_utils/__init__.pyi +0 -14
  232. bpy_extras/view3d_utils/__init__.pyi +0 -18
  233. {fake_bpy_module_latest-20251003.dist-info → fake_bpy_module_latest-20260114.dist-info}/METADATA +4 -1
  234. fake_bpy_module_latest-20260114.dist-info/RECORD +382 -0
  235. {fake_bpy_module_latest-20251003.dist-info → fake_bpy_module_latest-20260114.dist-info}/top_level.txt +14 -14
  236. freestyle/chainingiterators/__init__.pyi +0 -22
  237. freestyle/functions/__init__.pyi +0 -139
  238. freestyle/predicates/__init__.pyi +0 -51
  239. freestyle/shaders/__init__.pyi +0 -65
  240. freestyle/types/__init__.pyi +139 -777
  241. freestyle/utils/ContextFunctions/__init__.pyi +0 -23
  242. freestyle/utils/__init__.pyi +1 -7
  243. gpu/capabilities/__init__.pyi +0 -21
  244. gpu/matrix/__init__.pyi +1 -10
  245. gpu/platform/__init__.pyi +0 -5
  246. gpu/shader/__init__.pyi +22 -6
  247. gpu/state/__init__.pyi +59 -38
  248. gpu/texture/__init__.pyi +0 -2
  249. gpu/types/__init__.pyi +84 -152
  250. gpu_extras/batch/__init__.pyi +0 -4
  251. gpu_extras/presets/__init__.pyi +6 -8
  252. idprop/types/__init__.pyi +5 -5
  253. imbuf/__init__.pyi +2 -9
  254. imbuf/types/__init__.pyi +5 -25
  255. keyingsets_builtins/__init__.pyi +1 -45
  256. mathutils/__init__.pyi +82 -2172
  257. mathutils/bvhtree/__init__.pyi +3 -25
  258. mathutils/geometry/__init__.pyi +24 -135
  259. mathutils/interpolate/__init__.pyi +3 -4
  260. mathutils/kdtree/__init__.pyi +0 -11
  261. mathutils/noise/__init__.pyi +0 -62
  262. fake_bpy_module_latest-20251003.dist-info/RECORD +0 -373
  263. {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
  264. {animsys_refactor → _animsys_refactor}/py.typed +0 -0
  265. {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
  266. {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
  267. {bl_console_utils → _bl_console_utils}/py.typed +0 -0
  268. {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +0 -0
  269. {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
  270. {bl_i18n_utils → _bl_i18n_utils}/py.typed +0 -0
  271. {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +0 -0
  272. {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
  273. {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
  274. {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
  275. {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
  276. {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
  277. {bl_previews_utils → _bl_previews_utils}/py.typed +0 -0
  278. {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
  279. {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
  280. {bl_rna_utils → _bl_rna_utils}/py.typed +0 -0
  281. {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
  282. {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
  283. {bl_text_utils → _bl_text_utils}/py.typed +0 -0
  284. {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
  285. {bl_ui_utils → _bl_ui_utils}/py.typed +0 -0
  286. {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
  287. {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
  288. {console_python → _console_python}/__init__.pyi +0 -0
  289. {console_python → _console_python}/py.typed +0 -0
  290. {console_shell → _console_shell}/__init__.pyi +0 -0
  291. {console_shell → _console_shell}/py.typed +0 -0
  292. {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
  293. {graphviz_export → _graphviz_export}/py.typed +0 -0
  294. {keyingsets_utils → _keyingsets_utils}/__init__.pyi +0 -0
  295. {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
  296. {rna_info → _rna_info}/py.typed +0 -0
  297. {rna_xml → _rna_xml}/__init__.pyi +0 -0
  298. {rna_xml → _rna_xml}/py.typed +0 -0
  299. {fake_bpy_module_latest-20251003.dist-info → fake_bpy_module_latest-20260114.dist-info}/WHEEL +0 -0
@@ -19,10 +19,7 @@ def brush_stroke(
19
19
  ) -> None:
20
20
  """Sculpt a stroke into the geometry
21
21
 
22
- :type execution_context: int | str | None
23
- :type undo: bool | None
24
22
  :param stroke: Stroke
25
- :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
26
23
  :param mode: Stroke Mode, Action taken when a paint stroke is made
27
24
 
28
25
  NORMAL
@@ -36,13 +33,9 @@ def brush_stroke(
36
33
 
37
34
  ERASE
38
35
  Erase -- Switch brush to erase mode for duration of stroke.
39
- :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
40
36
  :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
41
- :type pen_flip: bool | None
42
37
  :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
38
  :param ignore_background_click: Ignore Background Click, Clicks on the background do not start the stroke
45
- :type ignore_background_click: bool | None
46
39
  """
47
40
 
48
41
  def cloth_filter(
@@ -67,17 +60,10 @@ def cloth_filter(
67
60
  ) -> None:
68
61
  """Applies a cloth simulation deformation to the entire mesh
69
62
 
70
- :type execution_context: int | str | None
71
- :type undo: bool | None
72
63
  :param start_mouse: Starting Mouse
73
- :type start_mouse: collections.abc.Iterable[int] | None
74
64
  :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
65
  :param strength: Strength, Filter strength
77
- :type strength: float | None
78
66
  :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
67
  :param type: Filter Type, Operation that is going to be applied to the mesh
82
68
 
83
69
  GRAVITY
@@ -94,7 +80,6 @@ def cloth_filter(
94
80
 
95
81
  SCALE
96
82
  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
83
  :param force_axis: Force Axis, Apply the force in the selected axis
99
84
 
100
85
  X
@@ -105,7 +90,6 @@ def cloth_filter(
105
90
 
106
91
  Z
107
92
  Z -- Apply force in the Z axis.
108
- :type force_axis: set[typing.Literal['X','Y','Z']] | None
109
93
  :param orientation: Orientation, Orientation of the axis to limit the filter force
110
94
 
111
95
  LOCAL
@@ -116,15 +100,10 @@ def cloth_filter(
116
100
 
117
101
  VIEW
118
102
  View -- Use the view axis to limit the force and set the gravity direction.
119
- :type orientation: typing.Literal['LOCAL','WORLD','VIEW'] | None
120
103
  :param cloth_mass: Cloth Mass, Mass of each simulation particle
121
- :type cloth_mass: float | None
122
104
  :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
105
+ :param use_face_sets: Use Face Sets, Apply the filter only to the face set under the cursor
126
106
  :param use_collisions: Use Collisions, Collide with other collider objects in the scene
127
- :type use_collisions: bool | None
128
107
  """
129
108
 
130
109
  def color_filter(
@@ -159,17 +138,10 @@ def color_filter(
159
138
  ) -> None:
160
139
  """Applies a filter to modify the active color attribute
161
140
 
162
- :type execution_context: int | str | None
163
- :type undo: bool | None
164
141
  :param start_mouse: Starting Mouse
165
- :type start_mouse: collections.abc.Iterable[int] | None
166
142
  :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
143
  :param strength: Strength, Filter strength
169
- :type strength: float | None
170
144
  :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
145
  :param type: Filter Type
174
146
 
175
147
  FILL
@@ -201,9 +173,7 @@ def color_filter(
201
173
 
202
174
  BLUE
203
175
  Blue -- Change blue channel.
204
- :type type: typing.Literal['FILL','HUE','SATURATION','VALUE','BRIGHTNESS','CONTRAST','SMOOTH','RED','GREEN','BLUE'] | None
205
176
  :param fill_color: Fill Color
206
- :type fill_color: collections.abc.Sequence[float] | mathutils.Color | None
207
177
  """
208
178
 
209
179
  def detail_flood_fill(
@@ -211,33 +181,21 @@ def detail_flood_fill(
211
181
  undo: bool | None = None,
212
182
  /,
213
183
  ) -> 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
- """
184
+ """Flood fill the mesh with the selected detail setting"""
219
185
 
220
186
  def dynamic_topology_toggle(
221
187
  execution_context: int | str | None = None,
222
188
  undo: bool | None = None,
223
189
  /,
224
190
  ) -> None:
225
- """Dynamic topology alters the mesh topology while sculpting
226
-
227
- :type execution_context: int | str | None
228
- :type undo: bool | None
229
- """
191
+ """Dynamic topology alters the mesh topology while sculpting"""
230
192
 
231
193
  def dyntopo_detail_size_edit(
232
194
  execution_context: int | str | None = None,
233
195
  undo: bool | None = None,
234
196
  /,
235
197
  ) -> None:
236
- """Modify the detail size of dyntopo interactively
237
-
238
- :type execution_context: int | str | None
239
- :type undo: bool | None
240
- """
198
+ """Modify the detail size of dyntopo interactively"""
241
199
 
242
200
  def expand(
243
201
  execution_context: int | str | None = None,
@@ -267,28 +225,16 @@ def expand(
267
225
  ) -> None:
268
226
  """Generic sculpt expand operator
269
227
 
270
- :type execution_context: int | str | None
271
- :type undo: bool | None
272
228
  :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
229
  :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
230
  :param invert: Invert, Invert the expand active elements
277
- :type invert: bool | None
278
231
  :param use_mask_preserve: Preserve Previous, Preserve the previous state of the target data
279
- :type use_mask_preserve: bool | None
280
232
  :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
233
+ :param use_modify_active: Modify Active, Modify the active face set instead of creating a new one
284
234
  :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
235
  :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
236
  :param use_auto_mask: Auto Create, Fill in mask if nothing is already masked
289
- :type use_auto_mask: bool | None
290
237
  :param normal_falloff_smooth: Normal Smooth, Blurring steps for normal falloff
291
- :type normal_falloff_smooth: int | None
292
238
  """
293
239
 
294
240
  def face_set_box_gesture(
@@ -305,20 +251,12 @@ def face_set_box_gesture(
305
251
  ) -> None:
306
252
  """Add a face set in a rectangle defined by the cursor
307
253
 
308
- :type execution_context: int | str | None
309
- :type undo: bool | None
310
254
  :param xmin: X Min
311
- :type xmin: int | None
312
255
  :param xmax: X Max
313
- :type xmax: int | None
314
256
  :param ymin: Y Min
315
- :type ymin: int | None
316
257
  :param ymax: Y Max
317
- :type ymax: int | None
318
258
  :param wait_for_input: Wait for Input
319
- :type wait_for_input: bool | None
320
259
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
321
- :type use_front_faces_only: bool | None
322
260
  """
323
261
 
324
262
  def face_set_change_visibility(
@@ -328,21 +266,18 @@ def face_set_change_visibility(
328
266
  *,
329
267
  mode: typing.Literal["TOGGLE", "SHOW_ACTIVE", "HIDE_ACTIVE"] | None = "TOGGLE",
330
268
  ) -> None:
331
- """Change the visibility of the Face Sets of the sculpt
269
+ """Change the visibility of the face sets of the sculpt
332
270
 
333
- :type execution_context: int | str | None
334
- :type undo: bool | None
335
271
  :param mode: Mode
336
272
 
337
273
  TOGGLE
338
- Toggle Visibility -- Hide all Face Sets except for the active one.
274
+ Toggle Visibility -- Hide all face sets except for the active one.
339
275
 
340
276
  SHOW_ACTIVE
341
- Show Active Face Set -- Show Active Face Set.
277
+ Show Active Face Set -- Show the active face set.
342
278
 
343
279
  HIDE_ACTIVE
344
- Hide Active Face Sets -- Hide Active Face Sets.
345
- :type mode: typing.Literal['TOGGLE','SHOW_ACTIVE','HIDE_ACTIVE'] | None
280
+ Hide Active Face Set -- Hide the active face set.
346
281
  """
347
282
 
348
283
  def face_set_edit(
@@ -358,33 +293,27 @@ def face_set_edit(
358
293
  strength: float | None = 1.0,
359
294
  modify_hidden: bool | None = False,
360
295
  ) -> None:
361
- """Edits the current active Face Set
296
+ """Edits the current active face set
362
297
 
363
- :type execution_context: int | str | None
364
- :type undo: bool | None
365
298
  :param active_face_set: Active Face Set
366
- :type active_face_set: int | None
367
299
  :param mode: Mode
368
300
 
369
301
  GROW
370
- Grow Face Set -- Grows the Face Sets boundary by one face based on mesh topology.
302
+ Grow Face Set -- Grows the face set boundary by one face based on mesh topology.
371
303
 
372
304
  SHRINK
373
- Shrink Face Set -- Shrinks the Face Sets boundary by one face based on mesh topology.
305
+ Shrink Face Set -- Shrinks the face set boundary by one face based on mesh topology.
374
306
 
375
307
  DELETE_GEOMETRY
376
- Delete Geometry -- Deletes the faces that are assigned to the Face Set.
308
+ Delete Geometry -- Deletes the faces that are assigned to the face set.
377
309
 
378
310
  FAIR_POSITIONS
379
- Fair Positions -- Creates a smooth as possible geometry patch from the Face Set minimizing changes in vertex positions.
311
+ Fair Positions -- Creates a smooth as possible geometry patch from the face set minimizing changes in vertex positions.
380
312
 
381
313
  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
314
+ Fair Tangency -- Creates a smooth as possible geometry patch from the face set minimizing changes in vertex tangents.
384
315
  :param strength: Strength
385
- :type strength: float | None
386
316
  :param modify_hidden: Modify Hidden, Apply the edit operation to hidden geometry
387
- :type modify_hidden: bool | None
388
317
  """
389
318
 
390
319
  def face_set_extract(
@@ -397,18 +326,12 @@ def face_set_extract(
397
326
  apply_shrinkwrap: bool | None = True,
398
327
  add_solidify: bool | None = True,
399
328
  ) -> None:
400
- """Create a new mesh object from the selected Face Set
329
+ """Create a new mesh object from the selected face set
401
330
 
402
- :type execution_context: int | str | None
403
- :type undo: bool | None
404
331
  :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
332
  :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
407
- :type smooth_iterations: int | None
408
333
  :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
409
- :type apply_shrinkwrap: bool | None
410
334
  :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
411
- :type add_solidify: bool | None
412
335
  """
413
336
 
414
337
  def face_set_lasso_gesture(
@@ -424,18 +347,11 @@ def face_set_lasso_gesture(
424
347
  ) -> None:
425
348
  """Add a face set in a shape defined by the cursor
426
349
 
427
- :type execution_context: int | str | None
428
- :type undo: bool | None
429
350
  :param path: Path
430
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
431
351
  :param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
432
- :type use_smooth_stroke: bool | None
433
352
  :param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
434
- :type smooth_stroke_factor: float | None
435
353
  :param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
436
- :type smooth_stroke_radius: int | None
437
354
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
438
- :type use_front_faces_only: bool | None
439
355
  """
440
356
 
441
357
  def face_set_line_gesture(
@@ -454,24 +370,14 @@ def face_set_line_gesture(
454
370
  ) -> None:
455
371
  """Add a face set to one side of a line defined by the cursor
456
372
 
457
- :type execution_context: int | str | None
458
- :type undo: bool | None
459
373
  :param xstart: X Start
460
- :type xstart: int | None
461
374
  :param xend: X End
462
- :type xend: int | None
463
375
  :param ystart: Y Start
464
- :type ystart: int | None
465
376
  :param yend: Y End
466
- :type yend: int | None
467
377
  :param flip: Flip
468
- :type flip: bool | None
469
378
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
470
- :type cursor: int | None
471
379
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
472
- :type use_front_faces_only: bool | None
473
380
  :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
381
  """
476
382
 
477
383
  def face_set_polyline_gesture(
@@ -484,12 +390,8 @@ def face_set_polyline_gesture(
484
390
  ) -> None:
485
391
  """Add a face set in a shape defined by the cursor
486
392
 
487
- :type execution_context: int | str | None
488
- :type undo: bool | None
489
393
  :param path: Path
490
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
491
394
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
492
- :type use_front_faces_only: bool | None
493
395
  """
494
396
 
495
397
  def face_sets_create(
@@ -499,24 +401,21 @@ def face_sets_create(
499
401
  *,
500
402
  mode: typing.Literal["MASKED", "VISIBLE", "ALL", "SELECTION"] | None = "MASKED",
501
403
  ) -> None:
502
- """Create a new Face Set
404
+ """Create a new face set
503
405
 
504
- :type execution_context: int | str | None
505
- :type undo: bool | None
506
406
  :param mode: Mode
507
407
 
508
408
  MASKED
509
- Face Set from Masked -- Create a new Face Set from the masked faces.
409
+ Face Set from Masked -- Create a new face set from the masked faces.
510
410
 
511
411
  VISIBLE
512
- Face Set from Visible -- Create a new Face Set from the visible vertices.
412
+ Face Set from Visible -- Create a new face set from the visible vertices.
513
413
 
514
414
  ALL
515
- Face Set Full Mesh -- Create an unique Face Set with all faces in the sculpt.
415
+ Face Set Full Mesh -- Create an unique face set with all faces in the sculpt.
516
416
 
517
417
  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
418
+ Face Set from Edit Mode Selection -- Create an face set corresponding to the Edit Mode face selection.
520
419
  """
521
420
 
522
421
  def face_sets_init(
@@ -537,38 +436,34 @@ def face_sets_init(
537
436
  | None = "LOOSE_PARTS",
538
437
  threshold: float | None = 0.5,
539
438
  ) -> None:
540
- """Initializes all Face Sets in the mesh
439
+ """Initializes all face sets in the mesh
541
440
 
542
- :type execution_context: int | str | None
543
- :type undo: bool | None
544
441
  :param mode: Mode
545
442
 
546
443
  LOOSE_PARTS
547
- Face Sets from Loose Parts -- Create a Face Set per loose part in the mesh.
444
+ Face Sets from Loose Parts -- Create a face set per loose part in the mesh.
548
445
 
549
446
  MATERIALS
550
- Face Sets from Material Slots -- Create a Face Set per Material Slot.
447
+ Face Sets from Material Slots -- Create a face set per material slot.
551
448
 
552
449
  NORMALS
553
- Face Sets from Mesh Normals -- Create Face Sets for Faces that have similar normal.
450
+ Face Sets from Mesh Normals -- Create face sets for faces that have similar normal.
554
451
 
555
452
  UV_SEAMS
556
- Face Sets from UV Seams -- Create Face Sets using UV Seams as boundaries.
453
+ Face Sets from UV Seams -- Create face sets using UV seams as boundaries.
557
454
 
558
455
  CREASES
559
- Face Sets from Edge Creases -- Create Face Sets using Edge Creases as boundaries.
456
+ Face Sets from Edge Creases -- Create face sets using edge creases as boundaries.
560
457
 
561
458
  BEVEL_WEIGHT
562
- Face Sets from Bevel Weight -- Create Face Sets using Bevel Weights as boundaries.
459
+ Face Sets from Bevel Weight -- Create face sets using bevel weights as boundaries.
563
460
 
564
461
  SHARP_EDGES
565
- Face Sets from Sharp Edges -- Create Face Sets using Sharp Edges as boundaries.
462
+ Face Sets from Sharp Edges -- Create face sets using sharp edges as boundaries.
566
463
 
567
464
  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
465
+ Face Sets from Face Set Boundaries -- Create a face set per isolated face set.
466
+ :param threshold: Threshold, Minimum value to consider a certain attribute a boundary when creating the face sets
572
467
  """
573
468
 
574
469
  def face_sets_randomize_colors(
@@ -576,11 +471,7 @@ def face_sets_randomize_colors(
576
471
  undo: bool | None = None,
577
472
  /,
578
473
  ) -> 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
- """
474
+ """Generates a new set of random colors to render the face sets in the viewport"""
584
475
 
585
476
  def mask_by_color(
586
477
  execution_context: int | str | None = None,
@@ -595,18 +486,11 @@ def mask_by_color(
595
486
  ) -> None:
596
487
  """Creates a mask based on the active color attribute
597
488
 
598
- :type execution_context: int | str | None
599
- :type undo: bool | None
600
489
  :param contiguous: Contiguous, Mask only contiguous color areas
601
- :type contiguous: bool | None
602
490
  :param invert: Invert, Invert the generated mask
603
- :type invert: bool | None
604
491
  :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
492
  :param threshold: Threshold, How much changes in color affect the mask generation
607
- :type threshold: float | None
608
493
  :param location: Location, Region coordinates of sampling
609
- :type location: collections.abc.Iterable[int] | None
610
494
  """
611
495
 
612
496
  def mask_filter(
@@ -623,14 +507,9 @@ def mask_filter(
623
507
  ) -> None:
624
508
  """Applies a filter to modify the current mask
625
509
 
626
- :type execution_context: int | str | None
627
- :type undo: bool | None
628
510
  :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
511
  :param iterations: Iterations, Number of times that the filter is going to be applied
631
- :type iterations: int | None
632
512
  :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
513
  """
635
514
 
636
515
  def mask_from_boundary(
@@ -647,12 +526,8 @@ def mask_from_boundary(
647
526
  ) -> None:
648
527
  """Creates a mask based on the boundaries of the surface
649
528
 
650
- :type execution_context: int | str | None
651
- :type undo: bool | None
652
529
  :param mix_mode: Mode, Mix mode
653
- :type mix_mode: typing.Literal['MIX','MULTIPLY','DIVIDE','ADD','SUBTRACT'] | None
654
530
  :param mix_factor: Mix Factor
655
- :type mix_factor: float | None
656
531
  :param settings_source: Settings, Use settings from here
657
532
 
658
533
  OPERATOR
@@ -663,7 +538,6 @@ def mask_from_boundary(
663
538
 
664
539
  SCENE
665
540
  Scene -- Use settings from scene.
666
- :type settings_source: typing.Literal['OPERATOR','BRUSH','SCENE'] | None
667
541
  :param boundary_mode: Mode, Boundary type to mask
668
542
 
669
543
  MESH
@@ -671,9 +545,7 @@ def mask_from_boundary(
671
545
 
672
546
  FACE_SETS
673
547
  Face Sets -- Calculate the boundary mask between face sets.
674
- :type boundary_mode: typing.Literal['MESH','FACE_SETS'] | None
675
548
  :param propagation_steps: Propagation Steps
676
- :type propagation_steps: int | None
677
549
  """
678
550
 
679
551
  def mask_from_cavity(
@@ -692,12 +564,8 @@ def mask_from_cavity(
692
564
  ) -> None:
693
565
  """Creates a mask based on the curvature of the surface
694
566
 
695
- :type execution_context: int | str | None
696
- :type undo: bool | None
697
567
  :param mix_mode: Mode, Mix mode
698
- :type mix_mode: typing.Literal['MIX','MULTIPLY','DIVIDE','ADD','SUBTRACT'] | None
699
568
  :param mix_factor: Mix Factor
700
- :type mix_factor: float | None
701
569
  :param settings_source: Settings, Use settings from here
702
570
 
703
571
  OPERATOR
@@ -708,15 +576,10 @@ def mask_from_cavity(
708
576
 
709
577
  SCENE
710
578
  Scene -- Use settings from scene.
711
- :type settings_source: typing.Literal['OPERATOR','BRUSH','SCENE'] | None
712
579
  :param factor: Factor, The contrast of the cavity mask
713
- :type factor: float | None
714
580
  :param blur_steps: Blur, The number of times the cavity mask is blurred
715
- :type blur_steps: int | None
716
581
  :param use_curve: Custom Curve
717
- :type use_curve: bool | None
718
582
  :param invert: Cavity (Inverted)
719
- :type invert: bool | None
720
583
  """
721
584
 
722
585
  def mask_init(
@@ -731,10 +594,7 @@ def mask_init(
731
594
  ) -> None:
732
595
  """Creates a new mask for the entire mesh
733
596
 
734
- :type execution_context: int | str | None
735
- :type undo: bool | None
736
597
  :param mode: Mode
737
- :type mode: typing.Literal['RANDOM_PER_VERTEX','RANDOM_PER_FACE_SET','RANDOM_PER_LOOSE_PART'] | None
738
598
  """
739
599
 
740
600
  def mesh_filter(
@@ -772,17 +632,10 @@ def mesh_filter(
772
632
  ) -> None:
773
633
  """Applies a filter to modify the current mesh
774
634
 
775
- :type execution_context: int | str | None
776
- :type undo: bool | None
777
635
  :param start_mouse: Starting Mouse
778
- :type start_mouse: collections.abc.Iterable[int] | None
779
636
  :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
637
  :param strength: Strength, Filter strength
782
- :type strength: float | None
783
638
  :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
639
  :param type: Filter Type, Operation that is going to be applied to the mesh
787
640
 
788
641
  SMOOTH
@@ -804,7 +657,7 @@ def mesh_filter(
804
657
  Relax -- Relax mesh.
805
658
 
806
659
  RELAX_FACE_SETS
807
- Relax Face Sets -- Smooth the edges of all the Face Sets.
660
+ Relax Face Sets -- Smooth the edges of all the face sets.
808
661
 
809
662
  SURFACE_SMOOTH
810
663
  Surface Smooth -- Smooth the surface of the mesh, preserving the volume.
@@ -817,7 +670,6 @@ def mesh_filter(
817
670
 
818
671
  ERASE_DISPLACEMENT
819
672
  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
673
  :param deform_axis: Deform Axis, Apply the deformation in the selected axis
822
674
 
823
675
  X
@@ -828,7 +680,6 @@ def mesh_filter(
828
680
 
829
681
  Z
830
682
  Z -- Deform in the Z axis.
831
- :type deform_axis: set[typing.Literal['X','Y','Z']] | None
832
683
  :param orientation: Orientation, Orientation of the axis to limit the filter displacement
833
684
 
834
685
  LOCAL
@@ -839,17 +690,11 @@ def mesh_filter(
839
690
 
840
691
  VIEW
841
692
  View -- Use the view axis to limit the displacement.
842
- :type orientation: typing.Literal['LOCAL','WORLD','VIEW'] | None
843
693
  :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
694
  :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
695
  :param sharpen_smooth_ratio: Smooth Ratio, How much smoothing is applied to polished surfaces
848
- :type sharpen_smooth_ratio: float | None
849
696
  :param sharpen_intensify_detail_strength: Intensify Details, How much creases and valleys are intensified
850
- :type sharpen_intensify_detail_strength: float | None
851
697
  :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
698
  """
854
699
 
855
700
  def optimize(
@@ -857,11 +702,7 @@ def optimize(
857
702
  undo: bool | None = None,
858
703
  /,
859
704
  ) -> None:
860
- """Recalculate the sculpt BVH to improve performance
861
-
862
- :type execution_context: int | str | None
863
- :type undo: bool | None
864
- """
705
+ """Recalculate the sculpt BVH to improve performance"""
865
706
 
866
707
  def paint_mask_extract(
867
708
  execution_context: int | str | None = None,
@@ -876,18 +717,11 @@ def paint_mask_extract(
876
717
  ) -> None:
877
718
  """Create a new mesh object from the current paint mask
878
719
 
879
- :type execution_context: int | str | None
880
- :type undo: bool | None
881
720
  :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
721
  :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
722
  :param smooth_iterations: Smooth Iterations, Smooth iterations applied to the extracted mesh
886
- :type smooth_iterations: int | None
887
723
  :param apply_shrinkwrap: Project to Sculpt, Project the extracted mesh into the original sculpt
888
- :type apply_shrinkwrap: bool | None
889
724
  :param add_solidify: Extract as Solid, Extract the mask as a solid object with a solidify modifier
890
- :type add_solidify: bool | None
891
725
  """
892
726
 
893
727
  def paint_mask_slice(
@@ -901,14 +735,9 @@ def paint_mask_slice(
901
735
  ) -> None:
902
736
  """Slices the paint mask from the mesh
903
737
 
904
- :type execution_context: int | str | None
905
- :type undo: bool | None
906
738
  :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
739
  :param fill_holes: Fill Holes, Fill holes after slicing the mask
909
- :type fill_holes: bool | None
910
740
  :param new_object: Slice to New Object, Create a new object from the sliced mask
911
- :type new_object: bool | None
912
741
  """
913
742
 
914
743
  def project_line_gesture(
@@ -927,35 +756,14 @@ def project_line_gesture(
927
756
  ) -> None:
928
757
  """Project the geometry onto a plane defined by a line
929
758
 
930
- :type execution_context: int | str | None
931
- :type undo: bool | None
932
759
  :param xstart: X Start
933
- :type xstart: int | None
934
760
  :param xend: X End
935
- :type xend: int | None
936
761
  :param ystart: Y Start
937
- :type ystart: int | None
938
762
  :param yend: Y End
939
- :type yend: int | None
940
763
  :param flip: Flip
941
- :type flip: bool | None
942
764
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
943
- :type cursor: int | None
944
765
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
945
- :type use_front_faces_only: bool | None
946
766
  :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
767
  """
960
768
 
961
769
  def sample_detail_size(
@@ -968,10 +776,7 @@ def sample_detail_size(
968
776
  ) -> None:
969
777
  """Sample the mesh detail on clicked point
970
778
 
971
- :type execution_context: int | str | None
972
- :type undo: bool | None
973
779
  :param location: Location, Screen coordinates of sampling
974
- :type location: collections.abc.Iterable[int] | None
975
780
  :param mode: Detail Mode, Target sculpting workflow that is going to use the sampled size
976
781
 
977
782
  DYNTOPO
@@ -979,7 +784,6 @@ def sample_detail_size(
979
784
 
980
785
  VOXEL
981
786
  Voxel -- Sample mesh voxel size.
982
- :type mode: typing.Literal['DYNTOPO','VOXEL'] | None
983
787
  """
984
788
 
985
789
  def sculptmode_toggle(
@@ -987,22 +791,14 @@ def sculptmode_toggle(
987
791
  undo: bool | None = None,
988
792
  /,
989
793
  ) -> None:
990
- """Toggle sculpt mode in 3D view
991
-
992
- :type execution_context: int | str | None
993
- :type undo: bool | None
994
- """
794
+ """Toggle sculpt mode in 3D view"""
995
795
 
996
796
  def set_persistent_base(
997
797
  execution_context: int | str | None = None,
998
798
  undo: bool | None = None,
999
799
  /,
1000
800
  ) -> 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
- """
801
+ """Reset the copy of the mesh that is being sculpted on"""
1006
802
 
1007
803
  def set_pivot_position(
1008
804
  execution_context: int | str | None = None,
@@ -1016,8 +812,6 @@ def set_pivot_position(
1016
812
  ) -> None:
1017
813
  """Sets the sculpt transform pivot position
1018
814
 
1019
- :type execution_context: int | str | None
1020
- :type undo: bool | None
1021
815
  :param mode: Mode
1022
816
 
1023
817
  ORIGIN
@@ -1034,11 +828,8 @@ def set_pivot_position(
1034
828
 
1035
829
  SURFACE
1036
830
  Surface -- Sets the pivot position to the surface under the cursor.
1037
- :type mode: typing.Literal['ORIGIN','UNMASKED','BORDER','ACTIVE','SURFACE'] | None
1038
831
  :param mouse_x: Mouse Position X, Position of the mouse used for "Surface" and "Active Vertex" mode
1039
- :type mouse_x: float | None
1040
832
  :param mouse_y: Mouse Position Y, Position of the mouse used for "Surface" and "Active Vertex" mode
1041
- :type mouse_y: float | None
1042
833
  """
1043
834
 
1044
835
  def symmetrize(
@@ -1050,10 +841,7 @@ def symmetrize(
1050
841
  ) -> None:
1051
842
  """Symmetrize the topology modifications
1052
843
 
1053
- :type execution_context: int | str | None
1054
- :type undo: bool | None
1055
844
  :param merge_tolerance: Merge Distance, Distance within which symmetrical vertices are merged
1056
- :type merge_tolerance: float | None
1057
845
  """
1058
846
 
1059
847
  def trim_box_gesture(
@@ -1076,22 +864,13 @@ def trim_box_gesture(
1076
864
  ) -> None:
1077
865
  """Execute a boolean operation on the mesh and a rectangle defined by the cursor
1078
866
 
1079
- :type execution_context: int | str | None
1080
- :type undo: bool | None
1081
867
  :param xmin: X Min
1082
- :type xmin: int | None
1083
868
  :param xmax: X Max
1084
- :type xmax: int | None
1085
869
  :param ymin: Y Min
1086
- :type ymin: int | None
1087
870
  :param ymax: Y Max
1088
- :type ymax: int | None
1089
871
  :param wait_for_input: Wait for Input
1090
- :type wait_for_input: bool | None
1091
872
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1092
- :type use_front_faces_only: bool | None
1093
873
  :param location: Location, Mouse location
1094
- :type location: collections.abc.Iterable[int] | None
1095
874
  :param trim_mode: Trim Mode
1096
875
 
1097
876
  DIFFERENCE
@@ -1102,9 +881,7 @@ def trim_box_gesture(
1102
881
 
1103
882
  JOIN
1104
883
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1105
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1106
884
  :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
885
  :param trim_orientation: Shape Orientation
1109
886
 
1110
887
  VIEW
@@ -1112,7 +889,6 @@ def trim_box_gesture(
1112
889
 
1113
890
  SURFACE
1114
891
  Surface -- Use the surface normal to orientate the trimming shape.
1115
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1116
892
  :param trim_extrude_mode: Extrude Mode
1117
893
 
1118
894
  PROJECT
@@ -1120,7 +896,6 @@ def trim_box_gesture(
1120
896
 
1121
897
  FIXED
1122
898
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1123
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1124
899
  :param trim_solver: Solver
1125
900
 
1126
901
  EXACT
@@ -1131,7 +906,6 @@ def trim_box_gesture(
1131
906
 
1132
907
  MANIFOLD
1133
908
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1134
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1135
909
  """
1136
910
 
1137
911
  def trim_lasso_gesture(
@@ -1153,20 +927,12 @@ def trim_lasso_gesture(
1153
927
  ) -> None:
1154
928
  """Execute a boolean operation on the mesh and a shape defined by the cursor
1155
929
 
1156
- :type execution_context: int | str | None
1157
- :type undo: bool | None
1158
930
  :param path: Path
1159
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
1160
931
  :param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
1161
- :type use_smooth_stroke: bool | None
1162
932
  :param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
1163
- :type smooth_stroke_factor: float | None
1164
933
  :param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
1165
- :type smooth_stroke_radius: int | None
1166
934
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1167
- :type use_front_faces_only: bool | None
1168
935
  :param location: Location, Mouse location
1169
- :type location: collections.abc.Iterable[int] | None
1170
936
  :param trim_mode: Trim Mode
1171
937
 
1172
938
  DIFFERENCE
@@ -1177,9 +943,7 @@ def trim_lasso_gesture(
1177
943
 
1178
944
  JOIN
1179
945
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1180
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1181
946
  :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
947
  :param trim_orientation: Shape Orientation
1184
948
 
1185
949
  VIEW
@@ -1187,7 +951,6 @@ def trim_lasso_gesture(
1187
951
 
1188
952
  SURFACE
1189
953
  Surface -- Use the surface normal to orientate the trimming shape.
1190
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1191
954
  :param trim_extrude_mode: Extrude Mode
1192
955
 
1193
956
  PROJECT
@@ -1195,7 +958,6 @@ def trim_lasso_gesture(
1195
958
 
1196
959
  FIXED
1197
960
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1198
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1199
961
  :param trim_solver: Solver
1200
962
 
1201
963
  EXACT
@@ -1206,7 +968,6 @@ def trim_lasso_gesture(
1206
968
 
1207
969
  MANIFOLD
1208
970
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1209
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1210
971
  """
1211
972
 
1212
973
  def trim_line_gesture(
@@ -1231,26 +992,15 @@ def trim_line_gesture(
1231
992
  ) -> None:
1232
993
  """Remove a portion of the mesh on one side of a line
1233
994
 
1234
- :type execution_context: int | str | None
1235
- :type undo: bool | None
1236
995
  :param xstart: X Start
1237
- :type xstart: int | None
1238
996
  :param xend: X End
1239
- :type xend: int | None
1240
997
  :param ystart: Y Start
1241
- :type ystart: int | None
1242
998
  :param yend: Y End
1243
- :type yend: int | None
1244
999
  :param flip: Flip
1245
- :type flip: bool | None
1246
1000
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
1247
- :type cursor: int | None
1248
1001
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1249
- :type use_front_faces_only: bool | None
1250
1002
  :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
1003
  :param location: Location, Mouse location
1253
- :type location: collections.abc.Iterable[int] | None
1254
1004
  :param trim_mode: Trim Mode
1255
1005
 
1256
1006
  DIFFERENCE
@@ -1261,9 +1011,7 @@ def trim_line_gesture(
1261
1011
 
1262
1012
  JOIN
1263
1013
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1264
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1265
1014
  :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
1015
  :param trim_orientation: Shape Orientation
1268
1016
 
1269
1017
  VIEW
@@ -1271,7 +1019,6 @@ def trim_line_gesture(
1271
1019
 
1272
1020
  SURFACE
1273
1021
  Surface -- Use the surface normal to orientate the trimming shape.
1274
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1275
1022
  :param trim_extrude_mode: Extrude Mode
1276
1023
 
1277
1024
  PROJECT
@@ -1279,7 +1026,6 @@ def trim_line_gesture(
1279
1026
 
1280
1027
  FIXED
1281
1028
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1282
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1283
1029
  :param trim_solver: Solver
1284
1030
 
1285
1031
  EXACT
@@ -1290,7 +1036,6 @@ def trim_line_gesture(
1290
1036
 
1291
1037
  MANIFOLD
1292
1038
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1293
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1294
1039
  """
1295
1040
 
1296
1041
  def trim_polyline_gesture(
@@ -1309,14 +1054,9 @@ def trim_polyline_gesture(
1309
1054
  ) -> None:
1310
1055
  """Execute a boolean operation on the mesh and a polygonal shape defined by the cursor
1311
1056
 
1312
- :type execution_context: int | str | None
1313
- :type undo: bool | None
1314
1057
  :param path: Path
1315
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
1316
1058
  :param use_front_faces_only: Front Faces Only, Affect only faces facing towards the view
1317
- :type use_front_faces_only: bool | None
1318
1059
  :param location: Location, Mouse location
1319
- :type location: collections.abc.Iterable[int] | None
1320
1060
  :param trim_mode: Trim Mode
1321
1061
 
1322
1062
  DIFFERENCE
@@ -1327,9 +1067,7 @@ def trim_polyline_gesture(
1327
1067
 
1328
1068
  JOIN
1329
1069
  Join -- Join the new mesh as separate geometry, without performing any boolean operation.
1330
- :type trim_mode: typing.Literal['DIFFERENCE','UNION','JOIN'] | None
1331
1070
  :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
1071
  :param trim_orientation: Shape Orientation
1334
1072
 
1335
1073
  VIEW
@@ -1337,7 +1075,6 @@ def trim_polyline_gesture(
1337
1075
 
1338
1076
  SURFACE
1339
1077
  Surface -- Use the surface normal to orientate the trimming shape.
1340
- :type trim_orientation: typing.Literal['VIEW','SURFACE'] | None
1341
1078
  :param trim_extrude_mode: Extrude Mode
1342
1079
 
1343
1080
  PROJECT
@@ -1345,7 +1082,6 @@ def trim_polyline_gesture(
1345
1082
 
1346
1083
  FIXED
1347
1084
  Fixed -- Align trim geometry orthogonally for a shape with 90 degree angles.
1348
- :type trim_extrude_mode: typing.Literal['PROJECT','FIXED'] | None
1349
1085
  :param trim_solver: Solver
1350
1086
 
1351
1087
  EXACT
@@ -1356,7 +1092,6 @@ def trim_polyline_gesture(
1356
1092
 
1357
1093
  MANIFOLD
1358
1094
  Manifold -- Fastest solver that works only on manifold meshes but gives better results.
1359
- :type trim_solver: typing.Literal['EXACT','FLOAT','MANIFOLD'] | None
1360
1095
  """
1361
1096
 
1362
1097
  def uv_sculpt_grab(
@@ -1368,10 +1103,7 @@ def uv_sculpt_grab(
1368
1103
  ) -> None:
1369
1104
  """Grab UVs
1370
1105
 
1371
- :type execution_context: int | str | None
1372
- :type undo: bool | None
1373
1106
  :param use_invert: Invert, Invert action for the duration of the stroke
1374
- :type use_invert: bool | None
1375
1107
  """
1376
1108
 
1377
1109
  def uv_sculpt_pinch(
@@ -1383,10 +1115,7 @@ def uv_sculpt_pinch(
1383
1115
  ) -> None:
1384
1116
  """Pinch UVs
1385
1117
 
1386
- :type execution_context: int | str | None
1387
- :type undo: bool | None
1388
1118
  :param use_invert: Invert, Invert action for the duration of the stroke
1389
- :type use_invert: bool | None
1390
1119
  """
1391
1120
 
1392
1121
  def uv_sculpt_relax(
@@ -1399,10 +1128,7 @@ def uv_sculpt_relax(
1399
1128
  ) -> None:
1400
1129
  """Relax UVs
1401
1130
 
1402
- :type execution_context: int | str | None
1403
- :type undo: bool | None
1404
1131
  :param use_invert: Invert, Invert action for the duration of the stroke
1405
- :type use_invert: bool | None
1406
1132
  :param relax_method: Relax Method, Algorithm used for UV relaxation
1407
1133
 
1408
1134
  LAPLACIAN
@@ -1413,5 +1139,4 @@ def uv_sculpt_relax(
1413
1139
 
1414
1140
  COTAN
1415
1141
  Geometry -- Use Geometry (cotangent) relaxation, making UVs follow the underlying 3D geometry.
1416
- :type relax_method: typing.Literal['LAPLACIAN','HC','COTAN'] | None
1417
1142
  """