313997082c712ec193d5abaacf491822320be999
[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 enum {
78         V3D_LIGHTING_FLAT   = 0,
79         V3D_LIGHTING_STUDIO = 1,
80         V3D_LIGHTING_SCENE  = 2
81 };
82
83 enum {
84         V3D_DRAWOPTION_RANDOMIZE = (1 << 0),
85         V3D_DRAWOPTION_OBJECT_OVERLAP   = (2 << 0),
86 };
87
88 enum {
89         V3D_OVERLAY_FACE_ORIENTATION = (1 << 0),
90 };
91
92 typedef struct RegionView3D {
93         
94         float winmat[4][4];                     /* GL_PROJECTION matrix */
95         float viewmat[4][4];            /* GL_MODELVIEW matrix */
96         float viewinv[4][4];            /* inverse of viewmat */
97         float persmat[4][4];            /* viewmat*winmat */
98         float persinv[4][4];            /* inverse of persmat */
99         float viewcamtexcofac[4];       /* offset/scale for camera glsl texcoords */
100
101         /* viewmat/persmat multiplied with object matrix, while drawing and selection */
102         float viewmatob[4][4];
103         float persmatob[4][4];
104
105         /* user defined clipping planes */
106         float clip[6][4];
107         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
108         struct BoundBox *clipbb;
109
110         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
111         struct RenderEngine *render_engine;
112         struct ViewDepths *depths;
113         void *gpuoffscreen;
114
115         /* animated smooth view */
116         struct SmoothView3DStore *sms;
117         struct wmTimer *smooth_timer;
118
119
120         /* transform manipulator matrix */
121         float twmat[4][4];
122         /* min/max dot product on twmat xyz axis. */
123         float tw_axis_min[3], tw_axis_max[3];
124         float tw_axis_matrix[3][3];
125
126         float gridview;
127
128         float viewquat[4];                      /* view rotation, must be kept normalized */
129         float dist;                                     /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */
130         float camdx, camdy;                     /* camera view offsets, 1.0 = viewplane moves entire width/height */
131         float pixsize;                          /* runtime only */
132         float ofs[3];                           /* view center & orbit pivot, negative of worldspace location,
133                                                                  * also matches -viewinv[3][0:3] in ortho mode.*/
134         float camzoom;                          /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */
135         char is_persp;                          /* check if persp/ortho view, since 'persp' cant be used for this since
136                                                                  * it can have cameras assigned as well. (only set in view3d_winmatrix_set) */
137         char persp;
138         char view;
139         char viewlock;
140         char viewlock_quad;                     /* options for quadview (store while out of quad view) */
141         char pad[3];
142         float ofs_lock[2];                      /* normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right */
143
144         short twdrawflag; /* XXX can easily get rid of this (Julian) */
145         short rflag;
146
147
148         /* last view (use when switching out of camera view) */
149         float lviewquat[4];
150         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
151
152         /* active rotation from NDOF or elsewhere */
153         float rot_angle;
154         float rot_axis[3];
155
156         struct GPUFX *compositor;
157 } RegionView3D;
158
159 /* 3D ViewPort Struct */
160 typedef struct View3D {
161         struct SpaceLink *next, *prev;
162         ListBase regionbase;            /* storage of regions for inactive spaces */
163         int spacetype;
164         float blockscale;
165         short blockhandler[8];
166
167         float viewquat[4]  DNA_DEPRECATED;
168         float dist         DNA_DEPRECATED;
169
170         float bundle_size;                      /* size of bundles in reconstructed data */
171         char bundle_drawtype;           /* display style for bundle */
172         char pad[3];
173
174         unsigned int lay_prev; /* for active layer toggle */
175         unsigned int lay_used; /* used while drawing */
176         
177         short persp  DNA_DEPRECATED;
178         short view   DNA_DEPRECATED;
179         
180         struct Object *camera, *ob_centre;
181         rctf render_border;
182
183         struct View3D *localvd; /* allocated backup of its self while in localview */
184         
185         char ob_centre_bone[64];                /* optional string for armature bone to define center, MAXBONENAME */
186         
187         unsigned int lay;
188         int layact;
189         
190         /**
191          * The drawing mode for the 3d display. Set to OB_BOUNDBOX, OB_WIRE, OB_SOLID,
192          * OB_TEXTURE, OB_MATERIAL or OB_RENDER */
193         short drawtype;
194         short ob_centre_cursor;         /* optional bool for 3d cursor to define center */
195         short scenelock, around;
196         short flag, flag2;
197         
198         float lens, grid;
199         float near, far;
200         float ofs[3]  DNA_DEPRECATED;                   /* XXX deprecated */
201         float cursor[3];
202
203         short matcap_icon;                      /* icon id */
204
205         short gridlines;
206         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
207         char gridflag;
208
209         /* transform manipulator info */
210         char twtype, _pad5, twflag;
211         
212         short flag3;
213
214         /* afterdraw, for xray & transparent */
215         struct ListBase afterdraw_transp;
216         struct ListBase afterdraw_xray;
217         struct ListBase afterdraw_xraytransp;
218
219         /* drawflags, denoting state */
220         char zbuf, transp, xray;
221
222         char multiview_eye;                             /* multiview current eye - for internal use */
223
224         char pad3[4];
225
226         /* note, 'fx_settings.dof' is currently _not_ allocated,
227          * instead set (temporarily) from camera */
228         struct GPUFXSettings fx_settings;
229
230         void *properties_storage;               /* Nkey panel stores stuff here (runtime only!) */
231         /* Allocated per view, not library data (used by matcap). */
232         struct Material *defmaterial;
233
234         /* XXX deprecated? */
235         struct bGPdata *gpd  DNA_DEPRECATED;            /* Grease-Pencil Data (annotation layers) */
236
237          /* multiview - stereo 3d */
238         short stereo3d_flag;
239         char stereo3d_camera;
240         char pad4;
241         float stereo3d_convergence_factor;
242         float stereo3d_volume_alpha;
243         float stereo3d_convergence_alpha;
244
245         /* Previous viewport draw type.
246          * Runtime-only, set in the rendered viewport toggle operator.
247          */
248         short prev_drawtype;
249         /* drawtype options (lighting, random) used for drawtype == OB_SOLID */
250         short drawtype_lighting;
251         short drawtype_options;
252         short pad5;
253
254         int overlays;
255         int pad6;
256
257         View3DDebug debug;
258 } View3D;
259
260
261 /* View3D->stereo_flag (short) */
262 #define V3D_S3D_DISPCAMERAS             (1 << 0)
263 #define V3D_S3D_DISPPLANE               (1 << 1)
264 #define V3D_S3D_DISPVOLUME              (1 << 2)
265
266 /* View3D->flag (short) */
267 /*#define V3D_DISPIMAGE         1*/ /*UNUSED*/
268 /*#define V3D_DISPBGPICS                2*/ /* UNUSED */
269 #define V3D_HIDE_HELPLINES      4
270 #define V3D_INVALID_BACKBUF     8
271
272 #define V3D_ALIGN                       1024
273 #define V3D_SELECT_OUTLINE      2048
274 #define V3D_ZBUF_SELECT         4096
275 #define V3D_GLOBAL_STATS        8192
276 #define V3D_DRAW_CENTERS        32768
277
278 /* RegionView3d->persp */
279 #define RV3D_ORTHO                              0
280 #define RV3D_PERSP                              1
281 #define RV3D_CAMOB                              2
282
283 /* RegionView3d->rflag */
284 #define RV3D_CLIPPING                           4
285 #define RV3D_NAVIGATING                         8
286 #define RV3D_GPULIGHT_UPDATE            16
287 /*#define RV3D_IS_GAME_ENGINE                   32 *//* UNUSED */
288 /**
289  * Disable zbuffer offset, skip calls to #ED_view3d_polygon_offset.
290  * Use when precise surface depth is needed and picking bias isn't, see T45434).
291  */
292 #define RV3D_ZOFFSET_DISABLED           64
293
294 /* RegionView3d->viewlock */
295 #define RV3D_LOCKED                     (1 << 0)
296 #define RV3D_BOXVIEW            (1 << 1)
297 #define RV3D_BOXCLIP            (1 << 2)
298 /* RegionView3d->viewlock_quad */
299 #define RV3D_VIEWLOCK_INIT      (1 << 7)
300
301 /* RegionView3d->view */
302 #define RV3D_VIEW_USER                   0
303 #define RV3D_VIEW_FRONT                  1
304 #define RV3D_VIEW_BACK                   2
305 #define RV3D_VIEW_LEFT                   3
306 #define RV3D_VIEW_RIGHT                  4
307 #define RV3D_VIEW_TOP                    5
308 #define RV3D_VIEW_BOTTOM                 6
309 #define RV3D_VIEW_CAMERA                 8
310
311 #define RV3D_VIEW_IS_AXIS(view) \
312         (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
313
314 /* View3d->flag2 (short) */
315 #define V3D_RENDER_OVERRIDE             (1 << 2)
316 #define V3D_SOLID_TEX                   (1 << 3)
317 #define V3D_SHOW_GPENCIL                (1 << 4)
318 #define V3D_LOCK_CAMERA                 (1 << 5)
319 #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 */
320 #define V3D_SHOW_RECONSTRUCTION (1 << 7)
321 #define V3D_SHOW_CAMERAPATH             (1 << 8)
322 #define V3D_SHOW_BUNDLENAME             (1 << 9)
323 #define V3D_BACKFACE_CULLING    (1 << 10)
324 #define V3D_RENDER_BORDER               (1 << 11)
325 #define V3D_SOLID_MATCAP                (1 << 12)       /* user flag */
326 #define V3D_SHOW_SOLID_MATCAP   (1 << 13)       /* runtime flag */
327 #define V3D_OCCLUDE_WIRE                (1 << 14)
328 #define V3D_SHOW_MODE_SHADE_OVERRIDE    (1 << 15)
329
330
331 /* View3d->flag3 (short) */
332 #define V3D_SHOW_WORLD                  (1 << 0)
333
334 /* View3d->debug.background */
335 enum {
336         V3D_DEBUG_BACKGROUND_NONE     = (1 << 0),
337         V3D_DEBUG_BACKGROUND_GRADIENT = (1 << 1),
338         V3D_DEBUG_BACKGROUND_WORLD    = (1 << 2),
339 };
340
341 /* View3D->around */
342 enum {
343         /* center of the bounding box */
344         V3D_AROUND_CENTER_BOUNDS        = 0,
345         /* center from the sum of all points divided by the total */
346         V3D_AROUND_CENTER_MEAN          = 3,
347         /* pivot around the 2D/3D cursor */
348         V3D_AROUND_CURSOR                       = 1,
349         /* pivot around each items own origin */
350         V3D_AROUND_LOCAL_ORIGINS        = 2,
351         /* pivot around the active items origin */
352         V3D_AROUND_ACTIVE                       = 4,
353 };
354
355 /*View3D types (only used in tools, not actually saved)*/
356 #define V3D_VIEW_STEPLEFT                1
357 #define V3D_VIEW_STEPRIGHT               2
358 #define V3D_VIEW_STEPDOWN                3
359 #define V3D_VIEW_STEPUP          4
360 #define V3D_VIEW_PANLEFT                 5
361 #define V3D_VIEW_PANRIGHT                6
362 #define V3D_VIEW_PANDOWN                 7
363 #define V3D_VIEW_PANUP                   8
364
365 /* View3d->gridflag */
366 #define V3D_SHOW_FLOOR                  1
367 #define V3D_SHOW_X                              2
368 #define V3D_SHOW_Y                              4
369 #define V3D_SHOW_Z                              8
370
371 /* Scene.orientation_type */
372 #define V3D_MANIP_GLOBAL                0
373 #define V3D_MANIP_LOCAL                 1
374 #define V3D_MANIP_NORMAL                2
375 #define V3D_MANIP_VIEW                  3
376 #define V3D_MANIP_GIMBAL                4
377 #define V3D_MANIP_CUSTOM                5
378
379 /* View3d->twflag (also) */
380 enum {
381         V3D_MANIPULATOR_DRAW        = (1 << 0),
382 };
383
384 #define RV3D_CAMZOOM_MIN -30
385 #define RV3D_CAMZOOM_MAX 600
386
387 /* #BKE_screen_view3d_zoom_to_fac() values above */
388 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
389 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
390
391 #endif
392