682174ebbed57ab40d9b850c81584396034e2e9a
[blender.git] / source / blender / editors / space_node / node_relationships.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) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): David Millan Escriva, Juho Vepsäläinen, Nathan Letwory
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/space_node/node_relationships.c
29  *  \ingroup spnode
30  */
31
32 #include "MEM_guardedalloc.h"
33
34 #include "DNA_anim_types.h"
35 #include "DNA_node_types.h"
36
37 #include "BLI_math.h"
38 #include "BLI_blenlib.h"
39 #include "BLI_easing.h"
40
41 #include "BKE_animsys.h"
42 #include "BKE_context.h"
43 #include "BKE_global.h"
44 #include "BKE_library.h"
45 #include "BKE_main.h"
46 #include "BKE_node.h"
47
48 #include "ED_node.h"  /* own include */
49 #include "ED_screen.h"
50 #include "ED_render.h"
51 #include "ED_util.h"
52
53 #include "RNA_access.h"
54 #include "RNA_define.h"
55
56 #include "WM_api.h"
57 #include "WM_types.h"
58
59 #include "UI_view2d.h"
60 #include "UI_resources.h"
61
62 #include "BLT_translation.h"
63
64 #include "node_intern.h"  /* own include */
65
66 /* ****************** Relations helpers *********************** */
67
68 static bool ntree_has_drivers(bNodeTree *ntree)
69 {
70         AnimData *adt = BKE_animdata_from_id(&ntree->id);
71         if (adt == NULL) {
72                 return false;
73         }
74         return !BLI_listbase_is_empty(&adt->drivers);
75 }
76
77 static bool ntree_check_nodes_connected_dfs(bNodeTree *ntree,
78                                             bNode *from,
79                                             bNode *to)
80 {
81         if (from->flag & NODE_TEST) {
82                 return false;
83         }
84         from->flag |= NODE_TEST;
85         for (bNodeLink *link = ntree->links.first; link != NULL; link = link->next) {
86                 if (link->fromnode == from) {
87                         if (link->tonode == to) {
88                                 return true;
89                         }
90                         else {
91                                 if (ntree_check_nodes_connected_dfs(ntree, link->tonode, to)) {
92                                         return true;
93                                 }
94                         }
95                 }
96         }
97         return false;
98 }
99
100 static bool ntree_check_nodes_connected(bNodeTree *ntree, bNode *from, bNode *to)
101 {
102         if (from == to) {
103                 return true;
104         }
105         ntreeNodeFlagSet(ntree, NODE_TEST, false);
106         return ntree_check_nodes_connected_dfs(ntree, from, to);
107 }
108
109 static bool node_group_has_output_dfs(bNode *node)
110 {
111         bNodeTree *ntree = (bNodeTree *)node->id;
112         if (ntree->id.tag & LIB_TAG_DOIT) {
113                 return false;
114         }
115         ntree->id.tag |= LIB_TAG_DOIT;
116         for (bNode *current_node = ntree->nodes.first;
117              current_node != NULL;
118              current_node = current_node->next)
119         {
120                 if (current_node->type == NODE_GROUP) {
121                         if (current_node->id && node_group_has_output_dfs(current_node)) {
122                                 return true;
123                         }
124                 }
125                 if (current_node->flag & NODE_DO_OUTPUT &&
126                     current_node->type != NODE_GROUP_OUTPUT)
127                 {
128                         return true;
129                 }
130         }
131         return false;
132 }
133
134 static bool node_group_has_output(bNode *node)
135 {
136         Main *bmain = G.main;
137         BLI_assert(node->type == NODE_GROUP);
138         bNodeTree *ntree = (bNodeTree *)node->id;
139         if (ntree == NULL) {
140                 return false;
141         }
142         BKE_main_id_tag_listbase(&bmain->nodetree, LIB_TAG_DOIT, false);
143         return node_group_has_output_dfs(node);
144 }
145
146 bool node_connected_to_output(bNodeTree *ntree, bNode *node)
147 {
148         /* Special case for drivers: if node tree has any drivers we assume it is
149          * always to be tagged for update when node changes. Otherwise we will be
150          * doomed to do some deep and nasty deep search of indirect dependencies,
151          * which will be too complicated without real benefit.
152          */
153         if (ntree_has_drivers(ntree)) {
154                 return true;
155         }
156         for (bNode *current_node = ntree->nodes.first;
157              current_node != NULL;
158              current_node = current_node->next)
159         {
160                 /* Special case for group nodes -- if modified node connected to a group
161                  * with active output inside we consider refresh is needed.
162                  *
163                  * We could make check more grained here by taking which socket the node
164                  * is connected to and so eventually.
165                  */
166                 if (current_node->type == NODE_GROUP) {
167                         if (current_node->id != NULL &&
168                             ntree_has_drivers((bNodeTree *)current_node->id))
169                         {
170                                 return true;
171                         }
172                         if (ntree_check_nodes_connected(ntree, node, current_node) &&
173                             node_group_has_output(current_node))
174                         {
175                                 return true;
176                         }
177                 }
178                 if (current_node->flag & NODE_DO_OUTPUT) {
179                         if (ntree_check_nodes_connected(ntree, node, current_node)) {
180                                 return true;
181                         }
182                 }
183         }
184         return false;
185 }
186
187 /* ****************** Add *********************** */
188
189
190 typedef struct bNodeListItem {
191         struct bNodeListItem *next, *prev;
192         struct bNode *node;
193 } bNodeListItem;
194
195 typedef struct NodeInsertOfsData {
196         bNodeTree *ntree;
197         bNode *insert;        /* inserted node */
198         bNode *prev, *next;   /* prev/next node in the chain */
199         bNode *insert_parent;
200
201         wmTimer *anim_timer;
202
203         float offset_x;       /* offset to apply to node chain */
204 } NodeInsertOfsData;
205
206 static int sort_nodes_locx(const void *a, const void *b)
207 {
208         const bNodeListItem *nli1 = a;
209         const bNodeListItem *nli2 = b;
210         const bNode *node1 = nli1->node;
211         const bNode *node2 = nli2->node;
212
213         if (node1->locx > node2->locx)
214                 return 1;
215         else
216                 return 0;
217 }
218
219 static bool socket_is_available(bNodeTree *UNUSED(ntree), bNodeSocket *sock, const bool allow_used)
220 {
221         if (nodeSocketIsHidden(sock))
222                 return 0;
223
224         if (!allow_used && (sock->flag & SOCK_IN_USE))
225                 return 0;
226
227         return 1;
228 }
229
230 static bNodeSocket *best_socket_output(bNodeTree *ntree, bNode *node, bNodeSocket *sock_target, const bool allow_multiple)
231 {
232         bNodeSocket *sock;
233
234         /* first look for selected output */
235         for (sock = node->outputs.first; sock; sock = sock->next) {
236                 if (!socket_is_available(ntree, sock, allow_multiple))
237                         continue;
238
239                 if (sock->flag & SELECT)
240                         return sock;
241         }
242
243         /* try to find a socket with a matching name */
244         for (sock = node->outputs.first; sock; sock = sock->next) {
245                 if (!socket_is_available(ntree, sock, allow_multiple))
246                         continue;
247
248                 /* check for same types */
249                 if (sock->type == sock_target->type) {
250                         if (STREQ(sock->name, sock_target->name))
251                                 return sock;
252                 }
253         }
254
255         /* otherwise settle for the first available socket of the right type */
256         for (sock = node->outputs.first; sock; sock = sock->next) {
257
258                 if (!socket_is_available(ntree, sock, allow_multiple))
259                         continue;
260
261                 /* check for same types */
262                 if (sock->type == sock_target->type) {
263                         return sock;
264                 }
265         }
266
267         return NULL;
268 }
269
270 /* this is a bit complicated, but designed to prioritize finding
271  * sockets of higher types, such as image, first */
272 static bNodeSocket *best_socket_input(bNodeTree *ntree, bNode *node, int num, int replace)
273 {
274         bNodeSocket *sock;
275         int socktype, maxtype = 0;
276         int a = 0;
277
278         for (sock = node->inputs.first; sock; sock = sock->next) {
279                 maxtype = max_ii(sock->type, maxtype);
280         }
281
282         /* find sockets of higher 'types' first (i.e. image) */
283         for (socktype = maxtype; socktype >= 0; socktype--) {
284                 for (sock = node->inputs.first; sock; sock = sock->next) {
285
286                         if (!socket_is_available(ntree, sock, replace)) {
287                                 a++;
288                                 continue;
289                         }
290
291                         if (sock->type == socktype) {
292                                 /* increment to make sure we don't keep finding
293                                  * the same socket on every attempt running this function */
294                                 a++;
295                                 if (a > num)
296                                         return sock;
297                         }
298                 }
299         }
300
301         return NULL;
302 }
303
304 static bool snode_autoconnect_input(SpaceNode *snode, bNode *node_fr, bNodeSocket *sock_fr, bNode *node_to, bNodeSocket *sock_to, int replace)
305 {
306         bNodeTree *ntree = snode->edittree;
307
308         /* then we can connect */
309         if (replace)
310                 nodeRemSocketLinks(ntree, sock_to);
311
312         nodeAddLink(ntree, node_fr, sock_fr, node_to, sock_to);
313         return true;
314 }
315
316 static void snode_autoconnect(SpaceNode *snode, const bool allow_multiple, const bool replace)
317 {
318         bNodeTree *ntree = snode->edittree;
319         ListBase *nodelist = MEM_callocN(sizeof(ListBase), "items_list");
320         bNodeListItem *nli;
321         bNode *node;
322         int i, numlinks = 0;
323
324         for (node = ntree->nodes.first; node; node = node->next) {
325                 if (node->flag & NODE_SELECT) {
326                         nli = MEM_mallocN(sizeof(bNodeListItem), "temporary node list item");
327                         nli->node = node;
328                         BLI_addtail(nodelist, nli);
329                 }
330         }
331
332         /* sort nodes left to right */
333         BLI_listbase_sort(nodelist, sort_nodes_locx);
334
335         for (nli = nodelist->first; nli; nli = nli->next) {
336                 bNode *node_fr, *node_to;
337                 bNodeSocket *sock_fr, *sock_to;
338                 bool has_selected_inputs = false;
339
340                 if (nli->next == NULL) break;
341
342                 node_fr = nli->node;
343                 node_to = nli->next->node;
344                 /* corner case: input/output node aligned the wrong way around (T47729) */
345                 if (BLI_listbase_is_empty(&node_to->inputs) || BLI_listbase_is_empty(&node_fr->outputs)) {
346                         SWAP(bNode *, node_fr, node_to);
347                 }
348
349                 /* if there are selected sockets, connect those */
350                 for (sock_to = node_to->inputs.first; sock_to; sock_to = sock_to->next) {
351                         if (sock_to->flag & SELECT) {
352                                 has_selected_inputs = 1;
353
354                                 if (!socket_is_available(ntree, sock_to, replace))
355                                         continue;
356
357                                 /* check for an appropriate output socket to connect from */
358                                 sock_fr = best_socket_output(ntree, node_fr, sock_to, allow_multiple);
359                                 if (!sock_fr)
360                                         continue;
361
362                                 if (snode_autoconnect_input(snode, node_fr, sock_fr, node_to, sock_to, replace)) {
363                                         numlinks++;
364                                 }
365                         }
366                 }
367
368                 if (!has_selected_inputs) {
369                         /* no selected inputs, connect by finding suitable match */
370                         int num_inputs = BLI_listbase_count(&node_to->inputs);
371
372                         for (i = 0; i < num_inputs; i++) {
373
374                                 /* find the best guess input socket */
375                                 sock_to = best_socket_input(ntree, node_to, i, replace);
376                                 if (!sock_to)
377                                         continue;
378
379                                 /* check for an appropriate output socket to connect from */
380                                 sock_fr = best_socket_output(ntree, node_fr, sock_to, allow_multiple);
381                                 if (!sock_fr)
382                                         continue;
383
384                                 if (snode_autoconnect_input(snode, node_fr, sock_fr, node_to, sock_to, replace)) {
385                                         numlinks++;
386                                         break;
387                                 }
388                         }
389                 }
390         }
391
392         if (numlinks > 0) {
393                 ntreeUpdateTree(G.main, ntree);
394         }
395
396         BLI_freelistN(nodelist);
397         MEM_freeN(nodelist);
398 }
399
400 /* *************************** link viewer op ******************** */
401
402 static int node_link_viewer(const bContext *C, bNode *tonode)
403 {
404         SpaceNode *snode = CTX_wm_space_node(C);
405         bNode *node;
406         bNodeLink *link;
407         bNodeSocket *sock;
408
409         /* context check */
410         if (tonode == NULL || BLI_listbase_is_empty(&tonode->outputs))
411                 return OPERATOR_CANCELLED;
412         if (ELEM(tonode->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER))
413                 return OPERATOR_CANCELLED;
414
415         /* get viewer */
416         for (node = snode->edittree->nodes.first; node; node = node->next)
417                 if (ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER))
418                         if (node->flag & NODE_DO_OUTPUT)
419                                 break;
420         /* no viewer, we make one active */
421         if (node == NULL) {
422                 for (node = snode->edittree->nodes.first; node; node = node->next) {
423                         if (ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)) {
424                                 node->flag |= NODE_DO_OUTPUT;
425                                 break;
426                         }
427                 }
428         }
429
430         sock = NULL;
431
432         /* try to find an already connected socket to cycle to the next */
433         if (node) {
434                 link = NULL;
435                 for (link = snode->edittree->links.first; link; link = link->next)
436                         if (link->tonode == node && link->fromnode == tonode)
437                                 if (link->tosock == node->inputs.first)
438                                         break;
439                 if (link) {
440                         /* unlink existing connection */
441                         sock = link->fromsock;
442                         nodeRemLink(snode->edittree, link);
443
444                         /* find a socket after the previously connected socket */
445                         for (sock = sock->next; sock; sock = sock->next)
446                                 if (!nodeSocketIsHidden(sock))
447                                         break;
448                 }
449         }
450
451         /* find a socket starting from the first socket */
452         if (!sock) {
453                 for (sock = tonode->outputs.first; sock; sock = sock->next)
454                         if (!nodeSocketIsHidden(sock))
455                                 break;
456         }
457
458         if (sock) {
459                 /* add a new viewer if none exists yet */
460                 if (!node) {
461                         /* XXX location is a quick hack, just place it next to the linked socket */
462                         node = node_add_node(C, NULL, CMP_NODE_VIEWER, sock->locx + 100, sock->locy);
463                         if (!node)
464                                 return OPERATOR_CANCELLED;
465
466                         link = NULL;
467                 }
468                 else {
469                         /* get link to viewer */
470                         for (link = snode->edittree->links.first; link; link = link->next)
471                                 if (link->tonode == node && link->tosock == node->inputs.first)
472                                         break;
473                 }
474
475                 if (link == NULL) {
476                         nodeAddLink(snode->edittree, tonode, sock, node, node->inputs.first);
477                 }
478                 else {
479                         link->fromnode = tonode;
480                         link->fromsock = sock;
481                         /* make sure the dependency sorting is updated */
482                         snode->edittree->update |= NTREE_UPDATE_LINKS;
483                 }
484                 ntreeUpdateTree(CTX_data_main(C), snode->edittree);
485                 snode_update(snode, node);
486         }
487
488         return OPERATOR_FINISHED;
489 }
490
491
492 static int node_active_link_viewer_exec(bContext *C, wmOperator *UNUSED(op))
493 {
494         SpaceNode *snode = CTX_wm_space_node(C);
495         bNode *node;
496
497         node = nodeGetActive(snode->edittree);
498
499         if (!node)
500                 return OPERATOR_CANCELLED;
501
502         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
503
504         if (node_link_viewer(C, node) == OPERATOR_CANCELLED)
505                 return OPERATOR_CANCELLED;
506
507         snode_notify(C, snode);
508
509         return OPERATOR_FINISHED;
510 }
511
512
513 void NODE_OT_link_viewer(wmOperatorType *ot)
514 {
515         /* identifiers */
516         ot->name = "Link to Viewer Node";
517         ot->description = "Link to viewer node";
518         ot->idname = "NODE_OT_link_viewer";
519
520         /* api callbacks */
521         ot->exec = node_active_link_viewer_exec;
522         ot->poll = composite_node_editable;
523
524         /* flags */
525         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
526 }
527
528
529 /* *************************** add link op ******************** */
530
531 static void node_link_update_header(bContext *C, bNodeLinkDrag *UNUSED(nldrag))
532 {
533         char header[UI_MAX_DRAW_STR];
534
535         BLI_strncpy(header, IFACE_("LMB: drag node link, RMB: cancel"), sizeof(header));
536         ED_area_headerprint(CTX_wm_area(C), header);
537 }
538
539 static int node_count_links(bNodeTree *ntree, bNodeSocket *sock)
540 {
541         bNodeLink *link;
542         int count = 0;
543         for (link = ntree->links.first; link; link = link->next) {
544                 if (link->fromsock == sock)
545                         ++count;
546                 if (link->tosock == sock)
547                         ++count;
548         }
549         return count;
550 }
551
552 static void node_remove_extra_links(SpaceNode *snode, bNodeLink *link)
553 {
554         bNodeTree *ntree = snode->edittree;
555         bNodeSocket *from = link->fromsock, *to = link->tosock;
556         bNodeLink *tlink, *tlink_next;
557         int to_count = node_count_links(ntree, to);
558         int from_count = node_count_links(ntree, from);
559
560         for (tlink = ntree->links.first; tlink; tlink = tlink_next) {
561                 tlink_next = tlink->next;
562                 if (tlink == link)
563                         continue;
564
565                 if (tlink && tlink->fromsock == from) {
566                         if (from_count > from->limit) {
567                                 nodeRemLink(ntree, tlink);
568                                 tlink = NULL;
569                                 --from_count;
570                         }
571                 }
572
573                 if (tlink && tlink->tosock == to) {
574                         if (to_count > to->limit) {
575                                 nodeRemLink(ntree, tlink);
576                                 tlink = NULL;
577                                 --to_count;
578                         }
579                 }
580         }
581 }
582
583 static void node_link_exit(bContext *C, wmOperator *op, bool apply_links)
584 {
585         SpaceNode *snode = CTX_wm_space_node(C);
586         bNodeTree *ntree = snode->edittree;
587         bNodeLinkDrag *nldrag = op->customdata;
588         LinkData *linkdata;
589         bool do_tag_update = false;
590
591         /* avoid updates while applying links */
592         ntree->is_updating = true;
593         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
594                 bNodeLink *link = linkdata->data;
595
596                 /* See note below, but basically TEST flag means that the link
597                  * was connected to output (or to a node which affects the
598                  * output).
599                  */
600                 do_tag_update |= (link->flag & NODE_LINK_TEST) != 0;
601
602                 if (apply_links && link->tosock && link->fromsock) {
603                         /* before actually adding the link,
604                          * let nodes perform special link insertion handling
605                          */
606                         if (link->fromnode->typeinfo->insert_link)
607                                 link->fromnode->typeinfo->insert_link(ntree, link->fromnode, link);
608                         if (link->tonode->typeinfo->insert_link)
609                                 link->tonode->typeinfo->insert_link(ntree, link->tonode, link);
610
611                         /* add link to the node tree */
612                         BLI_addtail(&ntree->links, link);
613
614                         ntree->update |= NTREE_UPDATE_LINKS;
615
616                         /* tag tonode for update */
617                         link->tonode->update |= NODE_UPDATE;
618
619                         /* we might need to remove a link */
620                         node_remove_extra_links(snode, link);
621
622                         if (link->tonode) {
623                                 do_tag_update |= (do_tag_update || node_connected_to_output(ntree, link->tonode));
624                         }
625                 }
626                 else {
627                         nodeRemLink(ntree, link);
628                 }
629         }
630         ntree->is_updating = false;
631
632         ntreeUpdateTree(CTX_data_main(C), ntree);
633         snode_notify(C, snode);
634         if (do_tag_update) {
635                 snode_dag_update(C, snode);
636         }
637
638         BLI_remlink(&snode->linkdrag, nldrag);
639         /* links->data pointers are either held by the tree or freed already */
640         BLI_freelistN(&nldrag->links);
641         MEM_freeN(nldrag);
642 }
643
644 static void node_link_find_socket(bContext *C, wmOperator *op, float cursor[2])
645 {
646         SpaceNode *snode = CTX_wm_space_node(C);
647         bNodeLinkDrag *nldrag = op->customdata;
648         bNode *tnode;
649         bNodeSocket *tsock = NULL;
650         LinkData *linkdata;
651
652         if (nldrag->in_out == SOCK_OUT) {
653                 if (node_find_indicated_socket(snode, &tnode, &tsock, cursor, SOCK_IN)) {
654                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
655                                 bNodeLink *link = linkdata->data;
656
657                                 /* skip if this is already the target socket */
658                                 if (link->tosock == tsock)
659                                         continue;
660                                 /* skip if socket is on the same node as the fromsock */
661                                 if (tnode && link->fromnode == tnode)
662                                         continue;
663
664                                 /* attach links to the socket */
665                                 link->tonode = tnode;
666                                 link->tosock = tsock;
667                         }
668                 }
669                 else {
670                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
671                                 bNodeLink *link = linkdata->data;
672
673                                 link->tonode = NULL;
674                                 link->tosock = NULL;
675                         }
676                 }
677         }
678         else {
679                 if (node_find_indicated_socket(snode, &tnode, &tsock, cursor, SOCK_OUT)) {
680                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
681                                 bNodeLink *link = linkdata->data;
682
683                                 /* skip if this is already the target socket */
684                                 if (link->fromsock == tsock)
685                                         continue;
686                                 /* skip if socket is on the same node as the fromsock */
687                                 if (tnode && link->tonode == tnode)
688                                         continue;
689
690                                 /* attach links to the socket */
691                                 link->fromnode = tnode;
692                                 link->fromsock = tsock;
693                         }
694                 }
695                 else {
696                         for (linkdata = nldrag->links.first; linkdata; linkdata = linkdata->next) {
697                                 bNodeLink *link = linkdata->data;
698
699                                 link->fromnode = NULL;
700                                 link->fromsock = NULL;
701                         }
702                 }
703         }
704 }
705
706 /* loop that adds a nodelink, called by function below  */
707 /* in_out = starting socket */
708 static int node_link_modal(bContext *C, wmOperator *op, const wmEvent *event)
709 {
710         bNodeLinkDrag *nldrag = op->customdata;
711         ARegion *ar = CTX_wm_region(C);
712         float cursor[2];
713
714         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1],
715                                  &cursor[0], &cursor[1]);
716
717         switch (event->type) {
718                 case MOUSEMOVE:
719                         node_link_find_socket(C, op, cursor);
720
721                         node_link_update_header(C, nldrag);
722                         ED_region_tag_redraw(ar);
723                         break;
724
725                 case LEFTMOUSE:
726                 case RIGHTMOUSE:
727                 case MIDDLEMOUSE:
728                 {
729                         if (event->val == KM_RELEASE) {
730                                 node_link_exit(C, op, true);
731
732                                 ED_area_headerprint(CTX_wm_area(C), NULL);
733                                 ED_region_tag_redraw(ar);
734                                 return OPERATOR_FINISHED;
735                         }
736                         break;
737                 }
738         }
739
740         return OPERATOR_RUNNING_MODAL;
741 }
742
743 /* return 1 when socket clicked */
744 static bNodeLinkDrag *node_link_init(SpaceNode *snode, float cursor[2], bool detach)
745 {
746         bNode *node;
747         bNodeSocket *sock;
748         bNodeLink *link, *link_next, *oplink;
749         bNodeLinkDrag *nldrag = NULL;
750         LinkData *linkdata;
751         int num_links;
752
753         /* output indicated? */
754         if (node_find_indicated_socket(snode, &node, &sock, cursor, SOCK_OUT)) {
755                 nldrag = MEM_callocN(sizeof(bNodeLinkDrag), "drag link op customdata");
756
757                 num_links = nodeCountSocketLinks(snode->edittree, sock);
758                 if (num_links > 0 && (num_links >= sock->limit || detach)) {
759                         /* dragged links are fixed on input side */
760                         nldrag->in_out = SOCK_IN;
761                         /* detach current links and store them in the operator data */
762                         for (link = snode->edittree->links.first; link; link = link_next) {
763                                 link_next = link->next;
764                                 if (link->fromsock == sock) {
765                                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
766                                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
767                                         *oplink = *link;
768                                         oplink->next = oplink->prev = NULL;
769                                         oplink->flag |= NODE_LINK_VALID;
770
771                                         /* The link could be disconnected and in that case we
772                                          * wouldn't be able to check whether tag update is
773                                          * needed or not when releasing mouse button. So we
774                                          * cache whether the link affects output or not here
775                                          * using TEST flag.
776                                          */
777                                         oplink->flag &= ~NODE_LINK_TEST;
778                                         if (node_connected_to_output(snode->edittree, link->tonode)) {
779                                                 oplink->flag |= NODE_LINK_TEST;
780                                         }
781
782                                         BLI_addtail(&nldrag->links, linkdata);
783                                         nodeRemLink(snode->edittree, link);
784                                 }
785                         }
786                 }
787                 else {
788                         /* dragged links are fixed on output side */
789                         nldrag->in_out = SOCK_OUT;
790                         /* create a new link */
791                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
792                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
793                         oplink->fromnode = node;
794                         oplink->fromsock = sock;
795                         oplink->flag |= NODE_LINK_VALID;
796                         oplink->flag &= ~NODE_LINK_TEST;
797                         if (node_connected_to_output(snode->edittree, node)) {
798                                 oplink->flag |= NODE_LINK_TEST;
799                         }
800
801                         BLI_addtail(&nldrag->links, linkdata);
802                 }
803         }
804         /* or an input? */
805         else if (node_find_indicated_socket(snode, &node, &sock, cursor, SOCK_IN)) {
806                 nldrag = MEM_callocN(sizeof(bNodeLinkDrag), "drag link op customdata");
807
808                 num_links = nodeCountSocketLinks(snode->edittree, sock);
809                 if (num_links > 0 && (num_links >= sock->limit || detach)) {
810                         /* dragged links are fixed on output side */
811                         nldrag->in_out = SOCK_OUT;
812                         /* detach current links and store them in the operator data */
813                         for (link = snode->edittree->links.first; link; link = link_next) {
814                                 link_next = link->next;
815                                 if (link->tosock == sock) {
816                                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
817                                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
818                                         *oplink = *link;
819                                         oplink->next = oplink->prev = NULL;
820                                         oplink->flag |= NODE_LINK_VALID;
821                                         oplink->flag &= ~NODE_LINK_TEST;
822                                         if (node_connected_to_output(snode->edittree, link->tonode)) {
823                                                 oplink->flag |= NODE_LINK_TEST;
824                                         }
825
826                                         BLI_addtail(&nldrag->links, linkdata);
827                                         nodeRemLink(snode->edittree, link);
828
829                                         /* send changed event to original link->tonode */
830                                         if (node)
831                                                 snode_update(snode, node);
832                                 }
833                         }
834                 }
835                 else {
836                         /* dragged links are fixed on input side */
837                         nldrag->in_out = SOCK_IN;
838                         /* create a new link */
839                         linkdata = MEM_callocN(sizeof(LinkData), "drag link op link data");
840                         linkdata->data = oplink = MEM_callocN(sizeof(bNodeLink), "drag link op link");
841                         oplink->tonode = node;
842                         oplink->tosock = sock;
843                         oplink->flag |= NODE_LINK_VALID;
844                         oplink->flag &= ~NODE_LINK_TEST;
845                         if (node_connected_to_output(snode->edittree, node)) {
846                                 oplink->flag |= NODE_LINK_TEST;
847                         }
848
849                         BLI_addtail(&nldrag->links, linkdata);
850                 }
851         }
852
853         return nldrag;
854 }
855
856 static int node_link_invoke(bContext *C, wmOperator *op, const wmEvent *event)
857 {
858         SpaceNode *snode = CTX_wm_space_node(C);
859         ARegion *ar = CTX_wm_region(C);
860         bNodeLinkDrag *nldrag;
861         float cursor[2];
862
863         bool detach = RNA_boolean_get(op->ptr, "detach");
864
865         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1],
866                                  &cursor[0], &cursor[1]);
867
868         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
869
870         nldrag = node_link_init(snode, cursor, detach);
871
872         if (nldrag) {
873                 op->customdata = nldrag;
874                 BLI_addtail(&snode->linkdrag, nldrag);
875
876                 /* add modal handler */
877                 WM_event_add_modal_handler(C, op);
878
879                 return OPERATOR_RUNNING_MODAL;
880         }
881         else
882                 return OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH;
883 }
884
885 static void node_link_cancel(bContext *C, wmOperator *op)
886 {
887         SpaceNode *snode = CTX_wm_space_node(C);
888         bNodeLinkDrag *nldrag = op->customdata;
889
890         BLI_remlink(&snode->linkdrag, nldrag);
891
892         BLI_freelistN(&nldrag->links);
893         MEM_freeN(nldrag);
894 }
895
896 void NODE_OT_link(wmOperatorType *ot)
897 {
898         /* identifiers */
899         ot->name = "Link Nodes";
900         ot->idname = "NODE_OT_link";
901         ot->description = "Use the mouse to create a link between two nodes";
902
903         /* api callbacks */
904         ot->invoke = node_link_invoke;
905         ot->modal = node_link_modal;
906 //      ot->exec = node_link_exec;
907         ot->poll = ED_operator_node_editable;
908         ot->cancel = node_link_cancel;
909
910         /* flags */
911         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
912
913         RNA_def_boolean(ot->srna, "detach", false, "Detach", "Detach and redirect existing links");
914 }
915
916 /* ********************** Make Link operator ***************** */
917
918 /* makes a link between selected output and input sockets */
919 static int node_make_link_exec(bContext *C, wmOperator *op)
920 {
921         SpaceNode *snode = CTX_wm_space_node(C);
922         const bool replace = RNA_boolean_get(op->ptr, "replace");
923
924         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
925
926         snode_autoconnect(snode, 1, replace);
927
928         /* deselect sockets after linking */
929         node_deselect_all_input_sockets(snode, 0);
930         node_deselect_all_output_sockets(snode, 0);
931
932         ntreeUpdateTree(CTX_data_main(C), snode->edittree);
933         snode_notify(C, snode);
934         snode_dag_update(C, snode);
935
936         return OPERATOR_FINISHED;
937 }
938
939 void NODE_OT_link_make(wmOperatorType *ot)
940 {
941         /* identifiers */
942         ot->name = "Make Links";
943         ot->description = "Makes a link between selected output in input sockets";
944         ot->idname = "NODE_OT_link_make";
945
946         /* callbacks */
947         ot->exec = node_make_link_exec;
948         ot->poll = ED_operator_node_editable; // XXX we need a special poll which checks that there are selected input/output sockets
949
950         /* flags */
951         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
952
953         RNA_def_boolean(ot->srna, "replace", 0, "Replace", "Replace socket connections with the new links");
954 }
955
956 /* ********************** Cut Link operator ***************** */
957 static bool cut_links_intersect(bNodeLink *link, float mcoords[][2], int tot)
958 {
959         float coord_array[NODE_LINK_RESOL + 1][2];
960         int i, b;
961
962         if (node_link_bezier_points(NULL, NULL, link, coord_array, NODE_LINK_RESOL)) {
963
964                 for (i = 0; i < tot - 1; i++)
965                         for (b = 0; b < NODE_LINK_RESOL; b++)
966                                 if (isect_seg_seg_v2(mcoords[i], mcoords[i + 1], coord_array[b], coord_array[b + 1]) > 0)
967                                         return 1;
968         }
969         return 0;
970 }
971
972 static int cut_links_exec(bContext *C, wmOperator *op)
973 {
974         SpaceNode *snode = CTX_wm_space_node(C);
975         ARegion *ar = CTX_wm_region(C);
976         float mcoords[256][2];
977         int i = 0;
978         bool do_tag_update = false;
979
980         RNA_BEGIN (op->ptr, itemptr, "path")
981         {
982                 float loc[2];
983
984                 RNA_float_get_array(&itemptr, "loc", loc);
985                 UI_view2d_region_to_view(&ar->v2d, (int)loc[0], (int)loc[1],
986                                          &mcoords[i][0], &mcoords[i][1]);
987                 i++;
988                 if (i >= 256) break;
989         }
990         RNA_END;
991
992         if (i > 1) {
993                 bool found = false;
994                 bNodeLink *link, *next;
995
996                 ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
997
998                 for (link = snode->edittree->links.first; link; link = next) {
999                         next = link->next;
1000                         if (nodeLinkIsHidden(link))
1001                                 continue;
1002
1003                         if (cut_links_intersect(link, mcoords, i)) {
1004
1005                                 if (found == false) {
1006                                         /* TODO(sergey): Why did we kill jobs twice? */
1007                                         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
1008                                         found = true;
1009                                 }
1010
1011                                 do_tag_update |= (do_tag_update || node_connected_to_output(snode->edittree, link->tonode));
1012
1013                                 snode_update(snode, link->tonode);
1014                                 nodeRemLink(snode->edittree, link);
1015                         }
1016                 }
1017
1018                 if (found) {
1019                         ntreeUpdateTree(CTX_data_main(C), snode->edittree);
1020                         snode_notify(C, snode);
1021                         if (do_tag_update) {
1022                                 snode_dag_update(C, snode);
1023                         }
1024
1025                         return OPERATOR_FINISHED;
1026                 }
1027                 else {
1028                         return OPERATOR_CANCELLED;
1029                 }
1030
1031         }
1032
1033         return OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH;
1034 }
1035
1036 void NODE_OT_links_cut(wmOperatorType *ot)
1037 {
1038         ot->name = "Cut Links";
1039         ot->idname = "NODE_OT_links_cut";
1040         ot->description = "Use the mouse to cut (remove) some links";
1041
1042         ot->invoke = WM_gesture_lines_invoke;
1043         ot->modal = WM_gesture_lines_modal;
1044         ot->exec = cut_links_exec;
1045         ot->cancel = WM_gesture_lines_cancel;
1046
1047         ot->poll = ED_operator_node_editable;
1048
1049         /* flags */
1050         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1051
1052         /* properties */
1053         PropertyRNA *prop;
1054         prop = RNA_def_collection_runtime(ot->srna, "path", &RNA_OperatorMousePath, "Path", "");
1055         RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
1056
1057         /* internal */
1058         RNA_def_int(ot->srna, "cursor", BC_KNIFECURSOR, 0, INT_MAX, "Cursor", "", 0, INT_MAX);
1059 }
1060
1061 /* ********************** Detach links operator ***************** */
1062
1063 static int detach_links_exec(bContext *C, wmOperator *UNUSED(op))
1064 {
1065         SpaceNode *snode = CTX_wm_space_node(C);
1066         bNodeTree *ntree = snode->edittree;
1067         bNode *node;
1068
1069         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
1070
1071         for (node = ntree->nodes.first; node; node = node->next) {
1072                 if (node->flag & SELECT) {
1073                         nodeInternalRelink(ntree, node);
1074                 }
1075         }
1076
1077         ntreeUpdateTree(CTX_data_main(C), ntree);
1078
1079         snode_notify(C, snode);
1080         snode_dag_update(C, snode);
1081
1082         return OPERATOR_FINISHED;
1083 }
1084
1085 void NODE_OT_links_detach(wmOperatorType *ot)
1086 {
1087         ot->name = "Detach Links";
1088         ot->idname = "NODE_OT_links_detach";
1089         ot->description = "Remove all links to selected nodes, and try to connect neighbor nodes together";
1090
1091         ot->exec = detach_links_exec;
1092         ot->poll = ED_operator_node_editable;
1093
1094         /* flags */
1095         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1096 }
1097
1098
1099 /* ****************** Set Parent ******************* */
1100
1101 static int node_parent_set_exec(bContext *C, wmOperator *UNUSED(op))
1102 {
1103         SpaceNode *snode = CTX_wm_space_node(C);
1104         bNodeTree *ntree = snode->edittree;
1105         bNode *frame = nodeGetActive(ntree), *node;
1106         if (!frame || frame->type != NODE_FRAME)
1107                 return OPERATOR_CANCELLED;
1108
1109         for (node = ntree->nodes.first; node; node = node->next) {
1110                 if (node == frame)
1111                         continue;
1112                 if (node->flag & NODE_SELECT) {
1113                         nodeDetachNode(node);
1114                         nodeAttachNode(node, frame);
1115                 }
1116         }
1117
1118         ED_node_sort(ntree);
1119         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1120
1121         return OPERATOR_FINISHED;
1122 }
1123
1124 void NODE_OT_parent_set(wmOperatorType *ot)
1125 {
1126         /* identifiers */
1127         ot->name = "Make Parent";
1128         ot->description = "Attach selected nodes";
1129         ot->idname = "NODE_OT_parent_set";
1130
1131         /* api callbacks */
1132         ot->exec = node_parent_set_exec;
1133         ot->poll = ED_operator_node_editable;
1134
1135         /* flags */
1136         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1137 }
1138
1139 /* ****************** Join Nodes ******************* */
1140
1141 /* tags for depth-first search */
1142 #define NODE_JOIN_DONE          1
1143 #define NODE_JOIN_IS_DESCENDANT 2
1144
1145 static void node_join_attach_recursive(bNode *node, bNode *frame)
1146 {
1147         node->done |= NODE_JOIN_DONE;
1148
1149         if (node == frame) {
1150                 node->done |= NODE_JOIN_IS_DESCENDANT;
1151         }
1152         else if (node->parent) {
1153                 /* call recursively */
1154                 if (!(node->parent->done & NODE_JOIN_DONE))
1155                         node_join_attach_recursive(node->parent, frame);
1156
1157                 /* in any case: if the parent is a descendant, so is the child */
1158                 if (node->parent->done & NODE_JOIN_IS_DESCENDANT)
1159                         node->done |= NODE_JOIN_IS_DESCENDANT;
1160                 else if (node->flag & NODE_TEST) {
1161                         /* if parent is not an decendant of the frame, reattach the node */
1162                         nodeDetachNode(node);
1163                         nodeAttachNode(node, frame);
1164                         node->done |= NODE_JOIN_IS_DESCENDANT;
1165                 }
1166         }
1167         else if (node->flag & NODE_TEST) {
1168                 nodeAttachNode(node, frame);
1169                 node->done |= NODE_JOIN_IS_DESCENDANT;
1170         }
1171 }
1172
1173 static int node_join_exec(bContext *C, wmOperator *UNUSED(op))
1174 {
1175         SpaceNode *snode = CTX_wm_space_node(C);
1176         bNodeTree *ntree = snode->edittree;
1177         bNode *node, *frame;
1178
1179         /* XXX save selection: node_add_node call below sets the new frame as single active+selected node */
1180         for (node = ntree->nodes.first; node; node = node->next) {
1181                 if (node->flag & NODE_SELECT)
1182                         node->flag |= NODE_TEST;
1183                 else
1184                         node->flag &= ~NODE_TEST;
1185         }
1186
1187         frame = node_add_node(C, NULL, NODE_FRAME, 0.0f, 0.0f);
1188
1189         /* reset tags */
1190         for (node = ntree->nodes.first; node; node = node->next)
1191                 node->done = 0;
1192
1193         for (node = ntree->nodes.first; node; node = node->next) {
1194                 if (!(node->done & NODE_JOIN_DONE))
1195                         node_join_attach_recursive(node, frame);
1196         }
1197
1198         /* restore selection */
1199         for (node = ntree->nodes.first; node; node = node->next) {
1200                 if (node->flag & NODE_TEST)
1201                         node->flag |= NODE_SELECT;
1202         }
1203
1204         ED_node_sort(ntree);
1205         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1206
1207         return OPERATOR_FINISHED;
1208 }
1209
1210 void NODE_OT_join(wmOperatorType *ot)
1211 {
1212         /* identifiers */
1213         ot->name = "Join Nodes";
1214         ot->description = "Attach selected nodes to a new common frame";
1215         ot->idname = "NODE_OT_join";
1216
1217         /* api callbacks */
1218         ot->exec = node_join_exec;
1219         ot->poll = ED_operator_node_editable;
1220
1221         /* flags */
1222         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1223 }
1224
1225 /* ****************** Attach ******************* */
1226
1227 static bNode *node_find_frame_to_attach(ARegion *ar, const bNodeTree *ntree, const int mouse_xy[2])
1228 {
1229         bNode *frame;
1230         float cursor[2];
1231
1232         /* convert mouse coordinates to v2d space */
1233         UI_view2d_region_to_view(&ar->v2d, UNPACK2(mouse_xy), &cursor[0], &cursor[1]);
1234
1235         /* check nodes front to back */
1236         for (frame = ntree->nodes.last; frame; frame = frame->prev) {
1237                 /* skip selected, those are the nodes we want to attach */
1238                 if ((frame->type != NODE_FRAME) || (frame->flag & NODE_SELECT))
1239                         continue;
1240                 if (BLI_rctf_isect_pt_v(&frame->totr, cursor))
1241                         return frame;
1242         }
1243
1244         return NULL;
1245 }
1246
1247 static int node_attach_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
1248 {
1249         ARegion *ar = CTX_wm_region(C);
1250         SpaceNode *snode = CTX_wm_space_node(C);
1251         bNodeTree *ntree = snode->edittree;
1252         bNode *frame = node_find_frame_to_attach(ar, ntree, event->mval);
1253
1254         if (frame) {
1255                 bNode *node, *parent;
1256                 for (node = ntree->nodes.last; node; node = node->prev) {
1257                         if (node->flag & NODE_SELECT) {
1258                                 if (node->parent == NULL) {
1259                                         /* disallow moving a parent into its child */
1260                                         if (nodeAttachNodeCheck(frame, node) == false) {
1261                                                 /* attach all unparented nodes */
1262                                                 nodeAttachNode(node, frame);
1263                                         }
1264                                 }
1265                                 else {
1266                                         /* attach nodes which share parent with the frame */
1267                                         for (parent = frame->parent; parent; parent = parent->parent) {
1268                                                 if (parent == node->parent) {
1269                                                         break;
1270                                                 }
1271                                         }
1272
1273                                         if (parent) {
1274                                                 /* disallow moving a parent into its child */
1275                                                 if (nodeAttachNodeCheck(frame, node) == false) {
1276                                                         nodeDetachNode(node);
1277                                                         nodeAttachNode(node, frame);
1278                                                 }
1279                                         }
1280                                 }
1281                         }
1282                 }
1283         }
1284
1285         ED_node_sort(ntree);
1286         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1287
1288         return OPERATOR_FINISHED;
1289 }
1290
1291
1292 void NODE_OT_attach(wmOperatorType *ot)
1293 {
1294         /* identifiers */
1295         ot->name = "Attach Nodes";
1296         ot->description = "Attach active node to a frame";
1297         ot->idname = "NODE_OT_attach";
1298
1299         /* api callbacks */
1300
1301         ot->invoke = node_attach_invoke;
1302         ot->poll = ED_operator_node_editable;
1303
1304         /* flags */
1305         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1306 }
1307
1308 /* ****************** Detach ******************* */
1309
1310 /* tags for depth-first search */
1311 #define NODE_DETACH_DONE            1
1312 #define NODE_DETACH_IS_DESCENDANT   2
1313
1314 static void node_detach_recursive(bNode *node)
1315 {
1316         node->done |= NODE_DETACH_DONE;
1317
1318         if (node->parent) {
1319                 /* call recursively */
1320                 if (!(node->parent->done & NODE_DETACH_DONE))
1321                         node_detach_recursive(node->parent);
1322
1323                 /* in any case: if the parent is a descendant, so is the child */
1324                 if (node->parent->done & NODE_DETACH_IS_DESCENDANT)
1325                         node->done |= NODE_DETACH_IS_DESCENDANT;
1326                 else if (node->flag & NODE_SELECT) {
1327                         /* if parent is not a decendant of a selected node, detach */
1328                         nodeDetachNode(node);
1329                         node->done |= NODE_DETACH_IS_DESCENDANT;
1330                 }
1331         }
1332         else if (node->flag & NODE_SELECT) {
1333                 node->done |= NODE_DETACH_IS_DESCENDANT;
1334         }
1335 }
1336
1337
1338 /* detach the root nodes in the current selection */
1339 static int node_detach_exec(bContext *C, wmOperator *UNUSED(op))
1340 {
1341         SpaceNode *snode = CTX_wm_space_node(C);
1342         bNodeTree *ntree = snode->edittree;
1343         bNode *node;
1344
1345         /* reset tags */
1346         for (node = ntree->nodes.first; node; node = node->next)
1347                 node->done = 0;
1348         /* detach nodes recursively
1349          * relative order is preserved here!
1350          */
1351         for (node = ntree->nodes.first; node; node = node->next) {
1352                 if (!(node->done & NODE_DETACH_DONE))
1353                         node_detach_recursive(node);
1354         }
1355
1356         ED_node_sort(ntree);
1357         WM_event_add_notifier(C, NC_NODE | ND_DISPLAY, NULL);
1358
1359         return OPERATOR_FINISHED;
1360 }
1361
1362 void NODE_OT_detach(wmOperatorType *ot)
1363 {
1364         /* identifiers */
1365         ot->name = "Detach Nodes";
1366         ot->description = "Detach selected nodes from parents";
1367         ot->idname = "NODE_OT_detach";
1368
1369         /* api callbacks */
1370         ot->exec = node_detach_exec;
1371         ot->poll = ED_operator_node_editable;
1372
1373         /* flags */
1374         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1375 }
1376
1377 /* *********************  automatic node insert on dragging ******************* */
1378
1379
1380 /* prevent duplicate testing code below */
1381 static bool ed_node_link_conditions(ScrArea *sa, bool test, SpaceNode **r_snode, bNode **r_select)
1382 {
1383         SpaceNode *snode = sa ? sa->spacedata.first : NULL;
1384         bNode *node, *select = NULL;
1385         bNodeLink *link;
1386
1387         *r_snode = snode;
1388         *r_select = NULL;
1389
1390         /* no unlucky accidents */
1391         if (sa == NULL || sa->spacetype != SPACE_NODE)
1392                 return false;
1393
1394         if (!test) {
1395                 /* no need to look for a node */
1396                 return true;
1397         }
1398
1399         for (node = snode->edittree->nodes.first; node; node = node->next) {
1400                 if (node->flag & SELECT) {
1401                         if (select)
1402                                 break;
1403                         else
1404                                 select = node;
1405                 }
1406         }
1407         /* only one selected */
1408         if (node || select == NULL)
1409                 return false;
1410
1411         /* correct node */
1412         if (BLI_listbase_is_empty(&select->inputs) || BLI_listbase_is_empty(&select->outputs))
1413                 return false;
1414
1415         /* test node for links */
1416         for (link = snode->edittree->links.first; link; link = link->next) {
1417                 if (nodeLinkIsHidden(link))
1418                         continue;
1419
1420                 if (link->tonode == select || link->fromnode == select)
1421                         return false;
1422         }
1423
1424         *r_select = select;
1425         return true;
1426 }
1427
1428 /* test == 0, clear all intersect flags */
1429 void ED_node_link_intersect_test(ScrArea *sa, int test)
1430 {
1431         bNode *select;
1432         SpaceNode *snode;
1433         bNodeLink *link, *selink = NULL;
1434         float dist_best = FLT_MAX;
1435
1436         if (!ed_node_link_conditions(sa, test, &snode, &select)) return;
1437
1438         /* clear flags */
1439         for (link = snode->edittree->links.first; link; link = link->next)
1440                 link->flag &= ~NODE_LINKFLAG_HILITE;
1441
1442         if (test == 0) return;
1443
1444         /* find link to select/highlight */
1445         for (link = snode->edittree->links.first; link; link = link->next) {
1446                 float coord_array[NODE_LINK_RESOL + 1][2];
1447
1448                 if (nodeLinkIsHidden(link))
1449                         continue;
1450
1451                 if (node_link_bezier_points(NULL, NULL, link, coord_array, NODE_LINK_RESOL)) {
1452                         float dist = FLT_MAX;
1453                         int i;
1454
1455                         /* loop over link coords to find shortest dist to upper left node edge of a intersected line segment */
1456                         for (i = 0; i < NODE_LINK_RESOL; i++) {
1457                                 /* check if the node rect intersetcts the line from this point to next one */
1458                                 if (BLI_rctf_isect_segment(&select->totr, coord_array[i], coord_array[i + 1])) {
1459                                         /* store the shortest distance to the upper left edge of all intersetctions found so far */
1460                                         const float node_xy[] = {select->totr.xmin, select->totr.ymax};
1461
1462                                         /* to be precise coord_array should be clipped by select->totr,
1463                                          * but not done since there's no real noticeable difference */
1464                                         dist = min_ff(dist_squared_to_line_segment_v2(node_xy, coord_array[i], coord_array[i + 1]),
1465                                                            dist);
1466                                 }
1467                         }
1468
1469                         /* we want the link with the shortest distance to node center */
1470                         if (dist < dist_best) {
1471                                 dist_best = dist;
1472                                 selink = link;
1473                         }
1474                 }
1475         }
1476
1477         if (selink)
1478                 selink->flag |= NODE_LINKFLAG_HILITE;
1479 }
1480
1481 /* assumes sockets in list */
1482 static bNodeSocket *socket_best_match(ListBase *sockets)
1483 {
1484         bNodeSocket *sock;
1485         int type, maxtype = 0;
1486
1487         /* find type range */
1488         for (sock = sockets->first; sock; sock = sock->next)
1489                 maxtype = max_ii(sock->type, maxtype);
1490
1491         /* try all types, starting from 'highest' (i.e. colors, vectors, values) */
1492         for (type = maxtype; type >= 0; --type) {
1493                 for (sock = sockets->first; sock; sock = sock->next) {
1494                         if (!nodeSocketIsHidden(sock) && type == sock->type) {
1495                                 return sock;
1496                         }
1497                 }
1498         }
1499
1500         /* no visible sockets, unhide first of highest type */
1501         for (type = maxtype; type >= 0; --type) {
1502                 for (sock = sockets->first; sock; sock = sock->next) {
1503                         if (type == sock->type) {
1504                                 sock->flag &= ~SOCK_HIDDEN;
1505                                 return sock;
1506                         }
1507                 }
1508         }
1509
1510         return NULL;
1511 }
1512
1513 static bool node_parents_offset_flag_enable_cb(bNode *parent, void *UNUSED(userdata))
1514 {
1515         /* NODE_TEST is used to flag nodes that shouldn't be offset (again) */
1516         parent->flag |= NODE_TEST;
1517
1518         return true;
1519 }
1520
1521 static void node_offset_apply(bNode *node, const float offset_x)
1522 {
1523         /* NODE_TEST is used to flag nodes that shouldn't be offset (again) */
1524         if ((node->flag & NODE_TEST) == 0) {
1525                 node->anim_init_locx = node->locx;
1526                 node->anim_ofsx = (offset_x / UI_DPI_FAC);
1527                 node->flag |= NODE_TEST;
1528         }
1529 }
1530
1531 static void node_parent_offset_apply(NodeInsertOfsData *data, bNode *parent, const float offset_x)
1532 {
1533         bNode *node;
1534
1535         node_offset_apply(parent, offset_x);
1536
1537         /* flag all childs as offset to prevent them from being offset
1538          * separately (they've already moved with the parent) */
1539         for (node = data->ntree->nodes.first; node; node = node->next) {
1540                 if (nodeIsChildOf(parent, node)) {
1541                         /* NODE_TEST is used to flag nodes that shouldn't be offset (again) */
1542                         node->flag |= NODE_TEST;
1543                 }
1544         }
1545 }
1546
1547 #define NODE_INSOFS_ANIM_DURATION 0.25f
1548
1549 /**
1550  * Callback that applies NodeInsertOfsData.offset_x to a node or its parent, similar
1551  * to node_link_insert_offset_output_chain_cb below, but with slightly different logic
1552  */
1553 static bool node_link_insert_offset_frame_chain_cb(
1554         bNode *fromnode, bNode *tonode,
1555         void *userdata,
1556         const bool reversed)
1557 {
1558         NodeInsertOfsData *data = userdata;
1559         bNode *ofs_node = reversed ? fromnode : tonode;
1560
1561         if (ofs_node->parent && ofs_node->parent != data->insert_parent) {
1562                 node_offset_apply(ofs_node->parent, data->offset_x);
1563         }
1564         else {
1565                 node_offset_apply(ofs_node, data->offset_x);
1566         }
1567
1568         return true;
1569 }
1570
1571 /**
1572  * Applies NodeInsertOfsData.offset_x to all childs of \a parent
1573  */
1574 static void node_link_insert_offset_frame_chains(
1575         const bNodeTree *ntree, const bNode *parent,
1576         NodeInsertOfsData *data,
1577         const bool reversed)
1578 {
1579         bNode *node;
1580
1581         for (node = ntree->nodes.first; node; node = node->next) {
1582                 if (nodeIsChildOf(parent, node)) {
1583                         nodeChainIter(ntree, node, node_link_insert_offset_frame_chain_cb, data, reversed);
1584                 }
1585         }
1586 }
1587
1588 /**
1589  * Callback that applies NodeInsertOfsData.offset_x to a node or its parent,
1590  * considering the logic needed for offseting nodes after link insert
1591  */
1592 static bool node_link_insert_offset_chain_cb(
1593         bNode *fromnode, bNode *tonode,
1594         void *userdata,
1595         const bool reversed)
1596 {
1597         NodeInsertOfsData *data = userdata;
1598         bNode *ofs_node = reversed ? fromnode : tonode;
1599
1600         if (data->insert_parent) {
1601                 if (ofs_node->parent && (ofs_node->parent->flag & NODE_TEST) == 0) {
1602                         node_parent_offset_apply(data, ofs_node->parent, data->offset_x);
1603                         node_link_insert_offset_frame_chains(data->ntree, ofs_node->parent, data, reversed);
1604                 }
1605                 else {
1606                         node_offset_apply(ofs_node, data->offset_x);
1607                 }
1608
1609                 if (nodeIsChildOf(data->insert_parent, ofs_node) == false) {
1610                         data->insert_parent = NULL;
1611                 }
1612         }
1613         else if (ofs_node->parent) {
1614                 bNode *node = nodeFindRootParent(ofs_node);
1615                 node_offset_apply(node, data->offset_x);
1616         }
1617         else {
1618                 node_offset_apply(ofs_node, data->offset_x);
1619         }
1620
1621         return true;
1622 }
1623
1624 static void node_link_insert_offset_ntree(
1625         NodeInsertOfsData *iofsd, ARegion *ar,
1626         const int mouse_xy[2], const bool right_alignment)
1627 {
1628         bNodeTree *ntree = iofsd->ntree;
1629         bNode *insert = iofsd->insert;
1630         bNode *prev = iofsd->prev, *next = iofsd->next;
1631         bNode *init_parent = insert->parent; /* store old insert->parent for restoring later */
1632         rctf totr_insert;
1633
1634         const float min_margin = U.node_margin * UI_DPI_FAC;
1635         const float width = NODE_WIDTH(insert);
1636         const bool needs_alignment = (next->totr.xmin - prev->totr.xmax) < (width + (min_margin * 2.0f));
1637
1638         float margin = width;
1639         float dist, addval;
1640
1641
1642         /* NODE_TEST will be used later, so disable for all nodes */
1643         ntreeNodeFlagSet(ntree, NODE_TEST, false);
1644
1645         /* insert->totr isn't updated yet, so totr_insert is used to get the correct worldspace coords */
1646         node_to_updated_rect(insert, &totr_insert);
1647
1648         /* frame attachement was't handled yet so we search the frame that the node will be attached to later */
1649         insert->parent = node_find_frame_to_attach(ar, ntree, mouse_xy);
1650
1651         /* this makes sure nodes are also correctly offset when inserting a node on top of a frame
1652          * without actually making it a part of the frame (because mouse isn't intersecting it)
1653          * - logic here is similar to node_find_frame_to_attach */
1654         if (!insert->parent ||
1655             (prev->parent && (prev->parent == next->parent) && (prev->parent != insert->parent)))
1656         {
1657                 bNode *frame;
1658                 rctf totr_frame;
1659
1660                 /* check nodes front to back */
1661                 for (frame = ntree->nodes.last; frame; frame = frame->prev) {
1662                         /* skip selected, those are the nodes we want to attach */
1663                         if ((frame->type != NODE_FRAME) || (frame->flag & NODE_SELECT))
1664                                 continue;
1665
1666                         /* for some reason frame y coords aren't correct yet */
1667                         node_to_updated_rect(frame, &totr_frame);
1668
1669                         if (BLI_rctf_isect_x(&totr_frame, totr_insert.xmin) &&
1670                             BLI_rctf_isect_x(&totr_frame, totr_insert.xmax))
1671                         {
1672                                 if (BLI_rctf_isect_y(&totr_frame, totr_insert.ymin) ||
1673                                     BLI_rctf_isect_y(&totr_frame, totr_insert.ymax))
1674                                 {
1675                                         /* frame isn't insert->parent actually, but this is needed to make offsetting
1676                                          * nodes work correctly for above checked cases (it is restored later) */
1677                                         insert->parent = frame;
1678                                         break;
1679                                 }
1680                         }
1681                 }
1682         }
1683
1684
1685         /* *** ensure offset at the left (or right for right_alignment case) of insert_node *** */
1686
1687         dist = right_alignment ? totr_insert.xmin - prev->totr.xmax : next->totr.xmin - totr_insert.xmax;
1688         /* distance between insert_node and prev is smaller than min margin */
1689         if (dist < min_margin) {
1690                 addval = (min_margin - dist) * (right_alignment ? 1.0f : -1.0f);
1691
1692                 node_offset_apply(insert, addval);
1693
1694                 totr_insert.xmin  += addval;
1695                 totr_insert.xmax  += addval;
1696                 margin            += min_margin;
1697         }
1698
1699         /* *** ensure offset at the right (or left for right_alignment case) of insert_node *** */
1700
1701         dist = right_alignment ? next->totr.xmin - totr_insert.xmax : totr_insert.xmin - prev->totr.xmax;
1702         /* distance between insert_node and next is smaller than min margin */
1703         if (dist < min_margin) {
1704                 addval = (min_margin - dist) * (right_alignment ? 1.0f : -1.0f);
1705                 if (needs_alignment) {
1706                         bNode *offs_node = right_alignment ? next : prev;
1707                         if (!offs_node->parent ||
1708                             offs_node->parent == insert->parent ||
1709                             nodeIsChildOf(offs_node->parent, insert))
1710                         {
1711                                 node_offset_apply(offs_node, addval);
1712                         }
1713                         else if (!insert->parent && offs_node->parent) {
1714                                 node_offset_apply(nodeFindRootParent(offs_node), addval);
1715                         }
1716                         margin = addval;
1717                 }
1718                 /* enough room is available, but we want to ensure the min margin at the right */
1719                 else {
1720                         /* offset inserted node so that min margin is kept at the right */
1721                         node_offset_apply(insert, -addval);
1722                 }
1723         }
1724
1725
1726         if (needs_alignment) {
1727                 iofsd->insert_parent = insert->parent;
1728                 iofsd->offset_x = margin;
1729
1730                 /* flag all parents of insert as offset to prevent them from being offset */
1731                 nodeParentsIter(insert, node_parents_offset_flag_enable_cb, NULL);
1732                 /* iterate over entire chain and apply offsets */
1733                 nodeChainIter(ntree, right_alignment ? next : prev, node_link_insert_offset_chain_cb, iofsd, !right_alignment);
1734         }
1735
1736         insert->parent = init_parent;
1737 }
1738
1739 /**
1740  * Modal handler for insert offset animation
1741  */
1742 static int node_insert_offset_modal(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
1743 {
1744         SpaceNode *snode = CTX_wm_space_node(C);
1745         NodeInsertOfsData *iofsd = snode->iofsd;
1746         bNode *node;
1747         float duration;
1748         bool redraw = false;
1749
1750         if (!snode || event->type != TIMER || iofsd == NULL || iofsd->anim_timer != event->customdata)
1751                 return OPERATOR_PASS_THROUGH;
1752
1753         duration = (float)iofsd->anim_timer->duration;
1754
1755         /* handle animation - do this before possibly aborting due to duration, since
1756          * main thread might be so busy that node hasn't reached final position yet */
1757         for (node = snode->edittree->nodes.first; node; node = node->next) {
1758                 if (UNLIKELY(node->anim_ofsx)) {
1759                         const float endval = node->anim_init_locx + node->anim_ofsx;
1760                         if (IS_EQF(node->locx, endval) == false) {
1761                                 node->locx = BLI_easing_cubic_ease_in_out(duration, node->anim_init_locx, node->anim_ofsx,
1762                                                                           NODE_INSOFS_ANIM_DURATION);
1763                                 if (node->anim_ofsx < 0) {
1764                                         CLAMP_MIN(node->locx, endval);
1765                                 }
1766                                 else {
1767                                         CLAMP_MAX(node->locx, endval);
1768                                 }
1769                                 redraw = true;
1770                         }
1771                 }
1772         }
1773         if (redraw) {
1774                 ED_region_tag_redraw(CTX_wm_region(C));
1775         }
1776
1777         /* end timer + free insert offset data */
1778         if (duration > NODE_INSOFS_ANIM_DURATION) {
1779                 WM_event_remove_timer(CTX_wm_manager(C), NULL, iofsd->anim_timer);
1780
1781                 for (node = snode->edittree->nodes.first; node; node = node->next) {
1782                         node->anim_init_locx = node->anim_ofsx = 0.0f;
1783                 }
1784
1785                 snode->iofsd = NULL;
1786                 MEM_freeN(iofsd);
1787
1788                 return (OPERATOR_FINISHED | OPERATOR_PASS_THROUGH);
1789         }
1790
1791         return OPERATOR_RUNNING_MODAL;
1792 }
1793
1794 #undef NODE_INSOFS_ANIM_DURATION
1795
1796 static int node_insert_offset_invoke(bContext *C, wmOperator *op, const wmEvent *event)
1797 {
1798         const SpaceNode *snode = CTX_wm_space_node(C);
1799         NodeInsertOfsData *iofsd = snode->iofsd;
1800
1801         if (!iofsd || !iofsd->insert)
1802                 return OPERATOR_CANCELLED;
1803
1804         BLI_assert((snode->flag & SNODE_SKIP_INSOFFSET) == 0);
1805
1806         iofsd->ntree = snode->edittree;
1807         iofsd->anim_timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.02);
1808
1809         node_link_insert_offset_ntree(
1810                     iofsd, CTX_wm_region(C),
1811                     event->mval, (snode->insert_ofs_dir == SNODE_INSERTOFS_DIR_RIGHT));
1812
1813         /* add temp handler */
1814         WM_event_add_modal_handler(C, op);
1815
1816         return OPERATOR_RUNNING_MODAL;
1817 }
1818
1819 void NODE_OT_insert_offset(wmOperatorType *ot)
1820 {
1821         /* identifiers */
1822         ot->name = "Insert Offset";
1823         ot->description = "Automatically offset nodes on insertion";
1824         ot->idname = "NODE_OT_insert_offset";
1825
1826         /* callbacks */
1827         ot->invoke = node_insert_offset_invoke;
1828         ot->modal = node_insert_offset_modal;
1829         ot->poll = ED_operator_node_editable;
1830
1831         /* flags */
1832         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
1833 }
1834
1835 /* assumes link with NODE_LINKFLAG_HILITE set */
1836 void ED_node_link_insert(ScrArea *sa)
1837 {
1838         bNode *node, *select;
1839         SpaceNode *snode;
1840         bNodeLink *link;
1841         bNodeSocket *sockto;
1842
1843         if (!ed_node_link_conditions(sa, true, &snode, &select)) return;
1844
1845         /* get the link */
1846         for (link = snode->edittree->links.first; link; link = link->next)
1847                 if (link->flag & NODE_LINKFLAG_HILITE)
1848                         break;
1849
1850         if (link) {
1851                 bNodeSocket *best_input = socket_best_match(&select->inputs);
1852                 bNodeSocket *best_output = socket_best_match(&select->outputs);
1853
1854                 if (best_input && best_output) {
1855                         node = link->tonode;
1856                         sockto = link->tosock;
1857
1858                         link->tonode = select;
1859                         link->tosock = best_input;
1860                         node_remove_extra_links(snode, link);
1861                         link->flag &= ~NODE_LINKFLAG_HILITE;
1862
1863                         nodeAddLink(snode->edittree, select, best_output, node, sockto);
1864
1865                         /* set up insert offset data, it needs stuff from here */
1866                         if ((snode->flag & SNODE_SKIP_INSOFFSET) == 0) {
1867                                 NodeInsertOfsData *iofsd = MEM_callocN(sizeof(NodeInsertOfsData), __func__);
1868
1869                                 iofsd->insert = select;
1870                                 iofsd->prev = link->fromnode;
1871                                 iofsd->next = node;
1872
1873                                 snode->iofsd = iofsd;
1874                         }
1875
1876                         ntreeUpdateTree(G.main, snode->edittree);   /* needed for pointers */
1877                         snode_update(snode, select);
1878                         ED_node_tag_update_id(snode->id);
1879                 }
1880         }
1881 }