Quick addition to the node sidebar "Active Node" panel: draw input socket values...
[blender.git] / source / blender / editors / space_node / node_buttons.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_node/node_buttons.c
28  *  \ingroup spnode
29  */
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_node_types.h"
34
35 #include "BLI_math.h"
36 #include "BLI_blenlib.h"
37
38 #include "BLF_translation.h"
39
40 #include "BKE_context.h"
41 #include "BKE_global.h"
42 #include "BKE_node.h"
43 #include "BKE_screen.h"
44
45 #include "WM_api.h"
46 #include "WM_types.h"
47
48 #include "RNA_access.h"
49
50 #include "ED_gpencil.h"
51 #include "ED_screen.h"
52
53 #include "UI_resources.h"
54
55 #include "node_intern.h"  /* own include */
56
57
58 /* ******************* node space & buttons ************** */
59
60 /* poll for active nodetree */
61 static int active_nodetree_poll(const bContext *C, PanelType *UNUSED(pt))
62 {
63         SpaceNode *snode = CTX_wm_space_node(C);
64         
65         return (snode && snode->nodetree);
66 }
67
68 /* poll callback for active node */
69 static int active_node_poll(const bContext *C, PanelType *UNUSED(pt))
70 {
71         SpaceNode *snode = CTX_wm_space_node(C);
72         
73         return (snode && snode->edittree && nodeGetActive(snode->edittree));
74 }
75
76 /* active node */
77 static void active_node_panel(const bContext *C, Panel *pa)
78 {
79         SpaceNode *snode = CTX_wm_space_node(C);
80         bNodeTree *ntree = (snode) ? snode->edittree : NULL;
81         bNode *node = (ntree) ? nodeGetActive(ntree) : NULL; // xxx... for editing group nodes
82         bNodeSocket *sock;
83         uiLayout *layout, *row, *col, *sub;
84         PointerRNA ptr, opptr;
85         bool show_inputs;
86         
87         /* verify pointers, and create RNA pointer for the node */
88         if (ELEM(NULL, ntree, node))
89                 return;
90         //if (node->id) /* for group nodes */
91         //      RNA_pointer_create(node->id, &RNA_Node, node, &ptr);
92         //else
93         RNA_pointer_create(&ntree->id, &RNA_Node, node, &ptr);
94         
95         layout = uiLayoutColumn(pa->layout, FALSE);
96         uiLayoutSetContextPointer(layout, "node", &ptr);
97         
98         /* draw this node's name, etc. */
99         uiItemR(layout, &ptr, "label", 0, NULL, ICON_NODE);
100         uiItemS(layout);
101         uiItemR(layout, &ptr, "name", 0, NULL, ICON_NODE);
102         uiItemS(layout);
103         
104         uiItemO(layout, NULL, 0, "NODE_OT_hide_socket_toggle");
105         uiItemS(layout);
106         uiItemS(layout);
107
108         row = uiLayoutRow(layout, FALSE);
109         
110         col = uiLayoutColumn(row, TRUE);
111         uiItemM(col, (bContext *)C, "NODE_MT_node_color_presets", NULL, 0);
112         uiItemR(col, &ptr, "use_custom_color", UI_ITEM_R_ICON_ONLY, NULL, ICON_NONE);
113         sub = uiLayoutRow(col, FALSE);
114         if (!(node->flag & NODE_CUSTOM_COLOR))
115                 uiLayoutSetEnabled(sub, FALSE);
116         uiItemR(sub, &ptr, "color", 0, "", ICON_NONE);
117         
118         col = uiLayoutColumn(row, TRUE);
119         uiItemO(col, "", ICON_ZOOMIN, "node.node_color_preset_add");
120         opptr = uiItemFullO(col, "node.node_color_preset_add", "", ICON_ZOOMOUT, NULL, WM_OP_INVOKE_DEFAULT, UI_ITEM_O_RETURN_PROPS);
121         RNA_boolean_set(&opptr, "remove_active", 1);
122         uiItemM(col, (bContext *)C, "NODE_MT_node_color_specials", "", ICON_DOWNARROW_HLT);
123         
124         /* draw this node's settings */
125         if (node->typeinfo && node->typeinfo->uifuncbut) {
126                 uiItemS(layout);
127                 uiItemS(layout);
128                 node->typeinfo->uifuncbut(layout, (bContext *)C, &ptr);
129         }
130         else if (node->typeinfo && node->typeinfo->uifunc) {
131                 uiItemS(layout);
132                 uiItemS(layout);
133                 node->typeinfo->uifunc(layout, (bContext *)C, &ptr);
134         }
135         
136         uiItemS(layout);
137         
138         /* socket input values */
139         /* XXX this is not quite perfect yet, it still shows sockets without meaningful input values
140          * and does not yet use the socket link template - but better than nothing.
141          * Eventually could move this panel to python
142          * and leave it up to the individual node system implementation.
143          */
144         show_inputs = false;
145         for (sock = node->inputs.first; sock; sock = sock->next) {
146                 if (!nodeSocketIsHidden(sock) && !(sock->flag & SOCK_IN_USE)) {
147                         show_inputs = true;
148                         break;
149                 }
150         }
151         if (show_inputs) {
152                 uiItemL(layout, "Inputs:", 0);
153                 for (sock = node->inputs.first; sock; sock = sock->next) {
154                         if (!nodeSocketIsHidden(sock) && !(sock->flag & SOCK_IN_USE)) {
155                                 uiLayout *row = uiLayoutRow(layout, false);
156                                 PointerRNA sock_ptr;
157                                 RNA_pointer_create(&ntree->id, &RNA_NodeSocket, sock, &sock_ptr);
158                                 sock->typeinfo->draw((bContext *)C, row, &sock_ptr, &ptr, sock->name);
159                         }
160                 }
161         }
162 }
163
164 static int node_sockets_poll(const bContext *C, PanelType *UNUSED(pt))
165 {
166         SpaceNode *snode = CTX_wm_space_node(C);
167         
168         return (snode && snode->nodetree && G.debug_value == 777);
169 }
170
171 static void node_sockets_panel(const bContext *C, Panel *pa)
172 {
173         SpaceNode *snode = CTX_wm_space_node(C);
174         bNodeTree *ntree = (snode) ? snode->edittree : NULL;
175         bNode *node = (ntree) ? nodeGetActive(ntree) : NULL;
176         bNodeSocket *sock;
177         uiLayout *layout = pa->layout, *split;
178         char name[UI_MAX_NAME_STR];
179         
180         if (ELEM(NULL, ntree, node))
181                 return;
182         
183         for (sock = node->inputs.first; sock; sock = sock->next) {
184                 BLI_snprintf(name, sizeof(name), "%s:", sock->name);
185
186                 split = uiLayoutSplit(layout, 0.35f, FALSE);
187                 uiItemL(split, name, ICON_NONE);
188                 uiTemplateNodeLink(split, ntree, node, sock);
189         }
190 }
191
192 static int node_tree_interface_poll(const bContext *C, PanelType *UNUSED(pt))
193 {
194         SpaceNode *snode = CTX_wm_space_node(C);
195         
196         return (snode && snode->edittree && (snode->edittree->inputs.first || snode->edittree->outputs.first));
197 }
198
199 static int node_tree_find_active_socket(bNodeTree *ntree, bNodeSocket **r_sock, int *r_in_out)
200 {
201         bNodeSocket *sock;
202         for (sock = ntree->inputs.first; sock; sock = sock->next) {
203                 if (sock->flag & SELECT) {
204                         *r_sock = sock;
205                         *r_in_out = SOCK_IN;
206                         return TRUE;
207                 }
208         }
209         for (sock = ntree->outputs.first; sock; sock = sock->next) {
210                 if (sock->flag & SELECT) {
211                         *r_sock = sock;
212                         *r_in_out = SOCK_OUT;
213                         return TRUE;
214                 }
215         }
216         
217         *r_sock = NULL;
218         *r_in_out = 0;
219         return FALSE;
220 }
221
222 static void node_tree_interface_panel(const bContext *C, Panel *pa)
223 {
224         SpaceNode *snode = CTX_wm_space_node(C);
225         bNodeTree *ntree = (snode) ? snode->edittree : NULL;
226         bNodeSocket *sock;
227         int in_out;
228         uiLayout *layout = pa->layout, *row, *split, *col;
229         PointerRNA ptr, sockptr, opptr;
230
231         if (!ntree)
232                 return;
233         
234         RNA_id_pointer_create((ID *)ntree, &ptr);
235         
236         node_tree_find_active_socket(ntree, &sock, &in_out);
237         RNA_pointer_create((ID *)ntree, &RNA_NodeSocketInterface, sock, &sockptr);
238         
239         row = uiLayoutRow(layout, FALSE);
240         
241         split = uiLayoutRow(row, TRUE);
242         col = uiLayoutColumn(split, TRUE);
243         uiItemL(col, IFACE_("Inputs:"), ICON_NONE);
244         uiTemplateList(col, (bContext *)C, "NODE_UL_interface_sockets", "inputs", &ptr, "inputs", &ptr, "active_input", 0, 0, 0);
245         opptr = uiItemFullO(col, "NODE_OT_tree_socket_add", "", ICON_PLUS, NULL, WM_OP_EXEC_DEFAULT, UI_ITEM_O_RETURN_PROPS);
246         RNA_enum_set(&opptr, "in_out", SOCK_IN);
247         
248         col = uiLayoutColumn(split, TRUE);
249         uiItemL(col, IFACE_("Outputs:"), ICON_NONE);
250         uiTemplateList(col, (bContext *)C, "NODE_UL_interface_sockets", "outputs", &ptr, "outputs", &ptr, "active_output", 0, 0, 0);
251         opptr = uiItemFullO(col, "NODE_OT_tree_socket_add", "", ICON_PLUS, NULL, WM_OP_EXEC_DEFAULT, UI_ITEM_O_RETURN_PROPS);
252         RNA_enum_set(&opptr, "in_out", SOCK_OUT);
253         
254         col = uiLayoutColumn(row, TRUE);
255         opptr = uiItemFullO(col, "NODE_OT_tree_socket_move", "", ICON_TRIA_UP, NULL, WM_OP_EXEC_DEFAULT, UI_ITEM_O_RETURN_PROPS);
256         RNA_enum_set(&opptr, "direction", 1);
257         opptr = uiItemFullO(col, "NODE_OT_tree_socket_move", "", ICON_TRIA_DOWN, NULL, WM_OP_EXEC_DEFAULT, UI_ITEM_O_RETURN_PROPS);
258         RNA_enum_set(&opptr, "direction", 2);
259         
260         if (sock) {
261                 row = uiLayoutRow(layout, TRUE);
262                 uiItemR(row, &sockptr, "name", 0, NULL, ICON_NONE);
263                 uiItemO(row, "", ICON_X, "NODE_OT_tree_socket_remove");
264                 
265                 if (sock->typeinfo->interface_draw) {
266                         uiItemS(layout);
267                         sock->typeinfo->interface_draw((bContext *)C, layout, &sockptr);
268                 }
269         }
270 }
271
272 /* ******************* node buttons registration ************** */
273
274 void node_buttons_register(ARegionType *art)
275 {
276         PanelType *pt;
277         
278         pt = MEM_callocN(sizeof(PanelType), "spacetype node panel active node");
279         strcpy(pt->idname, "NODE_PT_item");
280         strcpy(pt->label, N_("Active Node"));
281         strcpy(pt->translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
282         pt->draw = active_node_panel;
283         pt->poll = active_node_poll;
284         BLI_addtail(&art->paneltypes, pt);
285
286         pt = MEM_callocN(sizeof(PanelType), "spacetype node panel node sockets");
287         strcpy(pt->idname, "NODE_PT_sockets");
288         strcpy(pt->label, N_("Sockets"));
289         strcpy(pt->translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
290         pt->draw = node_sockets_panel;
291         pt->poll = node_sockets_poll;
292         pt->flag |= PNL_DEFAULT_CLOSED;
293         BLI_addtail(&art->paneltypes, pt);
294
295         pt = MEM_callocN(sizeof(PanelType), "spacetype node panel tree interface");
296         strcpy(pt->idname, "NODE_PT_node_tree_interface");
297         strcpy(pt->label, N_("Interface"));
298         strcpy(pt->translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
299         pt->draw = node_tree_interface_panel;
300         pt->poll = node_tree_interface_poll;
301         BLI_addtail(&art->paneltypes, pt);
302
303         pt = MEM_callocN(sizeof(PanelType), "spacetype node panel gpencil");
304         strcpy(pt->idname, "NODE_PT_gpencil");
305         strcpy(pt->label, N_("Grease Pencil"));
306         strcpy(pt->translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
307         pt->draw_header = gpencil_panel_standard_header;
308         pt->draw = gpencil_panel_standard;
309         pt->poll = active_nodetree_poll;
310         BLI_addtail(&art->paneltypes, pt);
311 }
312
313 static int node_properties(bContext *C, wmOperator *UNUSED(op))
314 {
315         ScrArea *sa = CTX_wm_area(C);
316         ARegion *ar = node_has_buttons_region(sa);
317         
318         if (ar)
319                 ED_region_toggle_hidden(C, ar);
320
321         return OPERATOR_FINISHED;
322 }
323
324 /* non-standard poll operator which doesn't care if there are any nodes */
325 static int node_properties_poll(bContext *C)
326 {
327         ScrArea *sa = CTX_wm_area(C);
328         return (sa && (sa->spacetype == SPACE_NODE));
329 }
330
331 void NODE_OT_properties(wmOperatorType *ot)
332 {
333         ot->name = "Properties";
334         ot->description = "Toggles the properties panel display";
335         ot->idname = "NODE_OT_properties";
336         
337         ot->exec = node_properties;
338         ot->poll = node_properties_poll;
339         
340         /* flags */
341         ot->flag = 0;
342 }