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       if (sa)
100         break;
101     }
102   }
103
104   return sa;
105 }
106
107 static ScrArea *find_area_image_empty(bContext *C)
108 {
109   bScreen *sc = CTX_wm_screen(C);
110   ScrArea *sa;
111   SpaceImage *sima;
112
113   /* find an imagewindow showing render result */
114   for (sa = sc->areabase.first; sa; sa = sa->next) {
115     if (sa->spacetype == SPACE_IMAGE) {
116       sima = sa->spacedata.first;
117       if (!sima->image)
118         break;
119     }
120   }
121
122   return sa;
123 }
124
125 /********************** open image editor for render *************************/
126
127 /* new window uses x,y to set position */
128 ScrArea *render_view_open(bContext *C, int mx, int my, ReportList *reports)
129 {
130   Main *bmain = CTX_data_main(C);
131   Scene *scene = CTX_data_scene(C);
132   wmWindow *win = NULL;
133   ScrArea *sa = NULL;
134   SpaceImage *sima;
135   bool area_was_image = false;
136
137   if (scene->r.displaymode == R_OUTPUT_NONE)
138     return NULL;
139
140   if (scene->r.displaymode == R_OUTPUT_WINDOW) {
141     int sizex = 30 * UI_DPI_FAC + (scene->r.xsch * scene->r.size) / 100;
142     int sizey = 60 * UI_DPI_FAC + (scene->r.ysch * scene->r.size) / 100;
143
144     /* arbitrary... miniature image window views don't make much sense */
145     if (sizex < 320)
146       sizex = 320;
147     if (sizey < 256)
148       sizey = 256;
149
150     /* changes context! */
151     if (WM_window_open_temp(C, mx, my, sizex, sizey, WM_WINDOW_RENDER) == NULL) {
152       BKE_report(reports, RPT_ERROR, "Failed to open window!");
153       return NULL;
154     }
155
156     sa = CTX_wm_area(C);
157   }
158   else if (scene->r.displaymode == R_OUTPUT_SCREEN) {
159     sa = CTX_wm_area(C);
160
161     /* if the active screen is already in fullscreen mode, skip this and
162      * unset the area, so that the fullscreen area is just changed later */
163     if (sa && sa->full) {
164       sa = NULL;
165     }
166     else {
167       if (sa && sa->spacetype == SPACE_IMAGE)
168         area_was_image = true;
169
170       /* this function returns with changed context */
171       sa = ED_screen_full_newspace(C, sa, SPACE_IMAGE);
172     }
173   }
174
175   if (!sa) {
176     sa = find_area_showing_r_result(C, scene, &win);
177     if (sa == NULL)
178       sa = find_area_image_empty(C);
179
180     /* if area found in other window, we make that one show in front */
181     if (win && win != CTX_wm_window(C))
182       wm_window_raise(win);
183
184     if (sa == NULL) {
185       /* find largest open non-image area */
186       sa = biggest_non_image_area(C);
187       if (sa) {
188         ED_area_newspace(C, sa, SPACE_IMAGE, true);
189         sima = sa->spacedata.first;
190
191         /* makes ESC go back to prev space */
192         sima->flag |= SI_PREVSPACE;
193
194         /* we already had a fullscreen here -> mark new space as a stacked fullscreen */
195         if (sa->full) {
196           sa->flag |= (AREA_FLAG_STACKED_FULLSCREEN | AREA_FLAG_TEMP_TYPE);
197         }
198       }
199       else {
200         /* use any area of decent size */
201         sa = BKE_screen_find_big_area(CTX_wm_screen(C), SPACE_TYPE_ANY, 0);
202         if (sa->spacetype != SPACE_IMAGE) {
203           // XXX newspace(sa, SPACE_IMAGE);
204           sima = sa->spacedata.first;
205
206           /* makes ESC go back to prev space */
207           sima->flag |= SI_PREVSPACE;
208         }
209       }
210     }
211   }
212   sima = sa->spacedata.first;
213
214   /* get the correct image, and scale it */
215   sima->image = BKE_image_verify_viewer(bmain, IMA_TYPE_R_RESULT, "Render Result");
216
217   /* if we're rendering to full screen, set appropriate hints on image editor
218    * so it can restore properly on pressing esc */
219   if (sa->full) {
220     sima->flag |= SI_FULLWINDOW;
221
222     /* Tell the image editor to revert to previous space in space list on close
223      * _only_ if it wasn't already an image editor when the render was invoked */
224     if (area_was_image == 0)
225       sima->flag |= SI_PREVSPACE;
226     else {
227       /* Leave it alone so the image editor will just go back from
228        * full screen to the original tiled setup */
229     }
230   }
231
232   return sa;
233 }
234
235 /*************************** cancel render viewer **********************/
236
237 static int render_view_cancel_exec(bContext *C, wmOperator *UNUSED(op))
238 {
239   wmWindow *win = CTX_wm_window(C);
240   ScrArea *sa = CTX_wm_area(C);
241   SpaceImage *sima = sa->spacedata.first;
242
243   /* ensure image editor fullscreen and area fullscreen states are in sync */
244   if ((sima->flag & SI_FULLWINDOW) && !sa->full) {
245     sima->flag &= ~SI_FULLWINDOW;
246   }
247
248   /* test if we have a temp screen in front */
249   if (WM_window_is_temp_screen(win)) {
250     wm_window_lower(win);
251     return OPERATOR_FINISHED;
252   }
253   /* determine if render already shows */
254   else if (sima->flag & SI_PREVSPACE) {
255     sima->flag &= ~SI_PREVSPACE;
256
257     if (sima->flag & SI_FULLWINDOW) {
258       sima->flag &= ~SI_FULLWINDOW;
259       ED_screen_full_prevspace(C, sa);
260     }
261     else {
262       ED_area_prevspace(C, sa);
263     }
264
265     return OPERATOR_FINISHED;
266   }
267   else if (sima->flag & SI_FULLWINDOW) {
268     sima->flag &= ~SI_FULLWINDOW;
269     ED_screen_state_toggle(C, win, sa, SCREENMAXIMIZED);
270     return OPERATOR_FINISHED;
271   }
272
273   return OPERATOR_PASS_THROUGH;
274 }
275
276 void RENDER_OT_view_cancel(struct wmOperatorType *ot)
277 {
278   /* identifiers */
279   ot->name = "Cancel Render View";
280   ot->description = "Cancel show render view";
281   ot->idname = "RENDER_OT_view_cancel";
282
283   /* api callbacks */
284   ot->exec = render_view_cancel_exec;
285   ot->poll = ED_operator_image_active;
286 }
287
288 /************************* show render viewer *****************/
289
290 static int render_view_show_invoke(bContext *C, wmOperator *op, const wmEvent *event)
291 {
292   wmWindow *wincur = CTX_wm_window(C);
293
294   /* test if we have currently a temp screen active */
295   if (WM_window_is_temp_screen(wincur)) {
296     wm_window_lower(wincur);
297   }
298   else {
299     wmWindow *win, *winshow;
300     ScrArea *sa = find_area_showing_r_result(C, CTX_data_scene(C), &winshow);
301
302     /* is there another window on current scene showing result? */
303     for (win = CTX_wm_manager(C)->windows.first; win; win = win->next) {
304       const bScreen *sc = WM_window_get_active_screen(win);
305
306       if ((WM_window_is_temp_screen(win) &&
307            ((ScrArea *)sc->areabase.first)->spacetype == SPACE_IMAGE) ||
308           (win == winshow && winshow != wincur)) {
309         wm_window_raise(win);
310         return OPERATOR_FINISHED;
311       }
312     }
313
314     /* determine if render already shows */
315     if (sa) {
316       /* but don't close it when rendering */
317       if (G.is_rendering == false) {
318         SpaceImage *sima = sa->spacedata.first;
319
320         if (sima->flag & SI_PREVSPACE) {
321           sima->flag &= ~SI_PREVSPACE;
322
323           if (sima->flag & SI_FULLWINDOW) {
324             sima->flag &= ~SI_FULLWINDOW;
325             ED_screen_full_prevspace(C, sa);
326           }
327           else {
328             ED_area_prevspace(C, sa);
329           }
330         }
331       }
332     }
333     else {
334       render_view_open(C, event->x, event->y, op->reports);
335     }
336   }
337
338   return OPERATOR_FINISHED;
339 }
340
341 void RENDER_OT_view_show(struct wmOperatorType *ot)
342 {
343   /* identifiers */
344   ot->name = "Show/Hide Render View";
345   ot->description = "Toggle show render view";
346   ot->idname = "RENDER_OT_view_show";
347
348   /* api callbacks */
349   ot->invoke = render_view_show_invoke;
350   ot->poll = ED_operator_screenactive;
351 }