Sculpt: Fast Navigate option for multires. This will show the lowest multires
[blender-staging.git] / source / blender / makesdna / DNA_scene_types.h
1 /**
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef DNA_SCENE_TYPES_H
30 #define DNA_SCENE_TYPES_H
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 #include "DNA_brush_types.h"
37 #include "DNA_vec_types.h"
38 #include "DNA_listBase.h"
39 #include "DNA_ID.h"
40
41 struct Object;
42 struct World;
43 struct Scene;
44 struct Image;
45 struct Group;
46 struct Text;
47 struct bNodeTree;
48 struct AnimData;
49 struct Editing;
50 struct SceneStats;
51 struct bGPdata;
52
53 typedef struct Base {
54         struct Base *next, *prev;
55         unsigned int lay, selcol;
56         int flag;
57         short sx, sy;
58         struct Object *object;
59 } Base;
60
61 typedef struct AviCodecData {
62         void                    *lpFormat;  /* save format */
63         void                    *lpParms;   /* compressor options */
64         unsigned int    cbFormat;           /* size of lpFormat buffer */
65         unsigned int    cbParms;            /* size of lpParms buffer */
66
67         unsigned int    fccType;            /* stream type, for consistency */
68         unsigned int    fccHandler;         /* compressor */
69         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
70         unsigned int    dwQuality;          /* compress quality 0-10,000 */
71         unsigned int    dwBytesPerSecond;   /* bytes per second */
72         unsigned int    dwFlags;            /* flags... see below */
73         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
74         unsigned int    pad;
75
76         char                    avicodecname[128];
77 } AviCodecData;
78
79 typedef struct QuicktimeCodecData {
80
81         void                    *cdParms;   /* codec/compressor options */
82         void                    *pad;       /* padding */
83
84         unsigned int    cdSize;             /* size of cdParms buffer */
85         unsigned int    pad2;               /* padding */
86
87         char                    qtcodecname[128];
88 } QuicktimeCodecData;
89
90 typedef struct FFMpegCodecData {
91         int type;
92         int codec;
93         int audio_codec;
94         int video_bitrate;
95         int audio_bitrate;
96         int audio_mixrate;
97         float audio_volume;
98         int gop_size;
99         int flags;
100
101         int rc_min_rate;
102         int rc_max_rate;
103         int rc_buffer_size;
104         int mux_packet_size;
105         int mux_rate;
106         IDProperty *properties;
107 } FFMpegCodecData;
108
109
110 typedef struct AudioData {
111         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
112         float main; // 2.5: now in FFMpegCodecData: audio_volume
113         float speed_of_sound;
114         float doppler_factor;
115         int distance_model;
116         short flag;
117         short pad;
118 } AudioData;
119
120 typedef struct SceneRenderLayer {
121         struct SceneRenderLayer *next, *prev;
122         
123         char name[32];
124         
125         struct Material *mat_override;
126         struct Group *light_override;
127         
128         unsigned int lay;               /* scene->lay itself has priority over this */
129         unsigned int lay_zmask; /* has to be after lay, this is for Z-masking */
130         int layflag;
131         
132         int pad;
133         
134         int passflag;                   /* pass_xor has to be after passflag */
135         int pass_xor;
136 } SceneRenderLayer;
137
138 /* srl->layflag */
139 #define SCE_LAY_SOLID   1
140 #define SCE_LAY_ZTRA    2
141 #define SCE_LAY_HALO    4
142 #define SCE_LAY_EDGE    8
143 #define SCE_LAY_SKY             16
144 #define SCE_LAY_STRAND  32
145         /* flags between 32 and 0x8000 are set to 1 already, for future options */
146
147 #define SCE_LAY_ALL_Z           0x8000
148 #define SCE_LAY_XOR                     0x10000
149 #define SCE_LAY_DISABLE         0x20000
150 #define SCE_LAY_ZMASK           0x40000
151 #define SCE_LAY_NEG_ZMASK       0x80000
152
153 /* srl->passflag */
154 #define SCE_PASS_COMBINED       1
155 #define SCE_PASS_Z                      2
156 #define SCE_PASS_RGBA           4
157 #define SCE_PASS_DIFFUSE        8
158 #define SCE_PASS_SPEC           16
159 #define SCE_PASS_SHADOW         32
160 #define SCE_PASS_AO                     64
161 #define SCE_PASS_REFLECT        128
162 #define SCE_PASS_NORMAL         256
163 #define SCE_PASS_VECTOR         512
164 #define SCE_PASS_REFRACT        1024
165 #define SCE_PASS_INDEXOB        2048
166 #define SCE_PASS_UV                     4096
167 #define SCE_PASS_RADIO          8192 /* Radio removed, can use for new GI? */
168 #define SCE_PASS_MIST           16384
169
170 #define SCE_PASS_RAYHITS        32768
171
172 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
173
174
175 typedef struct RenderData {
176         
177         struct AviCodecData *avicodecdata;
178         struct QuicktimeCodecData *qtcodecdata;
179         struct FFMpegCodecData ffcodecdata;
180         
181         int cfra, sfra, efra;   /* frames as in 'images' */
182         int psfra, pefra;               /* start+end frames of preview range */
183
184         int images, framapto;
185         short flag, threads;
186
187         float ctime;                    /* use for calcutions */
188         float framelen, blurfac;
189
190         /** For UR edge rendering: give the edges this color */
191         float edgeR, edgeG, edgeB;
192         
193         short fullscreen, xplay, yplay, freqplay;       /* standalone player */  //  XXX deprecated since 2.5
194         short depth, attrib, rt2;                       /* standalone player */  //  XXX deprecated since 2.5
195         short frame_step;               /* frames to jump during render/playback */
196
197         short stereomode;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
198         
199         short dimensionspreset;         /* for the dimensions presets menu */
200         
201         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
202
203         short size, maximsize;  /* size in %, max in Kb */
204         /* from buttons: */
205         /**
206          * The desired number of pixels in the x direction
207          */
208         short xsch;
209         /**
210          * The desired number of pixels in the y direction
211          */
212         short ysch;
213         /**
214          * The number of part to use in the x direction
215          */
216         short xparts;
217         /**
218          * The number of part to use in the y direction
219          */
220         short yparts;
221         
222         short winpos, planes, imtype, subimtype;
223         
224         /** Mode bits:                                                           */
225         /* 0: Enable backbuffering for images                                    */
226         short bufflag;
227         short quality;
228         
229         /**
230          * Render to image editor, fullscreen or to new window.
231          */
232         short displaymode;
233         
234         short rpad1, rpad2;
235
236         /**
237          * Flags for render settings. Use bit-masking to access the settings.
238          */
239         int scemode;
240
241         /**
242          * Flags for render settings. Use bit-masking to access the settings.
243          */
244         int mode;
245
246         /**
247          * Flags for raytrace settings. Use bit-masking to access the settings.
248          */
249         int raytrace_options;
250         
251         /**
252          * Raytrace acceleration structure
253          */
254         short raytrace_structure;
255
256         /* renderer (deprecated) */
257         short renderer;
258
259         /* octree resolution */
260         short ocres;
261         short pad4;
262         
263         /**
264          * What to do with the sky/background. Picks sky/premul/key
265          * blending for the background
266          */
267         short alphamode;
268
269         /**
270          * The number of samples to use per pixel.
271          */
272         short osa;
273
274         short frs_sec, edgeint;
275
276         
277         /* safety, border and display rect */
278         rctf safety, border;
279         rcti disprect;
280         
281         /* information on different layers to be rendered */
282         ListBase layers;
283         short actlay, pad;
284         
285         /**
286          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
287          */
288         float xasp;
289         /**
290          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
291          */
292         float yasp;
293
294         float frs_sec_base;
295         
296         /**
297          * Value used to define filter size for all filter options  */
298         float gauss;
299         
300         
301         /* color management settings - color profiles, gamma correction, etc */
302         int color_mgt_flag;
303         
304         /** post-production settings. Depricated, but here for upwards compat (initialized to 1) */      
305         float postgamma, posthue, postsat;       
306         
307         /* Dither noise intensity */
308         float dither_intensity;
309         
310         /* Bake Render options */
311         short bake_osa, bake_filter, bake_mode, bake_flag;
312         short bake_normal_space, bake_quad_split;
313         float bake_maxdist, bake_biasdist, bake_pad;
314         
315         /* yafray: global panel params. TODO: move elsewhere */
316         short GIquality, GIcache, GImethod, GIphotons, GIdirect;
317         short YF_AA, YFexportxml, YF_nobump, YF_clamprgb, yfpad1;
318         int GIdepth, GIcausdepth, GIpixelspersample;
319         int GIphotoncount, GImixphotons;
320         float GIphotonradius;
321         int YF_raydepth, YF_AApasses, YF_AAsamples, yfpad2;
322         float GIshadowquality, GIrefinement, GIpower, GIindirpower;
323         float YF_gamma, YF_exposure, YF_raybias, YF_AApixelsize, YF_AAthreshold;
324
325         /* paths to backbufffer, output, ftype */
326         char backbuf[160], pic[160];
327
328         /* stamps flags. */
329         int stamp;
330         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
331
332         /* stamp info user data. */
333         char stamp_udata[160];
334
335         /* foreground/background color. */
336         float fg_stamp[4];
337         float bg_stamp[4];
338
339         /* render simplify */
340         int simplify_subsurf;
341         int simplify_shadowsamples;
342         float simplify_particles;
343         float simplify_aosss;
344
345         /* cineon */
346         short cineonwhite, cineonblack;
347         float cineongamma;
348         
349         /* jpeg2000 */
350         short jp2_preset, jp2_depth;
351         int rpad3;
352
353         /* Dome variables */ //  XXX deprecated since 2.5
354         short domeres, domemode;        //  XXX deprecated since 2.5
355         short domeangle, dometilt;      //  XXX deprecated since 2.5
356         float domeresbuf;       //  XXX deprecated since 2.5
357         float pad2;                     //  XXX deprecated since 2.5
358         struct Text *dometext;  //  XXX deprecated since 2.5
359
360         /* render engine */
361         char engine[32];
362 } RenderData;
363
364 /* control render convert and shading engine */
365 typedef struct RenderProfile {
366         struct RenderProfile *next, *prev;
367         char name[32];
368         
369         short particle_perc;
370         short subsurf_max;
371         short shadbufsample_max;
372         short pad1;
373         
374         float ao_error, pad2;
375         
376 } RenderProfile;
377
378 typedef struct GameDome {
379         short res, mode;
380         short angle, tilt;
381         float resbuf, pad2;
382         struct Text *warptext;
383 } GameDome;
384
385 #define DOME_FISHEYE                    1
386 #define DOME_TRUNCATED_FRONT    2
387 #define DOME_TRUNCATED_REAR             3
388 #define DOME_ENVMAP                             4
389 #define DOME_PANORAM_SPH                5
390 #define DOME_NUM_MODES                  6
391
392 typedef struct GameFraming {
393         float col[3];
394         char type, pad1, pad2, pad3;
395 } GameFraming;
396
397 #define SCE_GAMEFRAMING_BARS   0
398 #define SCE_GAMEFRAMING_EXTEND 1
399 #define SCE_GAMEFRAMING_SCALE  2
400
401 typedef struct GameData {
402
403         /* physics (it was in world)*/
404         float gravity; /*Gravitation constant for the game world*/
405
406         /*
407          * Radius of the activity bubble, in Manhattan length. Objects
408          * outside the box are activity-culled. */
409         float activityBoxRadius; //it's not being used ANYWHERE !!!!!!!!!!!!!!
410         /*
411          * bit 3: (gameengine): Activity culling is enabled.
412          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustrum culling
413         */
414         short mode, flag, matmode, pad[3];
415         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
416         short physicsEngine;
417         short ticrate, maxlogicstep, physubstep, maxphystep;
418
419         /*  standalone player */
420         struct GameFraming framing;
421         short fullscreen, xplay, yplay, freqplay;
422         short depth, attrib, rt1, rt2;
423
424         /* stereo/dome mode */
425         struct GameDome dome;
426         short stereoflag, stereomode, xsch, ysch; //xsch and ysch can be deleted !!!
427 } GameData;
428
429 #define STEREO_NOSTEREO         1
430 #define STEREO_ENABLED          2
431 #define STEREO_DOME                     3
432
433 //#define STEREO_NOSTEREO                1
434 #define STEREO_QUADBUFFERED 2
435 #define STEREO_ABOVEBELOW        3
436 #define STEREO_INTERLACED        4
437 #define STEREO_ANAGLYPH         5
438 #define STEREO_SIDEBYSIDE       6
439 #define STEREO_VINTERLACE       7
440 //#define STEREO_DOME           8
441
442 /* physicsEngine */
443 #define WOPHY_NONE              0
444 #define WOPHY_ENJI              1
445 #define WOPHY_SUMO              2
446 #define WOPHY_DYNAMO    3
447 #define WOPHY_ODE               4
448 #define WOPHY_BULLET    5
449
450 /* GameData.flag */
451 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
452 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
453 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
454 #define GAME_SHOW_PHYSICS                                       (1 << 4)
455 #define GAME_DISPLAY_LISTS                                      (1 << 5)
456 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
457 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
458 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
459 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
460 #define GAME_GLSL_NO_NODES                                      (1 << 10)
461 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
462 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
463
464 /* GameData.matmode */
465 #define GAME_MAT_TEXFACE        0
466 #define GAME_MAT_MULTITEX       1
467 #define GAME_MAT_GLSL           2
468
469 typedef struct TimeMarker {
470         struct TimeMarker *next, *prev;
471         int frame;
472         char name[64];
473         unsigned int flag;
474 } TimeMarker;
475
476 typedef struct Paint {
477         /* Array of brushes selected for use in this paint mode */
478         Brush **brushes;
479         int active_brush_index, brush_count;
480         
481         /* WM Paint cursor */
482         void *paint_cursor;
483         unsigned char paint_cursor_col[4];
484
485         int flags;
486 } Paint;
487
488 typedef struct ImagePaintSettings {
489         Paint paint;
490
491         short flag, tool;
492         
493         /* for projection painting only */
494         short seam_bleed, normal_angle;
495
496         void *paintcursor;                      /* wm handle */
497 } ImagePaintSettings;
498
499 typedef struct ParticleBrushData {
500         short size, strength;   /* common settings */
501         short step, invert;             /* for specific brushes only */
502 } ParticleBrushData;
503
504 typedef struct ParticleEditSettings {
505         short flag;
506         short totrekey;
507         short totaddkey;
508         short brushtype;
509
510         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
511         void *paintcursor;                      /* runtime */
512
513         float emitterdist, rt;
514
515         int selectmode;
516         int edittype;
517
518         int draw_step, fade_frames;
519
520         struct Scene *scene;
521         struct Object *object;
522 } ParticleEditSettings;
523
524 typedef struct TransformOrientation {
525         struct TransformOrientation *next, *prev;
526         char name[36];
527         float mat[3][3];
528 } TransformOrientation;
529
530 typedef struct Sculpt {
531         Paint paint;
532
533         /* For rotating around a pivot point */
534         float pivot[3];
535         int flags;
536
537         /* Control tablet input */
538         char tablet_size, tablet_strength;
539         char pad[6];
540 } Sculpt;
541
542 typedef struct VPaint {
543         Paint paint;
544
545         float gamma, mul;                       /* should become part of struct Brush? */
546         short mode, flag;
547         int tot;                                                        /* allocation size of prev buffers */
548         unsigned int *vpaint_prev;                      /* previous mesh colors */
549         struct MDeformVert *wpaint_prev;        /* previous vertex weights */
550         
551         void *paintcursor;                                      /* wm handle */
552 } VPaint;
553
554 /* VPaint flag */
555 #define VP_COLINDEX     1
556 #define VP_AREA         2
557 #define VP_SOFT         4
558 #define VP_NORMALS      8
559 #define VP_SPRAY        16
560 // #define VP_MIRROR_X  32 // depricated in 2.5x use (me->editflag & ME_EDIT_MIRROR_X)
561 #define VP_HARD         64
562 #define VP_ONLYVGROUP   128
563
564
565 typedef struct ToolSettings {
566         VPaint *vpaint;         /* vertex paint */
567         VPaint *wpaint;         /* weight paint */
568         Sculpt *sculpt;
569         
570         /* Vertex groups */
571         float vgroup_weight;
572
573         /* Subdivide Settings */
574         short cornertype;
575         short editbutflag;
576         /*Triangle to Quad conversion threshold*/
577         float jointrilimit;
578         /* Editmode Tools */
579         float degr; 
580         short step;
581         short turn; 
582         
583         float extr_offs;        /* extrude offset */
584         float doublimit;        /* remove doubles limit */
585         float normalsize;       /* size of normals */
586         short automerge;
587
588         /* Selection Mode for Mesh */
589         short selectmode;
590
591         /* Primitive Settings */
592         /* UV Sphere */
593         short segments;
594         short rings;
595         
596         /* Cylinder - Tube - Circle */
597         short vertices;
598
599         /* UV Calculation */
600         short unwrapper;
601         float uvcalc_radius;
602         float uvcalc_cubesize;
603         float uvcalc_margin;
604         short uvcalc_mapdir;
605         short uvcalc_mapalign;
606         short uvcalc_flag;
607         short uv_flag, uv_selectmode;
608         short uv_pad[2];
609
610         /* Auto-IK */
611         short autoik_chainlen;
612
613         /* Image Paint (8 byttse aligned please!) */
614         struct ImagePaintSettings imapaint;
615
616         /* Particle Editing */
617         struct ParticleEditSettings particle;
618         
619         /* Transform Proportional Area of Effect */
620         float proportional_size;
621
622         /* Select Group Threshold */
623         float select_thresh;
624         
625         /* Graph Editor */
626         float clean_thresh;
627
628         /* Auto-Keying Mode */
629         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
630         
631         /* Retopo */
632         char retopo_mode;
633         char retopo_paint_tool;
634         char line_div, ellipse_div, retopo_hotspot;
635
636         /* Multires */
637         char multires_subdiv_type;
638         
639         /* Skeleton generation */
640         short skgen_resolution;
641         float skgen_threshold_internal;
642         float skgen_threshold_external;
643         float skgen_length_ratio;
644         float skgen_length_limit;
645         float skgen_angle_limit;
646         float skgen_correlation_limit;
647         float skgen_symmetry_limit;
648         float skgen_retarget_angle_weight;
649         float skgen_retarget_length_weight;
650         float skgen_retarget_distance_weight;
651         short skgen_options;
652         char  skgen_postpro;
653         char  skgen_postpro_passes;
654         char  skgen_subdivisions[3];
655         char  skgen_multi_level;
656         
657         /* Skeleton Sketching */
658         struct Object *skgen_template;
659         char bone_sketching;
660         char bone_sketching_convert;
661         char skgen_subdivision_number;
662         char skgen_retarget_options;
663         char skgen_retarget_roll;
664         char skgen_side_string[8];
665         char skgen_num_string[8];
666         
667         /* Alt+RMB option */
668         char edge_mode;
669
670         /* Transform */
671         short snap_mode, snap_flag, snap_target;
672         short proportional, prop_mode;
673
674         int auto_normalize, intpad; /*auto normalizing mode in wpaint*/
675 } ToolSettings;
676
677 typedef struct bStats {
678         /* scene totals for visible layers */
679         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
680         int totvert, totface;
681 } bStats;
682
683 typedef struct UnitSettings {
684         /* Display/Editing unit options for each scene */
685         float scale_length; /* maybe have other unit conversions? */
686         short system;
687         short flag; /* imperial, metric etc */
688 } UnitSettings;
689
690 typedef struct PhysicsSettings {
691         float gravity[3];
692         int flag;
693 } PhysicsSettings;
694
695 typedef struct Scene {
696         ID id;
697         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
698         
699         struct Object *camera;
700         struct World *world;
701         
702         struct Scene *set;
703         struct Image *ima;
704         
705         ListBase base;
706         struct Base *basact;            /* active base */
707         struct Object *obedit;          /* name replaces old G.obedit */
708         
709         float cursor[3];                        /* 3d cursor location */
710         float twcent[3];                        /* center for transform widget */
711         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
712         unsigned int lay;
713         
714
715         short flag;                                                             /* various settings */
716         
717         short use_nodes;
718         
719         struct bNodeTree *nodetree;     
720         
721         struct Editing *ed;                                                             /* sequence editor data is allocated here */
722         
723         struct ToolSettings *toolsettings;              /* default allocated now */
724         struct SceneStats *stats;                               /* default allocated now */
725
726         /* migrate or replace? depends on some internal things... */
727         /* no, is on the right place (ton) */
728         struct RenderData r;
729         struct AudioData audio;
730         
731         ListBase markers;
732         ListBase transform_spaces;
733         
734         ListBase sound_handles;
735         
736         /* none of the dependancy graph  vars is mean to be saved */
737         struct  DagForest *theDag;
738         short dagisvalid, dagflags;
739         short recalc;                           /* recalc = counterpart of ob->recalc */
740
741         short jumpframe;
742         int pad5;
743
744         /* User-Defined KeyingSets */
745         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
746         ListBase keyingsets;                    /* KeyingSets for the given frame */
747         
748         /* Game Settings */
749         struct GameFraming framing; // XXX  deprecated since 2.5
750         struct GameData gm;
751
752         /* Units */
753         struct UnitSettings unit;
754         
755         /* Grease Pencil */
756         struct bGPdata *gpd;
757
758         /* Physics simulation settings */
759         struct PhysicsSettings physics_settings;
760 } Scene;
761
762
763 /* **************** RENDERDATA ********************* */
764
765 /* bufflag */
766 #define R_BACKBUF               1
767 #define R_BACKBUFANIM   2
768 #define R_FRONTBUF              4
769 #define R_FRONTBUFANIM  8
770
771 /* mode (int now) */
772 #define R_OSA                   0x0001
773 #define R_SHADOW                0x0002
774 #define R_GAMMA                 0x0004
775 #define R_ORTHO                 0x0008
776 #define R_ENVMAP                0x0010
777 #define R_EDGE                  0x0020
778 #define R_FIELDS                0x0040
779 #define R_FIELDSTILL    0x0080
780 #define R_RADIO                 0x0100
781 #define R_BORDER                0x0200
782 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
783 #define R_CROP                  0x0800
784 #define R_COSMO                 0x1000
785 #define R_ODDFIELD              0x2000
786 #define R_MBLUR                 0x4000
787                 /* unified was here */
788 #define R_RAYTRACE      0x10000
789                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
790 #define R_GAUSS         0x20000
791                 /* fbuf obsolete... */
792 #define R_FBUF                  0x40000
793                 /* threads obsolete... is there for old files, now use for autodetect threads */
794 #define R_THREADS               0x80000
795                 /* Use the same flag for autothreads */
796 #define R_FIXED_THREADS         0x80000 
797
798 #define R_SPEED                 0x100000
799 #define R_SSS                   0x200000
800 #define R_NO_OVERWRITE  0x400000 /* skip existing files */
801 #define R_TOUCH                 0x800000 /* touch files before rendering */
802 #define R_SIMPLIFY              0x1000000
803
804 /* displaymode */
805
806 #define R_OUTPUT_SCREEN 0
807 #define R_OUTPUT_AREA   1
808 #define R_OUTPUT_WINDOW 2
809 #define R_OUTPUT_FORKED 3
810
811 /* filtertype */
812 #define R_FILTER_BOX    0
813 #define R_FILTER_TENT   1
814 #define R_FILTER_QUAD   2
815 #define R_FILTER_CUBIC  3
816 #define R_FILTER_CATROM 4
817 #define R_FILTER_GAUSS  5
818 #define R_FILTER_MITCH  6
819 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
820
821 /* yafray: renderer flag (not only exclusive to yafray) */
822 #define R_INTERN        0
823 #define R_YAFRAY        1
824
825 /* raytrace structure */
826 #define R_RAYSTRUCTURE_AUTO                             0
827 #define R_RAYSTRUCTURE_OCTREE                   1
828 #define R_RAYSTRUCTURE_BLIBVH                   2
829 #define R_RAYSTRUCTURE_VBVH                             3
830 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
831 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
832
833 /* raytrace_options */
834 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
835 #define R_RAYTRACE_USE_INSTANCES                0x0002
836
837 /* scemode (int now) */
838 #define R_DOSEQ                         0x0001
839 #define R_BG_RENDER                     0x0002
840                 /* passepartout is camera option now, keep this for backward compatibility */
841 #define R_PASSEPARTOUT          0x0004
842 #define R_PREVIEWBUTS           0x0008
843 #define R_EXTENSION                     0x0010
844 #define R_MATNODE_PREVIEW       0x0020
845 #define R_DOCOMP                        0x0040
846 #define R_COMP_CROP                     0x0080
847 #define R_FREE_IMAGE            0x0100
848 #define R_SINGLE_LAYER          0x0200
849 #define R_EXR_TILE_FILE         0x0400
850 #define R_COMP_FREE                     0x0800
851 #define R_NO_IMAGE_LOAD         0x1000
852 #define R_NO_TEX                        0x2000
853 #define R_STAMP_INFO            0x4000  /* deprecated */
854 #define R_FULL_SAMPLE           0x8000
855 #define R_COMP_RERENDER         0x10000
856 #define R_RECURS_PROTECTION     0x20000
857 #define R_TEXNODE_PREVIEW       0x40000
858
859 /* r->stamp */
860 #define R_STAMP_TIME    0x0001
861 #define R_STAMP_FRAME   0x0002
862 #define R_STAMP_DATE    0x0004
863 #define R_STAMP_CAMERA  0x0008
864 #define R_STAMP_SCENE   0x0010
865 #define R_STAMP_NOTE    0x0020
866 #define R_STAMP_DRAW    0x0040 /* draw in the image */
867 #define R_STAMP_MARKER  0x0080
868 #define R_STAMP_FILENAME        0x0100
869 #define R_STAMP_SEQSTRIP        0x0200
870 #define R_STAMP_RENDERTIME      0x0400
871 #define R_STAMP_ALL             (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE|R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|R_STAMP_RENDERTIME)
872
873 /* alphamode */
874 #define R_ADDSKY                0
875 #define R_ALPHAPREMUL   1
876 #define R_ALPHAKEY              2
877
878 /* planes */
879 #define R_PLANES24              24
880 #define R_PLANES32              32
881 #define R_PLANESBW              8
882
883 /* color_mgt_flag */
884 #define R_COLOR_MANAGEMENT      1
885
886 /* imtype */
887 #define R_TARGA         0
888 #define R_IRIS          1
889 #define R_HAMX          2
890 #define R_FTYPE         3 /* ftype is nomore */
891 #define R_JPEG90        4
892 #define R_MOVIE         5
893 #define R_IRIZ          7
894 #define R_RAWTGA        14
895 #define R_AVIRAW        15
896 #define R_AVIJPEG       16
897 #define R_PNG           17
898 #define R_AVICODEC      18
899 #define R_QUICKTIME 19
900 #define R_BMP           20
901 #define R_RADHDR        21
902 #define R_TIFF          22
903 #define R_OPENEXR       23
904 #define R_FFMPEG        24
905 #define R_FRAMESERVER   25
906 #define R_CINEON                26
907 #define R_DPX                   27
908 #define R_MULTILAYER    28
909 #define R_DDS                   29
910 #define R_JP2                   30
911 #define R_H264          31
912 #define R_XVID          32
913 #define R_THEORA        33
914
915 /* subimtype, flag options for imtype */
916 #define R_OPENEXR_HALF  1
917 #define R_OPENEXR_ZBUF  2
918 #define R_PREVIEW_JPG   4
919 #define R_CINEON_LOG    8
920 #define R_TIFF_16BIT    16
921
922 #define R_JPEG2K_12BIT  32 /* Jpeg2000 */
923 #define R_JPEG2K_16BIT  64
924 #define R_JPEG2K_YCC    128 /* when disabled use RGB */
925 #define R_JPEG2K_CINE_PRESET    256
926 #define R_JPEG2K_CINE_48FPS             512
927
928
929 /* bake_mode: same as RE_BAKE_xxx defines */
930 /* bake_flag: */
931 #define R_BAKE_CLEAR            1
932 #define R_BAKE_OSA                      2
933 #define R_BAKE_TO_ACTIVE        4
934 #define R_BAKE_NORMALIZE        8
935
936 /* bake_normal_space */
937 #define R_BAKE_SPACE_CAMERA      0
938 #define R_BAKE_SPACE_WORLD       1
939 #define R_BAKE_SPACE_OBJECT      2
940 #define R_BAKE_SPACE_TANGENT 3
941
942 /* **************** SCENE ********************* */
943
944 /* for general use */
945 #define MAXFRAME        300000
946 #define MAXFRAMEF       300000.0f
947
948 #define MINFRAME        1
949 #define MINFRAMEF       1.0f
950
951 /* (minimum frame number for current-frame) */
952 #define MINAFRAME       -300000
953 #define MINAFRAMEF      -300000.0f
954
955 /* depricate this! */
956 #define TESTBASE(v3d, base)     ( ((base)->flag & SELECT) && ((base)->lay & v3d->lay) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0) )
957 #define TESTBASELIB(v3d, base)  ( ((base)->flag & SELECT) && ((base)->lay & v3d->lay) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
958 #define TESTBASELIB_BGMODE(v3d, scene, base)   ( ((base)->flag & SELECT) && ((base)->lay & (v3d ? v3d->lay : scene->lay)) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
959 #define BASE_EDITABLE_BGMODE(v3d, scene, base)   (((base)->lay & (v3d ? v3d->lay : scene->lay)) && ((base)->object->id.lib==0) && (((base)->object->restrictflag & OB_RESTRICT_VIEW)==0))
960 #define BASE_SELECTABLE(v3d, base)       ((base->lay & v3d->lay) && (base->object->restrictflag & (OB_RESTRICT_SELECT|OB_RESTRICT_VIEW))==0)
961 #define FIRSTBASE               scene->base.first
962 #define LASTBASE                scene->base.last
963 #define BASACT                  (scene->basact)
964 #define OBACT                   (BASACT? BASACT->object: 0)
965
966 #define ID_NEW(a)               if( (a) && (a)->id.newid ) (a)= (void *)(a)->id.newid
967 #define ID_NEW_US(a)    if( (a)->id.newid) {(a)= (void *)(a)->id.newid; (a)->id.us++;}
968 #define ID_NEW_US2(a)   if( ((ID *)a)->newid) {(a)= ((ID *)a)->newid; ((ID *)a)->us++;}
969 #define CFRA                    (scene->r.cfra)
970 #define F_CFRA                  ((float)(scene->r.cfra))
971 #define SFRA                    (scene->r.sfra)
972 #define EFRA                    (scene->r.efra)
973 #define PSFRA                   ((scene->r.psfra != 0)? (scene->r.psfra): (scene->r.sfra))
974 #define PEFRA                   ((scene->r.psfra != 0)? (scene->r.pefra): (scene->r.efra))
975 #define FRA2TIME(a)           ((((double) scene->r.frs_sec_base) * (a)) / scene->r.frs_sec)
976 #define TIME2FRA(a)           ((((double) scene->r.frs_sec) * (a)) / scene->r.frs_sec_base)
977 #define FPS                     (((double) scene->r.frs_sec) / scene->r.frs_sec_base)
978
979 #define RAD_PHASE_PATCHES       1
980 #define RAD_PHASE_FACES         2
981
982 /* base->flag is in DNA_object_types.h */
983
984 /* toolsettings->snap_flag */
985 #define SCE_SNAP                                1
986 #define SCE_SNAP_ROTATE                 2
987 #define SCE_SNAP_PEEL_OBJECT    4
988 #define SCE_SNAP_PROJECT                8
989 /* toolsettings->snap_target */
990 #define SCE_SNAP_TARGET_CLOSEST 0
991 #define SCE_SNAP_TARGET_CENTER  1
992 #define SCE_SNAP_TARGET_MEDIAN  2
993 #define SCE_SNAP_TARGET_ACTIVE  3
994 /* toolsettings->snap_mode */
995 #define SCE_SNAP_MODE_VERTEX    0
996 #define SCE_SNAP_MODE_EDGE              1
997 #define SCE_SNAP_MODE_FACE              2
998 #define SCE_SNAP_MODE_VOLUME    3
999
1000 /* toolsettings->selectmode */
1001 #define SCE_SELECT_VERTEX       1 /* for mesh */
1002 #define SCE_SELECT_EDGE         2
1003 #define SCE_SELECT_FACE         4
1004
1005 /* toolsettings->particle.selectmode for particles */
1006 #define SCE_SELECT_PATH         1
1007 #define SCE_SELECT_POINT        2
1008 #define SCE_SELECT_END          4
1009
1010 /* sce->recalc (now in use by previewrender) */
1011 #define SCE_PRV_CHANGED         1
1012
1013 /* toolsettings->prop_mode (proportional falloff) */
1014 #define PROP_SMOOTH            0
1015 #define PROP_SPHERE            1
1016 #define PROP_ROOT              2
1017 #define PROP_SHARP             3
1018 #define PROP_LIN               4
1019 #define PROP_CONST             5
1020 #define PROP_RANDOM             6
1021
1022 /* toolsettings->proportional */
1023 #define PROP_EDIT_OFF                   0
1024 #define PROP_EDIT_ON                    1
1025 #define PROP_EDIT_CONNECTED     2
1026
1027 /* sce->flag */
1028 #define SCE_DS_SELECTED                 (1<<0)
1029 #define SCE_DS_COLLAPSED                (1<<1)
1030 #define SCE_NLA_EDIT_ON                 (1<<2)
1031
1032
1033         /* return flag next_object function */
1034 #define F_ERROR                 -1
1035 #define F_START                 0
1036 #define F_SCENE                 1
1037 #define F_SET                   2
1038 #define F_DUPLI                 3
1039
1040 /* audio->flag */
1041 #define AUDIO_MUTE              1
1042 #define AUDIO_SYNC              2
1043 #define AUDIO_SCRUB             4
1044
1045 #define FFMPEG_MULTIPLEX_AUDIO  1
1046 #define FFMPEG_AUTOSPLIT_OUTPUT 2
1047
1048 /* Paint.flags */
1049 typedef enum {
1050         PAINT_SHOW_BRUSH = 1,
1051         PAINT_FAST_NAVIGATE = 2
1052 } PaintFlags;
1053
1054 /* Sculpt.flags */
1055 /* These can eventually be moved to paint flags? */
1056 typedef enum SculptFlags {
1057         SCULPT_SYMM_X = 1,
1058         SCULPT_SYMM_Y = 2,
1059         SCULPT_SYMM_Z = 4,
1060         SCULPT_LOCK_X = 64,
1061         SCULPT_LOCK_Y = 128,
1062         SCULPT_LOCK_Z = 256
1063 } SculptFlags;
1064
1065 /* ImagePaintSettings.flag */
1066 #define IMAGEPAINT_DRAWING                              1
1067 #define IMAGEPAINT_DRAW_TOOL                    2
1068 #define IMAGEPAINT_DRAW_TOOL_DRAWING    4
1069 /* projection painting only */
1070 #define IMAGEPAINT_PROJECT_DISABLE              8       /* Non projection 3D painting */
1071 #define IMAGEPAINT_PROJECT_XRAY                 16
1072 #define IMAGEPAINT_PROJECT_BACKFACE             32
1073 #define IMAGEPAINT_PROJECT_FLAT                 64
1074 #define IMAGEPAINT_PROJECT_LAYER_CLONE  128
1075 #define IMAGEPAINT_PROJECT_LAYER_MASK   256
1076 #define IMAGEPAINT_PROJECT_LAYER_MASK_INV       512
1077
1078 /* toolsettings->uvcalc_flag */
1079 #define UVCALC_FILLHOLES                        1
1080 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
1081 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
1082
1083 /* toolsettings->uv_flag */
1084 #define UV_SYNC_SELECTION       1
1085 #define UV_SHOW_SAME_IMAGE      2
1086
1087 /* toolsettings->uv_selectmode */
1088 #define UV_SELECT_VERTEX        1
1089 #define UV_SELECT_EDGE          2
1090 #define UV_SELECT_FACE          4
1091 #define UV_SELECT_ISLAND        8
1092
1093 /* toolsettings->edge_mode */
1094 #define EDGE_MODE_SELECT                                0
1095 #define EDGE_MODE_TAG_SEAM                              1
1096 #define EDGE_MODE_TAG_SHARP                             2
1097 #define EDGE_MODE_TAG_CREASE                    3
1098 #define EDGE_MODE_TAG_BEVEL                             4
1099
1100 /* toolsettings->particle flag */
1101 #define PE_KEEP_LENGTHS                 1
1102 #define PE_LOCK_FIRST                   2
1103 #define PE_DEFLECT_EMITTER              4
1104 #define PE_INTERPOLATE_ADDED    8
1105 #define PE_DRAW_PART                    16
1106 #define PE_X_MIRROR                             64
1107 #define PE_FADE_TIME                    128
1108 #define PE_AUTO_VELOCITY                256
1109
1110 /* toolsetting->particle brushtype */
1111 #define PE_BRUSH_NONE           -1
1112 #define PE_BRUSH_COMB           0
1113 #define PE_BRUSH_CUT            1
1114 #define PE_BRUSH_LENGTH         2
1115 #define PE_BRUSH_PUFF           3
1116 #define PE_BRUSH_ADD            4
1117 #define PE_BRUSH_SMOOTH         5
1118
1119 /* this must equal ParticleEditSettings.brush array size */
1120 #define PE_TOT_BRUSH            6
1121
1122 /* tooksettings->particle edittype */
1123 #define PE_TYPE_PARTICLES       0
1124 #define PE_TYPE_SOFTBODY        1
1125 #define PE_TYPE_CLOTH           2
1126
1127 /* toolsettings->retopo_mode */
1128 #define RETOPO 1
1129 #define RETOPO_PAINT 2
1130
1131 /* toolsettings->retopo_paint_tool */
1132 #define RETOPO_PEN 1
1133 #define RETOPO_LINE 2
1134 #define RETOPO_ELLIPSE 4
1135
1136 /* toolsettings->skgen_options */
1137 #define SKGEN_FILTER_INTERNAL   (1 << 0)
1138 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
1139 #define SKGEN_SYMMETRY                  (1 << 2)
1140 #define SKGEN_CUT_LENGTH                (1 << 3)
1141 #define SKGEN_CUT_ANGLE                 (1 << 4)
1142 #define SKGEN_CUT_CORRELATION   (1 << 5)
1143 #define SKGEN_HARMONIC                  (1 << 6)
1144 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
1145 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
1146 #define SKGEN_FILTER_SMART              (1 << 9)
1147 #define SKGEN_DISP_LENGTH               (1 << 10)
1148 #define SKGEN_DISP_WEIGHT               (1 << 11)
1149 #define SKGEN_DISP_ORIG                 (1 << 12)
1150 #define SKGEN_DISP_EMBED                (1 << 13)
1151 #define SKGEN_DISP_INDEX                (1 << 14)
1152
1153 #define SKGEN_SUB_LENGTH                0
1154 #define SKGEN_SUB_ANGLE                 1
1155 #define SKGEN_SUB_CORRELATION   2
1156 #define SKGEN_SUB_TOTAL                 3
1157
1158 /* toolsettings->skgen_postpro */
1159 #define SKGEN_SMOOTH                    0
1160 #define SKGEN_AVERAGE                   1
1161 #define SKGEN_SHARPEN                   2
1162
1163 /* toolsettings->bone_sketching */
1164 #define BONE_SKETCHING                  1
1165 #define BONE_SKETCHING_QUICK    2
1166 #define BONE_SKETCHING_ADJUST   4
1167
1168 /* toolsettings->bone_sketching_convert */
1169 #define SK_CONVERT_CUT_FIXED                    0
1170 #define SK_CONVERT_CUT_LENGTH                   1
1171 #define SK_CONVERT_CUT_ADAPTATIVE               2
1172 #define SK_CONVERT_RETARGET                             3
1173
1174 /* toolsettings->skgen_retarget_options */
1175 #define SK_RETARGET_AUTONAME                    1
1176
1177 /* toolsettings->skgen_retarget_roll */
1178 #define SK_RETARGET_ROLL_NONE                   0
1179 #define SK_RETARGET_ROLL_VIEW                   1
1180 #define SK_RETARGET_ROLL_JOINT                  2
1181
1182 /* physics_settings->flag */
1183 #define PHYS_GLOBAL_GRAVITY             1
1184
1185 /* UnitSettings */
1186
1187 /* UnitSettings->system */
1188 #define USER_UNIT_NONE                  0
1189 #define USER_UNIT_METRIC                1
1190 #define USER_UNIT_IMPERIAL              2
1191 /* UnitSettings->flag */
1192 #define USER_UNIT_OPT_SPLIT             1
1193
1194
1195 #ifdef __cplusplus
1196 }
1197 #endif
1198
1199 #endif