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