007699758937e38508f87fb7140bbeecfd27556d
[blender.git] / source / blender / editors / space_node / node_add.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_add.c
29  *  \ingroup spnode
30  */
31
32 #include <errno.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_node_types.h"
37
38 #include "BLI_listbase.h"
39 #include "BLI_math.h"
40
41 #include "BLF_translation.h"
42
43 #include "BKE_context.h"
44 #include "BKE_image.h"
45 #include "BKE_library.h"
46 #include "BKE_main.h"
47 #include "BKE_node.h"
48 #include "BKE_report.h"
49
50 #include "ED_node.h"  /* own include */
51 #include "ED_screen.h"
52 #include "ED_render.h"
53
54 #include "RNA_access.h"
55 #include "RNA_define.h"
56 #include "RNA_enum_types.h"
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61 #include "UI_view2d.h"
62
63 #include "node_intern.h"  /* own include */
64
65 /* XXX Does some additional initialization on top of nodeAddNode
66  * Can be used with both custom and static nodes, if idname==NULL the static int type will be used instead.
67  */
68 bNode *node_add_node(const bContext *C, const char *idname, int type, float locx, float locy)
69 {
70         SpaceNode *snode = CTX_wm_space_node(C);
71         Main *bmain = CTX_data_main(C);
72         bNode *node = NULL;
73         
74         node_deselect_all(snode);
75         
76         if (idname)
77                 node = nodeAddNode(C, snode->edittree, idname);
78         else
79                 node = nodeAddStaticNode(C, snode->edittree, type);
80         BLI_assert(node && node->typeinfo);
81         
82         /* generics */
83         node->locx = locx;
84         node->locy = locy + 60.0f;     /* arbitrary... so its visible, (0,0) is top of node */
85         nodeSetSelected(node, TRUE);
86         
87         node->locx = locx;
88         node->locy = locy + 60.0f;
89         
90         ntreeUpdateTree(bmain, snode->edittree);
91         ED_node_set_active(bmain, snode->edittree, node);
92         
93         if (snode->flag & SNODE_USE_HIDDEN_PREVIEW)
94                 node->flag &= ~NODE_PREVIEW;
95         
96         snode_update(snode, node);
97         
98         if (snode->nodetree->type == NTREE_TEXTURE) {
99                 ntreeTexCheckCyclics(snode->edittree);
100         }
101         
102         return node;
103 }
104
105 /* ********************** Add reroute operator ***************** */
106 static int add_reroute_intersect_check(bNodeLink *link, float mcoords[][2], int tot, float result[2])
107 {
108         float coord_array[NODE_LINK_RESOL + 1][2];
109         int i, b;
110
111         if (node_link_bezier_points(NULL, NULL, link, coord_array, NODE_LINK_RESOL)) {
112
113                 for (i = 0; i < tot - 1; i++)
114                         for (b = 0; b < NODE_LINK_RESOL; b++)
115                                 if (isect_line_line_v2(mcoords[i], mcoords[i + 1], coord_array[b], coord_array[b + 1]) > 0) {
116                                         result[0] = (mcoords[i][0] + mcoords[i + 1][0]) / 2.0f;
117                                         result[1] = (mcoords[i][1] + mcoords[i + 1][1]) / 2.0f;
118                                         return 1;
119                                 }
120         }
121         return 0;
122 }
123
124 typedef struct bNodeSocketLink {
125         struct bNodeSocketLink *next, *prev;
126         
127         struct bNodeSocket *sock;
128         struct bNodeLink *link;
129         float point[2];
130 } bNodeSocketLink;
131
132 static bNodeSocketLink *add_reroute_insert_socket_link(ListBase *lb, bNodeSocket *sock, bNodeLink *link, const float point[2])
133 {
134         bNodeSocketLink *socklink, *prev;
135         
136         socklink = MEM_callocN(sizeof(bNodeSocketLink), "socket link");
137         socklink->sock = sock;
138         socklink->link = link;
139         copy_v2_v2(socklink->point, point);
140         
141         for (prev = lb->last; prev; prev = prev->prev) {
142                 if (prev->sock == sock)
143                         break;
144         }
145         BLI_insertlinkafter(lb, prev, socklink);
146         return socklink;
147 }
148
149 static bNodeSocketLink *add_reroute_do_socket_section(bContext *C, bNodeSocketLink *socklink, int in_out)
150 {
151         SpaceNode *snode = CTX_wm_space_node(C);
152         bNodeTree *ntree = snode->edittree;
153         bNode *reroute_node = NULL;
154         bNodeSocket *cursock = socklink->sock;
155         float insert_point[2];
156         int num_links;
157         
158         zero_v2(insert_point);
159         num_links = 0;
160         
161         while (socklink && socklink->sock == cursock) {
162                 if (!(socklink->link->flag & NODE_LINK_TEST)) {
163                         socklink->link->flag |= NODE_LINK_TEST;
164                         
165                         /* create the reroute node for this cursock */
166                         if (!reroute_node) {
167                                 reroute_node = nodeAddStaticNode(C, ntree, NODE_REROUTE);
168                                 
169                                 /* add a single link to/from the reroute node to replace multiple links */
170                                 if (in_out == SOCK_OUT) {
171                                         nodeAddLink(ntree, socklink->link->fromnode, socklink->link->fromsock, reroute_node, reroute_node->inputs.first);
172                                 }
173                                 else {
174                                         nodeAddLink(ntree, reroute_node, reroute_node->outputs.first, socklink->link->tonode, socklink->link->tosock);
175                                 }
176                         }
177                         
178                         /* insert the reroute node into the link */
179                         if (in_out == SOCK_OUT) {
180                                 socklink->link->fromnode = reroute_node;
181                                 socklink->link->fromsock = reroute_node->outputs.first;
182                         }
183                         else {
184                                 socklink->link->tonode = reroute_node;
185                                 socklink->link->tosock = reroute_node->inputs.first;
186                         }
187                         
188                         add_v2_v2(insert_point, socklink->point);
189                         num_links++;
190                 }
191                 socklink = socklink->next;
192         }
193         
194         if (num_links > 0) {
195                 /* average cut point from shared links */
196                 mul_v2_fl(insert_point, 1.0f / num_links);
197                 
198                 reroute_node->locx = insert_point[0];
199                 reroute_node->locy = insert_point[1];
200         }
201         
202         return socklink;
203 }
204
205 static int add_reroute_exec(bContext *C, wmOperator *op)
206 {
207         SpaceNode *snode = CTX_wm_space_node(C);
208         ARegion *ar = CTX_wm_region(C);
209         bNodeTree *ntree = snode->edittree;
210         float mcoords[256][2];
211         int i = 0;
212         
213         /* Get the cut path */
214         RNA_BEGIN (op->ptr, itemptr, "path")
215         {
216                 float loc[2];
217
218                 RNA_float_get_array(&itemptr, "loc", loc);
219                 UI_view2d_region_to_view(&ar->v2d, (short)loc[0], (short)loc[1],
220                                          &mcoords[i][0], &mcoords[i][1]);
221                 i++;
222                 if (i >= 256) break;
223         }
224         RNA_END;
225
226         if (i > 1) {
227                 ListBase output_links, input_links;
228                 bNodeLink *link;
229                 bNodeSocketLink *socklink;
230                 float insert_point[2];
231                 
232                 /* always first */
233                 ED_preview_kill_jobs(C);
234                 
235                 node_deselect_all(snode);
236                 
237                 /* Find cut links and sort them by sockets */
238                 output_links.first = output_links.last = NULL;
239                 input_links.first = input_links.last = NULL;
240                 for (link = ntree->links.first; link; link = link->next) {
241                         if (nodeLinkIsHidden(link))
242                                 continue;
243                         if (add_reroute_intersect_check(link, mcoords, i, insert_point)) {
244                                 add_reroute_insert_socket_link(&output_links, link->fromsock, link, insert_point);
245                                 add_reroute_insert_socket_link(&input_links, link->tosock, link, insert_point);
246                                 
247                                 /* Clear flag */
248                                 link->flag &= ~NODE_LINK_TEST;
249                         }
250                 }
251                 
252                 /* Create reroute nodes for intersected links.
253                  * Only one reroute if links share the same input/output socket.
254                  */
255                 socklink = output_links.first;
256                 while (socklink) {
257                         socklink = add_reroute_do_socket_section(C, socklink, SOCK_OUT);
258                 }
259                 socklink = input_links.first;
260                 while (socklink) {
261                         socklink = add_reroute_do_socket_section(C, socklink, SOCK_IN);
262                 }
263                 
264                 BLI_freelistN(&output_links);
265                 BLI_freelistN(&input_links);
266                 
267                 /* always last */
268                 ntreeUpdateTree(CTX_data_main(C), ntree);
269                 snode_notify(C, snode);
270                 snode_dag_update(C, snode);
271                 
272                 return OPERATOR_FINISHED;
273         }
274         
275         return OPERATOR_CANCELLED | OPERATOR_PASS_THROUGH;
276 }
277
278 void NODE_OT_add_reroute(wmOperatorType *ot)
279 {
280         PropertyRNA *prop;
281
282         ot->name = "Add Reroute";
283         ot->idname = "NODE_OT_add_reroute";
284         ot->description = "Add a reroute node";
285
286         ot->invoke = WM_gesture_lines_invoke;
287         ot->modal = WM_gesture_lines_modal;
288         ot->exec = add_reroute_exec;
289         ot->cancel = WM_gesture_lines_cancel;
290
291         ot->poll = ED_operator_node_editable;
292
293         /* flags */
294         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
295
296         prop = RNA_def_property(ot->srna, "path", PROP_COLLECTION, PROP_NONE);
297         RNA_def_property_struct_runtime(prop, &RNA_OperatorMousePath);
298         /* internal */
299         RNA_def_int(ot->srna, "cursor", BC_CROSSCURSOR, 0, INT_MAX, "Cursor", "", 0, INT_MAX);
300 }
301
302
303 /* ****************** Add File Node Operator  ******************* */
304
305 static int node_add_file_exec(bContext *C, wmOperator *op)
306 {
307         SpaceNode *snode = CTX_wm_space_node(C);
308         bNode *node;
309         Image *ima = NULL;
310         int type = 0;
311
312         /* check input variables */
313         if (RNA_struct_property_is_set(op->ptr, "filepath")) {
314                 char path[FILE_MAX];
315                 RNA_string_get(op->ptr, "filepath", path);
316
317                 errno = 0;
318
319                 ima = BKE_image_load_exists(path);
320
321                 if (!ima) {
322                         BKE_reportf(op->reports, RPT_ERROR, "Cannot read image '%s': %s",
323                                     path, errno ? strerror(errno) : TIP_("unsupported format"));
324                         return OPERATOR_CANCELLED;
325                 }
326         }
327         else if (RNA_struct_property_is_set(op->ptr, "name")) {
328                 char name[MAX_ID_NAME - 2];
329                 RNA_string_get(op->ptr, "name", name);
330                 ima = (Image *)BKE_libblock_find_name(ID_IM, name);
331
332                 if (!ima) {
333                         BKE_reportf(op->reports, RPT_ERROR, "Image '%s' not found", name);
334                         return OPERATOR_CANCELLED;
335                 }
336         }
337
338         switch (snode->nodetree->type) {
339                 case NTREE_SHADER:
340                         type = SH_NODE_TEX_IMAGE;
341                         break;
342                 case NTREE_TEXTURE:
343                         type = TEX_NODE_IMAGE;
344                         break;
345                 case NTREE_COMPOSIT:
346                         type = CMP_NODE_IMAGE;
347                         break;
348                 default:
349                         return OPERATOR_CANCELLED;
350         }
351         
352         ED_preview_kill_jobs(C);
353         
354         node = node_add_node(C, NULL, type, snode->cursor[0], snode->cursor[1]);
355         
356         if (!node) {
357                 BKE_report(op->reports, RPT_WARNING, "Could not add an image node");
358                 return OPERATOR_CANCELLED;
359         }
360         
361         node->id = (ID *)ima;
362         
363         BKE_image_signal(ima, NULL, IMA_SIGNAL_RELOAD);
364         WM_event_add_notifier(C, NC_IMAGE | NA_EDITED, ima);
365
366         snode_notify(C, snode);
367         snode_dag_update(C, snode);
368         
369         return OPERATOR_FINISHED;
370 }
371
372 static int node_add_file_invoke(bContext *C, wmOperator *op, const wmEvent *event)
373 {
374         ARegion *ar = CTX_wm_region(C);
375         SpaceNode *snode = CTX_wm_space_node(C);
376         
377         /* convert mouse coordinates to v2d space */
378         UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1],
379                                  &snode->cursor[0], &snode->cursor[1]);
380         
381         if (RNA_struct_property_is_set(op->ptr, "filepath") || RNA_struct_property_is_set(op->ptr, "name"))
382                 return node_add_file_exec(C, op);
383         else
384                 return WM_operator_filesel(C, op, event);
385 }
386
387 void NODE_OT_add_file(wmOperatorType *ot)
388 {
389         /* identifiers */
390         ot->name = "Add File Node";
391         ot->description = "Add a file node to the current node editor";
392         ot->idname = "NODE_OT_add_file";
393
394         /* callbacks */
395         ot->exec = node_add_file_exec;
396         ot->invoke = node_add_file_invoke;
397         ot->poll = ED_operator_node_editable;
398
399         /* flags */
400         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
401
402         WM_operator_properties_filesel(ot, FOLDERFILE | IMAGEFILE, FILE_SPECIAL, FILE_OPENFILE,
403                                        WM_FILESEL_FILEPATH, FILE_DEFAULTDISPLAY);  //XXX TODO, relative_path
404         RNA_def_string(ot->srna, "name", "Image", MAX_ID_NAME - 2, "Name", "Datablock name to assign");
405 }
406
407 /* ****************** Add Mask Node Operator  ******************* */
408
409 static int node_add_mask_poll(bContext *C)
410 {
411         SpaceNode *snode = CTX_wm_space_node(C);
412
413         return ED_operator_node_editable(C) && snode->nodetree->type == NTREE_COMPOSIT;
414 }
415
416 static int node_add_mask_exec(bContext *C, wmOperator *op)
417 {
418         SpaceNode *snode = CTX_wm_space_node(C);
419         bNode *node;
420         ID *mask = NULL;
421
422         /* check input variables */
423         char name[MAX_ID_NAME - 2];
424         RNA_string_get(op->ptr, "name", name);
425         mask = BKE_libblock_find_name(ID_MSK, name);
426         if (!mask) {
427                 BKE_reportf(op->reports, RPT_ERROR, "Mask '%s' not found", name);
428                 return OPERATOR_CANCELLED;
429         }
430
431         ED_preview_kill_jobs(C);
432
433         node = node_add_node(C, NULL, CMP_NODE_MASK, snode->cursor[0], snode->cursor[1]);
434
435         if (!node) {
436                 BKE_report(op->reports, RPT_WARNING, "Could not add a mask node");
437                 return OPERATOR_CANCELLED;
438         }
439
440         node->id = mask;
441         id_us_plus(mask);
442
443         snode_notify(C, snode);
444         snode_dag_update(C, snode);
445
446         return OPERATOR_FINISHED;
447 }
448
449 void NODE_OT_add_mask(wmOperatorType *ot)
450 {
451         /* identifiers */
452         ot->name = "Add Mask Node";
453         ot->description = "Add a mask node to the current node editor";
454         ot->idname = "NODE_OT_add_mask";
455
456         /* callbacks */
457         ot->exec = node_add_mask_exec;
458         ot->poll = node_add_mask_poll;
459
460         /* flags */
461         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
462
463         RNA_def_string(ot->srna, "name", "Mask", MAX_ID_NAME - 2, "Name", "Datablock name to assign");
464 }
465
466 /********************** New node tree operator *********************/
467
468 static int new_node_tree_exec(bContext *C, wmOperator *op)
469 {
470         SpaceNode *snode = CTX_wm_space_node(C);
471         Main *bmain = CTX_data_main(C);
472         bNodeTree *ntree;
473         PointerRNA ptr, idptr;
474         PropertyRNA *prop;
475         const char *idname;
476         char _treename[MAX_ID_NAME - 2];
477         char *treename = _treename;
478         
479         if (RNA_struct_property_is_set(op->ptr, "type")) {
480                 prop = RNA_struct_find_property(op->ptr, "type");
481                 RNA_property_enum_identifier(C, op->ptr, prop, RNA_property_enum_get(op->ptr, prop), &idname);
482         }
483         else if (snode)
484                 idname = snode->tree_idname;
485         else
486                 return OPERATOR_CANCELLED;
487         
488         if (RNA_struct_property_is_set(op->ptr, "name")) {
489                 RNA_string_get(op->ptr, "name", treename);
490         }
491         else {
492                 treename = (char *)DATA_("NodeTree");
493         }
494         
495         if (!ntreeTypeFind(idname)) {
496                 BKE_reportf(op->reports, RPT_ERROR, "Node tree type %s undefined", idname);
497                 return OPERATOR_CANCELLED;
498         }
499         
500         ntree = ntreeAddTree(bmain, treename, idname);
501         
502         /* hook into UI */
503         uiIDContextProperty(C, &ptr, &prop);
504
505         if (prop) {
506                 /* RNA_property_pointer_set increases the user count,
507                  * fixed here as the editor is the initial user.
508                  */
509                 ntree->id.us--;
510
511                 RNA_id_pointer_create(&ntree->id, &idptr);
512                 RNA_property_pointer_set(&ptr, prop, idptr);
513                 RNA_property_update(C, &ptr, prop);
514         }
515         else if (snode) {
516                 snode->nodetree = ntree;
517                 
518                 ED_node_tree_update(C);
519         }
520         
521         return OPERATOR_FINISHED;
522 }
523
524 static EnumPropertyItem *new_node_tree_type_itemf(bContext *UNUSED(C), PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop), int *free)
525 {
526         return rna_node_tree_type_itemf(NULL, NULL, free);
527 }
528
529 void NODE_OT_new_node_tree(wmOperatorType *ot)
530 {
531         PropertyRNA *prop;
532         
533         /* identifiers */
534         ot->name = "New Node Tree";
535         ot->idname = "NODE_OT_new_node_tree";
536         ot->description = "Create a new node tree";
537         
538         /* api callbacks */
539         ot->exec = new_node_tree_exec;
540         
541         /* flags */
542         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
543         
544         prop = RNA_def_enum(ot->srna, "type", DummyRNA_NULL_items, 0, "Tree Type", "");
545         RNA_def_enum_funcs(prop, new_node_tree_type_itemf);
546         RNA_def_string(ot->srna, "name", "NodeTree", MAX_ID_NAME - 2, "Name", "");
547 }
548