406f74340333f1832a7309224893e71bbbcba0e1
[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 /* This is needed to not let VC choke on near and far... old
50  * proprietary MS extensions... */
51 #ifdef WIN32
52 #undef near
53 #undef far
54 #define near clipsta
55 #define far clipend
56 #endif
57
58 #include "DNA_defs.h"
59 #include "DNA_listBase.h"
60 #include "DNA_image_types.h"
61 #include "DNA_movieclip_types.h"
62 #include "DNA_gpu_types.h"
63
64 /* ******************************** */
65
66 /* The near/far thing is a Win EXCEPTION. Thus, leave near/far in the
67  * code, and patch for windows. */
68
69 typedef struct RegionView3D {
70         
71         float winmat[4][4];                     /* GL_PROJECTION matrix */
72         float viewmat[4][4];            /* GL_MODELVIEW matrix */
73         float viewinv[4][4];            /* inverse of viewmat */
74         float persmat[4][4];            /* viewmat*winmat */
75         float persinv[4][4];            /* inverse of persmat */
76         float viewcamtexcofac[4];       /* offset/scale for camera glsl texcoords */
77
78         /* viewmat/persmat multiplied with object matrix, while drawing and selection */
79         float viewmatob[4][4];
80         float persmatob[4][4];
81
82         /* user defined clipping planes */
83         float clip[6][4];
84         float clip_local[6][4]; /* clip in object space, means we can test for clipping in editmode without first going into worldspace */
85         struct BoundBox *clipbb;
86
87         struct RegionView3D *localvd; /* allocated backup of its self while in localview */
88         struct RenderEngine *render_engine;
89         struct ViewDepths *depths;
90         void *gpuoffscreen;
91
92         /* animated smooth view */
93         struct SmoothView3DStore *sms;
94         struct wmTimer *smooth_timer;
95
96
97         /* transform manipulator matrix */
98         float twmat[4][4];
99         /* min/max dot product on twmat xyz axis. */
100         float tw_axis_min[3], tw_axis_max[3];
101         float tw_axis_matrix[3][3];
102
103         float gridview;
104
105         float viewquat[4];                      /* view rotation, must be kept normalized */
106         float dist;                                     /* distance from 'ofs' along -viewinv[2] vector, where result is negative as is 'ofs' */
107         float camdx, camdy;                     /* camera view offsets, 1.0 = viewplane moves entire width/height */
108         float pixsize;                          /* runtime only */
109         float ofs[3];                           /* view center & orbit pivot, negative of worldspace location,
110                                                                  * also matches -viewinv[3][0:3] in ortho mode.*/
111         float camzoom;                          /* viewport zoom on the camera frame, see BKE_screen_view3d_zoom_to_fac */
112         char is_persp;                          /* check if persp/ortho view, since 'persp' cant be used for this since
113                                                                  * it can have cameras assigned as well. (only set in view3d_winmatrix_set) */
114         char persp;
115         char view;
116         char viewlock;
117         char viewlock_quad;                     /* options for quadview (store while out of quad view) */
118         char pad[3];
119         float ofs_lock[2];                      /* normalized offset for locked view: (-1, -1) bottom left, (1, 1) upper right */
120
121         short twdrawflag; /* XXX can easily get rid of this (Julian) */
122         short rflag;
123
124
125         /* last view (use when switching out of camera view) */
126         float lviewquat[4];
127         short lpersp, lview; /* lpersp can never be set to 'RV3D_CAMOB' */
128
129         /* active rotation from NDOF or elsewhere */
130         float rot_angle;
131         float rot_axis[3];
132 } RegionView3D;
133
134 /* 3D Viewport Shading setings */
135 typedef struct View3DShading {
136         short flag;
137         short color_type;
138
139         short light;
140         short studio_light;
141
142         float shadow_intensity;
143         float single_color[3];
144 } View3DShading;
145
146 /* 3D Viewport Overlay setings */
147 typedef struct View3DOverlay {
148         int flag;
149
150         /* Edit mode settings */
151         int edit_flag;
152         float normals_length;
153         float backwire_opacity;
154
155         /* Paint mode settings */
156         int paint_flag;
157
158         /* Armature edit/pose mode settings */
159         int arm_flag;
160 } View3DOverlay;
161
162 /* 3D ViewPort Struct */
163 typedef struct View3D {
164         struct SpaceLink *next, *prev;
165         ListBase regionbase;            /* storage of regions for inactive spaces */
166         int spacetype;
167         float blockscale;
168         short blockhandler[8];
169
170         float viewquat[4]  DNA_DEPRECATED;
171         float dist         DNA_DEPRECATED;
172
173         float bundle_size;                      /* size of bundles in reconstructed data */
174         char bundle_drawtype;           /* display style for bundle */
175         char pad[3];
176
177         unsigned int lay_prev; /* for active layer toggle */
178         unsigned int lay_used; /* used while drawing */
179         
180         short persp  DNA_DEPRECATED;
181         short view   DNA_DEPRECATED;
182         
183         struct Object *camera, *ob_centre;
184         rctf render_border;
185
186         struct View3D *localvd; /* allocated backup of its self while in localview */
187         
188         char ob_centre_bone[64];                /* optional string for armature bone to define center, MAXBONENAME */
189         
190         unsigned int lay;
191         int layact;
192         
193         short ob_centre_cursor;         /* optional bool for 3d cursor to define center */
194         short scenelock, around;
195         short flag, flag2, pad2;
196         
197         float lens, grid;
198         float near, far;
199         float ofs[3]  DNA_DEPRECATED;                   /* XXX deprecated */
200         float cursor[3];
201
202         short matcap_icon;                      /* icon id */
203
204         short gridlines;
205         short gridsubdiv;       /* Number of subdivisions in the grid between each highlighted grid line */
206         char gridflag;
207
208         /* transform manipulator info */
209         char twtype, _pad5, twflag;
210         
211         short flag3;
212
213         /* drawflags, denoting state */
214         char zbuf, transp, xray;
215
216         char multiview_eye;                             /* multiview current eye - for internal use */
217
218         char pad3[4];
219
220         /* note, 'fx_settings.dof' is currently _not_ allocated,
221          * instead set (temporarily) from camera */
222         struct GPUFXSettings fx_settings;
223
224         void *properties_storage;               /* Nkey panel stores stuff here (runtime only!) */
225
226         /* XXX deprecated? */
227         struct bGPdata *gpd  DNA_DEPRECATED;            /* Grease-Pencil Data (annotation layers) */
228
229         /* Stereoscopy settings */
230         short stereo3d_flag;
231         char stereo3d_camera;
232         char pad4;
233         float stereo3d_convergence_factor;
234         float stereo3d_volume_alpha;
235         float stereo3d_convergence_alpha;
236
237         /* Display settings */
238         short drawtype;         /* Shading mode (OB_SOLID, OB_TEXTURE, ..) */
239         short prev_drawtype;    /* Runtime, for toggle between rendered viewport. */
240         int pad5;
241
242         View3DShading shading;
243         View3DOverlay overlay;
244 } View3D;
245
246
247 /* View3D->stereo_flag (short) */
248 #define V3D_S3D_DISPCAMERAS             (1 << 0)
249 #define V3D_S3D_DISPPLANE               (1 << 1)
250 #define V3D_S3D_DISPVOLUME              (1 << 2)
251
252 /* View3D->flag (short) */
253 /*#define V3D_DISPIMAGE         1*/ /*UNUSED*/
254 /*#define V3D_DISPBGPICS                2*/ /* UNUSED */
255 #define V3D_HIDE_HELPLINES      4
256 #define V3D_INVALID_BACKBUF     8
257
258 #define V3D_ALIGN                       1024
259 #define V3D_SELECT_OUTLINE      2048
260 #define V3D_ZBUF_SELECT         4096
261 #define V3D_GLOBAL_STATS        8192
262 #define V3D_DRAW_CENTERS        32768
263
264 /* RegionView3d->persp */
265 #define RV3D_ORTHO                              0
266 #define RV3D_PERSP                              1
267 #define RV3D_CAMOB                              2
268
269 /* RegionView3d->rflag */
270 #define RV3D_CLIPPING                           4
271 #define RV3D_NAVIGATING                         8
272 #define RV3D_GPULIGHT_UPDATE            16
273 /*#define RV3D_IS_GAME_ENGINE                   32 *//* UNUSED */
274 /**
275  * Disable zbuffer offset, skip calls to #ED_view3d_polygon_offset.
276  * Use when precise surface depth is needed and picking bias isn't, see T45434).
277  */
278 #define RV3D_ZOFFSET_DISABLED           64
279
280 /* RegionView3d->viewlock */
281 #define RV3D_LOCKED                     (1 << 0)
282 #define RV3D_BOXVIEW            (1 << 1)
283 #define RV3D_BOXCLIP            (1 << 2)
284 /* RegionView3d->viewlock_quad */
285 #define RV3D_VIEWLOCK_INIT      (1 << 7)
286
287 /* RegionView3d->view */
288 #define RV3D_VIEW_USER                   0
289 #define RV3D_VIEW_FRONT                  1
290 #define RV3D_VIEW_BACK                   2
291 #define RV3D_VIEW_LEFT                   3
292 #define RV3D_VIEW_RIGHT                  4
293 #define RV3D_VIEW_TOP                    5
294 #define RV3D_VIEW_BOTTOM                 6
295 #define RV3D_VIEW_CAMERA                 8
296
297 #define RV3D_VIEW_IS_AXIS(view) \
298         (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
299
300 /* View3d->flag2 (short) */
301 #define V3D_RENDER_OVERRIDE             (1 << 2)
302 #define V3D_SOLID_TEX                   (1 << 3)
303 #define V3D_SHOW_GPENCIL                (1 << 4)
304 #define V3D_LOCK_CAMERA                 (1 << 5)
305 #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 */
306 #define V3D_SHOW_RECONSTRUCTION (1 << 7)
307 #define V3D_SHOW_CAMERAPATH             (1 << 8)
308 #define V3D_SHOW_BUNDLENAME             (1 << 9)
309 #define V3D_BACKFACE_CULLING    (1 << 10)
310 #define V3D_RENDER_BORDER               (1 << 11)
311 #define V3D_SOLID_MATCAP                (1 << 12)       /* user flag */
312 #define V3D_SHOW_SOLID_MATCAP   (1 << 13)       /* runtime flag */
313 #define V3D_OCCLUDE_WIRE                (1 << 14)
314 #define V3D_SHOW_MODE_SHADE_OVERRIDE    (1 << 15)
315
316
317 /* View3d->flag3 (short) */
318 #define V3D_SHOW_WORLD                  (1 << 0)
319
320 /* View3DShading->light */
321 enum {
322         V3D_LIGHTING_FLAT   = 0,
323         V3D_LIGHTING_STUDIO = 1,
324         V3D_LIGHTING_SCENE  = 2
325 };
326
327 /* View3DShading->flag */
328 enum {
329         V3D_SHADING_OBJECT_OVERLAP = (1 << 0),
330         V3D_SHADING_SHADOW         = (1 << 2),
331 };
332
333 /* View3DShading->single_color_type */
334 enum {
335         V3D_SHADING_MATERIAL_COLOR = 0,
336         V3D_SHADING_RANDOM_COLOR   = 1,
337         V3D_SHADING_SINGLE_COLOR   = 2,
338         V3D_SHADING_OBJECT_COLOR   = 3,
339 };
340
341 /* View3DOverlay->flag */
342 enum {
343         V3D_OVERLAY_FACE_ORIENTATION  = (1 << 0),
344         V3D_OVERLAY_HIDE_CURSOR       = (1 << 1),
345 };
346
347 /* View3DOverlay->edit_flag */
348 enum {
349         V3D_OVERLAY_EDIT_VERT_NORMALS = (1 << 0),
350         V3D_OVERLAY_EDIT_LOOP_NORMALS = (1 << 1),
351         V3D_OVERLAY_EDIT_FACE_NORMALS = (1 << 2),
352
353         V3D_OVERLAY_EDIT_OCCLUDE_WIRE = (1 << 3),
354
355         V3D_OVERLAY_EDIT_WEIGHT       = (1 << 4),
356 };
357
358 /* View3DOverlay->arm_flag */
359 enum {
360         V3D_OVERLAY_ARM_TRANSP_BONES  = (1 << 0),
361 };
362
363 /* View3DOverlay->paint_flag */
364 enum {
365         V3D_OVERLAY_PAINT_WIRE        = (1 << 0),
366 };
367
368 /* View3D->around */
369 enum {
370         /* center of the bounding box */
371         V3D_AROUND_CENTER_BOUNDS        = 0,
372         /* center from the sum of all points divided by the total */
373         V3D_AROUND_CENTER_MEAN          = 3,
374         /* pivot around the 2D/3D cursor */
375         V3D_AROUND_CURSOR                       = 1,
376         /* pivot around each items own origin */
377         V3D_AROUND_LOCAL_ORIGINS        = 2,
378         /* pivot around the active items origin */
379         V3D_AROUND_ACTIVE                       = 4,
380 };
381
382 /*View3D types (only used in tools, not actually saved)*/
383 #define V3D_VIEW_STEPLEFT                1
384 #define V3D_VIEW_STEPRIGHT               2
385 #define V3D_VIEW_STEPDOWN                3
386 #define V3D_VIEW_STEPUP          4
387 #define V3D_VIEW_PANLEFT                 5
388 #define V3D_VIEW_PANRIGHT                6
389 #define V3D_VIEW_PANDOWN                 7
390 #define V3D_VIEW_PANUP                   8
391
392 /* View3d->gridflag */
393 #define V3D_SHOW_FLOOR                  1
394 #define V3D_SHOW_X                              2
395 #define V3D_SHOW_Y                              4
396 #define V3D_SHOW_Z                              8
397
398 /* Scene.orientation_type */
399 #define V3D_MANIP_GLOBAL                0
400 #define V3D_MANIP_LOCAL                 1
401 #define V3D_MANIP_NORMAL                2
402 #define V3D_MANIP_VIEW                  3
403 #define V3D_MANIP_GIMBAL                4
404 #define V3D_MANIP_CUSTOM                5
405
406 /* View3d->twflag (also) */
407 enum {
408         V3D_MANIPULATOR_DRAW        = (1 << 0),
409 };
410
411 #define RV3D_CAMZOOM_MIN -30
412 #define RV3D_CAMZOOM_MAX 600
413
414 /* #BKE_screen_view3d_zoom_to_fac() values above */
415 #define RV3D_CAMZOOM_MIN_FACTOR  0.1657359312880714853f
416 #define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
417
418 #endif
419