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