From 8f3d981847478aa583eae41700f9167539ad0043 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 26 Jun 2024 17:11:26 +0200 Subject: [PATCH 01/30] Merge basic brush page into brush introduction, rename to "Brushes" Found the current navigation quite confusing. Mostly having a section named "Brush" with a rather empty "Introduction" page and then a separate "Brushes" section --- build_files/.htaccess | 2 + manual/files/data_blocks.rst | 2 +- manual/sculpt_paint/brush/brush.rst | 51 ------------------ manual/sculpt_paint/brush/index.rst | 3 +- manual/sculpt_paint/brush/introduction.rst | 53 +++++++++++++++++++ .../sculpting/tool_settings/index.rst | 2 +- .../texture_paint/tool_settings/index.rst | 2 +- .../vertex_paint/tool_settings/index.rst | 2 +- .../weight_paint/tool_settings/index.rst | 2 +- 9 files changed, 61 insertions(+), 58 deletions(-) delete mode 100644 manual/sculpt_paint/brush/brush.rst diff --git a/build_files/.htaccess b/build_files/.htaccess index de1a74427..085b0d5d9 100644 --- a/build_files/.htaccess +++ b/build_files/.htaccess @@ -249,3 +249,5 @@ RedirectMatch "^/manual/{lang}/{version}/movie_clip/introduction.html" "^/manual RedirectMatch "^/manual/{lang}/{version}/getting_started/about/introduction.html" "^/manual/{lang}/{version}/getting_started/about/index.html" RedirectMatch "^/manual/{lang}/{version}/animation/armatures/bones/properties/introduction.html" "^/manual/{lang}/{version}/animation/armatures/bones/properties/index.html" RedirectMatch "^/manual/{lang}/{version}/advanced/command_line/introduction.html" "^/manual/{lang}/{version}/advanced/command_line/index.html" + +RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/brush/brush.html" "^/manual/{lang}/{version}/sculpt_paint/brush/introduction.html" \ No newline at end of file diff --git a/manual/files/data_blocks.rst b/manual/files/data_blocks.rst index 9cb4c166d..0520b2dd3 100644 --- a/manual/files/data_blocks.rst +++ b/manual/files/data_blocks.rst @@ -98,7 +98,7 @@ Pack - |none| - Skeleton used to deform meshes. Used as data of armature objects, and by the Armature Modifier. - * - :doc:`Brush ` + * - :doc:`Brush ` - |tick| - |none| - Used by paint tools. diff --git a/manual/sculpt_paint/brush/brush.rst b/manual/sculpt_paint/brush/brush.rst deleted file mode 100644 index bff1f7d00..000000000 --- a/manual/sculpt_paint/brush/brush.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _bpy.types.Brush: -.. _bpy.ops.brush: -.. _bpy.types.UnifiedPaintSettings: - -******* -Brushes -******* - -.. reference:: - - :Mode: Sculpt Mode - :Panel: :menuselection:`Sidebar --> Tools --> Brushes` - -For painting/sculpting modes each brush type is exposed as a tool in the toolbar. -The brush on the other hand is a saved preset of all the brush settings, including a name and thumbnail. - -All these settings can be found and changed here in the tool setting (brush, texture, stroke, falloff & cursor). - -.. figure:: /images/sculpt-paint_brush_brush_data-block-menu.png - :align: right - - Brush panel in the tool settings. - -Brushes - Clicking on the brush thumbnail will open the :ref:`ui-data-block` to select a brush. - - Add Brush (Duplicate icon) - When you add a brush, the new brush is a duplicate of the current one. - Fake User (Shield icon) - Enabling this button will ensure that the brush will not be deleted, - even if it is not used by any tool. - Unlink Data-Block (Cross icon) - Unassign the brush from the active tool. - Hold :kbd:`Shift` to remove the brush from all users, - so it will be deleted upon reloading the file or purging orphan data. - - Brush Specials (Arrow button) - Enabled Modes - Enable the brush to be used in different (even multiple) modes. - For example, the exact same brushes are used in both Weight Paint - and Vertex Paint mode. - Tool Selection - Transfer the brush preset to be used by a different brush type. - Reset Brush - Reset all brush settings to the default values of the current brush type. - -.. _bpy.types.Brush.use_custom_icon: -.. _bpy.types.Brush.icon_filepath: - - Custom Icon - Define a custom brush thumbnail from an image file. diff --git a/manual/sculpt_paint/brush/index.rst b/manual/sculpt_paint/brush/index.rst index f6c67cec4..da8bb10e6 100644 --- a/manual/sculpt_paint/brush/index.rst +++ b/manual/sculpt_paint/brush/index.rst @@ -1,6 +1,6 @@ ######### - Brush + Brushes ######### .. toctree:: @@ -15,7 +15,6 @@ Brush Settings .. toctree:: :maxdepth: 1 - brush.rst brush_settings.rst texture.rst stroke.rst diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index c0f4b01cd..83a4520c0 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -33,3 +33,56 @@ Move the mouse right or left to increase/reduce the value Finally confirm (:kbd:`LMB`, :kbd:`Return`) or cancel (:kbd:`RMB`, :kbd:`Esc`). You can also invert the brush direction/effect by holding :kbd:`Ctrl`. + +.. _bpy.types.Brush: +.. _bpy.ops.brush: +.. _bpy.types.UnifiedPaintSettings: + +******* +Brush Editing +******* + +.. reference:: + + :Mode: Sculpt Mode + :Panel: :menuselection:`Sidebar --> Tools --> Brushes` + +For painting/sculpting modes each brush type is exposed as a tool in the toolbar. +The brush on the other hand is a saved preset of all the brush settings, including a name and thumbnail. + +All these settings can be found and changed here in the tool setting (brush, texture, stroke, falloff & cursor). + +.. figure:: /images/sculpt-paint_brush_brush_data-block-menu.png + :align: right + + Brush panel in the tool settings. + +Brushes + Clicking on the brush thumbnail will open the :ref:`ui-data-block` to select a brush. + + Add Brush (Duplicate icon) + When you add a brush, the new brush is a duplicate of the current one. + Fake User (Shield icon) + Enabling this button will ensure that the brush will not be deleted, + even if it is not used by any tool. + Unlink Data-Block (Cross icon) + Unassign the brush from the active tool. + Hold :kbd:`Shift` to remove the brush from all users, + so it will be deleted upon reloading the file or purging orphan data. + + Brush Specials (Arrow button) + Enabled Modes + Enable the brush to be used in different (even multiple) modes. + For example, the exact same brushes are used in both Weight Paint + and Vertex Paint mode. + Tool Selection + Transfer the brush preset to be used by a different brush type. + Reset Brush + Reset all brush settings to the default values of the current brush type. + +.. _bpy.types.Brush.use_custom_icon: +.. _bpy.types.Brush.icon_filepath: + + Custom Icon + Define a custom brush thumbnail from an image file. + diff --git a/manual/sculpt_paint/sculpting/tool_settings/index.rst b/manual/sculpt_paint/sculpting/tool_settings/index.rst index 9fc3da270..50e257ba5 100644 --- a/manual/sculpt_paint/sculpting/tool_settings/index.rst +++ b/manual/sculpt_paint/sculpting/tool_settings/index.rst @@ -6,7 +6,7 @@ .. toctree:: :maxdepth: 2 - /sculpt_paint/brush/brush.rst + /sculpt_paint/brush/index.rst brush_settings.rst dyntopo.rst remesh.rst diff --git a/manual/sculpt_paint/texture_paint/tool_settings/index.rst b/manual/sculpt_paint/texture_paint/tool_settings/index.rst index 8616eb0cc..ba0b538d3 100644 --- a/manual/sculpt_paint/texture_paint/tool_settings/index.rst +++ b/manual/sculpt_paint/texture_paint/tool_settings/index.rst @@ -7,7 +7,7 @@ :maxdepth: 2 texture_slots.rst - /sculpt_paint/brush/brush.rst + /sculpt_paint/brush/index.rst brush_settings.rst mask.rst symmetry.rst diff --git a/manual/sculpt_paint/vertex_paint/tool_settings/index.rst b/manual/sculpt_paint/vertex_paint/tool_settings/index.rst index 2cd2352a0..63b85ebb9 100644 --- a/manual/sculpt_paint/vertex_paint/tool_settings/index.rst +++ b/manual/sculpt_paint/vertex_paint/tool_settings/index.rst @@ -6,6 +6,6 @@ .. toctree:: :maxdepth: 2 - /sculpt_paint/brush/brush.rst + /sculpt_paint/brush/index.rst brush_settings.rst symmetry.rst diff --git a/manual/sculpt_paint/weight_paint/tool_settings/index.rst b/manual/sculpt_paint/weight_paint/tool_settings/index.rst index d36b2e6e9..d1afd389b 100644 --- a/manual/sculpt_paint/weight_paint/tool_settings/index.rst +++ b/manual/sculpt_paint/weight_paint/tool_settings/index.rst @@ -6,7 +6,7 @@ .. toctree:: :maxdepth: 2 - /sculpt_paint/brush/brush.rst + /sculpt_paint/brush/index.rst brush_settings.rst symmetry.rst options.rst -- 2.30.2 From bc208359a28dc1c34b8c99b82a4ab87e4fc0103c Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 26 Jun 2024 18:37:04 +0200 Subject: [PATCH 02/30] Some introductory paragraphs --- manual/sculpt_paint/brush/introduction.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index 83a4520c0..44f3a4dfb 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -8,9 +8,9 @@ Introduction Brush cursor. -The brush is the main way of interacting with any painting and sculpting mode. +Brushes are the main way of interacting with any painting and sculpting mode. While click & dragging in the 3D Viewport it will create a :doc:`stroke ` -and apply an effect depending on various brush settings. +and apply an effect depending on the used brush and brush/tool settings. .. tip:: @@ -34,13 +34,26 @@ Finally confirm (:kbd:`LMB`, :kbd:`Return`) or cancel (:kbd:`RMB`, :kbd:`Esc`). You can also invert the brush direction/effect by holding :kbd:`Ctrl`. +Brush Assets +============ + +Brushes are used as assets, and stored in :doc:`asset libraries `. This makes the +brushes shared across project files. All available brush assets can be displayed in the Asset Browser, which also +provides ways to organize them. + +Blender comes bundled with a number of brushes in the `Essentials` asset library. These can be customized into all +kinds of custom brushes by duplicating them (see :doc:`Brush Editing`). + +While it's possible to have brush data-blocks that are local to the file and not marked as assets, such brushes cannot +be activated for actual painting or sculpting. Use the `Mark as Asset` operator to make them brush assets that can be +activated. + .. _bpy.types.Brush: .. _bpy.ops.brush: .. _bpy.types.UnifiedPaintSettings: -******* Brush Editing -******* +============= .. reference:: -- 2.30.2 From 86b64d7b0c400924b99d4644d41216fac1dbf808 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Mon, 1 Jul 2024 15:19:01 +0200 Subject: [PATCH 03/30] Add section on brush access --- manual/editors/properties_editor.rst | 1 + ...t_brush_introduction_brush-asset-shelf.png | 3 +++ manual/interface/window_system/regions.rst | 2 ++ manual/sculpt_paint/brush/introduction.rst | 20 ++++++++++++++++++- 4 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 manual/images/sculpt-paint_brush_introduction_brush-asset-shelf.png diff --git a/manual/editors/properties_editor.rst b/manual/editors/properties_editor.rst index 9973d590a..e05915eed 100644 --- a/manual/editors/properties_editor.rst +++ b/manual/editors/properties_editor.rst @@ -19,6 +19,7 @@ Tabs The Properties editor has several categories, which can be chosen via tabs (the icons column to its left). Each tab regroups properties and settings of a data type, and is documented in its own manual sections, linked below. +.. _properties-tool-tab: Active Tool and Workspace Settings ---------------------------------- diff --git a/manual/images/sculpt-paint_brush_introduction_brush-asset-shelf.png b/manual/images/sculpt-paint_brush_introduction_brush-asset-shelf.png new file mode 100644 index 000000000..307d84d2c --- /dev/null +++ b/manual/images/sculpt-paint_brush_introduction_brush-asset-shelf.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9bfe2d6c40f790f1443e99c0c2bcf7cc51a10f5b467383a8715406cf9fbe7194 +size 184793 diff --git a/manual/interface/window_system/regions.rst b/manual/interface/window_system/regions.rst index 73ced30f1..b51130d02 100644 --- a/manual/interface/window_system/regions.rst +++ b/manual/interface/window_system/regions.rst @@ -83,6 +83,8 @@ The :ref:`Toolbar ` (on the left side of the editor area) contains a set of interactive tools. :kbd:`T` toggles the visibility of the Toolbar. +.. _ui-region-tool-settings: + Tool Settings ============= diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index 44f3a4dfb..8d825a0c6 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -18,6 +18,22 @@ and apply an effect depending on the used brush and brush/tool settings. for a better brush feel and additional features. +Accessing Brushes +================= + +In modes that use painting or sculpting functionality, the :ref:`Asset Shelf ` of the 3D +Viewport and Image Editor displays brush assets that can be used in that mode. Clicking a brush asset will activate it. + +.. figure:: /images/sculpt-paint_brush_introduction_brush-asset-shelf.png + :align: center + + The Asset Shelf of the 3D Viewport, providing access to brush assets. + +This asset shelf is also available as popup in the :ref:`Tool Settings `, the +:ref:`Sidebar`, :ref:`Active Tool and Workspace Settings ` and using the +:kbd:`Shift-Spacebar` shortcut. + + Brush Control ============= @@ -34,6 +50,7 @@ Finally confirm (:kbd:`LMB`, :kbd:`Return`) or cancel (:kbd:`RMB`, :kbd:`Esc`). You can also invert the brush direction/effect by holding :kbd:`Ctrl`. + Brush Assets ============ @@ -48,6 +65,7 @@ While it's possible to have brush data-blocks that are local to the file and not be activated for actual painting or sculpting. Use the `Mark as Asset` operator to make them brush assets that can be activated. + .. _bpy.types.Brush: .. _bpy.ops.brush: .. _bpy.types.UnifiedPaintSettings: @@ -58,7 +76,7 @@ Brush Editing .. reference:: :Mode: Sculpt Mode - :Panel: :menuselection:`Sidebar --> Tools --> Brushes` + :Panel: :menuselection:`Sidebar --> Tool --> Brushes` For painting/sculpting modes each brush type is exposed as a tool in the toolbar. The brush on the other hand is a saved preset of all the brush settings, including a name and thumbnail. -- 2.30.2 From 7576275657671bc2c1c64c50a55c03e5004aabd2 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Mon, 1 Jul 2024 18:08:08 +0200 Subject: [PATCH 04/30] Improvements to accessing section --- manual/sculpt_paint/brush/introduction.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index 8d825a0c6..ad0779365 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -22,7 +22,8 @@ Accessing Brushes ================= In modes that use painting or sculpting functionality, the :ref:`Asset Shelf ` of the 3D -Viewport and Image Editor displays brush assets that can be used in that mode. Clicking a brush asset will activate it. +Viewport and Image Editor displays brush assets that can be used in that mode. Clicking a brush asset will activate the +Brush Tool if necessary, with the clicked brush set. .. figure:: /images/sculpt-paint_brush_introduction_brush-asset-shelf.png :align: center @@ -30,8 +31,15 @@ Viewport and Image Editor displays brush assets that can be used in that mode. C The Asset Shelf of the 3D Viewport, providing access to brush assets. This asset shelf is also available as popup in the :ref:`Tool Settings `, the -:ref:`Sidebar`, :ref:`Active Tool and Workspace Settings ` and using the -:kbd:`Shift-Spacebar` shortcut. +:ref:`Sidebar`, :doc:`Properties ` and using a shortcut. + +.. reference:: + + :Mode: All Paint Modes + :Header: :menuselection:`Tool Settings` + :Panel: :menuselection:`Sidebar --> Tool --> Brush Asset`, + :menuselection:`Properties --> Tool --> Brush Asset` + :Shortcut: :kbd:`Shift-Spacebar` Brush Control @@ -75,7 +83,7 @@ Brush Editing .. reference:: - :Mode: Sculpt Mode + :Mode: All Paint Modes :Panel: :menuselection:`Sidebar --> Tool --> Brushes` For painting/sculpting modes each brush type is exposed as a tool in the toolbar. -- 2.30.2 From f6cc0ff285b3fab1994ad5bd25b9246738dbc58d Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Mon, 1 Jul 2024 20:10:58 +0200 Subject: [PATCH 05/30] Add initial brush management contents --- ...ulpt-paint_brush_brush_data-block-menu.png | 3 - ...brush_brush-management_asset-operators.png | 3 + .../sculpt_paint/brush/brush_management.rst | 74 +++++++++++++++++++ manual/sculpt_paint/brush/index.rst | 1 + manual/sculpt_paint/brush/introduction.rst | 71 ++++-------------- 5 files changed, 91 insertions(+), 61 deletions(-) delete mode 100644 manual/images/sculpt-paint_brush_brush_data-block-menu.png create mode 100644 manual/images/sculpt_paint_brush_brush-management_asset-operators.png create mode 100644 manual/sculpt_paint/brush/brush_management.rst diff --git a/manual/images/sculpt-paint_brush_brush_data-block-menu.png b/manual/images/sculpt-paint_brush_brush_data-block-menu.png deleted file mode 100644 index a796c7c09..000000000 --- a/manual/images/sculpt-paint_brush_brush_data-block-menu.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:34516b910e9be172f9f8c8cd433cb28da930d1bffa23bf4d6236d6c1528ab3ed -size 19217 diff --git a/manual/images/sculpt_paint_brush_brush-management_asset-operators.png b/manual/images/sculpt_paint_brush_brush-management_asset-operators.png new file mode 100644 index 000000000..fbdd119c4 --- /dev/null +++ b/manual/images/sculpt_paint_brush_brush-management_asset-operators.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa0fbeab9c72d8cabd15f6cd1564011d665f4a7657e709f2cbbfabe5066d8d6f +size 68892 diff --git a/manual/sculpt_paint/brush/brush_management.rst b/manual/sculpt_paint/brush/brush_management.rst new file mode 100644 index 000000000..cabac18ff --- /dev/null +++ b/manual/sculpt_paint/brush/brush_management.rst @@ -0,0 +1,74 @@ +**************** +Brush Management +**************** + +Brush assets are stored in :doc:`asset libraries ` to make them accesible from +any Blender session. There are two ways of managing brush assets: + +- :ref:`Asset Operators `: Create and update brush assets using utility operators + from any Blender file. Storage is managed by Blender. Convenient for simple "on the fly" management of personal brush + asset libraries. +- :ref:`Manual Storage `: Create and update brush assets by opening blend files within asset + libraries, and managing brush asset data-blocks in there. Useful for careful curation of asset libraries, especially + to prepare them for sharing with others. + +.. _brush-management-utility-operators: + +Asset Operators +=============== + +.. reference:: + + :Mode: All Paint Modes + :Panel: :menuselection:`Sidebar --> Tool --> Brush Asset` + :menuselection:`Properties --> Tool --> Brush Asset` + :Menu: :menuselection:`Asset Shelf --> Context Menu` + +.. figure:: /images/sculpt_paint_brush_brush-management_asset-operators.png + :align: right + :width: 300 + + Brush Asset panel in the tool settings showing asset operators. + +Duplicate Asset... (Duplicate icon) + Creates a copy of the currently active brush as asset, and activates it. A popup is spawned to input some settings + to use: + + Name + A custom name to use for the new brush + Library + Choose an Asset Library to store the new brush asset in. The available asset libraries are configured + :ref:`in the Preferences `. + Catalog + Choose an Asset Catalog to assign the brush asset to. Entering a non-existent name/path will create a new catalog + accordingly. + +Delete Asset + Permanently remove this brush asset from the Asset Library it is stored in. This cannot be undone, so a popup will + ask for confirmation. +Edit Metadata... + Spawns a popup to change some of the available :ref:`asset metadata ` fields. + + Catalog + Choose an Asset Catalog to assign the brush asset to. Entering a non-existent name/path will create a new catalog + accordingly. + Author + See :ref:`Asset Author ` + Description + See :ref:`Asset Description ` +Edit Preview Image... + Opens a window with the File Browser to select an image for the asset preview. +Update Asset + Saves any changes made to the active brush to the asset library. +Revert to Asset + Discards any unsaved changes made to the brush asset. + + +.. _brush-management-manual: + +Manual Storage +============== + +It is also possible to manually manage brushes in blend-files. By marking brushes as assets and saving the file in an +Asset Library, they become available from any Blender session. This gives full control over managing storage, and is +particularly useful for curating asset libraries that can be shared with others. diff --git a/manual/sculpt_paint/brush/index.rst b/manual/sculpt_paint/brush/index.rst index da8bb10e6..1a841c8f3 100644 --- a/manual/sculpt_paint/brush/index.rst +++ b/manual/sculpt_paint/brush/index.rst @@ -7,6 +7,7 @@ :maxdepth: 2 introduction.rst + brush_management.rst Brush Settings diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index ad0779365..e97a94974 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -1,3 +1,6 @@ +.. _bpy.types.Brush: +.. _bpy.ops.brush: +.. _bpy.types.UnifiedPaintSettings: ************ Introduction @@ -8,15 +11,19 @@ Introduction Brush cursor. -Brushes are the main way of interacting with any painting and sculpting mode. -While click & dragging in the 3D Viewport it will create a :doc:`stroke ` -and apply an effect depending on the used brush and brush/tool settings. +Brushes are the main way of interacting with any painting and sculpting mode. By click & dragging in the 3D Viewport +(or the Image Editor when using :doc:`Texture Paint `), the active brush creates a +:doc:`stroke ` with a certain effect, depending on the used brush settings. Typically +Brushes have a preview image and a name that indicate the effect they create. Brushes are only used while the Brush +Tool is active. + .. tip:: It is highly recommended to use a :ref:`Graphics Tablet ` for a better brush feel and additional features. +.. _brush-introduction-accessing-brushes: Accessing Brushes ================= @@ -63,65 +70,13 @@ Brush Assets ============ Brushes are used as assets, and stored in :doc:`asset libraries `. This makes the -brushes shared across project files. All available brush assets can be displayed in the Asset Browser, which also -provides ways to organize them. +brushes shared across project files. All available brush assets can be displayed in the +:doc:`Asset Browser `, which also provides ways to organize them. Blender comes bundled with a number of brushes in the `Essentials` asset library. These can be customized into all -kinds of custom brushes by duplicating them (see :doc:`Brush Editing`). +kinds of custom brushes by duplicating them (see :doc:`Brush Editing`). While it's possible to have brush data-blocks that are local to the file and not marked as assets, such brushes cannot be activated for actual painting or sculpting. Use the `Mark as Asset` operator to make them brush assets that can be activated. - -.. _bpy.types.Brush: -.. _bpy.ops.brush: -.. _bpy.types.UnifiedPaintSettings: - -Brush Editing -============= - -.. reference:: - - :Mode: All Paint Modes - :Panel: :menuselection:`Sidebar --> Tool --> Brushes` - -For painting/sculpting modes each brush type is exposed as a tool in the toolbar. -The brush on the other hand is a saved preset of all the brush settings, including a name and thumbnail. - -All these settings can be found and changed here in the tool setting (brush, texture, stroke, falloff & cursor). - -.. figure:: /images/sculpt-paint_brush_brush_data-block-menu.png - :align: right - - Brush panel in the tool settings. - -Brushes - Clicking on the brush thumbnail will open the :ref:`ui-data-block` to select a brush. - - Add Brush (Duplicate icon) - When you add a brush, the new brush is a duplicate of the current one. - Fake User (Shield icon) - Enabling this button will ensure that the brush will not be deleted, - even if it is not used by any tool. - Unlink Data-Block (Cross icon) - Unassign the brush from the active tool. - Hold :kbd:`Shift` to remove the brush from all users, - so it will be deleted upon reloading the file or purging orphan data. - - Brush Specials (Arrow button) - Enabled Modes - Enable the brush to be used in different (even multiple) modes. - For example, the exact same brushes are used in both Weight Paint - and Vertex Paint mode. - Tool Selection - Transfer the brush preset to be used by a different brush type. - Reset Brush - Reset all brush settings to the default values of the current brush type. - -.. _bpy.types.Brush.use_custom_icon: -.. _bpy.types.Brush.icon_filepath: - - Custom Icon - Define a custom brush thumbnail from an image file. - -- 2.30.2 From 8c84e9e6f7bdc77f0854c3479461529049fb045e Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Tue, 2 Jul 2024 19:58:23 +0200 Subject: [PATCH 06/30] Smaller improvements --- manual/files/data_blocks.rst | 2 +- .../sculpt_paint/brush/brush_management.rst | 27 +++++++++++-------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/manual/files/data_blocks.rst b/manual/files/data_blocks.rst index 0520b2dd3..c6644319a 100644 --- a/manual/files/data_blocks.rst +++ b/manual/files/data_blocks.rst @@ -101,7 +101,7 @@ Pack * - :doc:`Brush ` - |tick| - |none| - - Used by paint tools. + - Used as brush assets in sculpt and paint modes. * - :doc:`Camera ` - |tick| - |none| diff --git a/manual/sculpt_paint/brush/brush_management.rst b/manual/sculpt_paint/brush/brush_management.rst index cabac18ff..ee56cacd2 100644 --- a/manual/sculpt_paint/brush/brush_management.rst +++ b/manual/sculpt_paint/brush/brush_management.rst @@ -1,6 +1,6 @@ -**************** -Brush Management -**************** +************** +Manage Brushes +************** Brush assets are stored in :doc:`asset libraries ` to make them accesible from any Blender session. There are two ways of managing brush assets: @@ -17,6 +17,9 @@ any Blender session. There are two ways of managing brush assets: Asset Operators =============== +Note that only assets created via :ref:`Duplicate Asset... ` can be edited using these +operators. For others (including brush assets bundled in the Essentials library), these operations will be grayed out. + .. reference:: :Mode: All Paint Modes @@ -30,32 +33,34 @@ Asset Operators Brush Asset panel in the tool settings showing asset operators. +.. _bpy.ops.brush.asset_save_as: + Duplicate Asset... (Duplicate icon) Creates a copy of the currently active brush as asset, and activates it. A popup is spawned to input some settings to use: Name - A custom name to use for the new brush + A custom name to use for the new brush. Library Choose an Asset Library to store the new brush asset in. The available asset libraries are configured :ref:`in the Preferences `. Catalog - Choose an Asset Catalog to assign the brush asset to. Entering a non-existent name/path will create a new catalog - accordingly. + Choose an :doc:`Asset Catalog ` to assign the brush asset to. Entering a + non-existent name/path will create a new catalog accordingly. Delete Asset Permanently remove this brush asset from the Asset Library it is stored in. This cannot be undone, so a popup will ask for confirmation. Edit Metadata... - Spawns a popup to change some of the available :ref:`asset metadata ` fields. + Spawns a popup to change some of the available :ref:`asset metadata ` fields: Catalog - Choose an Asset Catalog to assign the brush asset to. Entering a non-existent name/path will create a new catalog - accordingly. + Choose an :doc:`Asset Catalog ` to assign the brush asset to. Entering a + non-existent name/path will create a new catalog accordingly. Author - See :ref:`Asset Author ` + See :ref:`Asset Author `. Description - See :ref:`Asset Description ` + See :ref:`Asset Description `. Edit Preview Image... Opens a window with the File Browser to select an image for the asset preview. Update Asset -- 2.30.2 From 1e4ee90218c20f7e33f940dc0d5bb6af3ff0d180 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 17:21:12 +0200 Subject: [PATCH 07/30] Update asset library page for brush assets --- manual/files/asset_libraries/introduction.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index 07b5d9d75..e2ff8362e 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -75,9 +75,11 @@ Primitive assets are data-blocks that are either **linked or appended** to the c Examples are objects, materials, and worlds. These can be dragged from the Asset Browser into the scene (objects and worlds), or onto existing objects (materials). -Preset assets are data-blocks that are loaded and then **applied** to something. -An example is a pose asset. When applying the pose, the data-block is loaded -from its blend-file, and then the pose is applied to the active armature. +Preset assets are data-blocks that are loaded and then **applied** to something or **activated**. +An example is a pose asset. When applying the pose, the data-block is loaded from its blend-file, +and then the pose is applied to the active armature. Brush assets are an example of an asset type +that is activated. They get loaded into the current file and activated for painting or sculpting, +but don't get saved in the file. In the future, the asset type definition will be expanded; see :ref:`asset-libraries-future-development` for more info. @@ -120,10 +122,9 @@ When using *Mark as Asset*, an automatic preview is generated. If you want, you can also change or replace this with an image of your own choosing; use the folder button next to the preview image in the Asset Details region of the Asset Browser. -For preset assets, there will be a dedicated button for the different asset types. -Currently poses are the only preset assets; use the **Create Pose Asset** button in the Action editor. -This will copy the pose of the selected bones into a new Action, mark it as asset, -and put it into the currently active asset catalog if there is an Asset Browser open. +For preset assets, there will be a dedicated button for the different asset types. For example for +poses there is a **Create Pose Asset** button in the Action editor. Brush assets are created by +using **Duplicate Asset** from existing brush assets. After creating the asset, make sure the current blend-file is saved in your asset library. Blender does not copy the asset into the asset library for you. @@ -261,6 +262,10 @@ or as an add-on; the rule above applies to Blender itself, not to its add-ons. Asset Pushing ------------- +.. note:: + The introduction of Brush assets in Blender 4.3 includes support for an asset pushing concept as + described here. This might be brought to more asset types in future. + Asset **pushing** is a way of getting assets into the asset library, where you are working on a file and want to copy the asset from that file into the library. This is a concept that appears deceptively simple. In certain cases it is actually simple, but often enough it gets quite complex. For example, -- 2.30.2 From 1ae2d8132a1014c1e0b8ff248e6fa1a2b7710d02 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 17:59:46 +0200 Subject: [PATCH 08/30] Document .asset.blend files --- manual/files/asset_libraries/introduction.rst | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index e2ff8362e..2e3011379 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -209,18 +209,33 @@ Included in this library are: .. _asset-libraries-design-limitations: +.. _asset-system-files + +Asset System Files (`.asset.blend` Extention) +============================================= + +Some types of assets can be edited without having to open a blend-file inside of an asset library. +Blender saves these assets to libraries in special files using the `.asset.blend` extension. They +are entirely managed by Blender's asset system, and only contain a single asset and its +dependencies. + +`.asset.blend` files may be deleted or overwritten by Blender's asset system at any time. Hence, +saving changes to them is highly discouraged, as they can easily be lost. Attempting to save edits +to such a file will spawn a warning popup, giving you the choice to use +:ref:`Save As ` to instead save the changes in a new, regular +blend-file. + +Currently, only brush assets support this feature. + + Design Limitations ================== -Blender is **not allowed to write to other blend-files** than the one you have currently open. -This means that to edit an asset, you have to open its blend-file. -Fortunately this is only a single click away, both in the Source List region of the Asset Browser +Blender is **not allowed to write to other blend-files** than the one you have currently open, or +the special `.asset.blend` files explained above. This means that to edit an asset, you have to +open its blend-file. Fortunately this is only a single click away, both in the Source List region of the Asset Browser and in the asset context menu. -This also means that **Blender does not copy assets into the asset library** for you. -You are responsible for placing the blend-file with the asset in an asset library directory, -and marking the asset as such. See :ref:`asset-pushing` for more on this topic. - .. _asset-libraries-future-development: -- 2.30.2 From 83394e1b6f4e716fd1bfaf3696264c9f266e4739 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 18:29:44 +0200 Subject: [PATCH 09/30] (Hopefully) finish section on asset editing operators --- manual/files/asset_libraries/introduction.rst | 11 +++++------ manual/sculpt_paint/brush/brush_management.rst | 14 +++++++++++--- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index 2e3011379..7d5203021 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -207,9 +207,7 @@ Included in this library are: - :doc:`/modeling/geometry_nodes/normals/smooth_by_angle` -.. _asset-libraries-design-limitations: - -.. _asset-system-files +.. _asset-system-files: Asset System Files (`.asset.blend` Extention) ============================================= @@ -219,14 +217,15 @@ Blender saves these assets to libraries in special files using the `.asset.blend are entirely managed by Blender's asset system, and only contain a single asset and its dependencies. -`.asset.blend` files may be deleted or overwritten by Blender's asset system at any time. Hence, -saving changes to them is highly discouraged, as they can easily be lost. Attempting to save edits -to such a file will spawn a warning popup, giving you the choice to use +`.asset.blend` files may be deleted or overwritten by Blender's asset system. Hence, saving changes +to them is highly discouraged, as they can easily be lost. Attempting to save edits to such a file +will spawn a warning popup, giving you the choice to use :ref:`Save As ` to instead save the changes in a new, regular blend-file. Currently, only brush assets support this feature. +.. _asset-libraries-design-limitations: Design Limitations ================== diff --git a/manual/sculpt_paint/brush/brush_management.rst b/manual/sculpt_paint/brush/brush_management.rst index ee56cacd2..c4c677316 100644 --- a/manual/sculpt_paint/brush/brush_management.rst +++ b/manual/sculpt_paint/brush/brush_management.rst @@ -2,7 +2,7 @@ Manage Brushes ************** -Brush assets are stored in :doc:`asset libraries ` to make them accesible from +Brush assets are stored in :doc:`asset libraries ` to make them accessible from any Blender session. There are two ways of managing brush assets: - :ref:`Asset Operators `: Create and update brush assets using utility operators @@ -17,8 +17,16 @@ any Blender session. There are two ways of managing brush assets: Asset Operators =============== -Note that only assets created via :ref:`Duplicate Asset... ` can be edited using these -operators. For others (including brush assets bundled in the Essentials library), these operations will be grayed out. +Brushes can be managed through a few operators that let Blender handle the act of saving and +updating the brushes in asset libraries for you. Assets managed this way will be saved in special +:ref:`asset system files ` using a `.asset.blend` file extension. + +.. note:: + Note that only brush assets created via :ref:`Duplicate Asset... ` + can be edited further using these asset operators. For others, these operations will be grayed + out, and :ref:`manual management ` is necessary. + + Brushes from the **Essentials** asset library cannot be edited. .. reference:: -- 2.30.2 From b9852d9c22908783067f48ce31b96326f3850d17 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 19:02:50 +0200 Subject: [PATCH 10/30] Document asset shelf regions for 3D View and Image Editor --- manual/editors/3dview/introduction.rst | 8 ++++++++ manual/editors/image/introduction.rst | 9 +++++++++ 2 files changed, 17 insertions(+) diff --git a/manual/editors/3dview/introduction.rst b/manual/editors/3dview/introduction.rst index 221762e46..7129bbfc8 100644 --- a/manual/editors/3dview/introduction.rst +++ b/manual/editors/3dview/introduction.rst @@ -110,3 +110,11 @@ The Sidebar region contains properties of the active object and tool, as well as of the viewport itself. See :doc:`Sidebar ` for more information. + +Asset Shelf Region +================== + +Depending on the current mode, the asset shelf may be available, providing quick access to assets +for this specific mode (for example pose assets in *Pose Mode*, brush assets in *Sculpt Mode*). + +See :ref:`ui-region-asset_shelf` for more information. \ No newline at end of file diff --git a/manual/editors/image/introduction.rst b/manual/editors/image/introduction.rst index fbf7f588e..6788afe1e 100644 --- a/manual/editors/image/introduction.rst +++ b/manual/editors/image/introduction.rst @@ -123,6 +123,15 @@ Display Channels Single color channel visualized as a grayscale image. +Asset Shelf Region +================== + +Depending on the current mode, the asset shelf may be available, providing quick access to assets +for this specific mode (for example brush assets in *Paint* mode). + +See :ref:`ui-region-asset_shelf` for more information. + + Main View ========= -- 2.30.2 From f72cb6c30132d992730d3e7b8cc596e467587de2 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 19:45:21 +0200 Subject: [PATCH 11/30] Fill section on manual brush management, add/correct pictures --- manual/editors/outliner/interface.rst | 3 ++ manual/files/asset_libraries/introduction.rst | 2 + ...brush_brush-management_asset-operators.png | 3 ++ ...t_brush_brush-management_mark-as-asset.png | 3 ++ ...brush_brush-management_asset-operators.png | 3 -- .../sculpt_paint/brush/brush_management.rst | 43 +++++++++++++------ 6 files changed, 42 insertions(+), 15 deletions(-) create mode 100644 manual/images/sculpt-paint_brush_brush-management_asset-operators.png create mode 100644 manual/images/sculpt-paint_brush_brush-management_mark-as-asset.png delete mode 100644 manual/images/sculpt_paint_brush_brush-management_asset-operators.png diff --git a/manual/editors/outliner/interface.rst b/manual/editors/outliner/interface.rst index 34f28f87c..ab0ab4660 100644 --- a/manual/editors/outliner/interface.rst +++ b/manual/editors/outliner/interface.rst @@ -20,6 +20,9 @@ It helps to narrow the list of objects so that you can find things quickly and e Shows all the collections and objects in the current view layer. :Video Sequencer: Lists data, images and videos, that are used by the :doc:`Video Sequencer `. + +.. _outliner-blender-file-mode: + :Blender File: Lists all data in the current blend-file. :Data API: diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index 7d5203021..1052288dc 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -100,6 +100,8 @@ When the current blend-file is part of an asset library, you can also see its as The assets that are in the current file are marked with an icon; only those are editable. +.. _asset-life-cycle: + Life Cycle of an Asset ====================== diff --git a/manual/images/sculpt-paint_brush_brush-management_asset-operators.png b/manual/images/sculpt-paint_brush_brush-management_asset-operators.png new file mode 100644 index 000000000..71cc794ef --- /dev/null +++ b/manual/images/sculpt-paint_brush_brush-management_asset-operators.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d07db4d767520d58b9952eb988f5f6f3d671d66c439819f30b23d91113f9b82 +size 74423 diff --git a/manual/images/sculpt-paint_brush_brush-management_mark-as-asset.png b/manual/images/sculpt-paint_brush_brush-management_mark-as-asset.png new file mode 100644 index 000000000..a1b741ae4 --- /dev/null +++ b/manual/images/sculpt-paint_brush_brush-management_mark-as-asset.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14036c81893916ecb742c2a303e1b0646e1bb51a960b16862ec02d7500b68816 +size 124883 diff --git a/manual/images/sculpt_paint_brush_brush-management_asset-operators.png b/manual/images/sculpt_paint_brush_brush-management_asset-operators.png deleted file mode 100644 index fbdd119c4..000000000 --- a/manual/images/sculpt_paint_brush_brush-management_asset-operators.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:aa0fbeab9c72d8cabd15f6cd1564011d665f4a7657e709f2cbbfabe5066d8d6f -size 68892 diff --git a/manual/sculpt_paint/brush/brush_management.rst b/manual/sculpt_paint/brush/brush_management.rst index c4c677316..efa206e7a 100644 --- a/manual/sculpt_paint/brush/brush_management.rst +++ b/manual/sculpt_paint/brush/brush_management.rst @@ -5,12 +5,13 @@ Manage Brushes Brush assets are stored in :doc:`asset libraries ` to make them accessible from any Blender session. There are two ways of managing brush assets: -- :ref:`Asset Operators `: Create and update brush assets using utility operators - from any Blender file. Storage is managed by Blender. Convenient for simple "on the fly" management of personal brush +- Using :ref:`asset operators `: Create and update brush assets + using utility operators from any Blender file. Storage is managed by Blender. Convenient for + simple "on the fly" management of personal brush asset libraries. -- :ref:`Manual Storage `: Create and update brush assets by opening blend files within asset - libraries, and managing brush asset data-blocks in there. Useful for careful curation of asset libraries, especially - to prepare them for sharing with others. +- Using :ref:`manual storage `: Create and update brush assets by opening + blend files within asset libraries, and managing brush asset data-blocks in there. Useful for + careful curation of asset libraries, especially to prepare them for sharing with others. .. _brush-management-utility-operators: @@ -22,11 +23,11 @@ updating the brushes in asset libraries for you. Assets managed this way will be :ref:`asset system files ` using a `.asset.blend` file extension. .. note:: - Note that only brush assets created via :ref:`Duplicate Asset... ` + Note that only brush assets created via :ref:`Duplicate Asset ` can be edited further using these asset operators. For others, these operations will be grayed out, and :ref:`manual management ` is necessary. - Brushes from the **Essentials** asset library cannot be edited. + Brushes from the *Essentials* asset library cannot be edited. .. reference:: @@ -35,11 +36,11 @@ updating the brushes in asset libraries for you. Assets managed this way will be :menuselection:`Properties --> Tool --> Brush Asset` :Menu: :menuselection:`Asset Shelf --> Context Menu` -.. figure:: /images/sculpt_paint_brush_brush-management_asset-operators.png +.. figure:: /images/sculpt-paint_brush_brush-management_asset-operators.png :align: right :width: 300 - Brush Asset panel in the tool settings showing asset operators. + Brush Asset panel in the Sidebar showing asset operators. .. _bpy.ops.brush.asset_save_as: @@ -82,6 +83,24 @@ Revert to Asset Manual Storage ============== -It is also possible to manually manage brushes in blend-files. By marking brushes as assets and saving the file in an -Asset Library, they become available from any Blender session. This gives full control over managing storage, and is -particularly useful for curating asset libraries that can be shared with others. +.. seealso:: + :ref:`asset-life-cycle` + Complete description of the manual asset create, edit, share and use workflow. + +It is also possible to manually manage brushes in blend-files like any other asset data-block. By +marking brushes as assets and saving the file in an asset library, they become available from any +Blender session. This gives full control over how assets are stored, and is particularly useful for +curating asset libraries that can be shared with others. + +.. figure:: /images/sculpt-paint_brush_brush-management_mark-as-asset.png + :align: right + :width: 350 + + The *Mark as Asset* operator used on a brush in the Outliner. + +Brushes can be imported as normal data-blocks from other files (including from `.asset.blend` files +from an asset library) through :ref:`appending `. In the +:ref:`Blender File ` mode of the Outliner, the brush will be listed +under *Brushes*. Right-click the brush and select *Mark as Asset*. By saving the file inside of +an asset library directory, the asset becomes available from all Blender sessions. If necessary, +configure an asset library directory in the Preferences. -- 2.30.2 From b92ba2912e4301f906485a0ddc7977f673377e20 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 19:54:17 +0200 Subject: [PATCH 12/30] Remove unnecessary picture of brush cursor This picture doesn't seem useful in any way, it's basically just a picture of a circle. Instead, this page has a screenshot of the asset view now, that I much rather draw attention to. The previews of brushes visually explain the working of brushes well. --- .../images/sculpt-paint_brush_introduction_brush-circle.png | 3 --- manual/sculpt_paint/brush/introduction.rst | 5 ----- 2 files changed, 8 deletions(-) delete mode 100644 manual/images/sculpt-paint_brush_introduction_brush-circle.png diff --git a/manual/images/sculpt-paint_brush_introduction_brush-circle.png b/manual/images/sculpt-paint_brush_introduction_brush-circle.png deleted file mode 100644 index 524c46cbf..000000000 --- a/manual/images/sculpt-paint_brush_introduction_brush-circle.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:4cbf2842bda9ee886e6adc5d96b8a89400f592382bb0d80ff1698917f3eb09ba -size 16132 diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index e97a94974..43bb6ad16 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -6,11 +6,6 @@ Introduction ************ -.. figure:: /images/sculpt-paint_brush_introduction_brush-circle.png - :align: center - - Brush cursor. - Brushes are the main way of interacting with any painting and sculpting mode. By click & dragging in the 3D Viewport (or the Image Editor when using :doc:`Texture Paint `), the active brush creates a :doc:`stroke ` with a certain effect, depending on the used brush settings. Typically -- 2.30.2 From e34817f91535177b78d4b81afe9e0a0e7af71261 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 20:28:18 +0200 Subject: [PATCH 13/30] Document brush tool --- .../sculpt-paint_brush_introduction_brush-tool.png | 3 +++ manual/sculpt_paint/brush/introduction.rst | 10 ++++++++++ 2 files changed, 13 insertions(+) create mode 100644 manual/images/sculpt-paint_brush_introduction_brush-tool.png diff --git a/manual/images/sculpt-paint_brush_introduction_brush-tool.png b/manual/images/sculpt-paint_brush_introduction_brush-tool.png new file mode 100644 index 000000000..ee6b9d33f --- /dev/null +++ b/manual/images/sculpt-paint_brush_introduction_brush-tool.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72296e9b753fae91a312ea5679ba1b4b87a3a5ce569571abb575f48af01910e8 +size 21214 diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index 43bb6ad16..38ddc3c77 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -75,3 +75,13 @@ While it's possible to have brush data-blocks that are local to the file and not be activated for actual painting or sculpting. Use the `Mark as Asset` operator to make them brush assets that can be activated. +Brush Tool +========== + +.. figure:: /images/sculpt-paint_brush_introduction_brush-tool.png + :align: right + + The *Brush* tool. + +Painting or sculpting with brushes requires the brush tool to be active. Activating a brush from an +asset shelf or brush selector also activates the brush tool for convenience. -- 2.30.2 From 8ae426044bf18d0c0e0f2b036bc4ec9b18721d3a Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 23:45:39 +0200 Subject: [PATCH 14/30] Move all docs on brush tools to brushes --- manual/files/asset_libraries/introduction.rst | 1 + .../{tools => brushes}/add_curves.rst | 0 .../{tools => brushes}/comb_curves.rst | 0 .../{tools => brushes}/delete_curves.rst | 0 .../{tools => brushes}/density_curves.rst | 0 .../{tools => brushes}/grow_shrink_curves.rst | 0 .../{tools => brushes}/index.rst | 6 ++- .../{tools => brushes}/pinch_curves.rst | 0 .../{tools => brushes}/puff_curves.rst | 0 .../{tools => brushes}/selection_paint.rst | 0 .../{tools => brushes}/slide_curves.rst | 0 .../{tools => brushes}/smooth_curves.rst | 0 .../{tools => brushes}/snake_hook_curves.rst | 0 .../sculpt_paint/curves_sculpting/index.rst | 2 +- .../sculpting/{tools => brushes}/blob.rst | 0 .../sculpting/{tools => brushes}/boundary.rst | 0 .../sculpting/{tools => brushes}/clay.rst | 0 .../{tools => brushes}/clay_strips.rst | 0 .../{tools => brushes}/clay_thumb.rst | 0 .../sculpting/{tools => brushes}/cloth.rst | 0 .../sculpting/{tools => brushes}/crease.rst | 0 .../sculpting/{tools => brushes}/draw.rst | 0 .../{tools => brushes}/draw_facesets.rst | 0 .../{tools => brushes}/draw_sharp.rst | 0 .../{tools => brushes}/elastic_deform.rst | 0 .../sculpting/{tools => brushes}/fill.rst | 0 .../sculpting/{tools => brushes}/flatten.rst | 0 .../sculpting/{tools => brushes}/grab.rst | 0 .../sculpt_paint/sculpting/brushes/index.rst | 42 +++++++++++++++ .../sculpting/{tools => brushes}/inflate.rst | 0 .../sculpting/{tools => brushes}/layer.rst | 0 .../sculpting/{tools => brushes}/mask.rst | 0 .../{tools => brushes}/multiplane_scrape.rst | 0 .../multires_displacement_eraser.rst | 0 .../multires_displacement_smear.rst | 0 .../sculpting/{tools => brushes}/nudge.rst | 0 .../sculpting/{tools => brushes}/paint.rst | 0 .../sculpting/{tools => brushes}/pinch.rst | 0 .../sculpting/{tools => brushes}/pose.rst | 0 .../sculpting/{tools => brushes}/rotate.rst | 0 .../sculpting/{tools => brushes}/scrape.rst | 0 .../sculpting/{tools => brushes}/simplify.rst | 0 .../{tools => brushes}/slide_relax.rst | 0 .../sculpting/{tools => brushes}/smear.rst | 0 .../sculpting/{tools => brushes}/smooth.rst | 0 .../{tools => brushes}/snake_hook.rst | 0 .../sculpting/{tools => brushes}/thumb.rst | 0 manual/sculpt_paint/sculpting/index.rst | 1 + manual/sculpt_paint/sculpting/tools/index.rst | 32 ------------ .../texture_paint/{tools.rst => brushes.rst} | 8 +-- manual/sculpt_paint/texture_paint/index.rst | 2 +- manual/sculpt_paint/vertex_paint/brushes.rst | 23 ++++++++ manual/sculpt_paint/vertex_paint/index.rst | 1 + manual/sculpt_paint/vertex_paint/tools.rst | 15 +----- manual/sculpt_paint/weight_paint/brushes.rst | 52 +++++++++++++++++++ manual/sculpt_paint/weight_paint/index.rst | 1 + manual/sculpt_paint/weight_paint/tools.rst | 49 +---------------- 57 files changed, 136 insertions(+), 99 deletions(-) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/add_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/comb_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/delete_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/density_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/grow_shrink_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/index.rst (72%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/pinch_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/puff_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/selection_paint.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/slide_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/smooth_curves.rst (100%) rename manual/sculpt_paint/curves_sculpting/{tools => brushes}/snake_hook_curves.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/blob.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/boundary.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/clay.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/clay_strips.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/clay_thumb.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/cloth.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/crease.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/draw.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/draw_facesets.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/draw_sharp.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/elastic_deform.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/fill.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/flatten.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/grab.rst (100%) create mode 100644 manual/sculpt_paint/sculpting/brushes/index.rst rename manual/sculpt_paint/sculpting/{tools => brushes}/inflate.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/layer.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/mask.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/multiplane_scrape.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/multires_displacement_eraser.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/multires_displacement_smear.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/nudge.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/paint.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/pinch.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/pose.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/rotate.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/scrape.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/simplify.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/slide_relax.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/smear.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/smooth.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/snake_hook.rst (100%) rename manual/sculpt_paint/sculpting/{tools => brushes}/thumb.rst (100%) rename manual/sculpt_paint/texture_paint/{tools.rst => brushes.rst} (97%) create mode 100644 manual/sculpt_paint/vertex_paint/brushes.rst create mode 100644 manual/sculpt_paint/weight_paint/brushes.rst diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index 1052288dc..5cae1d7c9 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -207,6 +207,7 @@ Included in this library are: - :doc:`Hair node groups ` - :doc:`/modeling/geometry_nodes/normals/smooth_by_angle` +- :doc:`Sculpt Brushes ` .. _asset-system-files: diff --git a/manual/sculpt_paint/curves_sculpting/tools/add_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/add_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/add_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/add_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/comb_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/comb_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/comb_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/comb_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/delete_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/delete_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/delete_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/delete_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/density_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/density_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/density_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/density_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/grow_shrink_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/grow_shrink_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/grow_shrink_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/grow_shrink_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/index.rst b/manual/sculpt_paint/curves_sculpting/brushes/index.rst similarity index 72% rename from manual/sculpt_paint/curves_sculpting/tools/index.rst rename to manual/sculpt_paint/curves_sculpting/brushes/index.rst index 6ebce7ea1..5be284036 100644 --- a/manual/sculpt_paint/curves_sculpting/tools/index.rst +++ b/manual/sculpt_paint/curves_sculpting/brushes/index.rst @@ -1,8 +1,10 @@ ######### - Tools + Brushes ######### +Brushes for Curves *Sculpt Mode* bundled in the *Essentials* library. + .. toctree:: :maxdepth: 1 @@ -16,4 +18,4 @@ pinch_curves.rst puff_curves.rst smooth_curves.rst - slide_curves.rst + slide_curves.rst \ No newline at end of file diff --git a/manual/sculpt_paint/curves_sculpting/tools/pinch_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/pinch_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/pinch_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/pinch_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/puff_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/puff_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/puff_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/puff_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/selection_paint.rst b/manual/sculpt_paint/curves_sculpting/brushes/selection_paint.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/selection_paint.rst rename to manual/sculpt_paint/curves_sculpting/brushes/selection_paint.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/slide_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/slide_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/slide_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/slide_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/smooth_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/smooth_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/smooth_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/smooth_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/tools/snake_hook_curves.rst b/manual/sculpt_paint/curves_sculpting/brushes/snake_hook_curves.rst similarity index 100% rename from manual/sculpt_paint/curves_sculpting/tools/snake_hook_curves.rst rename to manual/sculpt_paint/curves_sculpting/brushes/snake_hook_curves.rst diff --git a/manual/sculpt_paint/curves_sculpting/index.rst b/manual/sculpt_paint/curves_sculpting/index.rst index 85fc5af24..d73f7d9b6 100644 --- a/manual/sculpt_paint/curves_sculpting/index.rst +++ b/manual/sculpt_paint/curves_sculpting/index.rst @@ -9,5 +9,5 @@ :maxdepth: 2 introduction.rst - tools/index.rst + brushes/index.rst tools_settings.rst diff --git a/manual/sculpt_paint/sculpting/tools/blob.rst b/manual/sculpt_paint/sculpting/brushes/blob.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/blob.rst rename to manual/sculpt_paint/sculpting/brushes/blob.rst diff --git a/manual/sculpt_paint/sculpting/tools/boundary.rst b/manual/sculpt_paint/sculpting/brushes/boundary.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/boundary.rst rename to manual/sculpt_paint/sculpting/brushes/boundary.rst diff --git a/manual/sculpt_paint/sculpting/tools/clay.rst b/manual/sculpt_paint/sculpting/brushes/clay.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/clay.rst rename to manual/sculpt_paint/sculpting/brushes/clay.rst diff --git a/manual/sculpt_paint/sculpting/tools/clay_strips.rst b/manual/sculpt_paint/sculpting/brushes/clay_strips.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/clay_strips.rst rename to manual/sculpt_paint/sculpting/brushes/clay_strips.rst diff --git a/manual/sculpt_paint/sculpting/tools/clay_thumb.rst b/manual/sculpt_paint/sculpting/brushes/clay_thumb.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/clay_thumb.rst rename to manual/sculpt_paint/sculpting/brushes/clay_thumb.rst diff --git a/manual/sculpt_paint/sculpting/tools/cloth.rst b/manual/sculpt_paint/sculpting/brushes/cloth.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/cloth.rst rename to manual/sculpt_paint/sculpting/brushes/cloth.rst diff --git a/manual/sculpt_paint/sculpting/tools/crease.rst b/manual/sculpt_paint/sculpting/brushes/crease.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/crease.rst rename to manual/sculpt_paint/sculpting/brushes/crease.rst diff --git a/manual/sculpt_paint/sculpting/tools/draw.rst b/manual/sculpt_paint/sculpting/brushes/draw.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/draw.rst rename to manual/sculpt_paint/sculpting/brushes/draw.rst diff --git a/manual/sculpt_paint/sculpting/tools/draw_facesets.rst b/manual/sculpt_paint/sculpting/brushes/draw_facesets.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/draw_facesets.rst rename to manual/sculpt_paint/sculpting/brushes/draw_facesets.rst diff --git a/manual/sculpt_paint/sculpting/tools/draw_sharp.rst b/manual/sculpt_paint/sculpting/brushes/draw_sharp.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/draw_sharp.rst rename to manual/sculpt_paint/sculpting/brushes/draw_sharp.rst diff --git a/manual/sculpt_paint/sculpting/tools/elastic_deform.rst b/manual/sculpt_paint/sculpting/brushes/elastic_deform.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/elastic_deform.rst rename to manual/sculpt_paint/sculpting/brushes/elastic_deform.rst diff --git a/manual/sculpt_paint/sculpting/tools/fill.rst b/manual/sculpt_paint/sculpting/brushes/fill.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/fill.rst rename to manual/sculpt_paint/sculpting/brushes/fill.rst diff --git a/manual/sculpt_paint/sculpting/tools/flatten.rst b/manual/sculpt_paint/sculpting/brushes/flatten.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/flatten.rst rename to manual/sculpt_paint/sculpting/brushes/flatten.rst diff --git a/manual/sculpt_paint/sculpting/tools/grab.rst b/manual/sculpt_paint/sculpting/brushes/grab.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/grab.rst rename to manual/sculpt_paint/sculpting/brushes/grab.rst diff --git a/manual/sculpt_paint/sculpting/brushes/index.rst b/manual/sculpt_paint/sculpting/brushes/index.rst new file mode 100644 index 000000000..5a89b1aed --- /dev/null +++ b/manual/sculpt_paint/sculpting/brushes/index.rst @@ -0,0 +1,42 @@ + +######### + Brushes +######### + +Brushes for *Sculpt Mode* bundled in the *Essentials* library. + +.. toctree:: + :maxdepth: 1 + + draw.rst + draw_sharp.rst + clay.rst + clay_strips.rst + clay_thumb.rst + layer.rst + inflate.rst + blob.rst + crease.rst + smooth.rst + flatten.rst + fill.rst + scrape.rst + multiplane_scrape.rst + pinch.rst + grab.rst + elastic_deform.rst + snake_hook.rst + thumb.rst + pose.rst + nudge.rst + rotate.rst + slide_relax.rst + boundary.rst + cloth.rst + simplify.rst + mask.rst + draw_facesets.rst + multires_displacement_eraser.rst + multires_displacement_smear.rst + paint.rst + smear.rst \ No newline at end of file diff --git a/manual/sculpt_paint/sculpting/tools/inflate.rst b/manual/sculpt_paint/sculpting/brushes/inflate.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/inflate.rst rename to manual/sculpt_paint/sculpting/brushes/inflate.rst diff --git a/manual/sculpt_paint/sculpting/tools/layer.rst b/manual/sculpt_paint/sculpting/brushes/layer.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/layer.rst rename to manual/sculpt_paint/sculpting/brushes/layer.rst diff --git a/manual/sculpt_paint/sculpting/tools/mask.rst b/manual/sculpt_paint/sculpting/brushes/mask.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/mask.rst rename to manual/sculpt_paint/sculpting/brushes/mask.rst diff --git a/manual/sculpt_paint/sculpting/tools/multiplane_scrape.rst b/manual/sculpt_paint/sculpting/brushes/multiplane_scrape.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/multiplane_scrape.rst rename to manual/sculpt_paint/sculpting/brushes/multiplane_scrape.rst diff --git a/manual/sculpt_paint/sculpting/tools/multires_displacement_eraser.rst b/manual/sculpt_paint/sculpting/brushes/multires_displacement_eraser.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/multires_displacement_eraser.rst rename to manual/sculpt_paint/sculpting/brushes/multires_displacement_eraser.rst diff --git a/manual/sculpt_paint/sculpting/tools/multires_displacement_smear.rst b/manual/sculpt_paint/sculpting/brushes/multires_displacement_smear.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/multires_displacement_smear.rst rename to manual/sculpt_paint/sculpting/brushes/multires_displacement_smear.rst diff --git a/manual/sculpt_paint/sculpting/tools/nudge.rst b/manual/sculpt_paint/sculpting/brushes/nudge.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/nudge.rst rename to manual/sculpt_paint/sculpting/brushes/nudge.rst diff --git a/manual/sculpt_paint/sculpting/tools/paint.rst b/manual/sculpt_paint/sculpting/brushes/paint.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/paint.rst rename to manual/sculpt_paint/sculpting/brushes/paint.rst diff --git a/manual/sculpt_paint/sculpting/tools/pinch.rst b/manual/sculpt_paint/sculpting/brushes/pinch.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/pinch.rst rename to manual/sculpt_paint/sculpting/brushes/pinch.rst diff --git a/manual/sculpt_paint/sculpting/tools/pose.rst b/manual/sculpt_paint/sculpting/brushes/pose.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/pose.rst rename to manual/sculpt_paint/sculpting/brushes/pose.rst diff --git a/manual/sculpt_paint/sculpting/tools/rotate.rst b/manual/sculpt_paint/sculpting/brushes/rotate.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/rotate.rst rename to manual/sculpt_paint/sculpting/brushes/rotate.rst diff --git a/manual/sculpt_paint/sculpting/tools/scrape.rst b/manual/sculpt_paint/sculpting/brushes/scrape.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/scrape.rst rename to manual/sculpt_paint/sculpting/brushes/scrape.rst diff --git a/manual/sculpt_paint/sculpting/tools/simplify.rst b/manual/sculpt_paint/sculpting/brushes/simplify.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/simplify.rst rename to manual/sculpt_paint/sculpting/brushes/simplify.rst diff --git a/manual/sculpt_paint/sculpting/tools/slide_relax.rst b/manual/sculpt_paint/sculpting/brushes/slide_relax.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/slide_relax.rst rename to manual/sculpt_paint/sculpting/brushes/slide_relax.rst diff --git a/manual/sculpt_paint/sculpting/tools/smear.rst b/manual/sculpt_paint/sculpting/brushes/smear.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/smear.rst rename to manual/sculpt_paint/sculpting/brushes/smear.rst diff --git a/manual/sculpt_paint/sculpting/tools/smooth.rst b/manual/sculpt_paint/sculpting/brushes/smooth.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/smooth.rst rename to manual/sculpt_paint/sculpting/brushes/smooth.rst diff --git a/manual/sculpt_paint/sculpting/tools/snake_hook.rst b/manual/sculpt_paint/sculpting/brushes/snake_hook.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/snake_hook.rst rename to manual/sculpt_paint/sculpting/brushes/snake_hook.rst diff --git a/manual/sculpt_paint/sculpting/tools/thumb.rst b/manual/sculpt_paint/sculpting/brushes/thumb.rst similarity index 100% rename from manual/sculpt_paint/sculpting/tools/thumb.rst rename to manual/sculpt_paint/sculpting/brushes/thumb.rst diff --git a/manual/sculpt_paint/sculpting/index.rst b/manual/sculpt_paint/sculpting/index.rst index d267abf9f..91ab4e57a 100644 --- a/manual/sculpt_paint/sculpting/index.rst +++ b/manual/sculpt_paint/sculpting/index.rst @@ -10,6 +10,7 @@ :maxdepth: 2 introduction/index.rst + brushes/index.rst toolbar.rst tools/index.rst tool_settings/index.rst diff --git a/manual/sculpt_paint/sculpting/tools/index.rst b/manual/sculpt_paint/sculpting/tools/index.rst index 007ea3672..f16260796 100644 --- a/manual/sculpt_paint/sculpting/tools/index.rst +++ b/manual/sculpt_paint/sculpting/tools/index.rst @@ -6,38 +6,6 @@ .. toctree:: :maxdepth: 1 - draw.rst - draw_sharp.rst - clay.rst - clay_strips.rst - clay_thumb.rst - layer.rst - inflate.rst - blob.rst - crease.rst - smooth.rst - flatten.rst - fill.rst - scrape.rst - multiplane_scrape.rst - pinch.rst - grab.rst - elastic_deform.rst - snake_hook.rst - thumb.rst - pose.rst - nudge.rst - rotate.rst - slide_relax.rst - boundary.rst - cloth.rst - simplify.rst - mask.rst - draw_facesets.rst - multires_displacement_eraser.rst - multires_displacement_smear.rst - paint.rst - smear.rst mask_tools.rst hide_tools.rst face_set_tools.rst diff --git a/manual/sculpt_paint/texture_paint/tools.rst b/manual/sculpt_paint/texture_paint/brushes.rst similarity index 97% rename from manual/sculpt_paint/texture_paint/tools.rst rename to manual/sculpt_paint/texture_paint/brushes.rst index f72488236..d6efe3370 100644 --- a/manual/sculpt_paint/texture_paint/tools.rst +++ b/manual/sculpt_paint/texture_paint/brushes.rst @@ -1,7 +1,9 @@ -******************* -Texture Paint Tools -******************* +******* +Brushes +******* + +Brushes for *Texture Paint* bundled in the *Essentials* library. Draw The normal brush, paints a swath of color. diff --git a/manual/sculpt_paint/texture_paint/index.rst b/manual/sculpt_paint/texture_paint/index.rst index 6cd6e51ac..ba95a04d8 100644 --- a/manual/sculpt_paint/texture_paint/index.rst +++ b/manual/sculpt_paint/texture_paint/index.rst @@ -9,5 +9,5 @@ :maxdepth: 2 introduction.rst - tools.rst + brushes.rst tool_settings/index.rst diff --git a/manual/sculpt_paint/vertex_paint/brushes.rst b/manual/sculpt_paint/vertex_paint/brushes.rst new file mode 100644 index 000000000..9177faa39 --- /dev/null +++ b/manual/sculpt_paint/vertex_paint/brushes.rst @@ -0,0 +1,23 @@ + +******* +Brushes +******* + +Brushes for *Vertex Paint* bundled in the *Essentials* library. + +Draw + Paints a specified color over the object. + +Blur + Smooths out the colors of adjacent vertices. In this mode the Color + Value is ignored. The strength defines how much the colors are blurred. + +Average + Smooths color by painting the average resulting color from all colors under the brush. + +Smear + Smudges colors by grabbing the colors under the brush and "dragging" them. + This can be imagined as a finger painting tool. + +Brush + Tool to use for any of the vertex paint :doc:`brushes `. diff --git a/manual/sculpt_paint/vertex_paint/index.rst b/manual/sculpt_paint/vertex_paint/index.rst index c539ed07c..da31c5c62 100644 --- a/manual/sculpt_paint/vertex_paint/index.rst +++ b/manual/sculpt_paint/vertex_paint/index.rst @@ -10,6 +10,7 @@ :maxdepth: 2 introduction.rst + brushes.rst tools.rst tool_settings/index.rst editing.rst diff --git a/manual/sculpt_paint/vertex_paint/tools.rst b/manual/sculpt_paint/vertex_paint/tools.rst index fb5e4b532..3ce6cbb9f 100644 --- a/manual/sculpt_paint/vertex_paint/tools.rst +++ b/manual/sculpt_paint/vertex_paint/tools.rst @@ -3,19 +3,8 @@ Vertex Paint Tools ****************** -Draw - Paints a specified color over the object. - -Blur - Smooths out the colors of adjacent vertices. In this mode the Color - Value is ignored. The strength defines how much the colors are blurred. - -Average - Smooths color by painting the average resulting color from all colors under the brush. - -Smear - Smudges colors by grabbing the colors under the brush and "dragging" them. - This can be imagined as a finger painting tool. +Brush + Tool to use for any of the vertex paint :doc:`brushes `. :ref:`Annotate ` Draw free-hand annotation. diff --git a/manual/sculpt_paint/weight_paint/brushes.rst b/manual/sculpt_paint/weight_paint/brushes.rst new file mode 100644 index 000000000..226594efe --- /dev/null +++ b/manual/sculpt_paint/weight_paint/brushes.rst @@ -0,0 +1,52 @@ + +******* +Brushes +******* + +Draw + Paints a specified weight over the object. + + Blend + The brush :term:`Blend Modes` defines in which way the weight value is + applied to the vertex group while painting. + + Mix + In this Blending mode the Weight value defines the *target weight* + that will eventually be reached when you paint long enough on the same + location of the mesh. And the strength determines how many strokes + you need to place at the target weight. Note that for strength = 1.0 + the target weight is painted immediately and for Weight = 0.0 the brush just does nothing. + Add + In this Blending mode the specified weight value is *added* to the vertex weights. + The strength determines which fraction of the weight gets added per stroke. + However, the brush will not paint weight values above 1.0. + Subtract + In this Blending mode the specified weight value is *subtracted* from the vertex weights. + The strength determines which fraction of the weight gets removed per stroke. + However, the brush will not paint weight values below 0.0. + Lighten + In this Blending mode the specified weight value is interpreted as the target weight. + Very similar to the Mix Blending mode, but only weights below the target weight are affected. + Weights above the target weight remain unchanged. + Darken + This Blending mode is very similar to the Lighten Blending mode. + But only weights above the target weight are affected. + Weights below the target weight remain unchanged. + Multiply + Multiplies the vertex weights with the specified weight value. + This is somewhat like subtract, but the amount of removed weight is now + dependent on the Weight value itself. + Blur + Smooths out the weighting of adjacent vertices. In this mode the Weight + Value is ignored. The strength defines how much the smoothing is applied. + +Blur + Smooths out the weighting of adjacent vertices. In this mode the Weight + Value is ignored. The strength defines how much the smoothing is applied. + +Average + Smooths weights by painting the average resulting weight from all weights under the brush. + +Smear + Smudges weights by grabbing the weights under the brush and "dragging" them. + This can be imagined as a finger painting tool. diff --git a/manual/sculpt_paint/weight_paint/index.rst b/manual/sculpt_paint/weight_paint/index.rst index f33b661a7..840810442 100644 --- a/manual/sculpt_paint/weight_paint/index.rst +++ b/manual/sculpt_paint/weight_paint/index.rst @@ -8,6 +8,7 @@ :maxdepth: 2 introduction.rst + brushes.rst tools.rst tool_settings/index.rst usage.rst diff --git a/manual/sculpt_paint/weight_paint/tools.rst b/manual/sculpt_paint/weight_paint/tools.rst index 1afdf4684..7da2f4bd3 100644 --- a/manual/sculpt_paint/weight_paint/tools.rst +++ b/manual/sculpt_paint/weight_paint/tools.rst @@ -3,53 +3,8 @@ Weight Paint Tools ****************** -Draw - Paints a specified weight over the object. - - Blend - The brush :term:`Blend Modes` defines in which way the weight value is - applied to the vertex group while painting. - - Mix - In this Blending mode the Weight value defines the *target weight* - that will eventually be reached when you paint long enough on the same - location of the mesh. And the strength determines how many strokes - you need to place at the target weight. Note that for strength = 1.0 - the target weight is painted immediately and for Weight = 0.0 the brush just does nothing. - Add - In this Blending mode the specified weight value is *added* to the vertex weights. - The strength determines which fraction of the weight gets added per stroke. - However, the brush will not paint weight values above 1.0. - Subtract - In this Blending mode the specified weight value is *subtracted* from the vertex weights. - The strength determines which fraction of the weight gets removed per stroke. - However, the brush will not paint weight values below 0.0. - Lighten - In this Blending mode the specified weight value is interpreted as the target weight. - Very similar to the Mix Blending mode, but only weights below the target weight are affected. - Weights above the target weight remain unchanged. - Darken - This Blending mode is very similar to the Lighten Blending mode. - But only weights above the target weight are affected. - Weights below the target weight remain unchanged. - Multiply - Multiplies the vertex weights with the specified weight value. - This is somewhat like subtract, but the amount of removed weight is now - dependent on the Weight value itself. - Blur - Smooths out the weighting of adjacent vertices. In this mode the Weight - Value is ignored. The strength defines how much the smoothing is applied. - -Blur - Smooths out the weighting of adjacent vertices. In this mode the Weight - Value is ignored. The strength defines how much the smoothing is applied. - -Average - Smooths weights by painting the average resulting weight from all weights under the brush. - -Smear - Smudges weights by grabbing the weights under the brush and "dragging" them. - This can be imagined as a finger painting tool. +Brush + Tool to use for any of the weight paint :doc:`brushes `. Gradient Applies a linear/radial weight gradient; -- 2.30.2 From 279abfa1bf422bea7cfd0dbc62579e887ac74ecf Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Wed, 3 Jul 2024 23:49:47 +0200 Subject: [PATCH 15/30] Add links to brushes from essentials library section --- manual/files/asset_libraries/introduction.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index 5cae1d7c9..673def963 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -207,8 +207,12 @@ Included in this library are: - :doc:`Hair node groups ` - :doc:`/modeling/geometry_nodes/normals/smooth_by_angle` -- :doc:`Sculpt Brushes ` - +- Brushes: + - :doc:`Mesh Sculpt` + - :doc:`Curve Sculpt` + - :doc:`Texture Paint` + - :doc:`Vertex Paint` + - :doc:`Weight Paint` .. _asset-system-files: -- 2.30.2 From e1935ffc199128f2b5566f30f8d0bcae44872e75 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 09:29:20 +0200 Subject: [PATCH 16/30] Correct formatting --- manual/files/asset_libraries/introduction.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index 673def963..b33692ae3 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -208,11 +208,12 @@ Included in this library are: - :doc:`Hair node groups ` - :doc:`/modeling/geometry_nodes/normals/smooth_by_angle` - Brushes: - - :doc:`Mesh Sculpt` - - :doc:`Curve Sculpt` - - :doc:`Texture Paint` - - :doc:`Vertex Paint` - - :doc:`Weight Paint` + + - :doc:`Mesh Sculpt` + - :doc:`Curve Sculpt` + - :doc:`Texture Paint` + - :doc:`Vertex Paint` + - :doc:`Weight Paint` .. _asset-system-files: -- 2.30.2 From d4f4bb27125caae6fed818d3f02bd3e1aea56ae1 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 09:43:17 +0200 Subject: [PATCH 17/30] Ensure brush tool is listed in all list of tools --- .../sculpt_paint/sculpting/tools/brush_tool.rst | 15 +++++++++++++++ manual/sculpt_paint/sculpting/tools/index.rst | 1 + manual/sculpt_paint/vertex_paint/brushes.rst | 2 +- 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 manual/sculpt_paint/sculpting/tools/brush_tool.rst diff --git a/manual/sculpt_paint/sculpting/tools/brush_tool.rst b/manual/sculpt_paint/sculpting/tools/brush_tool.rst new file mode 100644 index 000000000..b60179166 --- /dev/null +++ b/manual/sculpt_paint/sculpting/tools/brush_tool.rst @@ -0,0 +1,15 @@ +***** +Brush +***** + +.. reference:: + + :Mode: Sculpt Mode + :Tool: :menuselection:`Toolbar --> Brush` + + +Tool to use for any of the *Sculpt* mode brushes. Activating a brush from an asset shelf or brush +asset selector will also activate this tool for convenience. + +See :doc:`brushes ` for a detailed list of all brushes and their +options. diff --git a/manual/sculpt_paint/sculpting/tools/index.rst b/manual/sculpt_paint/sculpting/tools/index.rst index f16260796..8f8df4018 100644 --- a/manual/sculpt_paint/sculpting/tools/index.rst +++ b/manual/sculpt_paint/sculpting/tools/index.rst @@ -6,6 +6,7 @@ .. toctree:: :maxdepth: 1 + brush_tool.rst mask_tools.rst hide_tools.rst face_set_tools.rst diff --git a/manual/sculpt_paint/vertex_paint/brushes.rst b/manual/sculpt_paint/vertex_paint/brushes.rst index 9177faa39..0360fabad 100644 --- a/manual/sculpt_paint/vertex_paint/brushes.rst +++ b/manual/sculpt_paint/vertex_paint/brushes.rst @@ -20,4 +20,4 @@ Smear This can be imagined as a finger painting tool. Brush - Tool to use for any of the vertex paint :doc:`brushes `. + Tool to use for any of the vertex paint :doc:`brushes `. -- 2.30.2 From c57bb2866badc60136201772b80433e2cdd83140 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 12:25:12 +0200 Subject: [PATCH 18/30] Add redirects for tools moved to brush assets --- build_files/.htaccess | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/build_files/.htaccess b/build_files/.htaccess index a9c6337c8..49d592a1b 100644 --- a/build_files/.htaccess +++ b/build_files/.htaccess @@ -256,3 +256,17 @@ RedirectMatch "^/manual/{lang}/{version}/modeling/modifiers/modify/normal_edit.h RedirectMatch "^/manual/{lang}/{version}/modeling/modifiers/modify/weighted_normal.html" "^/manual/{lang}/{version}/modeling/modifiers/normals/weighted_normal.html" RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/brush/brush.html" "^/manual/{lang}/{version}/sculpt_paint/brush/introduction.html" +# Mesh sculpting tools converted to asset +RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/sculpting/tools/\ + (blob|boundary|clay|clay_strips|clay_thumb|cloth|crease|draw|draw_facesets|draw_sharp|\ + elastic_deform|fill|flatten|grab|inflate|layer|mask|multiplane_scrape|\ + multires_displacement_eraser|multires_displacement_smear|nudge|paint|pinch|pose|\ + rotate|scrape|simplify|slide_relax|smear|smooth|snake_hook|thumb).html" \ + "^/manual/{lang}/{version}/sculpt_paint/sculpting/brushes/$1.html" +# Curve sculpting tools converted to asset +RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/curves_sculpting/tools/\ + (index|add_curves|comb_curves|delete_curves|density_curves|grow_shrink_curves|\ + pinch_curves|puff_curves|selection_paint|slide_curves|smooth_curves|snake_hook_curves).html" \ + "^/manual/{lang}/{version}/sculpt_paint/curves_sculpting/brushes/$1.html" +# Texture paint tools converted to asset +RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/texture_paint/tools.html" "^/manual/{lang}/{version}/sculpt_paint/texture_paint/brushes.html" -- 2.30.2 From 7af11af61cd68da5dfe782db371515eeec7a87d6 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 16:02:21 +0200 Subject: [PATCH 19/30] Correct links, correct names, update images, small fixes --- ...ulpting_brushes_overview-add-substract.png | 3 + ...nt_sculpting_brushes_overview-contrast.png | 3 + ...paint_sculpting_brushes_overview-paint.png | 3 + ...t_sculpting_brushes_overview-transform.png | 3 + ...t_sculpting_brushes_overview-utilities.png | 3 + ...int_sculpting_toolbar_add_subt_brushes.png | 3 - .../sculpt-paint_sculpting_toolbar_brush.png | 3 + ...int_sculpting_toolbar_contrast_brushes.png | 3 - manual/sculpt_paint/brush/brush_settings.rst | 2 +- manual/sculpt_paint/brush/texture.rst | 2 +- .../sculpt_paint/sculpting/brushes/blob.rst | 4 +- .../sculpting/brushes/boundary.rst | 10 +- .../sculpt_paint/sculpting/brushes/clay.rst | 6 +- .../sculpting/brushes/clay_strips.rst | 4 +- .../sculpting/brushes/clay_thumb.rst | 4 +- .../sculpt_paint/sculpting/brushes/cloth.rst | 2 +- .../sculpt_paint/sculpting/brushes/crease.rst | 6 +- .../brushes/{simplify.rst => density.rst} | 12 +- .../sculpt_paint/sculpting/brushes/draw.rst | 2 +- .../sculpting/brushes/draw_facesets.rst | 2 +- .../sculpting/brushes/draw_sharp.rst | 12 +- .../sculpting/brushes/elastic_deform.rst | 2 +- .../sculpt_paint/sculpting/brushes/fill.rst | 4 +- .../sculpting/brushes/flatten.rst | 8 +- .../sculpt_paint/sculpting/brushes/grab.rst | 2 +- .../sculpt_paint/sculpting/brushes/index.rst | 7 +- .../sculpting/brushes/inflate.rst | 10 +- .../sculpt_paint/sculpting/brushes/layer.rst | 4 +- .../sculpting/brushes/multiplane_scrape.rst | 4 +- .../brushes/multires_displacement_eraser.rst | 8 +- .../brushes/multires_displacement_smear.rst | 4 +- .../sculpt_paint/sculpting/brushes/nudge.rst | 4 +- .../sculpting/brushes/overview.rst | 161 ++++++++++++++++++ .../sculpt_paint/sculpting/brushes/paint.rst | 2 +- .../sculpt_paint/sculpting/brushes/pinch.rst | 8 +- .../sculpt_paint/sculpting/brushes/pose.rst | 2 +- .../sculpt_paint/sculpting/brushes/scrape.rst | 10 +- .../sculpting/brushes/slide_relax.rst | 4 +- .../sculpt_paint/sculpting/brushes/smear.rst | 2 +- .../sculpt_paint/sculpting/brushes/smooth.rst | 2 +- .../sculpting/brushes/snake_hook.rst | 4 +- .../sculpt_paint/sculpting/brushes/thumb.rst | 4 +- .../brushes/{rotate.rst => twist.rst} | 8 +- manual/sculpt_paint/sculpting/controls.rst | 4 +- .../sculpt_paint/sculpting/editing/expand.rst | 4 +- .../sculpt_paint/sculpting/editing/mask.rst | 2 +- .../sculpt_paint/sculpting/editing/sculpt.rst | 14 +- .../sculpting/introduction/adaptive.rst | 12 +- .../sculpting/introduction/brush.rst | 20 +-- .../introduction/cloth_sculpting.rst | 6 +- .../sculpting/introduction/painting.rst | 4 +- .../sculpting/introduction/transforming.rst | 6 +- .../visibility_masking_face_sets.rst | 2 +- manual/sculpt_paint/sculpting/toolbar.rst | 150 +--------------- .../sculpting/tools/brush_tool.rst | 5 +- .../sculpting/tools/cloth_filter.rst | 4 +- .../sculpting/tools/mesh_filter.rst | 12 +- manual/sculpt_paint/texture_paint/brushes.rst | 14 +- manual/sculpt_paint/vertex_paint/brushes.rst | 11 +- manual/sculpt_paint/weight_paint/brushes.rst | 8 +- 60 files changed, 334 insertions(+), 300 deletions(-) create mode 100644 manual/images/sculpt-paint_sculpting_brushes_overview-add-substract.png create mode 100644 manual/images/sculpt-paint_sculpting_brushes_overview-contrast.png create mode 100644 manual/images/sculpt-paint_sculpting_brushes_overview-paint.png create mode 100644 manual/images/sculpt-paint_sculpting_brushes_overview-transform.png create mode 100644 manual/images/sculpt-paint_sculpting_brushes_overview-utilities.png delete mode 100644 manual/images/sculpt-paint_sculpting_toolbar_add_subt_brushes.png create mode 100644 manual/images/sculpt-paint_sculpting_toolbar_brush.png delete mode 100644 manual/images/sculpt-paint_sculpting_toolbar_contrast_brushes.png rename manual/sculpt_paint/sculpting/brushes/{simplify.rst => density.rst} (84%) create mode 100644 manual/sculpt_paint/sculpting/brushes/overview.rst rename manual/sculpt_paint/sculpting/brushes/{rotate.rst => twist.rst} (86%) diff --git a/manual/images/sculpt-paint_sculpting_brushes_overview-add-substract.png b/manual/images/sculpt-paint_sculpting_brushes_overview-add-substract.png new file mode 100644 index 000000000..f5c9b290f --- /dev/null +++ b/manual/images/sculpt-paint_sculpting_brushes_overview-add-substract.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5eaa5c82062e57b5ea9ff0aab925067ec21a74b1c1f713564bd7b6acec845244 +size 147852 diff --git a/manual/images/sculpt-paint_sculpting_brushes_overview-contrast.png b/manual/images/sculpt-paint_sculpting_brushes_overview-contrast.png new file mode 100644 index 000000000..6929b4753 --- /dev/null +++ b/manual/images/sculpt-paint_sculpting_brushes_overview-contrast.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3b8989928275ba207db51942982f337788a9d8ca27d3740ac3d23e9fcc303ce8 +size 92070 diff --git a/manual/images/sculpt-paint_sculpting_brushes_overview-paint.png b/manual/images/sculpt-paint_sculpting_brushes_overview-paint.png new file mode 100644 index 000000000..04f26b94e --- /dev/null +++ b/manual/images/sculpt-paint_sculpting_brushes_overview-paint.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d763376441c6d3cdfb9a137093105cb4405712f7f302032bf00c7b66580b526c +size 32475 diff --git a/manual/images/sculpt-paint_sculpting_brushes_overview-transform.png b/manual/images/sculpt-paint_sculpting_brushes_overview-transform.png new file mode 100644 index 000000000..3f53b9331 --- /dev/null +++ b/manual/images/sculpt-paint_sculpting_brushes_overview-transform.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7365deb23e040fdb71a29e65d66b0d91daa6341c96837e25b7d4a9e7d0b203f6 +size 163291 diff --git a/manual/images/sculpt-paint_sculpting_brushes_overview-utilities.png b/manual/images/sculpt-paint_sculpting_brushes_overview-utilities.png new file mode 100644 index 000000000..a16498d8d --- /dev/null +++ b/manual/images/sculpt-paint_sculpting_brushes_overview-utilities.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8248e2dcaa3aa6c205975991481b0710b4ca5f75654ca8fe1719dc18da54443 +size 103706 diff --git a/manual/images/sculpt-paint_sculpting_toolbar_add_subt_brushes.png b/manual/images/sculpt-paint_sculpting_toolbar_add_subt_brushes.png deleted file mode 100644 index 38d05b81c..000000000 --- a/manual/images/sculpt-paint_sculpting_toolbar_add_subt_brushes.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:73dc24746414b6f882c1adede84c9c6cecb3137d0cb55d09f619c623095aef01 -size 29425 diff --git a/manual/images/sculpt-paint_sculpting_toolbar_brush.png b/manual/images/sculpt-paint_sculpting_toolbar_brush.png new file mode 100644 index 000000000..537a77678 --- /dev/null +++ b/manual/images/sculpt-paint_sculpting_toolbar_brush.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43d7dab7ea8146ba3dcaa993de51cb0d71a75c84c889ab0fd80cf31331f771ac +size 3796 diff --git a/manual/images/sculpt-paint_sculpting_toolbar_contrast_brushes.png b/manual/images/sculpt-paint_sculpting_toolbar_contrast_brushes.png deleted file mode 100644 index b5943ba11..000000000 --- a/manual/images/sculpt-paint_sculpting_toolbar_contrast_brushes.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:b68894b9d66271f09b93c8f705c2095881b99ba39c9659c874810ac69e986d06 -size 17519 diff --git a/manual/sculpt_paint/brush/brush_settings.rst b/manual/sculpt_paint/brush/brush_settings.rst index 74503929b..3faee1aa2 100644 --- a/manual/sculpt_paint/brush/brush_settings.rst +++ b/manual/sculpt_paint/brush/brush_settings.rst @@ -161,7 +161,7 @@ Deformation Target :Geometry: Deform the geometry directly. :Cloth Simulation: - Deform the mesh while a :doc:`cloth simulation ` + Deform the mesh while a :doc:`cloth simulation ` is applied to it at the same time. diff --git a/manual/sculpt_paint/brush/texture.rst b/manual/sculpt_paint/brush/texture.rst index 8e22c86de..05c5145af 100644 --- a/manual/sculpt_paint/brush/texture.rst +++ b/manual/sculpt_paint/brush/texture.rst @@ -146,5 +146,5 @@ Vector Displacement :guilabel:`Sculpt Mode` .. note:: - This is only supported for the :doc:`Draw ` brush + This is only supported for the :doc:`Draw ` brush with :ref:`Area Plane ` mapping enabled. diff --git a/manual/sculpt_paint/sculpting/brushes/blob.rst b/manual/sculpt_paint/sculpting/brushes/blob.rst index f7e102786..2a9f3edbc 100644 --- a/manual/sculpt_paint/sculpting/brushes/blob.rst +++ b/manual/sculpt_paint/sculpting/brushes/blob.rst @@ -6,9 +6,9 @@ Blob .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Blob` + :Brush: :menuselection:`Asset Shelf --> Blob` -Similar to :doc:`Draw `, +Similar to :doc:`Draw `, but vertices are pushed outwards like an inverted pinching effect. This will lead to a more consistent spherical curvature and thickening of strokes. diff --git a/manual/sculpt_paint/sculpting/brushes/boundary.rst b/manual/sculpt_paint/sculpting/brushes/boundary.rst index fdad3cc77..e434894f4 100644 --- a/manual/sculpt_paint/sculpting/brushes/boundary.rst +++ b/manual/sculpt_paint/sculpting/brushes/boundary.rst @@ -6,9 +6,9 @@ Boundary .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Boundary` + :Brush: :menuselection:`Asset Shelf --> Boundary` -Similar to the :doc:`Pose ` brush +Similar to the :doc:`Pose ` brush but deforms the open boundaries of a mesh. The tool detects the mesh boundary closest to the active vertex and propagates the deformation using the brush :doc:`Falloff ` into the mesh. @@ -61,16 +61,16 @@ Deformation Moves/extends the mesh boundary in the local X direction. Useful for extending the boundaries along the surface. :Inflate: - Works similar to the :doc:`Inflate ` tool but, + Works similar to the :doc:`Inflate ` tool but, the vertices that are inflated are constrained to the mesh boundary. :Grab: - Works similar to the :doc:`Grab ` tool but, + Works similar to the :doc:`Grab ` tool but, the vertices that are grabbed are constrained to the mesh boundary. :Twist: Rotates the active boundary around the local Z axis. Useful for creating folds like on a skirt. :Smooth: - Works similar to the :doc:`Grab ` tool but, + Works similar to the :doc:`Grab ` tool but, the vertices that are smoothed are constrained to the mesh boundary. .. _bpy.types.Brush.boundary_falloff_type: diff --git a/manual/sculpt_paint/sculpting/brushes/clay.rst b/manual/sculpt_paint/sculpting/brushes/clay.rst index 0ad92db9b..c9c88cecb 100644 --- a/manual/sculpt_paint/sculpting/brushes/clay.rst +++ b/manual/sculpt_paint/sculpting/brushes/clay.rst @@ -6,12 +6,12 @@ Clay .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Clay` + :Brush: :menuselection:`Asset Shelf --> Clay` -Similar to the :doc:`Draw ` brush, +Similar to the :doc:`Draw ` brush, but includes settings to adjust the :ref:`sculpt plane ` on which the brush acts. That's because it behaves like a combination of the -:doc:`Flatten ` and *Draw* brushes. +:doc:`Flatten ` and *Draw* brushes. This brush is useful for building and removing volumes and shapes like real clay, because it flattens details as you add/subtract from the surfaces. diff --git a/manual/sculpt_paint/sculpting/brushes/clay_strips.rst b/manual/sculpt_paint/sculpting/brushes/clay_strips.rst index 7275052a2..0fbf72bb2 100644 --- a/manual/sculpt_paint/sculpting/brushes/clay_strips.rst +++ b/manual/sculpt_paint/sculpting/brushes/clay_strips.rst @@ -6,10 +6,10 @@ Clay Strips .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Clay Strips` + :Brush: :menuselection:`Asset Shelf --> Clay Strips` :Shortcut: :kbd:`C` -Similar to the :doc:`Clay ` brush, +Similar to the :doc:`Clay ` brush, but it uses a square tip shape instead of a round one. Just like the *Clay* brush, it's useful for building and removing volumes diff --git a/manual/sculpt_paint/sculpting/brushes/clay_thumb.rst b/manual/sculpt_paint/sculpting/brushes/clay_thumb.rst index 5117bd68d..11fe0f851 100644 --- a/manual/sculpt_paint/sculpting/brushes/clay_thumb.rst +++ b/manual/sculpt_paint/sculpting/brushes/clay_thumb.rst @@ -6,9 +6,9 @@ Clay Thumb .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Clay Thumb` + :Brush: :menuselection:`Asset Shelf --> Clay Thumb` -Similar to the :doc:`/sculpt_paint/sculpting/tools/clay` brush. +Similar to the :doc:`/sculpt_paint/sculpting/brushes/clay` brush. It imitates the effect of deforming clay with the finger, accumulating material during the stroke. The sculpt plane tilts during the stroke in the front part of the brush to achieve this effect. diff --git a/manual/sculpt_paint/sculpting/brushes/cloth.rst b/manual/sculpt_paint/sculpting/brushes/cloth.rst index ef5ca1b91..00fee96d6 100644 --- a/manual/sculpt_paint/sculpting/brushes/cloth.rst +++ b/manual/sculpt_paint/sculpting/brushes/cloth.rst @@ -7,7 +7,7 @@ Cloth .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Cloth` + :Brush: :menuselection:`Asset Shelf --> Cloth` This brush simulates cloth physics on the mesh under the brush cursor. There are various deformation types and settings to customize the brush. diff --git a/manual/sculpt_paint/sculpting/brushes/crease.rst b/manual/sculpt_paint/sculpting/brushes/crease.rst index 2d8e2b1f2..e8c692e96 100644 --- a/manual/sculpt_paint/sculpting/brushes/crease.rst +++ b/manual/sculpt_paint/sculpting/brushes/crease.rst @@ -6,7 +6,7 @@ Crease .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Crease` + :Brush: :menuselection:`Asset Shelf --> Crease` :Shortcut: :kbd:`Shift-C` Create sharp indents or ridges by pushing or pulling the mesh, while pinching the vertices together. @@ -24,9 +24,9 @@ General Pinch Adds a consistent pinching effect to your stroke. If set to 0 it the brush will behave like the - :doc:`Draw ` brush. + :doc:`Draw ` brush. If set to 1 and the brush strength set to 0, the brush - will behave like a :doc:`Pinch ` brush. + will behave like a :doc:`Pinch ` brush. .. note:: diff --git a/manual/sculpt_paint/sculpting/brushes/simplify.rst b/manual/sculpt_paint/sculpting/brushes/density.rst similarity index 84% rename from manual/sculpt_paint/sculpting/brushes/simplify.rst rename to manual/sculpt_paint/sculpting/brushes/density.rst index 679d55dce..3c8abdd42 100644 --- a/manual/sculpt_paint/sculpting/brushes/simplify.rst +++ b/manual/sculpt_paint/sculpting/brushes/density.rst @@ -1,20 +1,20 @@ -******** -Simplify -******** +******* +Density +******* .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Simplify` + :Brush: :menuselection:`Asset Shelf --> Density` -The Simplify brush is specifically meant for use with +The Density brush is specifically meant for use with :doc:`/sculpt_paint/sculpting/tool_settings/dyntopo` to remove/add detail in the mesh. Even when the :ref:`Refine Method ` is set to *Subdivide Edges*, this brush is always able to collapse edges. -This ensures that while focusing on adding detail to your sculpt, the *Simplify* brush +This ensures that while focusing on adding detail to your sculpt, the *Density* brush can always be used to simplify and polish surfaces. This brush has no effect if Dyntopo is disabled. diff --git a/manual/sculpt_paint/sculpting/brushes/draw.rst b/manual/sculpt_paint/sculpting/brushes/draw.rst index dee1d6c31..b1949e4e1 100644 --- a/manual/sculpt_paint/sculpting/brushes/draw.rst +++ b/manual/sculpt_paint/sculpting/brushes/draw.rst @@ -5,7 +5,7 @@ Draw .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Draw` + :Brush: :menuselection:`Asset Shelf --> Draw` :Shortcut: :kbd:`V` Moves vertices inward or outward, based the average vertex normals within the brush radius. diff --git a/manual/sculpt_paint/sculpting/brushes/draw_facesets.rst b/manual/sculpt_paint/sculpting/brushes/draw_facesets.rst index decca1f69..f2e1b460e 100644 --- a/manual/sculpt_paint/sculpting/brushes/draw_facesets.rst +++ b/manual/sculpt_paint/sculpting/brushes/draw_facesets.rst @@ -6,7 +6,7 @@ Draw Face Sets .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Draw Face Sets` + :Brush: :menuselection:`Asset Shelf --> Draw Face Sets` Draw new or extend existing :ref:`Face Sets ` with each stroke. diff --git a/manual/sculpt_paint/sculpting/brushes/draw_sharp.rst b/manual/sculpt_paint/sculpting/brushes/draw_sharp.rst index 7a3473bee..1bb31d7ab 100644 --- a/manual/sculpt_paint/sculpting/brushes/draw_sharp.rst +++ b/manual/sculpt_paint/sculpting/brushes/draw_sharp.rst @@ -6,21 +6,21 @@ Draw Sharp .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Draw Sharp` + :Brush: :menuselection:`Asset Shelf --> Draw Sharp` -Similar to the :doc:`Draw ` brush, +Similar to the :doc:`Draw ` brush, but it always deforms the mesh from the original coordinates and uses the *Sharper* Falloff by default. Draw Sharp is useful on high density meshes for creating cloth wrinkles, stylized hair or hard surface edges. To further sharpen or polish sharp edges in the case that the mesh density is not enough, -it's recommended to use the :doc:`Pinch `, -:doc:`Crease ` or -:doc:`Multiplane Scrape ` brushes. +it's recommended to use the :doc:`Pinch `, +:doc:`Crease ` or +:doc:`Multiplane Scrape ` brushes. A limitation is that the brush does not remesh the sculpted surfaces with :ref:`Dyntopo ` enabled. -Because of that, a better brush to use with Dyntopo can be :doc:`Crease `. +Because of that, a better brush to use with Dyntopo can be :doc:`Crease `. Brush Settings diff --git a/manual/sculpt_paint/sculpting/brushes/elastic_deform.rst b/manual/sculpt_paint/sculpting/brushes/elastic_deform.rst index dd731e406..af9669b24 100644 --- a/manual/sculpt_paint/sculpting/brushes/elastic_deform.rst +++ b/manual/sculpt_paint/sculpting/brushes/elastic_deform.rst @@ -6,7 +6,7 @@ Elastic Deform .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Elastic Deform` + :Brush: :menuselection:`Asset Shelf --> Elastic Deform` Used to simulate realistic deformations such as grabbing or twisting of :term:`Elastic` objects. For example, this tool works great for modeling the shape of organic objects such as humans or animals. diff --git a/manual/sculpt_paint/sculpting/brushes/fill.rst b/manual/sculpt_paint/sculpting/brushes/fill.rst index f2c38bdb4..b21e93d31 100644 --- a/manual/sculpt_paint/sculpting/brushes/fill.rst +++ b/manual/sculpt_paint/sculpting/brushes/fill.rst @@ -6,9 +6,9 @@ Fill .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Fill` + :Brush: :menuselection:`Asset Shelf --> Fill` -Similar to the :doc:`Flatten ` brush, +Similar to the :doc:`Flatten ` brush, but only pushes surfaces upwards to the medium height. Although :kbd:`Ctrl` can be held to invert the effect to a Scrape brush, diff --git a/manual/sculpt_paint/sculpting/brushes/flatten.rst b/manual/sculpt_paint/sculpting/brushes/flatten.rst index a80e4c8f3..3caf265cf 100644 --- a/manual/sculpt_paint/sculpting/brushes/flatten.rst +++ b/manual/sculpt_paint/sculpting/brushes/flatten.rst @@ -1,12 +1,12 @@ -******* -Flatten -******* +**************** +Flatten/Contrast +**************** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Flatten` + :Brush: :menuselection:`Asset Shelf --> Flatten/Contrast` Flatten or contrast surfaces by pulling and pushing them towards (or away from) a defined medium height. diff --git a/manual/sculpt_paint/sculpting/brushes/grab.rst b/manual/sculpt_paint/sculpting/brushes/grab.rst index 5ac76ce5f..9d363ee78 100644 --- a/manual/sculpt_paint/sculpting/brushes/grab.rst +++ b/manual/sculpt_paint/sculpting/brushes/grab.rst @@ -6,7 +6,7 @@ Grab .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Grab` + :Brush: :menuselection:`Asset Shelf --> Grab` :Shortcut: :kbd:`G` Drag geometry across the screen, following the cursor. diff --git a/manual/sculpt_paint/sculpting/brushes/index.rst b/manual/sculpt_paint/sculpting/brushes/index.rst index 5a89b1aed..b5d301b70 100644 --- a/manual/sculpt_paint/sculpting/brushes/index.rst +++ b/manual/sculpt_paint/sculpting/brushes/index.rst @@ -8,6 +8,7 @@ Brushes for *Sculpt Mode* bundled in the *Essentials* library. .. toctree:: :maxdepth: 1 + overview.rst draw.rst draw_sharp.rst clay.rst @@ -29,14 +30,14 @@ Brushes for *Sculpt Mode* bundled in the *Essentials* library. thumb.rst pose.rst nudge.rst - rotate.rst + twist.rst slide_relax.rst boundary.rst cloth.rst - simplify.rst + density.rst mask.rst draw_facesets.rst multires_displacement_eraser.rst multires_displacement_smear.rst paint.rst - smear.rst \ No newline at end of file + smear.rst diff --git a/manual/sculpt_paint/sculpting/brushes/inflate.rst b/manual/sculpt_paint/sculpting/brushes/inflate.rst index b1b19d385..03a69f36c 100644 --- a/manual/sculpt_paint/sculpting/brushes/inflate.rst +++ b/manual/sculpt_paint/sculpting/brushes/inflate.rst @@ -1,15 +1,15 @@ -******* -Inflate -******* +*************** +Inflate/Deflate +*************** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Inflate` + :Brush: :menuselection:`Asset Shelf --> Inflate/Deflate` :Shortcut: :kbd:`I` -Similar to :doc:`Draw `, +Similar to :doc:`Draw `, except that vertices are moved in the direction of their own normals. Especially useful when sculpting meshes with a lot of curvature. diff --git a/manual/sculpt_paint/sculpting/brushes/layer.rst b/manual/sculpt_paint/sculpting/brushes/layer.rst index 64078fd10..ef2ab8ba2 100644 --- a/manual/sculpt_paint/sculpting/brushes/layer.rst +++ b/manual/sculpt_paint/sculpting/brushes/layer.rst @@ -6,9 +6,9 @@ Layer .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Layer` + :Brush: :menuselection:`Asset Shelf --> Layer` -This brush is similar to :doc:`Draw `, +This brush is similar to :doc:`Draw `, except that the height capped. This creates the appearance of a flat layer. diff --git a/manual/sculpt_paint/sculpting/brushes/multiplane_scrape.rst b/manual/sculpt_paint/sculpting/brushes/multiplane_scrape.rst index 7d4149165..597678920 100644 --- a/manual/sculpt_paint/sculpting/brushes/multiplane_scrape.rst +++ b/manual/sculpt_paint/sculpting/brushes/multiplane_scrape.rst @@ -1,12 +1,12 @@ ***************** -Multiplane Scrape +Scrape Multiplane ***************** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Multiplane Scrape` + :Brush: :menuselection:`Brush --> Scrape Multiplane` Scrapes the mesh with two angled planes at the same time, creating a sharp edge between them. This is useful for creating & polishing hard surface objects. diff --git a/manual/sculpt_paint/sculpting/brushes/multires_displacement_eraser.rst b/manual/sculpt_paint/sculpting/brushes/multires_displacement_eraser.rst index 860b2f581..4d62c4c1d 100644 --- a/manual/sculpt_paint/sculpting/brushes/multires_displacement_eraser.rst +++ b/manual/sculpt_paint/sculpting/brushes/multires_displacement_eraser.rst @@ -1,12 +1,12 @@ -**************************** -Multires Displacement Eraser -**************************** +*************************** +Erase Multires Displacement +*************************** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Multires Displacement Erase` + :Brush: :menuselection:`Asset Shelf --> Erase Multires Displacement` This brush deletes displacement information of the :doc:`Multires Modifier `, diff --git a/manual/sculpt_paint/sculpting/brushes/multires_displacement_smear.rst b/manual/sculpt_paint/sculpting/brushes/multires_displacement_smear.rst index 365676f67..27ccf9f31 100644 --- a/manual/sculpt_paint/sculpting/brushes/multires_displacement_smear.rst +++ b/manual/sculpt_paint/sculpting/brushes/multires_displacement_smear.rst @@ -1,12 +1,12 @@ *************************** -Multires Displacement Smear +Smear Multires Displacement *************************** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Multires Displacement Smear` + :Brush: :menuselection:`Asset Shelf --> Smear Multires Displacement` This tool deforms displacement information of the :doc:`Multires Modifier `, diff --git a/manual/sculpt_paint/sculpting/brushes/nudge.rst b/manual/sculpt_paint/sculpting/brushes/nudge.rst index ac1d8e95a..e232dc456 100644 --- a/manual/sculpt_paint/sculpting/brushes/nudge.rst +++ b/manual/sculpt_paint/sculpting/brushes/nudge.rst @@ -6,11 +6,11 @@ Nudge .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Nudge` + :Brush: :menuselection:`Asset Shelf --> Nudge` Moves vertices in the direction of the brush stroke. -Similar to the :doc:`Snake Hook ` brush, +Similar to the :doc:`Snake Hook ` brush, but instead only moves the geometry along the surface (using the area plane). This is useful for grabbing geometry along curved surfaces, without making too impactful changes to the overall object shape. diff --git a/manual/sculpt_paint/sculpting/brushes/overview.rst b/manual/sculpt_paint/sculpting/brushes/overview.rst new file mode 100644 index 000000000..5ede0804d --- /dev/null +++ b/manual/sculpt_paint/sculpting/brushes/overview.rst @@ -0,0 +1,161 @@ + +******** +Overview +******** + +There are a number of brushes for sculpt mode bundled in the *Essentials* asset library. +This is an overview of all of them, categorized by their general functions. + +Add/Subtract Brushes +==================== + +.. figure:: /images/sculpt-paint_sculpting_brushes_overview-add-substract.png + :align: right + :width: 250 + +These brushes generally push vertices outwards and inwards. + +:doc:`draw` + The standard brush for pushing vertices inwards and outwards from the surface direction. + +:doc:`draw_sharp` + Same as *Draw* but with a much sharper :doc:`Falloff `. + Useful for creating creases and sharp angles. + +:doc:`clay` + Similar to the *Draw* brush but with a flattening effect and subtle smoothing. + Useful for polishing and building volumes. + +:doc:`clay_strips` + The same as the *Clay* brush, but more aggressive with a square falloff. + A common standard for building rough volumes. + +:doc:`layer` + Draw with a fixed height. Useful for adding flat layers to a surface. + +:doc:`inflate` + Moves the mesh in multiple direction. Useful for inflating or shrinking surfaces and volumes. + +:doc:`blob` + Magnifies the mesh as you draw. Useful for an additional inflation effect on the stroke. + +:doc:`crease` + Same as *Blob* but with a pinching effect. Useful for creating and polishing sharp creases. + + +Contrast Brushes +================ + +.. figure:: /images/sculpt-paint_sculpting_brushes_overview-contrast.png + :align: right + :width: 250 + +Recognizable by their red icon and cursor. +These brushes generally flatten or heighten the contrast of the surface. + +:doc:`smooth` + Smooths out irregularities in the surface and shrinks volumes by averaging the vertices positions. + An essential brush that is frequently used. + +:doc:`flatten` + Pushes vertices to an average height to create a flat plateau. + +:doc:`fill` + Pushes surfaces outwards. Useful for filling in holes and crevices. + +:doc:`scrape` + Pushes surfaces inwards. This is the most common brush for flattening meshes. + +:doc:`multiplane_scrape` + Scrapes the mesh with two angled planes at the same time, producing a sharp edge between them. + + +Transform Brushes +================= + +.. figure:: /images/sculpt-paint_sculpting_brushes_overview-transform.png + :align: right + :width: 250 + +Recognizable by their yellow icon and cursor. +These brushes generally move, pinch and magnify the mesh. + +:doc:`pinch` + Pulls vertices towards the center of the brush. Useful for polishing angles and creases. + +:doc:`grab` + Moves vertices along with the mouse. An essential brush for building shapes and adjusting proportions. + +:doc:`elastic_deform` + Used to simulate realistic deformations such as grabbing or twisting of :term:`Elastic` objects. + +:doc:`snake_hook` + Pulls vertices along with the stroke to create long, snake-like forms. + +:doc:`thumb` + Same as *Grab* but moves vertices along the surface direction. Useful for preserving specific surfaces. + +:doc:`pose` + Simulating an armature-like deformations. Useful for quick posing and transformations. + +:doc:`nudge` + Similar as *Thumb* but dynamically picks up vertices like the *Snake Hook*. + Useful for nudging something along the mesh surface. + +:doc:`twist` + Rotates vertices within the brush in the direction mouse. + +:doc:`slide_relax` + Slides the topology of the mesh in the direction of the stroke + while preserving the geometrical shape of the mesh. + Also useful for redistributing topology where it is needed. + +:doc:`boundary` + Transform mesh boundaries specifically with various deformations. + + +Utility Brushes +=============== + +.. figure:: /images/sculpt-paint_sculpting_brushes_overview-utilities.png + :align: right + :width: 250 + +No clear color assignment. +These brushes are general purpose brushes or specific. + +:doc:`cloth` + Simulates cloth to create folds and draping, which can be sculpted further. + +:doc:`density` + Cleans up geometry by collapsing short edges. + +:doc:`mask` + Paints a selection on parts of the mesh to be unaffected by other brushes. + +:doc:`draw_facesets` + Paint new or extend existing face sets. + +:doc:`multires_displacement_eraser` + Remove displacement information on a Multiresolution modifier. + +:doc:`multires_displacement_smear` + Smear displacement information on a Multiresolution modifier. + + +Painting Brushes +================ + +.. figure:: /images/sculpt-paint_sculpting_brushes_overview-paint.png + :align: right + :width: 250 + +Recognizable by their green icon. +These brushes are used for painting color attributes within sculpt mode. + +:doc:`paint` + Paint on the vertices of your mesh via color attributes. + +:doc:`smear` + Smears the vertex colors via color attributes. + diff --git a/manual/sculpt_paint/sculpting/brushes/paint.rst b/manual/sculpt_paint/sculpting/brushes/paint.rst index 525a8e2e2..0799b9532 100644 --- a/manual/sculpt_paint/sculpting/brushes/paint.rst +++ b/manual/sculpt_paint/sculpting/brushes/paint.rst @@ -6,7 +6,7 @@ Paint .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Paint` + :Brush: :menuselection:`Asset Shelf --> Paint` Paints on the active color attribute. Hold :kbd:`Shift` to blur painted colors instead. diff --git a/manual/sculpt_paint/sculpting/brushes/pinch.rst b/manual/sculpt_paint/sculpting/brushes/pinch.rst index f64a9bf59..e695121a3 100644 --- a/manual/sculpt_paint/sculpting/brushes/pinch.rst +++ b/manual/sculpt_paint/sculpting/brushes/pinch.rst @@ -1,12 +1,12 @@ -***** -Pinch -***** +************* +Pinch/Magnify +************* .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Pinch` + :Brush: :menuselection:`Asset Shelf --> Pinch/Magnify` :Shortcut: :kbd:`P` Pulls geometry towards the center of the brush. diff --git a/manual/sculpt_paint/sculpting/brushes/pose.rst b/manual/sculpt_paint/sculpting/brushes/pose.rst index 5f77f57d0..7f3359904 100644 --- a/manual/sculpt_paint/sculpting/brushes/pose.rst +++ b/manual/sculpt_paint/sculpting/brushes/pose.rst @@ -6,7 +6,7 @@ Pose .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Pose` + :Brush: :menuselection:`Asset Shelf --> Pose` Deform a model simulating armature-like workflow. This can either be useful for posing a model without a rig, diff --git a/manual/sculpt_paint/sculpting/brushes/scrape.rst b/manual/sculpt_paint/sculpting/brushes/scrape.rst index 685f91a2b..f177c9402 100644 --- a/manual/sculpt_paint/sculpting/brushes/scrape.rst +++ b/manual/sculpt_paint/sculpting/brushes/scrape.rst @@ -1,15 +1,15 @@ -****** -Scrape -****** +*********** +Scrape/Fill +*********** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Scrape` + :Brush: :menuselection:`Asset Shelf --> Scrape/Fill` :Shortcut: :kbd:`Shift-T` -Similar to the :doc:`Flatten ` brush, +Similar to the :doc:`Flatten ` brush, but only pushes surfaces downward to the medium height. Although :kbd:`Ctrl` can be held to invert the effect to a Fill brush, diff --git a/manual/sculpt_paint/sculpting/brushes/slide_relax.rst b/manual/sculpt_paint/sculpting/brushes/slide_relax.rst index d10d2bc0c..4ecc8ac87 100644 --- a/manual/sculpt_paint/sculpting/brushes/slide_relax.rst +++ b/manual/sculpt_paint/sculpting/brushes/slide_relax.rst @@ -1,12 +1,12 @@ *********** -Slide Relax +Relax Slide *********** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Slide Relax` + :Brush: :menuselection:`Asset Shelf --> Relax Slide` This brush deforms the topology of the mesh while minimizing changes to the geometrical shape of the mesh. diff --git a/manual/sculpt_paint/sculpting/brushes/smear.rst b/manual/sculpt_paint/sculpting/brushes/smear.rst index a6b3d8954..76b5a2db0 100644 --- a/manual/sculpt_paint/sculpting/brushes/smear.rst +++ b/manual/sculpt_paint/sculpting/brushes/smear.rst @@ -6,7 +6,7 @@ Smear .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Smear` + :Brush: :menuselection:`Asset Shelf --> Smear` Smears the painted colors of the active color attribute. It takes the colors under the cursor, and blends them in the direction of your stroke. diff --git a/manual/sculpt_paint/sculpting/brushes/smooth.rst b/manual/sculpt_paint/sculpting/brushes/smooth.rst index d119cc1d1..dc3d56d07 100644 --- a/manual/sculpt_paint/sculpting/brushes/smooth.rst +++ b/manual/sculpt_paint/sculpting/brushes/smooth.rst @@ -6,7 +6,7 @@ Smooth .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Smooth` + :Brush: :menuselection:`Asset Shelf --> Smooth` :Shortcut: :kbd:`S` Smooths the positions of the vertices to either polish surfaces or remove volume from larger shapes. diff --git a/manual/sculpt_paint/sculpting/brushes/snake_hook.rst b/manual/sculpt_paint/sculpting/brushes/snake_hook.rst index e47b69250..0a81f5683 100644 --- a/manual/sculpt_paint/sculpting/brushes/snake_hook.rst +++ b/manual/sculpt_paint/sculpting/brushes/snake_hook.rst @@ -6,7 +6,7 @@ Snake Hook .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Snake Hook` + :Brush: :menuselection:`Asset Shelf --> Snake Hook` :Shortcut: :kbd:`K` Pulls vertices along with the movement of the brush to create long, snake-like forms. @@ -50,4 +50,4 @@ Deformation Applies the brush falloff to the tip of the brush. :Elastic: Modifies the entire mesh using an :term:`Elastic` deformation. - More info in the :doc:`Elastic Deform ` brush. + More info in the :doc:`Elastic Deform ` brush. diff --git a/manual/sculpt_paint/sculpting/brushes/thumb.rst b/manual/sculpt_paint/sculpting/brushes/thumb.rst index c9147e8a2..2b0cc98ab 100644 --- a/manual/sculpt_paint/sculpting/brushes/thumb.rst +++ b/manual/sculpt_paint/sculpting/brushes/thumb.rst @@ -6,9 +6,9 @@ Thumb .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Thumb` + :Brush: :menuselection:`Asset Shelf --> Thumb` -Similar to the :doc:`Grab ` brush, +Similar to the :doc:`Grab ` brush, but instead only moves the geometry along the surface (using the area plane). This is useful for grabbing surfaces with a very specific direction, or without making too impactful changes to the overall object shape. diff --git a/manual/sculpt_paint/sculpting/brushes/rotate.rst b/manual/sculpt_paint/sculpting/brushes/twist.rst similarity index 86% rename from manual/sculpt_paint/sculpting/brushes/rotate.rst rename to manual/sculpt_paint/sculpting/brushes/twist.rst index a5f5e52c2..0770072b3 100644 --- a/manual/sculpt_paint/sculpting/brushes/rotate.rst +++ b/manual/sculpt_paint/sculpting/brushes/twist.rst @@ -1,12 +1,12 @@ -****** -Rotate -****** +***** +Twist +***** .. reference:: :Mode: Sculpt Mode - :Tool: :menuselection:`Toolbar --> Rotate` + :Brush: :menuselection:`Asset Shelf --> Twist` Rotates geometry in the direction in which the cursor is moved. The initial drag direction is the zero angle diff --git a/manual/sculpt_paint/sculpting/controls.rst b/manual/sculpt_paint/sculpting/controls.rst index b3b433f98..b211b17b0 100644 --- a/manual/sculpt_paint/sculpting/controls.rst +++ b/manual/sculpt_paint/sculpting/controls.rst @@ -32,8 +32,8 @@ Topology 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 ` and - :doc:`Thumb ` brushes, anything that + Additionally for the :doc:`Grab ` and + :doc:`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. diff --git a/manual/sculpt_paint/sculpting/editing/expand.rst b/manual/sculpt_paint/sculpting/editing/expand.rst index de3ef4069..a39e4ea93 100644 --- a/manual/sculpt_paint/sculpting/editing/expand.rst +++ b/manual/sculpt_paint/sculpting/editing/expand.rst @@ -227,7 +227,7 @@ Saving Masks :doc:`hide face sets `) Pivot Points for Pose Brush - When using the :doc:`Pose Brush ` it is most predictable when using it with + When using the :doc:`Pose Brush ` it is most predictable when using it with Face Sets to define the face set boundaries as pivot point locations. Face Sets can be expanded from a point or from a boundary between hidden face sets to create them quickly. @@ -239,7 +239,7 @@ Pivot Points for Pose Brush Cloth Sculpting Tools like the :doc:`Cloth Filter ` - and :doc:`Cloth Brush ` + and :doc:`Cloth Brush ` work especially well when only simulating small areas at a time. Face Sets can very easily be created with Expand to assign areas of action. diff --git a/manual/sculpt_paint/sculpting/editing/mask.rst b/manual/sculpt_paint/sculpting/editing/mask.rst index 829626a0a..1a72ad15f 100644 --- a/manual/sculpt_paint/sculpting/editing/mask.rst +++ b/manual/sculpt_paint/sculpting/editing/mask.rst @@ -115,7 +115,7 @@ Type Smooth/Sharpen Mask Changes the sharpness of the mask edge. Using this can be faster and more consistent than smoothing the mask - with the :doc:`Mask ` brush. + with the :doc:`Mask ` brush. Grow/Shrink Mask Further grow or shrink the mask along the surface of the mesh. Increase/Decrease Contrast diff --git a/manual/sculpt_paint/sculpting/editing/sculpt.rst b/manual/sculpt_paint/sculpting/editing/sculpt.rst index 4fd4a8287..0050ec3d6 100644 --- a/manual/sculpt_paint/sculpting/editing/sculpt.rst +++ b/manual/sculpt_paint/sculpting/editing/sculpt.rst @@ -145,23 +145,23 @@ or from right to left for a negative effect. Smooth Smooths the positions of the vertices to either polish surfaces or remove volume from larger shapes. Especially useful to fix most of the artifacts of the voxel remesher. - This filter works similar to the :doc:`Smooth ` brush. + This filter works similar to the :doc:`Smooth ` brush. Surface Smooth Eliminates irregularities of the mesh by making the positions of the vertices more uniform while preserving the volume of the object. This filter works similar to the *Surface* deformation type of the - :doc:`Smooth ` brush. + :doc:`Smooth ` brush. Inflate Displaces vertices uniformly along their normal. - This filter works similar to the :doc:`Inflate ` brush. + This filter works similar to the :doc:`Inflate ` brush. Relax Topology Tries to create an even distribution of quads without deforming the volume of the mesh. This filter works the same as holding :kbd:`Shift` with the - :doc:`Slide Relax ` brush. + :doc:`Slide Relax ` brush. Relax Face Sets This will remove the jagged lines visible after drawing or creating a face set. This filter works the same as holding :kbd:`Shift` with the - :doc:`Draw Face Set ` brush. + :doc:`Draw Face Set ` brush. Sharpen Sharpens and smooths the mesh based on its curvature, resulting in pinching hard edges and polishing flat surfaces. @@ -171,7 +171,7 @@ Enhance Details Increases the high frequency surface details of the mesh by intensifying the difference between creases and valleys. This filter works similar to the inverted direction of the - :doc:`Smooth ` brush. + :doc:`Smooth ` brush. Erase Displacement Deletes displacement information of the :doc:`Multires Modifier `, @@ -198,7 +198,7 @@ Sample Color :Shortcut: :kbd:`Shift-X` -Adjust the brush color of the :doc:`/sculpt_paint/sculpting/tools/paint` tool to the color under the mouse cursor. +Adjust the brush color of the :doc:`/sculpt_paint/sculpting/brushes/paint` tool to the color under the mouse cursor. .. _bpy.ops.sculpt.set_pivot_position: diff --git a/manual/sculpt_paint/sculpting/introduction/adaptive.rst b/manual/sculpt_paint/sculpting/introduction/adaptive.rst index f7c21722f..f853ffd2f 100644 --- a/manual/sculpt_paint/sculpting/introduction/adaptive.rst +++ b/manual/sculpt_paint/sculpting/introduction/adaptive.rst @@ -74,9 +74,9 @@ Use :kbd:`R` to define the resolution and :kbd:`Ctrl-R` to flood fill the resolu .. figure:: /images/sculpt-paint_sculpt_dyntopo_detail.png -Brushes like :doc:`Simplify `, -:doc:`Snake Hook ` -and :doc:`Clay Strips ` work especially well with this feature. +Brushes like :doc:`Density `, +:doc:`Snake Hook ` +and :doc:`Clay Strips ` work especially well with this feature. .. seealso:: @@ -120,11 +120,11 @@ since any edits to the base mesh will result in corrupted subdivision details. Pay attention to the topology that you sculpt and how much it gets stretched. If more resolution is needed you can always subdivide another time, but there will be worse performance and slower level switching once more than 5 subdivisions are used. - Alternatively use the :doc:`Slide Relax ` + Alternatively use the :doc:`Slide Relax ` brush to slide topology to where it is needed. -Additional brushes like the :doc:`Multires Eraser ` and -:doc:`Multires Smear ` are recommended for adjustments. +Additional brushes like the :doc:`Multires Eraser ` and +:doc:`Multires Smear ` are recommended for adjustments. Here are general shortcuts to use the feature. diff --git a/manual/sculpt_paint/sculpting/introduction/brush.rst b/manual/sculpt_paint/sculpting/introduction/brush.rst index 028557ce6..05b54a024 100644 --- a/manual/sculpt_paint/sculpting/introduction/brush.rst +++ b/manual/sculpt_paint/sculpting/introduction/brush.rst @@ -17,7 +17,7 @@ The inner ring of the brush cursor is used to visualize the strength of the brus How closely the cursor follows the curvature of the mesh can be changed in the :doc:`Brush Settings ` with "Normal Radius". This can make hard surface sculpting easier, for example with the - :doc:`Scrape ` brush. + :doc:`Scrape ` brush. The brush is also used for other :doc:`tools ` in the toolbar to better display how that tool works. For example, the :ref:`Box Trim ` @@ -34,34 +34,34 @@ More information on sculpting brushes in the :doc:`Toolbar ` +:doc:`Clay Strips ` Block out broad shapes and build up volumes before refining them further. -:doc:`Grab ` +:doc:`Grab ` Move geometry across the screen for general shaping. -:doc:`Smooth ` +:doc:`Smooth ` Smooth and shrink surfaces to remove noise or flatten shapes. -:doc:`Draw ` +:doc:`Draw ` Generic adding and subtracting on surfaces. This brush is often customized with different stroke methods and textures for various effects. -:doc:`Scrape ` +:doc:`Scrape ` Scrape and fill surfaces either for hard surface sculpting or more aggressive smoothing. -:doc:`Inflate ` +:doc:`Inflate ` Inflate or shrink volumes or surfaces. Especially useful for controlling the thickness of cylindrical shapes. -:doc:`Draw Sharp ` +:doc:`Draw Sharp ` Same as *Draw* but with a much sharper falloff. Useful for adding creases, cracks and other sharp edges. -:doc:`Crease ` +:doc:`Crease ` A mix of the *Draw* and *Pinch* brushes. Useful for creating detailed creases or sharpening existing creases for additional polish. -:doc:`Snake Hook `. +:doc:`Snake Hook `. Similar to *Grab* but this brush will dynamically let go and pick up geometry during the stroke. The dragged geometry is also following the angle of the stroke, making it very useful for pulling geometry out. diff --git a/manual/sculpt_paint/sculpting/introduction/cloth_sculpting.rst b/manual/sculpt_paint/sculpting/introduction/cloth_sculpting.rst index 2e3a6b382..0ce2efbc7 100644 --- a/manual/sculpt_paint/sculpting/introduction/cloth_sculpting.rst +++ b/manual/sculpt_paint/sculpting/introduction/cloth_sculpting.rst @@ -21,10 +21,10 @@ are :doc:`pinned ` in the simulation. Another example is with :doc:`auto-masked ` face set boundaries. The sculpt mode :ref:`gravity ` factor is also applied on the cloth physics. -The main brushes and tools for this feature are the :doc:`Cloth Brush ` +The main brushes and tools for this feature are the :doc:`Cloth Brush ` and :doc:`Cloth Filter `, -but other transform brushes like :doc:`Pose ` and -:doc:`Boundary ` also support cloth sculpting in the brush settings. +but other transform brushes like :doc:`Pose ` and +:doc:`Boundary ` also support cloth sculpting in the brush settings. A demo file for trying out the various brushes and tools is available `here `__. diff --git a/manual/sculpt_paint/sculpting/introduction/painting.rst b/manual/sculpt_paint/sculpting/introduction/painting.rst index 7646dced7..b97a4a2a3 100644 --- a/manual/sculpt_paint/sculpting/introduction/painting.rst +++ b/manual/sculpt_paint/sculpting/introduction/painting.rst @@ -12,8 +12,8 @@ common actions related to the sculpting workflow are contained in the same mode, Other sculpt mode features such as face sets, masking and filters can also be used with painting tools. The painting functionality in Sculpt Mode is limited to a -:doc:`Paint ` -and :doc:`Smear ` brush, +:doc:`Paint ` +and :doc:`Smear ` brush, as well as a :doc:`Color Filter ` and :doc:`Mask by Color ` tool. diff --git a/manual/sculpt_paint/sculpting/introduction/transforming.rst b/manual/sculpt_paint/sculpting/introduction/transforming.rst index edab37a4f..582311da9 100644 --- a/manual/sculpt_paint/sculpting/introduction/transforming.rst +++ b/manual/sculpt_paint/sculpting/introduction/transforming.rst @@ -19,6 +19,6 @@ Optionally instead of keeping the transform tools active, you can enable the In that case move the pivot point somewhere else to be able to click on the desired surface. Apart from the transform tools there are also special brushes to move, -rotate and scale the topology like :doc:`Pose `, -:doc:`Boundary ` -and :doc:`Elastic Deform `. +rotate and scale the topology like :doc:`Pose `, +:doc:`Boundary ` +and :doc:`Elastic Deform `. 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 c514a6761..67dd91792 100644 --- a/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst +++ b/manual/sculpt_paint/sculpting/introduction/visibility_masking_face_sets.rst @@ -85,7 +85,7 @@ More options can be found in the :kbd:`Alt-W` pie menu. .. figure:: /images/sculpt-paint_sculpting_editing_face_set_pie.png Otherwise Face Sets can be created/edited with the -:doc:`Draw Face Sets ` brush, +:doc:`Draw Face Sets ` brush, :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 85e5d0289..8db7c4f90 100644 --- a/manual/sculpt_paint/sculpting/toolbar.rst +++ b/manual/sculpt_paint/sculpting/toolbar.rst @@ -7,153 +7,15 @@ The amount of tools in sculpt mode is very extensive. This is an overview of all of them, categorized by their general functions. -Add/Subtract Brushes -==================== - -.. figure:: /images/sculpt-paint_sculpting_toolbar_add_subt_brushes.png - :align: right - -Recognizable by their blue icon and cursor. -These brushes generally push vertices outwards and inwards. - -:doc:`/sculpt_paint/sculpting/tools/draw` - The standard brush for pushing vertices inwards and outwards from the surface direction. - -:doc:`/sculpt_paint/sculpting/tools/draw_sharp` - Same as *Draw* but with a much sharper :doc:`Falloff `. - Useful for creating creases and sharp angles. - -:doc:`/sculpt_paint/sculpting/tools/clay` - Similar to the *Draw* brush but with a flattening effect and subtle smoothing. - Useful for polishing and building volumes. - -:doc:`/sculpt_paint/sculpting/tools/clay_strips` - The same as the *Clay* brush, but more aggressive with a square falloff. - A common standard for building rough volumes. - -:doc:`/sculpt_paint/sculpting/tools/layer` - Draw with a fixed height. Useful for adding flat layers to a surface. - -:doc:`/sculpt_paint/sculpting/tools/inflate` - Moves the mesh in multiple direction. Useful for inflating or shrinking surfaces and volumes. - -:doc:`/sculpt_paint/sculpting/tools/blob` - Magnifies the mesh as you draw. Useful for an additional inflation effect on the stroke. - -:doc:`/sculpt_paint/sculpting/tools/crease` - Same as *Blob* but with a pinching effect. Useful for creating and polishing sharp creases. - -Contrast Brushes -================ - -.. figure:: /images/sculpt-paint_sculpting_toolbar_contrast_brushes.png - :align: right - -Recognizable by their red icon and cursor. -These brushes generally flatten or heighten the contrast of the surface. - -:doc:`/sculpt_paint/sculpting/tools/smooth` - Smooths out irregularities in the surface and shrinks volumes by averaging the vertices positions. - An essential brush that is frequently used. - -:doc:`/sculpt_paint/sculpting/tools/flatten` - Pushes vertices to an average height to create a flat plateau. - -:doc:`/sculpt_paint/sculpting/tools/fill` - Pushes surfaces outwards. Useful for filling in holes and crevices. - -:doc:`/sculpt_paint/sculpting/tools/scrape` - Pushes surfaces inwards. This is the most common brush for flattening meshes. - -:doc:`/sculpt_paint/sculpting/tools/multiplane_scrape` - Scrapes the mesh with two angled planes at the same time, producing a sharp edge between them. - - -Transform Brushes -================= - -.. figure:: /images/sculpt-paint_sculpting_toolbar_transform_brushes.png - :align: right - -Recognizable by their yellow icon and cursor. -These brushes generally move, pinch and magnify the mesh. - -:doc:`/sculpt_paint/sculpting/tools/pinch` - Pulls vertices towards the center of the brush. Useful for polishing angles and creases. - -:doc:`/sculpt_paint/sculpting/tools/grab` - Moves vertices along with the mouse. An essential brush for building shapes and adjusting proportions. - -:doc:`/sculpt_paint/sculpting/tools/elastic_deform` - Used to simulate realistic deformations such as grabbing or twisting of :term:`Elastic` objects. - -:doc:`/sculpt_paint/sculpting/tools/snake_hook` - Pulls vertices along with the stroke to create long, snake-like forms. - -:doc:`/sculpt_paint/sculpting/tools/thumb` - Same as *Grab* but moves vertices along the surface direction. Useful for preserving specific surfaces. - -:doc:`/sculpt_paint/sculpting/tools/pose` - Simulating an armature-like deformations. Useful for quick posing and transformations. - -:doc:`/sculpt_paint/sculpting/tools/nudge` - Similar as *Thumb* but dynamically picks up vertices like the *Snake Hook*. - Useful for nudging something along the mesh surface. - -:doc:`/sculpt_paint/sculpting/tools/rotate` - Rotates vertices within the brush in the direction mouse. - -:doc:`/sculpt_paint/sculpting/tools/slide_relax` - Slides the topology of the mesh in the direction of the stroke - while preserving the geometrical shape of the mesh. - Also useful for redistributing topology where it is needed. - -:doc:`/sculpt_paint/sculpting/tools/boundary` - Transform mesh boundaries specifically with various deformations. - - -General Brushes +Sculpting Tools =============== -.. figure:: /images/sculpt-paint_sculpting_toolbar_general_brushes.png +.. figure:: /images/sculpt-paint_sculpting_toolbar_brush.png :align: right + :width: 220 -No clear color assignment. -These brushes are general purpose brushes or specific. - -:doc:`/sculpt_paint/sculpting/tools/cloth` - Simulates cloth to create folds and draping, which can be sculpted further. - -:doc:`/sculpt_paint/sculpting/tools/simplify` - Cleans up geometry by collapsing short edges. - -:doc:`/sculpt_paint/sculpting/tools/mask` - Paints a selection on parts of the mesh to be unaffected by other brushes. - -:doc:`/sculpt_paint/sculpting/tools/draw_facesets` - Paint new or extend existing face sets. - -:doc:`/sculpt_paint/sculpting/tools/multires_displacement_eraser` - Remove displacement information on a Multiresolution modifier. - -:doc:`/sculpt_paint/sculpting/tools/multires_displacement_smear` - Smear displacement information on a Multiresolution modifier. - - -Painting Brushes -================ - -.. figure:: /images/sculpt-paint_sculpting_toolbar_paint.png - :align: right - -Recognizable by their green icon. -These brushes are used for painting color attributes within sculpt mode. - -:doc:`/sculpt_paint/sculpting/tools/paint` - Paint on the vertices of your mesh via color attributes. - -:doc:`/sculpt_paint/sculpting/tools/smear` - Smears the vertex colors via color attributes. +:doc:`/sculpt_paint/sculpting/tools/brush_tool` + Tool to use for any of the *Sculpt* mode brushes. Gesture Tools @@ -162,7 +24,7 @@ Gesture Tools .. figure:: /images/sculpt-paint_sculpting_toolbar_gestures.png :align: right -General gesture tools to apply an operation via box, lasso, line and polyline shapes. +General gesture tools to apply an operation via box, lasso, line and polyline shapes. See :doc:`/sculpt_paint/sculpting/introduction/gesture_tools` for more information. :doc:`/sculpt_paint/sculpting/tools/mask_tools` diff --git a/manual/sculpt_paint/sculpting/tools/brush_tool.rst b/manual/sculpt_paint/sculpting/tools/brush_tool.rst index b60179166..9a0194d60 100644 --- a/manual/sculpt_paint/sculpting/tools/brush_tool.rst +++ b/manual/sculpt_paint/sculpting/tools/brush_tool.rst @@ -11,5 +11,6 @@ Brush Tool to use for any of the *Sculpt* mode brushes. Activating a brush from an asset shelf or brush asset selector will also activate this tool for convenience. -See :doc:`brushes ` for a detailed list of all brushes and their -options. +See :doc:`brushes ` (or the +:doc:`overview `) for a detailed list of all brushes and +their options. diff --git a/manual/sculpt_paint/sculpting/tools/cloth_filter.rst b/manual/sculpt_paint/sculpting/tools/cloth_filter.rst index a4fc5e725..641e6cf02 100644 --- a/manual/sculpt_paint/sculpting/tools/cloth_filter.rst +++ b/manual/sculpt_paint/sculpting/tools/cloth_filter.rst @@ -8,13 +8,13 @@ Cloth Filter :Mode: Sculpt Mode :Tool: :menuselection:`Toolbar --> Cloth Filter` -This tool works similar to the :doc:`Cloth Brush `, +This tool works similar to the :doc:`Cloth Brush `, however, it applies a cloth simulation to all vertices in the mesh at the same time. Click and drag away from the object for a positive effect and towards for a negative effect. .. tip:: - Vertices can be "pinned" by :doc:`masking ` vertices + Vertices can be "pinned" by :doc:`masking ` vertices that should remain stationary, or by using :ref:`Face Sets `. diff --git a/manual/sculpt_paint/sculpting/tools/mesh_filter.rst b/manual/sculpt_paint/sculpting/tools/mesh_filter.rst index 24acdba45..60ae94f5d 100644 --- a/manual/sculpt_paint/sculpting/tools/mesh_filter.rst +++ b/manual/sculpt_paint/sculpting/tools/mesh_filter.rst @@ -24,13 +24,13 @@ Filter Type :Smooth: Smooths the positions of the vertices to either polish surfaces or remove volume from larger shapes. Especially useful to fix most of the artifacts of the voxel remesher. - This filter works similar to the :doc:`Smooth ` brush. + This filter works similar to the :doc:`Smooth ` brush. :Scale: Increases the size of the mesh. This filter works similar to the :ref:`Scale Transform `. :Inflate: Displaces vertices uniformly along their normal. - This filter works similar to the :doc:`Inflate ` brush. + This filter works similar to the :doc:`Inflate ` brush. :Sphere: Morphs the mesh progressively into a sphere. This filter works similar to the :ref:`To Sphere Transform `. @@ -40,16 +40,16 @@ Filter Type :Relax: Tries to create an even distribution of quads without deforming the volume of the mesh. This filter works the same as holding :kbd:`Shift` with the - :doc:`Slide Relax ` brush. + :doc:`Slide Relax ` brush. :Relax Face Sets: This will remove the jagged lines visible after drawing or creating a face set. This filter works the same as holding :kbd:`Shift` with the - :doc:`Draw Face Set ` brush. + :doc:`Draw Face Set ` brush. :Surface Smooth: Eliminates irregularities of the mesh by making the positions of the vertices more uniform while preserving the volume of the object. This filter works similar to the *Surface* deformation type of the - :doc:`Smooth ` brush. + :doc:`Smooth ` brush. Shape Preservation How much of the original shape is preserved when smoothing. @@ -73,7 +73,7 @@ Filter Type Increases the high frequency surface details of the mesh by intensifying the difference between creases and valleys. This filter works similar to the inverted direction of the - :doc:`Smooth ` brush. + :doc:`Smooth ` brush. :Erase Displacement: Deletes displacement information of the :doc:`Multires Modifier `, diff --git a/manual/sculpt_paint/texture_paint/brushes.rst b/manual/sculpt_paint/texture_paint/brushes.rst index d6efe3370..8896415aa 100644 --- a/manual/sculpt_paint/texture_paint/brushes.rst +++ b/manual/sculpt_paint/texture_paint/brushes.rst @@ -5,10 +5,10 @@ Brushes Brushes for *Texture Paint* bundled in the *Essentials* library. -Draw - The normal brush, paints a swath of color. +Paint Texture + The normal brush, draws a swath of color. -Soften +Blur Texture Uses a "blur effect" to soften or sharpen the image. Direction @@ -31,11 +31,11 @@ Soften :Gaussian: Gaussian will sample the pixels near the center of the brush most. :Box: Box samples all surrounding pixels equally. -Smear +Smear Texture When you click, takes the colors under the cursor, and blends them in the direction you move the mouse. Similar to the "smudge" tool of *Gimp*. -Clone +Clone Texture Copies the colors from the specified image (or location of the same image) to the active image. In 3D projective painting the clone cursor can be set with :kbd:`Ctrl-LMB`. @@ -52,7 +52,7 @@ Clone Alpha (2D only) Opacity of the clone image display. -Fill +Fill Texture It can be used to fill large areas of the image with the brush color. The tool fills adjacent pixels that have a color value similar to the pixel you clicked on. @@ -76,7 +76,7 @@ Fill regardless of whether the options are activated in the :doc:`External ` panel. -Mask +Mask Texture This brush paints gray-scale values on the mask texture specified in the :doc:`Mask panel `. Any masked surfaces will not be affected by other paint brushes, similar to diff --git a/manual/sculpt_paint/vertex_paint/brushes.rst b/manual/sculpt_paint/vertex_paint/brushes.rst index 0360fabad..2de11b925 100644 --- a/manual/sculpt_paint/vertex_paint/brushes.rst +++ b/manual/sculpt_paint/vertex_paint/brushes.rst @@ -5,19 +5,16 @@ Brushes Brushes for *Vertex Paint* bundled in the *Essentials* library. -Draw +Paint Vertex Paints a specified color over the object. -Blur +Blur Vertex Smooths out the colors of adjacent vertices. In this mode the Color Value is ignored. The strength defines how much the colors are blurred. -Average +Average Vertex Smooths color by painting the average resulting color from all colors under the brush. -Smear +Smear Vertex Smudges colors by grabbing the colors under the brush and "dragging" them. This can be imagined as a finger painting tool. - -Brush - Tool to use for any of the vertex paint :doc:`brushes `. diff --git a/manual/sculpt_paint/weight_paint/brushes.rst b/manual/sculpt_paint/weight_paint/brushes.rst index 226594efe..564b919f0 100644 --- a/manual/sculpt_paint/weight_paint/brushes.rst +++ b/manual/sculpt_paint/weight_paint/brushes.rst @@ -3,7 +3,7 @@ Brushes ******* -Draw +Paint Weight Paints a specified weight over the object. Blend @@ -40,13 +40,13 @@ Draw Smooths out the weighting of adjacent vertices. In this mode the Weight Value is ignored. The strength defines how much the smoothing is applied. -Blur +Blur Weight Smooths out the weighting of adjacent vertices. In this mode the Weight Value is ignored. The strength defines how much the smoothing is applied. -Average +Average Weight Smooths weights by painting the average resulting weight from all weights under the brush. -Smear +Smear Weight Smudges weights by grabbing the weights under the brush and "dragging" them. This can be imagined as a finger painting tool. -- 2.30.2 From e97df436c830b7a07e94d5d9fb6a76a05d9e72d7 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 17:04:19 +0200 Subject: [PATCH 20/30] Add missing redirects Forgot to includ in last commit --- build_files/.htaccess | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/build_files/.htaccess b/build_files/.htaccess index 49d592a1b..547ac7fc9 100644 --- a/build_files/.htaccess +++ b/build_files/.htaccess @@ -256,12 +256,14 @@ RedirectMatch "^/manual/{lang}/{version}/modeling/modifiers/modify/normal_edit.h RedirectMatch "^/manual/{lang}/{version}/modeling/modifiers/modify/weighted_normal.html" "^/manual/{lang}/{version}/modeling/modifiers/normals/weighted_normal.html" RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/brush/brush.html" "^/manual/{lang}/{version}/sculpt_paint/brush/introduction.html" +RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/sculpting/tools/rotate.html" "^/manual/{lang}/{version}/sculpt_paint/sculpting/brushes/twist.html" +RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/sculpting/tools/simplify.html" "^/manual/{lang}/{version}/sculpt_paint/sculpting/brushes/density.html" # Mesh sculpting tools converted to asset RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/sculpting/tools/\ (blob|boundary|clay|clay_strips|clay_thumb|cloth|crease|draw|draw_facesets|draw_sharp|\ elastic_deform|fill|flatten|grab|inflate|layer|mask|multiplane_scrape|\ multires_displacement_eraser|multires_displacement_smear|nudge|paint|pinch|pose|\ - rotate|scrape|simplify|slide_relax|smear|smooth|snake_hook|thumb).html" \ + scrape|slide_relax|smear|smooth|snake_hook|thumb).html" \ "^/manual/{lang}/{version}/sculpt_paint/sculpting/brushes/$1.html" # Curve sculpting tools converted to asset RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/curves_sculpting/tools/\ -- 2.30.2 From 9d344b34f3a49d8dcea7e160a974d0a0e092b1ce Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 17:22:57 +0200 Subject: [PATCH 21/30] Update grease pencil mode docs, plus some consistency fixes --- build_files/.htaccess | 3 ++ .../grease_pencil/materials/introduction.rst | 2 +- .../modes/draw/{tools => brushes}/draw.rst | 13 +++--- .../modes/draw/{tools => brushes}/erase.rst | 10 ++-- .../modes/draw/{tools => brushes}/fill.rst | 13 +++--- .../modes/draw/brushes/index.rst | 13 ++++++ .../modes/draw/brushes/overview.rst | 19 ++++++++ .../modes/draw/{tools => brushes}/tint.rst | 10 ++-- manual/grease_pencil/modes/draw/index.rst | 1 + manual/grease_pencil/modes/draw/tools.rst | 13 +----- manual/grease_pencil/modes/draw/tools/arc.rst | 2 +- manual/grease_pencil/modes/draw/tools/box.rst | 2 +- .../grease_pencil/modes/draw/tools/brush.rst | 17 +++++++ .../grease_pencil/modes/draw/tools/circle.rst | 2 +- .../grease_pencil/modes/draw/tools/curve.rst | 2 +- .../grease_pencil/modes/draw/tools/index.rst | 5 +- .../grease_pencil/modes/draw/tools/line.rst | 2 +- .../modes/draw/tools/polyline.rst | 2 +- .../modes/edit/grease_pencil_menu.rst | 2 +- .../grease_pencil/modes/sculpting/brushes.rst | 46 +++++++++++++++++++ .../grease_pencil/modes/sculpting/index.rst | 1 + .../grease_pencil/modes/sculpting/tools.rst | 44 +----------------- .../modes/vertex_paint/brushes.rst | 23 ++++++++++ .../modes/vertex_paint/index.rst | 1 + .../modes/vertex_paint/tools.rst | 18 +------- .../modes/weight_paint/brushes.rst | 20 ++++++++ .../modes/weight_paint/index.rst | 1 + .../modes/weight_paint/tools.rst | 15 +----- .../sculpting/tools/brush_tool.rst | 2 +- manual/sculpt_paint/vertex_paint/brushes.rst | 2 +- manual/sculpt_paint/weight_paint/brushes.rst | 2 + 31 files changed, 188 insertions(+), 120 deletions(-) rename manual/grease_pencil/modes/draw/{tools => brushes}/draw.rst (97%) rename manual/grease_pencil/modes/draw/{tools => brushes}/erase.rst (96%) rename manual/grease_pencil/modes/draw/{tools => brushes}/fill.rst (96%) create mode 100644 manual/grease_pencil/modes/draw/brushes/index.rst create mode 100644 manual/grease_pencil/modes/draw/brushes/overview.rst rename manual/grease_pencil/modes/draw/{tools => brushes}/tint.rst (87%) create mode 100644 manual/grease_pencil/modes/draw/tools/brush.rst create mode 100644 manual/grease_pencil/modes/sculpting/brushes.rst create mode 100644 manual/grease_pencil/modes/vertex_paint/brushes.rst create mode 100644 manual/grease_pencil/modes/weight_paint/brushes.rst diff --git a/build_files/.htaccess b/build_files/.htaccess index 547ac7fc9..b66b04f3f 100644 --- a/build_files/.htaccess +++ b/build_files/.htaccess @@ -270,5 +270,8 @@ RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/curves_sculpting/tools/\ (index|add_curves|comb_curves|delete_curves|density_curves|grow_shrink_curves|\ pinch_curves|puff_curves|selection_paint|slide_curves|smooth_curves|snake_hook_curves).html" \ "^/manual/{lang}/{version}/sculpt_paint/curves_sculpting/brushes/$1.html" +# Grease pencil draw tools +RedirectMatch "^/manual/{lang}/{version}/grease_pencil/modes/draw/tools/(draw|erase|fill|tint).html" \ + "^/manual/{lang}/{version}/sculpt_paint/curves_sculpting/brushes/$1.html" # Texture paint tools converted to asset RedirectMatch "^/manual/{lang}/{version}/sculpt_paint/texture_paint/tools.html" "^/manual/{lang}/{version}/sculpt_paint/texture_paint/brushes.html" diff --git a/manual/grease_pencil/materials/introduction.rst b/manual/grease_pencil/materials/introduction.rst index b61e9874f..ed30adda2 100644 --- a/manual/grease_pencil/materials/introduction.rst +++ b/manual/grease_pencil/materials/introduction.rst @@ -58,7 +58,7 @@ to interactively preview how the material looks in the scene. Grease Pencil materials are data-blocks that can be :doc:`assigned ` to one or more objects, and different materials can be assigned to different strokes. -In Grease Pencil the :doc:`brush ` +In Grease Pencil the :doc:`brush ` settings together with the material used will define the look and feel of the final strokes. Materials slots in the :ref:`List view ` also have some extra controls diff --git a/manual/grease_pencil/modes/draw/tools/draw.rst b/manual/grease_pencil/modes/draw/brushes/draw.rst similarity index 97% rename from manual/grease_pencil/modes/draw/tools/draw.rst rename to manual/grease_pencil/modes/draw/brushes/draw.rst index 53c646a12..751629fd5 100644 --- a/manual/grease_pencil/modes/draw/tools/draw.rst +++ b/manual/grease_pencil/modes/draw/brushes/draw.rst @@ -1,15 +1,14 @@ -.. _tool-grease-pencil-draw-draw: -********* -Draw Tool -********* +********** +Draw Brush +********** .. reference:: :Mode: Draw Mode - :Tool: :menuselection:`Toolbar --> Draw` + :Brush: :menuselection:`Asset Shelf --> Draw` -The Draw tool allows you to draw free-hand strokes. +The Draw brush allows you to draw free-hand strokes. Brush Settings @@ -284,6 +283,6 @@ Switching to the Erase Tool --------------------------- :kbd:`Ctrl-LMB` changes temporally to the active Erase tool. -See :doc:`Erase Tool ` for more information. +See :doc:`Erase Tool ` for more information. You can also use :kbd:`B` to delete all the points in the selected drawing area. diff --git a/manual/grease_pencil/modes/draw/tools/erase.rst b/manual/grease_pencil/modes/draw/brushes/erase.rst similarity index 96% rename from manual/grease_pencil/modes/draw/tools/erase.rst rename to manual/grease_pencil/modes/draw/brushes/erase.rst index faff00d47..b448b51bc 100644 --- a/manual/grease_pencil/modes/draw/tools/erase.rst +++ b/manual/grease_pencil/modes/draw/brushes/erase.rst @@ -1,15 +1,15 @@ .. _tool-grease-pencil-draw-erase: -********** -Erase Tool -********** +*********** +Erase Brush +*********** .. reference:: :Mode: Draw Mode - :Tool: :menuselection:`Toolbar --> Erase` + :Brush: :menuselection:`Asset Shelf --> Erase` -The Erase tool erase already drawn strokes. +The Erase brush erases already drawn strokes. Brush Settings diff --git a/manual/grease_pencil/modes/draw/tools/fill.rst b/manual/grease_pencil/modes/draw/brushes/fill.rst similarity index 96% rename from manual/grease_pencil/modes/draw/tools/fill.rst rename to manual/grease_pencil/modes/draw/brushes/fill.rst index 85f49c930..1185952d2 100644 --- a/manual/grease_pencil/modes/draw/tools/fill.rst +++ b/manual/grease_pencil/modes/draw/brushes/fill.rst @@ -1,15 +1,14 @@ -.. _tool-grease-pencil-draw-fill: -********* -Fill Tool -********* +********** +Fill Brush +********** .. reference:: :Mode: Draw Mode - :Tool: :menuselection:`Toolbar --> Fill` + :Brush: :menuselection:`Asset Shelf --> Fill` -The Fill tool is used to automatically fill closed strokes areas. +The Fill brush is used to automatically fill closed strokes areas. Brush Settings @@ -248,4 +247,4 @@ Switch to Draw Tool Use :kbd:`Ctrl-LMB` to change temporary to the active draw tool. For example to manually cover small areas difficult to reach for the Fill tool. -See :doc:`Draw Tool ` for more information. +See :doc:`Draw Tool ` for more information. diff --git a/manual/grease_pencil/modes/draw/brushes/index.rst b/manual/grease_pencil/modes/draw/brushes/index.rst new file mode 100644 index 000000000..589bf2a78 --- /dev/null +++ b/manual/grease_pencil/modes/draw/brushes/index.rst @@ -0,0 +1,13 @@ + +######### + Brushes +######### + +.. toctree:: + :maxdepth: 2 + + overview.rst + draw.rst + fill.rst + erase.rst + tint.rst diff --git a/manual/grease_pencil/modes/draw/brushes/overview.rst b/manual/grease_pencil/modes/draw/brushes/overview.rst new file mode 100644 index 000000000..4545dc5a7 --- /dev/null +++ b/manual/grease_pencil/modes/draw/brushes/overview.rst @@ -0,0 +1,19 @@ + +******** +Overview +******** + +There are a number of brushes for draw mode bundled in the *Essentials* asset library. This is an +overview of all of them. + +:doc:`Draw ` + Draw free-hand strokes. + +:doc:`Fill ` + Automatic fill closed strokes areas. + +:doc:`Erase ` + Erase strokes. + +:doc:`Tint ` + Colorize stroke points. diff --git a/manual/grease_pencil/modes/draw/tools/tint.rst b/manual/grease_pencil/modes/draw/brushes/tint.rst similarity index 87% rename from manual/grease_pencil/modes/draw/tools/tint.rst rename to manual/grease_pencil/modes/draw/brushes/tint.rst index a6edf3515..ad8f85d0d 100644 --- a/manual/grease_pencil/modes/draw/tools/tint.rst +++ b/manual/grease_pencil/modes/draw/brushes/tint.rst @@ -1,15 +1,15 @@ .. _tool-grease-pencil-draw-tint: -********* -Tint Tool -********* +********** +Tint Brush +********** .. reference:: :Mode: Draw Mode - :Tool: :menuselection:`Toolbar --> Tint` + :Brush: :menuselection:`Brush --> Tint` -The Tint tool allows you to paint onto strokes point mixing the material base color with a selected color. +The Tint brush allows you to paint onto strokes point mixing the material base color with a selected color. Brush Settings diff --git a/manual/grease_pencil/modes/draw/index.rst b/manual/grease_pencil/modes/draw/index.rst index 8fc860186..7f698982f 100644 --- a/manual/grease_pencil/modes/draw/index.rst +++ b/manual/grease_pencil/modes/draw/index.rst @@ -7,6 +7,7 @@ :maxdepth: 2 introduction.rst + brushes/index.rst tools.rst tools/index.rst tool_settings/index.rst diff --git a/manual/grease_pencil/modes/draw/tools.rst b/manual/grease_pencil/modes/draw/tools.rst index ebbdd55c6..782bc138b 100644 --- a/manual/grease_pencil/modes/draw/tools.rst +++ b/manual/grease_pencil/modes/draw/tools.rst @@ -10,17 +10,8 @@ Drawing Tools Cursor Change the location of the 3D Cursor. -:ref:`Draw ` - Draw free-hand strokes. - -:ref:`Fill ` - Automatic fill closed strokes areas. - -:ref:`Erase ` - Erase strokes. - -:ref:`Tint ` - Colorize stroke points. +:doc:`Brush ` + Tool to use for any of the drawing brushes. :ref:`Cutter ` Cut strokes in between others. diff --git a/manual/grease_pencil/modes/draw/tools/arc.rst b/manual/grease_pencil/modes/draw/tools/arc.rst index 9fc4f1cf8..81136691a 100644 --- a/manual/grease_pencil/modes/draw/tools/arc.rst +++ b/manual/grease_pencil/modes/draw/tools/arc.rst @@ -17,7 +17,7 @@ Tool Settings You can configure the brush main settings exposed on the Tool Settings for convenience. For the draw brushes configuration and settings see: -:doc:`Draw Brush `. +:doc:`Draw Brush `. Subdivisions The number of stroke points between each stroke edge. diff --git a/manual/grease_pencil/modes/draw/tools/box.rst b/manual/grease_pencil/modes/draw/tools/box.rst index c57cde31d..040d9c853 100644 --- a/manual/grease_pencil/modes/draw/tools/box.rst +++ b/manual/grease_pencil/modes/draw/tools/box.rst @@ -17,7 +17,7 @@ Tool Settings You can configure the brush main settings exposed on the Tool Settings for convenience. For the draw brushes configuration and settings see: -:doc:`Draw Brush `. +:doc:`Draw Brush `. Subdivisions The number of stroke points between each stroke edge. diff --git a/manual/grease_pencil/modes/draw/tools/brush.rst b/manual/grease_pencil/modes/draw/tools/brush.rst new file mode 100644 index 000000000..aa1f86dc5 --- /dev/null +++ b/manual/grease_pencil/modes/draw/tools/brush.rst @@ -0,0 +1,17 @@ + +***** +Brush +***** + +.. reference:: + + :Mode: Draw Mode + :Tool: :menuselection:`Toolbar --> Brush` + + +Tool to use for any of the Grease Pencil *Draw* mode brushes. Activating a brush from an asset +shelf or brush selector will also activate this tool for convenience. + +See :doc:`brushes ` (or the +:doc:`overview `) for a detailed list of all brushes and +their options. diff --git a/manual/grease_pencil/modes/draw/tools/circle.rst b/manual/grease_pencil/modes/draw/tools/circle.rst index d89950c78..44829db29 100644 --- a/manual/grease_pencil/modes/draw/tools/circle.rst +++ b/manual/grease_pencil/modes/draw/tools/circle.rst @@ -17,7 +17,7 @@ Tool Settings You can configure the brush main settings exposed on the Tool Settings for convenience. For the draw brushes configuration and settings see: -:doc:`Draw Brush `. +:doc:`Draw Brush `. Subdivisions The number of stroke points between each stroke edge. diff --git a/manual/grease_pencil/modes/draw/tools/curve.rst b/manual/grease_pencil/modes/draw/tools/curve.rst index d728a482d..ad16578c6 100644 --- a/manual/grease_pencil/modes/draw/tools/curve.rst +++ b/manual/grease_pencil/modes/draw/tools/curve.rst @@ -17,7 +17,7 @@ Tool Settings You can configure the brush main settings exposed on the Tool Settings for convenience. For the draw brushes configuration and settings see: -:doc:`Draw Brush `. +:doc:`Draw Brush `. Subdivisions The number of stroke points between each stroke edge. diff --git a/manual/grease_pencil/modes/draw/tools/index.rst b/manual/grease_pencil/modes/draw/tools/index.rst index 4acd6a328..c9d9b333e 100644 --- a/manual/grease_pencil/modes/draw/tools/index.rst +++ b/manual/grease_pencil/modes/draw/tools/index.rst @@ -7,10 +7,7 @@ .. toctree:: :maxdepth: 2 - draw.rst - fill.rst - erase.rst - tint.rst + brush.rst cutter.rst eyedropper.rst line.rst diff --git a/manual/grease_pencil/modes/draw/tools/line.rst b/manual/grease_pencil/modes/draw/tools/line.rst index 847199de5..7d13ff7f5 100644 --- a/manual/grease_pencil/modes/draw/tools/line.rst +++ b/manual/grease_pencil/modes/draw/tools/line.rst @@ -17,7 +17,7 @@ Tool Settings You can configure the brush main settings exposed on the Tool Settings for convenience. For the draw brushes configuration and settings see: -:doc:`Draw Brush `. +:doc:`Draw Brush `. Subdivisions The number of stroke points between each stroke edge. diff --git a/manual/grease_pencil/modes/draw/tools/polyline.rst b/manual/grease_pencil/modes/draw/tools/polyline.rst index 93b83ae5a..8f1f2cb52 100644 --- a/manual/grease_pencil/modes/draw/tools/polyline.rst +++ b/manual/grease_pencil/modes/draw/tools/polyline.rst @@ -17,7 +17,7 @@ Tool Settings You can configure the brush main settings exposed on the Tool Settings for convenience. For the draw brushes configuration and settings see: -:doc:`Draw Brush `. +:doc:`Draw Brush `. Subdivisions The number of stroke points between each stroke edge. diff --git a/manual/grease_pencil/modes/edit/grease_pencil_menu.rst b/manual/grease_pencil/modes/edit/grease_pencil_menu.rst index b1258e966..a3f36f450 100644 --- a/manual/grease_pencil/modes/edit/grease_pencil_menu.rst +++ b/manual/grease_pencil/modes/edit/grease_pencil_menu.rst @@ -217,7 +217,7 @@ Boundary Strokes :Menu: :menuselection:`Grease Pencil --> Clean Up --> Boundary Strokes` Removes boundary strokes used by the *Fill* tool. -See :doc:`Fill tool ` for more information. +See :doc:`Fill tool ` for more information. Mode Active Frame Only diff --git a/manual/grease_pencil/modes/sculpting/brushes.rst b/manual/grease_pencil/modes/sculpting/brushes.rst new file mode 100644 index 000000000..511b161af --- /dev/null +++ b/manual/grease_pencil/modes/sculpting/brushes.rst @@ -0,0 +1,46 @@ + +***************** +Sculpting Brushes +***************** + +Brushes for Grease Pencil *Sculpt* mode bundled in the *Essentials* library. +See :doc:`Brush ` for more information. + +.. figure:: /images/grease-pencil_modes_sculpting_tools_brushes.png + :align: right + +Smooth Stroke + Eliminates irregularities in the area of the drawing + within the brush's influence by smoothing the positions of the points. + +Thickness Stroke + Increase or decrease the points thickness in the area of the drawing + within the brush's influence. + +Strength Stroke + Increase or decrease the points transparency (alpha) in the area of the drawing + within the brush's influence. + +Randomize Stroke + Add noise to the strokes in the area of the drawing + within the brush's influence by moving points location in a random way. + +Grab Stroke + Used to drag a group of points around. Unlike the other brushes, + Grab does not modify different points as the brush is dragged across the model. + Instead, Grab selects a group of points on mouse-down, and pulls them to follow the mouse. + The effect is similar to moving a group of points in Edit Mode with Proportional Editing enabled. + +Pull Stroke + Moves points in the direction of the brush stroke. + +Twist Stroke + Twist the points in counter-clockwise (CCW) or Clockwise (CW) rotation. + +Pinch Stroke + Pulls points towards the center of the brush. + The inverse setting is Inflate, in which points are pushed away from the center of the brush. + +Clone Stroke + Adds copies of the strokes in the clipboard in the center of the brush. + You have to copy the selected strokes you want into the clipboard with :kbd:`Ctrl-C` before using the tool. diff --git a/manual/grease_pencil/modes/sculpting/index.rst b/manual/grease_pencil/modes/sculpting/index.rst index f409d5c12..e36056e2a 100644 --- a/manual/grease_pencil/modes/sculpting/index.rst +++ b/manual/grease_pencil/modes/sculpting/index.rst @@ -7,5 +7,6 @@ :maxdepth: 2 introduction.rst + brushes.rst tools.rst tool_settings/brush.rst diff --git a/manual/grease_pencil/modes/sculpting/tools.rst b/manual/grease_pencil/modes/sculpting/tools.rst index 9fe92eaa8..784e67c68 100644 --- a/manual/grease_pencil/modes/sculpting/tools.rst +++ b/manual/grease_pencil/modes/sculpting/tools.rst @@ -4,48 +4,8 @@ Sculpting Tools *************** -For Grease Pencil sculpt modes each brush type is exposed as a tool, -the brush can be changed in the Tool Settings. -See :doc:`Brush ` for more information. - -.. figure:: /images/grease-pencil_modes_sculpting_tools_brushes.png - :align: right - -Smooth - Eliminates irregularities in the area of the drawing - within the brush's influence by smoothing the positions of the points. - -Thickness - Increase or decrease the points thickness in the area of the drawing - within the brush's influence. - -Strength - Increase or decrease the points transparency (alpha) in the area of the drawing - within the brush's influence. - -Randomize - Add noise to the strokes in the area of the drawing - within the brush's influence by moving points location in a random way. - -Grab - Used to drag a group of points around. Unlike the other brushes, - Grab does not modify different points as the brush is dragged across the model. - Instead, Grab selects a group of points on mouse-down, and pulls them to follow the mouse. - The effect is similar to moving a group of points in Edit Mode with Proportional Editing enabled. - -Push - Moves points in the direction of the brush stroke. - -Twist - Twist the points in counter-clockwise (CCW) or Clockwise (CW) rotation. - -Pinch/Inflate - Pulls points towards the center of the brush. - The inverse setting is Inflate, in which points are pushed away from the center of the brush. - -Clone - Adds copies of the strokes in the clipboard in the center of the brush. - You have to copy the selected strokes you want into the clipboard with :kbd:`Ctrl-C` before using the tool. +Brush + Tool to use for any of the sculpting :doc:`brushes `. :ref:`Annotate ` Draw free-hand annotation. diff --git a/manual/grease_pencil/modes/vertex_paint/brushes.rst b/manual/grease_pencil/modes/vertex_paint/brushes.rst new file mode 100644 index 000000000..6cb7f8864 --- /dev/null +++ b/manual/grease_pencil/modes/vertex_paint/brushes.rst @@ -0,0 +1,23 @@ + +******************** +Vertex Paint Brushes +******************** + +Brushes for Grease Pencil *Vertex Paint* mode bundled in the *Essentials* library. + +Paint Point Color + Paints a specified color over the object. + +Blur Point Color + Smooths out the colors of adjacent vertices. In this mode the Color + Value is ignored. The strength defines how much the colors are blurred. + +Average Point Color + Smooths color by painting the average resulting color from all colors under the brush. + +Smear Point Color + Smudges colors by grabbing the colors under the brush and "dragging" them. + This can be imagined as a finger painting tool. + +Replace Point Color + Change the color only to the stroke points that already have a color applied. diff --git a/manual/grease_pencil/modes/vertex_paint/index.rst b/manual/grease_pencil/modes/vertex_paint/index.rst index 7bec25a11..3be28b9ce 100644 --- a/manual/grease_pencil/modes/vertex_paint/index.rst +++ b/manual/grease_pencil/modes/vertex_paint/index.rst @@ -7,6 +7,7 @@ :maxdepth: 2 introduction.rst + brushes.rst tools.rst tool_settings/brush.rst editing.rst diff --git a/manual/grease_pencil/modes/vertex_paint/tools.rst b/manual/grease_pencil/modes/vertex_paint/tools.rst index 311006463..63b916c0e 100644 --- a/manual/grease_pencil/modes/vertex_paint/tools.rst +++ b/manual/grease_pencil/modes/vertex_paint/tools.rst @@ -6,22 +6,8 @@ Vertex Paint Tools .. figure:: /images/grease-pencil_modes_vertex-paint_tools_brushes.png :align: right -Draw - Paints a specified color over the object. - -Blur - Smooths out the colors of adjacent vertices. In this mode the Color - Value is ignored. The strength defines how much the colors are blurred. - -Average - Smooths color by painting the average resulting color from all colors under the brush. - -Smear - Smudges colors by grabbing the colors under the brush and "dragging" them. - This can be imagined as a finger painting tool. - -Replace - Change the color only to the stroke points that already have a color applied. +Brush + Tool to use for any of the vertex paint :doc:`brushes `. :ref:`Annotate ` Draw free-hand annotation. diff --git a/manual/grease_pencil/modes/weight_paint/brushes.rst b/manual/grease_pencil/modes/weight_paint/brushes.rst new file mode 100644 index 000000000..d41cd4b91 --- /dev/null +++ b/manual/grease_pencil/modes/weight_paint/brushes.rst @@ -0,0 +1,20 @@ + +******************** +Weight Paint Brushes +******************** + +Brushes for Grease Pencil *Weight Paint* mode bundled in the *Essentials* library. + +Paint Point Weight + Paints a specified weight over the strokes. + +Blur Point Weight + Smooths out the weighting of adjacent points. In this mode the Weight + Value is ignored. The strength defines how much the smoothing is applied. + +Average Point Weight + Smooths weights by painting the average resulting weight from all weights under the brush. + +Smear Point Weight + Smudges weights by grabbing the weights under the brush and "dragging" them. + This can be imagined as a finger painting tool. diff --git a/manual/grease_pencil/modes/weight_paint/index.rst b/manual/grease_pencil/modes/weight_paint/index.rst index 452ebb1b5..b4ffafd9a 100644 --- a/manual/grease_pencil/modes/weight_paint/index.rst +++ b/manual/grease_pencil/modes/weight_paint/index.rst @@ -7,6 +7,7 @@ :maxdepth: 2 introduction.rst + brushes.rst tools.rst tool_settings/index.rst weights_menu.rst diff --git a/manual/grease_pencil/modes/weight_paint/tools.rst b/manual/grease_pencil/modes/weight_paint/tools.rst index f0d97a317..a3c5807e7 100644 --- a/manual/grease_pencil/modes/weight_paint/tools.rst +++ b/manual/grease_pencil/modes/weight_paint/tools.rst @@ -11,19 +11,8 @@ See :doc:`Brush ` for mor .. figure:: /images/grease-pencil_modes_weight-paint_tools_brushes.png :align: right -Draw - Paints a specified weight over the strokes. - -Blur - Smooths out the weighting of adjacent points. In this mode the Weight - Value is ignored. The strength defines how much the smoothing is applied. - -Average - Smooths weights by painting the average resulting weight from all weights under the brush. - -Smear - Smudges weights by grabbing the weights under the brush and "dragging" them. - This can be imagined as a finger painting tool. +Brush + Tool to use for any of the weight paint :doc:`brushes `. :ref:`Annotate ` Draw free-hand annotation. diff --git a/manual/sculpt_paint/sculpting/tools/brush_tool.rst b/manual/sculpt_paint/sculpting/tools/brush_tool.rst index 9a0194d60..54dc6b34f 100644 --- a/manual/sculpt_paint/sculpting/tools/brush_tool.rst +++ b/manual/sculpt_paint/sculpting/tools/brush_tool.rst @@ -9,7 +9,7 @@ Brush Tool to use for any of the *Sculpt* mode brushes. Activating a brush from an asset shelf or brush -asset selector will also activate this tool for convenience. +selector will also activate this tool for convenience. See :doc:`brushes ` (or the :doc:`overview `) for a detailed list of all brushes and diff --git a/manual/sculpt_paint/vertex_paint/brushes.rst b/manual/sculpt_paint/vertex_paint/brushes.rst index 2de11b925..d0a3e5a1f 100644 --- a/manual/sculpt_paint/vertex_paint/brushes.rst +++ b/manual/sculpt_paint/vertex_paint/brushes.rst @@ -3,7 +3,7 @@ Brushes ******* -Brushes for *Vertex Paint* bundled in the *Essentials* library. +Brushes for *Vertex Paint* mode bundled in the *Essentials* library. Paint Vertex Paints a specified color over the object. diff --git a/manual/sculpt_paint/weight_paint/brushes.rst b/manual/sculpt_paint/weight_paint/brushes.rst index 564b919f0..474ad659b 100644 --- a/manual/sculpt_paint/weight_paint/brushes.rst +++ b/manual/sculpt_paint/weight_paint/brushes.rst @@ -3,6 +3,8 @@ Brushes ******* +Brushes for *Weight Paint* mode bundled in the *Essentials* library. + Paint Weight Paints a specified weight over the object. -- 2.30.2 From 88dd40632a009305c445e0ccc0784f394fc4f2df Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 17:26:53 +0200 Subject: [PATCH 22/30] Remove unused references --- manual/grease_pencil/modes/draw/brushes/erase.rst | 1 - manual/grease_pencil/modes/draw/brushes/tint.rst | 1 - 2 files changed, 2 deletions(-) diff --git a/manual/grease_pencil/modes/draw/brushes/erase.rst b/manual/grease_pencil/modes/draw/brushes/erase.rst index b448b51bc..016d1da10 100644 --- a/manual/grease_pencil/modes/draw/brushes/erase.rst +++ b/manual/grease_pencil/modes/draw/brushes/erase.rst @@ -1,4 +1,3 @@ -.. _tool-grease-pencil-draw-erase: *********** Erase Brush diff --git a/manual/grease_pencil/modes/draw/brushes/tint.rst b/manual/grease_pencil/modes/draw/brushes/tint.rst index ad8f85d0d..dedfb70e9 100644 --- a/manual/grease_pencil/modes/draw/brushes/tint.rst +++ b/manual/grease_pencil/modes/draw/brushes/tint.rst @@ -1,4 +1,3 @@ -.. _tool-grease-pencil-draw-tint: ********** Tint Brush -- 2.30.2 From f214274af43d3b02f48c06768bf976ed0e0a5713 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 17:52:55 +0200 Subject: [PATCH 23/30] Add section on custom shortcuts --- manual/sculpt_paint/brush/introduction.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index 38ddc3c77..94dadb8c9 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -61,6 +61,14 @@ Finally confirm (:kbd:`LMB`, :kbd:`Return`) or cancel (:kbd:`RMB`, :kbd:`Esc`). You can also invert the brush direction/effect by holding :kbd:`Ctrl`. +Custom Brush Shortcuts +====================== + +To give a brush a shortcut, simply right click it in the asset shelf or brush selector popup, and +select *Assign Shortcut*. To modify or remove an existing shortcut, select *Change Shortcut* or +*Remove Shortcut* accordingly. + + Brush Assets ============ -- 2.30.2 From 8897ade5566adc9ff1ca4f85402e5eacde4cd006 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 20:04:11 +0200 Subject: [PATCH 24/30] Document grease pencil eraser brush --- manual/grease_pencil/modes/draw/tools.rst | 4 ++-- manual/grease_pencil/modes/draw/tools/brush.rst | 7 +++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/manual/grease_pencil/modes/draw/tools.rst b/manual/grease_pencil/modes/draw/tools.rst index 782bc138b..a72a4da5e 100644 --- a/manual/grease_pencil/modes/draw/tools.rst +++ b/manual/grease_pencil/modes/draw/tools.rst @@ -10,8 +10,8 @@ Drawing Tools Cursor Change the location of the 3D Cursor. -:doc:`Brush ` - Tool to use for any of the drawing brushes. +:doc:`Brush ` + Tool to use for any of the drawing brushes, see :doc:`/grease_pencil/modes/draw/brushes/overview`. :ref:`Cutter ` Cut strokes in between others. diff --git a/manual/grease_pencil/modes/draw/tools/brush.rst b/manual/grease_pencil/modes/draw/tools/brush.rst index aa1f86dc5..46a46e0e3 100644 --- a/manual/grease_pencil/modes/draw/tools/brush.rst +++ b/manual/grease_pencil/modes/draw/tools/brush.rst @@ -15,3 +15,10 @@ shelf or brush selector will also activate this tool for convenience. See :doc:`brushes ` (or the :doc:`overview `) for a detailed list of all brushes and their options. + +Tool Settings +============= + +Default Eraser Brush + Select a brush to use as eraser for quickly alternating with the main brush using + :kbd:`Ctrl-LMB`. -- 2.30.2 From 32633e73beb232b3c8f98302f9af9514d6d1ec4e Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Thu, 4 Jul 2024 21:58:39 +0200 Subject: [PATCH 25/30] Fix link --- manual/sculpt_paint/curves_sculpting/introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual/sculpt_paint/curves_sculpting/introduction.rst b/manual/sculpt_paint/curves_sculpting/introduction.rst index 56217308f..b6128f5a7 100644 --- a/manual/sculpt_paint/curves_sculpting/introduction.rst +++ b/manual/sculpt_paint/curves_sculpting/introduction.rst @@ -7,7 +7,7 @@ Introduction It is commonly used for hair grooming, but can be used with all kinds of curves. The curves' surface object plays an important role in many curves sculpting brushes. -Most brushes such as :doc:`Add Curves ` +Most brushes such as :doc:`Add Curves ` require the surface to be set already. .. note:: -- 2.30.2 From 4a2a8d2bb8c42b50fcdc5388066d6b846381b6aa Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Fri, 5 Jul 2024 18:36:23 +0200 Subject: [PATCH 26/30] Document brush types, try to make relation to essentials brushes clear --- manual/sculpt_paint/brush/brush_settings.rst | 19 +++ .../brushes/{overview.rst => brush_types.rst} | 139 +++++++++++++----- .../sculpt_paint/sculpting/brushes/index.rst | 2 +- .../sculpting/tools/brush_tool.rst | 6 +- manual/sculpt_paint/texture_paint/brushes.rst | 34 ++++- manual/sculpt_paint/vertex_paint/brushes.rst | 23 ++- manual/sculpt_paint/weight_paint/brushes.rst | 25 +++- 7 files changed, 191 insertions(+), 57 deletions(-) rename manual/sculpt_paint/sculpting/brushes/{overview.rst => brush_types.rst} (73%) diff --git a/manual/sculpt_paint/brush/brush_settings.rst b/manual/sculpt_paint/brush/brush_settings.rst index 3faee1aa2..32a0b3fd3 100644 --- a/manual/sculpt_paint/brush/brush_settings.rst +++ b/manual/sculpt_paint/brush/brush_settings.rst @@ -170,6 +170,25 @@ Deformation Target Advanced ======== +.. _sculpt-tool-settings-brush-type: + +Brush Type + Defines the basic behavior and the available settings. Through the settings of + a brush type, brushes can be created that produce vastly different effects. + + The *Essentials* asset library contains brushes for each of the brush types. Their preview image + and description should give a good idea of the effect the brush produces, with the particular + combination of brush type and settings. Because of this, they are usually the more useful starting + point for custom brushes than the mere brush type is, which is why the brush type is part of the + *Advanced* brush settings. + + types. + + - :doc:`Sculpt ` + - :doc:`Vertex Paint ` + - :doc:`Weight Paint ` + - :doc:`Texture Paint ` + Accumulate Causes stroke dabs to accumulate on top of each other. diff --git a/manual/sculpt_paint/sculpting/brushes/overview.rst b/manual/sculpt_paint/sculpting/brushes/brush_types.rst similarity index 73% rename from manual/sculpt_paint/sculpting/brushes/overview.rst rename to manual/sculpt_paint/sculpting/brushes/brush_types.rst index 5ede0804d..38d1b5ee1 100644 --- a/manual/sculpt_paint/sculpting/brushes/overview.rst +++ b/manual/sculpt_paint/sculpting/brushes/brush_types.rst @@ -1,10 +1,13 @@ -******** -Overview -******** -There are a number of brushes for sculpt mode bundled in the *Essentials* asset library. -This is an overview of all of them, categorized by their general functions. +*********** +Brush Types +*********** + +See :ref:`Brush Type `. + +Available brush types are listed here, together with links to the *Essentials* library brushes +using them. Add/Subtract Brushes ==================== @@ -13,33 +16,49 @@ Add/Subtract Brushes :align: right :width: 250 -These brushes generally push vertices outwards and inwards. +These brush types generally push vertices outwards and inwards. + +Draw + Brushes: :doc:`draw` -:doc:`draw` The standard brush for pushing vertices inwards and outwards from the surface direction. -:doc:`draw_sharp` +Draw Sharp + Brushes: :doc:`draw_sharp` + Same as *Draw* but with a much sharper :doc:`Falloff `. Useful for creating creases and sharp angles. -:doc:`clay` +Clay + Brushes: :doc:`clay` + Similar to the *Draw* brush but with a flattening effect and subtle smoothing. Useful for polishing and building volumes. -:doc:`clay_strips` +Clay Strips + Brushes: :doc:`clay_strips` + The same as the *Clay* brush, but more aggressive with a square falloff. A common standard for building rough volumes. -:doc:`layer` +Layer + Brushes: :doc:`layer` + Draw with a fixed height. Useful for adding flat layers to a surface. -:doc:`inflate` +Inflate + Brushes: :doc:`inflate` + Moves the mesh in multiple direction. Useful for inflating or shrinking surfaces and volumes. -:doc:`blob` +Blob + Brushes: :doc:`blob` + Magnifies the mesh as you draw. Useful for an additional inflation effect on the stroke. -:doc:`crease` +Crease + Brushes: :doc:`crease` + Same as *Blob* but with a pinching effect. Useful for creating and polishing sharp creases. @@ -53,20 +72,30 @@ Contrast Brushes Recognizable by their red icon and cursor. These brushes generally flatten or heighten the contrast of the surface. -:doc:`smooth` +Smooth + Brushes: :doc:`smooth` + Smooths out irregularities in the surface and shrinks volumes by averaging the vertices positions. An essential brush that is frequently used. -:doc:`flatten` +Flatten + Brushes: :doc:`flatten` + Pushes vertices to an average height to create a flat plateau. -:doc:`fill` +Fill + Brushes: :doc:`fill` + Pushes surfaces outwards. Useful for filling in holes and crevices. -:doc:`scrape` +Scrape + Brushes: :doc:`scrape` + Pushes surfaces inwards. This is the most common brush for flattening meshes. -:doc:`multiplane_scrape` +Multi-plane Scrape + Brushes: :doc:`multiplane_scrape` + Scrapes the mesh with two angled planes at the same time, producing a sharp edge between them. @@ -80,37 +109,57 @@ Transform Brushes Recognizable by their yellow icon and cursor. These brushes generally move, pinch and magnify the mesh. -:doc:`pinch` +Pinch + Brushes: :doc:`pinch` + Pulls vertices towards the center of the brush. Useful for polishing angles and creases. -:doc:`grab` +Grab + Brushes: :doc:`grab` + Moves vertices along with the mouse. An essential brush for building shapes and adjusting proportions. -:doc:`elastic_deform` +Elastic Deform + Brushes: :doc:`elastic_deform` + Used to simulate realistic deformations such as grabbing or twisting of :term:`Elastic` objects. -:doc:`snake_hook` +Snake Hook + Brushes: :doc:`snake_hook` + Pulls vertices along with the stroke to create long, snake-like forms. -:doc:`thumb` +Thumb + Brushes: :doc:`thumb` + Same as *Grab* but moves vertices along the surface direction. Useful for preserving specific surfaces. -:doc:`pose` +Pose + Brushes: :doc:`pose` + Simulating an armature-like deformations. Useful for quick posing and transformations. -:doc:`nudge` +Nudge + Brushes: :doc:`nudge` + Similar as *Thumb* but dynamically picks up vertices like the *Snake Hook*. Useful for nudging something along the mesh surface. -:doc:`twist` +Rotate + Brushes: :doc:`twist` + Rotates vertices within the brush in the direction mouse. -:doc:`slide_relax` +Slide Relax + Brushes: :doc:`slide_relax` + Slides the topology of the mesh in the direction of the stroke while preserving the geometrical shape of the mesh. Also useful for redistributing topology where it is needed. -:doc:`boundary` +Boundary + Brushes: :doc:`boundary` + Transform mesh boundaries specifically with various deformations. @@ -124,22 +173,34 @@ Utility Brushes No clear color assignment. These brushes are general purpose brushes or specific. -:doc:`cloth` +Cloth + Brushes: :doc:`cloth` + Simulates cloth to create folds and draping, which can be sculpted further. -:doc:`density` +Simplify + Brushes: :doc:`density` + Cleans up geometry by collapsing short edges. -:doc:`mask` +Mask + Brushes: :doc:`mask` + Paints a selection on parts of the mesh to be unaffected by other brushes. -:doc:`draw_facesets` +Draw Face Sets + Brushes: :doc:`draw_facesets` + Paint new or extend existing face sets. -:doc:`multires_displacement_eraser` +Multires Displacement Eraser + Brushes: :doc:`multires_displacement_eraser` + Remove displacement information on a Multiresolution modifier. -:doc:`multires_displacement_smear` +Multires Displacement Smear + Brushes: :doc:`multires_displacement_smear` + Smear displacement information on a Multiresolution modifier. @@ -153,9 +214,13 @@ Painting Brushes Recognizable by their green icon. These brushes are used for painting color attributes within sculpt mode. -:doc:`paint` +Paint + Brushes: :doc:`paint` + Paint on the vertices of your mesh via color attributes. -:doc:`smear` +Smear + Brushes: :doc:`smear` + Smears the vertex colors via color attributes. diff --git a/manual/sculpt_paint/sculpting/brushes/index.rst b/manual/sculpt_paint/sculpting/brushes/index.rst index b5d301b70..b604420c0 100644 --- a/manual/sculpt_paint/sculpting/brushes/index.rst +++ b/manual/sculpt_paint/sculpting/brushes/index.rst @@ -8,7 +8,7 @@ Brushes for *Sculpt Mode* bundled in the *Essentials* library. .. toctree:: :maxdepth: 1 - overview.rst + brush_types.rst draw.rst draw_sharp.rst clay.rst diff --git a/manual/sculpt_paint/sculpting/tools/brush_tool.rst b/manual/sculpt_paint/sculpting/tools/brush_tool.rst index 54dc6b34f..b01fceb53 100644 --- a/manual/sculpt_paint/sculpting/tools/brush_tool.rst +++ b/manual/sculpt_paint/sculpting/tools/brush_tool.rst @@ -11,6 +11,6 @@ Brush Tool to use for any of the *Sculpt* mode brushes. Activating a brush from an asset shelf or brush selector will also activate this tool for convenience. -See :doc:`brushes ` (or the -:doc:`overview `) for a detailed list of all brushes and -their options. +See :doc:`brushes ` (or the available +:doc:`Brush Types `) for a detailed list of all +brushes and their options. diff --git a/manual/sculpt_paint/texture_paint/brushes.rst b/manual/sculpt_paint/texture_paint/brushes.rst index 8896415aa..83bcd0e70 100644 --- a/manual/sculpt_paint/texture_paint/brushes.rst +++ b/manual/sculpt_paint/texture_paint/brushes.rst @@ -3,12 +3,24 @@ Brushes ******* -Brushes for *Texture Paint* bundled in the *Essentials* library. +Brush Types +=========== + +See :ref:`Brush Type `. + +Available brush types are listed here, together with brushes from the +*Essentials* asset library using them. + + +Draw + Brushes: Paint Texture -Paint Texture The normal brush, draws a swath of color. -Blur Texture + +Soften + Brushes: Blur Texture + Uses a "blur effect" to soften or sharpen the image. Direction @@ -31,11 +43,15 @@ Blur Texture :Gaussian: Gaussian will sample the pixels near the center of the brush most. :Box: Box samples all surrounding pixels equally. -Smear Texture +Smear + Brushes: Smear Texture + When you click, takes the colors under the cursor, and blends them in the direction you move the mouse. Similar to the "smudge" tool of *Gimp*. -Clone Texture +Clone + Brushes: Clone Texture + Copies the colors from the specified image (or location of the same image) to the active image. In 3D projective painting the clone cursor can be set with :kbd:`Ctrl-LMB`. @@ -52,7 +68,9 @@ Clone Texture Alpha (2D only) Opacity of the clone image display. -Fill Texture +Fill + Brushes: Fill Texture + It can be used to fill large areas of the image with the brush color. The tool fills adjacent pixels that have a color value similar to the pixel you clicked on. @@ -76,7 +94,9 @@ Fill Texture regardless of whether the options are activated in the :doc:`External ` panel. -Mask Texture +Mask + Brushes: Mask Texture + This brush paints gray-scale values on the mask texture specified in the :doc:`Mask panel `. Any masked surfaces will not be affected by other paint brushes, similar to diff --git a/manual/sculpt_paint/vertex_paint/brushes.rst b/manual/sculpt_paint/vertex_paint/brushes.rst index d0a3e5a1f..f4440656d 100644 --- a/manual/sculpt_paint/vertex_paint/brushes.rst +++ b/manual/sculpt_paint/vertex_paint/brushes.rst @@ -3,18 +3,33 @@ Brushes ******* -Brushes for *Vertex Paint* mode bundled in the *Essentials* library. + +Brush Types +=========== + +See :ref:`Brush Type `. + +Available brush types are listed here, together with brushes from the +*Essentials* asset library using them. Paint Vertex + Brushes: Paint Vertex + Paints a specified color over the object. -Blur Vertex +Blur + Brushes: Blur Vertex + Smooths out the colors of adjacent vertices. In this mode the Color Value is ignored. The strength defines how much the colors are blurred. -Average Vertex +Average + Brushes: Average Vertex + Smooths color by painting the average resulting color from all colors under the brush. -Smear Vertex +Smear + Brushes: Smear Vertex + Smudges colors by grabbing the colors under the brush and "dragging" them. This can be imagined as a finger painting tool. diff --git a/manual/sculpt_paint/weight_paint/brushes.rst b/manual/sculpt_paint/weight_paint/brushes.rst index 474ad659b..89088883d 100644 --- a/manual/sculpt_paint/weight_paint/brushes.rst +++ b/manual/sculpt_paint/weight_paint/brushes.rst @@ -3,9 +3,18 @@ Brushes ******* -Brushes for *Weight Paint* mode bundled in the *Essentials* library. +Brush Types +=========== + +See :ref:`Brush Type `. + +Available brush types are listed here, together with brushes from the +*Essentials* asset library using them. + + +Draw + Brushes: Paint Weight -Paint Weight Paints a specified weight over the object. Blend @@ -42,13 +51,19 @@ Paint Weight Smooths out the weighting of adjacent vertices. In this mode the Weight Value is ignored. The strength defines how much the smoothing is applied. -Blur Weight +Blur + Brushes: Blur Weight + Smooths out the weighting of adjacent vertices. In this mode the Weight Value is ignored. The strength defines how much the smoothing is applied. -Average Weight +Average + Brushes: Average Weight + Smooths weights by painting the average resulting weight from all weights under the brush. -Smear Weight +Smear + Brushes: Smear Weight + Smudges weights by grabbing the weights under the brush and "dragging" them. This can be imagined as a finger painting tool. -- 2.30.2 From eb41b4b2cc380663cd28bb276539d1f080f18d0e Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Fri, 5 Jul 2024 19:42:17 +0200 Subject: [PATCH 27/30] Correct link --- manual/grease_pencil/modes/draw/tools/brush.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/manual/grease_pencil/modes/draw/tools/brush.rst b/manual/grease_pencil/modes/draw/tools/brush.rst index 46a46e0e3..53880c502 100644 --- a/manual/grease_pencil/modes/draw/tools/brush.rst +++ b/manual/grease_pencil/modes/draw/tools/brush.rst @@ -13,8 +13,8 @@ Tool to use for any of the Grease Pencil *Draw* mode brushes. Activating a brush shelf or brush selector will also activate this tool for convenience. See :doc:`brushes ` (or the -:doc:`overview `) for a detailed list of all brushes and -their options. +:doc:`overview `) for a detailed list of all brushes +and their options. Tool Settings ============= -- 2.30.2 From 0be91ffd64c9e936e3d1c71f63510c815ad32c75 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Fri, 5 Jul 2024 19:45:51 +0200 Subject: [PATCH 28/30] Small tweak to the brush introduction Already note that brushes are used as assets here, this is important. Plus remove unnecessary information about the brush tool, this is documented sufficiently elsewhere. --- manual/sculpt_paint/brush/introduction.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/manual/sculpt_paint/brush/introduction.rst b/manual/sculpt_paint/brush/introduction.rst index 94dadb8c9..a07dc5aae 100644 --- a/manual/sculpt_paint/brush/introduction.rst +++ b/manual/sculpt_paint/brush/introduction.rst @@ -8,9 +8,9 @@ Introduction Brushes are the main way of interacting with any painting and sculpting mode. By click & dragging in the 3D Viewport (or the Image Editor when using :doc:`Texture Paint `), the active brush creates a -:doc:`stroke ` with a certain effect, depending on the used brush settings. Typically -Brushes have a preview image and a name that indicate the effect they create. Brushes are only used while the Brush -Tool is active. +:doc:`stroke ` with a certain effect, depending on the used brush settings. Brushes are +used as brush assets and stored in asset libraries, which makes it easy to reuse and share them. Typically they have a +preview image and a name that indicate the effect they create. .. tip:: -- 2.30.2 From 02a506fb512ed935d3d78df821ef1d0ff29a9ccb Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Sat, 6 Jul 2024 21:25:18 +0200 Subject: [PATCH 29/30] Remove now unused images --- .../images/sculpt-paint_sculpting_toolbar_general_brushes.png | 3 --- manual/images/sculpt-paint_sculpting_toolbar_paint.png | 3 --- .../sculpt-paint_sculpting_toolbar_transform_brushes.png | 3 --- 3 files changed, 9 deletions(-) delete mode 100644 manual/images/sculpt-paint_sculpting_toolbar_general_brushes.png delete mode 100644 manual/images/sculpt-paint_sculpting_toolbar_paint.png delete mode 100644 manual/images/sculpt-paint_sculpting_toolbar_transform_brushes.png diff --git a/manual/images/sculpt-paint_sculpting_toolbar_general_brushes.png b/manual/images/sculpt-paint_sculpting_toolbar_general_brushes.png deleted file mode 100644 index b13eff7d6..000000000 --- a/manual/images/sculpt-paint_sculpting_toolbar_general_brushes.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:a93ab37f2178a7f7d5beb003eea6a99cbe113e33f3389be7c4ed53925a1e74df -size 24936 diff --git a/manual/images/sculpt-paint_sculpting_toolbar_paint.png b/manual/images/sculpt-paint_sculpting_toolbar_paint.png deleted file mode 100644 index 6dd1040af..000000000 --- a/manual/images/sculpt-paint_sculpting_toolbar_paint.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:30822fa480e641451717f98a7477dac37c22a2b78895284f4f575828a7d4995c -size 4177 diff --git a/manual/images/sculpt-paint_sculpting_toolbar_transform_brushes.png b/manual/images/sculpt-paint_sculpting_toolbar_transform_brushes.png deleted file mode 100644 index e0570bbcf..000000000 --- a/manual/images/sculpt-paint_sculpting_toolbar_transform_brushes.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:7fade524610a173e58c73b8796f46bb77fc219bb29601ced1ed06bb95f04e4db -size 35017 -- 2.30.2 From a8c808e5bf219e9c7aacb7126524363c9f0d43c3 Mon Sep 17 00:00:00 2001 From: Julian Eisel Date: Sun, 7 Jul 2024 17:09:22 +0200 Subject: [PATCH 30/30] Assets: Improve section on asset system files (.asset.blend files) --- manual/files/asset_libraries/introduction.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/manual/files/asset_libraries/introduction.rst b/manual/files/asset_libraries/introduction.rst index b33692ae3..66e4829b8 100644 --- a/manual/files/asset_libraries/introduction.rst +++ b/manual/files/asset_libraries/introduction.rst @@ -225,11 +225,18 @@ Blender saves these assets to libraries in special files using the `.asset.blend are entirely managed by Blender's asset system, and only contain a single asset and its dependencies. -`.asset.blend` files may be deleted or overwritten by Blender's asset system. Hence, saving changes -to them is highly discouraged, as they can easily be lost. Attempting to save edits to such a file -will spawn a warning popup, giving you the choice to use -:ref:`Save As ` to instead save the changes in a new, regular -blend-file. +It is still possible to save a normal file with the `.asset.blend` extension. This will then not +be treated as an asset system file, Blender knows the difference. + +Asset system files have one more special characteristic: You can open, but not save them. The +:ref:`Save As ` operator can still be used to create a new file from +them, which will then be just a normal blend-file. Thus contained assets cannot be edited without +opening the file itself. Blender shows some clear warnings to communicate that asset system files +cannot be changed and saved the normal way. + +The reason these files are special is that the asset system might need to regenerate them. Any +additional changes done by the user might be lost then. To prevent this data-loss, these files are +protected from user modifications. Currently, only brush assets support this feature. -- 2.30.2