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