Workbench: Fix memleaks.
[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 ID;
39 struct ListBase;
40 struct Menu;
41 struct Panel;
42 struct Scene;
43 struct ScrArea;
44 struct ScrVert;
45 struct SpaceType;
46 struct TransformOrientation;
47 struct View3D;
48 struct bContext;
49 struct bContextDataResult;
50 struct bScreen;
51 struct uiLayout;
52 struct uiList;
53 struct wmKeyConfig;
54 struct wmManipulatorMap;
55 struct wmNotifier;
56 struct wmWindow;
57 struct wmWindowManager;
58 struct WorkSpace;
59 struct GPUFXSettings;
60 struct wmMsgBus;
61 struct ScrAreaMap;
62
63 #include "BLI_compiler_attrs.h"
64
65 #include "RNA_types.h"
66
67 /* spacetype has everything stored to get an editor working, it gets initialized via 
68  * ED_spacetypes_init() in editors/space_api/spacetypes.c   */
69 /* an editor in Blender is a combined ScrArea + SpaceType + SpaceData */
70
71 #define BKE_ST_MAXNAME  64
72
73 typedef struct SpaceType {
74         struct SpaceType *next, *prev;
75         
76         char name[BKE_ST_MAXNAME];                  /* for menus */
77         int spaceid;                                /* unique space identifier */
78         int iconid;                                 /* icon lookup for menus */
79         
80         /* Initial allocation, after this WM will call init() too. Some editors need
81          * area and scene data (e.g. frame range) to set their initial scrolling. */
82         struct SpaceLink    *(*new)(const struct ScrArea *, const struct Scene *);
83         /* not free spacelink itself */
84         void (*free)(struct SpaceLink *);
85         
86         /* init is to cope with file load, screen (size) changes, check handlers */
87         void (*init)(struct wmWindowManager *, struct ScrArea *);
88         /* exit is called when the area is hidden or removed */
89         void (*exit)(struct wmWindowManager *, struct ScrArea *);
90         /* Listeners can react to bContext changes */
91         void (*listener)(struct bScreen *sc, struct ScrArea *,
92                          struct wmNotifier *, struct Scene *scene,
93                          struct WorkSpace *workspace);
94         
95         /* refresh context, called after filereads, ED_area_tag_refresh() */
96         void (*refresh)(const struct bContext *, struct ScrArea *);
97         
98         /* after a spacedata copy, an init should result in exact same situation */
99         struct SpaceLink    *(*duplicate)(struct SpaceLink *);
100
101         /* register operator types on startup */
102         void (*operatortypes)(void);
103         /* add default items to WM keymap */
104         void (*keymap)(struct wmKeyConfig *);
105         /* on startup, define dropboxes for spacetype+regions */
106         void (*dropboxes)(void);
107
108         /* initialize manipulator-map-types and manipulator-group-types with the region */
109         void (*manipulators)(void);
110
111         /* return context data */
112         int (*context)(const struct bContext *, const char *, struct bContextDataResult *);
113
114         /* Used when we want to replace an ID by another (or NULL). */
115         void (*id_remap)(struct ScrArea *, struct SpaceLink *, struct ID *, struct ID *);
116
117         int  (*space_subtype_get)(struct ScrArea *sa);
118         void (*space_subtype_set)(struct ScrArea *sa, int value);
119         void (*space_subtype_item_extend)(struct bContext *C, EnumPropertyItem **item, int *totitem);
120
121         /* region type definitions */
122         ListBase regiontypes;
123         
124         /* tool shelf definitions */
125         ListBase toolshelf;
126                 
127         /* read and write... */
128         
129         /* default keymaps to add */
130         int keymapflag;
131         
132 } SpaceType;
133
134 /* region types are also defined using spacetypes_init, via a callback */
135
136 typedef struct ARegionType {
137         struct ARegionType *next, *prev;
138         
139         int regionid;           /* unique identifier within this space, defines RGN_TYPE_xxxx */
140         
141         /* add handlers, stuff you only do once or on area/region type/size changes */
142         void (*init)(struct wmWindowManager *, struct ARegion *);
143         /* exit is called when the region is hidden or removed */
144         void (*exit)(struct wmWindowManager *, struct ARegion *);
145         /* draw entirely, view changes should be handled here */
146         void (*draw)(const struct bContext *, struct ARegion *);
147         /* optional, compute button layout before drawing for dynamic size */
148         void (*layout)(const struct bContext *, struct ARegion *);
149         /* snap the size of the region (can be NULL for no snapping). */
150         int (*snap_size)(const struct ARegion *ar, int size, int axis);
151         /* contextual changes should be handled here */
152         void (*listener)(struct bScreen *, struct ScrArea *, struct ARegion *,
153                          struct wmNotifier *, const struct Scene *scene);
154         /* Optional callback to generate subscriptions. */
155         void (*message_subscribe)(
156                 const struct bContext *C,
157                 struct WorkSpace *workspace, struct Scene *scene,
158                 struct bScreen *sc, struct ScrArea *sa, struct ARegion *ar,
159                 struct wmMsgBus *mbus);
160
161         void (*free)(struct ARegion *);
162
163         /* split region, copy data optionally */
164         void        *(*duplicate)(void *);
165
166         
167         /* register operator types on startup */
168         void (*operatortypes)(void);
169         /* add own items to keymap */
170         void (*keymap)(struct wmKeyConfig *);
171         /* allows default cursor per region */
172         void (*cursor)(struct wmWindow *, struct ScrArea *, struct ARegion *ar);
173
174         /* return context data */
175         int (*context)(const struct bContext *, const char *, struct bContextDataResult *);
176
177         /* custom drawing callbacks */
178         ListBase drawcalls;
179
180         /* panels type definitions */
181         ListBase paneltypes;
182
183         /* header type definitions */
184         ListBase headertypes;
185         
186         /* hardcoded constraints, smaller than these values region is not visible */
187         int minsizex, minsizey;
188         /* when new region opens (region prefsizex/y are zero then */
189         int prefsizex, prefsizey;
190         /* default keymaps to add */
191         int keymapflag;
192         /* return without drawing. lock is set by region definition, and copied to do_lock by render. can become flag */
193         short do_lock, lock;
194         /* call cursor function on each move event */
195         short event_cursor;
196 } ARegionType;
197
198 /* panel types */
199
200 typedef struct PanelType {
201         struct PanelType *next, *prev;
202         
203         char idname[BKE_ST_MAXNAME];              /* unique name */
204         char label[BKE_ST_MAXNAME];               /* for panel header */
205         char translation_context[BKE_ST_MAXNAME];
206         char context[BKE_ST_MAXNAME];             /* for buttons window */
207         char category[BKE_ST_MAXNAME];            /* for category tabs */
208         char owner_id[BKE_ST_MAXNAME];              /* for work-spaces to selectively show. */
209         int space_type;
210         int region_type;
211
212         int flag;
213
214         /* verify if the panel should draw or not */
215         int (*poll)(const struct bContext *, struct PanelType *);
216         /* draw header (optional) */
217         void (*draw_header)(const struct bContext *, struct Panel *);
218         /* draw entirely, view changes should be handled here */
219         void (*draw)(const struct bContext *, struct Panel *);
220
221         /* RNA integration */
222         ExtensionRNA ext;
223 } PanelType;
224
225 /* uilist types */
226
227 /* Draw an item in the uiList */
228 typedef void (*uiListDrawItemFunc)(struct uiList *, struct bContext *, struct uiLayout *, struct PointerRNA *,
229                                    struct PointerRNA *, int, struct PointerRNA *, const char *, int, int);
230
231 /* Draw the filtering part of an uiList */
232 typedef void (*uiListDrawFilterFunc)(struct uiList *, struct bContext *, struct uiLayout *);
233
234 /* Filter items of an uiList */
235 typedef void (*uiListFilterItemsFunc)(struct uiList *, struct bContext *, struct PointerRNA *, const char *);
236
237 typedef struct uiListType {
238         struct uiListType *next, *prev;
239
240         char idname[BKE_ST_MAXNAME];            /* unique name */
241
242         uiListDrawItemFunc draw_item;
243         uiListDrawFilterFunc draw_filter;
244         uiListFilterItemsFunc filter_items;
245
246         /* RNA integration */
247         ExtensionRNA ext;
248 } uiListType;
249
250 /* header types */
251
252 typedef struct HeaderType {
253         struct HeaderType *next, *prev;
254
255         char idname[BKE_ST_MAXNAME];        /* unique name */
256         int space_type;
257         int region_type;
258
259         /* draw entirely, view changes should be handled here */
260         void (*draw)(const struct bContext *, struct Header *);
261
262         /* RNA integration */
263         ExtensionRNA ext;
264 } HeaderType;
265
266 typedef struct Header {
267         struct HeaderType *type;    /* runtime */
268         struct uiLayout *layout;    /* runtime for drawing */
269 } Header;
270
271
272 /* menu types */
273
274 typedef struct MenuType {
275         struct MenuType *next, *prev;
276
277         char idname[BKE_ST_MAXNAME];        /* unique name */
278         char label[BKE_ST_MAXNAME];         /* for button text */
279         char translation_context[BKE_ST_MAXNAME];
280         char owner_id[BKE_ST_MAXNAME];  /* optional, see: #wmOwnerID */
281         const char *description;
282
283         /* verify if the menu should draw or not */
284         int (*poll)(const struct bContext *, struct MenuType *);
285         /* draw entirely, view changes should be handled here */
286         void (*draw)(const struct bContext *, struct Menu *);
287
288         /* RNA integration */
289         ExtensionRNA ext;
290 } MenuType;
291
292 typedef struct Menu {
293         struct MenuType *type;      /* runtime */
294         struct uiLayout *layout;    /* runtime for drawing */
295 } Menu;
296
297 /* spacetypes */
298 struct SpaceType *BKE_spacetype_from_id(int spaceid);
299 struct ARegionType *BKE_regiontype_from_id(struct SpaceType *st, int regionid);
300 const struct ListBase *BKE_spacetypes_list(void);
301 void BKE_spacetype_register(struct SpaceType *st);
302 bool BKE_spacetype_exists(int spaceid);
303 void BKE_spacetypes_free(void); /* only for quitting blender */
304
305 /* spacedata */
306 void BKE_spacedata_freelist(ListBase *lb);
307 void BKE_spacedata_copylist(ListBase *lb1, ListBase *lb2);
308 void BKE_spacedata_draw_locks(int set);
309
310 void BKE_spacedata_callback_id_remap_set(void (*func)(struct ScrArea *, struct SpaceLink *, struct ID *, struct ID *));
311 void BKE_spacedata_id_unref(struct ScrArea *sa, struct SpaceLink *sl, struct ID *id);
312
313 /* area/regions */
314 struct ARegion *BKE_area_region_copy(struct SpaceType *st, struct ARegion *ar);
315 void            BKE_area_region_free(struct SpaceType *st, struct ARegion *ar);
316 void            BKE_screen_area_free(struct ScrArea *sa);
317 /* Manipulator-maps of a region need to be freed with the region. Uses callback to avoid low-level call. */
318 void BKE_region_callback_free_manipulatormap_set(void (*callback)(struct wmManipulatorMap *));
319 void BKE_region_callback_refresh_tag_manipulatormap_set(void (*callback)(struct wmManipulatorMap *));
320
321 struct ARegion *BKE_area_find_region_type(struct ScrArea *sa, int type);
322 struct ARegion *BKE_area_find_region_active_win(struct ScrArea *sa);
323 struct ARegion *BKE_area_find_region_xy(struct ScrArea *sa, const int regiontype, int x, int y);
324 struct ScrArea *BKE_screen_find_area_from_space(struct bScreen *sc, struct SpaceLink *sl) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
325 struct ScrArea *BKE_screen_find_big_area(struct bScreen *sc, const int spacetype, const short min);
326 struct ScrArea *BKE_screen_find_area_xy(struct bScreen *sc, const int spacetype, int x, int y);
327
328 unsigned int BKE_screen_view3d_layer_active_ex(
329         const struct View3D *v3d, const struct Scene *scene, bool use_localvd) ATTR_NONNULL(2);
330 unsigned int BKE_screen_view3d_layer_active(
331         const struct View3D *v3d, const struct Scene *scene) ATTR_NONNULL(2);
332
333 unsigned int BKE_screen_view3d_layer_all(const struct bScreen *sc) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
334
335 void BKE_screen_manipulator_tag_refresh(struct bScreen *sc);
336
337 void BKE_screen_view3d_sync(struct View3D *v3d, struct Scene *scene);
338 void BKE_screen_view3d_scene_sync(struct bScreen *sc, struct Scene *scene);
339 bool BKE_screen_is_fullscreen_area(const struct bScreen *screen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
340 bool BKE_screen_is_used(const struct bScreen *screen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
341
342 /* zoom factor conversion */
343 float BKE_screen_view3d_zoom_to_fac(float camzoom);
344 float BKE_screen_view3d_zoom_from_fac(float zoomfac);
345
346 /* screen */
347 void BKE_screen_free(struct bScreen *sc); 
348 void BKE_screen_area_map_free(struct ScrAreaMap *area_map) ATTR_NONNULL();
349 unsigned int BKE_screen_visible_layers(struct bScreen *screen, struct Scene *scene);
350
351 struct ScrEdge *BKE_screen_find_edge(struct bScreen *sc, struct ScrVert *v1, struct ScrVert *v2);
352 void BKE_screen_sort_scrvert(struct ScrVert **v1, struct ScrVert **v2);
353 void BKE_screen_remove_double_scrverts(struct bScreen *sc);
354 void BKE_screen_remove_double_scredges(struct bScreen *sc);
355 void BKE_screen_remove_unused_scredges(struct bScreen *sc);
356 void BKE_screen_remove_unused_scrverts(struct bScreen *sc);
357
358 #endif
359