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