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