[Bf-docboard-svn] bf-manual: [7579] trunk/blender_docs/manual: Cleanup: Add vertex clean properties

[Aaron Carlisle]

Revision: 7579
          https://developer.blender.org/rBM7579
Author:   Blendify
Date:     2021-01-12 22:18:21 +0100 (Tue, 12 Jan 2021)
Log Message:
-----------
Cleanup: Add vertex clean properties

Modified Paths:
--------------
    trunk/blender_docs/manual/scene_layout/object/editing/cleanup.rst
    trunk/blender_docs/manual/sculpt_paint/weight_paint/editing.rst

Modified: trunk/blender_docs/manual/scene_layout/object/editing/cleanup.rst
===================================================================
--- trunk/blender_docs/manual/scene_layout/object/editing/cleanup.rst	2021-01-12 21:12:58 UTC (rev 7578)
+++ trunk/blender_docs/manual/scene_layout/object/editing/cleanup.rst	2021-01-12 21:18:21 UTC (rev 7579)
@@ -12,9 +12,34 @@
    :Mode:      Object Mode
    :Menu:      :menuselection:`Object --> Clean Up --> Clean Vertex Group Weights`
 
-Removes :doc:`Vertex Group </modeling/meshes/properties/vertex_groups/index>` assignments which are not required.
+Clean Vertex Group Weights unassigns vertices from
+:doc:`Vertex Groups </modeling/meshes/properties/vertex_groups/index>`
+whose weights are below the *Limit*.  Removes weights below a given threshold.
+This tool is useful for clearing your weight groups of very low (or zero) weights.
 
+In the example shown, a cutoff value of 0.2 is used (see operator options below)
+so all blue parts are cleaned out.
 
+Note, the images use the *Show Zero weights* Active option
+so that unreferenced Weights are shown in Black.
+
+.. figure:: /images/sculpt-paint_weight-paint_editing_clean-example.png
+
+   Clean example.
+
+Subset
+   Restrict the tool to a subset.
+   See above :ref:`The Subset Option <sculpt-paint_weight-paint_editing_subset>` for how subsets are defined.
+Limit
+   This is the minimum weight value that will be kept in the group.
+   Weights below this value will be removed from the group.
+Keep Single
+   Ensure that the *Clean Vertex Group Weights* tool will not create completely unreferenced vertices
+   (vertices which are not assigned to any vertex group), so each vertex will
+   keep at least one weight, even if it is below the limit value!
+
+
+
 Limit Total Vertex Groups
 =========================
 
@@ -24,9 +49,20 @@
    :Mode:      Object Mode
    :Menu:      :menuselection:`Object --> Clean Up --> Limit Total Vertex Groups`
 
-Limits deform weights associated with a vertex to a specific number by removing lowest weights.
+Reduce the number of weight groups per vertex to the specified Limit.
+The tool removes lowest weights first until the limit is reached.
 
+.. hint::
 
+   The tool can only work reasonably when more than one weight group is selected.
+
+Subset
+   Restrict the tool to a subset.
+   See above :ref:`The Subset Option <sculpt-paint_weight-paint_editing_subset>` for how subsets are defined.
+Limit
+   Maximum number of weights allowed on each vertex.
+
+
 .. _bpy.ops.object.material_slot_remove_unused:
 
 Remove Unused Material Slots

Modified: trunk/blender_docs/manual/sculpt_paint/weight_paint/editing.rst
===================================================================
--- trunk/blender_docs/manual/sculpt_paint/weight_paint/editing.rst	2021-01-12 21:12:58 UTC (rev 7578)
+++ trunk/blender_docs/manual/sculpt_paint/weight_paint/editing.rst	2021-01-12 21:18:21 UTC (rev 7579)
@@ -159,7 +159,9 @@
 Clean
 =====
 
-Removes weights below a given threshold.
+Clean Vertex Group Weights unassigns vertices from
+:doc:`Vertex Groups </modeling/meshes/properties/vertex_groups/index>`
+whose weights are below the *Limit*.  Removes weights below a given threshold.
 This tool is useful for clearing your weight groups of very low (or zero) weights.
 
 In the example shown, a cutoff value of 0.2 is used (see operator options below)