Adds an update flag to the bNode struct (similar to bNodeTree->update).
[blender.git] / source / blender / editors / space_node / space_node.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/editors/space_node/space_node.c
30  *  \ingroup spnode
31  */
32
33
34 #include <string.h>
35 #include <stdio.h>
36
37 #include "DNA_node_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_material_types.h"
40 #include "DNA_scene_types.h"
41
42 #include "MEM_guardedalloc.h"
43
44 #include "BLI_blenlib.h"
45 #include "BLI_math.h"
46 #include "BLI_rand.h"
47 #include "BLI_utildefines.h"
48
49 #include "BKE_context.h"
50 #include "BKE_screen.h"
51 #include "BKE_node.h"
52
53 #include "ED_space_api.h"
54 #include "ED_render.h"
55 #include "ED_screen.h"
56
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61 #include "UI_resources.h"
62 #include "UI_view2d.h"
63
64 #include "RNA_access.h"
65
66 #include "node_intern.h"        // own include
67
68 /* ******************** manage regions ********************* */
69
70 ARegion *node_has_buttons_region(ScrArea *sa)
71 {
72         ARegion *ar, *arnew;
73
74         ar= BKE_area_find_region_type(sa, RGN_TYPE_UI);
75         if(ar) return ar;
76         
77         /* add subdiv level; after header */
78         ar= BKE_area_find_region_type(sa, RGN_TYPE_HEADER);
79
80         /* is error! */
81         if(ar==NULL) return NULL;
82         
83         arnew= MEM_callocN(sizeof(ARegion), "buttons for node");
84         
85         BLI_insertlinkafter(&sa->regionbase, ar, arnew);
86         arnew->regiontype= RGN_TYPE_UI;
87         arnew->alignment= RGN_ALIGN_RIGHT;
88         
89         arnew->flag = RGN_FLAG_HIDDEN;
90         
91         return arnew;
92 }
93
94 /* ******************** default callbacks for node space ***************** */
95
96 static SpaceLink *node_new(const bContext *UNUSED(C))
97 {
98         ARegion *ar;
99         SpaceNode *snode;
100         
101         snode= MEM_callocN(sizeof(SpaceNode), "initnode");
102         snode->spacetype= SPACE_NODE;   
103         
104         /* backdrop */
105         snode->zoom = 1.0f;
106         
107         /* header */
108         ar= MEM_callocN(sizeof(ARegion), "header for node");
109         
110         BLI_addtail(&snode->regionbase, ar);
111         ar->regiontype= RGN_TYPE_HEADER;
112         ar->alignment= RGN_ALIGN_BOTTOM;
113         
114         /* buttons/list view */
115         ar= MEM_callocN(sizeof(ARegion), "buttons for node");
116         
117         BLI_addtail(&snode->regionbase, ar);
118         ar->regiontype= RGN_TYPE_UI;
119         ar->alignment= RGN_ALIGN_RIGHT;
120         ar->flag = RGN_FLAG_HIDDEN;
121         
122         /* main area */
123         ar= MEM_callocN(sizeof(ARegion), "main area for node");
124         
125         BLI_addtail(&snode->regionbase, ar);
126         ar->regiontype= RGN_TYPE_WINDOW;
127         
128         ar->v2d.tot.xmin=  -256.0f;
129         ar->v2d.tot.ymin=  -256.0f;
130         ar->v2d.tot.xmax= 768.0f;
131         ar->v2d.tot.ymax= 768.0f;
132         
133         ar->v2d.cur.xmin=  -256.0f;
134         ar->v2d.cur.ymin=  -256.0f;
135         ar->v2d.cur.xmax= 768.0f;
136         ar->v2d.cur.ymax= 768.0f;
137         
138         ar->v2d.min[0]= 1.0f;
139         ar->v2d.min[1]= 1.0f;
140         
141         ar->v2d.max[0]= 32000.0f;
142         ar->v2d.max[1]= 32000.0f;
143         
144         ar->v2d.minzoom= 0.09f;
145         ar->v2d.maxzoom= 2.31f;
146         
147         ar->v2d.scroll= (V2D_SCROLL_RIGHT|V2D_SCROLL_BOTTOM);
148         ar->v2d.keepzoom= V2D_LIMITZOOM|V2D_KEEPASPECT;
149         ar->v2d.keeptot= 0;
150         
151         return (SpaceLink *)snode;
152 }
153
154 /* not spacelink itself */
155 static void node_free(SpaceLink *UNUSED(sl))
156 {       
157         
158 }
159
160
161 /* spacetype; init callback */
162 static void node_init(struct wmWindowManager *UNUSED(wm), ScrArea *UNUSED(sa))
163 {
164
165 }
166
167 static void node_area_listener(ScrArea *sa, wmNotifier *wmn)
168 {
169         /* note, ED_area_tag_refresh will re-execute compositor */
170         SpaceNode *snode= sa->spacedata.first;
171         int type= snode->treetype;
172         
173         /* preview renders */
174         switch(wmn->category) {
175                 case NC_SCENE:
176                         switch (wmn->data) {
177                                 case ND_NODES:
178                                 case ND_FRAME:
179                                         ED_area_tag_refresh(sa);
180                                         break;
181                                 case ND_COMPO_RESULT:
182                                         ED_area_tag_redraw(sa);
183                                         break;
184                                 case ND_TRANSFORM_DONE:
185                                         if(type==NTREE_COMPOSIT) {
186                                                 if(snode->flag & SNODE_AUTO_RENDER) {
187                                                         snode->recalc= 1;
188                                                         ED_area_tag_refresh(sa);
189                                                 }
190                                         }
191                                         break;
192                         }
193                         break;
194                 case NC_WM:
195                         if(wmn->data==ND_FILEREAD)
196                                 ED_area_tag_refresh(sa);
197                         break;
198                 
199                 /* future: add ID checks? */
200                 case NC_MATERIAL:
201                         if(type==NTREE_SHADER) {
202                                 if(wmn->data==ND_SHADING)
203                                         ED_area_tag_refresh(sa);
204                                 else if(wmn->data==ND_SHADING_DRAW)
205                                         ED_area_tag_refresh(sa);
206                                 else if(wmn->action==NA_ADDED && snode->edittree)
207                                         nodeSetActiveID(snode->edittree, ID_MA, wmn->reference);
208                                         
209                         }
210                         break;
211                 case NC_TEXTURE:
212                         if(type==NTREE_SHADER || type==NTREE_TEXTURE) {
213                                 if(wmn->data==ND_NODES)
214                                         ED_area_tag_refresh(sa);
215                         }
216                         break;
217                 case NC_TEXT:
218                         /* pynodes */
219                         if(wmn->data==ND_SHADING)
220                                 ED_area_tag_refresh(sa);
221                         break;
222                 case NC_SPACE:
223                         if(wmn->data==ND_SPACE_NODE)
224                                 ED_area_tag_refresh(sa);
225                         else if(wmn->data==ND_SPACE_NODE_VIEW)
226                                 ED_area_tag_redraw(sa);
227                         break;
228                 case NC_NODE:
229                         if (wmn->action == NA_EDITED)
230                                 ED_area_tag_refresh(sa);
231                         else if (wmn->action == NA_SELECTED)
232                                 ED_area_tag_redraw(sa);
233                         break;
234                 case NC_SCREEN:
235                         switch(wmn->data) {
236                                 case ND_ANIMPLAY:
237                                         ED_area_tag_refresh(sa);
238                                         break;
239                         }
240                         break;
241
242                 case NC_IMAGE:
243                         if (wmn->action == NA_EDITED) {
244                                 if(type==NTREE_COMPOSIT) {
245                                         Scene *scene= wmn->window->screen->scene;
246                                         
247                                         /* note that nodeUpdateID is already called by BKE_image_signal() on all
248                                          * scenes so really this is just to know if the images is used in the compo else
249                                          * painting on images could become very slow when the compositor is open. */
250                                         if(nodeUpdateID(scene->nodetree, wmn->reference))
251                                                 ED_area_tag_refresh(sa);
252                                 }
253                         }
254                         break;
255         }
256 }
257
258 static void node_area_refresh(const struct bContext *C, struct ScrArea *sa)
259 {
260         /* default now: refresh node is starting preview */
261         SpaceNode *snode= sa->spacedata.first;
262
263         snode_set_context(snode, CTX_data_scene(C));
264         
265         if(snode->nodetree) {
266                 if(snode->treetype==NTREE_SHADER) {
267                         Material *ma= (Material *)snode->id;
268                         if(ma->use_nodes)
269                                 ED_preview_shader_job(C, sa, snode->id, NULL, NULL, 100, 100, PR_NODE_RENDER);
270                 }
271                 else if(snode->treetype==NTREE_COMPOSIT) {
272                         Scene *scene= (Scene *)snode->id;
273                         if(scene->use_nodes) {
274                                 /* recalc is set on 3d view changes for auto compo */
275                                 if(snode->recalc) {
276                                         snode->recalc= 0;
277                                         node_render_changed_exec((struct bContext*)C, NULL);
278                                 }
279                                 else 
280                                         snode_composite_job(C, sa);
281                         }
282                 }
283                 else if(snode->treetype==NTREE_TEXTURE) {
284                         Tex *tex= (Tex *)snode->id;
285                         if(tex->use_nodes) {
286                                 ED_preview_shader_job(C, sa, snode->id, NULL, NULL, 100, 100, PR_NODE_RENDER);
287                         }
288                 }
289         }
290 }
291
292 static SpaceLink *node_duplicate(SpaceLink *sl)
293 {
294         SpaceNode *snoden= MEM_dupallocN(sl);
295         
296         /* clear or remove stuff from old */
297         snoden->nodetree= NULL;
298         snoden->linkdrag.first= snoden->linkdrag.last= NULL;
299         
300         return (SpaceLink *)snoden;
301 }
302
303
304 /* add handlers, stuff you only do once or on area/region changes */
305 static void node_buttons_area_init(wmWindowManager *wm, ARegion *ar)
306 {
307         wmKeyMap *keymap;
308
309         ED_region_panels_init(wm, ar);
310         
311         keymap= WM_keymap_find(wm->defaultconf, "Node Generic", SPACE_NODE, 0);
312         WM_event_add_keymap_handler(&ar->handlers, keymap);
313 }
314
315 static void node_buttons_area_draw(const bContext *C, ARegion *ar)
316 {
317         ED_region_panels(C, ar, 1, NULL, -1);
318 }
319
320 /* Initialise main area, setting handlers. */
321 static void node_main_area_init(wmWindowManager *wm, ARegion *ar)
322 {
323         wmKeyMap *keymap;
324         ListBase *lb;
325         
326         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);
327         
328         /* own keymaps */
329         keymap= WM_keymap_find(wm->defaultconf, "Node Generic", SPACE_NODE, 0);
330         WM_event_add_keymap_handler(&ar->handlers, keymap);
331         
332         keymap= WM_keymap_find(wm->defaultconf, "Node Editor", SPACE_NODE, 0);
333         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
334         
335         /* add drop boxes */
336         lb = WM_dropboxmap_find("Node Editor", SPACE_NODE, RGN_TYPE_WINDOW);
337         
338         WM_event_add_dropbox_handler(&ar->handlers, lb);
339 }
340
341 static void node_main_area_draw(const bContext *C, ARegion *ar)
342 {
343         View2D *v2d= &ar->v2d;
344         
345         drawnodespace(C, ar, v2d);
346 }
347
348
349 /* ************* dropboxes ************* */
350
351 static int node_drop_poll(bContext *UNUSED(C), wmDrag *drag, wmEvent *UNUSED(event))
352 {
353         if(drag->type==WM_DRAG_ID) {
354                 ID *id= (ID *)drag->poin;
355                 if( GS(id->name)==ID_IM )
356                         return 1;
357         }
358         else if(drag->type==WM_DRAG_PATH){
359                 if(ELEM(drag->icon, 0, ICON_FILE_IMAGE))        /* rule might not work? */
360                         return 1;
361         }
362         return 0;
363 }
364
365 static void node_id_path_drop_copy(wmDrag *drag, wmDropBox *drop)
366 {
367         ID *id= (ID *)drag->poin;
368         
369         if(id) {
370                 RNA_string_set(drop->ptr, "name", id->name+2);
371         }
372         if (drag->path[0]) {
373                 RNA_string_set(drop->ptr, "filepath", drag->path);
374         }
375 }
376
377 /* this region dropbox definition */
378 static void node_dropboxes(void)
379 {
380         ListBase *lb= WM_dropboxmap_find("Node Editor", SPACE_NODE, RGN_TYPE_WINDOW);
381         
382         WM_dropbox_add(lb, "NODE_OT_add_file", node_drop_poll, node_id_path_drop_copy);
383         
384 }
385
386 /* ************* end drop *********** */
387
388
389 /* add handlers, stuff you only do once or on area/region changes */
390 static void node_header_area_init(wmWindowManager *UNUSED(wm), ARegion *ar)
391 {
392         ED_region_header_init(ar);
393 }
394
395 static void node_header_area_draw(const bContext *C, ARegion *ar)
396 {
397         SpaceNode *snode= CTX_wm_space_node(C);
398         Scene *scene= CTX_data_scene(C);
399
400         /* find and set the context */
401         snode_set_context(snode, scene);
402
403         ED_region_header(C, ar);
404 }
405
406 /* used for header + main area */
407 static void node_region_listener(ARegion *ar, wmNotifier *wmn)
408 {
409         /* context changes */
410         switch(wmn->category) {
411                 case NC_SPACE:
412                         if(wmn->data==ND_SPACE_NODE)
413                                 ED_region_tag_redraw(ar);
414                         break;
415                 case NC_SCREEN:
416                         if(wmn->data == ND_GPENCIL)     
417                                 ED_region_tag_redraw(ar);
418                         break;
419                 case NC_SCENE:
420                 case NC_MATERIAL:
421                 case NC_TEXTURE:
422                 case NC_NODE:
423                         ED_region_tag_redraw(ar);
424                         break;
425                 case NC_ID:
426                         if(wmn->action == NA_RENAME)
427                                 ED_region_tag_redraw(ar);
428                         break;
429         }
430 }
431
432 const char *node_context_dir[] = {"selected_nodes", NULL};
433
434 static int node_context(const bContext *C, const char *member, bContextDataResult *result)
435 {
436         SpaceNode *snode= CTX_wm_space_node(C);
437         
438         if(CTX_data_dir(member)) {
439                 CTX_data_dir_set(result, node_context_dir);
440                 return 1;
441         }
442         else if(CTX_data_equals(member, "selected_nodes")) {
443                 bNode *node;
444                 
445                 if(snode->edittree) {
446                         for(node=snode->edittree->nodes.last; node; node=node->prev) {
447                                 if(node->flag & NODE_SELECT) {
448                                         CTX_data_list_add(result, &snode->edittree->id, &RNA_Node, node);
449                                 }
450                         }
451                 }
452                 CTX_data_type_set(result, CTX_DATA_TYPE_COLLECTION);
453                 return 1;
454         }
455         else if(CTX_data_equals(member, "active_node")) {
456                 bNode *node;
457                 
458                 if(snode->edittree) {
459                         for(node=snode->edittree->nodes.last; node; node=node->prev) {
460                                 if(node->flag & NODE_ACTIVE) {
461                                         CTX_data_pointer_set(result, &snode->edittree->id, &RNA_Node, node);
462                                         break;
463                                 }
464                         }
465                 }
466                 CTX_data_type_set(result, CTX_DATA_TYPE_POINTER);
467                 return 1;
468         }
469         
470         return 0;
471 }
472
473 /* only called once, from space/spacetypes.c */
474 void ED_spacetype_node(void)
475 {
476         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype node");
477         ARegionType *art;
478         
479         st->spaceid= SPACE_NODE;
480         strncpy(st->name, "Node", BKE_ST_MAXNAME);
481         
482         st->new= node_new;
483         st->free= node_free;
484         st->init= node_init;
485         st->duplicate= node_duplicate;
486         st->operatortypes= node_operatortypes;
487         st->keymap= node_keymap;
488         st->listener= node_area_listener;
489         st->refresh= node_area_refresh;
490         st->context= node_context;
491         st->dropboxes = node_dropboxes;
492         
493         /* regions: main window */
494         art= MEM_callocN(sizeof(ARegionType), "spacetype node region");
495         art->regionid = RGN_TYPE_WINDOW;
496         art->init= node_main_area_init;
497         art->draw= node_main_area_draw;
498         art->listener= node_region_listener;
499         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_FRAMES|ED_KEYMAP_GPENCIL;
500
501         BLI_addhead(&st->regiontypes, art);
502         
503         /* regions: header */
504         art= MEM_callocN(sizeof(ARegionType), "spacetype node region");
505         art->regionid = RGN_TYPE_HEADER;
506         art->prefsizey= HEADERY;
507         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_FRAMES|ED_KEYMAP_HEADER;
508         art->listener= node_region_listener;
509         art->init= node_header_area_init;
510         art->draw= node_header_area_draw;
511         
512         BLI_addhead(&st->regiontypes, art);
513
514         node_menus_register();
515         
516         /* regions: listview/buttons */
517         art= MEM_callocN(sizeof(ARegionType), "spacetype node region");
518         art->regionid = RGN_TYPE_UI;
519         art->prefsizex= 180; // XXX
520         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_FRAMES;
521         art->listener= node_region_listener;
522         art->init= node_buttons_area_init;
523         art->draw= node_buttons_area_draw;
524         BLI_addhead(&st->regiontypes, art);
525         
526         node_buttons_register(art);
527         
528         BKE_spacetype_register(st);
529 }
530