Cycles Node Editor:
[blender.git] / source / blender / editors / space_node / space_node.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_node/space_node.c
28  *  \ingroup spnode
29  */
30
31
32 #include <string.h>
33 #include <stdio.h>
34
35 #include "DNA_lamp_types.h"
36 #include "DNA_material_types.h"
37 #include "DNA_node_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_scene_types.h"
40 #include "DNA_world_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_WORLD:
218                         if(type==NTREE_SHADER) {
219                                 ED_area_tag_refresh(sa);        
220                         }
221                         break;
222                 case NC_OBJECT:
223                         if(type==NTREE_SHADER) {
224                                 if(wmn->data==ND_OB_SHADING)
225                                         ED_area_tag_refresh(sa);
226                         }
227                         break;
228                 case NC_TEXT:
229                         /* pynodes */
230                         if(wmn->data==ND_SHADING)
231                                 ED_area_tag_refresh(sa);
232                         break;
233                 case NC_SPACE:
234                         if(wmn->data==ND_SPACE_NODE)
235                                 ED_area_tag_refresh(sa);
236                         else if(wmn->data==ND_SPACE_NODE_VIEW)
237                                 ED_area_tag_redraw(sa);
238                         break;
239                 case NC_NODE:
240                         if (wmn->action == NA_EDITED)
241                                 ED_area_tag_refresh(sa);
242                         else if (wmn->action == NA_SELECTED)
243                                 ED_area_tag_redraw(sa);
244                         break;
245                 case NC_SCREEN:
246                         switch(wmn->data) {
247                                 case ND_ANIMPLAY:
248                                         ED_area_tag_refresh(sa);
249                                         break;
250                         }
251                         break;
252
253                 case NC_IMAGE:
254                         if (wmn->action == NA_EDITED) {
255                                 if(type==NTREE_COMPOSIT) {
256                                         /* note that nodeUpdateID is already called by BKE_image_signal() on all
257                                          * scenes so really this is just to know if the images is used in the compo else
258                                          * painting on images could become very slow when the compositor is open. */
259                                         if(nodeUpdateID(snode->nodetree, wmn->reference))
260                                                 ED_area_tag_refresh(sa);
261                                 }
262                         }
263                         break;
264         }
265 }
266
267 static void node_area_refresh(const struct bContext *C, struct ScrArea *sa)
268 {
269         /* default now: refresh node is starting preview */
270         SpaceNode *snode= sa->spacedata.first;
271
272         snode_set_context(snode, CTX_data_scene(C));
273         
274         if(snode->nodetree) {
275                 if(snode->treetype==NTREE_SHADER) {
276                         if(GS(snode->id->name) == ID_MA) {
277                                 Material *ma= (Material *)snode->id;
278                                 if(ma->use_nodes)
279                                         ED_preview_shader_job(C, sa, snode->id, NULL, NULL, 100, 100, PR_NODE_RENDER);
280                         }
281                         else if(GS(snode->id->name) == ID_LA) {
282                                 Lamp *la= (Lamp *)snode->id;
283                                 if(la->use_nodes)
284                                         ED_preview_shader_job(C, sa, snode->id, NULL, NULL, 100, 100, PR_NODE_RENDER);
285                         }
286                         else if(GS(snode->id->name) == ID_WO) {
287                                 World *wo= (World *)snode->id;
288                                 if(wo->use_nodes)
289                                         ED_preview_shader_job(C, sa, snode->id, NULL, NULL, 100, 100, PR_NODE_RENDER);
290                         }
291                 }
292                 else if(snode->treetype==NTREE_COMPOSIT) {
293                         Scene *scene= (Scene *)snode->id;
294                         if(scene->use_nodes) {
295                                 /* recalc is set on 3d view changes for auto compo */
296                                 if(snode->recalc) {
297                                         snode->recalc= 0;
298                                         node_render_changed_exec((struct bContext*)C, NULL);
299                                 }
300                                 else 
301                                         snode_composite_job(C, sa);
302                         }
303                 }
304                 else if(snode->treetype==NTREE_TEXTURE) {
305                         Tex *tex= (Tex *)snode->id;
306                         if(tex->use_nodes) {
307                                 ED_preview_shader_job(C, sa, snode->id, NULL, NULL, 100, 100, PR_NODE_RENDER);
308                         }
309                 }
310         }
311 }
312
313 static SpaceLink *node_duplicate(SpaceLink *sl)
314 {
315         SpaceNode *snoden= MEM_dupallocN(sl);
316         
317         /* clear or remove stuff from old */
318         snoden->nodetree= NULL;
319         snoden->linkdrag.first= snoden->linkdrag.last= NULL;
320         
321         return (SpaceLink *)snoden;
322 }
323
324
325 /* add handlers, stuff you only do once or on area/region changes */
326 static void node_buttons_area_init(wmWindowManager *wm, ARegion *ar)
327 {
328         wmKeyMap *keymap;
329
330         ED_region_panels_init(wm, ar);
331         
332         keymap= WM_keymap_find(wm->defaultconf, "Node Generic", SPACE_NODE, 0);
333         WM_event_add_keymap_handler(&ar->handlers, keymap);
334 }
335
336 static void node_buttons_area_draw(const bContext *C, ARegion *ar)
337 {
338         ED_region_panels(C, ar, 1, NULL, -1);
339 }
340
341 /* Initialise main area, setting handlers. */
342 static void node_main_area_init(wmWindowManager *wm, ARegion *ar)
343 {
344         wmKeyMap *keymap;
345         ListBase *lb;
346         
347         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);
348         
349         /* own keymaps */
350         keymap= WM_keymap_find(wm->defaultconf, "Node Generic", SPACE_NODE, 0);
351         WM_event_add_keymap_handler(&ar->handlers, keymap);
352         
353         keymap= WM_keymap_find(wm->defaultconf, "Node Editor", SPACE_NODE, 0);
354         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
355         
356         /* add drop boxes */
357         lb = WM_dropboxmap_find("Node Editor", SPACE_NODE, RGN_TYPE_WINDOW);
358         
359         WM_event_add_dropbox_handler(&ar->handlers, lb);
360 }
361
362 static void node_main_area_draw(const bContext *C, ARegion *ar)
363 {
364         View2D *v2d= &ar->v2d;
365         
366         drawnodespace(C, ar, v2d);
367 }
368
369
370 /* ************* dropboxes ************* */
371
372 static int node_drop_poll(bContext *UNUSED(C), wmDrag *drag, wmEvent *UNUSED(event))
373 {
374         if(drag->type==WM_DRAG_ID) {
375                 ID *id= (ID *)drag->poin;
376                 if( GS(id->name)==ID_IM )
377                         return 1;
378         }
379         else if(drag->type==WM_DRAG_PATH){
380                 if(ELEM(drag->icon, 0, ICON_FILE_IMAGE))        /* rule might not work? */
381                         return 1;
382         }
383         return 0;
384 }
385
386 static void node_id_path_drop_copy(wmDrag *drag, wmDropBox *drop)
387 {
388         ID *id= (ID *)drag->poin;
389         
390         if(id) {
391                 RNA_string_set(drop->ptr, "name", id->name+2);
392         }
393         if (drag->path[0]) {
394                 RNA_string_set(drop->ptr, "filepath", drag->path);
395         }
396 }
397
398 /* this region dropbox definition */
399 static void node_dropboxes(void)
400 {
401         ListBase *lb= WM_dropboxmap_find("Node Editor", SPACE_NODE, RGN_TYPE_WINDOW);
402         
403         WM_dropbox_add(lb, "NODE_OT_add_file", node_drop_poll, node_id_path_drop_copy);
404         
405 }
406
407 /* ************* end drop *********** */
408
409
410 /* add handlers, stuff you only do once or on area/region changes */
411 static void node_header_area_init(wmWindowManager *UNUSED(wm), ARegion *ar)
412 {
413         ED_region_header_init(ar);
414 }
415
416 static void node_header_area_draw(const bContext *C, ARegion *ar)
417 {
418         SpaceNode *snode= CTX_wm_space_node(C);
419         Scene *scene= CTX_data_scene(C);
420
421         /* find and set the context */
422         snode_set_context(snode, scene);
423
424         ED_region_header(C, ar);
425 }
426
427 /* used for header + main area */
428 static void node_region_listener(ARegion *ar, wmNotifier *wmn)
429 {
430         /* context changes */
431         switch(wmn->category) {
432                 case NC_SPACE:
433                         if(wmn->data==ND_SPACE_NODE)
434                                 ED_region_tag_redraw(ar);
435                         break;
436                 case NC_SCREEN:
437                         if(wmn->data == ND_GPENCIL)     
438                                 ED_region_tag_redraw(ar);
439                         break;
440                 case NC_SCENE:
441                 case NC_MATERIAL:
442                 case NC_TEXTURE:
443                 case NC_NODE:
444                         ED_region_tag_redraw(ar);
445                         break;
446                 case NC_OBJECT:
447                         if(wmn->data==ND_OB_SHADING)
448                                 ED_region_tag_redraw(ar);
449                         break;
450                 case NC_ID:
451                         if(wmn->action == NA_RENAME)
452                                 ED_region_tag_redraw(ar);
453                         break;
454         }
455 }
456
457 const char *node_context_dir[] = {"selected_nodes", NULL};
458
459 static int node_context(const bContext *C, const char *member, bContextDataResult *result)
460 {
461         SpaceNode *snode= CTX_wm_space_node(C);
462         
463         if(CTX_data_dir(member)) {
464                 CTX_data_dir_set(result, node_context_dir);
465                 return 1;
466         }
467         else if(CTX_data_equals(member, "selected_nodes")) {
468                 bNode *node;
469                 
470                 if(snode->edittree) {
471                         for(node=snode->edittree->nodes.last; node; node=node->prev) {
472                                 if(node->flag & NODE_SELECT) {
473                                         CTX_data_list_add(result, &snode->edittree->id, &RNA_Node, node);
474                                 }
475                         }
476                 }
477                 CTX_data_type_set(result, CTX_DATA_TYPE_COLLECTION);
478                 return 1;
479         }
480         else if(CTX_data_equals(member, "active_node")) {
481                 bNode *node;
482                 
483                 if(snode->edittree) {
484                         for(node=snode->edittree->nodes.last; node; node=node->prev) {
485                                 if(node->flag & NODE_ACTIVE) {
486                                         CTX_data_pointer_set(result, &snode->edittree->id, &RNA_Node, node);
487                                         break;
488                                 }
489                         }
490                 }
491                 CTX_data_type_set(result, CTX_DATA_TYPE_POINTER);
492                 return 1;
493         }
494         
495         return 0;
496 }
497
498 /* only called once, from space/spacetypes.c */
499 void ED_spacetype_node(void)
500 {
501         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype node");
502         ARegionType *art;
503         
504         st->spaceid= SPACE_NODE;
505         strncpy(st->name, "Node", BKE_ST_MAXNAME);
506         
507         st->new= node_new;
508         st->free= node_free;
509         st->init= node_init;
510         st->duplicate= node_duplicate;
511         st->operatortypes= node_operatortypes;
512         st->keymap= node_keymap;
513         st->listener= node_area_listener;
514         st->refresh= node_area_refresh;
515         st->context= node_context;
516         st->dropboxes = node_dropboxes;
517         
518         /* regions: main window */
519         art= MEM_callocN(sizeof(ARegionType), "spacetype node region");
520         art->regionid = RGN_TYPE_WINDOW;
521         art->init= node_main_area_init;
522         art->draw= node_main_area_draw;
523         art->listener= node_region_listener;
524         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_FRAMES|ED_KEYMAP_GPENCIL;
525
526         BLI_addhead(&st->regiontypes, art);
527         
528         /* regions: header */
529         art= MEM_callocN(sizeof(ARegionType), "spacetype node region");
530         art->regionid = RGN_TYPE_HEADER;
531         art->prefsizey= HEADERY;
532         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_FRAMES|ED_KEYMAP_HEADER;
533         art->listener= node_region_listener;
534         art->init= node_header_area_init;
535         art->draw= node_header_area_draw;
536         
537         BLI_addhead(&st->regiontypes, art);
538
539         node_menus_register();
540         
541         /* regions: listview/buttons */
542         art= MEM_callocN(sizeof(ARegionType), "spacetype node region");
543         art->regionid = RGN_TYPE_UI;
544         art->prefsizex= 180; // XXX
545         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_FRAMES;
546         art->listener= node_region_listener;
547         art->init= node_buttons_area_init;
548         art->draw= node_buttons_area_draw;
549         BLI_addhead(&st->regiontypes, art);
550         
551         node_buttons_register(art);
552         
553         BKE_spacetype_register(st);
554 }
555