Code cleanup: use r_ prefix for return args
[blender.git] / source / blender / blenkernel / BKE_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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_SCREEN_H__
28 #define __BKE_SCREEN_H__
29
30 /** \file BKE_screen.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 struct ARegion;
37 struct Header;
38 struct ListBase;
39 struct Menu;
40 struct Panel;
41 struct Scene;
42 struct ScrArea;
43 struct SpaceType;
44 struct View3D;
45 struct bContext;
46 struct bContextDataResult;
47 struct bScreen;
48 struct uiLayout;
49 struct uiList;
50 struct uiMenuItem;
51 struct wmKeyConfig;
52 struct wmNotifier;
53 struct wmWindow;
54 struct wmWindowManager;
55
56 #include "RNA_types.h"
57
58 /* spacetype has everything stored to get an editor working, it gets initialized via 
59  * ED_spacetypes_init() in editors/space_api/spacetypes.c   */
60 /* an editor in Blender is a combined ScrArea + SpaceType + SpaceData */
61
62 #define BKE_ST_MAXNAME  64
63
64 typedef struct SpaceType {
65         struct SpaceType *next, *prev;
66         
67         char name[BKE_ST_MAXNAME];                  /* for menus */
68         int spaceid;                                /* unique space identifier */
69         int iconid;                                 /* icon lookup for menus */
70         
71         /* initial allocation, after this WM will call init() too */
72         struct SpaceLink    *(*new)(const struct bContext *C);
73         /* not free spacelink itself */
74         void (*free)(struct SpaceLink *);
75         
76         /* init is to cope with file load, screen (size) changes, check handlers */
77         void (*init)(struct wmWindowManager *, struct ScrArea *);
78         /* exit is called when the area is hidden or removed */
79         void (*exit)(struct wmWindowManager *, struct ScrArea *);
80         /* Listeners can react to bContext changes */
81         void (*listener)(struct bScreen *sc, struct ScrArea *, struct wmNotifier *);
82         
83         /* refresh context, called after filereads, ED_area_tag_refresh() */
84         void (*refresh)(const struct bContext *, struct ScrArea *);
85         
86         /* after a spacedata copy, an init should result in exact same situation */
87         struct SpaceLink    *(*duplicate)(struct SpaceLink *);
88
89         /* register operator types on startup */
90         void (*operatortypes)(void);
91         /* add default items to WM keymap */
92         void (*keymap)(struct wmKeyConfig *);
93         /* on startup, define dropboxes for spacetype+regions */
94         void (*dropboxes)(void);
95
96         /* return context data */
97         int (*context)(const struct bContext *, const char *, struct bContextDataResult *);
98
99         /* region type definitions */
100         ListBase regiontypes;
101         
102         /* tool shelf definitions */
103         ListBase toolshelf;
104                 
105         /* read and write... */
106         
107         /* default keymaps to add */
108         int keymapflag;
109         
110 } SpaceType;
111
112 /* region types are also defined using spacetypes_init, via a callback */
113
114 typedef struct ARegionType {
115         struct ARegionType *next, *prev;
116         
117         int regionid;           /* unique identifier within this space, defines RGN_TYPE_xxxx */
118         
119         /* add handlers, stuff you only do once or on area/region type/size changes */
120         void (*init)(struct wmWindowManager *, struct ARegion *);
121         /* exit is called when the region is hidden or removed */
122         void (*exit)(struct wmWindowManager *, struct ARegion *);
123         /* draw entirely, view changes should be handled here */
124         void (*draw)(const struct bContext *, struct ARegion *);
125         /* contextual changes should be handled here */
126         void (*listener)(struct bScreen *sc, struct ScrArea *, struct ARegion *, struct wmNotifier *);
127         
128         void (*free)(struct ARegion *);
129
130         /* split region, copy data optionally */
131         void        *(*duplicate)(void *);
132
133         
134         /* register operator types on startup */
135         void (*operatortypes)(void);
136         /* add own items to keymap */
137         void (*keymap)(struct wmKeyConfig *);
138         /* allows default cursor per region */
139         void (*cursor)(struct wmWindow *, struct ScrArea *, struct ARegion *ar);
140
141         /* return context data */
142         int (*context)(const struct bContext *, const char *, struct bContextDataResult *);
143
144         /* custom drawing callbacks */
145         ListBase drawcalls;
146
147         /* panels type definitions */
148         ListBase paneltypes;
149
150         /* header type definitions */
151         ListBase headertypes;
152         
153         /* hardcoded constraints, smaller than these values region is not visible */
154         int minsizex, minsizey;
155         /* when new region opens (region prefsizex/y are zero then */
156         int prefsizex, prefsizey;
157         /* default keymaps to add */
158         int keymapflag;
159         /* return without drawing. lock is set by region definition, and copied to do_lock by render. can become flag */
160         short do_lock, lock;
161         /* call cursor function on each move event */
162         short event_cursor;
163 } ARegionType;
164
165 /* panel types */
166
167 typedef struct PanelType {
168         struct PanelType *next, *prev;
169         
170         char idname[BKE_ST_MAXNAME];              /* unique name */
171         char label[BKE_ST_MAXNAME];               /* for panel header */
172         char translation_context[BKE_ST_MAXNAME];
173         char context[BKE_ST_MAXNAME];             /* for buttons window */
174         char category[BKE_ST_MAXNAME];            /* for category tabs */
175         int space_type;
176         int region_type;
177
178         int flag;
179
180         /* verify if the panel should draw or not */
181         int (*poll)(const struct bContext *, struct PanelType *);
182         /* draw header (optional) */
183         void (*draw_header)(const struct bContext *, struct Panel *);
184         /* draw entirely, view changes should be handled here */
185         void (*draw)(const struct bContext *, struct Panel *);
186
187         /* RNA integration */
188         ExtensionRNA ext;
189 } PanelType;
190
191 /* uilist types */
192
193 /* Draw an item in the uiList */
194 typedef void (*uiListDrawItemFunc)(struct uiList *, struct bContext *, struct uiLayout *, struct PointerRNA *,
195                                    struct PointerRNA *, int, struct PointerRNA *, const char *, int, int);
196
197 /* Draw the filtering part of an uiList */
198 typedef void (*uiListDrawFilterFunc)(struct uiList *, struct bContext *, struct uiLayout *);
199
200 /* Filter items of an uiList */
201 typedef void (*uiListFilterItemsFunc)(struct uiList *, struct bContext *, struct PointerRNA *, const char *);
202
203 typedef struct uiListType {
204         struct uiListType *next, *prev;
205
206         char idname[BKE_ST_MAXNAME];            /* unique name */
207
208         uiListDrawItemFunc draw_item;
209         uiListDrawFilterFunc draw_filter;
210         uiListFilterItemsFunc filter_items;
211
212         /* RNA integration */
213         ExtensionRNA ext;
214 } uiListType;
215
216 /* header types */
217
218 typedef struct HeaderType {
219         struct HeaderType *next, *prev;
220
221         char idname[BKE_ST_MAXNAME];        /* unique name */
222         int space_type;
223
224         /* draw entirely, view changes should be handled here */
225         void (*draw)(const struct bContext *, struct Header *);
226
227         /* RNA integration */
228         ExtensionRNA ext;
229 } HeaderType;
230
231 typedef struct Header {
232         struct HeaderType *type;    /* runtime */
233         struct uiLayout *layout;    /* runtime for drawing */
234 } Header;
235
236
237 /* menu types */
238
239 typedef struct MenuType {
240         struct MenuType *next, *prev;
241
242         char idname[BKE_ST_MAXNAME];        /* unique name */
243         char label[BKE_ST_MAXNAME];         /* for button text */
244         char translation_context[BKE_ST_MAXNAME];
245         const char *description;
246
247         /* verify if the menu should draw or not */
248         int (*poll)(const struct bContext *, struct MenuType *);
249         /* draw entirely, view changes should be handled here */
250         void (*draw)(const struct bContext *, struct Menu *);
251
252         /* RNA integration */
253         ExtensionRNA ext;
254 } MenuType;
255
256 typedef struct Menu {
257         struct MenuType *type;      /* runtime */
258         struct uiLayout *layout;    /* runtime for drawing */
259 } Menu;
260
261 /* spacetypes */
262 struct SpaceType *BKE_spacetype_from_id(int spaceid);
263 struct ARegionType *BKE_regiontype_from_id(struct SpaceType *st, int regionid);
264 const struct ListBase *BKE_spacetypes_list(void);
265 void BKE_spacetype_register(struct SpaceType *st);
266 int BKE_spacetype_exists(int spaceid);
267 void BKE_spacetypes_free(void); /* only for quitting blender */
268
269 /* spacedata */
270 void BKE_spacedata_freelist(ListBase *lb);
271 void BKE_spacedata_copylist(ListBase *lb1, ListBase *lb2);
272 void BKE_spacedata_draw_locks(int set);
273
274 /* area/regions */
275 struct ARegion *BKE_area_region_copy(struct SpaceType *st, struct ARegion *ar);
276 void            BKE_area_region_free(struct SpaceType *st, struct ARegion *ar);
277 void            BKE_screen_area_free(struct ScrArea *sa);
278
279 struct ARegion *BKE_area_find_region_type(struct ScrArea *sa, int type);
280 struct ARegion *BKE_area_find_region_active_win(struct ScrArea *sa);
281 struct ScrArea *BKE_screen_find_big_area(struct bScreen *sc, const int spacetype, const short min);
282
283 void BKE_screen_view3d_sync(struct View3D *v3d, struct Scene *scene);
284 void BKE_screen_view3d_scene_sync(struct bScreen *sc);
285 void BKE_screen_view3d_main_sync(ListBase *screen_lb, struct Scene *scene);
286 void BKE_screen_view3d_twmode_remove(struct View3D *v3d, const int i);
287 void BKE_screen_view3d_main_twmode_remove(ListBase *screen_lb, struct Scene *scene, const int i);
288
289 /* zoom factor conversion */
290 float BKE_screen_view3d_zoom_to_fac(float camzoom);
291 float BKE_screen_view3d_zoom_from_fac(float zoomfac);
292
293 /* screen */
294 void BKE_screen_free(struct bScreen *sc); 
295 unsigned int BKE_screen_visible_layers(struct bScreen *screen, struct Scene *scene);
296
297 #endif
298