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