Merging r39435 through r39477 from trunk into soc-2011-tomato
[blender.git] / source / blender / makesdna / DNA_view3d_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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef DNA_VIEW3D_TYPES_H
30 #define DNA_VIEW3D_TYPES_H
31
32 /** \file DNA_view3d_types.h
33  *  \ingroup DNA
34  */
35
36 struct ViewDepths;
37 struct Object;
38 struct Image;
39 struct Tex;
40 struct SpaceLink;
41 struct Base;
42 struct BoundBox;
43 struct MovieClip;
44 struct MovieClipUser;
45 struct RenderInfo;
46 struct bGPdata;
47 struct SmoothViewStore;
48 struct wmTimer;
49
50 /* This is needed to not let VC choke on near and far... old
51  * proprietary MS extensions... */
52 #ifdef WIN32
53 #undef near
54 #undef far
55 #define near clipsta
56 #define far clipend
57 #endif
58
59 #include "DNA_listBase.h"
60 #include "DNA_image_types.h"
61 #include "DNA_movieclip_types.h"
62
63 /* ******************************** */
64
65 /* The near/far thing is a Win EXCEPTION. Thus, leave near/far in the
66  * code, and patch for windows. */
67  
68 /* Background Picture in 3D-View */
69 typedef struct BGpic {
70         struct BGpic *next, *prev;
71
72         struct Image *ima;
73         struct ImageUser iuser;
74         struct MovieClip *clip;
75         struct MovieClipUser cuser;
76         float xof, yof, size, blend;
77         short view;
78         short flag;
79         short source, pad;
80 } BGpic;
81
82 /* ********************************* */
83
84 typedef struct RegionView3D {
85         
86         float winmat[4][4];                     /* GL_PROJECTION matrix */
87         float viewmat[4][4];            /* GL_MODELVIEW matrix */
88         float viewinv[4][4];            /* inverse of viewmat */
89         float persmat[4][4];            /* viewmat*winmat */
90         float persinv[4][4];            /* inverse of persmat */
91
92         /* viewmat/persmat multiplied with object matrix, while drawing and selection */
93         float viewmatob[4][4];
94         float persmatob[4][4];
95
96         /* transform widget matrix */
97         float twmat[4][4];
98
99         float viewquat[4];                      /* view rotation, must be kept normalized */
100         float dist;                                     /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */
101         float zfac;                                     /* initgrabz() result */
102         float camdx, camdy;                     /* camera view offsets, 1.0 = viewplane moves entire width/height */
103         float pixsize;                          /* runtime only */
104         float ofs[3];                           /* view center & orbit pivot, negative of worldspace location,
105                                                                  * also matches -viewinv[3][0:3] in ortho mode.*/
106         short camzoom;                          /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */
107         short twdrawflag;
108         char is_persp;                          /* check if persp/ortho view, since 'persp' cant be used for this since
109                                                                  * it can have cameras assigned as well. (only set in setwinmatrixview3d) */
110         char pad[3];
111         
112         short rflag, viewlock;
113         short persp;
114         short view;
115         
116         /* user defined clipping planes */
117         float clip[6][4];
118         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
119         struct BoundBox *clipbb;        
120         
121         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
122         
123         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
124         struct RenderInfo *ri;
125         struct ViewDepths *depths;
126         
127         /* animated smooth view */
128         struct SmoothViewStore *sms;
129         struct wmTimer *smooth_timer;
130         
131         /* last view */
132         float lviewquat[4];
133         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
134         float gridview;
135         
136         float twangle[3];
137
138         /* active rotation from NDOF or elsewhere */
139         float rot_angle;
140         float rot_axis[3];
141         
142         char pad2[4];
143
144 } RegionView3D;
145
146 /* 3D ViewPort Struct */
147 typedef struct View3D {
148         struct SpaceLink *next, *prev;
149         ListBase regionbase;            /* storage of regions for inactive spaces */
150         int spacetype;
151         float blockscale;
152         short blockhandler[8];
153         
154         float viewquat[4], dist;        /* XXX depricated */
155
156         float bundle_size;                      /* size of bundles in reconstructed data */
157         short bundle_drawtype;          /* display style for bundle */
158
159         char pad[6];
160         
161         unsigned int lay_used; /* used while drawing */
162         
163         short persp;    /* XXX depricated */
164         short view;     /* XXX depricated */
165         
166         struct Object *camera, *ob_centre;
167
168         struct ListBase bgpicbase;
169         struct BGpic *bgpic; /* deprecated, use bgpicbase, only kept for do_versions(...) */
170
171         struct View3D *localvd; /* allocated backup of its self while in localview */
172         
173         char ob_centre_bone[32];                /* optional string for armature bone to define center */
174         
175         unsigned int lay;
176         int layact;
177         
178         /**
179          * The drawing mode for the 3d display. Set to OB_WIRE, OB_SOLID,
180          * OB_SHADED or OB_TEXTURE */
181         short drawtype;
182         short ob_centre_cursor;         /* optional bool for 3d cursor to define center */
183         short scenelock, around;
184         short flag, flag2;
185         
186         float lens, grid;
187         float near, far;
188         float ofs[3];                   /* XXX deprecated */
189         float cursor[3];
190
191         short modeselect;
192         short gridlines;
193         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
194         char gridflag;
195
196         /* transform widget info */
197         char twtype, twmode, twflag, pad2[2];
198         
199         /* afterdraw, for xray & transparent */
200         struct ListBase afterdraw_transp;
201         struct ListBase afterdraw_xray;
202         struct ListBase afterdraw_xraytransp;
203         
204         /* drawflags, denoting state */
205         short zbuf, transp, xray;
206
207         char pad3[2];
208
209         void *properties_storage;       /* Nkey panel stores stuff here (runtime only!) */
210
211         /* XXX depricated? */
212         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
213
214 } View3D;
215
216
217 /* View3D->flag (short) */
218 /*#define V3D_DISPIMAGE         1*/ /*UNUSED*/
219 #define V3D_DISPBGPICS          2
220 #define V3D_HIDE_HELPLINES      4
221 #define V3D_INVALID_BACKBUF     8
222
223 #define V3D_ALIGN                       1024
224 #define V3D_SELECT_OUTLINE      2048
225 #define V3D_ZBUF_SELECT         4096
226 #define V3D_GLOBAL_STATS        8192
227 #define V3D_DRAW_CENTERS        32768
228
229 /* RegionView3d->persp */
230 #define RV3D_ORTHO                              0
231 #define RV3D_PERSP                              1
232 #define RV3D_CAMOB                              2
233
234 /* RegionView3d->rflag */
235 #define RV3D_CLIPPING                           4
236 #define RV3D_NAVIGATING                         8
237 #define RV3D_GPULIGHT_UPDATE            16
238
239 /* RegionView3d->viewlock */
240 #define RV3D_LOCKED                     1
241 #define RV3D_BOXVIEW            2
242 #define RV3D_BOXCLIP            4
243
244 /* RegionView3d->view */
245 #define RV3D_VIEW_USER                   0
246 #define RV3D_VIEW_FRONT                  1
247 #define RV3D_VIEW_BACK                   2
248 #define RV3D_VIEW_LEFT                   3
249 #define RV3D_VIEW_RIGHT                  4
250 #define RV3D_VIEW_TOP                    5
251 #define RV3D_VIEW_BOTTOM                 6
252 #define RV3D_VIEW_PERSPORTHO     7
253 #define RV3D_VIEW_CAMERA                 8
254
255 /* View3d->flag2 (short) */
256 #define V3D_RENDER_OVERRIDE             4
257 #define V3D_SOLID_TEX                   8
258 #define V3D_DISPGP                              16
259 #define V3D_LOCK_CAMERA                 32
260 #define V3D_SHOW_RECONSTRUCTION 64
261 #define V3D_SHOW_CAMERAPATH             128
262 #define V3D_SHOW_BUNDLENAME             256
263
264 /* View3D->around */
265 #define V3D_CENTER               0
266 #define V3D_CENTROID     3
267 #define V3D_CURSOR               1
268 #define V3D_LOCAL                2
269 #define V3D_ACTIVE               4
270
271 /*View3D types (only used in tools, not actually saved)*/
272 #define V3D_VIEW_STEPLEFT                1
273 #define V3D_VIEW_STEPRIGHT               2
274 #define V3D_VIEW_STEPDOWN                3
275 #define V3D_VIEW_STEPUP          4
276 #define V3D_VIEW_PANLEFT                 5
277 #define V3D_VIEW_PANRIGHT                6
278 #define V3D_VIEW_PANDOWN                 7
279 #define V3D_VIEW_PANUP                   8
280
281 /* View3d->gridflag */
282 #define V3D_SHOW_FLOOR                  1
283 #define V3D_SHOW_X                              2
284 #define V3D_SHOW_Y                              4
285 #define V3D_SHOW_Z                              8
286
287 /* View3d->twtype (bits, we can combine them) */
288 #define V3D_MANIP_TRANSLATE             1
289 #define V3D_MANIP_ROTATE                2
290 #define V3D_MANIP_SCALE                 4
291
292 /* View3d->twmode */
293 #define V3D_MANIP_GLOBAL                0
294 #define V3D_MANIP_LOCAL                 1
295 #define V3D_MANIP_NORMAL                2
296 #define V3D_MANIP_VIEW                  3
297 #define V3D_MANIP_GIMBAL                4
298 #define V3D_MANIP_CUSTOM                5 /* anything of value 5 or higher is custom */
299
300 /* View3d->twflag */
301    /* USE = user setting, DRAW = based on selection */
302 #define V3D_USE_MANIPULATOR             1
303 #define V3D_DRAW_MANIPULATOR    2
304 /* #define V3D_CALC_MANIPULATOR 4 */ /*UNUSED*/
305
306 /* BGPic->flag */
307 /* may want to use 1 for select ?*/
308 #define V3D_BGPIC_EXPANDED              2
309
310 /* BGPic->source */
311 /* may want to use 1 for select ?*/
312 #define V3D_BGPIC_IMAGE         0
313 #define V3D_BGPIC_MOVIE         1
314
315 #define RV3D_CAMZOOM_MIN -30
316 #define RV3D_CAMZOOM_MAX 600
317
318 #endif
319
320