synched with trunk at revision 30597
[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 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 14)
520
521 /* GameData.matmode */
522 #define GAME_MAT_TEXFACE        0
523 #define GAME_MAT_MULTITEX       1
524 #define GAME_MAT_GLSL           2
525
526 typedef struct TimeMarker {
527         struct TimeMarker *next, *prev;
528         int frame;
529         char name[64];
530         unsigned int flag;
531         struct Object *camera;
532 } TimeMarker;
533
534 typedef struct Paint {
535         /* Array of brushes selected for use in this paint mode */
536         Brush **brushes;
537         int active_brush_index, brush_count;
538         
539         /* WM Paint cursor */
540         void *paint_cursor;
541         unsigned char paint_cursor_col[4];
542
543         int flags;
544 } Paint;
545
546 typedef struct ImagePaintSettings {
547         Paint paint;
548
549         short flag, pad;
550         
551         /* for projection painting only */
552         short seam_bleed, normal_angle;
553         short screen_grab_size[2]; /* capture size for re-projection */
554
555         int pad1;
556
557         void *paintcursor;                      /* wm handle */
558 } ImagePaintSettings;
559
560 typedef struct ParticleBrushData {
561         short size;                                             /* common setting */
562         short step, invert, count;              /* for specific brushes only */
563         int flag;
564         float strength;
565 } ParticleBrushData;
566
567 typedef struct ParticleEditSettings {
568         short flag;
569         short totrekey;
570         short totaddkey;
571         short brushtype;
572
573         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
574         void *paintcursor;                      /* runtime */
575
576         float emitterdist, rt;
577
578         int selectmode;
579         int edittype;
580
581         int draw_step, fade_frames;
582
583         struct Scene *scene;
584         struct Object *object;
585 } ParticleEditSettings;
586
587 typedef struct TransformOrientation {
588         struct TransformOrientation *next, *prev;
589         char name[36];
590         float mat[3][3];
591 } TransformOrientation;
592
593 typedef struct Sculpt {
594         Paint paint;
595
596         /* For rotating around a pivot point */
597         //float pivot[3]; XXX not used?
598         int flags;
599
600         /* Control tablet input */
601         //char tablet_size, tablet_strength; XXX not used?
602         int radial_symm[3];
603
604         // all this below is used to communicate with the cursor drawing routine
605
606         /* record movement of mouse so that rake can start at an intuitive angle */
607         float last_x, last_y;
608         float last_angle;
609
610         int draw_anchored;
611         int   anchored_size;
612         float anchored_location[3];
613         float anchored_initial_mouse[2];
614
615         int draw_pressure;
616         float pressure_value;
617
618         float special_rotation;
619
620         int pad;
621 } Sculpt;
622
623 typedef struct VPaint {
624         Paint paint;
625
626         short flag, pad;
627         int tot;                                                        /* allocation size of prev buffers */
628         unsigned int *vpaint_prev;                      /* previous mesh colors */
629         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
630         
631         void *paintcursor;                                      /* wm handle */
632 } VPaint;
633
634 /* VPaint flag */
635 #define VP_COLINDEX     1
636 #define VP_AREA         2
637
638 #define VP_NORMALS      8
639 #define VP_SPRAY        16
640 // #define VP_MIRROR_X  32 // depricated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X)
641 #define VP_ONLYVGROUP   128
642
643
644 typedef struct ToolSettings {
645         VPaint *vpaint;         /* vertex paint */
646         VPaint *wpaint;         /* weight paint */
647         Sculpt *sculpt;
648         
649         /* Vertex groups */
650         float vgroup_weight;
651
652         /* Subdivide Settings */
653         short cornertype;
654         short editbutflag;
655         /*Triangle to Quad conversion threshold*/
656         float jointrilimit;
657         /* Editmode Tools */
658         float degr; 
659         short step;
660         short turn; 
661         
662         float extr_offs;        /* extrude offset */
663         float doublimit;        /* remove doubles limit */
664         float normalsize;       /* size of normals */
665         short automerge;
666
667         /* Selection Mode for Mesh */
668         short selectmode;
669
670         /* Primitive Settings */
671         /* UV Sphere */
672         short segments;
673         short rings;
674         
675         /* Cylinder - Tube - Circle */
676         short vertices;
677
678         /* UV Calculation */
679         short unwrapper;
680         float uvcalc_radius;
681         float uvcalc_cubesize;
682         float uvcalc_margin;
683         short uvcalc_mapdir;
684         short uvcalc_mapalign;
685         short uvcalc_flag;
686         short uv_flag, uv_selectmode;
687         short uv_pad[2];
688
689         /* Auto-IK */
690         short autoik_chainlen;
691
692         /* Image Paint (8 byttse aligned please!) */
693         struct ImagePaintSettings imapaint;
694
695         /* Particle Editing */
696         struct ParticleEditSettings particle;
697         
698         /* Transform Proportional Area of Effect */
699         float proportional_size;
700
701         /* Select Group Threshold */
702         float select_thresh;
703         
704         /* Graph Editor */
705         float clean_thresh;
706
707         /* Auto-Keying Mode */
708         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
709         
710         /* Retopo */
711         char retopo_mode;
712         char retopo_paint_tool;
713         char line_div, ellipse_div, retopo_hotspot;
714
715         /* Multires */
716         char multires_subdiv_type;
717         
718         /* Skeleton generation */
719         short skgen_resolution;
720         float skgen_threshold_internal;
721         float skgen_threshold_external;
722         float skgen_length_ratio;
723         float skgen_length_limit;
724         float skgen_angle_limit;
725         float skgen_correlation_limit;
726         float skgen_symmetry_limit;
727         float skgen_retarget_angle_weight;
728         float skgen_retarget_length_weight;
729         float skgen_retarget_distance_weight;
730         short skgen_options;
731         char  skgen_postpro;
732         char  skgen_postpro_passes;
733         char  skgen_subdivisions[3];
734         char  skgen_multi_level;
735         
736         /* Skeleton Sketching */
737         struct Object *skgen_template;
738         char bone_sketching;
739         char bone_sketching_convert;
740         char skgen_subdivision_number;
741         char skgen_retarget_options;
742         char skgen_retarget_roll;
743         char skgen_side_string[8];
744         char skgen_num_string[8];
745         
746         /* Alt+RMB option */
747         char edge_mode;
748
749         /* Transform */
750         short snap_mode, snap_flag, snap_target;
751         short proportional, prop_mode;
752
753         int auto_normalize, intpad; /*auto normalizing mode in wpaint*/
754 } ToolSettings;
755
756 typedef struct bStats {
757         /* scene totals for visible layers */
758         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
759         int totvert, totface;
760 } bStats;
761
762 typedef struct UnitSettings {
763         /* Display/Editing unit options for each scene */
764         float scale_length; /* maybe have other unit conversions? */
765         short system;
766         short flag; /* imperial, metric etc */
767 } UnitSettings;
768
769 typedef struct PhysicsSettings {
770         float gravity[3];
771         int flag, quick_cache_step, rt;
772 } PhysicsSettings;
773
774 typedef struct Scene {
775         ID id;
776         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
777         
778         struct Object *camera;
779         struct World *world;
780         
781         struct Scene *set;
782         struct Image *ima;
783         
784         ListBase base;
785         struct Base *basact;            /* active base */
786         struct Object *obedit;          /* name replaces old G.obedit */
787         
788         float cursor[3];                        /* 3d cursor location */
789         float twcent[3];                        /* center for transform widget */
790         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
791         
792         unsigned int lay;                       /* bitflags for layer visibility */
793         int layact;             /* active layer */
794         int pad1;
795         
796         short flag;                                                             /* various settings */
797         
798         short use_nodes;
799         
800         struct bNodeTree *nodetree;     
801         
802         struct Editing *ed;                                                             /* sequence editor data is allocated here */
803         
804         struct ToolSettings *toolsettings;              /* default allocated now */
805         struct SceneStats *stats;                               /* default allocated now */
806
807         /* migrate or replace? depends on some internal things... */
808         /* no, is on the right place (ton) */
809         struct RenderData r;
810         struct AudioData audio;
811         
812         ListBase markers;
813         ListBase transform_spaces;
814         
815         void *sound_scene;
816         void *sound_scene_handle;
817         
818         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
819         
820         /* none of the dependancy graph  vars is mean to be saved */
821         struct  DagForest *theDag;
822         short dagisvalid, dagflags;
823         short recalc;                           /* recalc = counterpart of ob->recalc */
824
825         short jumpframe;
826         int pad5;
827
828         /* User-Defined KeyingSets */
829         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
830         ListBase keyingsets;                    /* KeyingSets for the given frame */
831         
832         /* Game Settings */
833         struct GameFraming framing; // XXX  deprecated since 2.5
834         struct GameData gm;
835
836         /* Units */
837         struct UnitSettings unit;
838         
839         /* Grease Pencil */
840         struct bGPdata *gpd;
841
842         /* Physics simulation settings */
843         struct PhysicsSettings physics_settings;
844 } Scene;
845
846
847 /* **************** RENDERDATA ********************* */
848
849 /* bufflag */
850 #define R_BACKBUF               1
851 #define R_BACKBUFANIM   2
852 #define R_FRONTBUF              4
853 #define R_FRONTBUFANIM  8
854
855 /* flag */
856         /* use preview range */
857 #define SCER_PRV_RANGE  (1<<0)
858
859 /* mode (int now) */
860 #define R_OSA                   0x0001
861 #define R_SHADOW                0x0002
862 #define R_GAMMA                 0x0004
863 #define R_ORTHO                 0x0008
864 #define R_ENVMAP                0x0010
865 #define R_EDGE                  0x0020
866 #define R_FIELDS                0x0040
867 #define R_FIELDSTILL    0x0080
868 #define R_RADIO                 0x0100
869 #define R_BORDER                0x0200
870 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
871 #define R_CROP                  0x0800
872 #define R_COSMO                 0x1000
873 #define R_ODDFIELD              0x2000
874 #define R_MBLUR                 0x4000
875                 /* unified was here */
876 #define R_RAYTRACE      0x10000
877                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
878 #define R_GAUSS         0x20000
879                 /* fbuf obsolete... */
880 #define R_FBUF                  0x40000
881                 /* threads obsolete... is there for old files, now use for autodetect threads */
882 #define R_THREADS               0x80000
883                 /* Use the same flag for autothreads */
884 #define R_FIXED_THREADS         0x80000 
885
886 #define R_SPEED                 0x100000
887 #define R_SSS                   0x200000
888 #define R_NO_OVERWRITE  0x400000 /* skip existing files */
889 #define R_TOUCH                 0x800000 /* touch files before rendering */
890 #define R_SIMPLIFY              0x1000000
891
892 /* seq_flag */
893 #define R_SEQ_GL_PREV 1
894 #define R_SEQ_GL_REND 2
895
896 /* displaymode */
897
898 #define R_OUTPUT_SCREEN 0
899 #define R_OUTPUT_AREA   1
900 #define R_OUTPUT_WINDOW 2
901 #define R_OUTPUT_FORKED 3
902
903 /* filtertype */
904 #define R_FILTER_BOX    0
905 #define R_FILTER_TENT   1
906 #define R_FILTER_QUAD   2
907 #define R_FILTER_CUBIC  3
908 #define R_FILTER_CATROM 4
909 #define R_FILTER_GAUSS  5
910 #define R_FILTER_MITCH  6
911 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
912
913 /* yafray: renderer flag (not only exclusive to yafray) */
914 #define R_INTERN        0
915 #define R_YAFRAY        1
916
917 /* raytrace structure */
918 #define R_RAYSTRUCTURE_AUTO                             0
919 #define R_RAYSTRUCTURE_OCTREE                   1
920 #define R_RAYSTRUCTURE_BLIBVH                   2
921 #define R_RAYSTRUCTURE_VBVH                             3
922 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
923 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
924
925 /* raytrace_options */
926 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
927 #define R_RAYTRACE_USE_INSTANCES                0x0002
928
929 /* scemode (int now) */
930 #define R_DOSEQ                         0x0001
931 #define R_BG_RENDER                     0x0002
932                 /* passepartout is camera option now, keep this for backward compatibility */
933 #define R_PASSEPARTOUT          0x0004
934 #define R_PREVIEWBUTS           0x0008
935 #define R_EXTENSION                     0x0010
936 #define R_MATNODE_PREVIEW       0x0020
937 #define R_DOCOMP                        0x0040
938 #define R_COMP_CROP                     0x0080
939 #define R_FREE_IMAGE            0x0100
940 #define R_SINGLE_LAYER          0x0200
941 #define R_EXR_TILE_FILE         0x0400
942 #define R_COMP_FREE                     0x0800
943 #define R_NO_IMAGE_LOAD         0x1000
944 #define R_NO_TEX                        0x2000
945 #define R_STAMP_INFO            0x4000  /* deprecated */
946 #define R_FULL_SAMPLE           0x8000
947 #define R_DEPRECATED            0x10000
948 #define R_RECURS_PROTECTION     0x20000
949 #define R_TEXNODE_PREVIEW       0x40000
950
951 /* r->stamp */
952 #define R_STAMP_TIME    0x0001
953 #define R_STAMP_FRAME   0x0002
954 #define R_STAMP_DATE    0x0004
955 #define R_STAMP_CAMERA  0x0008
956 #define R_STAMP_SCENE   0x0010
957 #define R_STAMP_NOTE    0x0020
958 #define R_STAMP_DRAW    0x0040 /* draw in the image */
959 #define R_STAMP_MARKER  0x0080
960 #define R_STAMP_FILENAME        0x0100
961 #define R_STAMP_SEQSTRIP        0x0200
962 #define R_STAMP_RENDERTIME      0x0400
963 #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)
964
965 /* alphamode */
966 #define R_ADDSKY                0
967 #define R_ALPHAPREMUL   1
968 #define R_ALPHAKEY              2
969
970 /* planes */
971 #define R_PLANES24              24
972 #define R_PLANES32              32
973 #define R_PLANESBW              8
974
975 /* color_mgt_flag */
976 #define R_COLOR_MANAGEMENT      1
977
978 /* imtype */
979 #define R_TARGA         0
980 #define R_IRIS          1
981 #define R_HAMX          2
982 #define R_FTYPE         3 /* ftype is nomore */
983 #define R_JPEG90        4
984 #define R_MOVIE         5
985 #define R_IRIZ          7
986 #define R_RAWTGA        14
987 #define R_AVIRAW        15
988 #define R_AVIJPEG       16
989 #define R_PNG           17
990 #define R_AVICODEC      18
991 #define R_QUICKTIME 19
992 #define R_BMP           20
993 #define R_RADHDR        21
994 #define R_TIFF          22
995 #define R_OPENEXR       23
996 #define R_FFMPEG        24
997 #define R_FRAMESERVER   25
998 #define R_CINEON                26
999 #define R_DPX                   27
1000 #define R_MULTILAYER    28
1001 #define R_DDS                   29
1002 #define R_JP2                   30
1003 #define R_H264          31
1004 #define R_XVID          32
1005 #define R_THEORA        33
1006
1007 /* subimtype, flag options for imtype */
1008 #define R_OPENEXR_HALF  1
1009 #define R_OPENEXR_ZBUF  2
1010 #define R_PREVIEW_JPG   4
1011 #define R_CINEON_LOG    8
1012 #define R_TIFF_16BIT    16
1013
1014 #define R_JPEG2K_12BIT  32 /* Jpeg2000 */
1015 #define R_JPEG2K_16BIT  64
1016 #define R_JPEG2K_YCC    128 /* when disabled use RGB */
1017 #define R_JPEG2K_CINE_PRESET    256
1018 #define R_JPEG2K_CINE_48FPS             512
1019
1020
1021 /* bake_mode: same as RE_BAKE_xxx defines */
1022 /* bake_flag: */
1023 #define R_BAKE_CLEAR            1
1024 #define R_BAKE_OSA                      2
1025 #define R_BAKE_TO_ACTIVE        4
1026 #define R_BAKE_NORMALIZE        8
1027
1028 /* bake_normal_space */
1029 #define R_BAKE_SPACE_CAMERA      0
1030 #define R_BAKE_SPACE_WORLD       1
1031 #define R_BAKE_SPACE_OBJECT      2
1032 #define R_BAKE_SPACE_TANGENT 3
1033
1034 /* simplify_flag */
1035 #define R_SIMPLE_NO_TRIANGULATE         1
1036
1037 /* sequencer seq_prev_type seq_rend_type */
1038
1039
1040 /* **************** SCENE ********************* */
1041
1042 /* for general use */
1043 #define MAXFRAME        300000
1044 #define MAXFRAMEF       300000.0f
1045
1046 #define MINFRAME        0
1047 #define MINFRAMEF       0.0f
1048
1049 /* (minimum frame number for current-frame) */
1050 #define MINAFRAME       -300000
1051 #define MINAFRAMEF      -300000.0f
1052
1053 /* depricate this! */
1054 #define TESTBASE(v3d, base)     ( ((base)->flag & SELECT) && ((base)->lay & v3d->lay) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0) )
1055 #define TESTBASELIB(v3d, base)  ( ((base)->flag & SELECT) && ((base)->lay & v3d->lay) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
1056 #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))
1057 #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))
1058 #define BASE_SELECTABLE(v3d, base)       ((base->lay & v3d->lay) && (base->object->restrictflag & (OB_RESTRICT_SELECT|OB_RESTRICT_VIEW))==0)
1059 #define FIRSTBASE               scene->base.first
1060 #define LASTBASE                scene->base.last
1061 #define BASACT                  (scene->basact)
1062 #define OBACT                   (BASACT? BASACT->object: 0)
1063
1064 #define ID_NEW(a)               if( (a) && (a)->id.newid ) (a)= (void *)(a)->id.newid
1065 #define ID_NEW_US(a)    if( (a)->id.newid) {(a)= (void *)(a)->id.newid; (a)->id.us++;}
1066 #define ID_NEW_US2(a)   if( ((ID *)a)->newid) {(a)= ((ID *)a)->newid; ((ID *)a)->us++;}
1067 #define CFRA                    (scene->r.cfra)
1068 #define SUBFRA                  (scene->r.subframe)
1069 #define F_CFRA                  ((float)(scene->r.cfra))
1070 #define SFRA                    (scene->r.sfra)
1071 #define EFRA                    (scene->r.efra)
1072 #define PRVRANGEON              (scene->r.flag & SCER_PRV_RANGE)
1073 #define PSFRA                   ((PRVRANGEON)? (scene->r.psfra): (scene->r.sfra))
1074 #define PEFRA                   ((PRVRANGEON)? (scene->r.pefra): (scene->r.efra))
1075 #define FRA2TIME(a)           ((((double) scene->r.frs_sec_base) * (a)) / scene->r.frs_sec)
1076 #define TIME2FRA(a)           ((((double) scene->r.frs_sec) * (a)) / scene->r.frs_sec_base)
1077 #define FPS                     (((double) scene->r.frs_sec) / scene->r.frs_sec_base)
1078
1079 #define RAD_PHASE_PATCHES       1
1080 #define RAD_PHASE_FACES         2
1081
1082 /* base->flag is in DNA_object_types.h */
1083
1084 /* toolsettings->snap_flag */
1085 #define SCE_SNAP                                1
1086 #define SCE_SNAP_ROTATE                 2
1087 #define SCE_SNAP_PEEL_OBJECT    4
1088 #define SCE_SNAP_PROJECT                8
1089 /* toolsettings->snap_target */
1090 #define SCE_SNAP_TARGET_CLOSEST 0
1091 #define SCE_SNAP_TARGET_CENTER  1
1092 #define SCE_SNAP_TARGET_MEDIAN  2
1093 #define SCE_SNAP_TARGET_ACTIVE  3
1094 /* toolsettings->snap_mode */
1095 #define SCE_SNAP_MODE_INCREMENT 0
1096 #define SCE_SNAP_MODE_VERTEX    1
1097 #define SCE_SNAP_MODE_EDGE              2
1098 #define SCE_SNAP_MODE_FACE              3
1099 #define SCE_SNAP_MODE_VOLUME    4
1100
1101 /* toolsettings->selectmode */
1102 #define SCE_SELECT_VERTEX       1 /* for mesh */
1103 #define SCE_SELECT_EDGE         2
1104 #define SCE_SELECT_FACE         4
1105
1106 /* toolsettings->particle.selectmode for particles */
1107 #define SCE_SELECT_PATH         1
1108 #define SCE_SELECT_POINT        2
1109 #define SCE_SELECT_END          4
1110
1111 /* sce->recalc (now in use by previewrender) */
1112 #define SCE_PRV_CHANGED         1
1113
1114 /* toolsettings->prop_mode (proportional falloff) */
1115 #define PROP_SMOOTH            0
1116 #define PROP_SPHERE            1
1117 #define PROP_ROOT              2
1118 #define PROP_SHARP             3
1119 #define PROP_LIN               4
1120 #define PROP_CONST             5
1121 #define PROP_RANDOM             6
1122
1123 /* toolsettings->proportional */
1124 #define PROP_EDIT_OFF                   0
1125 #define PROP_EDIT_ON                    1
1126 #define PROP_EDIT_CONNECTED     2
1127
1128 /* sce->flag */
1129 #define SCE_DS_SELECTED                 (1<<0)
1130 #define SCE_DS_COLLAPSED                (1<<1)
1131 #define SCE_NLA_EDIT_ON                 (1<<2)
1132 #define SCE_FRAME_DROP                  (1<<3)
1133
1134
1135         /* return flag next_object function */
1136 #define F_ERROR                 -1
1137 #define F_START                 0
1138 #define F_SCENE                 1
1139 #define F_DUPLI                 3
1140
1141 /* audio->flag */
1142 #define AUDIO_MUTE              1
1143 #define AUDIO_SYNC              2
1144 #define AUDIO_SCRUB             4
1145
1146 #define FFMPEG_MULTIPLEX_AUDIO  1 /* deprecated, you can choose none as audiocodec now */
1147 #define FFMPEG_AUTOSPLIT_OUTPUT 2
1148
1149 /* Paint.flags */
1150 typedef enum {
1151         PAINT_SHOW_BRUSH = (1<<0),
1152         PAINT_FAST_NAVIGATE = (1<<1),
1153         PAINT_SHOW_BRUSH_ON_SURFACE = (1<<2),
1154 } PaintFlags;
1155
1156 /* Sculpt.flags */
1157 /* These can eventually be moved to paint flags? */
1158 typedef enum SculptFlags {
1159         SCULPT_SYMM_X = (1<<0),
1160         SCULPT_SYMM_Y = (1<<1),
1161         SCULPT_SYMM_Z = (1<<2),
1162         SCULPT_LOCK_X = (1<<3),
1163         SCULPT_LOCK_Y = (1<<4),
1164         SCULPT_LOCK_Z = (1<<5),
1165         SCULPT_SYMMETRY_FEATHER = (1<<6),
1166         SCULPT_USE_OPENMP = (1<<7),
1167 } SculptFlags;
1168
1169 /* ImagePaintSettings.flag */
1170 #define IMAGEPAINT_DRAWING                              1
1171 #define IMAGEPAINT_DRAW_TOOL                    2
1172 #define IMAGEPAINT_DRAW_TOOL_DRAWING    4
1173 /* projection painting only */
1174 #define IMAGEPAINT_PROJECT_DISABLE              8       /* Non projection 3D painting */
1175 #define IMAGEPAINT_PROJECT_XRAY                 16
1176 #define IMAGEPAINT_PROJECT_BACKFACE             32
1177 #define IMAGEPAINT_PROJECT_FLAT                 64
1178 #define IMAGEPAINT_PROJECT_LAYER_CLONE  128
1179 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        256
1180 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    512
1181
1182 /* toolsettings->uvcalc_flag */
1183 #define UVCALC_FILLHOLES                        1
1184 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
1185 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
1186
1187 /* toolsettings->uv_flag */
1188 #define UV_SYNC_SELECTION       1
1189 #define UV_SHOW_SAME_IMAGE      2
1190
1191 /* toolsettings->uv_selectmode */
1192 #define UV_SELECT_VERTEX        1
1193 #define UV_SELECT_EDGE          2
1194 #define UV_SELECT_FACE          4
1195 #define UV_SELECT_ISLAND        8
1196
1197 /* toolsettings->edge_mode */
1198 #define EDGE_MODE_SELECT                                0
1199 #define EDGE_MODE_TAG_SEAM                              1
1200 #define EDGE_MODE_TAG_SHARP                             2
1201 #define EDGE_MODE_TAG_CREASE                    3
1202 #define EDGE_MODE_TAG_BEVEL                             4
1203
1204 /* toolsettings->particle flag */
1205 #define PE_KEEP_LENGTHS                 1
1206 #define PE_LOCK_FIRST                   2
1207 #define PE_DEFLECT_EMITTER              4
1208 #define PE_INTERPOLATE_ADDED    8
1209 #define PE_DRAW_PART                    16
1210 #define PE_X_MIRROR                             64              /* deprecated */
1211 #define PE_FADE_TIME                    128
1212 #define PE_AUTO_VELOCITY                256
1213
1214 /* toolsetting->particle brushtype */
1215 #define PE_BRUSH_NONE           -1
1216 #define PE_BRUSH_COMB           0
1217 #define PE_BRUSH_CUT            1
1218 #define PE_BRUSH_LENGTH         2
1219 #define PE_BRUSH_PUFF           3
1220 #define PE_BRUSH_ADD            4
1221 #define PE_BRUSH_SMOOTH         5
1222 #define PE_BRUSH_WEIGHT         6
1223
1224 /* this must equal ParticleEditSettings.brush array size */
1225 #define PE_TOT_BRUSH            6
1226
1227 /* ParticleBrushData->flag */
1228 #define PE_BRUSH_DATA_PUFF_VOLUME 1
1229
1230 /* tooksettings->particle edittype */
1231 #define PE_TYPE_PARTICLES       0
1232 #define PE_TYPE_SOFTBODY        1
1233 #define PE_TYPE_CLOTH           2
1234
1235 /* toolsettings->retopo_mode */
1236 #define RETOPO 1
1237 #define RETOPO_PAINT 2
1238
1239 /* toolsettings->retopo_paint_tool */
1240 #define RETOPO_PEN 1
1241 #define RETOPO_LINE 2
1242 #define RETOPO_ELLIPSE 4
1243
1244 /* toolsettings->skgen_options */
1245 #define SKGEN_FILTER_INTERNAL   (1 << 0)
1246 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
1247 #define SKGEN_SYMMETRY                  (1 << 2)
1248 #define SKGEN_CUT_LENGTH                (1 << 3)
1249 #define SKGEN_CUT_ANGLE                 (1 << 4)
1250 #define SKGEN_CUT_CORRELATION   (1 << 5)
1251 #define SKGEN_HARMONIC                  (1 << 6)
1252 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
1253 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
1254 #define SKGEN_FILTER_SMART              (1 << 9)
1255 #define SKGEN_DISP_LENGTH               (1 << 10)
1256 #define SKGEN_DISP_WEIGHT               (1 << 11)
1257 #define SKGEN_DISP_ORIG                 (1 << 12)
1258 #define SKGEN_DISP_EMBED                (1 << 13)
1259 #define SKGEN_DISP_INDEX                (1 << 14)
1260
1261 #define SKGEN_SUB_LENGTH                0
1262 #define SKGEN_SUB_ANGLE                 1
1263 #define SKGEN_SUB_CORRELATION   2
1264 #define SKGEN_SUB_TOTAL                 3
1265
1266 /* toolsettings->skgen_postpro */
1267 #define SKGEN_SMOOTH                    0
1268 #define SKGEN_AVERAGE                   1
1269 #define SKGEN_SHARPEN                   2
1270
1271 /* toolsettings->bone_sketching */
1272 #define BONE_SKETCHING                  1
1273 #define BONE_SKETCHING_QUICK    2
1274 #define BONE_SKETCHING_ADJUST   4
1275
1276 /* toolsettings->bone_sketching_convert */
1277 #define SK_CONVERT_CUT_FIXED                    0
1278 #define SK_CONVERT_CUT_LENGTH                   1
1279 #define SK_CONVERT_CUT_ADAPTATIVE               2
1280 #define SK_CONVERT_RETARGET                             3
1281
1282 /* toolsettings->skgen_retarget_options */
1283 #define SK_RETARGET_AUTONAME                    1
1284
1285 /* toolsettings->skgen_retarget_roll */
1286 #define SK_RETARGET_ROLL_NONE                   0
1287 #define SK_RETARGET_ROLL_VIEW                   1
1288 #define SK_RETARGET_ROLL_JOINT                  2
1289
1290 /* physics_settings->flag */
1291 #define PHYS_GLOBAL_GRAVITY             1
1292
1293 /* UnitSettings */
1294
1295 /* UnitSettings->system */
1296 #define USER_UNIT_NONE                  0
1297 #define USER_UNIT_METRIC                1
1298 #define USER_UNIT_IMPERIAL              2
1299 /* UnitSettings->flag */
1300 #define USER_UNIT_OPT_SPLIT             1
1301 #define USER_UNIT_ROT_RADIANS   2
1302
1303
1304 #ifdef __cplusplus
1305 }
1306 #endif
1307
1308 #endif