Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / include / ED_screen.h
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 \ingroup editors
21  */
22
23 #ifndef __ED_SCREEN_H__
24 #define __ED_SCREEN_H__
25
26 #include "DNA_screen_types.h"
27 #include "DNA_space_types.h"
28 #include "DNA_view2d_types.h"
29 #include "DNA_view3d_types.h"
30 #include "DNA_workspace_types.h"
31
32 #include "DNA_object_enums.h"
33
34 #include "BLI_compiler_attrs.h"
35
36 struct ARegion;
37 struct Depsgraph;
38 struct IDProperty;
39 struct Main;
40 struct MenuType;
41 struct PropertyRNA;
42 struct Scene;
43 struct ViewLayer;
44 struct WorkSpace;
45 struct WorkSpaceInstanceHook;
46 struct bContext;
47 struct bScreen;
48 struct rcti;
49 struct uiBlock;
50 struct wmEvent;
51 struct wmKeyConfig;
52 struct wmMsgBus;
53 struct wmMsgSubscribeKey;
54 struct wmMsgSubscribeValue;
55 struct wmNotifier;
56 struct wmOperatorType;
57 struct wmWindow;
58 struct wmWindowManager;
59
60 /* regions */
61 void    ED_region_do_listen(
62         struct wmWindow *win, struct ScrArea *sa, struct ARegion *ar,
63         struct wmNotifier *note, const Scene *scene);
64 void    ED_region_do_layout(struct bContext *C, struct ARegion *ar);
65 void    ED_region_do_draw(struct bContext *C, struct ARegion *ar);
66 void    ED_region_exit(struct bContext *C, struct ARegion *ar);
67 void    ED_region_pixelspace(struct ARegion *ar);
68 void    ED_region_update_rect(struct ARegion *ar);
69 void    ED_region_init(struct ARegion *ar);
70 void    ED_region_tag_redraw(struct ARegion *ar);
71 void    ED_region_tag_redraw_partial(struct ARegion *ar, const struct rcti *rct);
72 void    ED_region_tag_redraw_overlay(struct ARegion *ar);
73 void    ED_region_tag_redraw_no_rebuild(struct ARegion *ar);
74 void    ED_region_tag_refresh_ui(struct ARegion *ar);
75
76 void ED_region_panels_init(struct wmWindowManager *wm, struct ARegion *ar);
77 void ED_region_panels_ex(
78         const struct bContext *C, struct ARegion *ar,
79         const char *contexts[], int contextnr, const bool vertical);
80 void ED_region_panels(
81         const struct bContext *C, struct ARegion *ar);
82 void ED_region_panels_layout_ex(
83         const struct bContext *C, struct ARegion *ar,
84         const char *contexts[], int contextnr, const bool vertical);
85 void ED_region_panels_layout(
86         const struct bContext *C, struct ARegion *ar);
87 void ED_region_panels_draw(
88         const struct bContext *C, struct ARegion *ar);
89
90 void ED_region_header_init(struct ARegion *ar);
91 void ED_region_header(const struct bContext *C, struct ARegion *ar);
92 void ED_region_header_layout(const struct bContext *C, struct ARegion *ar);
93 void ED_region_header_draw(const struct bContext *C, struct ARegion *ar);
94
95 void    ED_region_cursor_set(struct wmWindow *win, struct ScrArea *sa, struct ARegion *ar);
96 void    ED_region_toggle_hidden(struct bContext *C, struct ARegion *ar);
97 void    ED_region_visibility_change_update(struct bContext *C, struct ARegion *ar);
98 void    ED_region_info_draw(struct ARegion *ar, const char *text, float fill_color[4], const bool full_redraw);
99 void    ED_region_info_draw_multiline(ARegion *ar, const char *text_array[], float fill_color[4], const bool full_redraw);
100 void    ED_region_image_metadata_draw(int x, int y, struct ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy);
101 void    ED_region_grid_draw(struct ARegion *ar, float zoomx, float zoomy);
102 float   ED_region_blend_alpha(struct ARegion *ar);
103 void    ED_region_visible_rect(struct ARegion *ar, struct rcti *rect);
104 bool    ED_region_is_overlap(int spacetype, int regiontype);
105
106 int     ED_region_snap_size_test(const struct ARegion *ar);
107 bool    ED_region_snap_size_apply(struct ARegion *ar, int snap_flag);
108
109 /* message_bus callbacks */
110 void ED_region_do_msg_notify_tag_redraw(
111         struct bContext *C, struct wmMsgSubscribeKey *msg_key, struct wmMsgSubscribeValue *msg_val);
112 void ED_area_do_msg_notify_tag_refresh(
113         struct bContext *C, struct wmMsgSubscribeKey *msg_key, struct wmMsgSubscribeValue *msg_val);
114
115 /* message bus */
116 void ED_region_message_subscribe(
117         struct bContext *C,
118         struct WorkSpace *workspace, struct Scene *scene,
119         struct bScreen *screen, struct ScrArea *sa, struct ARegion *ar,
120         struct wmMsgBus *mbus);
121
122 /* spaces */
123 void    ED_spacetypes_keymap(struct wmKeyConfig *keyconf);
124 int     ED_area_header_switchbutton(const struct bContext *C, struct uiBlock *block, int yco);
125
126 /* areas */
127 void    ED_area_initialize(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa);
128 void    ED_area_exit(struct bContext *C, struct ScrArea *sa);
129 int     ED_screen_area_active(const struct bContext *C);
130 void    ED_screen_global_areas_refresh(struct wmWindow *win);
131 void    ED_screen_global_areas_sync(struct wmWindow *win);
132 void    ED_area_do_listen(struct wmWindow *win, ScrArea *sa, struct wmNotifier *note, Scene *scene);
133 void    ED_area_tag_redraw(ScrArea *sa);
134 void    ED_area_tag_redraw_no_rebuild(ScrArea *sa);
135 void    ED_area_tag_redraw_regiontype(ScrArea *sa, int type);
136 void    ED_area_tag_refresh(ScrArea *sa);
137 void    ED_area_do_refresh(struct bContext *C, ScrArea *sa);
138 struct AZone *ED_area_azones_update(ScrArea *sa, const int mouse_xy[]);
139 void    ED_area_status_text(ScrArea *sa, const char *str);
140 void    ED_area_newspace(struct bContext *C, ScrArea *sa, int type, const bool skip_ar_exit);
141 void    ED_area_prevspace(struct bContext *C, ScrArea *sa);
142 void    ED_area_swapspace(struct bContext *C, ScrArea *sa1, ScrArea *sa2);
143 int     ED_area_headersize(void);
144 int     ED_area_header_alignment_or_fallback(const ScrArea *area, int fallback);
145 int     ED_area_header_alignment(const ScrArea *area);
146 int     ED_area_global_size_y(const ScrArea *area);
147 int     ED_area_global_min_size_y(const ScrArea *area);
148 int     ED_area_global_max_size_y(const ScrArea *area);
149 bool    ED_area_is_global(const ScrArea *area);
150 int     ED_region_global_size_y(void);
151 void    ED_area_update_region_sizes(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *area);
152
153 ScrArea *ED_screen_areas_iter_first(const struct wmWindow *win, const bScreen *screen);
154 ScrArea *ED_screen_areas_iter_next(const bScreen *screen, const ScrArea *area);
155 /**
156  * Iterate over all areas visible in the screen (screen as in everything
157  * visible in the window, not just bScreen).
158  * \note Skips global areas with flag GLOBAL_AREA_IS_HIDDEN.
159  */
160 #define ED_screen_areas_iter(win, screen, area_name)                       \
161         for (ScrArea *area_name = ED_screen_areas_iter_first(win, screen);     \
162              area_name != NULL;                                                \
163              area_name = ED_screen_areas_iter_next(screen, area_name))
164 #define ED_screen_verts_iter(win, screen, vert_name)                       \
165         for (ScrVert *vert_name = (win)->global_areas.vertbase.first ?         \
166                                           (win)->global_areas.vertbase.first : \
167                                           screen->vertbase.first;              \
168              vert_name != NULL;                                                \
169              vert_name = (vert_name == (win)->global_areas.vertbase.last) ? (screen)->vertbase.first : vert_name->next)
170
171 /* screens */
172 void    ED_screens_initialize(struct Main *bmain, struct wmWindowManager *wm);
173 void    ED_screen_draw_edges(struct wmWindow *win);
174 void    ED_screen_draw_join_shape(struct ScrArea *sa1, struct ScrArea *sa2);
175 void    ED_screen_draw_split_preview(struct ScrArea *sa, const int dir, const float fac);
176 void    ED_screen_refresh(struct wmWindowManager *wm, struct wmWindow *win);
177 void    ED_screen_ensure_updated(struct wmWindowManager *wm, struct wmWindow *win, struct bScreen *screen);
178 void    ED_screen_do_listen(struct bContext *C, struct wmNotifier *note);
179 bool    ED_screen_change(struct bContext *C, struct bScreen *sc);
180 void    ED_screen_scene_change(struct bContext *C, struct wmWindow *win, struct Scene *scene);
181 void    ED_screen_set_active_region(struct bContext *C, struct wmWindow *win, const int xy[2]);
182 void    ED_screen_exit(struct bContext *C, struct wmWindow *window, struct bScreen *screen);
183 void    ED_screen_animation_timer(struct bContext *C, int redraws, int refresh, int sync, int enable);
184 void    ED_screen_animation_timer_update(struct bScreen *screen, int redraws, int refresh);
185 void    ED_screen_restore_temp_type(struct bContext *C, ScrArea *sa);
186 ScrArea *ED_screen_full_newspace(struct bContext *C, ScrArea *sa, int type);
187 void    ED_screen_full_prevspace(struct bContext *C, ScrArea *sa);
188 void    ED_screen_full_restore(struct bContext *C, ScrArea *sa);
189 struct ScrArea *ED_screen_state_toggle(struct bContext *C, struct wmWindow *win, struct ScrArea *sa, const short state);
190 void    ED_screens_header_tools_menu_create(struct bContext *C, struct uiLayout *layout, void *arg);
191 void    ED_screens_navigation_bar_tools_menu_create(struct bContext *C, struct uiLayout *layout, void *arg);
192 bool    ED_screen_stereo3d_required(const struct bScreen *screen, const struct Scene *scene);
193 Scene   *ED_screen_scene_find(const struct bScreen *screen, const struct wmWindowManager *wm);
194 Scene   *ED_screen_scene_find_with_window(const struct bScreen *screen, const struct wmWindowManager *wm, struct wmWindow **r_window);
195 struct wmWindow *ED_screen_window_find(const struct bScreen *screen, const struct wmWindowManager *wm);
196 void    ED_screen_preview_render(const struct bScreen *screen, int size_x, int size_y, unsigned int *r_rect) ATTR_NONNULL();
197
198 /* workspaces */
199 struct WorkSpace *ED_workspace_add(
200         struct Main *bmain,
201         const char *name) ATTR_NONNULL();
202 bool ED_workspace_change(
203         struct WorkSpace *workspace_new,
204         struct bContext *C,
205         struct wmWindowManager *wm, struct wmWindow *win) ATTR_NONNULL();
206 struct WorkSpace *ED_workspace_duplicate(
207         struct WorkSpace *workspace_old,
208         struct Main *bmain, struct wmWindow *win);
209 bool ED_workspace_delete(
210         struct WorkSpace *workspace,
211         struct Main *bmain, struct bContext *C,
212         struct wmWindowManager *wm) ATTR_NONNULL();
213 void ED_workspace_scene_data_sync(
214         struct WorkSpaceInstanceHook *hook, Scene *scene) ATTR_NONNULL();
215 struct WorkSpaceLayout *ED_workspace_layout_add(
216         struct Main *bmain,
217         struct WorkSpace *workspace,
218         struct wmWindow *win,
219         const char *name) ATTR_NONNULL();
220 struct WorkSpaceLayout *ED_workspace_layout_duplicate(
221         struct Main *bmain,
222         struct WorkSpace *workspace, const struct WorkSpaceLayout *layout_old,
223         struct wmWindow *win) ATTR_NONNULL();
224 bool ED_workspace_layout_delete(
225         struct WorkSpace *workspace, struct WorkSpaceLayout *layout_old,
226         struct bContext *C) ATTR_NONNULL();
227 bool ED_workspace_layout_cycle(
228         struct WorkSpace *workspace, const short direction,
229         struct bContext *C) ATTR_NONNULL();
230
231 void    ED_workspace_status_text(struct bContext *C, const char *str);
232
233 /* anim */
234 void    ED_update_for_newframe(struct Main *bmain, struct Depsgraph *depsgraph);
235
236 void    ED_refresh_viewport_fps(struct bContext *C);
237 int             ED_screen_animation_play(struct bContext *C, int sync, int mode);
238 bScreen *ED_screen_animation_playing(const struct wmWindowManager *wm);
239 bScreen *ED_screen_animation_no_scrub(const struct wmWindowManager *wm);
240
241 /* screen keymaps */
242 void    ED_operatortypes_screen(void);
243 void    ED_keymap_screen(struct wmKeyConfig *keyconf);
244 /* workspace keymaps */
245 void    ED_operatortypes_workspace(void);
246
247 /* operators; context poll callbacks */
248 bool ED_operator_screenactive(struct bContext *C);
249 bool ED_operator_screen_mainwinactive(struct bContext *C);
250 bool ED_operator_areaactive(struct bContext *C);
251 bool ED_operator_regionactive(struct bContext *C);
252
253 bool ED_operator_scene(struct bContext *C);
254 bool ED_operator_scene_editable(struct bContext *C);
255 bool ED_operator_objectmode(struct bContext *C);
256
257 bool ED_operator_view3d_active(struct bContext *C);
258 bool ED_operator_region_view3d_active(struct bContext *C);
259 bool ED_operator_animview_active(struct bContext *C);
260 bool ED_operator_outliner_active(struct bContext *C);
261 bool ED_operator_outliner_active_no_editobject(struct bContext *C);
262 bool ED_operator_file_active(struct bContext *C);
263 bool ED_operator_action_active(struct bContext *C);
264 bool ED_operator_buttons_active(struct bContext *C);
265 bool ED_operator_node_active(struct bContext *C);
266 bool ED_operator_node_editable(struct bContext *C);
267 bool ED_operator_graphedit_active(struct bContext *C);
268 bool ED_operator_sequencer_active(struct bContext *C);
269 bool ED_operator_sequencer_active_editable(struct bContext *C);
270 bool ED_operator_image_active(struct bContext *C);
271 bool ED_operator_nla_active(struct bContext *C);
272 bool ED_operator_info_active(struct bContext *C);
273 bool ED_operator_console_active(struct bContext *C);
274
275
276 bool ED_operator_object_active(struct bContext *C);
277 bool ED_operator_object_active_editable(struct bContext *C);
278 bool ED_operator_object_active_editable_mesh(struct bContext *C);
279 bool ED_operator_object_active_editable_font(struct bContext *C);
280 bool ED_operator_editmesh(struct bContext *C);
281 bool ED_operator_editmesh_view3d(struct bContext *C);
282 bool ED_operator_editmesh_region_view3d(struct bContext *C);
283 bool ED_operator_editmesh_auto_smooth(struct bContext *C);
284 bool ED_operator_editarmature(struct bContext *C);
285 bool ED_operator_editcurve(struct bContext *C);
286 bool ED_operator_editcurve_3d(struct bContext *C);
287 bool ED_operator_editsurf(struct bContext *C);
288 bool ED_operator_editsurfcurve(struct bContext *C);
289 bool ED_operator_editsurfcurve_region_view3d(struct bContext *C);
290 bool ED_operator_editfont(struct bContext *C);
291 bool ED_operator_editlattice(struct bContext *C);
292 bool ED_operator_editmball(struct bContext *C);
293 bool ED_operator_uvedit(struct bContext *C);
294 bool ED_operator_uvedit_space_image(struct bContext *C);
295 bool ED_operator_uvmap(struct bContext *C);
296 bool ED_operator_posemode_exclusive(struct bContext *C);
297 bool ED_operator_posemode_context(struct bContext *C);
298 bool ED_operator_posemode(struct bContext *C);
299 bool ED_operator_posemode_local(struct bContext *C);
300 bool ED_operator_mask(struct bContext *C);
301 bool ED_operator_camera(struct bContext *C);
302
303 /* screen_user_menu.c */
304
305 bUserMenu **ED_screen_user_menus_find(const struct bContext *C, uint *r_len);
306 struct bUserMenu *ED_screen_user_menu_ensure(struct bContext *C);
307
308
309 struct bUserMenuItem_Op *ED_screen_user_menu_item_find_operator(
310         struct ListBase *lb,
311         const struct wmOperatorType *ot, struct IDProperty *prop, short opcontext);
312 struct bUserMenuItem_Menu *ED_screen_user_menu_item_find_menu(
313         struct ListBase *lb,
314         const struct MenuType *mt);
315 struct bUserMenuItem_Prop *ED_screen_user_menu_item_find_prop(
316         struct ListBase *lb,
317         const char *context_data_path, const char *prop_id, int prop_index);
318
319 void ED_screen_user_menu_item_add_operator(
320         struct ListBase *lb, const char *ui_name,
321         const struct wmOperatorType *ot, const struct IDProperty *prop, short opcontext);
322 void ED_screen_user_menu_item_add_menu(
323         struct ListBase *lb, const char *ui_name,
324         const struct MenuType *mt);
325 void ED_screen_user_menu_item_add_prop(
326         ListBase *lb, const char *ui_name,
327         const char *context_data_path, const char *prop_id, int prop_index);
328
329 void ED_screen_user_menu_item_remove(
330         struct ListBase *lb, struct bUserMenuItem *umi);
331 void ED_screen_user_menu_register(void);
332
333 /* Cache display helpers */
334
335 void ED_region_cache_draw_background(const struct ARegion *ar);
336 void ED_region_cache_draw_curfra_label(const int framenr, const float x, const float y);
337 void ED_region_cache_draw_cached_segments(const struct ARegion *ar, const int num_segments, const int *points, const int sfra, const int efra);
338
339 /* area_utils.c */
340 void ED_region_generic_tools_region_message_subscribe(
341         const struct bContext *C,
342         struct WorkSpace *workspace, struct Scene *scene,
343         struct bScreen *screen, struct ScrArea *sa, struct ARegion *ar,
344         struct wmMsgBus *mbus);
345 int ED_region_generic_tools_region_snap_size(const struct ARegion *ar, int size, int axis);
346
347 /* interface_region_hud.c */
348 struct ARegionType *ED_area_type_hud(int space_type);
349 void ED_area_type_hud_clear(struct wmWindowManager *wm, ScrArea *sa_keep);
350 void ED_area_type_hud_ensure(struct bContext *C, struct ScrArea *sa);
351
352 /* default keymaps, bitflags (matches order of evaluation). */
353 enum {
354         ED_KEYMAP_UI        = (1 << 1),
355         ED_KEYMAP_GIZMO     = (1 << 2),
356         ED_KEYMAP_VIEW2D    = (1 << 3),
357         ED_KEYMAP_MARKERS   = (1 << 4),
358         ED_KEYMAP_ANIMATION = (1 << 5),
359         ED_KEYMAP_FRAMES    = (1 << 6),
360         ED_KEYMAP_HEADER    = (1 << 7),
361         ED_KEYMAP_GPENCIL   = (1 << 8),
362 };
363
364 /* SCREEN_OT_space_context_cycle direction */
365 enum {
366         SPACE_CONTEXT_CYCLE_PREV,
367         SPACE_CONTEXT_CYCLE_NEXT,
368 };
369
370 #endif /* __ED_SCREEN_H__ */