Fix a bunch of temp full-screen glitches
[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
39 struct wmWindowManager;
40 struct wmWindow;
41 struct wmNotifier;
42 struct wmEvent;
43 struct wmKeyConfig;
44 struct bContext;
45 struct Scene;
46 struct bScreen;
47 struct ARegion;
48 struct uiBlock;
49 struct rcti;
50
51 /* regions */
52 void    ED_region_do_listen(struct bScreen *sc, struct ScrArea *sa, struct ARegion *ar, struct wmNotifier *note);
53 void    ED_region_do_draw(struct bContext *C, struct ARegion *ar);
54 void    ED_region_exit(struct bContext *C, struct ARegion *ar);
55 void    ED_region_pixelspace(struct ARegion *ar);
56 void    ED_region_set(const struct bContext *C, struct ARegion *ar);
57 void    ED_region_update_rect(struct bContext *C, struct ARegion *ar);
58 void    ED_region_init(struct bContext *C, struct ARegion *ar);
59 void    ED_region_tag_redraw(struct ARegion *ar);
60 void    ED_region_tag_redraw_partial(struct ARegion *ar, const struct rcti *rct);
61 void    ED_region_tag_redraw_overlay(struct ARegion *ar);
62 void    ED_region_tag_refresh_ui(struct ARegion *ar);
63 void    ED_region_panels_init(struct wmWindowManager *wm, struct ARegion *ar);
64 void    ED_region_panels(
65             const struct bContext *C, struct ARegion *ar,
66             const char *context, int contextnr,
67             const bool vertical);
68 void    ED_region_header_init(struct ARegion *ar);
69 void    ED_region_header(const struct bContext *C, struct ARegion *ar);
70 void    ED_region_toggle_hidden(struct bContext *C, struct ARegion *ar);
71 void    ED_region_info_draw(struct ARegion *ar, const char *text, float fill_color[4], const bool full_redraw);
72 void    ED_region_image_metadata_draw(int x, int y, struct ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy);
73 void    ED_region_grid_draw(struct ARegion *ar, float zoomx, float zoomy);
74 float   ED_region_blend_factor(struct ARegion *ar);
75 void    ED_region_visible_rect(struct ARegion *ar, struct rcti *rect);
76
77
78 /* spaces */
79 void    ED_spacetypes_keymap(struct wmKeyConfig *keyconf);
80 int     ED_area_header_switchbutton(const struct bContext *C, struct uiBlock *block, int yco);
81
82 /* areas */
83 void    ED_area_initialize(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa);
84 void    ED_area_exit(struct bContext *C, struct ScrArea *sa);
85 int     ED_screen_area_active(const struct bContext *C);
86 void    ED_area_do_listen(struct bScreen *sc, ScrArea *sa, struct wmNotifier *note);
87 void    ED_area_tag_redraw(ScrArea *sa);
88 void    ED_area_tag_redraw_regiontype(ScrArea *sa, int type);
89 void    ED_area_tag_refresh(ScrArea *sa);
90 void    ED_area_do_refresh(struct bContext *C, ScrArea *sa);
91 void    ED_area_azones_update(ScrArea *sa, const int mouse_xy[]);
92 void    ED_area_headerprint(ScrArea *sa, const char *str);
93 void    ED_area_newspace(struct bContext *C, ScrArea *sa, int type, const bool skip_ar_exit);
94 void    ED_area_prevspace(struct bContext *C, ScrArea *sa);
95 void    ED_area_swapspace(struct bContext *C, ScrArea *sa1, ScrArea *sa2);
96 int     ED_area_headersize(void);
97
98 /* screens */
99 void    ED_screens_initialize(struct wmWindowManager *wm);
100 void    ED_screen_draw(struct wmWindow *win);
101 void    ED_screen_refresh(struct wmWindowManager *wm, struct wmWindow *win);
102 void    ED_screen_do_listen(struct bContext *C, struct wmNotifier *note);
103 bScreen *ED_screen_duplicate(struct wmWindow *win, struct bScreen *sc);
104 bScreen *ED_screen_add(struct wmWindow *win, struct Scene *scene, const char *name);
105 bool    ED_screen_set(struct bContext *C, struct bScreen *sc);
106 bool    ED_screen_delete(struct bContext *C, struct bScreen *sc);
107 void    ED_screen_set_scene(struct bContext *C, struct bScreen *screen, struct Scene *scene);
108 bool    ED_screen_delete_scene(struct bContext *C, struct Scene *scene);
109 void    ED_screen_set_subwinactive(struct bContext *C, struct wmEvent *event);
110 void    ED_screen_exit(struct bContext *C, struct wmWindow *window, struct bScreen *screen);
111 void    ED_screen_animation_timer(struct bContext *C, int redraws, int refresh, int sync, int enable);
112 void    ED_screen_animation_timer_update(struct bScreen *screen, int redraws, int refresh);
113 void    ED_screen_restore_temp_type(struct bContext *C, ScrArea *sa);
114 ScrArea *ED_screen_full_newspace(struct bContext *C, ScrArea *sa, int type);
115 void    ED_screen_full_prevspace(struct bContext *C, ScrArea *sa);
116 void    ED_screen_full_restore(struct bContext *C, ScrArea *sa);
117 struct ScrArea *ED_screen_state_toggle(struct bContext *C, struct wmWindow *win, struct ScrArea *sa, const short state);
118 void    ED_screens_header_tools_menu_create(struct bContext *C, struct uiLayout *layout, void *arg);
119 bool    ED_screen_stereo3d_required(struct bScreen *screen);
120
121 /* anim */
122 void    ED_update_for_newframe(struct Main *bmain, struct Scene *scene, int mute);
123
124 void    ED_refresh_viewport_fps(struct bContext *C);
125 int             ED_screen_animation_play(struct bContext *C, int sync, int mode);
126 bScreen *ED_screen_animation_playing(const struct wmWindowManager *wm);
127 bScreen *ED_screen_animation_no_scrub(const struct wmWindowManager *wm);
128
129 /* screen keymaps */
130 void    ED_operatortypes_screen(void);
131 void    ED_keymap_screen(struct wmKeyConfig *keyconf);
132
133 /* operators; context poll callbacks */
134 int     ED_operator_screenactive(struct bContext *C);
135 int     ED_operator_screen_mainwinactive(struct bContext *C);
136 int     ED_operator_areaactive(struct bContext *C);
137 int     ED_operator_regionactive(struct bContext *C);
138
139 int     ED_operator_scene_editable(struct bContext *C);
140 int     ED_operator_objectmode(struct bContext *C);
141
142 int     ED_operator_view3d_active(struct bContext *C);
143 int     ED_operator_region_view3d_active(struct bContext *C);
144 int     ED_operator_animview_active(struct bContext *C);
145 int     ED_operator_timeline_active(struct bContext *C);
146 int     ED_operator_outliner_active(struct bContext *C);
147 int     ED_operator_outliner_active_no_editobject(struct bContext *C);
148 int     ED_operator_file_active(struct bContext *C);
149 int     ED_operator_action_active(struct bContext *C);
150 int     ED_operator_buttons_active(struct bContext *C);
151 int     ED_operator_node_active(struct bContext *C);
152 int     ED_operator_node_editable(struct bContext *C);
153 int     ED_operator_graphedit_active(struct bContext *C);
154 int     ED_operator_sequencer_active(struct bContext *C);
155 int     ED_operator_sequencer_active_editable(struct bContext *C);
156 int     ED_operator_image_active(struct bContext *C);
157 int     ED_operator_nla_active(struct bContext *C);
158 int     ED_operator_logic_active(struct bContext *C);
159 int     ED_operator_info_active(struct bContext *C);
160 int     ED_operator_console_active(struct bContext *C);
161
162
163 int     ED_operator_object_active(struct bContext *C);
164 int     ED_operator_object_active_editable(struct bContext *C);
165 int     ED_operator_object_active_editable_mesh(struct bContext *C);
166 int     ED_operator_object_active_editable_font(struct bContext *C);
167 int     ED_operator_editmesh(struct bContext *C);
168 int     ED_operator_editmesh_view3d(struct bContext *C);
169 int     ED_operator_editmesh_region_view3d(struct bContext *C);
170 int     ED_operator_editarmature(struct bContext *C);
171 int     ED_operator_editcurve(struct bContext *C);
172 int     ED_operator_editcurve_3d(struct bContext *C);
173 int     ED_operator_editsurf(struct bContext *C);
174 int     ED_operator_editsurfcurve(struct bContext *C);
175 int     ED_operator_editsurfcurve_region_view3d(struct bContext *C);
176 int     ED_operator_editfont(struct bContext *C);
177 int     ED_operator_editlattice(struct bContext *C);
178 int     ED_operator_editmball(struct bContext *C);
179 int     ED_operator_uvedit(struct bContext *C);
180 int     ED_operator_uvedit_space_image(struct bContext *C);
181 int     ED_operator_uvmap(struct bContext *C);
182 int     ED_operator_posemode_exclusive(struct bContext *C);
183 int     ED_operator_posemode_context(struct bContext *C);
184 int     ED_operator_posemode(struct bContext *C);
185 int     ED_operator_mask(struct bContext *C);
186
187
188 /* Cache display helpers */
189
190 void ED_region_cache_draw_background(const struct ARegion *ar);
191 void ED_region_cache_draw_curfra_label(const int framenr, const float x, const float y);
192 void ED_region_cache_draw_cached_segments(const struct ARegion *ar, const int num_segments, const int *points, const int sfra, const int efra);
193
194 /* default keymaps, bitflags */
195 #define ED_KEYMAP_UI        1
196 #define ED_KEYMAP_VIEW2D    2
197 #define ED_KEYMAP_MARKERS   4
198 #define ED_KEYMAP_ANIMATION 8
199 #define ED_KEYMAP_FRAMES    16
200 #define ED_KEYMAP_GPENCIL   32
201 #define ED_KEYMAP_HEADER    64
202
203 #endif /* __ED_SCREEN_H__ */
204