UI: ignore events in empty region overlap areas
[blender.git] / source / blender / editors / screen / screen_edit.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 edscr
22  */
23
24 #include <string.h>
25 #include <math.h>
26
27 #include "MEM_guardedalloc.h"
28
29 #include "DNA_object_types.h"
30 #include "DNA_scene_types.h"
31 #include "DNA_workspace_types.h"
32 #include "DNA_userdef_types.h"
33
34 #include "BLI_blenlib.h"
35 #include "BLI_utildefines.h"
36
37 #include "BKE_context.h"
38 #include "BKE_global.h"
39 #include "BKE_icons.h"
40 #include "BKE_image.h"
41 #include "BKE_layer.h"
42 #include "BKE_library.h"
43 #include "BKE_main.h"
44 #include "BKE_node.h"
45 #include "BKE_screen.h"
46 #include "BKE_scene.h"
47 #include "BKE_workspace.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 #include "ED_object.h"
53 #include "ED_screen.h"
54 #include "ED_screen_types.h"
55 #include "ED_clip.h"
56 #include "ED_node.h"
57 #include "ED_render.h"
58
59 #include "UI_interface.h"
60
61 #include "WM_message.h"
62
63 #include "DEG_depsgraph_query.h"
64
65 #include "screen_intern.h" /* own module include */
66
67 /* adds no space data */
68 static ScrArea *screen_addarea_ex(ScrAreaMap *area_map,
69                                   ScrVert *bottom_left,
70                                   ScrVert *top_left,
71                                   ScrVert *top_right,
72                                   ScrVert *bottom_right,
73                                   short spacetype)
74 {
75   ScrArea *sa = MEM_callocN(sizeof(ScrArea), "addscrarea");
76
77   sa->v1 = bottom_left;
78   sa->v2 = top_left;
79   sa->v3 = top_right;
80   sa->v4 = bottom_right;
81   sa->spacetype = spacetype;
82
83   BLI_addtail(&area_map->areabase, sa);
84
85   return sa;
86 }
87 static ScrArea *screen_addarea(bScreen *sc,
88                                ScrVert *left_bottom,
89                                ScrVert *left_top,
90                                ScrVert *right_top,
91                                ScrVert *right_bottom,
92                                short spacetype)
93 {
94   return screen_addarea_ex(
95       AREAMAP_FROM_SCREEN(sc), left_bottom, left_top, right_top, right_bottom, spacetype);
96 }
97
98 static void screen_delarea(bContext *C, bScreen *sc, ScrArea *sa)
99 {
100
101   ED_area_exit(C, sa);
102
103   BKE_screen_area_free(sa);
104
105   BLI_remlink(&sc->areabase, sa);
106   MEM_freeN(sa);
107 }
108
109 ScrArea *area_split(const wmWindow *win, bScreen *sc, ScrArea *sa, char dir, float fac, int merge)
110 {
111   ScrArea *newa = NULL;
112   ScrVert *sv1, *sv2;
113   short split;
114   rcti window_rect;
115
116   if (sa == NULL) {
117     return NULL;
118   }
119
120   WM_window_rect_calc(win, &window_rect);
121
122   split = screen_geom_find_area_split_point(sa, &window_rect, dir, fac);
123   if (split == 0) {
124     return NULL;
125   }
126
127   /* note regarding (fac > 0.5f) checks below.
128    * normally it shouldn't matter which is used since the copy should match the original
129    * however with viewport rendering and python console this isn't the case. - campbell */
130
131   if (dir == 'h') {
132     /* new vertices */
133     sv1 = screen_geom_vertex_add(sc, sa->v1->vec.x, split);
134     sv2 = screen_geom_vertex_add(sc, sa->v4->vec.x, split);
135
136     /* new edges */
137     screen_geom_edge_add(sc, sa->v1, sv1);
138     screen_geom_edge_add(sc, sv1, sa->v2);
139     screen_geom_edge_add(sc, sa->v3, sv2);
140     screen_geom_edge_add(sc, sv2, sa->v4);
141     screen_geom_edge_add(sc, sv1, sv2);
142
143     if (fac > 0.5f) {
144       /* new areas: top */
145       newa = screen_addarea(sc, sv1, sa->v2, sa->v3, sv2, sa->spacetype);
146
147       /* area below */
148       sa->v2 = sv1;
149       sa->v3 = sv2;
150     }
151     else {
152       /* new areas: bottom */
153       newa = screen_addarea(sc, sa->v1, sv1, sv2, sa->v4, sa->spacetype);
154
155       /* area above */
156       sa->v1 = sv1;
157       sa->v4 = sv2;
158     }
159
160     ED_area_data_copy(newa, sa, true);
161   }
162   else {
163     /* new vertices */
164     sv1 = screen_geom_vertex_add(sc, split, sa->v1->vec.y);
165     sv2 = screen_geom_vertex_add(sc, split, sa->v2->vec.y);
166
167     /* new edges */
168     screen_geom_edge_add(sc, sa->v1, sv1);
169     screen_geom_edge_add(sc, sv1, sa->v4);
170     screen_geom_edge_add(sc, sa->v2, sv2);
171     screen_geom_edge_add(sc, sv2, sa->v3);
172     screen_geom_edge_add(sc, sv1, sv2);
173
174     if (fac > 0.5f) {
175       /* new areas: right */
176       newa = screen_addarea(sc, sv1, sv2, sa->v3, sa->v4, sa->spacetype);
177
178       /* area left */
179       sa->v3 = sv2;
180       sa->v4 = sv1;
181     }
182     else {
183       /* new areas: left */
184       newa = screen_addarea(sc, sa->v1, sa->v2, sv2, sv1, sa->spacetype);
185
186       /* area right */
187       sa->v1 = sv1;
188       sa->v2 = sv2;
189     }
190
191     ED_area_data_copy(newa, sa, true);
192   }
193
194   /* remove double vertices en edges */
195   if (merge) {
196     BKE_screen_remove_double_scrverts(sc);
197   }
198   BKE_screen_remove_double_scredges(sc);
199   BKE_screen_remove_unused_scredges(sc);
200
201   return newa;
202 }
203
204 /**
205  * Empty screen, with 1 dummy area without spacedata. Uses window size.
206  */
207 bScreen *screen_add(Main *bmain, const char *name, const rcti *rect)
208 {
209   bScreen *sc;
210   ScrVert *sv1, *sv2, *sv3, *sv4;
211
212   sc = BKE_libblock_alloc(bmain, ID_SCR, name, 0);
213   sc->do_refresh = true;
214   sc->redraws_flag = TIME_ALL_3D_WIN | TIME_ALL_ANIM_WIN;
215
216   sv1 = screen_geom_vertex_add(sc, rect->xmin, rect->ymin);
217   sv2 = screen_geom_vertex_add(sc, rect->xmin, rect->ymax - 1);
218   sv3 = screen_geom_vertex_add(sc, rect->xmax - 1, rect->ymax - 1);
219   sv4 = screen_geom_vertex_add(sc, rect->xmax - 1, rect->ymin);
220
221   screen_geom_edge_add(sc, sv1, sv2);
222   screen_geom_edge_add(sc, sv2, sv3);
223   screen_geom_edge_add(sc, sv3, sv4);
224   screen_geom_edge_add(sc, sv4, sv1);
225
226   /* dummy type, no spacedata */
227   screen_addarea(sc, sv1, sv2, sv3, sv4, SPACE_EMPTY);
228
229   return sc;
230 }
231
232 void screen_data_copy(bScreen *to, bScreen *from)
233 {
234   ScrVert *s1, *s2;
235   ScrEdge *se;
236   ScrArea *sa, *saf;
237
238   /* free contents of 'to', is from blenkernel screen.c */
239   BKE_screen_free(to);
240
241   to->flag = from->flag;
242
243   BLI_duplicatelist(&to->vertbase, &from->vertbase);
244   BLI_duplicatelist(&to->edgebase, &from->edgebase);
245   BLI_duplicatelist(&to->areabase, &from->areabase);
246   BLI_listbase_clear(&to->regionbase);
247
248   s2 = to->vertbase.first;
249   for (s1 = from->vertbase.first; s1; s1 = s1->next, s2 = s2->next) {
250     s1->newv = s2;
251   }
252
253   for (se = to->edgebase.first; se; se = se->next) {
254     se->v1 = se->v1->newv;
255     se->v2 = se->v2->newv;
256     BKE_screen_sort_scrvert(&(se->v1), &(se->v2));
257   }
258
259   saf = from->areabase.first;
260   for (sa = to->areabase.first; sa; sa = sa->next, saf = saf->next) {
261     sa->v1 = sa->v1->newv;
262     sa->v2 = sa->v2->newv;
263     sa->v3 = sa->v3->newv;
264     sa->v4 = sa->v4->newv;
265
266     BLI_listbase_clear(&sa->spacedata);
267     BLI_listbase_clear(&sa->regionbase);
268     BLI_listbase_clear(&sa->actionzones);
269     BLI_listbase_clear(&sa->handlers);
270
271     ED_area_data_copy(sa, saf, true);
272   }
273
274   /* put at zero (needed?) */
275   for (s1 = from->vertbase.first; s1; s1 = s1->next) {
276     s1->newv = NULL;
277   }
278 }
279
280 /**
281  * Prepare a newly created screen for initializing it as active screen.
282  */
283 void screen_new_activate_prepare(const wmWindow *win, bScreen *screen_new)
284 {
285   screen_new->winid = win->winid;
286   screen_new->do_refresh = true;
287   screen_new->do_draw = true;
288 }
289
290 /* with sa as center, sb is located at: 0=W, 1=N, 2=E, 3=S */
291 /* -1 = not valid check */
292 /* used with join operator */
293 int area_getorientation(ScrArea *sa, ScrArea *sb)
294 {
295   ScrVert *sav1, *sav2, *sav3, *sav4;
296   ScrVert *sbv1, *sbv2, *sbv3, *sbv4;
297
298   if (sa == NULL || sb == NULL) {
299     return -1;
300   }
301
302   sav1 = sa->v1;
303   sav2 = sa->v2;
304   sav3 = sa->v3;
305   sav4 = sa->v4;
306   sbv1 = sb->v1;
307   sbv2 = sb->v2;
308   sbv3 = sb->v3;
309   sbv4 = sb->v4;
310
311   if (sav1 == sbv4 && sav2 == sbv3) { /* sa to right of sb = W */
312     return 0;
313   }
314   else if (sav2 == sbv1 && sav3 == sbv4) { /* sa to bottom of sb = N */
315     return 1;
316   }
317   else if (sav3 == sbv2 && sav4 == sbv1) { /* sa to left of sb = E */
318     return 2;
319   }
320   else if (sav1 == sbv2 && sav4 == sbv3) { /* sa on top of sb = S*/
321     return 3;
322   }
323
324   return -1;
325 }
326
327 /* Helper function to join 2 areas, it has a return value, 0=failed 1=success
328  * used by the split, join operators
329  */
330 int screen_area_join(bContext *C, bScreen *scr, ScrArea *sa1, ScrArea *sa2)
331 {
332   int dir;
333
334   dir = area_getorientation(sa1, sa2);
335   /*printf("dir is : %i\n", dir);*/
336
337   if (dir == -1) {
338     return 0;
339   }
340
341   if (dir == 0) {
342     sa1->v1 = sa2->v1;
343     sa1->v2 = sa2->v2;
344     screen_geom_edge_add(scr, sa1->v2, sa1->v3);
345     screen_geom_edge_add(scr, sa1->v1, sa1->v4);
346   }
347   else if (dir == 1) {
348     sa1->v2 = sa2->v2;
349     sa1->v3 = sa2->v3;
350     screen_geom_edge_add(scr, sa1->v1, sa1->v2);
351     screen_geom_edge_add(scr, sa1->v3, sa1->v4);
352   }
353   else if (dir == 2) {
354     sa1->v3 = sa2->v3;
355     sa1->v4 = sa2->v4;
356     screen_geom_edge_add(scr, sa1->v2, sa1->v3);
357     screen_geom_edge_add(scr, sa1->v1, sa1->v4);
358   }
359   else if (dir == 3) {
360     sa1->v1 = sa2->v1;
361     sa1->v4 = sa2->v4;
362     screen_geom_edge_add(scr, sa1->v1, sa1->v2);
363     screen_geom_edge_add(scr, sa1->v3, sa1->v4);
364   }
365
366   screen_delarea(C, scr, sa2);
367   BKE_screen_remove_double_scrverts(scr);
368   /* Update preview thumbnail */
369   BKE_icon_changed(scr->id.icon_id);
370
371   return 1;
372 }
373
374 /* ****************** EXPORTED API TO OTHER MODULES *************************** */
375
376 /* screen sets cursor based on active region */
377 static void region_cursor_set(wmWindow *win, bool swin_changed)
378 {
379   bScreen *screen = WM_window_get_active_screen(win);
380
381   ED_screen_areas_iter(win, screen, sa)
382   {
383     for (ARegion *ar = sa->regionbase.first; ar; ar = ar->next) {
384       if (ar == screen->active_region) {
385         if (swin_changed || (ar->type && ar->type->event_cursor)) {
386           if (ar->gizmo_map != NULL) {
387             if (WM_gizmomap_cursor_set(ar->gizmo_map, win)) {
388               return;
389             }
390           }
391           ED_region_cursor_set(win, sa, ar);
392         }
393         return;
394       }
395     }
396   }
397 }
398
399 void ED_screen_do_listen(bContext *C, wmNotifier *note)
400 {
401   wmWindow *win = CTX_wm_window(C);
402   bScreen *screen = CTX_wm_screen(C);
403
404   /* generic notes */
405   switch (note->category) {
406     case NC_WM:
407       if (note->data == ND_FILEREAD) {
408         screen->do_draw = true;
409       }
410       break;
411     case NC_WINDOW:
412       screen->do_draw = true;
413       break;
414     case NC_SCREEN:
415       if (note->action == NA_EDITED) {
416         screen->do_draw = screen->do_refresh = true;
417       }
418       break;
419     case NC_SCENE:
420       if (note->data == ND_MODE) {
421         region_cursor_set(win, true);
422       }
423       break;
424   }
425 }
426
427 /* helper call for below, dpi changes headers */
428 static void screen_refresh_headersizes(void)
429 {
430   const ListBase *lb = BKE_spacetypes_list();
431   SpaceType *st;
432
433   for (st = lb->first; st; st = st->next) {
434     ARegionType *art;
435     art = BKE_regiontype_from_id(st, RGN_TYPE_HEADER);
436     if (art) {
437       art->prefsizey = ED_area_headersize();
438     }
439
440     art = BKE_regiontype_from_id(st, RGN_TYPE_TOOL_HEADER);
441     if (art) {
442       art->prefsizey = ED_area_headersize();
443     }
444
445     art = BKE_regiontype_from_id(st, RGN_TYPE_FOOTER);
446     if (art) {
447       art->prefsizey = ED_area_headersize();
448     }
449   }
450 }
451
452 /* make this screen usable */
453 /* for file read and first use, for scaling window, area moves */
454 void ED_screen_refresh(wmWindowManager *wm, wmWindow *win)
455 {
456   bScreen *screen = WM_window_get_active_screen(win);
457
458   /* exception for bg mode, we only need the screen context */
459   if (!G.background) {
460     /* header size depends on DPI, let's verify */
461     WM_window_set_dpi(win);
462
463     ED_screen_global_areas_refresh(win);
464     screen_refresh_headersizes();
465
466     screen_geom_vertices_scale(win, screen);
467
468     ED_screen_areas_iter(win, screen, area)
469     {
470       /* set spacetype and region callbacks, calls init() */
471       /* sets subwindows for regions, adds handlers */
472       ED_area_initialize(wm, win, area);
473     }
474
475     /* wake up animtimer */
476     if (screen->animtimer) {
477       WM_event_timer_sleep(wm, win, screen->animtimer, false);
478     }
479   }
480
481   if (G.debug & G_DEBUG_EVENTS) {
482     printf("%s: set screen\n", __func__);
483   }
484   screen->do_refresh = false;
485   /* prevent multiwin errors */
486   screen->winid = win->winid;
487
488   screen->context = ed_screen_context;
489 }
490
491 /* file read, set all screens, ... */
492 void ED_screens_initialize(Main *bmain, wmWindowManager *wm)
493 {
494   wmWindow *win;
495
496   for (win = wm->windows.first; win; win = win->next) {
497     if (BKE_workspace_active_get(win->workspace_hook) == NULL) {
498       BKE_workspace_active_set(win->workspace_hook, bmain->workspaces.first);
499     }
500
501     ED_screen_refresh(wm, win);
502     if (win->eventstate) {
503       ED_screen_set_active_region(NULL, win, &win->eventstate->x);
504     }
505   }
506
507   if (U.uiflag & USER_HEADER_FROM_PREF) {
508     for (bScreen *screen = bmain->screens.first; screen; screen = screen->id.next) {
509       BKE_screen_header_alignment_reset(screen);
510     }
511   }
512 }
513
514 void ED_screen_ensure_updated(wmWindowManager *wm, wmWindow *win, bScreen *screen)
515 {
516   if (screen->do_refresh) {
517     ED_screen_refresh(wm, win);
518   }
519 }
520
521 /* *********** exit calls are for closing running stuff ******** */
522
523 void ED_region_exit(bContext *C, ARegion *ar)
524 {
525   wmWindowManager *wm = CTX_wm_manager(C);
526   wmWindow *win = CTX_wm_window(C);
527   ARegion *prevar = CTX_wm_region(C);
528
529   if (ar->type && ar->type->exit) {
530     ar->type->exit(wm, ar);
531   }
532
533   CTX_wm_region_set(C, ar);
534
535   WM_event_remove_handlers(C, &ar->handlers);
536   WM_event_modal_handler_region_replace(win, ar, NULL);
537   WM_draw_region_free(ar);
538
539   if (ar->headerstr) {
540     MEM_freeN(ar->headerstr);
541     ar->headerstr = NULL;
542   }
543
544   if (ar->regiontimer) {
545     WM_event_remove_timer(wm, win, ar->regiontimer);
546     ar->regiontimer = NULL;
547   }
548
549   WM_msgbus_clear_by_owner(wm->message_bus, ar);
550
551   CTX_wm_region_set(C, prevar);
552 }
553
554 void ED_area_exit(bContext *C, ScrArea *sa)
555 {
556   wmWindowManager *wm = CTX_wm_manager(C);
557   wmWindow *win = CTX_wm_window(C);
558   ScrArea *prevsa = CTX_wm_area(C);
559   ARegion *ar;
560
561   if (sa->type && sa->type->exit) {
562     sa->type->exit(wm, sa);
563   }
564
565   CTX_wm_area_set(C, sa);
566
567   for (ar = sa->regionbase.first; ar; ar = ar->next) {
568     ED_region_exit(C, ar);
569   }
570
571   WM_event_remove_handlers(C, &sa->handlers);
572   WM_event_modal_handler_area_replace(win, sa, NULL);
573
574   CTX_wm_area_set(C, prevsa);
575 }
576
577 void ED_screen_exit(bContext *C, wmWindow *window, bScreen *screen)
578 {
579   wmWindowManager *wm = CTX_wm_manager(C);
580   wmWindow *prevwin = CTX_wm_window(C);
581
582   CTX_wm_window_set(C, window);
583
584   if (screen->animtimer) {
585     WM_event_remove_timer(wm, window, screen->animtimer);
586   }
587   screen->animtimer = NULL;
588   screen->scrubbing = false;
589
590   screen->active_region = NULL;
591
592   for (ARegion *ar = screen->regionbase.first; ar; ar = ar->next) {
593     ED_region_exit(C, ar);
594   }
595   for (ScrArea *sa = screen->areabase.first; sa; sa = sa->next) {
596     ED_area_exit(C, sa);
597   }
598   /* Don't use ED_screen_areas_iter here, it skips hidden areas. */
599   for (ScrArea *sa = window->global_areas.areabase.first; sa; sa = sa->next) {
600     ED_area_exit(C, sa);
601   }
602
603   /* mark it available for use for other windows */
604   screen->winid = 0;
605
606   if (!WM_window_is_temp_screen(prevwin)) {
607     /* use previous window if possible */
608     CTX_wm_window_set(C, prevwin);
609   }
610   else {
611     /* none otherwise */
612     CTX_wm_window_set(C, NULL);
613   }
614 }
615
616 /* *********************************** */
617
618 /* case when on area-edge or in azones, or outside window */
619 static void screen_cursor_set(wmWindow *win, const int xy[2])
620 {
621   const bScreen *screen = WM_window_get_active_screen(win);
622   AZone *az = NULL;
623   ScrArea *sa;
624
625   for (sa = screen->areabase.first; sa; sa = sa->next) {
626     if ((az = ED_area_actionzone_find_xy(sa, xy))) {
627       break;
628     }
629   }
630
631   if (sa) {
632     if (az->type == AZONE_AREA) {
633       WM_cursor_set(win, CURSOR_EDIT);
634     }
635     else if (az->type == AZONE_REGION) {
636       if (az->edge == AE_LEFT_TO_TOPRIGHT || az->edge == AE_RIGHT_TO_TOPLEFT) {
637         WM_cursor_set(win, CURSOR_X_MOVE);
638       }
639       else {
640         WM_cursor_set(win, CURSOR_Y_MOVE);
641       }
642     }
643   }
644   else {
645     ScrEdge *actedge = screen_geom_find_active_scredge(win, screen, xy[0], xy[1]);
646
647     if (actedge) {
648       if (screen_geom_edge_is_horizontal(actedge)) {
649         WM_cursor_set(win, CURSOR_Y_MOVE);
650       }
651       else {
652         WM_cursor_set(win, CURSOR_X_MOVE);
653       }
654     }
655     else {
656       WM_cursor_set(win, CURSOR_STD);
657     }
658   }
659 }
660
661 /* called in wm_event_system.c. sets state vars in screen, cursors */
662 /* event type is mouse move */
663 void ED_screen_set_active_region(bContext *C, wmWindow *win, const int xy[2])
664 {
665   bScreen *scr = WM_window_get_active_screen(win);
666
667   if (scr) {
668     ScrArea *sa = NULL;
669     ARegion *ar;
670     ARegion *old_ar = scr->active_region;
671
672     ED_screen_areas_iter(win, scr, area_iter)
673     {
674       if (xy[0] > area_iter->totrct.xmin && xy[0] < area_iter->totrct.xmax) {
675         if (xy[1] > area_iter->totrct.ymin && xy[1] < area_iter->totrct.ymax) {
676           if (ED_area_azones_update(area_iter, xy) == NULL) {
677             sa = area_iter;
678             break;
679           }
680         }
681       }
682     }
683     if (sa) {
684       /* make overlap active when mouse over */
685       for (ar = sa->regionbase.first; ar; ar = ar->next) {
686         if (ED_region_contains_xy(ar, xy)) {
687           scr->active_region = ar;
688           break;
689         }
690       }
691     }
692     else {
693       scr->active_region = NULL;
694     }
695
696     /* check for redraw headers */
697     if (old_ar != scr->active_region) {
698
699       ED_screen_areas_iter(win, scr, area_iter)
700       {
701         bool do_draw = false;
702
703         for (ar = area_iter->regionbase.first; ar; ar = ar->next) {
704           if (ar == old_ar || ar == scr->active_region) {
705             do_draw = true;
706           }
707         }
708
709         if (do_draw) {
710           for (ar = area_iter->regionbase.first; ar; ar = ar->next) {
711             if (ELEM(ar->regiontype, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER)) {
712               ED_region_tag_redraw_no_rebuild(ar);
713             }
714           }
715         }
716       }
717     }
718
719     /* cursors, for time being set always on edges, otherwise aregion doesn't switch */
720     if (scr->active_region == NULL) {
721       screen_cursor_set(win, xy);
722     }
723     else {
724       /* notifier invokes freeing the buttons... causing a bit too much redraws */
725       if (old_ar != scr->active_region) {
726         region_cursor_set(win, true);
727
728         /* this used to be a notifier, but needs to be done immediate
729          * because it can undo setting the right button as active due
730          * to delayed notifier handling */
731         if (C) {
732           UI_screen_free_active_but(C, scr);
733         }
734       }
735       else {
736         region_cursor_set(win, false);
737       }
738     }
739   }
740 }
741
742 int ED_screen_area_active(const bContext *C)
743 {
744   wmWindow *win = CTX_wm_window(C);
745   bScreen *sc = CTX_wm_screen(C);
746   ScrArea *sa = CTX_wm_area(C);
747
748   if (win && sc && sa) {
749     AZone *az = ED_area_actionzone_find_xy(sa, &win->eventstate->x);
750     ARegion *ar;
751
752     if (az && az->type == AZONE_REGION) {
753       return 1;
754     }
755
756     for (ar = sa->regionbase.first; ar; ar = ar->next) {
757       if (ar == sc->active_region) {
758         return 1;
759       }
760     }
761   }
762   return 0;
763 }
764
765 /**
766  * Add an area and geometry (screen-edges and -vertices) for it to \a area_map,
767  * with coordinates/dimensions matching \a rect.
768  */
769 static ScrArea *screen_area_create_with_geometry(ScrAreaMap *area_map,
770                                                  const rcti *rect,
771                                                  short spacetype)
772 {
773   ScrVert *bottom_left = screen_geom_vertex_add_ex(area_map, rect->xmin, rect->ymin);
774   ScrVert *top_left = screen_geom_vertex_add_ex(area_map, rect->xmin, rect->ymax);
775   ScrVert *top_right = screen_geom_vertex_add_ex(area_map, rect->xmax, rect->ymax);
776   ScrVert *bottom_right = screen_geom_vertex_add_ex(area_map, rect->xmax, rect->ymin);
777
778   screen_geom_edge_add_ex(area_map, bottom_left, top_left);
779   screen_geom_edge_add_ex(area_map, top_left, top_right);
780   screen_geom_edge_add_ex(area_map, top_right, bottom_right);
781   screen_geom_edge_add_ex(area_map, bottom_right, bottom_left);
782
783   return screen_addarea_ex(area_map, bottom_left, top_left, top_right, bottom_right, spacetype);
784 }
785
786 static void screen_area_set_geometry_rect(ScrArea *sa, const rcti *rect)
787 {
788   sa->v1->vec.x = rect->xmin;
789   sa->v1->vec.y = rect->ymin;
790   sa->v2->vec.x = rect->xmin;
791   sa->v2->vec.y = rect->ymax;
792   sa->v3->vec.x = rect->xmax;
793   sa->v3->vec.y = rect->ymax;
794   sa->v4->vec.x = rect->xmax;
795   sa->v4->vec.y = rect->ymin;
796 }
797
798 static void screen_global_area_refresh(wmWindow *win,
799                                        bScreen *screen,
800                                        eSpace_Type space_type,
801                                        GlobalAreaAlign align,
802                                        const rcti *rect,
803                                        const short height_cur,
804                                        const short height_min,
805                                        const short height_max)
806 {
807   ScrArea *area;
808
809   for (area = win->global_areas.areabase.first; area; area = area->next) {
810     if (area->spacetype == space_type) {
811       break;
812     }
813   }
814
815   if (area) {
816     screen_area_set_geometry_rect(area, rect);
817   }
818   else {
819     area = screen_area_create_with_geometry(&win->global_areas, rect, space_type);
820     SpaceType *stype = BKE_spacetype_from_id(space_type);
821     SpaceLink *slink = stype->new (area, WM_window_get_active_scene(win));
822
823     area->regionbase = slink->regionbase;
824
825     BLI_addhead(&area->spacedata, slink);
826     BLI_listbase_clear(&slink->regionbase);
827
828     /* Data specific to global areas. */
829     area->global = MEM_callocN(sizeof(*area->global), __func__);
830     area->global->size_max = height_max;
831     area->global->size_min = height_min;
832     area->global->align = align;
833   }
834
835   if (area->global->cur_fixed_height != height_cur) {
836     /* Refresh layout if size changes. */
837     area->global->cur_fixed_height = height_cur;
838     screen->do_refresh = true;
839   }
840 }
841
842 static int screen_global_header_size(void)
843 {
844   return (int)ceilf(ED_area_headersize() / UI_DPI_FAC);
845 }
846
847 static void screen_global_topbar_area_refresh(wmWindow *win, bScreen *screen)
848 {
849   const short size = screen_global_header_size();
850   rcti rect;
851
852   BLI_rcti_init(&rect, 0, WM_window_pixels_x(win) - 1, 0, WM_window_pixels_y(win) - 1);
853   rect.ymin = rect.ymax - size;
854
855   screen_global_area_refresh(
856       win, screen, SPACE_TOPBAR, GLOBAL_AREA_ALIGN_TOP, &rect, size, size, size);
857 }
858
859 static void screen_global_statusbar_area_refresh(wmWindow *win, bScreen *screen)
860 {
861   const short size_min = 1;
862   const short size_max = 0.8f * screen_global_header_size();
863   const short size = (screen->flag & SCREEN_COLLAPSE_STATUSBAR) ? size_min : size_max;
864   rcti rect;
865
866   BLI_rcti_init(&rect, 0, WM_window_pixels_x(win) - 1, 0, WM_window_pixels_y(win) - 1);
867   rect.ymax = rect.ymin + size_max;
868
869   screen_global_area_refresh(
870       win, screen, SPACE_STATUSBAR, GLOBAL_AREA_ALIGN_BOTTOM, &rect, size, size_min, size_max);
871 }
872
873 void ED_screen_global_areas_sync(wmWindow *win)
874 {
875   /* Update screen flags from height in window, this is weak and perhaps
876    * global areas should just become part of the screen instead. */
877   bScreen *screen = BKE_workspace_active_screen_get(win->workspace_hook);
878
879   screen->flag &= ~SCREEN_COLLAPSE_STATUSBAR;
880
881   for (ScrArea *area = win->global_areas.areabase.first; area; area = area->next) {
882     if (area->global->cur_fixed_height == area->global->size_min) {
883       if (area->spacetype == SPACE_STATUSBAR) {
884         screen->flag |= SCREEN_COLLAPSE_STATUSBAR;
885       }
886     }
887   }
888 }
889
890 void ED_screen_global_areas_refresh(wmWindow *win)
891 {
892   /* Don't create global area for child and temporary windows. */
893   bScreen *screen = BKE_workspace_active_screen_get(win->workspace_hook);
894   if ((win->parent != NULL) || screen->temp) {
895     if (win->global_areas.areabase.first) {
896       screen->do_refresh = true;
897       BKE_screen_area_map_free(&win->global_areas);
898     }
899     return;
900   }
901
902   screen_global_topbar_area_refresh(win, screen);
903   screen_global_statusbar_area_refresh(win, screen);
904 }
905
906 /* -------------------------------------------------------------------- */
907 /* Screen changing */
908
909 static bScreen *screen_fullscreen_find_associated_normal_screen(const Main *bmain, bScreen *screen)
910 {
911   for (bScreen *screen_iter = bmain->screens.first; screen_iter;
912        screen_iter = screen_iter->id.next) {
913     ScrArea *sa = screen_iter->areabase.first;
914     if (sa && sa->full == screen) {
915       return screen_iter;
916     }
917   }
918
919   return screen;
920 }
921
922 /**
923  * \return the screen to activate.
924  * \warning The returned screen may not always equal \a screen_new!
925  */
926 bScreen *screen_change_prepare(
927     bScreen *screen_old, bScreen *screen_new, Main *bmain, bContext *C, wmWindow *win)
928 {
929   /* validate screen, it's called with notifier reference */
930   if (BLI_findindex(&bmain->screens, screen_new) == -1) {
931     return NULL;
932   }
933
934   if (ELEM(screen_new->state, SCREENMAXIMIZED, SCREENFULL)) {
935     screen_new = screen_fullscreen_find_associated_normal_screen(bmain, screen_new);
936   }
937
938   /* check for valid winid */
939   if (!(screen_new->winid == 0 || screen_new->winid == win->winid)) {
940     return NULL;
941   }
942
943   if (screen_old != screen_new) {
944     wmTimer *wt = screen_old->animtimer;
945
946     /* remove handlers referencing areas in old screen */
947     for (ScrArea *sa = screen_old->areabase.first; sa; sa = sa->next) {
948       WM_event_remove_area_handler(&win->modalhandlers, sa);
949     }
950
951     /* we put timer to sleep, so screen_exit has to think there's no timer */
952     screen_old->animtimer = NULL;
953     if (wt) {
954       WM_event_timer_sleep(CTX_wm_manager(C), win, wt, true);
955     }
956     ED_screen_exit(C, win, screen_old);
957
958     /* Same scene, "transfer" playback to new screen. */
959     if (wt) {
960       screen_new->animtimer = wt;
961     }
962
963     return screen_new;
964   }
965
966   return NULL;
967 }
968
969 void screen_change_update(bContext *C, wmWindow *win, bScreen *sc)
970 {
971   Scene *scene = WM_window_get_active_scene(win);
972   WorkSpace *workspace = BKE_workspace_active_get(win->workspace_hook);
973   WorkSpaceLayout *layout = BKE_workspace_layout_find(workspace, sc);
974
975   CTX_wm_window_set(C, win); /* stores C->wm.screen... hrmf */
976
977   ED_screen_refresh(CTX_wm_manager(C), win);
978
979   BKE_screen_view3d_scene_sync(sc, scene); /* sync new screen with scene data */
980   WM_event_add_notifier(C, NC_WINDOW, NULL);
981   WM_event_add_notifier(C, NC_SCREEN | ND_LAYOUTSET, layout);
982
983   /* makes button hilites work */
984   WM_event_add_mousemove(C);
985 }
986
987 /**
988  * \brief Change the active screen.
989  *
990  * Operator call, WM + Window + screen already existed before
991  *
992  * \warning Do NOT call in area/region queues!
993  * \returns if screen changing was successful.
994  */
995 bool ED_screen_change(bContext *C, bScreen *sc)
996 {
997   Main *bmain = CTX_data_main(C);
998   wmWindow *win = CTX_wm_window(C);
999   bScreen *screen_old = CTX_wm_screen(C);
1000   bScreen *screen_new = screen_change_prepare(screen_old, sc, bmain, C, win);
1001
1002   if (screen_new) {
1003     WorkSpace *workspace = BKE_workspace_active_get(win->workspace_hook);
1004     WM_window_set_active_screen(win, workspace, sc);
1005     screen_change_update(C, win, screen_new);
1006
1007     return true;
1008   }
1009
1010   return false;
1011 }
1012
1013 static void screen_set_3dview_camera(Scene *scene, ViewLayer *view_layer, ScrArea *sa, View3D *v3d)
1014 {
1015   /* fix any cameras that are used in the 3d view but not in the scene */
1016   BKE_screen_view3d_sync(v3d, scene);
1017
1018   if (!v3d->camera || !BKE_view_layer_base_find(view_layer, v3d->camera)) {
1019     v3d->camera = BKE_view_layer_camera_find(view_layer);
1020     // XXX if (sc == curscreen) handle_view3d_lock();
1021     if (!v3d->camera) {
1022       ARegion *ar;
1023       ListBase *regionbase;
1024
1025       /* regionbase is in different place depending if space is active */
1026       if (v3d == sa->spacedata.first) {
1027         regionbase = &sa->regionbase;
1028       }
1029       else {
1030         regionbase = &v3d->regionbase;
1031       }
1032
1033       for (ar = regionbase->first; ar; ar = ar->next) {
1034         if (ar->regiontype == RGN_TYPE_WINDOW) {
1035           RegionView3D *rv3d = ar->regiondata;
1036           if (rv3d->persp == RV3D_CAMOB) {
1037             rv3d->persp = RV3D_PERSP;
1038           }
1039         }
1040       }
1041     }
1042   }
1043 }
1044
1045 void ED_screen_scene_change(bContext *C, wmWindow *win, Scene *scene)
1046 {
1047 #if 0
1048   ViewLayer *view_layer_old = WM_window_get_active_view_layer(win);
1049 #endif
1050
1051   /* Switch scene. */
1052   win->scene = scene;
1053   if (CTX_wm_window(C) == win) {
1054     CTX_data_scene_set(C, scene);
1055   }
1056
1057   /* Ensure the view layer name is updated. */
1058   WM_window_ensure_active_view_layer(win);
1059   ViewLayer *view_layer = WM_window_get_active_view_layer(win);
1060
1061 #if 0
1062   /* Mode Syncing. */
1063   if (view_layer_old) {
1064     WorkSpace *workspace = CTX_wm_workspace(C);
1065     Object *obact_new = OBACT(view_layer);
1066     UNUSED_VARS(obact_new);
1067     eObjectMode object_mode_old = workspace->object_mode;
1068     Object *obact_old = OBACT(view_layer_old);
1069     UNUSED_VARS(obact_old, object_mode_old);
1070   }
1071 #endif
1072
1073   /* Update 3D view cameras. */
1074   const bScreen *screen = WM_window_get_active_screen(win);
1075   for (ScrArea *sa = screen->areabase.first; sa; sa = sa->next) {
1076     for (SpaceLink *sl = sa->spacedata.first; sl; sl = sl->next) {
1077       if (sl->spacetype == SPACE_VIEW3D) {
1078         View3D *v3d = (View3D *)sl;
1079         screen_set_3dview_camera(scene, view_layer, sa, v3d);
1080       }
1081     }
1082   }
1083 }
1084
1085 ScrArea *ED_screen_full_newspace(bContext *C, ScrArea *sa, int type)
1086 {
1087   wmWindow *win = CTX_wm_window(C);
1088   ScrArea *newsa = NULL;
1089
1090   if (!sa || sa->full == NULL) {
1091     newsa = ED_screen_state_toggle(C, win, sa, SCREENMAXIMIZED);
1092   }
1093
1094   if (!newsa) {
1095     newsa = sa;
1096   }
1097
1098   BLI_assert(newsa);
1099
1100   if (sa && (sa->spacetype != type)) {
1101     newsa->flag |= AREA_FLAG_TEMP_TYPE;
1102   }
1103   else {
1104     newsa->flag &= ~AREA_FLAG_TEMP_TYPE;
1105   }
1106
1107   ED_area_newspace(C, newsa, type, (newsa->flag & AREA_FLAG_TEMP_TYPE));
1108
1109   return newsa;
1110 }
1111
1112 /**
1113  * \a was_prev_temp for the case previous space was a temporary fullscreen as well
1114  */
1115 void ED_screen_full_prevspace(bContext *C, ScrArea *sa)
1116 {
1117   BLI_assert(sa->full);
1118
1119   if (sa->flag & AREA_FLAG_STACKED_FULLSCREEN) {
1120     /* stacked fullscreen -> only go back to previous screen and don't toggle out of fullscreen */
1121     ED_area_prevspace(C, sa);
1122   }
1123   else {
1124     ED_screen_restore_temp_type(C, sa);
1125   }
1126 }
1127
1128 void ED_screen_restore_temp_type(bContext *C, ScrArea *sa)
1129 {
1130   /* incase nether functions below run */
1131   ED_area_tag_redraw(sa);
1132
1133   if (sa->flag & AREA_FLAG_TEMP_TYPE) {
1134     ED_area_prevspace(C, sa);
1135     /* Flag should be cleared now. */
1136     BLI_assert((sa->flag & AREA_FLAG_TEMP_TYPE) == 0);
1137   }
1138
1139   if (sa->full) {
1140     ED_screen_state_toggle(C, CTX_wm_window(C), sa, SCREENMAXIMIZED);
1141   }
1142 }
1143
1144 /* restore a screen / area back to default operation, after temp fullscreen modes */
1145 void ED_screen_full_restore(bContext *C, ScrArea *sa)
1146 {
1147   wmWindow *win = CTX_wm_window(C);
1148   SpaceLink *sl = sa->spacedata.first;
1149   bScreen *screen = CTX_wm_screen(C);
1150   short state = (screen ? screen->state : SCREENMAXIMIZED);
1151
1152   /* if fullscreen area has a temporary space (such as a file browser or fullscreen render
1153    * overlaid on top of an existing setup) then return to the previous space */
1154
1155   if (sl->next) {
1156     if (sa->flag & AREA_FLAG_TEMP_TYPE) {
1157       ED_screen_full_prevspace(C, sa);
1158     }
1159     else {
1160       ED_screen_state_toggle(C, win, sa, state);
1161     }
1162     /* warning: 'sa' may be freed */
1163   }
1164   /* otherwise just tile the area again */
1165   else {
1166     ED_screen_state_toggle(C, win, sa, state);
1167   }
1168 }
1169
1170 /**
1171  * this function toggles: if area is maximized/full then the parent will be restored
1172  *
1173  * \warning \a sa may be freed.
1174  */
1175 ScrArea *ED_screen_state_toggle(bContext *C, wmWindow *win, ScrArea *sa, const short state)
1176 {
1177   Main *bmain = CTX_data_main(C);
1178   wmWindowManager *wm = CTX_wm_manager(C);
1179   WorkSpace *workspace = WM_window_get_active_workspace(win);
1180   bScreen *sc, *oldscreen;
1181   ARegion *ar;
1182
1183   if (sa) {
1184     /* ensure we don't have a button active anymore, can crash when
1185      * switching screens with tooltip open because region and tooltip
1186      * are no longer in the same screen */
1187     for (ar = sa->regionbase.first; ar; ar = ar->next) {
1188       UI_blocklist_free(C, &ar->uiblocks);
1189
1190       if (ar->regiontimer) {
1191         WM_event_remove_timer(wm, NULL, ar->regiontimer);
1192         ar->regiontimer = NULL;
1193       }
1194     }
1195
1196     /* prevent hanging status prints */
1197     ED_area_status_text(sa, NULL);
1198     ED_workspace_status_text(C, NULL);
1199   }
1200
1201   if (sa && sa->full) {
1202     WorkSpaceLayout *layout_old = WM_window_get_active_layout(win);
1203     /* restoring back to SCREENNORMAL */
1204     sc = sa->full;                                /* the old screen to restore */
1205     oldscreen = WM_window_get_active_screen(win); /* the one disappearing */
1206
1207     BLI_assert(BKE_workspace_layout_screen_get(layout_old) != sc);
1208     BLI_assert(BKE_workspace_layout_screen_get(layout_old)->state != SCREENNORMAL);
1209
1210     sc->state = SCREENNORMAL;
1211     sc->flag = oldscreen->flag;
1212
1213     /* find old area to restore from */
1214     ScrArea *fullsa = NULL;
1215     for (ScrArea *old = sc->areabase.first; old; old = old->next) {
1216       /* area to restore from is always first */
1217       if (old->full && !fullsa) {
1218         fullsa = old;
1219       }
1220
1221       /* clear full screen state */
1222       old->full = NULL;
1223     }
1224
1225     sa->full = NULL;
1226
1227     if (fullsa == NULL) {
1228       if (G.debug & G_DEBUG) {
1229         printf("%s: something wrong in areafullscreen\n", __func__);
1230       }
1231       return NULL;
1232     }
1233
1234     if (state == SCREENFULL) {
1235       /* unhide global areas */
1236       for (ScrArea *glob_area = win->global_areas.areabase.first; glob_area;
1237            glob_area = glob_area->next) {
1238         glob_area->global->flag &= ~GLOBAL_AREA_IS_HIDDEN;
1239       }
1240       /* restore the old side panels/header visibility */
1241       for (ar = sa->regionbase.first; ar; ar = ar->next) {
1242         ar->flag = ar->flagfullscreen;
1243       }
1244     }
1245
1246     ED_area_data_swap(fullsa, sa);
1247
1248     /* animtimer back */
1249     sc->animtimer = oldscreen->animtimer;
1250     oldscreen->animtimer = NULL;
1251
1252     ED_screen_change(C, sc);
1253
1254     BKE_workspace_layout_remove(CTX_data_main(C), workspace, layout_old);
1255
1256     /* After we've restored back to SCREENNORMAL, we have to wait with
1257      * screen handling as it uses the area coords which aren't updated yet.
1258      * Without doing so, the screen handling gets wrong area coords,
1259      * which in worst case can lead to crashes (see T43139) */
1260     sc->skip_handling = true;
1261   }
1262   else {
1263     /* change from SCREENNORMAL to new state */
1264     WorkSpaceLayout *layout_new;
1265     ScrArea *newa;
1266     char newname[MAX_ID_NAME - 2];
1267
1268     BLI_assert(ELEM(state, SCREENMAXIMIZED, SCREENFULL));
1269
1270     oldscreen = WM_window_get_active_screen(win);
1271
1272     oldscreen->state = state;
1273     BLI_snprintf(newname, sizeof(newname), "%s-%s", oldscreen->id.name + 2, "nonnormal");
1274
1275     layout_new = ED_workspace_layout_add(bmain, workspace, win, newname);
1276
1277     sc = BKE_workspace_layout_screen_get(layout_new);
1278     sc->state = state;
1279     sc->redraws_flag = oldscreen->redraws_flag;
1280     sc->temp = oldscreen->temp;
1281     sc->flag = oldscreen->flag;
1282
1283     /* timer */
1284     sc->animtimer = oldscreen->animtimer;
1285     oldscreen->animtimer = NULL;
1286
1287     /* use random area when we have no active one, e.g. when the
1288      * mouse is outside of the window and we open a file browser */
1289     if (!sa || sa->global) {
1290       sa = oldscreen->areabase.first;
1291     }
1292
1293     newa = (ScrArea *)sc->areabase.first;
1294
1295     /* copy area */
1296     ED_area_data_swap(newa, sa);
1297     newa->flag = sa->flag; /* mostly for AREA_FLAG_WASFULLSCREEN */
1298
1299     if (state == SCREENFULL) {
1300       /* temporarily hide global areas */
1301       for (ScrArea *glob_area = win->global_areas.areabase.first; glob_area;
1302            glob_area = glob_area->next) {
1303         glob_area->global->flag |= GLOBAL_AREA_IS_HIDDEN;
1304       }
1305       /* temporarily hide the side panels/header */
1306       for (ar = newa->regionbase.first; ar; ar = ar->next) {
1307         ar->flagfullscreen = ar->flag;
1308
1309         if (ELEM(ar->regiontype,
1310                  RGN_TYPE_UI,
1311                  RGN_TYPE_HEADER,
1312                  RGN_TYPE_TOOL_HEADER,
1313                  RGN_TYPE_FOOTER,
1314                  RGN_TYPE_TOOLS,
1315                  RGN_TYPE_NAV_BAR,
1316                  RGN_TYPE_EXECUTE)) {
1317           ar->flag |= RGN_FLAG_HIDDEN;
1318         }
1319       }
1320     }
1321
1322     sa->full = oldscreen;
1323     newa->full = oldscreen;
1324
1325     ED_screen_change(C, sc);
1326   }
1327
1328   /* XXX bad code: setscreen() ends with first area active. fullscreen render assumes this too */
1329   CTX_wm_area_set(C, sc->areabase.first);
1330
1331   return sc->areabase.first;
1332 }
1333
1334 /* update frame rate info for viewport drawing */
1335 void ED_refresh_viewport_fps(bContext *C)
1336 {
1337   wmTimer *animtimer = CTX_wm_screen(C)->animtimer;
1338   Scene *scene = CTX_data_scene(C);
1339
1340   /* is anim playback running? */
1341   if (animtimer && (U.uiflag & USER_SHOW_FPS)) {
1342     ScreenFrameRateInfo *fpsi = scene->fps_info;
1343
1344     /* if there isn't any info, init it first */
1345     if (fpsi == NULL) {
1346       fpsi = scene->fps_info = MEM_callocN(sizeof(ScreenFrameRateInfo),
1347                                            "refresh_viewport_fps fps_info");
1348     }
1349
1350     /* update the values */
1351     fpsi->redrawtime = fpsi->lredrawtime;
1352     fpsi->lredrawtime = animtimer->ltime;
1353   }
1354   else {
1355     /* playback stopped or shouldn't be running */
1356     if (scene->fps_info) {
1357       MEM_freeN(scene->fps_info);
1358     }
1359     scene->fps_info = NULL;
1360   }
1361 }
1362
1363 /* redraws: uses defines from stime->redraws
1364  * enable: 1 - forward on, -1 - backwards on, 0 - off
1365  */
1366 void ED_screen_animation_timer(bContext *C, int redraws, int refresh, int sync, int enable)
1367 {
1368   bScreen *screen = CTX_wm_screen(C);
1369   wmWindowManager *wm = CTX_wm_manager(C);
1370   wmWindow *win = CTX_wm_window(C);
1371   Scene *scene = CTX_data_scene(C);
1372   bScreen *stopscreen = ED_screen_animation_playing(wm);
1373
1374   if (stopscreen) {
1375     WM_event_remove_timer(wm, win, stopscreen->animtimer);
1376     stopscreen->animtimer = NULL;
1377   }
1378
1379   if (enable) {
1380     ScreenAnimData *sad = MEM_callocN(sizeof(ScreenAnimData), "ScreenAnimData");
1381
1382     screen->animtimer = WM_event_add_timer(wm, win, TIMER0, (1.0 / FPS));
1383
1384     sad->ar = CTX_wm_region(C);
1385     /* if startframe is larger than current frame, we put currentframe on startframe.
1386      * note: first frame then is not drawn! (ton) */
1387     if (PRVRANGEON) {
1388       if (scene->r.psfra > scene->r.cfra) {
1389         sad->sfra = scene->r.cfra;
1390         scene->r.cfra = scene->r.psfra;
1391       }
1392       else {
1393         sad->sfra = scene->r.cfra;
1394       }
1395     }
1396     else {
1397       if (scene->r.sfra > scene->r.cfra) {
1398         sad->sfra = scene->r.cfra;
1399         scene->r.cfra = scene->r.sfra;
1400       }
1401       else {
1402         sad->sfra = scene->r.cfra;
1403       }
1404     }
1405     sad->redraws = redraws;
1406     sad->refresh = refresh;
1407     sad->flag |= (enable < 0) ? ANIMPLAY_FLAG_REVERSE : 0;
1408     sad->flag |= (sync == 0) ? ANIMPLAY_FLAG_NO_SYNC : (sync == 1) ? ANIMPLAY_FLAG_SYNC : 0;
1409
1410     ScrArea *sa = CTX_wm_area(C);
1411
1412     char spacetype = -1;
1413
1414     if (sa) {
1415       spacetype = sa->spacetype;
1416     }
1417
1418     sad->from_anim_edit = (ELEM(spacetype, SPACE_GRAPH, SPACE_ACTION, SPACE_NLA));
1419
1420     screen->animtimer->customdata = sad;
1421   }
1422
1423   /* notifier catched by top header, for button */
1424   WM_event_add_notifier(C, NC_SCREEN | ND_ANIMPLAY, NULL);
1425 }
1426
1427 /* helper for screen_animation_play() - only to be used for TimeLine */
1428 static ARegion *time_top_left_3dwindow(bScreen *screen)
1429 {
1430   ARegion *aret = NULL;
1431   ScrArea *sa;
1432   int min = 10000;
1433
1434   for (sa = screen->areabase.first; sa; sa = sa->next) {
1435     if (sa->spacetype == SPACE_VIEW3D) {
1436       ARegion *ar;
1437       for (ar = sa->regionbase.first; ar; ar = ar->next) {
1438         if (ar->regiontype == RGN_TYPE_WINDOW) {
1439           if (ar->winrct.xmin - ar->winrct.ymin < min) {
1440             aret = ar;
1441             min = ar->winrct.xmin - ar->winrct.ymin;
1442           }
1443         }
1444       }
1445     }
1446   }
1447
1448   return aret;
1449 }
1450
1451 void ED_screen_animation_timer_update(bScreen *screen, int redraws, int refresh)
1452 {
1453   if (screen && screen->animtimer) {
1454     wmTimer *wt = screen->animtimer;
1455     ScreenAnimData *sad = wt->customdata;
1456
1457     sad->redraws = redraws;
1458     sad->refresh = refresh;
1459     sad->ar = NULL;
1460     if (redraws & TIME_REGION) {
1461       sad->ar = time_top_left_3dwindow(screen);
1462     }
1463   }
1464 }
1465
1466 /* results in fully updated anim system */
1467 void ED_update_for_newframe(Main *bmain, Depsgraph *depsgraph)
1468 {
1469   Scene *scene = DEG_get_input_scene(depsgraph);
1470
1471 #ifdef DURIAN_CAMERA_SWITCH
1472   void *camera = BKE_scene_camera_switch_find(scene);
1473   if (camera && scene->camera != camera) {
1474     bScreen *sc;
1475     scene->camera = camera;
1476     /* are there cameras in the views that are not in the scene? */
1477     for (sc = bmain->screens.first; sc; sc = sc->id.next) {
1478       BKE_screen_view3d_scene_sync(sc, scene);
1479     }
1480     DEG_id_tag_update(&scene->id, ID_RECALC_COPY_ON_WRITE);
1481   }
1482 #endif
1483
1484   ED_clip_update_frame(bmain, scene->r.cfra);
1485
1486   /* this function applies the changes too */
1487   BKE_scene_graph_update_for_newframe(depsgraph, bmain);
1488 }
1489
1490 /*
1491  * return true if any active area requires to see in 3D
1492  */
1493 bool ED_screen_stereo3d_required(const bScreen *screen, const Scene *scene)
1494 {
1495   ScrArea *sa;
1496   const bool is_multiview = (scene->r.scemode & R_MULTIVIEW) != 0;
1497
1498   for (sa = screen->areabase.first; sa; sa = sa->next) {
1499     switch (sa->spacetype) {
1500       case SPACE_VIEW3D: {
1501         View3D *v3d;
1502
1503         if (!is_multiview) {
1504           continue;
1505         }
1506
1507         v3d = sa->spacedata.first;
1508         if (v3d->camera && v3d->stereo3d_camera == STEREO_3D_ID) {
1509           ARegion *ar;
1510           for (ar = sa->regionbase.first; ar; ar = ar->next) {
1511             if (ar->regiondata && ar->regiontype == RGN_TYPE_WINDOW) {
1512               RegionView3D *rv3d = ar->regiondata;
1513               if (rv3d->persp == RV3D_CAMOB) {
1514                 return true;
1515               }
1516             }
1517           }
1518         }
1519         break;
1520       }
1521       case SPACE_IMAGE: {
1522         SpaceImage *sima;
1523
1524         /* images should always show in stereo, even if
1525          * the file doesn't have views enabled */
1526         sima = sa->spacedata.first;
1527         if (sima->image && BKE_image_is_stereo(sima->image) &&
1528             (sima->iuser.flag & IMA_SHOW_STEREO)) {
1529           return true;
1530         }
1531         break;
1532       }
1533       case SPACE_NODE: {
1534         SpaceNode *snode;
1535
1536         if (!is_multiview) {
1537           continue;
1538         }
1539
1540         snode = sa->spacedata.first;
1541         if ((snode->flag & SNODE_BACKDRAW) && ED_node_is_compositor(snode)) {
1542           return true;
1543         }
1544         break;
1545       }
1546       case SPACE_SEQ: {
1547         SpaceSeq *sseq;
1548
1549         if (!is_multiview) {
1550           continue;
1551         }
1552
1553         sseq = sa->spacedata.first;
1554         if (ELEM(sseq->view, SEQ_VIEW_PREVIEW, SEQ_VIEW_SEQUENCE_PREVIEW)) {
1555           return true;
1556         }
1557
1558         if (sseq->draw_flag & SEQ_DRAW_BACKDROP) {
1559           return true;
1560         }
1561
1562         break;
1563       }
1564     }
1565   }
1566
1567   return false;
1568 }
1569
1570 /**
1571  * Find the scene displayed in \a screen.
1572  * \note Assumes \a screen to be visible/active!
1573  */
1574
1575 Scene *ED_screen_scene_find_with_window(const bScreen *screen,
1576                                         const wmWindowManager *wm,
1577                                         struct wmWindow **r_window)
1578 {
1579   for (wmWindow *win = wm->windows.first; win; win = win->next) {
1580     if (WM_window_get_active_screen(win) == screen) {
1581       if (r_window) {
1582         *r_window = win;
1583       }
1584       return WM_window_get_active_scene(win);
1585     }
1586   }
1587
1588   BLI_assert(0);
1589   return NULL;
1590 }
1591
1592 ScrArea *ED_screen_area_find_with_spacedata(const bScreen *screen,
1593                                             const SpaceLink *sl,
1594                                             const bool only_visible)
1595 {
1596   if (only_visible) {
1597     for (ScrArea *sa = screen->areabase.first; sa; sa = sa->next) {
1598       if (sa->spacedata.first == sl) {
1599         return sa;
1600       }
1601     }
1602   }
1603   else {
1604     for (ScrArea *sa = screen->areabase.first; sa; sa = sa->next) {
1605       if (BLI_findindex(&sa->spacedata, sl) != -1) {
1606         return sa;
1607       }
1608     }
1609   }
1610   return NULL;
1611 }
1612
1613 Scene *ED_screen_scene_find(const bScreen *screen, const wmWindowManager *wm)
1614 {
1615   return ED_screen_scene_find_with_window(screen, wm, NULL);
1616 }
1617
1618 wmWindow *ED_screen_window_find(const bScreen *screen, const wmWindowManager *wm)
1619 {
1620   for (wmWindow *win = wm->windows.first; win; win = win->next) {
1621     if (WM_window_get_active_screen(win) == screen) {
1622       return win;
1623     }
1624   }
1625   return NULL;
1626 }