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