Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_node / node_group.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_group.c
29  *  \ingroup spnode
30  */
31
32 #include <stdlib.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_node_types.h"
37 #include "DNA_anim_types.h"
38
39 #include "BLI_listbase.h"
40 #include "BLI_linklist.h"
41 #include "BLI_math.h"
42
43 #include "BLT_translation.h"
44
45 #include "BKE_action.h"
46 #include "BKE_animsys.h"
47 #include "BKE_context.h"
48 #include "BKE_global.h"
49 #include "BKE_library.h"
50 #include "BKE_main.h"
51 #include "BKE_report.h"
52
53 #include "ED_node.h"  /* own include */
54 #include "ED_screen.h"
55 #include "ED_render.h"
56
57 #include "RNA_access.h"
58 #include "RNA_define.h"
59
60 #include "WM_api.h"
61 #include "WM_types.h"
62
63 #include "UI_resources.h"
64
65 #include "node_intern.h"  /* own include */
66 #include "NOD_common.h"
67
68 static int node_group_operator_active(bContext *C)
69 {
70         if (ED_operator_node_active(C)) {
71                 SpaceNode *snode = CTX_wm_space_node(C);
72
73                 /* Group operators only defined for standard node tree types.
74                  * Disabled otherwise to allow pynodes define their own operators
75                  * with same keymap.
76                  */
77                 if (STREQ(snode->tree_idname, "ShaderNodeTree") ||
78                     STREQ(snode->tree_idname, "CompositorNodeTree") ||
79                     STREQ(snode->tree_idname, "TextureNodeTree"))
80                 {
81                         return true;
82                 }
83         }
84         return false;
85 }
86
87 static int node_group_operator_editable(bContext *C)
88 {
89         if (ED_operator_node_editable(C)) {
90                 SpaceNode *snode = CTX_wm_space_node(C);
91
92                 /* Group operators only defined for standard node tree types.
93                  * Disabled otherwise to allow pynodes define their own operators
94                  * with same keymap.
95                  */
96                 if (ED_node_is_shader(snode) ||
97                     ED_node_is_compositor(snode) ||
98                     ED_node_is_texture(snode))
99                 {
100                         return true;
101                 }
102         }
103         return false;
104 }
105
106 static const char *group_ntree_idname(bContext *C)
107 {
108         SpaceNode *snode = CTX_wm_space_node(C);
109         return snode->tree_idname;
110 }
111
112 static const char *group_node_idname(bContext *C)
113 {
114         SpaceNode *snode = CTX_wm_space_node(C);
115
116         if (ED_node_is_shader(snode))
117                 return "ShaderNodeGroup";
118         else if (ED_node_is_compositor(snode))
119                 return "CompositorNodeGroup";
120         else if (ED_node_is_texture(snode))
121                 return "TextureNodeGroup";
122
123         return "";
124 }
125
126 static bNode *node_group_get_active(bContext *C, const char *node_idname)
127 {
128         SpaceNode *snode = CTX_wm_space_node(C);
129         bNode *node = nodeGetActive(snode->edittree);
130
131         if (node && STREQ(node->idname, node_idname))
132                 return node;
133         else
134                 return NULL;
135 }
136
137 /* ***************** Edit Group operator ************* */
138
139 static int node_group_edit_exec(bContext *C, wmOperator *op)
140 {
141         SpaceNode *snode = CTX_wm_space_node(C);
142         const char *node_idname = group_node_idname(C);
143         bNode *gnode;
144         const bool exit = RNA_boolean_get(op->ptr, "exit");
145
146         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
147
148         gnode = node_group_get_active(C, node_idname);
149
150         if (gnode && !exit) {
151                 bNodeTree *ngroup = (bNodeTree *)gnode->id;
152
153                 if (ngroup)
154                         ED_node_tree_push(snode, ngroup, gnode);
155         }
156         else
157                 ED_node_tree_pop(snode);
158
159         WM_event_add_notifier(C, NC_SCENE | ND_NODES, NULL);
160
161         return OPERATOR_FINISHED;
162 }
163
164 void NODE_OT_group_edit(wmOperatorType *ot)
165 {
166         /* identifiers */
167         ot->name = "Edit Group";
168         ot->description = "Edit node group";
169         ot->idname = "NODE_OT_group_edit";
170
171         /* api callbacks */
172         ot->exec = node_group_edit_exec;
173         ot->poll = node_group_operator_active;
174
175         /* flags */
176         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
177
178         RNA_def_boolean(ot->srna, "exit", false, "Exit", "");
179 }
180
181 /* ******************** Ungroup operator ********************** */
182
183 /* returns 1 if its OK */
184 static int node_group_ungroup(bNodeTree *ntree, bNode *gnode)
185 {
186         bNodeLink *link, *linkn, *tlink;
187         bNode *node, *nextnode;
188         bNodeTree *ngroup, *wgroup;
189         ListBase anim_basepaths = {NULL, NULL};
190         LinkNode *nodes_delayed_free = NULL;
191
192         ngroup = (bNodeTree *)gnode->id;
193
194         /* clear new pointers, set in copytree */
195         for (node = ntree->nodes.first; node; node = node->next)
196                 node->new_node = NULL;
197
198         /* wgroup is a temporary copy of the NodeTree we're merging in
199          * - all of wgroup's nodes are transferred across to their new home
200          * - ngroup (i.e. the source NodeTree) is left unscathed
201          * - temp copy. don't change ID usercount
202          */
203         wgroup = ntreeCopyTree_ex(ngroup, G.main, false);
204
205         /* Add the nodes into the ntree */
206         for (node = wgroup->nodes.first; node; node = nextnode) {
207                 nextnode = node->next;
208
209                 /* Remove interface nodes.
210                  * This also removes remaining links to and from interface nodes.
211                  */
212                 if (ELEM(node->type, NODE_GROUP_INPUT, NODE_GROUP_OUTPUT)) {
213                         /* We must delay removal since sockets will reference this node. see: T52092 */
214                         BLI_linklist_prepend(&nodes_delayed_free, node);
215                 }
216
217                 /* keep track of this node's RNA "base" path (the part of the path identifying the node)
218                  * if the old nodetree has animation data which potentially covers this node
219                  */
220                 if (wgroup->adt) {
221                         PointerRNA ptr;
222                         char *path;
223
224                         RNA_pointer_create(&wgroup->id, &RNA_Node, node, &ptr);
225                         path = RNA_path_from_ID_to_struct(&ptr);
226
227                         if (path)
228                                 BLI_addtail(&anim_basepaths, BLI_genericNodeN(path));
229                 }
230
231                 /* migrate node */
232                 BLI_remlink(&wgroup->nodes, node);
233                 BLI_addtail(&ntree->nodes, node);
234
235                 /* ensure unique node name in the node tree */
236                 nodeUniqueName(ntree, node);
237
238                 if (!node->parent) {
239                         node->locx += gnode->locx;
240                         node->locy += gnode->locy;
241                 }
242
243                 node->flag |= NODE_SELECT;
244         }
245
246         /* Add internal links to the ntree */
247         for (link = wgroup->links.first; link; link = linkn) {
248                 linkn = link->next;
249                 BLI_remlink(&wgroup->links, link);
250                 BLI_addtail(&ntree->links, link);
251         }
252
253         /* and copy across the animation,
254          * note that the animation data's action can be NULL here */
255         if (wgroup->adt) {
256                 LinkData *ld, *ldn = NULL;
257                 bAction *waction;
258
259                 /* firstly, wgroup needs to temporary dummy action that can be destroyed, as it shares copies */
260                 waction = wgroup->adt->action = BKE_action_copy(G.main, wgroup->adt->action);
261
262                 /* now perform the moving */
263                 BKE_animdata_separate_by_basepath(&wgroup->id, &ntree->id, &anim_basepaths);
264
265                 /* paths + their wrappers need to be freed */
266                 for (ld = anim_basepaths.first; ld; ld = ldn) {
267                         ldn = ld->next;
268
269                         MEM_freeN(ld->data);
270                         BLI_freelinkN(&anim_basepaths, ld);
271                 }
272
273                 /* free temp action too */
274                 if (waction) {
275                         BKE_libblock_free(G.main, waction);
276                         wgroup->adt->action = NULL;
277                 }
278         }
279
280         /* free the group tree (takes care of user count) */
281         BKE_libblock_free(G.main, wgroup);
282
283         /* restore external links to and from the gnode */
284         /* note: the nodes have been copied to intermediate wgroup first (so need to use new_node),
285          *       then transferred to ntree (new_node pointers remain valid).
286          */
287
288         /* input links */
289         for (link = ngroup->links.first; link; link = link->next) {
290                 if (link->fromnode->type == NODE_GROUP_INPUT) {
291                         const char *identifier = link->fromsock->identifier;
292                         int num_external_links = 0;
293
294                         /* find external links to this input */
295                         for (tlink = ntree->links.first; tlink; tlink = tlink->next) {
296                                 if (tlink->tonode == gnode && STREQ(tlink->tosock->identifier, identifier)) {
297                                         nodeAddLink(ntree, tlink->fromnode, tlink->fromsock, link->tonode->new_node, link->tosock->new_sock);
298                                         ++num_external_links;
299                                 }
300                         }
301
302                         /* if group output is not externally linked,
303                          * convert the constant input value to ensure somewhat consistent behavior */
304                         if (num_external_links == 0) {
305                                 /* XXX TODO bNodeSocket *sock = node_group_find_input_socket(gnode, identifier);
306                                 BLI_assert(sock);*/
307
308                                 /* XXX TODO nodeSocketCopy(ntree, link->tosock->new_sock, link->tonode->new_node, ntree, sock, gnode);*/
309                         }
310                 }
311         }
312
313         /* output links */
314         for (link = ntree->links.first; link; link = link->next) {
315                 if (link->fromnode == gnode) {
316                         const char *identifier = link->fromsock->identifier;
317                         int num_internal_links = 0;
318
319                         /* find internal links to this output */
320                         for (tlink = ngroup->links.first; tlink; tlink = tlink->next) {
321                                 /* only use active output node */
322                                 if (tlink->tonode->type == NODE_GROUP_OUTPUT && (tlink->tonode->flag & NODE_DO_OUTPUT)) {
323                                         if (STREQ(tlink->tosock->identifier, identifier)) {
324                                                 nodeAddLink(ntree, tlink->fromnode->new_node, tlink->fromsock->new_sock, link->tonode, link->tosock);
325                                                 ++num_internal_links;
326                                         }
327                                 }
328                         }
329
330                         /* if group output is not internally linked,
331                          * convert the constant output value to ensure somewhat consistent behavior */
332                         if (num_internal_links == 0) {
333                                 /* XXX TODO bNodeSocket *sock = node_group_find_output_socket(gnode, identifier);
334                                 BLI_assert(sock);*/
335
336                                 /* XXX TODO nodeSocketCopy(ntree, link->tosock, link->tonode, ntree, sock, gnode); */
337                         }
338                 }
339         }
340
341         while (nodes_delayed_free) {
342                 node = BLI_linklist_pop(&nodes_delayed_free);
343                 nodeFreeNode(ntree, node);
344         }
345
346         /* delete the group instance */
347         nodeFreeNode(ntree, gnode);
348
349         ntree->update |= NTREE_UPDATE_NODES | NTREE_UPDATE_LINKS;
350
351         return 1;
352 }
353
354
355 static int node_group_ungroup_exec(bContext *C, wmOperator *op)
356 {
357         SpaceNode *snode = CTX_wm_space_node(C);
358         const char *node_idname = group_node_idname(C);
359         bNode *gnode;
360
361         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
362
363         gnode = node_group_get_active(C, node_idname);
364         if (!gnode)
365                 return OPERATOR_CANCELLED;
366
367         if (gnode->id && node_group_ungroup(snode->edittree, gnode)) {
368                 ntreeUpdateTree(CTX_data_main(C), snode->nodetree);
369         }
370         else {
371                 BKE_report(op->reports, RPT_WARNING, "Cannot ungroup");
372                 return OPERATOR_CANCELLED;
373         }
374
375         snode_notify(C, snode);
376         snode_dag_update(C, snode);
377
378         return OPERATOR_FINISHED;
379 }
380
381 void NODE_OT_group_ungroup(wmOperatorType *ot)
382 {
383         /* identifiers */
384         ot->name = "Ungroup";
385         ot->description = "Ungroup selected nodes";
386         ot->idname = "NODE_OT_group_ungroup";
387
388         /* api callbacks */
389         ot->exec = node_group_ungroup_exec;
390         ot->poll = node_group_operator_editable;
391
392         /* flags */
393         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
394 }
395
396 /* ******************** Separate operator ********************** */
397
398 /* returns 1 if its OK */
399 static int node_group_separate_selected(bNodeTree *ntree, bNodeTree *ngroup, float offx, float offy, int make_copy)
400 {
401         bNodeLink *link, *link_next;
402         bNode *node, *node_next, *newnode;
403         ListBase anim_basepaths = {NULL, NULL};
404
405         /* deselect all nodes in the target tree */
406         for (node = ntree->nodes.first; node; node = node->next)
407                 nodeSetSelected(node, false);
408
409         /* clear new pointers, set in nodeCopyNode */
410         for (node = ngroup->nodes.first; node; node = node->next)
411                 node->new_node = NULL;
412
413         /* add selected nodes into the ntree */
414         for (node = ngroup->nodes.first; node; node = node_next) {
415                 node_next = node->next;
416                 if (!(node->flag & NODE_SELECT))
417                         continue;
418
419                 /* ignore interface nodes */
420                 if (ELEM(node->type, NODE_GROUP_INPUT, NODE_GROUP_OUTPUT)) {
421                         nodeSetSelected(node, false);
422                         continue;
423                 }
424
425                 if (make_copy) {
426                         /* make a copy */
427                         newnode = nodeCopyNode(ngroup, node);
428                 }
429                 else {
430                         /* use the existing node */
431                         newnode = node;
432                 }
433
434                 /* keep track of this node's RNA "base" path (the part of the path identifying the node)
435                  * if the old nodetree has animation data which potentially covers this node
436                  */
437                 if (ngroup->adt) {
438                         PointerRNA ptr;
439                         char *path;
440
441                         RNA_pointer_create(&ngroup->id, &RNA_Node, newnode, &ptr);
442                         path = RNA_path_from_ID_to_struct(&ptr);
443
444                         if (path)
445                                 BLI_addtail(&anim_basepaths, BLI_genericNodeN(path));
446                 }
447
448                 /* ensure valid parent pointers, detach if parent stays inside the group */
449                 if (newnode->parent && !(newnode->parent->flag & NODE_SELECT))
450                         nodeDetachNode(newnode);
451
452                 /* migrate node */
453                 BLI_remlink(&ngroup->nodes, newnode);
454                 BLI_addtail(&ntree->nodes, newnode);
455
456                 /* ensure unique node name in the node tree */
457                 nodeUniqueName(ntree, newnode);
458
459                 if (!newnode->parent) {
460                         newnode->locx += offx;
461                         newnode->locy += offy;
462                 }
463         }
464
465         /* add internal links to the ntree */
466         for (link = ngroup->links.first; link; link = link_next) {
467                 const bool fromselect = (link->fromnode && (link->fromnode->flag & NODE_SELECT));
468                 const bool toselect = (link->tonode && (link->tonode->flag & NODE_SELECT));
469                 link_next = link->next;
470
471                 if (make_copy) {
472                         /* make a copy of internal links */
473                         if (fromselect && toselect)
474                                 nodeAddLink(ntree, link->fromnode->new_node, link->fromsock->new_sock, link->tonode->new_node, link->tosock->new_sock);
475                 }
476                 else {
477                         /* move valid links over, delete broken links */
478                         if (fromselect && toselect) {
479                                 BLI_remlink(&ngroup->links, link);
480                                 BLI_addtail(&ntree->links, link);
481                         }
482                         else if (fromselect || toselect) {
483                                 nodeRemLink(ngroup, link);
484                         }
485                 }
486         }
487
488         /* and copy across the animation,
489          * note that the animation data's action can be NULL here */
490         if (ngroup->adt) {
491                 LinkData *ld, *ldn = NULL;
492
493                 /* now perform the moving */
494                 BKE_animdata_separate_by_basepath(&ngroup->id, &ntree->id, &anim_basepaths);
495
496                 /* paths + their wrappers need to be freed */
497                 for (ld = anim_basepaths.first; ld; ld = ldn) {
498                         ldn = ld->next;
499
500                         MEM_freeN(ld->data);
501                         BLI_freelinkN(&anim_basepaths, ld);
502                 }
503         }
504
505         ntree->update |= NTREE_UPDATE_NODES | NTREE_UPDATE_LINKS;
506         if (!make_copy)
507                 ngroup->update |= NTREE_UPDATE_NODES | NTREE_UPDATE_LINKS;
508
509         return 1;
510 }
511
512 typedef enum eNodeGroupSeparateType {
513         NODE_GS_COPY,
514         NODE_GS_MOVE
515 } eNodeGroupSeparateType;
516
517 /* Operator Property */
518 static const EnumPropertyItem node_group_separate_types[] = {
519         {NODE_GS_COPY, "COPY", 0, "Copy", "Copy to parent node tree, keep group intact"},
520         {NODE_GS_MOVE, "MOVE", 0, "Move", "Move to parent node tree, remove from group"},
521         {0, NULL, 0, NULL, NULL}
522 };
523
524 static int node_group_separate_exec(bContext *C, wmOperator *op)
525 {
526         SpaceNode *snode = CTX_wm_space_node(C);
527         bNodeTree *ngroup, *nparent;
528         int type = RNA_enum_get(op->ptr, "type");
529         float offx, offy;
530
531         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
532
533         /* are we inside of a group? */
534         ngroup = snode->edittree;
535         nparent = ED_node_tree_get(snode, 1);
536         if (!nparent) {
537                 BKE_report(op->reports, RPT_WARNING, "Not inside node group");
538                 return OPERATOR_CANCELLED;
539         }
540         /* get node tree offset */
541         snode_group_offset(snode, &offx, &offy);
542
543         switch (type) {
544                 case NODE_GS_COPY:
545                         if (!node_group_separate_selected(nparent, ngroup, offx, offy, 1)) {
546                                 BKE_report(op->reports, RPT_WARNING, "Cannot separate nodes");
547                                 return OPERATOR_CANCELLED;
548                         }
549                         break;
550                 case NODE_GS_MOVE:
551                         if (!node_group_separate_selected(nparent, ngroup, offx, offy, 0)) {
552                                 BKE_report(op->reports, RPT_WARNING, "Cannot separate nodes");
553                                 return OPERATOR_CANCELLED;
554                         }
555                         break;
556         }
557
558         /* switch to parent tree */
559         ED_node_tree_pop(snode);
560
561         ntreeUpdateTree(CTX_data_main(C), snode->nodetree);
562
563         snode_notify(C, snode);
564         snode_dag_update(C, snode);
565
566         return OPERATOR_FINISHED;
567 }
568
569 static int node_group_separate_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *UNUSED(event))
570 {
571         uiPopupMenu *pup = UI_popup_menu_begin(C, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Separate"), ICON_NONE);
572         uiLayout *layout = UI_popup_menu_layout(pup);
573
574         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_DEFAULT);
575         uiItemEnumO(layout, "NODE_OT_group_separate", NULL, 0, "type", NODE_GS_COPY);
576         uiItemEnumO(layout, "NODE_OT_group_separate", NULL, 0, "type", NODE_GS_MOVE);
577
578         UI_popup_menu_end(C, pup);
579
580         return OPERATOR_INTERFACE;
581 }
582
583 void NODE_OT_group_separate(wmOperatorType *ot)
584 {
585         /* identifiers */
586         ot->name = "Separate";
587         ot->description = "Separate selected nodes from the node group";
588         ot->idname = "NODE_OT_group_separate";
589
590         /* api callbacks */
591         ot->invoke = node_group_separate_invoke;
592         ot->exec = node_group_separate_exec;
593         ot->poll = node_group_operator_editable;
594
595         /* flags */
596         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
597
598         RNA_def_enum(ot->srna, "type", node_group_separate_types, NODE_GS_COPY, "Type", "");
599 }
600
601 /* ****************** Make Group operator ******************* */
602
603 static bool node_group_make_use_node(bNode *node, bNode *gnode)
604 {
605         return (node != gnode &&
606                 !ELEM(node->type, NODE_GROUP_INPUT, NODE_GROUP_OUTPUT) &&
607                 (node->flag & NODE_SELECT));
608 }
609
610 static bool node_group_make_test_selected(bNodeTree *ntree, bNode *gnode, const char *ntree_idname, struct ReportList *reports)
611 {
612         bNodeTree *ngroup;
613         bNode *node;
614         bNodeLink *link;
615         int ok = true;
616
617         /* make a local pseudo node tree to pass to the node poll functions */
618         ngroup = ntreeAddTree(NULL, "Pseudo Node Group", ntree_idname);
619
620         /* check poll functions for selected nodes */
621         for (node = ntree->nodes.first; node; node = node->next) {
622                 if (node_group_make_use_node(node, gnode)) {
623                         if (node->typeinfo->poll_instance && !node->typeinfo->poll_instance(node, ngroup)) {
624                                 BKE_reportf(reports, RPT_WARNING, "Can not add node '%s' in a group", node->name);
625                                 ok = false;
626                                 break;
627                         }
628                 }
629
630                 node->done = 0;
631         }
632
633         /* free local pseudo node tree again */
634         ntreeFreeTree(ngroup);
635         MEM_freeN(ngroup);
636         if (!ok)
637                 return false;
638
639         /* check if all connections are OK, no unselected node has both
640          * inputs and outputs to a selection */
641         for (link = ntree->links.first; link; link = link->next) {
642                 if (node_group_make_use_node(link->fromnode, gnode))
643                         link->tonode->done |= 1;
644                 if (node_group_make_use_node(link->tonode, gnode))
645                         link->fromnode->done |= 2;
646         }
647         for (node = ntree->nodes.first; node; node = node->next) {
648                 if (!(node->flag & NODE_SELECT) &&
649                     node != gnode &&
650                     node->done == 3)
651                 {
652                         return false;
653                 }
654         }
655         return true;
656 }
657
658 static int node_get_selected_minmax(bNodeTree *ntree, bNode *gnode, float *min, float *max)
659 {
660         bNode *node;
661         float loc[2];
662         int totselect = 0;
663
664         INIT_MINMAX2(min, max);
665         for (node = ntree->nodes.first; node; node = node->next) {
666                 if (node_group_make_use_node(node, gnode)) {
667                         nodeToView(node, 0.0f, 0.0f, &loc[0], &loc[1]);
668                         minmax_v2v2_v2(min, max, loc);
669                         ++totselect;
670                 }
671         }
672
673         /* sane min/max if no selected nodes */
674         if (totselect == 0) {
675                 min[0] = min[1] = max[0] = max[1] = 0.0f;
676         }
677
678         return totselect;
679 }
680
681 static void node_group_make_insert_selected(const bContext *C, bNodeTree *ntree, bNode *gnode)
682 {
683         bNodeTree *ngroup = (bNodeTree *)gnode->id;
684         bNodeLink *link, *linkn;
685         bNode *node, *nextn;
686         bNodeSocket *sock;
687         ListBase anim_basepaths = {NULL, NULL};
688         float min[2], max[2], center[2];
689         int totselect;
690         bool expose_all = false;
691         bNode *input_node, *output_node;
692
693         /* XXX rough guess, not nice but we don't have access to UI constants here ... */
694         static const float offsetx = 200;
695         static const float offsety = 0.0f;
696
697         /* deselect all nodes in the target tree */
698         for (node = ngroup->nodes.first; node; node = node->next)
699                 nodeSetSelected(node, false);
700
701         totselect = node_get_selected_minmax(ntree, gnode, min, max);
702         add_v2_v2v2(center, min, max);
703         mul_v2_fl(center, 0.5f);
704
705         /* auto-add interface for "solo" nodes */
706         if (totselect == 1)
707                 expose_all = true;
708
709         /* move nodes over */
710         for (node = ntree->nodes.first; node; node = nextn) {
711                 nextn = node->next;
712                 if (node_group_make_use_node(node, gnode)) {
713                         /* keep track of this node's RNA "base" path (the part of the pat identifying the node)
714                          * if the old nodetree has animation data which potentially covers this node
715                          */
716                         if (ntree->adt) {
717                                 PointerRNA ptr;
718                                 char *path;
719
720                                 RNA_pointer_create(&ntree->id, &RNA_Node, node, &ptr);
721                                 path = RNA_path_from_ID_to_struct(&ptr);
722
723                                 if (path)
724                                         BLI_addtail(&anim_basepaths, BLI_genericNodeN(path));
725                         }
726
727                         /* ensure valid parent pointers, detach if parent stays outside the group */
728                         if (node->parent && !(node->parent->flag & NODE_SELECT))
729                                 nodeDetachNode(node);
730
731                         /* change node-collection membership */
732                         BLI_remlink(&ntree->nodes, node);
733                         BLI_addtail(&ngroup->nodes, node);
734
735                         /* ensure unique node name in the ngroup */
736                         nodeUniqueName(ngroup, node);
737                 }
738         }
739
740         /* move animation data over */
741         if (ntree->adt) {
742                 LinkData *ld, *ldn = NULL;
743
744                 BKE_animdata_separate_by_basepath(&ntree->id, &ngroup->id, &anim_basepaths);
745
746                 /* paths + their wrappers need to be freed */
747                 for (ld = anim_basepaths.first; ld; ld = ldn) {
748                         ldn = ld->next;
749
750                         MEM_freeN(ld->data);
751                         BLI_freelinkN(&anim_basepaths, ld);
752                 }
753         }
754
755         /* node groups don't use internal cached data */
756         ntreeFreeCache(ngroup);
757
758         /* create input node */
759         input_node = nodeAddStaticNode(C, ngroup, NODE_GROUP_INPUT);
760         input_node->locx = min[0] - center[0] - offsetx;
761         input_node->locy = -offsety;
762
763         /* create output node */
764         output_node = nodeAddStaticNode(C, ngroup, NODE_GROUP_OUTPUT);
765         output_node->locx = max[0] - center[0] + offsetx;
766         output_node->locy = -offsety;
767
768         /* relink external sockets */
769         for (link = ntree->links.first; link; link = linkn) {
770                 int fromselect = node_group_make_use_node(link->fromnode, gnode);
771                 int toselect = node_group_make_use_node(link->tonode, gnode);
772
773                 linkn = link->next;
774
775                 if ((fromselect && link->tonode == gnode) || (toselect && link->fromnode == gnode)) {
776                         /* remove all links to/from the gnode.
777                          * this can remove link information, but there's no general way to preserve it.
778                          */
779                         nodeRemLink(ntree, link);
780                 }
781                 else if (fromselect && toselect) {
782                         BLI_remlink(&ntree->links, link);
783                         BLI_addtail(&ngroup->links, link);
784                 }
785                 else if (toselect) {
786                         bNodeSocket *iosock = ntreeAddSocketInterfaceFromSocket(ngroup, link->tonode, link->tosock);
787                         bNodeSocket *input_sock;
788
789                         /* update the group node and interface node sockets,
790                          * so the new interface socket can be linked.
791                          */
792                         node_group_verify(ntree, gnode, (ID *)ngroup);
793                         node_group_input_verify(ngroup, input_node, (ID *)ngroup);
794
795                         /* create new internal link */
796                         input_sock = node_group_input_find_socket(input_node, iosock->identifier);
797                         nodeAddLink(ngroup, input_node, input_sock, link->tonode, link->tosock);
798
799                         /* redirect external link */
800                         link->tonode = gnode;
801                         link->tosock = node_group_find_input_socket(gnode, iosock->identifier);
802                 }
803                 else if (fromselect) {
804                         /* First check whether the source of this link is already connected to an output.
805                          * If yes, reuse that output instead of duplicating it. */
806                         bool connected = false;
807                         bNodeLink *olink;
808                         for (olink = ngroup->links.first; olink; olink = olink->next) {
809                                 if (olink->fromsock == link->fromsock && olink->tonode == output_node) {
810                                         bNodeSocket *output_sock = node_group_find_output_socket(gnode, olink->tosock->identifier);
811                                         link->fromnode = gnode;
812                                         link->fromsock = output_sock;
813                                         connected = true;
814                                 }
815                         }
816
817                         if (!connected) {
818                                 bNodeSocket *iosock = ntreeAddSocketInterfaceFromSocket(ngroup, link->fromnode, link->fromsock);
819                                 bNodeSocket *output_sock;
820
821                                 /* update the group node and interface node sockets,
822                                  * so the new interface socket can be linked.
823                                  */
824                                 node_group_verify(ntree, gnode, (ID *)ngroup);
825                                 node_group_output_verify(ngroup, output_node, (ID *)ngroup);
826
827                                 /* create new internal link */
828                                 output_sock = node_group_output_find_socket(output_node, iosock->identifier);
829                                 nodeAddLink(ngroup, link->fromnode, link->fromsock, output_node, output_sock);
830
831                                 /* redirect external link */
832                                 link->fromnode = gnode;
833                                 link->fromsock = node_group_find_output_socket(gnode, iosock->identifier);
834                         }
835                 }
836         }
837
838         /* move nodes in the group to the center */
839         for (node = ngroup->nodes.first; node; node = node->next) {
840                 if (node_group_make_use_node(node, gnode) && !node->parent) {
841                         node->locx -= center[0];
842                         node->locy -= center[1];
843                 }
844         }
845
846         /* expose all unlinked sockets too */
847         if (expose_all) {
848                 for (node = ngroup->nodes.first; node; node = node->next) {
849                         if (node_group_make_use_node(node, gnode)) {
850                                 for (sock = node->inputs.first; sock; sock = sock->next) {
851                                         bNodeSocket *iosock, *input_sock;
852                                         bool skip = false;
853                                         for (link = ngroup->links.first; link; link = link->next) {
854                                                 if (link->tosock == sock) {
855                                                         skip = true;
856                                                         break;
857                                                 }
858                                         }
859                                         if (skip)
860                                                 continue;
861
862                                         iosock = ntreeAddSocketInterfaceFromSocket(ngroup, node, sock);
863
864                                         node_group_input_verify(ngroup, input_node, (ID *)ngroup);
865
866                                         /* create new internal link */
867                                         input_sock = node_group_input_find_socket(input_node, iosock->identifier);
868                                         nodeAddLink(ngroup, input_node, input_sock, node, sock);
869                                 }
870
871                                 for (sock = node->outputs.first; sock; sock = sock->next) {
872                                         bNodeSocket *iosock, *output_sock;
873                                         bool skip = false;
874                                         for (link = ngroup->links.first; link; link = link->next)
875                                                 if (link->fromsock == sock)
876                                                         skip = true;
877                                         if (skip)
878                                                 continue;
879
880                                         iosock = ntreeAddSocketInterfaceFromSocket(ngroup, node, sock);
881
882                                         node_group_output_verify(ngroup, output_node, (ID *)ngroup);
883
884                                         /* create new internal link */
885                                         output_sock = node_group_output_find_socket(output_node, iosock->identifier);
886                                         nodeAddLink(ngroup, node, sock, output_node, output_sock);
887                                 }
888                         }
889                 }
890         }
891
892         /* update of the group tree */
893         ngroup->update |= NTREE_UPDATE | NTREE_UPDATE_LINKS;
894         /* update of the tree containing the group instance node */
895         ntree->update |= NTREE_UPDATE_NODES | NTREE_UPDATE_LINKS;
896 }
897
898 static bNode *node_group_make_from_selected(const bContext *C, bNodeTree *ntree, const char *ntype, const char *ntreetype)
899 {
900         Main *bmain = CTX_data_main(C);
901         bNode *gnode;
902         bNodeTree *ngroup;
903         float min[2], max[2];
904         int totselect;
905
906         totselect = node_get_selected_minmax(ntree, NULL, min, max);
907         /* don't make empty group */
908         if (totselect == 0)
909                 return NULL;
910
911         /* new nodetree */
912         ngroup = ntreeAddTree(bmain, "NodeGroup", ntreetype);
913
914         /* make group node */
915         gnode = nodeAddNode(C, ntree, ntype);
916         gnode->id = (ID *)ngroup;
917
918         gnode->locx = 0.5f * (min[0] + max[0]);
919         gnode->locy = 0.5f * (min[1] + max[1]);
920
921         node_group_make_insert_selected(C, ntree, gnode);
922
923         /* update of the tree containing the group instance node */
924         ntree->update |= NTREE_UPDATE_NODES;
925
926         return gnode;
927 }
928
929 static int node_group_make_exec(bContext *C, wmOperator *op)
930 {
931         SpaceNode *snode = CTX_wm_space_node(C);
932         bNodeTree *ntree = snode->edittree;
933         const char *ntree_idname = group_ntree_idname(C);
934         const char *node_idname = group_node_idname(C);
935         bNodeTree *ngroup;
936         bNode *gnode;
937         Main *bmain = CTX_data_main(C);
938
939         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
940
941         if (!node_group_make_test_selected(ntree, NULL, ntree_idname, op->reports))
942                 return OPERATOR_CANCELLED;
943
944         gnode = node_group_make_from_selected(C, ntree, node_idname, ntree_idname);
945
946         if (gnode) {
947                 ngroup = (bNodeTree *)gnode->id;
948
949                 nodeSetActive(ntree, gnode);
950                 if (ngroup) {
951                         ED_node_tree_push(snode, ngroup, gnode);
952                         ntreeUpdateTree(bmain, ngroup);
953                 }
954         }
955
956         ntreeUpdateTree(bmain, ntree);
957
958         snode_notify(C, snode);
959         snode_dag_update(C, snode);
960
961         return OPERATOR_FINISHED;
962 }
963
964 void NODE_OT_group_make(wmOperatorType *ot)
965 {
966         /* identifiers */
967         ot->name = "Make Group";
968         ot->description = "Make group from selected nodes";
969         ot->idname = "NODE_OT_group_make";
970
971         /* api callbacks */
972         ot->exec = node_group_make_exec;
973         ot->poll = node_group_operator_editable;
974
975         /* flags */
976         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
977 }
978
979 /* ****************** Group Insert operator ******************* */
980
981 static int node_group_insert_exec(bContext *C, wmOperator *op)
982 {
983         SpaceNode *snode = CTX_wm_space_node(C);
984         bNodeTree *ntree = snode->edittree;
985         bNodeTree *ngroup;
986         const char *node_idname = group_node_idname(C);
987         bNode *gnode;
988         Main *bmain = CTX_data_main(C);
989
990         ED_preview_kill_jobs(CTX_wm_manager(C), CTX_data_main(C));
991
992         gnode = node_group_get_active(C, node_idname);
993
994         if (!gnode || !gnode->id)
995                 return OPERATOR_CANCELLED;
996
997         ngroup = (bNodeTree *)gnode->id;
998         if (!node_group_make_test_selected(ntree, gnode, ngroup->idname, op->reports))
999                 return OPERATOR_CANCELLED;
1000
1001         node_group_make_insert_selected(C, ntree, gnode);
1002
1003         nodeSetActive(ntree, gnode);
1004         ED_node_tree_push(snode, ngroup, gnode);
1005         ntreeUpdateTree(bmain, ngroup);
1006
1007         ntreeUpdateTree(bmain, ntree);
1008
1009         snode_notify(C, snode);
1010         snode_dag_update(C, snode);
1011
1012         return OPERATOR_FINISHED;
1013 }
1014
1015 void NODE_OT_group_insert(wmOperatorType *ot)
1016 {
1017         /* identifiers */
1018         ot->name = "Group Insert";
1019         ot->description = "Insert selected nodes into a node group";
1020         ot->idname = "NODE_OT_group_insert";
1021
1022         /* api callbacks */
1023         ot->exec = node_group_insert_exec;
1024         ot->poll = node_group_operator_editable;
1025
1026         /* flags */
1027         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1028 }