source/blender/makesdna/DNA_scene_types.h

   1 /**
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version. The Blender
  10  * Foundation also sells licenses for use in proprietary software under
  11  * the Blender License.  See http://www.blender.org/BL/ for information
  12  * about this.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22  *
  23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  24  * All rights reserved.
  25  *
  26  * The Original Code is: all of this file.
  27  *
  28  * Contributor(s): none yet.
  29  *
  30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  31  */
  32 #ifndef DNA_SCENE_TYPES_H
  33 #define DNA_SCENE_TYPES_H
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 #include "DNA_vec_types.h"
  40 #include "DNA_listBase.h"
  41 #include "DNA_scriptlink_types.h"
  42 #include "DNA_ID.h"
  43 #include "DNA_scriptlink_types.h"
  44
  45 struct Radio;
  46 struct Object;
  47 struct World;
  48 struct Scene;
  49 struct Image;
  50 struct Group;
  51 struct bNodeTree;
  52
  53 typedef struct Base {
  54         struct Base *next, *prev;
  55         unsigned int lay, selcol;
  56         int flag;
  57         short sx, sy;
  58         struct Object *object;
  59 } Base;
  60
  61 typedef struct AviCodecData {
  62         void                    *lpFormat;                      /* save format */
  63         void                    *lpParms;                       /* compressor options */
  64         unsigned int    cbFormat;                       /* size of lpFormat buffer */
  65         unsigned int    cbParms;                        /* size of lpParms buffer */
  66
  67         unsigned int    fccType;            /* stream type, for consistency */
  68         unsigned int    fccHandler;         /* compressor */
  69         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
  70         unsigned int    dwQuality;          /* compress quality 0-10,000 */
  71         unsigned int    dwBytesPerSecond;   /* bytes per second */
  72         unsigned int    dwFlags;            /* flags... see below */
  73         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
  74         unsigned int    pad;
  75
  76         char                    avicodecname[128];
  77 } AviCodecData;
  78
  79 typedef struct QuicktimeCodecData {
  80
  81         void                    *cdParms;                       /* codec/compressor options */
  82         void                    *pad;                           /* padding */
  83
  84         unsigned int    cdSize;                         /* size of cdParms buffer */
  85         unsigned int    pad2;                           /* padding */
  86
  87         char                    qtcodecname[128];
  88 } QuicktimeCodecData;
  89
  90 typedef struct AudioData {
  91         int mixrate;
  92         float main;             /* Main mix in dB */
  93         short flag;
  94         short pad[3];
  95 } AudioData;
  96
  97 typedef struct RenderData {
  98         struct AviCodecData *avicodecdata;
  99         struct QuicktimeCodecData *qtcodecdata;
 100
 101         short cfra, sfra, efra; /* fames as in 'images' */
 102         short images, framapto, flag;
 103         float ctime;                    /* use for calcutions */
 104         float framelen, blurfac;
 105
 106         /** For UR edge rendering: give the edges this colour */
 107         float edgeR, edgeG, edgeB;
 108
 109         short fullscreen, xplay, yplay, freqplay;       /* standalone player */
 110         short depth, attrib, rt1, rt2;                          /* standalone player */
 111
 112         short stereomode;                                       /* standalone player stereo settings */
 113
 114         short dimensionspreset;         /* for the dimensions presets menu */
 115
 116         short filtertype;                       /* filter is box, tent, gauss, mitch, etc */
 117
 118
 119         short size, maximsize;  /* size in %, max in Kb */
 120         /* from buttons: */
 121         /**
 122          * The desired number of pixels in the x direction
 123          */
 124         short xsch;
 125         /**
 126          * The desired number of pixels in the y direction
 127          */
 128         short ysch;
 129         /**
 130          * Adjustment factors for the aspect ratio in the x direction
 131          */
 132         short xasp;
 133         /**
 134          * Adjustment factors for the aspect ratio in the x direction
 135          */
 136         short yasp;
 137         /**
 138          * The number of part to use in the x direction
 139          */
 140         short xparts;
 141         /**
 142          * The number of part to use in the y direction
 143          */
 144         short yparts;
 145
 146         short winpos, planes, imtype, subimtype;
 147
 148         /** Mode bits:                                                           */
 149         /* 0: Enable backbuffering for images                                    */
 150         short bufflag;
 151         short quality;
 152
 153         /**
 154          * Flags for render settings. Use bit-masking to access the settings.
 155          * 0: enable sequence output rendering
 156          * 1: render daemon
 157          * 4: add extensions to filenames
 158          */
 159         short scemode;
 160
 161         /**
 162          * Flags for render settings. Use bit-masking to access the settings.
 163          * The bits have these meanings:
 164          * 0: do oversampling
 165          * 1: do shadows
 166          * 2: do gamma correction
 167          * 3: ortho (not used?)
 168          * 4: do envmap
 169          * 5: edge shading
 170          * 6: field rendering
 171          * 7: Disables time difference in field calculations
 172          * 8: radio rendering
 173          * 9: borders
 174          * 10: panorama
 175          * 11: crop
 176          * 12: save SGI movies with Cosmo hardware
 177          * 13: odd field first rendering
 178          * 14: motion blur
 179          * 15: use unified renderer for this pic
 180          * 16: enable raytracing
 181          * 17: gauss sampling for subpixels
 182          * 18: keep float buffer after render
 183          */
 184         int mode;
 185
 186         /* render engine, octree resolution */
 187         short renderer, ocres, rpad[2];
 188
 189         /**
 190          * What to do with the sky/background. Picks sky/premul/key
 191          * blending for the background
 192          */
 193         short alphamode;
 194         /**
 195          * Toggles whether to apply a gamma correction for subpixel to
 196          * pixel blending
 197          */
 198         short dogamma;
 199         /**
 200          * The number of samples to use per pixel.
 201          */
 202         short osa;
 203         short frs_sec, edgeint;
 204
 205         /** For unified renderer: reduce intensity on boundaries with
 206          * identical materials with this number.*/
 207         short same_mat_redux;
 208
 209         /* safety and border rect */
 210         rctf safety, border;
 211
 212         /**
 213          * The gamma for the normal rendering. Used when doing
 214          * oversampling, to correctly blend subpixels to pixels.  */
 215         float gamma, gauss;
 216         /** post-production settings. */
 217         float postmul, postgamma, postadd, postigamma, posthue, postsat;
 218
 219         /* Dither noise intensity */
 220         float dither_intensity;
 221
 222         /* Zblur settings */
 223         float zmin, focus, zgamma, zsigma, zblur;
 224
 225         /* yafray: global panel params. TODO: move elsewhere */
 226         short GIquality, GIcache, GImethod, GIphotons, GIdirect;
 227         short YF_AA, YFexportxml, YF_nobump, YF_clamprgb, yfpad1;
 228         int GIdepth, GIcausdepth, GIpixelspersample;
 229         int GIphotoncount, GImixphotons;
 230         float GIphotonradius;
 231         int YF_numprocs, YF_raydepth, YF_AApasses, YF_AAsamples;
 232         float GIshadowquality, GIrefinement, GIpower, GIindirpower;
 233         float YF_gamma, YF_exposure, YF_raybias, YF_AApixelsize, YF_AAthreshold;
 234
 235         char backbuf[160], pic[160], ftype[160];
 236
 237 } RenderData;
 238
 239
 240 typedef struct GameFraming {
 241         float col[3];
 242         char type, pad1, pad2, pad3;
 243 } GameFraming;
 244
 245 #define SCE_GAMEFRAMING_BARS   0
 246 #define SCE_GAMEFRAMING_EXTEND 1
 247 #define SCE_GAMEFRAMING_SCALE  2
 248
 249 typedef struct TimeMarker {
 250         struct TimeMarker *next, *prev;
 251         int frame;
 252         char name[64];
 253         unsigned int flag;
 254 } TimeMarker;
 255
 256 typedef struct ToolSettings {
 257         // Subdivide Settings
 258         short cornertype;
 259         short editbutflag;
 260         // Extrude Tools
 261         short degr;
 262         short step;
 263         short turn;
 264
 265         short pad1;
 266
 267         float extr_offs;
 268         float doublimit;
 269
 270         // Primitive Settings
 271         // UV Sphere
 272         short segments;
 273         short rings;
 274
 275         // Cylinder - Tube - Circle
 276         short vertices;
 277
 278         char pad2,pad3;
 279 } ToolSettings;
 280
 281 typedef struct Scene {
 282         ID id;
 283         struct Object *camera;
 284         struct World *world;
 285
 286         struct Scene *set;
 287         struct Image *ima;
 288
 289         ListBase base;
 290         struct Base *basact;
 291
 292         float cursor[3];
 293         float twcent[3];                        /* center for transform widget */
 294         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
 295         unsigned int lay;
 296
 297         /* editmode stuff */
 298         float editbutsize;                      /* size of normals */
 299         short selectmode;
 300         short proportional, prop_mode;
 301
 302         short use_nodes;
 303         struct bNodeTree *nodetree;
 304
 305         void *ed;
 306         struct Radio *radio;
 307         void *sumohandle;
 308
 309         struct GameFraming framing;
 310
 311         struct ToolSettings *toolsettings;
 312
 313         /* migrate or replace? depends on some internal things... */
 314         /* no, is on the right place (ton) */
 315         struct RenderData r;
 316         struct AudioData audio;
 317
 318         ScriptLink scriptlink;
 319
 320         ListBase markers;
 321
 322         /* none of the dependancy graph  vars is mean to be saved */
 323         struct  DagForest *theDag;
 324         short dagisvalid, dagflags;
 325         short dirty, recalc;                            /* recalc = counterpart of ob->recalc */
 326 } Scene;
 327
 328
 329 /* **************** RENDERDATA ********************* */
 330
 331 /* bufflag */
 332 #define R_BACKBUF               1
 333 #define R_BACKBUFANIM   2
 334 #define R_FRONTBUF              4
 335 #define R_FRONTBUFANIM  8
 336
 337 /* mode (int now) */
 338 #define R_OSA                   0x0001
 339 #define R_SHADOW                0x0002
 340 #define R_GAMMA                 0x0004
 341 #define R_ORTHO                 0x0008
 342 #define R_ENVMAP                0x0010
 343 #define R_EDGE                  0x0020
 344 #define R_FIELDS                0x0040
 345 #define R_FIELDSTILL    0x0080
 346 #define R_RADIO                 0x0100
 347 #define R_BORDER                0x0200
 348 #define R_PANORAMA              0x0400
 349 #define R_MOVIECROP             0x0800
 350 #define R_COSMO                 0x1000
 351 #define R_ODDFIELD              0x2000
 352 #define R_MBLUR                 0x4000
 353 #define R_UNIFIED       0x8000
 354 #define R_RAYTRACE      0x10000
 355                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
 356 #define R_GAUSS         0x20000
 357 #define R_FBUF                  0x40000
 358 #define R_THREADS               0x80000
 359 #define R_ZBLUR                 0x100000
 360
 361 /* filtertype */
 362 #define R_FILTER_BOX    0
 363 #define R_FILTER_TENT   1
 364 #define R_FILTER_QUAD   2
 365 #define R_FILTER_CUBIC  3
 366 #define R_FILTER_CATROM 4
 367 #define R_FILTER_GAUSS  5
 368 #define R_FILTER_MITCH  6
 369
 370 /* yafray: renderer flag (not only exclusive to yafray) */
 371 #define R_INTERN        0
 372 #define R_YAFRAY        1
 373
 374 /* scemode */
 375 #define R_DOSEQ                 0x0001
 376 #define R_BG_RENDER             0x0002
 377                 /* passepartout is camera option now, keep this for backward compatibility */
 378 #define R_PASSEPARTOUT  0x0004
 379
 380 #define R_EXTENSION             0x0010
 381 #define R_NODE_PREVIEW  0x0020
 382 #define R_DOCOMP                0x0040
 383
 384 /* alphamode */
 385 #define R_ADDSKY                0
 386 #define R_ALPHAPREMUL   1
 387 #define R_ALPHAKEY              2
 388
 389 /* planes */
 390 #define R_PLANES24              24
 391 #define R_PLANES32              32
 392 #define R_PLANESBW              8
 393
 394 /* imtype */
 395 #define R_TARGA         0
 396 #define R_IRIS          1
 397 #define R_HAMX          2
 398 #define R_FTYPE         3
 399 #define R_JPEG90        4
 400 #define R_MOVIE         5
 401 #define R_IRIZ          7
 402 #define R_RAWTGA        14
 403 #define R_AVIRAW        15
 404 #define R_AVIJPEG       16
 405 #define R_PNG           17
 406 #define R_AVICODEC      18
 407 #define R_QUICKTIME     19
 408 #define R_BMP           20
 409 #define R_RADHDR        21
 410 #define R_TIFF          22
 411 #define R_OPENEXR       23
 412
 413 /* subimtype, flag options for imtype */
 414 #define R_OPENEXR_HALF  1
 415 #define R_OPENEXR_ZBUF  2
 416
 417
 418 /* **************** SCENE ********************* */
 419 #define RAD_PHASE_PATCHES       1
 420 #define RAD_PHASE_FACES         2
 421
 422 /* base->flag is in DNA_object_types.h */
 423
 424 /* sce->flag */
 425 #define SCE_ADDSCENAME          1
 426
 427 /* sce->selectmode */
 428 #define SCE_SELECT_VERTEX       1
 429 #define SCE_SELECT_EDGE         2
 430 #define SCE_SELECT_FACE         4
 431
 432 /* sce->dirty */
 433 #define SCE_CLEAN           0
 434 #define SCE_DIRTY           1
 435
 436 /* sce->recalc (now in use by previewrender) */
 437 #define SCE_PRV_CHANGED         1
 438
 439 /* sce->prop_mode (proportional falloff) */
 440 #define PROP_SMOOTH            0
 441 #define PROP_SPHERE            1
 442 #define PROP_ROOT              2
 443 #define PROP_SHARP             3
 444 #define PROP_LIN               4
 445 #define PROP_CONST             5
 446
 447         /* return flag next_object function */
 448 #define F_START                 0
 449 #define F_SCENE                 1
 450 #define F_SET                   2
 451 #define F_DUPLI                 3
 452
 453 /* audio->flag */
 454 #define AUDIO_MUTE              1
 455 #define AUDIO_SYNC              2
 456 #define AUDIO_SCRUB             4
 457
 458
 459 #ifdef __cplusplus
 460 }
 461 #endif
 462
 463 #endif
 464