BGE Button types panel, can edit existing buttons but not add new ones yet.
[blender.git] / source / blender / blenkernel / intern / anim_sys.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Joshua Leung (full recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #include <stdio.h>
31 #include <string.h>
32 #include <stddef.h>
33 #include <float.h>
34 #include <math.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_arithb.h"
40 #include "BLI_dynstr.h"
41
42 #include "DNA_anim_types.h"
43
44 #include "BKE_animsys.h"
45 #include "BKE_action.h"
46 #include "BKE_fcurve.h"
47 #include "BKE_nla.h"
48 #include "BKE_global.h"
49 #include "BKE_main.h"
50 #include "BKE_utildefines.h"
51
52 #include "RNA_access.h"
53 #include "RNA_types.h"
54
55 #include "nla_private.h"
56
57 /* ***************************************** */
58 /* AnimData API */
59
60 /* Getter/Setter -------------------------------------------- */
61
62 /* Internal utility to check if ID can have AnimData */
63 static short id_has_animdata (ID *id)
64 {
65         /* sanity check */
66         if (id == NULL)
67                 return 0;
68                 
69         /* Only some ID-blocks have this info for now */
70         // TODO: finish adding this for the other blocktypes
71         switch (GS(id->name)) {
72                         /* has AnimData */
73                 case ID_OB:
74                 case ID_CU:
75                 case ID_KE:
76                 case ID_PA:
77                 case ID_MA: case ID_TE: case ID_NT:
78                 case ID_LA: case ID_CA: case ID_WO:
79                 case ID_SCE:
80                 {
81                         return 1;
82                 }
83                 
84                         /* no AnimData */
85                 default:
86                         return 0;
87         }
88 }
89
90
91 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
92  * the AnimData pointer is stored immediately after the given ID-block in the struct,
93  * as per IdAdtTemplate.
94  */
95 AnimData *BKE_animdata_from_id (ID *id)
96 {
97         /* only some ID-blocks have this info for now, so we cast the 
98          * types that do to be of type IdAdtTemplate, and extract the
99          * AnimData that way
100          */
101         if (id_has_animdata(id)) {
102                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
103                 return iat->adt;
104         }
105         else
106                 return NULL;
107 }
108
109 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
110  * the AnimData pointer is stored immediately after the given ID-block in the struct,
111  * as per IdAdtTemplate. Also note that 
112  */
113 AnimData *BKE_id_add_animdata (ID *id)
114 {
115         /* Only some ID-blocks have this info for now, so we cast the 
116          * types that do to be of type IdAdtTemplate, and add the AnimData
117          * to it using the template
118          */
119         if (id_has_animdata(id)) {
120                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
121                 
122                 /* check if there's already AnimData, in which case, don't add */
123                 if (iat->adt == NULL)
124                         iat->adt= MEM_callocN(sizeof(AnimData), "AnimData");
125                 
126                 return iat->adt;
127         }
128         else 
129                 return NULL;
130 }
131
132 /* Freeing -------------------------------------------- */
133
134 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
135 void BKE_free_animdata (ID *id)
136 {
137         /* Only some ID-blocks have this info for now, so we cast the 
138          * types that do to be of type IdAdtTemplate
139          */
140         if (id_has_animdata(id)) {
141                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
142                 AnimData *adt= iat->adt;
143                 
144                 /* check if there's any AnimData to start with */
145                 if (adt) {
146                         /* unlink action (don't free, as it's in its own list) */
147                         if (adt->action)
148                                 adt->action->id.us--;
149                         /* same goes for the temporarily displaced action */
150                         if (adt->tmpact)
151                                 adt->tmpact->id.us--;
152                                 
153                         /* free nla data */
154                         free_nladata(&adt->nla_tracks);
155                         
156                         /* free drivers - stored as a list of F-Curves */
157                         free_fcurves(&adt->drivers);
158                         
159                         /* free overrides */
160                         // TODO...
161                         
162                         /* free animdata now */
163                         MEM_freeN(adt);
164                         iat->adt= NULL;
165                 }
166         }
167 }
168
169 /* Freeing -------------------------------------------- */
170
171 /* Make a copy of the given AnimData - to be used when copying datablocks */
172 AnimData *BKE_copy_animdata (AnimData *adt)
173 {
174         AnimData *dadt;
175         
176         /* sanity check before duplicating struct */
177         if (adt == NULL)
178                 return NULL;
179         dadt= MEM_dupallocN(adt);
180         
181         /* make a copy of action - at worst, user has to delete copies... */
182         // XXX review this... it might not be optimal behaviour yet...
183         //id_us_plus((ID *)dadt->action);
184         dadt->action= copy_action(adt->action);
185         dadt->tmpact= copy_action(adt->tmpact);
186         
187         /* duplicate NLA data */
188         copy_nladata(&dadt->nla_tracks, &adt->nla_tracks);
189         
190         /* duplicate drivers (F-Curves) */
191         copy_fcurves(&dadt->drivers, &adt->drivers);
192         
193         /* don't copy overrides */
194         dadt->overrides.first= dadt->overrides.last= NULL;
195         
196         /* return */
197         return dadt;
198 }
199
200 /* *********************************** */ 
201 /* KeyingSet API */
202
203 /* NOTES:
204  * It is very likely that there will be two copies of the api - one for internal use,
205  * and one 'operator' based wrapper of the internal API, which should allow for access
206  * from Python/scripts so that riggers can automate the creation of KeyingSets for their rigs.
207  */
208
209 /* Finding Tools --------------------------- */
210
211 /* Find the first path that matches the given criteria */
212 // TODO: do we want some method to perform partial matches too?
213 KS_Path *BKE_keyingset_find_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode)
214 {
215         KS_Path *ksp;
216         
217         /* sanity checks */
218         if ELEM(NULL, ks, rna_path)
219                 return NULL;
220         
221         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
222         if (id == NULL) {
223                 if (ks->flag & KEYINGSET_ABSOLUTE)
224                         return NULL;
225         }
226         
227         /* loop over paths in the current KeyingSet, finding the first one where all settings match 
228          * (i.e. the first one where none of the checks fail and equal 0)
229          */
230         for (ksp= ks->paths.first; ksp; ksp= ksp->next) {
231                 short eq_id=1, eq_path=1, eq_index=1, eq_group=1;
232                 
233                 /* id */
234                 if ((ks->flag & KEYINGSET_ABSOLUTE) && (id != ksp->id))
235                         eq_id= 0;
236                 
237                 /* path */
238                 if ((ksp->rna_path==0) || strcmp(rna_path, ksp->rna_path))
239                         eq_path= 0;
240                         
241                 /* index */
242                 if (ksp->array_index != array_index)
243                         eq_index= 0;
244                         
245                 /* group */
246                 if (group_name) {
247                         // FIXME: these checks need to be coded... for now, it's not too important though
248                 }
249                         
250                 /* if all aspects are ok, return */
251                 if (eq_id && eq_path && eq_index && eq_group)
252                         return ksp;
253         }
254         
255         /* none found */
256         return NULL;
257 }
258  
259 /* Defining Tools --------------------------- */
260
261 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
262 KeyingSet *BKE_keyingset_add (ListBase *list, const char name[], short flag, short keyingflag)
263 {
264         KeyingSet *ks;
265         
266         /* allocate new KeyingSet */
267         ks= MEM_callocN(sizeof(KeyingSet), "KeyingSet");
268         
269         if (name)
270                 BLI_snprintf(ks->name, 64, name);
271         else
272                 strcpy(ks->name, "Keying Set");
273         
274         ks->flag= flag;
275         ks->keyingflag= keyingflag;
276         
277         /* add KeyingSet to list */
278         BLI_addtail(list, ks);
279         
280         /* make sure KeyingSet has a unique name (this helps with identification) */
281         BLI_uniquename(list, ks, "Keying Set", ' ', offsetof(KeyingSet, name), 64);
282         
283         /* return new KeyingSet for further editing */
284         return ks;
285 }
286
287 /* Add a destination to a KeyingSet. Nothing is returned for now...
288  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
289  */
290 void BKE_keyingset_add_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode)
291 {
292         KS_Path *ksp;
293         
294         /* sanity checks */
295         if ELEM(NULL, ks, rna_path)
296                 return;
297         
298         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
299         if (id == NULL) {
300                 if (ks->flag & KEYINGSET_ABSOLUTE)
301                         return;
302         }
303         
304         /* don't add if there is already a matching KS_Path in the KeyingSet */
305         if (BKE_keyingset_find_destination(ks, id, group_name, rna_path, array_index, groupmode))
306                 return;
307         
308         /* allocate a new KeyingSet Path */
309         ksp= MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
310         
311         /* just store absolute info */
312         if (ks->flag & KEYINGSET_ABSOLUTE) {
313                 ksp->id= id;
314                 if (group_name)
315                         BLI_snprintf(ksp->group, 64, group_name);
316                 else
317                         strcpy(ksp->group, "");
318         }
319         
320         /* store additional info for relative paths (just in case user makes the set relative) */
321         if (id)
322                 ksp->idtype= GS(id->name);
323         
324         /* just copy path info */
325         // XXX no checks are performed for templates yet
326         // should array index be checked too?
327         ksp->rna_path= BLI_strdupn(rna_path, strlen(rna_path));
328         ksp->array_index= array_index;
329         
330         /* store flags */
331         ksp->flag= flag;
332         ksp->groupmode= groupmode;
333         
334         /* add KeyingSet path to KeyingSet */
335         BLI_addtail(&ks->paths, ksp);
336 }       
337
338
339 /* Freeing Tools --------------------------- */
340
341 /* Free data for KeyingSet but not set itself */
342 void BKE_keyingset_free (KeyingSet *ks)
343 {
344         KS_Path *ksp, *kspn;
345         
346         /* sanity check */
347         if (ks == NULL)
348                 return;
349         
350         /* free each path as we go to avoid looping twice */
351         for (ksp= ks->paths.first; ksp; ksp= kspn) {
352                 kspn= ksp->next;
353                 
354                 /* free RNA-path info */
355                 MEM_freeN(ksp->rna_path);
356                 
357                 /* free path itself */
358                 BLI_freelinkN(&ks->paths, ksp);
359         }
360 }
361
362 /* Free all the KeyingSets in the given list */
363 void BKE_keyingsets_free (ListBase *list)
364 {
365         KeyingSet *ks, *ksn;
366         
367         /* sanity check */
368         if (list == NULL)
369                 return;
370         
371         /* loop over KeyingSets freeing them 
372          *      - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
373          */
374         for (ks= list->first; ks; ks= ksn) {
375                 ksn= ks->next;
376                 BKE_keyingset_free(ks);
377                 BLI_freelinkN(list, ks);
378         }
379 }
380
381 /* ***************************************** */
382 /* Evaluation Data-Setting Backend */
383
384 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
385  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
386  * // 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
387  *
388  *      - remap: remapping table to use
389  *      - path: original path string (as stored in F-Curve data)
390  *      - dst: destination string to write data to
391  */
392 short animsys_remap_path (AnimMapper *remap, char *path, char **dst)
393 {
394         /* is there a valid remapping table to use? */
395         //if (remap) {
396                 /* find a matching entry... to use to remap */
397                 // ...TODO...
398         //}
399         
400         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
401         *dst= path;
402         return 0;
403 }
404
405
406 /* Write the given value to a setting using RNA, and return success */
407 static short animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_index, float value)
408 {
409         PropertyRNA *prop;
410         PointerRNA new_ptr;
411         
412         /* get property to write to */
413         if (RNA_path_resolve(ptr, path, &new_ptr, &prop)) 
414         {
415                 /* set value - only for animatable numerical values */
416                 if (RNA_property_animateable(&new_ptr, prop)) 
417                 {
418                         switch (RNA_property_type(prop)) 
419                         {
420                                 case PROP_BOOLEAN:
421                                         if (RNA_property_array_length(prop))
422                                                 RNA_property_boolean_set_index(&new_ptr, prop, array_index, (int)value);
423                                         else
424                                                 RNA_property_boolean_set(&new_ptr, prop, (int)value);
425                                         break;
426                                 case PROP_INT:
427                                         if (RNA_property_array_length(prop))
428                                                 RNA_property_int_set_index(&new_ptr, prop, array_index, (int)value);
429                                         else
430                                                 RNA_property_int_set(&new_ptr, prop, (int)value);
431                                         break;
432                                 case PROP_FLOAT:
433                                         if (RNA_property_array_length(prop))
434                                                 RNA_property_float_set_index(&new_ptr, prop, array_index, value);
435                                         else
436                                                 RNA_property_float_set(&new_ptr, prop, value);
437                                         break;
438                                 case PROP_ENUM:
439                                         RNA_property_enum_set(&new_ptr, prop, (int)value);
440                                         break;
441                                 default:
442                                         /* nothing can be done here... so it is unsuccessful? */
443                                         return 0;
444                         }
445                 }
446                 
447                 /* successful */
448                 return 1;
449         }
450         else {
451                 /* failed to get path */
452                 // XXX don't tag as failed yet though, as there are some legit situations (Action Constraint) 
453                 // where some channels will not exist, but shouldn't lock up Action
454                 if (G.f & G_DEBUG) {
455                         printf("Animato: Invalid path. ID = '%s',  '%s [%d]' \n", 
456                                 (ptr && ptr->id.data) ? (((ID *)ptr->id.data)->name+2) : "<No ID>", 
457                                 path, array_index);
458                 }
459                 return 0;
460         }
461 }
462
463 /* Simple replacement based data-setting of the FCurve using RNA */
464 static short animsys_execute_fcurve (PointerRNA *ptr, AnimMapper *remap, FCurve *fcu)
465 {
466         char *path = NULL;
467         short free_path=0;
468         short ok= 0;
469         
470         /* get path, remapped as appropriate to work in its new environment */
471         free_path= animsys_remap_path(remap, fcu->rna_path, &path);
472         
473         /* write value to setting */
474         if (path)
475                 ok= animsys_write_rna_setting(ptr, path, fcu->array_index, fcu->curval);
476         
477         /* free temp path-info */
478         if (free_path)
479                 MEM_freeN(path);
480                 
481         /* return whether we were successful */
482         return ok;
483 }
484
485 /* Evaluate all the F-Curves in the given list 
486  * This performs a set of standard checks. If extra checks are required, separate code should be used
487  */
488 static void animsys_evaluate_fcurves (PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
489 {
490         FCurve *fcu;
491         
492         /* calculate then execute each curve */
493         for (fcu= list->first; fcu; fcu= fcu->next) 
494         {
495                 /* check if this F-Curve doesn't belong to a muted group */
496                 if ((fcu->grp == NULL) || (fcu->grp->flag & AGRP_MUTED)==0) {
497                         /* check if this curve should be skipped */
498                         if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
499                         {
500                                 calculate_fcurve(fcu, ctime);
501                                 animsys_execute_fcurve(ptr, remap, fcu); 
502                         }
503                 }
504         }
505 }
506
507 /* ***************************************** */
508 /* Driver Evaluation */
509
510 /* Evaluate Drivers */
511 static void animsys_evaluate_drivers (PointerRNA *ptr, AnimData *adt, float ctime)
512 {
513         FCurve *fcu;
514         
515         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
516          * the depsgraph requested that this driver be evaluated...
517          */
518         for (fcu= adt->drivers.first; fcu; fcu= fcu->next) 
519         {
520                 ChannelDriver *driver= fcu->driver;
521                 short ok= 0;
522                 
523                 /* check if this driver's curve should be skipped */
524                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
525                 {
526                         /* check if driver itself is tagged for recalculation */
527                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID)/*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {      // XXX driver recalc flag is not set yet by depsgraph!
528                                 /* evaluate this using values set already in other places */
529                                 // 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
530                                 calculate_fcurve(fcu, ctime);
531                                 ok= animsys_execute_fcurve(ptr, NULL, fcu);
532                                 
533                                 /* clear recalc flag */
534                                 driver->flag &= ~DRIVER_FLAG_RECALC;
535                                 
536                                 /* set error-flag if evaluation failed */
537                                 if (ok == 0)
538                                         driver->flag |= DRIVER_FLAG_INVALID; 
539                         }
540                 }
541         }
542 }
543
544 /* ***************************************** */
545 /* Actions Evaluation */
546
547 /* Evaluate Action Group */
548 void animsys_evaluate_action_group (PointerRNA *ptr, bAction *act, bActionGroup *agrp, AnimMapper *remap, float ctime)
549 {
550         FCurve *fcu;
551         
552         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
553         if ELEM(NULL, act, agrp) return;
554         if ((remap) && (remap->target != act)) remap= NULL;
555         
556         /* if group is muted, don't evaluated any of the F-Curve */
557         if (agrp->flag & AGRP_MUTED)
558                 return;
559         
560         /* calculate then execute each curve */
561         for (fcu= agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu= fcu->next) 
562         {
563                 /* check if this curve should be skipped */
564                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
565                 {
566                         calculate_fcurve(fcu, ctime);
567                         animsys_execute_fcurve(ptr, remap, fcu); 
568                 }
569         }
570 }
571
572 /* Evaluate Action (F-Curve Bag) */
573 void animsys_evaluate_action (PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
574 {
575         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
576         if (act == NULL) return;
577         if ((remap) && (remap->target != act)) remap= NULL;
578         
579         /* calculate then execute each curve */
580         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
581 }
582
583 /* ***************************************** */
584 /* NLA System - Evaluation */
585
586 /* calculate influence of strip based for given frame based on blendin/out values */
587 static float nlastrip_get_influence (NlaStrip *strip, float cframe)
588 {
589         /* sanity checks - normalise the blendin/out values? */
590         strip->blendin= (float)fabs(strip->blendin);
591         strip->blendout= (float)fabs(strip->blendout);
592         
593         /* result depends on where frame is in respect to blendin/out values */
594         if (IS_EQ(strip->blendin, 0)==0 && (cframe <= (strip->start + strip->blendin))) {
595                 /* there is some blend-in */
596                 return (float)fabs(cframe - strip->start) / (strip->blendin);
597         }
598         else if (IS_EQ(strip->blendout, 0)==0 && (cframe >= (strip->end - strip->blendout))) {
599                 /* there is some blend-out */
600                 return (float)fabs(strip->end - cframe) / (strip->blendout);
601         }
602         else {
603                 /* in the middle of the strip, we should be full strength */
604                 return 1.0f;
605         }
606 }
607
608 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
609 static void nlastrip_evaluate_controls (NlaStrip *strip, float ctime)
610 {
611         /* firstly, analytically generate values for influence and time (if applicable) */
612         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
613                 strip->strip_time= nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
614         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
615                 strip->influence= nlastrip_get_influence(strip, ctime);
616         
617         /* now strip's evaluate F-Curves for these settings (if applicable) */
618         if (strip->fcurves.first) {
619                 PointerRNA strip_ptr;
620                 
621                 /* create RNA-pointer needed to set values */
622                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
623                 
624                 /* execute these settings as per normal */
625                 animsys_evaluate_fcurves(&strip_ptr, &strip->fcurves, NULL, ctime);
626         }
627 }
628
629 /* gets the strip active at the current time for a list of strips for evaluation purposes */
630 NlaEvalStrip *nlastrips_ctime_get_strip (ListBase *list, ListBase *strips, short index, float ctime)
631 {
632         NlaStrip *strip, *estrip=NULL;
633         NlaEvalStrip *nes;
634         short side= 0;
635         
636         /* loop over strips, checking if they fall within the range */
637         for (strip= strips->first; strip; strip= strip->next) {
638                 /* check if current time occurs within this strip  */
639                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
640                         /* this strip is active, so try to use it */
641                         estrip= strip;
642                         side= NES_TIME_WITHIN;
643                         break;
644                 }
645                 
646                 /* if time occurred before current strip... */
647                 if (ctime < strip->start) {
648                         if (strip == strips->first) {
649                                 /* before first strip - only try to use it if it extends backwards in time too */
650                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
651                                         estrip= strip;
652                                         
653                                 /* side is 'before' regardless of whether there's a useful strip */
654                                 side= NES_TIME_BEFORE;
655                         }
656                         else {
657                                 /* before next strip - previous strip has ended, but next hasn't begun, 
658                                  * so blending mode depends on whether strip is being held or not...
659                                  *      - only occurs when no transition strip added, otherwise the transition would have
660                                  *        been picked up above...
661                                  */
662                                 strip= strip->prev;
663                                 
664                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
665                                         estrip= strip;
666                                 side= NES_TIME_AFTER;
667                         }
668                         break;
669                 }
670                 
671                 /* if time occurred after current strip... */
672                 if (ctime > strip->end) {
673                         /* only if this is the last strip should we do anything, and only if that is being held */
674                         if (strip == strips->last) {
675                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
676                                         estrip= strip;
677                                         
678                                 side= NES_TIME_AFTER;
679                                 break;
680                         }
681                         
682                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
683                 }
684         }
685         
686         /* check if a valid strip was found
687          *      - must not be muted (i.e. will have contribution
688          */
689         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED)) 
690                 return NULL;
691                 
692         /* if ctime was not within the boundaries of the strip, clamp! */
693         switch (side) {
694                 case NES_TIME_BEFORE: /* extend first frame only */
695                         ctime= estrip->start;
696                         break;
697                 case NES_TIME_AFTER: /* extend last frame only */
698                         ctime= estrip->end;
699                         break;
700         }
701         
702         /* evaluate strip's evaluation controls  
703          *      - skip if no influence (i.e. same effect as muting the strip)
704          *      - negative influence is not supported yet... how would that be defined?
705          */
706         // TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on...
707         nlastrip_evaluate_controls(estrip, ctime);
708         if (estrip->influence <= 0.0f)
709                 return NULL;
710                 
711         /* check if strip has valid data to evaluate,
712          * and/or perform any additional type-specific actions
713          */
714         switch (estrip->type) {
715                 case NLASTRIP_TYPE_CLIP: 
716                         /* clip must have some action to evaluate */
717                         if (estrip->act == NULL)
718                                 return NULL;
719                         break;
720                 case NLASTRIP_TYPE_TRANSITION:
721                         /* there must be strips to transition from and to (i.e. prev and next required) */
722                         if (ELEM(NULL, estrip->prev, estrip->next))
723                                 return NULL;
724                                 
725                         /* evaluate controls for the relevant extents of the bordering strips... */
726                         nlastrip_evaluate_controls(estrip->prev, estrip->start);
727                         nlastrip_evaluate_controls(estrip->next, estrip->end);
728                         break;
729         }
730         
731         /* add to list of strips we need to evaluate */
732         nes= MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
733         
734         nes->strip= estrip;
735         nes->strip_mode= side;
736         nes->track_index= index;
737         nes->strip_time= estrip->strip_time;
738         
739         if (list)
740                 BLI_addtail(list, nes);
741         
742         return nes;
743 }
744
745 /* ---------------------- */
746
747 /* find an NlaEvalChannel that matches the given criteria 
748  *      - ptr and prop are the RNA data to find a match for
749  */
750 static NlaEvalChannel *nlaevalchan_find_match (ListBase *channels, PointerRNA *ptr, PropertyRNA *prop, int array_index)
751 {
752         NlaEvalChannel *nec;
753         
754         /* sanity check */
755         if (channels == NULL)
756                 return NULL;
757         
758         /* loop through existing channels, checking for a channel which affects the same property */
759         for (nec= channels->first; nec; nec= nec->next) {
760                 /* - comparing the PointerRNA's is done by comparing the pointers
761                  *   to the actual struct the property resides in, since that all the
762                  *   other data stored in PointerRNA cannot allow us to definitively 
763                  *      identify the data 
764                  */
765                 if ((nec->ptr.data == ptr->data) && (nec->prop == prop) && (nec->index == array_index))
766                         return nec;
767         }
768         
769         /* not found */
770         return NULL;
771 }
772
773 /* verify that an appropriate NlaEvalChannel for this F-Curve exists */
774 static NlaEvalChannel *nlaevalchan_verify (PointerRNA *ptr, ListBase *channels, NlaEvalStrip *nes, FCurve *fcu, short *newChan)
775 {
776         NlaEvalChannel *nec;
777         NlaStrip *strip= nes->strip;
778         PropertyRNA *prop;
779         PointerRNA new_ptr;
780         char *path = NULL;
781         short free_path=0;
782         
783         /* sanity checks */
784         if (channels == NULL)
785                 return NULL;
786         
787         /* get RNA pointer+property info from F-Curve for more convenient handling */
788                 /* get path, remapped as appropriate to work in its new environment */
789         free_path= animsys_remap_path(strip->remap, fcu->rna_path, &path);
790         
791                 /* a valid property must be available, and it must be animateable */
792         if (RNA_path_resolve(ptr, path, &new_ptr, &prop) == 0) {
793                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Cannot resolve path \n");
794                 return NULL;
795         }
796                 /* only ok if animateable */
797         else if (RNA_property_animateable(&new_ptr, prop) == 0) {
798                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Property not animateable \n");
799                 return NULL;
800         }
801         
802         /* try to find a match */
803         nec= nlaevalchan_find_match(channels, &new_ptr, prop, fcu->array_index);
804         
805         /* allocate a new struct for this if none found */
806         if (nec == NULL) {
807                 nec= MEM_callocN(sizeof(NlaEvalChannel), "NlaEvalChannel");
808                 *newChan= 1;
809                 BLI_addtail(channels, nec);
810                 
811                 nec->ptr= new_ptr; 
812                 nec->prop= prop;
813                 nec->index= fcu->array_index;
814         }
815         else
816                 *newChan= 0;
817         
818         /* we can now return */
819         return nec;
820 }
821
822 /* accumulate (i.e. blend) the given value on to the channel it affects */
823 static void nlaevalchan_accumulate (NlaEvalChannel *nec, NlaEvalStrip *nes, short newChan, float value)
824 {
825         NlaStrip *strip= nes->strip;
826         short blendmode= strip->blendmode;
827         float inf= strip->influence;
828         
829         /* if channel is new, just store value regardless of blending factors, etc. */
830         if (newChan) {
831                 nec->value= value;
832                 return;
833         }
834                 
835         /* if this is being performed as part of transition evaluation, incorporate
836          * an additional weighting factor for the influence
837          */
838         if (nes->strip_mode == NES_TIME_TRANSITION_END) 
839                 inf *= nes->strip_time;
840         
841         /* premultiply the value by the weighting factor */
842         if (IS_EQ(inf, 0)) return;
843         value *= inf;
844         
845         /* perform blending */
846         switch (blendmode) {
847                 case NLASTRIP_MODE_ADD:
848                         /* simply add the scaled value on to the stack */
849                         nec->value += value;
850                         break;
851                         
852                 case NLASTRIP_MODE_SUBTRACT:
853                         /* simply subtract the scaled value from the stack */
854                         nec->value -= value;
855                         break;
856                         
857                 case NLASTRIP_MODE_MULTIPLY:
858                         /* multiply the scaled value with the stack */
859                         nec->value *= value;
860                         break;
861                 
862                 case NLASTRIP_MODE_REPLACE:
863                 default: // TODO: do we really want to blend by default? it seems more uses might prefer add...
864                         /* do linear interpolation 
865                          *      - the influence of the accumulated data (elsewhere, that is called dstweight) 
866                          *        is 1 - influence, since the strip's influence is srcweight
867                          */
868                         nec->value= nec->value * (1.0f - inf)   +   value;
869                         break;
870         }
871 }
872
873 /* accumulate the results of a temporary buffer with the results of the full-buffer */
874 static void nlaevalchan_buffers_accumulate (ListBase *channels, ListBase *tmp_buffer, NlaEvalStrip *nes)
875 {
876         NlaEvalChannel *nec, *necn, *necd;
877         
878         /* optimise - abort if no channels */
879         if (tmp_buffer->first == NULL)
880                 return;
881         
882         /* accumulate results in tmp_channels buffer to the accumulation buffer */
883         for (nec= tmp_buffer->first; nec; nec= necn) {
884                 /* get pointer to next channel in case we remove the current channel from the temp-buffer */
885                 necn= nec->next;
886                 
887                 /* try to find an existing matching channel for this setting in the accumulation buffer */
888                 necd= nlaevalchan_find_match(channels, &nec->ptr, nec->prop, nec->index);
889                 
890                 /* if there was a matching channel already in the buffer, accumulate to it,
891                  * otherwise, add the current channel to the buffer for efficiency
892                  */
893                 if (necd)
894                         nlaevalchan_accumulate(necd, nes, 0, nec->value);
895                 else {
896                         BLI_remlink(tmp_buffer, nec);
897                         BLI_addtail(channels, nec);
898                 }
899         }
900         
901         /* free temp-channels that haven't been assimilated into the buffer */
902         BLI_freelistN(tmp_buffer);
903 }
904
905 /* ---------------------- */
906 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
907
908 /* Temporarily join two lists of modifiers together, storing the result in a third list */
909 static void nlaeval_fmodifiers_join_stacks (ListBase *result, ListBase *list1, ListBase *list2)
910 {
911         FModifier *fcm1, *fcm2;
912         
913         /* if list1 is invalid...  */
914         if ELEM(NULL, list1, list1->first) {
915                 if (list2 && list2->first) {
916                         result->first= list2->first;
917                         result->last= list2->last;
918                 }
919         }
920         /* if list 2 is invalid... */
921         else if ELEM(NULL, list2, list2->first) {
922                 result->first= list1->first;
923                 result->last= list1->last;
924         }
925         else {
926                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result 
927                  *      - the original lists must be left unchanged though, as we need that fact for restoring
928                  */
929                 result->first= list1->first;
930                 result->last= list2->last;
931                 
932                 fcm1= list1->last;
933                 fcm2= list2->first;
934                 
935                 fcm1->next= fcm2;
936                 fcm2->prev= fcm1;
937         }
938 }
939
940 /* Split two temporary lists of modifiers */
941 static void nlaeval_fmodifiers_split_stacks (ListBase *list1, ListBase *list2)
942 {
943         FModifier *fcm1, *fcm2;
944         
945         /* if list1/2 is invalid... just skip */
946         if ELEM(NULL, list1, list2)
947                 return;
948         if ELEM(NULL, list1->first, list2->first)
949                 return;
950                 
951         /* get endpoints */
952         fcm1= list1->last;
953         fcm2= list2->first;
954         
955         /* clear their links */
956         fcm1->next= NULL;
957         fcm2->prev= NULL;
958 }
959
960 /* ---------------------- */
961
962 /* evaluate action-clip strip */
963 static void nlastrip_evaluate_actionclip (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
964 {
965         ListBase tmp_modifiers = {NULL, NULL};
966         NlaStrip *strip= nes->strip;
967         FCurve *fcu;
968         float evaltime;
969         
970         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
971         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
972         
973         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
974         evaltime= evaluate_time_fmodifiers(&tmp_modifiers, NULL, 0.0f, strip->strip_time);
975         
976         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
977         for (fcu= strip->act->curves.first; fcu; fcu= fcu->next) {
978                 NlaEvalChannel *nec;
979                 float value = 0.0f;
980                 short newChan = -1;
981                 
982                 /* check if this curve should be skipped */
983                 if (fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) 
984                         continue;
985                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
986                         continue;
987                         
988                 /* evaluate the F-Curve's value for the time given in the strip 
989                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this 
990                  */
991                 value= evaluate_fcurve(fcu, evaltime);
992                 
993                 /* apply strip's F-Curve Modifiers on this value 
994                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
995                  */
996                 evaluate_value_fmodifiers(&tmp_modifiers, fcu, &value, strip->strip_time);
997                 
998                 
999                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
1000                  * stored in this channel if it has been used already
1001                  */
1002                 nec= nlaevalchan_verify(ptr, channels, nes, fcu, &newChan);
1003                 if (nec)
1004                         nlaevalchan_accumulate(nec, nes, newChan, value);
1005         }
1006         
1007         /* unlink this strip's modifiers from the parent's modifiers again */
1008         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1009 }
1010
1011 /* evaluate transition strip */
1012 static void nlastrip_evaluate_transition (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1013 {
1014         ListBase tmp_channels = {NULL, NULL};
1015         ListBase tmp_modifiers = {NULL, NULL};
1016         NlaEvalStrip tmp_nes;
1017         NlaStrip *s1, *s2;
1018         
1019         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1020         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
1021         
1022         /* get the two strips to operate on 
1023          *      - we use the endpoints of the strips directly flanking our strip
1024          *        using these as the endpoints of the transition (destination and source)
1025          *      - these should have already been determined to be valid...
1026          *      - if this strip is being played in reverse, we need to swap these endpoints
1027          *        otherwise they will be interpolated wrong
1028          */
1029         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
1030                 s1= nes->strip->next;
1031                 s2= nes->strip->prev;
1032         }
1033         else {
1034                 s1= nes->strip->prev;
1035                 s2= nes->strip->next;
1036         }
1037         
1038         /* prepare template for 'evaluation strip' 
1039          *      - based on the transition strip's evaluation strip data
1040          *      - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
1041          *      - strip_time is the 'normalised' (i.e. in-strip) time for evaluation,
1042          *        which doubles up as an additional weighting factor for the strip influences
1043          *        which allows us to appear to be 'interpolating' between the two extremes
1044          */
1045         tmp_nes= *nes;
1046         
1047         /* evaluate these strips into a temp-buffer (tmp_channels) */
1048         // FIXME: modifier evalation here needs some work...
1049                 /* first strip */
1050         tmp_nes.strip_mode= NES_TIME_TRANSITION_START;
1051         tmp_nes.strip= s1;
1052         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1053         
1054                 /* second strip */
1055         tmp_nes.strip_mode= NES_TIME_TRANSITION_END;
1056         tmp_nes.strip= s2;
1057         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1058         
1059         
1060         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1061         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1062         
1063         /* unlink this strip's modifiers from the parent's modifiers again */
1064         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
1065 }
1066
1067 /* evaluate meta-strip */
1068 static void nlastrip_evaluate_meta (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1069 {
1070         ListBase tmp_channels = {NULL, NULL};
1071         ListBase tmp_modifiers = {NULL, NULL};
1072         NlaStrip *strip= nes->strip;
1073         NlaEvalStrip *tmp_nes;
1074         float evaltime;
1075         
1076         /* meta-strip was calculated normally to have some time to be evaluated at
1077          * and here we 'look inside' the meta strip, treating it as a decorated window to
1078          * it's child strips, which get evaluated as if they were some tracks on a strip 
1079          * (but with some extra modifiers to apply).
1080          *
1081          * NOTE: keep this in sync with animsys_evaluate_nla()
1082          */
1083          
1084         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1085         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers); 
1086         
1087         /* find the child-strip to evaluate */
1088         evaltime= (nes->strip_time * (strip->end - strip->start)) + strip->start;
1089         tmp_nes= nlastrips_ctime_get_strip(NULL, &strip->strips, -1, evaltime);
1090         if (tmp_nes == NULL)
1091                 return;
1092                 
1093         /* evaluate child-strip into tmp_channels buffer before accumulating 
1094          * in the accumulation buffer
1095          */
1096         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, tmp_nes);
1097         
1098         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1099         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1100         
1101         /* free temp eval-strip */
1102         MEM_freeN(tmp_nes);
1103         
1104         /* unlink this strip's modifiers from the parent's modifiers again */
1105         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1106 }
1107
1108 /* evaluates the given evaluation strip */
1109 void nlastrip_evaluate (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1110 {
1111         NlaStrip *strip= nes->strip;
1112         
1113         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
1114          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
1115          */
1116         // TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running
1117         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
1118                 return;
1119         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
1120         
1121         /* actions to take depend on the type of strip */
1122         switch (strip->type) {
1123                 case NLASTRIP_TYPE_CLIP: /* action-clip */
1124                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes);
1125                         break;
1126                 case NLASTRIP_TYPE_TRANSITION: /* transition */
1127                         nlastrip_evaluate_transition(ptr, channels, modifiers, nes);
1128                         break;
1129                 case NLASTRIP_TYPE_META: /* meta */
1130                         nlastrip_evaluate_meta(ptr, channels, modifiers, nes);
1131                         break;
1132         }
1133         
1134         /* clear temp recursion safe-check */
1135         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
1136 }
1137
1138 /* write the accumulated settings to */
1139 void nladata_flush_channels (ListBase *channels)
1140 {
1141         NlaEvalChannel *nec;
1142         
1143         /* sanity checks */
1144         if (channels == NULL)
1145                 return;
1146         
1147         /* for each channel with accumulated values, write its value on the property it affects */
1148         for (nec= channels->first; nec; nec= nec->next) {
1149                 PointerRNA *ptr= &nec->ptr;
1150                 PropertyRNA *prop= nec->prop;
1151                 int array_index= nec->index;
1152                 float value= nec->value;
1153                 
1154                 /* write values - see animsys_write_rna_setting() to sync the code */
1155                 switch (RNA_property_type(prop)) 
1156                 {
1157                         case PROP_BOOLEAN:
1158                                 if (RNA_property_array_length(prop))
1159                                         RNA_property_boolean_set_index(ptr, prop, array_index, (int)value);
1160                                 else
1161                                         RNA_property_boolean_set(ptr, prop, (int)value);
1162                                 break;
1163                         case PROP_INT:
1164                                 if (RNA_property_array_length(prop))
1165                                         RNA_property_int_set_index(ptr, prop, array_index, (int)value);
1166                                 else
1167                                         RNA_property_int_set(ptr, prop, (int)value);
1168                                 break;
1169                         case PROP_FLOAT:
1170                                 if (RNA_property_array_length(prop))
1171                                         RNA_property_float_set_index(ptr, prop, array_index, value);
1172                                 else
1173                                         RNA_property_float_set(ptr, prop, value);
1174                                 break;
1175                         case PROP_ENUM:
1176                                 RNA_property_enum_set(ptr, prop, (int)value);
1177                                 break;
1178                         default:
1179                                 // can't do anything with other types of property....
1180                                 break;
1181                 }
1182         }
1183 }
1184
1185 /* ---------------------- */
1186
1187 /* NLA Evaluation function (mostly for use through do_animdata) 
1188  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
1189  *              some temp channels, where values can be accumulated in one go.
1190  */
1191 static void animsys_evaluate_nla (PointerRNA *ptr, AnimData *adt, float ctime)
1192 {
1193         NlaTrack *nlt;
1194         short track_index=0;
1195         
1196         ListBase estrips= {NULL, NULL};
1197         ListBase echannels= {NULL, NULL};
1198         NlaEvalStrip *nes;
1199         
1200         // TODO: need to zero out all channels used, otherwise we have problems with threadsafety
1201         // and also when the user jumps between different times instead of moving sequentially...
1202         
1203         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
1204         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next, track_index++) { 
1205                 /* if tweaking is on and this strip is the tweaking track, stop on this one */
1206                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
1207                         break;
1208                         
1209                 /* skip if we're only considering a track tagged 'solo' */
1210                 if ((adt->flag & ADT_NLA_SOLO_TRACK) && (nlt->flag & NLATRACK_SOLO)==0)
1211                         continue;
1212                 /* skip if track is muted */
1213                 if (nlt->flag & NLATRACK_MUTED) 
1214                         continue;
1215                         
1216                 /* otherwise, get strip to evaluate for this channel */
1217                 nes= nlastrips_ctime_get_strip(&estrips, &nlt->strips, track_index, ctime);
1218                 if (nes) nes->track= nlt;
1219         }
1220         
1221         /* only continue if there are strips to evaluate */
1222         if (estrips.first == NULL)
1223                 return;
1224         
1225         
1226         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
1227         for (nes= estrips.first; nes; nes= nes->next) 
1228                 nlastrip_evaluate(ptr, &echannels, NULL, nes);
1229         
1230         /* 3. flush effects of accumulating channels in NLA to the actual data they affect */
1231         nladata_flush_channels(&echannels);
1232         
1233         /* 4. free temporary evaluation data */
1234         BLI_freelistN(&estrips);
1235         BLI_freelistN(&echannels);
1236 }
1237
1238 /* ***************************************** */ 
1239 /* Overrides System - Public API */
1240
1241 /* Clear all overides */
1242
1243 /* Add or get existing Override for given setting */
1244 AnimOverride *BKE_animsys_validate_override (PointerRNA *ptr, char *path, int array_index)
1245 {
1246         // FIXME: need to define how to get overrides
1247         return NULL;
1248
1249
1250 /* -------------------- */
1251
1252 /* Evaluate Overrides */
1253 static void animsys_evaluate_overrides (PointerRNA *ptr, AnimData *adt, float ctime)
1254 {
1255         AnimOverride *aor;
1256         
1257         /* for each override, simply execute... */
1258         for (aor= adt->overrides.first; aor; aor= aor->next)
1259                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
1260 }
1261
1262 /* ***************************************** */
1263 /* Evaluation System - Public API */
1264
1265 /* Overview of how this system works:
1266  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
1267  *              that all dependences are resolved before dependants.
1268  *      2) All normal animation is evaluated, so that drivers have some basis values to
1269  *              work with
1270  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
1271  *                      which modify the effects of the NLA-stacks
1272  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
1273  *
1274  * --------------< often in a separate phase... >------------------ 
1275  *
1276  *      3) Drivers/expressions are evaluated on top of this, in an order where dependences are
1277  *              resolved nicely. 
1278  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
1279  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
1280  *
1281  * --------------< always executed >------------------ 
1282  *
1283  * Maintainance of editability of settings (XXX):
1284  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
1285  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
1286  *
1287  * Unresolved things:
1288  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
1289  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists?  
1290  */
1291
1292 /* Evaluation loop for evaluation animation data 
1293  *
1294  * This assumes that the animation-data provided belongs to the ID block in question,
1295  * and that the flags for which parts of the anim-data settings need to be recalculated 
1296  * have been set already by the depsgraph. Now, we use the recalc 
1297  */
1298 void BKE_animsys_evaluate_animdata (ID *id, AnimData *adt, float ctime, short recalc)
1299 {
1300         PointerRNA id_ptr;
1301         
1302         /* sanity checks */
1303         if ELEM(NULL, id, adt)
1304                 return;
1305         
1306         /* get pointer to ID-block for RNA to use */
1307         RNA_id_pointer_create(id, &id_ptr);
1308         
1309         /* recalculate keyframe data:
1310          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
1311          *        that overrides 'rough' work in NLA
1312          */
1313         // TODO: need to double check that this all works correctly
1314         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM))
1315         {
1316                 /* evaluate NLA data */
1317                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF))
1318                 {
1319                         /* evaluate NLA-stack */
1320                         animsys_evaluate_nla(&id_ptr, adt, ctime);
1321                         
1322                         /* evaluate 'active' Action (may be tweaking track) on top of results of NLA-evaluation 
1323                          *      - only do this if we're not exclusively evaluating the 'solo' NLA-track
1324                          */
1325                         if ((adt->action) && !(adt->flag & ADT_NLA_SOLO_TRACK))
1326                                 animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
1327                 }
1328                 /* evaluate Active Action only */
1329                 else if (adt->action)
1330                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
1331                 
1332                 /* reset tag */
1333                 adt->recalc &= ~ADT_RECALC_ANIM;
1334         }
1335         
1336         /* recalculate drivers 
1337          *      - Drivers need to be evaluated afterwards, as they can either override 
1338          *        or be layered on top of existing animation data.
1339          *      - Drivers should be in the appropriate order to be evaluated without problems...
1340          */
1341         if ((recalc & ADT_RECALC_DRIVERS) /*&& (adt->recalc & ADT_RECALC_DRIVERS)*/) // XXX for now, don't check yet, as depsgraph hasn't been updated
1342         {
1343                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
1344         }
1345         
1346         /* always execute 'overrides' 
1347          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
1348          *        value last set by the user (and not keyframed yet). 
1349          *      - Overrides are cleared upon frame change and/or keyframing
1350          *      - It is best that we execute this everytime, so that no errors are likely to occur.
1351          */
1352         animsys_evaluate_overrides(&id_ptr, adt, ctime);
1353         
1354         /* clear recalc flag now */
1355         adt->recalc= 0;
1356 }
1357
1358 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
1359  *
1360  * This will evaluate only the animation info available in the animation data-blocks
1361  * encountered. In order to enforce the system by which some settings controlled by a
1362  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
1363  * standard 'root') block are overridden by a larger 'user'
1364  */
1365 // TODO: we currently go over entire 'main' database...
1366 void BKE_animsys_evaluate_all_animation (Main *main, float ctime)
1367 {
1368         ID *id;
1369         
1370         if (G.f & G_DEBUG)
1371                 printf("Evaluate all animation - %f \n", ctime);
1372
1373         /* macro for less typing */
1374 #define EVAL_ANIM_IDS(first, flag) \
1375         for (id= first; id; id= id->next) { \
1376                 AnimData *adt= BKE_animdata_from_id(id); \
1377                 BKE_animsys_evaluate_animdata(id, adt, ctime, flag); \
1378         }
1379         
1380         /* nodes */
1381         // TODO...
1382         
1383         /* textures */
1384         EVAL_ANIM_IDS(main->tex.first, ADT_RECALC_ANIM);
1385         
1386         /* lamps */
1387         EVAL_ANIM_IDS(main->lamp.first, ADT_RECALC_ANIM);
1388         
1389         /* materials */
1390         EVAL_ANIM_IDS(main->mat.first, ADT_RECALC_ANIM);
1391         
1392         /* cameras */
1393         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
1394         
1395         /* shapekeys */
1396                 // TODO: we probably need the same hack as for curves (ctime-hack)
1397         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
1398         
1399         /* curves */
1400                 /* we need to perform a special hack here to ensure that the ctime 
1401                  * value of the curve gets set in case there's no animation for that
1402                  *      - it needs to be set before animation is evaluated just so that 
1403                  *        animation can successfully override...
1404                  */
1405         for (id= main->curve.first; id; id= id->next) {
1406                 AnimData *adt= BKE_animdata_from_id(id);
1407                 Curve *cu= (Curve *)id;
1408                 
1409                 cu->ctime= ctime;
1410                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM);
1411         }
1412         
1413         /* meshes */
1414         // TODO...
1415         
1416         /* particles */
1417         EVAL_ANIM_IDS(main->particle.first, ADT_RECALC_ANIM);
1418         
1419         /* objects */
1420                 /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets 
1421                  * this tagged by Depsgraph on framechange 
1422                  */
1423         EVAL_ANIM_IDS(main->object.first, /*ADT_RECALC_ANIM*/0); 
1424         
1425         /* worlds */
1426         EVAL_ANIM_IDS(main->world.first, ADT_RECALC_ANIM);
1427         
1428         /* scenes */
1429         EVAL_ANIM_IDS(main->scene.first, ADT_RECALC_ANIM);
1430 }
1431
1432 /* ***************************************** */