Keying Sets: Wrapped KeyingSets in RNA
[blender.git] / source / blender / blenkernel / intern / anim_sys.c
1 /* Testing code for new animation system in 2.5 
2  * Copyright 2009, Joshua Leung
3  */
4
5 #include <stdio.h>
6 #include <string.h>
7
8 #include "MEM_guardedalloc.h"
9
10 #include "BLI_blenlib.h"
11 #include "BLI_arithb.h"
12 #include "BLI_dynstr.h"
13
14 #include "BKE_animsys.h"
15 #include "BKE_action.h"
16 #include "BKE_fcurve.h"
17 #include "BKE_global.h"
18 #include "BKE_main.h"
19 #include "BKE_utildefines.h"
20
21 #include "RNA_access.h"
22 #include "RNA_types.h"
23
24 #include "DNA_anim_types.h"
25
26 /* ***************************************** */
27 /* AnimData API */
28
29 /* Getter/Setter -------------------------------------------- */
30
31 /* Internal utility to check if ID can have AnimData */
32 static short id_has_animdata (ID *id)
33 {
34         /* sanity check */
35         if (id == NULL)
36                 return 0;
37                 
38         /* Only some ID-blocks have this info for now */
39         // TODO: finish adding this for the other blocktypes
40         switch (GS(id->name)) {
41                         /* has AnimData */
42                 case ID_OB:
43                 case ID_CU:
44                 case ID_KE:
45                 case ID_MA: case ID_TE: case ID_NT:
46                 case ID_LA: case ID_CA: case ID_WO:
47                 case ID_SCE:
48                 {
49                         return 1;
50                 }
51                 
52                         /* no AnimData */
53                 default:
54                         return 0;
55         }
56 }
57
58
59 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
60  * the AnimData pointer is stored immediately after the given ID-block in the struct,
61  * as per IdAdtTemplate.
62  */
63 AnimData *BKE_animdata_from_id (ID *id)
64 {
65         /* only some ID-blocks have this info for now, so we cast the 
66          * types that do to be of type IdAdtTemplate, and extract the
67          * AnimData that way
68          */
69         if (id_has_animdata(id)) {
70                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
71                 return iat->adt;
72         }
73         else
74                 return NULL;
75 }
76
77 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
78  * the AnimData pointer is stored immediately after the given ID-block in the struct,
79  * as per IdAdtTemplate. Also note that 
80  */
81 AnimData *BKE_id_add_animdata (ID *id)
82 {
83         /* Only some ID-blocks have this info for now, so we cast the 
84          * types that do to be of type IdAdtTemplate, and add the AnimData
85          * to it using the template
86          */
87         if (id_has_animdata(id)) {
88                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
89                 
90                 /* check if there's already AnimData, in which case, don't add */
91                 if (iat->adt == NULL)
92                         iat->adt= MEM_callocN(sizeof(AnimData), "AnimData");
93                 
94                 return iat->adt;
95         }
96         else 
97                 return NULL;
98 }
99
100 /* Freeing -------------------------------------------- */
101
102 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
103 void BKE_free_animdata (ID *id)
104 {
105         /* Only some ID-blocks have this info for now, so we cast the 
106          * types that do to be of type IdAdtTemplate
107          */
108         if (id_has_animdata(id)) {
109                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
110                 AnimData *adt= iat->adt;
111                 
112                 /* check if there's any AnimData to start with */
113                 if (adt) {
114                         /* unlink action (don't free, as it's in its own list) */
115                         if (adt->action)
116                                 adt->action->id.us--;
117                                 
118                         /* free drivers - stored as a list of F-Curves */
119                         free_fcurves(&adt->drivers);
120                         
121                         /* free overrides */
122                         // TODO...
123                         
124                         /* free animdata now */
125                         MEM_freeN(adt);
126                         iat->adt= NULL;
127                 }
128         }
129 }
130
131 /* Freeing -------------------------------------------- */
132
133 /* Make a copy of the given AnimData - to be used when copying datablocks */
134 AnimData *BKE_copy_animdata (AnimData *adt)
135 {
136         AnimData *dadt;
137         
138         /* sanity check before duplicating struct */
139         if (adt == NULL)
140                 return NULL;
141         dadt= MEM_dupallocN(adt);
142         
143         /* make a copy of action - at worst, user has to delete copies... */
144         // XXX review this... it might not be optimal behaviour yet...
145         //id_us_plus((ID *)dadt->action);
146         dadt->action= copy_action(adt->action);
147         
148         /* duplicate NLA data */
149         // XXX todo...
150         
151         /* duplicate drivers (F-Curves) */
152         copy_fcurves(&dadt->drivers, &adt->drivers);
153         
154         /* don't copy overrides */
155         dadt->overrides.first= dadt->overrides.last= NULL;
156         
157         /* return */
158         return dadt;
159 }
160
161 /* *********************************** */ 
162 /* KeyingSet API */
163
164 /* NOTES:
165  * It is very likely that there will be two copies of the api - one for internal use,
166  * and one 'operator' based wrapper of the internal API, which should allow for access
167  * from Python/scripts so that riggers can automate the creation of KeyingSets for their rigs.
168  */
169
170 /* Defining Tools --------------------------- */
171
172 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
173 KeyingSet *BKE_keyingset_add (ListBase *list, const char name[], short flag, short keyingflag)
174 {
175         KeyingSet *ks;
176         
177         /* allocate new KeyingSet */
178         ks= MEM_callocN(sizeof(KeyingSet), "KeyingSet");
179         
180         if (name)
181                 BLI_snprintf(ks->name, 64, name);
182         else
183                 strcpy(ks->name, "Keying Set");
184         
185         ks->flag= flag;
186         ks->keyingflag= keyingflag;
187         
188         /* add KeyingSet to list */
189         BLI_addtail(list, ks);
190         
191         /* return new KeyingSet for further editing */
192         return ks;
193 }
194
195 /* Add a destination to a KeyingSet. Nothing is returned for now...
196  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
197  */
198 void BKE_keyingset_add_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode)
199 {
200         KS_Path *ksp;
201         
202         /* sanity checks */
203         if ELEM(NULL, ks, rna_path)
204                 return;
205         
206         /* ID is optional, and should only be provided for absolute KeyingSets */
207         if (id) {
208                 if ((ks->flag & KEYINGSET_ABSOLUTE) == 0)
209                         return;
210         }
211         
212         /* allocate a new KeyingSet Path */
213         ksp= MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
214         
215         /* just store absolute info */
216         if (ks->flag & KEYINGSET_ABSOLUTE) {
217                 ksp->id= id;
218                 if (group_name)
219                         BLI_snprintf(ksp->group, 64, group_name);
220                 else
221                         strcpy(ksp->group, "");
222         }
223         
224         /* just copy path info */
225         // XXX no checks are performed for templates yet
226         // should array index be checked too?
227         ksp->rna_path= BLI_strdupn(rna_path, strlen(rna_path));
228         ksp->array_index= array_index;
229         
230         /* store flags */
231         ksp->flag= flag;
232         ksp->groupmode= groupmode;
233         
234         /* add KeyingSet path to KeyingSet */
235         BLI_addtail(&ks->paths, ksp);
236 }       
237
238
239 /* Freeing Tools --------------------------- */
240
241 /* Free data for KeyingSet but not set itself */
242 void BKE_keyingset_free (KeyingSet *ks)
243 {
244         KS_Path *ksp, *kspn;
245         
246         /* sanity check */
247         if (ks == NULL)
248                 return;
249         
250         /* free each path as we go to avoid looping twice */
251         for (ksp= ks->paths.first; ksp; ksp= kspn) {
252                 kspn= ksp->next;
253                 
254                 /* free RNA-path info */
255                 MEM_freeN(ksp->rna_path);
256                 
257                 /* free path itself */
258                 BLI_freelinkN(&ks->paths, ksp);
259         }
260 }
261
262 /* Free all the KeyingSets in the given list */
263 void BKE_keyingsets_free (ListBase *list)
264 {
265         KeyingSet *ks, *ksn;
266         
267         /* sanity check */
268         if (list == NULL)
269                 return;
270         
271         /* loop over KeyingSets freeing them 
272          *      - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
273          */
274         for (ks= list->first; ks; ks= ksn) {
275                 ksn= ks->next;
276                 BKE_keyingset_free(ks);
277                 BLI_freelinkN(list, ks);
278         }
279 }
280
281 /* ***************************************** */
282 /* Evaluation Data-Setting Backend */
283
284 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
285  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
286  * // FIXME: maybe it would be faster if we didn't have to alloc/free strings like this all the time, but for now it's safer
287  *
288  *      - remap: remapping table to use
289  *      - path: original path string (as stored in F-Curve data)
290  *      - dst: destination string to write data to
291  */
292 short animsys_remap_path (AnimMapper *remap, char *path, char **dst)
293 {
294         /* is there a valid remapping table to use? */
295         if (remap) {
296                 /* find a matching entry... to use to remap */
297                 // ...TODO...
298         }
299         
300         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
301         *dst= path;
302         return 0;
303 }
304
305
306 /* Write the given value to a setting using RNA, and return success */
307 static short animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_index, float value)
308 {
309         PropertyRNA *prop;
310         PointerRNA new_ptr;
311         
312         /* get property to write to */
313         if (RNA_path_resolve(ptr, path, &new_ptr, &prop)) 
314         {
315                 /* set value - only for animatable numerical values */
316                 if (RNA_property_animateable(&new_ptr, prop)) 
317                 {
318                         switch (RNA_property_type(&new_ptr, prop)) 
319                         {
320                                 case PROP_BOOLEAN:
321                                         if (RNA_property_array_length(&new_ptr, prop))
322                                                 RNA_property_boolean_set_index(&new_ptr, prop, array_index, (int)value);
323                                         else
324                                                 RNA_property_boolean_set(&new_ptr, prop, (int)value);
325                                         break;
326                                 case PROP_INT:
327                                         if (RNA_property_array_length(&new_ptr, prop))
328                                                 RNA_property_int_set_index(&new_ptr, prop, array_index, (int)value);
329                                         else
330                                                 RNA_property_int_set(&new_ptr, prop, (int)value);
331                                         break;
332                                 case PROP_FLOAT:
333                                         if (RNA_property_array_length(&new_ptr, prop))
334                                                 RNA_property_float_set_index(&new_ptr, prop, array_index, value);
335                                         else
336                                                 RNA_property_float_set(&new_ptr, prop, value);
337                                         break;
338                                 case PROP_ENUM:
339                                         RNA_property_enum_set(&new_ptr, prop, (int)value);
340                                         break;
341                                 default:
342                                         break;
343                         }
344                 }
345                 
346                 /* successful */
347                 // XXX should the unhandled case also be successful?
348                 return 1;
349         }
350         else {
351                 /* failed to get path */
352                 // XXX don't tag as failed yet though, as there are some legit situations (Action Constraint) 
353                 // where some channels will not exist, but shouldn't lock up Action
354                 if (G.f & G_DEBUG) {
355                         printf("Animato: Invalid path. ID = '%s',  '%s [%d]' \n", 
356                                 (ptr && ptr->id.data) ? (((ID *)ptr->id.data)->name+2) : "<No ID>", 
357                                 path, array_index);
358                 }
359                 return 0;
360         }
361 }
362
363 /* Simple replacement based data-setting of the FCurve using RNA */
364 static void animsys_execute_fcurve (PointerRNA *ptr, AnimMapper *remap, FCurve *fcu)
365 {
366         char *path = NULL;
367         short free_path=0;
368         
369         /* get path, remapped as appropriate to work in its new environment */
370         free_path= animsys_remap_path(remap, fcu->rna_path, &path);
371         
372         /* write value to setting */
373         if (path)
374                 animsys_write_rna_setting(ptr, path, fcu->array_index, fcu->curval);
375         
376         /* free temp path-info */
377         if (free_path)
378                 MEM_freeN(path);
379 }
380
381 /* Evaluate all the F-Curves in the given list 
382  * This performs a set of standard checks. If extra checks are required, separate code should be used
383  */
384 static void animsys_evaluate_fcurves (PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
385 {
386         FCurve *fcu;
387         
388         /* calculate then execute each curve */
389         for (fcu= list->first; fcu; fcu= fcu->next) 
390         {
391                 /* check if this curve should be skipped */
392                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
393                 {
394                         calculate_fcurve(fcu, ctime);
395                         animsys_execute_fcurve(ptr, remap, fcu); 
396                 }
397         }
398 }
399
400 /* ***************************************** */
401 /* Driver Evaluation */
402
403 /* Evaluate Drivers */
404 static void animsys_evaluate_drivers (PointerRNA *ptr, AnimData *adt, float ctime)
405 {
406         FCurve *fcu;
407         
408         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
409          * the depsgraph requested that this driver be evaluated...
410          */
411         for (fcu= adt->drivers.first; fcu; fcu= fcu->next) 
412         {
413                 ChannelDriver *driver= fcu->driver;
414                 
415                 /* check if this driver's curve should be skipped */
416                 // FIXME: maybe we shouldn't check for muted, though that would make things more confusing, as there's already too many ways to disable?
417                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
418                 {
419                         /* check if driver itself is tagged for recalculation */
420                         if ((driver) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {      // XXX driver recalc flag is not set yet by depsgraph!
421                                 /* evaluate this using values set already in other places */
422                                 // NOTE: for 'layering' option later on, we should check if we should remove old value before adding new to only be done when drivers only changed
423                                 calculate_fcurve(fcu, ctime);
424                                 animsys_execute_fcurve(ptr, NULL, fcu);
425                                 
426                                 /* clear recalc flag */
427                                 driver->flag &= ~DRIVER_FLAG_RECALC;
428                         }
429                 }
430         }
431 }
432
433 /* ***************************************** */
434 /* Actions Evaluation */
435
436 /* Evaluate Action (F-Curve Bag) */
437 static void animsys_evaluate_action (PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
438 {
439         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
440         if (act == NULL) return;
441         if ((remap) && (remap->target != act)) remap= NULL;
442         
443         /* calculate then execute each curve */
444         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
445 }
446
447 /* ***************************************** */
448 /* NLA System - Evaluation */
449
450 /* used for list of strips to accumulate at current time */
451 typedef struct NlaEvalStrip {
452         struct NlaEvalStrip *next, *prev;
453         
454         NlaTrack *track;                        /* track that this strip belongs to */
455         NlaStrip *strip;                /* strip that's being used */
456         NlaStrip *sblend;               /* strip that's being blended towards (if applicable) */
457         
458         short track_index;                      /* the index of the track within the list */
459         short strip_mode;                       /* which end of the strip are we looking at */
460 } NlaEvalStrip;
461
462 /* bNlaEvalStrip->strip_mode */
463 enum {
464         NES_TIME_BEFORE = -1,
465         NES_TIME_WITHIN,
466         NES_TIME_AFTER,
467         NES_TIME_AFTER_BLEND
468 } eNlaEvalStrip_StripMode;
469
470
471 /* temp channel for accumulating data from NLA (avoids needing to clear all values first) */
472 // TODO: maybe this will be used as the 'cache' stuff needed for editable values too?
473 typedef struct NlaEvalChannel {
474         struct NlaEvalChannel *next, *prev;
475         
476         char *path;                             /* ready-to-use path (i.e. remapped already) */
477         int array_index;                /* if applicable... */
478         
479         float value;                    /* value of this channel */
480 } NlaEvalChannel;
481
482
483 /* ---------------------- */
484
485 /* evaluate the F-Curves controlling settings for the NLA-strips (currently, not relinkable) */
486 static void nlastrip_evaluate_fcurves (NlaStrip *strip, float ctime)
487 {
488         //PointerRNA actstrip_ptr;
489         //FCurve *fcu;
490         
491         /* create RNA-pointer needed to set values */
492         //RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &actstrip_ptr);
493         
494         /* execute these settings as per normal */
495         //animsys_evaluate_fcurves(&actstrip_ptr, &strip->fcurves, NULL, ctime);
496 }
497
498
499 /* gets the strip active at the current time for a track */
500 static void nlatrack_ctime_get_strip (ListBase *list, NlaTrack *nlt, short index, float ctime)
501 {
502         NlaStrip *strip, *astrip=NULL, *bstrip=NULL;
503         NlaEvalStrip *nes;
504         short side= 0;
505         
506         /* skip if track is muted */
507         if (nlt->flag & NLATRACK_MUTED) 
508                 return;
509         
510         /* loop over strips, checking if they fall within the range */
511         for (strip= nlt->strips.first; strip; strip= strip->next) {
512                 /* only consider if:
513                  *      - current time occurs within strip's extents
514                  *      - current time occurs before strip (if it is the first)
515                  *      - current time occurs after strip (if hold is on)
516                  *      - current time occurs between strips (1st of those isn't holding) - blend!
517                  */
518                 if (IN_RANGE(ctime, strip->start, strip->end)) {
519                         astrip= strip;
520                         side= NES_TIME_WITHIN;
521                         break;
522                 }
523                 else if (ctime < strip->start) {
524                         if (strip == nlt->strips.first) {
525                                 astrip= strip;
526                                 side= NES_TIME_BEFORE;
527                                 break;
528                         }
529                         else {
530                                 astrip= strip->prev;
531                                 
532                                 if (astrip->flag & NLASTRIP_HOLDLASTFRAME) {
533                                         side= NES_TIME_AFTER;
534                                         break;
535                                 }
536                                 else {
537                                         bstrip= strip;
538                                         side= NES_TIME_AFTER_BLEND;
539                                         break;
540                                 }
541                         }
542                 }
543         }
544         
545         /* check if strip has been found (and whether it has data worth considering) */
546         if (ELEM(NULL, astrip, astrip->act)) 
547                 return;
548         if (astrip->flag & NLASTRIP_MUTE) 
549                 return;
550         
551         /* check if blending between strips */
552         if (side == NES_TIME_AFTER_BLEND) {
553                 /* blending between strips... so calculate influence+act_time of both */
554                 nlastrip_evaluate_fcurves(astrip, ctime);
555                 nlastrip_evaluate_fcurves(bstrip, ctime);
556                 
557                 if ((astrip->influence <= 0.0f) && (bstrip->influence <= 0.0f))
558                         return;
559         }
560         else {
561                 /* calculate/set the influence+act_time of this strip - don't consider if 0 influence */
562                 nlastrip_evaluate_fcurves(astrip, ctime);
563                 
564                 if (astrip->influence <= 0.0f) 
565                         return;
566         }
567         
568         
569         /* allocate new eval-strip for this strip + add to stack */
570         nes= MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
571         
572         nes->track= nlt;
573         nes->strip= astrip;
574         nes->sblend= bstrip;
575         nes->track_index= index;
576         nes->strip_mode= side;
577         
578         BLI_addtail(list, nes);
579 }
580
581 /* ---------------------- */
582
583 /* evaluates the given evaluation strip */
584 // FIXME: will we need the evaluation cache table set up to blend stuff in?
585 // TODO: only evaluate here, but flush in one go using the accumulated channels at end...
586 static void nlastrip_ctime_evaluate (ListBase *channels, NlaEvalStrip *nes, float ctime)
587 {
588         // 1. (in old code) was to extract 'IPO-channels' from actions
589         // 2. blend between the 'accumulated' data, and the new data
590 }
591
592 /* write the accumulated settings to */
593 static void nladata_flush_channels (PointerRNA *ptr, ListBase *channels)
594 {
595         
596 }
597
598 /* ---------------------- */
599
600 /* NLA Evaluation function (mostly for use through do_animdata) 
601  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
602  *              some temp channels, where values can be accumulated in one go.
603  */
604 static void animsys_evaluate_nla (PointerRNA *ptr, AnimData *adt, float ctime)
605 {
606         NlaTrack *nlt;
607         short track_index=0;
608         
609         ListBase estrips= {NULL, NULL};
610         ListBase echannels= {NULL, NULL};
611         NlaEvalStrip *nes;
612         
613         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
614         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next, track_index++) 
615                 nlatrack_ctime_get_strip(&estrips, nlt, track_index, ctime);
616         
617         /* only continue if there are strips to evaluate */
618         if (estrips.first == NULL)
619                 return;
620         
621         
622         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
623         for (nes= estrips.first; nes; nes= nes->next) 
624                 nlastrip_ctime_evaluate(&echannels, nes, ctime);
625         
626         /* 3. flush effects of accumulating channels in NLA to the actual data they affect */
627         nladata_flush_channels(ptr, &echannels);
628         
629         /* 4. free temporary evaluation data */
630         BLI_freelistN(&estrips);
631         BLI_freelistN(&echannels);
632 }
633
634 /* ***************************************** */ 
635 /* Overrides System - Public API */
636
637 /* Clear all overides */
638
639 /* Add or get existing Override for given setting */
640 AnimOverride *BKE_animsys_validate_override (PointerRNA *ptr, char *path, int array_index)
641 {
642         // FIXME: need to define how to get overrides
643         return NULL;
644
645
646 /* -------------------- */
647
648 /* Evaluate Overrides */
649 static void animsys_evaluate_overrides (PointerRNA *ptr, AnimData *adt, float ctime)
650 {
651         AnimOverride *aor;
652         
653         /* for each override, simply execute... */
654         for (aor= adt->overrides.first; aor; aor= aor->next)
655                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
656 }
657
658 /* ***************************************** */
659 /* Evaluation System - Public API */
660
661 /* Overview of how this system works:
662  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
663  *              that all dependences are resolved before dependants.
664  *      2) All normal animation is evaluated, so that drivers have some basis values to
665  *              work with
666  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
667  *                      which modify the effects of the NLA-stacks
668  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
669  *
670  * --------------< often in a separate phase... >------------------ 
671  *
672  *      3) Drivers/expressions are evaluated on top of this, in an order where dependences are
673  *              resolved nicely. 
674  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
675  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
676  *
677  * --------------< always executed >------------------ 
678  *
679  * Maintainance of editability of settings (XXX):
680  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
681  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
682  *
683  * Unresolved things:
684  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
685  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists?  
686  */
687
688 /* Evaluation loop for evaluation animation data 
689  *
690  * This assumes that the animation-data provided belongs to the ID block in question,
691  * and that the flags for which parts of the anim-data settings need to be recalculated 
692  * have been set already by the depsgraph. Now, we use the recalc 
693  */
694 void BKE_animsys_evaluate_animdata (ID *id, AnimData *adt, float ctime, short recalc)
695 {
696         PointerRNA id_ptr;
697         
698         /* sanity checks */
699         if ELEM(NULL, id, adt)
700                 return;
701         
702         /* get pointer to ID-block for RNA to use */
703         RNA_id_pointer_create(id, &id_ptr);
704         
705         /* recalculate keyframe data:
706          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
707          *        that overrides 'rough' work in NLA
708          */
709         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM))
710         {
711                 /* evaluate NLA data */
712                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF))
713                 {
714                         animsys_evaluate_nla(&id_ptr, adt, ctime);
715                 }
716                 
717                 /* evaluate Action data */
718                 // FIXME: what if the solo track was not tweaking one, then nla-solo should be checked too?
719                 if (adt->action) 
720                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
721                 
722                 /* reset tag */
723                 adt->recalc &= ~ADT_RECALC_ANIM;
724         }
725         
726         /* recalculate drivers 
727          *      - Drivers need to be evaluated afterwards, as they can either override 
728          *        or be layered on top of existing animation data.
729          *      - Drivers should be in the appropriate order to be evaluated without problems...
730          */
731         if ((recalc & ADT_RECALC_DRIVERS) /*&& (adt->recalc & ADT_RECALC_DRIVERS)*/) // XXX for now, don't check yet, as depsgraph hasn't been updated
732         {
733                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
734         }
735         
736         /* always execute 'overrides' 
737          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
738          *        value last set by the user (and not keyframed yet). 
739          *      - Overrides are cleared upon frame change and/or keyframing
740          *      - It is best that we execute this everytime, so that no errors are likely to occur.
741          */
742         animsys_evaluate_overrides(&id_ptr, adt, ctime);
743         
744         /* clear recalc flag now */
745         adt->recalc= 0;
746 }
747
748 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
749  *
750  * This will evaluate only the animation info available in the animation data-blocks
751  * encountered. In order to enforce the system by which some settings controlled by a
752  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
753  * standard 'root') block are overridden by a larger 'user'
754  */
755 // TODO: we currently go over entire 'main' database...
756 void BKE_animsys_evaluate_all_animation (Main *main, float ctime)
757 {
758         ID *id;
759         
760         if (G.f & G_DEBUG)
761                 printf("Evaluate all animation - %f \n", ctime);
762
763         /* macro for less typing */
764 #define EVAL_ANIM_IDS(first, flag) \
765         for (id= first; id; id= id->next) { \
766                 AnimData *adt= BKE_animdata_from_id(id); \
767                 BKE_animsys_evaluate_animdata(id, adt, ctime, flag); \
768         }
769         
770         /* nodes */
771         // TODO...
772         
773         /* textures */
774         EVAL_ANIM_IDS(main->tex.first, ADT_RECALC_ANIM);
775         
776         /* lamps */
777         EVAL_ANIM_IDS(main->lamp.first, ADT_RECALC_ANIM);
778         
779         /* materials */
780         EVAL_ANIM_IDS(main->mat.first, ADT_RECALC_ANIM);
781         
782         /* cameras */
783         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
784         
785         /* shapekeys */
786         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
787         
788         /* curves */
789         // TODO...
790         
791         /* meshes */
792         // TODO...
793         
794         /* objects */
795         EVAL_ANIM_IDS(main->object.first, 0);
796         
797         /* worlds */
798         EVAL_ANIM_IDS(main->world.first, ADT_RECALC_ANIM);
799         
800         /* scenes */
801         EVAL_ANIM_IDS(main->scene.first, ADT_RECALC_ANIM);
802 }
803
804 /* ***************************************** */