2.5
[blender.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, zoom, blend;
69     short xim, yim;
70 } BGpic;
71
72 /* ********************************* */
73
74 /* 3D ViewPort Struct */
75 typedef struct View3D {
76         struct SpaceLink *next, *prev;
77         ListBase regionbase;            /* storage of regions for inactive spaces */
78         int spacetype;
79         float blockscale;
80         
81         short blockhandler[8];
82
83         float winmat[4][4];
84         float viewmat[4][4];
85         float viewinv[4][4];
86         float persmat[4][4];
87         float persinv[4][4];
88         
89         float viewquat[4], dist, zfac;  /* zfac is initgrabz() result */
90         int lay_used; /* used while drawing */
91
92         short persp;
93         short view;
94
95         struct Object *camera, *ob_centre;
96         struct BGpic *bgpic;
97         struct View3D *localvd;
98         struct RenderInfo *ri;
99         struct RetopoViewData *retopo_view_data;
100         struct ViewDepths *depths;
101         
102         char ob_centre_bone[32];                /* optional string for armature bone to define center */
103         
104         /**
105          * The drawing mode for the 3d display. Set to OB_WIRE, OB_SOLID,
106          * OB_SHADED or OB_TEXTURE */
107         short drawtype;
108         short localview;
109         int lay, layact;
110         short scenelock, around, camzoom;
111         
112         char pivot_last, pad1; /* pivot_last is for rotating around the last edited element */
113         
114         float lens, grid, gridview, pixsize, near, far;
115         float camdx, camdy;             /* camera view offsets, 1.0 = viewplane moves entire width/height */
116         float ofs[3], cursor[3];
117
118         short gridlines, viewbut;
119         short gridflag;
120         short modeselect, menunr, texnr;
121         
122         /* transform widget info */
123         short twtype, twmode, twflag, twdrawflag;
124         float twmat[4][4];
125         
126         /* user defined clipping planes */
127         float clip[4][4];
128         
129         struct BoundBox *clipbb;
130         
131         /* afterdraw, for xray & transparent */
132         struct ListBase afterdraw;
133         /* drawflags, denoting state */
134         short zbuf, transp, xray;
135
136         short flag, flag2;
137         
138         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
139         
140         short keyflags;         /* flags for display of keyframes */
141         
142         char ndofmode;  /* mode of transform for 6DOF devices -1 not found, 0 normal, 1 fly, 2 ob transform */
143         char ndoffilter;                /*filter for 6DOF devices 0 normal, 1 dominant */
144         
145         void *properties_storage;       /* Nkey panel stores stuff here, not in file */
146         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
147
148         /* animated smooth view */
149         struct SmoothViewStore *sms;
150         struct wmTimer *smooth_timer;
151         
152         /* last view */
153         float lviewquat[4];
154         short lpersp, lview;
155
156         short pad5, pad6;
157 } View3D;
158
159
160 /* View3D->flag (short) */
161 #define V3D_MODE                        (16+32+64+128+256+512)
162 #define V3D_DISPIMAGE           1
163 #define V3D_DISPBGPIC           2
164 #define V3D_HIDE_HELPLINES      4
165 #define V3D_NEEDBACKBUFDRAW     8
166 #define V3D_EDITMODE            16
167 #define V3D_VERTEXPAINT         32
168 #define V3D_FACESELECT          64
169 #define V3D_POSEMODE            128
170 #define V3D_TEXTUREPAINT        256
171 #define V3D_WEIGHTPAINT         512
172 #define V3D_ALIGN                       1024
173 #define V3D_SELECT_OUTLINE      2048
174 #define V3D_ZBUF_SELECT         4096
175 #define V3D_GLOBAL_STATS        8192
176 #define V3D_CLIPPING            16384
177 #define V3D_DRAW_CENTERS        32768
178
179 /* View3d->flag2 (short) */
180 #define V3D_MODE2                       (32)
181 #define V3D_OPP_DIRECTION_NAME  1
182 #define V3D_FLYMODE                             2
183 #define V3D_DEPRECATED                  4 /* V3D_TRANSFORM_SNAP, moved to a scene setting */
184 #define V3D_SOLID_TEX                   8
185 #define V3D_DISPGP                              16
186
187 /* View3D->around */
188 #define V3D_CENTER               0
189 #define V3D_CENTROID     3
190 #define V3D_CURSOR               1
191 #define V3D_LOCAL                2
192 #define V3D_ACTIVE               4
193
194 /*View3D view types*/
195 #define V3D_VIEW_FRONT           1
196 #define V3D_VIEW_BACK            2
197 #define V3D_VIEW_LEFT            3
198 #define V3D_VIEW_RIGHT           4
199 #define V3D_VIEW_TOP             5
200 #define V3D_VIEW_BOTTOM          6
201 #define V3D_VIEW_PERSPORTHO              7
202 #define V3D_VIEW_CAMERA          8
203 #define V3D_VIEW_STEPLEFT                9
204 #define V3D_VIEW_STEPRIGHT               10
205 #define V3D_VIEW_STEPDOWN                11
206 #define V3D_VIEW_STEPUP          12
207 #define V3D_VIEW_PANLEFT                 13
208 #define V3D_VIEW_PANRIGHT                14
209 #define V3D_VIEW_PANDOWN                 15
210 #define V3D_VIEW_PANUP           16
211
212 /* View3d->persp */
213 #define V3D_ORTHO                               0
214 #define V3D_PERSP                               1
215 #define V3D_CAMOB                               2
216
217 /* View3d->gridflag */
218 #define V3D_SHOW_FLOOR                  1
219 #define V3D_SHOW_X                              2
220 #define V3D_SHOW_Y                              4
221 #define V3D_SHOW_Z                              8
222
223 /* View3d->twtype (bits, we can combine them) */
224 #define V3D_MANIP_TRANSLATE             1
225 #define V3D_MANIP_ROTATE                2
226 #define V3D_MANIP_SCALE                 4
227
228 /* View3d->twmode */
229 #define V3D_MANIP_GLOBAL                0
230 #define V3D_MANIP_LOCAL                 1
231 #define V3D_MANIP_NORMAL                2
232 #define V3D_MANIP_VIEW                  3
233 #define V3D_MANIP_CUSTOM                4 /* anything of value 4 or higher is custom */
234
235 /* View3d->twflag */
236    /* USE = user setting, DRAW = based on selection */
237 #define V3D_USE_MANIPULATOR             1
238 #define V3D_DRAW_MANIPULATOR    2
239 #define V3D_CALC_MANIPULATOR    4
240
241
242 #endif
243
244