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_color_types.h"  /* color management */
  45 #include "DNA_vec_types.h"
  46 #include "DNA_listBase.h"
  47 #include "DNA_ID.h"
  48 #include "DNA_freestyle_types.h"
  49 #include "DNA_gpu_types.h"
  50 #include "DNA_userdef_types.h"
  51
  52 struct CurveMapping;
  53 struct Object;
  54 struct Brush;
  55 struct World;
  56 struct Scene;
  57 struct Image;
  58 struct Group;
  59 struct Text;
  60 struct bNodeTree;
  61 struct AnimData;
  62 struct Editing;
  63 struct SceneStats;
  64 struct bGPdata;
  65 struct bGPDbrush;
  66 struct MovieClip;
  67 struct ColorSpace;
  68
  69 /* ************************************************************* */
  70 /* Scene Data */
  71
  72 /* Base - Wrapper for referencing Objects in a Scene */
  73 typedef struct Base {
  74         struct Base *next, *prev;
  75         unsigned int lay, selcol;
  76         int flag;
  77         short sx, sy;
  78         struct Object *object;
  79 } Base;
  80
  81 /* ************************************************************* */
  82 /* Output Format Data */
  83
  84 typedef struct AviCodecData {
  85         void                    *lpFormat;  /* save format */
  86         void                    *lpParms;   /* compressor options */
  87         unsigned int    cbFormat;           /* size of lpFormat buffer */
  88         unsigned int    cbParms;            /* size of lpParms buffer */
  89
  90         unsigned int    fccType;            /* stream type, for consistency */
  91         unsigned int    fccHandler;         /* compressor */
  92         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
  93         unsigned int    dwQuality;          /* compress quality 0-10,000 */
  94         unsigned int    dwBytesPerSecond;   /* bytes per second */
  95         unsigned int    dwFlags;            /* flags... see below */
  96         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
  97         unsigned int    pad;
  98
  99         char                    avicodecname[128];
 100 } AviCodecData;
 101
 102 typedef struct QuicktimeCodecData {
 103         /*Old quicktime implementation compatibility fields, read only in 2.5 - deprecated*/
 104         void                    *cdParms;   /* codec/compressor options */
 105         void                    *pad;       /* padding */
 106
 107         unsigned int    cdSize;             /* size of cdParms buffer */
 108         unsigned int    pad2;               /* padding */
 109
 110         char                    qtcodecname[128];
 111 } QuicktimeCodecData;
 112
 113 typedef struct QuicktimeCodecSettings {
 114         /* Codec settings detailed for 2.5 implementation*/
 115         int codecType; /* Types defined in quicktime_export.h */
 116         int     codecSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 117
 118         /* Settings not available in current QTKit API */
 119         int     codec;
 120         int     codecFlags;
 121         int     colorDepth;
 122         int     codecTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 123         int     minSpatialQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 124         int     minTemporalQuality; /* in 0-100 scale, to be translated in 0-1024 for qt use */
 125         int     keyFrameRate;
 126         int     bitRate;        /* bitrate in bps */
 127
 128         /* Audio Codec settings */
 129         int audiocodecType;
 130         int audioSampleRate;
 131         short audioBitDepth;
 132         short audioChannels;
 133         int audioCodecFlags;
 134         int audioBitRate;
 135         int pad1;
 136 } QuicktimeCodecSettings;
 137
 138 typedef enum FFMpegPreset {
 139         FFM_PRESET_NONE,
 140         FFM_PRESET_ULTRAFAST,
 141         FFM_PRESET_SUPERFAST,
 142         FFM_PRESET_VERYFAST,
 143         FFM_PRESET_FASTER,
 144         FFM_PRESET_FAST,
 145         FFM_PRESET_MEDIUM,
 146         FFM_PRESET_SLOW,
 147         FFM_PRESET_SLOWER,
 148         FFM_PRESET_VERYSLOW,
 149 } FFMpegPreset;
 150
 151
 152 /* Mapping from easily-understandable descriptions to CRF values.
 153  * Assumes we output 8-bit video. Needs to be remapped if 10-bit
 154  * is output.
 155  * We use a slightly wider than "subjectively sane range" according
 156  * to https://trac.ffmpeg.org/wiki/Encode/H.264#a1.ChooseaCRFvalue
 157  */
 158 typedef enum FFMpegCrf {
 159         FFM_CRF_NONE = -1,
 160         FFM_CRF_LOSSLESS = 0,
 161         FFM_CRF_PERC_LOSSLESS = 17,
 162         FFM_CRF_HIGH = 20,
 163         FFM_CRF_MEDIUM = 23,
 164         FFM_CRF_LOW = 26,
 165         FFM_CRF_VERYLOW = 29,
 166         FFM_CRF_LOWEST = 32,
 167 } FFMpegCrf;
 168
 169 typedef struct FFMpegCodecData {
 170         int type;
 171         int codec;
 172         int audio_codec;
 173         int video_bitrate;
 174         int audio_bitrate;
 175         int audio_mixrate;
 176         int audio_channels;
 177         int audio_pad;
 178         float audio_volume;
 179         int gop_size;
 180         int max_b_frames; /* only used if FFMPEG_USE_MAX_B_FRAMES flag is set. */
 181         int flags;
 182         int constant_rate_factor;
 183         int ffmpeg_preset; /* see FFMpegPreset */
 184
 185         int rc_min_rate;
 186         int rc_max_rate;
 187         int rc_buffer_size;
 188         int mux_packet_size;
 189         int mux_rate;
 190         int pad1;
 191
 192         IDProperty *properties;
 193 } FFMpegCodecData;
 194
 195 /* ************************************************************* */
 196 /* Audio */
 197
 198 typedef struct AudioData {
 199         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
 200         float main; // 2.5: now in FFMpegCodecData: audio_volume
 201         float speed_of_sound;
 202         float doppler_factor;
 203         int distance_model;
 204         short flag;
 205         short pad;
 206         float volume;
 207         float pad2;
 208 } AudioData;
 209
 210 /* *************************************************************** */
 211 /* Render Layers */
 212
 213 /* Render Layer */
 214 typedef struct SceneRenderLayer {
 215         struct SceneRenderLayer *next, *prev;
 216
 217         char name[64];  /* MAX_NAME */
 218
 219         struct Material *mat_override;
 220         struct Group *light_override;
 221
 222         unsigned int lay;                 /* scene->lay itself has priority over this */
 223         unsigned int lay_zmask;   /* has to be after lay, this is for Z-masking */
 224         unsigned int lay_exclude; /* not used by internal, exclude */
 225         int layflag;
 226
 227         int passflag;                   /* pass_xor has to be after passflag */
 228         int pass_xor;
 229
 230         int samples;
 231         float pass_alpha_threshold;
 232
 233         struct FreestyleConfig freestyleConfig;
 234 } SceneRenderLayer;
 235
 236 /* srl->layflag */
 237 #define SCE_LAY_SOLID   1
 238 #define SCE_LAY_ZTRA    2
 239 #define SCE_LAY_HALO    4
 240 #define SCE_LAY_EDGE    8
 241 #define SCE_LAY_SKY             16
 242 #define SCE_LAY_STRAND  32
 243 #define SCE_LAY_FRS             64
 244 #define SCE_LAY_AO              128
 245         /* flags between 256 and 0x8000 are set to 1 already, for future options */
 246
 247 #define SCE_LAY_ALL_Z           0x8000
 248 #define SCE_LAY_XOR                     0x10000
 249 #define SCE_LAY_DISABLE         0x20000
 250 #define SCE_LAY_ZMASK           0x40000
 251 #define SCE_LAY_NEG_ZMASK       0x80000
 252
 253 /* srl->passflag */
 254 typedef enum ScenePassType {
 255         SCE_PASS_COMBINED                 = (1 << 0),
 256         SCE_PASS_Z                        = (1 << 1),
 257         SCE_PASS_RGBA                     = (1 << 2),
 258         SCE_PASS_DIFFUSE                  = (1 << 3),
 259         SCE_PASS_SPEC                     = (1 << 4),
 260         SCE_PASS_SHADOW                   = (1 << 5),
 261         SCE_PASS_AO                       = (1 << 6),
 262         SCE_PASS_REFLECT                  = (1 << 7),
 263         SCE_PASS_NORMAL                   = (1 << 8),
 264         SCE_PASS_VECTOR                   = (1 << 9),
 265         SCE_PASS_REFRACT                  = (1 << 10),
 266         SCE_PASS_INDEXOB                  = (1 << 11),
 267         SCE_PASS_UV                       = (1 << 12),
 268         SCE_PASS_INDIRECT                 = (1 << 13),
 269         SCE_PASS_MIST                     = (1 << 14),
 270         SCE_PASS_RAYHITS                  = (1 << 15),
 271         SCE_PASS_EMIT                     = (1 << 16),
 272         SCE_PASS_ENVIRONMENT              = (1 << 17),
 273         SCE_PASS_INDEXMA                  = (1 << 18),
 274         SCE_PASS_DIFFUSE_DIRECT           = (1 << 19),
 275         SCE_PASS_DIFFUSE_INDIRECT         = (1 << 20),
 276         SCE_PASS_DIFFUSE_COLOR            = (1 << 21),
 277         SCE_PASS_GLOSSY_DIRECT            = (1 << 22),
 278         SCE_PASS_GLOSSY_INDIRECT          = (1 << 23),
 279         SCE_PASS_GLOSSY_COLOR             = (1 << 24),
 280         SCE_PASS_TRANSM_DIRECT            = (1 << 25),
 281         SCE_PASS_TRANSM_INDIRECT          = (1 << 26),
 282         SCE_PASS_TRANSM_COLOR             = (1 << 27),
 283         SCE_PASS_SUBSURFACE_DIRECT        = (1 << 28),
 284         SCE_PASS_SUBSURFACE_INDIRECT      = (1 << 29),
 285         SCE_PASS_SUBSURFACE_COLOR         = (1 << 30),
 286         SCE_PASS_DEBUG                    = (1 << 31),  /* This is a virtual pass. */
 287 } ScenePassType;
 288
 289 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
 290
 291 /* View - MultiView */
 292 typedef struct SceneRenderView {
 293         struct SceneRenderView *next, *prev;
 294
 295         char name[64];  /* MAX_NAME */
 296         char suffix[64];        /* MAX_NAME */
 297
 298         int viewflag;
 299         int pad[2];
 300         char pad2[4];
 301
 302 } SceneRenderView;
 303
 304 /* srv->viewflag */
 305 #define SCE_VIEW_DISABLE                (1<<0)
 306
 307 /* scene.render.views_format */
 308 enum {
 309         SCE_VIEWS_FORMAT_STEREO_3D = 0,
 310         SCE_VIEWS_FORMAT_MULTIVIEW = 1,
 311 };
 312
 313 /* ImageFormatData.views_output */
 314 enum {
 315         R_IMF_VIEWS_INDIVIDUAL = 0,
 316         R_IMF_VIEWS_STEREO_3D  = 1,
 317         R_IMF_VIEWS_MULTIVIEW  = 2,
 318 };
 319
 320 typedef struct Stereo3dFormat {
 321         short flag;
 322         char display_mode; /* encoding mode */
 323         char anaglyph_type; /* anaglyph scheme for the user display */
 324         char interlace_type;  /* interlace type for the user display */
 325         char pad[3];
 326 } Stereo3dFormat;
 327
 328 /* Stereo3dFormat.display_mode */
 329 typedef enum eStereoDisplayMode {
 330         S3D_DISPLAY_ANAGLYPH    = 0,
 331         S3D_DISPLAY_INTERLACE   = 1,
 332         S3D_DISPLAY_PAGEFLIP    = 2,
 333         S3D_DISPLAY_SIDEBYSIDE  = 3,
 334         S3D_DISPLAY_TOPBOTTOM   = 4,
 335 } eStereoDisplayMode;
 336
 337 /* Stereo3dFormat.flag */
 338 typedef enum eStereo3dFlag {
 339         S3D_INTERLACE_SWAP        = (1 << 0),
 340         S3D_SIDEBYSIDE_CROSSEYED  = (1 << 1),
 341         S3D_SQUEEZED_FRAME        = (1 << 2),
 342 } eStereo3dFlag;
 343
 344 /* Stereo3dFormat.anaglyph_type */
 345 typedef enum eStereo3dAnaglyphType {
 346         S3D_ANAGLYPH_REDCYAN      = 0,
 347         S3D_ANAGLYPH_GREENMAGENTA = 1,
 348         S3D_ANAGLYPH_YELLOWBLUE   = 2,
 349 } eStereo3dAnaglyphType;
 350
 351 /* Stereo3dFormat.interlace_type */
 352 typedef enum eStereo3dInterlaceType {
 353         S3D_INTERLACE_ROW          = 0,
 354         S3D_INTERLACE_COLUMN       = 1,
 355         S3D_INTERLACE_CHECKERBOARD = 2,
 356 } eStereo3dInterlaceType;
 357
 358 /* *************************************************************** */
 359
 360 /* Generic image format settings,
 361  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
 362  *
 363  * note: its a bit strange that even though this is an image format struct
 364  *  the imtype can still be used to select video formats.
 365  *  RNA ensures these enum's are only selectable for render output.
 366  */
 367 typedef struct ImageFormatData {
 368         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
 369                        /* note, video types should only ever be set from this
 370                         * structure when used from RenderData */
 371         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
 372                         * not a flag, only set 1 at a time */
 373
 374         char planes;   /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
 375         char flag;     /* generic options for all image types, alpha zbuffer */
 376
 377         char quality;  /* (0 - 100), eg: jpeg quality */
 378         char compress; /* (0 - 100), eg: png compression */
 379
 380
 381         /* --- format specific --- */
 382
 383         /* OpenEXR */
 384         char  exr_codec;
 385
 386         /* Cineon */
 387         char  cineon_flag;
 388         short cineon_white, cineon_black;
 389         float cineon_gamma;
 390
 391         /* Jpeg2000 */
 392         char  jp2_flag;
 393         char jp2_codec;
 394
 395         /* TIFF */
 396         char tiff_codec;
 397
 398         char pad[4];
 399
 400         /* Multiview */
 401         char views_format;
 402         Stereo3dFormat stereo3d_format;
 403
 404         /* color management */
 405         ColorManagedViewSettings view_settings;
 406         ColorManagedDisplaySettings display_settings;
 407 } ImageFormatData;
 408
 409
 410 /* ImageFormatData.imtype */
 411 #define R_IMF_IMTYPE_TARGA           0
 412 #define R_IMF_IMTYPE_IRIS            1
 413 /* #define R_HAMX                    2 */ /* hamx is nomore */
 414 /* #define R_FTYPE                   3 */ /* ftype is nomore */
 415 #define R_IMF_IMTYPE_JPEG90          4
 416 /* #define R_MOVIE                   5 */ /* movie is nomore */
 417 #define R_IMF_IMTYPE_IRIZ            7
 418 #define R_IMF_IMTYPE_RAWTGA         14
 419 #define R_IMF_IMTYPE_AVIRAW         15
 420 #define R_IMF_IMTYPE_AVIJPEG        16
 421 #define R_IMF_IMTYPE_PNG            17
 422 /* #define R_IMF_IMTYPE_AVICODEC    18 */ /* avicodec is nomore */
 423 #define R_IMF_IMTYPE_QUICKTIME      19
 424 #define R_IMF_IMTYPE_BMP            20
 425 #define R_IMF_IMTYPE_RADHDR         21
 426 #define R_IMF_IMTYPE_TIFF           22
 427 #define R_IMF_IMTYPE_OPENEXR        23
 428 #define R_IMF_IMTYPE_FFMPEG         24
 429 #define R_IMF_IMTYPE_FRAMESERVER    25
 430 #define R_IMF_IMTYPE_CINEON         26
 431 #define R_IMF_IMTYPE_DPX            27
 432 #define R_IMF_IMTYPE_MULTILAYER     28
 433 #define R_IMF_IMTYPE_DDS            29
 434 #define R_IMF_IMTYPE_JP2            30
 435 #define R_IMF_IMTYPE_H264           31
 436 #define R_IMF_IMTYPE_XVID           32
 437 #define R_IMF_IMTYPE_THEORA         33
 438 #define R_IMF_IMTYPE_PSD            34
 439
 440 #define R_IMF_IMTYPE_INVALID        255
 441
 442 /* ImageFormatData.flag */
 443 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
 444 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
 445
 446 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
 447 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
 448 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
 449 #define R_IMF_CHAN_DEPTH_10 (1<<2) /* 10bits (uncommon, Cineon/DPX support) */
 450 #define R_IMF_CHAN_DEPTH_12 (1<<3) /* 12bits (uncommon, jp2/DPX support) */
 451 #define R_IMF_CHAN_DEPTH_16 (1<<4) /* 16bits (tiff, halff float exr) */
 452 #define R_IMF_CHAN_DEPTH_24 (1<<5) /* 24bits (unused) */
 453 #define R_IMF_CHAN_DEPTH_32 (1<<6) /* 32bits (full float exr) */
 454
 455 /* ImageFormatData.planes */
 456 #define R_IMF_PLANES_RGB   24
 457 #define R_IMF_PLANES_RGBA  32
 458 #define R_IMF_PLANES_BW    8
 459
 460 /* ImageFormatData.exr_codec */
 461 #define R_IMF_EXR_CODEC_NONE  0
 462 #define R_IMF_EXR_CODEC_PXR24 1
 463 #define R_IMF_EXR_CODEC_ZIP   2
 464 #define R_IMF_EXR_CODEC_PIZ   3
 465 #define R_IMF_EXR_CODEC_RLE   4
 466 #define R_IMF_EXR_CODEC_ZIPS  5
 467 #define R_IMF_EXR_CODEC_B44   6
 468 #define R_IMF_EXR_CODEC_B44A  7
 469 #define R_IMF_EXR_CODEC_DWAA  8
 470 #define R_IMF_EXR_CODEC_DWAB  9
 471 #define R_IMF_EXR_CODEC_MAX  10
 472
 473 /* ImageFormatData.jp2_flag */
 474 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
 475 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
 476 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
 477
 478 /* ImageFormatData.jp2_codec */
 479 #define R_IMF_JP2_CODEC_JP2  0
 480 #define R_IMF_JP2_CODEC_J2K  1
 481
 482 /* ImageFormatData.cineon_flag */
 483 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
 484
 485 /* ImageFormatData.tiff_codec */
 486 enum {
 487         R_IMF_TIFF_CODEC_DEFLATE   = 0,
 488         R_IMF_TIFF_CODEC_LZW       = 1,
 489         R_IMF_TIFF_CODEC_PACKBITS  = 2,
 490         R_IMF_TIFF_CODEC_NONE      = 3,
 491 };
 492
 493 typedef struct BakeData {
 494         struct ImageFormatData im_format;
 495
 496         char filepath[1024]; /* FILE_MAX */
 497
 498         short width, height;
 499         short margin, flag;
 500
 501         float cage_extrusion;
 502         int pass_filter;
 503
 504         char normal_swizzle[3];
 505         char normal_space;
 506
 507         char save_mode;
 508         char pad[3];
 509
 510         char cage[64];  /* MAX_NAME */
 511 } BakeData;
 512
 513 /* (char) normal_swizzle */
 514 typedef enum BakeNormalSwizzle {
 515         R_BAKE_POSX = 0,
 516         R_BAKE_POSY = 1,
 517         R_BAKE_POSZ = 2,
 518         R_BAKE_NEGX = 3,
 519         R_BAKE_NEGY = 4,
 520         R_BAKE_NEGZ = 5,
 521 } BakeNormalSwizzle;
 522
 523 /* (char) save_mode */
 524 typedef enum BakeSaveMode {
 525         R_BAKE_SAVE_INTERNAL = 0,
 526         R_BAKE_SAVE_EXTERNAL = 1,
 527 } BakeSaveMode;
 528
 529 /* bake->pass_filter */
 530 typedef enum BakePassFilter {
 531         R_BAKE_PASS_FILTER_NONE           = 0,
 532         R_BAKE_PASS_FILTER_AO             = (1 << 0),
 533         R_BAKE_PASS_FILTER_EMIT           = (1 << 1),
 534         R_BAKE_PASS_FILTER_DIFFUSE        = (1 << 2),
 535         R_BAKE_PASS_FILTER_GLOSSY         = (1 << 3),
 536         R_BAKE_PASS_FILTER_TRANSM         = (1 << 4),
 537         R_BAKE_PASS_FILTER_SUBSURFACE     = (1 << 5),
 538         R_BAKE_PASS_FILTER_DIRECT         = (1 << 6),
 539         R_BAKE_PASS_FILTER_INDIRECT       = (1 << 7),
 540         R_BAKE_PASS_FILTER_COLOR          = (1 << 8),
 541 } BakePassFilter;
 542
 543 #define R_BAKE_PASS_FILTER_ALL (~0)
 544
 545 /* *************************************************************** */
 546 /* Render Data */
 547
 548 typedef struct RenderData {
 549         struct ImageFormatData im_format;
 550
 551         struct AviCodecData *avicodecdata;
 552         struct QuicktimeCodecData *qtcodecdata;
 553         struct QuicktimeCodecSettings qtcodecsettings;
 554         struct FFMpegCodecData ffcodecdata;
 555
 556         int cfra, sfra, efra;   /* frames as in 'images' */
 557         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
 558         int psfra, pefra;               /* start+end frames of preview range */
 559
 560         int images, framapto;
 561         short flag, threads;
 562
 563         float framelen, blurfac;
 564
 565         /** For UR edge rendering: give the edges this color */
 566         float edgeR, edgeG, edgeB;
 567
 568
 569         /* standalone player */  //  XXX deprecated since 2.5
 570         short fullscreen  DNA_DEPRECATED, xplay  DNA_DEPRECATED, yplay  DNA_DEPRECATED;
 571         short freqplay  DNA_DEPRECATED;
 572         /* standalone player */  //  XXX deprecated since 2.5
 573         short depth  DNA_DEPRECATED, attrib  DNA_DEPRECATED;
 574
 575
 576         int frame_step;         /* frames to jump during render/playback */
 577
 578         short stereomode  DNA_DEPRECATED;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
 579
 580         short dimensionspreset;         /* for the dimensions presets menu */
 581
 582         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
 583
 584         short size; /* size in % */
 585
 586         short maximsize DNA_DEPRECATED; /* max in Kb */
 587
 588         short pad6;
 589
 590         /* from buttons: */
 591         /**
 592          * The desired number of pixels in the x direction
 593          */
 594         int xsch;
 595         /**
 596          * The desired number of pixels in the y direction
 597          */
 598         int ysch;
 599
 600         /**
 601          * The number of part to use in the x direction
 602          */
 603         short xparts DNA_DEPRECATED;
 604         /**
 605          * The number of part to use in the y direction
 606          */
 607         short yparts DNA_DEPRECATED;
 608
 609         /**
 610          * render tile dimensions
 611          */
 612         int tilex, tiley;
 613
 614         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
 615
 616         /**
 617          * Render to image editor, fullscreen or to new window.
 618          */
 619         short displaymode;
 620         char use_lock_interface;
 621         char pad7;
 622
 623         /**
 624          * Flags for render settings. Use bit-masking to access the settings.
 625          */
 626         int scemode;
 627
 628         /**
 629          * Flags for render settings. Use bit-masking to access the settings.
 630          */
 631         int mode;
 632
 633         /**
 634          * Flags for raytrace settings. Use bit-masking to access the settings.
 635          */
 636         int raytrace_options;
 637
 638         /**
 639          * Raytrace acceleration structure
 640          */
 641         short raytrace_structure;
 642
 643         short pad1;
 644
 645         /* octree resolution */
 646         short ocres;
 647         short pad4;
 648
 649         /**
 650          * What to do with the sky/background. Picks sky/premul/key
 651          * blending for the background
 652          */
 653         short alphamode;
 654
 655         /**
 656          * The number of samples to use per pixel.
 657          */
 658         short osa;
 659
 660         short frs_sec, edgeint;
 661
 662
 663         /* safety, border and display rect */
 664         rctf safety, border;
 665         rcti disprect;
 666
 667         /* information on different layers to be rendered */
 668         ListBase layers;
 669         short actlay;
 670
 671         /* number of mblur samples */
 672         short mblur_samples;
 673
 674         /**
 675          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
 676          */
 677         float xasp, yasp;
 678
 679         float frs_sec_base;
 680
 681         /**
 682          * Value used to define filter size for all filter options  */
 683         float gauss;
 684
 685
 686         /* color management settings - color profiles, gamma correction, etc */
 687         int color_mgt_flag;
 688
 689         /** post-production settings. deprecated, but here for upwards compat (initialized to 1) */
 690         float postgamma, posthue, postsat;
 691
 692          /* Dither noise intensity */
 693         float dither_intensity;
 694
 695         /* Bake Render options */
 696         short bake_osa, bake_filter, bake_mode, bake_flag;
 697         short bake_normal_space, bake_quad_split;
 698         float bake_maxdist, bake_biasdist;
 699         short bake_samples, bake_pad;
 700         float bake_user_scale, bake_pad1;
 701
 702         /* path to render output */
 703         char pic[1024]; /* 1024 = FILE_MAX */
 704
 705         /* stamps flags. */
 706         int stamp;
 707         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
 708
 709         /* stamp info user data. */
 710         char stamp_udata[768];
 711
 712         /* foreground/background color. */
 713         float fg_stamp[4];
 714         float bg_stamp[4];
 715
 716         /* sequencer options */
 717         char seq_prev_type;
 718         char seq_rend_type;
 719         char seq_flag; /* flag use for sequence render/draw */
 720         char pad5[5];
 721
 722         /* render simplify */
 723         int simplify_flag;
 724         short simplify_subsurf;
 725         short simplify_subsurf_render;
 726         short simplify_shadowsamples, pad9;
 727         float simplify_particles;
 728         float simplify_particles_render;
 729         float simplify_aosss;
 730
 731         /* cineon */
 732         short cineonwhite  DNA_DEPRECATED, cineonblack  DNA_DEPRECATED;  /*deprecated*/
 733         float cineongamma  DNA_DEPRECATED;  /*deprecated*/
 734
 735         /* jpeg2000 */
 736         short jp2_preset  DNA_DEPRECATED, jp2_depth  DNA_DEPRECATED;  /*deprecated*/
 737         int rpad3;
 738
 739         /* Dome variables */ //  XXX deprecated since 2.5
 740         short domeres  DNA_DEPRECATED, domemode  DNA_DEPRECATED;        //  XXX deprecated since 2.5
 741         short domeangle  DNA_DEPRECATED, dometilt  DNA_DEPRECATED;      //  XXX deprecated since 2.5
 742         float domeresbuf  DNA_DEPRECATED;       //  XXX deprecated since 2.5
 743         float pad2;
 744         struct Text *dometext  DNA_DEPRECATED;  //  XXX deprecated since 2.5
 745
 746         /* Freestyle line thickness options */
 747         int line_thickness_mode;
 748         float unit_line_thickness; /* in pixels */
 749
 750         /* render engine */
 751         char engine[32];
 752
 753         /* Cycles baking */
 754         struct BakeData bake;
 755
 756         int preview_start_resolution;
 757
 758         /* Type of the debug pass to use.
 759          * Only used when built with debug passes support.
 760          */
 761         short debug_pass_type;
 762
 763         short pad;
 764
 765         /* MultiView */
 766         ListBase views;  /* SceneRenderView */
 767         short actview;
 768         short views_format;
 769         short pad8[2];
 770
 771         /* Motion blur shutter */
 772         struct CurveMapping mblur_shutter_curve;
 773 } RenderData;
 774
 775 /* *************************************************************** */
 776 /* Render Conversion/Simplfication Settings */
 777
 778 /* control render convert and shading engine */
 779 typedef struct RenderProfile {
 780         struct RenderProfile *next, *prev;
 781         char name[32];
 782
 783         short particle_perc;
 784         short subsurf_max;
 785         short shadbufsample_max;
 786         short pad1;
 787
 788         float ao_error, pad2;
 789
 790 } RenderProfile;
 791
 792 /* *************************************************************** */
 793 /* Game Engine - Dome */
 794
 795 typedef struct GameDome {
 796         short res, mode;
 797         short angle, tilt;
 798         float resbuf, pad2;
 799         struct Text *warptext;
 800 } GameDome;
 801
 802 #define DOME_FISHEYE                    1
 803 #define DOME_TRUNCATED_FRONT    2
 804 #define DOME_TRUNCATED_REAR             3
 805 #define DOME_ENVMAP                             4
 806 #define DOME_PANORAM_SPH                5
 807 #define DOME_NUM_MODES                  6
 808
 809 /* *************************************************************** */
 810 /* Game Engine */
 811
 812 typedef struct GameFraming {
 813         float col[3];
 814         char type, pad1, pad2, pad3;
 815 } GameFraming;
 816
 817 #define SCE_GAMEFRAMING_BARS   0
 818 #define SCE_GAMEFRAMING_EXTEND 1
 819 #define SCE_GAMEFRAMING_SCALE  2
 820
 821 typedef struct RecastData {
 822         float cellsize;
 823         float cellheight;
 824         float agentmaxslope;
 825         float agentmaxclimb;
 826         float agentheight;
 827         float agentradius;
 828         float edgemaxlen;
 829         float edgemaxerror;
 830         float regionminsize;
 831         float regionmergesize;
 832         int vertsperpoly;
 833         float detailsampledist;
 834         float detailsamplemaxerror;
 835         char partitioning;
 836         char pad1;
 837         short pad2;
 838 } RecastData;
 839
 840 #define RC_PARTITION_WATERSHED 0
 841 #define RC_PARTITION_MONOTONE 1
 842 #define RC_PARTITION_LAYERS 2
 843
 844 typedef struct GameData {
 845
 846         /* standalone player */
 847         struct GameFraming framing;
 848         short playerflag, xplay, yplay, freqplay;
 849         short depth, attrib, rt1, rt2;
 850         short aasamples, pad4[3];
 851
 852         /* stereo/dome mode */
 853         struct GameDome dome;
 854         short stereoflag, stereomode;
 855         float eyeseparation;
 856         RecastData recastData;
 857
 858
 859         /* physics (it was in world)*/
 860         float gravity; /*Gravitation constant for the game world*/
 861
 862         /*
 863          * Radius of the activity bubble, in Manhattan length. Objects
 864          * outside the box are activity-culled. */
 865         float activityBoxRadius;
 866
 867         /*
 868          * bit 3: (gameengine): Activity culling is enabled.
 869          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustum culling
 870          */
 871         int flag;
 872         short mode, matmode;
 873         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
 874         short physicsEngine;
 875         short exitkey;
 876         short vsync; /* Controls vsync: off, on, or adaptive (if supported) */
 877         short ticrate, maxlogicstep, physubstep, maxphystep;
 878         short obstacleSimulation;
 879         short raster_storage;
 880         float levelHeight;
 881         float deactivationtime, lineardeactthreshold, angulardeactthreshold;
 882
 883         /* Scene LoD */
 884         short lodflag, pad2;
 885         int scehysteresis, pad5;
 886
 887 } GameData;
 888
 889 #define STEREO_NOSTEREO         1
 890 #define STEREO_ENABLED          2
 891 #define STEREO_DOME                     3
 892
 893 //#define STEREO_NOSTEREO                1
 894 #define STEREO_QUADBUFFERED 2
 895 #define STEREO_ABOVEBELOW        3
 896 #define STEREO_INTERLACED        4
 897 #define STEREO_ANAGLYPH         5
 898 #define STEREO_SIDEBYSIDE       6
 899 #define STEREO_VINTERLACE       7
 900 //#define STEREO_DOME           8
 901 #define STEREO_3DTVTOPBOTTOM 9
 902
 903 /* physicsEngine */
 904 #define WOPHY_NONE              0
 905 #define WOPHY_BULLET    5
 906
 907 /* obstacleSimulation */
 908 #define OBSTSIMULATION_NONE             0
 909 #define OBSTSIMULATION_TOI_rays         1
 910 #define OBSTSIMULATION_TOI_cells        2
 911
 912 /* Raster storage */
 913 #define RAS_STORE_AUTO          0
 914 #define RAS_STORE_IMMEDIATE     1
 915 #define RAS_STORE_VA            2
 916 #define RAS_STORE_VBO           3
 917
 918 /* vsync */
 919 #define VSYNC_ON        0
 920 #define VSYNC_OFF       1
 921 #define VSYNC_ADAPTIVE  2
 922
 923 /* GameData.flag */
 924 #define GAME_RESTRICT_ANIM_UPDATES                      (1 << 0)
 925 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
 926 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
 927 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
 928 #define GAME_SHOW_PHYSICS                                       (1 << 4)
 929 #define GAME_DISPLAY_LISTS                                      (1 << 5)
 930 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
 931 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
 932 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
 933 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
 934 #define GAME_GLSL_NO_NODES                                      (1 << 10)
 935 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
 936 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
 937 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
 938 #define GAME_SHOW_MOUSE                                         (1 << 14)
 939 #define GAME_GLSL_NO_COLOR_MANAGEMENT           (1 << 15)
 940 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 16)
 941 #define GAME_NO_MATERIAL_CACHING                        (1 << 17)
 942 #define GAME_GLSL_NO_ENV_LIGHTING                       (1 << 18)
 943 /* Note: GameData.flag is now an int (max 32 flags). A short could only take 16 flags */
 944
 945 /* GameData.playerflag */
 946 #define GAME_PLAYER_FULLSCREEN                          (1 << 0)
 947 #define GAME_PLAYER_DESKTOP_RESOLUTION          (1 << 1)
 948
 949 /* GameData.matmode */
 950 enum {
 951 #ifdef DNA_DEPRECATED
 952         GAME_MAT_TEXFACE    = 0, /* deprecated */
 953 #endif
 954         GAME_MAT_MULTITEX   = 1,
 955         GAME_MAT_GLSL       = 2,
 956 };
 957
 958 /* GameData.lodflag */
 959 #define SCE_LOD_USE_HYST                (1 << 0)
 960
 961 /* UV Paint */
 962 #define UV_SCULPT_LOCK_BORDERS                          1
 963 #define UV_SCULPT_ALL_ISLANDS                           2
 964
 965 #define UV_SCULPT_TOOL_PINCH                            1
 966 #define UV_SCULPT_TOOL_RELAX                            2
 967 #define UV_SCULPT_TOOL_GRAB                                     3
 968
 969 #define UV_SCULPT_TOOL_RELAX_LAPLACIAN  1
 970 #define UV_SCULPT_TOOL_RELAX_HC                 2
 971
 972 /* Stereo Flags */
 973 #define STEREO_RIGHT_NAME "right"
 974 #define STEREO_LEFT_NAME "left"
 975 #define STEREO_RIGHT_SUFFIX "_R"
 976 #define STEREO_LEFT_SUFFIX "_L"
 977
 978 typedef enum StereoViews {
 979         STEREO_LEFT_ID = 0,
 980         STEREO_RIGHT_ID = 1,
 981         STEREO_3D_ID = 2,
 982         STEREO_MONO_ID = 3,
 983 } StereoViews;
 984
 985 /* *************************************************************** */
 986 /* Markers */
 987
 988 typedef struct TimeMarker {
 989         struct TimeMarker *next, *prev;
 990         int frame;
 991         char name[64];
 992         unsigned int flag;
 993         struct Object *camera;
 994 } TimeMarker;
 995
 996 /* *************************************************************** */
 997 /* Paint Mode/Tool Data */
 998
 999 #define PAINT_MAX_INPUT_SAMPLES 64
1000
1001 /* Paint Tool Base */
1002 typedef struct Paint {
1003         struct Brush *brush;
1004         struct Palette *palette;
1005         struct CurveMapping *cavity_curve; /* cavity curve */
1006
1007         /* WM Paint cursor */
1008         void *paint_cursor;
1009         unsigned char paint_cursor_col[4];
1010
1011         /* enum PaintFlags */
1012         int flags;
1013
1014         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to
1015          * smooth the stroke */
1016         int num_input_samples;
1017
1018         /* flags used for symmetry */
1019         int symmetry_flags;
1020
1021         float tile_offset[3];
1022         int pad2;
1023 } Paint;
1024
1025 /* ------------------------------------------- */
1026 /* Image Paint */
1027
1028 /* Texture/Image Editor */
1029 typedef struct ImagePaintSettings {
1030         Paint paint;
1031
1032         short flag, missing_data;
1033
1034         /* for projection painting only */
1035         short seam_bleed, normal_angle;
1036         short screen_grab_size[2]; /* capture size for re-projection */
1037
1038         int mode;                  /* mode used for texture painting */
1039
1040         void *paintcursor;                 /* wm handle */
1041         struct Image *stencil;     /* workaround until we support true layer masks */
1042         struct Image *clone;       /* clone layer for image mode for projective texture painting */
1043         struct Image *canvas;      /* canvas when the explicit system is used for painting */
1044         float stencil_col[3];
1045         float dither;              /* dither amount used when painting on byte images */
1046 } ImagePaintSettings;
1047
1048 /* ------------------------------------------- */
1049 /* Sculpt */
1050
1051 /* Sculpt */
1052 typedef struct Sculpt {
1053         Paint paint;
1054
1055         /* For rotating around a pivot point */
1056         //float pivot[3]; XXX not used?
1057         int flags;
1058
1059         /* Control tablet input */
1060         //char tablet_size, tablet_strength; XXX not used?
1061         int radial_symm[3];
1062
1063         /* Maximum edge length for dynamic topology sculpting (in pixels) */
1064         float detail_size;
1065
1066         /* Direction used for SCULPT_OT_symmetrize operator */
1067         int symmetrize_direction;
1068
1069         /* gravity factor for sculpting */
1070         float gravity_factor;
1071
1072         /* scale for constant detail size */
1073         float constant_detail;
1074         float detail_percent;
1075         float pad;
1076
1077         struct Object *gravity_object;
1078 } Sculpt;
1079
1080 typedef struct UvSculpt {
1081         Paint paint;
1082 } UvSculpt;
1083
1084 /* ------------------------------------------- */
1085 /* Vertex Paint */
1086
1087 /* Vertex Paint */
1088 typedef struct VPaint {
1089         Paint paint;
1090
1091         short flag, pad;
1092         int tot;                                                        /* allocation size of prev buffers */
1093         unsigned int *vpaint_prev;                      /* previous mesh colors */
1094         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
1095
1096         void *paintcursor;                                      /* wm handle */
1097 } VPaint;
1098
1099 /* VPaint.flag */
1100 enum {
1101         // VP_COLINDEX  = (1 << 0),  /* only paint onto active material*/  /* deprecated since before 2.49 */
1102         // VP_AREA      = (1 << 1),  /* deprecated since 2.70 */
1103         VP_NORMALS      = (1 << 3),
1104         VP_SPRAY        = (1 << 4),
1105         // VP_MIRROR_X  = (1 << 5),  /* deprecated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X) */
1106         VP_ONLYVGROUP   = (1 << 7)   /* weight paint only */
1107 };
1108
1109 /* ------------------------------------------- */
1110 /* GPencil Stroke Sculpting */
1111
1112 /* Brush types */
1113 typedef enum eGP_EditBrush_Types {
1114         GP_EDITBRUSH_TYPE_SMOOTH    = 0,
1115         GP_EDITBRUSH_TYPE_THICKNESS = 1,
1116         GP_EDITBRUSH_TYPE_GRAB      = 2,
1117         GP_EDITBRUSH_TYPE_PUSH      = 3,
1118         GP_EDITBRUSH_TYPE_TWIST     = 4,
1119         GP_EDITBRUSH_TYPE_PINCH     = 5,
1120         GP_EDITBRUSH_TYPE_RANDOMIZE = 6,
1121         GP_EDITBRUSH_TYPE_SUBDIVIDE = 7,
1122         GP_EDITBRUSH_TYPE_SIMPLIFY  = 8,
1123         GP_EDITBRUSH_TYPE_CLONE     = 9,
1124         GP_EDITBRUSH_TYPE_STRENGTH  = 10,
1125
1126         /* !!! Update GP_EditBrush_Data brush[###]; below !!! */
1127         TOT_GP_EDITBRUSH_TYPES
1128 } eGP_EditBrush_Types;
1129
1130 /* Lock axis options */
1131 typedef enum eGP_Lockaxis_Types {
1132         GP_LOCKAXIS_NONE = 0,
1133         GP_LOCKAXIS_X = 1,
1134         GP_LOCKAXIS_Y = 2,
1135         GP_LOCKAXIS_Z = 3
1136 } eGP_Lockaxis_Types;
1137
1138 /* Settings for a GPencil Stroke Sculpting Brush */
1139 typedef struct GP_EditBrush_Data {
1140         short size;             /* radius of brush */
1141         short flag;             /* eGP_EditBrush_Flag */
1142         float strength;         /* strength of effect */
1143 } GP_EditBrush_Data;
1144
1145 /* GP_EditBrush_Data.flag */
1146 typedef enum eGP_EditBrush_Flag {
1147         /* invert the effect of the brush */
1148         GP_EDITBRUSH_FLAG_INVERT       = (1 << 0),
1149         /* adjust strength using pen pressure */
1150         GP_EDITBRUSH_FLAG_USE_PRESSURE = (1 << 1),
1151
1152         /* strength of brush falls off with distance from cursor */
1153         GP_EDITBRUSH_FLAG_USE_FALLOFF  = (1 << 2),
1154
1155         /* smooth brush affects pressure values as well */
1156         GP_EDITBRUSH_FLAG_SMOOTH_PRESSURE  = (1 << 3)
1157 } eGP_EditBrush_Flag;
1158
1159
1160
1161 /* GPencil Stroke Sculpting Settings */
1162 typedef struct GP_BrushEdit_Settings {
1163         GP_EditBrush_Data brush[11];  /* TOT_GP_EDITBRUSH_TYPES */
1164         void *paintcursor;            /* runtime */
1165
1166         int brushtype;                /* eGP_EditBrush_Types */
1167         int flag;                     /* eGP_BrushEdit_SettingsFlag */
1168         int lock_axis;                /* lock drawing to one axis */
1169         float alpha;                  /* alpha factor for selection color */
1170 } GP_BrushEdit_Settings;
1171
1172 /* GP_BrushEdit_Settings.flag */
1173 typedef enum eGP_BrushEdit_SettingsFlag {
1174         /* only affect selected points */
1175         GP_BRUSHEDIT_FLAG_SELECT_MASK = (1 << 0),
1176         /* apply brush to position */
1177         GP_BRUSHEDIT_FLAG_APPLY_POSITION = (1 << 1),
1178         /* apply brush to strength */
1179         GP_BRUSHEDIT_FLAG_APPLY_STRENGTH = (1 << 2),
1180         /* apply brush to thickness */
1181         GP_BRUSHEDIT_FLAG_APPLY_THICKNESS = (1 << 3),
1182         /* apply interpolation to all layers */
1183         GP_BRUSHEDIT_FLAG_INTERPOLATE_ALL_LAYERS = (1 << 4),
1184         /* apply interpolation to only selected */
1185         GP_BRUSHEDIT_FLAG_INTERPOLATE_ONLY_SELECTED = (1 << 5)
1186
1187 } eGP_BrushEdit_SettingsFlag;
1188
1189 /* *************************************************************** */
1190 /* Transform Orientations */
1191
1192 typedef struct TransformOrientation {
1193         struct TransformOrientation *next, *prev;
1194         char name[64];  /* MAX_NAME */
1195         float mat[3][3];
1196         int pad;
1197 } TransformOrientation;
1198
1199 /* *************************************************************** */
1200 /* Unified Paint Settings
1201  */
1202
1203 /* These settings can override the equivalent fields in the active
1204  * Brush for any paint mode; the flag field controls whether these
1205  * values are used */
1206 typedef struct UnifiedPaintSettings {
1207         /* unified radius of brush in pixels */
1208         int size;
1209
1210         /* unified radius of brush in Blender units */
1211         float unprojected_radius;
1212
1213         /* unified strength of brush */
1214         float alpha;
1215
1216         /* unified brush weight, [0, 1] */
1217         float weight;
1218
1219         /* unified brush color */
1220         float rgb[3];
1221         /* unified brush secondary color */
1222         float secondary_rgb[3];
1223
1224         /* user preferences for sculpt and paint */
1225         int flag;
1226
1227         /* rake rotation */
1228
1229         /* record movement of mouse so that rake can start at an intuitive angle */
1230         float last_rake[2];
1231         float last_rake_angle;
1232
1233         int last_stroke_valid;
1234         float average_stroke_accum[3];
1235         int average_stroke_counter;
1236
1237
1238         float brush_rotation;
1239         float brush_rotation_sec;
1240
1241         /*********************************************************************************
1242          *  all data below are used to communicate with cursor drawing and tex sampling  *
1243          *********************************************************************************/
1244         int anchored_size;
1245
1246         float overlap_factor; /* normalization factor due to accumulated value of curve along spacing.
1247                                * Calculated when brush spacing changes to dampen strength of stroke
1248                                * if space attenuation is used*/
1249         char draw_inverted;
1250         /* check is there an ongoing stroke right now */
1251         char stroke_active;
1252
1253         char draw_anchored;
1254         char do_linear_conversion;
1255
1256         /* store last location of stroke or whether the mesh was hit. Valid only while stroke is active */
1257         float last_location[3];
1258         int last_hit;
1259
1260         float anchored_initial_mouse[2];
1261
1262         /* radius of brush, premultiplied with pressure.
1263          * In case of anchored brushes contains the anchored radius */
1264         float pixel_radius;
1265
1266         /* drawing pressure */
1267         float size_pressure_value;
1268
1269         /* position of mouse, used to sample the texture */
1270         float tex_mouse[2];
1271
1272         /* position of mouse, used to sample the mask texture */
1273         float mask_tex_mouse[2];
1274
1275         /* ColorSpace cache to avoid locking up during sampling */
1276         struct ColorSpace *colorspace;
1277 } UnifiedPaintSettings;
1278
1279 typedef enum {
1280         UNIFIED_PAINT_SIZE  = (1 << 0),
1281         UNIFIED_PAINT_ALPHA = (1 << 1),
1282         UNIFIED_PAINT_WEIGHT = (1 << 5),
1283         UNIFIED_PAINT_COLOR = (1 << 6),
1284
1285         /* only used if unified size is enabled, mirrors the brush flags
1286          * BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
1287         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1 << 2),
1288         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1 << 3),
1289
1290         /* only used if unified alpha is enabled, mirrors the brush flag
1291          * BRUSH_ALPHA_PRESSURE */
1292         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1 << 4)
1293 } UnifiedPaintSettingsFlags;
1294
1295
1296 typedef struct CurvePaintSettings {
1297         char curve_type;
1298         char flag;
1299         char depth_mode;
1300         char surface_plane;
1301         char fit_method;
1302         char pad;
1303         short error_threshold;
1304         float radius_min, radius_max;
1305         float radius_taper_start, radius_taper_end;
1306         float surface_offset;
1307         float corner_angle;
1308 } CurvePaintSettings;
1309
1310 /* CurvePaintSettings.flag */
1311 enum {
1312         CURVE_PAINT_FLAG_CORNERS_DETECT             = (1 << 0),
1313         CURVE_PAINT_FLAG_PRESSURE_RADIUS            = (1 << 1),
1314         CURVE_PAINT_FLAG_DEPTH_STROKE_ENDPOINTS     = (1 << 2),
1315         CURVE_PAINT_FLAG_DEPTH_STROKE_OFFSET_ABS    = (1 << 3),
1316 };
1317
1318 /* CurvePaintSettings.fit_method */
1319 enum {
1320         CURVE_PAINT_FIT_METHOD_REFIT            = 0,
1321         CURVE_PAINT_FIT_METHOD_SPLIT            = 1,
1322 };
1323
1324 /* CurvePaintSettings.depth_mode */
1325 enum {
1326         CURVE_PAINT_PROJECT_CURSOR              = 0,
1327         CURVE_PAINT_PROJECT_SURFACE             = 1,
1328 };
1329
1330 /* CurvePaintSettings.surface_plane */
1331 enum {
1332         CURVE_PAINT_SURFACE_PLANE_NORMAL_VIEW           = 0,
1333         CURVE_PAINT_SURFACE_PLANE_NORMAL_SURFACE        = 1,
1334         CURVE_PAINT_SURFACE_PLANE_VIEW                  = 2,
1335 };
1336
1337
1338 /* *************************************************************** */
1339 /* Stats */
1340
1341 /* Stats for Meshes */
1342 typedef struct MeshStatVis {
1343         char type;
1344         char _pad1[2];
1345
1346         /* overhang */
1347         char  overhang_axis;
1348         float overhang_min, overhang_max;
1349
1350         /* thickness */
1351         float thickness_min, thickness_max;
1352         char thickness_samples;
1353         char _pad2[3];
1354
1355         /* distort */
1356         float distort_min, distort_max;
1357
1358         /* sharp */
1359         float sharp_min, sharp_max;
1360 } MeshStatVis;
1361
1362
1363 /* *************************************************************** */
1364 /* Tool Settings */
1365
1366 typedef struct ToolSettings {
1367         VPaint *vpaint;         /* vertex paint */
1368         VPaint *wpaint;         /* weight paint */
1369         Sculpt *sculpt;
1370         UvSculpt *uvsculpt;     /* uv smooth */
1371
1372         /* Vertex group weight - used only for editmode, not weight
1373          * paint */
1374         float vgroup_weight;
1375
1376         float doublimit;        /* remove doubles limit */
1377         float normalsize;       /* size of normals */
1378         short automerge;
1379
1380         /* Selection Mode for Mesh */
1381         short selectmode;
1382
1383         /* UV Calculation */
1384         char unwrapper;
1385         char uvcalc_flag;
1386         char uv_flag;
1387         char uv_selectmode;
1388
1389         float uvcalc_margin;
1390
1391         /* Auto-IK */
1392         short autoik_chainlen;  /* runtime only */
1393
1394         /* Grease Pencil */
1395         char gpencil_flags;             /* flags/options for how the tool works */
1396         char gpencil_src;               /* for main 3D view Grease Pencil, where data comes from */
1397
1398         char gpencil_v3d_align; /* stroke placement settings: 3D View */
1399         char gpencil_v2d_align; /*                          : General 2D Editor */
1400         char gpencil_seq_align; /*                          : Sequencer Preview */
1401         char gpencil_ima_align; /*                          : Image Editor */
1402
1403         /* Grease Pencil Sculpt */
1404         struct GP_BrushEdit_Settings gp_sculpt;
1405
1406         /* Grease Pencil Drawing Brushes (bGPDbrush) */
1407         ListBase gp_brushes;
1408
1409         /* Image Paint (8 byttse aligned please!) */
1410         struct ImagePaintSettings imapaint;
1411
1412         /* Transform Proportional Area of Effect */
1413         float proportional_size;
1414
1415         /* Select Group Threshold */
1416         float select_thresh;
1417
1418         /* Auto-Keying Mode */
1419         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
1420         char keyframe_type;                 /* keyframe type (see DNA_curve_types.h) */
1421
1422         /* Multires */
1423         char multires_subdiv_type;
1424
1425         /* Skeleton generation */
1426         short skgen_resolution;
1427         float skgen_threshold_internal;
1428         float skgen_threshold_external;
1429         float skgen_length_ratio;
1430         float skgen_length_limit;
1431         float skgen_angle_limit;
1432         float skgen_correlation_limit;
1433         float skgen_symmetry_limit;
1434         float skgen_retarget_angle_weight;
1435         float skgen_retarget_length_weight;
1436         float skgen_retarget_distance_weight;
1437         short skgen_options;
1438         char  skgen_postpro;
1439         char  skgen_postpro_passes;
1440         char  skgen_subdivisions[3];
1441         char  skgen_multi_level;
1442
1443         /* Skeleton Sketching */
1444         struct Object *skgen_template;
1445         char bone_sketching;
1446         char bone_sketching_convert;
1447         char skgen_subdivision_number;
1448         char skgen_retarget_options;
1449         char skgen_retarget_roll;
1450         char skgen_side_string[8];
1451         char skgen_num_string[8];
1452
1453         /* Alt+RMB option */
1454         char edge_mode;
1455         char edge_mode_live_unwrap;
1456
1457         /* Transform */
1458         char snap_mode, snap_node_mode;
1459         char snap_uv_mode;
1460         short snap_flag, snap_target;
1461         short proportional, prop_mode;
1462         char proportional_objects; /* proportional edit, object mode */
1463         char proportional_mask; /* proportional edit, mask editing */
1464         char proportional_action; /* proportional edit, action editor */
1465         char proportional_fcurve; /* proportional edit, graph editor */
1466         char lock_markers; /* lock marker editing */
1467         char pad4[5];
1468
1469         char auto_normalize; /*auto normalizing mode in wpaint*/
1470         char multipaint; /* paint multiple bones in wpaint */
1471         char weightuser;
1472         char vgroupsubset; /* subset selection filter in wpaint */
1473
1474         /* UV painting */
1475         int use_uv_sculpt;
1476         int uv_sculpt_settings;
1477         int uv_sculpt_tool;
1478         int uv_relax_method;
1479         /* XXX: these sculpt_paint_* fields are deprecated, use the
1480          * unified_paint_settings field instead! */
1481         short sculpt_paint_settings DNA_DEPRECATED;     short pad5;
1482         int sculpt_paint_unified_size DNA_DEPRECATED;
1483         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
1484         float sculpt_paint_unified_alpha DNA_DEPRECATED;
1485
1486         /* Unified Paint Settings */
1487         struct UnifiedPaintSettings unified_paint_settings;
1488
1489         struct CurvePaintSettings curve_paint_settings;
1490
1491         struct MeshStatVis statvis;
1492 } ToolSettings;
1493
1494 /* *************************************************************** */
1495 /* Assorted Scene Data */
1496
1497 /* ------------------------------------------- */
1498 /* Stats (show in Info header) */
1499
1500 typedef struct bStats {
1501         /* scene totals for visible layers */
1502         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
1503         int totvert, totface;
1504 } bStats;
1505
1506 /* ------------------------------------------- */
1507 /* Unit Settings */
1508
1509 typedef struct UnitSettings {
1510         /* Display/Editing unit options for each scene */
1511         float scale_length; /* maybe have other unit conversions? */
1512         char system; /* imperial, metric etc */
1513         char system_rotation; /* not implemented as a proper unit system yet */
1514         short flag;
1515 } UnitSettings;
1516
1517 /* ------------------------------------------- */
1518 /* Global/Common Physics Settings */
1519
1520 typedef struct PhysicsSettings {
1521         float gravity[3];
1522         int flag, quick_cache_step, rt;
1523 } PhysicsSettings;
1524
1525 /* ------------------------------------------- */
1526 /* Safe Area options used in Camera View & VSE
1527  */
1528 typedef struct DisplaySafeAreas {
1529         /* each value represents the (x,y) margins as a multiplier.
1530          * 'center' in this context is just the name for a different kind of safe-area */
1531
1532         float title[2];         /* Title Safe */
1533         float action[2];        /* Image/Graphics Safe */
1534
1535         /* use for alternate aspect ratio */
1536         float title_center[2];
1537         float action_center[2];
1538 } DisplaySafeAreas;
1539
1540 /* *************************************************************** */
1541 /* Scene ID-Block */
1542
1543 typedef struct Scene {
1544         ID id;
1545         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
1546
1547         struct Object *camera;
1548         struct World *world;
1549
1550         struct Scene *set;
1551
1552         ListBase base;
1553         struct Base *basact;            /* active base */
1554         struct Object *obedit;          /* name replaces old G.obedit */
1555
1556         float cursor[3];                        /* 3d cursor location */
1557         float twcent[3];                        /* center for transform widget */
1558         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
1559
1560         unsigned int lay;                       /* bitflags for layer visibility */
1561         int layact;             /* active layer */
1562         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1563
1564         short flag;                                                             /* various settings */
1565
1566         char use_nodes;
1567         char pad[1];
1568
1569         struct bNodeTree *nodetree;
1570
1571         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1572
1573         struct ToolSettings *toolsettings;              /* default allocated now */
1574         struct SceneStats *stats;                               /* default allocated now */
1575         struct DisplaySafeAreas safe_areas;
1576
1577         /* migrate or replace? depends on some internal things... */
1578         /* no, is on the right place (ton) */
1579         struct RenderData r;
1580         struct AudioData audio;
1581
1582         ListBase markers;
1583         ListBase transform_spaces;
1584
1585         void *sound_scene;
1586         void *playback_handle;
1587         void *sound_scrub_handle;
1588         void *speaker_handles;
1589
1590         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1591
1592         /* none of the dependency graph  vars is mean to be saved */
1593         struct Depsgraph *depsgraph;
1594         void *pad1;
1595         struct  DagForest *theDag;
1596         short dagflags;
1597         short pad3;
1598
1599         /* User-Defined KeyingSets */
1600         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1601         ListBase keyingsets;                    /* KeyingSets for this scene */
1602
1603         /* Game Settings */
1604         struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5
1605         struct GameData gm;
1606
1607         /* Units */
1608         struct UnitSettings unit;
1609
1610         /* Grease Pencil */
1611         struct bGPdata *gpd;
1612
1613         /* Physics simulation settings */
1614         struct PhysicsSettings physics_settings;
1615
1616         /* Movie Tracking */
1617         struct MovieClip *clip;                 /* active movie clip */
1618
1619         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by BKE_object_handle_update() */
1620         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1621
1622         /* Color Management */
1623         ColorManagedViewSettings view_settings;
1624         ColorManagedDisplaySettings display_settings;
1625         ColorManagedColorspaceSettings sequencer_colorspace_settings;
1626
1627         /* RigidBody simulation world+settings */
1628         struct RigidBodyWorld *rigidbody_world;
1629
1630         struct PreviewImage *preview;
1631 } Scene;
1632
1633 /* **************** RENDERDATA ********************* */
1634
1635 /* flag */
1636         /* use preview range */
1637 #define SCER_PRV_RANGE  (1<<0)
1638 #define SCER_LOCK_FRAME_SELECTION       (1<<1)
1639         /* timeline/keyframe jumping - only selected items (on by default) */
1640 #define SCE_KEYS_NO_SELONLY     (1<<2)
1641
1642 /* mode (int now) */
1643 #define R_OSA                   0x0001
1644 #define R_SHADOW                0x0002
1645 #define R_GAMMA                 0x0004
1646 #define R_ORTHO                 0x0008
1647 #define R_ENVMAP                0x0010
1648 #define R_EDGE                  0x0020
1649 #define R_FIELDS                0x0040
1650 #define R_FIELDSTILL    0x0080
1651 /*#define R_RADIO                       0x0100 */ /* deprecated */
1652 #define R_BORDER                0x0200
1653 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
1654 #define R_CROP                  0x0800
1655 /*#define R_COSMO                       0x1000 deprecated */
1656 #define R_ODDFIELD              0x2000
1657 #define R_MBLUR                 0x4000
1658                 /* unified was here */
1659 #define R_RAYTRACE      0x10000
1660                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1661 #define R_GAUSS         0x20000
1662                 /* fbuf obsolete... */
1663 /*#define R_FBUF                        0x40000*/
1664                 /* threads obsolete... is there for old files, now use for autodetect threads */
1665 #define R_THREADS               0x80000
1666                 /* Use the same flag for autothreads */
1667 #define R_FIXED_THREADS         0x80000
1668
1669 #define R_SPEED                         0x100000
1670 #define R_SSS                           0x200000
1671 #define R_NO_OVERWRITE          0x400000  /* skip existing files */
1672 #define R_TOUCH                         0x800000  /* touch files before rendering */
1673 #define R_SIMPLIFY                      0x1000000
1674 #define R_EDGE_FRS                      0x2000000 /* R_EDGE reserved for Freestyle */
1675 #define R_PERSISTENT_DATA       0x4000000 /* keep data around for re-render */
1676 #define R_USE_WS_SHADING        0x8000000 /* use world space interpretation of lighting data */
1677
1678 /* seq_flag */
1679 #define R_SEQ_GL_PREV 1
1680 // #define R_SEQ_GL_REND 2  // UNUSED, opengl render has its own operator now.
1681 #define R_SEQ_SOLID_TEX 4
1682
1683 /* displaymode */
1684
1685 #define R_OUTPUT_SCREEN 0
1686 #define R_OUTPUT_AREA   1
1687 #define R_OUTPUT_WINDOW 2
1688 #define R_OUTPUT_NONE   3
1689 /*#define R_OUTPUT_FORKED       4*/
1690
1691 /* filtertype */
1692 #define R_FILTER_BOX    0
1693 #define R_FILTER_TENT   1
1694 #define R_FILTER_QUAD   2
1695 #define R_FILTER_CUBIC  3
1696 #define R_FILTER_CATROM 4
1697 #define R_FILTER_GAUSS  5
1698 #define R_FILTER_MITCH  6
1699 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
1700
1701 /* raytrace structure */
1702 #define R_RAYSTRUCTURE_AUTO                             0
1703 #define R_RAYSTRUCTURE_OCTREE                   1
1704 #define R_RAYSTRUCTURE_BLIBVH                   2       /* removed */
1705 #define R_RAYSTRUCTURE_VBVH                             3
1706 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
1707 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
1708
1709 /* raytrace_options */
1710 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
1711 #define R_RAYTRACE_USE_INSTANCES                0x0002
1712
1713 /* scemode (int now) */
1714 #define R_DOSEQ                         0x0001
1715 #define R_BG_RENDER                     0x0002
1716                 /* passepartout is camera option now, keep this for backward compatibility */
1717 #define R_PASSEPARTOUT          0x0004
1718 #define R_BUTS_PREVIEW          0x0008
1719 #define R_EXTENSION                     0x0010
1720 #define R_MATNODE_PREVIEW       0x0020
1721 #define R_DOCOMP                        0x0040
1722 #define R_COMP_CROP                     0x0080
1723 #define R_FREE_IMAGE            0x0100
1724 #define R_SINGLE_LAYER          0x0200
1725 #define R_EXR_TILE_FILE         0x0400
1726 /* #define R_COMP_FREE                  0x0800 */
1727 #define R_NO_IMAGE_LOAD         0x1000
1728 #define R_NO_TEX                        0x2000
1729 #define R_NO_FRAME_UPDATE       0x4000
1730 #define R_FULL_SAMPLE           0x8000
1731 /* #define R_DEPRECATED         0x10000 */
1732 /* #define R_RECURS_PROTECTION  0x20000 */
1733 #define R_TEXNODE_PREVIEW       0x40000
1734 #define R_VIEWPORT_PREVIEW      0x80000
1735 #define R_EXR_CACHE_FILE        0x100000
1736 #define R_MULTIVIEW                     0x200000
1737
1738 /* r->stamp */
1739 #define R_STAMP_TIME    0x0001
1740 #define R_STAMP_FRAME   0x0002
1741 #define R_STAMP_DATE    0x0004
1742 #define R_STAMP_CAMERA  0x0008
1743 #define R_STAMP_SCENE   0x0010
1744 #define R_STAMP_NOTE    0x0020
1745 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1746 #define R_STAMP_MARKER  0x0080
1747 #define R_STAMP_FILENAME        0x0100
1748 #define R_STAMP_SEQSTRIP        0x0200
1749 #define R_STAMP_RENDERTIME      0x0400
1750 #define R_STAMP_CAMERALENS      0x0800
1751 #define R_STAMP_STRIPMETA       0x1000
1752 #define R_STAMP_MEMORY          0x2000
1753 #define R_STAMP_HIDE_LABELS     0x4000
1754 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1755                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1756                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS|R_STAMP_MEMORY|                 \
1757                      R_STAMP_HIDE_LABELS)
1758
1759 /* alphamode */
1760 #define R_ADDSKY                0
1761 #define R_ALPHAPREMUL   1
1762 /*#define R_ALPHAKEY            2*/ /* deprecated, shouldn't be used */
1763
1764 /* color_mgt_flag */
1765 enum {
1766         R_COLOR_MANAGEMENT              = (1 << 0),  /* deprecated, should only be used in versioning code only */
1767         /*R_COLOR_MANAGEMENT_PREDIVIDE    = (1 << 1)*/  /* deprecated, shouldn't be used */
1768 };
1769
1770 #ifdef DNA_DEPRECATED
1771 /* subimtype, flag options for imtype */
1772 enum {
1773         R_OPENEXR_HALF  = 1,  /*deprecated*/
1774         R_OPENEXR_ZBUF  = 2,  /*deprecated*/
1775         R_PREVIEW_JPG   = 4,  /*deprecated*/
1776         R_CINEON_LOG    = 8,  /*deprecated*/
1777         R_TIFF_16BIT    = 16, /*deprecated*/
1778
1779         R_JPEG2K_12BIT                  =     32,  /* Jpeg2000 */                    /*deprecated*/
1780         R_JPEG2K_16BIT                  =     64,                                    /*deprecated*/
1781         R_JPEG2K_YCC                    =     128,  /* when disabled use RGB */      /*deprecated*/
1782         R_JPEG2K_CINE_PRESET    =     256,                                   /*deprecated*/
1783         R_JPEG2K_CINE_48FPS             =     512,                                   /*deprecated*/
1784 };
1785 #endif
1786
1787 /* bake_mode: same as RE_BAKE_xxx defines */
1788 /* bake_flag: */
1789 #define R_BAKE_CLEAR            1
1790 #define R_BAKE_OSA                      2
1791 #define R_BAKE_TO_ACTIVE        4
1792 #define R_BAKE_NORMALIZE        8
1793 #define R_BAKE_MULTIRES         16
1794 #define R_BAKE_LORES_MESH       32
1795 #define R_BAKE_VCOL                     64
1796 #define R_BAKE_USERSCALE        128
1797 #define R_BAKE_CAGE                     256
1798 #define R_BAKE_SPLIT_MAT        512
1799 #define R_BAKE_AUTO_NAME        1024
1800
1801 /* bake_normal_space */
1802 #define R_BAKE_SPACE_CAMERA      0
1803 #define R_BAKE_SPACE_WORLD       1
1804 #define R_BAKE_SPACE_OBJECT      2
1805 #define R_BAKE_SPACE_TANGENT 3
1806
1807 /* simplify_flag */
1808 #define R_SIMPLE_NO_TRIANGULATE         1
1809
1810 /* line_thickness_mode */
1811 #define R_LINE_THICKNESS_ABSOLUTE 1
1812 #define R_LINE_THICKNESS_RELATIVE 2
1813
1814 /* sequencer seq_prev_type seq_rend_type */
1815
1816 /* scene->r.engine (scene.c) */
1817 extern const char *RE_engine_id_BLENDER_RENDER;
1818 extern const char *RE_engine_id_BLENDER_GAME;
1819 extern const char *RE_engine_id_CYCLES;
1820
1821 /* **************** SCENE ********************* */
1822
1823 /* note that much higher maxframes give imprecise sub-frames, see: T46859 */
1824 /* for general use */
1825 #define MAXFRAME        500000
1826 #define MAXFRAMEF       500000.0f
1827
1828 #define MINFRAME        0
1829 #define MINFRAMEF       0.0f
1830
1831 /* (minimum frame number for current-frame) */
1832 #define MINAFRAME       -500000
1833 #define MINAFRAMEF      -500000.0f
1834
1835 /* depricate this! */
1836 #define TESTBASE(v3d, base)  (                                                \
1837         ((base)->flag & SELECT) &&                                                \
1838         ((base)->lay & v3d->lay) &&                                               \
1839         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1840 #define TESTBASELIB(v3d, base)  (                                             \
1841         ((base)->flag & SELECT) &&                                                \
1842         ((base)->lay & v3d->lay) &&                                               \
1843         ((base)->object->id.lib == NULL) &&                                       \
1844         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1845 #define TESTBASELIB_BGMODE(v3d, scene, base)  (                               \
1846         ((base)->flag & SELECT) &&                                                \
1847         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1848         ((base)->object->id.lib == NULL) &&                                       \
1849         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1850 #define BASE_EDITABLE_BGMODE(v3d, scene, base)  (                             \
1851         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1852         ((base)->object->id.lib == NULL) &&                                       \
1853         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1854 #define BASE_SELECTABLE(v3d, base)  (                                         \
1855         (base->lay & v3d->lay) &&                                                 \
1856         (base->object->restrictflag & (OB_RESTRICT_SELECT | OB_RESTRICT_VIEW)) == 0)
1857 #define BASE_VISIBLE(v3d, base)  (                                            \
1858         (base->lay & v3d->lay) &&                                                 \
1859         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1860 #define BASE_VISIBLE_BGMODE(v3d, scene, base)  (                              \
1861         (base->lay & (v3d ? v3d->lay : scene->lay)) &&                            \
1862         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1863
1864 #define FIRSTBASE               scene->base.first
1865 #define LASTBASE                scene->base.last
1866 #define BASACT                  (scene->basact)
1867 #define OBACT                   (BASACT ? BASACT->object: NULL)
1868
1869 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1870 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1871
1872 #define CFRA            (scene->r.cfra)
1873 #define SUBFRA          (scene->r.subframe)
1874 #define SFRA            (scene->r.sfra)
1875 #define EFRA            (scene->r.efra)
1876 #define PRVRANGEON      (scene->r.flag & SCER_PRV_RANGE)
1877 #define PSFRA           ((PRVRANGEON) ? (scene->r.psfra) : (scene->r.sfra))
1878 #define PEFRA           ((PRVRANGEON) ? (scene->r.pefra) : (scene->r.efra))
1879 #define FRA2TIME(a)     ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1880 #define TIME2FRA(a)     ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1881 #define FPS              (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1882
1883 /* base->flag is in DNA_object_types.h */
1884
1885 /* toolsettings->snap_flag */
1886 #define SCE_SNAP                                1
1887 #define SCE_SNAP_ROTATE                 2
1888 #define SCE_SNAP_PEEL_OBJECT    4
1889 #define SCE_SNAP_PROJECT                8
1890 #define SCE_SNAP_NO_SELF                16
1891 #define SCE_SNAP_ABS_GRID               32
1892
1893 /* toolsettings->snap_target */
1894 #define SCE_SNAP_TARGET_CLOSEST 0
1895 #define SCE_SNAP_TARGET_CENTER  1
1896 #define SCE_SNAP_TARGET_MEDIAN  2
1897 #define SCE_SNAP_TARGET_ACTIVE  3
1898 /* toolsettings->snap_mode */
1899 #define SCE_SNAP_MODE_INCREMENT 0
1900 #define SCE_SNAP_MODE_VERTEX    1
1901 #define SCE_SNAP_MODE_EDGE              2
1902 #define SCE_SNAP_MODE_FACE              3
1903 #define SCE_SNAP_MODE_VOLUME    4
1904 #define SCE_SNAP_MODE_NODE_X    5
1905 #define SCE_SNAP_MODE_NODE_Y    6
1906 #define SCE_SNAP_MODE_NODE_XY   7
1907 #define SCE_SNAP_MODE_GRID              8
1908
1909 /* toolsettings->selectmode */
1910 #define SCE_SELECT_VERTEX       1 /* for mesh */
1911 #define SCE_SELECT_EDGE         2
1912 #define SCE_SELECT_FACE         4
1913
1914 /* toolsettings->statvis->type */
1915 #define SCE_STATVIS_OVERHANG    0
1916 #define SCE_STATVIS_THICKNESS   1
1917 #define SCE_STATVIS_INTERSECT   2
1918 #define SCE_STATVIS_DISTORT             3
1919 #define SCE_STATVIS_SHARP               4
1920
1921 /* toolsettings->particle.selectmode for particles */
1922 #define SCE_SELECT_PATH         1
1923 #define SCE_SELECT_POINT        2
1924 #define SCE_SELECT_END          4
1925
1926 /* toolsettings->prop_mode (proportional falloff) */
1927 #define PROP_SMOOTH            0
1928 #define PROP_SPHERE            1
1929 #define PROP_ROOT              2
1930 #define PROP_SHARP             3
1931 #define PROP_LIN               4
1932 #define PROP_CONST             5
1933 #define PROP_RANDOM            6
1934 #define PROP_INVSQUARE         7
1935 #define PROP_MODE_MAX          8
1936
1937 /* toolsettings->proportional */
1938 #define PROP_EDIT_OFF                   0
1939 #define PROP_EDIT_ON                    1
1940 #define PROP_EDIT_CONNECTED             2
1941 #define PROP_EDIT_PROJECTED             3
1942
1943 /* toolsettings->weightuser */
1944 enum {
1945         OB_DRAW_GROUPUSER_NONE      = 0,
1946         OB_DRAW_GROUPUSER_ACTIVE    = 1,
1947         OB_DRAW_GROUPUSER_ALL       = 2
1948 };
1949
1950 /* toolsettings->vgroupsubset */
1951 /* object_vgroup.c */
1952 typedef enum eVGroupSelect {
1953         WT_VGROUP_ALL = 0,
1954         WT_VGROUP_ACTIVE = 1,
1955         WT_VGROUP_BONE_SELECT = 2,
1956         WT_VGROUP_BONE_DEFORM = 3,
1957         WT_VGROUP_BONE_DEFORM_OFF = 4
1958 } eVGroupSelect;
1959
1960 #define WT_VGROUP_MASK_ALL \
1961         ((1 << WT_VGROUP_ACTIVE) | \
1962          (1 << WT_VGROUP_BONE_SELECT) | \
1963          (1 << WT_VGROUP_BONE_DEFORM) | \
1964          (1 << WT_VGROUP_BONE_DEFORM_OFF) | \
1965          (1 << WT_VGROUP_ALL))
1966
1967
1968 /* sce->flag */
1969 #define SCE_DS_SELECTED                 (1<<0)
1970 #define SCE_DS_COLLAPSED                (1<<1)
1971 #define SCE_NLA_EDIT_ON                 (1<<2)
1972 #define SCE_FRAME_DROP                  (1<<3)
1973
1974
1975         /* return flag BKE_scene_base_iter_next functions */
1976 /* #define F_ERROR                      -1 */  /* UNUSED */
1977 #define F_START                 0
1978 #define F_SCENE                 1
1979 #define F_DUPLI                 3
1980
1981 /* audio->flag */
1982 #define AUDIO_MUTE                (1<<0)
1983 #define AUDIO_SYNC                (1<<1)
1984 #define AUDIO_SCRUB                       (1<<2)
1985 #define AUDIO_VOLUME_ANIMATED     (1<<3)
1986
1987 enum {
1988 #ifdef DNA_DEPRECATED
1989         FFMPEG_MULTIPLEX_AUDIO  = 1,  /* deprecated, you can choose none as audiocodec now */
1990 #endif
1991         FFMPEG_AUTOSPLIT_OUTPUT = 2,
1992         FFMPEG_LOSSLESS_OUTPUT  = 4,
1993         FFMPEG_USE_MAX_B_FRAMES = (1 << 3),
1994 };
1995
1996 /* Paint.flags */
1997 typedef enum {
1998         PAINT_SHOW_BRUSH = (1 << 0),
1999         PAINT_FAST_NAVIGATE = (1 << 1),
2000         PAINT_SHOW_BRUSH_ON_SURFACE = (1 << 2),
2001         PAINT_USE_CAVITY_MASK = (1 << 3)
2002 } PaintFlags;
2003
2004 /* Paint.symmetry_flags
2005  * (for now just a duplicate of sculpt symmetry flags) */
2006 typedef enum SymmetryFlags {
2007         PAINT_SYMM_X = (1 << 0),
2008         PAINT_SYMM_Y = (1 << 1),
2009         PAINT_SYMM_Z = (1 << 2),
2010         PAINT_SYMMETRY_FEATHER = (1 << 3),
2011         PAINT_TILE_X = (1 << 4),
2012         PAINT_TILE_Y = (1 << 5),
2013         PAINT_TILE_Z = (1 << 6),
2014 } SymmetryFlags;
2015
2016 #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z)
2017
2018 /* Sculpt.flags */
2019 /* These can eventually be moved to paint flags? */
2020 typedef enum SculptFlags {
2021 #ifdef DNA_DEPRECATED
2022         /* deprecated, part of paint struct symmetry_flags now */
2023         SCULPT_SYMM_X = (1 << 0),
2024         SCULPT_SYMM_Y = (1 << 1),
2025         SCULPT_SYMM_Z = (1 << 2),
2026 #endif
2027
2028         SCULPT_LOCK_X = (1 << 3),
2029         SCULPT_LOCK_Y = (1 << 4),
2030         SCULPT_LOCK_Z = (1 << 5),
2031         /* deprecated, part of paint struct symmetry_flags now */
2032         SCULPT_SYMMETRY_FEATHER = (1 << 6),
2033
2034         SCULPT_USE_OPENMP = (1 << 7),
2035         SCULPT_ONLY_DEFORM = (1 << 8),
2036         SCULPT_SHOW_DIFFUSE = (1 << 9),
2037
2038         /* If set, the mesh will be drawn with smooth-shading in
2039          * dynamic-topology mode */
2040         SCULPT_DYNTOPO_SMOOTH_SHADING = (1 << 10),
2041
2042         /* If set, dynamic-topology brushes will subdivide short edges */
2043         SCULPT_DYNTOPO_SUBDIVIDE = (1 << 12),
2044         /* If set, dynamic-topology brushes will collapse short edges */
2045         SCULPT_DYNTOPO_COLLAPSE = (1 << 11),
2046
2047         /* If set, dynamic-topology detail size will be constant in object space */
2048         SCULPT_DYNTOPO_DETAIL_CONSTANT = (1 << 13),
2049         SCULPT_DYNTOPO_DETAIL_BRUSH = (1 << 14),
2050 } SculptFlags;
2051
2052 typedef enum ImagePaintMode {
2053         IMAGEPAINT_MODE_MATERIAL, /* detect texture paint slots from the material */
2054         IMAGEPAINT_MODE_IMAGE,    /* select texture paint image directly */
2055 } ImagePaintMode;
2056
2057 /* ImagePaintSettings.flag */
2058 #define IMAGEPAINT_DRAWING                              1
2059 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
2060 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
2061
2062 /* projection painting only */
2063 #define IMAGEPAINT_PROJECT_XRAY                 (1 << 4)
2064 #define IMAGEPAINT_PROJECT_BACKFACE             (1 << 5)
2065 #define IMAGEPAINT_PROJECT_FLAT                 (1 << 6)
2066 #define IMAGEPAINT_PROJECT_LAYER_CLONE  (1 << 7)
2067 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        (1 << 8)
2068 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    (1 << 9)
2069
2070
2071 #define IMAGEPAINT_MISSING_UVS       (1 << 0)
2072 #define IMAGEPAINT_MISSING_MATERIAL  (1 << 1)
2073 #define IMAGEPAINT_MISSING_TEX       (1 << 2)
2074 #define IMAGEPAINT_MISSING_STENCIL   (1 << 3)
2075
2076 /* toolsettings->uvcalc_flag */
2077 #define UVCALC_FILLHOLES                        1
2078 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
2079 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
2080 #define UVCALC_USESUBSURF                       8       /* Use mesh data after subsurf to compute UVs*/
2081
2082 /* toolsettings->uv_flag */
2083 #define UV_SYNC_SELECTION       1
2084 #define UV_SHOW_SAME_IMAGE      2
2085
2086 /* toolsettings->uv_selectmode */
2087 #define UV_SELECT_VERTEX        1
2088 #define UV_SELECT_EDGE          2
2089 #define UV_SELECT_FACE          4
2090 #define UV_SELECT_ISLAND        8
2091
2092 /* toolsettings->edge_mode */
2093 #define EDGE_MODE_SELECT                                0
2094 #define EDGE_MODE_TAG_SEAM                              1
2095 #define EDGE_MODE_TAG_SHARP                             2
2096 #define EDGE_MODE_TAG_CREASE                    3
2097 #define EDGE_MODE_TAG_BEVEL                             4
2098 #define EDGE_MODE_TAG_FREESTYLE                 5
2099
2100 /* toolsettings->gpencil_flags */
2101 typedef enum eGPencil_Flags {
2102         /* "Continuous Drawing" - The drawing operator enters a mode where multiple strokes can be drawn */
2103         GP_TOOL_FLAG_PAINTSESSIONS_ON       = (1 << 0),
2104         /* When creating new frames, the last frame gets used as the basis for the new one */
2105         GP_TOOL_FLAG_RETAIN_LAST            = (1 << 1),
2106         /* Add the strokes below all strokes in the layer */
2107         GP_TOOL_FLAG_PAINT_ONBACK = (1 << 2)
2108 } eGPencil_Flags;
2109
2110 /* toolsettings->gpencil_src */
2111 typedef enum eGPencil_Source_3D {
2112         GP_TOOL_SOURCE_SCENE    = 0,
2113         GP_TOOL_SOURCE_OBJECT   = 1
2114 } eGPencil_Source_3d;
2115
2116 /* toolsettings->gpencil_*_align - Stroke Placement mode flags */
2117 typedef enum eGPencil_Placement_Flags {
2118         /* New strokes are added in viewport/data space (i.e. not screen space) */
2119         GP_PROJECT_VIEWSPACE    = (1 << 0),
2120
2121         /* Viewport space, but relative to render canvas (Sequencer Preview Only) */
2122         GP_PROJECT_CANVAS       = (1 << 1),
2123
2124         /* Project into the screen's Z values */
2125         GP_PROJECT_DEPTH_VIEW   = (1 << 2),
2126         GP_PROJECT_DEPTH_STROKE = (1 << 3),
2127
2128         /* "Use Endpoints" */
2129         GP_PROJECT_DEPTH_STROKE_ENDPOINTS = (1 << 4),
2130 } eGPencil_Placement_Flags;
2131
2132 /* toolsettings->particle flag */
2133 #define PE_KEEP_LENGTHS                 1
2134 #define PE_LOCK_FIRST                   2
2135 #define PE_DEFLECT_EMITTER              4
2136 #define PE_INTERPOLATE_ADDED    8
2137 #define PE_DRAW_PART                    16
2138 /* #define PE_X_MIRROR                  64 */   /* deprecated */
2139 #define PE_FADE_TIME                    128
2140 #define PE_AUTO_VELOCITY                256
2141
2142 /* toolsetting->particle brushtype */
2143 #define PE_BRUSH_NONE           -1
2144 #define PE_BRUSH_COMB           0
2145 #define PE_BRUSH_CUT            1
2146 #define PE_BRUSH_LENGTH         2
2147 #define PE_BRUSH_PUFF           3
2148 #define PE_BRUSH_ADD            4
2149 #define PE_BRUSH_SMOOTH         5
2150 #define PE_BRUSH_WEIGHT         6
2151
2152 /* this must equal ParticleEditSettings.brush array size */
2153 #define PE_TOT_BRUSH            6
2154
2155 /* ParticleBrushData->flag */
2156 #define PE_BRUSH_DATA_PUFF_VOLUME 1
2157
2158 /* tooksettings->particle edittype */
2159 #define PE_TYPE_PARTICLES       0
2160 #define PE_TYPE_SOFTBODY        1
2161 #define PE_TYPE_CLOTH           2
2162
2163 /* toolsettings->skgen_options */
2164 #define SKGEN_FILTER_INTERNAL   (1 << 0)
2165 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
2166 #define SKGEN_SYMMETRY                  (1 << 2)
2167 #define SKGEN_CUT_LENGTH                (1 << 3)
2168 #define SKGEN_CUT_ANGLE                 (1 << 4)
2169 #define SKGEN_CUT_CORRELATION   (1 << 5)
2170 #define SKGEN_HARMONIC                  (1 << 6)
2171 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
2172 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
2173 #define SKGEN_FILTER_SMART              (1 << 9)
2174 #define SKGEN_DISP_LENGTH               (1 << 10)
2175 #define SKGEN_DISP_WEIGHT               (1 << 11)
2176 #define SKGEN_DISP_ORIG                 (1 << 12)
2177 #define SKGEN_DISP_EMBED                (1 << 13)
2178 #define SKGEN_DISP_INDEX                (1 << 14)
2179
2180 #define SKGEN_SUB_LENGTH                0
2181 #define SKGEN_SUB_ANGLE                 1
2182 #define SKGEN_SUB_CORRELATION   2
2183 #define SKGEN_SUB_TOTAL                 3
2184
2185 /* toolsettings->skgen_postpro */
2186 #define SKGEN_SMOOTH                    0
2187 #define SKGEN_AVERAGE                   1
2188 #define SKGEN_SHARPEN                   2
2189
2190 /* toolsettings->bone_sketching */
2191 #define BONE_SKETCHING                  1
2192 #define BONE_SKETCHING_QUICK    2
2193 #define BONE_SKETCHING_ADJUST   4
2194
2195 /* toolsettings->bone_sketching_convert */
2196 #define SK_CONVERT_CUT_FIXED                    0
2197 #define SK_CONVERT_CUT_LENGTH                   1
2198 #define SK_CONVERT_CUT_ADAPTATIVE               2
2199 #define SK_CONVERT_RETARGET                             3
2200
2201 /* toolsettings->skgen_retarget_options */
2202 #define SK_RETARGET_AUTONAME                    1
2203
2204 /* toolsettings->skgen_retarget_roll */
2205 #define SK_RETARGET_ROLL_NONE                   0
2206 #define SK_RETARGET_ROLL_VIEW                   1
2207 #define SK_RETARGET_ROLL_JOINT                  2
2208
2209 /* physics_settings->flag */
2210 #define PHYS_GLOBAL_GRAVITY             1
2211
2212 /* UnitSettings */
2213
2214 /* UnitSettings->system */
2215 #define USER_UNIT_NONE                  0
2216 #define USER_UNIT_METRIC                1
2217 #define USER_UNIT_IMPERIAL              2
2218 /* UnitSettings->flag */
2219 #define USER_UNIT_OPT_SPLIT             1
2220 #define USER_UNIT_ROT_RADIANS   2
2221
2222 #ifdef __cplusplus
2223 }
2224 #endif
2225
2226 #endif  /* __DNA_SCENE_TYPES_H__ */