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