source/blender/makesdna/DNA_scene_types.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  19  * All rights reserved.
  20  *
  21  * The Original Code is: all of this file.
  22  *
  23  * Contributor(s): none yet.
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 /** \file DNA_scene_types.h
  29  *  \ingroup DNA
  30  */
  31
  32 #ifndef DNA_SCENE_TYPES_H
  33 #define DNA_SCENE_TYPES_H
  34
  35 #include "DNA_defs.h"
  36
  37 // XXX, temp feature - campbell
  38 #define DURIAN_CAMERA_SWITCH
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #include "DNA_vec_types.h"
  45 #include "DNA_listBase.h"
  46 #include "DNA_ID.h"
  47
  48 struct Object;
  49 struct Brush;
  50 struct World;
  51 struct Scene;
  52 struct Image;
  53 struct Group;
  54 struct Text;
  55 struct bNodeTree;
  56 struct AnimData;
  57 struct Editing;
  58 struct SceneStats;
  59 struct bGPdata;
  60 struct MovieClip;
  61
  62 /* ************************************************************* */
  63 /* Scene Data */
  64
  65 /* Base - Wrapper for referencing Objects in a Scene */
  66 typedef struct Base {
  67         struct Base *next, *prev;
  68         unsigned int lay, selcol;
  69         int flag;
  70         short sx, sy;
  71         struct Object *object;
  72 } Base;
  73
  74 /* ************************************************************* */
  75 /* Output Format Data */
  76
  77 typedef struct AviCodecData {
  78         void                    *lpFormat;  /* save format */
  79         void                    *lpParms;   /* compressor options */
  80         unsigned int    cbFormat;           /* size of lpFormat buffer */
  81         unsigned int    cbParms;            /* size of lpParms buffer */
  82
  83         unsigned int    fccType;            /* stream type, for consistency */
  84         unsigned int    fccHandler;         /* compressor */
  85         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
  86         unsigned int    dwQuality;          /* compress quality 0-10,000 */
  87         unsigned int    dwBytesPerSecond;   /* bytes per second */
  88         unsigned int    dwFlags;            /* flags... see below */
  89         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
  90         unsigned int    pad;
  91
  92         char                    avicodecname[128];
  93 } AviCodecData;
  94
  95 typedef struct QuicktimeCodecData {
  96         /*Old quicktime implementation compatibility fields, read only in 2.5 - deprecated*/
  97         void                    *cdParms;   /* codec/compressor options */
  98         void                    *pad;       /* padding */
  99
 100         unsigned int    cdSize;             /* size of cdParms buffer */
 101         unsigned int    pad2;               /* padding */
 102
 103         char                    qtcodecname[128];
 104 } QuicktimeCodecData;
 105
 106 typedef struct QuicktimeCodecSettings {
 107         /* Codec settings detailed for 2.5 implementation*/
 108         int codecType; /* Types defined in quicktime_export.h */
 109         int     codecSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 110
 111         /* Settings not available in current QTKit API */
 112         int     codec;
 113         int     codecFlags;
 114         int     colorDepth;
 115         int     codecTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 116         int     minSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 117         int     minTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 118         int     keyFrameRate;
 119         int     bitRate;        /* bitrate in bps */
 120
 121         /* Audio Codec settings */
 122         int audiocodecType;
 123         int audioSampleRate;
 124         short audioBitDepth;
 125         short audioChannels;
 126         int audioCodecFlags;
 127         int audioBitRate;
 128         int pad1;
 129 } QuicktimeCodecSettings;
 130
 131 typedef struct FFMpegCodecData {
 132         int type;
 133         int codec;
 134         int audio_codec;
 135         int video_bitrate;
 136         int audio_bitrate;
 137         int audio_mixrate;
 138         int audio_channels;
 139         int audio_pad;
 140         float audio_volume;
 141         int gop_size;
 142         int flags;
 143
 144         int rc_min_rate;
 145         int rc_max_rate;
 146         int rc_buffer_size;
 147         int mux_packet_size;
 148         int mux_rate;
 149         IDProperty *properties;
 150 } FFMpegCodecData;
 151
 152 /* ************************************************************* */
 153 /* Audio */
 154
 155 typedef struct AudioData {
 156         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
 157         float main; // 2.5: now in FFMpegCodecData: audio_volume
 158         float speed_of_sound;
 159         float doppler_factor;
 160         int distance_model;
 161         short flag;
 162         short pad;
 163         float volume;
 164         float pad2;
 165 } AudioData;
 166
 167 /* *************************************************************** */
 168 /* Render Layers */
 169
 170 /* Render Layer */
 171 typedef struct SceneRenderLayer {
 172         struct SceneRenderLayer *next, *prev;
 173
 174         char name[64];  /* MAX_NAME */
 175
 176         struct Material *mat_override;
 177         struct Group *light_override;
 178
 179         unsigned int lay;               /* scene->lay itself has priority over this */
 180         unsigned int lay_zmask; /* has to be after lay, this is for Z-masking */
 181         int layflag;
 182
 183         int pad;
 184
 185         int passflag;                   /* pass_xor has to be after passflag */
 186         int pass_xor;
 187 } SceneRenderLayer;
 188
 189 /* srl->layflag */
 190 #define SCE_LAY_SOLID   1
 191 #define SCE_LAY_ZTRA    2
 192 #define SCE_LAY_HALO    4
 193 #define SCE_LAY_EDGE    8
 194 #define SCE_LAY_SKY             16
 195 #define SCE_LAY_STRAND  32
 196         /* flags between 32 and 0x8000 are set to 1 already, for future options */
 197
 198 #define SCE_LAY_ALL_Z           0x8000
 199 #define SCE_LAY_XOR                     0x10000
 200 #define SCE_LAY_DISABLE         0x20000
 201 #define SCE_LAY_ZMASK           0x40000
 202 #define SCE_LAY_NEG_ZMASK       0x80000
 203
 204 /* srl->passflag */
 205 #define SCE_PASS_COMBINED               (1<<0)
 206 #define SCE_PASS_Z                              (1<<1)
 207 #define SCE_PASS_RGBA                   (1<<2)
 208 #define SCE_PASS_DIFFUSE                (1<<3)
 209 #define SCE_PASS_SPEC                   (1<<4)
 210 #define SCE_PASS_SHADOW                 (1<<5)
 211 #define SCE_PASS_AO                             (1<<6)
 212 #define SCE_PASS_REFLECT                (1<<7)
 213 #define SCE_PASS_NORMAL                 (1<<8)
 214 #define SCE_PASS_VECTOR                 (1<<9)
 215 #define SCE_PASS_REFRACT                (1<<10)
 216 #define SCE_PASS_INDEXOB                (1<<11)
 217 #define SCE_PASS_UV                             (1<<12)
 218 #define SCE_PASS_INDIRECT               (1<<13)
 219 #define SCE_PASS_MIST                   (1<<14)
 220 #define SCE_PASS_RAYHITS                (1<<15)
 221 #define SCE_PASS_EMIT                   (1<<16)
 222 #define SCE_PASS_ENVIRONMENT    (1<<17)
 223 #define SCE_PASS_INDEXMA        (1<<18)
 224
 225 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
 226
 227 /* *************************************************************** */
 228
 229 /* Generic image format settings,
 230  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
 231  *
 232  * note: its a bit strange that even though this is an image format struct
 233  *  the imtype can still be used to select video formats.
 234  *  RNA ensures these enum's are only selectable for render output.
 235  */
 236 typedef struct ImageFormatData {
 237         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
 238                        /* note, video types should only ever be set from this
 239                         * structure when used from RenderData */
 240         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
 241                         * not a flag, only set 1 at a time */
 242
 243         char planes  ; /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
 244         char flag;     /* generic options for all image types, alpha zbuffer */
 245
 246         char quality;  /* (0 - 100), eg: jpeg quality */
 247         char compress; /* (0 - 100), eg: png compression */
 248
 249
 250         /* --- format specific --- */
 251
 252         /* OpenEXR */
 253         char  exr_codec;
 254
 255         /* Cineon */
 256         char  cineon_flag;
 257         short cineon_white, cineon_black;
 258         float cineon_gamma;
 259
 260         /* Jpeg2000 */
 261         char  jp2_flag;
 262
 263         char pad[7];
 264
 265 } ImageFormatData;
 266
 267
 268 /* ImageFormatData.imtype */
 269 #define R_IMF_IMTYPE_TARGA           0
 270 #define R_IMF_IMTYPE_IRIS            1
 271 /* #define R_HAMX                    2 */ /* hamx is nomore */
 272 /* #define R_FTYPE                   3 */ /* ftype is nomore */
 273 #define R_IMF_IMTYPE_JPEG90          4
 274 /* #define R_MOVIE                   5 */ /* movie is nomore */
 275 #define R_IMF_IMTYPE_IRIZ            7
 276 #define R_IMF_IMTYPE_RAWTGA         14
 277 #define R_IMF_IMTYPE_AVIRAW         15
 278 #define R_IMF_IMTYPE_AVIJPEG        16
 279 #define R_IMF_IMTYPE_PNG            17
 280 #define R_IMF_IMTYPE_AVICODEC       18
 281 #define R_IMF_IMTYPE_QUICKTIME      19
 282 #define R_IMF_IMTYPE_BMP            20
 283 #define R_IMF_IMTYPE_RADHDR         21
 284 #define R_IMF_IMTYPE_TIFF           22
 285 #define R_IMF_IMTYPE_OPENEXR        23
 286 #define R_IMF_IMTYPE_FFMPEG         24
 287 #define R_IMF_IMTYPE_FRAMESERVER    25
 288 #define R_IMF_IMTYPE_CINEON         26
 289 #define R_IMF_IMTYPE_DPX            27
 290 #define R_IMF_IMTYPE_MULTILAYER     28
 291 #define R_IMF_IMTYPE_DDS            29
 292 #define R_IMF_IMTYPE_JP2            30
 293 #define R_IMF_IMTYPE_H264           31
 294 #define R_IMF_IMTYPE_XVID           32
 295 #define R_IMF_IMTYPE_THEORA         33
 296
 297 #define R_IMF_IMTYPE_INVALID        255
 298
 299 /* ImageFormatData.flag */
 300 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
 301 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
 302
 303 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
 304 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
 305 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
 306 #define R_IMF_CHAN_DEPTH_12 (1<<2) /* 12bits (uncommon, jp2 supports) */
 307 #define R_IMF_CHAN_DEPTH_16 (1<<3) /* 16bits (tiff, halff float exr) */
 308 #define R_IMF_CHAN_DEPTH_24 (1<<4) /* 24bits (unused) */
 309 #define R_IMF_CHAN_DEPTH_32 (1<<5) /* 32bits (full float exr) */
 310
 311 /* ImageFormatData.planes */
 312 #define R_IMF_PLANES_RGB   24
 313 #define R_IMF_PLANES_RGBA  32
 314 #define R_IMF_PLANES_BW    8
 315
 316 /* ImageFormatData.exr_codec */
 317 #define R_IMF_EXR_CODEC_NONE  0
 318 #define R_IMF_EXR_CODEC_PXR24 1
 319 #define R_IMF_EXR_CODEC_ZIP   2
 320 #define R_IMF_EXR_CODEC_PIZ   3
 321 #define R_IMF_EXR_CODEC_RLE   4
 322
 323 /* ImageFormatData.jp2_flag */
 324 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
 325 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
 326 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
 327
 328 /* ImageFormatData.cineon_flag */
 329 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
 330
 331 /* *************************************************************** */
 332 /* Render Data */
 333
 334 typedef struct RenderData {
 335         struct ImageFormatData im_format;
 336
 337         struct AviCodecData *avicodecdata;
 338         struct QuicktimeCodecData *qtcodecdata;
 339         struct QuicktimeCodecSettings qtcodecsettings;
 340         struct FFMpegCodecData ffcodecdata;
 341
 342         int cfra, sfra, efra;   /* frames as in 'images' */
 343         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
 344         int psfra, pefra;               /* start+end frames of preview range */
 345
 346         int images, framapto;
 347         short flag, threads;
 348
 349         float framelen, blurfac;
 350
 351         /** For UR edge rendering: give the edges this color */
 352         float edgeR, edgeG, edgeB;
 353
 354
 355         /* standalone player */  //  XXX deprecated since 2.5
 356         short fullscreen  DNA_DEPRECATED, xplay  DNA_DEPRECATED, yplay  DNA_DEPRECATED;
 357         short freqplay  DNA_DEPRECATED;
 358         /* standalone player */  //  XXX deprecated since 2.5
 359         short depth  DNA_DEPRECATED, attrib  DNA_DEPRECATED;
 360
 361
 362         int frame_step;         /* frames to jump during render/playback */
 363
 364         short stereomode  DNA_DEPRECATED;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
 365
 366         short dimensionspreset;         /* for the dimensions presets menu */
 367
 368         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
 369
 370         short size, maximsize;  /* size in %, max in Kb */
 371         /* from buttons: */
 372         /**
 373          * The desired number of pixels in the x direction
 374          */
 375         short xsch;
 376         /**
 377          * The desired number of pixels in the y direction
 378          */
 379         short ysch;
 380         /**
 381          * The number of part to use in the x direction
 382          */
 383         short xparts;
 384         /**
 385          * The number of part to use in the y direction
 386          */
 387         short yparts;
 388
 389         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
 390
 391         /**
 392          * Render to image editor, fullscreen or to new window.
 393          */
 394         short displaymode;
 395
 396         /**
 397          * Flags for render settings. Use bit-masking to access the settings.
 398          */
 399         int scemode;
 400
 401         /**
 402          * Flags for render settings. Use bit-masking to access the settings.
 403          */
 404         int mode;
 405
 406         /**
 407          * Flags for raytrace settings. Use bit-masking to access the settings.
 408          */
 409         int raytrace_options;
 410
 411         /**
 412          * Raytrace acceleration structure
 413          */
 414         short raytrace_structure;
 415
 416         short pad1;
 417
 418         /* octree resolution */
 419         short ocres;
 420         short pad4;
 421
 422         /**
 423          * What to do with the sky/background. Picks sky/premul/key
 424          * blending for the background
 425          */
 426         short alphamode;
 427
 428         /**
 429          * The number of samples to use per pixel.
 430          */
 431         short osa;
 432
 433         short frs_sec, edgeint;
 434
 435
 436         /* safety, border and display rect */
 437         rctf safety, border;
 438         rcti disprect;
 439
 440         /* information on different layers to be rendered */
 441         ListBase layers;
 442         short actlay;
 443
 444         /* number of mblur samples */
 445         short mblur_samples;
 446
 447         /**
 448          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
 449          */
 450         float xasp, yasp;
 451
 452         float frs_sec_base;
 453
 454         /**
 455          * Value used to define filter size for all filter options  */
 456         float gauss;
 457
 458
 459         /* color management settings - color profiles, gamma correction, etc */
 460         int color_mgt_flag;
 461
 462         /** post-production settings. deprecated, but here for upwards compat (initialized to 1) */
 463         float postgamma, posthue, postsat;
 464
 465          /* Dither noise intensity */
 466         float dither_intensity;
 467
 468         /* Bake Render options */
 469         short bake_osa, bake_filter, bake_mode, bake_flag;
 470         short bake_normal_space, bake_quad_split;
 471         float bake_maxdist, bake_biasdist, bake_pad;
 472
 473         /* path to render output */
 474         char pic[240];
 475
 476         /* stamps flags. */
 477         int stamp;
 478         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
 479
 480         /* stamp info user data. */
 481         char stamp_udata[160];
 482
 483         /* foreground/background color. */
 484         float fg_stamp[4];
 485         float bg_stamp[4];
 486
 487         /* sequencer options */
 488         char seq_prev_type;
 489         char seq_rend_type;
 490         char seq_flag; /* flag use for sequence render/draw */
 491         char pad5[5];
 492
 493         /* render simplify */
 494         int simplify_flag;
 495         short simplify_subsurf;
 496         short simplify_shadowsamples;
 497         float simplify_particles;
 498         float simplify_aosss;
 499
 500         /* cineon */
 501         short cineonwhite  DNA_DEPRECATED, cineonblack  DNA_DEPRECATED;  /*deprecated*/
 502         float cineongamma  DNA_DEPRECATED;  /*deprecated*/
 503
 504         /* jpeg2000 */
 505         short jp2_preset  DNA_DEPRECATED, jp2_depth  DNA_DEPRECATED;  /*deprecated*/
 506         int rpad3;
 507
 508         /* Dome variables */ //  XXX deprecated since 2.5
 509         short domeres  DNA_DEPRECATED, domemode  DNA_DEPRECATED;        //  XXX deprecated since 2.5
 510         short domeangle  DNA_DEPRECATED, dometilt  DNA_DEPRECATED;      //  XXX deprecated since 2.5
 511         float domeresbuf  DNA_DEPRECATED;       //  XXX deprecated since 2.5
 512         float pad2;
 513         struct Text *dometext  DNA_DEPRECATED;  //  XXX deprecated since 2.5
 514
 515         /* render engine */
 516         char engine[32];
 517 } RenderData;
 518
 519 /* *************************************************************** */
 520 /* Render Conversion/Simplfication Settings */
 521
 522 /* control render convert and shading engine */
 523 typedef struct RenderProfile {
 524         struct RenderProfile *next, *prev;
 525         char name[32];
 526
 527         short particle_perc;
 528         short subsurf_max;
 529         short shadbufsample_max;
 530         short pad1;
 531
 532         float ao_error, pad2;
 533
 534 } RenderProfile;
 535
 536 /* *************************************************************** */
 537 /* Game Engine - Dome */
 538
 539 typedef struct GameDome {
 540         short res, mode;
 541         short angle, tilt;
 542         float resbuf, pad2;
 543         struct Text *warptext;
 544 } GameDome;
 545
 546 #define DOME_FISHEYE                    1
 547 #define DOME_TRUNCATED_FRONT    2
 548 #define DOME_TRUNCATED_REAR             3
 549 #define DOME_ENVMAP                             4
 550 #define DOME_PANORAM_SPH                5
 551 #define DOME_NUM_MODES                  6
 552
 553 /* *************************************************************** */
 554 /* Game Engine */
 555
 556 typedef struct GameFraming {
 557         float col[3];
 558         char type, pad1, pad2, pad3;
 559 } GameFraming;
 560
 561 #define SCE_GAMEFRAMING_BARS   0
 562 #define SCE_GAMEFRAMING_EXTEND 1
 563 #define SCE_GAMEFRAMING_SCALE  2
 564
 565 typedef struct RecastData {
 566         float cellsize;
 567         float cellheight;
 568         float agentmaxslope;
 569         float agentmaxclimb;
 570         float agentheight;
 571         float agentradius;
 572         float edgemaxlen;
 573         float edgemaxerror;
 574         float regionminsize;
 575         float regionmergesize;
 576         int vertsperpoly;
 577         float detailsampledist;
 578         float detailsamplemaxerror;
 579         short pad1, pad2;
 580 } RecastData;
 581
 582 typedef struct GameData {
 583
 584         /*  standalone player */
 585         struct GameFraming framing;
 586         short playerflag, xplay, yplay, freqplay;
 587         short depth, attrib, rt1, rt2;
 588         short aasamples, pad4[3];
 589
 590         /* stereo/dome mode */
 591         struct GameDome dome;
 592         short stereoflag, stereomode;
 593         float eyeseparation;
 594         RecastData recastData;
 595
 596
 597         /* physics (it was in world)*/
 598         float gravity; /*Gravitation constant for the game world*/
 599
 600         /*
 601          * Radius of the activity bubble, in Manhattan length. Objects
 602          * outside the box are activity-culled. */
 603         float activityBoxRadius;
 604
 605         /*
 606          * bit 3: (gameengine): Activity culling is enabled.
 607          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustrum culling
 608         */
 609         int flag;
 610         short mode, matmode;
 611         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
 612         short physicsEngine;
 613         short exitkey, pad;
 614         short ticrate, maxlogicstep, physubstep, maxphystep;
 615         short obstacleSimulation, pad1;
 616         float levelHeight;
 617 } GameData;
 618
 619 #define STEREO_NOSTEREO         1
 620 #define STEREO_ENABLED          2
 621 #define STEREO_DOME                     3
 622
 623 //#define STEREO_NOSTEREO                1
 624 #define STEREO_QUADBUFFERED 2
 625 #define STEREO_ABOVEBELOW        3
 626 #define STEREO_INTERLACED        4
 627 #define STEREO_ANAGLYPH         5
 628 #define STEREO_SIDEBYSIDE       6
 629 #define STEREO_VINTERLACE       7
 630 //#define STEREO_DOME           8
 631
 632 /* physicsEngine */
 633 #define WOPHY_NONE              0
 634 #define WOPHY_ENJI              1
 635 #define WOPHY_SUMO              2
 636 #define WOPHY_DYNAMO    3
 637 #define WOPHY_ODE               4
 638 #define WOPHY_BULLET    5
 639
 640 /* obstacleSimulation */
 641 #define OBSTSIMULATION_NONE             0
 642 #define OBSTSIMULATION_TOI_rays         1
 643 #define OBSTSIMULATION_TOI_cells        2
 644
 645 /* GameData.flag */
 646 #define GAME_RESTRICT_ANIM_UPDATES                      (1 << 0)
 647 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
 648 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
 649 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
 650 #define GAME_SHOW_PHYSICS                                       (1 << 4)
 651 #define GAME_DISPLAY_LISTS                                      (1 << 5)
 652 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
 653 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
 654 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
 655 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
 656 #define GAME_GLSL_NO_NODES                                      (1 << 10)
 657 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
 658 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
 659 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
 660 #define GAME_SHOW_MOUSE                                         (1 << 14)
 661 #define GAME_GLSL_NO_COLOR_MANAGEMENT           (1 << 15)
 662 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 16)
 663 /* Note: GameData.flag is now an int (max 32 flags). A short could only take 16 flags */
 664
 665 /* GameData.playerflag */
 666 #define GAME_PLAYER_FULLSCREEN                          (1 << 0)
 667 #define GAME_PLAYER_DESKTOP_RESOLUTION          (1 << 1)
 668
 669 /* GameData.matmode */
 670 #define GAME_MAT_TEXFACE        0
 671 #define GAME_MAT_MULTITEX       1
 672 #define GAME_MAT_GLSL           2
 673
 674 /* *************************************************************** */
 675 /* Markers */
 676
 677 typedef struct TimeMarker {
 678         struct TimeMarker *next, *prev;
 679         int frame;
 680         char name[64];
 681         unsigned int flag;
 682         struct Object *camera;
 683 } TimeMarker;
 684
 685 /* *************************************************************** */
 686 /* Paint Mode/Tool Data */
 687
 688 /* Paint Tool Base */
 689 typedef struct Paint {
 690         struct Brush *brush;
 691
 692         /* WM Paint cursor */
 693         void *paint_cursor;
 694         unsigned char paint_cursor_col[4];
 695
 696         int flags;
 697 } Paint;
 698
 699 /* ------------------------------------------- */
 700 /* Image Paint */
 701
 702 /* Texture/Image Editor */
 703 typedef struct ImagePaintSettings {
 704         Paint paint;
 705
 706         short flag, pad;
 707
 708         /* for projection painting only */
 709         short seam_bleed, normal_angle;
 710         short screen_grab_size[2]; /* capture size for re-projection */
 711
 712         int pad1;
 713
 714         void *paintcursor;                      /* wm handle */
 715 } ImagePaintSettings;
 716
 717 /* ------------------------------------------- */
 718 /* Particle Edit */
 719
 720 /* Settings for a Particle Editing Brush */
 721 typedef struct ParticleBrushData {
 722         short size;                                             /* common setting */
 723         short step, invert, count;              /* for specific brushes only */
 724         int flag;
 725         float strength;
 726 } ParticleBrushData;
 727
 728 /* Particle Edit Mode Settings */
 729 typedef struct ParticleEditSettings {
 730         short flag;
 731         short totrekey;
 732         short totaddkey;
 733         short brushtype;
 734
 735         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
 736         void *paintcursor;                      /* runtime */
 737
 738         float emitterdist, rt;
 739
 740         int selectmode;
 741         int edittype;
 742
 743         int draw_step, fade_frames;
 744
 745         struct Scene *scene;
 746         struct Object *object;
 747 } ParticleEditSettings;
 748
 749 /* ------------------------------------------- */
 750 /* Sculpt */
 751
 752 /* Sculpt */
 753 typedef struct Sculpt {
 754         Paint paint;
 755
 756         /* For rotating around a pivot point */
 757         //float pivot[3]; XXX not used?
 758         int flags;
 759
 760         /* Control tablet input */
 761         //char tablet_size, tablet_strength; XXX not used?
 762         int radial_symm[3];
 763
 764         // all this below is used to communicate with the cursor drawing routine
 765
 766         /* record movement of mouse so that rake can start at an intuitive angle */
 767         float last_x, last_y;
 768         float last_angle;
 769
 770         int draw_anchored;
 771         int   anchored_size;
 772         float anchored_location[3];
 773         float anchored_initial_mouse[2];
 774
 775         int draw_pressure;
 776         float pressure_value;
 777
 778         float special_rotation;
 779
 780         int pad;
 781 } Sculpt;
 782
 783 /* ------------------------------------------- */
 784 /* Vertex Paint */
 785
 786 /* Vertex Paint */
 787 typedef struct VPaint {
 788         Paint paint;
 789
 790         short flag, pad;
 791         int tot;                                                        /* allocation size of prev buffers */
 792         unsigned int *vpaint_prev;                      /* previous mesh colors */
 793         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
 794
 795         void *paintcursor;                                      /* wm handle */
 796 } VPaint;
 797
 798 /* VPaint flag */
 799 #define VP_COLINDEX     1
 800 #define VP_AREA         2
 801
 802 #define VP_NORMALS      8
 803 #define VP_SPRAY        16
 804 // #define VP_MIRROR_X  32 // deprecated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X)
 805 #define VP_ONLYVGROUP   128
 806
 807 /* *************************************************************** */
 808 /* Transform Orientations */
 809
 810 typedef struct TransformOrientation {
 811         struct TransformOrientation *next, *prev;
 812         char name[64];  /* MAX_NAME */
 813         float mat[3][3];
 814         int pad;
 815 } TransformOrientation;
 816
 817 /* *************************************************************** */
 818 /* Unified Paint Settings */
 819
 820 /* These settings can override the equivalent fields in the active
 821    Brush for any paint mode; the flag field controls whether these
 822    values are used */
 823 typedef struct UnifiedPaintSettings {
 824         /* unified radius of brush in pixels */
 825         int size;
 826
 827         /* unified radius of brush in Blender units */
 828         float unprojected_radius;
 829
 830         /* unified strength of brush */
 831         float alpha;
 832
 833         /* user preferences for sculpt and paint */
 834         int flag;
 835 } UnifiedPaintSettings;
 836
 837 typedef enum {
 838         UNIFIED_PAINT_SIZE  = (1<<0),
 839         UNIFIED_PAINT_ALPHA = (1<<1),
 840
 841         /* only used if unified size is enabled, mirros the brush flags
 842            BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
 843         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1<<2),
 844         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1<<3),
 845
 846         /* only used if unified alpha is enabled, mirrors the brush flag
 847            BRUSH_ALPHA_PRESSURE */
 848         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1<<4)
 849 } UnifiedPaintSettingsFlags;
 850
 851 /* *************************************************************** */
 852 /* Tool Settings */
 853
 854 typedef struct ToolSettings {
 855         VPaint *vpaint;         /* vertex paint */
 856         VPaint *wpaint;         /* weight paint */
 857         Sculpt *sculpt;
 858
 859         /* Vertex groups */
 860         float vgroup_weight;
 861
 862         /* Subdivide Settings */
 863         short cornertype;
 864         short editbutflag;
 865         /*Triangle to Quad conversion threshold*/
 866         float jointrilimit;
 867         /* Editmode Tools */
 868         float degr;
 869         short step;
 870         short turn;
 871
 872         float extr_offs;        /* extrude offset */
 873         float doublimit;        /* remove doubles limit */
 874         float normalsize;       /* size of normals */
 875         short automerge;
 876
 877         /* Selection Mode for Mesh */
 878         short selectmode;
 879
 880         /* Primitive Settings */
 881         /* UV Sphere */
 882         short segments;
 883         short rings;
 884
 885         /* Cylinder - Tube - Circle */
 886         short vertices;
 887
 888         /* UV Calculation */
 889         short unwrapper;
 890         float uvcalc_radius;
 891         float uvcalc_cubesize;
 892         float uvcalc_margin;
 893         short uvcalc_mapdir;
 894         short uvcalc_mapalign;
 895         short uvcalc_flag;
 896         short uv_flag, uv_selectmode;
 897         short uv_pad;
 898
 899         /* Grease Pencil */
 900         short gpencil_flags;
 901
 902         /* Auto-IK */
 903         short autoik_chainlen;
 904
 905         /* Image Paint (8 byttse aligned please!) */
 906         struct ImagePaintSettings imapaint;
 907
 908         /* Particle Editing */
 909         struct ParticleEditSettings particle;
 910
 911         /* Transform Proportional Area of Effect */
 912         float proportional_size;
 913
 914         /* Select Group Threshold */
 915         float select_thresh;
 916
 917         /* Graph Editor */
 918         float clean_thresh;
 919
 920         /* Auto-Keying Mode */
 921         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
 922
 923         /* Retopo */
 924         char retopo_mode;
 925         char retopo_paint_tool;
 926         char line_div, ellipse_div, retopo_hotspot;
 927
 928         /* Multires */
 929         char multires_subdiv_type;
 930
 931         /* Skeleton generation */
 932         short skgen_resolution;
 933         float skgen_threshold_internal;
 934         float skgen_threshold_external;
 935         float skgen_length_ratio;
 936         float skgen_length_limit;
 937         float skgen_angle_limit;
 938         float skgen_correlation_limit;
 939         float skgen_symmetry_limit;
 940         float skgen_retarget_angle_weight;
 941         float skgen_retarget_length_weight;
 942         float skgen_retarget_distance_weight;
 943         short skgen_options;
 944         char  skgen_postpro;
 945         char  skgen_postpro_passes;
 946         char  skgen_subdivisions[3];
 947         char  skgen_multi_level;
 948
 949         /* Skeleton Sketching */
 950         struct Object *skgen_template;
 951         char bone_sketching;
 952         char bone_sketching_convert;
 953         char skgen_subdivision_number;
 954         char skgen_retarget_options;
 955         char skgen_retarget_roll;
 956         char skgen_side_string[8];
 957         char skgen_num_string[8];
 958
 959         /* Alt+RMB option */
 960         char edge_mode;
 961         char edge_mode_live_unwrap;
 962
 963         /* Transform */
 964         char snap_mode;
 965         short snap_flag, snap_target;
 966         short proportional, prop_mode;
 967         char proportional_objects; /* proportional edit, object mode */
 968         char pad[5];
 969
 970         char auto_normalize; /*auto normalizing mode in wpaint*/
 971         char multipaint; /* paint multiple bones in wpaint */
 972
 973         /* XXX: these sculpt_paint_* fields are deprecated, use the
 974            unified_paint_settings field instead! */
 975         short sculpt_paint_settings DNA_DEPRECATED;
 976         short pad1;
 977         int sculpt_paint_unified_size DNA_DEPRECATED;
 978         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
 979         float sculpt_paint_unified_alpha DNA_DEPRECATED;
 980
 981         /* Unified Paint Settings */
 982         struct UnifiedPaintSettings unified_paint_settings;
 983 } ToolSettings;
 984
 985 /* *************************************************************** */
 986 /* Assorted Scene Data */
 987
 988 /* ------------------------------------------- */
 989 /* Stats (show in Info header) */
 990
 991 typedef struct bStats {
 992         /* scene totals for visible layers */
 993         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
 994         int totvert, totface;
 995 } bStats;
 996
 997 /* ------------------------------------------- */
 998 /* Unit Settings */
 999
1000 typedef struct UnitSettings {
1001         /* Display/Editing unit options for each scene */
1002         float scale_length; /* maybe have other unit conversions? */
1003         char system; /* imperial, metric etc */
1004         char system_rotation; /* not implimented as a propper unit system yet */
1005         short flag;
1006 } UnitSettings;
1007
1008 /* ------------------------------------------- */
1009 /* Global/Common Physics Settings */
1010
1011 typedef struct PhysicsSettings {
1012         float gravity[3];
1013         int flag, quick_cache_step, rt;
1014 } PhysicsSettings;
1015
1016 /* *************************************************************** */
1017 /* Scene ID-Block */
1018
1019 typedef struct Scene {
1020         ID id;
1021         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
1022
1023         struct Object *camera;
1024         struct World *world;
1025
1026         struct Scene *set;
1027
1028         ListBase base;
1029         struct Base *basact;            /* active base */
1030         struct Object *obedit;          /* name replaces old G.obedit */
1031
1032         float cursor[3];                        /* 3d cursor location */
1033         float twcent[3];                        /* center for transform widget */
1034         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
1035
1036         unsigned int lay;                       /* bitflags for layer visibility */
1037         int layact;             /* active layer */
1038         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1039
1040         short flag;                                                             /* various settings */
1041
1042         short use_nodes;
1043
1044         struct bNodeTree *nodetree;
1045
1046         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1047
1048         struct ToolSettings *toolsettings;              /* default allocated now */
1049         struct SceneStats *stats;                               /* default allocated now */
1050
1051         /* migrate or replace? depends on some internal things... */
1052         /* no, is on the right place (ton) */
1053         struct RenderData r;
1054         struct AudioData audio;
1055
1056         ListBase markers;
1057         ListBase transform_spaces;
1058
1059         void *sound_scene;
1060         void *sound_scene_handle;
1061         void *sound_scrub_handle;
1062         void *speaker_handles;
1063
1064         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1065
1066         /* none of the dependancy graph  vars is mean to be saved */
1067         struct  DagForest *theDag;
1068         short dagisvalid, dagflags;
1069         short recalc;                           /* recalc = counterpart of ob->recalc */
1070
1071         short pad6;
1072         int pad5;
1073
1074         /* User-Defined KeyingSets */
1075         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1076         ListBase keyingsets;                    /* KeyingSets for this scene */
1077
1078         /* Game Settings */
1079         struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5
1080         struct GameData gm;
1081
1082         /* Units */
1083         struct UnitSettings unit;
1084
1085         /* Grease Pencil */
1086         struct bGPdata *gpd;
1087
1088         /* Physics simulation settings */
1089         struct PhysicsSettings physics_settings;
1090
1091         /* Movie Tracking */
1092         struct MovieClip *clip;                 /* active movie clip */
1093
1094         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by object_handle_update() */
1095         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1096 } Scene;
1097
1098
1099 /* **************** RENDERDATA ********************* */
1100
1101 /* flag */
1102         /* use preview range */
1103 #define SCER_PRV_RANGE  (1<<0)
1104
1105 /* mode (int now) */
1106 #define R_OSA                   0x0001
1107 #define R_SHADOW                0x0002
1108 #define R_GAMMA                 0x0004
1109 #define R_ORTHO                 0x0008
1110 #define R_ENVMAP                0x0010
1111 #define R_EDGE                  0x0020
1112 #define R_FIELDS                0x0040
1113 #define R_FIELDSTILL    0x0080
1114 #define R_RADIO                 0x0100
1115 #define R_BORDER                0x0200
1116 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
1117 #define R_CROP                  0x0800
1118 /*#define R_COSMO                       0x1000 deprecated */
1119 #define R_ODDFIELD              0x2000
1120 #define R_MBLUR                 0x4000
1121                 /* unified was here */
1122 #define R_RAYTRACE      0x10000
1123                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1124 #define R_GAUSS         0x20000
1125                 /* fbuf obsolete... */
1126 /*#define R_FBUF                        0x40000*/
1127                 /* threads obsolete... is there for old files, now use for autodetect threads */
1128 #define R_THREADS               0x80000
1129                 /* Use the same flag for autothreads */
1130 #define R_FIXED_THREADS         0x80000
1131
1132 #define R_SPEED                 0x100000
1133 #define R_SSS                   0x200000
1134 #define R_NO_OVERWRITE  0x400000 /* skip existing files */
1135 #define R_TOUCH                 0x800000 /* touch files before rendering */
1136 #define R_SIMPLIFY              0x1000000
1137
1138 /* seq_flag */
1139 #define R_SEQ_GL_PREV 1
1140 #define R_SEQ_GL_REND 2
1141
1142 /* displaymode */
1143
1144 #define R_OUTPUT_SCREEN 0
1145 #define R_OUTPUT_AREA   1
1146 #define R_OUTPUT_WINDOW 2
1147 #define R_OUTPUT_NONE   3
1148 /*#define R_OUTPUT_FORKED       4*/
1149
1150 /* filtertype */
1151 #define R_FILTER_BOX    0
1152 #define R_FILTER_TENT   1
1153 #define R_FILTER_QUAD   2
1154 #define R_FILTER_CUBIC  3
1155 #define R_FILTER_CATROM 4
1156 #define R_FILTER_GAUSS  5
1157 #define R_FILTER_MITCH  6
1158 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
1159
1160 /* raytrace structure */
1161 #define R_RAYSTRUCTURE_AUTO                             0
1162 #define R_RAYSTRUCTURE_OCTREE                   1
1163 #define R_RAYSTRUCTURE_BLIBVH                   2
1164 #define R_RAYSTRUCTURE_VBVH                             3
1165 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
1166 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
1167
1168 /* raytrace_options */
1169 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
1170 #define R_RAYTRACE_USE_INSTANCES                0x0002
1171
1172 /* scemode (int now) */
1173 #define R_DOSEQ                         0x0001
1174 #define R_BG_RENDER                     0x0002
1175                 /* passepartout is camera option now, keep this for backward compatibility */
1176 #define R_PASSEPARTOUT          0x0004
1177 #define R_PREVIEWBUTS           0x0008
1178 #define R_EXTENSION                     0x0010
1179 #define R_MATNODE_PREVIEW       0x0020
1180 #define R_DOCOMP                        0x0040
1181 #define R_COMP_CROP                     0x0080
1182 #define R_FREE_IMAGE            0x0100
1183 #define R_SINGLE_LAYER          0x0200
1184 #define R_EXR_TILE_FILE         0x0400
1185 #define R_COMP_FREE                     0x0800
1186 #define R_NO_IMAGE_LOAD         0x1000
1187 #define R_NO_TEX                        0x2000
1188 #define R_NO_FRAME_UPDATE       0x4000
1189 #define R_FULL_SAMPLE           0x8000
1190 /* #define R_DEPRECATED         0x10000 */
1191 /* #define R_RECURS_PROTECTION  0x20000 */
1192 #define R_TEXNODE_PREVIEW       0x40000
1193
1194 /* r->stamp */
1195 #define R_STAMP_TIME    0x0001
1196 #define R_STAMP_FRAME   0x0002
1197 #define R_STAMP_DATE    0x0004
1198 #define R_STAMP_CAMERA  0x0008
1199 #define R_STAMP_SCENE   0x0010
1200 #define R_STAMP_NOTE    0x0020
1201 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1202 #define R_STAMP_MARKER  0x0080
1203 #define R_STAMP_FILENAME        0x0100
1204 #define R_STAMP_SEQSTRIP        0x0200
1205 #define R_STAMP_RENDERTIME      0x0400
1206 #define R_STAMP_CAMERALENS      0x0800
1207 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1208                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1209                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS)
1210
1211 /* alphamode */
1212 #define R_ADDSKY                0
1213 #define R_ALPHAPREMUL   1
1214 #define R_ALPHAKEY              2
1215
1216 /* color_mgt_flag */
1217 #define R_COLOR_MANAGEMENT              (1 << 0)
1218 #define R_COLOR_MANAGEMENT_PREDIVIDE    (1 << 1)
1219
1220 /* subimtype, flag options for imtype */
1221 #define R_OPENEXR_HALF    1                                      /*deprecated*/
1222 #define R_OPENEXR_ZBUF    2                                      /*deprecated*/
1223 #define R_PREVIEW_JPG    4                                       /*deprecated*/
1224 #define R_CINEON_LOG     8                                       /*deprecated*/
1225 #define R_TIFF_16BIT    16                                       /*deprecated*/
1226
1227 #define R_JPEG2K_12BIT    32 /* Jpeg2000 */                      /*deprecated*/
1228 #define R_JPEG2K_16BIT    64                                     /*deprecated*/
1229 #define R_JPEG2K_YCC    128 /* when disabled use RGB */          /*deprecated*/
1230 #define R_JPEG2K_CINE_PRESET    256                              /*deprecated*/
1231 #define R_JPEG2K_CINE_48FPS        512                           /*deprecated*/
1232
1233 /* bake_mode: same as RE_BAKE_xxx defines */
1234 /* bake_flag: */
1235 #define R_BAKE_CLEAR            1
1236 #define R_BAKE_OSA                      2
1237 #define R_BAKE_TO_ACTIVE        4
1238 #define R_BAKE_NORMALIZE        8
1239 #define R_BAKE_MULTIRES         16
1240 #define R_BAKE_LORES_MESH       32
1241
1242 /* bake_normal_space */
1243 #define R_BAKE_SPACE_CAMERA      0
1244 #define R_BAKE_SPACE_WORLD       1
1245 #define R_BAKE_SPACE_OBJECT      2
1246 #define R_BAKE_SPACE_TANGENT 3
1247
1248 /* simplify_flag */
1249 #define R_SIMPLE_NO_TRIANGULATE         1
1250
1251 /* sequencer seq_prev_type seq_rend_type */
1252
1253
1254 /* **************** SCENE ********************* */
1255
1256 /* for general use */
1257 #define MAXFRAME        300000
1258 #define MAXFRAMEF       300000.0f
1259
1260 #define MINFRAME        0
1261 #define MINFRAMEF       0.0f
1262
1263 /* (minimum frame number for current-frame) */
1264 #define MINAFRAME       -300000
1265 #define MINAFRAMEF      -300000.0f
1266
1267 /* depricate this! */
1268 #define TESTBASE(v3d, base)  (                                                \
1269         ((base)->flag & SELECT) &&                                                \
1270         ((base)->lay & v3d->lay) &&                                               \
1271         (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0)  )
1272 #define TESTBASELIB(v3d, base)  (                                             \
1273         ((base)->flag & SELECT) &&                                                \
1274         ((base)->lay & v3d->lay) &&                                               \
1275         ((base)->object->id.lib==NULL) &&                                         \
1276         (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0)  )
1277 #define TESTBASELIB_BGMODE(v3d, scene, base)  (                               \
1278         ((base)->flag & SELECT) &&                                                \
1279         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1280         ((base)->object->id.lib==NULL) &&                                         \
1281         (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0)  )
1282 #define BASE_EDITABLE_BGMODE(v3d, scene, base)  (                             \
1283         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1284         ((base)->object->id.lib==NULL) &&                                         \
1285         (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
1286 #define BASE_SELECTABLE(v3d, base)  (                                         \
1287         (base->lay & v3d->lay) &&                                                 \
1288         (base->object->restrictflag & (OB_RESTRICT_SELECT|OB_RESTRICT_VIEW))==0  )
1289 #define BASE_VISIBLE(v3d, base)  (                                            \
1290         (base->lay & v3d->lay) &&                                                 \
1291         (base->object->restrictflag & OB_RESTRICT_VIEW)==0  )
1292
1293 #define FIRSTBASE               scene->base.first
1294 #define LASTBASE                scene->base.last
1295 #define BASACT                  (scene->basact)
1296 #define OBACT                   (BASACT? BASACT->object: NULL)
1297
1298 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1299 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1300
1301 #define ID_NEW(a)               if( (a) && (a)->id.newid ) (a)= (void *)(a)->id.newid
1302 #define ID_NEW_US(a)    if( (a)->id.newid) {(a)= (void *)(a)->id.newid; (a)->id.us++;}
1303 #define ID_NEW_US2(a)   if( ((ID *)a)->newid) {(a)= ((ID *)a)->newid; ((ID *)a)->us++;}
1304 #define CFRA                    (scene->r.cfra)
1305 #define SUBFRA                  (scene->r.subframe)
1306 #define SFRA                    (scene->r.sfra)
1307 #define EFRA                    (scene->r.efra)
1308 #define PRVRANGEON              (scene->r.flag & SCER_PRV_RANGE)
1309 #define PSFRA                   ((PRVRANGEON)? (scene->r.psfra): (scene->r.sfra))
1310 #define PEFRA                   ((PRVRANGEON)? (scene->r.pefra): (scene->r.efra))
1311 #define FRA2TIME(a)           ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1312 #define TIME2FRA(a)           ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1313 #define FPS                     (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1314
1315 #define RAD_PHASE_PATCHES       1
1316 #define RAD_PHASE_FACES         2
1317
1318 /* base->flag is in DNA_object_types.h */
1319
1320 /* toolsettings->snap_flag */
1321 #define SCE_SNAP                                1
1322 #define SCE_SNAP_ROTATE                 2
1323 #define SCE_SNAP_PEEL_OBJECT    4
1324 #define SCE_SNAP_PROJECT                8
1325 #define SCE_SNAP_NO_SELF                16
1326 /* toolsettings->snap_target */
1327 #define SCE_SNAP_TARGET_CLOSEST 0
1328 #define SCE_SNAP_TARGET_CENTER  1
1329 #define SCE_SNAP_TARGET_MEDIAN  2
1330 #define SCE_SNAP_TARGET_ACTIVE  3
1331 /* toolsettings->snap_mode */
1332 #define SCE_SNAP_MODE_INCREMENT 0
1333 #define SCE_SNAP_MODE_VERTEX    1
1334 #define SCE_SNAP_MODE_EDGE              2
1335 #define SCE_SNAP_MODE_FACE              3
1336 #define SCE_SNAP_MODE_VOLUME    4
1337
1338 /* toolsettings->selectmode */
1339 #define SCE_SELECT_VERTEX       1 /* for mesh */
1340 #define SCE_SELECT_EDGE         2
1341 #define SCE_SELECT_FACE         4
1342
1343 /* toolsettings->particle.selectmode for particles */
1344 #define SCE_SELECT_PATH         1
1345 #define SCE_SELECT_POINT        2
1346 #define SCE_SELECT_END          4
1347
1348 /* sce->recalc (now in use by previewrender) */
1349 #define SCE_PRV_CHANGED         1
1350
1351 /* toolsettings->prop_mode (proportional falloff) */
1352 #define PROP_SMOOTH            0
1353 #define PROP_SPHERE            1
1354 #define PROP_ROOT              2
1355 #define PROP_SHARP             3
1356 #define PROP_LIN               4
1357 #define PROP_CONST             5
1358 #define PROP_RANDOM            6
1359 #define PROP_MODE_MAX          7
1360
1361 /* toolsettings->proportional */
1362 #define PROP_EDIT_OFF                   0
1363 #define PROP_EDIT_ON                    1
1364 #define PROP_EDIT_CONNECTED     2
1365
1366 /* sce->flag */
1367 #define SCE_DS_SELECTED                 (1<<0)
1368 #define SCE_DS_COLLAPSED                (1<<1)
1369 #define SCE_NLA_EDIT_ON                 (1<<2)
1370 #define SCE_FRAME_DROP                  (1<<3)
1371
1372
1373         /* return flag next_object function */
1374 #define F_ERROR                 -1
1375 #define F_START                 0
1376 #define F_SCENE                 1
1377 #define F_DUPLI                 3
1378
1379 /* audio->flag */
1380 #define AUDIO_MUTE                (1<<0)
1381 #define AUDIO_SYNC                (1<<1)
1382 #define AUDIO_SCRUB                       (1<<2)
1383 #define AUDIO_VOLUME_ANIMATED     (1<<3)
1384
1385 #define FFMPEG_MULTIPLEX_AUDIO  1 /* deprecated, you can choose none as audiocodec now */
1386 #define FFMPEG_AUTOSPLIT_OUTPUT 2
1387
1388 /* Paint.flags */
1389 typedef enum {
1390         PAINT_SHOW_BRUSH = (1<<0),
1391         PAINT_FAST_NAVIGATE = (1<<1),
1392         PAINT_SHOW_BRUSH_ON_SURFACE = (1<<2),
1393 } PaintFlags;
1394
1395 /* Sculpt.flags */
1396 /* These can eventually be moved to paint flags? */
1397 typedef enum SculptFlags {
1398         SCULPT_SYMM_X = (1<<0),
1399         SCULPT_SYMM_Y = (1<<1),
1400         SCULPT_SYMM_Z = (1<<2),
1401         SCULPT_LOCK_X = (1<<3),
1402         SCULPT_LOCK_Y = (1<<4),
1403         SCULPT_LOCK_Z = (1<<5),
1404         SCULPT_SYMMETRY_FEATHER = (1<<6),
1405         SCULPT_USE_OPENMP = (1<<7),
1406         SCULPT_ONLY_DEFORM = (1<<8),
1407 } SculptFlags;
1408
1409 /* ImagePaintSettings.flag */
1410 #define IMAGEPAINT_DRAWING                              1
1411 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
1412 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
1413
1414 /* projection painting only */
1415 #define IMAGEPAINT_PROJECT_DISABLE              8       /* Non projection 3D painting */
1416 #define IMAGEPAINT_PROJECT_XRAY                 16
1417 #define IMAGEPAINT_PROJECT_BACKFACE             32
1418 #define IMAGEPAINT_PROJECT_FLAT                 64
1419 #define IMAGEPAINT_PROJECT_LAYER_CLONE  128
1420 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        256
1421 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    512
1422
1423 /* toolsettings->uvcalc_flag */
1424 #define UVCALC_FILLHOLES                        1
1425 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
1426 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
1427
1428 /* toolsettings->uv_flag */
1429 #define UV_SYNC_SELECTION       1
1430 #define UV_SHOW_SAME_IMAGE      2
1431
1432 /* toolsettings->uv_selectmode */
1433 #define UV_SELECT_VERTEX        1
1434 #define UV_SELECT_EDGE          2
1435 #define UV_SELECT_FACE          4
1436 #define UV_SELECT_ISLAND        8
1437
1438 /* toolsettings->edge_mode */
1439 #define EDGE_MODE_SELECT                                0
1440 #define EDGE_MODE_TAG_SEAM                              1
1441 #define EDGE_MODE_TAG_SHARP                             2
1442 #define EDGE_MODE_TAG_CREASE                    3
1443 #define EDGE_MODE_TAG_BEVEL                             4
1444
1445 /* toolsettings->gpencil_flags */
1446 #define GP_TOOL_FLAG_PAINTSESSIONS_ON   (1<<0)
1447
1448 /* toolsettings->particle flag */
1449 #define PE_KEEP_LENGTHS                 1
1450 #define PE_LOCK_FIRST                   2
1451 #define PE_DEFLECT_EMITTER              4
1452 #define PE_INTERPOLATE_ADDED    8
1453 #define PE_DRAW_PART                    16
1454 /* #define PE_X_MIRROR                  64 */   /* deprecated */
1455 #define PE_FADE_TIME                    128
1456 #define PE_AUTO_VELOCITY                256
1457
1458 /* toolsetting->particle brushtype */
1459 #define PE_BRUSH_NONE           -1
1460 #define PE_BRUSH_COMB           0
1461 #define PE_BRUSH_CUT            1
1462 #define PE_BRUSH_LENGTH         2
1463 #define PE_BRUSH_PUFF           3
1464 #define PE_BRUSH_ADD            4
1465 #define PE_BRUSH_SMOOTH         5
1466 #define PE_BRUSH_WEIGHT         6
1467
1468 /* this must equal ParticleEditSettings.brush array size */
1469 #define PE_TOT_BRUSH            6
1470
1471 /* ParticleBrushData->flag */
1472 #define PE_BRUSH_DATA_PUFF_VOLUME 1
1473
1474 /* tooksettings->particle edittype */
1475 #define PE_TYPE_PARTICLES       0
1476 #define PE_TYPE_SOFTBODY        1
1477 #define PE_TYPE_CLOTH           2
1478
1479 /* toolsettings->retopo_mode */
1480 #define RETOPO 1
1481 #define RETOPO_PAINT 2
1482
1483 /* toolsettings->retopo_paint_tool */ /*UNUSED*/
1484 /* #define RETOPO_PEN 1 */
1485 /* #define RETOPO_LINE 2 */
1486 /* #define RETOPO_ELLIPSE 4 */
1487
1488 /* toolsettings->skgen_options */
1489 #define SKGEN_FILTER_INTERNAL   (1 << 0)
1490 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
1491 #define SKGEN_SYMMETRY                  (1 << 2)
1492 #define SKGEN_CUT_LENGTH                (1 << 3)
1493 #define SKGEN_CUT_ANGLE                 (1 << 4)
1494 #define SKGEN_CUT_CORRELATION   (1 << 5)
1495 #define SKGEN_HARMONIC                  (1 << 6)
1496 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
1497 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
1498 #define SKGEN_FILTER_SMART              (1 << 9)
1499 #define SKGEN_DISP_LENGTH               (1 << 10)
1500 #define SKGEN_DISP_WEIGHT               (1 << 11)
1501 #define SKGEN_DISP_ORIG                 (1 << 12)
1502 #define SKGEN_DISP_EMBED                (1 << 13)
1503 #define SKGEN_DISP_INDEX                (1 << 14)
1504
1505 #define SKGEN_SUB_LENGTH                0
1506 #define SKGEN_SUB_ANGLE                 1
1507 #define SKGEN_SUB_CORRELATION   2
1508 #define SKGEN_SUB_TOTAL                 3
1509
1510 /* toolsettings->skgen_postpro */
1511 #define SKGEN_SMOOTH                    0
1512 #define SKGEN_AVERAGE                   1
1513 #define SKGEN_SHARPEN                   2
1514
1515 /* toolsettings->bone_sketching */
1516 #define BONE_SKETCHING                  1
1517 #define BONE_SKETCHING_QUICK    2
1518 #define BONE_SKETCHING_ADJUST   4
1519
1520 /* toolsettings->bone_sketching_convert */
1521 #define SK_CONVERT_CUT_FIXED                    0
1522 #define SK_CONVERT_CUT_LENGTH                   1
1523 #define SK_CONVERT_CUT_ADAPTATIVE               2
1524 #define SK_CONVERT_RETARGET                             3
1525
1526 /* toolsettings->skgen_retarget_options */
1527 #define SK_RETARGET_AUTONAME                    1
1528
1529 /* toolsettings->skgen_retarget_roll */
1530 #define SK_RETARGET_ROLL_NONE                   0
1531 #define SK_RETARGET_ROLL_VIEW                   1
1532 #define SK_RETARGET_ROLL_JOINT                  2
1533
1534 /* physics_settings->flag */
1535 #define PHYS_GLOBAL_GRAVITY             1
1536
1537 /* UnitSettings */
1538
1539 /* UnitSettings->system */
1540 #define USER_UNIT_NONE                  0
1541 #define USER_UNIT_METRIC                1
1542 #define USER_UNIT_IMPERIAL              2
1543 /* UnitSettings->flag */
1544 #define USER_UNIT_OPT_SPLIT             1
1545 #define USER_UNIT_ROT_RADIANS   2
1546
1547 #ifdef __cplusplus
1548 }
1549 #endif
1550
1551 #endif