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