Merge branch 'blender2.7'
[blender.git] / source / blender / makesdna / DNA_view3d_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  */
23
24 #ifndef __DNA_VIEW3D_TYPES_H__
25 #define __DNA_VIEW3D_TYPES_H__
26
27 struct BoundBox;
28 struct GPUViewport;
29 struct Image;
30 struct Material;
31 struct MovieClip;
32 struct MovieClipUser;
33 struct Object;
34 struct RenderEngine;
35 struct SmoothView3DStore;
36 struct SpaceLink;
37 struct ViewDepths;
38 struct bGPdata;
39 struct wmTimer;
40
41 #include "DNA_defs.h"
42 #include "DNA_listBase.h"
43 #include "DNA_image_types.h"
44 #include "DNA_object_types.h"
45 #include "DNA_movieclip_types.h"
46 #include "DNA_gpu_types.h"
47
48 typedef struct RegionView3D {
49
50         /** GL_PROJECTION matrix. */
51         float winmat[4][4];
52         /** GL_MODELVIEW matrix. */
53         float viewmat[4][4];
54         /** Inverse of viewmat. */
55         float viewinv[4][4];
56         /** Viewmat*winmat. */
57         float persmat[4][4];
58         /** Inverse of persmat. */
59         float persinv[4][4];
60         /** Offset/scale for camera glsl texcoords. */
61         float viewcamtexcofac[4];
62
63         /** viewmat/persmat multiplied with object matrix, while drawing and selection. */
64         float viewmatob[4][4];
65         float persmatob[4][4];
66
67         /** User defined clipping planes. */
68         float clip[6][4];
69         /** Clip in object space,
70          * means we can test for clipping in editmode without first going into worldspace. */
71         float clip_local[6][4];
72         struct BoundBox *clipbb;
73
74         /** Allocated backup of its self while in localview. */
75         struct RegionView3D *localvd;
76         struct RenderEngine *render_engine;
77         struct ViewDepths *depths;
78         void *gpuoffscreen;
79
80         /** Animated smooth view. */
81         struct SmoothView3DStore *sms;
82         struct wmTimer *smooth_timer;
83
84
85         /** Transform gizmo matrix. */
86         float twmat[4][4];
87         /** min/max dot product on twmat xyz axis. */
88         float tw_axis_min[3], tw_axis_max[3];
89         float tw_axis_matrix[3][3];
90
91         float gridview DNA_DEPRECATED;
92
93         /** View rotation, must be kept normalized. */
94         float viewquat[4];
95         /** Distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs'. */
96         float dist;
97         /** Camera view offsets, 1.0 = viewplane moves entire width/height. */
98         float camdx, camdy;
99         /** Runtime only. */
100         float pixsize;
101         /**
102          * View center & orbit pivot, negative of worldspace location,
103          * also matches -viewinv[3][0:3] in ortho mode.
104          */
105         float ofs[3];
106         /** Viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac. */
107         float camzoom;
108         /**
109          * Check if persp/ortho view, since 'persp' cant be used for this since
110          * it can have cameras assigned as well. (only set in #view3d_winmatrix_set)
111          */
112         char is_persp;
113         char persp;
114         char view;
115         char viewlock;
116         /** Options for quadview (store while out of quad view). */
117         char viewlock_quad;
118         char pad[3];
119         /** Normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right. */
120         float ofs_lock[2];
121
122         /** XXX can easily get rid of this (Julian). */
123         short twdrawflag;
124         short rflag;
125
126
127         /** Last view (use when switching out of camera view). */
128         float lviewquat[4];
129         /** Lpersp can never be set to 'RV3D_CAMOB'. */
130         short lpersp, lview;
131
132         /** Active rotation from NDOF or elsewhere. */
133         float rot_angle;
134         float rot_axis[3];
135 } RegionView3D;
136
137 typedef struct View3DCursor {
138         float location[3];
139
140         float rotation_quaternion[4];
141         float rotation_euler[3];
142         float rotation_axis[3], rotation_angle;
143         short rotation_mode;
144
145         char _pad[6];
146 } View3DCursor;
147
148 /* 3D Viewport Shading settings */
149 typedef struct View3DShading {
150         /** Shading type (VIEW3D_SHADE_SOLID, ..). */
151         char type;
152         /** Runtime, for toggle between rendered viewport. */
153         char prev_type;
154         char prev_type_wire;
155
156         char color_type;
157         short flag;
158
159         char light;
160         char background_type;
161         char cavity_type;
162         char wire_color_type;
163         char pad[6];
164
165         /** FILE_MAXFILE. */
166         char studio_light[256];
167         /** FILE_MAXFILE. */
168         char lookdev_light[256];
169         /** FILE_MAXFILE. */
170         char matcap[256];
171
172         float shadow_intensity;
173         float single_color[3];
174
175         float studiolight_rot_z;
176         float studiolight_background;
177
178         float object_outline_color[3];
179         float xray_alpha;
180         float xray_alpha_wire;
181
182         float cavity_valley_factor;
183         float cavity_ridge_factor;
184
185         float background_color[3];
186
187         float curvature_ridge_factor;
188         float curvature_valley_factor;
189
190 } View3DShading;
191
192 /* 3D Viewport Overlay settings */
193 typedef struct View3DOverlay {
194         int flag;
195
196         /* Edit mode settings */
197         int edit_flag;
198         float normals_length;
199         float backwire_opacity;
200
201         /* Paint mode settings */
202         int paint_flag;
203
204         /* Weight paint mode settings */
205         int wpaint_flag;
206         char _pad2[4];
207
208         /* Alpha for texture, weight, vertex paint overlay */
209         float texture_paint_mode_opacity;
210         float vertex_paint_mode_opacity;
211         float weight_paint_mode_opacity;
212
213         /* Armature edit/pose mode settings */
214         int arm_flag;
215         float xray_alpha_bone;
216
217         /* Other settings */
218         float wireframe_threshold;
219
220         /* grease pencil settings */
221         float gpencil_paper_opacity;
222         float gpencil_grid_opacity;
223         float gpencil_fade_layer;
224
225 } View3DOverlay;
226
227 /* 3D ViewPort Struct */
228 typedef struct View3D {
229         struct SpaceLink *next, *prev;
230         /** Storage of regions for inactive spaces. */
231         ListBase regionbase;
232         char spacetype;
233         char link_flag;
234         char _pad0[6];
235         /* End 'SpaceLink' header. */
236
237         float viewquat[4]  DNA_DEPRECATED;
238         float dist         DNA_DEPRECATED;
239
240         /** Size of bundles in reconstructed data. */
241         float bundle_size;
242         /** Display style for bundle. */
243         char bundle_drawtype;
244         char _pad3[2];
245
246         /** Multiview current eye - for internal use. */
247         char multiview_eye;
248
249         int object_type_exclude_viewport;
250         int object_type_exclude_select;
251
252         short persp  DNA_DEPRECATED;
253         short view   DNA_DEPRECATED;
254
255         struct Object *camera, *ob_centre;
256         rctf render_border;
257
258         /** Allocated backup of its self while in localview. */
259         struct View3D *localvd;
260
261         /** Optional string for armature bone to define center, MAXBONENAME. */
262         char ob_centre_bone[64];
263
264         unsigned short local_view_uuid;
265         short _pad6;
266         int layact DNA_DEPRECATED;
267
268         /** Optional bool for 3d cursor to define center. */
269         short ob_centre_cursor;
270         short scenelock;
271         short gp_flag;
272         short flag;
273         int flag2;
274
275         float lens, grid;
276         float clip_start, clip_end;
277         float ofs[3] DNA_DEPRECATED;
278
279         char _pad[4];
280
281         /** Icon id. */
282         short matcap_icon;
283
284         short gridlines;
285         /** Number of subdivisions in the grid between each highlighted grid line. */
286         short gridsubdiv;
287         char gridflag;
288
289         /** Transform gizmo info. */
290         char gizmo_flag;
291
292         /* actually only used to define the opacity of the grease pencil vertex in edit mode */
293         float vertex_opacity;
294
295         /* note, 'fx_settings.dof' is currently _not_ allocated,
296          * instead set (temporarily) from camera */
297         struct GPUFXSettings fx_settings;
298
299         /** Nkey panel stores stuff here (runtime only!). */
300         void *properties_storage;
301
302         /* XXX deprecated? */
303         /** Grease-Pencil Data (annotation layers). */
304         struct bGPdata *gpd  DNA_DEPRECATED;
305
306         /* Stereoscopy settings */
307         short stereo3d_flag;
308         char stereo3d_camera;
309         char pad4;
310         float stereo3d_convergence_factor;
311         float stereo3d_volume_alpha;
312         float stereo3d_convergence_alpha;
313
314         /* Display settings */
315         short drawtype DNA_DEPRECATED;
316         short pad5[3];
317
318         View3DShading shading;
319         View3DOverlay overlay;
320 } View3D;
321
322
323 /* View3D->stereo_flag (short) */
324 #define V3D_S3D_DISPCAMERAS     (1 << 0)
325 #define V3D_S3D_DISPPLANE       (1 << 1)
326 #define V3D_S3D_DISPVOLUME      (1 << 2)
327
328 /* View3D->flag (short) */
329 #define V3D_FLAG_DEPRECATED_0   (1 << 0)  /* cleared */
330 #define V3D_FLAG_DEPRECATED_1   (1 << 1)  /* cleared */
331 #define V3D_HIDE_HELPLINES      (1 << 2)
332 #define V3D_INVALID_BACKBUF     (1 << 3)
333
334 #define V3D_FLAG_DEPRECATED_10  (1 << 10)  /* cleared */
335 #define V3D_SELECT_OUTLINE      (1 << 11)
336 #define V3D_FLAG_DEPRECATED_12  (1 << 12)  /* cleared */
337 #define V3D_GLOBAL_STATS        (1 << 13)
338 #define V3D_DRAW_CENTERS        (1 << 15)
339
340 /* RegionView3d->persp */
341 #define RV3D_ORTHO                              0
342 #define RV3D_PERSP                              1
343 #define RV3D_CAMOB                              2
344
345 /* RegionView3d->rflag */
346 #define RV3D_CLIPPING               (1 << 2)
347 #define RV3D_NAVIGATING             (1 << 3)
348 #define RV3D_GPULIGHT_UPDATE        (1 << 4)
349 /*#define RV3D_IS_GAME_ENGINE       (1 << 5) *//* UNUSED */
350 /**
351  * Disable zbuffer offset, skip calls to #ED_view3d_polygon_offset.
352  * Use when precise surface depth is needed and picking bias isn't, see T45434).
353  */
354 #define RV3D_ZOFFSET_DISABLED           64
355
356 /* RegionView3d->viewlock */
357 #define RV3D_LOCKED                     (1 << 0)
358 #define RV3D_BOXVIEW            (1 << 1)
359 #define RV3D_BOXCLIP            (1 << 2)
360 /* RegionView3d->viewlock_quad */
361 #define RV3D_VIEWLOCK_INIT      (1 << 7)
362
363 /* RegionView3d->view */
364 #define RV3D_VIEW_USER                   0
365 #define RV3D_VIEW_FRONT                  1
366 #define RV3D_VIEW_BACK                   2
367 #define RV3D_VIEW_LEFT                   3
368 #define RV3D_VIEW_RIGHT                  4
369 #define RV3D_VIEW_TOP                    5
370 #define RV3D_VIEW_BOTTOM                 6
371 #define RV3D_VIEW_CAMERA                 8
372
373 #define RV3D_VIEW_IS_AXIS(view) \
374         (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
375
376 /* View3d->flag2 (int) */
377 #define V3D_RENDER_OVERRIDE     (1 << 2)
378 #define V3D_FLAG2_DEPRECATED_3  (1 << 3)   /* cleared */
379 #define V3D_SHOW_ANNOTATION     (1 << 4)
380 #define V3D_LOCK_CAMERA         (1 << 5)
381 #define V3D_FLAG2_DEPRECATED_6  (1 << 6)   /* cleared */
382 #define V3D_SHOW_RECONSTRUCTION (1 << 7)
383 #define V3D_SHOW_CAMERAPATH     (1 << 8)
384 #define V3D_SHOW_BUNDLENAME     (1 << 9)
385 #define V3D_FLAG2_DEPRECATED_10 (1 << 10)  /* cleared */
386 #define V3D_RENDER_BORDER       (1 << 11)
387 #define V3D_FLAG2_DEPRECATED_12 (1 << 12)  /* cleared */
388 #define V3D_FLAG2_DEPRECATED_13 (1 << 13)  /* cleared */
389 #define V3D_FLAG2_DEPRECATED_14 (1 << 14)  /* cleared */
390 #define V3D_FLAG2_DEPRECATED_15 (1 << 15)  /* cleared */
391
392 /* View3d->gp_flag (short) */
393 #define V3D_GP_SHOW_PAPER            (1 << 0) /* Activate paper to cover all viewport */
394 #define V3D_GP_SHOW_GRID             (1 << 1) /* Activate paper grid */
395 #define V3D_GP_SHOW_EDIT_LINES       (1 << 2)
396 #define V3D_GP_SHOW_MULTIEDIT_LINES  (1 << 3)
397 #define V3D_GP_SHOW_ONION_SKIN       (1 << 4) /* main switch at view level */
398 #define V3D_GP_FADE_NOACTIVE_LAYERS  (1 << 5) /* fade layers not active */
399
400 /* View3DShading->light */
401 enum {
402         V3D_LIGHTING_FLAT   = 0,
403         V3D_LIGHTING_STUDIO = 1,
404         V3D_LIGHTING_MATCAP = 2,
405 };
406
407 /* View3DShading->flag */
408 enum {
409         V3D_SHADING_OBJECT_OUTLINE      = (1 << 0),
410         V3D_SHADING_XRAY                = (1 << 1),
411         V3D_SHADING_SHADOW              = (1 << 2),
412         V3D_SHADING_SCENE_LIGHTS        = (1 << 3),
413         V3D_SHADING_SPECULAR_HIGHLIGHT  = (1 << 4),
414         V3D_SHADING_CAVITY              = (1 << 5),
415         V3D_SHADING_MATCAP_FLIP_X       = (1 << 6),
416         V3D_SHADING_SCENE_WORLD         = (1 << 7),
417         V3D_SHADING_XRAY_BONE           = (1 << 8),
418         V3D_SHADING_WORLD_ORIENTATION   = (1 << 9),
419         V3D_SHADING_BACKFACE_CULLING    = (1 << 10),
420         V3D_SHADING_DEPTH_OF_FIELD      = (1 << 11),
421 };
422
423 /* View3DShading->color_type */
424 enum {
425         V3D_SHADING_MATERIAL_COLOR = 0,
426         V3D_SHADING_RANDOM_COLOR   = 1,
427         V3D_SHADING_SINGLE_COLOR   = 2,
428         V3D_SHADING_TEXTURE_COLOR  = 3,
429         V3D_SHADING_OBJECT_COLOR   = 4,
430 };
431
432 /* View3DShading->background_type */
433 enum {
434         V3D_SHADING_BACKGROUND_THEME    = 0,
435         V3D_SHADING_BACKGROUND_WORLD    = 1,
436         V3D_SHADING_BACKGROUND_VIEWPORT = 2,
437 };
438
439 /* View3DShading->cavity_type */
440 enum {
441         V3D_SHADING_CAVITY_SSAO = 0,
442         V3D_SHADING_CAVITY_CURVATURE = 1,
443         V3D_SHADING_CAVITY_BOTH = 2,
444 };
445
446 /* View3DOverlay->flag */
447 enum {
448         V3D_OVERLAY_FACE_ORIENTATION  = (1 << 0),
449         V3D_OVERLAY_HIDE_CURSOR       = (1 << 1),
450         V3D_OVERLAY_BONE_SELECT       = (1 << 2),
451         V3D_OVERLAY_LOOK_DEV          = (1 << 3),
452         V3D_OVERLAY_WIREFRAMES        = (1 << 4),
453         V3D_OVERLAY_HIDE_TEXT         = (1 << 5),
454         V3D_OVERLAY_HIDE_MOTION_PATHS = (1 << 6),
455         V3D_OVERLAY_ONION_SKINS       = (1 << 7),
456         V3D_OVERLAY_HIDE_BONES        = (1 << 8),
457         V3D_OVERLAY_HIDE_OBJECT_XTRAS = (1 << 9),
458         V3D_OVERLAY_HIDE_OBJECT_ORIGINS = (1 << 10),
459 };
460
461 /* View3DOverlay->edit_flag */
462 enum {
463         V3D_OVERLAY_EDIT_VERT_NORMALS = (1 << 0),
464         V3D_OVERLAY_EDIT_LOOP_NORMALS = (1 << 1),
465         V3D_OVERLAY_EDIT_FACE_NORMALS = (1 << 2),
466
467         V3D_OVERLAY_EDIT_OCCLUDE_WIRE = (1 << 3),
468
469         V3D_OVERLAY_EDIT_WEIGHT       = (1 << 4),
470
471         V3D_OVERLAY_EDIT_EDGES        = (1 << 5),
472         V3D_OVERLAY_EDIT_FACES        = (1 << 6),
473         V3D_OVERLAY_EDIT_FACE_DOT     = (1 << 7),
474
475         V3D_OVERLAY_EDIT_SEAMS        = (1 << 8),
476         V3D_OVERLAY_EDIT_SHARP        = (1 << 9),
477         V3D_OVERLAY_EDIT_CREASES      = (1 << 10),
478         V3D_OVERLAY_EDIT_BWEIGHTS     = (1 << 11),
479
480         V3D_OVERLAY_EDIT_FREESTYLE_EDGE = (1 << 12),
481         V3D_OVERLAY_EDIT_FREESTYLE_FACE = (1 << 13),
482
483         V3D_OVERLAY_EDIT_STATVIS      = (1 << 14),
484         V3D_OVERLAY_EDIT_EDGE_LEN     = (1 << 15),
485         V3D_OVERLAY_EDIT_EDGE_ANG     = (1 << 16),
486         V3D_OVERLAY_EDIT_FACE_ANG     = (1 << 17),
487         V3D_OVERLAY_EDIT_FACE_AREA    = (1 << 18),
488         V3D_OVERLAY_EDIT_INDICES      = (1 << 19),
489
490         V3D_OVERLAY_EDIT_CU_HANDLES   = (1 << 20),
491         V3D_OVERLAY_EDIT_CU_NORMALS   = (1 << 21),
492 };
493
494 /* View3DOverlay->arm_flag */
495 enum {
496         V3D_OVERLAY_ARM_TRANSP_BONES  = (1 << 0),
497 };
498
499 /* View3DOverlay->paint_flag */
500 enum {
501         V3D_OVERLAY_PAINT_WIRE        = (1 << 0),
502 };
503
504 /* View3DOverlay->wpaint_flag */
505 enum {
506         V3D_OVERLAY_WPAINT_CONTOURS   = (1 << 0),
507 };
508
509 /* View3D->around */
510 enum {
511         /* center of the bounding box */
512         V3D_AROUND_CENTER_BOUNDS        = 0,
513         /* center from the sum of all points divided by the total */
514         V3D_AROUND_CENTER_MEDIAN    = 3,
515         /* pivot around the 2D/3D cursor */
516         V3D_AROUND_CURSOR                       = 1,
517         /* pivot around each items own origin */
518         V3D_AROUND_LOCAL_ORIGINS        = 2,
519         /* pivot around the active items origin */
520         V3D_AROUND_ACTIVE                       = 4,
521 };
522
523 /*View3D types (only used in tools, not actually saved)*/
524 #define V3D_VIEW_STEPLEFT                1
525 #define V3D_VIEW_STEPRIGHT               2
526 #define V3D_VIEW_STEPDOWN                3
527 #define V3D_VIEW_STEPUP          4
528 #define V3D_VIEW_PANLEFT                 5
529 #define V3D_VIEW_PANRIGHT                6
530 #define V3D_VIEW_PANDOWN                 7
531 #define V3D_VIEW_PANUP                   8
532
533 /* View3d->gridflag */
534 #define V3D_SHOW_FLOOR          (1 << 0)
535 #define V3D_SHOW_X              (1 << 1)
536 #define V3D_SHOW_Y              (1 << 2)
537 #define V3D_SHOW_Z              (1 << 3)
538
539 /** #TransformOrientationSlot.type */
540 enum {
541         V3D_ORIENT_GLOBAL        = 0,
542         V3D_ORIENT_LOCAL         = 1,
543         V3D_ORIENT_NORMAL        = 2,
544         V3D_ORIENT_VIEW          = 3,
545         V3D_ORIENT_GIMBAL        = 4,
546         V3D_ORIENT_CURSOR        = 5,
547         V3D_ORIENT_CUSTOM        = 1024,
548         /** Runtime only, never saved to DNA. */
549         V3D_ORIENT_CUSTOM_MATRIX =   (V3D_ORIENT_CUSTOM - 1),
550 };
551
552 /* View3d.mpr_flag (also) */
553 enum {
554         /** All gizmos. */
555         V3D_GIZMO_HIDE                = (1 << 0),
556         V3D_GIZMO_HIDE_NAVIGATE       = (1 << 1),
557         V3D_GIZMO_HIDE_CONTEXT        = (1 << 2),
558         V3D_GIZMO_HIDE_TOOL           = (1 << 3),
559 };
560
561 #define RV3D_CAMZOOM_MIN -30
562 #define RV3D_CAMZOOM_MAX 600
563
564 /* #BKE_screen_view3d_zoom_to_fac() values above */
565 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
566 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
567
568 #endif