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