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