remove some unused view3d members & added RV3D_VIEW_USER define.
[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         short camzoom;
101         short twdrawflag;
102         int pad;
103         
104         short rflag, viewlock;
105         short persp;
106         short view;
107         
108         /* user defined clipping planes */
109         float clip[6][4];
110         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
111         struct BoundBox *clipbb;        
112         
113         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
114         
115         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
116         struct RenderInfo *ri;
117         struct ViewDepths *depths;
118         
119         /* animated smooth view */
120         struct SmoothViewStore *sms;
121         struct wmTimer *smooth_timer;
122         
123         /* last view */
124         float lviewquat[4];
125         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
126         float gridview;
127         
128         float twangle[3];
129
130         float padf;
131
132 } RegionView3D;
133
134 /* 3D ViewPort Struct */
135 typedef struct View3D {
136         struct SpaceLink *next, *prev;
137         ListBase regionbase;            /* storage of regions for inactive spaces */
138         int spacetype;
139         float blockscale;
140         short blockhandler[8];
141         
142         float viewquat[4], dist, pad1;  /* XXX depricated */
143         
144         unsigned int lay_used; /* used while drawing */
145         
146         short persp;    /* XXX depricated */
147         short view;     /* XXX depricated */
148         
149         struct Object *camera, *ob_centre;
150
151         struct ListBase bgpicbase;
152         struct BGpic *bgpic; /* deprecated, use bgpicbase, only kept for do_versions(...) */
153
154         struct View3D *localvd; /* allocated backup of its self while in localview */
155         
156         char ob_centre_bone[32];                /* optional string for armature bone to define center */
157         
158         unsigned int lay;
159         int layact;
160         
161         /**
162          * The drawing mode for the 3d display. Set to OB_WIRE, OB_SOLID,
163          * OB_SHADED or OB_TEXTURE */
164         short drawtype;
165         short ob_centre_cursor;         /* optional bool for 3d cursor to define center */
166         short scenelock, around;
167         short flag, flag2;
168         
169         float lens, grid;
170         float near, far;
171         float ofs[3];                   /* XXX deprecated */
172         float cursor[3];
173
174         short modeselect;
175         short gridlines;
176         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
177         char gridflag;
178
179         /* transform widget info */
180         char twtype, twmode, twflag, pad2[2];
181         
182         /* afterdraw, for xray & transparent */
183         struct ListBase afterdraw_transp;
184         struct ListBase afterdraw_xray;
185         struct ListBase afterdraw_xraytransp;
186         
187         /* drawflags, denoting state */
188         short zbuf, transp, xray;
189
190         char ndofmode;                  /* mode of transform for 6DOF devices -1 not found, 0 normal, 1 fly, 2 ob transform */
191         char ndoffilter;                /* filter for 6DOF devices 0 normal, 1 dominant */
192         
193         void *properties_storage;       /* Nkey panel stores stuff here (runtime only!) */
194         
195         /* XXX depricated? */
196         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
197
198 } View3D;
199
200
201 /* View3D->flag (short) */
202 /*#define V3D_DISPIMAGE         1*/ /*UNUSED*/
203 #define V3D_DISPBGPICS          2
204 #define V3D_HIDE_HELPLINES      4
205 #define V3D_INVALID_BACKBUF     8
206
207 #define V3D_ALIGN                       1024
208 #define V3D_SELECT_OUTLINE      2048
209 #define V3D_ZBUF_SELECT         4096
210 #define V3D_GLOBAL_STATS        8192
211 #define V3D_DRAW_CENTERS        32768
212
213 /* RegionView3d->persp */
214 #define RV3D_ORTHO                              0
215 #define RV3D_PERSP                              1
216 #define RV3D_CAMOB                              2
217
218 /* RegionView3d->rflag */
219 #define RV3D_CLIPPING                           4
220 #define RV3D_NAVIGATING                         8
221 #define RV3D_GPULIGHT_UPDATE            16
222
223 /* RegionView3d->viewlock */
224 #define RV3D_LOCKED                     1
225 #define RV3D_BOXVIEW            2
226 #define RV3D_BOXCLIP            4
227
228 /* RegionView3d->view */
229 #define RV3D_VIEW_USER                   0
230 #define RV3D_VIEW_FRONT                  1
231 #define RV3D_VIEW_BACK                   2
232 #define RV3D_VIEW_LEFT                   3
233 #define RV3D_VIEW_RIGHT                  4
234 #define RV3D_VIEW_TOP                    5
235 #define RV3D_VIEW_BOTTOM                 6
236 #define RV3D_VIEW_PERSPORTHO     7
237 #define RV3D_VIEW_CAMERA                 8
238
239 /* View3d->flag2 (short) */
240 #define V3D_RENDER_OVERRIDE             4
241 #define V3D_SOLID_TEX                   8
242 #define V3D_DISPGP                              16
243 #define V3D_LOCK_CAMERA                 32
244
245 /* View3D->around */
246 #define V3D_CENTER               0
247 #define V3D_CENTROID     3
248 #define V3D_CURSOR               1
249 #define V3D_LOCAL                2
250 #define V3D_ACTIVE               4
251
252 /*View3D types (only used in tools, not actually saved)*/
253 #define V3D_VIEW_STEPLEFT                1
254 #define V3D_VIEW_STEPRIGHT               2
255 #define V3D_VIEW_STEPDOWN                3
256 #define V3D_VIEW_STEPUP          4
257 #define V3D_VIEW_PANLEFT                 5
258 #define V3D_VIEW_PANRIGHT                6
259 #define V3D_VIEW_PANDOWN                 7
260 #define V3D_VIEW_PANUP                   8
261
262 /* View3d->gridflag */
263 #define V3D_SHOW_FLOOR                  1
264 #define V3D_SHOW_X                              2
265 #define V3D_SHOW_Y                              4
266 #define V3D_SHOW_Z                              8
267
268 /* View3d->twtype (bits, we can combine them) */
269 #define V3D_MANIP_TRANSLATE             1
270 #define V3D_MANIP_ROTATE                2
271 #define V3D_MANIP_SCALE                 4
272
273 /* View3d->twmode */
274 #define V3D_MANIP_GLOBAL                0
275 #define V3D_MANIP_LOCAL                 1
276 #define V3D_MANIP_NORMAL                2
277 #define V3D_MANIP_VIEW                  3
278 #define V3D_MANIP_GIMBAL                4
279 #define V3D_MANIP_CUSTOM                5 /* anything of value 5 or higher is custom */
280
281 /* View3d->twflag */
282    /* USE = user setting, DRAW = based on selection */
283 #define V3D_USE_MANIPULATOR             1
284 #define V3D_DRAW_MANIPULATOR    2
285 /* #define V3D_CALC_MANIPULATOR 4 */ /*UNUSED*/
286
287 /* BGPic->flag */
288 /* may want to use 1 for select ?*/
289 #define V3D_BGPIC_EXPANDED              2
290
291 #define RV3D_CAMZOOM_MIN -30
292 #define RV3D_CAMZOOM_MAX 600
293
294 #endif
295
296