Merge branch 'blender2.7'
[blender.git] / source / blender / editors / render / render_view.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edrend
22  */
23
24 #include <string.h>
25 #include <stddef.h>
26
27 #include "BLI_utildefines.h"
28
29 #include "DNA_scene_types.h"
30 #include "DNA_userdef_types.h"
31
32 #include "BKE_context.h"
33 #include "BKE_image.h"
34 #include "BKE_global.h"
35 #include "BKE_main.h"
36 #include "BKE_screen.h"
37 #include "BKE_report.h"
38
39 #include "WM_api.h"
40 #include "WM_types.h"
41
42 #include "ED_screen.h"
43 #include "UI_interface.h"
44
45 #include "wm_window.h"
46
47 #include "render_intern.h"
48
49 /*********************** utilities for finding areas *************************/
50
51 /* returns biggest area that is not uv/image editor. Note that it uses buttons */
52 /* window as the last possible alternative.                                    */
53 /* would use BKE_screen_find_big_area(...) but this is too specific            */
54 static ScrArea *biggest_non_image_area(bContext *C)
55 {
56   bScreen *sc = CTX_wm_screen(C);
57   ScrArea *sa, *big = NULL;
58   int size, maxsize = 0, bwmaxsize = 0;
59   short foundwin = 0;
60
61   for (sa = sc->areabase.first; sa; sa = sa->next) {
62     if (sa->winx > 30 && sa->winy > 30) {
63       size = sa->winx * sa->winy;
64       if (!sa->full && sa->spacetype == SPACE_PROPERTIES) {
65         if (foundwin == 0 && size > bwmaxsize) {
66           bwmaxsize = size;
67           big = sa;
68         }
69       }
70       else if (sa->spacetype != SPACE_IMAGE && size > maxsize) {
71         maxsize = size;
72         big = sa;
73         foundwin = 1;
74       }
75     }
76   }
77
78   return big;
79 }
80
81 static ScrArea *find_area_showing_r_result(bContext *C, Scene *scene, wmWindow **win)
82 {
83   wmWindowManager *wm = CTX_wm_manager(C);
84   ScrArea *sa = NULL;
85   SpaceImage *sima;
86
87   /* find an imagewindow showing render result */
88   for (*win = wm->windows.first; *win; *win = (*win)->next) {
89     if (WM_window_get_active_scene(*win) == scene) {
90       const bScreen *screen = WM_window_get_active_screen(*win);
91
92       for (sa = screen->areabase.first; sa; sa = sa->next) {
93         if (sa->spacetype == SPACE_IMAGE) {
94           sima = sa->spacedata.first;
95           if (sima->image && sima->image->type == IMA_TYPE_R_RESULT) {
96             break;
97           }
98         }
99       }
100       if (sa) {
101         break;
102       }
103     }
104   }
105
106   return sa;
107 }
108
109 static ScrArea *find_area_image_empty(bContext *C)
110 {
111   bScreen *sc = CTX_wm_screen(C);
112   ScrArea *sa;
113   SpaceImage *sima;
114
115   /* find an imagewindow showing render result */
116   for (sa = sc->areabase.first; sa; sa = sa->next) {
117     if (sa->spacetype == SPACE_IMAGE) {
118       sima = sa->spacedata.first;
119       if (!sima->image) {
120         break;
121       }
122     }
123   }
124
125   return sa;
126 }
127
128 /********************** open image editor for render *************************/
129
130 /* new window uses x,y to set position */
131 ScrArea *render_view_open(bContext *C, int mx, int my, ReportList *reports)
132 {
133   Main *bmain = CTX_data_main(C);
134   Scene *scene = CTX_data_scene(C);
135   wmWindow *win = NULL;
136   ScrArea *sa = NULL;
137   SpaceImage *sima;
138   bool area_was_image = false;
139
140   if (scene->r.displaymode == R_OUTPUT_NONE) {
141     return NULL;
142   }
143
144   if (scene->r.displaymode == R_OUTPUT_WINDOW) {
145     int sizex = 30 * UI_DPI_FAC + (scene->r.xsch * scene->r.size) / 100;
146     int sizey = 60 * UI_DPI_FAC + (scene->r.ysch * scene->r.size) / 100;
147
148     /* arbitrary... miniature image window views don't make much sense */
149     if (sizex < 320) {
150       sizex = 320;
151     }
152     if (sizey < 256) {
153       sizey = 256;
154     }
155
156     /* changes context! */
157     if (WM_window_open_temp(C, mx, my, sizex, sizey, WM_WINDOW_RENDER) == NULL) {
158       BKE_report(reports, RPT_ERROR, "Failed to open window!");
159       return NULL;
160     }
161
162     sa = CTX_wm_area(C);
163   }
164   else if (scene->r.displaymode == R_OUTPUT_SCREEN) {
165     sa = CTX_wm_area(C);
166
167     /* if the active screen is already in fullscreen mode, skip this and
168      * unset the area, so that the fullscreen area is just changed later */
169     if (sa && sa->full) {
170       sa = NULL;
171     }
172     else {
173       if (sa && sa->spacetype == SPACE_IMAGE) {
174         area_was_image = true;
175       }
176
177       /* this function returns with changed context */
178       sa = ED_screen_full_newspace(C, sa, SPACE_IMAGE);
179     }
180   }
181
182   if (!sa) {
183     sa = find_area_showing_r_result(C, scene, &win);
184     if (sa == NULL) {
185       sa = find_area_image_empty(C);
186     }
187
188     /* if area found in other window, we make that one show in front */
189     if (win && win != CTX_wm_window(C)) {
190       wm_window_raise(win);
191     }
192
193     if (sa == NULL) {
194       /* find largest open non-image area */
195       sa = biggest_non_image_area(C);
196       if (sa) {
197         ED_area_newspace(C, sa, SPACE_IMAGE, true);
198         sima = sa->spacedata.first;
199
200         /* makes ESC go back to prev space */
201         sima->flag |= SI_PREVSPACE;
202
203         /* we already had a fullscreen here -> mark new space as a stacked fullscreen */
204         if (sa->full) {
205           sa->flag |= (AREA_FLAG_STACKED_FULLSCREEN | AREA_FLAG_TEMP_TYPE);
206         }
207       }
208       else {
209         /* use any area of decent size */
210         sa = BKE_screen_find_big_area(CTX_wm_screen(C), SPACE_TYPE_ANY, 0);
211         if (sa->spacetype != SPACE_IMAGE) {
212           // XXX newspace(sa, SPACE_IMAGE);
213           sima = sa->spacedata.first;
214
215           /* makes ESC go back to prev space */
216           sima->flag |= SI_PREVSPACE;
217         }
218       }
219     }
220   }
221   sima = sa->spacedata.first;
222
223   /* get the correct image, and scale it */
224   sima->image = BKE_image_verify_viewer(bmain, IMA_TYPE_R_RESULT, "Render Result");
225
226   /* if we're rendering to full screen, set appropriate hints on image editor
227    * so it can restore properly on pressing esc */
228   if (sa->full) {
229     sima->flag |= SI_FULLWINDOW;
230
231     /* Tell the image editor to revert to previous space in space list on close
232      * _only_ if it wasn't already an image editor when the render was invoked */
233     if (area_was_image == 0) {
234       sima->flag |= SI_PREVSPACE;
235     }
236     else {
237       /* Leave it alone so the image editor will just go back from
238        * full screen to the original tiled setup */
239     }
240   }
241
242   return sa;
243 }
244
245 /*************************** cancel render viewer **********************/
246
247 static int render_view_cancel_exec(bContext *C, wmOperator *UNUSED(op))
248 {
249   wmWindow *win = CTX_wm_window(C);
250   ScrArea *sa = CTX_wm_area(C);
251   SpaceImage *sima = sa->spacedata.first;
252
253   /* ensure image editor fullscreen and area fullscreen states are in sync */
254   if ((sima->flag & SI_FULLWINDOW) && !sa->full) {
255     sima->flag &= ~SI_FULLWINDOW;
256   }
257
258   /* test if we have a temp screen in front */
259   if (WM_window_is_temp_screen(win)) {
260     wm_window_lower(win);
261     return OPERATOR_FINISHED;
262   }
263   /* determine if render already shows */
264   else if (sima->flag & SI_PREVSPACE) {
265     sima->flag &= ~SI_PREVSPACE;
266
267     if (sima->flag & SI_FULLWINDOW) {
268       sima->flag &= ~SI_FULLWINDOW;
269       ED_screen_full_prevspace(C, sa);
270     }
271     else {
272       ED_area_prevspace(C, sa);
273     }
274
275     return OPERATOR_FINISHED;
276   }
277   else if (sima->flag & SI_FULLWINDOW) {
278     sima->flag &= ~SI_FULLWINDOW;
279     ED_screen_state_toggle(C, win, sa, SCREENMAXIMIZED);
280     return OPERATOR_FINISHED;
281   }
282
283   return OPERATOR_PASS_THROUGH;
284 }
285
286 void RENDER_OT_view_cancel(struct wmOperatorType *ot)
287 {
288   /* identifiers */
289   ot->name = "Cancel Render View";
290   ot->description = "Cancel show render view";
291   ot->idname = "RENDER_OT_view_cancel";
292
293   /* api callbacks */
294   ot->exec = render_view_cancel_exec;
295   ot->poll = ED_operator_image_active;
296 }
297
298 /************************* show render viewer *****************/
299
300 static int render_view_show_invoke(bContext *C, wmOperator *op, const wmEvent *event)
301 {
302   wmWindow *wincur = CTX_wm_window(C);
303
304   /* test if we have currently a temp screen active */
305   if (WM_window_is_temp_screen(wincur)) {
306     wm_window_lower(wincur);
307   }
308   else {
309     wmWindow *win, *winshow;
310     ScrArea *sa = find_area_showing_r_result(C, CTX_data_scene(C), &winshow);
311
312     /* is there another window on current scene showing result? */
313     for (win = CTX_wm_manager(C)->windows.first; win; win = win->next) {
314       const bScreen *sc = WM_window_get_active_screen(win);
315
316       if ((WM_window_is_temp_screen(win) &&
317            ((ScrArea *)sc->areabase.first)->spacetype == SPACE_IMAGE) ||
318           (win == winshow && winshow != wincur)) {
319         wm_window_raise(win);
320         return OPERATOR_FINISHED;
321       }
322     }
323
324     /* determine if render already shows */
325     if (sa) {
326       /* but don't close it when rendering */
327       if (G.is_rendering == false) {
328         SpaceImage *sima = sa->spacedata.first;
329
330         if (sima->flag & SI_PREVSPACE) {
331           sima->flag &= ~SI_PREVSPACE;
332
333           if (sima->flag & SI_FULLWINDOW) {
334             sima->flag &= ~SI_FULLWINDOW;
335             ED_screen_full_prevspace(C, sa);
336           }
337           else {
338             ED_area_prevspace(C, sa);
339           }
340         }
341       }
342     }
343     else {
344       render_view_open(C, event->x, event->y, op->reports);
345     }
346   }
347
348   return OPERATOR_FINISHED;
349 }
350
351 void RENDER_OT_view_show(struct wmOperatorType *ot)
352 {
353   /* identifiers */
354   ot->name = "Show/Hide Render View";
355   ot->description = "Toggle show render view";
356   ot->idname = "RENDER_OT_view_show";
357
358   /* api callbacks */
359   ot->invoke = render_view_show_invoke;
360   ot->poll = ED_operator_screenactive;
361 }