GPencil: New interpolate strokes operators
[blender.git] / source / blender / makesdna / DNA_scene_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_scene_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_SCENE_TYPES_H__
33 #define __DNA_SCENE_TYPES_H__
34
35 #include "DNA_defs.h"
36
37 /* XXX, temp feature - campbell */
38 #define DURIAN_CAMERA_SWITCH
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #include "DNA_color_types.h"  /* color management */
45 #include "DNA_vec_types.h"
46 #include "DNA_listBase.h"
47 #include "DNA_ID.h"
48 #include "DNA_freestyle_types.h"
49 #include "DNA_gpu_types.h"
50 #include "DNA_userdef_types.h"
51
52 struct CurveMapping;
53 struct Object;
54 struct Brush;
55 struct World;
56 struct Scene;
57 struct Image;
58 struct Group;
59 struct Text;
60 struct bNodeTree;
61 struct AnimData;
62 struct Editing;
63 struct SceneStats;
64 struct bGPdata;
65 struct bGPDbrush;
66 struct MovieClip;
67 struct ColorSpace;
68
69 /* ************************************************************* */
70 /* Scene Data */
71
72 /* Base - Wrapper for referencing Objects in a Scene */
73 typedef struct Base {
74         struct Base *next, *prev;
75         unsigned int lay, selcol;
76         int flag;
77         short sx, sy;
78         struct Object *object;
79 } Base;
80
81 /* ************************************************************* */
82 /* Output Format Data */
83
84 typedef struct AviCodecData {
85         void                    *lpFormat;  /* save format */
86         void                    *lpParms;   /* compressor options */
87         unsigned int    cbFormat;           /* size of lpFormat buffer */
88         unsigned int    cbParms;            /* size of lpParms buffer */
89
90         unsigned int    fccType;            /* stream type, for consistency */
91         unsigned int    fccHandler;         /* compressor */
92         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
93         unsigned int    dwQuality;          /* compress quality 0-10,000 */
94         unsigned int    dwBytesPerSecond;   /* bytes per second */
95         unsigned int    dwFlags;            /* flags... see below */
96         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
97         unsigned int    pad;
98
99         char                    avicodecname[128];
100 } AviCodecData;
101
102 typedef struct QuicktimeCodecData {
103         /*Old quicktime implementation compatibility fields, read only in 2.5 - deprecated*/
104         void                    *cdParms;   /* codec/compressor options */
105         void                    *pad;       /* padding */
106
107         unsigned int    cdSize;             /* size of cdParms buffer */
108         unsigned int    pad2;               /* padding */
109
110         char                    qtcodecname[128];
111 } QuicktimeCodecData;
112         
113 typedef struct QuicktimeCodecSettings {
114         /* Codec settings detailed for 2.5 implementation*/
115         int codecType; /* Types defined in quicktime_export.h */
116         int     codecSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
117
118         /* Settings not available in current QTKit API */
119         int     codec;
120         int     codecFlags;
121         int     colorDepth;
122         int     codecTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
123         int     minSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
124         int     minTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
125         int     keyFrameRate;
126         int     bitRate;        /* bitrate in bps */
127         
128         /* Audio Codec settings */
129         int audiocodecType;
130         int audioSampleRate;
131         short audioBitDepth;
132         short audioChannels;
133         int audioCodecFlags;
134         int audioBitRate;
135         int pad1;
136 } QuicktimeCodecSettings;
137
138 typedef struct FFMpegCodecData {
139         int type;
140         int codec;
141         int audio_codec;
142         int video_bitrate;
143         int audio_bitrate;
144         int audio_mixrate;
145         int audio_channels;
146         int audio_pad;
147         float audio_volume;
148         int gop_size;
149         int flags;
150
151         int rc_min_rate;
152         int rc_max_rate;
153         int rc_buffer_size;
154         int mux_packet_size;
155         int mux_rate;
156         IDProperty *properties;
157 } FFMpegCodecData;
158
159 /* ************************************************************* */
160 /* Audio */
161
162 typedef struct AudioData {
163         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
164         float main; // 2.5: now in FFMpegCodecData: audio_volume
165         float speed_of_sound;
166         float doppler_factor;
167         int distance_model;
168         short flag;
169         short pad;
170         float volume;
171         float pad2;
172 } AudioData;
173
174 /* *************************************************************** */
175 /* Render Layers */
176
177 /* Render Layer */
178 typedef struct SceneRenderLayer {
179         struct SceneRenderLayer *next, *prev;
180         
181         char name[64];  /* MAX_NAME */
182         
183         struct Material *mat_override;
184         struct Group *light_override;
185         
186         unsigned int lay;                 /* scene->lay itself has priority over this */
187         unsigned int lay_zmask;   /* has to be after lay, this is for Z-masking */
188         unsigned int lay_exclude; /* not used by internal, exclude */
189         int layflag;
190         
191         int passflag;                   /* pass_xor has to be after passflag */
192         int pass_xor;
193
194         int samples;
195         float pass_alpha_threshold;
196         
197         struct FreestyleConfig freestyleConfig;
198 } SceneRenderLayer;
199
200 /* srl->layflag */
201 #define SCE_LAY_SOLID   1
202 #define SCE_LAY_ZTRA    2
203 #define SCE_LAY_HALO    4
204 #define SCE_LAY_EDGE    8
205 #define SCE_LAY_SKY             16
206 #define SCE_LAY_STRAND  32
207 #define SCE_LAY_FRS             64
208 #define SCE_LAY_AO              128
209         /* flags between 256 and 0x8000 are set to 1 already, for future options */
210
211 #define SCE_LAY_ALL_Z           0x8000
212 #define SCE_LAY_XOR                     0x10000
213 #define SCE_LAY_DISABLE         0x20000
214 #define SCE_LAY_ZMASK           0x40000
215 #define SCE_LAY_NEG_ZMASK       0x80000
216
217 /* srl->passflag */
218 typedef enum ScenePassType {
219         SCE_PASS_COMBINED                 = (1 << 0),
220         SCE_PASS_Z                        = (1 << 1),
221         SCE_PASS_RGBA                     = (1 << 2),
222         SCE_PASS_DIFFUSE                  = (1 << 3),
223         SCE_PASS_SPEC                     = (1 << 4),
224         SCE_PASS_SHADOW                   = (1 << 5),
225         SCE_PASS_AO                       = (1 << 6),
226         SCE_PASS_REFLECT                  = (1 << 7),
227         SCE_PASS_NORMAL                   = (1 << 8),
228         SCE_PASS_VECTOR                   = (1 << 9),
229         SCE_PASS_REFRACT                  = (1 << 10),
230         SCE_PASS_INDEXOB                  = (1 << 11),
231         SCE_PASS_UV                       = (1 << 12),
232         SCE_PASS_INDIRECT                 = (1 << 13),
233         SCE_PASS_MIST                     = (1 << 14),
234         SCE_PASS_RAYHITS                  = (1 << 15),
235         SCE_PASS_EMIT                     = (1 << 16),
236         SCE_PASS_ENVIRONMENT              = (1 << 17),
237         SCE_PASS_INDEXMA                  = (1 << 18),
238         SCE_PASS_DIFFUSE_DIRECT           = (1 << 19),
239         SCE_PASS_DIFFUSE_INDIRECT         = (1 << 20),
240         SCE_PASS_DIFFUSE_COLOR            = (1 << 21),
241         SCE_PASS_GLOSSY_DIRECT            = (1 << 22),
242         SCE_PASS_GLOSSY_INDIRECT          = (1 << 23),
243         SCE_PASS_GLOSSY_COLOR             = (1 << 24),
244         SCE_PASS_TRANSM_DIRECT            = (1 << 25),
245         SCE_PASS_TRANSM_INDIRECT          = (1 << 26),
246         SCE_PASS_TRANSM_COLOR             = (1 << 27),
247         SCE_PASS_SUBSURFACE_DIRECT        = (1 << 28),
248         SCE_PASS_SUBSURFACE_INDIRECT      = (1 << 29),
249         SCE_PASS_SUBSURFACE_COLOR         = (1 << 30),
250         SCE_PASS_DEBUG                    = (1 << 31),  /* This is a virtual pass. */
251 } ScenePassType;
252
253 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
254
255 /* View - MultiView */
256 typedef struct SceneRenderView {
257         struct SceneRenderView *next, *prev;
258
259         char name[64];  /* MAX_NAME */
260         char suffix[64];        /* MAX_NAME */
261
262         int viewflag;
263         int pad[2];
264         char pad2[4];
265
266 } SceneRenderView;
267
268 /* srv->viewflag */
269 #define SCE_VIEW_DISABLE                (1<<0)
270
271 /* scene.render.views_format */
272 enum {
273         SCE_VIEWS_FORMAT_STEREO_3D = 0,
274         SCE_VIEWS_FORMAT_MULTIVIEW = 1,
275 };
276
277 /* ImageFormatData.views_output */
278 enum {
279         R_IMF_VIEWS_INDIVIDUAL = 0,
280         R_IMF_VIEWS_STEREO_3D  = 1,
281         R_IMF_VIEWS_MULTIVIEW  = 2,
282 };
283
284 typedef struct Stereo3dFormat {
285         short flag;
286         char display_mode; /* encoding mode */
287         char anaglyph_type; /* anaglyph scheme for the user display */
288         char interlace_type;  /* interlace type for the user display */
289         char pad[3];
290 } Stereo3dFormat;
291
292 /* Stereo3dFormat.display_mode */
293 typedef enum eStereoDisplayMode {
294         S3D_DISPLAY_ANAGLYPH    = 0,
295         S3D_DISPLAY_INTERLACE   = 1,
296         S3D_DISPLAY_PAGEFLIP    = 2,
297         S3D_DISPLAY_SIDEBYSIDE  = 3,
298         S3D_DISPLAY_TOPBOTTOM   = 4,
299 } eStereoDisplayMode;
300
301 /* Stereo3dFormat.flag */
302 typedef enum eStereo3dFlag {
303         S3D_INTERLACE_SWAP        = (1 << 0),
304         S3D_SIDEBYSIDE_CROSSEYED  = (1 << 1),
305         S3D_SQUEEZED_FRAME        = (1 << 2),
306 } eStereo3dFlag;
307
308 /* Stereo3dFormat.anaglyph_type */
309 typedef enum eStereo3dAnaglyphType {
310         S3D_ANAGLYPH_REDCYAN      = 0,
311         S3D_ANAGLYPH_GREENMAGENTA = 1,
312         S3D_ANAGLYPH_YELLOWBLUE   = 2,
313 } eStereo3dAnaglyphType;
314
315 /* Stereo3dFormat.interlace_type */
316 typedef enum eStereo3dInterlaceType {
317         S3D_INTERLACE_ROW          = 0,
318         S3D_INTERLACE_COLUMN       = 1,
319         S3D_INTERLACE_CHECKERBOARD = 2,
320 } eStereo3dInterlaceType;
321
322 /* *************************************************************** */
323
324 /* Generic image format settings,
325  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
326  *
327  * note: its a bit strange that even though this is an image format struct
328  *  the imtype can still be used to select video formats.
329  *  RNA ensures these enum's are only selectable for render output.
330  */
331 typedef struct ImageFormatData {
332         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
333                        /* note, video types should only ever be set from this
334                         * structure when used from RenderData */
335         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
336                         * not a flag, only set 1 at a time */
337
338         char planes;   /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
339         char flag;     /* generic options for all image types, alpha zbuffer */
340
341         char quality;  /* (0 - 100), eg: jpeg quality */
342         char compress; /* (0 - 100), eg: png compression */
343
344
345         /* --- format specific --- */
346
347         /* OpenEXR */
348         char  exr_codec;
349
350         /* Cineon */
351         char  cineon_flag;
352         short cineon_white, cineon_black;
353         float cineon_gamma;
354
355         /* Jpeg2000 */
356         char  jp2_flag;
357         char jp2_codec;
358
359         /* TIFF */
360         char tiff_codec;
361
362         char pad[4];
363
364         /* Multiview */
365         char views_format;
366         Stereo3dFormat stereo3d_format;
367
368         /* color management */
369         ColorManagedViewSettings view_settings;
370         ColorManagedDisplaySettings display_settings;
371 } ImageFormatData;
372
373
374 /* ImageFormatData.imtype */
375 #define R_IMF_IMTYPE_TARGA           0
376 #define R_IMF_IMTYPE_IRIS            1
377 /* #define R_HAMX                    2 */ /* hamx is nomore */
378 /* #define R_FTYPE                   3 */ /* ftype is nomore */
379 #define R_IMF_IMTYPE_JPEG90          4
380 /* #define R_MOVIE                   5 */ /* movie is nomore */
381 #define R_IMF_IMTYPE_IRIZ            7
382 #define R_IMF_IMTYPE_RAWTGA         14
383 #define R_IMF_IMTYPE_AVIRAW         15
384 #define R_IMF_IMTYPE_AVIJPEG        16
385 #define R_IMF_IMTYPE_PNG            17
386 /* #define R_IMF_IMTYPE_AVICODEC    18 */ /* avicodec is nomore */
387 #define R_IMF_IMTYPE_QUICKTIME      19
388 #define R_IMF_IMTYPE_BMP            20
389 #define R_IMF_IMTYPE_RADHDR         21
390 #define R_IMF_IMTYPE_TIFF           22
391 #define R_IMF_IMTYPE_OPENEXR        23
392 #define R_IMF_IMTYPE_FFMPEG         24
393 #define R_IMF_IMTYPE_FRAMESERVER    25
394 #define R_IMF_IMTYPE_CINEON         26
395 #define R_IMF_IMTYPE_DPX            27
396 #define R_IMF_IMTYPE_MULTILAYER     28
397 #define R_IMF_IMTYPE_DDS            29
398 #define R_IMF_IMTYPE_JP2            30
399 #define R_IMF_IMTYPE_H264           31
400 #define R_IMF_IMTYPE_XVID           32
401 #define R_IMF_IMTYPE_THEORA         33
402 #define R_IMF_IMTYPE_PSD            34
403
404 #define R_IMF_IMTYPE_INVALID        255
405
406 /* ImageFormatData.flag */
407 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
408 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
409
410 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
411 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
412 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
413 #define R_IMF_CHAN_DEPTH_10 (1<<2) /* 10bits (uncommon, Cineon/DPX support) */
414 #define R_IMF_CHAN_DEPTH_12 (1<<3) /* 12bits (uncommon, jp2/DPX support) */
415 #define R_IMF_CHAN_DEPTH_16 (1<<4) /* 16bits (tiff, halff float exr) */
416 #define R_IMF_CHAN_DEPTH_24 (1<<5) /* 24bits (unused) */
417 #define R_IMF_CHAN_DEPTH_32 (1<<6) /* 32bits (full float exr) */
418
419 /* ImageFormatData.planes */
420 #define R_IMF_PLANES_RGB   24
421 #define R_IMF_PLANES_RGBA  32
422 #define R_IMF_PLANES_BW    8
423
424 /* ImageFormatData.exr_codec */
425 #define R_IMF_EXR_CODEC_NONE  0
426 #define R_IMF_EXR_CODEC_PXR24 1
427 #define R_IMF_EXR_CODEC_ZIP   2
428 #define R_IMF_EXR_CODEC_PIZ   3
429 #define R_IMF_EXR_CODEC_RLE   4
430 #define R_IMF_EXR_CODEC_ZIPS  5
431 #define R_IMF_EXR_CODEC_B44   6
432 #define R_IMF_EXR_CODEC_B44A  7
433 #define R_IMF_EXR_CODEC_DWAA  8
434 #define R_IMF_EXR_CODEC_DWAB  9
435 #define R_IMF_EXR_CODEC_MAX  10
436
437 /* ImageFormatData.jp2_flag */
438 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
439 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
440 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
441
442 /* ImageFormatData.jp2_codec */
443 #define R_IMF_JP2_CODEC_JP2  0
444 #define R_IMF_JP2_CODEC_J2K  1
445
446 /* ImageFormatData.cineon_flag */
447 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
448
449 /* ImageFormatData.tiff_codec */
450 enum {
451         R_IMF_TIFF_CODEC_DEFLATE   = 0,
452         R_IMF_TIFF_CODEC_LZW       = 1,
453         R_IMF_TIFF_CODEC_PACKBITS  = 2,
454         R_IMF_TIFF_CODEC_NONE      = 3,
455 };
456
457 typedef struct BakeData {
458         struct ImageFormatData im_format;
459
460         char filepath[1024]; /* FILE_MAX */
461
462         short width, height;
463         short margin, flag;
464
465         float cage_extrusion;
466         int pass_filter;
467
468         char normal_swizzle[3];
469         char normal_space;
470
471         char save_mode;
472         char pad[3];
473
474         char cage[64];  /* MAX_NAME */
475 } BakeData;
476
477 /* (char) normal_swizzle */
478 typedef enum BakeNormalSwizzle {
479         R_BAKE_POSX = 0,
480         R_BAKE_POSY = 1,
481         R_BAKE_POSZ = 2,
482         R_BAKE_NEGX = 3,
483         R_BAKE_NEGY = 4,
484         R_BAKE_NEGZ = 5,
485 } BakeNormalSwizzle;
486
487 /* (char) save_mode */
488 typedef enum BakeSaveMode {
489         R_BAKE_SAVE_INTERNAL = 0,
490         R_BAKE_SAVE_EXTERNAL = 1,
491 } BakeSaveMode;
492
493 /* bake->pass_filter */
494 typedef enum BakePassFilter {
495         R_BAKE_PASS_FILTER_NONE           = 0,
496         R_BAKE_PASS_FILTER_AO             = (1 << 0),
497         R_BAKE_PASS_FILTER_EMIT           = (1 << 1),
498         R_BAKE_PASS_FILTER_DIFFUSE        = (1 << 2),
499         R_BAKE_PASS_FILTER_GLOSSY         = (1 << 3),
500         R_BAKE_PASS_FILTER_TRANSM         = (1 << 4),
501         R_BAKE_PASS_FILTER_SUBSURFACE     = (1 << 5),
502         R_BAKE_PASS_FILTER_DIRECT         = (1 << 6),
503         R_BAKE_PASS_FILTER_INDIRECT       = (1 << 7),
504         R_BAKE_PASS_FILTER_COLOR          = (1 << 8),
505 } BakePassFilter;
506
507 #define R_BAKE_PASS_FILTER_ALL (~0)
508
509 /* *************************************************************** */
510 /* Render Data */
511
512 typedef struct RenderData {
513         struct ImageFormatData im_format;
514         
515         struct AviCodecData *avicodecdata;
516         struct QuicktimeCodecData *qtcodecdata;
517         struct QuicktimeCodecSettings qtcodecsettings;
518         struct FFMpegCodecData ffcodecdata;
519
520         int cfra, sfra, efra;   /* frames as in 'images' */
521         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
522         int psfra, pefra;               /* start+end frames of preview range */
523
524         int images, framapto;
525         short flag, threads;
526
527         float framelen, blurfac;
528
529         /** For UR edge rendering: give the edges this color */
530         float edgeR, edgeG, edgeB;
531
532
533         /* standalone player */  //  XXX deprecated since 2.5
534         short fullscreen  DNA_DEPRECATED, xplay  DNA_DEPRECATED, yplay  DNA_DEPRECATED;
535         short freqplay  DNA_DEPRECATED;
536         /* standalone player */  //  XXX deprecated since 2.5
537         short depth  DNA_DEPRECATED, attrib  DNA_DEPRECATED;
538
539
540         int frame_step;         /* frames to jump during render/playback */
541
542         short stereomode  DNA_DEPRECATED;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
543         
544         short dimensionspreset;         /* for the dimensions presets menu */
545
546         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
547
548         short size; /* size in % */
549         
550         short maximsize DNA_DEPRECATED; /* max in Kb */
551
552         short pad6;
553
554         /* from buttons: */
555         /**
556          * The desired number of pixels in the x direction
557          */
558         int xsch;
559         /**
560          * The desired number of pixels in the y direction
561          */
562         int ysch;
563
564         /**
565          * The number of part to use in the x direction
566          */
567         short xparts DNA_DEPRECATED;
568         /**
569          * The number of part to use in the y direction
570          */
571         short yparts DNA_DEPRECATED;
572
573         /**
574          * render tile dimensions
575          */
576         int tilex, tiley;
577
578         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
579         
580         /**
581          * Render to image editor, fullscreen or to new window.
582          */
583         short displaymode;
584         char use_lock_interface;
585         char pad7;
586
587         /**
588          * Flags for render settings. Use bit-masking to access the settings.
589          */
590         int scemode;
591
592         /**
593          * Flags for render settings. Use bit-masking to access the settings.
594          */
595         int mode;
596
597         /**
598          * Flags for raytrace settings. Use bit-masking to access the settings.
599          */
600         int raytrace_options;
601         
602         /**
603          * Raytrace acceleration structure
604          */
605         short raytrace_structure;
606
607         short pad1;
608
609         /* octree resolution */
610         short ocres;
611         short pad4;
612         
613         /**
614          * What to do with the sky/background. Picks sky/premul/key
615          * blending for the background
616          */
617         short alphamode;
618
619         /**
620          * The number of samples to use per pixel.
621          */
622         short osa;
623
624         short frs_sec, edgeint;
625
626         
627         /* safety, border and display rect */
628         rctf safety, border;
629         rcti disprect;
630         
631         /* information on different layers to be rendered */
632         ListBase layers;
633         short actlay;
634         
635         /* number of mblur samples */
636         short mblur_samples;
637         
638         /**
639          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
640          */
641         float xasp, yasp;
642
643         float frs_sec_base;
644         
645         /**
646          * Value used to define filter size for all filter options  */
647         float gauss;
648         
649         
650         /* color management settings - color profiles, gamma correction, etc */
651         int color_mgt_flag;
652         
653         /** post-production settings. deprecated, but here for upwards compat (initialized to 1) */
654         float postgamma, posthue, postsat;
655         
656          /* Dither noise intensity */
657         float dither_intensity;
658         
659         /* Bake Render options */
660         short bake_osa, bake_filter, bake_mode, bake_flag;
661         short bake_normal_space, bake_quad_split;
662         float bake_maxdist, bake_biasdist;
663         short bake_samples, bake_pad;
664         float bake_user_scale, bake_pad1;
665
666         /* path to render output */
667         char pic[1024]; /* 1024 = FILE_MAX */
668
669         /* stamps flags. */
670         int stamp;
671         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
672
673         /* stamp info user data. */
674         char stamp_udata[768];
675
676         /* foreground/background color. */
677         float fg_stamp[4];
678         float bg_stamp[4];
679
680         /* sequencer options */
681         char seq_prev_type;
682         char seq_rend_type;
683         char seq_flag; /* flag use for sequence render/draw */
684         char pad5[5];
685
686         /* render simplify */
687         int simplify_flag;
688         short simplify_subsurf;
689         short simplify_subsurf_render;
690         short simplify_shadowsamples, pad9;
691         float simplify_particles;
692         float simplify_particles_render;
693         float simplify_aosss;
694
695         /* cineon */
696         short cineonwhite  DNA_DEPRECATED, cineonblack  DNA_DEPRECATED;  /*deprecated*/
697         float cineongamma  DNA_DEPRECATED;  /*deprecated*/
698         
699         /* jpeg2000 */
700         short jp2_preset  DNA_DEPRECATED, jp2_depth  DNA_DEPRECATED;  /*deprecated*/
701         int rpad3;
702
703         /* Dome variables */ //  XXX deprecated since 2.5
704         short domeres  DNA_DEPRECATED, domemode  DNA_DEPRECATED;        //  XXX deprecated since 2.5
705         short domeangle  DNA_DEPRECATED, dometilt  DNA_DEPRECATED;      //  XXX deprecated since 2.5
706         float domeresbuf  DNA_DEPRECATED;       //  XXX deprecated since 2.5
707         float pad2;
708         struct Text *dometext  DNA_DEPRECATED;  //  XXX deprecated since 2.5
709
710         /* Freestyle line thickness options */
711         int line_thickness_mode;
712         float unit_line_thickness; /* in pixels */
713
714         /* render engine */
715         char engine[32];
716
717         /* Cycles baking */
718         struct BakeData bake;
719
720         int preview_start_resolution;
721
722         /* Type of the debug pass to use.
723          * Only used when built with debug passes support.
724          */
725         short debug_pass_type;
726
727         short pad;
728
729         /* MultiView */
730         ListBase views;  /* SceneRenderView */
731         short actview;
732         short views_format;
733         short pad8[2];
734
735         /* Motion blur shutter */
736         struct CurveMapping mblur_shutter_curve;
737 } RenderData;
738
739 /* *************************************************************** */
740 /* Render Conversion/Simplfication Settings */
741
742 /* control render convert and shading engine */
743 typedef struct RenderProfile {
744         struct RenderProfile *next, *prev;
745         char name[32];
746         
747         short particle_perc;
748         short subsurf_max;
749         short shadbufsample_max;
750         short pad1;
751         
752         float ao_error, pad2;
753         
754 } RenderProfile;
755
756 /* *************************************************************** */
757 /* Game Engine - Dome */
758
759 typedef struct GameDome {
760         short res, mode;
761         short angle, tilt;
762         float resbuf, pad2;
763         struct Text *warptext;
764 } GameDome;
765
766 #define DOME_FISHEYE                    1
767 #define DOME_TRUNCATED_FRONT    2
768 #define DOME_TRUNCATED_REAR             3
769 #define DOME_ENVMAP                             4
770 #define DOME_PANORAM_SPH                5
771 #define DOME_NUM_MODES                  6
772
773 /* *************************************************************** */
774 /* Game Engine */
775
776 typedef struct GameFraming {
777         float col[3];
778         char type, pad1, pad2, pad3;
779 } GameFraming;
780
781 #define SCE_GAMEFRAMING_BARS   0
782 #define SCE_GAMEFRAMING_EXTEND 1
783 #define SCE_GAMEFRAMING_SCALE  2
784
785 typedef struct RecastData {
786         float cellsize;
787         float cellheight;
788         float agentmaxslope;
789         float agentmaxclimb;
790         float agentheight;
791         float agentradius;
792         float edgemaxlen;
793         float edgemaxerror;
794         float regionminsize;
795         float regionmergesize;
796         int vertsperpoly;
797         float detailsampledist;
798         float detailsamplemaxerror;
799         char partitioning;
800         char pad1;
801         short pad2;
802 } RecastData;
803
804 #define RC_PARTITION_WATERSHED 0
805 #define RC_PARTITION_MONOTONE 1
806 #define RC_PARTITION_LAYERS 2
807
808 typedef struct GameData {
809
810         /* standalone player */
811         struct GameFraming framing;
812         short playerflag, xplay, yplay, freqplay;
813         short depth, attrib, rt1, rt2;
814         short aasamples, pad4[3];
815
816         /* stereo/dome mode */
817         struct GameDome dome;
818         short stereoflag, stereomode;
819         float eyeseparation;
820         RecastData recastData;
821
822
823         /* physics (it was in world)*/
824         float gravity; /*Gravitation constant for the game world*/
825
826         /*
827          * Radius of the activity bubble, in Manhattan length. Objects
828          * outside the box are activity-culled. */
829         float activityBoxRadius;
830
831         /*
832          * bit 3: (gameengine): Activity culling is enabled.
833          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustum culling
834          */
835         int flag;
836         short mode, matmode;
837         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
838         short physicsEngine;
839         short exitkey;
840         short vsync; /* Controls vsync: off, on, or adaptive (if supported) */
841         short ticrate, maxlogicstep, physubstep, maxphystep;
842         short obstacleSimulation;
843         short raster_storage;
844         float levelHeight;
845         float deactivationtime, lineardeactthreshold, angulardeactthreshold;
846
847         /* Scene LoD */
848         short lodflag, pad2;
849         int scehysteresis, pad5;
850
851 } GameData;
852
853 #define STEREO_NOSTEREO         1
854 #define STEREO_ENABLED          2
855 #define STEREO_DOME                     3
856
857 //#define STEREO_NOSTEREO                1
858 #define STEREO_QUADBUFFERED 2
859 #define STEREO_ABOVEBELOW        3
860 #define STEREO_INTERLACED        4
861 #define STEREO_ANAGLYPH         5
862 #define STEREO_SIDEBYSIDE       6
863 #define STEREO_VINTERLACE       7
864 //#define STEREO_DOME           8
865 #define STEREO_3DTVTOPBOTTOM 9
866
867 /* physicsEngine */
868 #define WOPHY_NONE              0
869 #define WOPHY_BULLET    5
870
871 /* obstacleSimulation */
872 #define OBSTSIMULATION_NONE             0
873 #define OBSTSIMULATION_TOI_rays         1
874 #define OBSTSIMULATION_TOI_cells        2
875
876 /* Raster storage */
877 #define RAS_STORE_AUTO          0
878 #define RAS_STORE_IMMEDIATE     1
879 #define RAS_STORE_VA            2
880 #define RAS_STORE_VBO           3
881
882 /* vsync */
883 #define VSYNC_ON        0
884 #define VSYNC_OFF       1
885 #define VSYNC_ADAPTIVE  2
886
887 /* GameData.flag */
888 #define GAME_RESTRICT_ANIM_UPDATES                      (1 << 0)
889 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
890 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
891 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
892 #define GAME_SHOW_PHYSICS                                       (1 << 4)
893 #define GAME_DISPLAY_LISTS                                      (1 << 5)
894 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
895 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
896 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
897 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
898 #define GAME_GLSL_NO_NODES                                      (1 << 10)
899 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
900 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
901 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
902 #define GAME_SHOW_MOUSE                                         (1 << 14)
903 #define GAME_GLSL_NO_COLOR_MANAGEMENT           (1 << 15)
904 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 16)
905 #define GAME_NO_MATERIAL_CACHING                        (1 << 17)
906 #define GAME_GLSL_NO_ENV_LIGHTING                       (1 << 18)
907 /* Note: GameData.flag is now an int (max 32 flags). A short could only take 16 flags */
908
909 /* GameData.playerflag */
910 #define GAME_PLAYER_FULLSCREEN                          (1 << 0)
911 #define GAME_PLAYER_DESKTOP_RESOLUTION          (1 << 1)
912
913 /* GameData.matmode */
914 enum {
915 #ifdef DNA_DEPRECATED
916         GAME_MAT_TEXFACE    = 0, /* deprecated */
917 #endif
918         GAME_MAT_MULTITEX   = 1,
919         GAME_MAT_GLSL       = 2,
920 };
921
922 /* GameData.lodflag */
923 #define SCE_LOD_USE_HYST                (1 << 0)
924
925 /* UV Paint */
926 #define UV_SCULPT_LOCK_BORDERS                          1
927 #define UV_SCULPT_ALL_ISLANDS                           2
928
929 #define UV_SCULPT_TOOL_PINCH                            1
930 #define UV_SCULPT_TOOL_RELAX                            2
931 #define UV_SCULPT_TOOL_GRAB                                     3
932
933 #define UV_SCULPT_TOOL_RELAX_LAPLACIAN  1
934 #define UV_SCULPT_TOOL_RELAX_HC                 2
935
936 /* Stereo Flags */
937 #define STEREO_RIGHT_NAME "right"
938 #define STEREO_LEFT_NAME "left"
939 #define STEREO_RIGHT_SUFFIX "_R"
940 #define STEREO_LEFT_SUFFIX "_L"
941
942 typedef enum StereoViews {
943         STEREO_LEFT_ID = 0,
944         STEREO_RIGHT_ID = 1,
945         STEREO_3D_ID = 2,
946         STEREO_MONO_ID = 3,
947 } StereoViews;
948
949 /* *************************************************************** */
950 /* Markers */
951
952 typedef struct TimeMarker {     
953         struct TimeMarker *next, *prev;
954         int frame;
955         char name[64];
956         unsigned int flag;
957         struct Object *camera;
958 } TimeMarker;
959
960 /* *************************************************************** */
961 /* Paint Mode/Tool Data */
962
963 #define PAINT_MAX_INPUT_SAMPLES 64
964
965 /* Paint Tool Base */
966 typedef struct Paint {
967         struct Brush *brush;
968         struct Palette *palette;
969         struct CurveMapping *cavity_curve; /* cavity curve */
970
971         /* WM Paint cursor */
972         void *paint_cursor;
973         unsigned char paint_cursor_col[4];
974
975         /* enum PaintFlags */
976         int flags;
977
978         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to
979          * smooth the stroke */
980         int num_input_samples;
981         
982         /* flags used for symmetry */
983         int symmetry_flags;
984
985         float tile_offset[3];
986         int pad2;
987 } Paint;
988
989 /* ------------------------------------------- */
990 /* Image Paint */
991
992 /* Texture/Image Editor */
993 typedef struct ImagePaintSettings {
994         Paint paint;
995
996         short flag, missing_data;
997         
998         /* for projection painting only */
999         short seam_bleed, normal_angle;
1000         short screen_grab_size[2]; /* capture size for re-projection */
1001
1002         int mode;                  /* mode used for texture painting */
1003
1004         void *paintcursor;                 /* wm handle */
1005         struct Image *stencil;     /* workaround until we support true layer masks */
1006         struct Image *clone;       /* clone layer for image mode for projective texture painting */
1007         struct Image *canvas;      /* canvas when the explicit system is used for painting */
1008         float stencil_col[3];
1009         float dither;              /* dither amount used when painting on byte images */
1010 } ImagePaintSettings;
1011
1012 /* ------------------------------------------- */
1013 /* Particle Edit */
1014
1015 /* Settings for a Particle Editing Brush */
1016 typedef struct ParticleBrushData {
1017         short size;                                             /* common setting */
1018         short step, invert, count;              /* for specific brushes only */
1019         int flag;
1020         float strength;
1021 } ParticleBrushData;
1022
1023 /* Particle Edit Mode Settings */
1024 typedef struct ParticleEditSettings {
1025         short flag;
1026         short totrekey;
1027         short totaddkey;
1028         short brushtype;
1029
1030         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
1031         void *paintcursor;                      /* runtime */
1032
1033         float emitterdist, rt;
1034
1035         int selectmode;
1036         int edittype;
1037
1038         int draw_step, fade_frames;
1039
1040         struct Scene *scene;
1041         struct Object *object;
1042         struct Object *shape_object;
1043 } ParticleEditSettings;
1044
1045 /* ------------------------------------------- */
1046 /* Sculpt */
1047
1048 /* Sculpt */
1049 typedef struct Sculpt {
1050         Paint paint;
1051
1052         /* For rotating around a pivot point */
1053         //float pivot[3]; XXX not used?
1054         int flags;
1055
1056         /* Control tablet input */
1057         //char tablet_size, tablet_strength; XXX not used?
1058         int radial_symm[3];
1059
1060         /* Maximum edge length for dynamic topology sculpting (in pixels) */
1061         float detail_size;
1062
1063         /* Direction used for SCULPT_OT_symmetrize operator */
1064         int symmetrize_direction;
1065
1066         /* gravity factor for sculpting */
1067         float gravity_factor;
1068
1069         /* scale for constant detail size */
1070         float constant_detail;
1071         float detail_percent;
1072         float pad;
1073
1074         struct Object *gravity_object;
1075 } Sculpt;
1076
1077 typedef struct UvSculpt {
1078         Paint paint;
1079 } UvSculpt;
1080
1081 /* ------------------------------------------- */
1082 /* Vertex Paint */
1083
1084 /* Vertex Paint */
1085 typedef struct VPaint {
1086         Paint paint;
1087
1088         short flag, pad;
1089         int tot;                                                        /* allocation size of prev buffers */
1090         unsigned int *vpaint_prev;                      /* previous mesh colors */
1091         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
1092         
1093         void *paintcursor;                                      /* wm handle */
1094 } VPaint;
1095
1096 /* VPaint.flag */
1097 enum {
1098         // VP_COLINDEX  = (1 << 0),  /* only paint onto active material*/  /* deprecated since before 2.49 */
1099         // VP_AREA      = (1 << 1),  /* deprecated since 2.70 */
1100         VP_NORMALS      = (1 << 3),
1101         VP_SPRAY        = (1 << 4),
1102         // VP_MIRROR_X  = (1 << 5),  /* deprecated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X) */
1103         VP_ONLYVGROUP   = (1 << 7)   /* weight paint only */
1104 };
1105
1106 /* ------------------------------------------- */
1107 /* GPencil Stroke Sculpting */
1108
1109 /* Brush types */
1110 typedef enum eGP_EditBrush_Types {
1111         GP_EDITBRUSH_TYPE_SMOOTH    = 0,
1112         GP_EDITBRUSH_TYPE_THICKNESS = 1,
1113         GP_EDITBRUSH_TYPE_GRAB      = 2,
1114         GP_EDITBRUSH_TYPE_PUSH      = 3,
1115         GP_EDITBRUSH_TYPE_TWIST     = 4,
1116         GP_EDITBRUSH_TYPE_PINCH     = 5,
1117         GP_EDITBRUSH_TYPE_RANDOMIZE = 6,
1118         GP_EDITBRUSH_TYPE_SUBDIVIDE = 7,
1119         GP_EDITBRUSH_TYPE_SIMPLIFY  = 8,
1120         GP_EDITBRUSH_TYPE_CLONE     = 9,
1121         GP_EDITBRUSH_TYPE_STRENGTH  = 10,
1122
1123         /* !!! Update GP_EditBrush_Data brush[###]; below !!! */
1124         TOT_GP_EDITBRUSH_TYPES
1125 } eGP_EditBrush_Types;
1126
1127 /* Settings for a GPencil Stroke Sculpting Brush */
1128 typedef struct GP_EditBrush_Data {
1129         short size;             /* radius of brush */
1130         short flag;             /* eGP_EditBrush_Flag */
1131         float strength;         /* strength of effect */
1132 } GP_EditBrush_Data;
1133
1134 /* GP_EditBrush_Data.flag */
1135 typedef enum eGP_EditBrush_Flag {
1136         /* invert the effect of the brush */
1137         GP_EDITBRUSH_FLAG_INVERT       = (1 << 0),
1138         /* adjust strength using pen pressure */
1139         GP_EDITBRUSH_FLAG_USE_PRESSURE = (1 << 1),
1140         
1141         /* strength of brush falls off with distance from cursor */
1142         GP_EDITBRUSH_FLAG_USE_FALLOFF  = (1 << 2),
1143         
1144         /* smooth brush affects pressure values as well */
1145         GP_EDITBRUSH_FLAG_SMOOTH_PRESSURE  = (1 << 3)
1146 } eGP_EditBrush_Flag;
1147
1148
1149
1150 /* GPencil Stroke Sculpting Settings */
1151 typedef struct GP_BrushEdit_Settings {
1152         GP_EditBrush_Data brush[11];  /* TOT_GP_EDITBRUSH_TYPES */
1153         void *paintcursor;            /* runtime */
1154         
1155         int brushtype;                /* eGP_EditBrush_Types */
1156         int flag;                     /* eGP_BrushEdit_SettingsFlag */
1157         char pad[4];
1158         float alpha;                  /* alpha factor for selection color */
1159 } GP_BrushEdit_Settings;
1160
1161 /* GP_BrushEdit_Settings.flag */
1162 typedef enum eGP_BrushEdit_SettingsFlag {
1163         /* only affect selected points */
1164         GP_BRUSHEDIT_FLAG_SELECT_MASK = (1 << 0),
1165         /* apply brush to position */
1166         GP_BRUSHEDIT_FLAG_APPLY_POSITION = (1 << 1),
1167         /* apply brush to strength */
1168         GP_BRUSHEDIT_FLAG_APPLY_STRENGTH = (1 << 2),
1169         /* apply brush to thickness */
1170         GP_BRUSHEDIT_FLAG_APPLY_THICKNESS = (1 << 3),
1171         /* apply interpolation to all layers */
1172         GP_BRUSHEDIT_FLAG_INTERPOLATE_ALL_LAYERS = (1 << 4),
1173         /* apply interpolation to only selected */
1174         GP_BRUSHEDIT_FLAG_INTERPOLATE_ONLY_SELECTED = (1 << 5)
1175
1176 } eGP_BrushEdit_SettingsFlag;
1177
1178 /* *************************************************************** */
1179 /* Transform Orientations */
1180
1181 typedef struct TransformOrientation {
1182         struct TransformOrientation *next, *prev;
1183         char name[64];  /* MAX_NAME */
1184         float mat[3][3];
1185         int pad;
1186 } TransformOrientation;
1187
1188 /* *************************************************************** */
1189 /* Unified Paint Settings
1190  */
1191
1192 /* These settings can override the equivalent fields in the active
1193  * Brush for any paint mode; the flag field controls whether these
1194  * values are used */
1195 typedef struct UnifiedPaintSettings {
1196         /* unified radius of brush in pixels */
1197         int size;
1198
1199         /* unified radius of brush in Blender units */
1200         float unprojected_radius;
1201
1202         /* unified strength of brush */
1203         float alpha;
1204
1205         /* unified brush weight, [0, 1] */
1206         float weight;
1207
1208         /* unified brush color */
1209         float rgb[3];
1210         /* unified brush secondary color */
1211         float secondary_rgb[3];
1212
1213         /* user preferences for sculpt and paint */
1214         int flag;
1215
1216         /* rake rotation */
1217
1218         /* record movement of mouse so that rake can start at an intuitive angle */
1219         float last_rake[2];
1220         float last_rake_angle;
1221         
1222         int last_stroke_valid;
1223         float average_stroke_accum[3];
1224         int average_stroke_counter;
1225         
1226
1227         float brush_rotation;
1228         float brush_rotation_sec;
1229
1230         /*********************************************************************************
1231          *  all data below are used to communicate with cursor drawing and tex sampling  *
1232          *********************************************************************************/
1233         int anchored_size;
1234
1235         float overlap_factor; /* normalization factor due to accumulated value of curve along spacing.
1236                                * Calculated when brush spacing changes to dampen strength of stroke
1237                                * if space attenuation is used*/
1238         char draw_inverted;
1239         /* check is there an ongoing stroke right now */
1240         char stroke_active;
1241
1242         char draw_anchored;
1243         char do_linear_conversion;
1244
1245         /* store last location of stroke or whether the mesh was hit. Valid only while stroke is active */
1246         float last_location[3];
1247         int last_hit;
1248
1249         float anchored_initial_mouse[2];
1250
1251         /* radius of brush, premultiplied with pressure.
1252          * In case of anchored brushes contains the anchored radius */
1253         float pixel_radius;
1254
1255         /* drawing pressure */
1256         float size_pressure_value;
1257
1258         /* position of mouse, used to sample the texture */
1259         float tex_mouse[2];
1260
1261         /* position of mouse, used to sample the mask texture */
1262         float mask_tex_mouse[2];
1263
1264         /* ColorSpace cache to avoid locking up during sampling */
1265         struct ColorSpace *colorspace;
1266 } UnifiedPaintSettings;
1267
1268 typedef enum {
1269         UNIFIED_PAINT_SIZE  = (1 << 0),
1270         UNIFIED_PAINT_ALPHA = (1 << 1),
1271         UNIFIED_PAINT_WEIGHT = (1 << 5),
1272         UNIFIED_PAINT_COLOR = (1 << 6),
1273
1274         /* only used if unified size is enabled, mirrors the brush flags
1275          * BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
1276         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1 << 2),
1277         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1 << 3),
1278
1279         /* only used if unified alpha is enabled, mirrors the brush flag
1280          * BRUSH_ALPHA_PRESSURE */
1281         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1 << 4)
1282 } UnifiedPaintSettingsFlags;
1283
1284
1285 typedef struct CurvePaintSettings {
1286         char curve_type;
1287         char flag;
1288         char depth_mode;
1289         char surface_plane;
1290         char fit_method;
1291         char pad;
1292         short error_threshold;
1293         float radius_min, radius_max;
1294         float radius_taper_start, radius_taper_end;
1295         float surface_offset;
1296         float corner_angle;
1297 } CurvePaintSettings;
1298
1299 /* CurvePaintSettings.flag */
1300 enum {
1301         CURVE_PAINT_FLAG_CORNERS_DETECT             = (1 << 0),
1302         CURVE_PAINT_FLAG_PRESSURE_RADIUS            = (1 << 1),
1303         CURVE_PAINT_FLAG_DEPTH_STROKE_ENDPOINTS     = (1 << 2),
1304         CURVE_PAINT_FLAG_DEPTH_STROKE_OFFSET_ABS    = (1 << 3),
1305 };
1306
1307 /* CurvePaintSettings.fit_method */
1308 enum {
1309         CURVE_PAINT_FIT_METHOD_REFIT            = 0,
1310         CURVE_PAINT_FIT_METHOD_SPLIT            = 1,
1311 };
1312
1313 /* CurvePaintSettings.depth_mode */
1314 enum {
1315         CURVE_PAINT_PROJECT_CURSOR              = 0,
1316         CURVE_PAINT_PROJECT_SURFACE             = 1,
1317 };
1318
1319 /* CurvePaintSettings.surface_plane */
1320 enum {
1321         CURVE_PAINT_SURFACE_PLANE_NORMAL_VIEW           = 0,
1322         CURVE_PAINT_SURFACE_PLANE_NORMAL_SURFACE        = 1,
1323         CURVE_PAINT_SURFACE_PLANE_VIEW                  = 2,
1324 };
1325
1326
1327 /* *************************************************************** */
1328 /* Stats */
1329
1330 /* Stats for Meshes */
1331 typedef struct MeshStatVis {
1332         char type;
1333         char _pad1[2];
1334
1335         /* overhang */
1336         char  overhang_axis;
1337         float overhang_min, overhang_max;
1338
1339         /* thickness */
1340         float thickness_min, thickness_max;
1341         char thickness_samples;
1342         char _pad2[3];
1343
1344         /* distort */
1345         float distort_min, distort_max;
1346
1347         /* sharp */
1348         float sharp_min, sharp_max;
1349 } MeshStatVis;
1350
1351
1352 /* *************************************************************** */
1353 /* Tool Settings */
1354
1355 typedef struct ToolSettings {
1356         VPaint *vpaint;         /* vertex paint */
1357         VPaint *wpaint;         /* weight paint */
1358         Sculpt *sculpt;
1359         UvSculpt *uvsculpt;     /* uv smooth */
1360         
1361         /* Vertex group weight - used only for editmode, not weight
1362          * paint */
1363         float vgroup_weight;
1364
1365         float doublimit;        /* remove doubles limit */
1366         float normalsize;       /* size of normals */
1367         short automerge;
1368
1369         /* Selection Mode for Mesh */
1370         short selectmode;
1371
1372         /* UV Calculation */
1373         char unwrapper;
1374         char uvcalc_flag;
1375         char uv_flag;
1376         char uv_selectmode;
1377
1378         float uvcalc_margin;
1379
1380         /* Auto-IK */
1381         short autoik_chainlen;  /* runtime only */
1382
1383         /* Grease Pencil */
1384         char gpencil_flags;             /* flags/options for how the tool works */
1385         char gpencil_src;               /* for main 3D view Grease Pencil, where data comes from */
1386
1387         char gpencil_v3d_align; /* stroke placement settings: 3D View */
1388         char gpencil_v2d_align; /*                          : General 2D Editor */
1389         char gpencil_seq_align; /*                          : Sequencer Preview */
1390         char gpencil_ima_align; /*                          : Image Editor */
1391         
1392         /* Grease Pencil Sculpt */
1393         struct GP_BrushEdit_Settings gp_sculpt;
1394
1395         /* Grease Pencil Drawing Brushes (bGPDbrush) */
1396         ListBase gp_brushes; 
1397
1398         /* Image Paint (8 byttse aligned please!) */
1399         struct ImagePaintSettings imapaint;
1400
1401         /* Particle Editing */
1402         struct ParticleEditSettings particle;
1403         
1404         /* Transform Proportional Area of Effect */
1405         float proportional_size;
1406
1407         /* Select Group Threshold */
1408         float select_thresh;
1409
1410         /* Auto-Keying Mode */
1411         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
1412         char keyframe_type;                 /* keyframe type (see DNA_curve_types.h) */
1413
1414         /* Multires */
1415         char multires_subdiv_type;
1416
1417         /* Skeleton generation */
1418         short skgen_resolution;
1419         float skgen_threshold_internal;
1420         float skgen_threshold_external;
1421         float skgen_length_ratio;
1422         float skgen_length_limit;
1423         float skgen_angle_limit;
1424         float skgen_correlation_limit;
1425         float skgen_symmetry_limit;
1426         float skgen_retarget_angle_weight;
1427         float skgen_retarget_length_weight;
1428         float skgen_retarget_distance_weight;
1429         short skgen_options;
1430         char  skgen_postpro;
1431         char  skgen_postpro_passes;
1432         char  skgen_subdivisions[3];
1433         char  skgen_multi_level;
1434
1435         /* Skeleton Sketching */
1436         struct Object *skgen_template;
1437         char bone_sketching;
1438         char bone_sketching_convert;
1439         char skgen_subdivision_number;
1440         char skgen_retarget_options;
1441         char skgen_retarget_roll;
1442         char skgen_side_string[8];
1443         char skgen_num_string[8];
1444         
1445         /* Alt+RMB option */
1446         char edge_mode;
1447         char edge_mode_live_unwrap;
1448
1449         /* Transform */
1450         char snap_mode, snap_node_mode;
1451         char snap_uv_mode;
1452         short snap_flag, snap_target;
1453         short proportional, prop_mode;
1454         char proportional_objects; /* proportional edit, object mode */
1455         char proportional_mask; /* proportional edit, mask editing */
1456         char proportional_action; /* proportional edit, action editor */
1457         char proportional_fcurve; /* proportional edit, graph editor */
1458         char lock_markers; /* lock marker editing */
1459         char pad4[5];
1460
1461         char auto_normalize; /*auto normalizing mode in wpaint*/
1462         char multipaint; /* paint multiple bones in wpaint */
1463         char weightuser;
1464         char vgroupsubset; /* subset selection filter in wpaint */
1465
1466         /* UV painting */
1467         int use_uv_sculpt;
1468         int uv_sculpt_settings;
1469         int uv_sculpt_tool;
1470         int uv_relax_method;
1471         /* XXX: these sculpt_paint_* fields are deprecated, use the
1472          * unified_paint_settings field instead! */
1473         short sculpt_paint_settings DNA_DEPRECATED;     short pad5;
1474         int sculpt_paint_unified_size DNA_DEPRECATED;
1475         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
1476         float sculpt_paint_unified_alpha DNA_DEPRECATED;
1477
1478         /* Unified Paint Settings */
1479         struct UnifiedPaintSettings unified_paint_settings;
1480
1481         struct CurvePaintSettings curve_paint_settings;
1482
1483         struct MeshStatVis statvis;
1484 } ToolSettings;
1485
1486 /* *************************************************************** */
1487 /* Assorted Scene Data */
1488
1489 /* ------------------------------------------- */
1490 /* Stats (show in Info header) */
1491
1492 typedef struct bStats {
1493         /* scene totals for visible layers */
1494         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
1495         int totvert, totface;
1496 } bStats;
1497
1498 /* ------------------------------------------- */
1499 /* Unit Settings */
1500
1501 typedef struct UnitSettings {
1502         /* Display/Editing unit options for each scene */
1503         float scale_length; /* maybe have other unit conversions? */
1504         char system; /* imperial, metric etc */
1505         char system_rotation; /* not implemented as a proper unit system yet */
1506         short flag;
1507 } UnitSettings;
1508
1509 /* ------------------------------------------- */
1510 /* Global/Common Physics Settings */
1511
1512 typedef struct PhysicsSettings {
1513         float gravity[3];
1514         int flag, quick_cache_step, rt;
1515 } PhysicsSettings;
1516
1517 /* ------------------------------------------- */
1518 /* Safe Area options used in Camera View & VSE
1519  */
1520 typedef struct DisplaySafeAreas {
1521         /* each value represents the (x,y) margins as a multiplier.
1522          * 'center' in this context is just the name for a different kind of safe-area */
1523
1524         float title[2];         /* Title Safe */
1525         float action[2];        /* Image/Graphics Safe */
1526
1527         /* use for alternate aspect ratio */
1528         float title_center[2];
1529         float action_center[2];
1530 } DisplaySafeAreas;
1531
1532 /* *************************************************************** */
1533 /* Scene ID-Block */
1534
1535 typedef struct Scene {
1536         ID id;
1537         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
1538         
1539         struct Object *camera;
1540         struct World *world;
1541         
1542         struct Scene *set;
1543         
1544         ListBase base;
1545         struct Base *basact;            /* active base */
1546         struct Object *obedit;          /* name replaces old G.obedit */
1547         
1548         float cursor[3];                        /* 3d cursor location */
1549         float twcent[3];                        /* center for transform widget */
1550         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
1551         
1552         unsigned int lay;                       /* bitflags for layer visibility */
1553         int layact;             /* active layer */
1554         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1555         
1556         short flag;                                                             /* various settings */
1557         
1558         char use_nodes;
1559         char pad[1];
1560         
1561         struct bNodeTree *nodetree;
1562         
1563         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1564         
1565         struct ToolSettings *toolsettings;              /* default allocated now */
1566         struct SceneStats *stats;                               /* default allocated now */
1567         struct DisplaySafeAreas safe_areas;
1568
1569         /* migrate or replace? depends on some internal things... */
1570         /* no, is on the right place (ton) */
1571         struct RenderData r;
1572         struct AudioData audio;
1573         
1574         ListBase markers;
1575         ListBase transform_spaces;
1576         
1577         void *sound_scene;
1578         void *playback_handle;
1579         void *sound_scrub_handle;
1580         void *speaker_handles;
1581         
1582         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1583         
1584         /* none of the dependency graph  vars is mean to be saved */
1585         struct Depsgraph *depsgraph;
1586         void *pad1;
1587         struct  DagForest *theDag;
1588         short dagflags;
1589         short pad3;
1590
1591         /* User-Defined KeyingSets */
1592         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1593         ListBase keyingsets;                    /* KeyingSets for this scene */
1594         
1595         /* Game Settings */
1596         struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5
1597         struct GameData gm;
1598
1599         /* Units */
1600         struct UnitSettings unit;
1601         
1602         /* Grease Pencil */
1603         struct bGPdata *gpd;
1604
1605         /* Physics simulation settings */
1606         struct PhysicsSettings physics_settings;
1607
1608         /* Movie Tracking */
1609         struct MovieClip *clip;                 /* active movie clip */
1610
1611         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by BKE_object_handle_update() */
1612         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1613
1614         /* Color Management */
1615         ColorManagedViewSettings view_settings;
1616         ColorManagedDisplaySettings display_settings;
1617         ColorManagedColorspaceSettings sequencer_colorspace_settings;
1618         
1619         /* RigidBody simulation world+settings */
1620         struct RigidBodyWorld *rigidbody_world;
1621
1622         struct PreviewImage *preview;
1623 } Scene;
1624
1625 /* **************** RENDERDATA ********************* */
1626
1627 /* flag */
1628         /* use preview range */
1629 #define SCER_PRV_RANGE  (1<<0)
1630 #define SCER_LOCK_FRAME_SELECTION       (1<<1)
1631         /* timeline/keyframe jumping - only selected items (on by default) */
1632 #define SCE_KEYS_NO_SELONLY     (1<<2)
1633
1634 /* mode (int now) */
1635 #define R_OSA                   0x0001
1636 #define R_SHADOW                0x0002
1637 #define R_GAMMA                 0x0004
1638 #define R_ORTHO                 0x0008
1639 #define R_ENVMAP                0x0010
1640 #define R_EDGE                  0x0020
1641 #define R_FIELDS                0x0040
1642 #define R_FIELDSTILL    0x0080
1643 /*#define R_RADIO                       0x0100 */ /* deprecated */
1644 #define R_BORDER                0x0200
1645 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
1646 #define R_CROP                  0x0800
1647 /*#define R_COSMO                       0x1000 deprecated */
1648 #define R_ODDFIELD              0x2000
1649 #define R_MBLUR                 0x4000
1650                 /* unified was here */
1651 #define R_RAYTRACE      0x10000
1652                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1653 #define R_GAUSS         0x20000
1654                 /* fbuf obsolete... */
1655 /*#define R_FBUF                        0x40000*/
1656                 /* threads obsolete... is there for old files, now use for autodetect threads */
1657 #define R_THREADS               0x80000
1658                 /* Use the same flag for autothreads */
1659 #define R_FIXED_THREADS         0x80000 
1660
1661 #define R_SPEED                         0x100000
1662 #define R_SSS                           0x200000
1663 #define R_NO_OVERWRITE          0x400000  /* skip existing files */
1664 #define R_TOUCH                         0x800000  /* touch files before rendering */
1665 #define R_SIMPLIFY                      0x1000000
1666 #define R_EDGE_FRS                      0x2000000 /* R_EDGE reserved for Freestyle */
1667 #define R_PERSISTENT_DATA       0x4000000 /* keep data around for re-render */
1668 #define R_USE_WS_SHADING        0x8000000 /* use world space interpretation of lighting data */
1669
1670 /* seq_flag */
1671 #define R_SEQ_GL_PREV 1
1672 // #define R_SEQ_GL_REND 2  // UNUSED, opengl render has its own operator now.
1673 #define R_SEQ_SOLID_TEX 4
1674
1675 /* displaymode */
1676
1677 #define R_OUTPUT_SCREEN 0
1678 #define R_OUTPUT_AREA   1
1679 #define R_OUTPUT_WINDOW 2
1680 #define R_OUTPUT_NONE   3
1681 /*#define R_OUTPUT_FORKED       4*/
1682
1683 /* filtertype */
1684 #define R_FILTER_BOX    0
1685 #define R_FILTER_TENT   1
1686 #define R_FILTER_QUAD   2
1687 #define R_FILTER_CUBIC  3
1688 #define R_FILTER_CATROM 4
1689 #define R_FILTER_GAUSS  5
1690 #define R_FILTER_MITCH  6
1691 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
1692
1693 /* raytrace structure */
1694 #define R_RAYSTRUCTURE_AUTO                             0
1695 #define R_RAYSTRUCTURE_OCTREE                   1
1696 #define R_RAYSTRUCTURE_BLIBVH                   2       /* removed */
1697 #define R_RAYSTRUCTURE_VBVH                             3
1698 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
1699 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
1700
1701 /* raytrace_options */
1702 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
1703 #define R_RAYTRACE_USE_INSTANCES                0x0002
1704
1705 /* scemode (int now) */
1706 #define R_DOSEQ                         0x0001
1707 #define R_BG_RENDER                     0x0002
1708                 /* passepartout is camera option now, keep this for backward compatibility */
1709 #define R_PASSEPARTOUT          0x0004
1710 #define R_BUTS_PREVIEW          0x0008
1711 #define R_EXTENSION                     0x0010
1712 #define R_MATNODE_PREVIEW       0x0020
1713 #define R_DOCOMP                        0x0040
1714 #define R_COMP_CROP                     0x0080
1715 #define R_FREE_IMAGE            0x0100
1716 #define R_SINGLE_LAYER          0x0200
1717 #define R_EXR_TILE_FILE         0x0400
1718 /* #define R_COMP_FREE                  0x0800 */
1719 #define R_NO_IMAGE_LOAD         0x1000
1720 #define R_NO_TEX                        0x2000
1721 #define R_NO_FRAME_UPDATE       0x4000
1722 #define R_FULL_SAMPLE           0x8000
1723 /* #define R_DEPRECATED         0x10000 */
1724 /* #define R_RECURS_PROTECTION  0x20000 */
1725 #define R_TEXNODE_PREVIEW       0x40000
1726 #define R_VIEWPORT_PREVIEW      0x80000
1727 #define R_EXR_CACHE_FILE        0x100000
1728 #define R_MULTIVIEW                     0x200000
1729
1730 /* r->stamp */
1731 #define R_STAMP_TIME    0x0001
1732 #define R_STAMP_FRAME   0x0002
1733 #define R_STAMP_DATE    0x0004
1734 #define R_STAMP_CAMERA  0x0008
1735 #define R_STAMP_SCENE   0x0010
1736 #define R_STAMP_NOTE    0x0020
1737 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1738 #define R_STAMP_MARKER  0x0080
1739 #define R_STAMP_FILENAME        0x0100
1740 #define R_STAMP_SEQSTRIP        0x0200
1741 #define R_STAMP_RENDERTIME      0x0400
1742 #define R_STAMP_CAMERALENS      0x0800
1743 #define R_STAMP_STRIPMETA       0x1000
1744 #define R_STAMP_MEMORY          0x2000
1745 #define R_STAMP_HIDE_LABELS     0x4000
1746 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1747                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1748                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS|R_STAMP_MEMORY|                 \
1749                      R_STAMP_HIDE_LABELS)
1750
1751 /* alphamode */
1752 #define R_ADDSKY                0
1753 #define R_ALPHAPREMUL   1
1754 /*#define R_ALPHAKEY            2*/ /* deprecated, shouldn't be used */
1755
1756 /* color_mgt_flag */
1757 enum {
1758         R_COLOR_MANAGEMENT              = (1 << 0),  /* deprecated, should only be used in versioning code only */
1759         /*R_COLOR_MANAGEMENT_PREDIVIDE    = (1 << 1)*/  /* deprecated, shouldn't be used */
1760 };
1761
1762 #ifdef DNA_DEPRECATED
1763 /* subimtype, flag options for imtype */
1764 enum {
1765         R_OPENEXR_HALF  = 1,  /*deprecated*/
1766         R_OPENEXR_ZBUF  = 2,  /*deprecated*/
1767         R_PREVIEW_JPG   = 4,  /*deprecated*/
1768         R_CINEON_LOG    = 8,  /*deprecated*/
1769         R_TIFF_16BIT    = 16, /*deprecated*/
1770
1771         R_JPEG2K_12BIT                  =     32,  /* Jpeg2000 */                    /*deprecated*/
1772         R_JPEG2K_16BIT                  =     64,                                    /*deprecated*/
1773         R_JPEG2K_YCC                    =     128,  /* when disabled use RGB */      /*deprecated*/
1774         R_JPEG2K_CINE_PRESET    =     256,                                   /*deprecated*/
1775         R_JPEG2K_CINE_48FPS             =     512,                                   /*deprecated*/
1776 };
1777 #endif
1778
1779 /* bake_mode: same as RE_BAKE_xxx defines */
1780 /* bake_flag: */
1781 #define R_BAKE_CLEAR            1
1782 #define R_BAKE_OSA                      2
1783 #define R_BAKE_TO_ACTIVE        4
1784 #define R_BAKE_NORMALIZE        8
1785 #define R_BAKE_MULTIRES         16
1786 #define R_BAKE_LORES_MESH       32
1787 #define R_BAKE_VCOL                     64
1788 #define R_BAKE_USERSCALE        128
1789 #define R_BAKE_CAGE                     256
1790 #define R_BAKE_SPLIT_MAT        512
1791 #define R_BAKE_AUTO_NAME        1024
1792
1793 /* bake_normal_space */
1794 #define R_BAKE_SPACE_CAMERA      0
1795 #define R_BAKE_SPACE_WORLD       1
1796 #define R_BAKE_SPACE_OBJECT      2
1797 #define R_BAKE_SPACE_TANGENT 3
1798
1799 /* simplify_flag */
1800 #define R_SIMPLE_NO_TRIANGULATE         1
1801
1802 /* line_thickness_mode */
1803 #define R_LINE_THICKNESS_ABSOLUTE 1
1804 #define R_LINE_THICKNESS_RELATIVE 2
1805
1806 /* sequencer seq_prev_type seq_rend_type */
1807
1808 /* scene->r.engine (scene.c) */
1809 extern const char *RE_engine_id_BLENDER_RENDER;
1810 extern const char *RE_engine_id_BLENDER_GAME;
1811 extern const char *RE_engine_id_CYCLES;
1812
1813 /* **************** SCENE ********************* */
1814
1815 /* note that much higher maxframes give imprecise sub-frames, see: T46859 */
1816 /* for general use */
1817 #define MAXFRAME        500000
1818 #define MAXFRAMEF       500000.0f
1819
1820 #define MINFRAME        0
1821 #define MINFRAMEF       0.0f
1822
1823 /* (minimum frame number for current-frame) */
1824 #define MINAFRAME       -500000
1825 #define MINAFRAMEF      -500000.0f
1826
1827 /* depricate this! */
1828 #define TESTBASE(v3d, base)  (                                                \
1829         ((base)->flag & SELECT) &&                                                \
1830         ((base)->lay & v3d->lay) &&                                               \
1831         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1832 #define TESTBASELIB(v3d, base)  (                                             \
1833         ((base)->flag & SELECT) &&                                                \
1834         ((base)->lay & v3d->lay) &&                                               \
1835         ((base)->object->id.lib == NULL) &&                                       \
1836         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1837 #define TESTBASELIB_BGMODE(v3d, scene, base)  (                               \
1838         ((base)->flag & SELECT) &&                                                \
1839         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1840         ((base)->object->id.lib == NULL) &&                                       \
1841         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1842 #define BASE_EDITABLE_BGMODE(v3d, scene, base)  (                             \
1843         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1844         ((base)->object->id.lib == NULL) &&                                       \
1845         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1846 #define BASE_SELECTABLE(v3d, base)  (                                         \
1847         (base->lay & v3d->lay) &&                                                 \
1848         (base->object->restrictflag & (OB_RESTRICT_SELECT | OB_RESTRICT_VIEW)) == 0)
1849 #define BASE_VISIBLE(v3d, base)  (                                            \
1850         (base->lay & v3d->lay) &&                                                 \
1851         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1852 #define BASE_VISIBLE_BGMODE(v3d, scene, base)  (                              \
1853         (base->lay & (v3d ? v3d->lay : scene->lay)) &&                            \
1854         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1855
1856 #define FIRSTBASE               scene->base.first
1857 #define LASTBASE                scene->base.last
1858 #define BASACT                  (scene->basact)
1859 #define OBACT                   (BASACT ? BASACT->object: NULL)
1860
1861 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1862 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1863
1864 #define CFRA            (scene->r.cfra)
1865 #define SUBFRA          (scene->r.subframe)
1866 #define SFRA            (scene->r.sfra)
1867 #define EFRA            (scene->r.efra)
1868 #define PRVRANGEON      (scene->r.flag & SCER_PRV_RANGE)
1869 #define PSFRA           ((PRVRANGEON) ? (scene->r.psfra) : (scene->r.sfra))
1870 #define PEFRA           ((PRVRANGEON) ? (scene->r.pefra) : (scene->r.efra))
1871 #define FRA2TIME(a)     ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1872 #define TIME2FRA(a)     ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1873 #define FPS              (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1874
1875 /* base->flag is in DNA_object_types.h */
1876
1877 /* toolsettings->snap_flag */
1878 #define SCE_SNAP                                1
1879 #define SCE_SNAP_ROTATE                 2
1880 #define SCE_SNAP_PEEL_OBJECT    4
1881 #define SCE_SNAP_PROJECT                8
1882 #define SCE_SNAP_NO_SELF                16
1883 #define SCE_SNAP_ABS_GRID               32
1884
1885 /* toolsettings->snap_target */
1886 #define SCE_SNAP_TARGET_CLOSEST 0
1887 #define SCE_SNAP_TARGET_CENTER  1
1888 #define SCE_SNAP_TARGET_MEDIAN  2
1889 #define SCE_SNAP_TARGET_ACTIVE  3
1890 /* toolsettings->snap_mode */
1891 #define SCE_SNAP_MODE_INCREMENT 0
1892 #define SCE_SNAP_MODE_VERTEX    1
1893 #define SCE_SNAP_MODE_EDGE              2
1894 #define SCE_SNAP_MODE_FACE              3
1895 #define SCE_SNAP_MODE_VOLUME    4
1896 #define SCE_SNAP_MODE_NODE_X    5
1897 #define SCE_SNAP_MODE_NODE_Y    6
1898 #define SCE_SNAP_MODE_NODE_XY   7
1899 #define SCE_SNAP_MODE_GRID              8
1900
1901 /* toolsettings->selectmode */
1902 #define SCE_SELECT_VERTEX       1 /* for mesh */
1903 #define SCE_SELECT_EDGE         2
1904 #define SCE_SELECT_FACE         4
1905
1906 /* toolsettings->statvis->type */
1907 #define SCE_STATVIS_OVERHANG    0
1908 #define SCE_STATVIS_THICKNESS   1
1909 #define SCE_STATVIS_INTERSECT   2
1910 #define SCE_STATVIS_DISTORT             3
1911 #define SCE_STATVIS_SHARP               4
1912
1913 /* toolsettings->particle.selectmode for particles */
1914 #define SCE_SELECT_PATH         1
1915 #define SCE_SELECT_POINT        2
1916 #define SCE_SELECT_END          4
1917
1918 /* toolsettings->prop_mode (proportional falloff) */
1919 #define PROP_SMOOTH            0
1920 #define PROP_SPHERE            1
1921 #define PROP_ROOT              2
1922 #define PROP_SHARP             3
1923 #define PROP_LIN               4
1924 #define PROP_CONST             5
1925 #define PROP_RANDOM            6
1926 #define PROP_INVSQUARE         7
1927 #define PROP_MODE_MAX          8
1928
1929 /* toolsettings->proportional */
1930 #define PROP_EDIT_OFF                   0
1931 #define PROP_EDIT_ON                    1
1932 #define PROP_EDIT_CONNECTED             2
1933 #define PROP_EDIT_PROJECTED             3
1934
1935 /* toolsettings->weightuser */
1936 enum {
1937         OB_DRAW_GROUPUSER_NONE      = 0,
1938         OB_DRAW_GROUPUSER_ACTIVE    = 1,
1939         OB_DRAW_GROUPUSER_ALL       = 2
1940 };
1941
1942 /* toolsettings->vgroupsubset */
1943 /* object_vgroup.c */
1944 typedef enum eVGroupSelect {
1945         WT_VGROUP_ALL = 0,
1946         WT_VGROUP_ACTIVE = 1,
1947         WT_VGROUP_BONE_SELECT = 2,
1948         WT_VGROUP_BONE_DEFORM = 3,
1949         WT_VGROUP_BONE_DEFORM_OFF = 4
1950 } eVGroupSelect;
1951
1952 #define WT_VGROUP_MASK_ALL \
1953         ((1 << WT_VGROUP_ACTIVE) | \
1954          (1 << WT_VGROUP_BONE_SELECT) | \
1955          (1 << WT_VGROUP_BONE_DEFORM) | \
1956          (1 << WT_VGROUP_BONE_DEFORM_OFF) | \
1957          (1 << WT_VGROUP_ALL))
1958
1959
1960 /* sce->flag */
1961 #define SCE_DS_SELECTED                 (1<<0)
1962 #define SCE_DS_COLLAPSED                (1<<1)
1963 #define SCE_NLA_EDIT_ON                 (1<<2)
1964 #define SCE_FRAME_DROP                  (1<<3)
1965
1966
1967         /* return flag BKE_scene_base_iter_next functions */
1968 /* #define F_ERROR                      -1 */  /* UNUSED */
1969 #define F_START                 0
1970 #define F_SCENE                 1
1971 #define F_DUPLI                 3
1972
1973 /* audio->flag */
1974 #define AUDIO_MUTE                (1<<0)
1975 #define AUDIO_SYNC                (1<<1)
1976 #define AUDIO_SCRUB                       (1<<2)
1977 #define AUDIO_VOLUME_ANIMATED     (1<<3)
1978
1979 enum {
1980 #ifdef DNA_DEPRECATED
1981         FFMPEG_MULTIPLEX_AUDIO  = 1,  /* deprecated, you can choose none as audiocodec now */
1982 #endif
1983         FFMPEG_AUTOSPLIT_OUTPUT = 2,
1984         FFMPEG_LOSSLESS_OUTPUT  = 4,
1985 };
1986
1987 /* Paint.flags */
1988 typedef enum {
1989         PAINT_SHOW_BRUSH = (1 << 0),
1990         PAINT_FAST_NAVIGATE = (1 << 1),
1991         PAINT_SHOW_BRUSH_ON_SURFACE = (1 << 2),
1992         PAINT_USE_CAVITY_MASK = (1 << 3)
1993 } PaintFlags;
1994
1995 /* Paint.symmetry_flags
1996  * (for now just a duplicate of sculpt symmetry flags) */
1997 typedef enum SymmetryFlags {
1998         PAINT_SYMM_X = (1 << 0),
1999         PAINT_SYMM_Y = (1 << 1),
2000         PAINT_SYMM_Z = (1 << 2),
2001         PAINT_SYMMETRY_FEATHER = (1 << 3),
2002         PAINT_TILE_X = (1 << 4),
2003         PAINT_TILE_Y = (1 << 5),
2004         PAINT_TILE_Z = (1 << 6),
2005 } SymmetryFlags;
2006
2007 #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z)
2008
2009 /* Sculpt.flags */
2010 /* These can eventually be moved to paint flags? */
2011 typedef enum SculptFlags {
2012 #ifdef DNA_DEPRECATED
2013         /* deprecated, part of paint struct symmetry_flags now */
2014         SCULPT_SYMM_X = (1 << 0),
2015         SCULPT_SYMM_Y = (1 << 1),
2016         SCULPT_SYMM_Z = (1 << 2),
2017 #endif
2018
2019         SCULPT_LOCK_X = (1 << 3),
2020         SCULPT_LOCK_Y = (1 << 4),
2021         SCULPT_LOCK_Z = (1 << 5),
2022         /* deprecated, part of paint struct symmetry_flags now */
2023         SCULPT_SYMMETRY_FEATHER = (1 << 6),
2024
2025         SCULPT_USE_OPENMP = (1 << 7),
2026         SCULPT_ONLY_DEFORM = (1 << 8),
2027         SCULPT_SHOW_DIFFUSE = (1 << 9),
2028
2029         /* If set, the mesh will be drawn with smooth-shading in
2030          * dynamic-topology mode */
2031         SCULPT_DYNTOPO_SMOOTH_SHADING = (1 << 10),
2032
2033         /* If set, dynamic-topology brushes will subdivide short edges */
2034         SCULPT_DYNTOPO_SUBDIVIDE = (1 << 12),
2035         /* If set, dynamic-topology brushes will collapse short edges */
2036         SCULPT_DYNTOPO_COLLAPSE = (1 << 11),
2037
2038         /* If set, dynamic-topology detail size will be constant in object space */
2039         SCULPT_DYNTOPO_DETAIL_CONSTANT = (1 << 13),
2040         SCULPT_DYNTOPO_DETAIL_BRUSH = (1 << 14),
2041 } SculptFlags;
2042
2043 typedef enum ImagePaintMode {
2044         IMAGEPAINT_MODE_MATERIAL, /* detect texture paint slots from the material */
2045         IMAGEPAINT_MODE_IMAGE,    /* select texture paint image directly */
2046 } ImagePaintMode;
2047
2048 /* ImagePaintSettings.flag */
2049 #define IMAGEPAINT_DRAWING                              1
2050 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
2051 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
2052
2053 /* projection painting only */
2054 #define IMAGEPAINT_PROJECT_XRAY                 (1 << 4)
2055 #define IMAGEPAINT_PROJECT_BACKFACE             (1 << 5)
2056 #define IMAGEPAINT_PROJECT_FLAT                 (1 << 6)
2057 #define IMAGEPAINT_PROJECT_LAYER_CLONE  (1 << 7)
2058 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        (1 << 8)
2059 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    (1 << 9)
2060
2061
2062 #define IMAGEPAINT_MISSING_UVS       (1 << 0)
2063 #define IMAGEPAINT_MISSING_MATERIAL  (1 << 1)
2064 #define IMAGEPAINT_MISSING_TEX       (1 << 2)
2065 #define IMAGEPAINT_MISSING_STENCIL   (1 << 3)
2066
2067 /* toolsettings->uvcalc_flag */
2068 #define UVCALC_FILLHOLES                        1
2069 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
2070 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
2071 #define UVCALC_USESUBSURF                       8       /* Use mesh data after subsurf to compute UVs*/
2072
2073 /* toolsettings->uv_flag */
2074 #define UV_SYNC_SELECTION       1
2075 #define UV_SHOW_SAME_IMAGE      2
2076
2077 /* toolsettings->uv_selectmode */
2078 #define UV_SELECT_VERTEX        1
2079 #define UV_SELECT_EDGE          2
2080 #define UV_SELECT_FACE          4
2081 #define UV_SELECT_ISLAND        8
2082
2083 /* toolsettings->edge_mode */
2084 #define EDGE_MODE_SELECT                                0
2085 #define EDGE_MODE_TAG_SEAM                              1
2086 #define EDGE_MODE_TAG_SHARP                             2
2087 #define EDGE_MODE_TAG_CREASE                    3
2088 #define EDGE_MODE_TAG_BEVEL                             4
2089 #define EDGE_MODE_TAG_FREESTYLE                 5
2090
2091 /* toolsettings->gpencil_flags */
2092 typedef enum eGPencil_Flags {
2093         /* "Continuous Drawing" - The drawing operator enters a mode where multiple strokes can be drawn */
2094         GP_TOOL_FLAG_PAINTSESSIONS_ON       = (1 << 0),
2095         /* When creating new frames, the last frame gets used as the basis for the new one */
2096         GP_TOOL_FLAG_RETAIN_LAST            = (1 << 1),
2097         /* Add the strokes below all strokes in the layer */
2098         GP_TOOL_FLAG_PAINT_ONBACK = (1 << 2)
2099 } eGPencil_Flags;
2100
2101 /* toolsettings->gpencil_src */
2102 typedef enum eGPencil_Source_3D {
2103         GP_TOOL_SOURCE_SCENE    = 0,
2104         GP_TOOL_SOURCE_OBJECT   = 1
2105 } eGPencil_Source_3d;
2106
2107 /* toolsettings->gpencil_*_align - Stroke Placement mode flags */
2108 typedef enum eGPencil_Placement_Flags {
2109         /* New strokes are added in viewport/data space (i.e. not screen space) */
2110         GP_PROJECT_VIEWSPACE    = (1 << 0),
2111         
2112         /* Viewport space, but relative to render canvas (Sequencer Preview Only) */
2113         GP_PROJECT_CANVAS       = (1 << 1),
2114         
2115         /* Project into the screen's Z values */
2116         GP_PROJECT_DEPTH_VIEW   = (1 << 2),
2117         GP_PROJECT_DEPTH_STROKE = (1 << 3),
2118         
2119         /* "Use Endpoints" */
2120         GP_PROJECT_DEPTH_STROKE_ENDPOINTS = (1 << 4),
2121 } eGPencil_Placement_Flags;
2122
2123 /* toolsettings->particle flag */
2124 #define PE_KEEP_LENGTHS                 1
2125 #define PE_LOCK_FIRST                   2
2126 #define PE_DEFLECT_EMITTER              4
2127 #define PE_INTERPOLATE_ADDED    8
2128 #define PE_DRAW_PART                    16
2129 /* #define PE_X_MIRROR                  64 */   /* deprecated */
2130 #define PE_FADE_TIME                    128
2131 #define PE_AUTO_VELOCITY                256
2132
2133 /* toolsetting->particle brushtype */
2134 #define PE_BRUSH_NONE           -1
2135 #define PE_BRUSH_COMB           0
2136 #define PE_BRUSH_CUT            1
2137 #define PE_BRUSH_LENGTH         2
2138 #define PE_BRUSH_PUFF           3
2139 #define PE_BRUSH_ADD            4
2140 #define PE_BRUSH_SMOOTH         5
2141 #define PE_BRUSH_WEIGHT         6
2142
2143 /* this must equal ParticleEditSettings.brush array size */
2144 #define PE_TOT_BRUSH            6
2145
2146 /* ParticleBrushData->flag */
2147 #define PE_BRUSH_DATA_PUFF_VOLUME 1
2148
2149 /* tooksettings->particle edittype */
2150 #define PE_TYPE_PARTICLES       0
2151 #define PE_TYPE_SOFTBODY        1
2152 #define PE_TYPE_CLOTH           2
2153
2154 /* toolsettings->skgen_options */
2155 #define SKGEN_FILTER_INTERNAL   (1 << 0)
2156 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
2157 #define SKGEN_SYMMETRY                  (1 << 2)
2158 #define SKGEN_CUT_LENGTH                (1 << 3)
2159 #define SKGEN_CUT_ANGLE                 (1 << 4)
2160 #define SKGEN_CUT_CORRELATION   (1 << 5)
2161 #define SKGEN_HARMONIC                  (1 << 6)
2162 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
2163 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
2164 #define SKGEN_FILTER_SMART              (1 << 9)
2165 #define SKGEN_DISP_LENGTH               (1 << 10)
2166 #define SKGEN_DISP_WEIGHT               (1 << 11)
2167 #define SKGEN_DISP_ORIG                 (1 << 12)
2168 #define SKGEN_DISP_EMBED                (1 << 13)
2169 #define SKGEN_DISP_INDEX                (1 << 14)
2170
2171 #define SKGEN_SUB_LENGTH                0
2172 #define SKGEN_SUB_ANGLE                 1
2173 #define SKGEN_SUB_CORRELATION   2
2174 #define SKGEN_SUB_TOTAL                 3
2175
2176 /* toolsettings->skgen_postpro */
2177 #define SKGEN_SMOOTH                    0
2178 #define SKGEN_AVERAGE                   1
2179 #define SKGEN_SHARPEN                   2
2180
2181 /* toolsettings->bone_sketching */
2182 #define BONE_SKETCHING                  1
2183 #define BONE_SKETCHING_QUICK    2
2184 #define BONE_SKETCHING_ADJUST   4
2185
2186 /* toolsettings->bone_sketching_convert */
2187 #define SK_CONVERT_CUT_FIXED                    0
2188 #define SK_CONVERT_CUT_LENGTH                   1
2189 #define SK_CONVERT_CUT_ADAPTATIVE               2
2190 #define SK_CONVERT_RETARGET                             3
2191
2192 /* toolsettings->skgen_retarget_options */
2193 #define SK_RETARGET_AUTONAME                    1
2194
2195 /* toolsettings->skgen_retarget_roll */
2196 #define SK_RETARGET_ROLL_NONE                   0
2197 #define SK_RETARGET_ROLL_VIEW                   1
2198 #define SK_RETARGET_ROLL_JOINT                  2
2199
2200 /* physics_settings->flag */
2201 #define PHYS_GLOBAL_GRAVITY             1
2202
2203 /* UnitSettings */
2204
2205 /* UnitSettings->system */
2206 #define USER_UNIT_NONE                  0
2207 #define USER_UNIT_METRIC                1
2208 #define USER_UNIT_IMPERIAL              2
2209 /* UnitSettings->flag */
2210 #define USER_UNIT_OPT_SPLIT             1
2211 #define USER_UNIT_ROT_RADIANS   2
2212
2213 #ifdef __cplusplus
2214 }
2215 #endif
2216
2217 #endif  /* __DNA_SCENE_TYPES_H__ */