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