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