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