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