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