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