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