Blender V5.3
screen_intern.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "DNA_space_types.h"
12
13namespace blender {
14
15struct ARegion;
16struct AZone;
17struct ReportList;
18struct bContext;
20struct bScreen;
21struct Main;
22struct rcti;
23struct ScrArea;
24struct ScrAreaMap;
25struct ScrEdge;
26struct ScrVert;
27struct WorkSpaceLayout;
28struct wmOperatorType;
29struct wmWindow;
30struct wmWindowManager;
31
32/* internal exports only */
33
46
47#define SCREEN_DIR_IS_VERTICAL(dir) (ELEM(dir, SCREEN_DIR_N, SCREEN_DIR_S))
48#define SCREEN_DIR_IS_HORIZONTAL(dir) (ELEM(dir, SCREEN_DIR_W, SCREEN_DIR_E))
49
56
57enum class AreaDockTarget {
58 None,
59 Right, /* Right diagonal quadrant of area. */
60 Left, /* Left diagonal quadrant of area. */
61 Top, /* Top diagonal quadrant of area. */
62 Bottom, /* Bottom diagonal quadrant of area. */
63 Center, /* Middle portion of area. */
64};
65
66#define AZONEFADEIN (5.0f * U.widget_unit) /* when #AZone is totally visible */
67#define AZONEFADEOUT (6.5f * U.widget_unit) /* when we start seeing the #AZone */
68
69/* Edges must be within these to allow joining. */
70#define AREAJOINTOLERANCEX (AREAMINX * UI_SCALE_FAC)
71#define AREAJOINTOLERANCEY (HEADERY * UI_SCALE_FAC)
72
73/* Edges must be within this amount to allow aligned edge merging and moving. */
74#define EDGE_ALIGN_TOLERANCE (7 * UI_SCALE_FAC)
75
79#define BORDERPADDING (U.border_width * UI_SCALE_FAC + 3.0f * UI_SCALE_FAC)
80
84#define EDITORRADIUS (6.0f * UI_SCALE_FAC)
85
86/* Less expansion needed for global edges. */
87#define BORDERPADDING_GLOBAL (3.0f * UI_SCALE_FAC)
88
89#define AREA_CLOSE_FADEOUT 0.15f /* seconds */
90#define AREA_DOCK_FADEOUT 0.15f /* seconds */
91#define AREA_DOCK_FADEIN 0.15f /* seconds */
92#define AREA_JOIN_FADEOUT 0.15f /* seconds */
93#define AREA_SPLIT_FADEOUT 0.15f /* seconds */
94#define AREA_MOVE_LINE_FADEIN 0.1f /* seconds */
95#define AREA_MOVE_LINE_FADEOUT 0.15f /* seconds */
96
97/* `area.cc` */
98
102void ED_area_data_copy(ScrArea *area_dst, ScrArea *area_src, bool do_free);
103void ED_area_data_swap(ScrArea *area_dst, ScrArea *area_src);
104/* for quick toggle, can skip fades */
105void region_toggle_hidden(bContext *C, ARegion *region, bool do_fade);
106
107/* `screen_draw.cc` */
108
116 const wmWindow *win, ScrArea *sa1, ScrArea *sa2, eScreenDir dir, float anim_factor);
117void screen_draw_dock_preview(const wmWindow *win,
118 ScrArea *source,
119 ScrArea *target,
120 AreaDockTarget dock_target,
121 float factor,
122 int x,
123 int y,
124 float anim_factor);
125void screen_draw_split_preview(ScrArea *area, eScreenAxis dir_axis, float factor);
126
127void screen_draw_move_highlight(const wmWindow *win,
128 bScreen *screen,
129 eScreenAxis dir_axis,
130 float anim_factor);
131
132void screen_draw_region_scale_highlight(ARegion *region);
133
134void screen_animate_area_highlight(wmWindow *win,
135 bScreen *screen,
136 const rcti *rect,
137 float inner[4],
138 float outline[4],
139 float seconds);
140
141/* `screen_edit.cc` */
142
146bScreen *screen_add(Main *bmain, const char *name, const rcti *rect);
150void screen_new_activate_prepare(const wmWindow *win, bScreen *screen_new);
151void screen_change_update(bContext *C, wmWindow *win, bScreen *screen);
157 bScreen *screen_old, bScreen *screen_new, Main *bmain, bContext *C, wmWindow *win);
158ScrArea *area_split(
159 const wmWindow *win, bScreen *screen, ScrArea *area, eScreenAxis dir_axis, float fac);
164 bContext *C, ReportList *reports, bScreen *screen, ScrArea *sa1, ScrArea *sa2);
170eScreenDir area_getorientation(ScrArea *sa_a, ScrArea *sa_b);
174void area_getoffsets(ScrArea *sa_a, ScrArea *sa_b, eScreenDir dir, int *r_offset1, int *r_offset2);
180 bContext *C, ReportList *reports, bScreen *screen, ScrArea *area, ScrArea *not_area = nullptr);
181
182void screen_area_spacelink_add(const Scene *scene, ScrArea *area, eSpace_Type space_type);
183AZone *ED_area_actionzone_find_xy(ScrArea *area, const int xy[2]);
184
188bool area_regions_poll(bContext *C, const bScreen *screen, ScrArea *area);
189
190/* `screen_geometry.cc` */
191
192int screen_geom_area_height(const ScrArea *area);
193int screen_geom_area_width(const ScrArea *area);
194ScrVert *screen_geom_vertex_add_ex(ScrAreaMap *area_map, short x, short y);
195ScrVert *screen_geom_vertex_add(bScreen *screen, short x, short y);
196ScrEdge *screen_geom_edge_add_ex(ScrAreaMap *area_map, ScrVert *v1, ScrVert *v2);
197ScrEdge *screen_geom_edge_add(bScreen *screen, ScrVert *v1, ScrVert *v2);
198bool screen_geom_edge_is_horizontal(ScrEdge *se);
203ScrEdge *screen_geom_area_map_find_active_scredge(const ScrAreaMap *area_map,
204 const rcti *bounds_rect,
205 int mx,
206 int my,
207 int safety = BORDERPADDING);
211ScrEdge *screen_geom_find_active_scredge(const wmWindow *win,
212 const bScreen *screen,
213 int mx,
214 int my);
222void screen_geom_vertices_scale(const wmWindow *win, bScreen *screen);
226short screen_geom_find_area_split_point(const ScrArea *area,
227 const rcti *window_rect,
228 eScreenAxis dir_axis,
229 float fac);
233void screen_geom_select_connected_edge(const wmWindow *win, ScrEdge *edge);
234
238void screen_geom_select_extended_edge(const wmWindow *win, ScrEdge *edge);
239
243bool screen_geom_edge_can_extend(const wmWindow *win, ScrEdge *edge);
244
248void screen_geom_edge_aligned_merge(const wmWindow *win, ScrEdge *edge);
249
250/* `screen_context.cc` */
251
255int ed_screen_context(const bContext *C, const char *member, bContextDataResult *result);
256
257extern "C" const char *screen_context_dir[]; /* doc access */
258
259/* `screen_ops.cc` */
260
265void screen_stop_playback(Main *bmain, wmWindowManager *wm, wmWindow *win, bScreen *screen);
266
267/* `screendump.cc` */
268
269void SCREEN_OT_screenshot(wmOperatorType *ot);
270void SCREEN_OT_screenshot_area(wmOperatorType *ot);
271
272/* `workspace_layout_edit.cc` */
273
274bool workspace_layout_set_poll(const WorkSpaceLayout *layout);
275
276} // namespace blender
#define C
Definition RandGen.cpp:29
Definition scene.h:133
BMesh Iterators.
void screen_stop_playback(Main *bmain, wmWindowManager *wm, wmWindow *win, bScreen *screen)
eScreenDir area_getorientation(ScrArea *sa_a, ScrArea *sa_b)
bool screen_area_close(bContext *C, ReportList *reports, bScreen *screen, ScrArea *area, ScrArea *not_area)
int screen_area_join(bContext *C, ReportList *reports, bScreen *screen, ScrArea *sa1, ScrArea *sa2)
void ED_area_data_copy(ScrArea *area_dst, ScrArea *area_src, const bool do_free)
Definition area.cc:2628
int ed_screen_context(const bContext *C, const char *member, bContextDataResult *result)
ScrEdge * screen_geom_find_active_scredge(const wmWindow *win, const bScreen *screen, const int mx, const int my)
ScrArea * area_split(const wmWindow *win, bScreen *screen, ScrArea *area, const eScreenAxis dir_axis, const float fac)
void screen_draw_split_preview(ScrArea *area, const eScreenAxis dir_axis, const float factor)
ScrVert * screen_geom_vertex_add_ex(ScrAreaMap *area_map, short x, short y)
bool screen_geom_edge_can_extend(const wmWindow *win, ScrEdge *edge)
bool workspace_layout_set_poll(const WorkSpaceLayout *layout)
void screen_change_prepare(bScreen *screen_old, bScreen *screen_new, Main *bmain, bContext *C, wmWindow *win)
AZone * ED_area_actionzone_find_xy(ScrArea *area, const int xy[2])
int screen_geom_area_width(const ScrArea *area)
void ED_area_data_swap(ScrArea *area_dst, ScrArea *area_src)
Definition area.cc:2637
ScrVert * screen_geom_vertex_add(bScreen *screen, short x, short y)
void SCREEN_OT_screenshot_area(wmOperatorType *ot)
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, const eScreenAxis dir_axis, float fac)
ScrEdge * screen_geom_area_map_find_active_scredge(const ScrAreaMap *area_map, const rcti *bounds_rect, const int mx, const int my, int safety)
void screen_draw_dock_preview(const wmWindow *win, ScrArea *source, ScrArea *target, AreaDockTarget dock_target, float factor, int x, int y, float anim_factor)
bool screen_geom_edge_is_horizontal(ScrEdge *se)
void area_getoffsets(ScrArea *sa_a, ScrArea *sa_b, const eScreenDir dir, int *r_offset1, int *r_offset2)
ScrEdge * screen_geom_edge_add_ex(ScrAreaMap *area_map, ScrVert *v1, ScrVert *v2)
bool area_regions_poll(bContext *C, const bScreen *screen, ScrArea *area)
void screen_geom_select_connected_edge(const wmWindow *win, ScrEdge *edge)
void screen_animate_area_highlight(wmWindow *win, bScreen *screen, const rcti *rect, float inner[4], float outline[4], float seconds)
ATTR_WARN_UNUSED_RESULT const BMVert * v2
void screen_geom_select_extended_edge(const wmWindow *win, ScrEdge *edge)
ScrEdge * screen_geom_edge_add(bScreen *screen, ScrVert *v1, ScrVert *v2)
void screen_draw_join_highlight(const wmWindow *win, ScrArea *sa1, ScrArea *sa2, eScreenDir dir, float anim_factor)
bScreen * screen_add(Main *bmain, const char *name, const rcti *rect)
int screen_geom_area_height(const ScrArea *area)
const char * screen_context_dir[]
void screen_change_update(bContext *C, wmWindow *win, bScreen *screen)
void region_toggle_hidden(bContext *C, ARegion *region, const bool do_fade)
Definition area.cc:2606
void screen_new_activate_prepare(const wmWindow *win, bScreen *screen_new)
void screen_draw_move_highlight(const wmWindow *win, bScreen *screen, eScreenAxis dir_axis, float anim_factor)
void SCREEN_OT_screenshot(wmOperatorType *ot)
void screen_geom_edge_aligned_merge(const wmWindow *win, ScrEdge *edge)
void screen_draw_region_scale_highlight(ARegion *region)
void screen_area_spacelink_add(const Scene *scene, ScrArea *area, eSpace_Type space_type)
#define BORDERPADDING