Fullscreen Editor (new fullscreen mode for clean UI)

Organize Maximize/Fullscreen mess and add a new fullscreen mode with no UI

* Maximize Editor: (old Ctrl+Up)
* Full Screen Window: (old Alt + F11)
* Full Screen Editor: new operator (Alt + F10)
* Change Show/Hide Header: (Alt + F9)

When the mode is on moving the mouse near the top right corner of the
editor shows an icon to go back to the normal editor mode.

This was originally intended for the multiview branch, but this
functionality also benefits non-stereo workflows, thus it can be
reviewed and committed independently.

Development notes:
* This includes cleanups in the code to sanitize the naming of
  fullscreen/maximize across the window/editor code.

* Originally the idea was to make the window fullscreen as well, but
  this idea was dropped.

* You can see the clicking area when debug is 1

* Technically the user can be left with an unfaded icon in the corner
  (specially when using a tablet). If we think this is too bad we can
  increase the action zone to be the whole screen, or something similar.

Reviewers: campbellbarton [1], ton [2], fsiddi [2]

[1] actual code review
[2] design review

Differential Revision: https://developer.blender.org/D678

1 files changed, 146 insertions, 26 deletions

diff --git a/source/blender/editors/screen/screen_ops.c b/source/blender/editors/screen/screen_ops.c
index 7c7574b3af3..8be25e34f6f 100644
--- a/source/blender/editors/screen/screen_ops.c
+++ b/source/blender/editors/screen/screen_ops.c
@@ -129,13 +129,31 @@ static int screen_active_editable(bContext *C)
 {
 	if (ED_operator_screenactive(C)) {
 		/* no full window splitting allowed */
-		if (CTX_wm_screen(C)->full != SCREENNORMAL)
+		if (CTX_wm_screen(C)->state != SCREENNORMAL)
 			return 0;
 		return 1;
 	}
 	return 0;
 }
 
+static ARegion *screen_find_region_type(bContext *C, int type)
+{
+	ARegion *ar = CTX_wm_region(C);
+
+	/* find the header region
+	 * - try context first, but upon failing, search all regions in area...
+	 */
+	if ((ar == NULL) || (ar->regiontype != type)) {
+		ScrArea *sa = CTX_wm_area(C);
+		ar = BKE_area_find_region_type(sa, type);
+	}
+	else {
+		ar = NULL;
+	}
+
+	return ar;
+}
+
 /* when mouse is over area-edge */
 int ED_operator_screen_mainwinactive(bContext *C)
 {
@@ -611,6 +629,24 @@ static int actionzone_area_poll(bContext *C)
 	return 0;
 }
 
+/* the debug drawing of the click_rect is in area_draw_azone_fullscreen, keep both in sync */
+static void fullscreen_click_rcti_init(rcti *rect, const short x1, const short y1, const short x2, const short y2)
+{
+	int x = x2 - ((float) x2 - x1) * 0.5f / UI_DPI_FAC;
+	int y = y2 - ((float) y2 - y1) * 0.5f / UI_DPI_FAC;
+	float icon_size = UI_DPI_ICON_SIZE + 7 * UI_DPI_FAC;
+
+	/* adjust the icon distance from the corner */
+	x += 36.0f / UI_DPI_FAC;
+	y += 36.0f / UI_DPI_FAC;
+
+	/* draws from the left bottom corner of the icon */
+	x -= UI_DPI_ICON_SIZE;
+	y -= UI_DPI_ICON_SIZE;
+
+	BLI_rcti_init(rect, x, x + icon_size, y, y + icon_size);
+}
+
 AZone *is_in_area_actionzone(ScrArea *sa, const int xy[2])
 {
 	AZone *az = NULL;
@@ -627,6 +663,42 @@ AZone *is_in_area_actionzone(ScrArea *sa, const int xy[2])
 			else if (az->type == AZONE_REGION) {
 				break;
 			}
+			else if (az->type == AZONE_FULLSCREEN) {
+				int mouse_radius, spot_radius, fadein_radius, fadeout_radius;
+				rcti click_rect;
+
+				fullscreen_click_rcti_init(&click_rect, az->x1, az->y1, az->x2, az->y2);
+
+				if (BLI_rcti_isect_pt_v(&click_rect, xy)) {
+					az->alpha = 1.0f;
+				}
+				else {
+					mouse_radius = (xy[0] - az->x2) * (xy[0] - az->x2) + (xy[1] - az->y2) * (xy[1] - az->y2);
+					spot_radius = AZONESPOT * AZONESPOT;
+					fadein_radius = AZONEFADEIN * AZONEFADEIN;
+					fadeout_radius = AZONEFADEOUT * AZONEFADEOUT;
+
+					if (mouse_radius < spot_radius) {
+						az->alpha = 1.0f;
+					}
+					else if (mouse_radius < fadein_radius) {
+						az->alpha = 1.0f;
+					}
+					else if (mouse_radius < fadeout_radius) {
+						az->alpha = 1.0f - ((float)(mouse_radius - fadein_radius)) / ((float)(fadeout_radius - fadein_radius));
+					}
+					else {
+						az->alpha = 0.0f;
+					}
+
+					/* fade in/out but no click */
+					az = NULL;
+				}
+
+				/* XXX force redraw to show/hide the action zone */
+				ED_area_tag_redraw(sa);
+				break;
+			}
 		}
 	}
 	
@@ -654,8 +726,11 @@ static void actionzone_apply(bContext *C, wmOperator *op, int type)
 
 	if (type == AZONE_AREA)
 		event.type = EVT_ACTIONZONE_AREA;
+	else if (type == AZONE_FULLSCREEN)
+		event.type = EVT_ACTIONZONE_FULLSCREEN;
 	else
 		event.type = EVT_ACTIONZONE_REGION;
+
 	event.val = 0;
 	event.customdata = op->customdata;
 	event.customdatafree = true;
@@ -680,8 +755,8 @@ static int actionzone_invoke(bContext *C, wmOperator *op, const wmEvent *event)
 	sad->x = event->x; sad->y = event->y;
 	
 	/* region azone directly reacts on mouse clicks */
-	if (sad->az->type == AZONE_REGION) {
-		actionzone_apply(C, op, AZONE_REGION);
+	if (ELEM(sad->az->type, AZONE_REGION, AZONE_FULLSCREEN)) {
+		actionzone_apply(C, op, sad->az->type);
 		actionzone_exit(op);
 		return OPERATOR_FINISHED;
 	}
@@ -1462,7 +1537,7 @@ static int area_split_invoke(bContext *C, wmOperator *op, const wmEvent *event)
 	int dir;
 	
 	/* no full window splitting allowed */
-	if (sc->full != SCREENNORMAL)
+	if (sc->state != SCREENNORMAL)
 		return OPERATOR_CANCELLED;
 	
 	if (event->type == EVT_ACTIONZONE_AREA) {
@@ -2231,8 +2306,8 @@ static void SCREEN_OT_marker_jump(wmOperatorType *ot)
 
 static bool screen_set_is_ok(bScreen *screen, bScreen *screen_prev)
 {
-	return ((screen->winid == 0)    &&
-	        (screen->full == 0)     &&
+	return ((screen->winid == 0) &&
+	        (screen->state == SCREENNORMAL) &&
 	        (screen != screen_prev) &&
 	        (screen->id.name[2] != '.' || !(U.uiflag & USER_HIDE_DOT)));
 }
@@ -2303,10 +2378,11 @@ static void SCREEN_OT_screen_set(wmOperatorType *ot)
 
 
 /* function to be called outside UI context, or for redo */
-static int screen_full_area_exec(bContext *C, wmOperator *UNUSED(op))
+static int screen_maximize_area_exec(bContext *C, wmOperator *op)
 {
 	bScreen *screen = CTX_wm_screen(C);
 	ScrArea *sa = NULL;
+	const bool hide_panels = RNA_boolean_get(op->ptr, "use_hide_panels");
 	
 	/* search current screen for 'fullscreen' areas */
 	/* prevents restoring info header, when mouse is over it */
@@ -2314,25 +2390,41 @@ static int screen_full_area_exec(bContext *C, wmOperator *UNUSED(op))
 		if (sa->full) break;
 	}
 	
-	if (sa == NULL) sa = CTX_wm_area(C);
+	if (sa == NULL) {
+		sa = CTX_wm_area(C);
+	}
 	
-	ED_screen_full_toggle(C, CTX_wm_window(C), sa);
+	if (hide_panels) {
+		if (!ELEM(screen->state, SCREENNORMAL, SCREENFULL)) {
+			return OPERATOR_CANCELLED;
+		}
+		ED_screen_state_toggle(C, CTX_wm_window(C), sa, SCREENFULL);
+	}
+	else {
+		if (!ELEM(screen->state, SCREENNORMAL, SCREENMAXIMIZED)) {
+			return OPERATOR_CANCELLED;
+		}
+		ED_screen_state_toggle(C, CTX_wm_window(C), sa, SCREENMAXIMIZED);
+	}
+
 	return OPERATOR_FINISHED;
 }
 
 static void SCREEN_OT_screen_full_area(wmOperatorType *ot)
 {
-	ot->name = "Toggle Full Screen";
-	ot->description = "Toggle display selected area as fullscreen";
+	PropertyRNA *prop;
+
+	ot->name = "Toggle Fullscreen Area";
+	ot->description = "Toggle display selected area as fullscreen/maximized";
 	ot->idname = "SCREEN_OT_screen_full_area";
 	
-	ot->exec = screen_full_area_exec;
+	ot->exec = screen_maximize_area_exec;
 	ot->poll = ED_operator_areaactive;
 	ot->flag = 0;
-	
-}
-
 
+	prop = RNA_def_boolean(ot->srna, "use_hide_panels", false, "Hide Panels", "Hide all the panels");
+	RNA_def_property_flag(prop, PROP_SKIP_SAVE);
+}
 
 /* ************** join area operator ********************************************** */
 
@@ -3027,23 +3119,44 @@ static void SCREEN_OT_region_flip(wmOperatorType *ot)
 	ot->flag = 0;
 }
 
+/* ************** header operator ***************************** */
+static int header_exec(bContext *C, wmOperator *UNUSED(op))
+{
+	ARegion *ar = screen_find_region_type(C, RGN_TYPE_HEADER);
+
+	if (ar == NULL) {
+		return OPERATOR_CANCELLED;
+	}
+
+	ar->flag ^= RGN_FLAG_HIDDEN;
+
+	ED_area_tag_redraw(CTX_wm_area(C));
+
+	WM_event_add_notifier(C, NC_SCREEN | NA_EDITED, NULL);
+
+	return OPERATOR_FINISHED;
+}
+
+static void SCREEN_OT_header(wmOperatorType *ot)
+{
+	/* identifiers */
+	ot->name = "Header";
+	ot->description = "Display display header";
+	ot->idname = "SCREEN_OT_header";
+
+	/* api callbacks */
+	ot->exec = header_exec;
+}
+
 /* ************** header flip operator ***************************** */
 
 /* flip a header region alignment */
 static int header_flip_exec(bContext *C, wmOperator *UNUSED(op))
 {
-	ARegion *ar = CTX_wm_region(C);
-	
-	/* find the header region 
-	 *	- try context first, but upon failing, search all regions in area...
-	 */
-	if ((ar == NULL) || (ar->regiontype != RGN_TYPE_HEADER)) {
-		ScrArea *sa = CTX_wm_area(C);
-		ar = BKE_area_find_region_type(sa, RGN_TYPE_HEADER);
+	ARegion *ar = screen_find_region_type(C, RGN_TYPE_HEADER);
 
-		/* don't do anything if no region */
-		if (ar == NULL)
-			return OPERATOR_CANCELLED;
+	if (ar == NULL) {
+		return OPERATOR_CANCELLED;
 	}
 	
 	/* copied from SCREEN_OT_region_flip */
@@ -3945,6 +4058,7 @@ void ED_operatortypes_screen(void)
 	WM_operatortype_append(SCREEN_OT_region_scale);
 	WM_operatortype_append(SCREEN_OT_region_flip);
 	WM_operatortype_append(SCREEN_OT_header_flip);
+	WM_operatortype_append(SCREEN_OT_header);
 	WM_operatortype_append(SCREEN_OT_header_toggle_menus);
 	WM_operatortype_append(SCREEN_OT_header_toolbox);
 	WM_operatortype_append(SCREEN_OT_screen_set);
@@ -4047,6 +4161,7 @@ void ED_keymap_screen(wmKeyConfig *keyconf)
 	
 	WM_keymap_verify_item(keymap, "SCREEN_OT_area_options", RIGHTMOUSE, KM_PRESS, 0, 0);
 	
+	WM_keymap_add_item(keymap, "SCREEN_OT_header", F9KEY, KM_PRESS, KM_ALT, 0);
 	
 	/* Header Editing ------------------------------------------------ */
 	keymap = WM_keymap_find(keyconf, "Header", 0, 0);
@@ -4066,6 +4181,11 @@ void ED_keymap_screen(wmKeyConfig *keyconf)
 	WM_keymap_add_item(keymap, "SCREEN_OT_screen_full_area", UPARROWKEY, KM_PRESS, KM_CTRL, 0);
 	WM_keymap_add_item(keymap, "SCREEN_OT_screen_full_area", DOWNARROWKEY, KM_PRESS, KM_CTRL, 0);
 	WM_keymap_add_item(keymap, "SCREEN_OT_screen_full_area", SPACEKEY, KM_PRESS, KM_SHIFT, 0);
+	kmi = WM_keymap_add_item(keymap, "SCREEN_OT_screen_full_area", F10KEY, KM_PRESS, KM_ALT, 0);
+	RNA_boolean_set(kmi->ptr, "use_hide_panels", true);
+	kmi = WM_keymap_add_item(keymap, "SCREEN_OT_screen_full_area", EVT_ACTIONZONE_FULLSCREEN, 0, 0, 0);
+	RNA_boolean_set(kmi->ptr, "use_hide_panels", true);
+
 	WM_keymap_add_item(keymap, "SCREEN_OT_screenshot", F3KEY, KM_PRESS, KM_CTRL, 0);
 	WM_keymap_add_item(keymap, "SCREEN_OT_screencast", F3KEY, KM_PRESS, KM_ALT, 0);