[Bf-docboard-svn] bf-manual: [9946] trunk/blender_docs/manual: Update Node Wrangler documentation
Aaron Carlisle
noreply at blender.org
Tue Feb 7 06:05:17 CET 2023
Revision: 9946
https://developer.blender.org/rBM9946
Author: Blendify
Date: 2023-02-07 06:05:16 +0100 (Tue, 07 Feb 2023)
Log Message:
-----------
Update Node Wrangler documentation
- Update outdated shortcuts and names
- Add labels to functions that are only available in certain node editors
- Add menu locations to functions
- Add screenshots
- Add undocumented features: Principled Texture Setup, Reset Nodes
- Remove obsolete feature: Geometry Nodes preview
- Rewrite and re-organize many parts
- And other minor fixes
Fixes T100397
Author: @persun
Differential Revision: https://developer.blender.org/D17116
Modified Paths:
--------------
trunk/blender_docs/manual/addons/node/node_wrangler.rst
Added Paths:
-----------
trunk/blender_docs/manual/images/addons_node_node-wrangler_lazy-connect.png
trunk/blender_docs/manual/images/addons_node_node-wrangler_menu.png
trunk/blender_docs/manual/images/addons_node_node-wrangler_swap_links.png
trunk/blender_docs/manual/images/addons_node_node-wrangler_swap_pbr-setup.jpg
Modified: trunk/blender_docs/manual/addons/node/node_wrangler.rst
===================================================================
--- trunk/blender_docs/manual/addons/node/node_wrangler.rst 2023-02-07 04:57:17 UTC (rev 9945)
+++ trunk/blender_docs/manual/addons/node/node_wrangler.rst 2023-02-07 05:05:16 UTC (rev 9946)
@@ -3,26 +3,33 @@
Node Wrangler
*************
-This add-on gives you several tools that help you work with nodes quickly and efficiently.
-Many functions work for both the Compositor and shader nodes, and some functions bring features
-already in the Compositor to the shader nodes as well. Some tools are made for a specific function,
-however we have made it our goal to allow complete flexibility for you to use the tools in every situation,
-even where we did not intend.
+Node Wrangler provides various tools that help you to work with nodes quickly and efficiently.
+While many of this add-on's functions work in all supported node editors (Compositor, Shader, Geometry Nodes,
+and Texture Nodes) some functions only work in specific node editors, and some functions work differently per
+editor.
+Functions that only work in specific editors are marked with labels (:guilabel:`Compositor`, :guilabel:`Shader`,
+:guilabel:`Geometry Nodes`, :guilabel:`Texture Nodes`). Functions without labels should work for all node editors.
+
Activation
==========
-- Open Blender and go to Preferences then the Add-ons tab.
-- Click Node then Node Wrangler to enable the script.
+- Open Blender and go to the Preferences, then the Add-ons tab.
+- Find Node Wrangler and enable the add-on.
Usage
=====
-Use panel in Sidebar of node editor or :kbd:`Ctrl-Spacebar` keyboard shortcut or individual shortcuts for tools.
+Use the panel in Sidebar of the node editor or press :kbd:`Shift-W` to bring up the quick access menu. You can also
+look up the shortcut list in the add-on preferences panel.
+.. figure:: /images/addons_node_node-wrangler_menu.png
+ You can access most functions from the sidebar panel or quick access menu.
+
+
Description
===========
@@ -31,119 +38,164 @@
.. reference::
- :Shortcut: :kbd:`Ctrl-RMB`-drag, :kbd:`Shift-Ctrl-RMB`
+ :Shortcut: :kbd:`Alt-RMB`-drag, :kbd:`Alt-Shift-RMB`-drag
-Make links between the nodes without having to precisely select the sockets.
-Just drag from one node to another while holding :kbd:`Ctrl-RMB`.
-The nodes nearest the mouse are used, so you don't even have to click on one precisely.
+Connect two nodes without even clicking the sockets. Just drag the cursor from one node to another while
+holding :kbd:`Alt-RMB`.
+It will select the nodes nearest the start and end points of the drag for connection, so you don’t even have
+to click on the nodes.
-Also, use :kbd:`Shift-Ctrl-RMB` to show a menu of inputs and outputs to make a more accurate connection.
-This is useful when working with a large node tree,
-since you can easily make connections without having to zoom in and out a lot.
+.. figure:: /images/addons_node_node-wrangler_lazy-connect.png
+ Selection can be lazy.
+It tries to connect the best-matched sockets possible, based on their names, types, and whether they are
+open or not.
+
+For a more precise connection, you can alternatively use :kbd:`Alt-Shift-RMB`. It brings up menus of
+available inputs and outputs before connection, so you can select the exact sockets to connect.
+It's especially useful when working with a large node tree since you can make connections without
+frequently zooming in and out.
+
+
Lazy Mix
--------
.. reference::
- :Shortcut: :kbd:`Alt-RMB`-drag
+ :Shortcut: :kbd:`Ctrl-Shift-RMB`-drag
-Merge outputs of two nodes using a Mix node or Mix Shader node by dragging from one node to another
-while holding down :kbd:`Alt-RMB`. A Mix node or Mix Shader node will be added and
-the outputs of the nodes will be connected to it.
+Connect the outputs of two nodes into an appropriate "mix" type of node. This is the "lazy" way of selecting
+nodes and executing the *Mix* function from `Merge with Automatic Type Detection`_.
Merge
-----
-Quickly add Mix, Math, Z-Combine, Alpha Over, Mix Shader or Add Shader nodes
-that will merge outputs of selected nodes.
+.. reference::
+ :Menu: :menuselection:`Node Wrangler --> Merge Selected Nodes`
+Connect outputs of the selected nodes into a "mix" type of node (Mix, Math, Z-Combine, Alpha Over, Mix Shader, Add
+Shader, Join Geometry).
+
+.. note::
+
+ Merge currently does not support outputs of Integer, String, or Boolean types from Geometry Nodes.
+
+There are automatic and manual ways of merging. The automatic ways let the add-on determine which "mix" node
+to use based on the types of outputs to merge. The manual ways let you decide and force connections even if the
+types of outputs and the "mix" node are not compatible.
+
+.. note::
+
+ Generally, the modifier part of the shortcut signifies the type of "mix" node you want to use (:kbd:`Ctrl`
+ for automatic detection, :kbd:`Ctrl-Alt` for the Mix node, and :kbd:`Shift-Ctrl` for the Math node),
+ the non-modifier part signifies the mode of "mix" node you want to set (:kbd:`+` for add, :kbd:`-` for subtract,
+ :kbd:`/` for divide, and :kbd:`*` for multiply).
+
+
Merge with Automatic Type Detection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The automatic merge functions determine the type of "mix" node to use based on the types of outputs to merge. If
+it has a Color output, it will use the Mix node. It will use the Math node if both outputs are of Value type.
+Add Shader, Mix Shader, and Join Geometry nodes will also be used for specific cases.
+
+Modes
+ Add :kbd:`Ctrl-=`, :kbd:`Ctrl-NumpadPlus`
+ Merge into Mix or Math nodes, then set blend mode or math operation as Add. If the outputs are Shaders,
+ it will use Add Shader node instead.
+ Multiply :kbd:`Ctrl-8`, :kbd:`Ctrl-NumpadAsterisk`
+ Merge into Mix or Math nodes, then set blend mode or math operation as Multiply.
+ Subtract :kbd:`Ctrl-Minus`, :kbd:`Ctrl-NumpadMinus`
+ Merge into Mix or Math nodes, then set blend mode or math operation as Subtract.
+ Divide :kbd:`Ctrl-Slash`, :kbd:`Ctrl-NumpadSlash`
+ Merge into Mix or Math nodes, then set blend mode or math operation as Divide.
+ Mix :kbd:`Ctrl-0`, :kbd:`Ctrl-Numpad0`
+ Merge into Mix node, then set blend mode as Mix. If the outputs are Shaders, it will use Mix Shader node
+ instead. If the outputs are Geometry, it will use Join Geometry node.
+
+
+Merge Using Mix Node
+^^^^^^^^^^^^^^^^^^^^
+
.. reference::
- :Shortcut: :kbd:`Ctrl-0`, :kbd:`Shift-Ctrl-=`, :kbd:`Ctrl-Minus`, :kbd:`Shift-Ctrl-8`, :kbd:`Ctrl-Slash`,
- :kbd:`Shift-Ctrl-Comma`, :kbd:`Shift-Ctrl-Period`
+ :Menu: :menuselection:`Node Wrangler --> Merge Selected Nodes --> Use Mix Nodes`
-Selected nodes' outputs will be merged using Mix, Math, Mix Shader or Add Shader nodes,
-depending on types of selected nodes.
+Use the Mix nodes for merging, regardless of the selected nodes. You can choose the mode of the node via the menu.
+You can quickly set some operations by using corresponding shortcuts.
-Add :kbd:`Shift-Ctrl-=`
- Sets the blend mode or math operation to Add. When shaders are selected an Add Shader will be used.
-Multiply :kbd:`Shift-Ctrl-8`
- Multiply blend mode or math operation.
-Subtract :kbd:`Ctrl-Minus`
- Subtract blend mode or math operation.
-Divide :kbd:`Ctrl-Slash`
- Divide blend mode or math operation.
-Mix :kbd:`Ctrl-0`
- Mix blend mode or when shaders are selected a Mix Shader node will be used.
-Greater than :kbd:`Shift-Ctrl-Comma`
- Greater than math operation.
-Less than :kbd:`Shift-Ctrl-Period`
- Less than math operation.
+- Add: :kbd:`Ctrl-Alt-=`, :kbd:`Ctrl-Alt-=`
+- Substract: :kbd:`Ctrl-Alt-Minus`, :kbd:`Ctrl-Alt-NumpadMinus`
+- Multiply: :kbd:`Ctrl-Alt-8`, :kbd:`Ctrl-Alt-NumpadAsterisk`
+- Divide: :kbd:`Ctrl-Alt-Slash`, :kbd:`Ctrl-Alt-NumpadSlash`
-Merge Using Mix Node
-^^^^^^^^^^^^^^^^^^^^
+Merge Using Math Node
+^^^^^^^^^^^^^^^^^^^^^
.. reference::
- :Shortcut: :kbd:`Shift-Ctrl-Alt-=`, :kbd:`Ctrl-Alt-Minus`, :kbd:`Shift-Ctrl-Alt-8`, :kbd:`Ctrl-Alt-Slash`
+ :Menu: :menuselection:`Node Wrangler --> Merge Selected Nodes --> Use Math Nodes`
-Using :kbd:`Ctrl-Alt` with proper keys will force to use Mix node for merging
-no matter what types of nodes are selected.
+Use the Math nodes for merging, regardless of the selected nodes. You can choose the mode of the node via the menu.
+You can quickly set some operations by using corresponding shortcuts.
+- Add: :kbd:`Shift-Ctrl-=`, :kbd:`Shift-Ctrl-=`
+- Substract: :kbd:`Shift-Ctrl-Minus`, :kbd:`Shift-Ctrl-NumpadMinus`
+- Multiply: :kbd:`Shift-Ctrl-8`, :kbd:`Shift-Ctrl-NumpadAsterisk`
+- Divide: :kbd:`Shift-Ctrl-Slash`, :kbd:`Shift-Ctrl-NumpadSlash`
+- Greater than: :kbd:`Ctrl-Comma`
+- Less than: :kbd:`Ctrl-Period`
+
Merge Using Z-Combine Node
^^^^^^^^^^^^^^^^^^^^^^^^^^
+:guilabel:`Compositor`
+
.. reference::
+ :Menu: :menuselection:`Node Wrangler --> Merge Selected Nodes --> Use Z-Combine Nodes`
:Shortcut: :kbd:`Ctrl-NumpadPeriod`
-Z-Combine nodes will be used for merging. If possible -- image and Z-Depth outputs will be linked.
+Use the Z-Combine nodes for merging. If possible, Image and Z-Depth outputs will be linked. If the current
+node editor is not Compositor, this will execute the *Mix* function from the automatic merge.
Merge Using Alpha Over Node
^^^^^^^^^^^^^^^^^^^^^^^^^^^
+:guilabel:`Compositor`
+
.. reference::
+ :Menu: :menuselection:`Node Wrangler --> Merge Selected Nodes --> Use Alpha Over Nodes`
:Shortcut: :kbd:`Ctrl-Alt-0`
-Alpha Over nodes will be used for merging.
+Use the Alpha Over nodes for merging. If the current node editor is not Compositor, this will execute the *Mix*
+function from the automatic merge.
-Merge Using Math Node
-^^^^^^^^^^^^^^^^^^^^^
-
-.. reference::
-
- :Shortcut: :kbd:`Shift-Ctrl-=`, :kbd:`Shift-Ctrl-Minus`, :kbd:`Shift-Ctrl-8`,
- :kbd:`Shift-Ctrl-Slash`, :kbd:`Shift-Ctrl-Comma`, :kbd:`Shift-Ctrl-Period`
-
-Using :kbd:`Shift-Ctrl` with proper keys will force to use Math node for merging
-no matter what types of nodes are selected.
-
-
Batch Change Blend Mode / Math Operation
----------------------------------------
.. reference::
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-docboard-svn
mailing list