3D Audio GSoC:
[blender-staging.git] / source / blender / makesdna / DNA_anim_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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * Contributor(s): Joshua Leung (full recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef DNA_ANIM_TYPES_H
29 #define DNA_ANIM_TYPES_H
30
31 /** \file DNA_anim_types.h
32  *  \ingroup DNA
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "DNA_ID.h"
40 #include "DNA_listBase.h"
41 #include "DNA_action_types.h"
42 #include "DNA_curve_types.h"
43
44 /* ************************************************ */
45 /* F-Curve DataTypes */
46
47 /* Modifiers -------------------------------------- */
48
49 /* F-Curve Modifiers (fcm) 
50  *
51  * These alter the way F-Curves behave, by altering the value that is returned
52  * when evaluating the curve's data at some time (t). 
53  */
54 typedef struct FModifier {
55         struct FModifier *next, *prev;
56         
57         void *data;                     /* pointer to modifier data */
58         void *edata;            /* pointer to temporary data used during evaluation */
59         
60         char name[64];          /* user-defined description for the modifier */
61         short type;                     /* type of f-curve modifier */
62         short flag;                     /* settings for the modifier */
63         
64         float influence;        /* the amount that the modifier should influence the value */
65         
66         float sfra;                     /* start frame of restricted frame-range */
67         float efra;                     /* end frame of restricted frame-range */
68         float blendin;          /* number of frames from sfra before modifier takes full influence */
69         float blendout;         /* number of frames from efra before modifier fades out */
70 } FModifier;
71
72 /* Types of F-Curve modifier 
73  * WARNING: order here is important!
74  */
75 typedef enum eFModifier_Types {
76         FMODIFIER_TYPE_NULL = 0,
77         FMODIFIER_TYPE_GENERATOR,
78         FMODIFIER_TYPE_FN_GENERATOR,
79         FMODIFIER_TYPE_ENVELOPE,
80         FMODIFIER_TYPE_CYCLES,
81         FMODIFIER_TYPE_NOISE,
82         FMODIFIER_TYPE_FILTER,          /* unimplemented - for applying: fft, high/low pass filters, etc. */
83         FMODIFIER_TYPE_PYTHON,  
84         FMODIFIER_TYPE_LIMITS,
85         FMODIFIER_TYPE_STEPPED,
86         
87         /* NOTE: all new modifiers must be added above this line */
88         FMODIFIER_NUM_TYPES
89 } eFModifier_Types;
90
91 /* F-Curve Modifier Settings */
92 typedef enum eFModifier_Flags {
93                 /* modifier is not able to be evaluated for some reason, and should be skipped (internal) */
94         FMODIFIER_FLAG_DISABLED          = (1<<0),
95                 /* modifier's data is expanded (in UI) */
96         FMODIFIER_FLAG_EXPANDED          = (1<<1),
97                 /* modifier is active one (in UI) for editing purposes */
98         FMODIFIER_FLAG_ACTIVE            = (1<<2),
99                 /* user wants modifier to be skipped */
100         FMODIFIER_FLAG_MUTED             = (1<<3),
101                 /* restrict range that F-Modifier can be considered over */
102         FMODIFIER_FLAG_RANGERESTRICT = (1<<4),
103                 /* use influence control */
104         FMODIFIER_FLAG_USEINFLUENCE  = (1<<5)
105 } eFModifier_Flags; 
106
107 /* --- */
108
109 /* Generator modifier data */
110 typedef struct FMod_Generator {
111                 /* general generator information */
112         float *coefficients;            /* coefficients array */
113         unsigned int arraysize;         /* size of the coefficients array */
114         
115         int poly_order;                         /* order of polynomial generated (i.e. 1 for linear, 2 for quadratic) */
116         int mode;                                       /* which 'generator' to use eFMod_Generator_Modes */
117         
118                 /* settings */
119         int flag;                                       /* settings */
120 } FMod_Generator;
121
122 /* generator modes */
123 typedef enum eFMod_Generator_Modes {
124         FCM_GENERATOR_POLYNOMIAL        = 0,
125         FCM_GENERATOR_POLYNOMIAL_FACTORISED
126 } eFMod_Generator_Modes;
127
128
129 /* generator flags 
130  *      - shared by Generator and Function Generator
131  */
132 typedef enum eFMod_Generator_Flags {
133                 /* generator works in conjunction with other modifiers (i.e. doesn't replace those before it) */
134         FCM_GENERATOR_ADDITIVE  = (1<<0)
135 } eFMod_Generator_Flags;
136
137
138 /* 'Built-In Function' Generator modifier data
139  * 
140  * This uses the general equation for equations:
141  *              y = amplitude * fn(phase_multiplier*x + phase_offset) + y_offset
142  *
143  * where amplitude, phase_multiplier/offset, y_offset are user-defined coefficients,
144  * x is the evaluation 'time', and 'y' is the resultant value
145  */
146 typedef struct FMod_FunctionGenerator {
147                 /* coefficients for general equation (as above) */
148         float amplitude;
149         float phase_multiplier;
150         float phase_offset;
151         float value_offset;
152         
153                 /* flags */
154         int type;                               /* eFMod_Generator_Functions */
155         int flag;                               /* eFMod_Generator_flags */
156 } FMod_FunctionGenerator;
157
158 /* 'function' generator types */
159 typedef enum eFMod_Generator_Functions {
160         FCM_GENERATOR_FN_SIN    = 0,
161         FCM_GENERATOR_FN_COS,
162         FCM_GENERATOR_FN_TAN,
163         FCM_GENERATOR_FN_SQRT,
164         FCM_GENERATOR_FN_LN,
165         FCM_GENERATOR_FN_SINC
166 } eFMod_Generator_Functions;
167
168
169 /* envelope modifier - envelope data */
170 typedef struct FCM_EnvelopeData {
171         float min, max;                         /* min/max values for envelope at this point (absolute values)  */
172         float time;                                     /* time for that this sample-point occurs */
173         
174         short f1;                                       /* settings for 'min' control point */
175         short f2;                                       /* settings for 'max' control point */
176 } FCM_EnvelopeData;
177
178 /* envelope-like adjustment to values (for fade in/out) */
179 typedef struct FMod_Envelope {
180         FCM_EnvelopeData *data;         /* data-points defining envelope to apply (array)  */
181         int totvert;                            /* number of envelope points */
182         
183         float midval;                           /* value that envelope's influence is centered around / based on */
184         float min, max;                         /* distances from 'middle-value' for 1:1 envelope influence */
185 } FMod_Envelope;
186
187
188 /* cycling/repetition modifier data */
189 // TODO: we can only do complete cycles...
190 typedef struct FMod_Cycles {
191         short   before_mode;            /* extrapolation mode to use before first keyframe */
192         short   after_mode;                     /* extrapolation mode to use after last keyframe */
193         short   before_cycles;          /* number of 'cycles' before first keyframe to do */
194         short   after_cycles;           /* number of 'cycles' after last keyframe to do */
195 } FMod_Cycles;
196
197 /* cycling modes */
198 typedef enum eFMod_Cycling_Modes {
199         FCM_EXTRAPOLATE_NONE = 0,                       /* don't do anything */
200         FCM_EXTRAPOLATE_CYCLIC,                         /* repeat keyframe range as-is */
201         FCM_EXTRAPOLATE_CYCLIC_OFFSET,          /* repeat keyframe range, but with offset based on gradient between values */
202         FCM_EXTRAPOLATE_MIRROR                          /* alternate between forward and reverse playback of keyframe range */
203 } eFMod_Cycling_Modes;
204
205
206 /* Python-script modifier data */
207 typedef struct FMod_Python {
208         struct Text *script;            /* text buffer containing script to execute */
209         IDProperty *prop;                       /* ID-properties to provide 'custom' settings */
210 } FMod_Python;
211
212
213 /* limits modifier data */
214 typedef struct FMod_Limits {
215         rctf rect;                                      /* rect defining the min/max values */
216         int flag;                                       /* settings for limiting */
217         int pad;
218 } FMod_Limits;
219
220 /* limiting flags */
221 typedef enum eFMod_Limit_Flags {
222         FCM_LIMIT_XMIN          = (1<<0),
223         FCM_LIMIT_XMAX          = (1<<1),
224         FCM_LIMIT_YMIN          = (1<<2),
225         FCM_LIMIT_YMAX          = (1<<3)
226 } eFMod_Limit_Flags;
227
228
229 /* noise modifier data */
230 typedef struct FMod_Noise {
231         float size;
232         float strength;
233         float phase;
234         float pad;
235         
236         short depth;
237         short modification;
238 } FMod_Noise;
239         
240 /* modification modes */
241 typedef enum eFMod_Noise_Modifications {
242         FCM_NOISE_MODIF_REPLACE = 0,    /* Modify existing curve, matching it's shape */
243         FCM_NOISE_MODIF_ADD,                    /* Add noise to the curve */
244         FCM_NOISE_MODIF_SUBTRACT,               /* Subtract noise from the curve */
245         FCM_NOISE_MODIF_MULTIPLY                /* Multiply the curve by noise */
246 } eFMod_Noise_Modifications;
247
248
249 /* stepped modifier data */
250 typedef struct FMod_Stepped {
251         float step_size;                                /* Number of frames each interpolated value should be held */
252         float offset;                                   /* Reference frame number that stepping starts from */
253         
254         float start_frame;                              /* start frame of the frame range that modifier works in */                             
255         float end_frame;                                /* end frame of the frame range that modifier works in */
256         
257         int flag;                                               /* various settings */  
258 } FMod_Stepped;
259
260 /* stepped modifier range flags */
261 typedef enum eFMod_Stepped_Flags {
262         FCM_STEPPED_NO_BEFORE   = (1<<0),       /* don't affect frames before the start frame */
263         FCM_STEPPED_NO_AFTER    = (1<<1),       /* don't affect frames after the end frame */
264 } eFMod_Stepped_Flags;
265
266 /* Drivers -------------------------------------- */
267
268 /* Driver Target (dtar)
269  *
270  * Defines how to access a dependency needed for a driver variable.
271  */
272 typedef struct DriverTarget {
273         ID      *id;                            /* ID-block which owns the target, no user count */
274         
275         char *rna_path;                 /* RNA path defining the setting to use (for DVAR_TYPE_SINGLE_PROP) */
276         
277         char pchan_name[32];    /* name of the posebone to use (for vars where DTAR_FLAG_STRUCT_REF is used) */
278         short transChan;                /* transform channel index (for DVAR_TYPE_TRANSFORM_CHAN)*/
279         
280         short flag;                             /* flags for the validity of the target (NOTE: these get reset everytime the types change) */
281         int idtype;                             /* type of ID-block that this target can use */
282 } DriverTarget;
283
284 /* Driver Target flags */
285 typedef enum eDriverTarget_Flag {
286                 /* used for targets that use the pchan_name instead of RNA path 
287                  * (i.e. rotation difference) 
288                  */
289         DTAR_FLAG_STRUCT_REF    = (1<<0),
290                 /* idtype can only be 'Object' */
291         DTAR_FLAG_ID_OB_ONLY    = (1<<1),
292         
293         /* "localspace" flags */
294                 /* base flag - basically "pre parent+constraints" */
295         DTAR_FLAG_LOCALSPACE    = (1<<2),
296                 /* include constraints transformed to space including parents */
297         DTAR_FLAG_LOCAL_CONSTS  = (1<<3),
298 } eDriverTarget_Flag;
299
300 /* Transform Channels for Driver Targets */
301 typedef enum eDriverTarget_TransformChannels {
302         DTAR_TRANSCHAN_LOCX = 0,
303         DTAR_TRANSCHAN_LOCY,
304         DTAR_TRANSCHAN_LOCZ,
305         DTAR_TRANSCHAN_ROTX,
306         DTAR_TRANSCHAN_ROTY,
307         DTAR_TRANSCHAN_ROTZ,
308         DTAR_TRANSCHAN_SCALEX,
309         DTAR_TRANSCHAN_SCALEY,
310         DTAR_TRANSCHAN_SCALEZ,
311         
312         MAX_DTAR_TRANSCHAN_TYPES
313 } eDriverTarget_TransformChannels;
314
315 /* --- */
316
317 /* maximum number of driver targets per variable */
318 #define MAX_DRIVER_TARGETS      8
319
320
321 /* Driver Variable (dvar)
322  *
323  * A 'variable' for use as an input for the driver evaluation.
324  * Defines a way of accessing some channel to use, that can be
325  * referred to in the expression as a variable, thus simplifying
326  * expressions and also Depsgraph building.
327  */
328 typedef struct DriverVar {
329         struct DriverVar *next, *prev;
330         
331         char name[64];                          /* name of the variable to use in py-expression (must be valid python identifier) */
332         
333         DriverTarget targets[8];        /* MAX_DRIVER_TARGETS, target slots */  
334         short num_targets;                      /* number of targets actually used by this variable */
335         
336         short type;                                     /* type of driver target (eDriverTarget_Types) */       
337         float curval;                           /* result of previous evaluation */
338 } DriverVar;
339
340 /* Driver Variable Types */
341 typedef enum eDriverVar_Types {
342                 /* single RNA property */
343         DVAR_TYPE_SINGLE_PROP   = 0,
344                 /* rotation difference (between 2 bones) */
345         DVAR_TYPE_ROT_DIFF,
346                 /* distance between objects/bones */
347         DVAR_TYPE_LOC_DIFF,
348                 /* 'final' transform for object/bones */
349         DVAR_TYPE_TRANSFORM_CHAN,
350         
351         /* maximum number of variable types 
352          * NOTE: this must always be th last item in this list,
353          *              so add new types above this line
354          */
355         MAX_DVAR_TYPES
356 } eDriverVar_Types;
357
358 /* --- */
359
360 /* Channel Driver (i.e. Drivers / Expressions) (driver)
361  *
362  * Channel Drivers are part of the dependency system, and are executed in addition to 
363  * normal user-defined animation. They take the animation result of some channel(s), and
364  * use that (optionally combined with its own F-Curve for modification of results) to define
365  * the value of some setting semi-procedurally.
366  *
367  * Drivers are stored as part of F-Curve data, so that the F-Curve's RNA-path settings (for storing
368  * what setting the driver will affect). The order in which they are stored defines the order that they're
369  * evaluated in. This order is set by the Depsgraph's sorting stuff. 
370  */
371 typedef struct ChannelDriver {
372         ListBase variables;     /* targets for this driver (i.e. list of DriverVar) */
373         
374         /* python expression to execute (may call functions defined in an accessory file) 
375          * which relates the target 'variables' in some way to yield a single usable value
376          */
377         char expression[256];   /* expression to compile for evaluation */
378         void *expr_comp;                /* PyObject - compiled expression, dont save this */
379         
380         float curval;           /* result of previous evaluation */
381         float influence;        /* influence of driver on result */ // XXX to be implemented... this is like the constraint influence setting
382         
383                 /* general settings */
384         int type;                       /* type of driver */
385         int flag;                       /* settings of driver */
386 } ChannelDriver;
387
388 /* driver type */
389 typedef enum eDriver_Types {
390                 /* target values are averaged together */
391         DRIVER_TYPE_AVERAGE     = 0,
392                 /* python expression/function relates targets */
393         DRIVER_TYPE_PYTHON,
394                 /* sum of all values */
395         DRIVER_TYPE_SUM,
396                 /* smallest value */
397         DRIVER_TYPE_MIN,
398                 /* largest value */
399         DRIVER_TYPE_MAX
400 } eDriver_Types;
401
402 /* driver flags */
403 typedef enum eDriver_Flags {
404                 /* driver has invalid settings (internal flag)  */
405         DRIVER_FLAG_INVALID             = (1<<0),
406                 /* driver needs recalculation (set by depsgraph) */
407         DRIVER_FLAG_RECALC              = (1<<1),
408                 /* driver does replace value, but overrides (for layering of animation over driver) */
409                 // TODO: this needs to be implemented at some stage or left out...
410         //DRIVER_FLAG_LAYERING  = (1<<2),
411                 /* use when the expression needs to be recompiled */
412         DRIVER_FLAG_RECOMPILE   = (1<<3),
413                 /* the names are cached so they dont need have python unicode versions created each time */
414         DRIVER_FLAG_RENAMEVAR   = (1<<4),
415                 /* intermediate values of driver should be shown in the UI for debugging purposes */
416         DRIVER_FLAG_SHOWDEBUG   = (1<<5)
417 } eDriver_Flags;
418
419 /* F-Curves -------------------------------------- */
420
421 /* FPoint (fpt)
422  *
423  * This is the bare-minimum data required storing motion samples. Should be more efficient
424  * than using BPoints, which contain a lot of other unnecessary data...
425  */
426 typedef struct FPoint {
427         float vec[2];           /* time + value */
428         int flag;                       /* selection info */
429         int pad;
430 } FPoint;
431
432 /* 'Function-Curve' - defines values over time for a given setting (fcu) */
433 typedef struct FCurve {
434         struct FCurve *next, *prev;
435         
436                 /* group */
437         bActionGroup *grp;              /* group that F-Curve belongs to */
438         
439                 /* driver settings */
440         ChannelDriver *driver;  /* only valid for drivers (i.e. stored in AnimData not Actions) */
441                 /* evaluation settings */
442         ListBase modifiers;             /* FCurve Modifiers */
443                 
444                 /* motion data */
445         BezTriple *bezt;                /* user-editable keyframes (array) */
446         FPoint *fpt;                    /* 'baked/imported' motion samples (array) */
447         unsigned int totvert;   /* total number of points which define the curve (i.e. size of arrays in FPoints) */
448         
449                 /* value cache + settings */
450         float curval;                   /* value stored from last time curve was evaluated */
451         short flag;                             /* user-editable settings for this curve */
452         short extend;                   /* value-extending mode for this curve (does not cover  */
453         
454                 /* RNA - data link */
455         int array_index;                /* if applicable, the index of the RNA-array item to get */
456         char *rna_path;                 /* RNA-path to resolve data-access */
457         
458                 /* curve coloring (for editor) */
459         int color_mode;                 /* coloring method to use (eFCurve_Coloring) */
460         float color[3];                 /* the last-color this curve took */
461 } FCurve;
462
463
464 /* user-editable flags/settings */
465 typedef enum eFCurve_Flags {
466                 /* curve/keyframes are visible in editor */
467         FCURVE_VISIBLE          = (1<<0),
468                 /* curve is selected for editing  */
469         FCURVE_SELECTED         = (1<<1),
470                 /* curve is active one */
471         FCURVE_ACTIVE           = (1<<2),
472                 /* keyframes (beztriples) cannot be edited */
473         FCURVE_PROTECTED        = (1<<3),
474                 /* fcurve will not be evaluated for the next round */
475         FCURVE_MUTED            = (1<<4),
476         
477                 /* fcurve uses 'auto-handles', which stay horizontal... */
478                 // DEPRECATED
479         FCURVE_AUTO_HANDLES     = (1<<5),
480         
481                 /* skip evaluation, as RNA-path cannot be resolved (similar to muting, but cannot be set by user) */
482         FCURVE_DISABLED                 = (1<<10),
483                 /* curve can only have whole-number values (integer types) */
484         FCURVE_INT_VALUES               = (1<<11),
485                 /* curve can only have certain discrete-number values (no interpolation at all, for enums/booleans) */
486         FCURVE_DISCRETE_VALUES  = (1<<12),
487         
488                 /* temporary tag for editing */
489         FCURVE_TAGGED                   = (1<<15)
490 } eFCurve_Flags;
491
492 /* extrapolation modes (only simple value 'extending') */
493 typedef enum eFCurve_Extend {
494         FCURVE_EXTRAPOLATE_CONSTANT     = 0,    /* just extend min/max keyframe value  */
495         FCURVE_EXTRAPOLATE_LINEAR                       /* just extend gradient of segment between first segment keyframes */
496 } eFCurve_Extend;
497
498 /* curve coloring modes */
499 typedef enum eFCurve_Coloring {
500         FCURVE_COLOR_AUTO_RAINBOW = 0,          /* automatically determine color using rainbow (calculated at drawtime) */
501         FCURVE_COLOR_AUTO_RGB,                          /* automatically determine color using XYZ (array index) <-> RGB */
502         FCURVE_COLOR_CUSTOM                                     /* custom color */
503 } eFCurve_Coloring;
504
505 /* ************************************************ */
506 /* 'Action' Datatypes */
507
508 /* NOTE: Although these are part of the Animation System,
509  * they are not stored here... see DNA_action_types.h instead
510  */
511
512  
513 /* ************************************************ */
514 /* Animation Reuse - i.e. users of Actions */
515
516 /* Retargetting ----------------------------------- */
517
518 /* Retargetting Pair
519  *
520  * Defines what parts of the paths should be remapped from 'abc' to 'xyz'.
521  * TODO:
522  *      - Regrex (possibly provided through PY, though having our own module might be faster)
523  *        would be important to have at some point. Current replacements are just simple
524  *        string matches...
525  */
526 typedef struct AnimMapPair {
527         char from[128];         /* part of path to bed replaced */
528         char to[128];           /* part of path to replace with */
529 } AnimMapPair;
530
531 /* Retargetting Information for Actions 
532  *
533  * This should only be used if it is strictly necessary (i.e. user will need to explictly 
534  * add this when they find that some channels do not match, or motion is not going to right 
535  * places). When executing an action, this will be checked to see if it provides any useful
536  * remaps for the given paths.
537  *
538  * NOTE: we currently don't store this in the Action itself, as that causes too many problems.
539  */
540 // FIXME: will this be too clumsy or slow? If we're using RNA paths anyway, we'll have to accept
541 // such consequences...
542 typedef struct AnimMapper {
543         struct AnimMapper *next, *prev;
544         
545         bAction *target;                /* target action */
546         ListBase mappings;              /* remapping table (bAnimMapPair) */
547 } AnimMapper;
548
549 /* ************************************************ */
550 /* NLA - Non-Linear Animation */
551
552 /* NLA Strips ------------------------------------- */
553
554 /* NLA Strip (strip)
555  *
556  * A NLA Strip is a container for the reuse of Action data, defining parameters
557  * to control the remapping of the Action data to some destination. 
558  */
559 typedef struct NlaStrip {
560         struct NlaStrip *next, *prev;
561         
562         ListBase strips;                        /* 'Child' strips (used for 'meta' strips) */
563         bAction *act;                           /* Action that is referenced by this strip (strip is 'user' of the action) */
564         AnimMapper *remap;                      /* Remapping info this strip (for tweaking correspondance of action with context) */
565         
566         ListBase fcurves;                       /* F-Curves for controlling this strip's influence and timing */        // TODO: move out?
567         ListBase modifiers;                     /* F-Curve modifiers to be applied to the entire strip's referenced F-Curves */
568         
569         char name[64];                          /* User-Visible Identifier for Strip */
570         
571         float influence;                        /* Influence of strip */
572         float strip_time;                       /* Current 'time' within action being used (automatically evaluated, but can be overridden) */
573         
574         float start, end;                       /* extents of the strip */
575         float actstart, actend;         /* range of the action to use */
576         
577         float repeat;                           /* The number of times to repeat the action range (only when no F-Curves) */
578         float scale;                            /* The amount the action range is scaled by (only when no F-Curves) */
579         
580         float blendin, blendout;        /* strip blending length (only used when there are no F-Curves) */      
581         short blendmode;                        /* strip blending mode (layer-based mixing) */
582         
583         short extendmode;                       /* strip extrapolation mode (time-based mixing) */
584         short pad1;
585         
586         short type;                                     /* type of NLA strip */
587         
588         void *speaker_handle;           /* handle for speaker objects */
589
590         int flag;                                       /* settings */
591         int pad2;
592 } NlaStrip;
593
594 /* NLA Strip Blending Mode */
595 typedef enum eNlaStrip_Blend_Mode {
596         NLASTRIP_MODE_REPLACE = 0,
597         NLASTRIP_MODE_ADD,
598         NLASTRIP_MODE_SUBTRACT,
599         NLASTRIP_MODE_MULTIPLY
600 } eNlaStrip_Blend_Mode;
601
602 /* NLA Strip Extrpolation Mode */
603 typedef enum eNlaStrip_Extrapolate_Mode {
604                 /* extend before first frame if no previous strips in track, and always hold+extend last frame */
605         NLASTRIP_EXTEND_HOLD    = 0,            
606                 /* only hold+extend last frame */
607         NLASTRIP_EXTEND_HOLD_FORWARD,   
608                 /* don't contribute at all */
609         NLASTRIP_EXTEND_NOTHING
610 } eNlaStrip_Extrapolate_Mode;
611
612 /* NLA Strip Settings */
613 typedef enum eNlaStrip_Flag {
614         /* UI selection flags */
615                 /* NLA strip is the active one in the track (also indicates if strip is being tweaked) */
616         NLASTRIP_FLAG_ACTIVE            = (1<<0),       
617                 /* NLA strip is selected for editing */
618         NLASTRIP_FLAG_SELECT            = (1<<1),
619 //      NLASTRIP_FLAG_SELECT_L          = (1<<2),       // left handle selected
620 //      NLASTRIP_FLAG_SELECT_R          = (1<<3),       // right handle selected
621                 /* NLA strip uses the same action that the action being tweaked uses (not set for the twaking one though) */
622         NLASTRIP_FLAG_TWEAKUSER         = (1<<4),
623         
624         /* controls driven by local F-Curves */
625                 /* strip influence is controlled by local F-Curve */
626         NLASTRIP_FLAG_USR_INFLUENCE     = (1<<5),
627         NLASTRIP_FLAG_USR_TIME          = (1<<6),
628         NLASTRIP_FLAG_USR_TIME_CYCLIC = (1<<7),
629         
630                 /* NLA strip length is synced to the length of the referenced action */
631         NLASTRIP_FLAG_SYNC_LENGTH       = (1<<9),
632         
633         /* playback flags (may be overriden by F-Curves) */
634                 /* NLA strip blendin/out values are set automatically based on overlaps */
635         NLASTRIP_FLAG_AUTO_BLENDS       = (1<<10),
636                 /* NLA strip is played back in reverse order */
637         NLASTRIP_FLAG_REVERSE           = (1<<11),
638                 /* NLA strip is muted (i.e. doesn't contribute in any way) */
639         NLASTRIP_FLAG_MUTED                     = (1<<12),
640                 /* NLA Strip is played back in 'ping-pong' style */
641         NLASTRIP_FLAG_MIRROR            = (1<<13),
642         
643         /* temporary editing flags */
644                 /* NLA-Strip is really just a temporary meta used to facilitate easier transform code */
645         NLASTRIP_FLAG_TEMP_META         = (1<<30),
646         NLASTRIP_FLAG_EDIT_TOUCHED      = (1<<31)
647 } eNlaStrip_Flag;
648
649 /* NLA Strip Type */
650 typedef enum eNlaStrip_Type {   
651                 /* 'clip' - references an Action */
652         NLASTRIP_TYPE_CLIP      = 0,
653                 /* 'transition' - blends between the adjacent strips */
654         NLASTRIP_TYPE_TRANSITION,
655                 /* 'meta' - a strip which acts as a container for a few others */
656         NLASTRIP_TYPE_META,     
657         
658                 /* 'emit sound' - a strip which is used for timing when speaker emits sounds */
659         NLASTRIP_TYPE_SOUND
660 } eNlaStrip_Type;
661
662 /* NLA Tracks ------------------------------------- */
663
664 /* NLA Track (nlt)
665  *
666  * A track groups a bunch of 'strips', which should form a continous set of 
667  * motion, on top of which other such groups can be layered. This should allow
668  * for animators to work in a non-destructive manner, layering tweaks, etc. over
669  * 'rough' blocks of their work.
670  */
671 typedef struct NlaTrack {
672         struct NlaTrack *next, *prev;
673         
674         ListBase strips;                /* bActionStrips in this track */
675         
676         int flag;                               /* settings for this track */
677         int index;                              /* index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!) */
678         
679         char name[64];                  /* short user-description of this track */
680 } NlaTrack;
681
682 /* settings for track */
683 typedef enum eNlaTrack_Flag {
684                 /* track is the one that settings can be modified on, also indicates if track is being 'tweaked' */
685         NLATRACK_ACTIVE         = (1<<0),
686                 /* track is selected in UI for relevant editing operations */
687         NLATRACK_SELECTED       = (1<<1),
688                 /* track is not evaluated */
689         NLATRACK_MUTED          = (1<<2),
690                 /* track is the only one evaluated (must be used in conjunction with adt->flag) */
691         NLATRACK_SOLO           = (1<<3),
692                 /* track's settings (and strips) cannot be edited (to guard against unwanted changes) */
693         NLATRACK_PROTECTED      = (1<<4),
694         
695                 /* track is not allowed to execute, usually as result of tweaking being enabled (internal flag) */
696         NLATRACK_DISABLED       = (1<<10)
697 } eNlaTrack_Flag;
698
699
700 /* ************************************ */
701 /* KeyingSet Datatypes */
702
703 /* Path for use in KeyingSet definitions (ksp) 
704  *
705  * Paths may be either specific (specifying the exact sub-ID
706  * dynamic data-block - such as PoseChannels - to act upon, ala
707  * Maya's 'Character Sets' and XSI's 'Marking Sets'), or they may
708  * be generic (using various placeholder template tags that will be
709  * replaced with appropriate information from the context). 
710  */
711 typedef struct KS_Path {
712         struct KS_Path *next, *prev;
713         
714         ID *id;                                 /* ID block that keyframes are for */
715         char group[64];                 /* name of the group to add to */
716         
717         int idtype;                             /* ID-type that path can be used on */
718         
719         short groupmode;                /* group naming (eKSP_Grouping) */
720         short pad;
721         
722         char *rna_path;                 /* dynamically (or statically in the case of predefined sets) path */
723         int array_index;                /* index that path affects */
724         
725         short flag;                             /* various settings, etc. */
726         short keyingflag;               /* settings to supply insertkey() with */
727 } KS_Path;
728
729 /* KS_Path->flag */
730 typedef enum eKSP_Settings {
731                 /* entire array (not just the specified index) gets keyframed */
732         KSP_FLAG_WHOLE_ARRAY    = (1<<0)
733 } eKSP_Settings;
734
735 /* KS_Path->groupmode */
736 typedef enum eKSP_Grouping {
737                 /* path should be grouped using group name stored in path */
738         KSP_GROUP_NAMED = 0,
739                 /* path should not be grouped at all */
740         KSP_GROUP_NONE,
741                 /* path should be grouped using KeyingSet's name */
742         KSP_GROUP_KSNAME,
743                 /* path should be grouped using name of inner-most context item from templates 
744                  *      - this is most useful for relative KeyingSets only
745                  */
746         KSP_GROUP_TEMPLATE_ITEM
747 } eKSP_Grouping;
748
749 /* ---------------- */
750  
751 /* KeyingSet definition (ks)
752  *
753  * A KeyingSet defines a group of properties that should
754  * be keyframed together, providing a convenient way for animators
755  * to insert keyframes without resorting to Auto-Keyframing.
756  *
757  * A few 'generic' (non-absolute and dependant on templates) KeyingSets 
758  * are defined 'built-in' to facilitate easy animating for the casual
759  * animator without the need to add extra steps to the rigging process.
760  */
761 typedef struct KeyingSet {
762         struct KeyingSet *next, *prev;
763         
764         ListBase paths;                 /* (KS_Path) paths to keyframe to */
765         
766         char name[64];                  /* user-viewable name for KeyingSet (for menus, etc.) */
767         char typeinfo[64];              /* name of the typeinfo data used for the relative paths */
768         
769         short flag;                             /* settings for KeyingSet */
770         short keyingflag;               /* settings to supply insertkey() with */
771         
772         int active_path;                /* index of the active path */
773 } KeyingSet;
774
775 /* KeyingSet settings */
776 typedef enum eKS_Settings {
777                 /* keyingset cannot be removed (and doesn't need to be freed) */
778         KEYINGSET_BUILTIN               = (1<<0),
779                 /* keyingset does not depend on context info (i.e. paths are absolute) */
780         KEYINGSET_ABSOLUTE              = (1<<1)
781 } eKS_Settings;
782
783 /* Flags for use by keyframe creation/deletion calls */
784 typedef enum eInsertKeyFlags {
785         INSERTKEY_NEEDED        = (1<<0),       /* only insert keyframes where they're needed */
786         INSERTKEY_MATRIX        = (1<<1),       /* insert 'visual' keyframes where possible/needed */
787         INSERTKEY_FAST          = (1<<2),       /* don't recalculate handles,etc. after adding key */
788         INSERTKEY_FASTR         = (1<<3),       /* don't realloc mem (or increase count, as array has already been set out) */
789         INSERTKEY_REPLACE       = (1<<4),       /* only replace an existing keyframe (this overrides INSERTKEY_NEEDED) */
790         INSERTKEY_XYZ2RGB       = (1<<5)        /* transform F-Curves should have XYZ->RGB color mode */
791 } eInsertKeyFlags;
792
793 /* ************************************************ */
794 /* Animation Data */
795
796 /* AnimOverride ------------------------------------- */
797
798 /* Animation Override (aor) 
799  *
800  * This is used to as temporary storage of values which have been changed by the user, but not
801  * yet keyframed (thus, would get overwritten by the animation system before the user had a chance
802  * to see the changes that were made). 
803  *
804  * It is probably not needed for overriding keyframed values in most cases, as those will only get evaluated
805  * on frame-change now. That situation may change in future.
806  */
807 typedef struct AnimOverride {
808         struct AnimOverride *next, *prev;
809         
810         char *rna_path;                 /* RNA-path to use to resolve data-access */
811         int array_index;                /* if applicable, the index of the RNA-array item to get */
812         
813         float value;                    /* value to override setting with */
814 } AnimOverride;
815
816 /* AnimData ------------------------------------- */
817
818 /* Animation data for some ID block (adt)
819  * 
820  * This block of data is used to provide all of the necessary animation data for a datablock.
821  * Currently, this data will not be reusable, as there shouldn't be any need to do so.
822  * 
823  * This information should be made available for most if not all ID-blocks, which should 
824  * enable all of its settings to be animatable locally. Animation from 'higher-up' ID-AnimData
825  * blocks may override local settings.
826  *
827  * This datablock should be placed immediately after the ID block where it is used, so that
828  * the code which retrieves this data can do so in an easier manner. See blenkernel/intern/anim_sys.c for details.
829  */
830 typedef struct AnimData {       
831                 /* active action - acts as the 'tweaking track' for the NLA */
832         bAction         *action;        
833                 /* temp-storage for the 'real' active action (i.e. the one used before the tweaking-action 
834                  * took over to be edited in the Animation Editors) 
835                  */
836         bAction         *tmpact;
837                 /* remapping-info for active action - should only be used if needed 
838                  * (for 'foreign' actions that aren't working correctly) 
839                  */
840         AnimMapper      *remap;                 
841         
842                 /* nla-tracks */
843         ListBase        nla_tracks;
844                 /* active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers) */
845         NlaStrip        *actstrip;
846         
847         /* 'drivers' for this ID-block's settings - FCurves, but are completely 
848          * separate from those for animation data 
849          */
850         ListBase        drivers;        /* standard user-created Drivers/Expressions (used as part of a rig) */
851         ListBase        overrides;      /* temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed) */
852         
853                 /* settings for animation evaluation */
854         int flag;                               /* user-defined settings */
855         int recalc;                             /* depsgraph recalculation flags */     
856         
857                 /* settings for active action evaluation (based on NLA strip settings) */
858         short act_blendmode;    /* accumulation mode for active action */
859         short act_extendmode;   /* extrapolation mode for active action */
860         float act_influence;    /* influence for active action */
861 } AnimData;
862
863 /* Animation Data settings (mostly for NLA) */
864 typedef enum eAnimData_Flag {
865                 /* only evaluate a single track in the NLA */
866         ADT_NLA_SOLO_TRACK              = (1<<0),
867                 /* don't use NLA */
868         ADT_NLA_EVAL_OFF                = (1<<1),
869                 /* NLA is being 'tweaked' (i.e. in EditMode) */
870         ADT_NLA_EDIT_ON                 = (1<<2),
871                 /* active Action for 'tweaking' does not have mapping applied for editing */
872         ADT_NLA_EDIT_NOMAP              = (1<<3),
873                 /* NLA-Strip F-Curves are expanded in UI */
874         ADT_NLA_SKEYS_COLLAPSED = (1<<4),
875         
876                 /* drivers expanded in UI */
877         ADT_DRIVERS_COLLAPSED   = (1<<10),
878                 /* don't execute drivers */
879         ADT_DRIVERS_DISABLED    = (1<<11),
880         
881                 /* AnimData block is selected in UI */
882         ADT_UI_SELECTED                 = (1<<14),
883                 /* AnimData block is active in UI */
884         ADT_UI_ACTIVE                   = (1<<15),
885         
886                 /* F-Curves from this AnimData block are not visible in the Graph Editor */
887         ADT_CURVES_NOT_VISIBLE  = (1<<16)
888 } eAnimData_Flag;
889
890 /* Animation Data recalculation settings (to be set by depsgraph) */
891 typedef enum eAnimData_Recalc {
892         ADT_RECALC_DRIVERS              = (1<<0),
893         ADT_RECALC_ANIM                 = (1<<1),
894         ADT_RECALC_ALL                  = (ADT_RECALC_DRIVERS|ADT_RECALC_ANIM)
895 } eAnimData_Recalc;
896
897 /* Base Struct for Anim ------------------------------------- */
898
899 /* Used for BKE_animdata_from_id() 
900  * All ID-datablocks which have their own 'local' AnimData
901  * should have the same arrangement in their structs.
902  */
903 typedef struct IdAdtTemplate {
904         ID id;
905         AnimData *adt;
906 } IdAdtTemplate;
907
908 /* ************************************************ */
909
910 #ifdef __cplusplus
911 };
912 #endif
913
914 #endif /* DNA_ANIM_TYPES_H */