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