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