Code cleanup: simplify subwindow code.
[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 "BLI_compiler_attrs.h"
41
42 struct Depsgraph;
43 struct wmWindowManager;
44 struct wmWindow;
45 struct wmNotifier;
46 struct wmEvent;
47 struct wmKeyConfig;
48 struct WorkSpace;
49 struct WorkSpaceInstanceHook;
50 struct bContext;
51 struct Scene;
52 struct ViewLayer;
53 struct bScreen;
54 struct ARegion;
55 struct uiBlock;
56 struct rcti;
57 struct Main;
58 struct wmMsgBus;
59 struct wmMsgSubscribeKey;
60 struct wmMsgSubscribeValue;
61
62 /* regions */
63 void    ED_region_do_listen(
64         struct bScreen *sc, struct ScrArea *sa, struct ARegion *ar,
65         struct wmNotifier *note, const Scene *scene);
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 bContext *C, struct ARegion *ar);
70 void    ED_region_init(struct bContext *C, 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_refresh_ui(struct ARegion *ar);
75 void    ED_region_panels_init(struct wmWindowManager *wm, struct ARegion *ar);
76 void    ED_region_panels(
77             const struct bContext *C, struct ARegion *ar,
78             const char *context, int contextnr,
79             const bool vertical);
80 void    ED_region_header_init(struct ARegion *ar);
81 void    ED_region_header(const struct bContext *C, struct ARegion *ar);
82 void    ED_region_cursor_set(struct wmWindow *win, struct ScrArea *sa, struct ARegion *ar);
83 void    ED_region_toggle_hidden(struct bContext *C, struct ARegion *ar);
84 void    ED_region_info_draw(struct ARegion *ar, const char *text, float fill_color[4], const bool full_redraw);
85 void    ED_region_info_draw_multiline(ARegion *ar, const char *text_array[], float fill_color[4], const bool full_redraw);
86 void    ED_region_image_metadata_draw(int x, int y, struct ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy);
87 void    ED_region_grid_draw(struct ARegion *ar, float zoomx, float zoomy);
88 float   ED_region_blend_factor(struct ARegion *ar);
89 void    ED_region_visible_rect(struct ARegion *ar, struct rcti *rect);
90
91 /* message_bus callbacks */
92 void ED_region_do_msg_notify_tag_redraw(
93         struct bContext *C, struct wmMsgSubscribeKey *msg_key, struct wmMsgSubscribeValue *msg_val);
94 void ED_area_do_msg_notify_tag_refresh(
95         struct bContext *C, struct wmMsgSubscribeKey *msg_key, struct wmMsgSubscribeValue *msg_val);
96
97 /* message bus */
98 void ED_region_message_subscribe(
99         struct bContext *C,
100         struct WorkSpace *workspace, struct Scene *scene,
101         struct bScreen *screen, struct ScrArea *sa, struct ARegion *ar,
102         struct wmMsgBus *mbus);
103
104 /* spaces */
105 void    ED_spacetypes_keymap(struct wmKeyConfig *keyconf);
106 int     ED_area_header_switchbutton(const struct bContext *C, struct uiBlock *block, int yco);
107
108 /* areas */
109 void    ED_area_initialize(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa);
110 void    ED_area_exit(struct bContext *C, struct ScrArea *sa);
111 int     ED_screen_area_active(const struct bContext *C);
112 void    ED_area_do_listen(struct bScreen *sc, ScrArea *sa, struct wmNotifier *note, Scene *scene,
113                           struct WorkSpace *workspace);
114 void    ED_area_tag_redraw(ScrArea *sa);
115 void    ED_area_tag_redraw_regiontype(ScrArea *sa, int type);
116 void    ED_area_tag_refresh(ScrArea *sa);
117 void    ED_area_do_refresh(struct bContext *C, ScrArea *sa);
118 void    ED_area_azones_update(ScrArea *sa, const int mouse_xy[]);
119 void    ED_area_headerprint(ScrArea *sa, const char *str);
120 void    ED_area_newspace(struct bContext *C, ScrArea *sa, int type, const bool skip_ar_exit);
121 void    ED_area_prevspace(struct bContext *C, ScrArea *sa);
122 void    ED_area_swapspace(struct bContext *C, ScrArea *sa1, ScrArea *sa2);
123 int     ED_area_headersize(void);
124
125 /* screens */
126 void    ED_screens_initialize(struct wmWindowManager *wm);
127 void    ED_screen_draw_edges(struct wmWindow *win);
128 void    ED_screen_draw_join_shape(struct ScrArea *sa1, struct ScrArea *sa2);
129 void    ED_screen_draw_split_preview(struct ScrArea *sa, const int dir, const float fac);
130 void    ED_screen_refresh(struct wmWindowManager *wm, struct wmWindow *win);
131 void    ED_screen_do_listen(struct bContext *C, struct wmNotifier *note);
132 bool    ED_screen_change(struct bContext *C, struct bScreen *sc);
133 void    ED_screen_update_after_scene_change(
134         const struct bScreen *screen,
135         struct Scene *scene_new,
136         struct ViewLayer *view_layer);
137 void    ED_screen_set_subwinactive(struct bContext *C, const struct wmEvent *event);
138 void    ED_screen_exit(struct bContext *C, struct wmWindow *window, struct bScreen *screen);
139 void    ED_screen_animation_timer(struct bContext *C, int redraws, int refresh, int sync, int enable);
140 void    ED_screen_animation_timer_update(struct bScreen *screen, int redraws, int refresh);
141 void    ED_screen_restore_temp_type(struct bContext *C, ScrArea *sa);
142 ScrArea *ED_screen_full_newspace(struct bContext *C, ScrArea *sa, int type);
143 void    ED_screen_full_prevspace(struct bContext *C, ScrArea *sa);
144 void    ED_screen_full_restore(struct bContext *C, ScrArea *sa);
145 struct ScrArea *ED_screen_state_toggle(struct bContext *C, struct wmWindow *win, struct ScrArea *sa, const short state);
146 void    ED_screens_header_tools_menu_create(struct bContext *C, struct uiLayout *layout, void *arg);
147 bool    ED_screen_stereo3d_required(const struct bScreen *screen, const struct Scene *scene);
148 Scene   *ED_screen_scene_find(const struct bScreen *screen, const struct wmWindowManager *wm);
149 Scene   *ED_screen_scene_find_with_window(const struct bScreen *screen, const struct wmWindowManager *wm, struct wmWindow **r_window);
150 struct wmWindow *ED_screen_window_find(const struct bScreen *screen, const struct wmWindowManager *wm);
151 void    ED_screen_preview_render(const struct bScreen *screen, int size_x, int size_y, unsigned int *r_rect) ATTR_NONNULL();
152
153 /* workspaces */
154 struct WorkSpace *ED_workspace_add(
155         struct Main *bmain,
156         const char *name,
157         Scene *scene,
158         ViewLayer *act_render_layer,
159         struct ViewRender *view_render) ATTR_NONNULL();
160 bool ED_workspace_change(
161         struct WorkSpace *workspace_new,
162         struct bContext *C,
163         struct wmWindow *win) ATTR_NONNULL();
164 struct WorkSpace *ED_workspace_duplicate(
165         struct WorkSpace *workspace_old,
166         struct Main *bmain, struct wmWindow *win);
167 bool ED_workspace_delete(
168         struct WorkSpace *workspace,
169         struct Main *bmain, struct bContext *C,
170         struct wmWindowManager *wm) ATTR_NONNULL();
171 void ED_workspace_scene_data_sync(
172         struct WorkSpaceInstanceHook *hook, Scene *scene) ATTR_NONNULL();
173 void ED_workspace_view_layer_unset(
174         const struct Main *bmain, struct Scene *scene,
175         const ViewLayer *layer_unset, ViewLayer *layer_new) ATTR_NONNULL(1, 2);
176 struct WorkSpaceLayout *ED_workspace_layout_add(
177         struct WorkSpace *workspace,
178         struct wmWindow *win,
179         const char *name) ATTR_NONNULL();
180 struct WorkSpaceLayout *ED_workspace_layout_duplicate(
181         struct WorkSpace *workspace, const struct WorkSpaceLayout *layout_old,
182         struct wmWindow *win) ATTR_NONNULL();
183 bool ED_workspace_layout_delete(
184         struct WorkSpace *workspace, struct WorkSpaceLayout *layout_old,
185         struct bContext *C) ATTR_NONNULL();
186 bool ED_workspace_layout_cycle(
187         struct WorkSpace *workspace, const short direction,
188         struct bContext *C) ATTR_NONNULL();
189
190 /* anim */
191 void    ED_update_for_newframe(struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer, struct Depsgraph *depsgraph);
192
193 void    ED_refresh_viewport_fps(struct bContext *C);
194 int             ED_screen_animation_play(struct bContext *C, int sync, int mode);
195 bScreen *ED_screen_animation_playing(const struct wmWindowManager *wm);
196 bScreen *ED_screen_animation_no_scrub(const struct wmWindowManager *wm);
197
198 /* screen keymaps */
199 void    ED_operatortypes_screen(void);
200 void    ED_keymap_screen(struct wmKeyConfig *keyconf);
201 /* workspace keymaps */
202 void    ED_operatortypes_workspace(void);
203
204 /* operators; context poll callbacks */
205 int     ED_operator_screenactive(struct bContext *C);
206 int     ED_operator_screen_mainwinactive(struct bContext *C);
207 int     ED_operator_areaactive(struct bContext *C);
208 int     ED_operator_regionactive(struct bContext *C);
209
210 int     ED_operator_scene_editable(struct bContext *C);
211 int     ED_operator_objectmode(struct bContext *C);
212
213 int     ED_operator_view3d_active(struct bContext *C);
214 int     ED_operator_region_view3d_active(struct bContext *C);
215 int     ED_operator_animview_active(struct bContext *C);
216 int     ED_operator_timeline_active(struct bContext *C);
217 int     ED_operator_outliner_active(struct bContext *C);
218 int     ED_operator_outliner_active_no_editobject(struct bContext *C);
219 int     ED_operator_file_active(struct bContext *C);
220 int     ED_operator_action_active(struct bContext *C);
221 int     ED_operator_buttons_active(struct bContext *C);
222 int     ED_operator_node_active(struct bContext *C);
223 int     ED_operator_node_editable(struct bContext *C);
224 int     ED_operator_graphedit_active(struct bContext *C);
225 int     ED_operator_sequencer_active(struct bContext *C);
226 int     ED_operator_sequencer_active_editable(struct bContext *C);
227 int     ED_operator_image_active(struct bContext *C);
228 int     ED_operator_nla_active(struct bContext *C);
229 int     ED_operator_logic_active(struct bContext *C);
230 int     ED_operator_info_active(struct bContext *C);
231 int     ED_operator_console_active(struct bContext *C);
232
233
234 int     ED_operator_object_active(struct bContext *C);
235 int     ED_operator_object_active_editable(struct bContext *C);
236 int     ED_operator_object_active_editable_mesh(struct bContext *C);
237 int     ED_operator_object_active_editable_font(struct bContext *C);
238 int     ED_operator_editmesh(struct bContext *C);
239 int     ED_operator_editmesh_view3d(struct bContext *C);
240 int     ED_operator_editmesh_region_view3d(struct bContext *C);
241 int     ED_operator_editarmature(struct bContext *C);
242 int     ED_operator_editcurve(struct bContext *C);
243 int     ED_operator_editcurve_3d(struct bContext *C);
244 int     ED_operator_editsurf(struct bContext *C);
245 int     ED_operator_editsurfcurve(struct bContext *C);
246 int     ED_operator_editsurfcurve_region_view3d(struct bContext *C);
247 int     ED_operator_editfont(struct bContext *C);
248 int     ED_operator_editlattice(struct bContext *C);
249 int     ED_operator_editmball(struct bContext *C);
250 int     ED_operator_uvedit(struct bContext *C);
251 int     ED_operator_uvedit_space_image(struct bContext *C);
252 int     ED_operator_uvmap(struct bContext *C);
253 int     ED_operator_posemode_exclusive(struct bContext *C);
254 int     ED_operator_posemode_context(struct bContext *C);
255 int     ED_operator_posemode(struct bContext *C);
256 int     ED_operator_posemode_local(struct bContext *C);
257 int     ED_operator_mask(struct bContext *C);
258 int     ED_operator_camera(struct bContext *C);
259
260
261 /* Cache display helpers */
262
263 void ED_region_cache_draw_background(const struct ARegion *ar);
264 void ED_region_cache_draw_curfra_label(const int framenr, const float x, const float y);
265 void ED_region_cache_draw_cached_segments(const struct ARegion *ar, const int num_segments, const int *points, const int sfra, const int efra);
266
267 /* default keymaps, bitflags */
268 #define ED_KEYMAP_UI        1
269 #define ED_KEYMAP_VIEW2D    2
270 #define ED_KEYMAP_MARKERS   4
271 #define ED_KEYMAP_ANIMATION 8
272 #define ED_KEYMAP_FRAMES    16
273 #define ED_KEYMAP_GPENCIL   32
274 #define ED_KEYMAP_HEADER    64
275
276 #endif /* __ED_SCREEN_H__ */
277