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