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