svn merge ^/trunk/blender -r44562:45364
[blender.git] / source / blender / editors / animation / keyingsets.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joshua Leung (full recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/animation/keyingsets.c
29  *  \ingroup edanimation
30  */
31
32  
33 #include <stdio.h>
34 #include <stddef.h>
35 #include <string.h>
36 #include <math.h>
37 #include <float.h>
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_blenlib.h"
42 #include "BLI_math.h"
43 #include "BLI_dynstr.h"
44 #include "BLI_utildefines.h"
45
46 #include "DNA_anim_types.h"
47 #include "DNA_scene_types.h"
48 #include "DNA_object_types.h"
49
50 #include "BKE_main.h"
51 #include "BKE_animsys.h"
52 #include "BKE_context.h"
53 #include "BKE_depsgraph.h"
54 #include "BKE_report.h"
55
56 #include "ED_keyframing.h"
57 #include "ED_screen.h"
58
59 #include "UI_interface.h"
60 #include "UI_resources.h"
61
62 #include "WM_api.h"
63 #include "WM_types.h"
64
65 #include "RNA_access.h"
66 #include "RNA_define.h"
67 #include "RNA_enum_types.h"
68
69 #include "anim_intern.h"
70
71 /* ************************************************** */
72 /* KEYING SETS - OPERATORS (for use in UI panels) */
73 /* These operators are really duplication of existing functionality, but just for completeness,
74  * they're here too, and will give the basic data needed...
75  */
76
77 /* poll callback for adding default KeyingSet */
78 static int keyingset_poll_default_add (bContext *C)
79 {
80         /* as long as there's an active Scene, it's fine */
81         return (CTX_data_scene(C) != NULL);
82 }
83
84 /* poll callback for editing active KeyingSet */
85 static int keyingset_poll_active_edit (bContext *C)
86 {
87         Scene *scene= CTX_data_scene(C);
88         
89         if (scene == NULL)
90                 return 0;
91         
92         /* there must be an active KeyingSet (and KeyingSets) */
93         return ((scene->active_keyingset > 0) && (scene->keyingsets.first));
94 }
95
96 /* poll callback for editing active KeyingSet Path */
97 static int keyingset_poll_activePath_edit (bContext *C)
98 {
99         Scene *scene= CTX_data_scene(C);
100         KeyingSet *ks;
101         
102         if (scene == NULL)
103                 return 0;
104         if (scene->active_keyingset <= 0)
105                 return 0;
106         else
107                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
108         
109         /* there must be an active KeyingSet and an active path */
110         return ((ks) && (ks->paths.first) && (ks->active_path > 0));
111 }
112
113  
114 /* Add a Default (Empty) Keying Set ------------------------- */
115
116 static int add_default_keyingset_exec (bContext *C, wmOperator *UNUSED(op))
117 {
118         Scene *scene= CTX_data_scene(C);
119         short flag=0, keyingflag=0;
120         
121         /* validate flags 
122          *      - absolute KeyingSets should be created by default
123          */
124         flag |= KEYINGSET_ABSOLUTE;
125         
126         /* 2nd arg is 0 to indicate that we don't want to include autokeying mode related settings */
127         keyingflag = ANIM_get_keyframing_flags(scene, 0);
128         
129         /* call the API func, and set the active keyingset index */
130         BKE_keyingset_add(&scene->keyingsets, NULL, NULL, flag, keyingflag);
131         
132         scene->active_keyingset= BLI_countlist(&scene->keyingsets);
133         
134         /* send notifiers */
135         WM_event_add_notifier(C, NC_SCENE|ND_KEYINGSET, NULL);
136         
137         return OPERATOR_FINISHED;
138 }
139
140 void ANIM_OT_keying_set_add (wmOperatorType *ot)
141 {
142         /* identifiers */
143         ot->name = "Add Empty Keying Set";
144         ot->idname = "ANIM_OT_keying_set_add";
145         ot->description = "Add a new (empty) Keying Set to the active Scene";
146         
147         /* callbacks */
148         ot->exec = add_default_keyingset_exec;
149         ot->poll = keyingset_poll_default_add;
150 }
151
152 /* Remove 'Active' Keying Set ------------------------- */
153
154 static int remove_active_keyingset_exec (bContext *C, wmOperator *op)
155 {
156         Scene *scene= CTX_data_scene(C);
157         KeyingSet *ks;
158         
159         /* verify the Keying Set to use:
160          *      - use the active one
161          *      - return error if it doesn't exist
162          */
163         if (scene->active_keyingset == 0) {
164                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set to remove");
165                 return OPERATOR_CANCELLED;
166         }
167         else if (scene->active_keyingset < 0) {
168                 BKE_report(op->reports, RPT_ERROR, "Cannot remove built in Keying Set");
169                 return OPERATOR_CANCELLED;
170         }
171         else
172                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
173         
174         /* free KeyingSet's data, then remove it from the scene */
175         BKE_keyingset_free(ks);
176         BLI_freelinkN(&scene->keyingsets, ks);
177         
178         /* the active one should now be the previously second-to-last one */
179         scene->active_keyingset--;
180         
181         /* send notifiers */
182         WM_event_add_notifier(C, NC_SCENE|ND_KEYINGSET, NULL);
183         
184         return OPERATOR_FINISHED;
185 }
186
187 void ANIM_OT_keying_set_remove (wmOperatorType *ot)
188 {
189         /* identifiers */
190         ot->name = "Remove Active Keying Set";
191         ot->idname = "ANIM_OT_keying_set_remove";
192         ot->description = "Remove the active Keying Set";
193         
194         /* callbacks */
195         ot->exec = remove_active_keyingset_exec;
196         ot->poll = keyingset_poll_active_edit;
197 }
198
199 /* Add Empty Keying Set Path ------------------------- */
200
201 static int add_empty_ks_path_exec (bContext *C, wmOperator *op)
202 {
203         Scene *scene= CTX_data_scene(C);
204         KeyingSet *ks;
205         KS_Path *ksp;
206         
207         /* verify the Keying Set to use:
208          *      - use the active one
209          *      - return error if it doesn't exist
210          */
211         if (scene->active_keyingset == 0) {
212                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set to add empty path to");
213                 return OPERATOR_CANCELLED;
214         }
215         else
216                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
217         
218         /* don't use the API method for this, since that checks on values... */
219         ksp= MEM_callocN(sizeof(KS_Path), "KeyingSetPath Empty");
220         BLI_addtail(&ks->paths, ksp);
221         ks->active_path= BLI_countlist(&ks->paths);
222         
223         ksp->groupmode= KSP_GROUP_KSNAME; // XXX?
224         ksp->idtype= ID_OB;
225         ksp->flag= KSP_FLAG_WHOLE_ARRAY;
226         
227         return OPERATOR_FINISHED;
228 }
229
230 void ANIM_OT_keying_set_path_add (wmOperatorType *ot)
231 {
232         /* identifiers */
233         ot->name = "Add Empty Keying Set Path";
234         ot->idname = "ANIM_OT_keying_set_path_add";
235         ot->description = "Add empty path to active Keying Set";
236         
237         /* callbacks */
238         ot->exec = add_empty_ks_path_exec;
239         ot->poll = keyingset_poll_active_edit;
240 }
241
242 /* Remove Active Keying Set Path ------------------------- */
243
244 static int remove_active_ks_path_exec (bContext *C, wmOperator *op)
245 {
246         Scene *scene= CTX_data_scene(C);
247         KeyingSet *ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
248         
249         /* if there is a KeyingSet, find the nominated path to remove */
250         if (ks) {
251                 KS_Path *ksp= BLI_findlink(&ks->paths, ks->active_path-1);
252                 
253                 if (ksp) {
254                         /* remove the active path from the KeyingSet */
255                         BKE_keyingset_free_path(ks, ksp);
256                         
257                         /* the active path should now be the previously second-to-last active one */
258                         ks->active_path--;
259                 }
260                 else {
261                         BKE_report(op->reports, RPT_ERROR, "No active Keying Set Path to remove");
262                         return OPERATOR_CANCELLED;
263                 }
264         }
265         else {
266                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set to remove a path from");
267                 return OPERATOR_CANCELLED;
268         }
269         
270         return OPERATOR_FINISHED;
271 }
272
273 void ANIM_OT_keying_set_path_remove (wmOperatorType *ot)
274 {
275         /* identifiers */
276         ot->name = "Remove Active Keying Set Path";
277         ot->idname = "ANIM_OT_keying_set_path_remove";
278         ot->description = "Remove active Path from active Keying Set";
279         
280         /* callbacks */
281         ot->exec = remove_active_ks_path_exec;
282         ot->poll = keyingset_poll_activePath_edit;
283 }
284
285 /* ************************************************** */
286 /* KEYING SETS - OPERATORS (for use in UI menus) */
287
288 /* Add to KeyingSet Button Operator ------------------------ */
289
290 static int add_keyingset_button_exec (bContext *C, wmOperator *op)
291 {
292         Main *bmain= CTX_data_main(C);
293         Scene *scene= CTX_data_scene(C);
294         KeyingSet *ks = NULL;
295         PropertyRNA *prop= NULL;
296         PointerRNA ptr= {{NULL}};
297         char *path = NULL;
298         short success= 0;
299         int index=0, pflag=0;
300         int all= RNA_boolean_get(op->ptr, "all");
301         
302         /* verify the Keying Set to use:
303          *      - use the active one for now (more control over this can be added later)
304          *      - add a new one if it doesn't exist 
305          */
306         if (scene->active_keyingset == 0) {
307                 short flag=0, keyingflag=0;
308                 
309                 /* validate flags 
310                  *      - absolute KeyingSets should be created by default
311                  */
312                 flag |= KEYINGSET_ABSOLUTE;
313                 
314                 keyingflag |= ANIM_get_keyframing_flags(scene, 0);
315                 
316                 if (IS_AUTOKEY_FLAG(scene, XYZ2RGB)) 
317                         keyingflag |= INSERTKEY_XYZ2RGB;
318                         
319                 /* call the API func, and set the active keyingset index */
320                 ks= BKE_keyingset_add(&scene->keyingsets, "ButtonKeyingSet", "Button Keying Set", flag, keyingflag);
321                 
322                 scene->active_keyingset= BLI_countlist(&scene->keyingsets);
323         }
324         else if (scene->active_keyingset < 0) {
325                 BKE_report(op->reports, RPT_ERROR, "Cannot add property to built in Keying Set");
326                 return OPERATOR_CANCELLED;
327         }
328         else
329                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
330         
331         /* try to add to keyingset using property retrieved from UI */
332         uiContextActiveProperty(C, &ptr, &prop, &index);
333         
334         /* check if property is able to be added */
335         if (ptr.id.data && ptr.data && prop && RNA_property_animateable(&ptr, prop)) {
336                 path= RNA_path_from_ID_to_property(&ptr, prop);
337                 
338                 if (path) {
339                         /* set flags */
340                         if (all) {
341                                 pflag |= KSP_FLAG_WHOLE_ARRAY;
342                                 
343                                 /* we need to set the index for this to 0, even though it may break in some cases, this is 
344                                  * necessary if we want the entire array for most cases to get included without the user
345                                  * having to worry about where they clicked
346                                  */
347                                 index= 0;
348                         }
349                                 
350                         /* add path to this setting */
351                         BKE_keyingset_add_path(ks, ptr.id.data, NULL, path, index, pflag, KSP_GROUP_KSNAME);
352                         ks->active_path= BLI_countlist(&ks->paths);
353                         success= 1;
354                         
355                         /* free the temp path created */
356                         MEM_freeN(path);
357                 }
358         }
359         
360         if (success) {
361                 /* send updates */
362                 DAG_ids_flush_update(bmain, 0);
363                 
364                 /* for now, only send ND_KEYS for KeyingSets */
365                 WM_event_add_notifier(C, NC_SCENE|ND_KEYINGSET, NULL);
366         }
367         
368         return (success)? OPERATOR_FINISHED: OPERATOR_CANCELLED;
369 }
370
371 void ANIM_OT_keyingset_button_add (wmOperatorType *ot)
372 {
373         /* identifiers */
374         ot->name = "Add to Keying Set";
375         ot->idname = "ANIM_OT_keyingset_button_add";
376         
377         /* callbacks */
378         ot->exec = add_keyingset_button_exec; 
379         //op->poll= ???
380         
381         /* flags */
382         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
383
384         /* properties */
385         RNA_def_boolean(ot->srna, "all", 1, "All", "Add all elements of the array to a Keying Set");
386 }
387
388 /* Remove from KeyingSet Button Operator ------------------------ */
389
390 static int remove_keyingset_button_exec (bContext *C, wmOperator *op)
391 {
392         Main *bmain= CTX_data_main(C);
393         Scene *scene= CTX_data_scene(C);
394         KeyingSet *ks = NULL;
395         PropertyRNA *prop= NULL;
396         PointerRNA ptr= {{NULL}};
397         char *path = NULL;
398         short success= 0;
399         int index=0;
400         
401         /* verify the Keying Set to use:
402          *      - use the active one for now (more control over this can be added later)
403          *      - return error if it doesn't exist
404          */
405         if (scene->active_keyingset == 0) {
406                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set to remove property from");
407                 return OPERATOR_CANCELLED;
408         }
409         else if (scene->active_keyingset < 0) {
410                 BKE_report(op->reports, RPT_ERROR, "Cannot remove property from built in Keying Set");
411                 return OPERATOR_CANCELLED;
412         }
413         else
414                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
415         
416         /* try to add to keyingset using property retrieved from UI */
417         uiContextActiveProperty(C, &ptr, &prop, &index);
418
419         if (ptr.id.data && ptr.data && prop) {
420                 path= RNA_path_from_ID_to_property(&ptr, prop);
421                 
422                 if (path) {
423                         KS_Path *ksp;
424                         
425                         /* try to find a path matching this description */
426                         ksp= BKE_keyingset_find_path(ks, ptr.id.data, ks->name, path, index, KSP_GROUP_KSNAME);
427
428                         if (ksp) {
429                                 BKE_keyingset_free_path(ks, ksp);
430                                 success= 1;
431                         }
432                         
433                         /* free temp path used */
434                         MEM_freeN(path);
435                 }
436         }
437         
438         
439         if (success) {
440                 /* send updates */
441                 DAG_ids_flush_update(bmain, 0);
442                 
443                 /* for now, only send ND_KEYS for KeyingSets */
444                 WM_event_add_notifier(C, NC_SCENE|ND_KEYINGSET, NULL);
445         }
446         
447         return (success)? OPERATOR_FINISHED: OPERATOR_CANCELLED;
448 }
449
450 void ANIM_OT_keyingset_button_remove (wmOperatorType *ot)
451 {
452         /* identifiers */
453         ot->name = "Remove from Keying Set";
454         ot->idname = "ANIM_OT_keyingset_button_remove";
455         
456         /* callbacks */
457         ot->exec = remove_keyingset_button_exec; 
458         //op->poll= ???
459         
460         /* flags */
461         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
462 }
463
464 /* ******************************************* */
465
466 /* Change Active KeyingSet Operator ------------------------ */
467 /* This operator checks if a menu should be shown for choosing the KeyingSet to make the active one */
468
469 static int keyingset_active_menu_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED(event))
470 {
471         uiPopupMenu *pup;
472         uiLayout *layout;
473         
474         /* call the menu, which will call this operator again, hence the canceled */
475         pup = uiPupMenuBegin(C, op->type->name, ICON_NONE);
476         layout = uiPupMenuLayout(pup);
477         uiItemsEnumO(layout, "ANIM_OT_keying_set_active_set", "type");
478         uiPupMenuEnd(C, pup);
479         
480         return OPERATOR_CANCELLED;
481 }
482
483 static int keyingset_active_menu_exec (bContext *C, wmOperator *op)
484 {
485         Scene *scene = CTX_data_scene(C);
486         int type = RNA_enum_get(op->ptr, "type");
487         
488         /* If type == 0, it will deselect any active keying set. */
489         scene->active_keyingset = type;
490         
491         /* send notifiers */
492         WM_event_add_notifier(C, NC_SCENE|ND_KEYINGSET, NULL);
493         
494         return OPERATOR_FINISHED;
495 }
496  
497 void ANIM_OT_keying_set_active_set (wmOperatorType *ot)
498 {
499         PropertyRNA *prop;
500         
501         /* identifiers */
502         ot->name = "Set Active Keying Set";
503         ot->idname = "ANIM_OT_keying_set_active_set";
504         
505         /* callbacks */
506         ot->invoke = keyingset_active_menu_invoke;
507         ot->exec = keyingset_active_menu_exec; 
508         ot->poll = ED_operator_areaactive;
509         
510         /* flags */
511         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
512         
513         /* keyingset to use (dynamic enum) */
514         prop= RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
515         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
516 /*      RNA_def_property_flag(prop, PROP_HIDDEN);*/
517 }
518
519 /* ******************************************* */
520 /* REGISTERED KEYING SETS */
521
522 /* Keying Set Type Info declarations */
523 static ListBase keyingset_type_infos = {NULL, NULL};
524
525 /* Built-In Keying Sets (referencing type infos)*/
526 ListBase builtin_keyingsets = {NULL, NULL};
527
528 /* --------------- */
529
530 /* Find KeyingSet type info given a name */
531 KeyingSetInfo *ANIM_keyingset_info_find_named (const char name[])
532 {
533         /* sanity checks */
534         if ((name == NULL) || (name[0] == 0))
535                 return NULL;
536                 
537         /* search by comparing names */
538         return BLI_findstring(&keyingset_type_infos, name, offsetof(KeyingSetInfo, idname));
539 }
540
541 /* Find builtin KeyingSet by name */
542 KeyingSet *ANIM_builtin_keyingset_get_named (KeyingSet *prevKS, const char name[])
543 {
544         KeyingSet *ks, *first=NULL;
545         
546         /* sanity checks  any name to check? */
547         if (name[0] == 0)
548                 return NULL;
549         
550         /* get first KeyingSet to use */
551         if (prevKS && prevKS->next)
552                 first= prevKS->next;
553         else
554                 first= builtin_keyingsets.first;
555         
556         /* loop over KeyingSets checking names */
557         for (ks= first; ks; ks= ks->next) {
558                 if (strcmp(name, ks->idname) == 0)
559                         return ks;
560         }
561
562         /* complain about missing keying sets on debug builds */
563 #ifndef NDEBUG
564         printf("%s: '%s' not found\n", __func__, name);
565 #endif
566
567         /* no matches found */
568         return NULL;
569 }
570
571 /* --------------- */
572
573 /* Add the given KeyingSetInfo to the list of type infos, and create an appropriate builtin set too */
574 void ANIM_keyingset_info_register (KeyingSetInfo *ksi)
575 {
576         KeyingSet *ks;
577         
578         /* create a new KeyingSet 
579          *      - inherit name and keyframing settings from the typeinfo
580          */
581         ks = BKE_keyingset_add(&builtin_keyingsets, ksi->idname, ksi->name, 1, ksi->keyingflag);
582         
583         /* link this KeyingSet with its typeinfo */
584         memcpy(&ks->typeinfo, ksi->idname, sizeof(ks->typeinfo));
585         
586         /* Copy description... */
587         BLI_strncpy(ks->description, ksi->description, sizeof(ks->description));
588         
589         /* add type-info to the list */
590         BLI_addtail(&keyingset_type_infos, ksi);
591 }
592
593 /* Remove the given KeyingSetInfo from the list of type infos, and also remove the builtin set if appropriate */
594 void ANIM_keyingset_info_unregister (Main *bmain, KeyingSetInfo *ksi)
595 {
596         KeyingSet *ks, *ksn;
597         
598         /* find relevant builtin KeyingSets which use this, and remove them */
599         // TODO: this isn't done now, since unregister is really only used atm when we
600         // reload the scripts, which kindof defeats the purpose of "builtin"?
601         for (ks= builtin_keyingsets.first; ks; ks= ksn) {
602                 ksn = ks->next;
603                 
604                 /* remove if matching typeinfo name */
605                 if (strcmp(ks->typeinfo, ksi->idname) == 0) {
606                         Scene *scene;
607                         BKE_keyingset_free(ks);
608                         BLI_remlink(&builtin_keyingsets, ks);
609
610                         for (scene= bmain->scene.first; scene; scene= scene->id.next)
611                                 BLI_remlink_safe(&scene->keyingsets, ks);
612
613                         MEM_freeN(ks);
614                 }
615         }
616         
617         /* free the type info */
618         BLI_freelinkN(&keyingset_type_infos, ksi);
619 }
620
621 /* --------------- */
622
623 void ANIM_keyingset_infos_exit (void)
624 {
625         KeyingSetInfo *ksi, *next;
626         
627         /* free type infos */
628         for (ksi=keyingset_type_infos.first; ksi; ksi=next) {
629                 next= ksi->next;
630                 
631                 /* free extra RNA data, and remove from list */
632                 if (ksi->ext.free)
633                         ksi->ext.free(ksi->ext.data);
634                 BLI_freelinkN(&keyingset_type_infos, ksi);
635         }
636         
637         /* free builtin sets */
638         BKE_keyingsets_free(&builtin_keyingsets);
639 }
640
641 /* ******************************************* */
642 /* KEYING SETS API (for UI) */
643
644 /* Getters for Active/Indices ----------------------------- */
645
646 /* Get the active Keying Set for the Scene provided */
647 KeyingSet *ANIM_scene_get_active_keyingset (Scene *scene)
648 {
649         /* if no scene, we've got no hope of finding the Keying Set */
650         if (scene == NULL)
651                 return NULL;
652         
653         /* currently, there are several possibilities here:
654          *      -   0: no active keying set
655          *      - > 0: one of the user-defined Keying Sets, but indices start from 0 (hence the -1)
656          *      - < 0: a builtin keying set
657          */
658         if (scene->active_keyingset > 0)
659                 return BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
660         else
661                 return BLI_findlink(&builtin_keyingsets, (-scene->active_keyingset)-1);
662 }
663
664 /* Get the index of the Keying Set provided, for the given Scene */
665 int ANIM_scene_get_keyingset_index (Scene *scene, KeyingSet *ks)
666 {
667         int index;
668         
669         /* if no KeyingSet provided, have none */
670         if (ks == NULL)
671                 return 0;
672         
673         /* check if the KeyingSet exists in scene list */
674         if (scene) {
675                 /* get index and if valid, return 
676                  *      - (absolute) Scene KeyingSets are from (>= 1)
677                  */
678                 index = BLI_findindex(&scene->keyingsets, ks);
679                 if (index != -1)
680                         return (index + 1);
681         }
682         
683         /* still here, so try builtins list too 
684          *      - builtins are from (<= -1)
685          *      - none/invalid is (= 0)
686          */
687         index = BLI_findindex(&builtin_keyingsets, ks);
688         if (index != -1)
689                 return -(index + 1);
690         else
691                 return 0;
692 }
693
694 /* Get Keying Set to use for Auto-Keyframing some transforms */
695 KeyingSet *ANIM_get_keyingset_for_autokeying(Scene *scene, const char *tranformKSName)
696 {
697         /* get KeyingSet to use 
698          *      - use the active KeyingSet if defined (and user wants to use it for all autokeying), 
699          *        or otherwise key transforms only
700          */
701         if (IS_AUTOKEY_FLAG(scene, ONLYKEYINGSET) && (scene->active_keyingset))
702                 return ANIM_scene_get_active_keyingset(scene);
703         else if (IS_AUTOKEY_FLAG(scene, INSERTAVAIL))
704                 return ANIM_builtin_keyingset_get_named(NULL, ANIM_KS_AVAILABLE_ID);
705         else 
706                 return ANIM_builtin_keyingset_get_named(NULL, tranformKSName);
707 }
708
709 /* Menu of All Keying Sets ----------------------------- */
710
711 /* Dynamically populate an enum of Keying Sets */
712 EnumPropertyItem *ANIM_keying_sets_enum_itemf (bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop), int *free)
713 {
714         Scene *scene = CTX_data_scene(C);
715         KeyingSet *ks;
716         EnumPropertyItem *item= NULL, item_tmp= {0};
717         int totitem= 0;
718         int i= 0;
719
720         if (C == NULL) {
721                 return DummyRNA_DEFAULT_items;
722         }
723         
724         /* active Keying Set 
725          *      - only include entry if it exists
726          */
727         if (scene->active_keyingset) {
728                 /* active Keying Set */
729                 item_tmp.identifier= "__ACTIVE__";
730                 item_tmp.name= "Active Keying Set";
731                 item_tmp.value= i;
732                 RNA_enum_item_add(&item, &totitem, &item_tmp);
733                 
734                 /* separator */
735                 RNA_enum_item_add_separator(&item, &totitem);
736         }
737         
738         i++;
739         
740         /* user-defined Keying Sets 
741          *      - these are listed in the order in which they were defined for the active scene
742          */
743         if (scene->keyingsets.first) {
744                 for (ks= scene->keyingsets.first; ks; ks= ks->next, i++) {
745                         if (ANIM_keyingset_context_ok_poll(C, ks)) {
746                                 item_tmp.identifier = ks->idname;
747                                 item_tmp.name = ks->name;
748                                 item_tmp.description = ks->description;
749                                 item_tmp.value= i;
750                                 RNA_enum_item_add(&item, &totitem, &item_tmp);
751                         }
752                 }
753                 
754                 /* separator */
755                 RNA_enum_item_add_separator(&item, &totitem);
756         }
757         
758         /* builtin Keying Sets */
759         i= -1;
760         for (ks= builtin_keyingsets.first; ks; ks= ks->next, i--) {
761                 /* only show KeyingSet if context is suitable */
762                 if (ANIM_keyingset_context_ok_poll(C, ks)) {
763                         item_tmp.identifier = ks->idname;
764                         item_tmp.name = ks->name;
765                         item_tmp.description = ks->description;
766                         item_tmp.value= i;
767                         RNA_enum_item_add(&item, &totitem, &item_tmp);
768                 }
769         }
770
771         RNA_enum_item_end(&item, &totitem);
772         *free= 1;
773
774         return item;
775 }
776
777 /* ******************************************* */
778 /* KEYFRAME MODIFICATION */
779
780 /* Polling API ----------------------------------------------- */
781
782 /* Check if KeyingSet can be used in the current context */
783 short ANIM_keyingset_context_ok_poll (bContext *C, KeyingSet *ks)
784 {
785         if ((ks->flag & KEYINGSET_ABSOLUTE) == 0) {
786                 KeyingSetInfo *ksi = ANIM_keyingset_info_find_named(ks->typeinfo);
787                 
788                 /* get the associated 'type info' for this KeyingSet */
789                 if (ksi == NULL)
790                         return 0;
791                 // TODO: check for missing callbacks!
792                 
793                 /* check if it can be used in the current context */
794                 return (ksi->poll(ksi, C));
795         }
796         
797         return 1;
798 }
799
800 /* Special 'Overrides' Iterator for Relative KeyingSets ------ */
801
802 /* 'Data Sources' for relative Keying Set 'overrides' 
803  *      - this is basically a wrapper for PointerRNA's in a linked list
804  *      - do not allow this to be accessed from outside for now
805  */
806 typedef struct tRKS_DSource {
807         struct tRKS_DSource *next, *prev;
808         PointerRNA ptr;         /* the whole point of this exercise! */
809 } tRKS_DSource;
810
811
812 /* Iterator used for overriding the behavior of iterators defined for 
813  * relative Keying Sets, with the main usage of this being operators 
814  * requiring Auto Keyframing. Internal Use Only!
815  */
816 static void RKS_ITER_overrides_list (KeyingSetInfo *ksi, bContext *C, KeyingSet *ks, ListBase *dsources)
817 {
818         tRKS_DSource *ds;
819         
820         for (ds = dsources->first; ds; ds = ds->next) {
821                 /* run generate callback on this data */
822                 ksi->generate(ksi, C, ks, &ds->ptr);
823         }
824 }
825
826 /* Add new data source for relative Keying Sets */
827 void ANIM_relative_keyingset_add_source (ListBase *dsources, ID *id, StructRNA *srna, void *data)
828 {
829         tRKS_DSource *ds;
830         
831         /* sanity checks 
832          *      - we must have somewhere to output the data
833          *      - we must have both srna+data (and with id too optionally), or id by itself only
834          */
835         if (dsources == NULL)
836                 return;
837         if (ELEM(NULL, srna, data) && (id == NULL))
838                 return;
839         
840         /* allocate new elem, and add to the list */
841         ds = MEM_callocN(sizeof(tRKS_DSource), "tRKS_DSource");
842         BLI_addtail(dsources, ds);
843         
844         /* depending on what data we have, create using ID or full pointer call */
845         if (srna && data)
846                 RNA_pointer_create(id, srna, data, &ds->ptr);
847         else
848                 RNA_id_pointer_create(id, &ds->ptr);
849 }
850
851 /* KeyingSet Operations (Insert/Delete Keyframes) ------------ */
852
853 /* Given a KeyingSet and context info, validate Keying Set's paths.
854  * This is only really necessary with relative/built-in KeyingSets
855  * where their list of paths is dynamically generated based on the
856  * current context info.
857  *
858  * Returns 0 if succeeded, otherwise an error code: eModifyKey_Returns
859  */
860 short ANIM_validate_keyingset (bContext *C, ListBase *dsources, KeyingSet *ks)
861 {
862         /* sanity check */
863         if (ks == NULL)
864                 return 0;
865         
866         /* if relative Keying Sets, poll and build up the paths */
867         if ((ks->flag & KEYINGSET_ABSOLUTE) == 0) {
868                 KeyingSetInfo *ksi = ANIM_keyingset_info_find_named(ks->typeinfo);
869                 
870                 /* clear all existing paths 
871                  * NOTE: BKE_keyingset_free() frees all of the paths for the KeyingSet, but not the set itself
872                  */
873                 BKE_keyingset_free(ks);
874                 
875                 /* get the associated 'type info' for this KeyingSet */
876                 if (ksi == NULL)
877                         return MODIFYKEY_MISSING_TYPEINFO;
878                 // TODO: check for missing callbacks!
879                 
880                 /* check if it can be used in the current context */
881                 if (ksi->poll(ksi, C)) {
882                         /* if a list of data sources are provided, run a special iterator over them,
883                          * otherwise, just continue per normal
884                          */
885                         if (dsources) 
886                                 RKS_ITER_overrides_list(ksi, C, ks, dsources);
887                         else
888                                 ksi->iter(ksi, C, ks);
889                                 
890                         /* if we don't have any paths now, then this still qualifies as invalid context */
891                         if (ks->paths.first == NULL)
892                                 return MODIFYKEY_INVALID_CONTEXT;
893                 }
894                 else {
895                         /* poll callback tells us that KeyingSet is useless in current context */
896                         return MODIFYKEY_INVALID_CONTEXT;
897                 }
898         }
899         
900         /* succeeded; return 0 to tag error free */
901         return 0;
902
903
904 /* Given a KeyingSet and context info (if required), modify keyframes for the channels specified
905  * by the KeyingSet. This takes into account many of the different combinations of using KeyingSets.
906  * Returns the number of channels that keyframes were added to
907  */
908 int ANIM_apply_keyingset (bContext *C, ListBase *dsources, bAction *act, KeyingSet *ks, short mode, float cfra)
909 {
910         Scene *scene= CTX_data_scene(C);
911         ReportList *reports = CTX_wm_reports(C);
912         KS_Path *ksp;
913         int kflag=0, success= 0;
914         char *groupname= NULL;
915         
916         /* sanity checks */
917         if (ks == NULL)
918                 return 0;
919         
920         /* get flags to use */
921         if (mode == MODIFYKEY_MODE_INSERT) {
922                 /* use KeyingSet's flags as base */
923                 kflag= ks->keyingflag;
924                 
925                 /* suppliment with info from the context */
926                 kflag |= ANIM_get_keyframing_flags(scene, 1);
927         }
928         else if (mode == MODIFYKEY_MODE_DELETE)
929                 kflag= 0;
930         
931         /* if relative Keying Sets, poll and build up the paths */
932         success = ANIM_validate_keyingset(C, dsources, ks);
933         
934         if (success != 0) {
935                 /* return error code if failed */
936                 return success;
937         }
938         
939         /* apply the paths as specified in the KeyingSet now */
940         for (ksp= ks->paths.first; ksp; ksp= ksp->next) { 
941                 int arraylen, i;
942                 short kflag2;
943                 
944                 /* skip path if no ID pointer is specified */
945                 if (ksp->id == NULL) {
946                         BKE_reportf(reports, RPT_WARNING,
947                                 "Skipping path in Keying Set, as it has no ID (KS = '%s', Path = '%s'[%d])",
948                                 ks->name, ksp->rna_path, ksp->array_index);
949                         continue;
950                 }
951                 
952                 /* since keying settings can be defined on the paths too, extend the path before using it */
953                 kflag2 = (kflag | ksp->keyingflag);
954                 
955                 /* get pointer to name of group to add channels to */
956                 if (ksp->groupmode == KSP_GROUP_NONE)
957                         groupname= NULL;
958                 else if (ksp->groupmode == KSP_GROUP_KSNAME)
959                         groupname= ks->name;
960                 else
961                         groupname= ksp->group;
962                 
963                 /* init arraylen and i - arraylen should be greater than i so that
964                  * normal non-array entries get keyframed correctly
965                  */
966                 i= ksp->array_index;
967                 arraylen= i;
968                 
969                 /* get length of array if whole array option is enabled */
970                 if (ksp->flag & KSP_FLAG_WHOLE_ARRAY) {
971                         PointerRNA id_ptr, ptr;
972                         PropertyRNA *prop;
973                         
974                         RNA_id_pointer_create(ksp->id, &id_ptr);
975                         if (RNA_path_resolve(&id_ptr, ksp->rna_path, &ptr, &prop) && prop)
976                                 arraylen= RNA_property_array_length(&ptr, prop);
977                 }
978                 
979                 /* we should do at least one step */
980                 if (arraylen == i)
981                         arraylen++;
982                 
983                 /* for each possible index, perform operation 
984                  *      - assume that arraylen is greater than index
985                  */
986                 for (; i < arraylen; i++) {
987                         /* action to take depends on mode */
988                         if (mode == MODIFYKEY_MODE_INSERT)
989                                 success += insert_keyframe(reports, ksp->id, act, groupname, ksp->rna_path, i, cfra, kflag2);
990                         else if (mode == MODIFYKEY_MODE_DELETE)
991                                 success += delete_keyframe(reports, ksp->id, act, groupname, ksp->rna_path, i, cfra, kflag2);
992                 }
993                 
994                 /* set recalc-flags */
995                 switch (GS(ksp->id->name)) {
996                         case ID_OB: /* Object (or Object-Related) Keyframes */
997                         {
998                                 Object *ob= (Object *)ksp->id;
999                                 
1000                                 ob->recalc |= OB_RECALC_OB|OB_RECALC_DATA|OB_RECALC_TIME; // XXX: only object transforms only?
1001                         }
1002                                 break;
1003                 }
1004                 
1005                 /* send notifiers for updates (this doesn't require context to work!) */
1006                 WM_main_add_notifier(NC_ANIMATION|ND_KEYFRAME|NA_EDITED, NULL);
1007         }
1008         
1009         /* return the number of channels successfully affected */
1010         return success;
1011 }
1012
1013 /* ************************************************** */