[Bf-docboard-svn] bf-manual: [9675] trunk/blender_docs/manual/sculpt_paint/sculpting: Adds missing and new documentation about auto-maskign features.
Julien Kaspar
noreply at blender.org
Thu Nov 3 10:10:37 CET 2022
Revision: 9675
https://developer.blender.org/rBM9675
Author: JulienKaspar
Date: 2022-11-03 10:10:37 +0100 (Thu, 03 Nov 2022)
Log Message:
-----------
Adds missing and new documentation about auto-maskign features.
More info in D16329.
Modified Paths:
--------------
trunk/blender_docs/manual/sculpt_paint/sculpting/controls.rst
trunk/blender_docs/manual/sculpt_paint/sculpting/editing/mask.rst
trunk/blender_docs/manual/sculpt_paint/sculpting/tool_settings/brush_settings.rst
Modified: trunk/blender_docs/manual/sculpt_paint/sculpting/controls.rst
===================================================================
--- trunk/blender_docs/manual/sculpt_paint/sculpting/controls.rst 2022-11-03 08:47:27 UTC (rev 9674)
+++ trunk/blender_docs/manual/sculpt_paint/sculpting/controls.rst 2022-11-03 09:10:37 UTC (rev 9675)
@@ -10,33 +10,93 @@
:Mode: Sculpt Mode
:Tool: :menuselection:`Header --> Auto-Masking`
+ :Shortcut: :kbd:`Alt-A`
These properties automatically mask geometry based on geometric features of the mesh.
+It's an quick alternative to frequent manual masking.
+These masks are initialized on every new stroke or tool usage. They are also never visible as an overlay.
+
Note, these properties are applied across all sculpt brushes, however, they can also be configured
per brush in the :ref:`Advanced Brush Settings <sculpt-tool-settings-brush-settings-advanced>`.
+
These properties can be accessed via a :ref:`bpy.types.UIPieMenu` by pressing :kbd:`Alt-A`.
+All auto-masking modes can be combined, which makes the generated auto-mask more specific.
+For example it's possible to auto-mask a specific face set, while excluding disconnected topology and face set boundaries,
+and only affect faces that are oriented towards the view via View Normal.
+
.. _bpy.types.Sculpt.use_automasking_topology:
Topology
- Brush affects only vertices connected to the active vertex under the brush.
+ Only vertices that are topologically connected to where you started the stroke/tool on are affected. So loose geometry islands will be auto-masked.
+ Additionally for the :doc:`Grab </sculpt_paint/sculpting/tools/grab>` and :doc:`Thumb </sculpt_paint/sculpting/tools/thumb>` brushes, anything that is not connected within the brush radius will be auto-masked.
+ So even if geometry is connected somewhere, it is considered separate if the connection is not within the radius.
+
.. _bpy.types.Sculpt.use_automasking_face_sets:
Face Sets
- Affect only vertices that share face sets with active vertex.
+ Only vertices that are part of the same face set that you started the stroke/tool on are affected.
+.. tip::
+ If no topology or face set is visible under the curser at the start of the stroke, the previously auto-masked area will be targeted.
+ This is especially useful with the "Projected" falloff shape in the :doc:`Falloff Settings </sculpt_paint/brush/falloff>`.
+
.. _bpy.types.Sculpt.use_automasking_boundary_edges:
Mesh Boundary
- Does not affect non-manifold boundary edges.
+ Vertices that are part of open boundary edges are not affected. This also includes boundary edges to hidden faces.
+ Propagation Steps
+ Increases the soft gradient towards the auto-masked boundary edges. Each step iterates the distance one edge further.
+ This setting is used for for both Mesh Boundary and Face Sets Boundary. It is also currently stored per brush.
+
.. _bpy.types.Sculpt.use_automasking_boundary_face_sets:
+.. _bpy.types.Brush.automasking_boundary_edges_propagation_steps:
Face Sets Boundary
- Does not affect vertices which belong to a face set boundary.
+ Vertices that are part of a boundary between face sets are not affected. This also includes boundary edges to hidden faces.
+ Propagation Steps are shared with Mesh Boundary auto-masking.
-.. _bpy.types.Brush.automasking_boundary_edges_propagation_steps:
+Cavity
+ Vertices that are the peaks of the surface curvature are not affected. While this auto-mask is primarily meant for painting,
+ it can also be used for regular sculpting.
-Propagation Steps
- The distance where *Mesh Boundary Auto-Masking* is going to protect vertices from the fully masked edge.
+ Factor
+ The overall contrast of how strong the cavity is applied. The value of 0.5 is the default, but better results can also be achieved on 0.2
+ if a Custom Curve is used as well.
+ Blur
+ The number of times the cavity mask is blurred. A value of 0 will give the pure cavity auto-mask. Anything higher than 6 will likely have
+ a less visible effect and decrease performance.
+ Even though the value is capped to 10, it can be increased up to 25 if typing in the value.
+ Custom Curve
+ Use a custom curve to fine tweak the cavity auto-mask. This is very useful if only small crevices or flat surfaces should be affected.
+ Or for example if the contrast should be increased/decreased in a specific way.
+ Create Mask
+ This will execute the `Mask From Cavity`_ operator with the current auto-masking settings. This is very useful to visualize the current auto-mask,
+ or to edit the mask further manually.
+
+Cavity (Inverted)
+ This is the same as "Cavity", but inverted. This means the valleys/crevices of the surface curvature will not be affected.
+ It cannot be used at the same time as Cavity and shares all of its settings.
+ Enable this to quickly invert the cavity auto-mask.
+
+View Normal
+ Only vertices with a :term:`Normal` that face the viewer are affected.
+ This is similar to the "Front Faces Only" toggle in the :doc:`Brush Setting </sculpt_paint/sculpting/tool_settings/brush_settings>`,
+ to only affect visible geometry.
+ The advantage of this auto-mask is that it has more options and works on sculpt mode as a whole.
+
+ Occlusion
+ Change the View Normal behavior to only affect vertices that are not occluded by other faces.
+ This setting is incompatible with the other Limit and Falloff sliders.
+ It also causes a much slower performance.
+ Limit
+ Determines the range of angles that will be affected. 90 degrees encompasses all that is visible.
+ Falloff
+ Extends the angular range of the Limit slider with a soft falloff gradient. This falloff will visually extend the limit range further.
+
+Area Normal
+ Very similar to the View Normal, but uses the Normal of the surface that you started the stroke/tool on.
+ This way any direction can be chosen for what vertices will be affected.
+ It has the same Limit and Falloff sliders as the View Normal auto-mask.
\ No newline at end of file
Modified: trunk/blender_docs/manual/sculpt_paint/sculpting/editing/mask.rst
===================================================================
--- trunk/blender_docs/manual/sculpt_paint/sculpting/editing/mask.rst 2022-11-03 08:47:27 UTC (rev 9674)
+++ trunk/blender_docs/manual/sculpt_paint/sculpting/editing/mask.rst 2022-11-03 09:10:37 UTC (rev 9675)
@@ -25,6 +25,7 @@
:Mode: Sculpt Mode
:Menu: :menuselection:`Mask`
+ :Shortcut: :kbd:`A`
Masks can be edited across the entire model.
Using :kbd:`A` opens a pie menu to choose different operations.
@@ -274,7 +275,7 @@
.. _bpy.ops.sculpt.dirty_mask:
-Dirty Mask
+Mask From Cavity
----------
.. reference::
@@ -282,9 +283,25 @@
:Mode: Sculpt Mode
:Menu: :menuselection:`Mask --> Dirty Mask`
-Generates a mask based on the geometry cavity and pointiness.
+Generates a mask based on the cavity of the surface. The settings of the operation can be changed
+in the :doc:`Adjust Last Operation </interface/undo_redo>` panel.
+Mode
+ Choose how the newly created mask is mixed with the existing one. By default it will replace the old mask via "Mix".
+Mix Factor
+ The factor of the mix effect. Choose how strong the new mask is applied on the existing one.
+Automask Settings
+ The same settings as the :doc:`Auto-Masking </sculpt_paint/sculpting/controls>` settings are applied.
+Factor
+ Same as :doc:`Auto-Masking </sculpt_paint/sculpting/controls>`.
+Blur
+ Same as :doc:`Auto-Masking </sculpt_paint/sculpting/controls>`.
+Invert
+ Same as :doc:`Auto-Masking </sculpt_paint/sculpting/controls>`.
+Custom Curve
+ Same as :doc:`Auto-Masking </sculpt_paint/sculpting/controls>`.
+
.. _bpy.ops.sculpt.mask_init:
Random Mask
Modified: trunk/blender_docs/manual/sculpt_paint/sculpting/tool_settings/brush_settings.rst
===================================================================
--- trunk/blender_docs/manual/sculpt_paint/sculpting/tool_settings/brush_settings.rst 2022-11-03 08:47:27 UTC (rev 9674)
+++ trunk/blender_docs/manual/sculpt_paint/sculpting/tool_settings/brush_settings.rst 2022-11-03 09:10:37 UTC (rev 9675)
@@ -95,29 +95,16 @@
========
.. _bpy.types.Brush.use_automasking_topology:
-
-Topology
- Setting per each brush, affects only vertices connected to the active vertex under the brush.
- This can be used for isolating disconnected meshes, face sets, masking cavities,
- mesh boundary edges, or creating topological falloffs.
-
.. _bpy.types.Brush.use_automasking_face_sets:
-
-Face Sets
- Affect only vertices that share face sets with active vertex.
-
.. _bpy.types.Brush.use_automasking_boundary_edges:
-
-Mesh Boundary
- Does not affect non-manifold boundary edges.
-
.. _bpy.types.Brush.use_automasking_boundary_face_sets:
-Face Sets Boundary
- Does not affect vertices which belong to a face set boundary.
+Auto-Masking
+ The auto-masking toggles in the brush settings are the same as the sculpt mode auto-masking settings.
+ The difference is that these toggles can be customized per brush to create specific brush behaviors.
-Propagation Steps
- The distance where *Mesh Boundary Auto-Masking* is going to protect vertices from the fully masked edge.
+.. seealso:: Auto-Masking
+ For more information on the Auto-Masking toggles, see :doc:`Auto-Masking </sculpt_paint/sculpting/controls>`.
.. _bpy.types.Brush.sculpt_plane:
More information about the Bf-docboard-svn
mailing list