Changeset View
Changeset View
Standalone View
Standalone View
manual/sculpt_paint/sculpting/editing/mask.rst
| .. _sculpt-mask-menu: | .. _sculpt-mask-menu: | ||||
| .. _bpy.ops.paint.mask: | .. _bpy.ops.paint.mask: | ||||
| **** | **** | ||||
| Mask | Mask | ||||
| **** | **** | ||||
| Masking to control which areas of the mesh are influenced by sculpting. | This page details the mask related hotkey operators and menu operators in sculpt mode. | ||||
| Other related information can also be found at the bottom of the page. | |||||
| .. figure:: /images/sculpt-paint_sculpting_editing_mask_example.jpg | |||||
| Black part is masked. | |||||
| Brush | |||||
| ===== | |||||
| To edit the mask, select the *Mask Brush* from the Brush panel. | |||||
| Editing | Editing | ||||
| ======= | ======== | ||||
| .. a screenshot of the menu | |||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask` | :Menu: :menuselection:`Mask` | ||||
| :Shortcut: :kbd:`A` | :Shortcut: :kbd:`A` | ||||
| Masks can be edited across the entire model. | Masks can be edited across all visible faces. | ||||
| Using :kbd:`A` opens a pie menu to choose different operations. | Using :kbd:`A` opens a pie menu to choose the most common operations. | ||||
| Invert Mask | Invert Mask | ||||
| ----------- | ----------- | ||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Invert Mask` | :Menu: :menuselection:`Mask --> Invert Mask` | ||||
| :Shortcut: :kbd:`Ctrl-I` | :Shortcut: :kbd:`Ctrl-I` | ||||
| Inverts an existing mask. | Inverts the visible mask. | ||||
| This is often useful because sometimes the masked vertices are the surfaces you want to sculpt/paint. | |||||
| In that case it is very useful to mask and then invert. | |||||
| .. An example image of this workflow with lasso masking | |||||
| .. _bpy.ops.paint.mask_flood_fill: | .. _bpy.ops.paint.mask_flood_fill: | ||||
| Fill Mask | Fill Mask | ||||
| --------- | --------- | ||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Fill Mask` | :Menu: :menuselection:`Mask --> Fill Mask` | ||||
| Fills the whole mask with a value of 1. | Fully masks the entire visible geometry. | ||||
| Alternatively it is also common to invert unmasked geometry to achieve the same effect. | |||||
| Clear Mask | Clear Mask | ||||
| ---------- | ---------- | ||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Clear Mask` | :Menu: :menuselection:`Mask --> Clear Mask` | ||||
| :Shortcut: :kbd:`Alt-M` | :Shortcut: :kbd:`Alt-M` | ||||
| Fills the mask with a value of 0. To completely remove the mask data, see `Clear Sculpt-Mask Data`_. | Removes the mask on all visible vertices. To completely remove the mask data, see `Clear Sculpt-Mask Data`_. | ||||
| .. _bpy.ops.paint.mask_box_gesture: | .. _bpy.ops.paint.mask_box_gesture: | ||||
| Box Mask | Box Mask | ||||
| -------- | -------- | ||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Box Mask` | :Menu: :menuselection:`Mask --> Box Mask` | ||||
| :Shortcut: :kbd:`B` | :Shortcut: :kbd:`B` | ||||
| Works like the *Box Select* tool, it creates a rectangular mask region. | Works like the the :doc:`Box Mask </sculpt_paint/sculpting/tools/box_mask>` tool, it creates a rectangular mask region. | ||||
| Hold :kbd:`Shift` to clear the mask of the selected region. | Hold :kbd:`Shift` or press :kbd:`MMB` to clear the mask of the selected region. | ||||
| .. _bpy.ops.paint.mask_lasso_gesture: | .. _bpy.ops.paint.mask_lasso_gesture: | ||||
| Lasso Mask | Lasso Mask | ||||
| ---------- | ---------- | ||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Lasso Mask` | :Menu: :menuselection:`Mask --> Lasso Mask` | ||||
| :Shortcut: :kbd:`Shift-Ctrl-LMB` | :Shortcut: :kbd:`Shift-Ctrl-LMB` | ||||
| Can be used to create a free-form mask, similar to the *Lasso Select* tool. | Can be used to create a free-form mask, similar to the :doc:`Lasso Mask </sculpt_paint/sculpting/tools/box_mask>` tool. | ||||
| This is very commonly used. | |||||
| .. tip:: | .. tip:: | ||||
| To clear the mask of areas with the *Lasso Mask* tool, first invert the mask, | To clear the mask of areas with the *Lasso Mask*, first invert the mask, | ||||
| apply the *Lasso Mask*, and then invert the mask back. | use *Lasso Mask*, and then invert the mask back. | ||||
| .. _bpy.ops.sculpt.mask_filter: | .. _bpy.ops.sculpt.mask_filter: | ||||
| Mask Filters | Mask Filters | ||||
| ------------ | ------------ | ||||
| .. needs visual examples | |||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Mask Filters` | :Menu: :menuselection:`Mask --> Mask Filters` | ||||
| Mask filters are operations that are applied to the whole paint mask. | Mask filters are operations that are applied to the whole mask. | ||||
| Type | Type | ||||
| Smooth/Sharpen Mask | Smooth/Sharpen Mask | ||||
| Changes the crispness of the mask edge. | Changes the sharpness of the mask edge. | ||||
| Grow/Shrink Mask | Grow/Shrink Mask | ||||
| Changes the size of the mask. | Further grow or shrink the mask along the surface of the mesh. | ||||
| Increase/Decrease Contrast | Increase/Decrease Contrast | ||||
| Changes the contrast of the mask. | Changes the contrast of the mask. | ||||
| In the :ref:`Adjust Last Operation <bpy.ops.screen.redo_last>` panel there are further options. | |||||
| Iterations | Iterations | ||||
| The number of times that the filter is going to be applied. | The number of times the filter is applied. | ||||
| Auto Iteration Count | Auto Iteration Count | ||||
| Use an automatic number of iterations based on the number of vertices of the sculpt. | Use an automatic number of iterations based on the number of vertices of the sculpt. | ||||
| Disable this option to set the Iterations manually. | |||||
| .. _bpy.ops.sculpt.mask_expand: | .. _bpy.ops.sculpt.mask_expand: | ||||
| .. _bpy.ops.sculpt.expand: | .. _bpy.ops.sculpt.expand: | ||||
| Expand Mask by Topology | Expand Mask by Topology | ||||
| ----------------------- | ----------------------- | ||||
| .. needs visual examples | |||||
| .. everything below this still needs rewrites | |||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Menu: :menuselection:`Mask --> Expand Mask by Topology` | :Menu: :menuselection:`Mask --> Expand Mask by Topology` | ||||
| :Shortcut: :kbd:`Shift-A` | :Shortcut: :kbd:`Shift-A` | ||||
| Creates a mask radiating outwards from the active vertex in a uniform manner. | Creates a mask radiating outwards from the active vertex in a uniform manner. | ||||
| ▲ Show 20 Lines • Show All 173 Lines • ▼ Show 20 Lines | |||||
| Per Face Set | Per Face Set | ||||
| Assigns a random mask value for each :doc:`Face Set </sculpt_paint/sculpting/editing/face_sets>`. | Assigns a random mask value for each :doc:`Face Set </sculpt_paint/sculpting/editing/face_sets>`. | ||||
| Per Loose Mask | Per Loose Mask | ||||
| Assigns a random mask value for each disjoint part of the mesh. | Assigns a random mask value for each disjoint part of the mesh. | ||||
| .. _bpy.types.Sculpt.show_mask: | .. _bpy.types.Sculpt.show_mask: | ||||
| .. _bpy.types.View3DOverlay.sculpt_mode_mask_opacity: | .. _bpy.types.View3DOverlay.sculpt_mode_mask_opacity: | ||||
| .. _Mask Display Settings: | |||||
| Display Settings | Display Settings | ||||
| ================ | ================ | ||||
| .. reference:: | .. reference:: | ||||
| :Mode: Sculpt Mode | :Mode: Sculpt Mode | ||||
| :Popover: :menuselection:`Viewport Overlays -- Sculpt --> Mask` | :Popover: :menuselection:`Viewport Overlays -- Sculpt --> Mask` | ||||
| Show All 17 Lines | |||||