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