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