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