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