Merged changes in the trunk up to revision 27647.
[blender-staging.git] / source / blender / makesdna / DNA_scene_types.h
1 /**
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef DNA_SCENE_TYPES_H
30 #define DNA_SCENE_TYPES_H
31
32 // XXX, temp feature
33 #define DURIAN_CAMERA_SWITCH
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "DNA_brush_types.h"
40 #include "DNA_vec_types.h"
41 #include "DNA_listBase.h"
42 #include "DNA_ID.h"
43 #include "DNA_freestyle_types.h"
44
45 struct Object;
46 struct World;
47 struct Scene;
48 struct Image;
49 struct Group;
50 struct Text;
51 struct bNodeTree;
52 struct AnimData;
53 struct Editing;
54 struct SceneStats;
55 struct bGPdata;
56
57 typedef struct Base {
58         struct Base *next, *prev;
59         unsigned int lay, selcol;
60         int flag;
61         short sx, sy;
62         struct Object *object;
63 } Base;
64
65 typedef struct AviCodecData {
66         void                    *lpFormat;  /* save format */
67         void                    *lpParms;   /* compressor options */
68         unsigned int    cbFormat;           /* size of lpFormat buffer */
69         unsigned int    cbParms;            /* size of lpParms buffer */
70
71         unsigned int    fccType;            /* stream type, for consistency */
72         unsigned int    fccHandler;         /* compressor */
73         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
74         unsigned int    dwQuality;          /* compress quality 0-10,000 */
75         unsigned int    dwBytesPerSecond;   /* bytes per second */
76         unsigned int    dwFlags;            /* flags... see below */
77         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
78         unsigned int    pad;
79
80         char                    avicodecname[128];
81 } AviCodecData;
82
83 typedef struct QuicktimeCodecData {
84         /*Old quicktime implementation compatibility fields, read only in 2.5 - deprecated*/
85         void                    *cdParms;   /* codec/compressor options */
86         void                    *pad;       /* padding */
87
88         unsigned int    cdSize;             /* size of cdParms buffer */
89         unsigned int    pad2;               /* padding */
90
91         char                    qtcodecname[128];
92 } QuicktimeCodecData;
93         
94 typedef struct QuicktimeCodecSettings {
95         /* Codec settings detailed for 2.5 implementation*/
96         int codecType; /* Types defined in quicktime_export.h */
97         int     codecSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
98
99         /* Settings not available in current QTKit API */
100         int     codec;
101         int     codecFlags;
102         int     colorDepth;
103         int     codecTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
104         int     minSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
105         int     minTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
106         int     keyFrameRate;
107         int     bitRate;        /* bitrate in bps */
108 } QuicktimeCodecSettings;
109
110 typedef struct FFMpegCodecData {
111         int type;
112         int codec;
113         int audio_codec;
114         int video_bitrate;
115         int audio_bitrate;
116         int audio_mixrate;
117         float audio_volume;
118         int gop_size;
119         int flags;
120
121         int rc_min_rate;
122         int rc_max_rate;
123         int rc_buffer_size;
124         int mux_packet_size;
125         int mux_rate;
126         IDProperty *properties;
127 } FFMpegCodecData;
128
129
130 typedef struct AudioData {
131         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
132         float main; // 2.5: now in FFMpegCodecData: audio_volume
133         float speed_of_sound;
134         float doppler_factor;
135         int distance_model;
136         short flag;
137         short pad;
138 } AudioData;
139
140 typedef struct SceneRenderLayer {
141         struct SceneRenderLayer *next, *prev;
142         
143         char name[32];
144         
145         struct Material *mat_override;
146         struct Group *light_override;
147         
148         unsigned int lay;               /* scene->lay itself has priority over this */
149         unsigned int lay_zmask; /* has to be after lay, this is for Z-masking */
150         int layflag;
151         
152         int pad;
153         
154         int passflag;                   /* pass_xor has to be after passflag */
155         int pass_xor;
156         
157         struct FreestyleConfig freestyleConfig;
158         
159 } SceneRenderLayer;
160
161 /* srl->layflag */
162 #define SCE_LAY_SOLID   1
163 #define SCE_LAY_ZTRA    2
164 #define SCE_LAY_HALO    4
165 #define SCE_LAY_EDGE    8
166 #define SCE_LAY_SKY             16
167 #define SCE_LAY_STRAND  32
168 #define SCE_LAY_FRS             64
169         /* flags between 32 and 0x8000 are set to 1 already, for future options */
170
171 #define SCE_LAY_ALL_Z           0x8000
172 #define SCE_LAY_XOR                     0x10000
173 #define SCE_LAY_DISABLE         0x20000
174 #define SCE_LAY_ZMASK           0x40000
175 #define SCE_LAY_NEG_ZMASK       0x80000
176
177 /* srl->passflag */
178 #define SCE_PASS_COMBINED               1
179 #define SCE_PASS_Z                              2
180 #define SCE_PASS_RGBA                   4
181 #define SCE_PASS_DIFFUSE                8
182 #define SCE_PASS_SPEC                   16
183 #define SCE_PASS_SHADOW                 32
184 #define SCE_PASS_AO                             64
185 #define SCE_PASS_REFLECT                128
186 #define SCE_PASS_NORMAL                 256
187 #define SCE_PASS_VECTOR                 512
188 #define SCE_PASS_REFRACT                1024
189 #define SCE_PASS_INDEXOB                2048
190 #define SCE_PASS_UV                             4096
191 #define SCE_PASS_INDIRECT               8192
192 #define SCE_PASS_MIST                   16384
193 #define SCE_PASS_RAYHITS                32768
194 #define SCE_PASS_EMIT                   65536
195 #define SCE_PASS_ENVIRONMENT    131072
196
197 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
198
199
200 typedef struct RenderData {
201         
202         struct AviCodecData *avicodecdata;
203         struct QuicktimeCodecData *qtcodecdata;
204         struct QuicktimeCodecSettings qtcodecsettings;
205         struct FFMpegCodecData ffcodecdata;
206         
207         int cfra, sfra, efra;   /* frames as in 'images' */
208         int psfra, pefra;               /* start+end frames of preview range */
209
210         int images, framapto;
211         short flag, threads;
212
213         float ctime;                    /* use for calcutions */
214         float framelen, blurfac;
215
216         /** For UR edge rendering: give the edges this color */
217         float edgeR, edgeG, edgeB;
218         
219         short fullscreen, xplay, yplay, freqplay;       /* standalone player */  //  XXX deprecated since 2.5
220         short depth, attrib, rt2;                       /* standalone player */  //  XXX deprecated since 2.5
221         short frame_step;               /* frames to jump during render/playback */
222
223         short stereomode;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
224         
225         short dimensionspreset;         /* for the dimensions presets menu */
226         
227         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
228
229         short size, maximsize;  /* size in %, max in Kb */
230         /* from buttons: */
231         /**
232          * The desired number of pixels in the x direction
233          */
234         short xsch;
235         /**
236          * The desired number of pixels in the y direction
237          */
238         short ysch;
239         /**
240          * The number of part to use in the x direction
241          */
242         short xparts;
243         /**
244          * The number of part to use in the y direction
245          */
246         short yparts;
247         
248         short winpos, planes, imtype, subimtype;
249         
250         /** Mode bits:                                                           */
251         /* 0: Enable backbuffering for images                                    */
252         short bufflag;
253         short quality;
254         
255         /**
256          * Render to image editor, fullscreen or to new window.
257          */
258         short displaymode;
259         
260         short rpad1, rpad2;
261
262         /**
263          * Flags for render settings. Use bit-masking to access the settings.
264          */
265         int scemode;
266
267         /**
268          * Flags for render settings. Use bit-masking to access the settings.
269          */
270         int mode;
271
272         /**
273          * Flags for raytrace settings. Use bit-masking to access the settings.
274          */
275         int raytrace_options;
276         
277         /**
278          * Raytrace acceleration structure
279          */
280         short raytrace_structure;
281
282         /* renderer (deprecated) */
283         short renderer;
284
285         /* octree resolution */
286         short ocres;
287         short pad4;
288         
289         /**
290          * What to do with the sky/background. Picks sky/premul/key
291          * blending for the background
292          */
293         short alphamode;
294
295         /**
296          * The number of samples to use per pixel.
297          */
298         short osa;
299
300         short frs_sec, edgeint;
301
302         
303         /* safety, border and display rect */
304         rctf safety, border;
305         rcti disprect;
306         
307         /* information on different layers to be rendered */
308         ListBase layers;
309         short actlay;
310         
311         /* number of mblur samples */
312         short mblur_samples;
313         
314         /**
315          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
316          */
317         float xasp;
318         /**
319          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
320          */
321         float yasp;
322
323         float frs_sec_base;
324         
325         /**
326          * Value used to define filter size for all filter options  */
327         float gauss;
328         
329         
330         /* color management settings - color profiles, gamma correction, etc */
331         int color_mgt_flag;
332         
333         /** post-production settings. Depricated, but here for upwards compat (initialized to 1) */      
334         float postgamma, posthue, postsat;       
335         
336         /* Dither noise intensity */
337         float dither_intensity;
338         
339         /* Bake Render options */
340         short bake_osa, bake_filter, bake_mode, bake_flag;
341         short bake_normal_space, bake_quad_split;
342         float bake_maxdist, bake_biasdist, bake_pad;
343         
344         /* yafray: global panel params. TODO: move elsewhere */
345         short GIquality, GIcache, GImethod, GIphotons, GIdirect;
346         short YF_AA, YFexportxml, YF_nobump, YF_clamprgb, yfpad1;
347         int GIdepth, GIcausdepth, GIpixelspersample;
348         int GIphotoncount, GImixphotons;
349         float GIphotonradius;
350         int YF_raydepth, YF_AApasses, YF_AAsamples, yfpad2;
351         float GIshadowquality, GIrefinement, GIpower, GIindirpower;
352         float YF_gamma, YF_exposure, YF_raybias, YF_AApixelsize, YF_AAthreshold;
353
354         /* paths to backbufffer, output, ftype */
355         char backbuf[160], pic[160];
356
357         /* stamps flags. */
358         int stamp;
359         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
360
361         /* stamp info user data. */
362         char stamp_udata[160];
363
364         /* foreground/background color. */
365         float fg_stamp[4];
366         float bg_stamp[4];
367
368         /* sequencer options */
369         char seq_prev_type;
370         char seq_rend_type;
371         char seq_flag; /* flag use for sequence render/draw */
372         char pad5[5];
373
374         /* render simplify */
375         int simplify_flag;
376         short simplify_subsurf;
377         short simplify_shadowsamples;
378         float simplify_particles;
379         float simplify_aosss;
380
381         /* cineon */
382         short cineonwhite, cineonblack;
383         float cineongamma;
384         
385         /* jpeg2000 */
386         short jp2_preset, jp2_depth;
387         int rpad3;
388
389         /* Dome variables */ //  XXX deprecated since 2.5
390         short domeres, domemode;        //  XXX deprecated since 2.5
391         short domeangle, dometilt;      //  XXX deprecated since 2.5
392         float domeresbuf;       //  XXX deprecated since 2.5
393         float pad2;                     //  XXX deprecated since 2.5
394         struct Text *dometext;  //  XXX deprecated since 2.5
395
396         /* render engine */
397         char engine[32];
398 } RenderData;
399
400 /* control render convert and shading engine */
401 typedef struct RenderProfile {
402         struct RenderProfile *next, *prev;
403         char name[32];
404         
405         short particle_perc;
406         short subsurf_max;
407         short shadbufsample_max;
408         short pad1;
409         
410         float ao_error, pad2;
411         
412 } RenderProfile;
413
414 typedef struct GameDome {
415         short res, mode;
416         short angle, tilt;
417         float resbuf, pad2;
418         struct Text *warptext;
419 } GameDome;
420
421 #define DOME_FISHEYE                    1
422 #define DOME_TRUNCATED_FRONT    2
423 #define DOME_TRUNCATED_REAR             3
424 #define DOME_ENVMAP                             4
425 #define DOME_PANORAM_SPH                5
426 #define DOME_NUM_MODES                  6
427
428 typedef struct GameFraming {
429         float col[3];
430         char type, pad1, pad2, pad3;
431 } GameFraming;
432
433 #define SCE_GAMEFRAMING_BARS   0
434 #define SCE_GAMEFRAMING_EXTEND 1
435 #define SCE_GAMEFRAMING_SCALE  2
436
437 typedef struct GameData {
438
439         /* physics (it was in world)*/
440         float gravity; /*Gravitation constant for the game world*/
441
442         /*
443          * Radius of the activity bubble, in Manhattan length. Objects
444          * outside the box are activity-culled. */
445         float activityBoxRadius; //it's not being used ANYWHERE !!!!!!!!!!!!!!
446         /*
447          * bit 3: (gameengine): Activity culling is enabled.
448          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustrum culling
449         */
450         short mode, flag, matmode, pad[3];
451         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
452         short physicsEngine;
453         short ticrate, maxlogicstep, physubstep, maxphystep;
454
455         /*  standalone player */
456         struct GameFraming framing;
457         short fullscreen, xplay, yplay, freqplay;
458         short depth, attrib, rt1, rt2;
459
460         /* stereo/dome mode */
461         struct GameDome dome;
462         short stereoflag, stereomode, xsch, ysch; //xsch and ysch can be deleted !!!
463         float eyeseparation, pad1;
464 } GameData;
465
466 #define STEREO_NOSTEREO         1
467 #define STEREO_ENABLED          2
468 #define STEREO_DOME                     3
469
470 //#define STEREO_NOSTEREO                1
471 #define STEREO_QUADBUFFERED 2
472 #define STEREO_ABOVEBELOW        3
473 #define STEREO_INTERLACED        4
474 #define STEREO_ANAGLYPH         5
475 #define STEREO_SIDEBYSIDE       6
476 #define STEREO_VINTERLACE       7
477 //#define STEREO_DOME           8
478
479 /* physicsEngine */
480 #define WOPHY_NONE              0
481 #define WOPHY_ENJI              1
482 #define WOPHY_SUMO              2
483 #define WOPHY_DYNAMO    3
484 #define WOPHY_ODE               4
485 #define WOPHY_BULLET    5
486
487 /* GameData.flag */
488 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
489 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
490 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
491 #define GAME_SHOW_PHYSICS                                       (1 << 4)
492 #define GAME_DISPLAY_LISTS                                      (1 << 5)
493 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
494 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
495 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
496 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
497 #define GAME_GLSL_NO_NODES                                      (1 << 10)
498 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
499 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
500 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
501
502 /* GameData.matmode */
503 #define GAME_MAT_TEXFACE        0
504 #define GAME_MAT_MULTITEX       1
505 #define GAME_MAT_GLSL           2
506
507 typedef struct TimeMarker {
508         struct TimeMarker *next, *prev;
509         int frame;
510         char name[64];
511         unsigned int flag;
512         struct Object *camera;
513 } TimeMarker;
514
515 typedef struct Paint {
516         /* Array of brushes selected for use in this paint mode */
517         Brush **brushes;
518         int active_brush_index, brush_count;
519         
520         /* WM Paint cursor */
521         void *paint_cursor;
522         unsigned char paint_cursor_col[4];
523
524         int flags;
525 } Paint;
526
527 typedef struct ImagePaintSettings {
528         Paint paint;
529
530         short flag, pad;
531         
532         /* for projection painting only */
533         short seam_bleed, normal_angle;
534         short screen_grab_size[2]; /* capture size for re-projection */
535
536         int pad1;
537
538         void *paintcursor;                      /* wm handle */
539 } ImagePaintSettings;
540
541 typedef struct ParticleBrushData {
542         short size, strength;   /* common settings */
543         short step, invert;             /* for specific brushes only */
544         int flag, pad;
545 } ParticleBrushData;
546
547 typedef struct ParticleEditSettings {
548         short flag;
549         short totrekey;
550         short totaddkey;
551         short brushtype;
552
553         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
554         void *paintcursor;                      /* runtime */
555
556         float emitterdist, rt;
557
558         int selectmode;
559         int edittype;
560
561         int draw_step, fade_frames;
562
563         struct Scene *scene;
564         struct Object *object;
565 } ParticleEditSettings;
566
567 typedef struct TransformOrientation {
568         struct TransformOrientation *next, *prev;
569         char name[36];
570         float mat[3][3];
571 } TransformOrientation;
572
573 typedef struct Sculpt {
574         Paint paint;
575
576         /* For rotating around a pivot point */
577         float pivot[3];
578         int flags;
579
580         /* Control tablet input */
581         char tablet_size, tablet_strength;
582         char pad[6];
583 } Sculpt;
584
585 typedef struct VPaint {
586         Paint paint;
587
588         short flag, pad;
589         int tot;                                                        /* allocation size of prev buffers */
590         unsigned int *vpaint_prev;                      /* previous mesh colors */
591         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
592         
593         void *paintcursor;                                      /* wm handle */
594 } VPaint;
595
596 /* VPaint flag */
597 #define VP_COLINDEX     1
598 #define VP_AREA         2
599
600 #define VP_NORMALS      8
601 #define VP_SPRAY        16
602 // #define VP_MIRROR_X  32 // depricated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X)
603 #define VP_ONLYVGROUP   128
604
605
606 typedef struct ToolSettings {
607         VPaint *vpaint;         /* vertex paint */
608         VPaint *wpaint;         /* weight paint */
609         Sculpt *sculpt;
610         
611         /* Vertex groups */
612         float vgroup_weight;
613
614         /* Subdivide Settings */
615         short cornertype;
616         short editbutflag;
617         /*Triangle to Quad conversion threshold*/
618         float jointrilimit;
619         /* Editmode Tools */
620         float degr; 
621         short step;
622         short turn; 
623         
624         float extr_offs;        /* extrude offset */
625         float doublimit;        /* remove doubles limit */
626         float normalsize;       /* size of normals */
627         short automerge;
628
629         /* Selection Mode for Mesh */
630         short selectmode;
631
632         /* Primitive Settings */
633         /* UV Sphere */
634         short segments;
635         short rings;
636         
637         /* Cylinder - Tube - Circle */
638         short vertices;
639
640         /* UV Calculation */
641         short unwrapper;
642         float uvcalc_radius;
643         float uvcalc_cubesize;
644         float uvcalc_margin;
645         short uvcalc_mapdir;
646         short uvcalc_mapalign;
647         short uvcalc_flag;
648         short uv_flag, uv_selectmode;
649         short uv_pad[2];
650
651         /* Auto-IK */
652         short autoik_chainlen;
653
654         /* Image Paint (8 byttse aligned please!) */
655         struct ImagePaintSettings imapaint;
656
657         /* Particle Editing */
658         struct ParticleEditSettings particle;
659         
660         /* Transform Proportional Area of Effect */
661         float proportional_size;
662
663         /* Select Group Threshold */
664         float select_thresh;
665         
666         /* Graph Editor */
667         float clean_thresh;
668
669         /* Auto-Keying Mode */
670         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
671         
672         /* Retopo */
673         char retopo_mode;
674         char retopo_paint_tool;
675         char line_div, ellipse_div, retopo_hotspot;
676
677         /* Multires */
678         char multires_subdiv_type;
679         
680         /* Skeleton generation */
681         short skgen_resolution;
682         float skgen_threshold_internal;
683         float skgen_threshold_external;
684         float skgen_length_ratio;
685         float skgen_length_limit;
686         float skgen_angle_limit;
687         float skgen_correlation_limit;
688         float skgen_symmetry_limit;
689         float skgen_retarget_angle_weight;
690         float skgen_retarget_length_weight;
691         float skgen_retarget_distance_weight;
692         short skgen_options;
693         char  skgen_postpro;
694         char  skgen_postpro_passes;
695         char  skgen_subdivisions[3];
696         char  skgen_multi_level;
697         
698         /* Skeleton Sketching */
699         struct Object *skgen_template;
700         char bone_sketching;
701         char bone_sketching_convert;
702         char skgen_subdivision_number;
703         char skgen_retarget_options;
704         char skgen_retarget_roll;
705         char skgen_side_string[8];
706         char skgen_num_string[8];
707         
708         /* Alt+RMB option */
709         char edge_mode;
710
711         /* Transform */
712         short snap_mode, snap_flag, snap_target;
713         short proportional, prop_mode;
714
715         int auto_normalize, intpad; /*auto normalizing mode in wpaint*/
716 } ToolSettings;
717
718 typedef struct bStats {
719         /* scene totals for visible layers */
720         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
721         int totvert, totface;
722 } bStats;
723
724 typedef struct UnitSettings {
725         /* Display/Editing unit options for each scene */
726         float scale_length; /* maybe have other unit conversions? */
727         short system;
728         short flag; /* imperial, metric etc */
729 } UnitSettings;
730
731 typedef struct PhysicsSettings {
732         float gravity[3];
733         int flag;
734 } PhysicsSettings;
735
736 typedef struct Scene {
737         ID id;
738         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
739         
740         struct Object *camera;
741         struct World *world;
742         
743         struct Scene *set;
744         struct Image *ima;
745         
746         ListBase base;
747         struct Base *basact;            /* active base */
748         struct Object *obedit;          /* name replaces old G.obedit */
749         
750         float cursor[3];                        /* 3d cursor location */
751         float twcent[3];                        /* center for transform widget */
752         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
753         unsigned int lay;
754         
755
756         short flag;                                                             /* various settings */
757         
758         short use_nodes;
759         
760         struct bNodeTree *nodetree;     
761         
762         struct Editing *ed;                                                             /* sequence editor data is allocated here */
763         
764         struct ToolSettings *toolsettings;              /* default allocated now */
765         struct SceneStats *stats;                               /* default allocated now */
766
767         /* migrate or replace? depends on some internal things... */
768         /* no, is on the right place (ton) */
769         struct RenderData r;
770         struct AudioData audio;
771         
772         ListBase markers;
773         ListBase transform_spaces;
774         
775         void *sound_scene;
776         void *sound_scene_handle;
777         
778         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
779         
780         /* none of the dependancy graph  vars is mean to be saved */
781         struct  DagForest *theDag;
782         short dagisvalid, dagflags;
783         short recalc;                           /* recalc = counterpart of ob->recalc */
784
785         short jumpframe;
786         int pad5;
787
788         /* User-Defined KeyingSets */
789         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
790         ListBase keyingsets;                    /* KeyingSets for the given frame */
791         
792         /* Game Settings */
793         struct GameFraming framing; // XXX  deprecated since 2.5
794         struct GameData gm;
795
796         /* Units */
797         struct UnitSettings unit;
798         
799         /* Grease Pencil */
800         struct bGPdata *gpd;
801
802         /* Physics simulation settings */
803         struct PhysicsSettings physics_settings;
804 } Scene;
805
806
807 /* **************** RENDERDATA ********************* */
808
809 /* bufflag */
810 #define R_BACKBUF               1
811 #define R_BACKBUFANIM   2
812 #define R_FRONTBUF              4
813 #define R_FRONTBUFANIM  8
814
815 /* flag */
816         /* use preview range */
817 #define SCER_PRV_RANGE  (1<<0)
818
819 /* mode (int now) */
820 #define R_OSA                   0x0001
821 #define R_SHADOW                0x0002
822 #define R_GAMMA                 0x0004
823 #define R_ORTHO                 0x0008
824 #define R_ENVMAP                0x0010
825 #define R_EDGE                  0x0020
826 #define R_FIELDS                0x0040
827 #define R_FIELDSTILL    0x0080
828 #define R_RADIO                 0x0100
829 #define R_BORDER                0x0200
830 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
831 #define R_CROP                  0x0800
832 #define R_COSMO                 0x1000
833 #define R_ODDFIELD              0x2000
834 #define R_MBLUR                 0x4000
835                 /* unified was here */
836 #define R_RAYTRACE      0x10000
837                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
838 #define R_GAUSS         0x20000
839                 /* fbuf obsolete... */
840 #define R_FBUF                  0x40000
841                 /* threads obsolete... is there for old files, now use for autodetect threads */
842 #define R_THREADS               0x80000
843                 /* Use the same flag for autothreads */
844 #define R_FIXED_THREADS         0x80000 
845
846 #define R_SPEED                 0x100000
847 #define R_SSS                   0x200000
848 #define R_NO_OVERWRITE  0x400000 /* skip existing files */
849 #define R_TOUCH                 0x800000 /* touch files before rendering */
850 #define R_SIMPLIFY              0x1000000
851 #define R_EDGE_FRS              0x2000000 /* R_EDGE for Freestyle */
852
853 /* seq_flag */
854 #define R_SEQ_GL_PREV 1
855 #define R_SEQ_GL_REND 2
856
857 /* displaymode */
858
859 #define R_OUTPUT_SCREEN 0
860 #define R_OUTPUT_AREA   1
861 #define R_OUTPUT_WINDOW 2
862 #define R_OUTPUT_FORKED 3
863
864 /* filtertype */
865 #define R_FILTER_BOX    0
866 #define R_FILTER_TENT   1
867 #define R_FILTER_QUAD   2
868 #define R_FILTER_CUBIC  3
869 #define R_FILTER_CATROM 4
870 #define R_FILTER_GAUSS  5
871 #define R_FILTER_MITCH  6
872 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
873
874 /* yafray: renderer flag (not only exclusive to yafray) */
875 #define R_INTERN        0
876 #define R_YAFRAY        1
877
878 /* raytrace structure */
879 #define R_RAYSTRUCTURE_AUTO                             0
880 #define R_RAYSTRUCTURE_OCTREE                   1
881 #define R_RAYSTRUCTURE_BLIBVH                   2
882 #define R_RAYSTRUCTURE_VBVH                             3
883 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
884 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
885
886 /* raytrace_options */
887 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
888 #define R_RAYTRACE_USE_INSTANCES                0x0002
889
890 /* scemode (int now) */
891 #define R_DOSEQ                         0x0001
892 #define R_BG_RENDER                     0x0002
893                 /* passepartout is camera option now, keep this for backward compatibility */
894 #define R_PASSEPARTOUT          0x0004
895 #define R_PREVIEWBUTS           0x0008
896 #define R_EXTENSION                     0x0010
897 #define R_MATNODE_PREVIEW       0x0020
898 #define R_DOCOMP                        0x0040
899 #define R_COMP_CROP                     0x0080
900 #define R_FREE_IMAGE            0x0100
901 #define R_SINGLE_LAYER          0x0200
902 #define R_EXR_TILE_FILE         0x0400
903 #define R_COMP_FREE                     0x0800
904 #define R_NO_IMAGE_LOAD         0x1000
905 #define R_NO_TEX                        0x2000
906 #define R_STAMP_INFO            0x4000  /* deprecated */
907 #define R_FULL_SAMPLE           0x8000
908 #define R_COMP_RERENDER         0x10000
909 #define R_RECURS_PROTECTION     0x20000
910 #define R_TEXNODE_PREVIEW       0x40000
911
912 /* r->stamp */
913 #define R_STAMP_TIME    0x0001
914 #define R_STAMP_FRAME   0x0002
915 #define R_STAMP_DATE    0x0004
916 #define R_STAMP_CAMERA  0x0008
917 #define R_STAMP_SCENE   0x0010
918 #define R_STAMP_NOTE    0x0020
919 #define R_STAMP_DRAW    0x0040 /* draw in the image */
920 #define R_STAMP_MARKER  0x0080
921 #define R_STAMP_FILENAME        0x0100
922 #define R_STAMP_SEQSTRIP        0x0200
923 #define R_STAMP_RENDERTIME      0x0400
924 #define R_STAMP_ALL             (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE|R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|R_STAMP_RENDERTIME)
925
926 /* alphamode */
927 #define R_ADDSKY                0
928 #define R_ALPHAPREMUL   1
929 #define R_ALPHAKEY              2
930
931 /* planes */
932 #define R_PLANES24              24
933 #define R_PLANES32              32
934 #define R_PLANESBW              8
935
936 /* color_mgt_flag */
937 #define R_COLOR_MANAGEMENT      1
938
939 /* imtype */
940 #define R_TARGA         0
941 #define R_IRIS          1
942 #define R_HAMX          2
943 #define R_FTYPE         3 /* ftype is nomore */
944 #define R_JPEG90        4
945 #define R_MOVIE         5
946 #define R_IRIZ          7
947 #define R_RAWTGA        14
948 #define R_AVIRAW        15
949 #define R_AVIJPEG       16
950 #define R_PNG           17
951 #define R_AVICODEC      18
952 #define R_QUICKTIME 19
953 #define R_BMP           20
954 #define R_RADHDR        21
955 #define R_TIFF          22
956 #define R_OPENEXR       23
957 #define R_FFMPEG        24
958 #define R_FRAMESERVER   25
959 #define R_CINEON                26
960 #define R_DPX                   27
961 #define R_MULTILAYER    28
962 #define R_DDS                   29
963 #define R_JP2                   30
964 #define R_H264          31
965 #define R_XVID          32
966 #define R_THEORA        33
967
968 /* subimtype, flag options for imtype */
969 #define R_OPENEXR_HALF  1
970 #define R_OPENEXR_ZBUF  2
971 #define R_PREVIEW_JPG   4
972 #define R_CINEON_LOG    8
973 #define R_TIFF_16BIT    16
974
975 #define R_JPEG2K_12BIT  32 /* Jpeg2000 */
976 #define R_JPEG2K_16BIT  64
977 #define R_JPEG2K_YCC    128 /* when disabled use RGB */
978 #define R_JPEG2K_CINE_PRESET    256
979 #define R_JPEG2K_CINE_48FPS             512
980
981
982 /* bake_mode: same as RE_BAKE_xxx defines */
983 /* bake_flag: */
984 #define R_BAKE_CLEAR            1
985 #define R_BAKE_OSA                      2
986 #define R_BAKE_TO_ACTIVE        4
987 #define R_BAKE_NORMALIZE        8
988
989 /* bake_normal_space */
990 #define R_BAKE_SPACE_CAMERA      0
991 #define R_BAKE_SPACE_WORLD       1
992 #define R_BAKE_SPACE_OBJECT      2
993 #define R_BAKE_SPACE_TANGENT 3
994
995 /* simplify_flag */
996 #define R_SIMPLE_NO_TRIANGULATE         1
997
998 /* sequencer seq_prev_type seq_rend_type */
999
1000
1001 /* **************** SCENE ********************* */
1002
1003 /* for general use */
1004 #define MAXFRAME        300000
1005 #define MAXFRAMEF       300000.0f
1006
1007 #define MINFRAME        0
1008 #define MINFRAMEF       0.0f
1009
1010 /* (minimum frame number for current-frame) */
1011 #define MINAFRAME       -300000
1012 #define MINAFRAMEF      -300000.0f
1013
1014 /* depricate this! */
1015 #define TESTBASE(v3d, base)     ( ((base)->flag & SELECT) && ((base)->lay & v3d->lay) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0) )
1016 #define TESTBASELIB(v3d, base)  ( ((base)->flag & SELECT) && ((base)->lay & v3d->lay) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
1017 #define TESTBASELIB_BGMODE(v3d, scene, base)   ( ((base)->flag & SELECT) && ((base)->lay & (v3d ? v3d->lay : scene->lay)) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
1018 #define BASE_EDITABLE_BGMODE(v3d, scene, base)   (((base)->lay & (v3d ? v3d->lay : scene->lay)) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
1019 #define BASE_SELECTABLE(v3d, base)       ((base->lay & v3d->lay) && (base->object->restrictflag & (OB_RESTRICT_SELECT|OB_RESTRICT_VIEW))==0)
1020 #define FIRSTBASE               scene->base.first
1021 #define LASTBASE                scene->base.last
1022 #define BASACT                  (scene->basact)
1023 #define OBACT                   (BASACT? BASACT->object: 0)
1024
1025 #define ID_NEW(a)               if( (a) && (a)->id.newid ) (a)= (void *)(a)->id.newid
1026 #define ID_NEW_US(a)    if( (a)->id.newid) {(a)= (void *)(a)->id.newid; (a)->id.us++;}
1027 #define ID_NEW_US2(a)   if( ((ID *)a)->newid) {(a)= ((ID *)a)->newid; ((ID *)a)->us++;}
1028 #define CFRA                    (scene->r.cfra)
1029 #define F_CFRA                  ((float)(scene->r.cfra))
1030 #define SFRA                    (scene->r.sfra)
1031 #define EFRA                    (scene->r.efra)
1032 #define PRVRANGEON              (scene->r.flag & SCER_PRV_RANGE)
1033 #define PSFRA                   ((PRVRANGEON)? (scene->r.psfra): (scene->r.sfra))
1034 #define PEFRA                   ((PRVRANGEON)? (scene->r.pefra): (scene->r.efra))
1035 #define FRA2TIME(a)           ((((double) scene->r.frs_sec_base) * (a)) / scene->r.frs_sec)
1036 #define TIME2FRA(a)           ((((double) scene->r.frs_sec) * (a)) / scene->r.frs_sec_base)
1037 #define FPS                     (((double) scene->r.frs_sec) / scene->r.frs_sec_base)
1038
1039 #define RAD_PHASE_PATCHES       1
1040 #define RAD_PHASE_FACES         2
1041
1042 /* base->flag is in DNA_object_types.h */
1043
1044 /* toolsettings->snap_flag */
1045 #define SCE_SNAP                                1
1046 #define SCE_SNAP_ROTATE                 2
1047 #define SCE_SNAP_PEEL_OBJECT    4
1048 #define SCE_SNAP_PROJECT                8
1049 /* toolsettings->snap_target */
1050 #define SCE_SNAP_TARGET_CLOSEST 0
1051 #define SCE_SNAP_TARGET_CENTER  1
1052 #define SCE_SNAP_TARGET_MEDIAN  2
1053 #define SCE_SNAP_TARGET_ACTIVE  3
1054 /* toolsettings->snap_mode */
1055 #define SCE_SNAP_MODE_INCREMENT 0
1056 #define SCE_SNAP_MODE_VERTEX    1
1057 #define SCE_SNAP_MODE_EDGE              2
1058 #define SCE_SNAP_MODE_FACE              3
1059 #define SCE_SNAP_MODE_VOLUME    4
1060
1061 /* toolsettings->selectmode */
1062 #define SCE_SELECT_VERTEX       1 /* for mesh */
1063 #define SCE_SELECT_EDGE         2
1064 #define SCE_SELECT_FACE         4
1065
1066 /* toolsettings->particle.selectmode for particles */
1067 #define SCE_SELECT_PATH         1
1068 #define SCE_SELECT_POINT        2
1069 #define SCE_SELECT_END          4
1070
1071 /* sce->recalc (now in use by previewrender) */
1072 #define SCE_PRV_CHANGED         1
1073
1074 /* toolsettings->prop_mode (proportional falloff) */
1075 #define PROP_SMOOTH            0
1076 #define PROP_SPHERE            1
1077 #define PROP_ROOT              2
1078 #define PROP_SHARP             3
1079 #define PROP_LIN               4
1080 #define PROP_CONST             5
1081 #define PROP_RANDOM             6
1082
1083 /* toolsettings->proportional */
1084 #define PROP_EDIT_OFF                   0
1085 #define PROP_EDIT_ON                    1
1086 #define PROP_EDIT_CONNECTED     2
1087
1088 /* sce->flag */
1089 #define SCE_DS_SELECTED                 (1<<0)
1090 #define SCE_DS_COLLAPSED                (1<<1)
1091 #define SCE_NLA_EDIT_ON                 (1<<2)
1092 #define SCE_FRAME_DROP                  (1<<3)
1093
1094
1095         /* return flag next_object function */
1096 #define F_ERROR                 -1
1097 #define F_START                 0
1098 #define F_SCENE                 1
1099 #define F_SET                   2
1100 #define F_DUPLI                 3
1101
1102 /* audio->flag */
1103 #define AUDIO_MUTE              1
1104 #define AUDIO_SYNC              2
1105 #define AUDIO_SCRUB             4
1106
1107 #define FFMPEG_MULTIPLEX_AUDIO  1 /* deprecated, you can choose none as audiocodec now */
1108 #define FFMPEG_AUTOSPLIT_OUTPUT 2
1109
1110 /* Paint.flags */
1111 typedef enum {
1112         PAINT_SHOW_BRUSH = 1,
1113         PAINT_FAST_NAVIGATE = 2
1114 } PaintFlags;
1115
1116 /* Sculpt.flags */
1117 /* These can eventually be moved to paint flags? */
1118 typedef enum SculptFlags {
1119         SCULPT_SYMM_X = 1,
1120         SCULPT_SYMM_Y = 2,
1121         SCULPT_SYMM_Z = 4,
1122         SCULPT_LOCK_X = 64,
1123         SCULPT_LOCK_Y = 128,
1124         SCULPT_LOCK_Z = 256
1125 } SculptFlags;
1126
1127 /* ImagePaintSettings.flag */
1128 #define IMAGEPAINT_DRAWING                              1
1129 #define IMAGEPAINT_DRAW_TOOL                    2
1130 #define IMAGEPAINT_DRAW_TOOL_DRAWING    4
1131 /* projection painting only */
1132 #define IMAGEPAINT_PROJECT_DISABLE              8       /* Non projection 3D painting */
1133 #define IMAGEPAINT_PROJECT_XRAY                 16
1134 #define IMAGEPAINT_PROJECT_BACKFACE             32
1135 #define IMAGEPAINT_PROJECT_FLAT                 64
1136 #define IMAGEPAINT_PROJECT_LAYER_CLONE  128
1137 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        256
1138 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    512
1139
1140 /* toolsettings->uvcalc_flag */
1141 #define UVCALC_FILLHOLES                        1
1142 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
1143 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
1144
1145 /* toolsettings->uv_flag */
1146 #define UV_SYNC_SELECTION       1
1147 #define UV_SHOW_SAME_IMAGE      2
1148
1149 /* toolsettings->uv_selectmode */
1150 #define UV_SELECT_VERTEX        1
1151 #define UV_SELECT_EDGE          2
1152 #define UV_SELECT_FACE          4
1153 #define UV_SELECT_ISLAND        8
1154
1155 /* toolsettings->edge_mode */
1156 #define EDGE_MODE_SELECT                                0
1157 #define EDGE_MODE_TAG_SEAM                              1
1158 #define EDGE_MODE_TAG_SHARP                             2
1159 #define EDGE_MODE_TAG_CREASE                    3
1160 #define EDGE_MODE_TAG_BEVEL                             4
1161
1162 /* toolsettings->particle flag */
1163 #define PE_KEEP_LENGTHS                 1
1164 #define PE_LOCK_FIRST                   2
1165 #define PE_DEFLECT_EMITTER              4
1166 #define PE_INTERPOLATE_ADDED    8
1167 #define PE_DRAW_PART                    16
1168 #define PE_X_MIRROR                             64              /* deprecated */
1169 #define PE_FADE_TIME                    128
1170 #define PE_AUTO_VELOCITY                256
1171
1172 /* toolsetting->particle brushtype */
1173 #define PE_BRUSH_NONE           -1
1174 #define PE_BRUSH_COMB           0
1175 #define PE_BRUSH_CUT            1
1176 #define PE_BRUSH_LENGTH         2
1177 #define PE_BRUSH_PUFF           3
1178 #define PE_BRUSH_ADD            4
1179 #define PE_BRUSH_SMOOTH         5
1180 #define PE_BRUSH_WEIGHT         6
1181
1182 /* this must equal ParticleEditSettings.brush array size */
1183 #define PE_TOT_BRUSH            6
1184
1185 /* ParticleBrushData->flag */
1186 #define PE_BRUSH_DATA_PUFF_VOLUME 1
1187
1188 /* tooksettings->particle edittype */
1189 #define PE_TYPE_PARTICLES       0
1190 #define PE_TYPE_SOFTBODY        1
1191 #define PE_TYPE_CLOTH           2
1192
1193 /* toolsettings->retopo_mode */
1194 #define RETOPO 1
1195 #define RETOPO_PAINT 2
1196
1197 /* toolsettings->retopo_paint_tool */
1198 #define RETOPO_PEN 1
1199 #define RETOPO_LINE 2
1200 #define RETOPO_ELLIPSE 4
1201
1202 /* toolsettings->skgen_options */
1203 #define SKGEN_FILTER_INTERNAL   (1 << 0)
1204 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
1205 #define SKGEN_SYMMETRY                  (1 << 2)
1206 #define SKGEN_CUT_LENGTH                (1 << 3)
1207 #define SKGEN_CUT_ANGLE                 (1 << 4)
1208 #define SKGEN_CUT_CORRELATION   (1 << 5)
1209 #define SKGEN_HARMONIC                  (1 << 6)
1210 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
1211 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
1212 #define SKGEN_FILTER_SMART              (1 << 9)
1213 #define SKGEN_DISP_LENGTH               (1 << 10)
1214 #define SKGEN_DISP_WEIGHT               (1 << 11)
1215 #define SKGEN_DISP_ORIG                 (1 << 12)
1216 #define SKGEN_DISP_EMBED                (1 << 13)
1217 #define SKGEN_DISP_INDEX                (1 << 14)
1218
1219 #define SKGEN_SUB_LENGTH                0
1220 #define SKGEN_SUB_ANGLE                 1
1221 #define SKGEN_SUB_CORRELATION   2
1222 #define SKGEN_SUB_TOTAL                 3
1223
1224 /* toolsettings->skgen_postpro */
1225 #define SKGEN_SMOOTH                    0
1226 #define SKGEN_AVERAGE                   1
1227 #define SKGEN_SHARPEN                   2
1228
1229 /* toolsettings->bone_sketching */
1230 #define BONE_SKETCHING                  1
1231 #define BONE_SKETCHING_QUICK    2
1232 #define BONE_SKETCHING_ADJUST   4
1233
1234 /* toolsettings->bone_sketching_convert */
1235 #define SK_CONVERT_CUT_FIXED                    0
1236 #define SK_CONVERT_CUT_LENGTH                   1
1237 #define SK_CONVERT_CUT_ADAPTATIVE               2
1238 #define SK_CONVERT_RETARGET                             3
1239
1240 /* toolsettings->skgen_retarget_options */
1241 #define SK_RETARGET_AUTONAME                    1
1242
1243 /* toolsettings->skgen_retarget_roll */
1244 #define SK_RETARGET_ROLL_NONE                   0
1245 #define SK_RETARGET_ROLL_VIEW                   1
1246 #define SK_RETARGET_ROLL_JOINT                  2
1247
1248 /* physics_settings->flag */
1249 #define PHYS_GLOBAL_GRAVITY             1
1250
1251 /* UnitSettings */
1252
1253 /* UnitSettings->system */
1254 #define USER_UNIT_NONE                  0
1255 #define USER_UNIT_METRIC                1
1256 #define USER_UNIT_IMPERIAL              2
1257 /* UnitSettings->flag */
1258 #define USER_UNIT_OPT_SPLIT             1
1259 #define USER_UNIT_ROT_RADIANS   2
1260
1261
1262 #ifdef __cplusplus
1263 }
1264 #endif
1265
1266 #endif