Code Cleanup: spelling
[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
50 struct Object;
51 struct Brush;
52 struct World;
53 struct Scene;
54 struct Image;
55 struct Group;
56 struct Text;
57 struct bNodeTree;
58 struct AnimData;
59 struct Editing;
60 struct SceneStats;
61 struct bGPdata;
62 struct MovieClip;
63
64 /* ************************************************************* */
65 /* Scene Data */
66
67 /* Base - Wrapper for referencing Objects in a Scene */
68 typedef struct Base {
69         struct Base *next, *prev;
70         unsigned int lay, selcol;
71         int flag;
72         short sx, sy;
73         struct Object *object;
74 } Base;
75
76 /* ************************************************************* */
77 /* Output Format Data */
78
79 typedef struct AviCodecData {
80         void                    *lpFormat;  /* save format */
81         void                    *lpParms;   /* compressor options */
82         unsigned int    cbFormat;           /* size of lpFormat buffer */
83         unsigned int    cbParms;            /* size of lpParms buffer */
84
85         unsigned int    fccType;            /* stream type, for consistency */
86         unsigned int    fccHandler;         /* compressor */
87         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
88         unsigned int    dwQuality;          /* compress quality 0-10,000 */
89         unsigned int    dwBytesPerSecond;   /* bytes per second */
90         unsigned int    dwFlags;            /* flags... see below */
91         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
92         unsigned int    pad;
93
94         char                    avicodecname[128];
95 } AviCodecData;
96
97 typedef struct QuicktimeCodecData {
98         /*Old quicktime implementation compatibility fields, read only in 2.5 - deprecated*/
99         void                    *cdParms;   /* codec/compressor options */
100         void                    *pad;       /* padding */
101
102         unsigned int    cdSize;             /* size of cdParms buffer */
103         unsigned int    pad2;               /* padding */
104
105         char                    qtcodecname[128];
106 } QuicktimeCodecData;
107         
108 typedef struct QuicktimeCodecSettings {
109         /* Codec settings detailed for 2.5 implementation*/
110         int codecType; /* Types defined in quicktime_export.h */
111         int     codecSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
112
113         /* Settings not available in current QTKit API */
114         int     codec;
115         int     codecFlags;
116         int     colorDepth;
117         int     codecTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
118         int     minSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
119         int     minTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
120         int     keyFrameRate;
121         int     bitRate;        /* bitrate in bps */
122         
123         /* Audio Codec settings */
124         int audiocodecType;
125         int audioSampleRate;
126         short audioBitDepth;
127         short audioChannels;
128         int audioCodecFlags;
129         int audioBitRate;
130         int pad1;
131 } QuicktimeCodecSettings;
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 flags;
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         IDProperty *properties;
152 } FFMpegCodecData;
153
154 /* ************************************************************* */
155 /* Audio */
156
157 typedef struct AudioData {
158         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
159         float main; // 2.5: now in FFMpegCodecData: audio_volume
160         float speed_of_sound;
161         float doppler_factor;
162         int distance_model;
163         short flag;
164         short pad;
165         float volume;
166         float pad2;
167 } AudioData;
168
169 /* *************************************************************** */
170 /* Render Layers */
171
172 /* Render Layer */
173 typedef struct SceneRenderLayer {
174         struct SceneRenderLayer *next, *prev;
175         
176         char name[64];  /* MAX_NAME */
177         
178         struct Material *mat_override;
179         struct Group *light_override;
180         
181         unsigned int lay;                 /* scene->lay itself has priority over this */
182         unsigned int lay_zmask;   /* has to be after lay, this is for Z-masking */
183         unsigned int lay_exclude; /* not used by internal, exclude */
184         int layflag;
185         
186         int passflag;                   /* pass_xor has to be after passflag */
187         int pass_xor;
188
189         int samples;
190         int pad;
191         
192         struct FreestyleConfig freestyleConfig;
193 } SceneRenderLayer;
194
195 /* srl->layflag */
196 #define SCE_LAY_SOLID   1
197 #define SCE_LAY_ZTRA    2
198 #define SCE_LAY_HALO    4
199 // #define SCE_LAY_EDGE 8 /* deprecated */
200 #define SCE_LAY_SKY             16
201 #define SCE_LAY_STRAND  32
202 #define SCE_LAY_FRS             64
203         /* flags between 128 and 0x8000 are set to 1 already, for future options */
204
205 #define SCE_LAY_ALL_Z           0x8000
206 #define SCE_LAY_XOR                     0x10000
207 #define SCE_LAY_DISABLE         0x20000
208 #define SCE_LAY_ZMASK           0x40000
209 #define SCE_LAY_NEG_ZMASK       0x80000
210
211 /* srl->passflag */
212 #define SCE_PASS_COMBINED                               (1<<0)
213 #define SCE_PASS_Z                                              (1<<1)
214 #define SCE_PASS_RGBA                                   (1<<2)
215 #define SCE_PASS_DIFFUSE                                (1<<3)
216 #define SCE_PASS_SPEC                                   (1<<4)
217 #define SCE_PASS_SHADOW                                 (1<<5)
218 #define SCE_PASS_AO                                             (1<<6)
219 #define SCE_PASS_REFLECT                                (1<<7)
220 #define SCE_PASS_NORMAL                                 (1<<8)
221 #define SCE_PASS_VECTOR                                 (1<<9)
222 #define SCE_PASS_REFRACT                                (1<<10)
223 #define SCE_PASS_INDEXOB                                (1<<11)
224 #define SCE_PASS_UV                                             (1<<12)
225 #define SCE_PASS_INDIRECT                               (1<<13)
226 #define SCE_PASS_MIST                                   (1<<14)
227 #define SCE_PASS_RAYHITS                                (1<<15)
228 #define SCE_PASS_EMIT                                   (1<<16)
229 #define SCE_PASS_ENVIRONMENT                    (1<<17)
230 #define SCE_PASS_INDEXMA                                (1<<18)
231 #define SCE_PASS_DIFFUSE_DIRECT                 (1<<19)
232 #define SCE_PASS_DIFFUSE_INDIRECT               (1<<20)
233 #define SCE_PASS_DIFFUSE_COLOR                  (1<<21)
234 #define SCE_PASS_GLOSSY_DIRECT                  (1<<22)
235 #define SCE_PASS_GLOSSY_INDIRECT                (1<<23)
236 #define SCE_PASS_GLOSSY_COLOR                   (1<<24)
237 #define SCE_PASS_TRANSM_DIRECT                  (1<<25)
238 #define SCE_PASS_TRANSM_INDIRECT                (1<<26)
239 #define SCE_PASS_TRANSM_COLOR                   (1<<27)
240 #define SCE_PASS_SUBSURFACE_DIRECT              (1<<28)
241 #define SCE_PASS_SUBSURFACE_INDIRECT    (1<<29)
242 #define SCE_PASS_SUBSURFACE_COLOR               (1<<30)
243
244 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
245
246 /* *************************************************************** */
247
248 /* Generic image format settings,
249  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
250  *
251  * note: its a bit strange that even though this is an image format struct
252  *  the imtype can still be used to select video formats.
253  *  RNA ensures these enum's are only selectable for render output.
254  */
255 typedef struct ImageFormatData {
256         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
257                        /* note, video types should only ever be set from this
258                         * structure when used from RenderData */
259         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
260                         * not a flag, only set 1 at a time */
261
262         char planes;   /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
263         char flag;     /* generic options for all image types, alpha zbuffer */
264
265         char quality;  /* (0 - 100), eg: jpeg quality */
266         char compress; /* (0 - 100), eg: png compression */
267
268
269         /* --- format specific --- */
270
271         /* OpenEXR */
272         char  exr_codec;
273
274         /* Cineon */
275         char  cineon_flag;
276         short cineon_white, cineon_black;
277         float cineon_gamma;
278
279         /* Jpeg2000 */
280         char  jp2_flag;
281         char jp2_codec;
282
283         char pad[6];
284
285         /* color management */
286         ColorManagedViewSettings view_settings;
287         ColorManagedDisplaySettings display_settings;
288 } ImageFormatData;
289
290
291 /* ImageFormatData.imtype */
292 #define R_IMF_IMTYPE_TARGA           0
293 #define R_IMF_IMTYPE_IRIS            1
294 /* #define R_HAMX                    2 */ /* hamx is nomore */
295 /* #define R_FTYPE                   3 */ /* ftype is nomore */
296 #define R_IMF_IMTYPE_JPEG90          4
297 /* #define R_MOVIE                   5 */ /* movie is nomore */
298 #define R_IMF_IMTYPE_IRIZ            7
299 #define R_IMF_IMTYPE_RAWTGA         14
300 #define R_IMF_IMTYPE_AVIRAW         15
301 #define R_IMF_IMTYPE_AVIJPEG        16
302 #define R_IMF_IMTYPE_PNG            17
303 /* #define R_IMF_IMTYPE_AVICODEC    18 */ /* avicodec is nomore */
304 #define R_IMF_IMTYPE_QUICKTIME      19
305 #define R_IMF_IMTYPE_BMP            20
306 #define R_IMF_IMTYPE_RADHDR         21
307 #define R_IMF_IMTYPE_TIFF           22
308 #define R_IMF_IMTYPE_OPENEXR        23
309 #define R_IMF_IMTYPE_FFMPEG         24
310 #define R_IMF_IMTYPE_FRAMESERVER    25
311 #define R_IMF_IMTYPE_CINEON         26
312 #define R_IMF_IMTYPE_DPX            27
313 #define R_IMF_IMTYPE_MULTILAYER     28
314 #define R_IMF_IMTYPE_DDS            29
315 #define R_IMF_IMTYPE_JP2            30
316 #define R_IMF_IMTYPE_H264           31
317 #define R_IMF_IMTYPE_XVID           32
318 #define R_IMF_IMTYPE_THEORA         33
319 #define R_IMF_IMTYPE_PSD            34
320
321 #define R_IMF_IMTYPE_INVALID        255
322
323 /* ImageFormatData.flag */
324 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
325 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
326
327 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
328 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
329 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
330 #define R_IMF_CHAN_DEPTH_10 (1<<2) /* 10bits (uncommon, Cineon/DPX support) */
331 #define R_IMF_CHAN_DEPTH_12 (1<<3) /* 12bits (uncommon, jp2/DPX support) */
332 #define R_IMF_CHAN_DEPTH_16 (1<<4) /* 16bits (tiff, halff float exr) */
333 #define R_IMF_CHAN_DEPTH_24 (1<<5) /* 24bits (unused) */
334 #define R_IMF_CHAN_DEPTH_32 (1<<6) /* 32bits (full float exr) */
335
336 /* ImageFormatData.planes */
337 #define R_IMF_PLANES_RGB   24
338 #define R_IMF_PLANES_RGBA  32
339 #define R_IMF_PLANES_BW    8
340
341 /* ImageFormatData.exr_codec */
342 #define R_IMF_EXR_CODEC_NONE  0
343 #define R_IMF_EXR_CODEC_PXR24 1
344 #define R_IMF_EXR_CODEC_ZIP   2
345 #define R_IMF_EXR_CODEC_PIZ   3
346 #define R_IMF_EXR_CODEC_RLE   4
347
348 /* ImageFormatData.jp2_flag */
349 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
350 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
351 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
352
353 /* ImageFormatData.jp2_codec */
354 #define R_IMF_JP2_CODEC_JP2  0
355 #define R_IMF_JP2_CODEC_J2K  1
356
357 /* ImageFormatData.cineon_flag */
358 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
359
360 /* *************************************************************** */
361 /* Render Data */
362
363 typedef struct RenderData {
364         struct ImageFormatData im_format;
365         
366         struct AviCodecData *avicodecdata;
367         struct QuicktimeCodecData *qtcodecdata;
368         struct QuicktimeCodecSettings qtcodecsettings;
369         struct FFMpegCodecData ffcodecdata;
370
371         int cfra, sfra, efra;   /* frames as in 'images' */
372         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
373         int psfra, pefra;               /* start+end frames of preview range */
374
375         int images, framapto;
376         short flag, threads;
377
378         float framelen, blurfac;
379
380         /** For UR edge rendering: give the edges this color */
381         float edgeR DNA_DEPRECATED, edgeG DNA_DEPRECATED, edgeB DNA_DEPRECATED;
382
383
384         /* standalone player */  //  XXX deprecated since 2.5
385         short fullscreen  DNA_DEPRECATED, xplay  DNA_DEPRECATED, yplay  DNA_DEPRECATED;
386         short freqplay  DNA_DEPRECATED;
387         /* standalone player */  //  XXX deprecated since 2.5
388         short depth  DNA_DEPRECATED, attrib  DNA_DEPRECATED;
389
390
391         int frame_step;         /* frames to jump during render/playback */
392
393         short stereomode  DNA_DEPRECATED;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
394         
395         short dimensionspreset;         /* for the dimensions presets menu */
396
397         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
398
399         short size; /* size in % */
400         
401         short maximsize DNA_DEPRECATED; /* max in Kb */
402
403         short pad6;
404
405         /* from buttons: */
406         /**
407          * The desired number of pixels in the x direction
408          */
409         int xsch;
410         /**
411          * The desired number of pixels in the y direction
412          */
413         int ysch;
414
415         /**
416          * The number of part to use in the x direction
417          */
418         short xparts DNA_DEPRECATED;
419         /**
420          * The number of part to use in the y direction
421          */
422         short yparts DNA_DEPRECATED;
423
424         /**
425          * render tile dimensions
426          */
427         int tilex, tiley;
428
429         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
430         
431         /**
432          * Render to image editor, fullscreen or to new window.
433          */
434         short displaymode;
435         short pad7;
436
437         /**
438          * Flags for render settings. Use bit-masking to access the settings.
439          */
440         int scemode;
441
442         /**
443          * Flags for render settings. Use bit-masking to access the settings.
444          */
445         int mode;
446
447         /**
448          * Flags for raytrace settings. Use bit-masking to access the settings.
449          */
450         int raytrace_options;
451         
452         /**
453          * Raytrace acceleration structure
454          */
455         short raytrace_structure;
456
457         short pad1;
458
459         /* octree resolution */
460         short ocres;
461         short pad4;
462         
463         /**
464          * What to do with the sky/background. Picks sky/premul/key
465          * blending for the background
466          */
467         short alphamode;
468
469         /**
470          * The number of samples to use per pixel.
471          */
472         short osa;
473
474         short frs_sec, edgeint;
475
476         
477         /* safety, border and display rect */
478         rctf safety, border;
479         rcti disprect;
480         
481         /* information on different layers to be rendered */
482         ListBase layers;
483         short actlay;
484         
485         /* number of mblur samples */
486         short mblur_samples;
487         
488         /**
489          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
490          */
491         float xasp, yasp;
492
493         float frs_sec_base;
494         
495         /**
496          * Value used to define filter size for all filter options  */
497         float gauss;
498         
499         
500         /* color management settings - color profiles, gamma correction, etc */
501         int color_mgt_flag;
502         
503         /** post-production settings. deprecated, but here for upwards compat (initialized to 1) */
504         float postgamma, posthue, postsat;
505         
506          /* Dither noise intensity */
507         float dither_intensity;
508         
509         /* Bake Render options */
510         short bake_osa, bake_filter, bake_mode, bake_flag;
511         short bake_normal_space, bake_quad_split;
512         float bake_maxdist, bake_biasdist;
513         short bake_samples, bake_pad;
514         float bake_user_scale, bake_pad1;
515
516         /* path to render output */
517         char pic[1024]; /* 1024 = FILE_MAX */
518
519         /* stamps flags. */
520         int stamp;
521         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
522
523         /* stamp info user data. */
524         char stamp_udata[768];
525
526         /* foreground/background color. */
527         float fg_stamp[4];
528         float bg_stamp[4];
529
530         /* sequencer options */
531         char seq_prev_type;
532         char seq_rend_type;
533         char seq_flag; /* flag use for sequence render/draw */
534         char pad5[5];
535
536         /* render simplify */
537         int simplify_flag;
538         short simplify_subsurf;
539         short simplify_shadowsamples;
540         float simplify_particles;
541         float simplify_aosss;
542
543         /* cineon */
544         short cineonwhite  DNA_DEPRECATED, cineonblack  DNA_DEPRECATED;  /*deprecated*/
545         float cineongamma  DNA_DEPRECATED;  /*deprecated*/
546         
547         /* jpeg2000 */
548         short jp2_preset  DNA_DEPRECATED, jp2_depth  DNA_DEPRECATED;  /*deprecated*/
549         int rpad3;
550
551         /* Dome variables */ //  XXX deprecated since 2.5
552         short domeres  DNA_DEPRECATED, domemode  DNA_DEPRECATED;        //  XXX deprecated since 2.5
553         short domeangle  DNA_DEPRECATED, dometilt  DNA_DEPRECATED;      //  XXX deprecated since 2.5
554         float domeresbuf  DNA_DEPRECATED;       //  XXX deprecated since 2.5
555         float pad2;
556         struct Text *dometext  DNA_DEPRECATED;  //  XXX deprecated since 2.5
557
558         /* Freestyle line thickness options */
559         int line_thickness_mode;
560         float unit_line_thickness; /* in pixels */
561
562         /* render engine */
563         char engine[32];
564 } RenderData;
565
566 /* *************************************************************** */
567 /* Render Conversion/Simplfication Settings */
568
569 /* control render convert and shading engine */
570 typedef struct RenderProfile {
571         struct RenderProfile *next, *prev;
572         char name[32];
573         
574         short particle_perc;
575         short subsurf_max;
576         short shadbufsample_max;
577         short pad1;
578         
579         float ao_error, pad2;
580         
581 } RenderProfile;
582
583 /* *************************************************************** */
584 /* Game Engine - Dome */
585
586 typedef struct GameDome {
587         short res, mode;
588         short angle, tilt;
589         float resbuf, pad2;
590         struct Text *warptext;
591 } GameDome;
592
593 #define DOME_FISHEYE                    1
594 #define DOME_TRUNCATED_FRONT    2
595 #define DOME_TRUNCATED_REAR             3
596 #define DOME_ENVMAP                             4
597 #define DOME_PANORAM_SPH                5
598 #define DOME_NUM_MODES                  6
599
600 /* *************************************************************** */
601 /* Game Engine */
602
603 typedef struct GameFraming {
604         float col[3];
605         char type, pad1, pad2, pad3;
606 } GameFraming;
607
608 #define SCE_GAMEFRAMING_BARS   0
609 #define SCE_GAMEFRAMING_EXTEND 1
610 #define SCE_GAMEFRAMING_SCALE  2
611
612 typedef struct RecastData {
613         float cellsize;
614         float cellheight;
615         float agentmaxslope;
616         float agentmaxclimb;
617         float agentheight;
618         float agentradius;
619         float edgemaxlen;
620         float edgemaxerror;
621         float regionminsize;
622         float regionmergesize;
623         int vertsperpoly;
624         float detailsampledist;
625         float detailsamplemaxerror;
626         short pad1, pad2;
627 } RecastData;
628
629 typedef struct GameData {
630
631         /*  standalone player */
632         struct GameFraming framing;
633         short playerflag, xplay, yplay, freqplay;
634         short depth, attrib, rt1, rt2;
635         short aasamples, pad4[3];
636
637         /* stereo/dome mode */
638         struct GameDome dome;
639         short stereoflag, stereomode;
640         float eyeseparation;
641         RecastData recastData;
642
643
644         /* physics (it was in world)*/
645         float gravity; /*Gravitation constant for the game world*/
646
647         /*
648          * Radius of the activity bubble, in Manhattan length. Objects
649          * outside the box are activity-culled. */
650         float activityBoxRadius;
651
652         /*
653          * bit 3: (gameengine): Activity culling is enabled.
654          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustrum culling
655          */
656         int flag;
657         short mode, matmode;
658         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
659         short physicsEngine;
660         short exitkey;
661         short vsync; /* Controls vsync: off, on, or adaptive (if supported) */
662         short ticrate, maxlogicstep, physubstep, maxphystep;
663         short obstacleSimulation;
664         short raster_storage;
665         float levelHeight;
666         float deactivationtime, lineardeactthreshold, angulardeactthreshold, pad2;
667 } GameData;
668
669 #define STEREO_NOSTEREO         1
670 #define STEREO_ENABLED          2
671 #define STEREO_DOME                     3
672
673 //#define STEREO_NOSTEREO                1
674 #define STEREO_QUADBUFFERED 2
675 #define STEREO_ABOVEBELOW        3
676 #define STEREO_INTERLACED        4
677 #define STEREO_ANAGLYPH         5
678 #define STEREO_SIDEBYSIDE       6
679 #define STEREO_VINTERLACE       7
680 //#define STEREO_DOME           8
681 #define STEREO_3DTVTOPBOTTOM 9
682
683 /* physicsEngine */
684 #define WOPHY_NONE              0
685 #define WOPHY_BULLET    5
686
687 /* obstacleSimulation */
688 #define OBSTSIMULATION_NONE             0
689 #define OBSTSIMULATION_TOI_rays         1
690 #define OBSTSIMULATION_TOI_cells        2
691
692 /* Raster storage */
693 #define RAS_STORE_AUTO          0
694 #define RAS_STORE_IMMEDIATE     1
695 #define RAS_STORE_VA            2
696 #define RAS_STORE_VBO           3
697
698 /* vsync */
699 #define VSYNC_ON        0
700 #define VSYNC_OFF       1
701 #define VSYNC_ADAPTIVE  2
702
703 /* GameData.flag */
704 #define GAME_RESTRICT_ANIM_UPDATES                      (1 << 0)
705 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
706 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
707 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
708 #define GAME_SHOW_PHYSICS                                       (1 << 4)
709 #define GAME_DISPLAY_LISTS                                      (1 << 5)
710 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
711 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
712 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
713 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
714 #define GAME_GLSL_NO_NODES                                      (1 << 10)
715 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
716 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
717 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
718 #define GAME_SHOW_MOUSE                                         (1 << 14)
719 #define GAME_GLSL_NO_COLOR_MANAGEMENT           (1 << 15)
720 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 16)
721 #define GAME_NO_MATERIAL_CACHING                        (1 << 17)
722 /* Note: GameData.flag is now an int (max 32 flags). A short could only take 16 flags */
723
724 /* GameData.playerflag */
725 #define GAME_PLAYER_FULLSCREEN                          (1 << 0)
726 #define GAME_PLAYER_DESKTOP_RESOLUTION          (1 << 1)
727
728 /* GameData.matmode */
729 enum {
730         GAME_MAT_TEXFACE    = 0, /* deprecated */
731         GAME_MAT_MULTITEX   = 1,
732         GAME_MAT_GLSL       = 2,
733 };
734
735 #if (DNA_DEPRECATED_GCC_POISON == 1)
736 #pragma GCC poison GAME_MAT_TEXFACE
737 #endif
738
739 /* UV Paint */
740 #define UV_SCULPT_LOCK_BORDERS                          1
741 #define UV_SCULPT_ALL_ISLANDS                           2
742
743 #define UV_SCULPT_TOOL_PINCH                            1
744 #define UV_SCULPT_TOOL_RELAX                            2
745 #define UV_SCULPT_TOOL_GRAB                                     3
746
747 #define UV_SCULPT_TOOL_RELAX_LAPLACIAN  1
748 #define UV_SCULPT_TOOL_RELAX_HC                 2
749
750 /* Markers */
751
752 typedef struct TimeMarker {     
753         struct TimeMarker *next, *prev;
754         int frame;
755         char name[64];
756         unsigned int flag;
757         struct Object *camera;
758 } TimeMarker;
759
760 /* *************************************************************** */
761 /* Paint Mode/Tool Data */
762
763 #define PAINT_MAX_INPUT_SAMPLES 64
764
765 /* Paint Tool Base */
766 typedef struct Paint {
767         struct Brush *brush;
768         
769         /* WM Paint cursor */
770         void *paint_cursor;
771         unsigned char paint_cursor_col[4];
772
773         /* enum PaintFlags */
774         int flags;
775
776         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to
777          * smooth the stroke */
778         int num_input_samples;
779         
780         /* flags used for symmetry */
781         int symmetry_flags;
782 } Paint;
783
784 /* ------------------------------------------- */
785 /* Image Paint */
786
787 /* Texture/Image Editor */
788 typedef struct ImagePaintSettings {
789         Paint paint;
790
791         short flag, pad;
792         
793         /* for projection painting only */
794         short seam_bleed, normal_angle;
795         short screen_grab_size[2]; /* capture size for re-projection */
796
797         int pad1;
798
799         void *paintcursor;                      /* wm handle */
800 } ImagePaintSettings;
801
802 /* ------------------------------------------- */
803 /* Particle Edit */
804
805 /* Settings for a Particle Editing Brush */
806 typedef struct ParticleBrushData {
807         short size;                                             /* common setting */
808         short step, invert, count;              /* for specific brushes only */
809         int flag;
810         float strength;
811 } ParticleBrushData;
812
813 /* Particle Edit Mode Settings */
814 typedef struct ParticleEditSettings {
815         short flag;
816         short totrekey;
817         short totaddkey;
818         short brushtype;
819
820         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
821         void *paintcursor;                      /* runtime */
822
823         float emitterdist, rt;
824
825         int selectmode;
826         int edittype;
827
828         int draw_step, fade_frames;
829
830         struct Scene *scene;
831         struct Object *object;
832 } ParticleEditSettings;
833
834 /* ------------------------------------------- */
835 /* Sculpt */
836
837 /* Sculpt */
838 typedef struct Sculpt {
839         Paint paint;
840
841         /* For rotating around a pivot point */
842         //float pivot[3]; XXX not used?
843         int flags;
844
845         /* Control tablet input */
846         //char tablet_size, tablet_strength; XXX not used?
847         int radial_symm[3];
848
849         /* Maximum edge length for dynamic topology sculpting (in pixels) */
850         int detail_size;
851
852         /* Direction used for SCULPT_OT_symmetrize operator */
853         int symmetrize_direction;
854
855         /* gravity factor for sculpting */
856         float gravity_factor;
857         int pad;
858
859         struct Object *gravity_object;
860         void *pad2;
861 } Sculpt;
862
863 typedef struct UvSculpt {
864         Paint paint;
865 } UvSculpt;
866 /* ------------------------------------------- */
867 /* Vertex Paint */
868
869 /* Vertex Paint */
870 typedef struct VPaint {
871         Paint paint;
872
873         short flag, pad;
874         int tot;                                                        /* allocation size of prev buffers */
875         unsigned int *vpaint_prev;                      /* previous mesh colors */
876         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
877         
878         void *paintcursor;                                      /* wm handle */
879 } VPaint;
880
881 /* VPaint.flag */
882 enum {
883         // VP_COLINDEX  = (1 << 0),  /* only paint onto active material*/  /* deprecated since before 2.49 */
884         // VP_AREA      = (1 << 1),  /* deprecated since 2.70 */
885         VP_NORMALS      = (1 << 3),
886         VP_SPRAY        = (1 << 4),
887         // VP_MIRROR_X  = (1 << 5),  /* deprecated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X) */
888         VP_ONLYVGROUP   = (1 << 7)   /* weight paint only */
889 };
890
891 /* *************************************************************** */
892 /* Transform Orientations */
893
894 typedef struct TransformOrientation {
895         struct TransformOrientation *next, *prev;
896         char name[64];  /* MAX_NAME */
897         float mat[3][3];
898         int pad;
899 } TransformOrientation;
900
901 /* *************************************************************** */
902 /* Unified Paint Settings
903  */
904
905 /* These settings can override the equivalent fields in the active
906  * Brush for any paint mode; the flag field controls whether these
907  * values are used */
908 typedef struct UnifiedPaintSettings {
909         /* unified radius of brush in pixels */
910         int size;
911
912         /* unified radius of brush in Blender units */
913         float unprojected_radius;
914
915         /* unified strength of brush */
916         float alpha;
917
918         /* unified brush weight, [0, 1] */
919         float weight;
920
921         /* user preferences for sculpt and paint */
922         int flag;
923
924         /* rake rotation */
925
926         /* record movement of mouse so that rake can start at an intuitive angle */
927         float last_rake[2];
928         int pad;
929
930         float brush_rotation;
931
932         // all this below is used to communicate with the cursor drawing routine
933         int draw_anchored;
934         int   anchored_size;
935         float anchored_initial_mouse[2];
936
937         /* check is there an ongoing stroke right now */
938         int stroke_active;
939
940         /* drawing pressure */
941         float pressure_value;
942
943         /* position of mouse, used to sample the texture */
944         float tex_mouse[2];
945
946         /* position of mouse, used to sample the mask texture */
947         float mask_tex_mouse[2];
948
949         /* radius of brush, premultiplied with pressure.
950          * In case of anchored brushes contains that radius */
951         float pixel_radius;
952 } UnifiedPaintSettings;
953
954 typedef enum {
955         UNIFIED_PAINT_SIZE  = (1 << 0),
956         UNIFIED_PAINT_ALPHA = (1 << 1),
957         UNIFIED_PAINT_WEIGHT = (1 << 5),
958
959         /* only used if unified size is enabled, mirrors the brush flags
960          * BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
961         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1 << 2),
962         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1 << 3),
963
964         /* only used if unified alpha is enabled, mirrors the brush flag
965          * BRUSH_ALPHA_PRESSURE */
966         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1 << 4)
967 } UnifiedPaintSettingsFlags;
968
969 typedef struct MeshStatVis {
970         char type;
971         char _pad1[2];
972
973         /* overhang */
974         char  overhang_axis;
975         float overhang_min, overhang_max;
976
977         /* thickness */
978         float thickness_min, thickness_max;
979         char thickness_samples;
980         char _pad2[3];
981
982         /* distort */
983         float distort_min, distort_max;
984
985         /* sharp */
986         float sharp_min, sharp_max;
987 } MeshStatVis;
988
989
990 /* *************************************************************** */
991 /* Tool Settings */
992
993 typedef struct ToolSettings {
994         VPaint *vpaint;         /* vertex paint */
995         VPaint *wpaint;         /* weight paint */
996         Sculpt *sculpt;
997         UvSculpt *uvsculpt;     /* uv smooth */
998         
999         /* Vertex group weight - used only for editmode, not weight
1000          * paint */
1001         float vgroup_weight;
1002
1003         float doublimit;        /* remove doubles limit */
1004         float normalsize;       /* size of normals */
1005         short automerge;
1006
1007         /* Selection Mode for Mesh */
1008         short selectmode;
1009
1010         /* UV Calculation */
1011         char unwrapper;
1012         char uvcalc_flag;
1013         char uv_flag;
1014         char uv_selectmode;
1015
1016         float uvcalc_margin;
1017
1018         /* Auto-IK */
1019         short autoik_chainlen;  /* runtime only */
1020
1021         /* Grease Pencil */
1022         char gpencil_flags;
1023
1024         char pad[5];
1025
1026         /* Image Paint (8 byttse aligned please!) */
1027         struct ImagePaintSettings imapaint;
1028
1029         /* Particle Editing */
1030         struct ParticleEditSettings particle;
1031         
1032         /* Transform Proportional Area of Effect */
1033         float proportional_size;
1034
1035         /* Select Group Threshold */
1036         float select_thresh;
1037
1038         /* Auto-Keying Mode */
1039         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
1040
1041         /* Multires */
1042         char multires_subdiv_type;
1043         char pad3[1];
1044
1045         /* Skeleton generation */
1046         short skgen_resolution;
1047         float skgen_threshold_internal;
1048         float skgen_threshold_external;
1049         float skgen_length_ratio;
1050         float skgen_length_limit;
1051         float skgen_angle_limit;
1052         float skgen_correlation_limit;
1053         float skgen_symmetry_limit;
1054         float skgen_retarget_angle_weight;
1055         float skgen_retarget_length_weight;
1056         float skgen_retarget_distance_weight;
1057         short skgen_options;
1058         char  skgen_postpro;
1059         char  skgen_postpro_passes;
1060         char  skgen_subdivisions[3];
1061         char  skgen_multi_level;
1062
1063         /* Skeleton Sketching */
1064         struct Object *skgen_template;
1065         char bone_sketching;
1066         char bone_sketching_convert;
1067         char skgen_subdivision_number;
1068         char skgen_retarget_options;
1069         char skgen_retarget_roll;
1070         char skgen_side_string[8];
1071         char skgen_num_string[8];
1072         
1073         /* Alt+RMB option */
1074         char edge_mode;
1075         char edge_mode_live_unwrap;
1076
1077         /* Transform */
1078         char snap_mode, snap_node_mode;
1079         char snap_uv_mode;
1080         short snap_flag, snap_target;
1081         short proportional, prop_mode;
1082         char proportional_objects; /* proportional edit, object mode */
1083         char proportional_mask; /* proportional edit, object mode */
1084
1085         char auto_normalize; /*auto normalizing mode in wpaint*/
1086         char multipaint; /* paint multiple bones in wpaint */
1087         char weightuser;
1088         char vgroupsubset; /* subset selection filter in wpaint */
1089
1090         /* UV painting */
1091         int use_uv_sculpt;
1092         int uv_sculpt_settings;
1093         int uv_sculpt_tool;
1094         int uv_relax_method;
1095         /* XXX: these sculpt_paint_* fields are deprecated, use the
1096          * unified_paint_settings field instead! */
1097         short sculpt_paint_settings DNA_DEPRECATED;     short pad5;
1098         int sculpt_paint_unified_size DNA_DEPRECATED;
1099         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
1100         float sculpt_paint_unified_alpha DNA_DEPRECATED;
1101
1102         /* Unified Paint Settings */
1103         struct UnifiedPaintSettings unified_paint_settings;
1104
1105         struct MeshStatVis statvis;
1106 } ToolSettings;
1107
1108 /* *************************************************************** */
1109 /* Assorted Scene Data */
1110
1111 /* ------------------------------------------- */
1112 /* Stats (show in Info header) */
1113
1114 typedef struct bStats {
1115         /* scene totals for visible layers */
1116         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
1117         int totvert, totface;
1118 } bStats;
1119
1120 /* ------------------------------------------- */
1121 /* Unit Settings */
1122
1123 typedef struct UnitSettings {
1124         /* Display/Editing unit options for each scene */
1125         float scale_length; /* maybe have other unit conversions? */
1126         char system; /* imperial, metric etc */
1127         char system_rotation; /* not implemented as a proper unit system yet */
1128         short flag;
1129 } UnitSettings;
1130
1131 /* ------------------------------------------- */
1132 /* Global/Common Physics Settings */
1133
1134 typedef struct PhysicsSettings {
1135         float gravity[3];
1136         int flag, quick_cache_step, rt;
1137 } PhysicsSettings;
1138
1139 /* *************************************************************** */
1140 /* Scene ID-Block */
1141
1142 typedef struct Scene {
1143         ID id;
1144         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
1145         
1146         struct Object *camera;
1147         struct World *world;
1148         
1149         struct Scene *set;
1150         
1151         ListBase base;
1152         struct Base *basact;            /* active base */
1153         struct Object *obedit;          /* name replaces old G.obedit */
1154         
1155         float cursor[3];                        /* 3d cursor location */
1156         float twcent[3];                        /* center for transform widget */
1157         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
1158         
1159         unsigned int lay;                       /* bitflags for layer visibility */
1160         int layact;             /* active layer */
1161         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1162         
1163         short flag;                                                             /* various settings */
1164         
1165         short use_nodes;
1166         
1167         struct bNodeTree *nodetree;
1168         
1169         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1170         
1171         struct ToolSettings *toolsettings;              /* default allocated now */
1172         struct SceneStats *stats;                               /* default allocated now */
1173
1174         /* migrate or replace? depends on some internal things... */
1175         /* no, is on the right place (ton) */
1176         struct RenderData r;
1177         struct AudioData audio;
1178         
1179         ListBase markers;
1180         ListBase transform_spaces;
1181         
1182         void *sound_scene;
1183         void *sound_scene_handle;
1184         void *sound_scrub_handle;
1185         void *speaker_handles;
1186         
1187         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1188         
1189         /* none of the dependency graph  vars is mean to be saved */
1190         struct  DagForest *theDag;
1191         short dagflags;
1192         short recalc;                           /* recalc = counterpart of ob->recalc */
1193
1194         /* User-Defined KeyingSets */
1195         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1196         ListBase keyingsets;                    /* KeyingSets for this scene */
1197         
1198         /* Game Settings */
1199         struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5
1200         struct GameData gm;
1201
1202         /* Units */
1203         struct UnitSettings unit;
1204         
1205         /* Grease Pencil */
1206         struct bGPdata *gpd;
1207
1208         /* Physics simulation settings */
1209         struct PhysicsSettings physics_settings;
1210
1211         /* Movie Tracking */
1212         struct MovieClip *clip;                 /* active movie clip */
1213
1214         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by BKE_object_handle_update() */
1215         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1216
1217         /* Color Management */
1218         ColorManagedViewSettings view_settings;
1219         ColorManagedDisplaySettings display_settings;
1220         ColorManagedColorspaceSettings sequencer_colorspace_settings;
1221         
1222         /* RigidBody simulation world+settings */
1223         struct RigidBodyWorld *rigidbody_world;
1224 } Scene;
1225
1226
1227 /* **************** RENDERDATA ********************* */
1228
1229 /* flag */
1230         /* use preview range */
1231 #define SCER_PRV_RANGE  (1<<0)
1232 #define SCER_LOCK_FRAME_SELECTION       (1<<1)
1233
1234 /* mode (int now) */
1235 #define R_OSA                   0x0001
1236 #define R_SHADOW                0x0002
1237 #define R_GAMMA                 0x0004
1238 #define R_ORTHO                 0x0008
1239 #define R_ENVMAP                0x0010
1240 /*#define R_EDGE                        0x0020 deprecated */
1241 #define R_FIELDS                0x0040
1242 #define R_FIELDSTILL    0x0080
1243 /*#define R_RADIO                       0x0100 */ /* deprecated */
1244 #define R_BORDER                0x0200
1245 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
1246 #define R_CROP                  0x0800
1247 /*#define R_COSMO                       0x1000 deprecated */
1248 #define R_ODDFIELD              0x2000
1249 #define R_MBLUR                 0x4000
1250                 /* unified was here */
1251 #define R_RAYTRACE      0x10000
1252                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1253 #define R_GAUSS         0x20000
1254                 /* fbuf obsolete... */
1255 /*#define R_FBUF                        0x40000*/
1256                 /* threads obsolete... is there for old files, now use for autodetect threads */
1257 #define R_THREADS               0x80000
1258                 /* Use the same flag for autothreads */
1259 #define R_FIXED_THREADS         0x80000 
1260
1261 #define R_SPEED                         0x100000
1262 #define R_SSS                           0x200000
1263 #define R_NO_OVERWRITE          0x400000  /* skip existing files */
1264 #define R_TOUCH                         0x800000  /* touch files before rendering */
1265 #define R_SIMPLIFY                      0x1000000
1266 #define R_EDGE_FRS                      0x2000000 /* R_EDGE reserved for Freestyle */
1267 #define R_PERSISTENT_DATA       0x4000000 /* keep data around for re-render */
1268
1269 /* seq_flag */
1270 #define R_SEQ_GL_PREV 1
1271 // #define R_SEQ_GL_REND 2  // UNUSED, opengl render has its own operator now.
1272 #define R_SEQ_SOLID_TEX 4
1273
1274 /* displaymode */
1275
1276 #define R_OUTPUT_SCREEN 0
1277 #define R_OUTPUT_AREA   1
1278 #define R_OUTPUT_WINDOW 2
1279 #define R_OUTPUT_NONE   3
1280 /*#define R_OUTPUT_FORKED       4*/
1281
1282 /* filtertype */
1283 #define R_FILTER_BOX    0
1284 #define R_FILTER_TENT   1
1285 #define R_FILTER_QUAD   2
1286 #define R_FILTER_CUBIC  3
1287 #define R_FILTER_CATROM 4
1288 #define R_FILTER_GAUSS  5
1289 #define R_FILTER_MITCH  6
1290 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
1291
1292 /* raytrace structure */
1293 #define R_RAYSTRUCTURE_AUTO                             0
1294 #define R_RAYSTRUCTURE_OCTREE                   1
1295 #define R_RAYSTRUCTURE_BLIBVH                   2
1296 #define R_RAYSTRUCTURE_VBVH                             3
1297 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
1298 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
1299
1300 /* raytrace_options */
1301 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
1302 #define R_RAYTRACE_USE_INSTANCES                0x0002
1303
1304 /* scemode (int now) */
1305 #define R_DOSEQ                         0x0001
1306 #define R_BG_RENDER                     0x0002
1307                 /* passepartout is camera option now, keep this for backward compatibility */
1308 #define R_PASSEPARTOUT          0x0004
1309 #define R_BUTS_PREVIEW          0x0008
1310 #define R_EXTENSION                     0x0010
1311 #define R_MATNODE_PREVIEW       0x0020
1312 #define R_DOCOMP                        0x0040
1313 #define R_COMP_CROP                     0x0080
1314 #define R_FREE_IMAGE            0x0100
1315 #define R_SINGLE_LAYER          0x0200
1316 #define R_EXR_TILE_FILE         0x0400
1317 #define R_COMP_FREE                     0x0800
1318 #define R_NO_IMAGE_LOAD         0x1000
1319 #define R_NO_TEX                        0x2000
1320 #define R_NO_FRAME_UPDATE       0x4000
1321 #define R_FULL_SAMPLE           0x8000
1322 /* #define R_DEPRECATED         0x10000 */
1323 /* #define R_RECURS_PROTECTION  0x20000 */
1324 #define R_TEXNODE_PREVIEW       0x40000
1325 #define R_VIEWPORT_PREVIEW      0x80000
1326
1327 /* r->stamp */
1328 #define R_STAMP_TIME    0x0001
1329 #define R_STAMP_FRAME   0x0002
1330 #define R_STAMP_DATE    0x0004
1331 #define R_STAMP_CAMERA  0x0008
1332 #define R_STAMP_SCENE   0x0010
1333 #define R_STAMP_NOTE    0x0020
1334 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1335 #define R_STAMP_MARKER  0x0080
1336 #define R_STAMP_FILENAME        0x0100
1337 #define R_STAMP_SEQSTRIP        0x0200
1338 #define R_STAMP_RENDERTIME      0x0400
1339 #define R_STAMP_CAMERALENS      0x0800
1340 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1341                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1342                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS)
1343
1344 /* alphamode */
1345 #define R_ADDSKY                0
1346 #define R_ALPHAPREMUL   1
1347 /*#define R_ALPHAKEY            2*/ /* deprecated, shouldn't be used */
1348
1349 /* color_mgt_flag */
1350 enum {
1351         R_COLOR_MANAGEMENT              = (1 << 0),  /* deprecated, should only be used in versioning code only */
1352         /*R_COLOR_MANAGEMENT_PREDIVIDE    = (1 << 1)*/  /* deprecated, shouldn't be used */
1353 };
1354
1355 #if 0  /* TODO */
1356 #if (DNA_DEPRECATED_GCC_POISON == 1)
1357 #pragma GCC poison R_COLOR_MANAGEMENT
1358 #endif
1359 #endif
1360
1361 /* subimtype, flag options for imtype */
1362 enum {
1363         R_OPENEXR_HALF  = 1,  /*deprecated*/
1364         R_OPENEXR_ZBUF  = 2,  /*deprecated*/
1365         R_PREVIEW_JPG   = 4,  /*deprecated*/
1366         R_CINEON_LOG    = 8,  /*deprecated*/
1367         R_TIFF_16BIT    = 16, /*deprecated*/
1368
1369         R_JPEG2K_12BIT                  =     32,  /* Jpeg2000 */                    /*deprecated*/
1370         R_JPEG2K_16BIT                  =     64,                                    /*deprecated*/
1371         R_JPEG2K_YCC                    =     128,  /* when disabled use RGB */      /*deprecated*/
1372         R_JPEG2K_CINE_PRESET    =     256,                                   /*deprecated*/
1373         R_JPEG2K_CINE_48FPS             =     512,                                   /*deprecated*/
1374 };
1375
1376 #if (DNA_DEPRECATED_GCC_POISON == 1)
1377 #pragma GCC poison R_OPENEXR_HALF R_OPENEXR_ZBUF R_PREVIEW_JPG R_CINEON_LOG R_TIFF_16BIT
1378 #pragma GCC poison R_JPEG2K_12BIT R_JPEG2K_16BIT R_JPEG2K_YCC R_JPEG2K_CINE_PRESET R_JPEG2K_CINE_48FPS
1379 #endif
1380
1381 /* bake_mode: same as RE_BAKE_xxx defines */
1382 /* bake_flag: */
1383 #define R_BAKE_CLEAR            1
1384 #define R_BAKE_OSA                      2
1385 #define R_BAKE_TO_ACTIVE        4
1386 #define R_BAKE_NORMALIZE        8
1387 #define R_BAKE_MULTIRES         16
1388 #define R_BAKE_LORES_MESH       32
1389 #define R_BAKE_VCOL                     64
1390 #define R_BAKE_USERSCALE        128
1391
1392 /* bake_normal_space */
1393 #define R_BAKE_SPACE_CAMERA      0
1394 #define R_BAKE_SPACE_WORLD       1
1395 #define R_BAKE_SPACE_OBJECT      2
1396 #define R_BAKE_SPACE_TANGENT 3
1397
1398 /* simplify_flag */
1399 #define R_SIMPLE_NO_TRIANGULATE         1
1400
1401 /* line_thickness_mode */
1402 #define R_LINE_THICKNESS_ABSOLUTE 1
1403 #define R_LINE_THICKNESS_RELATIVE 2
1404
1405 /* sequencer seq_prev_type seq_rend_type */
1406
1407
1408
1409 /* **************** SCENE ********************* */
1410
1411 /* for general use */
1412 #define MAXFRAME        300000
1413 #define MAXFRAMEF       300000.0f
1414
1415 #define MINFRAME        0
1416 #define MINFRAMEF       0.0f
1417
1418 /* (minimum frame number for current-frame) */
1419 #define MINAFRAME       -300000
1420 #define MINAFRAMEF      -300000.0f
1421
1422 /* depricate this! */
1423 #define TESTBASE(v3d, base)  (                                                \
1424         ((base)->flag & SELECT) &&                                                \
1425         ((base)->lay & v3d->lay) &&                                               \
1426         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1427 #define TESTBASELIB(v3d, base)  (                                             \
1428         ((base)->flag & SELECT) &&                                                \
1429         ((base)->lay & v3d->lay) &&                                               \
1430         ((base)->object->id.lib == NULL) &&                                       \
1431         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1432 #define TESTBASELIB_BGMODE(v3d, scene, base)  (                               \
1433         ((base)->flag & SELECT) &&                                                \
1434         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1435         ((base)->object->id.lib == NULL) &&                                       \
1436         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1437 #define BASE_EDITABLE_BGMODE(v3d, scene, base)  (                             \
1438         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1439         ((base)->object->id.lib == NULL) &&                                       \
1440         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1441 #define BASE_SELECTABLE(v3d, base)  (                                         \
1442         (base->lay & v3d->lay) &&                                                 \
1443         (base->object->restrictflag & (OB_RESTRICT_SELECT | OB_RESTRICT_VIEW)) == 0)
1444 #define BASE_VISIBLE(v3d, base)  (                                            \
1445         (base->lay & v3d->lay) &&                                                 \
1446         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1447 #define BASE_VISIBLE_BGMODE(v3d, scene, base)  (                              \
1448         (base->lay & (v3d ? v3d->lay : scene->lay)) &&                            \
1449         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1450
1451 #define FIRSTBASE               scene->base.first
1452 #define LASTBASE                scene->base.last
1453 #define BASACT                  (scene->basact)
1454 #define OBACT                   (BASACT ? BASACT->object: NULL)
1455
1456 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1457 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1458
1459 #define CFRA            (scene->r.cfra)
1460 #define SUBFRA          (scene->r.subframe)
1461 #define SFRA            (scene->r.sfra)
1462 #define EFRA            (scene->r.efra)
1463 #define PRVRANGEON      (scene->r.flag & SCER_PRV_RANGE)
1464 #define PSFRA           ((PRVRANGEON) ? (scene->r.psfra) : (scene->r.sfra))
1465 #define PEFRA           ((PRVRANGEON) ? (scene->r.pefra) : (scene->r.efra))
1466 #define FRA2TIME(a)     ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1467 #define TIME2FRA(a)     ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1468 #define FPS              (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1469
1470 /* base->flag is in DNA_object_types.h */
1471
1472 /* toolsettings->snap_flag */
1473 #define SCE_SNAP                                1
1474 #define SCE_SNAP_ROTATE                 2
1475 #define SCE_SNAP_PEEL_OBJECT    4
1476 #define SCE_SNAP_PROJECT                8
1477 #define SCE_SNAP_NO_SELF                16
1478 /* toolsettings->snap_target */
1479 #define SCE_SNAP_TARGET_CLOSEST 0
1480 #define SCE_SNAP_TARGET_CENTER  1
1481 #define SCE_SNAP_TARGET_MEDIAN  2
1482 #define SCE_SNAP_TARGET_ACTIVE  3
1483 /* toolsettings->snap_mode */
1484 #define SCE_SNAP_MODE_INCREMENT 0
1485 #define SCE_SNAP_MODE_VERTEX    1
1486 #define SCE_SNAP_MODE_EDGE              2
1487 #define SCE_SNAP_MODE_FACE              3
1488 #define SCE_SNAP_MODE_VOLUME    4
1489 #define SCE_SNAP_MODE_NODE_X    5
1490 #define SCE_SNAP_MODE_NODE_Y    6
1491 #define SCE_SNAP_MODE_NODE_XY   7
1492 #define SCE_SNAP_MODE_GRID              8
1493
1494 /* toolsettings->selectmode */
1495 #define SCE_SELECT_VERTEX       1 /* for mesh */
1496 #define SCE_SELECT_EDGE         2
1497 #define SCE_SELECT_FACE         4
1498
1499 /* toolsettings->statvis->type */
1500 #define SCE_STATVIS_OVERHANG    0
1501 #define SCE_STATVIS_THICKNESS   1
1502 #define SCE_STATVIS_INTERSECT   2
1503 #define SCE_STATVIS_DISTORT             3
1504 #define SCE_STATVIS_SHARP               4
1505
1506 /* toolsettings->particle.selectmode for particles */
1507 #define SCE_SELECT_PATH         1
1508 #define SCE_SELECT_POINT        2
1509 #define SCE_SELECT_END          4
1510
1511 /* sce->recalc (now in use by previewrender) */
1512 #define SCE_PRV_CHANGED         1
1513
1514 /* toolsettings->prop_mode (proportional falloff) */
1515 #define PROP_SMOOTH            0
1516 #define PROP_SPHERE            1
1517 #define PROP_ROOT              2
1518 #define PROP_SHARP             3
1519 #define PROP_LIN               4
1520 #define PROP_CONST             5
1521 #define PROP_RANDOM            6
1522 #define PROP_MODE_MAX          7
1523
1524 /* toolsettings->proportional */
1525 #define PROP_EDIT_OFF                   0
1526 #define PROP_EDIT_ON                    1
1527 #define PROP_EDIT_CONNECTED             2
1528 #define PROP_EDIT_PROJECTED             3
1529
1530 /* toolsettings->weightuser */
1531 enum {
1532         OB_DRAW_GROUPUSER_NONE      = 0,
1533         OB_DRAW_GROUPUSER_ACTIVE    = 1,
1534         OB_DRAW_GROUPUSER_ALL       = 2
1535 };
1536
1537 /* toolsettings->vgroupsubset */
1538 /* object_vgroup.c */
1539 typedef enum eVGroupSelect {
1540         WT_VGROUP_ALL = 0,
1541         WT_VGROUP_ACTIVE = 1,
1542         WT_VGROUP_BONE_SELECT = 2,
1543         WT_VGROUP_BONE_DEFORM = 3,
1544         WT_VGROUP_BONE_DEFORM_OFF = 4
1545 } eVGroupSelect;
1546
1547 #define WT_VGROUP_MASK_ALL \
1548         ((1 << WT_VGROUP_ACTIVE) | \
1549          (1 << WT_VGROUP_BONE_SELECT) | \
1550          (1 << WT_VGROUP_BONE_DEFORM) | \
1551          (1 << WT_VGROUP_BONE_DEFORM_OFF) | \
1552          (1 << WT_VGROUP_ALL))
1553
1554
1555 /* sce->flag */
1556 #define SCE_DS_SELECTED                 (1<<0)
1557 #define SCE_DS_COLLAPSED                (1<<1)
1558 #define SCE_NLA_EDIT_ON                 (1<<2)
1559 #define SCE_FRAME_DROP                  (1<<3)
1560
1561
1562         /* return flag BKE_scene_base_iter_next function */
1563 #define F_ERROR                 -1
1564 #define F_START                 0
1565 #define F_SCENE                 1
1566 #define F_DUPLI                 3
1567
1568 /* audio->flag */
1569 #define AUDIO_MUTE                (1<<0)
1570 #define AUDIO_SYNC                (1<<1)
1571 #define AUDIO_SCRUB                       (1<<2)
1572 #define AUDIO_VOLUME_ANIMATED     (1<<3)
1573
1574 enum {
1575         FFMPEG_MULTIPLEX_AUDIO  = 1,  /* deprecated, you can choose none as audiocodec now */
1576         FFMPEG_AUTOSPLIT_OUTPUT = 2,
1577         FFMPEG_LOSSLESS_OUTPUT  = 4,
1578 };
1579
1580 #if (DNA_DEPRECATED_GCC_POISON == 1)
1581 #pragma GCC poison FFMPEG_MULTIPLEX_AUDIO
1582 #endif
1583
1584
1585 /* Paint.flags */
1586 typedef enum {
1587         PAINT_SHOW_BRUSH = (1 << 0),
1588         PAINT_FAST_NAVIGATE = (1 << 1),
1589         PAINT_SHOW_BRUSH_ON_SURFACE = (1 << 2),
1590 } PaintFlags;
1591
1592 /* Paint.symmetry_flags
1593  * (for now just a duplicate of sculpt symmetry flags) */
1594 typedef enum SymmetryFlags {
1595         PAINT_SYMM_X = (1 << 0),
1596         PAINT_SYMM_Y = (1 << 1),
1597         PAINT_SYMM_Z = (1 << 2),
1598         PAINT_SYMMETRY_FEATHER = (1 << 3)
1599 } SymmetryFlags;
1600
1601 #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z)
1602
1603 /* Sculpt.flags */
1604 /* These can eventually be moved to paint flags? */
1605 typedef enum SculptFlags {
1606         /* deprecated, part of paint struct symmetry_flags now */
1607         SCULPT_SYMM_X = (1 << 0),
1608         SCULPT_SYMM_Y = (1 << 1),
1609         SCULPT_SYMM_Z = (1 << 2),
1610
1611         SCULPT_LOCK_X = (1 << 3),
1612         SCULPT_LOCK_Y = (1 << 4),
1613         SCULPT_LOCK_Z = (1 << 5),
1614         /* deprecated, part of paint struct symmetry_flags now */
1615         SCULPT_SYMMETRY_FEATHER = (1 << 6),
1616
1617         SCULPT_USE_OPENMP = (1 << 7),
1618         SCULPT_ONLY_DEFORM = (1 << 8),
1619         SCULPT_SHOW_DIFFUSE = (1 << 9),
1620
1621         /* If set, the mesh will be drawn with smooth-shading in
1622          * dynamic-topology mode */
1623         SCULPT_DYNTOPO_SMOOTH_SHADING = (1 << 10),
1624
1625         /* If set, dynamic-topology brushes will subdivide short edges */
1626         SCULPT_DYNTOPO_SUBDIVIDE = (1 << 12),
1627         /* If set, dynamic-topology brushes will collapse short edges */
1628         SCULPT_DYNTOPO_COLLAPSE = (1 << 11)
1629 } SculptFlags;
1630
1631 #if (DNA_DEPRECATED_GCC_POISON == 1)
1632 #pragma GCC poison SCULPT_SYMM_X SCULPT_SYMM_Y SCULPT_SYMM_Z SCULPT_SYMMETRY_FEATHER
1633 #endif
1634
1635
1636 /* ImagePaintSettings.flag */
1637 #define IMAGEPAINT_DRAWING                              1
1638 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
1639 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
1640
1641 /* projection painting only */
1642 #define IMAGEPAINT_PROJECT_XRAY                 16
1643 #define IMAGEPAINT_PROJECT_BACKFACE             32
1644 #define IMAGEPAINT_PROJECT_FLAT                 64
1645 #define IMAGEPAINT_PROJECT_LAYER_CLONE  128
1646 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        256
1647 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    512
1648
1649 /* toolsettings->uvcalc_flag */
1650 #define UVCALC_FILLHOLES                        1
1651 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
1652 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
1653 #define UVCALC_USESUBSURF                       8       /* Use mesh data after subsurf to compute UVs*/
1654
1655 /* toolsettings->uv_flag */
1656 #define UV_SYNC_SELECTION       1
1657 #define UV_SHOW_SAME_IMAGE      2
1658
1659 /* toolsettings->uv_selectmode */
1660 #define UV_SELECT_VERTEX        1
1661 #define UV_SELECT_EDGE          2
1662 #define UV_SELECT_FACE          4
1663 #define UV_SELECT_ISLAND        8
1664
1665 /* toolsettings->edge_mode */
1666 #define EDGE_MODE_SELECT                                0
1667 #define EDGE_MODE_TAG_SEAM                              1
1668 #define EDGE_MODE_TAG_SHARP                             2
1669 #define EDGE_MODE_TAG_CREASE                    3
1670 #define EDGE_MODE_TAG_BEVEL                             4
1671 #define EDGE_MODE_TAG_FREESTYLE                 5
1672
1673 /* toolsettings->gpencil_flags */
1674 #define GP_TOOL_FLAG_PAINTSESSIONS_ON   (1<<0)
1675
1676 /* toolsettings->particle flag */
1677 #define PE_KEEP_LENGTHS                 1
1678 #define PE_LOCK_FIRST                   2
1679 #define PE_DEFLECT_EMITTER              4
1680 #define PE_INTERPOLATE_ADDED    8
1681 #define PE_DRAW_PART                    16
1682 /* #define PE_X_MIRROR                  64 */   /* deprecated */
1683 #define PE_FADE_TIME                    128
1684 #define PE_AUTO_VELOCITY                256
1685
1686 /* toolsetting->particle brushtype */
1687 #define PE_BRUSH_NONE           -1
1688 #define PE_BRUSH_COMB           0
1689 #define PE_BRUSH_CUT            1
1690 #define PE_BRUSH_LENGTH         2
1691 #define PE_BRUSH_PUFF           3
1692 #define PE_BRUSH_ADD            4
1693 #define PE_BRUSH_SMOOTH         5
1694 #define PE_BRUSH_WEIGHT         6
1695
1696 /* this must equal ParticleEditSettings.brush array size */
1697 #define PE_TOT_BRUSH            6
1698
1699 /* ParticleBrushData->flag */
1700 #define PE_BRUSH_DATA_PUFF_VOLUME 1
1701
1702 /* tooksettings->particle edittype */
1703 #define PE_TYPE_PARTICLES       0
1704 #define PE_TYPE_SOFTBODY        1
1705 #define PE_TYPE_CLOTH           2
1706
1707 /* toolsettings->skgen_options */
1708 #define SKGEN_FILTER_INTERNAL   (1 << 0)
1709 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
1710 #define SKGEN_SYMMETRY                  (1 << 2)
1711 #define SKGEN_CUT_LENGTH                (1 << 3)
1712 #define SKGEN_CUT_ANGLE                 (1 << 4)
1713 #define SKGEN_CUT_CORRELATION   (1 << 5)
1714 #define SKGEN_HARMONIC                  (1 << 6)
1715 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
1716 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
1717 #define SKGEN_FILTER_SMART              (1 << 9)
1718 #define SKGEN_DISP_LENGTH               (1 << 10)
1719 #define SKGEN_DISP_WEIGHT               (1 << 11)
1720 #define SKGEN_DISP_ORIG                 (1 << 12)
1721 #define SKGEN_DISP_EMBED                (1 << 13)
1722 #define SKGEN_DISP_INDEX                (1 << 14)
1723
1724 #define SKGEN_SUB_LENGTH                0
1725 #define SKGEN_SUB_ANGLE                 1
1726 #define SKGEN_SUB_CORRELATION   2
1727 #define SKGEN_SUB_TOTAL                 3
1728
1729 /* toolsettings->skgen_postpro */
1730 #define SKGEN_SMOOTH                    0
1731 #define SKGEN_AVERAGE                   1
1732 #define SKGEN_SHARPEN                   2
1733
1734 /* toolsettings->bone_sketching */
1735 #define BONE_SKETCHING                  1
1736 #define BONE_SKETCHING_QUICK    2
1737 #define BONE_SKETCHING_ADJUST   4
1738
1739 /* toolsettings->bone_sketching_convert */
1740 #define SK_CONVERT_CUT_FIXED                    0
1741 #define SK_CONVERT_CUT_LENGTH                   1
1742 #define SK_CONVERT_CUT_ADAPTATIVE               2
1743 #define SK_CONVERT_RETARGET                             3
1744
1745 /* toolsettings->skgen_retarget_options */
1746 #define SK_RETARGET_AUTONAME                    1
1747
1748 /* toolsettings->skgen_retarget_roll */
1749 #define SK_RETARGET_ROLL_NONE                   0
1750 #define SK_RETARGET_ROLL_VIEW                   1
1751 #define SK_RETARGET_ROLL_JOINT                  2
1752
1753 /* physics_settings->flag */
1754 #define PHYS_GLOBAL_GRAVITY             1
1755
1756 /* UnitSettings */
1757
1758 /* UnitSettings->system */
1759 #define USER_UNIT_NONE                  0
1760 #define USER_UNIT_METRIC                1
1761 #define USER_UNIT_IMPERIAL              2
1762 /* UnitSettings->flag */
1763 #define USER_UNIT_OPT_SPLIT             1
1764 #define USER_UNIT_ROT_RADIANS   2
1765
1766 #ifdef __cplusplus
1767 }
1768 #endif
1769
1770 #endif  /* __DNA_SCENE_TYPES_H__ */