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