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