#include "DNA_space_types.h"

Macros
#define	SCREEN_DIR_IS_VERTICAL(dir)
#define	SCREEN_DIR_IS_HORIZONTAL(dir)
#define	AZONEFADEIN (5.0f * U.widget_unit) /* when #AZone is totally visible */
#define	AZONEFADEOUT (6.5f * U.widget_unit) /* when we start seeing the #AZone */
#define	AREAJOINTOLERANCEX (AREAMINX * UI_SCALE_FAC)
#define	AREAJOINTOLERANCEY (HEADERY * UI_SCALE_FAC)
#define	BORDERPADDING (U.border_width * UI_SCALE_FAC + 3.0f * UI_SCALE_FAC)
#define	EDITORRADIUS (6.0f * UI_SCALE_FAC)
#define	BORDERPADDING_GLOBAL (3.0f * UI_SCALE_FAC)
#define	AREA_CLOSE_FADEOUT 0.15f /* seconds */
#define	AREA_DOCK_FADEOUT 0.15f /* seconds */
#define	AREA_DOCK_FADEIN 0.15f /* seconds */
#define	AREA_JOIN_FADEOUT 0.15f /* seconds */
#define	AREA_SPLIT_FADEOUT 0.15f /* seconds */
#define	AREA_MOVE_LINE_FADEIN 0.1f /* seconds */
#define	AREA_MOVE_LINE_FADEOUT 0.15f /* seconds */

Enumerations
enum	eScreenDir { SCREEN_DIR_NONE = -1 , SCREEN_DIR_W = 0 , SCREEN_DIR_N = 1 , SCREEN_DIR_E = 2 , SCREEN_DIR_S = 3 }
enum	eScreenAxis { SCREEN_AXIS_H = 'h' , SCREEN_AXIS_V = 'v' }
enum class	AreaDockTarget { None , Right , Left , Top , Bottom , Center }

Functions
void	ED_area_data_copy (ScrArea area_dst, ScrArea area_src, bool do_free)
void	ED_area_data_swap (ScrArea area_dst, ScrArea area_src)
void	region_toggle_hidden (bContext C, ARegion region, bool do_fade)
void	screen_draw_join_highlight (const wmWindow win, ScrArea sa1, ScrArea *sa2, eScreenDir dir, float anim_factor)
void	screen_draw_dock_preview (const wmWindow win, ScrArea source, ScrArea *target, AreaDockTarget dock_target, float factor, int x, int y, float anim_factor)
void	screen_draw_split_preview (ScrArea *area, eScreenAxis dir_axis, float factor)
void	screen_draw_move_highlight (const wmWindow win, bScreen screen, eScreenAxis dir_axis, float anim_factor)
void	screen_draw_region_scale_highlight (ARegion *region)
void	screen_animate_area_highlight (wmWindow win, bScreen screen, const rcti *rect, float inner[4], float outline[4], float seconds)
bScreen *	screen_add (Main bmain, const char name, const rcti *rect)
void	screen_data_copy (bScreen to, bScreen from)
void	screen_new_activate_prepare (const wmWindow win, bScreen screen_new)
void	screen_change_update (bContext C, wmWindow win, bScreen *screen)
void	screen_change_prepare (bScreen screen_old, bScreen screen_new, Main bmain, bContext C, wmWindow *win)
ScrArea *	area_split (const wmWindow win, bScreen screen, ScrArea *area, eScreenAxis dir_axis, float fac, bool merge)
int	screen_area_join (bContext C, ReportList reports, bScreen screen, ScrArea sa1, ScrArea *sa2)
eScreenDir	area_getorientation (ScrArea sa_a, ScrArea sa_b)
void	area_getoffsets (ScrArea sa_a, ScrArea sa_b, eScreenDir dir, int r_offset1, int r_offset2)
bool	screen_area_close (bContext C, ReportList reports, bScreen screen, ScrArea area)
void	screen_area_spacelink_add (const Scene scene, ScrArea area, eSpace_Type space_type)
AZone *	ED_area_actionzone_find_xy (ScrArea *area, const int xy[2])
bool	area_regions_poll (bContext C, const bScreen screen, ScrArea *area)
int	screen_geom_area_height (const ScrArea *area)
int	screen_geom_area_width (const ScrArea *area)
ScrVert *	screen_geom_vertex_add_ex (ScrAreaMap *area_map, short x, short y)
ScrVert *	screen_geom_vertex_add (bScreen *screen, short x, short y)
ScrEdge *	screen_geom_edge_add_ex (ScrAreaMap area_map, ScrVert v1, ScrVert *v2)
ScrEdge *	screen_geom_edge_add (bScreen screen, ScrVert v1, ScrVert *v2)
bool	screen_geom_edge_is_horizontal (ScrEdge *se)
ScrEdge *	screen_geom_area_map_find_active_scredge (const ScrAreaMap area_map, const rcti bounds_rect, int mx, int my, int safety=BORDERPADDING)
ScrEdge *	screen_geom_find_active_scredge (const wmWindow win, const bScreen screen, int mx, int my)
void	screen_geom_vertices_scale (const wmWindow win, bScreen screen)
	Main screen-layout calculation function.
short	screen_geom_find_area_split_point (const ScrArea area, const rcti window_rect, eScreenAxis dir_axis, float fac)
void	screen_geom_select_connected_edge (const wmWindow win, ScrEdge edge)
int	ed_screen_context (const bContext C, const char member, bContextDataResult *result)
void	SCREEN_OT_screenshot (wmOperatorType *ot)
void	SCREEN_OT_screenshot_area (wmOperatorType *ot)
bool	workspace_layout_set_poll (const WorkSpaceLayout *layout)

Variables
const char *	screen_context_dir []

Macro Definition Documentation

◆ AREA_CLOSE_FADEOUT

#define AREA_CLOSE_FADEOUT 0.15f /* seconds */

Definition at line 83 of file screen_intern.hh.

Referenced by area_close_exec(), area_docking_apply(), and screen_area_join_ex().

◆ AREA_DOCK_FADEIN

#define AREA_DOCK_FADEIN 0.15f /* seconds */

Definition at line 85 of file screen_intern.hh.

Referenced by area_join_init(), and area_join_update_data().

◆ AREA_DOCK_FADEOUT

#define AREA_DOCK_FADEOUT 0.15f /* seconds */

Definition at line 84 of file screen_intern.hh.

Referenced by area_docking_apply().

◆ AREA_JOIN_FADEOUT

#define AREA_JOIN_FADEOUT 0.15f /* seconds */

Definition at line 86 of file screen_intern.hh.

Referenced by area_join_apply().

◆ AREA_MOVE_LINE_FADEIN

#define AREA_MOVE_LINE_FADEIN 0.1f /* seconds */

Definition at line 88 of file screen_intern.hh.

Referenced by area_move_init().

◆ AREA_MOVE_LINE_FADEOUT

#define AREA_MOVE_LINE_FADEOUT 0.15f /* seconds */

Definition at line 89 of file screen_intern.hh.

Referenced by area_move_exit().

◆ AREA_SPLIT_FADEOUT

#define AREA_SPLIT_FADEOUT 0.15f /* seconds */

Definition at line 87 of file screen_intern.hh.

Referenced by area_join_modal(), and area_split_modal().

◆ AREAJOINTOLERANCEX

#define AREAJOINTOLERANCEX (AREAMINX * UI_SCALE_FAC)

Definition at line 67 of file screen_intern.hh.

Referenced by area_getorientation(), screen_area_trim(), and screen_areas_can_align().

◆ AREAJOINTOLERANCEY

#define AREAJOINTOLERANCEY (HEADERY * UI_SCALE_FAC)

Definition at line 68 of file screen_intern.hh.

Referenced by area_getorientation(), screen_area_trim(), and screen_areas_can_align().

◆ AZONEFADEIN

#define AZONEFADEIN (5.0f * U.widget_unit) /* when #AZone is totally visible */

Definition at line 63 of file screen_intern.hh.

Referenced by area_actionzone_refresh_xy().

◆ AZONEFADEOUT

#define AZONEFADEOUT (6.5f * U.widget_unit) /* when we start seeing the #AZone */

Definition at line 64 of file screen_intern.hh.

Referenced by area_actionzone_refresh_xy(), and fullscreen_azone_init().

◆ BORDERPADDING

#define BORDERPADDING (U.border_width * UI_SCALE_FAC + 3.0f * UI_SCALE_FAC)

Expanded interaction influence of area borders.

Definition at line 73 of file screen_intern.hh.

Referenced by ED_screen_set_active_region(), and screen_geom_find_active_scredge().

◆ BORDERPADDING_GLOBAL

#define BORDERPADDING_GLOBAL (3.0f * UI_SCALE_FAC)

Definition at line 81 of file screen_intern.hh.

Referenced by screen_geom_find_active_scredge().

◆ EDITORRADIUS

#define EDITORRADIUS (6.0f * UI_SCALE_FAC)

Number of pixels of the area border corner radius.

Definition at line 78 of file screen_intern.hh.

Referenced by area_animate_highlight_cb(), ED_screen_draw_edges(), rounded_corners(), screen_draw_area_closed(), screen_draw_dock_preview(), screen_draw_join_highlight(), screen_draw_region_scale_highlight(), and screen_draw_split_preview().

◆ SCREEN_DIR_IS_HORIZONTAL

#define SCREEN_DIR_IS_HORIZONTAL ( dir )

Value:

(ELEM(dir, SCREEN_DIR_W, SCREEN_DIR_E))

ELEM

#define ELEM(...)

Definition BLI_utildefines.h:144

SCREEN_DIR_W

@ SCREEN_DIR_W

Definition screen_intern.hh:35

SCREEN_DIR_E

@ SCREEN_DIR_E

Definition screen_intern.hh:39

Definition at line 45 of file screen_intern.hh.

Referenced by screen_areas_align(), and screen_areas_can_align().

◆ SCREEN_DIR_IS_VERTICAL

#define SCREEN_DIR_IS_VERTICAL ( dir )

Value:

(ELEM(dir, SCREEN_DIR_N, SCREEN_DIR_S))

SCREEN_DIR_N

@ SCREEN_DIR_N

Definition screen_intern.hh:37

SCREEN_DIR_S

@ SCREEN_DIR_S

Definition screen_intern.hh:41

Definition at line 44 of file screen_intern.hh.

Referenced by actionzone_modal(), area_join_apply(), area_split_invoke(), screen_area_close(), screen_area_trim(), screen_areas_can_align(), and screen_draw_join_highlight().

Enumeration Type Documentation

◆ AreaDockTarget

enum class AreaDockTarget

strong

Enumerator
None
Right
Left
Top
Bottom
Center

Definition at line 54 of file screen_intern.hh.

◆ eScreenAxis

enum eScreenAxis

Enumerator
SCREEN_AXIS_H	Horizontal.
SCREEN_AXIS_V	Vertical.

Definition at line 47 of file screen_intern.hh.

◆ eScreenDir

enum eScreenDir

Enumerator
SCREEN_DIR_NONE	This can mean unset, unknown or invalid.
SCREEN_DIR_W	West/Left.
SCREEN_DIR_N	North/Up.
SCREEN_DIR_E	East/Right.
SCREEN_DIR_S	South/Down.

Definition at line 31 of file screen_intern.hh.

Function Documentation

◆ area_getoffsets()

void area_getoffsets	(	ScrArea *	sa_a,
		ScrArea *	sa_b,
		eScreenDir	dir,
		int *	r_offset1,
		int *	r_offset2 )

Get alignment offset of adjacent areas. 'dir' value is like area_getorientation().

Definition at line 315 of file screen_edit.cc.

References BLI_assert, SCREEN_DIR_E, SCREEN_DIR_N, SCREEN_DIR_NONE, SCREEN_DIR_S, SCREEN_DIR_W, ScrArea::v1, ScrArea::v2, ScrArea::v3, ScrArea::v4, ScrVert::vec, vec2s::x, and vec2s::y.

Referenced by area_docking_apply(), screen_area_join_ex(), screen_areas_can_align(), and screen_draw_join_highlight().

◆ area_getorientation()

eScreenDir area_getorientation	(	ScrArea *	sa_a,
		ScrArea *	sa_b )

with sa_a as center, sa_b is located at: 0=W, 1=N, 2=E, 3=S -1 = not valid check. used with join operator.

Definition at line 275 of file screen_edit.cc.

References AREAJOINTOLERANCEX, AREAJOINTOLERANCEY, SCREEN_DIR_NONE, ScrArea::v1, ScrArea::v3, ScrVert::vec, vec2s::x, and vec2s::y.

Referenced by area_close_poll(), area_docking_apply(), area_join_exec(), area_join_init(), area_join_update_data(), ED_area_has_shared_border(), screen_area_close(), screen_area_join_aligned(), screen_area_join_ex(), and screen_area_options_invoke().

◆ area_regions_poll()

bool area_regions_poll	(	bContext *	C,
		const bScreen *	screen,
		ScrArea *	area )

Returns: true if any region polling state changed, and an area re-init is needed.

Definition at line 736 of file screen_edit.cc.

References C, CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region(), CTX_wm_region_set(), CTX_wm_screen(), CTX_wm_screen_set(), ED_region_visibility_change_update_ex(), LISTBASE_FOREACH, region_poll(), ScrArea::regionbase, RGN_FLAG_HIDDEN, RGN_FLAG_POLL_FAILED, and V2D_IS_INIT.

Referenced by ED_area_init(), and screen_regions_poll().

◆ area_split()

ScrArea * area_split	(	const wmWindow *	win,
		bScreen *	screen,
		ScrArea *	area,
		eScreenAxis	dir_axis,
		float	fac,
		bool	merge )

◆ ED_area_actionzone_find_xy()

AZone * ED_area_actionzone_find_xy	(	ScrArea *	area,
		const int	xy[2] )

Definition at line 1109 of file screen_ops.cc.

References area_actionzone_refresh_xy(), and xy.

Referenced by actionzone_modal(), area_move_init(), ED_screen_area_active(), ED_screen_draw_edges(), and screen_cursor_set().

◆ ED_area_data_copy()

void ED_area_data_copy	(	ScrArea *	area_dst,
		ScrArea *	area_src,
		bool	do_free )

We swap spaces for full-screen to keep all allocated data area vertices were set.

Definition at line 2378 of file area.cc.

References BKE_area_region_copy(), BKE_area_region_free(), BKE_spacedata_copylist(), BKE_spacedata_freelist(), BKE_spacetype_from_id(), BLI_addtail(), BLI_freelistN(), ScrArea::flag, HEADER_NO_PULLDOWN, LISTBASE_FOREACH, ScrArea::regionbase, ScrArea::spacedata, ScrArea::spacetype, and ScrArea::type.

Referenced by area_dupli_fn(), area_split(), ED_area_swapspace(), ED_workspace_layout_duplicate(), and screen_data_copy().

◆ ED_area_data_swap()

void ED_area_data_swap	(	ScrArea *	area_dst,
		ScrArea *	area_src )

Definition at line 2411 of file area.cc.

References ScrArea::regionbase, ScrArea::spacedata, ScrArea::spacetype, and ScrArea::type.

Referenced by ED_screen_state_toggle(), and screen_state_to_nonnormal().

◆ ed_screen_context()

int ed_screen_context	(	const bContext *	C,
		const char *	member,
		bContextDataResult *	result )

Entry point for the screen context.

Definition at line 1223 of file screen_context.cc.

References C, CTX_data_dir(), CTX_data_dir_set(), CTX_RESULT_MEMBER_NOT_FOUND, CTX_RESULT_OK, ensure_ed_screen_context_functions(), blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::lookup_default(), result, and screen_context_dir.

Referenced by screen_refresh_if_needed().

◆ region_toggle_hidden()

void region_toggle_hidden	(	bContext *	C,
		ARegion *	region,
		bool	do_fade )

Definition at line 2358 of file area.cc.

References C, CTX_wm_area(), ED_region_visibility_change_update(), ED_region_visibility_change_update_animated(), ARegion::flag, ARegion::overlap, RGN_FLAG_HIDDEN, U, and USER_REDUCE_MOTION.

Referenced by ED_region_toggle_hidden(), and region_scale_toggle_hidden().

◆ screen_add()

bScreen * screen_add	(	Main *	bmain,
		const char *	name,
		const rcti *	rect )

Empty screen, with 1 dummy area without space-data. Uses window size.

Definition at line 198 of file screen_edit.cc.

References BKE_libblock_alloc(), bScreen::do_refresh, ID_SCR, name, bScreen::redraws_flag, screen_addarea(), screen_geom_edge_add(), screen_geom_vertex_add(), SPACE_EMPTY, TIME_ALL_3D_WIN, TIME_ALL_ANIM_WIN, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by ED_workspace_layout_add().

◆ screen_animate_area_highlight()

void screen_animate_area_highlight	(	wmWindow *	win,
		bScreen *	screen,
		const rcti *	rect,
		float	inner[4],
		float	outline[4],
		float	seconds )

Definition at line 720 of file screen_draw.cc.

References area_animate_highlight_cb(), BLI_rctf_rcti_copy(), BLI_time_now_seconds(), copy_v4_v4(), data, MEM_callocN(), and WM_draw_cb_activate().

Referenced by area_close_exec(), area_docking_apply(), area_join_apply(), area_join_modal(), area_split_modal(), and screen_area_join_ex().

◆ screen_area_close()

bool screen_area_close	(	bContext *	C,
		ReportList *	reports,
		bScreen *	screen,
		ScrArea *	area )

Close a screen area, allowing most-aligned neighbor to take its place.

Definition at line 604 of file screen_edit.cc.

References area_getorientation(), bScreen::areabase, C, float, LISTBASE_FOREACH, screen_area_join_ex(), SCREEN_DIR_IS_VERTICAL, SCREEN_DIR_NONE, ScrArea::v1, ScrArea::v3, ScrVert::vec, vec2s::x, and vec2s::y.

Referenced by area_close_exec(), area_docking_apply(), area_join_modal(), and screen_area_join_ex().

◆ screen_area_join()

int screen_area_join	(	bContext *	C,
		ReportList *	reports,
		bScreen *	screen,
		ScrArea *	sa1,
		ScrArea *	sa2 )

Join any two neighboring areas. Might involve complex changes.

Definition at line 599 of file screen_edit.cc.

References C, and screen_area_join_ex().

Referenced by area_docking_apply(), area_join_apply(), and area_split_cancel().

◆ screen_area_spacelink_add()

void screen_area_spacelink_add	(	const Scene *	scene,
		ScrArea *	area,
		eSpace_Type	space_type )

Definition at line 636 of file screen_edit.cc.

References BKE_spacetype_from_id(), BLI_addhead(), BLI_listbase_clear(), SpaceType::create, ScrArea::regionbase, SpaceLink::regionbase, and ScrArea::spacedata.

Referenced by area_init_type_fallback(), ED_area_offscreen_create(), and screen_global_area_refresh().

◆ screen_change_prepare()

void screen_change_prepare	(	bScreen *	screen_old,
		bScreen *	screen_new,
		Main *	bmain,
		bContext *	C,
		wmWindow *	win )

Returns: the screen to activate.

Warning: The returned screen may not always equal screen_new!

Definition at line 1371 of file screen_edit.cc.

References bScreen::animtimer, bScreen::areabase, BLI_assert, BLI_findindex(), C, CTX_wm_manager(), ED_screen_exit(), LISTBASE_FOREACH, wmWindow::modalhandlers, Main::screens, UI_popup_handlers_remove_all(), UNUSED_VARS_NDEBUG, WM_event_remove_handlers_by_area(), and WM_event_timer_sleep().

Referenced by ED_screen_change(), and ED_workspace_change().

◆ screen_change_update()

void screen_change_update	(	bContext *	C,
		wmWindow *	win,
		bScreen *	screen )

Definition at line 1407 of file screen_edit.cc.

References BKE_screen_view3d_scene_sync(), BKE_workspace_active_get(), BKE_workspace_layout_find(), C, CTX_wm_manager(), CTX_wm_window_set(), ED_screen_refresh(), NC_SCREEN, NC_WINDOW, ND_LAYOUTSET, WM_event_add_mousemove(), WM_event_add_notifier(), WM_window_get_active_scene(), and wmWindow::workspace_hook.

Referenced by ED_screen_change(), and ED_workspace_change().

◆ screen_data_copy()

void screen_data_copy	(	bScreen *	to,
		bScreen *	from )

Definition at line 220 of file screen_edit.cc.

References bScreen::areabase, BKE_screen_free_data(), BKE_screen_sort_scrvert(), BLI_duplicatelist(), BLI_listbase_clear(), ED_area_data_copy(), bScreen::edgebase, ListBase::first, bScreen::flag, LISTBASE_FOREACH, ScrVert::newv, ScrArea::next, ScrVert::next, bScreen::regionbase, ScrArea::v1, and bScreen::vertbase.

Referenced by ED_workspace_layout_duplicate().

◆ screen_draw_dock_preview()

void screen_draw_dock_preview	(	const wmWindow *	win,
		ScrArea *	source,
		ScrArea *	target,
		AreaDockTarget	dock_target,
		float	factor,
		int	x,
		int	y,
		float	anim_factor )