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