doxygen: add newline after \file
[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         float rotation[4];
140         char _pad[4];
141 } View3DCursor;
142
143 /* 3D Viewport Shading settings */
144 typedef struct View3DShading {
145         /** Shading type (VIEW3D_SHADE_SOLID, ..). */
146         char type;
147         /** Runtime, for toggle between rendered viewport. */
148         char prev_type;
149         char prev_type_wire;
150
151         char color_type;
152         short flag;
153
154         char light;
155         char background_type;
156         char cavity_type;
157         char pad[7];
158
159         /** FILE_MAXFILE. */
160         char studio_light[256];
161         /** FILE_MAXFILE. */
162         char lookdev_light[256];
163         /** FILE_MAXFILE. */
164         char matcap[256];
165
166         float shadow_intensity;
167         float single_color[3];
168
169         float studiolight_rot_z;
170         float studiolight_background;
171
172         float object_outline_color[3];
173         float xray_alpha;
174         float xray_alpha_wire;
175
176         float cavity_valley_factor;
177         float cavity_ridge_factor;
178
179         float background_color[3];
180
181         float curvature_ridge_factor;
182         float curvature_valley_factor;
183
184 } View3DShading;
185
186 /* 3D Viewport Overlay settings */
187 typedef struct View3DOverlay {
188         int flag;
189
190         /* Edit mode settings */
191         int edit_flag;
192         float normals_length;
193         float backwire_opacity;
194
195         /* Paint mode settings */
196         int paint_flag;
197
198         /* Weight paint mode settings */
199         int wpaint_flag;
200         char _pad2[4];
201
202         /* Alpha for texture, weight, vertex paint overlay */
203         float texture_paint_mode_opacity;
204         float vertex_paint_mode_opacity;
205         float weight_paint_mode_opacity;
206
207         /* Armature edit/pose mode settings */
208         int arm_flag;
209         float xray_alpha_bone;
210
211         /* Other settings */
212         float wireframe_threshold;
213
214         /* grease pencil settings */
215         float gpencil_paper_opacity;
216         float gpencil_grid_opacity;
217         float gpencil_fade_layer;
218
219 } View3DOverlay;
220
221 /* 3D ViewPort Struct */
222 typedef struct View3D {
223         struct SpaceLink *next, *prev;
224         /** Storage of regions for inactive spaces. */
225         ListBase regionbase;
226         char spacetype;
227         char link_flag;
228         char _pad0[6];
229         /* End 'SpaceLink' header. */
230
231         float viewquat[4]  DNA_DEPRECATED;
232         float dist         DNA_DEPRECATED;
233
234         /** Size of bundles in reconstructed data. */
235         float bundle_size;
236         /** Display style for bundle. */
237         char bundle_drawtype;
238         char _pad3[2];
239
240         /** Multiview current eye - for internal use. */
241         char multiview_eye;
242
243         int object_type_exclude_viewport;
244         int object_type_exclude_select;
245
246         short persp  DNA_DEPRECATED;
247         short view   DNA_DEPRECATED;
248
249         struct Object *camera, *ob_centre;
250         rctf render_border;
251
252         /** Allocated backup of its self while in localview. */
253         struct View3D *localvd;
254
255         /** Optional string for armature bone to define center, MAXBONENAME. */
256         char ob_centre_bone[64];
257
258         unsigned short local_view_uuid;
259         short _pad6;
260         int layact DNA_DEPRECATED;
261
262         /** Optional bool for 3d cursor to define center. */
263         short ob_centre_cursor;
264         short scenelock;
265         short gp_flag;
266         short flag;
267         int flag2;
268
269         float lens, grid;
270         float clip_start, clip_end;
271         float ofs[3] DNA_DEPRECATED;
272
273         char _pad[4];
274
275         /** Icon id. */
276         short matcap_icon;
277
278         short gridlines;
279         /** Number of subdivisions in the grid between each highlighted grid line. */
280         short gridsubdiv;
281         char gridflag;
282
283         /** Transform gizmo info. */
284         char gizmo_flag;
285
286         /* actually only used to define the opacity of the grease pencil vertex in edit mode */
287         float vertex_opacity;
288
289         /* note, 'fx_settings.dof' is currently _not_ allocated,
290          * instead set (temporarily) from camera */
291         struct GPUFXSettings fx_settings;
292
293         /** Nkey panel stores stuff here (runtime only!). */
294         void *properties_storage;
295
296         /* XXX deprecated? */
297         /** Grease-Pencil Data (annotation layers). */
298         struct bGPdata *gpd  DNA_DEPRECATED;
299
300         /* Stereoscopy settings */
301         short stereo3d_flag;
302         char stereo3d_camera;
303         char pad4;
304         float stereo3d_convergence_factor;
305         float stereo3d_volume_alpha;
306         float stereo3d_convergence_alpha;
307
308         /* Display settings */
309         short drawtype DNA_DEPRECATED;
310         short pad5[3];
311
312         View3DShading shading;
313         View3DOverlay overlay;
314 } View3D;
315
316
317 /* View3D->stereo_flag (short) */
318 #define V3D_S3D_DISPCAMERAS     (1 << 0)
319 #define V3D_S3D_DISPPLANE       (1 << 1)
320 #define V3D_S3D_DISPVOLUME      (1 << 2)
321
322 /* View3D->flag (short) */
323 #define V3D_FLAG_DEPRECATED_0   (1 << 0)  /* cleared */
324 #define V3D_FLAG_DEPRECATED_1   (1 << 1)  /* cleared */
325 #define V3D_HIDE_HELPLINES      (1 << 2)
326 #define V3D_INVALID_BACKBUF     (1 << 3)
327
328 #define V3D_FLAG_DEPRECATED_10  (1 << 10)  /* cleared */
329 #define V3D_SELECT_OUTLINE      (1 << 11)
330 #define V3D_FLAG_DEPRECATED_12  (1 << 12)  /* cleared */
331 #define V3D_GLOBAL_STATS        (1 << 13)
332 #define V3D_DRAW_CENTERS        (1 << 15)
333
334 /* RegionView3d->persp */
335 #define RV3D_ORTHO                              0
336 #define RV3D_PERSP                              1
337 #define RV3D_CAMOB                              2
338
339 /* RegionView3d->rflag */
340 #define RV3D_CLIPPING               (1 << 2)
341 #define RV3D_NAVIGATING             (1 << 3)
342 #define RV3D_GPULIGHT_UPDATE        (1 << 4)
343 /*#define RV3D_IS_GAME_ENGINE       (1 << 5) *//* UNUSED */
344 /**
345  * Disable zbuffer offset, skip calls to #ED_view3d_polygon_offset.
346  * Use when precise surface depth is needed and picking bias isn't, see T45434).
347  */
348 #define RV3D_ZOFFSET_DISABLED           64
349
350 /* RegionView3d->viewlock */
351 #define RV3D_LOCKED                     (1 << 0)
352 #define RV3D_BOXVIEW            (1 << 1)
353 #define RV3D_BOXCLIP            (1 << 2)
354 /* RegionView3d->viewlock_quad */
355 #define RV3D_VIEWLOCK_INIT      (1 << 7)
356
357 /* RegionView3d->view */
358 #define RV3D_VIEW_USER                   0
359 #define RV3D_VIEW_FRONT                  1
360 #define RV3D_VIEW_BACK                   2
361 #define RV3D_VIEW_LEFT                   3
362 #define RV3D_VIEW_RIGHT                  4
363 #define RV3D_VIEW_TOP                    5
364 #define RV3D_VIEW_BOTTOM                 6
365 #define RV3D_VIEW_CAMERA                 8
366
367 #define RV3D_VIEW_IS_AXIS(view) \
368         (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
369
370 /* View3d->flag2 (int) */
371 #define V3D_RENDER_OVERRIDE     (1 << 2)
372 #define V3D_FLAG2_DEPRECATED_3  (1 << 3)   /* cleared */
373 #define V3D_SHOW_ANNOTATION     (1 << 4)
374 #define V3D_LOCK_CAMERA         (1 << 5)
375 #define V3D_FLAG2_DEPRECATED_6  (1 << 6)   /* cleared */
376 #define V3D_SHOW_RECONSTRUCTION (1 << 7)
377 #define V3D_SHOW_CAMERAPATH     (1 << 8)
378 #define V3D_SHOW_BUNDLENAME     (1 << 9)
379 #define V3D_FLAG2_DEPRECATED_10 (1 << 10)  /* cleared */
380 #define V3D_RENDER_BORDER       (1 << 11)
381 #define V3D_FLAG2_DEPRECATED_12 (1 << 12)  /* cleared */
382 #define V3D_FLAG2_DEPRECATED_13 (1 << 13)  /* cleared */
383 #define V3D_FLAG2_DEPRECATED_14 (1 << 14)  /* cleared */
384 #define V3D_FLAG2_DEPRECATED_15 (1 << 15)  /* cleared */
385
386 /* View3d->gp_flag (short) */
387 #define V3D_GP_SHOW_PAPER            (1 << 0) /* Activate paper to cover all viewport */
388 #define V3D_GP_SHOW_GRID             (1 << 1) /* Activate paper grid */
389 #define V3D_GP_SHOW_EDIT_LINES       (1 << 2)
390 #define V3D_GP_SHOW_MULTIEDIT_LINES  (1 << 3)
391 #define V3D_GP_SHOW_ONION_SKIN       (1 << 4) /* main switch at view level */
392 #define V3D_GP_FADE_NOACTIVE_LAYERS  (1 << 5) /* fade layers not active */
393
394 /* View3DShading->light */
395 enum {
396         V3D_LIGHTING_FLAT   = 0,
397         V3D_LIGHTING_STUDIO = 1,
398         V3D_LIGHTING_MATCAP = 2,
399 };
400
401 /* View3DShading->flag */
402 enum {
403         V3D_SHADING_OBJECT_OUTLINE      = (1 << 0),
404         V3D_SHADING_XRAY                = (1 << 1),
405         V3D_SHADING_SHADOW              = (1 << 2),
406         V3D_SHADING_SCENE_LIGHTS        = (1 << 3),
407         V3D_SHADING_SPECULAR_HIGHLIGHT  = (1 << 4),
408         V3D_SHADING_CAVITY              = (1 << 5),
409         V3D_SHADING_MATCAP_FLIP_X       = (1 << 6),
410         V3D_SHADING_SCENE_WORLD         = (1 << 7),
411         V3D_SHADING_XRAY_BONE           = (1 << 8),
412         V3D_SHADING_WORLD_ORIENTATION   = (1 << 9),
413         V3D_SHADING_BACKFACE_CULLING    = (1 << 10),
414         V3D_SHADING_DEPTH_OF_FIELD      = (1 << 11),
415 };
416
417 /* View3DShading->color_type */
418 enum {
419         V3D_SHADING_MATERIAL_COLOR = 0,
420         V3D_SHADING_RANDOM_COLOR   = 1,
421         V3D_SHADING_SINGLE_COLOR   = 2,
422         V3D_SHADING_TEXTURE_COLOR  = 3,
423         V3D_SHADING_OBJECT_COLOR   = 4,
424 };
425
426 /* View3DShading->background_type */
427 enum {
428         V3D_SHADING_BACKGROUND_THEME    = 0,
429         V3D_SHADING_BACKGROUND_WORLD    = 1,
430         V3D_SHADING_BACKGROUND_VIEWPORT = 2,
431 };
432
433 /* View3DShading->cavity_type */
434 enum {
435         V3D_SHADING_CAVITY_SSAO = 0,
436         V3D_SHADING_CAVITY_CURVATURE = 1,
437         V3D_SHADING_CAVITY_BOTH = 2,
438 };
439
440 /* View3DOverlay->flag */
441 enum {
442         V3D_OVERLAY_FACE_ORIENTATION  = (1 << 0),
443         V3D_OVERLAY_HIDE_CURSOR       = (1 << 1),
444         V3D_OVERLAY_BONE_SELECT       = (1 << 2),
445         V3D_OVERLAY_LOOK_DEV          = (1 << 3),
446         V3D_OVERLAY_WIREFRAMES        = (1 << 4),
447         V3D_OVERLAY_HIDE_TEXT         = (1 << 5),
448         V3D_OVERLAY_HIDE_MOTION_PATHS = (1 << 6),
449         V3D_OVERLAY_ONION_SKINS       = (1 << 7),
450         V3D_OVERLAY_HIDE_BONES        = (1 << 8),
451         V3D_OVERLAY_HIDE_OBJECT_XTRAS = (1 << 9),
452         V3D_OVERLAY_HIDE_OBJECT_ORIGINS = (1 << 10),
453 };
454
455 /* View3DOverlay->edit_flag */
456 enum {
457         V3D_OVERLAY_EDIT_VERT_NORMALS = (1 << 0),
458         V3D_OVERLAY_EDIT_LOOP_NORMALS = (1 << 1),
459         V3D_OVERLAY_EDIT_FACE_NORMALS = (1 << 2),
460
461         V3D_OVERLAY_EDIT_OCCLUDE_WIRE = (1 << 3),
462
463         V3D_OVERLAY_EDIT_WEIGHT       = (1 << 4),
464
465         V3D_OVERLAY_EDIT_EDGES        = (1 << 5),
466         V3D_OVERLAY_EDIT_FACES        = (1 << 6),
467         V3D_OVERLAY_EDIT_FACE_DOT     = (1 << 7),
468
469         V3D_OVERLAY_EDIT_SEAMS        = (1 << 8),
470         V3D_OVERLAY_EDIT_SHARP        = (1 << 9),
471         V3D_OVERLAY_EDIT_CREASES      = (1 << 10),
472         V3D_OVERLAY_EDIT_BWEIGHTS     = (1 << 11),
473
474         V3D_OVERLAY_EDIT_FREESTYLE_EDGE = (1 << 12),
475         V3D_OVERLAY_EDIT_FREESTYLE_FACE = (1 << 13),
476
477         V3D_OVERLAY_EDIT_STATVIS      = (1 << 14),
478         V3D_OVERLAY_EDIT_EDGE_LEN     = (1 << 15),
479         V3D_OVERLAY_EDIT_EDGE_ANG     = (1 << 16),
480         V3D_OVERLAY_EDIT_FACE_ANG     = (1 << 17),
481         V3D_OVERLAY_EDIT_FACE_AREA    = (1 << 18),
482         V3D_OVERLAY_EDIT_INDICES      = (1 << 19),
483
484         V3D_OVERLAY_EDIT_CU_HANDLES   = (1 << 20),
485         V3D_OVERLAY_EDIT_CU_NORMALS   = (1 << 21),
486 };
487
488 /* View3DOverlay->arm_flag */
489 enum {
490         V3D_OVERLAY_ARM_TRANSP_BONES  = (1 << 0),
491 };
492
493 /* View3DOverlay->paint_flag */
494 enum {
495         V3D_OVERLAY_PAINT_WIRE        = (1 << 0),
496 };
497
498 /* View3DOverlay->wpaint_flag */
499 enum {
500         V3D_OVERLAY_WPAINT_CONTOURS   = (1 << 0),
501 };
502
503 /* View3D->around */
504 enum {
505         /* center of the bounding box */
506         V3D_AROUND_CENTER_BOUNDS        = 0,
507         /* center from the sum of all points divided by the total */
508         V3D_AROUND_CENTER_MEDIAN    = 3,
509         /* pivot around the 2D/3D cursor */
510         V3D_AROUND_CURSOR                       = 1,
511         /* pivot around each items own origin */
512         V3D_AROUND_LOCAL_ORIGINS        = 2,
513         /* pivot around the active items origin */
514         V3D_AROUND_ACTIVE                       = 4,
515 };
516
517 /*View3D types (only used in tools, not actually saved)*/
518 #define V3D_VIEW_STEPLEFT                1
519 #define V3D_VIEW_STEPRIGHT               2
520 #define V3D_VIEW_STEPDOWN                3
521 #define V3D_VIEW_STEPUP          4
522 #define V3D_VIEW_PANLEFT                 5
523 #define V3D_VIEW_PANRIGHT                6
524 #define V3D_VIEW_PANDOWN                 7
525 #define V3D_VIEW_PANUP                   8
526
527 /* View3d->gridflag */
528 #define V3D_SHOW_FLOOR          (1 << 0)
529 #define V3D_SHOW_X              (1 << 1)
530 #define V3D_SHOW_Y              (1 << 2)
531 #define V3D_SHOW_Z              (1 << 3)
532
533 /** #TransformOrientationSlot.type */
534 enum {
535         V3D_ORIENT_GLOBAL        = 0,
536         V3D_ORIENT_LOCAL         = 1,
537         V3D_ORIENT_NORMAL        = 2,
538         V3D_ORIENT_VIEW          = 3,
539         V3D_ORIENT_GIMBAL        = 4,
540         V3D_ORIENT_CURSOR        = 5,
541         V3D_ORIENT_CUSTOM        = 1024,
542         /** Runtime only, never saved to DNA. */
543         V3D_ORIENT_CUSTOM_MATRIX =   (V3D_ORIENT_CUSTOM - 1),
544 };
545
546 /* View3d.mpr_flag (also) */
547 enum {
548         /** All gizmos. */
549         V3D_GIZMO_HIDE                = (1 << 0),
550         V3D_GIZMO_HIDE_NAVIGATE       = (1 << 1),
551         V3D_GIZMO_HIDE_CONTEXT        = (1 << 2),
552         V3D_GIZMO_HIDE_TOOL           = (1 << 3),
553 };
554
555 #define RV3D_CAMZOOM_MIN -30
556 #define RV3D_CAMZOOM_MAX 600
557
558 /* #BKE_screen_view3d_zoom_to_fac() values above */
559 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
560 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
561
562 #endif