code cleanup
[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         {
177                 /* keep the previous node if it's the same type */
178                 node_from = node_prev;
179         }
180         else if (!node_from) {
181                 node_from = nodeAddStaticNode(C, ntree, type);
182                 node_from->locx = node_to->locx - (node_from->typeinfo->width + 50);
183                 node_from->locy = node_to->locy;
184                 
185                 /* XXX bad, should be dispatched to generic operator or something ... */
186                 if (type == NODE_GROUP) {
187                         node_from->id = (ID *)ngroup;
188                 }
189                 
190                 if (node_from->id)
191                         id_us_plus(node_from->id);
192         }
193
194         nodeSetActive(ntree, node_from);
195
196         /* add link */
197         sock_from_tmp = BLI_findlink(&node_from->outputs, sock_num);
198         nodeAddLink(ntree, node_from, sock_from_tmp, node_to, sock_to);
199         sock_to->flag &= ~SOCK_COLLAPSED;
200
201         /* copy input sockets from previous node */
202         if (node_prev && node_from != node_prev) {
203                 bNodeSocket *sock_prev, *sock_from;
204
205                 for (sock_prev = node_prev->inputs.first; sock_prev; sock_prev = sock_prev->next) {
206                         for (sock_from = node_from->inputs.first; sock_from; sock_from = sock_from->next) {
207                                 if (nodeCountSocketLinks(ntree, sock_from) >= sock_from->limit)
208                                         continue;
209
210                                 if (STREQ(sock_prev->name, sock_from->name) && sock_prev->type == sock_from->type) {
211                                         bNodeLink *link = sock_prev->link;
212
213                                         if (link && link->fromnode) {
214                                                 nodeAddLink(ntree, link->fromnode, link->fromsock, node_from, sock_from);
215                                                 nodeRemLink(ntree, link);
216                                         }
217
218 #if 0 /* XXX TODO */
219                                         node_socket_free_default_value(sock_from->typeinfo, sock_from->default_value);
220                                         sock_from->default_value = node_socket_make_default_value(sock_from->typeinfo);
221                                         node_socket_copy_default_value(sock_from->typeinfo, sock_from->default_value, sock_prev->default_value);
222 #endif
223                                 }
224                         }
225                 }
226
227                 /* also preserve mapping for texture nodes */
228                 if (node_from->typeinfo->nclass == NODE_CLASS_TEXTURE &&
229                     node_prev->typeinfo->nclass == NODE_CLASS_TEXTURE)
230                 {
231                         memcpy(node_from->storage, node_prev->storage, sizeof(NodeTexBase));
232                 }
233
234                 /* remove node */
235                 node_remove_linked(ntree, node_prev);
236         }
237
238         nodeUpdate(ntree, node_from);
239         nodeUpdate(ntree, node_to);
240         ntreeUpdateTree(ntree);
241
242         ED_node_tag_update_nodetree(CTX_data_main(C), ntree);
243 }
244
245 /****************************** Node Link Menu *******************************/
246
247 // #define UI_NODE_LINK_ADD        0
248 #define UI_NODE_LINK_DISCONNECT -1
249 #define UI_NODE_LINK_REMOVE     -2
250
251 typedef struct NodeLinkArg {
252         Main *bmain;
253         Scene *scene;
254         bNodeTree *ntree;
255         bNode *node;
256         bNodeSocket *sock;
257
258         bNodeTree *ngroup;
259         int type;
260         int output;
261
262         uiLayout *layout;
263 } NodeLinkArg;
264
265 static void ui_node_link(bContext *C, void *arg_p, void *event_p)
266 {
267         NodeLinkArg *arg = (NodeLinkArg *)arg_p;
268         Main *bmain = arg->bmain;
269         bNode *node_to = arg->node;
270         bNodeSocket *sock_to = arg->sock;
271         bNodeTree *ntree = arg->ntree;
272         int event = GET_INT_FROM_POINTER(event_p);
273
274         if (event == UI_NODE_LINK_DISCONNECT)
275                 node_socket_disconnect(bmain, ntree, node_to, sock_to);
276         else if (event == UI_NODE_LINK_REMOVE)
277                 node_socket_remove(bmain, ntree, node_to, sock_to);
278         else
279                 node_socket_add_replace(C, ntree, node_to, sock_to, arg->type, arg->ngroup, arg->output);
280
281         ED_undo_push(C, "Node input modify");
282 }
283
284 static void ui_node_sock_name(bNodeSocket *sock, char name[UI_MAX_NAME_STR])
285 {
286         if (sock->link && sock->link->fromnode) {
287                 bNode *node = sock->link->fromnode;
288                 char node_name[UI_MAX_NAME_STR];
289
290                 if (node->type == NODE_GROUP) {
291                         if (node->id)
292                                 BLI_strncpy(node_name, node->id->name + 2, UI_MAX_NAME_STR);
293                         else
294                                 BLI_strncpy(node_name, N_(node->typeinfo->ui_name), UI_MAX_NAME_STR);
295                 }
296                 else
297                         BLI_strncpy(node_name, node->typeinfo->ui_name, UI_MAX_NAME_STR);
298
299                 if (node->inputs.first == NULL &&
300                     node->outputs.first != node->outputs.last)
301                 {
302                         BLI_snprintf(name, UI_MAX_NAME_STR, "%s | %s", IFACE_(node_name), IFACE_(sock->link->fromsock->name));
303                 }
304                 else {
305                         BLI_strncpy(name, IFACE_(node_name), UI_MAX_NAME_STR);
306                 }
307         }
308         else if (sock->type == SOCK_SHADER)
309                 BLI_strncpy(name, IFACE_("None"), UI_MAX_NAME_STR);
310         else
311                 BLI_strncpy(name, IFACE_("Default"), UI_MAX_NAME_STR);
312 }
313
314 static int ui_compatible_sockets(int typeA, int typeB)
315 {
316         return (typeA == typeB);
317 }
318
319 static void ui_node_menu_column(NodeLinkArg *arg, int nclass, const char *cname)
320 {
321         bNodeTree *ntree = arg->ntree;
322         bNodeSocket *sock = arg->sock;
323         uiLayout *layout = arg->layout;
324         uiLayout *column = NULL;
325         uiBlock *block = uiLayoutGetBlock(layout);
326         uiBut *but;
327         NodeLinkArg *argN;
328         int first = 1;
329         int compatibility = 0;
330         
331         if (ntree->type == NTREE_SHADER) {
332                 if (BKE_scene_use_new_shading_nodes(arg->scene))
333                         compatibility = NODE_NEW_SHADING;
334                 else
335                         compatibility = NODE_OLD_SHADING;
336         }
337
338         NODE_TYPES_BEGIN(ntype)
339                 bNodeSocketTemplate *stemp;
340                 char name[UI_MAX_NAME_STR];
341                 int i, j, num = 0;
342                 
343                 if (compatibility && !(ntype->compatibility & compatibility))
344                         continue;
345                 
346                 if (ntype->nclass != nclass)
347                         continue;
348                 
349                 for (i = 0, stemp = ntype->outputs; stemp && stemp->type != -1; stemp++, i++)
350                         if (ui_compatible_sockets(stemp->type, sock->type))
351                                 num++;
352                 
353                 for (i = 0, j = 0, stemp = ntype->outputs; stemp && stemp->type != -1; stemp++, i++) {
354                         if (!ui_compatible_sockets(stemp->type, sock->type))
355                                 continue;
356                         
357                         if (first) {
358                                 column = uiLayoutColumn(layout, 0);
359                                 uiBlockSetCurLayout(block, column);
360                                 
361                                 uiItemL(column, IFACE_(cname), ICON_NODE);
362                                 but = block->buttons.last;
363                                 but->flag = UI_TEXT_LEFT;
364                                 
365                                 first = 0;
366                         }
367                         
368                         if (num > 1) {
369                                 if (j == 0) {
370                                         uiItemL(column, IFACE_(ntype->ui_name), ICON_NODE);
371                                         but = block->buttons.last;
372                                         but->flag = UI_TEXT_LEFT;
373                                 }
374                                 
375                                 BLI_snprintf(name, UI_MAX_NAME_STR, "  %s", IFACE_(stemp->name));
376                                 j++;
377                         }
378                         else
379                                 BLI_strncpy(name, IFACE_(ntype->ui_name), UI_MAX_NAME_STR);
380                         
381                         but = uiDefBut(block, BUT, 0, name, 0, 0, UI_UNIT_X * 4, UI_UNIT_Y,
382                                        NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Add node to input"));
383                         
384                         argN = MEM_dupallocN(arg);
385                         argN->type = ntype->type;
386                         argN->output = i;
387                         uiButSetNFunc(but, ui_node_link, argN, NULL);
388                 }
389         NODE_TYPES_END
390 }
391
392 static void node_menu_column_foreach_cb(void *calldata, int nclass, const char *name)
393 {
394         NodeLinkArg *arg = (NodeLinkArg *)calldata;
395
396         if (!ELEM(nclass, NODE_CLASS_GROUP, NODE_CLASS_LAYOUT))
397                 ui_node_menu_column(arg, nclass, name);
398 }
399
400 static void ui_template_node_link_menu(bContext *C, uiLayout *layout, void *but_p)
401 {
402         Main *bmain = CTX_data_main(C);
403         Scene *scene = CTX_data_scene(C);
404         uiBlock *block = uiLayoutGetBlock(layout);
405         uiBut *but = (uiBut *)but_p;
406         uiLayout *split, *column;
407         NodeLinkArg *arg = (NodeLinkArg *)but->func_argN;
408         bNodeSocket *sock = arg->sock;
409         bNodeTreeType *ntreetype = arg->ntree->typeinfo;
410
411         uiBlockSetCurLayout(block, layout);
412         split = uiLayoutSplit(layout, 0.0f, FALSE);
413
414         arg->bmain = bmain;
415         arg->scene = scene;
416         arg->layout = split;
417
418         if (ntreetype && ntreetype->foreach_nodeclass)
419                 ntreetype->foreach_nodeclass(scene, arg, node_menu_column_foreach_cb);
420
421         column = uiLayoutColumn(split, FALSE);
422         uiBlockSetCurLayout(block, column);
423
424         if (sock->link) {
425                 uiItemL(column, IFACE_("Link"), ICON_NONE);
426                 but = block->buttons.last;
427                 but->flag = UI_TEXT_LEFT;
428
429                 but = uiDefBut(block, BUT, 0, IFACE_("Remove"), 0, 0, UI_UNIT_X * 4, UI_UNIT_Y,
430                                NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Remove nodes connected to the input"));
431                 uiButSetNFunc(but, ui_node_link, MEM_dupallocN(arg), SET_INT_IN_POINTER(UI_NODE_LINK_REMOVE));
432
433                 but = uiDefBut(block, BUT, 0, IFACE_("Disconnect"), 0, 0, UI_UNIT_X * 4, UI_UNIT_Y,
434                                NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Disconnect nodes connected to the input"));
435                 uiButSetNFunc(but, ui_node_link, MEM_dupallocN(arg), SET_INT_IN_POINTER(UI_NODE_LINK_DISCONNECT));
436         }
437
438         ui_node_menu_column(arg, NODE_CLASS_GROUP, N_("Group"));
439 }
440
441 void uiTemplateNodeLink(uiLayout *layout, bNodeTree *ntree, bNode *node, bNodeSocket *sock)
442 {
443         uiBlock *block = uiLayoutGetBlock(layout);
444         NodeLinkArg *arg;
445         uiBut *but;
446
447         arg = MEM_callocN(sizeof(NodeLinkArg), "NodeLinkArg");
448         arg->ntree = ntree;
449         arg->node = node;
450         arg->sock = sock;
451         arg->type = 0;
452         arg->output = 0;
453
454         uiBlockSetCurLayout(block, layout);
455
456         if (sock->link || sock->type == SOCK_SHADER || (sock->flag & SOCK_HIDE_VALUE)) {
457                 char name[UI_MAX_NAME_STR];
458                 ui_node_sock_name(sock, name);
459                 but = uiDefMenuBut(block, ui_template_node_link_menu, NULL, name, 0, 0, UI_UNIT_X * 4, UI_UNIT_Y, "");
460         }
461         else
462                 but = uiDefIconMenuBut(block, ui_template_node_link_menu, NULL, ICON_NONE, 0, 0, UI_UNIT_X, UI_UNIT_Y, "");
463
464         but->type = MENU;
465         but->flag |= UI_TEXT_LEFT | UI_BUT_NODE_LINK;
466         but->poin = (char *)but;
467         but->func_argN = arg;
468
469         if (sock->link && sock->link->fromnode)
470                 if (sock->link->fromnode->flag & NODE_ACTIVE_TEXTURE)
471                         but->flag |= UI_BUT_NODE_ACTIVE;
472 }
473
474 /**************************** Node Tree Layout *******************************/
475
476 static void ui_node_draw_input(uiLayout *layout, bContext *C,
477                                bNodeTree *ntree, bNode *node, bNodeSocket *input, int depth);
478
479 static void ui_node_draw_node(uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, int depth)
480 {
481         bNodeSocket *input;
482         uiLayout *col, *split;
483         PointerRNA nodeptr;
484
485         RNA_pointer_create(&ntree->id, &RNA_Node, node, &nodeptr);
486
487         if (node->typeinfo->uifunc) {
488                 if (node->type != NODE_GROUP) {
489                         split = uiLayoutSplit(layout, 0.35f, FALSE);
490                         col = uiLayoutColumn(split, FALSE);
491                         col = uiLayoutColumn(split, FALSE);
492
493                         node->typeinfo->uifunc(col, C, &nodeptr);
494                 }
495         }
496
497         for (input = node->inputs.first; input; input = input->next)
498                 ui_node_draw_input(layout, C, ntree, node, input, depth + 1);
499 }
500
501 static void ui_node_draw_input(uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input, int depth)
502 {
503         PointerRNA inputptr, nodeptr;
504         uiBlock *block = uiLayoutGetBlock(layout);
505         uiBut *bt;
506         uiLayout *split, *row, *col;
507         bNode *lnode;
508         char label[UI_MAX_NAME_STR];
509         int indent = (depth > 1) ? 2 * (depth - 1) : 0;
510         int dependency_loop;
511
512         if (input->flag & SOCK_UNAVAIL)
513                 return;
514
515         /* to avoid eternal loops on cyclic dependencies */
516         node->flag |= NODE_TEST;
517         lnode = (input->link) ? input->link->fromnode : NULL;
518
519         dependency_loop = (lnode && (lnode->flag & NODE_TEST));
520         if (dependency_loop)
521                 lnode = NULL;
522
523         /* socket RNA pointer */
524         RNA_pointer_create(&ntree->id, &RNA_NodeSocket, input, &inputptr);
525         RNA_pointer_create(&ntree->id, &RNA_Node, node, &nodeptr);
526
527         /* indented label */
528         memset(label, ' ', indent);
529         label[indent] = '\0';
530         BLI_snprintf(label, UI_MAX_NAME_STR, "%s%s:", label, IFACE_(input->name));
531
532         /* split in label and value */
533         split = uiLayoutSplit(layout, 0.35f, FALSE);
534
535         row = uiLayoutRow(split, TRUE);
536
537         if (depth > 0) {
538                 uiBlockSetEmboss(block, UI_EMBOSSN);
539
540                 if (lnode && (lnode->inputs.first || (lnode->typeinfo->uifunc && lnode->type != NODE_GROUP))) {
541                         int icon = (input->flag & SOCK_COLLAPSED) ? ICON_DISCLOSURE_TRI_RIGHT : ICON_DISCLOSURE_TRI_DOWN;
542                         uiItemR(row, &inputptr, "show_expanded", UI_ITEM_R_ICON_ONLY, "", icon);
543                 }
544                 else
545                         uiItemL(row, "", ICON_BLANK1);
546
547                 bt = block->buttons.last;
548                 bt->rect.xmax = UI_UNIT_X / 2;
549
550                 uiBlockSetEmboss(block, UI_EMBOSS);
551         }
552
553         uiItemL(row, label, ICON_NONE);
554         bt = block->buttons.last;
555         bt->flag = UI_TEXT_LEFT;
556
557         if (dependency_loop) {
558                 row = uiLayoutRow(split, FALSE);
559                 uiItemL(row, IFACE_("Dependency Loop"), ICON_ERROR);
560         }
561         else if (lnode) {
562                 /* input linked to a node */
563                 uiTemplateNodeLink(split, ntree, node, input);
564
565                 if (depth == 0 || !(input->flag & SOCK_COLLAPSED)) {
566                         if (depth == 0)
567                                 uiItemS(layout);
568
569                         ui_node_draw_node(layout, C, ntree, lnode, depth);
570                 }
571         }
572         else {
573                 /* input not linked, show value */
574                 if (!(input->flag & SOCK_HIDE_VALUE)) {
575                         switch (input->type) {
576                         case SOCK_FLOAT:
577                         case SOCK_INT:
578                         case SOCK_BOOLEAN:
579                         case SOCK_RGBA:
580                         case SOCK_STRING:
581                                 row = uiLayoutRow(split, TRUE);
582                                 uiItemR(row, &inputptr, "default_value", 0, "", ICON_NONE);
583                                 break;
584                         case SOCK_VECTOR:
585                                 row = uiLayoutRow(split, FALSE);
586                                 col = uiLayoutColumn(row, FALSE);
587                                 uiItemR(col, &inputptr, "default_value", 0, "", ICON_NONE);
588                                 break;
589                                 
590                         default:
591                                 row = uiLayoutRow(split, FALSE);
592                                 break;
593                         }
594                 }
595                 else
596                         row = uiLayoutRow(split, FALSE);
597
598                 uiTemplateNodeLink(row, ntree, node, input);
599         }
600
601         /* clear */
602         node->flag &= ~NODE_TEST;
603 }
604
605 void uiTemplateNodeView(uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input)
606 {
607         bNode *tnode;
608
609         if (!ntreeIsValid(ntree))
610                 return;
611
612         /* clear for cycle check */
613         for (tnode = ntree->nodes.first; tnode; tnode = tnode->next)
614                 tnode->flag &= ~NODE_TEST;
615
616         if (input)
617                 ui_node_draw_input(layout, C, ntree, node, input, 0);
618         else
619                 ui_node_draw_node(layout, C, ntree, node, 0);
620 }
621