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