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