From f1ee81de8d85022c19a20376f39bb23d7d2230ca Mon Sep 17 00:00:00 2001 From: Sean Kim Date: Mon, 24 Jun 2024 16:18:27 -0700 Subject: [PATCH] Sculpt: Create Hide, Face Set, and Trim pages * Consolidates the existing Face Set tools into a single page. * Consolidates the existing Trim tools into a single page. * Creates a Hide page for related tools. * Minor other cleanup. --- .../visibility_masking_face_sets.rst | 5 +- manual/sculpt_paint/sculpting/toolbar.rst | 18 ++-- .../sculpting/tools/box_face_set.rst | 19 ----- .../sculpting/tools/face_set_tools.rst | 71 ++++++++++++++++ .../sculpting/tools/hide_tools.rst | 84 +++++++++++++++++++ manual/sculpt_paint/sculpting/tools/index.rst | 7 +- .../sculpting/tools/lasso_face_set.rst | 19 ----- .../sculpting/tools/lasso_trim.rst | 84 ------------------- .../sculpting/tools/mask_tools.rst | 8 +- .../tools/{box_trim.rst => trim_tools.rst} | 64 ++++++++++++-- 10 files changed, 230 insertions(+), 149 deletions(-) delete mode 100644 manual/sculpt_paint/sculpting/tools/box_face_set.rst create mode 100644 manual/sculpt_paint/sculpting/tools/face_set_tools.rst create mode 100644 manual/sculpt_paint/sculpting/tools/hide_tools.rst delete mode 100644 manual/sculpt_paint/sculpting/tools/lasso_face_set.rst delete mode 100644 manual/sculpt_paint/sculpting/tools/lasso_trim.rst rename manual/sculpt_paint/sculpting/tools/{box_trim.rst => trim_tools.rst} (70%) diff --git a/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst b/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst index ee040f6af..c514a6761 100644 --- a/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst +++ b/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst @@ -24,6 +24,8 @@ and :kbd:`Shift-H` to isolate the face set under the cursor (or show everything) :ref:`Inverting the visibility ` and :ref:`showing all ` is also available in the :kbd:`Alt-W` pie menu. +Modifying visibility can also be done via the :doc:`/sculpt_paint/sculpting/tools/hide_tools`. + .. seealso:: More information for controlling the visibility at :doc:`Show & Hide `. @@ -84,8 +86,7 @@ More options can be found in the :kbd:`Alt-W` pie menu. Otherwise Face Sets can be created/edited with the :doc:`Draw Face Sets ` brush, -:doc:`Box Face Set ` and -:doc:`Lasso Face Set `. +:doc:`/sculpt_paint/sculpting/tools/mask_tools`. They can also be edited with the :doc:`Edit Face Set ` tool. diff --git a/manual/sculpt_paint/sculpting/toolbar.rst b/manual/sculpt_paint/sculpting/toolbar.rst index 9ec43c022..85e5d0289 100644 --- a/manual/sculpt_paint/sculpting/toolbar.rst +++ b/manual/sculpt_paint/sculpting/toolbar.rst @@ -168,20 +168,14 @@ See :doc:`/sculpt_paint/sculpting/introduction/gesture_tools` for more informati :doc:`/sculpt_paint/sculpting/tools/mask_tools` Create a mask via a gesture. -Box Hide - Hides/Shows geometry via a box gesture. +:doc:`/sculpt_paint/sculpting/tools/hide_tools` + Hides/Shows geometry via a gesture. -:doc:`/sculpt_paint/sculpting/tools/box_face_set` - Create a face set via a box gesture. +:doc:`/sculpt_paint/sculpting/tools/face_set_tools` + Create a face set via a gesture. -:doc:`/sculpt_paint/sculpting/tools/lasso_face_set` - Create a face set via a lasso gesture. - -:doc:`/sculpt_paint/sculpting/tools/box_trim` - Perform a Boolean operation via a box gesture. - -:doc:`/sculpt_paint/sculpting/tools/lasso_trim` - Perform a Boolean operation via a lasso gesture. +:doc:`/sculpt_paint/sculpting/tools/trim_tools` + Perform a Boolean operation via a gesture. :doc:`/sculpt_paint/sculpting/tools/line_project` Flatten the geometry towards a drawn line. diff --git a/manual/sculpt_paint/sculpting/tools/box_face_set.rst b/manual/sculpt_paint/sculpting/tools/box_face_set.rst deleted file mode 100644 index e69cd9699..000000000 --- a/manual/sculpt_paint/sculpting/tools/box_face_set.rst +++ /dev/null @@ -1,19 +0,0 @@ - -************ -Box Face Set -************ - -.. reference:: - - :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Box Face Set` - -Creates a new :doc:`Face Set ` -based on a :ref:`box selection `. - - -Tool Settings -============= - -Front Faces Only - Only creates a mask on the faces that face towards the view. diff --git a/manual/sculpt_paint/sculpting/tools/face_set_tools.rst b/manual/sculpt_paint/sculpting/tools/face_set_tools.rst new file mode 100644 index 000000000..229beb746 --- /dev/null +++ b/manual/sculpt_paint/sculpting/tools/face_set_tools.rst @@ -0,0 +1,71 @@ + +********************** +Face Set Gesture Tools +********************** + +.. reference:: + + :Mode: Sculpt Mode + +Face Set gesture tools apply a single new Face Set to all faces within the selection area. + +All Face Set gesture tools can be activated in the Toolbar and are comprised of the following: + +.. _tool-box-face-set: + +Box Face Set +============ + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Box Face Set` + + +Creates a new :doc:`Face Set ` +based on a :ref:`box gesture `. + +.. _tool-lasso-face-set: + +Lasso Face Set +============== + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Lasso Face Set` + +Creates a new :doc:`Face Set ` +based on a :ref:`lasso gesture `. + +.. _tool-line-face-set: + +Line Face Set +============= + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Line Face Set` + +Creates a new :doc:`Face Set ` +based on a :ref:`line gesture `. + +.. _tool-polyline-face-set: + +Polyline Face Set +================= + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Polyline Face Set` + +Creates a new :doc:`Face Set ` +based on a :ref:`polyline gesture `. + +Tool Settings +============= + +Front Faces Only + Only creates a face set on the faces that face towards the view. diff --git a/manual/sculpt_paint/sculpting/tools/hide_tools.rst b/manual/sculpt_paint/sculpting/tools/hide_tools.rst new file mode 100644 index 000000000..b62fd0386 --- /dev/null +++ b/manual/sculpt_paint/sculpting/tools/hide_tools.rst @@ -0,0 +1,84 @@ + +****************** +Hide Gesture Tools +****************** + +.. reference:: + + :Mode: Sculpt Mode + +Hide gesture tools hide all selected vertices within the selection area and any of their connected +edges and faces. +Holding :kbd:`Ctrl` while performing the selection reveals the vertices, edges, and faces. + +Pressing :kbd:`LMB` with any of these tools without also dragging reveals all elements of a mesh. + +All hide gesture tools can be activated in the Toolbar and are comprised of the following: + +.. _tool-box-hide: + +Box Hide +======== + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Box Hide` + + +Hides vertices and connected edges and faces based on a +:ref:`box gesture `. + +.. _tool-lasso-hide: + +Lasso Hide +========== + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Lasso Hide` + +Hides vertices and connected edges and faces based on a +:ref:`lasso gesture `. + +.. _tool-line-hide: + +Line Hide +========= + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Line Mask` + +Hides vertices and connected edges and faces based on a +:ref:`line gesture `. + +.. _tool-polyline-hide: + +Polyline Hide +============= + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Polyline Mask` + +Hides vertices and connected edges and faces based on a +:ref:`polyline gesture `. + +.. note:: + + The Polyline Hide tool does not support showing all vertices via pressing :kbd:`LMB`. + +Tool Settings +============= + +Visibility Area + Determines whether all vertices inside or outside the selected area should be affected. + + :Inside: + All vertices and connected elements inside the selection area will be hidden. + :Outside: + All vertices and connected elements outside the selection area will be hidden. \ No newline at end of file diff --git a/manual/sculpt_paint/sculpting/tools/index.rst b/manual/sculpt_paint/sculpting/tools/index.rst index d0c4c88e3..007ea3672 100644 --- a/manual/sculpt_paint/sculpting/tools/index.rst +++ b/manual/sculpt_paint/sculpting/tools/index.rst @@ -39,10 +39,9 @@ paint.rst smear.rst mask_tools.rst - box_face_set.rst - lasso_face_set.rst - box_trim.rst - lasso_trim.rst + hide_tools.rst + face_set_tools.rst + trim_tools.rst line_project.rst mesh_filter.rst cloth_filter.rst diff --git a/manual/sculpt_paint/sculpting/tools/lasso_face_set.rst b/manual/sculpt_paint/sculpting/tools/lasso_face_set.rst deleted file mode 100644 index 7f1bebc2e..000000000 --- a/manual/sculpt_paint/sculpting/tools/lasso_face_set.rst +++ /dev/null @@ -1,19 +0,0 @@ - -************** -Lasso Face Set -************** - -.. reference:: - - :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Lasso Face Set` - -Creates a new :doc:`Face Set ` -based on a :ref:`lasso selection `. - - -Tool Settings -============= - -Front Faces Only - Only creates a mask on the faces that face towards the view. diff --git a/manual/sculpt_paint/sculpting/tools/lasso_trim.rst b/manual/sculpt_paint/sculpting/tools/lasso_trim.rst deleted file mode 100644 index 489c77750..000000000 --- a/manual/sculpt_paint/sculpting/tools/lasso_trim.rst +++ /dev/null @@ -1,84 +0,0 @@ - -********** -Lasso Trim -********** - -.. reference:: - - :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Lasso Trim` - -Adds or removes geometry based on a :ref:`lasso selection `. -This tool is especially useful for sketching an early base mesh for further -sculpting with the :doc:`voxel remesher `. - -.. list-table:: - - * - .. figure:: /images/sculpt-paint_sculpt_trim_lasso_visual_example_a.png - - Using Lasso Trim set to *Join* - - - .. figure:: /images/sculpt-paint_sculpt_trim_lasso_visual_example_b.png - - The symmetrized mesh. - - - .. figure:: /images/sculpt-paint_sculpt_trim_lasso_visual_example_c.png - - Sculpting with voxel remeshing. - -New geometry is assigned to a new :ref:`Face Set `. -When removing geometry, the new interior geometry along the selection will be assigned -a new face set instead. - -.. note:: - - It is not recommended to use this tool on a mesh above 100k vertices when using *Difference* - or *Union* as the Trim Mode with the *Exact* Solver. - This tool is using a Boolean operation so it might take a long time to process. - For higher resolution meshes it is recommended to instead use the - :doc:`Line Project ` tool or the *Fair Positions* - mode of the :doc:`Edit Face Set ` tool to trim geometry. - - -Tool Settings -============= - -Solver - Algorithm used to calculate the Boolean intersections. - - :Fast: - Uses a mathematically simple solver which offers the best performance; - however, this solver lacks support for overlapping geometry. - :Exact: - Uses a mathematically complex solver which offers the best results and has full - support for overlapping geometry; however, this solver is much slower than the - *Fast Solver*. - -Trim Mode - Geometry can be either added or removed by choosing one of these modes. - - :Difference: - Removes geometry, filling any holes that are created. - :Union: - Creates a geometry and joins any intersections with existing geometry. - :Join: - Similar to *Union* but joins the mesh as separate geometry, - without performing any Boolean operations with existing geometry. - -Shape Orientation - The method used to orientate the trimming shape. - - :View: - Use the view to orientate the trimming shape. - :Surface: - Use the surface normal to orientate the trimming shape. - -Extrude Mode - :Fixed: - Aligns new geometry orthogonally for 90 degree angles in depth. - :Project: - Aligns new geometry with the perspective of the current view for a tapered result. - -Use Cursor for Depth - Use cursor location and radius for the dimensions and position of the trimming shape. - If not set, the tool uses the full depth of the object from the camera view. diff --git a/manual/sculpt_paint/sculpting/tools/mask_tools.rst b/manual/sculpt_paint/sculpting/tools/mask_tools.rst index 18148f471..2f0d06885 100644 --- a/manual/sculpt_paint/sculpting/tools/mask_tools.rst +++ b/manual/sculpt_paint/sculpting/tools/mask_tools.rst @@ -52,7 +52,7 @@ Line Mask :Tool: :menuselection:`Toolbar --> Line Mask` Creates a new :doc:`Mask ` based on a -:ref:`line gesture ` +:ref:`line gesture `. .. _tool-polyline-mask: @@ -65,10 +65,10 @@ Polyline Mask :Tool: :menuselection:`Toolbar --> Polyline Mask` Creates a new :doc:`Mask ` based on a -:ref:`polyline gesture ` +:ref:`polyline gesture `. -Common Options -============== +Tool Settings +============= Front Faces Only Only creates a mask on the faces that face towards the view. \ No newline at end of file diff --git a/manual/sculpt_paint/sculpting/tools/box_trim.rst b/manual/sculpt_paint/sculpting/tools/trim_tools.rst similarity index 70% rename from manual/sculpt_paint/sculpting/tools/box_trim.rst rename to manual/sculpt_paint/sculpting/tools/trim_tools.rst index 8925c9b1f..5b5fc2539 100644 --- a/manual/sculpt_paint/sculpting/tools/box_trim.rst +++ b/manual/sculpt_paint/sculpting/tools/trim_tools.rst @@ -1,14 +1,13 @@ -******** -Box Trim -******** +****************** +Trim Gesture Tools +****************** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Box Trim` -Adds or removes geometry based on a :ref:`box selection `. +Trim gesture tools add or remove geometry based on a selection area. This tool is especially useful for sketching an early base mesh for further sculpting with the :doc:`voxel remesher `. @@ -40,6 +39,61 @@ a new face set instead. :doc:`Line Project ` tool or the *Fair Positions* mode of the :doc:`Edit Face Set ` tool to trim geometry. +.. _tool-box-trim: + +Box Trim +======== + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Box Trim` + +Performs a Boolean operation based on the area defined by a +:ref:`box gesture `. + +.. _tool-lasso-trim: + +Lasso Trim +========== + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Lasso Trim` + +Performs a Boolean operation based on the area defined by a +:ref:`lasso gesture `. + +.. _tool-line-trim: + +Line Trim +========= + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Line Trim` + +Performs a Boolean operation based on the area defined by a +:ref:`line gesture `. + +.. note:: + + The Line Trim tool does not support adding geometry. Only *Difference* mode is supported. + +.. _tool-polyline-trim: + +Polyline Trim +============= + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Polyline Trim` + +Performs a Boolean operation based on the area defined by a +:ref:`polyline gesture `. Tool Settings ============= -- 2.30.2