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