Merge branch 'master' into blender2.8
[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 GPUViewport;
48
49 #include "DNA_defs.h"
50 #include "DNA_listBase.h"
51 #include "DNA_image_types.h"
52 #include "DNA_movieclip_types.h"
53 #include "DNA_gpu_types.h"
54
55 /* ******************************** */
56
57 /* The near/far thing is a Win EXCEPTION, caused by indirect includes from <windows.h>.
58  * Thus, leave near/far in the code, and undef for windows. */
59 #ifdef _WIN32
60 #  undef near
61 #  undef far
62 #endif
63
64 typedef struct RegionView3D {
65         
66         float winmat[4][4];                     /* GL_PROJECTION matrix */
67         float viewmat[4][4];            /* GL_MODELVIEW matrix */
68         float viewinv[4][4];            /* inverse of viewmat */
69         float persmat[4][4];            /* viewmat*winmat */
70         float persinv[4][4];            /* inverse of persmat */
71         float viewcamtexcofac[4];       /* offset/scale for camera glsl texcoords */
72
73         /* viewmat/persmat multiplied with object matrix, while drawing and selection */
74         float viewmatob[4][4];
75         float persmatob[4][4];
76
77         /* user defined clipping planes */
78         float clip[6][4];
79         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
80         struct BoundBox *clipbb;
81
82         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
83         struct RenderEngine *render_engine;
84         struct ViewDepths *depths;
85         void *gpuoffscreen;
86
87         /* animated smooth view */
88         struct SmoothView3DStore *sms;
89         struct wmTimer *smooth_timer;
90
91
92         /* transform manipulator matrix */
93         float twmat[4][4];
94         /* min/max dot product on twmat xyz axis. */
95         float tw_axis_min[3], tw_axis_max[3];
96         float tw_axis_matrix[3][3];
97
98         float gridview;
99
100         float viewquat[4];                      /* view rotation, must be kept normalized */
101         float dist;                                     /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */
102         float camdx, camdy;                     /* camera view offsets, 1.0 = viewplane moves entire width/height */
103         float pixsize;                          /* runtime only */
104         float ofs[3];                           /* view center & orbit pivot, negative of worldspace location,
105                                                                  * also matches -viewinv[3][0:3] in ortho mode.*/
106         float camzoom;                          /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */
107         char is_persp;                          /* check if persp/ortho view, since 'persp' cant be used for this since
108                                                                  * it can have cameras assigned as well. (only set in view3d_winmatrix_set) */
109         char persp;
110         char view;
111         char viewlock;
112         char viewlock_quad;                     /* options for quadview (store while out of quad view) */
113         char pad[3];
114         float ofs_lock[2];                      /* normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right */
115
116         short twdrawflag; /* XXX can easily get rid of this (Julian) */
117         short rflag;
118
119
120         /* last view (use when switching out of camera view) */
121         float lviewquat[4];
122         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
123
124         /* active rotation from NDOF or elsewhere */
125         float rot_angle;
126         float rot_axis[3];
127 } RegionView3D;
128
129 typedef struct View3DCursor {
130         float location[3];
131         float rotation[4];
132         char _pad[4];
133 } View3DCursor;
134
135 /* 3D Viewport Shading setings */
136 typedef struct View3DShading {
137         short flag;
138         short color_type;
139
140         short light;
141         char pad[2];
142         char studio_light[256]; /* FILE_MAXFILE */
143
144         float shadow_intensity;
145         float single_color[3];
146
147         float studiolight_rot_z;
148         float studiolight_background;
149
150         float object_outline_color[3];
151         float xray_alpha;
152 } View3DShading;
153
154 /* 3D Viewport Overlay setings */
155 typedef struct View3DOverlay {
156         int flag;
157
158         /* Edit mode settings */
159         int edit_flag;
160         float normals_length;
161         float backwire_opacity;
162
163         /* Paint mode settings */
164         int paint_flag;
165
166         /* Armature edit/pose mode settings */
167         int arm_flag;
168 } View3DOverlay;
169
170 /* 3D ViewPort Struct */
171 typedef struct View3D {
172         struct SpaceLink *next, *prev;
173         ListBase regionbase;            /* storage of regions for inactive spaces */
174         char spacetype;
175         char link_flag;
176         char _pad0[6];
177         /* End 'SpaceLink' header. */
178
179         float viewquat[4]  DNA_DEPRECATED;
180         float dist         DNA_DEPRECATED;
181
182         float bundle_size;                      /* size of bundles in reconstructed data */
183         char bundle_drawtype;           /* display style for bundle */
184         char pad[3];
185
186         unsigned int lay_prev; /* for active layer toggle */
187         unsigned int lay_used; /* used while drawing */
188         
189         short persp  DNA_DEPRECATED;
190         short view   DNA_DEPRECATED;
191         
192         struct Object *camera, *ob_centre;
193         rctf render_border;
194
195         struct View3D *localvd; /* allocated backup of its self while in localview */
196         
197         char ob_centre_bone[64];                /* optional string for armature bone to define center, MAXBONENAME */
198         
199         unsigned int lay;
200         int layact;
201         
202         short ob_centre_cursor;         /* optional bool for 3d cursor to define center */
203         short scenelock, _pad1;
204         short flag, flag2, pad2;
205         
206         float lens, grid;
207         float near, far;
208         float ofs[3]  DNA_DEPRECATED;                   /* XXX deprecated */
209
210         View3DCursor cursor;
211
212         char _pad[4];
213
214         short matcap_icon;                      /* icon id */
215
216         short gridlines;
217         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
218         char gridflag;
219
220         /* transform manipulator info */
221         char twtype, _pad5, twflag;
222         
223         short flag3;
224
225         /* drawflags, denoting state */
226         char zbuf, transp, xray;
227
228         char multiview_eye;                             /* multiview current eye - for internal use */
229
230         char pad3[4];
231
232         /* note, 'fx_settings.dof' is currently _not_ allocated,
233          * instead set (temporarily) from camera */
234         struct GPUFXSettings fx_settings;
235
236         void *properties_storage;               /* Nkey panel stores stuff here (runtime only!) */
237
238         /* XXX deprecated? */
239         struct bGPdata *gpd  DNA_DEPRECATED;            /* Grease-Pencil Data (annotation layers) */
240
241         /* Stereoscopy settings */
242         short stereo3d_flag;
243         char stereo3d_camera;
244         char pad4;
245         float stereo3d_convergence_factor;
246         float stereo3d_volume_alpha;
247         float stereo3d_convergence_alpha;
248
249         /* Display settings */
250         short drawtype;         /* Shading mode (OB_SOLID, OB_TEXTURE, ..) */
251         short prev_drawtype;    /* Runtime, for toggle between rendered viewport. */
252         int pad5;
253
254         View3DShading shading;
255         View3DOverlay overlay;
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_FLAG_DEPRECATED_1 (1 << 0) */ /*UNUSED */
266 /*#define V3D_FLAG_DEPRECATED_2 (1 << 1) */ /* UNUSED */
267 #define V3D_HIDE_HELPLINES      4
268 #define V3D_INVALID_BACKBUF     8
269
270 /* #define V3D_FLAG_DEPRECATED_10 (1 << 10) */ /* UNUSED */
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 /* View3DShading->light */
333 enum {
334         V3D_LIGHTING_FLAT   = 0,
335         V3D_LIGHTING_STUDIO = 1,
336         V3D_LIGHTING_SCENE  = 2
337 };
338
339 /* View3DShading->flag */
340 enum {
341         V3D_SHADING_OBJECT_OUTLINE      = (1 << 0),
342         V3D_SHADING_XRAY                = (1 << 1),
343         V3D_SHADING_SHADOW              = (1 << 2),
344         V3D_SHADING_SCENE_LIGHT         = (1 << 3),
345         V3D_SHADING_SPECULAR_HIGHLIGHT  = (1 << 4),
346 };
347
348 /* View3DShading->single_color_type */
349 enum {
350         V3D_SHADING_MATERIAL_COLOR = 0,
351         V3D_SHADING_RANDOM_COLOR   = 1,
352         V3D_SHADING_SINGLE_COLOR   = 2,
353 };
354
355 /* View3DOverlay->flag */
356 enum {
357         V3D_OVERLAY_FACE_ORIENTATION  = (1 << 0),
358         V3D_OVERLAY_HIDE_CURSOR       = (1 << 1),
359         V3D_OVERLAY_BONE_SELECTION    = (1 << 2),
360         V3D_OVERLAY_LOOK_DEV          = (1 << 3),
361         V3D_OVERLAY_WIREFRAMES        = (1 << 4),
362         V3D_OVERLAY_HIDE_TEXT         = (1 << 5),
363         V3D_OVERLAY_HIDE_MOTION_PATHS = (1 << 6),
364 };
365
366 /* View3DOverlay->edit_flag */
367 enum {
368         V3D_OVERLAY_EDIT_VERT_NORMALS = (1 << 0),
369         V3D_OVERLAY_EDIT_LOOP_NORMALS = (1 << 1),
370         V3D_OVERLAY_EDIT_FACE_NORMALS = (1 << 2),
371
372         V3D_OVERLAY_EDIT_OCCLUDE_WIRE = (1 << 3),
373
374         V3D_OVERLAY_EDIT_WEIGHT       = (1 << 4),
375 };
376
377 /* View3DOverlay->arm_flag */
378 enum {
379         V3D_OVERLAY_ARM_TRANSP_BONES  = (1 << 0),
380 };
381
382 /* View3DOverlay->paint_flag */
383 enum {
384         V3D_OVERLAY_PAINT_WIRE        = (1 << 0),
385 };
386
387 /* View3D->around */
388 enum {
389         /* center of the bounding box */
390         V3D_AROUND_CENTER_BOUNDS        = 0,
391         /* center from the sum of all points divided by the total */
392         V3D_AROUND_CENTER_MEAN          = 3,
393         /* pivot around the 2D/3D cursor */
394         V3D_AROUND_CURSOR                       = 1,
395         /* pivot around each items own origin */
396         V3D_AROUND_LOCAL_ORIGINS        = 2,
397         /* pivot around the active items origin */
398         V3D_AROUND_ACTIVE                       = 4,
399 };
400
401 /*View3D types (only used in tools, not actually saved)*/
402 #define V3D_VIEW_STEPLEFT                1
403 #define V3D_VIEW_STEPRIGHT               2
404 #define V3D_VIEW_STEPDOWN                3
405 #define V3D_VIEW_STEPUP          4
406 #define V3D_VIEW_PANLEFT                 5
407 #define V3D_VIEW_PANRIGHT                6
408 #define V3D_VIEW_PANDOWN                 7
409 #define V3D_VIEW_PANUP                   8
410
411 /* View3d->gridflag */
412 #define V3D_SHOW_FLOOR                  1
413 #define V3D_SHOW_X                              2
414 #define V3D_SHOW_Y                              4
415 #define V3D_SHOW_Z                              8
416
417 /* Scene.orientation_type */
418 #define V3D_MANIP_GLOBAL                0
419 #define V3D_MANIP_LOCAL                 1
420 #define V3D_MANIP_NORMAL                2
421 #define V3D_MANIP_VIEW                  3
422 #define V3D_MANIP_GIMBAL                4
423 #define V3D_MANIP_CURSOR                5
424 #define V3D_MANIP_CUSTOM                1024
425
426 /* View3d->twflag (also) */
427 enum {
428         V3D_MANIPULATOR_DRAW        = (1 << 0),
429 };
430
431 #define RV3D_CAMZOOM_MIN -30
432 #define RV3D_CAMZOOM_MAX 600
433
434 /* #BKE_screen_view3d_zoom_to_fac() values above */
435 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
436 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
437
438 #endif
439