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