Workaround T56752: redo panel alpha flicker
[blender.git] / source / blender / editors / interface / interface_region_hud.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  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/interface_region_hud.c
27  *  \ingroup edinterface
28  *
29  * Floating Persistent Region
30  */
31
32 #include <string.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_userdef_types.h"
37
38 #include "BLI_string.h"
39 #include "BLI_rect.h"
40 #include "BLI_listbase.h"
41 #include "BLI_utildefines.h"
42 #include "BLI_math_color.h"
43
44 #include "BKE_context.h"
45 #include "BKE_screen.h"
46 #include "BKE_main.h"
47
48 #include "WM_api.h"
49 #include "WM_types.h"
50
51 #include "RNA_access.h"
52
53 #include "BIF_gl.h"
54
55 #include "UI_interface.h"
56 #include "UI_view2d.h"
57
58 #include "BLT_translation.h"
59
60 #include "ED_screen.h"
61 #include "ED_undo.h"
62
63 #include "interface_intern.h"
64 #include "GPU_framebuffer.h"
65
66
67 /* -------------------------------------------------------------------- */
68 /** \name Utilities
69  * \{ */
70
71 static bool last_redo_poll(const bContext *C)
72 {
73         wmOperator *op = WM_operator_last_redo(C);
74         if (op == NULL) {
75                 return false;
76         }
77         bool success = false;
78         if (WM_operator_repeat_check(C, op) &&
79             WM_operator_check_ui_empty(op->type) == false)
80         {
81                 success = WM_operator_poll((bContext *)C, op->type);
82         }
83         return success;
84 }
85
86 /** \} */
87
88 /* -------------------------------------------------------------------- */
89 /** \name Redo Panel
90  * \{ */
91
92 static bool hud_panel_operator_redo_poll(const bContext *C, PanelType *UNUSED(pt))
93 {
94         return last_redo_poll(C);
95 }
96
97 static void hud_panel_operator_redo_draw_header(const bContext *C, Panel *pa)
98 {
99         wmOperator *op = WM_operator_last_redo(C);
100         BLI_strncpy(pa->drawname, RNA_struct_ui_name(op->type->srna), sizeof(pa->drawname));
101 }
102
103 static void hud_panel_operator_redo_draw(const bContext *C, Panel *pa)
104 {
105         wmOperator *op = WM_operator_last_redo(C);
106         if (op == NULL) {
107                 return;
108         }
109         if (!WM_operator_check_ui_enabled(C, op->type->name)) {
110                 uiLayoutSetEnabled(pa->layout, false);
111         }
112         uiLayout *col = uiLayoutColumn(pa->layout, false);
113         uiTemplateOperatorRedoProperties(col, C);
114 }
115
116 static void hud_panels_register(ARegionType *art, int space_type, int region_type)
117 {
118         PanelType *pt;
119
120         pt = MEM_callocN(sizeof(PanelType), __func__);
121         strcpy(pt->idname, "OPERATOR_PT_redo");
122         strcpy(pt->label, N_("Redo"));
123         strcpy(pt->translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
124         pt->draw_header = hud_panel_operator_redo_draw_header;
125         pt->draw = hud_panel_operator_redo_draw;
126         pt->poll = hud_panel_operator_redo_poll;
127         pt->space_type = space_type;
128         pt->region_type = region_type;
129         BLI_addtail(&art->paneltypes, pt);
130 }
131
132 /** \} */
133
134 /* -------------------------------------------------------------------- */
135 /** \name Callbacks for Floating Region
136  * \{ */
137
138 struct HudRegionData {
139         short regionid;
140 };
141
142 static void hud_region_init(wmWindowManager *wm, ARegion *ar)
143 {
144         ED_region_panels_init(wm, ar);
145         UI_region_handlers_add(&ar->handlers);
146         ar->flag |= RGN_FLAG_TEMP_REGIONDATA;
147 }
148
149 static void hud_region_free(ARegion *ar)
150 {
151         MEM_SAFE_FREE(ar->regiondata);
152 }
153
154 static void hud_region_layout(const bContext *C, ARegion *ar)
155 {
156         bool ok = false;
157
158         {
159                 struct HudRegionData *hrd = ar->regiondata;
160                 if (hrd != NULL) {
161                         ScrArea *sa = CTX_wm_area(C);
162                         ARegion *ar_op = (hrd->regionid != -1) ? BKE_area_find_region_type(sa, hrd->regionid) : NULL;
163                         ARegion *ar_prev = CTX_wm_region(C);
164                         CTX_wm_region_set((bContext *)C, ar_op);
165                         ok = last_redo_poll(C);
166                         CTX_wm_region_set((bContext *)C, ar_prev);
167                 }
168         }
169
170         if (!ok) {
171                 ED_region_tag_redraw(ar);
172                 ar->flag |= RGN_FLAG_HIDDEN;
173                 return;
174         }
175
176         int size_y = ar->sizey;
177
178         ED_region_panels_layout(C, ar);
179
180         if (ar->panels.first && (ar->sizey != size_y)) {
181                 View2D *v2d = &ar->v2d;
182                 ar->winx = ar->sizex;
183                 ar->winy = ar->sizey;
184
185                 ar->winrct.xmax = (ar->winrct.xmin + ar->winx) - 1;
186                 ar->winrct.ymax = (ar->winrct.ymin + ar->winy) - 1;
187
188                 UI_view2d_region_reinit(v2d, V2D_COMMONVIEW_PANELS_UI, ar->winx, ar->winy);
189
190                 /* Weak, but needed to avoid glitches, especially with hi-dpi (where resizing the view glitches often).
191                  * Fortunately this only happens occasionally. */
192                 ED_region_panels_layout(C, ar);
193         }
194
195         /* restore view matrix */
196         UI_view2d_view_restore(C);
197 }
198
199 static void hud_region_draw(const bContext *C, ARegion *ar)
200 {
201         UI_view2d_view_ortho(&ar->v2d);
202         wmOrtho2_region_pixelspace(ar);
203         GPU_clear_color(0, 0, 0, 0.0f);
204         GPU_clear(GPU_COLOR_BIT);
205
206         if ((ar->flag & RGN_FLAG_HIDDEN) == 0) {
207                 if (0) {
208                         /* Has alpha flickering glitch, see T56752. */
209                         ui_draw_menu_back(NULL, NULL, &(rcti){.xmax = ar->winx, .ymax = ar->winy});
210                 }
211                 else {
212                         /* Use basic drawing instead. */
213                         bTheme *btheme = UI_GetTheme();
214                         float color[4];
215                         rgba_uchar_to_float(color, (const uchar *)btheme->tui.wcol_menu_back.inner);
216                         const float radius = U.widget_unit * btheme->tui.wcol_menu_back.roundness;
217                         UI_draw_roundbox_corner_set(UI_CNR_ALL);
218                         UI_draw_roundbox_4fv(true, 0, 0, ar->winx, ar->winy, radius, color);
219                 }
220
221                 ED_region_panels_draw(C, ar);
222         }
223 }
224
225 ARegionType *ED_area_type_hud(int space_type)
226 {
227         ARegionType *art = MEM_callocN(sizeof(ARegionType), __func__);
228         art->regionid = RGN_TYPE_HUD;
229         art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_VIEW2D;
230         art->layout = hud_region_layout;
231         art->draw = hud_region_draw;
232         art->init = hud_region_init;
233         art->free = hud_region_free;
234
235         hud_panels_register(art, space_type, art->regionid);
236
237         art->lock = 1;   /* can become flag, see BKE_spacedata_draw_locks */
238         return art;
239 }
240
241 static ARegion *hud_region_add(ScrArea *sa)
242 {
243         ARegion *ar = MEM_callocN(sizeof(ARegion), "area region");
244         ARegion *ar_win = BKE_area_find_region_type(sa, RGN_TYPE_WINDOW);
245         if (ar_win) {
246                 BLI_insertlinkbefore(&sa->regionbase, ar_win, ar);
247         }
248         else {
249                 BLI_addtail(&sa->regionbase, ar);
250         }
251         ar->regiontype = RGN_TYPE_HUD;
252         ar->alignment = RGN_ALIGN_FLOAT;
253         ar->overlap = true;
254         ar->flag |= RGN_FLAG_DYNAMIC_SIZE;
255
256         return ar;
257 }
258
259 void ED_area_type_hud_clear(wmWindowManager *wm, ScrArea *sa_keep)
260 {
261         for (wmWindow *win = wm->windows.first; win; win = win->next) {
262                 bScreen *screen = WM_window_get_active_screen(win);
263                 for (ScrArea *sa = screen->areabase.first; sa; sa = sa->next) {
264                         if (sa != sa_keep) {
265                                 for (ARegion *ar = sa->regionbase.first; ar; ar = ar->next) {
266                                         if (ar->regiontype == RGN_TYPE_HUD) {
267                                                 if ((ar->flag & RGN_FLAG_HIDDEN) == 0) {
268                                                         ar->flag |= RGN_FLAG_HIDDEN;
269                                                         ED_region_tag_redraw(ar);
270                                                         ED_area_tag_redraw(sa);
271                                                 }
272                                         }
273                                 }
274                         }
275                 }
276         }
277 }
278
279 void ED_area_type_hud_ensure(bContext *C, ScrArea *sa)
280 {
281         wmWindowManager *wm = CTX_wm_manager(C);
282         ED_area_type_hud_clear(wm, sa);
283
284         ARegionType *art = BKE_regiontype_from_id(sa->type, RGN_TYPE_HUD);
285         if (art == NULL) {
286                 return;
287         }
288
289         bool init = false;
290         ARegion *ar = BKE_area_find_region_type(sa, RGN_TYPE_HUD);
291         if (!last_redo_poll(C)) {
292                 if (ar) {
293                         ED_region_tag_redraw(ar);
294                         ar->flag |= RGN_FLAG_HIDDEN;
295                 }
296                 return;
297         }
298
299         if (ar == NULL) {
300                 init = true;
301                 ar = hud_region_add(sa);
302                 ar->type = art;
303         }
304
305         ED_region_init(ar);
306         ED_region_tag_redraw(ar);
307
308         /* Reset zoom level (not well supported). */
309         ar->v2d.cur = ar->v2d.tot = (rctf){.xmax = ar->winx, .ymax = ar->winy};
310         ar->v2d.minzoom = 1.0f;
311         ar->v2d.maxzoom = 1.0f;
312
313         /* Let 'ED_area_update_region_sizes' do the work of placing the region.
314          * Otherwise we could set the 'ar->winrct' & 'ar->winx/winy' here. */
315         if (init) {
316                 sa->flag |= AREA_FLAG_REGION_SIZE_UPDATE;
317         }
318         else {
319                 if (ar->flag & RGN_FLAG_HIDDEN) {
320                         sa->flag |= AREA_FLAG_REGION_SIZE_UPDATE;
321                 }
322                 ar->flag &= ~RGN_FLAG_HIDDEN;
323         }
324
325         {
326                 ARegion *ar_op = CTX_wm_region(C);
327                 BLI_assert((ar_op == NULL) || (ar_op->regiontype != RGN_TYPE_HUD));
328                 struct HudRegionData *hrd = ar->regiondata;
329                 if (hrd == NULL) {
330                         hrd = MEM_callocN(sizeof(*hrd), __func__);
331                         ar->regiondata = hrd;
332                 }
333                 if (ar_op) {
334                         hrd->regionid = ar_op->regiontype;
335                 }
336                 else {
337                         hrd->regionid = -1;
338                 }
339         }
340
341         /* XXX, should be handled in more general way. */
342         ar->visible = !((ar->flag & RGN_FLAG_HIDDEN) || (ar->flag & RGN_FLAG_TOO_SMALL));
343
344         /* We shouldn't need to do this every time :S */
345         /* XXX, this is evil! - it also makes the menu show on first draw. :( */
346         ARegion *ar_prev = CTX_wm_region(C);
347         CTX_wm_region_set((bContext *)C, ar);
348         hud_region_layout(C, ar);
349         CTX_wm_region_set((bContext *)C, ar_prev);
350 }
351
352 /** \} */