Workbench: clean up the viewport shading code
[blender.git] / source / blender / makesdna / DNA_view3d_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_view3d_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_VIEW3D_TYPES_H__
33 #define __DNA_VIEW3D_TYPES_H__
34
35 struct ViewDepths;
36 struct Object;
37 struct Image;
38 struct SpaceLink;
39 struct BoundBox;
40 struct MovieClip;
41 struct MovieClipUser;
42 struct RenderEngine;
43 struct bGPdata;
44 struct SmoothView3DStore;
45 struct wmTimer;
46 struct Material;
47 struct GPUFX;
48 struct GPUViewport;
49
50 /* This is needed to not let VC choke on near and far... old
51  * proprietary MS extensions... */
52 #ifdef WIN32
53 #undef near
54 #undef far
55 #define near clipsta
56 #define far clipend
57 #endif
58
59 #include "DNA_defs.h"
60 #include "DNA_listBase.h"
61 #include "DNA_image_types.h"
62 #include "DNA_movieclip_types.h"
63 #include "DNA_gpu_types.h"
64
65 /* ******************************** */
66
67 /* The near/far thing is a Win EXCEPTION. Thus, leave near/far in the
68  * code, and patch for windows. */
69
70 typedef struct View3DDebug {
71         float znear, zfar;
72         char background;
73         char pad[7];
74 } View3DDebug;
75
76 /* ********************************* */
77
78 typedef struct RegionView3D {
79         
80         float winmat[4][4];                     /* GL_PROJECTION matrix */
81         float viewmat[4][4];            /* GL_MODELVIEW matrix */
82         float viewinv[4][4];            /* inverse of viewmat */
83         float persmat[4][4];            /* viewmat*winmat */
84         float persinv[4][4];            /* inverse of persmat */
85         float viewcamtexcofac[4];       /* offset/scale for camera glsl texcoords */
86
87         /* viewmat/persmat multiplied with object matrix, while drawing and selection */
88         float viewmatob[4][4];
89         float persmatob[4][4];
90
91         /* user defined clipping planes */
92         float clip[6][4];
93         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
94         struct BoundBox *clipbb;
95
96         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
97         struct RenderEngine *render_engine;
98         struct ViewDepths *depths;
99         void *gpuoffscreen;
100
101         /* animated smooth view */
102         struct SmoothView3DStore *sms;
103         struct wmTimer *smooth_timer;
104
105
106         /* transform manipulator matrix */
107         float twmat[4][4];
108         /* min/max dot product on twmat xyz axis. */
109         float tw_axis_min[3], tw_axis_max[3];
110         float tw_axis_matrix[3][3];
111         char _pad[4];
112
113         float viewquat[4];                      /* view rotation, must be kept normalized */
114         float dist;                                     /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */
115         float camdx, camdy;                     /* camera view offsets, 1.0 = viewplane moves entire width/height */
116         float pixsize;                          /* runtime only */
117         float ofs[3];                           /* view center & orbit pivot, negative of worldspace location,
118                                                                  * also matches -viewinv[3][0:3] in ortho mode.*/
119         float camzoom;                          /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */
120         char is_persp;                          /* check if persp/ortho view, since 'persp' cant be used for this since
121                                                                  * it can have cameras assigned as well. (only set in view3d_winmatrix_set) */
122         char persp;
123         char view;
124         char viewlock;
125         char viewlock_quad;                     /* options for quadview (store while out of quad view) */
126         char pad[3];
127         float ofs_lock[2];                      /* normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right */
128
129         short twdrawflag; /* XXX can easily get rid of this (Julian) */
130         short rflag;
131
132
133         /* last view (use when switching out of camera view) */
134         float lviewquat[4];
135         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
136
137         float gridview;
138         float tw_idot[3];  /* manipulator runtime: (1 - dot) product with view vector (used to check view alignment) */
139
140
141         /* active rotation from NDOF or elsewhere */
142         float rot_angle;
143         float rot_axis[3];
144
145         struct GPUFX *compositor;
146         struct GPUViewport *viewport;
147 } RegionView3D;
148
149 /* 3D ViewPort Struct */
150 typedef struct View3D {
151         struct SpaceLink *next, *prev;
152         ListBase regionbase;            /* storage of regions for inactive spaces */
153         int spacetype;
154         float blockscale;
155         short blockhandler[8];
156
157         float viewquat[4]  DNA_DEPRECATED;
158         float dist         DNA_DEPRECATED;
159
160         float bundle_size;                      /* size of bundles in reconstructed data */
161         char bundle_drawtype;           /* display style for bundle */
162         char pad[3];
163
164         unsigned int lay_prev; /* for active layer toggle */
165         unsigned int lay_used; /* used while drawing */
166         
167         short persp  DNA_DEPRECATED;
168         short view   DNA_DEPRECATED;
169         
170         struct Object *camera, *ob_centre;
171         rctf render_border;
172
173         struct View3D *localvd; /* allocated backup of its self while in localview */
174         
175         char ob_centre_bone[64];                /* optional string for armature bone to define center, MAXBONENAME */
176         
177         unsigned int lay;
178         int layact;
179         
180         /**
181          * The drawing mode for the 3d display. Set to OB_BOUNDBOX, OB_WIRE, OB_SOLID,
182          * OB_TEXTURE, OB_MATERIAL or OB_RENDER */
183         short drawtype;
184         short ob_centre_cursor;         /* optional bool for 3d cursor to define center */
185         short scenelock, around;
186         short flag, flag2;
187         
188         float lens, grid;
189         float near, far;
190         float ofs[3]  DNA_DEPRECATED;                   /* XXX deprecated */
191         float cursor[3];
192
193         short matcap_icon;                      /* icon id */
194
195         short gridlines;
196         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
197         char gridflag;
198
199         /* transform manipulator info */
200         char twtype, twmode, twflag;
201         
202         short flag3;
203         
204         /* afterdraw, for xray & transparent */
205         struct ListBase afterdraw_transp;
206         struct ListBase afterdraw_xray;
207         struct ListBase afterdraw_xraytransp;
208
209         /* drawflags, denoting state */
210         char zbuf, transp, xray;
211
212         char multiview_eye;                             /* multiview current eye - for internal use */
213
214         /* The active custom transform orientation of this 3D view. */
215         short custom_orientation_index;
216         char pad3[2];
217
218         /* note, 'fx_settings.dof' is currently _not_ allocated,
219          * instead set (temporarily) from camera */
220         struct GPUFXSettings fx_settings;
221
222         void *properties_storage;               /* Nkey panel stores stuff here (runtime only!) */
223         /* Allocated per view, not library data (used by matcap). */
224         struct Material *defmaterial;
225
226         /* XXX deprecated? */
227         struct bGPdata *gpd  DNA_DEPRECATED;            /* Grease-Pencil Data (annotation layers) */
228
229          /* multiview - stereo 3d */
230         short stereo3d_flag;
231         char stereo3d_camera;
232         char pad4;
233         float stereo3d_convergence_factor;
234         float stereo3d_volume_alpha;
235         float stereo3d_convergence_alpha;
236
237         /* Previous viewport draw type.
238          * Runtime-only, set in the rendered viewport toggle operator.
239          */
240         short prev_drawtype;
241         /* drawtype subtype (visibility) used when drawtype == OB_WIRE */
242         short drawtype_wireframe;
243         /* drawtype subtype (lighting) used when drawtype == OB_SOLID */
244         short drawtype_solid;
245         /* drawtype subtype (lighting) used when drawtype == OB_TEXTURE */
246         short drawtype_texture;
247         View3DDebug debug;
248 } View3D;
249
250
251 /* View3D->stereo_flag (short) */
252 #define V3D_S3D_DISPCAMERAS             (1 << 0)
253 #define V3D_S3D_DISPPLANE               (1 << 1)
254 #define V3D_S3D_DISPVOLUME              (1 << 2)
255
256 /* View3D->flag (short) */
257 /*#define V3D_DISPIMAGE         1*/ /*UNUSED*/
258 /*#define V3D_DISPBGPICS                2*/ /* UNUSED */
259 #define V3D_HIDE_HELPLINES      4
260 #define V3D_INVALID_BACKBUF     8
261
262 #define V3D_ALIGN                       1024
263 #define V3D_SELECT_OUTLINE      2048
264 #define V3D_ZBUF_SELECT         4096
265 #define V3D_GLOBAL_STATS        8192
266 #define V3D_DRAW_CENTERS        32768
267
268 /* RegionView3d->persp */
269 #define RV3D_ORTHO                              0
270 #define RV3D_PERSP                              1
271 #define RV3D_CAMOB                              2
272
273 /* RegionView3d->rflag */
274 #define RV3D_CLIPPING                           4
275 #define RV3D_NAVIGATING                         8
276 #define RV3D_GPULIGHT_UPDATE            16
277 /*#define RV3D_IS_GAME_ENGINE                   32 *//* UNUSED */
278 /**
279  * Disable zbuffer offset, skip calls to #ED_view3d_polygon_offset.
280  * Use when precise surface depth is needed and picking bias isn't, see T45434).
281  */
282 #define RV3D_ZOFFSET_DISABLED           64
283
284 /* RegionView3d->viewlock */
285 #define RV3D_LOCKED                     (1 << 0)
286 #define RV3D_BOXVIEW            (1 << 1)
287 #define RV3D_BOXCLIP            (1 << 2)
288 /* RegionView3d->viewlock_quad */
289 #define RV3D_VIEWLOCK_INIT      (1 << 7)
290
291 /* RegionView3d->view */
292 #define RV3D_VIEW_USER                   0
293 #define RV3D_VIEW_FRONT                  1
294 #define RV3D_VIEW_BACK                   2
295 #define RV3D_VIEW_LEFT                   3
296 #define RV3D_VIEW_RIGHT                  4
297 #define RV3D_VIEW_TOP                    5
298 #define RV3D_VIEW_BOTTOM                 6
299 #define RV3D_VIEW_CAMERA                 8
300
301 #define RV3D_VIEW_IS_AXIS(view) \
302         (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
303
304 /* View3d->flag2 (short) */
305 #define V3D_RENDER_OVERRIDE             (1 << 2)
306 #define V3D_SOLID_TEX                   (1 << 3)
307 #define V3D_SHOW_GPENCIL                (1 << 4)
308 #define V3D_LOCK_CAMERA                 (1 << 5)
309 #define V3D_RENDER_SHADOW               (1 << 6)                /* This is a runtime only flag that's used to tell draw_mesh_object() that we're doing a shadow pass instead of a regular draw */
310 #define V3D_SHOW_RECONSTRUCTION (1 << 7)
311 #define V3D_SHOW_CAMERAPATH             (1 << 8)
312 #define V3D_SHOW_BUNDLENAME             (1 << 9)
313 #define V3D_BACKFACE_CULLING    (1 << 10)
314 #define V3D_RENDER_BORDER               (1 << 11)
315 #define V3D_SOLID_MATCAP                (1 << 12)       /* user flag */
316 #define V3D_SHOW_SOLID_MATCAP   (1 << 13)       /* runtime flag */
317 #define V3D_OCCLUDE_WIRE                (1 << 14)
318 #define V3D_SHOW_MODE_SHADE_OVERRIDE    (1 << 15)
319
320
321 /* View3d->flag3 (short) */
322 #define V3D_SHOW_WORLD                  (1 << 0)
323
324 /* View3d->debug.background */
325 enum {
326         V3D_DEBUG_BACKGROUND_NONE     = (1 << 0),
327         V3D_DEBUG_BACKGROUND_GRADIENT = (1 << 1),
328         V3D_DEBUG_BACKGROUND_WORLD    = (1 << 2),
329 };
330
331 /* View3D->around */
332 enum {
333         /* center of the bounding box */
334         V3D_AROUND_CENTER_BOUNDS        = 0,
335         /* center from the sum of all points divided by the total */
336         V3D_AROUND_CENTER_MEAN          = 3,
337         /* pivot around the 2D/3D cursor */
338         V3D_AROUND_CURSOR                       = 1,
339         /* pivot around each items own origin */
340         V3D_AROUND_LOCAL_ORIGINS        = 2,
341         /* pivot around the active items origin */
342         V3D_AROUND_ACTIVE                       = 4,
343 };
344
345 /*View3D types (only used in tools, not actually saved)*/
346 #define V3D_VIEW_STEPLEFT                1
347 #define V3D_VIEW_STEPRIGHT               2
348 #define V3D_VIEW_STEPDOWN                3
349 #define V3D_VIEW_STEPUP          4
350 #define V3D_VIEW_PANLEFT                 5
351 #define V3D_VIEW_PANRIGHT                6
352 #define V3D_VIEW_PANDOWN                 7
353 #define V3D_VIEW_PANUP                   8
354
355 /* View3d->gridflag */
356 #define V3D_SHOW_FLOOR                  1
357 #define V3D_SHOW_X                              2
358 #define V3D_SHOW_Y                              4
359 #define V3D_SHOW_Z                              8
360
361 /* View3d->twtype (bits, we can combine them) */
362 #define V3D_MANIP_TRANSLATE             1
363 #define V3D_MANIP_ROTATE                2
364 #define V3D_MANIP_SCALE                 4
365
366 /* View3d->twmode */
367 #define V3D_MANIP_GLOBAL                0
368 #define V3D_MANIP_LOCAL                 1
369 #define V3D_MANIP_NORMAL                2
370 #define V3D_MANIP_VIEW                  3
371 #define V3D_MANIP_GIMBAL                4
372 #define V3D_MANIP_CUSTOM                5
373
374 /* View3d->twflag (also) */
375 enum {
376         V3D_MANIPULATOR_DRAW        = (1 << 0),
377 };
378
379 #define RV3D_CAMZOOM_MIN -30
380 #define RV3D_CAMZOOM_MAX 600
381
382 /* #BKE_screen_view3d_zoom_to_fac() values above */
383 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
384 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
385
386 #endif
387