Workbench: Option to use Object color
[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_OBJECT_COLOR_COLLECTION = 0,
85         V3D_OBJECT_COLOR_OBJECT     = 1,
86 };
87
88 typedef struct RegionView3D {
89         
90         float winmat[4][4];                     /* GL_PROJECTION matrix */
91         float viewmat[4][4];            /* GL_MODELVIEW matrix */
92         float viewinv[4][4];            /* inverse of viewmat */
93         float persmat[4][4];            /* viewmat*winmat */
94         float persinv[4][4];            /* inverse of persmat */
95         float viewcamtexcofac[4];       /* offset/scale for camera glsl texcoords */
96
97         /* viewmat/persmat multiplied with object matrix, while drawing and selection */
98         float viewmatob[4][4];
99         float persmatob[4][4];
100
101         /* user defined clipping planes */
102         float clip[6][4];
103         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
104         struct BoundBox *clipbb;
105
106         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
107         struct RenderEngine *render_engine;
108         struct ViewDepths *depths;
109         void *gpuoffscreen;
110
111         /* animated smooth view */
112         struct SmoothView3DStore *sms;
113         struct wmTimer *smooth_timer;
114
115
116         /* transform manipulator matrix */
117         float twmat[4][4];
118         /* min/max dot product on twmat xyz axis. */
119         float tw_axis_min[3], tw_axis_max[3];
120         float tw_axis_matrix[3][3];
121         char _pad[4];
122
123         float viewquat[4];                      /* view rotation, must be kept normalized */
124         float dist;                                     /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */
125         float camdx, camdy;                     /* camera view offsets, 1.0 = viewplane moves entire width/height */
126         float pixsize;                          /* runtime only */
127         float ofs[3];                           /* view center & orbit pivot, negative of worldspace location,
128                                                                  * also matches -viewinv[3][0:3] in ortho mode.*/
129         float camzoom;                          /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */
130         char is_persp;                          /* check if persp/ortho view, since 'persp' cant be used for this since
131                                                                  * it can have cameras assigned as well. (only set in view3d_winmatrix_set) */
132         char persp;
133         char view;
134         char viewlock;
135         char viewlock_quad;                     /* options for quadview (store while out of quad view) */
136         char pad[3];
137         float ofs_lock[2];                      /* normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right */
138
139         short twdrawflag; /* XXX can easily get rid of this (Julian) */
140         short rflag;
141
142
143         /* last view (use when switching out of camera view) */
144         float lviewquat[4];
145         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
146
147         float gridview;
148         float tw_idot[3];  /* manipulator runtime: (1 - dot) product with view vector (used to check view alignment) */
149
150
151         /* active rotation from NDOF or elsewhere */
152         float rot_angle;
153         float rot_axis[3];
154
155         struct GPUFX *compositor;
156         struct GPUViewport *viewport;
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 subtype (visibility) used when drawtype == OB_WIRE */
250         short drawtype_wireframe;
251         /* drawtype subtype (lighting) used when drawtype == OB_SOLID */
252         short drawtype_solid;
253         /* drawtype subtype (lighting) used when drawtype == OB_TEXTURE */
254         short drawtype_texture;
255         View3DDebug debug;
256 } View3D;
257
258
259 /* View3D->stereo_flag (short) */
260 #define V3D_S3D_DISPCAMERAS             (1 << 0)
261 #define V3D_S3D_DISPPLANE               (1 << 1)
262 #define V3D_S3D_DISPVOLUME              (1 << 2)
263
264 /* View3D->flag (short) */
265 /*#define V3D_DISPIMAGE         1*/ /*UNUSED*/
266 /*#define V3D_DISPBGPICS                2*/ /* UNUSED */
267 #define V3D_HIDE_HELPLINES      4
268 #define V3D_INVALID_BACKBUF     8
269
270 #define V3D_ALIGN                       1024
271 #define V3D_SELECT_OUTLINE      2048
272 #define V3D_ZBUF_SELECT         4096
273 #define V3D_GLOBAL_STATS        8192
274 #define V3D_DRAW_CENTERS        32768
275
276 /* RegionView3d->persp */
277 #define RV3D_ORTHO                              0
278 #define RV3D_PERSP                              1
279 #define RV3D_CAMOB                              2
280
281 /* RegionView3d->rflag */
282 #define RV3D_CLIPPING                           4
283 #define RV3D_NAVIGATING                         8
284 #define RV3D_GPULIGHT_UPDATE            16
285 /*#define RV3D_IS_GAME_ENGINE                   32 *//* UNUSED */
286 /**
287  * Disable zbuffer offset, skip calls to #ED_view3d_polygon_offset.
288  * Use when precise surface depth is needed and picking bias isn't, see T45434).
289  */
290 #define RV3D_ZOFFSET_DISABLED           64
291
292 /* RegionView3d->viewlock */
293 #define RV3D_LOCKED                     (1 << 0)
294 #define RV3D_BOXVIEW            (1 << 1)
295 #define RV3D_BOXCLIP            (1 << 2)
296 /* RegionView3d->viewlock_quad */
297 #define RV3D_VIEWLOCK_INIT      (1 << 7)
298
299 /* RegionView3d->view */
300 #define RV3D_VIEW_USER                   0
301 #define RV3D_VIEW_FRONT                  1
302 #define RV3D_VIEW_BACK                   2
303 #define RV3D_VIEW_LEFT                   3
304 #define RV3D_VIEW_RIGHT                  4
305 #define RV3D_VIEW_TOP                    5
306 #define RV3D_VIEW_BOTTOM                 6
307 #define RV3D_VIEW_CAMERA                 8
308
309 #define RV3D_VIEW_IS_AXIS(view) \
310         (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
311
312 /* View3d->flag2 (short) */
313 #define V3D_RENDER_OVERRIDE             (1 << 2)
314 #define V3D_SOLID_TEX                   (1 << 3)
315 #define V3D_SHOW_GPENCIL                (1 << 4)
316 #define V3D_LOCK_CAMERA                 (1 << 5)
317 #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 */
318 #define V3D_SHOW_RECONSTRUCTION (1 << 7)
319 #define V3D_SHOW_CAMERAPATH             (1 << 8)
320 #define V3D_SHOW_BUNDLENAME             (1 << 9)
321 #define V3D_BACKFACE_CULLING    (1 << 10)
322 #define V3D_RENDER_BORDER               (1 << 11)
323 #define V3D_SOLID_MATCAP                (1 << 12)       /* user flag */
324 #define V3D_SHOW_SOLID_MATCAP   (1 << 13)       /* runtime flag */
325 #define V3D_OCCLUDE_WIRE                (1 << 14)
326 #define V3D_SHOW_MODE_SHADE_OVERRIDE    (1 << 15)
327
328
329 /* View3d->flag3 (short) */
330 #define V3D_SHOW_WORLD                  (1 << 0)
331
332 /* View3d->debug.background */
333 enum {
334         V3D_DEBUG_BACKGROUND_NONE     = (1 << 0),
335         V3D_DEBUG_BACKGROUND_GRADIENT = (1 << 1),
336         V3D_DEBUG_BACKGROUND_WORLD    = (1 << 2),
337 };
338
339 /* View3D->around */
340 enum {
341         /* center of the bounding box */
342         V3D_AROUND_CENTER_BOUNDS        = 0,
343         /* center from the sum of all points divided by the total */
344         V3D_AROUND_CENTER_MEAN          = 3,
345         /* pivot around the 2D/3D cursor */
346         V3D_AROUND_CURSOR                       = 1,
347         /* pivot around each items own origin */
348         V3D_AROUND_LOCAL_ORIGINS        = 2,
349         /* pivot around the active items origin */
350         V3D_AROUND_ACTIVE                       = 4,
351 };
352
353 /*View3D types (only used in tools, not actually saved)*/
354 #define V3D_VIEW_STEPLEFT                1
355 #define V3D_VIEW_STEPRIGHT               2
356 #define V3D_VIEW_STEPDOWN                3
357 #define V3D_VIEW_STEPUP          4
358 #define V3D_VIEW_PANLEFT                 5
359 #define V3D_VIEW_PANRIGHT                6
360 #define V3D_VIEW_PANDOWN                 7
361 #define V3D_VIEW_PANUP                   8
362
363 /* View3d->gridflag */
364 #define V3D_SHOW_FLOOR                  1
365 #define V3D_SHOW_X                              2
366 #define V3D_SHOW_Y                              4
367 #define V3D_SHOW_Z                              8
368
369 /* View3d->twtype (bits, we can combine them) */
370 #define V3D_MANIP_TRANSLATE             1
371 #define V3D_MANIP_ROTATE                2
372 #define V3D_MANIP_SCALE                 4
373
374 /* Scene.orientation_type */
375 #define V3D_MANIP_GLOBAL                0
376 #define V3D_MANIP_LOCAL                 1
377 #define V3D_MANIP_NORMAL                2
378 #define V3D_MANIP_VIEW                  3
379 #define V3D_MANIP_GIMBAL                4
380 #define V3D_MANIP_CUSTOM                5
381
382 /* View3d->twflag (also) */
383 enum {
384         V3D_MANIPULATOR_DRAW        = (1 << 0),
385 };
386
387 #define RV3D_CAMZOOM_MIN -30
388 #define RV3D_CAMZOOM_MAX 600
389
390 /* #BKE_screen_view3d_zoom_to_fac() values above */
391 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
392 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
393
394 #endif
395