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