Blender Git Loki

Git Commits -> Revision 94931f9

Revision 94931f9 by Lukas Toenne (master)
April 13, 2013, 15:38 (GMT)
Replacing the node Add menu and making the toolbar useful

As some people have already noticed, the "Add" menu for nodes is a bit messy since pynodes merge. The reason for this is that the order of nodes in submenus (categories) was previously defined by the order in which all nodes are registered (at the bottom of blenkernel/intern/node.c). For the dynamic registration of node types now possible this system of defining node order along with registration is no longer viable: while it would still sort of work for C nodes, it is completely meaningless for dynamic (python) nodes, which are basically registered automatically in whatever order modules and addons are loaded, with the added complexity of unloading and reloading.

To fix this problem and add a bunch of desirable features this commit replaces the C menu with a python implementation. The new menu does not rely on any particular order of types in the node registry, but instead uses a simple explicit list of all the available nodes, grouped by categories (in scripts/nodeitems_builtins.py).

There are a number of additional features that become possible with this implementation:

1) Node Toolbar can be populated!
The list of nodes is used to create 2 UI items for each node: 1 entry in a submenu of "Add" menu and 1 item in a node toolbar panel with basically the same functionality. Clicking a button in the toolbar will add a new node of this type, just like selecting an item in the menu. The toolbar has the advantage of having collapsible panels for each category, so users can decide if they don't need certain nodes categories and have the rest more easily accessible.

2) Each node item is a true operator call.
The old Add menu is a pretty old piece of C code which doesn't even use proper operator buttons. Now there is a generic node_add operator which can be used very flexibly for adding any of the available nodes.

3) Node Items support additional settings.
Each "NodeItem" consists of the basic node type plus an optional list of initial settings that shall be applied to a new instance. This gives additional flexibility for creating variants of the same node or for defining preferred initial settings. E.g. it has been requested to disable previews for all nodes except inputs, this would be simple change in the py code and much less intrusive than in C.

4) Node items can be generated with a function.
A callback can be used in any category instead of the fixed list, which generates a set of items based on the context (much like dynamic enum items in bpy.props). Originally this was implemented for group nodes, because these nodes only make sense when linked to a node tree from the library data. This principle could come in handy for a number of other nodes, e.g. Image nodes could provide a similar list of node variants based on images in the library - no need to first add node, then select an image.

WARNING: pynodes scripters will have to rework their "draw_add_menu" callback in node tree types, this has been removed now! It was already pretty redundant, since one can add draw functions to the Add menu just like for any other menu. In the future i'd like to improve the categories system further so scripters can use it for custom node systems too, for now just make a draw callback and attach it to the Add menu.

Commit Details:

Full Hash: 94931f9f45e5d9db369fd6e5b5142964cd95f3d7
SVN Revision: 56012
Parent Commit: a710434
Lines Changed: +509, -260

2 Added Paths:

/release/scripts/modules/nodeitems_utils.py (+123, -0) (View)
/release/scripts/startup/nodeitems_builtins.py (+356, -0) (View)

1 Deleted Path:

/source/blender/editors/space_node/node_header.c (+0, -88)

7 Modified Paths:

/release/scripts/startup/bl_operators/node.py (+28, -26) (Diff)
/source/blender/blenkernel/BKE_node.h (+0, -2) (Diff)
/source/blender/editors/space_node/CMakeLists.txt (+0, -1) (Diff)
/source/blender/editors/space_node/drawnode.c (+0, -105) (Diff)
/source/blender/editors/space_node/node_intern.h (+0, -3) (Diff)
/source/blender/editors/space_node/space_node.c (+0, -2) (Diff)
/source/blender/makesrna/intern/rna_nodetree.c (+2, -33) (Diff)
Tehnyt: Miika HämäläinenViimeksi päivitetty: 07.11.2014 14:18MiikaH:n Sivut a.k.a. MiikaHweb | 2003-2021