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