Blender: ED_screen.h Source File

Blender V2.59
00001 /*
00002  * $Id: ED_screen.h 37232 2011-06-06 00:42:36Z campbellbarton $
00003  *
00004  * ***** BEGIN GPL LICENSE BLOCK *****
00005  *
00006  * This program is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU General Public License
00008  * as published by the Free Software Foundation; either version 2
00009  * of the License, or (at your option) any later version. 
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software Foundation,
00018  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00019  *
00020  * The Original Code is Copyright (C) 2008 Blender Foundation.
00021  * All rights reserved.
00022  *
00023  * 
00024  * Contributor(s): Blender Foundation
00025  *
00026  * ***** END GPL LICENSE BLOCK *****
00027  */
00028 
00033 #ifndef ED_SCREEN_H
00034 #define ED_SCREEN_H
00035 
00036 #include "DNA_screen_types.h"
00037 #include "DNA_space_types.h"
00038 #include "DNA_view2d_types.h"
00039 #include "DNA_view3d_types.h"
00040 
00041 struct wmWindowManager;
00042 struct wmWindow;
00043 struct wmNotifier;
00044 struct wmEvent;
00045 struct wmKeyConfig;
00046 struct bContext;
00047 struct SpaceType;
00048 struct Scene;
00049 struct bScreen;
00050 struct ARegion;
00051 struct uiBlock;
00052 struct rcti;
00053 
00054 /* regions */
00055 void    ED_region_do_listen(struct ARegion *ar, struct wmNotifier *note);
00056 void    ED_region_do_draw(struct bContext *C, struct ARegion *ar);
00057 void    ED_region_exit(struct bContext *C, struct ARegion *ar);
00058 void    ED_region_pixelspace(struct ARegion *ar);
00059 void    ED_region_set(const struct bContext *C, struct ARegion *ar);
00060 void    ED_region_init(struct bContext *C, struct ARegion *ar);
00061 void    ED_region_tag_redraw(struct ARegion *ar);
00062 void    ED_region_tag_redraw_partial(struct ARegion *ar, struct rcti *rct);
00063 void    ED_region_tag_redraw_overlay(struct ARegion *ar);
00064 void    ED_region_panels_init(struct wmWindowManager *wm, struct ARegion *ar);
00065 void    ED_region_panels(const struct bContext *C, struct ARegion *ar, int vertical, const char *context, int contextnr);
00066 void    ED_region_header_init(struct ARegion *ar);
00067 void    ED_region_header(const struct bContext *C, struct ARegion *ar);
00068 void    ED_region_toggle_hidden(struct bContext *C, struct ARegion *ar);
00069 void    region_scissor_winrct(struct ARegion *ar, struct rcti *winrct);
00070 
00071 /* spaces */
00072 void    ED_spacetypes_init(void);
00073 void    ED_spacetypes_keymap(struct wmKeyConfig *keyconf);
00074 int             ED_area_header_switchbutton(const struct bContext *C, struct uiBlock *block, int yco);
00075 int             ED_area_header_standardbuttons(const struct bContext *C, struct uiBlock *block, int yco);
00076 void    ED_area_overdraw(struct bContext *C);
00077 void    ED_area_overdraw_flush(struct ScrArea *sa, struct ARegion *ar);
00078 
00079 
00080 /* areas */
00081 void    ED_area_initialize(struct wmWindowManager *wm, struct wmWindow *win, struct ScrArea *sa);
00082 void    ED_area_exit(struct bContext *C, struct ScrArea *sa);
00083 int             ED_screen_area_active(const struct bContext *C);
00084 void    ED_area_do_listen(ScrArea *sa, struct wmNotifier *note);
00085 void    ED_area_tag_redraw(ScrArea *sa);
00086 void    ED_area_tag_redraw_regiontype(ScrArea *sa, int type);
00087 void    ED_area_tag_refresh(ScrArea *sa);
00088 void    ED_area_do_refresh(struct bContext *C, ScrArea *sa);
00089 void    ED_area_headerprint(ScrArea *sa, const char *str);
00090 void    ED_area_newspace(struct bContext *C, ScrArea *sa, int type);
00091 void    ED_area_prevspace(struct bContext *C, ScrArea *sa);
00092 void    ED_area_swapspace(struct bContext *C, ScrArea *sa1, ScrArea *sa2);
00093 int             ED_area_headersize(void);
00094 
00095 /* screens */
00096 void    ED_screens_initialize(struct wmWindowManager *wm);
00097 void    ED_screen_draw(struct wmWindow *win);
00098 void    ED_screen_refresh(struct wmWindowManager *wm, struct wmWindow *win);
00099 void    ED_screen_do_listen(struct bContext *C, struct wmNotifier *note);
00100 bScreen *ED_screen_duplicate(struct wmWindow *win, struct bScreen *sc);
00101 bScreen *ED_screen_add(struct wmWindow *win, struct Scene *scene, const char *name);
00102 void    ED_screen_set(struct bContext *C, struct bScreen *sc);
00103 void    ED_screen_delete(struct bContext *C, struct bScreen *sc);
00104 void    ED_screen_set_scene(struct bContext *C, struct Scene *scene);
00105 void    ED_screen_delete_scene(struct bContext *C, struct Scene *scene);
00106 void    ED_screen_set_subwinactive(struct bContext *C, struct wmEvent *event);
00107 void    ED_screen_exit(struct bContext *C, struct wmWindow *window, struct bScreen *screen);
00108 void    ED_screen_animation_timer(struct bContext *C, int redraws, int refresh, int sync, int enable);
00109 void    ED_screen_animation_timer_update(struct bScreen *screen, int redraws, int refresh);
00110 ScrArea *ED_screen_full_newspace(struct bContext *C, ScrArea *sa, int type);
00111 void    ED_screen_full_prevspace(struct bContext *C, ScrArea *sa);
00112 void    ED_screen_full_restore(struct bContext *C, ScrArea *sa);
00113 struct ScrArea *ED_screen_full_toggle(struct bContext *C, struct wmWindow *win, struct ScrArea *sa);
00114 
00115 void    ED_screen_new_window(struct bContext *C, struct rcti *position, int type);
00116 
00117 /* anim */
00118 void    ED_update_for_newframe(struct Main *bmain, struct Scene *scene, struct bScreen *screen, int mute);
00119 
00120 void    ED_refresh_viewport_fps(struct bContext *C);
00121 int ED_screen_animation_play(struct bContext *C, int sync, int mode);
00122 
00123 /* screen keymaps */
00124 void    ED_operatortypes_screen(void);
00125 void    ED_keymap_screen(struct wmKeyConfig *keyconf);
00126 
00127 /* operators; context poll callbacks */
00128 int             ED_operator_screenactive(struct bContext *C);
00129 int             ED_operator_screen_mainwinactive(struct bContext *C);
00130 int             ED_operator_areaactive(struct bContext *C);
00131 int             ED_operator_regionactive(struct bContext *C);
00132 
00133 int             ED_operator_scene_editable(struct bContext *C);
00134 int             ED_operator_objectmode(struct bContext *C);
00135 
00136 int             ED_operator_view3d_active(struct bContext *C);
00137 int             ED_operator_region_view3d_active(struct bContext *C);
00138 int             ED_operator_animview_active(struct bContext *C);
00139 int             ED_operator_timeline_active(struct bContext *C);
00140 int             ED_operator_outliner_active(struct bContext *C);
00141 int             ED_operator_outliner_active_no_editobject(struct bContext *C);
00142 int             ED_operator_file_active(struct bContext *C);
00143 int             ED_operator_action_active(struct bContext *C);
00144 int             ED_operator_buttons_active(struct bContext *C);
00145 int             ED_operator_node_active(struct bContext *C);
00146 int             ED_operator_graphedit_active(struct bContext *C);
00147 int             ED_operator_sequencer_active(struct bContext *C);
00148 int             ED_operator_image_active(struct bContext *C);
00149 int             ED_operator_nla_active(struct bContext *C);
00150 int             ED_operator_logic_active(struct bContext *C);
00151 int             ED_operator_info_active(struct bContext *C);
00152 int             ED_operator_console_active(struct bContext *C);
00153 
00154 
00155 int             ED_operator_object_active(struct bContext *C);
00156 int             ED_operator_object_active_editable(struct bContext *C);
00157 int             ED_operator_object_active_editable_mesh(struct bContext *C);
00158 int             ED_operator_object_active_editable_font(struct bContext *C);
00159 int             ED_operator_editmesh(struct bContext *C);
00160 int             ED_operator_editmesh_view3d(struct bContext *C);
00161 int             ED_operator_editmesh_region_view3d(struct bContext *C);
00162 int             ED_operator_editarmature(struct bContext *C);
00163 int             ED_operator_editcurve(struct bContext *C);
00164 int             ED_operator_editsurf(struct bContext *C);
00165 int             ED_operator_editsurfcurve(struct bContext *C);
00166 int             ED_operator_editsurfcurve_region_view3d(struct bContext *C);
00167 int             ED_operator_editfont(struct bContext *C);
00168 int             ED_operator_editlattice(struct bContext *C);
00169 int             ED_operator_editmball(struct bContext *C);
00170 int             ED_operator_uvedit(struct bContext *C);
00171 int             ED_operator_uvmap(struct bContext *C);
00172 int             ED_operator_posemode(struct bContext *C);
00173 
00174 
00175 /* default keymaps, bitflags */
00176 #define ED_KEYMAP_UI            1
00177 #define ED_KEYMAP_VIEW2D        2
00178 #define ED_KEYMAP_MARKERS       4
00179 #define ED_KEYMAP_ANIMATION     8
00180 #define ED_KEYMAP_FRAMES        16
00181 #define ED_KEYMAP_GPENCIL       32
00182 #define ED_KEYMAP_HEADER        64
00183 
00184 #endif /* ED_SCREEN_H */
00185