Merge of the PyNodes branch (aka "custom nodes") into trunk.
[blender.git] / source / blender / editors / space_node / node_templates.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  * Contributor(s): Blender Foundation 2009.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/editors/space_node/node_templates.c
24  *  \ingroup edinterface
25  */
26
27 #include <string.h>
28
29 #include "MEM_guardedalloc.h"
30
31 #include "DNA_node_types.h"
32 #include "DNA_screen_types.h"
33 #include "DNA_space_types.h"
34
35 #include "BLI_listbase.h"
36 #include "BLI_string.h"
37
38 #include "BLF_translation.h"
39
40 #include "BKE_context.h"
41 #include "BKE_library.h"
42 #include "BKE_main.h"
43 #include "BKE_scene.h"
44
45 #include "RNA_access.h"
46
47 #include "NOD_socket.h"
48
49 #include "UI_interface.h"
50 #include "../interface/interface_intern.h"  /* XXX bad level */
51
52 #include "ED_node.h"  /* own include */
53
54 #include "ED_util.h"
55
56 #include "node_intern.h"
57
58 /************************* Node Socket Manipulation **************************/
59
60 static void node_tag_recursive(bNode *node)
61 {
62         bNodeSocket *input;
63
64         if (!node || (node->flag & NODE_TEST))
65                 return;  /* in case of cycles */
66
67         node->flag |= NODE_TEST;
68
69         for (input = node->inputs.first; input; input = input->next)
70                 if (input->link)
71                         node_tag_recursive(input->link->fromnode);
72 }
73
74 static void node_clear_recursive(bNode *node)
75 {
76         bNodeSocket *input;
77
78         if (!node || !(node->flag & NODE_TEST))
79                 return;  /* in case of cycles */
80
81         node->flag &= ~NODE_TEST;
82
83         for (input = node->inputs.first; input; input = input->next)
84                 if (input->link)
85                         node_clear_recursive(input->link->fromnode);
86 }
87
88 static void node_remove_linked(bNodeTree *ntree, bNode *rem_node)
89 {
90         bNode *node, *next;
91         bNodeSocket *sock;
92
93         if (!rem_node)
94                 return;
95
96         /* tag linked nodes to be removed */
97         for (node = ntree->nodes.first; node; node = node->next)
98                 node->flag &= ~NODE_TEST;
99
100         node_tag_recursive(rem_node);
101
102         /* clear tags on nodes that are still used by other nodes */
103         for (node = ntree->nodes.first; node; node = node->next)
104                 if (!(node->flag & NODE_TEST))
105                         for (sock = node->inputs.first; sock; sock = sock->next)
106                                 if (sock->link && sock->link->fromnode != rem_node)
107                                         node_clear_recursive(sock->link->fromnode);
108
109         /* remove nodes */
110         for (node = ntree->nodes.first; node; node = next) {
111                 next = node->next;
112
113                 if (node->flag & NODE_TEST) {
114                         if (node->id)
115                                 node->id->us--;
116                         nodeFreeNode(ntree, node);
117                 }
118         }
119 }
120
121 /* disconnect socket from the node it is connected to */
122 static void node_socket_disconnect(Main *bmain, bNodeTree *ntree, bNode *node_to, bNodeSocket *sock_to)
123 {
124         if (!sock_to->link)
125                 return;
126
127         nodeRemLink(ntree, sock_to->link);
128         sock_to->flag |= SOCK_COLLAPSED;
129
130         nodeUpdate(ntree, node_to);
131         ntreeUpdateTree(ntree);
132
133         ED_node_tag_update_nodetree(bmain, ntree);
134 }
135
136 /* remove all nodes connected to this socket, if they aren't connected to other nodes */
137 static void node_socket_remove(Main *bmain, bNodeTree *ntree, bNode *node_to, bNodeSocket *sock_to)
138 {
139         if (!sock_to->link)
140                 return;
141
142         node_remove_linked(ntree, sock_to->link->fromnode);
143         sock_to->flag |= SOCK_COLLAPSED;
144
145         nodeUpdate(ntree, node_to);
146         ntreeUpdateTree(ntree);
147
148         ED_node_tag_update_nodetree(bmain, ntree);
149 }
150
151 /* add new node connected to this socket, or replace an existing one */
152 static void node_socket_add_replace(const bContext *C, bNodeTree *ntree, bNode *node_to, bNodeSocket *sock_to, int type, bNodeTree *ngroup, int sock_num)
153 {
154         bNode *node_from;
155         bNodeSocket *sock_from_tmp;
156         bNode *node_prev = NULL;
157
158         /* unlink existing node */
159         if (sock_to->link) {
160                 node_prev = sock_to->link->fromnode;
161                 nodeRemLink(ntree, sock_to->link);
162         }
163
164         /* find existing node that we can use */
165         for (node_from = ntree->nodes.first; node_from; node_from = node_from->next)
166                 if (node_from->type == type)
167                         break;
168
169         if (node_from)
170                 if (!(node_from->inputs.first == NULL && !(node_from->typeinfo->flag & NODE_OPTIONS)))
171                         node_from = NULL;
172
173         /* XXX how can this be done nicely? bNodeTemplate is removed, it doesn't work for generic custom nodes */
174         if (node_prev && node_prev->type == type &&
175             (type != NODE_GROUP || node_prev->id == &ngroup->id)) {
176                 /* keep the previous node if it's the same type */
177                 node_from = node_prev;
178         }
179         else if (!node_from) {
180                 node_from = nodeAddStaticNode(C, ntree, type);
181                 node_from->locx = node_to->locx - (node_from->typeinfo->width + 50);
182                 node_from->locy = node_to->locy;
183                 
184                 /* XXX bad, should be dispatched to generic operator or something ... */
185                 if (type==NODE_GROUP) {
186                         node_from->id = (ID*)ngroup;
187                 }
188                 
189                 if (node_from->id)
190                         id_us_plus(node_from->id);
191         }
192
193         nodeSetActive(ntree, node_from);
194
195         /* add link */
196         sock_from_tmp = BLI_findlink(&node_from->outputs, sock_num);
197         nodeAddLink(ntree, node_from, sock_from_tmp, node_to, sock_to);
198         sock_to->flag &= ~SOCK_COLLAPSED;
199
200         /* copy input sockets from previous node */
201         if (node_prev && node_from != node_prev) {
202                 bNodeSocket *sock_prev, *sock_from;
203
204                 for (sock_prev = node_prev->inputs.first; sock_prev; sock_prev = sock_prev->next) {
205                         for (sock_from = node_from->inputs.first; sock_from; sock_from = sock_from->next) {
206                                 if (nodeCountSocketLinks(ntree, sock_from) >= sock_from->limit)
207                                         continue;
208
209                                 if (strcmp(sock_prev->name, sock_from->name) == 0 && sock_prev->type == sock_from->type) {
210                                         bNodeLink *link = sock_prev->link;
211
212                                         if (link && link->fromnode) {
213                                                 nodeAddLink(ntree, link->fromnode, link->fromsock, node_from, sock_from);
214                                                 nodeRemLink(ntree, link);
215                                         }
216
217 #if 0 /* XXX TODO */
218                                         node_socket_free_default_value(sock_from->typeinfo, sock_from->default_value);
219                                         sock_from->default_value = node_socket_make_default_value(sock_from->typeinfo);
220                                         node_socket_copy_default_value(sock_from->typeinfo, sock_from->default_value, sock_prev->default_value);
221 #endif
222                                 }
223                         }
224                 }
225
226                 /* also preserve mapping for texture nodes */
227                 if (node_from->typeinfo->nclass == NODE_CLASS_TEXTURE &&
228                     node_prev->typeinfo->nclass == NODE_CLASS_TEXTURE)
229                 {
230                         memcpy(node_from->storage, node_prev->storage, sizeof(NodeTexBase));
231                 }
232
233                 /* remove node */
234                 node_remove_linked(ntree, node_prev);
235         }
236
237         nodeUpdate(ntree, node_from);
238         nodeUpdate(ntree, node_to);
239         ntreeUpdateTree(ntree);
240
241         ED_node_tag_update_nodetree(CTX_data_main(C), ntree);
242 }
243
244 /****************************** Node Link Menu *******************************/
245
246 // #define UI_NODE_LINK_ADD        0
247 #define UI_NODE_LINK_DISCONNECT -1
248 #define UI_NODE_LINK_REMOVE     -2
249
250 typedef struct NodeLinkArg {
251         Main *bmain;
252         Scene *scene;
253         bNodeTree *ntree;
254         bNode *node;
255         bNodeSocket *sock;
256
257         bNodeTree *ngroup;
258         int type;
259         int output;
260
261         uiLayout *layout;
262 } NodeLinkArg;
263
264 static void ui_node_link(bContext *C, void *arg_p, void *event_p)
265 {
266         NodeLinkArg *arg = (NodeLinkArg *)arg_p;
267         Main *bmain = arg->bmain;
268         bNode *node_to = arg->node;
269         bNodeSocket *sock_to = arg->sock;
270         bNodeTree *ntree = arg->ntree;
271         int event = GET_INT_FROM_POINTER(event_p);
272
273         if (event == UI_NODE_LINK_DISCONNECT)
274                 node_socket_disconnect(bmain, ntree, node_to, sock_to);
275         else if (event == UI_NODE_LINK_REMOVE)
276                 node_socket_remove(bmain, ntree, node_to, sock_to);
277         else
278                 node_socket_add_replace(C, ntree, node_to, sock_to, arg->type, arg->ngroup, arg->output);
279
280         ED_undo_push(C, "Node input modify");
281 }
282
283 static void ui_node_sock_name(bNodeSocket *sock, char name[UI_MAX_NAME_STR])
284 {
285         if (sock->link && sock->link->fromnode) {
286                 bNode *node = sock->link->fromnode;
287                 char node_name[UI_MAX_NAME_STR];
288
289                 if (node->type == NODE_GROUP) {
290                         if (node->id)
291                                 BLI_strncpy(node_name, node->id->name + 2, UI_MAX_NAME_STR);
292                         else
293                                 BLI_strncpy(node_name, N_(node->typeinfo->ui_name), UI_MAX_NAME_STR);
294                 }
295                 else
296                         BLI_strncpy(node_name, node->typeinfo->ui_name, UI_MAX_NAME_STR);
297
298                 if (node->inputs.first == NULL &&
299                     node->outputs.first != node->outputs.last)
300                 {
301                         BLI_snprintf(name, UI_MAX_NAME_STR, "%s | %s", IFACE_(node_name), IFACE_(sock->link->fromsock->name));
302                 }
303                 else {
304                         BLI_strncpy(name, IFACE_(node_name), UI_MAX_NAME_STR);
305                 }
306         }
307         else if (sock->type == SOCK_SHADER)
308                 BLI_strncpy(name, IFACE_("None"), UI_MAX_NAME_STR);
309         else
310                 BLI_strncpy(name, IFACE_("Default"), UI_MAX_NAME_STR);
311 }
312
313 static int ui_compatible_sockets(int typeA, int typeB)
314 {
315         return (typeA == typeB);
316 }
317
318 static void ui_node_menu_column(NodeLinkArg *arg, int nclass, const char *cname)
319 {
320         bNodeTree *ntree = arg->ntree;
321         bNodeSocket *sock = arg->sock;
322         uiLayout *layout = arg->layout;
323         uiLayout *column = NULL;
324         uiBlock *block = uiLayoutGetBlock(layout);
325         uiBut *but;
326         NodeLinkArg *argN;
327         int first = 1;
328         int compatibility = 0;
329         
330         if (ntree->type == NTREE_SHADER) {
331                 if (BKE_scene_use_new_shading_nodes(arg->scene))
332                         compatibility = NODE_NEW_SHADING;
333                 else
334                         compatibility = NODE_OLD_SHADING;
335         }
336
337         NODE_TYPES_BEGIN(ntype)
338                 bNodeSocketTemplate *stemp;
339                 char name[UI_MAX_NAME_STR];
340                 int i, j, num = 0;
341                 
342                 if (compatibility && !(ntype->compatibility & compatibility))
343                         continue;
344                 
345                 if (ntype->nclass != nclass)
346                         continue;
347                 
348                 for (i = 0, stemp = ntype->outputs; stemp && stemp->type != -1; stemp++, i++)
349                         if (ui_compatible_sockets(stemp->type, sock->type))
350                                 num++;
351                 
352                 for (i = 0, j = 0, stemp = ntype->outputs; stemp && stemp->type != -1; stemp++, i++) {
353                         if (!ui_compatible_sockets(stemp->type, sock->type))
354                                 continue;
355                         
356                         if (first) {
357                                 column = uiLayoutColumn(layout, 0);
358                                 uiBlockSetCurLayout(block, column);
359                                 
360                                 uiItemL(column, IFACE_(cname), ICON_NODE);
361                                 but = block->buttons.last;
362                                 but->flag = UI_TEXT_LEFT;
363                                 
364                                 first = 0;
365                         }
366                         
367                         if (num > 1) {
368                                 if (j == 0) {
369                                         uiItemL(column, IFACE_(ntype->ui_name), ICON_NODE);
370                                         but = block->buttons.last;
371                                         but->flag = UI_TEXT_LEFT;
372                                 }
373                                 
374                                 BLI_snprintf(name, UI_MAX_NAME_STR, "  %s", IFACE_(stemp->name));
375                                 j++;
376                         }
377                         else
378                                 BLI_strncpy(name, IFACE_(ntype->ui_name), UI_MAX_NAME_STR);
379                         
380                         but = uiDefBut(block, BUT, 0, name, 0, 0, UI_UNIT_X*4, UI_UNIT_Y,
381                                 NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Add node to input"));
382                         
383                         argN = MEM_dupallocN(arg);
384                         argN->type = ntype->type;
385                         argN->output = i;
386                         uiButSetNFunc(but, ui_node_link, argN, NULL);
387                 }
388         NODE_TYPES_END
389 }
390
391 static void node_menu_column_foreach_cb(void *calldata, int nclass, const char *name)
392 {
393         NodeLinkArg *arg = (NodeLinkArg *)calldata;
394
395         if (!ELEM(nclass, NODE_CLASS_GROUP, NODE_CLASS_LAYOUT))
396                 ui_node_menu_column(arg, nclass, name);
397 }
398
399 static void ui_template_node_link_menu(bContext *C, uiLayout *layout, void *but_p)
400 {
401         Main *bmain = CTX_data_main(C);
402         Scene *scene = CTX_data_scene(C);
403         uiBlock *block = uiLayoutGetBlock(layout);
404         uiBut *but = (uiBut *)but_p;
405         uiLayout *split, *column;
406         NodeLinkArg *arg = (NodeLinkArg *)but->func_argN;
407         bNodeSocket *sock = arg->sock;
408         bNodeTreeType *ntreetype = arg->ntree->typeinfo;
409
410         uiBlockSetCurLayout(block, layout);
411         split = uiLayoutSplit(layout, 0.0f, FALSE);
412
413         arg->bmain = bmain;
414         arg->scene = scene;
415         arg->layout = split;
416
417         if (ntreetype && ntreetype->foreach_nodeclass)
418                 ntreetype->foreach_nodeclass(scene, arg, node_menu_column_foreach_cb);
419
420         column = uiLayoutColumn(split, FALSE);
421         uiBlockSetCurLayout(block, column);
422
423         if (sock->link) {
424                 uiItemL(column, IFACE_("Link"), ICON_NONE);
425                 but = block->buttons.last;
426                 but->flag = UI_TEXT_LEFT;
427
428                 but = uiDefBut(block, BUT, 0, IFACE_("Remove"), 0, 0, UI_UNIT_X * 4, UI_UNIT_Y,
429                                NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Remove nodes connected to the input"));
430                 uiButSetNFunc(but, ui_node_link, MEM_dupallocN(arg), SET_INT_IN_POINTER(UI_NODE_LINK_REMOVE));
431
432                 but = uiDefBut(block, BUT, 0, IFACE_("Disconnect"), 0, 0, UI_UNIT_X * 4, UI_UNIT_Y,
433                                NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Disconnect nodes connected to the input"));
434                 uiButSetNFunc(but, ui_node_link, MEM_dupallocN(arg), SET_INT_IN_POINTER(UI_NODE_LINK_DISCONNECT));
435         }
436
437         ui_node_menu_column(arg, NODE_CLASS_GROUP, N_("Group"));
438 }
439
440 void uiTemplateNodeLink(uiLayout *layout, bNodeTree *ntree, bNode *node, bNodeSocket *sock)
441 {
442         uiBlock *block = uiLayoutGetBlock(layout);
443         NodeLinkArg *arg;
444         uiBut *but;
445
446         arg = MEM_callocN(sizeof(NodeLinkArg), "NodeLinkArg");
447         arg->ntree = ntree;
448         arg->node = node;
449         arg->sock = sock;
450         arg->type = 0;
451         arg->output = 0;
452
453         uiBlockSetCurLayout(block, layout);
454
455         if (sock->link || sock->type == SOCK_SHADER || (sock->flag & SOCK_HIDE_VALUE)) {
456                 char name[UI_MAX_NAME_STR];
457                 ui_node_sock_name(sock, name);
458                 but = uiDefMenuBut(block, ui_template_node_link_menu, NULL, name, 0, 0, UI_UNIT_X * 4, UI_UNIT_Y, "");
459         }
460         else
461                 but = uiDefIconMenuBut(block, ui_template_node_link_menu, NULL, ICON_NONE, 0, 0, UI_UNIT_X, UI_UNIT_Y, "");
462
463         but->type = MENU;
464         but->flag |= UI_TEXT_LEFT | UI_BUT_NODE_LINK;
465         but->poin = (char *)but;
466         but->func_argN = arg;
467
468         if (sock->link && sock->link->fromnode)
469                 if (sock->link->fromnode->flag & NODE_ACTIVE_TEXTURE)
470                         but->flag |= UI_BUT_NODE_ACTIVE;
471 }
472
473 /**************************** Node Tree Layout *******************************/
474
475 static void ui_node_draw_input(uiLayout *layout, bContext *C,
476                                bNodeTree *ntree, bNode *node, bNodeSocket *input, int depth);
477
478 static void ui_node_draw_node(uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, int depth)
479 {
480         bNodeSocket *input;
481         uiLayout *col, *split;
482         PointerRNA nodeptr;
483
484         RNA_pointer_create(&ntree->id, &RNA_Node, node, &nodeptr);
485
486         if (node->typeinfo->uifunc) {
487                 if (node->type != NODE_GROUP) {
488                         split = uiLayoutSplit(layout, 0.35f, FALSE);
489                         col = uiLayoutColumn(split, FALSE);
490                         col = uiLayoutColumn(split, FALSE);
491
492                         node->typeinfo->uifunc(col, C, &nodeptr);
493                 }
494         }
495
496         for (input = node->inputs.first; input; input = input->next)
497                 ui_node_draw_input(layout, C, ntree, node, input, depth + 1);
498 }
499
500 static void ui_node_draw_input(uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input, int depth)
501 {
502         PointerRNA inputptr, nodeptr;
503         uiBlock *block = uiLayoutGetBlock(layout);
504         uiBut *bt;
505         uiLayout *split, *row, *col;
506         bNode *lnode;
507         char label[UI_MAX_NAME_STR];
508         int indent = (depth > 1) ? 2 * (depth - 1) : 0;
509         int dependency_loop;
510
511         if (input->flag & SOCK_UNAVAIL)
512                 return;
513
514         /* to avoid eternal loops on cyclic dependencies */
515         node->flag |= NODE_TEST;
516         lnode = (input->link) ? input->link->fromnode : NULL;
517
518         dependency_loop = (lnode && (lnode->flag & NODE_TEST));
519         if (dependency_loop)
520                 lnode = NULL;
521
522         /* socket RNA pointer */
523         RNA_pointer_create(&ntree->id, &RNA_NodeSocket, input, &inputptr);
524         RNA_pointer_create(&ntree->id, &RNA_Node, node, &nodeptr);
525
526         /* indented label */
527         memset(label, ' ', indent);
528         label[indent] = '\0';
529         BLI_snprintf(label, UI_MAX_NAME_STR, "%s%s:", label, IFACE_(input->name));
530
531         /* split in label and value */
532         split = uiLayoutSplit(layout, 0.35f, FALSE);
533
534         row = uiLayoutRow(split, TRUE);
535
536         if (depth > 0) {
537                 uiBlockSetEmboss(block, UI_EMBOSSN);
538
539                 if (lnode && (lnode->inputs.first || (lnode->typeinfo->uifunc && lnode->type != NODE_GROUP))) {
540                         int icon = (input->flag & SOCK_COLLAPSED) ? ICON_DISCLOSURE_TRI_RIGHT : ICON_DISCLOSURE_TRI_DOWN;
541                         uiItemR(row, &inputptr, "show_expanded", UI_ITEM_R_ICON_ONLY, "", icon);
542                 }
543                 else
544                         uiItemL(row, "", ICON_BLANK1);
545
546                 bt = block->buttons.last;
547                 bt->rect.xmax = UI_UNIT_X / 2;
548
549                 uiBlockSetEmboss(block, UI_EMBOSS);
550         }
551
552         uiItemL(row, label, ICON_NONE);
553         bt = block->buttons.last;
554         bt->flag = UI_TEXT_LEFT;
555
556         if (dependency_loop) {
557                 row = uiLayoutRow(split, FALSE);
558                 uiItemL(row, IFACE_("Dependency Loop"), ICON_ERROR);
559         }
560         else if (lnode) {
561                 /* input linked to a node */
562                 uiTemplateNodeLink(split, ntree, node, input);
563
564                 if (depth == 0 || !(input->flag & SOCK_COLLAPSED)) {
565                         if (depth == 0)
566                                 uiItemS(layout);
567
568                         ui_node_draw_node(layout, C, ntree, lnode, depth);
569                 }
570         }
571         else {
572                 /* input not linked, show value */
573                 if (!(input->flag & SOCK_HIDE_VALUE)) {
574                         switch (input->type) {
575                         case SOCK_FLOAT:
576                         case SOCK_INT:
577                         case SOCK_BOOLEAN:
578                         case SOCK_RGBA:
579                         case SOCK_STRING:
580                                 row = uiLayoutRow(split, TRUE);
581                                 uiItemR(row, &inputptr, "default_value", 0, "", ICON_NONE);
582                                 break;
583                         case SOCK_VECTOR:
584                                 row = uiLayoutRow(split, FALSE);
585                                 col = uiLayoutColumn(row, FALSE);
586                                 uiItemR(col, &inputptr, "default_value", 0, "", ICON_NONE);
587                                 break;
588                                 
589                         default:
590                                 row = uiLayoutRow(split, FALSE);
591                                 break;
592                         }
593                 }
594                 else
595                         row = uiLayoutRow(split, FALSE);
596
597                 uiTemplateNodeLink(row, ntree, node, input);
598         }
599
600         /* clear */
601         node->flag &= ~NODE_TEST;
602 }
603
604 void uiTemplateNodeView(uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input)
605 {
606         bNode *tnode;
607
608         if (!ntreeIsValid(ntree))
609                 return;
610
611         /* clear for cycle check */
612         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next)
613                 tnode->flag &= ~NODE_TEST;
614
615         if (input)
616                 ui_node_draw_input(layout, C, ntree, node, input, 0);
617         else
618                 ui_node_draw_node(layout, C, ntree, node, 0);
619 }
620