2.5 PoseLib/KeyingSets bugfixes:
[blender-staging.git] / source / blender / makesdna / DNA_anim_types.h
1 /* Testing code for new animation system in 2.5 
2  * Copyright 2009, Joshua Leung
3  */
4
5 #ifndef DNA_ANIM_TYPES_H
6 #define DNA_ANIM_TYPES_H
7
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11
12 #include "DNA_ID.h"
13 #include "DNA_listBase.h"
14 #include "DNA_action_types.h"
15 #include "DNA_curve_types.h"
16
17 /* ************************************************ */
18 /* F-Curve DataTypes */
19
20 /* Modifiers -------------------------------------- */
21
22 /* F-Curve Modifiers (fcm) 
23  *
24  * These alter the way F-Curves behave, by altering the value that is returned
25  * when evaluating the curve's data at some time (t). 
26  */
27 typedef struct FModifier {
28         struct FModifier *next, *prev;
29         
30         void *data;                     /* pointer to modifier data */
31         
32         char name[64];          /* user-defined description for the modifier */
33         short type;                     /* type of f-curve modifier */
34         short flag;                     /* settings for the modifier */
35         
36         float influence;        /* the amount that the modifier should influence the value */
37 } FModifier;
38
39 /* Types of F-Curve modifier 
40  * WARNING: order here is important!
41  */
42 enum {
43         FMODIFIER_TYPE_NULL = 0,
44         FMODIFIER_TYPE_GENERATOR,
45         FMODIFIER_TYPE_ENVELOPE,
46         FMODIFIER_TYPE_CYCLES,
47         FMODIFIER_TYPE_NOISE,           /* unimplemented - generate variations using some basic noise generator... */
48         FMODIFIER_TYPE_FILTER,          /* unimplemented - for applying: fft, high/low pass filters, etc. */
49         FMODIFIER_TYPE_PYTHON,  
50         FMODIFIER_TYPE_LIMITS,
51         
52         /* NOTE: all new modifiers must be added above this line */
53         FMODIFIER_NUM_TYPES
54 } eFModifier_Types;
55
56 /* F-Curve Modifier Settings */
57 enum {
58                 /* modifier is not able to be evaluated for some reason, and should be skipped (internal) */
59         FMODIFIER_FLAG_DISABLED         = (1<<0),
60                 /* modifier's data is expanded (in UI) */
61         FMODIFIER_FLAG_EXPANDED         = (1<<1),
62                 /* modifier is active one (in UI) for editing purposes */
63         FMODIFIER_FLAG_ACTIVE           = (1<<2),
64 } eFModifier_Flags; 
65
66 /* --- */
67
68 /* generator modifier data */
69 typedef struct FMod_Generator {
70                 /* generator based on PyExpression */
71         char expression[256];           /* python expression to use as generator */
72         
73                 /* general generator information */
74         float *coefficients;            /* coefficients array */
75         unsigned int arraysize;         /* size of the coefficients array */
76         
77         unsigned short poly_order;      /* order of polynomial generated (i.e. 1 for linear, 2 for quadratic) */
78         short func_type;                        /* builtin math function eFMod_Generator_Functions */
79         
80         int pad;
81         
82                 /* settings */
83         short flag;                                     /* settings */
84         short mode;                                     /* which 'generator' to use eFMod_Generator_Modes */
85 } FMod_Generator;
86
87 /* generator modes */
88 enum {
89         FCM_GENERATOR_POLYNOMIAL        = 0,
90         FCM_GENERATOR_POLYNOMIAL_FACTORISED,
91         FCM_GENERATOR_FUNCTION,
92         FCM_GENERATOR_EXPRESSION,
93 } eFMod_Generator_Modes;
94
95 /* generator flags */
96 enum {
97                 /* generator works in conjunction with other modifiers (i.e. doesn't replace those before it) */
98         FCM_GENERATOR_ADDITIVE  = (1<<0),
99 } eFMod_Generator_Flags;
100
101 /* 'function' generator types */
102 enum {
103         FCM_GENERATOR_FN_SIN    = 0,
104         FCM_GENERATOR_FN_COS,
105         FCM_GENERATOR_FN_TAN,
106         FCM_GENERATOR_FN_SQRT,
107         FCM_GENERATOR_FN_LN,
108 } eFMod_Generator_Functions;
109
110
111 /* envelope modifier - envelope data */
112 typedef struct FCM_EnvelopeData {
113         float min, max;                         /* min/max values for envelope at this point (absolute values)  */
114         float time;                                     /* time for that this sample-point occurs */
115         
116         short f1;                                       /* settings for 'min' control point */
117         short f2;                                       /* settings for 'max' control point */
118 } FCM_EnvelopeData;
119
120 /* envelope-like adjustment to values (for fade in/out) */
121 typedef struct FMod_Envelope {
122         FCM_EnvelopeData *data;         /* data-points defining envelope to apply (array)  */
123         int totvert;                            /* number of envelope points */
124         
125         float midval;                           /* value that envelope's influence is centered around / based on */
126         float min, max;                         /* distances from 'middle-value' for 1:1 envelope influence */
127 } FMod_Envelope;
128
129
130 /* cycling/repetition modifier data */
131 // TODO: we can only do complete cycles...
132 typedef struct FMod_Cycles {
133         short   before_mode;            /* extrapolation mode to use before first keyframe */
134         short   after_mode;                     /* extrapolation mode to use after last keyframe */
135         short   before_cycles;          /* number of 'cycles' before first keyframe to do */
136         short   after_cycles;           /* number of 'cycles' after last keyframe to do */
137 } FMod_Cycles;
138
139 /* cycling modes */
140 enum {
141         FCM_EXTRAPOLATE_NONE = 0,                       /* don't do anything */
142         FCM_EXTRAPOLATE_CYCLIC,                         /* repeat keyframe range as-is */
143         FCM_EXTRAPOLATE_CYCLIC_OFFSET,          /* repeat keyframe range, but with offset based on gradient between values */
144 } eFMod_Cycling_Modes;
145
146
147 /* Python-script modifier data */
148 typedef struct FMod_Python {
149         struct Text *script;            /* text buffer containing script to execute */
150         IDProperty *prop;                       /* ID-properties to provide 'custom' settings */
151 } FMod_Python;
152
153
154 /* limits modifier data */
155 typedef struct FMod_Limits {
156         rctf rect;                                      /* rect defining the min/max values */
157         int flag;                                       /* settings for limiting */
158         int pad;
159 } FMod_Limits;
160
161 /* limiting flags */
162 enum {
163         FCM_LIMIT_XMIN          = (1<<0),
164         FCM_LIMIT_XMAX          = (1<<1),
165         FCM_LIMIT_YMIN          = (1<<2),
166         FCM_LIMIT_YMAX          = (1<<3),
167 } eFMod_Limit_Flags;
168
169 /* Drivers -------------------------------------- */
170
171 /* Channel Driver (i.e. Drivers / Expressions) (driver)
172  *
173  * Channel Drivers are part of the dependency system, and are executed in addition to 
174  * normal user-defined animation. They take the animation result of some channel(s), and
175  * use that (optionally combined with its own F-Curve for modification of results) to define
176  * the value of some setting semi-procedurally.
177  *
178  * Drivers are stored as part of F-Curve data, so that the F-Curve's RNA-path settings (for storing
179  * what setting the driver will affect). The order in which they are stored defines the order that they're
180  * evaluated in. This order is set by the Depsgraph's sorting stuff. 
181  */
182 typedef struct ChannelDriver {
183                 /* primary target */
184         ID      *id;                    /* ID-block which owns the target */
185         char *rna_path;         /* target channel to use as driver value */
186         int array_index;        /* if applicable, the index of the RNA-array item to use as driver */
187         
188                 /* value cache (placed here for alignment reasons) */
189         float curval;           /* result of previous evaluation, for subtraction from result under certain circumstances */
190         
191                 /* secondary target (for rotational difference) */
192         ID      *id2;                   /* ID-block which owns the second target */
193         char *rna_path2;        /* second target channel to use as driver value */
194         int array_index2;       /* if applicable, the index of the RNA-array item to use as driver */
195                 
196                 /* general settings (placed here for alignment reasons) */
197         int type;                       /* type of driver */
198         int flag;                       /* settings of driver */
199         
200         float influence;        /* influence of driver on result */ // XXX to be implemented... this is like the constraint influence setting
201         
202                 /* settings for Python Drivers (PyDrivers) */
203         char expression[256]; /* python expression to execute (may call functions defined in an accessory file) */
204 } ChannelDriver;
205
206 /* driver type */
207 enum {
208                 /* channel drives channel */
209         DRIVER_TYPE_CHANNEL     = 0,
210                 /* py-expression used as driver */
211         DRIVER_TYPE_PYTHON,
212                 /* rotational difference (must use rotation channels only) */
213         DRIVER_TYPE_ROTDIFF,
214 } eDriver_Types;
215
216 /* driver flags */
217 enum {
218                 /* driver has invalid settings (internal flag)  */
219         DRIVER_FLAG_INVALID             = (1<<0),
220                 /* driver was disabled temporarily, so shouldn't be evaluated (set by user) */
221         DRIVER_FLAG_DISABLED    = (1<<1),
222                 /* driver needs recalculation (set by depsgraph) */
223         DRIVER_FLAG_RECALC              = (1<<2),
224                 /* driver does replace value, but overrides (for layering of animation over driver) */
225                 // TODO: is this necessary?
226         DRIVER_FLAG_LAYERING    = (1<<3),
227 } eDriver_Flags;
228
229 /* F-Curves -------------------------------------- */
230
231 /* FPoint (fpt)
232  *
233  * This is the bare-minimum data required storing motion samples. Should be more efficient
234  * than using BPoints, which contain a lot of other unnecessary data...
235  */
236 typedef struct FPoint {
237         float vec[2];           /* time + value */
238         int flag;                       /* selection info */
239         int pad;
240 } FPoint;
241
242 /* 'Function-Curve' - defines values over time for a given setting (fcu) */
243 typedef struct FCurve {
244         struct FCurve *next, *prev;
245         
246                 /* group */
247         bActionGroup *grp;              /* group that F-Curve belongs to */
248         
249                 /* driver settings */
250         ChannelDriver *driver;  /* only valid for drivers (i.e. stored in AnimData not Actions) */
251                 /* evaluation settings */
252         ListBase modifiers;             /* FCurve Modifiers */
253                 
254                 /* motion data */
255         BezTriple *bezt;                /* user-editable keyframes (array) */
256         FPoint *fpt;                    /* 'baked/imported' motion samples (array) */
257         unsigned int totvert;   /* total number of points which define the curve (i.e. size of arrays in FPoints) */
258         
259                 /* value cache + settings */
260         float curval;                   /* value stored from last time curve was evaluated */
261         short flag;                             /* user-editable settings for this curve */
262         short extend;                   /* value-extending mode for this curve (does not cover  */
263         
264                 /* RNA - data link */
265         int array_index;                /* if applicable, the index of the RNA-array item to get */
266         char *rna_path;                 /* RNA-path to resolve data-access */
267         
268                 /* curve coloring (for editor) */
269         int color_mode;                 /* coloring method to use */
270         float color[3];                 /* the last-color this curve took */
271 } FCurve;
272
273
274 /* user-editable flags/settings */
275 enum {
276                 /* curve/keyframes are visible in editor */
277         FCURVE_VISIBLE          = (1<<0),
278                 /* curve is selected for editing  */
279         FCURVE_SELECTED         = (1<<1),
280                 /* curve is active one */
281         FCURVE_ACTIVE           = (1<<2),
282                 /* keyframes (beztriples) cannot be edited */
283         FCURVE_PROTECTED        = (1<<3),
284                 /* fcurve will not be evaluated for the next round */
285         FCURVE_MUTED            = (1<<4),
286                 /* fcurve uses 'auto-handles', which stay horizontal... */
287         FCURVE_AUTO_HANDLES     = (1<<5),
288         
289                 /* skip evaluation, as RNA-path cannot be resolved (similar to muting, but cannot be set by user) */
290         FCURVE_DISABLED                 = (1<<10),
291                 /* curve can only have whole-number values (int or boolean types) */
292         FCURVE_INT_VALUES               = (1<<11),
293 } eFCurve_Flags;
294
295 /* extrapolation modes (only simple value 'extending') */
296 enum {
297         FCURVE_EXTRAPOLATE_CONSTANT     = 0,    /* just extend min/max keyframe value  */
298         FCURVE_EXTRAPOLATE_LINEAR,                      /* just extend gradient of segment between first segment keyframes */
299 } eFCurve_Extend;
300
301 /* curve coloring modes */
302 enum {
303         FCURVE_COLOR_AUTO_RAINBOW = 0,          /* automatically determine color using rainbow (calculated at drawtime) */
304         FCURVE_COLOR_AUTO_RGB,                          /* automatically determine color using XYZ (array index) <-> RGB */
305         FCURVE_COLOR_CUSTOM,                            /* custom color */
306 } eFCurve_Coloring;
307
308 /* ************************************************ */
309 /* 'Action' Datatypes */
310
311 /* NOTE: Although these are part of the Animation System,
312  * they are not stored here... see DNA_action_types.h instead
313  */
314
315  
316 /* ************************************************ */
317 /* Animation Reuse - i.e. users of Actions */
318
319 /* Retargetting ----------------------------------- */
320
321 /* Retargetting Pair
322  *
323  * Defines what parts of the paths should be remapped from 'abc' to 'xyz'.
324  * TODO:
325  *      - Regrex (possibly provided through PY, though having our own module might be faster)
326  *        would be important to have at some point. Current replacements are just simple
327  *        string matches...
328  */
329 typedef struct AnimMapPair {
330         char from[128];         /* part of path to bed replaced */
331         char to[128];           /* part of path to replace with */
332 } AnimMapPair;
333
334 /* Retargetting Information for Actions 
335  *
336  * This should only be used if it is strictly necessary (i.e. user will need to explictly 
337  * add this when they find that some channels do not match, or motion is not going to right 
338  * places). When executing an action, this will be checked to see if it provides any useful
339  * remaps for the given paths.
340  *
341  * NOTE: we currently don't store this in the Action itself, as that causes too many problems.
342  */
343 // FIXME: will this be too clumsy or slow? If we're using RNA paths anyway, we'll have to accept
344 // such consequences...
345 typedef struct AnimMapper {
346         struct AnimMapper *next, *prev;
347         
348         bAction *target;                /* target action */
349         ListBase mappings;              /* remapping table (bAnimMapPair) */
350 } AnimMapper;
351
352 /* ************************************************ */
353 /* NLA - Non-Linear Animation */
354 // TODO: the concepts here still need to be refined to solve any unresolved items
355
356 /* NLA Modifiers ---------------------------------- */
357
358 /* These differ from F-Curve modifiers, as although F-Curve modifiers also operate on a 
359  * per-channel basis too (in general), they are part of the animation data itself, which
360  * means that their effects are inherited by all of their users. In order to counteract this,
361  * the modifiers here should be used to provide variation to pre-created motions only. 
362  */
363
364 /* NLA Strips ------------------------------------- */
365
366 /* NLA Strip (strip)
367  *
368  * A NLA Strip is a container for the reuse of Action data, defining parameters
369  * to control the remapping of the Action data to some destination. Actions being
370  * referenced by NLA-Strips SHOULD-NOT be editable, unless they were created in such
371  * a way that results in very little mapping distortion (i.e. for layered animation only,
372  * opposed to prebuilt 'blocks' which are quickly dumped into the NLA for crappymatic machima-type
373  * stuff)
374  */
375 typedef struct NlaStrip {
376         struct NlaStrip *next, *prev;
377         
378         bAction *act;                           /* Action that is referenced by this strip */
379         AnimMapper *remap;                      /* Remapping info this strip (for tweaking correspondance of action with context) */
380         
381         ListBase modifiers;                     /* NLA Modifiers */     
382         
383         ListBase fcurves;                       /* F-Curves for controlling this strip's influence and timing */
384         float influence;                        /* Influence of strip */
385         float act_time;                         /* Current 'time' within action being used */
386         
387         float start, end;                       /* extents of the strip */
388         float actstart, actend;         /* range of the action to use */
389         
390         float   repeat;                         /* The number of times to repeat the action range (only when no F-Curves) */
391         float   scale;                          /* The amount the action range is scaled by (only when no F-Curves) */
392         
393         float blendin, blendout;        /* strip blending length (only used when there are no F-Curves) */      
394         int blendmode;                          /* strip blending mode */       
395         
396         int flag;                                       /* settings */
397         
398                 // umm... old unused cruft? 
399         int stride_axis;                        /* axis for stridebone stuff - 0=x, 1=y, 2=z */
400         int pad;
401         
402         float   actoffs;                        /* Offset within action, for cycles and striding (only set for ACT_USESTRIDE) */
403         float   stridelen;                      /* The stridelength (considered when flag & ACT_USESTRIDE) */
404         
405         char    stridechannel[32];      /* Instead of stridelen, it uses an action channel */
406         char    offs_bone[32];          /* if repeat, use this bone/channel for defining offset */
407 } NlaStrip;
408
409 /* NLA Strip Blending Mode */
410 enum {
411         NLASTRIPMODE_BLEND = 0,
412         NLASTRIPMODE_ADD,
413         NLASTRIPMODE_SUBTRACT,
414 } eActStrip_Mode;
415
416 /* NLA Strip Settings */
417 // TODO: check on which of these are still useful...
418 enum {
419         NLASTRIP_SELECT                 = (1<<0),
420         NLASTRIP_USESTRIDE              = (1<<1),
421         NLASTRIP_BLENDTONEXT    = (1<<2),       /* Not implemented. Is not used anywhere */
422         NLASTRIP_HOLDLASTFRAME  = (1<<3),
423         NLASTRIP_ACTIVE                 = (1<<4),
424         NLASTRIP_LOCK_ACTION    = (1<<5),
425         NLASTRIP_MUTE                   = (1<<6),
426         NLASTRIP_REVERSE                = (1<<7),       /* This has yet to be implemented. To indicate that a strip should be played backwards */
427         NLASTRIP_CYCLIC_USEX    = (1<<8),
428         NLASTRIP_CYCLIC_USEY    = (1<<9),
429         NLASTRIP_CYCLIC_USEZ    = (1<<10),
430         NLASTRIP_AUTO_BLENDS    = (1<<11),
431         NLASTRIP_TWEAK                  = (1<<12),      /* This strip is a tweaking strip (only set if owner track is a tweak track) */
432 } eActionStrip_Flag;
433
434 /* NLA Tracks ------------------------------------- */
435
436 /* NLA Track (nlt)
437  *
438  * A track groups a bunch of 'strips', which should form a continous set of 
439  * motion, on top of which other such groups can be layered. This should allow
440  * for animators to work in a non-destructive manner, layering tweaks, etc. over
441  * 'rough' blocks of their work.
442  */
443 typedef struct NlaTrack {
444         struct NlaTrack *next, *prev;
445         
446         ListBase strips;                /* bActionStrips in this track */
447         
448         int flag;                               /* settings for this track */
449         int index;                              /* index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!) */
450         
451         char info[64];                  /* short user-description of this track */
452 } NlaTrack;
453
454 /* settings for track */
455 enum {
456                 /* track is the one that settings can be modified on (doesn't indicate 
457                  * that it's for 'tweaking' though) 
458                  */
459         NLATRACK_ACTIVE         = (1<<0),
460                 /* track is selected in UI for relevant editing operations */
461         NLATRACK_SELECTED       = (1<<1),
462                 /* track is not evaluated */
463         NLATRACK_MUTED          = (1<<2),
464                 /* track is the only one evaluated (must be used in conjunction with adt->flag) */
465         NLATRACK_SOLO           = (1<<3),
466                 /* track's settings (and strips) cannot be edited (to guard against unwanted changes) */
467         NLATRACK_PROTECTED      = (1<<4),
468                 /* strip is the 'last' one that should be evaluated, as the active action 
469                  * is being used to tweak the animation of the strips up to here 
470                  */
471         NLATRACK_TWEAK          = (1<<5),
472 } eNlaTrack_Flag;
473
474
475 /* ************************************ */
476 /* KeyingSet Datatypes */
477
478 /* Path for use in KeyingSet definitions (ksp) 
479  *
480  * Paths may be either specific (specifying the exact sub-ID
481  * dynamic data-block - such as PoseChannels - to act upon, ala
482  * Maya's 'Character Sets' and XSI's 'Marking Sets'), or they may
483  * be generic (using various placeholder template tags that will be
484  * replaced with appropriate information from the context). 
485  */
486 typedef struct KS_Path {
487         struct KS_Path *next, *prev;
488         
489                 /* absolute paths only */
490         ID *id;                                 /* ID block that keyframes are for */
491         char group[64];                 /* name of the group to add to */
492         
493                 /* relative paths only */
494         int idtype;                             /* ID-type that path can be used on */
495         int templates;                  /* Templates that will be encountered in the path (as set of bitflags) */
496         
497                 /* all paths */
498         char *rna_path;                 /* dynamically (or statically in the case of predefined sets) path */
499         int array_index;                /* index that path affects */
500         
501         short flag;                             /* various settings, etc. */
502         short groupmode;                /* group naming (eKSP_Grouping) */
503 } KS_Path;
504
505 /* KS_Path->flag */
506 enum {
507                 /* entire array (not just the specified index) gets keyframed */
508         KSP_FLAG_WHOLE_ARRAY    = (1<<0),
509 } eKSP_Settings;
510
511 /* KS_Path->groupmode */
512 enum {
513                 /* path should be grouped using group name stored in path */
514         KSP_GROUP_NAMED = 0,
515                 /* path should not be grouped at all */
516         KSP_GROUP_NONE,
517                 /* path should be grouped using KeyingSet's name */
518         KSP_GROUP_KSNAME,
519                 /* path should be grouped using name of inner-most context item from templates 
520                  *      - this is most useful for relative KeyingSets only
521                  */
522         KSP_GROUP_TEMPLATE_ITEM,
523 } eKSP_Grouping;
524
525 /* KS_Path->templates  (Template Flags)
526  *
527  * Templates in paths are used to substitute information from the 
528  * active context into relavent places in the path strings. This
529  * enum here defines the flags which define which templates are
530  * required by a path before it can be used
531  */
532 enum {
533         KSP_TEMPLATE_OBJECT                     = (1<<0),       /* #obj - selected object */
534         KSP_TEMPLATE_PCHAN                      = (1<<1),       /* #pch - selected posechannel */
535         KSP_TEMPLATE_CONSTRAINT         = (1<<2),       /* #con - active only */
536         KSP_TEMPLATE_NODE                       = (1<<3),       /* #nod - selected node */
537 } eKSP_TemplateTypes;
538
539 /* ---------------- */
540  
541 /* KeyingSet definition (ks)
542  *
543  * A KeyingSet defines a group of properties that should
544  * be keyframed together, providing a convenient way for animators
545  * to insert keyframes without resorting to Auto-Keyframing.
546  *
547  * A few 'generic' (non-absolute and dependant on templates) KeyingSets 
548  * are defined 'built-in' to facilitate easy animating for the casual
549  * animator without the need to add extra steps to the rigging process.
550  */
551 typedef struct KeyingSet {
552         struct KeyingSet *next, *prev;
553         
554         ListBase paths;                 /* (KS_Path) paths to keyframe to */
555         
556         char name[64];                  /* user-viewable name for KeyingSet (for menus, etc.) */
557         
558         int flag;                               /* settings for KeyingSet */
559         int keyingflag;                 /* settings to supply insertkey() with */
560 } KeyingSet;
561
562 /* KeyingSet settings */
563 enum {
564                 /* keyingset cannot be removed (and doesn't need to be freed) */
565         KEYINGSET_BUILTIN               = (1<<0),
566                 /* keyingset does not depend on context info (i.e. paths are absolute) */
567         KEYINGSET_ABSOLUTE              = (1<<1),
568 } eKS_Settings;
569
570 /* Flags for use by keyframe creation/deletion calls */
571 enum {
572         INSERTKEY_NEEDED        = (1<<0),       /* only insert keyframes where they're needed */
573         INSERTKEY_MATRIX        = (1<<1),       /* insert 'visual' keyframes where possible/needed */
574         INSERTKEY_FAST          = (1<<2),       /* don't recalculate handles,etc. after adding key */
575         INSERTKEY_FASTR         = (1<<3),       /* don't realloc mem (or increase count, as array has already been set out) */
576         INSERTKEY_REPLACE       = (1<<4),       /* only replace an existing keyframe (this overrides INSERTKEY_NEEDED) */
577 } eInsertKeyFlags;
578
579 /* ************************************************ */
580 /* Animation Data */
581
582 /* AnimOverride ------------------------------------- */
583
584 /* Animation Override (aor) 
585  *
586  * This is used to as temporary storage of values which have been changed by the user, but not
587  * yet keyframed (thus, would get overwritten by the animation system before the user had a chance
588  * to see the changes that were made). 
589  *
590  * It is probably not needed for overriding keyframed values in most cases, as those will only get evaluated
591  * on frame-change now. That situation may change in future.
592  */
593 typedef struct AnimOverride {
594         struct AnimOverride *next, *prev;
595         
596         char *rna_path;                 /* RNA-path to use to resolve data-access */
597         int array_index;                /* if applicable, the index of the RNA-array item to get */
598         
599         float value;                    /* value to override setting with */
600 } AnimOverride;
601
602 /* AnimData ------------------------------------- */
603
604 /* Animation data for some ID block (adt)
605  * 
606  * This block of data is used to provide all of the necessary animation data for a datablock.
607  * Currently, this data will not be reusable, as there shouldn't be any need to do so.
608  * 
609  * This information should be made available for most if not all ID-blocks, which should 
610  * enable all of its settings to be animatable locally. Animation from 'higher-up' ID-AnimData
611  * blocks may override local settings.
612  *
613  * This datablock should be placed immediately after the ID block where it is used, so that
614  * the code which retrieves this data can do so in an easier manner. See blenkernel/internal/anim_sys.c for details.
615  */
616 typedef struct AnimData {       
617                 /* active action - acts as the 'tweaking track' for the NLA */
618         bAction         *action;                
619                 /* remapping-info for active action - should only be used if needed 
620                  * (for 'foreign' actions that aren't working correctly) 
621                  */
622         AnimMapper      *remap;                 
623         
624                 /* nla-tracks */
625         ListBase        nla_tracks;
626         
627         /* 'drivers' for this ID-block's settings - FCurves, but are completely 
628          * separate from those for animation data 
629          */
630         ListBase        drivers;        /* standard user-created Drivers/Expressions (used as part of a rig) */
631         ListBase        overrides;      /* temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed) */
632         
633                 /* settings for animation evaluation */
634         int flag;                       /* user-defined settings */
635         int recalc;                     /* depsgraph recalculation flags */             
636 } AnimData;
637
638 /* Animation Data settings (mostly for NLA) */
639 enum {
640                 /* only evaluate a single track in the NLA */
641         ADT_NLA_SOLO_TRACK              = (1<<0),
642                 /* don't use NLA */
643         ADT_NLA_EVAL_OFF                = (1<<1),
644                 /* don't execute drivers */
645         ADT_DRIVERS_DISABLED    = (1<<2),
646         
647                 /* drivers expanded in UI */
648         ADT_DRIVERS_COLLAPSED   = (1<<10),
649 } eAnimData_Flag;
650
651 /* Animation Data recalculation settings (to be set by depsgraph) */
652 enum {
653         ADT_RECALC_DRIVERS              = (1<<0),
654         ADT_RECALC_ANIM                 = (1<<1),
655         ADT_RECALC_ALL                  = (ADT_RECALC_DRIVERS|ADT_RECALC_ANIM),
656 } eAnimData_Recalc;
657
658 /* Base Struct for Anim ------------------------------------- */
659
660 /* Used for BKE_animdata_from_id() 
661  * All ID-datablocks which have their own 'local' AnimData
662  * should have the same arrangement in their structs.
663  */
664 typedef struct IdAdtTemplate {
665         ID id;
666         AnimData *adt;
667 } IdAdtTemplate;
668
669 /* ************************************************ */
670
671 #ifdef __cplusplus
672 };
673 #endif
674
675 #endif /* DNA_ANIM_TYPES_H */