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