Partial fix for [#20166] Snap to grid issues
[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         /* transform widget matrix */
86         float twmat[4][4];
87         
88         float viewquat[4], dist, zfac;  /* zfac is initgrabz() result */
89         float camdx, camdy;                             /* camera view offsets, 1.0 = viewplane moves entire width/height */
90         float pixsize;
91         float ofs[3];
92         short camzoom, viewbut, pad[2];
93         
94         short rflag, viewlock;
95         short persp;
96         short view;
97         
98         /* user defined clipping planes */
99         float clip[6][4];
100         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
101         struct BoundBox *clipbb;        
102         
103         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
104         
105         struct RegionView3D *localvd;
106         struct RenderInfo *ri;
107         struct RetopoViewData *retopo_view_data;
108         struct ViewDepths *depths;
109         
110         /* animated smooth view */
111         struct SmoothViewStore *sms;
112         struct wmTimer *smooth_timer;
113         
114         /* last view */
115         float lviewquat[4];
116         short lpersp, lview;
117         float gridview;
118         
119
120 } RegionView3D;
121
122 /* 3D ViewPort Struct */
123 typedef struct View3D {
124         struct SpaceLink *next, *prev;
125         ListBase regionbase;            /* storage of regions for inactive spaces */
126         int spacetype;
127         float blockscale;
128         short blockhandler[8];
129         
130         float viewquat[4], dist, pad1;  /* XXX depricated */
131         
132         int lay_used; /* used while drawing */
133         
134         short persp;    /* XXX depricated */
135         short view;     /* XXX depricated */
136         
137         struct Object *camera, *ob_centre;
138         struct BGpic *bgpic;
139         struct View3D *localvd;
140         
141         char ob_centre_bone[32];                /* optional string for armature bone to define center */
142         
143         int lay, layact;
144         
145         /**
146          * The drawing mode for the 3d display. Set to OB_WIRE, OB_SOLID,
147          * OB_SHADED or OB_TEXTURE */
148         short drawtype;
149         short pad2;
150         short scenelock, around, pad3;
151         short flag, flag2;
152         
153         short pivot_last; /* pivot_last is for rotating around the last edited element */
154         
155         float lens, grid;
156         float gridview; /* XXX deprecated, now in RegionView3D */
157         float padf, near, far;
158         float ofs[3];                   /* XXX deprecated */
159         float cursor[3];
160
161         short gridlines, pad4;
162         short gridflag;
163         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
164         short modeselect;
165         short keyflags;         /* flags for display of keyframes */
166         
167         /* transform widget info */
168         short twtype, twmode, twflag, twdrawflag;
169         
170         /* customdata flags from modes */
171         unsigned int customdata_mask;
172         
173         /* afterdraw, for xray & transparent */
174         struct ListBase afterdraw;
175         
176         /* drawflags, denoting state */
177         short zbuf, transp, xray;
178
179         char ndofmode;                  /* mode of transform for 6DOF devices -1 not found, 0 normal, 1 fly, 2 ob transform */
180         char ndoffilter;                /* filter for 6DOF devices 0 normal, 1 dominant */
181         
182         void *properties_storage;       /* Nkey panel stores stuff here, not in file */
183         
184         /* XXX depricated? */
185         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
186
187 } View3D;
188
189 /* XXX this needs cleaning */
190
191 /* View3D->flag (short) */
192 #define V3D_MODE                        (16+32+64+128+256+512)
193 #define V3D_DISPIMAGE           1
194 #define V3D_DISPBGPIC           2
195 #define V3D_HIDE_HELPLINES      4
196 #define V3D_INVALID_BACKBUF     8
197 #define V3D_EDITMODE            16
198 #define V3D_VERTEXPAINT         32
199 #define V3D_FACESELECT          64
200 #define V3D_POSEMODE            128
201 #define V3D_TEXTUREPAINT        256
202 #define V3D_WEIGHTPAINT         512
203 #define V3D_ALIGN                       1024
204 #define V3D_SELECT_OUTLINE      2048
205 #define V3D_ZBUF_SELECT         4096
206 #define V3D_GLOBAL_STATS        8192
207 #define V3D_DRAW_CENTERS        32768
208
209 /* RegionView3d->persp */
210 #define RV3D_ORTHO                              0
211 #define RV3D_PERSP                              1
212 #define RV3D_CAMOB                              2
213
214 /* RegionView3d->rflag */
215 #define RV3D_FLYMODE                            2
216 #define RV3D_CLIPPING                           4
217 #define RV3D_NAVIGATING                         8
218
219 /* RegionView3d->viewlock */
220 #define RV3D_LOCKED                     1
221 #define RV3D_BOXVIEW            2
222 #define RV3D_BOXCLIP            4
223
224 /* RegionView3d->view */
225 #define RV3D_VIEW_FRONT          1
226 #define RV3D_VIEW_BACK                   2
227 #define RV3D_VIEW_LEFT                   3
228 #define RV3D_VIEW_RIGHT          4
229 #define RV3D_VIEW_TOP                    5
230 #define RV3D_VIEW_BOTTOM                 6
231 #define RV3D_VIEW_PERSPORTHO     7
232 #define RV3D_VIEW_CAMERA                 8
233
234 /* View3d->flag2 (short) */
235 #define V3D_SOLID_TEX                   8
236 #define V3D_DISPGP                              16
237
238 /* View3D->around */
239 #define V3D_CENTER               0
240 #define V3D_CENTROID     3
241 #define V3D_CURSOR               1
242 #define V3D_LOCAL                2
243 #define V3D_ACTIVE               4
244
245 /*View3D types (only used in tools, not actually saved)*/
246 #define V3D_VIEW_STEPLEFT                1
247 #define V3D_VIEW_STEPRIGHT               2
248 #define V3D_VIEW_STEPDOWN                3
249 #define V3D_VIEW_STEPUP          4
250 #define V3D_VIEW_PANLEFT                 5
251 #define V3D_VIEW_PANRIGHT                6
252 #define V3D_VIEW_PANDOWN                 7
253 #define V3D_VIEW_PANUP                   8
254
255 /* View3d->gridflag */
256 #define V3D_SHOW_FLOOR                  1
257 #define V3D_SHOW_X                              2
258 #define V3D_SHOW_Y                              4
259 #define V3D_SHOW_Z                              8
260
261 /* View3d->twtype (bits, we can combine them) */
262 #define V3D_MANIP_TRANSLATE             1
263 #define V3D_MANIP_ROTATE                2
264 #define V3D_MANIP_SCALE                 4
265
266 /* View3d->twmode */
267 #define V3D_MANIP_GLOBAL                0
268 #define V3D_MANIP_LOCAL                 1
269 #define V3D_MANIP_NORMAL                2
270 #define V3D_MANIP_VIEW                  3
271 #define V3D_MANIP_GIMBAL                4
272 #define V3D_MANIP_CUSTOM                5 /* anything of value 5 or higher is custom */
273
274 /* View3d->twflag */
275    /* USE = user setting, DRAW = based on selection */
276 #define V3D_USE_MANIPULATOR             1
277 #define V3D_DRAW_MANIPULATOR    2
278 #define V3D_CALC_MANIPULATOR    4
279
280
281 #endif
282
283