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