5844bd6708f54859774d3c5cbde0653bc85bd1dc
[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         ot->description = "Add current UI-active property to current keying set";
377         
378         /* callbacks */
379         ot->exec = add_keyingset_button_exec; 
380         //op->poll= ???
381         
382         /* flags */
383         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
384
385         /* properties */
386         RNA_def_boolean(ot->srna, "all", 1, "All", "Add all elements of the array to a Keying Set");
387 }
388
389 /* Remove from KeyingSet Button Operator ------------------------ */
390
391 static int remove_keyingset_button_exec(bContext *C, wmOperator *op)
392 {
393         Main *bmain = CTX_data_main(C);
394         Scene *scene = CTX_data_scene(C);
395         KeyingSet *ks = NULL;
396         PropertyRNA *prop = NULL;
397         PointerRNA ptr = {{NULL}};
398         char *path = NULL;
399         short success = 0;
400         int index = 0;
401         
402         /* verify the Keying Set to use:
403          *      - use the active one for now (more control over this can be added later)
404          *      - return error if it doesn't exist
405          */
406         if (scene->active_keyingset == 0) {
407                 BKE_report(op->reports, RPT_ERROR, "No active keying set to remove property from");
408                 return OPERATOR_CANCELLED;
409         }
410         else if (scene->active_keyingset < 0) {
411                 BKE_report(op->reports, RPT_ERROR, "Cannot remove property from built in keying set");
412                 return OPERATOR_CANCELLED;
413         }
414         else
415                 ks = BLI_findlink(&scene->keyingsets, scene->active_keyingset - 1);
416         
417         /* try to add to keyingset using property retrieved from UI */
418         uiContextActiveProperty(C, &ptr, &prop, &index);
419
420         if (ptr.id.data && ptr.data && prop) {
421                 path = RNA_path_from_ID_to_property(&ptr, prop);
422                 
423                 if (path) {
424                         KS_Path *ksp;
425                         
426                         /* try to find a path matching this description */
427                         ksp = BKE_keyingset_find_path(ks, ptr.id.data, ks->name, path, index, KSP_GROUP_KSNAME);
428
429                         if (ksp) {
430                                 BKE_keyingset_free_path(ks, ksp);
431                                 success = 1;
432                         }
433                         
434                         /* free temp path used */
435                         MEM_freeN(path);
436                 }
437         }
438         
439         
440         if (success) {
441                 /* send updates */
442                 DAG_ids_flush_update(bmain, 0);
443                 
444                 /* for now, only send ND_KEYS for KeyingSets */
445                 WM_event_add_notifier(C, NC_SCENE | ND_KEYINGSET, NULL);
446         }
447         
448         return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
449 }
450
451 void ANIM_OT_keyingset_button_remove(wmOperatorType *ot)
452 {
453         /* identifiers */
454         ot->name = "Remove from Keying Set";
455         ot->idname = "ANIM_OT_keyingset_button_remove";
456         ot->description = "Remove current UI-active property from current keying set";
457         
458         /* callbacks */
459         ot->exec = remove_keyingset_button_exec; 
460         //op->poll= ???
461         
462         /* flags */
463         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
464 }
465
466 /* ******************************************* */
467
468 /* Change Active KeyingSet Operator ------------------------ */
469 /* This operator checks if a menu should be shown for choosing the KeyingSet to make the active one */
470
471 static int keyingset_active_menu_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
472 {
473         uiPopupMenu *pup;
474         uiLayout *layout;
475         
476         /* call the menu, which will call this operator again, hence the canceled */
477         pup = uiPupMenuBegin(C, op->type->name, ICON_NONE);
478         layout = uiPupMenuLayout(pup);
479         uiItemsEnumO(layout, "ANIM_OT_keying_set_active_set", "type");
480         uiPupMenuEnd(C, pup);
481         
482         return OPERATOR_CANCELLED;
483 }
484
485 static int keyingset_active_menu_exec(bContext *C, wmOperator *op)
486 {
487         Scene *scene = CTX_data_scene(C);
488         int type = RNA_enum_get(op->ptr, "type");
489         
490         /* If type == 0, it will deselect any active keying set. */
491         scene->active_keyingset = type;
492         
493         /* send notifiers */
494         WM_event_add_notifier(C, NC_SCENE | ND_KEYINGSET, NULL);
495         
496         return OPERATOR_FINISHED;
497 }
498  
499 void ANIM_OT_keying_set_active_set(wmOperatorType *ot)
500 {
501         PropertyRNA *prop;
502         
503         /* identifiers */
504         ot->name = "Set Active Keying Set";
505         ot->idname = "ANIM_OT_keying_set_active_set";
506         ot->description = "Select a new keying set as the active one";
507         
508         /* callbacks */
509         ot->invoke = keyingset_active_menu_invoke;
510         ot->exec = keyingset_active_menu_exec; 
511         ot->poll = ED_operator_areaactive;
512         
513         /* flags */
514         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
515         
516         /* keyingset to use (dynamic enum) */
517         prop = RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
518         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
519 /*      RNA_def_property_flag(prop, PROP_HIDDEN);*/
520 }
521
522 /* ******************************************* */
523 /* REGISTERED KEYING SETS */
524
525 /* Keying Set Type Info declarations */
526 static ListBase keyingset_type_infos = {NULL, NULL};
527
528 /* Built-In Keying Sets (referencing type infos)*/
529 ListBase builtin_keyingsets = {NULL, NULL};
530
531 /* --------------- */
532
533 /* Find KeyingSet type info given a name */
534 KeyingSetInfo *ANIM_keyingset_info_find_name(const char name[])
535 {
536         /* sanity checks */
537         if ((name == NULL) || (name[0] == 0))
538                 return NULL;
539                 
540         /* search by comparing names */
541         return BLI_findstring(&keyingset_type_infos, name, offsetof(KeyingSetInfo, idname));
542 }
543
544 /* Find builtin KeyingSet by name */
545 KeyingSet *ANIM_builtin_keyingset_get_named(KeyingSet *prevKS, const char name[])
546 {
547         KeyingSet *ks, *first = NULL;
548         
549         /* sanity checks  any name to check? */
550         if (name[0] == 0)
551                 return NULL;
552         
553         /* get first KeyingSet to use */
554         if (prevKS && prevKS->next)
555                 first = prevKS->next;
556         else
557                 first = builtin_keyingsets.first;
558         
559         /* loop over KeyingSets checking names */
560         for (ks = first; ks; ks = ks->next) {
561                 if (strcmp(name, ks->idname) == 0)
562                         return ks;
563         }
564
565         /* complain about missing keying sets on debug builds */
566 #ifndef NDEBUG
567         printf("%s: '%s' not found\n", __func__, name);
568 #endif
569
570         /* no matches found */
571         return NULL;
572 }
573
574 /* --------------- */
575
576 /* Add the given KeyingSetInfo to the list of type infos, and create an appropriate builtin set too */
577 void ANIM_keyingset_info_register(KeyingSetInfo *ksi)
578 {
579         KeyingSet *ks;
580         
581         /* create a new KeyingSet 
582          *      - inherit name and keyframing settings from the typeinfo
583          */
584         ks = BKE_keyingset_add(&builtin_keyingsets, ksi->idname, ksi->name, 1, ksi->keyingflag);
585         
586         /* link this KeyingSet with its typeinfo */
587         memcpy(&ks->typeinfo, ksi->idname, sizeof(ks->typeinfo));
588         
589         /* Copy description... */
590         BLI_strncpy(ks->description, ksi->description, sizeof(ks->description));
591         
592         /* add type-info to the list */
593         BLI_addtail(&keyingset_type_infos, ksi);
594 }
595
596 /* Remove the given KeyingSetInfo from the list of type infos, and also remove the builtin set if appropriate */
597 void ANIM_keyingset_info_unregister(Main *bmain, KeyingSetInfo *ksi)
598 {
599         KeyingSet *ks, *ksn;
600
601         /* find relevant builtin KeyingSets which use this, and remove them */
602         /* TODO: this isn't done now, since unregister is really only used atm when we
603          * reload the scripts, which kindof defeats the purpose of "builtin"? */
604         for (ks = builtin_keyingsets.first; ks; ks = ksn) {
605                 ksn = ks->next;
606
607                 /* remove if matching typeinfo name */
608                 if (strcmp(ks->typeinfo, ksi->idname) == 0) {
609                         Scene *scene;
610                         BKE_keyingset_free(ks);
611                         BLI_remlink(&builtin_keyingsets, ks);
612
613                         for (scene = bmain->scene.first; scene; scene = scene->id.next)
614                                 BLI_remlink_safe(&scene->keyingsets, ks);
615
616                         MEM_freeN(ks);
617                 }
618         }
619         
620         /* free the type info */
621         BLI_freelinkN(&keyingset_type_infos, ksi);
622 }
623
624 /* --------------- */
625
626 void ANIM_keyingset_infos_exit(void)
627 {
628         KeyingSetInfo *ksi, *next;
629         
630         /* free type infos */
631         for (ksi = keyingset_type_infos.first; ksi; ksi = next) {
632                 next = ksi->next;
633                 
634                 /* free extra RNA data, and remove from list */
635                 if (ksi->ext.free)
636                         ksi->ext.free(ksi->ext.data);
637                 BLI_freelinkN(&keyingset_type_infos, ksi);
638         }
639         
640         /* free builtin sets */
641         BKE_keyingsets_free(&builtin_keyingsets);
642 }
643
644 /* ******************************************* */
645 /* KEYING SETS API (for UI) */
646
647 /* Getters for Active/Indices ----------------------------- */
648
649 /* Get the active Keying Set for the Scene provided */
650 KeyingSet *ANIM_scene_get_active_keyingset(Scene *scene)
651 {
652         /* if no scene, we've got no hope of finding the Keying Set */
653         if (scene == NULL)
654                 return NULL;
655         
656         /* currently, there are several possibilities here:
657          *      -   0: no active keying set
658          *      - > 0: one of the user-defined Keying Sets, but indices start from 0 (hence the -1)
659          *      - < 0: a builtin keying set
660          */
661         if (scene->active_keyingset > 0)
662                 return BLI_findlink(&scene->keyingsets, scene->active_keyingset - 1);
663         else
664                 return BLI_findlink(&builtin_keyingsets, (-scene->active_keyingset) - 1);
665 }
666
667 /* Get the index of the Keying Set provided, for the given Scene */
668 int ANIM_scene_get_keyingset_index(Scene *scene, KeyingSet *ks)
669 {
670         int index;
671         
672         /* if no KeyingSet provided, have none */
673         if (ks == NULL)
674                 return 0;
675         
676         /* check if the KeyingSet exists in scene list */
677         if (scene) {
678                 /* get index and if valid, return 
679                  *      - (absolute) Scene KeyingSets are from (>= 1)
680                  */
681                 index = BLI_findindex(&scene->keyingsets, ks);
682                 if (index != -1)
683                         return (index + 1);
684         }
685         
686         /* still here, so try builtins list too 
687          *      - builtins are from (<= -1)
688          *      - none/invalid is (= 0)
689          */
690         index = BLI_findindex(&builtin_keyingsets, ks);
691         if (index != -1)
692                 return -(index + 1);
693         else
694                 return 0;
695 }
696
697 /* Get Keying Set to use for Auto-Keyframing some transforms */
698 KeyingSet *ANIM_get_keyingset_for_autokeying(Scene *scene, const char *tranformKSName)
699 {
700         /* get KeyingSet to use 
701          *      - use the active KeyingSet if defined (and user wants to use it for all autokeying), 
702          *    or otherwise key transforms only
703          */
704         if (IS_AUTOKEY_FLAG(scene, ONLYKEYINGSET) && (scene->active_keyingset))
705                 return ANIM_scene_get_active_keyingset(scene);
706         else if (IS_AUTOKEY_FLAG(scene, INSERTAVAIL))
707                 return ANIM_builtin_keyingset_get_named(NULL, ANIM_KS_AVAILABLE_ID);
708         else 
709                 return ANIM_builtin_keyingset_get_named(NULL, tranformKSName);
710 }
711
712 /* Menu of All Keying Sets ----------------------------- */
713
714 /* Dynamically populate an enum of Keying Sets */
715 EnumPropertyItem *ANIM_keying_sets_enum_itemf(bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop), int *free)
716 {
717         Scene *scene = CTX_data_scene(C);
718         KeyingSet *ks;
719         EnumPropertyItem *item = NULL, item_tmp = {0};
720         int totitem = 0;
721         int i = 0;
722
723         if (C == NULL) {
724                 return DummyRNA_DEFAULT_items;
725         }
726         
727         /* active Keying Set 
728          *      - only include entry if it exists
729          */
730         if (scene->active_keyingset) {
731                 /* active Keying Set */
732                 item_tmp.identifier = "__ACTIVE__";
733                 item_tmp.name = "Active Keying Set";
734                 item_tmp.value = i;
735                 RNA_enum_item_add(&item, &totitem, &item_tmp);
736                 
737                 /* separator */
738                 RNA_enum_item_add_separator(&item, &totitem);
739         }
740         
741         i++;
742         
743         /* user-defined Keying Sets 
744          *      - these are listed in the order in which they were defined for the active scene
745          */
746         if (scene->keyingsets.first) {
747                 for (ks = scene->keyingsets.first; ks; ks = ks->next, i++) {
748                         if (ANIM_keyingset_context_ok_poll(C, ks)) {
749                                 item_tmp.identifier = ks->idname;
750                                 item_tmp.name = ks->name;
751                                 item_tmp.description = ks->description;
752                                 item_tmp.value = i;
753                                 RNA_enum_item_add(&item, &totitem, &item_tmp);
754                         }
755                 }
756                 
757                 /* separator */
758                 RNA_enum_item_add_separator(&item, &totitem);
759         }
760         
761         /* builtin Keying Sets */
762         i = -1;
763         for (ks = builtin_keyingsets.first; ks; ks = ks->next, i--) {
764                 /* only show KeyingSet if context is suitable */
765                 if (ANIM_keyingset_context_ok_poll(C, ks)) {
766                         item_tmp.identifier = ks->idname;
767                         item_tmp.name = ks->name;
768                         item_tmp.description = ks->description;
769                         item_tmp.value = i;
770                         RNA_enum_item_add(&item, &totitem, &item_tmp);
771                 }
772         }
773
774         RNA_enum_item_end(&item, &totitem);
775         *free = 1;
776
777         return item;
778 }
779
780 /* ******************************************* */
781 /* KEYFRAME MODIFICATION */
782
783 /* Polling API ----------------------------------------------- */
784
785 /* Check if KeyingSet can be used in the current context */
786 short ANIM_keyingset_context_ok_poll(bContext *C, KeyingSet *ks)
787 {
788         if ((ks->flag & KEYINGSET_ABSOLUTE) == 0) {
789                 KeyingSetInfo *ksi = ANIM_keyingset_info_find_name(ks->typeinfo);
790                 
791                 /* get the associated 'type info' for this KeyingSet */
792                 if (ksi == NULL)
793                         return 0;
794                 /* TODO: check for missing callbacks! */
795
796                 /* check if it can be used in the current context */
797                 return (ksi->poll(ksi, C));
798         }
799         
800         return 1;
801 }
802
803 /* Special 'Overrides' Iterator for Relative KeyingSets ------ */
804
805 /* 'Data Sources' for relative Keying Set 'overrides' 
806  *  - this is basically a wrapper for PointerRNA's in a linked list
807  *      - do not allow this to be accessed from outside for now
808  */
809 typedef struct tRKS_DSource {
810         struct tRKS_DSource *next, *prev;
811         PointerRNA ptr;     /* the whole point of this exercise! */
812 } tRKS_DSource;
813
814
815 /* Iterator used for overriding the behavior of iterators defined for 
816  * relative Keying Sets, with the main usage of this being operators 
817  * requiring Auto Keyframing. Internal Use Only!
818  */
819 static void RKS_ITER_overrides_list(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks, ListBase *dsources)
820 {
821         tRKS_DSource *ds;
822         
823         for (ds = dsources->first; ds; ds = ds->next) {
824                 /* run generate callback on this data */
825                 ksi->generate(ksi, C, ks, &ds->ptr);
826         }
827 }
828
829 /* Add new data source for relative Keying Sets */
830 void ANIM_relative_keyingset_add_source(ListBase *dsources, ID *id, StructRNA *srna, void *data)
831 {
832         tRKS_DSource *ds;
833         
834         /* sanity checks 
835          *      - we must have somewhere to output the data
836          *      - we must have both srna+data (and with id too optionally), or id by itself only
837          */
838         if (dsources == NULL)
839                 return;
840         if (ELEM(NULL, srna, data) && (id == NULL))
841                 return;
842         
843         /* allocate new elem, and add to the list */
844         ds = MEM_callocN(sizeof(tRKS_DSource), "tRKS_DSource");
845         BLI_addtail(dsources, ds);
846         
847         /* depending on what data we have, create using ID or full pointer call */
848         if (srna && data)
849                 RNA_pointer_create(id, srna, data, &ds->ptr);
850         else
851                 RNA_id_pointer_create(id, &ds->ptr);
852 }
853
854 /* KeyingSet Operations (Insert/Delete Keyframes) ------------ */
855
856 /* Given a KeyingSet and context info, validate Keying Set's paths.
857  * This is only really necessary with relative/built-in KeyingSets
858  * where their list of paths is dynamically generated based on the
859  * current context info.
860  *
861  * Returns 0 if succeeded, otherwise an error code: eModifyKey_Returns
862  */
863 short ANIM_validate_keyingset(bContext *C, ListBase *dsources, KeyingSet *ks)
864 {
865         /* sanity check */
866         if (ks == NULL)
867                 return 0;
868         
869         /* if relative Keying Sets, poll and build up the paths */
870         if ((ks->flag & KEYINGSET_ABSOLUTE) == 0) {
871                 KeyingSetInfo *ksi = ANIM_keyingset_info_find_name(ks->typeinfo);
872                 
873                 /* clear all existing paths 
874                  * NOTE: BKE_keyingset_free() frees all of the paths for the KeyingSet, but not the set itself
875                  */
876                 BKE_keyingset_free(ks);
877                 
878                 /* get the associated 'type info' for this KeyingSet */
879                 if (ksi == NULL)
880                         return MODIFYKEY_MISSING_TYPEINFO;
881                 /* TODO: check for missing callbacks! */
882
883                 /* check if it can be used in the current context */
884                 if (ksi->poll(ksi, C)) {
885                         /* if a list of data sources are provided, run a special iterator over them,
886                          * otherwise, just continue per normal
887                          */
888                         if (dsources) 
889                                 RKS_ITER_overrides_list(ksi, C, ks, dsources);
890                         else
891                                 ksi->iter(ksi, C, ks);
892                                 
893                         /* if we don't have any paths now, then this still qualifies as invalid context */
894                         if (ks->paths.first == NULL)
895                                 return MODIFYKEY_INVALID_CONTEXT;
896                 }
897                 else {
898                         /* poll callback tells us that KeyingSet is useless in current context */
899                         return MODIFYKEY_INVALID_CONTEXT;
900                 }
901         }
902         
903         /* succeeded; return 0 to tag error free */
904         return 0;
905
906
907 /* Given a KeyingSet and context info (if required), modify keyframes for the channels specified
908  * by the KeyingSet. This takes into account many of the different combinations of using KeyingSets.
909  * Returns the number of channels that keyframes were added to
910  */
911 int ANIM_apply_keyingset(bContext *C, ListBase *dsources, bAction *act, KeyingSet *ks, short mode, float cfra)
912 {
913         Scene *scene = CTX_data_scene(C);
914         ReportList *reports = CTX_wm_reports(C);
915         KS_Path *ksp;
916         int kflag = 0, success = 0;
917         char *groupname = NULL;
918         
919         /* sanity checks */
920         if (ks == NULL)
921                 return 0;
922         
923         /* get flags to use */
924         if (mode == MODIFYKEY_MODE_INSERT) {
925                 /* use KeyingSet's flags as base */
926                 kflag = ks->keyingflag;
927                 
928                 /* suppliment with info from the context */
929                 kflag |= ANIM_get_keyframing_flags(scene, 1);
930         }
931         else if (mode == MODIFYKEY_MODE_DELETE)
932                 kflag = 0;
933         
934         /* if relative Keying Sets, poll and build up the paths */
935         success = ANIM_validate_keyingset(C, dsources, ks);
936         
937         if (success != 0) {
938                 /* return error code if failed */
939                 return success;
940         }
941         
942         /* apply the paths as specified in the KeyingSet now */
943         for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
944                 int arraylen, i;
945                 short kflag2;
946                 
947                 /* skip path if no ID pointer is specified */
948                 if (ksp->id == NULL) {
949                         BKE_reportf(reports, RPT_WARNING,
950                                     "Skipping path in keying set, as it has no ID (KS = '%s', path = '%s'[%d])",
951                                     ks->name, ksp->rna_path, ksp->array_index);
952                         continue;
953                 }
954                 
955                 /* since keying settings can be defined on the paths too, extend the path before using it */
956                 kflag2 = (kflag | ksp->keyingflag);
957                 
958                 /* get pointer to name of group to add channels to */
959                 if (ksp->groupmode == KSP_GROUP_NONE)
960                         groupname = NULL;
961                 else if (ksp->groupmode == KSP_GROUP_KSNAME)
962                         groupname = ks->name;
963                 else
964                         groupname = ksp->group;
965                 
966                 /* init arraylen and i - arraylen should be greater than i so that
967                  * normal non-array entries get keyframed correctly
968                  */
969                 i = ksp->array_index;
970                 arraylen = i;
971                 
972                 /* get length of array if whole array option is enabled */
973                 if (ksp->flag & KSP_FLAG_WHOLE_ARRAY) {
974                         PointerRNA id_ptr, ptr;
975                         PropertyRNA *prop;
976                         
977                         RNA_id_pointer_create(ksp->id, &id_ptr);
978                         if (RNA_path_resolve(&id_ptr, ksp->rna_path, &ptr, &prop) && prop)
979                                 arraylen = RNA_property_array_length(&ptr, prop);
980                 }
981                 
982                 /* we should do at least one step */
983                 if (arraylen == i)
984                         arraylen++;
985                 
986                 /* for each possible index, perform operation 
987                  *      - assume that arraylen is greater than index
988                  */
989                 for (; i < arraylen; i++) {
990                         /* action to take depends on mode */
991                         if (mode == MODIFYKEY_MODE_INSERT)
992                                 success += insert_keyframe(reports, ksp->id, act, groupname, ksp->rna_path, i, cfra, kflag2);
993                         else if (mode == MODIFYKEY_MODE_DELETE)
994                                 success += delete_keyframe(reports, ksp->id, act, groupname, ksp->rna_path, i, cfra, kflag2);
995                 }
996                 
997                 /* set recalc-flags */
998                 switch (GS(ksp->id->name)) {
999                         case ID_OB: /* Object (or Object-Related) Keyframes */
1000                         {
1001                                 Object *ob = (Object *)ksp->id;
1002                                 
1003                                 ob->recalc |= OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME; // XXX: only object transforms only?
1004                         }
1005                         break;
1006                 }
1007                 
1008                 /* send notifiers for updates (this doesn't require context to work!) */
1009                 WM_main_add_notifier(NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1010         }
1011         
1012         /* return the number of channels successfully affected */
1013         return success;
1014 }
1015
1016 /* ************************************************** */