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
45 /* This is needed to not let VC choke on near and far... old
46  * proprietary MS extensions... */
47 #ifdef WIN32
48 #undef near
49 #undef far
50 #define near clipsta
51 #define far clipend
52 #endif
53
54 #include "DNA_listBase.h"
55 #include "DNA_image_types.h"
56
57 /* ******************************** */
58
59 /* The near/far thing is a Win EXCEPTION. Thus, leave near/far in the
60  * code, and patch for windows. */
61  
62 /* Background Picture in 3D-View */
63 typedef struct BGpic {
64     struct Image *ima;
65         struct ImageUser iuser;
66     float xof, yof, size, zoom, blend;
67     short xim, yim;
68 } BGpic;
69
70 /* ********************************* */
71
72 /* 3D ViewPort Struct */
73 typedef struct View3D {
74         struct SpaceLink *next, *prev;
75         ListBase regionbase;            /* storage of regions for inactive spaces */
76         int spacetype;
77         float blockscale;
78         
79         short blockhandler[8];
80
81         float winmat[4][4];
82         float viewmat[4][4];
83         float viewinv[4][4];
84         float persmat[4][4];
85         float persinv[4][4];
86         
87         float viewquat[4], dist, zfac;  /* zfac is initgrabz() result */
88         int lay_used; /* used while drawing */
89
90         short persp;
91         short view;
92
93         struct Object *camera, *ob_centre;
94         struct BGpic *bgpic;
95         struct View3D *localvd;
96         struct RenderInfo *ri;
97         struct RetopoViewData *retopo_view_data;
98         struct ViewDepths *depths;
99         
100         char ob_centre_bone[32];                /* optional string for armature bone to define center */
101         
102         /**
103          * The drawing mode for the 3d display. Set to OB_WIRE, OB_SOLID,
104          * OB_SHADED or OB_TEXTURE */
105         short drawtype;
106         short localview;
107         int lay, layact;
108         short scenelock, around, camzoom;
109         
110         char pivot_last, pad1; /* pivot_last is for rotating around the last edited element */
111         
112         float lens, grid, gridview, pixsize, near, far;
113         float camdx, camdy;             /* camera view offsets, 1.0 = viewplane moves entire width/height */
114         float ofs[3], cursor[3];
115
116         short gridlines, viewbut;
117         short gridflag;
118         short modeselect, menunr, texnr;
119         
120         /* transform widget info */
121         short twtype, twmode, twflag, twdrawflag;
122         float twmat[4][4];
123         
124         /* user defined clipping planes */
125         float clip[4][4];
126         
127         struct BoundBox *clipbb;
128         
129         /* afterdraw, for xray & transparent */
130         struct ListBase afterdraw;
131         /* drawflags, denoting state */
132         short zbuf, transp, xray;
133
134         short flag, flag2;
135         
136         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
137         
138         short keyflags;         /* flags for display of keyframes */
139         
140         char ndofmode;  /* mode of transform for 6DOF devices -1 not found, 0 normal, 1 fly, 2 ob transform */
141         char ndoffilter;                /*filter for 6DOF devices 0 normal, 1 dominant */
142         
143         void *properties_storage;       /* Nkey panel stores stuff here, not in file */
144         struct bGPdata *gpd;            /* Grease-Pencil Data (annotation layers) */
145
146         /* last view */
147         float lviewquat[4];
148         short lpersp, lview;
149
150         short pad5, pad6;
151 } View3D;
152
153
154 /* View3D->flag (short) */
155 #define V3D_MODE                        (16+32+64+128+256+512)
156 #define V3D_DISPIMAGE           1
157 #define V3D_DISPBGPIC           2
158 #define V3D_HIDE_HELPLINES      4
159 #define V3D_NEEDBACKBUFDRAW     8
160 #define V3D_EDITMODE            16
161 #define V3D_VERTEXPAINT         32
162 #define V3D_FACESELECT          64
163 #define V3D_POSEMODE            128
164 #define V3D_TEXTUREPAINT        256
165 #define V3D_WEIGHTPAINT         512
166 #define V3D_ALIGN                       1024
167 #define V3D_SELECT_OUTLINE      2048
168 #define V3D_ZBUF_SELECT         4096
169 #define V3D_GLOBAL_STATS        8192
170 #define V3D_CLIPPING            16384
171 #define V3D_DRAW_CENTERS        32768
172
173 /* View3d->flag2 (short) */
174 #define V3D_MODE2                       (32)
175 #define V3D_OPP_DIRECTION_NAME  1
176 #define V3D_FLYMODE                             2
177 #define V3D_DEPRECATED                  4 /* V3D_TRANSFORM_SNAP, moved to a scene setting */
178 #define V3D_SOLID_TEX                   8
179 #define V3D_DISPGP                              16
180
181 /* View3D->around */
182 #define V3D_CENTER               0
183 #define V3D_CENTROID     3
184 #define V3D_CURSOR               1
185 #define V3D_LOCAL                2
186 #define V3D_ACTIVE               4
187
188
189 /* View3d->persp */
190 #define V3D_ORTHO                               0
191 #define V3D_PERSP                               1
192 #define V3D_CAMOB                               2
193
194 /* View3d->gridflag */
195 #define V3D_SHOW_FLOOR                  1
196 #define V3D_SHOW_X                              2
197 #define V3D_SHOW_Y                              4
198 #define V3D_SHOW_Z                              8
199
200 /* View3d->twtype (bits, we can combine them) */
201 #define V3D_MANIP_TRANSLATE             1
202 #define V3D_MANIP_ROTATE                2
203 #define V3D_MANIP_SCALE                 4
204
205 /* View3d->twmode */
206 #define V3D_MANIP_GLOBAL                0
207 #define V3D_MANIP_LOCAL                 1
208 #define V3D_MANIP_NORMAL                2
209 #define V3D_MANIP_VIEW                  3
210 #define V3D_MANIP_CUSTOM                4 /* anything of value 4 or higher is custom */
211
212 /* View3d->twflag */
213    /* USE = user setting, DRAW = based on selection */
214 #define V3D_USE_MANIPULATOR             1
215 #define V3D_DRAW_MANIPULATOR    2
216 #define V3D_CALC_MANIPULATOR    4
217
218
219 #endif
220
221