454ebd4873e0b7b33509b41c9ccd4869efff6505
[blender.git] / source / blender / makesdna / DNA_screen_types.h
1 /**
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef DNA_SCREEN_TYPES_H
28 #define DNA_SCREEN_TYPES_H
29
30 #include "DNA_listBase.h"
31 #include "DNA_view2d_types.h"
32 #include "DNA_vec_types.h"
33
34 #include "DNA_scriptlink_types.h"
35 #include "DNA_ID.h"
36
37 struct SpaceType;
38 struct SpaceLink;
39 struct ARegion;
40 struct ARegionType;
41 struct Scene;
42 struct wmTimer;
43
44 typedef struct bScreen {
45         ID id;
46         
47         ListBase vertbase, edgebase;
48         ListBase areabase;
49         ListBase regionbase;                            /* screen level regions, runtime only */
50         struct Scene *scene;
51         
52         short scenenr, screennr;                        /* only for pupmenu */
53         
54         short full, winid;                                      /* winid from WM, starts with 1 */
55         short do_draw;                                          /* notifier for drawing edges */
56         short do_refresh;                                       /* notifier for scale screen, changed screen, etc */
57         short do_gesture;                                       /* notifier for gesture draw. */
58         short pad[3];
59         
60         short mainwin;                                          /* screensize subwindow, for screenedges and global menus */
61         short subwinactive;                                     /* active subwindow */
62         
63         struct wmTimer *animtimer;                      /* if set, screen has timer handler added in window */
64         void *context;                                          /* context callback */
65         
66         short handler[8];                                       /* similar to space handler */
67 } bScreen;
68
69 typedef struct ScrVert {
70         struct ScrVert *next, *prev, *newv;
71         vec2s vec;
72         int flag;
73 } ScrVert;
74
75 typedef struct ScrEdge {
76         struct ScrEdge *next, *prev;
77         ScrVert *v1, *v2;
78         short border;                   /* 1 when at edge of screen */
79         short flag;
80         int pad;
81 } ScrEdge;
82
83 typedef struct Panel {          /* the part from uiBlock that needs saved in file */
84         struct Panel *next, *prev;
85
86         char panelname[64], tabname[64];        /* defined as UI_MAX_NAME_STR */
87         char drawname[64];                                      /* panelname is identifier for restoring location */
88         short ofsx, ofsy, sizex, sizey;
89         short flag, active;                                     /* active= used currently by a uiBlock */
90         short control;
91         short snap;
92         int sortcounter, pad;           /* when sorting panels, it uses this to put new ones in right place */
93         struct Panel *paneltab;         /* this panel is tabbed in *paneltab */
94         void *activedata;                       /* runtime for panel manipulation */
95 } Panel;
96
97 typedef struct ScrArea {
98         struct ScrArea *next, *prev;
99         
100         ScrVert *v1, *v2, *v3, *v4;
101         bScreen *full;                  /* if area==full, this is the parent */
102
103         rcti totrct;                    /* rect bound by v1 v2 v3 v4 */
104
105         char spacetype, butspacetype;   /* SPACE_..., butspacetype is button arg  */
106         short winx, winy;                               /* size */
107         
108         short headertype;                               /* OLD! 0=no header, 1= down, 2= up */
109         short pad;
110         short do_refresh;                               /* private, for spacetype refresh callback */
111         short cursor, flag;
112
113         ScriptLink scriptlink;
114         
115         struct SpaceType *type;         /* callbacks for this space type */
116         
117         ListBase spacedata;             /* SpaceLink */
118         ListBase regionbase;    /* ARegion */
119         ListBase handlers;              /* wmEventHandler */
120         
121         ListBase actionzones;   /* AZone */
122 } ScrArea;
123
124 typedef struct ARegion {
125         struct ARegion *next, *prev;
126         
127         View2D v2d;                                     /* 2D-View scrolling/zoom info (most regions are 2d anyways) */
128         rcti winrct;                            /* coordinates of region */
129         short winx, winy;                       /* size */
130         
131         short swinid;
132         short regiontype;                       /* window, header, etc. identifier for drawing */
133         short alignment;                        /* how it should split */
134         short flag;                                     /* hide, ... */
135         
136         float fsize;                            /* current split size in float */
137         
138         short do_draw;                          /* private, cached notifier events */
139         short pad;
140         int pad1;
141         
142         struct ARegionType *type;       /* callbacks for this region type */
143         
144         ListBase uiblocks;                      /* uiBlock */
145         ListBase panels;                        /* Panel */
146         ListBase handlers;                      /* wmEventHandler */
147         
148         char *headerstr;                        /* use this string to draw info */
149         void *regiondata;                       /* XXX 2.50, need spacedata equivalent? */
150 } ARegion;
151
152 /* area->flag */
153 #define HEADER_NO_PULLDOWN      1
154 #define AREA_FLAG_DRAWJOINTO 2
155 #define AREA_FLAG_DRAWJOINFROM 4
156
157 /* If you change EDGEWIDTH, also do the global arrat edcol[]  */
158 #define EDGEWIDTH       1
159 #define AREAGRID        4
160 #define AREAMINX        32
161 #define HEADERY         26
162 #define AREAMINY        (HEADERY+EDGEWIDTH)
163
164 #define HEADERDOWN      1
165 #define HEADERTOP       2
166
167 #define SCREENNORMAL    0
168 #define SCREENFULL      1
169 #define SCREENAUTOPLAY  2
170
171 /* sa->win_swap */
172 #define WIN_FRONT_OK    1
173 #define WIN_BACK_OK             2
174 #define WIN_EQUAL               3
175
176 /* Panel->snap - for snapping to screen edges */
177 #define PNL_SNAP_NONE           0
178 #define PNL_SNAP_TOP            1
179 #define PNL_SNAP_RIGHT          2
180 #define PNL_SNAP_BOTTOM 4
181 #define PNL_SNAP_LEFT           8
182
183 #define PNL_SNAP_DIST           9.0
184
185 /* screen handlers */
186 #define SCREEN_MAXHANDLER               8
187
188 #define SCREEN_HANDLER_ANIM             1
189 #define SCREEN_HANDLER_PYTHON   2
190 #define SCREEN_HANDLER_VERSE    3
191
192 /* regiontype, first two are the default set */
193 #define RGN_TYPE_WINDOW         0
194 #define RGN_TYPE_HEADER         1
195 #define RGN_TYPE_CHANNELS       2
196 #define RGN_TYPE_TEMPORARY      3
197 #define RGN_TYPE_UI                     4
198
199 /* region alignment */
200 #define RGN_ALIGN_NONE          0
201 #define RGN_ALIGN_TOP           1
202 #define RGN_ALIGN_BOTTOM        2
203 #define RGN_ALIGN_LEFT          3
204 #define RGN_ALIGN_RIGHT         4
205 #define RGN_ALIGN_HSPLIT        5
206 #define RGN_ALIGN_VSPLIT        6
207 #define RGN_ALIGN_FLOAT         7
208
209 /* region flag */
210 #define RGN_FLAG_HIDDEN         1
211 #define RGN_FLAG_TOO_SMALL      2
212
213 #endif
214