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