NLA SoC: Merge from 2.5
[blender-staging.git] / source / blender / makesdna / DNA_view3d_types.h
1 /**
2  * blenlib/DNA_view3d_types.h (mar-2001 nzc)
3  *
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef DNA_VIEW3D_TYPES_H
32 #define DNA_VIEW3D_TYPES_H
33
34 struct ViewDepths;
35 struct Object;
36 struct Image;
37 struct Tex;
38 struct SpaceLink;
39 struct Base;
40 struct BoundBox;
41 struct RenderInfo;
42 struct RetopoViewData;
43 struct bGPdata;
44 struct SmoothViewStore;
45 struct wmTimer;
46
47 /* This is needed to not let VC choke on near and far... old
48  * proprietary MS extensions... */
49 #ifdef WIN32
50 #undef near
51 #undef far
52 #define near clipsta
53 #define far clipend
54 #endif
55
56 #include "DNA_listBase.h"
57 #include "DNA_image_types.h"
58
59 /* ******************************** */
60
61 /* The near/far thing is a Win EXCEPTION. Thus, leave near/far in the
62  * code, and patch for windows. */
63  
64 /* Background Picture in 3D-View */
65 typedef struct BGpic {
66     struct Image *ima;
67         struct ImageUser iuser;
68     float xof, yof, size, blend;
69 } BGpic;
70
71 /* ********************************* */
72
73 typedef struct RegionView3D {
74         
75         float winmat[4][4];
76         float viewmat[4][4];
77         float viewinv[4][4];
78         float persmat[4][4];
79         float persinv[4][4];
80
81         /* local viewmat/persmat, multiplied with object matrix, while drawing */
82         float viewmatob[4][4];
83         float persmatob[4][4];
84
85         float viewquat[4], dist, zfac;  /* zfac is initgrabz() result */
86         float camdx, camdy;                             /* camera view offsets, 1.0 = viewplane moves entire width/height */
87         float pixsize;
88         float ofs[3];
89         short camzoom, viewbut;
90         
91         int lastmode;                                   /* for modal keymap switching, int because it stores notifier code */
92         
93         short rflag, viewlock;
94         short persp;
95         short view;
96         
97         /* user defined clipping planes */
98         float clip[6][4];
99         struct BoundBox *clipbb;        
100         
101         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
102         
103         struct RegionView3D *localvd;
104         struct RenderInfo *ri;
105         struct RetopoViewData *retopo_view_data;
106         struct ViewDepths *depths;
107         
108         /* animated smooth view */
109         struct SmoothViewStore *sms;
110         struct wmTimer *smooth_timer;
111         
112         /* last view */
113         float lviewquat[4];
114         short lpersp, lview;
115         int pad3;
116         
117 } RegionView3D;
118
119 /* 3D ViewPort Struct */
120 typedef struct View3D {
121         struct SpaceLink *next, *prev;
122         ListBase regionbase;            /* storage of regions for inactive spaces */
123         int spacetype;
124         float blockscale;
125         short blockhandler[8];
126         
127         float viewquat[4], dist, pad1;  /* XXX depricated */
128         
129         int lay_used; /* used while drawing */
130         
131         short persp;    /* XXX depricated */
132         short view;     /* XXX depricated */
133         
134         struct Object *camera, *ob_centre;
135         struct BGpic *bgpic;
136         struct View3D *localvd;
137         
138         char ob_centre_bone[32];                /* optional string for armature bone to define center */
139         
140         int lay, layact;
141         
142         /**
143          * The drawing mode for the 3d display. Set to OB_WIRE, OB_SOLID,
144          * OB_SHADED or OB_TEXTURE */
145         short drawtype;
146         short localview;
147         short scenelock, around, pad3;
148         short flag, flag2;
149         
150         short pivot_last; /* pivot_last is for rotating around the last edited element */
151         
152         float lens, grid, gridview, padf, near, far;
153         float ofs[3];                   /* XXX depricated */
154         float cursor[3];
155
156         short gridlines, pad4;
157         short gridflag;
158         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
159         short modeselect;
160         short keyflags;         /* flags for display of keyframes */
161         
162         /* transform widget info */
163         short twtype, twmode, twflag, twdrawflag;
164         
165         /* customdata flags from modes */
166         unsigned int customdata_mask;
167         
168         /* afterdraw, for xray & transparent */
169         struct ListBase afterdraw;
170         
171         /* drawflags, denoting state */
172         short zbuf, transp, xray;
173
174         char ndofmode;                  /* mode of transform for 6DOF devices -1 not found, 0 normal, 1 fly, 2 ob transform */
175         char ndoffilter;                /* filter for 6DOF devices 0 normal, 1 dominant */
176         
177         void *properties_storage;       /* Nkey panel stores stuff here, not in file */
178         
179         /* XXX depricated? */
180         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
181
182 } View3D;
183
184 /* XXX this needs cleaning */
185
186 /* View3D->flag (short) */
187 #define V3D_MODE                        (16+32+64+128+256+512)
188 #define V3D_DISPIMAGE           1
189 #define V3D_DISPBGPIC           2
190 #define V3D_HIDE_HELPLINES      4
191 #define V3D_NEEDBACKBUFDRAW     8
192 #define V3D_EDITMODE            16
193 #define V3D_VERTEXPAINT         32
194 #define V3D_FACESELECT          64
195 #define V3D_POSEMODE            128
196 #define V3D_TEXTUREPAINT        256
197 #define V3D_WEIGHTPAINT         512
198 #define V3D_ALIGN                       1024
199 #define V3D_SELECT_OUTLINE      2048
200 #define V3D_ZBUF_SELECT         4096
201 #define V3D_GLOBAL_STATS        8192
202 #define V3D_DRAW_CENTERS        32768
203
204 /* RegionView3d->rflag */
205 #define RV3D_FLYMODE                            2
206 #define RV3D_CLIPPING                           4
207
208 /* RegionView3d->viewlock */
209 #define RV3D_LOCKED                     1
210 #define RV3D_BOXVIEW            2
211 #define RV3D_BOXCLIP            4
212
213 /* View3d->flag2 (short) */
214 #define V3D_SOLID_TEX                   8
215 #define V3D_DISPGP                              16
216
217 /* View3D->around */
218 #define V3D_CENTER               0
219 #define V3D_CENTROID     3
220 #define V3D_CURSOR               1
221 #define V3D_LOCAL                2
222 #define V3D_ACTIVE               4
223
224 /*View3D view types*/
225 #define V3D_VIEW_FRONT           1
226 #define V3D_VIEW_BACK            2
227 #define V3D_VIEW_LEFT            3
228 #define V3D_VIEW_RIGHT           4
229 #define V3D_VIEW_TOP             5
230 #define V3D_VIEW_BOTTOM          6
231 #define V3D_VIEW_PERSPORTHO              7
232 #define V3D_VIEW_CAMERA          8
233 #define V3D_VIEW_STEPLEFT                9
234 #define V3D_VIEW_STEPRIGHT               10
235 #define V3D_VIEW_STEPDOWN                11
236 #define V3D_VIEW_STEPUP          12
237 #define V3D_VIEW_PANLEFT                 13
238 #define V3D_VIEW_PANRIGHT                14
239 #define V3D_VIEW_PANDOWN                 15
240 #define V3D_VIEW_PANUP           16
241
242 /* View3d->persp */
243 #define V3D_ORTHO                               0
244 #define V3D_PERSP                               1
245 #define V3D_CAMOB                               2
246
247 /* View3d->gridflag */
248 #define V3D_SHOW_FLOOR                  1
249 #define V3D_SHOW_X                              2
250 #define V3D_SHOW_Y                              4
251 #define V3D_SHOW_Z                              8
252
253 /* View3d->twtype (bits, we can combine them) */
254 #define V3D_MANIP_TRANSLATE             1
255 #define V3D_MANIP_ROTATE                2
256 #define V3D_MANIP_SCALE                 4
257
258 /* View3d->twmode */
259 #define V3D_MANIP_GLOBAL                0
260 #define V3D_MANIP_LOCAL                 1
261 #define V3D_MANIP_NORMAL                2
262 #define V3D_MANIP_VIEW                  3
263 #define V3D_MANIP_CUSTOM                4 /* anything of value 4 or higher is custom */
264
265 /* View3d->twflag */
266    /* USE = user setting, DRAW = based on selection */
267 #define V3D_USE_MANIPULATOR             1
268 #define V3D_DRAW_MANIPULATOR    2
269 #define V3D_CALC_MANIPULATOR    4
270
271
272 #endif
273
274