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