Merge branch 'blender2.8' into soc-2018-bevel
[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_group_types.h"
51 #include "DNA_layer_types.h"
52 #include "DNA_material_types.h"
53 #include "DNA_userdef_types.h"
54 #include "DNA_view3d_types.h"
55
56 struct CurveMapping;
57 struct Object;
58 struct Brush;
59 struct World;
60 struct Scene;
61 struct Image;
62 struct Collection;
63 struct Text;
64 struct bNodeTree;
65 struct AnimData;
66 struct Editing;
67 struct SceneStats;
68 struct bGPdata;
69 struct bGPDbrush;
70 struct MovieClip;
71 struct ColorSpace;
72 struct SceneCollection;
73
74 /* ************************************************************* */
75 /* Scene Data */
76
77 /* ************************************************************* */
78 /* Output Format Data */
79
80 typedef struct AviCodecData {
81         void                    *lpFormat;  /* save format */
82         void                    *lpParms;   /* compressor options */
83         unsigned int    cbFormat;           /* size of lpFormat buffer */
84         unsigned int    cbParms;            /* size of lpParms buffer */
85
86         unsigned int    fccType;            /* stream type, for consistency */
87         unsigned int    fccHandler;         /* compressor */
88         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
89         unsigned int    dwQuality;          /* compress quality 0-10,000 */
90         unsigned int    dwBytesPerSecond;   /* bytes per second */
91         unsigned int    dwFlags;            /* flags... see below */
92         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
93         unsigned int    pad;
94
95         char                    avicodecname[128];
96 } AviCodecData;
97
98 typedef enum eFFMpegPreset {
99         FFM_PRESET_NONE,
100
101 #ifdef DNA_DEPRECATED
102         /* Previously used by h.264 to control encoding speed vs. file size. */
103         FFM_PRESET_ULTRAFAST, /* DEPRECATED */
104         FFM_PRESET_SUPERFAST, /* DEPRECATED */
105         FFM_PRESET_VERYFAST,  /* DEPRECATED */
106         FFM_PRESET_FASTER,    /* DEPRECATED */
107         FFM_PRESET_FAST,      /* DEPRECATED */
108         FFM_PRESET_MEDIUM,    /* DEPRECATED */
109         FFM_PRESET_SLOW,      /* DEPRECATED */
110         FFM_PRESET_SLOWER,    /* DEPRECATED */
111         FFM_PRESET_VERYSLOW,  /* DEPRECATED */
112 #endif
113
114         /* Used by WEBM/VP9 and h.264 to control encoding speed vs. file size.
115          * WEBM/VP9 use these values directly, whereas h.264 map those to
116          * respectively the MEDIUM, SLOWER, and SUPERFAST presets.
117         */
118         FFM_PRESET_GOOD = 10, /* the default and recommended for most applications */
119         FFM_PRESET_BEST, /* recommended if you have lots of time and want the best compression efficiency */
120         FFM_PRESET_REALTIME, /* recommended for live / fast encoding */
121 } eFFMpegPreset;
122
123 /* Mapping from easily-understandable descriptions to CRF values.
124  * Assumes we output 8-bit video. Needs to be remapped if 10-bit
125  * is output.
126  * We use a slightly wider than "subjectively sane range" according
127  * to https://trac.ffmpeg.org/wiki/Encode/H.264#a1.ChooseaCRFvalue
128  */
129 typedef enum eFFMpegCrf {
130         FFM_CRF_NONE = -1,
131         FFM_CRF_LOSSLESS = 0,
132         FFM_CRF_PERC_LOSSLESS = 17,
133         FFM_CRF_HIGH = 20,
134         FFM_CRF_MEDIUM = 23,
135         FFM_CRF_LOW = 26,
136         FFM_CRF_VERYLOW = 29,
137         FFM_CRF_LOWEST = 32,
138 } eFFMpegCrf;
139
140 typedef struct FFMpegCodecData {
141         int type;
142         int codec;
143         int audio_codec;
144         int video_bitrate;
145         int audio_bitrate;
146         int audio_mixrate;
147         int audio_channels;
148         int audio_pad;
149         float audio_volume;
150         int gop_size;
151         int max_b_frames; /* only used if FFMPEG_USE_MAX_B_FRAMES flag is set. */
152         int flags;
153         int constant_rate_factor;
154         int ffmpeg_preset; /* see eFFMpegPreset */
155
156         int rc_min_rate;
157         int rc_max_rate;
158         int rc_buffer_size;
159         int mux_packet_size;
160         int mux_rate;
161         int pad1;
162
163         IDProperty *properties;
164 } FFMpegCodecData;
165
166 /* ************************************************************* */
167 /* Audio */
168
169 typedef struct AudioData {
170         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
171         float main; // 2.5: now in FFMpegCodecData: audio_volume
172         float speed_of_sound;
173         float doppler_factor;
174         int distance_model;
175         short flag;
176         short pad;
177         float volume;
178         float pad2;
179 } AudioData;
180
181 /* *************************************************************** */
182 /* Render Layers */
183
184 /* Render Layer */
185 typedef struct SceneRenderLayer {
186         struct SceneRenderLayer *next, *prev;
187
188         char name[64] DNA_DEPRECATED;   /* MAX_NAME */
189
190         struct Material *mat_override DNA_DEPRECATED; /* Converted to ViewLayer override. */
191
192         unsigned int lay DNA_DEPRECATED; /* Converted to LayerCollection cycles camera visibility override. */
193         unsigned int lay_zmask DNA_DEPRECATED; /* Converted to LayerCollection cycles holdout override. */
194         unsigned int lay_exclude DNA_DEPRECATED;
195         int layflag DNA_DEPRECATED; /* Converted to ViewLayer layflag and flag. */
196
197         /* pass_xor has to be after passflag */
198         int passflag DNA_DEPRECATED; /* pass_xor has to be after passflag */
199         int pass_xor DNA_DEPRECATED; /* Converted to ViewLayer passflag and flag. */
200
201         int samples DNA_DEPRECATED; /* Converted to ViewLayer override. */
202         float pass_alpha_threshold DNA_DEPRECATED; /* Converted to ViewLayer pass_alpha_threshold. */
203
204         IDProperty *prop DNA_DEPRECATED; /* Converted to ViewLayer id_properties. */
205
206         struct FreestyleConfig freestyleConfig DNA_DEPRECATED; /* Converted to ViewLayer freestyleConfig. */
207 } SceneRenderLayer;
208
209 /* SceneRenderLayer.layflag */
210 #define SCE_LAY_SOLID   1
211 #define SCE_LAY_ZTRA    2
212 #define SCE_LAY_HALO    4
213 #define SCE_LAY_EDGE    8
214 #define SCE_LAY_SKY             16
215 #define SCE_LAY_STRAND  32
216 #define SCE_LAY_FRS             64
217 #define SCE_LAY_AO              128
218         /* flags between 256 and 0x8000 are set to 1 already, for future options */
219
220 #define SCE_LAY_ALL_Z           0x8000
221 #define SCE_LAY_XOR                     0x10000
222 #define SCE_LAY_DISABLE         0x20000
223 #define SCE_LAY_ZMASK           0x40000
224 #define SCE_LAY_NEG_ZMASK       0x80000
225
226 /* SceneRenderLayer.passflag */
227 typedef enum eScenePassType {
228         SCE_PASS_COMBINED                 = (1 << 0),
229         SCE_PASS_Z                        = (1 << 1),
230         SCE_PASS_RGBA                     = (1 << 2),
231         SCE_PASS_DIFFUSE                  = (1 << 3),
232         SCE_PASS_SPEC                     = (1 << 4),
233         SCE_PASS_SHADOW                   = (1 << 5),
234         SCE_PASS_AO                       = (1 << 6),
235         SCE_PASS_REFLECT                  = (1 << 7),
236         SCE_PASS_NORMAL                   = (1 << 8),
237         SCE_PASS_VECTOR                   = (1 << 9),
238         SCE_PASS_REFRACT                  = (1 << 10),
239         SCE_PASS_INDEXOB                  = (1 << 11),
240         SCE_PASS_UV                       = (1 << 12),
241         SCE_PASS_INDIRECT                 = (1 << 13),
242         SCE_PASS_MIST                     = (1 << 14),
243         SCE_PASS_RAYHITS                  = (1 << 15),
244         SCE_PASS_EMIT                     = (1 << 16),
245         SCE_PASS_ENVIRONMENT              = (1 << 17),
246         SCE_PASS_INDEXMA                  = (1 << 18),
247         SCE_PASS_DIFFUSE_DIRECT           = (1 << 19),
248         SCE_PASS_DIFFUSE_INDIRECT         = (1 << 20),
249         SCE_PASS_DIFFUSE_COLOR            = (1 << 21),
250         SCE_PASS_GLOSSY_DIRECT            = (1 << 22),
251         SCE_PASS_GLOSSY_INDIRECT          = (1 << 23),
252         SCE_PASS_GLOSSY_COLOR             = (1 << 24),
253         SCE_PASS_TRANSM_DIRECT            = (1 << 25),
254         SCE_PASS_TRANSM_INDIRECT          = (1 << 26),
255         SCE_PASS_TRANSM_COLOR             = (1 << 27),
256         SCE_PASS_SUBSURFACE_DIRECT        = (1 << 28),
257         SCE_PASS_SUBSURFACE_INDIRECT      = (1 << 29),
258         SCE_PASS_SUBSURFACE_COLOR         = (1 << 30),
259         SCE_PASS_ROUGHNESS                = (1 << 31),
260 } eScenePassType;
261
262 #define RE_PASSNAME_COMBINED "Combined"
263 #define RE_PASSNAME_Z "Depth"
264 #define RE_PASSNAME_VECTOR "Vector"
265 #define RE_PASSNAME_NORMAL "Normal"
266 #define RE_PASSNAME_UV "UV"
267 #define RE_PASSNAME_RGBA "Color"
268 #define RE_PASSNAME_EMIT "Emit"
269 #define RE_PASSNAME_DIFFUSE "Diffuse"
270 #define RE_PASSNAME_SPEC "Spec"
271 #define RE_PASSNAME_SHADOW "Shadow"
272
273 #define RE_PASSNAME_AO "AO"
274 #define RE_PASSNAME_ENVIRONMENT "Env"
275 #define RE_PASSNAME_INDIRECT "Indirect"
276 #define RE_PASSNAME_REFLECT "Reflect"
277 #define RE_PASSNAME_REFRACT "Refract"
278 #define RE_PASSNAME_INDEXOB "IndexOB"
279 #define RE_PASSNAME_INDEXMA "IndexMA"
280 #define RE_PASSNAME_MIST "Mist"
281
282 #define RE_PASSNAME_RAYHITS "RayHits"
283 #define RE_PASSNAME_DIFFUSE_DIRECT "DiffDir"
284 #define RE_PASSNAME_DIFFUSE_INDIRECT "DiffInd"
285 #define RE_PASSNAME_DIFFUSE_COLOR "DiffCol"
286 #define RE_PASSNAME_GLOSSY_DIRECT "GlossDir"
287 #define RE_PASSNAME_GLOSSY_INDIRECT "GlossInd"
288 #define RE_PASSNAME_GLOSSY_COLOR "GlossCol"
289 #define RE_PASSNAME_TRANSM_DIRECT "TransDir"
290 #define RE_PASSNAME_TRANSM_INDIRECT "TransInd"
291 #define RE_PASSNAME_TRANSM_COLOR "TransCol"
292
293 #define RE_PASSNAME_SUBSURFACE_DIRECT "SubsurfaceDir"
294 #define RE_PASSNAME_SUBSURFACE_INDIRECT "SubsurfaceInd"
295 #define RE_PASSNAME_SUBSURFACE_COLOR "SubsurfaceCol"
296
297
298 /* View - MultiView */
299 typedef struct SceneRenderView {
300         struct SceneRenderView *next, *prev;
301
302         char name[64];  /* MAX_NAME */
303         char suffix[64];        /* MAX_NAME */
304
305         int viewflag;
306         int pad[2];
307         char pad2[4];
308
309 } SceneRenderView;
310
311 /* SceneRenderView.viewflag */
312 #define SCE_VIEW_DISABLE                (1<<0)
313
314 /* RenderData.views_format */
315 enum {
316         SCE_VIEWS_FORMAT_STEREO_3D = 0,
317         SCE_VIEWS_FORMAT_MULTIVIEW = 1,
318 };
319
320 /* ImageFormatData.views_format (also used for Sequence.views_format) */
321 enum {
322         R_IMF_VIEWS_INDIVIDUAL = 0,
323         R_IMF_VIEWS_STEREO_3D  = 1,
324         R_IMF_VIEWS_MULTIVIEW  = 2,
325 };
326
327 typedef struct Stereo3dFormat {
328         short flag;
329         char display_mode; /* encoding mode */
330         char anaglyph_type; /* anaglyph scheme for the user display */
331         char interlace_type;  /* interlace type for the user display */
332         char pad[3];
333 } Stereo3dFormat;
334
335 /* Stereo3dFormat.display_mode */
336 typedef enum eStereoDisplayMode {
337         S3D_DISPLAY_ANAGLYPH    = 0,
338         S3D_DISPLAY_INTERLACE   = 1,
339         S3D_DISPLAY_PAGEFLIP    = 2,
340         S3D_DISPLAY_SIDEBYSIDE  = 3,
341         S3D_DISPLAY_TOPBOTTOM   = 4,
342 } eStereoDisplayMode;
343
344 /* Stereo3dFormat.flag */
345 typedef enum eStereo3dFlag {
346         S3D_INTERLACE_SWAP        = (1 << 0),
347         S3D_SIDEBYSIDE_CROSSEYED  = (1 << 1),
348         S3D_SQUEEZED_FRAME        = (1 << 2),
349 } eStereo3dFlag;
350
351 /* Stereo3dFormat.anaglyph_type */
352 typedef enum eStereo3dAnaglyphType {
353         S3D_ANAGLYPH_REDCYAN      = 0,
354         S3D_ANAGLYPH_GREENMAGENTA = 1,
355         S3D_ANAGLYPH_YELLOWBLUE   = 2,
356 } eStereo3dAnaglyphType;
357
358 /* Stereo3dFormat.interlace_type */
359 typedef enum eStereo3dInterlaceType {
360         S3D_INTERLACE_ROW          = 0,
361         S3D_INTERLACE_COLUMN       = 1,
362         S3D_INTERLACE_CHECKERBOARD = 2,
363 } eStereo3dInterlaceType;
364
365 /* *************************************************************** */
366
367 /* Generic image format settings,
368  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
369  *
370  * note: its a bit strange that even though this is an image format struct
371  *  the imtype can still be used to select video formats.
372  *  RNA ensures these enum's are only selectable for render output.
373  */
374 typedef struct ImageFormatData {
375         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
376                        /* note, video types should only ever be set from this
377                         * structure when used from RenderData */
378         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
379                         * not a flag, only set 1 at a time */
380
381         char planes;   /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
382         char flag;     /* generic options for all image types, alpha zbuffer */
383
384         char quality;  /* (0 - 100), eg: jpeg quality */
385         char compress; /* (0 - 100), eg: png compression */
386
387
388         /* --- format specific --- */
389
390         /* OpenEXR */
391         char  exr_codec;
392
393         /* Cineon */
394         char  cineon_flag;
395         short cineon_white, cineon_black;
396         float cineon_gamma;
397
398         /* Jpeg2000 */
399         char  jp2_flag;
400         char jp2_codec;
401
402         /* TIFF */
403         char tiff_codec;
404
405         char pad[4];
406
407         /* Multiview */
408         char views_format;
409         Stereo3dFormat stereo3d_format;
410
411         /* color management */
412         ColorManagedViewSettings view_settings;
413         ColorManagedDisplaySettings display_settings;
414 } ImageFormatData;
415
416
417 /* ImageFormatData.imtype */
418 #define R_IMF_IMTYPE_TARGA           0
419 #define R_IMF_IMTYPE_IRIS            1
420 /* #define R_HAMX                    2 */ /* hamx is nomore */
421 /* #define R_FTYPE                   3 */ /* ftype is nomore */
422 #define R_IMF_IMTYPE_JPEG90          4
423 /* #define R_MOVIE                   5 */ /* movie is nomore */
424 #define R_IMF_IMTYPE_IRIZ            7
425 #define R_IMF_IMTYPE_RAWTGA         14
426 #define R_IMF_IMTYPE_AVIRAW         15
427 #define R_IMF_IMTYPE_AVIJPEG        16
428 #define R_IMF_IMTYPE_PNG            17
429 /* #define R_IMF_IMTYPE_AVICODEC    18 */ /* avicodec is nomore */
430 /* #define R_IMF_IMTYPE_QUICKTIME   19 */ /* quicktime is nomore */
431 #define R_IMF_IMTYPE_BMP            20
432 #define R_IMF_IMTYPE_RADHDR         21
433 #define R_IMF_IMTYPE_TIFF           22
434 #define R_IMF_IMTYPE_OPENEXR        23
435 #define R_IMF_IMTYPE_FFMPEG         24
436 /* #define R_IMF_IMTYPE_FRAMESERVER    25 */ /* frame server is nomore */
437 #define R_IMF_IMTYPE_CINEON         26
438 #define R_IMF_IMTYPE_DPX            27
439 #define R_IMF_IMTYPE_MULTILAYER     28
440 #define R_IMF_IMTYPE_DDS            29
441 #define R_IMF_IMTYPE_JP2            30
442 #define R_IMF_IMTYPE_H264           31
443 #define R_IMF_IMTYPE_XVID           32
444 #define R_IMF_IMTYPE_THEORA         33
445 #define R_IMF_IMTYPE_PSD            34
446
447 #define R_IMF_IMTYPE_INVALID        255
448
449 /* ImageFormatData.flag */
450 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
451 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
452
453 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
454 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
455 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
456 #define R_IMF_CHAN_DEPTH_10 (1<<2) /* 10bits (uncommon, Cineon/DPX support) */
457 #define R_IMF_CHAN_DEPTH_12 (1<<3) /* 12bits (uncommon, jp2/DPX support) */
458 #define R_IMF_CHAN_DEPTH_16 (1<<4) /* 16bits (tiff, halff float exr) */
459 #define R_IMF_CHAN_DEPTH_24 (1<<5) /* 24bits (unused) */
460 #define R_IMF_CHAN_DEPTH_32 (1<<6) /* 32bits (full float exr) */
461
462 /* ImageFormatData.planes */
463 #define R_IMF_PLANES_RGB   24
464 #define R_IMF_PLANES_RGBA  32
465 #define R_IMF_PLANES_BW    8
466
467 /* ImageFormatData.exr_codec */
468 #define R_IMF_EXR_CODEC_NONE  0
469 #define R_IMF_EXR_CODEC_PXR24 1
470 #define R_IMF_EXR_CODEC_ZIP   2
471 #define R_IMF_EXR_CODEC_PIZ   3
472 #define R_IMF_EXR_CODEC_RLE   4
473 #define R_IMF_EXR_CODEC_ZIPS  5
474 #define R_IMF_EXR_CODEC_B44   6
475 #define R_IMF_EXR_CODEC_B44A  7
476 #define R_IMF_EXR_CODEC_DWAA  8
477 #define R_IMF_EXR_CODEC_DWAB  9
478 #define R_IMF_EXR_CODEC_MAX  10
479
480 /* ImageFormatData.jp2_flag */
481 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
482 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
483 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
484
485 /* ImageFormatData.jp2_codec */
486 #define R_IMF_JP2_CODEC_JP2  0
487 #define R_IMF_JP2_CODEC_J2K  1
488
489 /* ImageFormatData.cineon_flag */
490 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
491
492 /* ImageFormatData.tiff_codec */
493 enum {
494         R_IMF_TIFF_CODEC_DEFLATE   = 0,
495         R_IMF_TIFF_CODEC_LZW       = 1,
496         R_IMF_TIFF_CODEC_PACKBITS  = 2,
497         R_IMF_TIFF_CODEC_NONE      = 3,
498 };
499
500 typedef struct BakeData {
501         struct ImageFormatData im_format;
502
503         char filepath[1024]; /* FILE_MAX */
504
505         short width, height;
506         short margin, flag;
507
508         float cage_extrusion;
509         int pass_filter;
510
511         char normal_swizzle[3];
512         char normal_space;
513
514         char save_mode;
515         char pad[3];
516
517         char cage[64];  /* MAX_NAME */
518 } BakeData;
519
520 /* BakeData.normal_swizzle (char) */
521 typedef enum eBakeNormalSwizzle {
522         R_BAKE_POSX = 0,
523         R_BAKE_POSY = 1,
524         R_BAKE_POSZ = 2,
525         R_BAKE_NEGX = 3,
526         R_BAKE_NEGY = 4,
527         R_BAKE_NEGZ = 5,
528 } eBakeNormalSwizzle;
529
530 /* BakeData.save_mode (char) */
531 typedef enum eBakeSaveMode {
532         R_BAKE_SAVE_INTERNAL = 0,
533         R_BAKE_SAVE_EXTERNAL = 1,
534 } eBakeSaveMode;
535
536 /* BakeData.pass_filter */
537 typedef enum eBakePassFilter {
538         R_BAKE_PASS_FILTER_NONE           = 0,
539         R_BAKE_PASS_FILTER_AO             = (1 << 0),
540         R_BAKE_PASS_FILTER_EMIT           = (1 << 1),
541         R_BAKE_PASS_FILTER_DIFFUSE        = (1 << 2),
542         R_BAKE_PASS_FILTER_GLOSSY         = (1 << 3),
543         R_BAKE_PASS_FILTER_TRANSM         = (1 << 4),
544         R_BAKE_PASS_FILTER_SUBSURFACE     = (1 << 5),
545         R_BAKE_PASS_FILTER_DIRECT         = (1 << 6),
546         R_BAKE_PASS_FILTER_INDIRECT       = (1 << 7),
547         R_BAKE_PASS_FILTER_COLOR          = (1 << 8),
548 } eBakePassFilter;
549
550 #define R_BAKE_PASS_FILTER_ALL (~0)
551
552 /* RenderEngineSettingsClay.options */
553 typedef enum ClayFlagSettings {
554         CLAY_USE_AO     = (1 << 0),
555         CLAY_USE_HSV    = (1 << 1),
556 } ClayFlagSettings;
557
558 /* *************************************************************** */
559 /* Render Data */
560
561 typedef struct RenderData {
562         struct ImageFormatData im_format;
563
564         struct AviCodecData *avicodecdata;
565         struct FFMpegCodecData ffcodecdata;
566
567         int cfra, sfra, efra;   /* frames as in 'images' */
568         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
569         int psfra, pefra;               /* start+end frames of preview range */
570
571         int images, framapto;
572         short flag, threads;
573
574         float framelen, blurfac;
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 size; /* size in % */
583
584         short pad6;
585
586         /* from buttons: */
587         /**
588          * The desired number of pixels in the x direction
589          */
590         int xsch;
591         /**
592          * The desired number of pixels in the y direction
593          */
594         int ysch;
595
596         /**
597          * render tile dimensions
598          */
599         int tilex, tiley;
600
601         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
602
603         /**
604          * Render to image editor, fullscreen or to new window.
605          */
606         short displaymode;
607         char use_lock_interface;
608         char pad7;
609
610         /**
611          * Flags for render settings. Use bit-masking to access the settings.
612          */
613         int scemode;
614
615         /**
616          * Flags for render settings. Use bit-masking to access the settings.
617          */
618         int mode;
619
620         /**
621          * What to do with the sky/background. Picks sky/premul/key
622          * blending for the background
623          */
624         short alphamode;
625
626         /**
627          * The number of samples to use per pixel.
628          */
629         short osa;
630
631         short frs_sec, pad[7];
632
633
634         /* safety, border and display rect */
635         rctf safety, border;
636         rcti disprect;
637
638         /* information on different layers to be rendered */
639         ListBase layers DNA_DEPRECATED; /* Converted to Scene->view_layers. */
640         short actlay DNA_DEPRECATED; /* Converted to Scene->active_layer. */
641         short pad1;
642
643         /**
644          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
645          */
646         float xasp, yasp;
647
648         float frs_sec_base;
649
650         /**
651          * Value used to define filter size for all filter options  */
652         float gauss;
653
654
655         /* color management settings - color profiles, gamma correction, etc */
656         int color_mgt_flag;
657
658          /* Dither noise intensity */
659         float dither_intensity;
660
661         /* Bake Render options */
662         short bake_mode, bake_flag;
663         short bake_filter, bake_samples;
664         float bake_biasdist, bake_user_scale;
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;  /* UNUSED! */
683         char seq_flag; /* flag use for sequence render/draw */
684         char pad5[5];
685
686         /* render simplify */
687         short simplify_subsurf;
688         short simplify_subsurf_render;
689         short pad9, pad10;
690         float simplify_particles;
691         float simplify_particles_render;
692
693         /* Freestyle line thickness options */
694         int line_thickness_mode;
695         float unit_line_thickness; /* in pixels */
696
697         /* render engine */
698         char engine[32];
699         int pad2;
700
701         /* Cycles baking */
702         struct BakeData bake;
703
704         int preview_start_resolution;
705         short preview_pixel_size;
706
707         /* Type of the debug pass to use.
708          * Only used when built with debug passes support.
709          */
710         short debug_pass_type;
711
712         /* MultiView */
713         ListBase views;  /* SceneRenderView */
714         short actview;
715         short views_format;
716
717         /* Hair Display */
718         short hair_type, hair_subdiv;
719
720         /* Motion blur shutter */
721         struct CurveMapping mblur_shutter_curve;
722 } RenderData;
723
724 /* RenderData.hair_type */
725 typedef enum eHairType {
726         SCE_HAIR_SHAPE_STRAND      = 0,
727         SCE_HAIR_SHAPE_STRIP       = 1,
728 } eHairType;
729
730
731 /* *************************************************************** */
732 /* Render Conversion/Simplfication Settings */
733
734 /* control render convert and shading engine */
735 typedef struct RenderProfile {
736         struct RenderProfile *next, *prev;
737         char name[32];
738
739         short particle_perc;
740         short subsurf_max;
741         short shadbufsample_max;
742         short pad1;
743
744         float ao_error, pad2;
745
746 } RenderProfile;
747
748 /* UV Paint */
749 /* ToolSettings.uv_sculpt_settings */
750 #define UV_SCULPT_LOCK_BORDERS                          1
751 #define UV_SCULPT_ALL_ISLANDS                           2
752
753 /* ToolSettings.uv_sculpt_tool */
754 #define UV_SCULPT_TOOL_PINCH                            1
755 #define UV_SCULPT_TOOL_RELAX                            2
756 #define UV_SCULPT_TOOL_GRAB                                     3
757
758 /* ToolSettings.uv_relax_method */
759 #define UV_SCULPT_TOOL_RELAX_LAPLACIAN  1
760 #define UV_SCULPT_TOOL_RELAX_HC                 2
761
762 /* Stereo Flags */
763 #define STEREO_RIGHT_NAME "right"
764 #define STEREO_LEFT_NAME "left"
765 #define STEREO_RIGHT_SUFFIX "_R"
766 #define STEREO_LEFT_SUFFIX "_L"
767
768 /* View3D.stereo3d_camera / View3D.multiview_eye / ImageUser.multiview_eye */
769 typedef enum eStereoViews {
770         STEREO_LEFT_ID = 0,
771         STEREO_RIGHT_ID = 1,
772         STEREO_3D_ID = 2,
773         STEREO_MONO_ID = 3,
774 } eStereoViews;
775
776 /* *************************************************************** */
777 /* Markers */
778
779 typedef struct TimeMarker {
780         struct TimeMarker *next, *prev;
781         int frame;
782         char name[64];
783         unsigned int flag;
784         struct Object *camera;
785 } TimeMarker;
786
787 /* *************************************************************** */
788 /* Paint Mode/Tool Data */
789
790 #define PAINT_MAX_INPUT_SAMPLES 64
791
792 /* Paint Tool Base */
793 typedef struct Paint {
794         struct Brush *brush;
795         struct Palette *palette;
796         struct CurveMapping *cavity_curve; /* cavity curve */
797
798         /* WM Paint cursor */
799         void *paint_cursor;
800         unsigned char paint_cursor_col[4];
801
802         /* enum ePaintFlags */
803         int flags;
804
805         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to
806          * smooth the stroke */
807         int num_input_samples;
808
809         /* flags used for symmetry */
810         int symmetry_flags;
811
812         float tile_offset[3];
813         int pad2;
814 } Paint;
815
816 /* ------------------------------------------- */
817 /* Image Paint */
818
819 /* Texture/Image Editor */
820 typedef struct ImagePaintSettings {
821         Paint paint;
822
823         short flag, missing_data;
824
825         /* for projection painting only */
826         short seam_bleed, normal_angle;
827         short screen_grab_size[2]; /* capture size for re-projection */
828
829         int mode;                  /* mode used for texture painting */
830
831         void *paintcursor;                 /* wm handle */
832         struct Image *stencil;     /* workaround until we support true layer masks */
833         struct Image *clone;       /* clone layer for image mode for projective texture painting */
834         struct Image *canvas;      /* canvas when the explicit system is used for painting */
835         float stencil_col[3];
836         float dither;              /* dither amount used when painting on byte images */
837 } ImagePaintSettings;
838
839 /* ------------------------------------------- */
840 /* Particle Edit */
841
842 /* Settings for a Particle Editing Brush */
843 typedef struct ParticleBrushData {
844         short size;                                             /* common setting */
845         short step, invert, count;              /* for specific brushes only */
846         int flag;
847         float strength;
848 } ParticleBrushData;
849
850 /* Particle Edit Mode Settings */
851 typedef struct ParticleEditSettings {
852         short flag;
853         short totrekey;
854         short totaddkey;
855         short brushtype;
856
857         ParticleBrushData brush[7];
858         void *paintcursor;                      /* runtime */
859
860         float emitterdist, rt;
861
862         int selectmode;
863         int edittype;
864
865         int draw_step, fade_frames;
866
867         struct Scene *scene;
868         struct Object *object;
869         struct Object *shape_object;
870 } ParticleEditSettings;
871
872 /* ------------------------------------------- */
873 /* Sculpt */
874
875 /* Sculpt */
876 typedef struct Sculpt {
877         Paint paint;
878
879         /* For rotating around a pivot point */
880         //float pivot[3]; XXX not used?
881         int flags;
882
883         /* Control tablet input */
884         //char tablet_size, tablet_strength; XXX not used?
885         int radial_symm[3];
886
887         /* Maximum edge length for dynamic topology sculpting (in pixels) */
888         float detail_size;
889
890         /* Direction used for SCULPT_OT_symmetrize operator */
891         int symmetrize_direction;
892
893         /* gravity factor for sculpting */
894         float gravity_factor;
895
896         /* scale for constant detail size */
897         float constant_detail; /* Constant detail resolution (Blender unit / constant_detail) */
898         float detail_percent;
899         float pad;
900
901         struct Object *gravity_object;
902 } Sculpt;
903
904 typedef struct UvSculpt {
905         Paint paint;
906 } UvSculpt;
907
908 /* ------------------------------------------- */
909 /* Vertex Paint */
910
911 /* Vertex Paint */
912 typedef struct VPaint {
913         Paint paint;
914         char flag;
915         char pad[3];
916         int radial_symm[3]; /* For mirrored painting */
917 } VPaint;
918
919 /* VPaint.flag */
920 enum {
921         /* weight paint only */
922         VP_FLAG_VGROUP_RESTRICT     = (1 << 7)
923 };
924
925 /* ------------------------------------------- */
926 /* GPencil Stroke Sculpting */
927
928 /* GP_BrushEdit_Settings.brushtype */
929 typedef enum eGP_EditBrush_Types {
930         GP_EDITBRUSH_TYPE_SMOOTH    = 0,
931         GP_EDITBRUSH_TYPE_THICKNESS = 1,
932         GP_EDITBRUSH_TYPE_GRAB      = 2,
933         GP_EDITBRUSH_TYPE_PUSH      = 3,
934         GP_EDITBRUSH_TYPE_TWIST     = 4,
935         GP_EDITBRUSH_TYPE_PINCH     = 5,
936         GP_EDITBRUSH_TYPE_RANDOMIZE = 6,
937         GP_EDITBRUSH_TYPE_SUBDIVIDE = 7,
938         GP_EDITBRUSH_TYPE_SIMPLIFY  = 8,
939         GP_EDITBRUSH_TYPE_CLONE     = 9,
940         GP_EDITBRUSH_TYPE_STRENGTH  = 10,
941
942         /* !!! Update GP_EditBrush_Data brush[###]; below !!! */
943         TOT_GP_EDITBRUSH_TYPES
944 } eGP_EditBrush_Types;
945
946 /* GP_BrushEdit_Settings.lock_axis */
947 typedef enum eGP_Lockaxis_Types {
948         GP_LOCKAXIS_NONE = 0,
949         GP_LOCKAXIS_X = 1,
950         GP_LOCKAXIS_Y = 2,
951         GP_LOCKAXIS_Z = 3
952 } eGP_Lockaxis_Types;
953
954 /* Settings for a GPencil Stroke Sculpting Brush */
955 typedef struct GP_EditBrush_Data {
956         short size;             /* radius of brush */
957         short flag;             /* eGP_EditBrush_Flag */
958         float strength;         /* strength of effect */
959 } GP_EditBrush_Data;
960
961 /* GP_EditBrush_Data.flag */
962 typedef enum eGP_EditBrush_Flag {
963         /* invert the effect of the brush */
964         GP_EDITBRUSH_FLAG_INVERT       = (1 << 0),
965         /* adjust strength using pen pressure */
966         GP_EDITBRUSH_FLAG_USE_PRESSURE = (1 << 1),
967
968         /* strength of brush falls off with distance from cursor */
969         GP_EDITBRUSH_FLAG_USE_FALLOFF  = (1 << 2),
970
971         /* smooth brush affects pressure values as well */
972         GP_EDITBRUSH_FLAG_SMOOTH_PRESSURE  = (1 << 3)
973 } eGP_EditBrush_Flag;
974
975
976
977 /* GPencil Stroke Sculpting Settings */
978 typedef struct GP_BrushEdit_Settings {
979         GP_EditBrush_Data brush[11];  /* TOT_GP_EDITBRUSH_TYPES */
980         void *paintcursor;            /* runtime */
981
982         int brushtype;                /* eGP_EditBrush_Types */
983         int flag;                     /* eGP_BrushEdit_SettingsFlag */
984         int lock_axis;                /* eGP_Lockaxis_Types lock drawing to one axis */
985         float alpha;                  /* alpha factor for selection color */
986 } GP_BrushEdit_Settings;
987
988 /* GP_BrushEdit_Settings.flag */
989 typedef enum eGP_BrushEdit_SettingsFlag {
990         /* only affect selected points */
991         GP_BRUSHEDIT_FLAG_SELECT_MASK = (1 << 0),
992         /* apply brush to position */
993         GP_BRUSHEDIT_FLAG_APPLY_POSITION = (1 << 1),
994         /* apply brush to strength */
995         GP_BRUSHEDIT_FLAG_APPLY_STRENGTH = (1 << 2),
996         /* apply brush to thickness */
997         GP_BRUSHEDIT_FLAG_APPLY_THICKNESS = (1 << 3),
998 } eGP_BrushEdit_SettingsFlag;
999
1000
1001 /* Settings for GP Interpolation Operators */
1002 typedef struct GP_Interpolate_Settings {
1003         short flag;                        /* eGP_Interpolate_SettingsFlag */
1004
1005         char type;                         /* eGP_Interpolate_Type - Interpolation Mode */
1006         char easing;                       /* eBezTriple_Easing - Easing mode (if easing equation used) */
1007
1008         float back;                        /* BEZT_IPO_BACK */
1009         float amplitude, period;           /* BEZT_IPO_ELASTIC */
1010
1011         struct CurveMapping *custom_ipo;   /* custom interpolation curve (for use with GP_IPO_CURVEMAP) */
1012 } GP_Interpolate_Settings;
1013
1014 /* GP_Interpolate_Settings.flag */
1015 typedef enum eGP_Interpolate_SettingsFlag {
1016         /* apply interpolation to all layers */
1017         GP_TOOLFLAG_INTERPOLATE_ALL_LAYERS    = (1 << 0),
1018         /* apply interpolation to only selected */
1019         GP_TOOLFLAG_INTERPOLATE_ONLY_SELECTED = (1 << 1),
1020 } eGP_Interpolate_SettingsFlag;
1021
1022 /* GP_Interpolate_Settings.type */
1023 typedef enum eGP_Interpolate_Type {
1024         /* Traditional Linear Interpolation */
1025         GP_IPO_LINEAR   = 0,
1026
1027         /* CurveMap Defined Interpolation */
1028         GP_IPO_CURVEMAP = 1,
1029
1030         /* Easing Equations */
1031         GP_IPO_BACK = 3,
1032         GP_IPO_BOUNCE = 4,
1033         GP_IPO_CIRC = 5,
1034         GP_IPO_CUBIC = 6,
1035         GP_IPO_ELASTIC = 7,
1036         GP_IPO_EXPO = 8,
1037         GP_IPO_QUAD = 9,
1038         GP_IPO_QUART = 10,
1039         GP_IPO_QUINT = 11,
1040         GP_IPO_SINE = 12,
1041 } eGP_Interpolate_Type;
1042
1043 /* *************************************************************** */
1044 /* Unified Paint Settings
1045  */
1046
1047 /* These settings can override the equivalent fields in the active
1048  * Brush for any paint mode; the flag field controls whether these
1049  * values are used */
1050 typedef struct UnifiedPaintSettings {
1051         /* unified radius of brush in pixels */
1052         int size;
1053
1054         /* unified radius of brush in Blender units */
1055         float unprojected_radius;
1056
1057         /* unified strength of brush */
1058         float alpha;
1059
1060         /* unified brush weight, [0, 1] */
1061         float weight;
1062
1063         /* unified brush color */
1064         float rgb[3];
1065         /* unified brush secondary color */
1066         float secondary_rgb[3];
1067
1068         /* user preferences for sculpt and paint */
1069         int flag;
1070
1071         /* rake rotation */
1072
1073         /* record movement of mouse so that rake can start at an intuitive angle */
1074         float last_rake[2];
1075         float last_rake_angle;
1076
1077         int last_stroke_valid;
1078         float average_stroke_accum[3];
1079         int average_stroke_counter;
1080
1081
1082         float brush_rotation;
1083         float brush_rotation_sec;
1084
1085         /*********************************************************************************
1086          *  all data below are used to communicate with cursor drawing and tex sampling  *
1087          *********************************************************************************/
1088         int anchored_size;
1089
1090         float overlap_factor; /* normalization factor due to accumulated value of curve along spacing.
1091                                * Calculated when brush spacing changes to dampen strength of stroke
1092                                * if space attenuation is used*/
1093         char draw_inverted;
1094         /* check is there an ongoing stroke right now */
1095         char stroke_active;
1096
1097         char draw_anchored;
1098         char do_linear_conversion;
1099
1100         /* store last location of stroke or whether the mesh was hit. Valid only while stroke is active */
1101         float last_location[3];
1102         int last_hit;
1103
1104         float anchored_initial_mouse[2];
1105
1106         /* radius of brush, premultiplied with pressure.
1107          * In case of anchored brushes contains the anchored radius */
1108         float pixel_radius;
1109
1110         /* drawing pressure */
1111         float size_pressure_value;
1112
1113         /* position of mouse, used to sample the texture */
1114         float tex_mouse[2];
1115
1116         /* position of mouse, used to sample the mask texture */
1117         float mask_tex_mouse[2];
1118
1119         /* ColorSpace cache to avoid locking up during sampling */
1120         struct ColorSpace *colorspace;
1121 } UnifiedPaintSettings;
1122
1123 /* UnifiedPaintSettings.flag */
1124 typedef enum {
1125         UNIFIED_PAINT_SIZE  = (1 << 0),
1126         UNIFIED_PAINT_ALPHA = (1 << 1),
1127         UNIFIED_PAINT_WEIGHT = (1 << 5),
1128         UNIFIED_PAINT_COLOR = (1 << 6),
1129
1130         /* only used if unified size is enabled, mirrors the brush flags
1131          * BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
1132         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1 << 2),
1133         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1 << 3),
1134
1135         /* only used if unified alpha is enabled, mirrors the brush flag
1136          * BRUSH_ALPHA_PRESSURE */
1137         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1 << 4)
1138 } eUnifiedPaintSettingsFlags;
1139
1140
1141 typedef struct CurvePaintSettings {
1142         char curve_type;
1143         char flag;
1144         char depth_mode;
1145         char surface_plane;
1146         char fit_method;
1147         char pad;
1148         short error_threshold;
1149         float radius_min, radius_max;
1150         float radius_taper_start, radius_taper_end;
1151         float surface_offset;
1152         float corner_angle;
1153 } CurvePaintSettings;
1154
1155 /* CurvePaintSettings.flag */
1156 enum {
1157         CURVE_PAINT_FLAG_CORNERS_DETECT             = (1 << 0),
1158         CURVE_PAINT_FLAG_PRESSURE_RADIUS            = (1 << 1),
1159         CURVE_PAINT_FLAG_DEPTH_STROKE_ENDPOINTS     = (1 << 2),
1160         CURVE_PAINT_FLAG_DEPTH_STROKE_OFFSET_ABS    = (1 << 3),
1161 };
1162
1163 /* CurvePaintSettings.fit_method */
1164 enum {
1165         CURVE_PAINT_FIT_METHOD_REFIT            = 0,
1166         CURVE_PAINT_FIT_METHOD_SPLIT            = 1,
1167 };
1168
1169 /* CurvePaintSettings.depth_mode */
1170 enum {
1171         CURVE_PAINT_PROJECT_CURSOR              = 0,
1172         CURVE_PAINT_PROJECT_SURFACE             = 1,
1173 };
1174
1175 /* CurvePaintSettings.surface_plane */
1176 enum {
1177         CURVE_PAINT_SURFACE_PLANE_NORMAL_VIEW           = 0,
1178         CURVE_PAINT_SURFACE_PLANE_NORMAL_SURFACE        = 1,
1179         CURVE_PAINT_SURFACE_PLANE_VIEW                  = 2,
1180 };
1181
1182
1183 /* *************************************************************** */
1184 /* Stats */
1185
1186 /* Stats for Meshes */
1187 typedef struct MeshStatVis {
1188         char type;
1189         char _pad1[2];
1190
1191         /* overhang */
1192         char  overhang_axis;
1193         float overhang_min, overhang_max;
1194
1195         /* thickness */
1196         float thickness_min, thickness_max;
1197         char thickness_samples;
1198         char _pad2[3];
1199
1200         /* distort */
1201         float distort_min, distort_max;
1202
1203         /* sharp */
1204         float sharp_min, sharp_max;
1205 } MeshStatVis;
1206
1207
1208 /* *************************************************************** */
1209 /* Tool Settings */
1210
1211 typedef struct ToolSettings {
1212         VPaint *vpaint;         /* vertex paint */
1213         VPaint *wpaint;         /* weight paint */
1214         Sculpt *sculpt;
1215         UvSculpt *uvsculpt;     /* uv smooth */
1216
1217         /* Vertex group weight - used only for editmode, not weight
1218          * paint */
1219         float vgroup_weight;
1220
1221         float doublimit;        /* remove doubles limit */
1222         char automerge;
1223         char object_flag;
1224
1225         /* Selection Mode for Mesh */
1226         short selectmode;
1227
1228         /* UV Calculation */
1229         char unwrapper;
1230         char uvcalc_flag;
1231         char uv_flag;
1232         char uv_selectmode;
1233
1234         float uvcalc_margin;
1235
1236         /* Auto-IK */
1237         short autoik_chainlen;  /* runtime only */
1238
1239         /* SCE_MPR_LOC/SCAL */
1240         char gizmo_flag;
1241
1242         /* Grease Pencil */
1243         char gpencil_flags;             /* flags/options for how the tool works */
1244         char gpencil_src;               /* for main 3D view Grease Pencil, where data comes from */
1245
1246         char gpencil_v3d_align; /* stroke placement settings: 3D View */
1247         char gpencil_v2d_align; /*                          : General 2D Editor */
1248         char gpencil_seq_align; /*                          : Sequencer Preview */
1249         char gpencil_ima_align; /*                          : Image Editor */
1250
1251         char _pad3[3];
1252
1253         /* Grease Pencil Sculpt */
1254         struct GP_BrushEdit_Settings gp_sculpt;
1255
1256         /* Grease Pencil Interpolation Tool(s) */
1257         struct GP_Interpolate_Settings gp_interpolate;
1258
1259         /* Grease Pencil Drawing Brushes (bGPDbrush) */
1260         ListBase gp_brushes;
1261
1262         /* Image Paint (8 byttse aligned please!) */
1263         struct ImagePaintSettings imapaint;
1264
1265         /* Particle Editing */
1266         struct ParticleEditSettings particle;
1267
1268         /* Transform Proportional Area of Effect */
1269         float proportional_size;
1270
1271         /* Select Group Threshold */
1272         float select_thresh;
1273
1274         /* Auto-Keying Mode */
1275         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
1276         char keyframe_type;                 /* keyframe type (see DNA_curve_types.h) */
1277
1278         /* Multires */
1279         char multires_subdiv_type;
1280
1281         /* Alt+RMB option */
1282         char edge_mode;
1283         char edge_mode_live_unwrap;
1284         char _pad1;
1285
1286         /* Transform */
1287         char transform_pivot_point;
1288         char transform_flag;
1289         char snap_mode, snap_node_mode;
1290         char snap_uv_mode;
1291         char snap_flag;
1292         char snap_target;
1293         short proportional, prop_mode;
1294         char proportional_objects; /* proportional edit, object mode */
1295         char proportional_mask; /* proportional edit, mask editing */
1296         char proportional_action; /* proportional edit, action editor */
1297         char proportional_fcurve; /* proportional edit, graph editor */
1298         char lock_markers; /* lock marker editing */
1299         char pad4[5];
1300
1301         char auto_normalize; /*auto normalizing mode in wpaint*/
1302         char multipaint; /* paint multiple bones in wpaint */
1303         char weightuser;
1304         char vgroupsubset; /* subset selection filter in wpaint */
1305
1306         /* UV painting */
1307         char _pad2[2];
1308         char use_uv_sculpt;
1309         char uv_sculpt_settings;
1310         char uv_sculpt_tool;
1311         char uv_relax_method;
1312         /* XXX: these sculpt_paint_* fields are deprecated, use the
1313          * unified_paint_settings field instead! */
1314         short sculpt_paint_settings DNA_DEPRECATED;     short pad5;
1315         int sculpt_paint_unified_size DNA_DEPRECATED;
1316         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
1317         float sculpt_paint_unified_alpha DNA_DEPRECATED;
1318
1319         /* Unified Paint Settings */
1320         struct UnifiedPaintSettings unified_paint_settings;
1321
1322         struct CurvePaintSettings curve_paint_settings;
1323
1324         struct MeshStatVis statvis;
1325
1326         /* Normal Editing */
1327         float normal_vector[3];
1328         int face_strength;
1329 } ToolSettings;
1330
1331 /* *************************************************************** */
1332 /* Assorted Scene Data */
1333
1334 /* ------------------------------------------- */
1335 /* Stats (show in Info header) */
1336
1337 typedef struct bStats {
1338         /* scene totals for visible layers */
1339         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
1340         int totvert, totface;
1341 } bStats;
1342
1343 /* ------------------------------------------- */
1344 /* Unit Settings */
1345
1346 typedef struct UnitSettings {
1347         /* Display/Editing unit options for each scene */
1348         float scale_length; /* maybe have other unit conversions? */
1349         char system; /* imperial, metric etc */
1350         char system_rotation; /* not implemented as a proper unit system yet */
1351         short flag;
1352 } UnitSettings;
1353
1354 /* ------------------------------------------- */
1355 /* Global/Common Physics Settings */
1356
1357 typedef struct PhysicsSettings {
1358         float gravity[3];
1359         int flag, quick_cache_step, rt;
1360 } PhysicsSettings;
1361
1362 /* ------------------------------------------- */
1363 /* Safe Area options used in Camera View & VSE
1364  */
1365 typedef struct DisplaySafeAreas {
1366         /* each value represents the (x,y) margins as a multiplier.
1367          * 'center' in this context is just the name for a different kind of safe-area */
1368
1369         float title[2];         /* Title Safe */
1370         float action[2];        /* Image/Graphics Safe */
1371
1372         /* use for alternate aspect ratio */
1373         float title_center[2];
1374         float action_center[2];
1375 } DisplaySafeAreas;
1376
1377 /* ------------------------------------------- */
1378 /* Scene Display - used for store scene specific display settings for the 3d view */
1379 typedef struct SceneDisplay {
1380         float light_direction[3];      /* light direction for shadows/highlight */
1381         float shadow_shift;
1382
1383         /* Settings for Cavity Shader */
1384         float matcap_ssao_distance;
1385         float matcap_ssao_attenuation;
1386         int matcap_ssao_samples;
1387         int pad;
1388
1389         /* OpenGL render engine settings. */
1390         View3DShading shading;
1391 } SceneDisplay;
1392
1393 typedef struct SceneEEVEE {
1394         int flag;
1395         int gi_diffuse_bounces;
1396         int gi_cubemap_resolution;
1397         int gi_visibility_resolution;
1398
1399         float gi_cubemap_draw_size;
1400         float gi_irradiance_draw_size;
1401
1402         int taa_samples;
1403         int taa_render_samples;
1404         int sss_samples;
1405         float sss_jitter_threshold;
1406
1407         float ssr_quality;
1408         float ssr_max_roughness;
1409         float ssr_thickness;
1410         float ssr_border_fade;
1411         float ssr_firefly_fac;
1412
1413         float volumetric_start;
1414         float volumetric_end;
1415         int volumetric_tile_size;
1416         int volumetric_samples;
1417         float volumetric_sample_distribution;
1418         float volumetric_light_clamp;
1419         int volumetric_shadow_samples;
1420
1421         float gtao_distance;
1422         float gtao_factor;
1423         float gtao_quality;
1424
1425         float bokeh_max_size;
1426         float bokeh_threshold;
1427
1428         float bloom_color[3];
1429         float bloom_threshold;
1430         float bloom_knee;
1431         float bloom_intensity;
1432         float bloom_radius;
1433         float bloom_clamp;
1434
1435         int motion_blur_samples;
1436         float motion_blur_shutter;
1437
1438         int shadow_method;
1439         int shadow_cube_size;
1440         int shadow_cascade_size;
1441
1442         struct LightCache *light_cache;
1443         char light_cache_info[64];
1444 } SceneEEVEE;
1445
1446 /* *************************************************************** */
1447 /* Scene ID-Block */
1448
1449 typedef struct Scene {
1450         ID id;
1451         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
1452
1453         struct Object *camera;
1454         struct World *world;
1455
1456         struct Scene *set;
1457
1458         ListBase base DNA_DEPRECATED;
1459         struct Base  *basact DNA_DEPRECATED; /* active base */
1460         void *_pad1;
1461
1462         View3DCursor cursor;                    /* 3d cursor location */
1463
1464         unsigned int lay;                       /* bitflags for layer visibility */
1465         int layact;             /* active layer */
1466         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1467
1468         short flag;                                                             /* various settings */
1469
1470         char use_nodes;
1471         char pad[1];
1472
1473         struct bNodeTree *nodetree;
1474
1475         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1476
1477         struct ToolSettings *toolsettings;              /* default allocated now */
1478         void *pad2;
1479         struct DisplaySafeAreas safe_areas;
1480
1481         /* migrate or replace? depends on some internal things... */
1482         /* no, is on the right place (ton) */
1483         struct RenderData r;
1484         struct AudioData audio;
1485
1486         ListBase markers;
1487         ListBase transform_spaces;
1488
1489         int orientation_index_custom;
1490         int orientation_type;
1491
1492         void *sound_scene;
1493         void *playback_handle;
1494         void *sound_scrub_handle;
1495         void *speaker_handles;
1496
1497         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1498
1499         /* none of the dependency graph  vars is mean to be saved */
1500         struct GHash *depsgraph_hash;
1501         int pad7;
1502
1503         /* User-Defined KeyingSets */
1504         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1505         ListBase keyingsets;                    /* KeyingSets for this scene */
1506
1507         /* Units */
1508         struct UnitSettings unit;
1509
1510         /* Grease Pencil */
1511         struct bGPdata *gpd;
1512
1513         /* Movie Tracking */
1514         struct MovieClip *clip;                 /* active movie clip */
1515
1516         /* Physics simulation settings */
1517         struct PhysicsSettings physics_settings;
1518
1519         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by BKE_object_handle_update() */
1520         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1521
1522         /* Color Management */
1523         ColorManagedViewSettings view_settings;
1524         ColorManagedDisplaySettings display_settings;
1525         ColorManagedColorspaceSettings sequencer_colorspace_settings;
1526
1527         /* RigidBody simulation world+settings */
1528         struct RigidBodyWorld *rigidbody_world;
1529
1530         struct PreviewImage *preview;
1531
1532         ListBase view_layers;
1533         /* Not an actual datablock, but memory owned by scene. */
1534         Collection *master_collection;
1535         struct SceneCollection *collection DNA_DEPRECATED;
1536
1537         IDProperty *layer_properties;  /* settings to be override by workspaces */
1538
1539         struct SceneDisplay display;
1540         struct SceneEEVEE eevee;
1541 } Scene;
1542
1543 /* **************** RENDERDATA ********************* */
1544
1545 /* RenderData.flag */
1546         /* use preview range */
1547 #define SCER_PRV_RANGE  (1<<0)
1548 #define SCER_LOCK_FRAME_SELECTION       (1<<1)
1549         /* show/use subframes (for checking motion blur) */
1550 #define SCER_SHOW_SUBFRAME      (1<<3)
1551
1552 /* RenderData.mode */
1553 #define R_OSA                   0x0001
1554 /* #define R_SHADOW             0x0002 */
1555 /* #define R_GAMMA                      0x0004 */
1556 #define R_ORTHO                 0x0008
1557 /* #define R_ENVMAP             0x0010 */
1558 /* #define R_EDGE                       0x0020 */
1559 /* #define R_FIELDS             0x0040 */
1560 /*#define R_FIELDSTILL  0x0080 */
1561 /*#define R_RADIO                       0x0100 */ /* deprecated */
1562 #define R_BORDER                0x0200
1563 #define R_PANORAMA              0x0400
1564 #define R_CROP                  0x0800
1565                 /* Disable camera switching: runtime (DURIAN_CAMERA_SWITCH) */
1566 #define R_NO_CAMERA_SWITCH      0x1000
1567 /* #define R_ODDFIELD           0x2000 */
1568 #define R_MBLUR                 0x4000
1569                 /* unified was here */
1570 /* #define R_RAYTRACE      0x10000 */
1571                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1572 /* #define R_GAUSS              0x20000 */
1573                 /* fbuf obsolete... */
1574 /*#define R_FBUF                        0x40000*/
1575                 /* threads obsolete... is there for old files, now use for autodetect threads */
1576 #define R_THREADS               0x80000
1577                 /* Use the same flag for autothreads */
1578 #define R_FIXED_THREADS         0x80000
1579
1580 /* #define R_SPEED                              0x100000 */
1581 /* #define R_SSS                                0x200000 */
1582 #define R_NO_OVERWRITE          0x400000  /* skip existing files */
1583 #define R_TOUCH                         0x800000  /* touch files before rendering */
1584 #define R_SIMPLIFY                      0x1000000
1585 #define R_EDGE_FRS                      0x2000000 /* R_EDGE reserved for Freestyle */
1586 #define R_PERSISTENT_DATA       0x4000000 /* keep data around for re-render */
1587 /* #define R_USE_WS_SHADING     0x8000000 */ /* use world space interpretation of lighting data */
1588
1589 /* RenderData.seq_flag */
1590 enum {
1591         // R_SEQ_GL_PREV = (1 << 1),  // UNUSED, we just use setting from seq_prev_type now.
1592         // R_SEQ_GL_REND = (1 << 2),  // UNUSED, opengl render has its own operator now.
1593         R_SEQ_SOLID_TEX  = (1 << 3),
1594         R_SEQ_CAMERA_DOF = (1 << 4),
1595 };
1596
1597 /* RenderData.displaymode */
1598 #define R_OUTPUT_SCREEN 0
1599 #define R_OUTPUT_AREA   1
1600 #define R_OUTPUT_WINDOW 2
1601 #define R_OUTPUT_NONE   3
1602 /*#define R_OUTPUT_FORKED       4*/
1603
1604 /* RenderData.filtertype (used for nodes) */
1605 #define R_FILTER_BOX    0
1606 #define R_FILTER_TENT   1
1607 #define R_FILTER_QUAD   2
1608 #define R_FILTER_CUBIC  3
1609 #define R_FILTER_CATROM 4
1610 #define R_FILTER_GAUSS  5
1611 #define R_FILTER_MITCH  6
1612 #define R_FILTER_FAST_GAUSS     7
1613
1614 /* RenderData.scemode (int now) */
1615 #define R_DOSEQ                         0x0001
1616 #define R_BG_RENDER                     0x0002
1617                 /* passepartout is camera option now, keep this for backward compatibility */
1618 #define R_PASSEPARTOUT          0x0004
1619 #define R_BUTS_PREVIEW          0x0008
1620 #define R_EXTENSION                     0x0010
1621 #define R_MATNODE_PREVIEW       0x0020
1622 #define R_DOCOMP                        0x0040
1623 #define R_COMP_CROP                     0x0080
1624 /* #define R_FREE_IMAGE         0x0100 */
1625 #define R_SINGLE_LAYER          0x0200
1626 #define R_EXR_TILE_FILE         0x0400
1627 /* #define R_COMP_FREE                  0x0800 */
1628 #define R_NO_IMAGE_LOAD         0x1000
1629 /* #define R_NO_TEX                     0x2000 */
1630 #define R_NO_FRAME_UPDATE       0x4000
1631 #define R_FULL_SAMPLE           0x8000
1632 /* #define R_DEPRECATED         0x10000 */
1633 /* #define R_RECURS_PROTECTION  0x20000 */
1634 #define R_TEXNODE_PREVIEW       0x40000
1635 /* #define R_VIEWPORT_PREVIEW   0x80000 */
1636 #define R_EXR_CACHE_FILE        0x100000
1637 #define R_MULTIVIEW                     0x200000
1638
1639 /* RenderData.stamp */
1640 #define R_STAMP_TIME    0x0001
1641 #define R_STAMP_FRAME   0x0002
1642 #define R_STAMP_DATE    0x0004
1643 #define R_STAMP_CAMERA  0x0008
1644 #define R_STAMP_SCENE   0x0010
1645 #define R_STAMP_NOTE    0x0020
1646 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1647 #define R_STAMP_MARKER  0x0080
1648 #define R_STAMP_FILENAME        0x0100
1649 #define R_STAMP_SEQSTRIP        0x0200
1650 #define R_STAMP_RENDERTIME      0x0400
1651 #define R_STAMP_CAMERALENS      0x0800
1652 #define R_STAMP_STRIPMETA       0x1000
1653 #define R_STAMP_MEMORY          0x2000
1654 #define R_STAMP_HIDE_LABELS     0x4000
1655 #define R_STAMP_FRAME_RANGE     0x8000
1656 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1657                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1658                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS|R_STAMP_MEMORY|                 \
1659                      R_STAMP_HIDE_LABELS|R_STAMP_FRAME_RANGE)
1660
1661 /* RenderData.alphamode */
1662 #define R_ADDSKY                0
1663 #define R_ALPHAPREMUL   1
1664 /*#define R_ALPHAKEY            2*/ /* deprecated, shouldn't be used */
1665
1666 /* RenderData.color_mgt_flag */
1667 enum {
1668         R_COLOR_MANAGEMENT              = (1 << 0),  /* deprecated, should only be used in versioning code only */
1669         /*R_COLOR_MANAGEMENT_PREDIVIDE    = (1 << 1)*/  /* deprecated, shouldn't be used */
1670 };
1671
1672 #ifdef DNA_DEPRECATED
1673 /* RenderData.subimtype flag options for imtype */
1674 enum {
1675         R_OPENEXR_HALF  = 1,  /*deprecated*/
1676         R_OPENEXR_ZBUF  = 2,  /*deprecated*/
1677         R_PREVIEW_JPG   = 4,  /*deprecated*/
1678         R_CINEON_LOG    = 8,  /*deprecated*/
1679         R_TIFF_16BIT    = 16, /*deprecated*/
1680
1681         R_JPEG2K_12BIT                  =     32,  /* Jpeg2000 */                    /*deprecated*/
1682         R_JPEG2K_16BIT                  =     64,                                    /*deprecated*/
1683         R_JPEG2K_YCC                    =     128,  /* when disabled use RGB */      /*deprecated*/
1684         R_JPEG2K_CINE_PRESET    =     256,                                   /*deprecated*/
1685         R_JPEG2K_CINE_48FPS             =     512,                                   /*deprecated*/
1686 };
1687 #endif
1688
1689 /* bake_mode: same as RE_BAKE_xxx defines */
1690 /* RenderData.bake_flag */
1691 #define R_BAKE_CLEAR            1
1692 /* #define R_BAKE_OSA           2 */ /* deprecated */
1693 #define R_BAKE_TO_ACTIVE        4
1694 /* #define R_BAKE_NORMALIZE     8 */ /* deprecated */
1695 #define R_BAKE_MULTIRES         16
1696 #define R_BAKE_LORES_MESH       32
1697 /* #define R_BAKE_VCOL          64 */ /* deprecated */
1698 #define R_BAKE_USERSCALE        128
1699 #define R_BAKE_CAGE                     256
1700 #define R_BAKE_SPLIT_MAT        512
1701 #define R_BAKE_AUTO_NAME        1024
1702
1703 /* RenderData.bake_normal_space */
1704 #define R_BAKE_SPACE_CAMERA      0
1705 #define R_BAKE_SPACE_WORLD       1
1706 #define R_BAKE_SPACE_OBJECT      2
1707 #define R_BAKE_SPACE_TANGENT 3
1708
1709 /* RenderData.line_thickness_mode */
1710 #define R_LINE_THICKNESS_ABSOLUTE 1
1711 #define R_LINE_THICKNESS_RELATIVE 2
1712
1713 /* sequencer seq_prev_type seq_rend_type */
1714
1715 /* RenderData.engine (scene.c) */
1716 extern const char *RE_engine_id_BLENDER_EEVEE;
1717 extern const char *RE_engine_id_BLENDER_OPENGL;
1718 extern const char *RE_engine_id_CYCLES;
1719
1720 /* **************** SCENE ********************* */
1721
1722 /* note that much higher maxframes give imprecise sub-frames, see: T46859 */
1723 /* Current precision is 16 for the sub-frames closer to MAXFRAME. */
1724
1725 /* for general use */
1726 #define MAXFRAME        1048574
1727 #define MAXFRAMEF       1048574.0f
1728
1729 #define MINFRAME        0
1730 #define MINFRAMEF       0.0f
1731
1732 /* (minimum frame number for current-frame) */
1733 #define MINAFRAME       -1048574
1734 #define MINAFRAMEF      -1048574.0f
1735
1736 /* deprecate this! */
1737 #define TESTBASE(base)  (                                                     \
1738         (((base)->flag & BASE_SELECTED) != 0) &&                                  \
1739         (((base)->flag & BASE_VISIBLE) != 0))
1740 #define TESTBASELIB(base)  (                                                  \
1741         (((base)->flag & BASE_SELECTED) != 0) &&                                  \
1742         ((base)->object->id.lib == NULL) &&                                       \
1743         (((base)->flag & BASE_VISIBLE) != 0))
1744 #define TESTBASELIB_BGMODE(base)  (                                           \
1745         (((base)->flag & BASE_SELECTED) != 0) &&                                  \
1746         ((base)->object->id.lib == NULL) &&                                       \
1747         (((base)->flag & BASE_VISIBLE) != 0))
1748 #define BASE_EDITABLE_BGMODE(base)  (                                         \
1749         ((base)->object->id.lib == NULL) &&                                       \
1750         (((base)->flag & BASE_VISIBLE) != 0))
1751 #define BASE_SELECTABLE(base)                                                 \
1752         (((base)->flag & BASE_SELECTABLE) != 0)
1753 #define BASE_VISIBLE(base)  (                                                 \
1754         ((base)->flag & BASE_VISIBLE) != 0)
1755
1756 #define FIRSTBASE(_view_layer)  ((_view_layer)->object_bases.first)
1757 #define LASTBASE(_view_layer)   ((_view_layer)->object_bases.last)
1758 #define BASACT(_view_layer)     ((_view_layer)->basact)
1759 #define OBACT(_view_layer)      (BASACT(_view_layer) ? BASACT(_view_layer)->object: NULL)
1760
1761 #define OBEDIT_FROM_WORKSPACE(workspace, _view_layer) \
1762         (((workspace)->object_mode & OD_MODE_EDIT) ? OBACT(_view_layer) : NULL)
1763 #define OBEDIT_FROM_OBACT(ob) \
1764         ((ob) ? (((ob)->mode & OB_MODE_EDIT) ? ob : NULL) : NULL)
1765 #define OBPOSE_FROM_OBACT(ob) \
1766         ((ob) ? (((ob)->mode & OB_MODE_POSE) ? ob : NULL) : NULL)
1767 #define OBEDIT_FROM_VIEW_LAYER(view_layer) \
1768         OBEDIT_FROM_OBACT(OBACT(view_layer))
1769
1770 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1771 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1772
1773 #define CFRA            (scene->r.cfra)
1774 #define SUBFRA          (scene->r.subframe)
1775 #define SFRA            (scene->r.sfra)
1776 #define EFRA            (scene->r.efra)
1777 #define PRVRANGEON      (scene->r.flag & SCER_PRV_RANGE)
1778 #define PSFRA           ((PRVRANGEON) ? (scene->r.psfra) : (scene->r.sfra))
1779 #define PEFRA           ((PRVRANGEON) ? (scene->r.pefra) : (scene->r.efra))
1780 #define FRA2TIME(a)     ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1781 #define TIME2FRA(a)     ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1782 #define FPS              (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1783
1784 /* Base.flag is in DNA_object_types.h */
1785
1786 /* ToolSettings.transform_flag */
1787 enum {
1788         SCE_XFORM_AXIS_ALIGN = (1 << 0),
1789 };
1790
1791 /* ToolSettings.object_flag */
1792 enum {
1793         SCE_OBJECT_MODE_LOCK = (1 << 0),
1794 };
1795
1796 /* ToolSettings.snap_flag */
1797 #define SCE_SNAP                                1
1798 #define SCE_SNAP_ROTATE                 2
1799 #define SCE_SNAP_PEEL_OBJECT    4
1800 #define SCE_SNAP_PROJECT                8
1801 #define SCE_SNAP_NO_SELF                16
1802 #define SCE_SNAP_ABS_GRID               32
1803
1804 /* ToolSettings.snap_target */
1805 #define SCE_SNAP_TARGET_CLOSEST 0
1806 #define SCE_SNAP_TARGET_CENTER  1
1807 #define SCE_SNAP_TARGET_MEDIAN  2
1808 #define SCE_SNAP_TARGET_ACTIVE  3
1809
1810 /* ToolSettings.snap_mode */
1811 #define SCE_SNAP_MODE_VERTEX    (1 << 0)
1812 #define SCE_SNAP_MODE_EDGE      (1 << 1)
1813 #define SCE_SNAP_MODE_FACE      (1 << 2)
1814 #define SCE_SNAP_MODE_VOLUME    (1 << 3)
1815 #define SCE_SNAP_MODE_INCREMENT (1 << 4)
1816
1817 /* ToolSettings.snap_node_mode */
1818 #define SCE_SNAP_MODE_GRID      (1 << 5)
1819 #define SCE_SNAP_MODE_NODE_X    (1 << 6)
1820 #define SCE_SNAP_MODE_NODE_Y    (1 << 7)
1821
1822 /* ToolSettings.selectmode */
1823 #define SCE_SELECT_VERTEX       1 /* for mesh */
1824 #define SCE_SELECT_EDGE         2
1825 #define SCE_SELECT_FACE         4
1826
1827 /* MeshStatVis.type */
1828 #define SCE_STATVIS_OVERHANG    0
1829 #define SCE_STATVIS_THICKNESS   1
1830 #define SCE_STATVIS_INTERSECT   2
1831 #define SCE_STATVIS_DISTORT             3
1832 #define SCE_STATVIS_SHARP               4
1833
1834 /* ParticleEditSettings.selectmode for particles */
1835 #define SCE_SELECT_PATH         1
1836 #define SCE_SELECT_POINT        2
1837 #define SCE_SELECT_END          4
1838
1839 /* ToolSettings.prop_mode (proportional falloff) */
1840 #define PROP_SMOOTH            0
1841 #define PROP_SPHERE            1
1842 #define PROP_ROOT              2
1843 #define PROP_SHARP             3
1844 #define PROP_LIN               4
1845 #define PROP_CONST             5
1846 #define PROP_RANDOM            6
1847 #define PROP_INVSQUARE         7
1848 #define PROP_MODE_MAX          8
1849
1850 /* ToolSettings.proportional */
1851 #define PROP_EDIT_OFF                   0
1852 #define PROP_EDIT_ON                    1
1853 #define PROP_EDIT_CONNECTED             2
1854 #define PROP_EDIT_PROJECTED             3
1855
1856 /* ToolSettings.weightuser */
1857 enum {
1858         OB_DRAW_GROUPUSER_NONE      = 0,
1859         OB_DRAW_GROUPUSER_ACTIVE    = 1,
1860         OB_DRAW_GROUPUSER_ALL       = 2
1861 };
1862
1863 /* toolsettings->face_strength */
1864 enum {
1865         FACE_STRENGTH_WEAK = -16384,
1866         FACE_STRENGTH_MEDIUM = 0,
1867         FACE_STRENGTH_STRONG = 16384,
1868 };
1869
1870 /* object_vgroup.c */
1871 /* ToolSettings.vgroupsubset */
1872 typedef enum eVGroupSelect {
1873         WT_VGROUP_ALL = 0,
1874         WT_VGROUP_ACTIVE = 1,
1875         WT_VGROUP_BONE_SELECT = 2,
1876         WT_VGROUP_BONE_DEFORM = 3,
1877         WT_VGROUP_BONE_DEFORM_OFF = 4
1878 } eVGroupSelect;
1879
1880 #define WT_VGROUP_MASK_ALL \
1881         ((1 << WT_VGROUP_ACTIVE) | \
1882          (1 << WT_VGROUP_BONE_SELECT) | \
1883          (1 << WT_VGROUP_BONE_DEFORM) | \
1884          (1 << WT_VGROUP_BONE_DEFORM_OFF) | \
1885          (1 << WT_VGROUP_ALL))
1886
1887
1888 /* Scene.flag */
1889 #define SCE_DS_SELECTED                 (1<<0)
1890 #define SCE_DS_COLLAPSED                (1<<1)
1891 #define SCE_NLA_EDIT_ON                 (1<<2)
1892 #define SCE_FRAME_DROP                  (1<<3)
1893 #define SCE_KEYS_NO_SELONLY         (1<<4)
1894
1895         /* return flag BKE_scene_base_iter_next functions */
1896 /* #define F_ERROR                      -1 */  /* UNUSED */
1897 #define F_START                 0
1898 #define F_SCENE                 1
1899 #define F_DUPLI                 3
1900
1901 /* AudioData.flag */
1902 #define AUDIO_MUTE                (1<<0)
1903 #define AUDIO_SYNC                (1<<1)
1904 #define AUDIO_SCRUB                       (1<<2)
1905 #define AUDIO_VOLUME_ANIMATED     (1<<3)
1906
1907 /* FFMpegCodecData.flags */
1908 enum {
1909 #ifdef DNA_DEPRECATED
1910         FFMPEG_MULTIPLEX_AUDIO  = 1,  /* deprecated, you can choose none as audiocodec now */
1911 #endif
1912         FFMPEG_AUTOSPLIT_OUTPUT = 2,
1913         FFMPEG_LOSSLESS_OUTPUT  = 4,
1914         FFMPEG_USE_MAX_B_FRAMES = (1 << 3),
1915 };
1916
1917 /* Paint.flags */
1918 typedef enum ePaintFlags {
1919         PAINT_SHOW_BRUSH = (1 << 0),
1920         PAINT_FAST_NAVIGATE = (1 << 1),
1921         PAINT_SHOW_BRUSH_ON_SURFACE = (1 << 2),
1922         PAINT_USE_CAVITY_MASK = (1 << 3)
1923 } ePaintFlags;
1924
1925 /* Paint.symmetry_flags
1926  * (for now just a duplicate of sculpt symmetry flags) */
1927 typedef enum ePaintSymmetryFlags {
1928         PAINT_SYMM_X = (1 << 0),
1929         PAINT_SYMM_Y = (1 << 1),
1930         PAINT_SYMM_Z = (1 << 2),
1931         PAINT_SYMMETRY_FEATHER = (1 << 3),
1932         PAINT_TILE_X = (1 << 4),
1933         PAINT_TILE_Y = (1 << 5),
1934         PAINT_TILE_Z = (1 << 6),
1935 } ePaintSymmetryFlags;
1936
1937 #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z)
1938
1939 /* Sculpt.flags */
1940 /* These can eventually be moved to paint flags? */
1941 typedef enum eSculptFlags {
1942 #ifdef DNA_DEPRECATED
1943         /* deprecated, part of paint struct symmetry_flags now */
1944         SCULPT_SYMM_X = (1 << 0),
1945         SCULPT_SYMM_Y = (1 << 1),
1946         SCULPT_SYMM_Z = (1 << 2),
1947 #endif
1948
1949         SCULPT_LOCK_X = (1 << 3),
1950         SCULPT_LOCK_Y = (1 << 4),
1951         SCULPT_LOCK_Z = (1 << 5),
1952         /* deprecated, part of paint struct symmetry_flags now */
1953         SCULPT_SYMMETRY_FEATHER = (1 << 6),
1954
1955         SCULPT_USE_OPENMP = (1 << 7),
1956         SCULPT_ONLY_DEFORM = (1 << 8),
1957         SCULPT_SHOW_DIFFUSE = (1 << 9),
1958
1959         /* If set, the mesh will be drawn with smooth-shading in
1960          * dynamic-topology mode */
1961         SCULPT_DYNTOPO_SMOOTH_SHADING = (1 << 10),
1962
1963         /* If set, dynamic-topology brushes will subdivide short edges */
1964         SCULPT_DYNTOPO_SUBDIVIDE = (1 << 12),
1965         /* If set, dynamic-topology brushes will collapse short edges */
1966         SCULPT_DYNTOPO_COLLAPSE = (1 << 11),
1967
1968         /* If set, dynamic-topology detail size will be constant in object space */
1969         SCULPT_DYNTOPO_DETAIL_CONSTANT = (1 << 13),
1970         SCULPT_DYNTOPO_DETAIL_BRUSH = (1 << 14),
1971         SCULPT_DYNTOPO_DETAIL_MANUAL = (1 << 16),
1972
1973         /* Don't display mask in viewport, but still use it for strokes. */
1974         SCULPT_HIDE_MASK = (1 << 15),
1975 } eSculptFlags;
1976
1977 /* ImagePaintSettings.mode */
1978 typedef enum eImagePaintMode {
1979         IMAGEPAINT_MODE_MATERIAL, /* detect texture paint slots from the material */
1980         IMAGEPAINT_MODE_IMAGE,    /* select texture paint image directly */
1981 } eImagePaintMode;
1982
1983 /* ImagePaintSettings.flag */
1984 #define IMAGEPAINT_DRAWING                              1
1985 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
1986 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
1987
1988 /* projection painting only */
1989 /* ImagePaintSettings.flag */
1990 #define IMAGEPAINT_PROJECT_XRAY                 (1 << 4)
1991 #define IMAGEPAINT_PROJECT_BACKFACE             (1 << 5)
1992 #define IMAGEPAINT_PROJECT_FLAT                 (1 << 6)
1993 #define IMAGEPAINT_PROJECT_LAYER_CLONE  (1 << 7)
1994 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        (1 << 8)
1995 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    (1 << 9)
1996
1997 /* ImagePaintSettings.missing_data */
1998 #define IMAGEPAINT_MISSING_UVS       (1 << 0)
1999 #define IMAGEPAINT_MISSING_MATERIAL  (1 << 1)
2000 #define IMAGEPAINT_MISSING_TEX       (1 << 2)
2001 #define IMAGEPAINT_MISSING_STENCIL   (1 << 3)
2002
2003 /* ToolSettings.uvcalc_flag */
2004 #define UVCALC_FILLHOLES                        1
2005 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
2006 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
2007 #define UVCALC_USESUBSURF                       8       /* Use mesh data after subsurf to compute UVs*/
2008
2009 /* ToolSettings.uv_flag */
2010 #define UV_SYNC_SELECTION       1
2011 #define UV_SHOW_SAME_IMAGE      2
2012
2013 /* ToolSettings.uv_selectmode */
2014 #define UV_SELECT_VERTEX        1
2015 #define UV_SELECT_EDGE          2
2016 #define UV_SELECT_FACE          4
2017 #define UV_SELECT_ISLAND        8
2018
2019 /* ToolSettings.edge_mode */
2020 #define EDGE_MODE_SELECT                                0
2021 #define EDGE_MODE_TAG_SEAM                              1
2022 #define EDGE_MODE_TAG_SHARP                             2
2023 #define EDGE_MODE_TAG_CREASE                    3
2024 #define EDGE_MODE_TAG_BEVEL                             4
2025 #define EDGE_MODE_TAG_FREESTYLE                 5
2026
2027 /* ToolSettings.gizmo_flag */
2028 #define SCE_MANIP_TRANSLATE     1
2029 #define SCE_MANIP_ROTATE                2
2030 #define SCE_MANIP_SCALE         4
2031
2032 /* ToolSettings.gpencil_flags */
2033 typedef enum eGPencil_Flags {
2034         /* "Continuous Drawing" - The drawing operator enters a mode where multiple strokes can be drawn */
2035         GP_TOOL_FLAG_PAINTSESSIONS_ON       = (1 << 0),
2036         /* When creating new frames, the last frame gets used as the basis for the new one */
2037         GP_TOOL_FLAG_RETAIN_LAST            = (1 << 1),
2038         /* Add the strokes below all strokes in the layer */
2039         GP_TOOL_FLAG_PAINT_ONBACK = (1 << 2)
2040 } eGPencil_Flags;
2041
2042 /* ToolSettings.gpencil_src */
2043 typedef enum eGPencil_Source_3D {
2044         GP_TOOL_SOURCE_SCENE    = 0,
2045         GP_TOOL_SOURCE_OBJECT   = 1
2046 } eGPencil_Source_3d;
2047
2048 /* ToolSettings.gpencil_*_align - Stroke Placement mode flags */
2049 typedef enum eGPencil_Placement_Flags {
2050         /* New strokes are added in viewport/data space (i.e. not screen space) */
2051         GP_PROJECT_VIEWSPACE    = (1 << 0),
2052
2053         /* Viewport space, but relative to render canvas (Sequencer Preview Only) */
2054         GP_PROJECT_CANVAS       = (1 << 1),
2055
2056         /* Project into the screen's Z values */
2057         GP_PROJECT_DEPTH_VIEW   = (1 << 2),
2058         GP_PROJECT_DEPTH_STROKE = (1 << 3),
2059
2060         /* "Use Endpoints" */
2061         GP_PROJECT_DEPTH_STROKE_ENDPOINTS = (1 << 4),
2062 } eGPencil_Placement_Flags;
2063
2064 /* ToolSettings.particle flag */
2065 #define PE_KEEP_LENGTHS                 1
2066 #define PE_LOCK_FIRST                   2
2067 #define PE_DEFLECT_EMITTER              4
2068 #define PE_INTERPOLATE_ADDED    8
2069 #define PE_DRAW_PART                    16
2070 /* #define PE_X_MIRROR                  64 */   /* deprecated */
2071 #define PE_FADE_TIME                    128
2072 #define PE_AUTO_VELOCITY                256
2073
2074 /* ParticleEditSettings.brushtype */
2075 #define PE_BRUSH_NONE           -1
2076 #define PE_BRUSH_COMB           0
2077 #define PE_BRUSH_CUT            1
2078 #define PE_BRUSH_LENGTH         2
2079 #define PE_BRUSH_PUFF           3
2080 #define PE_BRUSH_ADD            4
2081 #define PE_BRUSH_SMOOTH         5
2082 #define PE_BRUSH_WEIGHT         6
2083
2084 /* ParticleBrushData.flag */
2085 #define PE_BRUSH_DATA_PUFF_VOLUME 1
2086
2087 /* ParticleBrushData.edittype */
2088 #define PE_TYPE_PARTICLES       0
2089 #define PE_TYPE_SOFTBODY        1
2090 #define PE_TYPE_CLOTH           2
2091
2092 /* PhysicsSettings.flag */
2093 #define PHYS_GLOBAL_GRAVITY             1
2094
2095 /* UnitSettings */
2096
2097 /* UnitSettings.system */
2098 #define USER_UNIT_NONE                  0
2099 #define USER_UNIT_METRIC                1
2100 #define USER_UNIT_IMPERIAL              2
2101 /* UnitSettings.flag */
2102 #define USER_UNIT_OPT_SPLIT             1
2103 #define USER_UNIT_ROT_RADIANS   2
2104
2105 /* SceneEEVEE->flag */
2106 enum {
2107         SCE_EEVEE_VOLUMETRIC_ENABLED    = (1 << 0),
2108         SCE_EEVEE_VOLUMETRIC_LIGHTS             = (1 << 1),
2109         SCE_EEVEE_VOLUMETRIC_SHADOWS    = (1 << 2),
2110         SCE_EEVEE_VOLUMETRIC_COLORED    = (1 << 3),
2111         SCE_EEVEE_GTAO_ENABLED                  = (1 << 4),
2112         SCE_EEVEE_GTAO_BENT_NORMALS             = (1 << 5),
2113         SCE_EEVEE_GTAO_BOUNCE                   = (1 << 6),
2114         SCE_EEVEE_DOF_ENABLED                   = (1 << 7),
2115         SCE_EEVEE_BLOOM_ENABLED                 = (1 << 8),
2116         SCE_EEVEE_MOTION_BLUR_ENABLED   = (1 << 9),
2117         SCE_EEVEE_SHADOW_HIGH_BITDEPTH  = (1 << 10),
2118         SCE_EEVEE_TAA_REPROJECTION              = (1 << 11),
2119         SCE_EEVEE_SSS_ENABLED                   = (1 << 12),
2120         SCE_EEVEE_SSS_SEPARATE_ALBEDO   = (1 << 13),
2121         SCE_EEVEE_SSR_ENABLED                   = (1 << 14),
2122         SCE_EEVEE_SSR_REFRACTION                = (1 << 15),
2123         SCE_EEVEE_SSR_HALF_RESOLUTION   = (1 << 16),
2124         SCE_EEVEE_SHOW_IRRADIANCE               = (1 << 17),
2125         SCE_EEVEE_SHOW_CUBEMAPS                 = (1 << 18),
2126         SCE_EEVEE_GI_AUTOBAKE                   = (1 << 19),
2127 };
2128
2129 /* SceneEEVEE->shadow_method */
2130 enum {
2131         SHADOW_ESM = 1,
2132         SHADOW_VSM = 2,
2133         SHADOW_METHOD_MAX = 3,
2134 };
2135
2136 #ifdef __cplusplus
2137 }
2138 #endif
2139
2140 #endif  /* __DNA_SCENE_TYPES_H__ */