Geometry Nodes: Documentation for the menu switch node #104693

Merged
Lukas Tönne merged 1 commits from LukasTonne/blender-manual:menu-switch-node into main 2024-01-30 12:45:52 +01:00
5 changed files with 71 additions and 0 deletions

BIN
manual/images/node-types_GeometryNodeMenuSwitch.webp (Stored with Git LFS) Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -26,6 +26,7 @@ General purpose nodes for modifying data.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
menu_switch.rst
random_value.rst random_value.rst
repeat_zone.rst repeat_zone.rst
switch.rst switch.rst

View File

@ -0,0 +1,61 @@
.. index:: Geometry Nodes; Menu Switch
.. _bpy.types.GeometryNodeMenuSwitch:
****************
Menu Switch Node
****************
.. figure:: /images/node-types_GeometryNodeMenuSwitch.webp
:align: right
:alt: Menu Switch Node.
A *Menu Switch* node outputs one of its inputs depending on a menu
selection. Only the input that is passed through the node is computed.
The available menu entries are defined by the user. Menu items can be
added and removed, as well as renamed and reordered in the editor side
bar. Renaming a menu entry keeps existing links of the matching input
socket.
The menu can be used in node groups and the nodes modifier UI.
Connecting the menu input with a *Group Input* node will expose the menu
as a group input. A menu socket in a node group, reroute node, or other
pass-through nodes needs to be connected to a *Menu Switch* node in
order to work. An unconnected menu socket will show an empty menu by
default.
Connecting multiple *Menu Switch* nodes to the same output
socket creates a conflict (even when the menu entries are the same).
To avoid this a menu switch can be wrapped in a node group. Multiple
node groups of the same type can be connected to the same menu, since
they contain the same menu switch node.
+-------------------------------------------------------------------+------------------------------------------------------------------------+
|.. figure:: /images/node-types_GeometryNodeMenuSwitch_conflict.webp|.. figure:: /images/node-types_GeometryNodeMenuSwitch_group_wrapper.webp|
| :align: left | :align: right |
| :alt: Conflict caused by connecting different menus. | :alt: Same node group can be connected without conflict. |
+-------------------------------------------------------------------+------------------------------------------------------------------------+
Inputs
======
Menu
Determines which of the input options below will be passed through.
Item Inputs
One input is created for every menu entry. The input is used when the
matching option is selected.
Properties
==========
Type
Determines the type of the data that is handled by the node.
Outputs
=======
Output
One of the inputs without any modifications.