64832a1311f40b4134273c213de84a4116eb9c07
[blender.git] / source / blender / editors / animation / keyframing.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/keyframing.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 "BLF_translation.h"
47
48 #include "DNA_anim_types.h"
49 #include "DNA_armature_types.h"
50 #include "DNA_constraint_types.h"
51 #include "DNA_key_types.h"
52 #include "DNA_material_types.h"
53 #include "DNA_scene_types.h"
54 #include "DNA_object_types.h"
55 #include "DNA_rigidbody_types.h"
56
57 #include "BKE_animsys.h"
58 #include "BKE_action.h"
59 #include "BKE_armature.h"
60 #include "BKE_constraint.h"
61 #include "BKE_depsgraph.h"
62 #include "BKE_fcurve.h"
63 #include "BKE_main.h"
64 #include "BKE_nla.h"
65 #include "BKE_global.h"
66 #include "BKE_context.h"
67 #include "BKE_report.h"
68 #include "BKE_key.h"
69 #include "BKE_material.h"
70
71 #include "ED_anim_api.h"
72 #include "ED_keyframing.h"
73 #include "ED_keyframes_edit.h"
74 #include "ED_screen.h"
75
76 #include "UI_interface.h"
77 #include "UI_resources.h"
78
79 #include "WM_api.h"
80 #include "WM_types.h"
81
82 #include "RNA_access.h"
83 #include "RNA_define.h"
84 #include "RNA_enum_types.h"
85
86 #include "anim_intern.h"
87
88 /* ************************************************** */
89 /* Keyframing Setting Wrangling */
90
91 /* Get the active settings for keyframing settings from context (specifically the given scene) */
92 short ANIM_get_keyframing_flags(Scene *scene, short incl_mode)
93 {
94         short flag = 0;
95         
96         /* standard flags */
97         {
98                 /* visual keying */
99                 if (IS_AUTOKEY_FLAG(scene, AUTOMATKEY)) 
100                         flag |= INSERTKEY_MATRIX;
101                 
102                 /* only needed */
103                 if (IS_AUTOKEY_FLAG(scene, INSERTNEEDED)) 
104                         flag |= INSERTKEY_NEEDED;
105                 
106                 /* default F-Curve color mode - RGB from XYZ indices */
107                 if (IS_AUTOKEY_FLAG(scene, XYZ2RGB)) 
108                         flag |= INSERTKEY_XYZ2RGB;
109         }
110                 
111         /* only if including settings from the autokeying mode... */
112         if (incl_mode) {
113                 /* keyframing mode - only replace existing keyframes */
114                 if (IS_AUTOKEY_MODE(scene, EDITKEYS)) 
115                         flag |= INSERTKEY_REPLACE;
116         }
117                 
118         return flag;
119 }
120
121 /* ******************************************* */
122 /* Animation Data Validation */
123
124 /* Get (or add relevant data to be able to do so) the Active Action for the given 
125  * Animation Data block, given an ID block where the Animation Data should reside.
126  */
127 bAction *verify_adt_action(ID *id, short add)
128 {
129         AnimData *adt;
130         
131         /* init animdata if none available yet */
132         adt = BKE_animdata_from_id(id);
133         if ((adt == NULL) && (add))
134                 adt = BKE_id_add_animdata(id);
135         if (adt == NULL) {
136                 /* if still none (as not allowed to add, or ID doesn't have animdata for some reason) */
137                 printf("ERROR: Couldn't add AnimData (ID = %s)\n", (id) ? (id->name) : "<None>");
138                 return NULL;
139         }
140
141         /* init action if none available yet */
142         /* TODO: need some wizardry to handle NLA stuff correct */
143         if ((adt->action == NULL) && (add)) {
144                 char actname[sizeof(id->name) - 2];
145                 BLI_snprintf(actname, sizeof(actname), "%sAction", id->name + 2);
146                 adt->action = add_empty_action(actname);
147         }
148                 
149         /* return the action */
150         return adt->action;
151 }
152
153 /* Get (or add relevant data to be able to do so) F-Curve from the Active Action, 
154  * for the given Animation Data block. This assumes that all the destinations are valid.
155  */
156 FCurve *verify_fcurve(bAction *act, const char group[], PointerRNA *ptr, 
157                       const char rna_path[], const int array_index, short add)
158 {
159         bActionGroup *agrp;
160         FCurve *fcu;
161         
162         /* sanity checks */
163         if (ELEM(NULL, act, rna_path))
164                 return NULL;
165                 
166         /* try to find f-curve matching for this setting 
167          *      - add if not found and allowed to add one
168          *              TODO: add auto-grouping support? how this works will need to be resolved
169          */
170         fcu = list_find_fcurve(&act->curves, rna_path, array_index);
171         
172         if ((fcu == NULL) && (add)) {
173                 /* use default settings to make a F-Curve */
174                 fcu = MEM_callocN(sizeof(FCurve), "FCurve");
175                 
176                 fcu->flag = (FCURVE_VISIBLE | FCURVE_SELECTED);
177                 if (act->curves.first == NULL)
178                         fcu->flag |= FCURVE_ACTIVE;  /* first one added active */
179                         
180                 /* store path - make copy, and store that */
181                 fcu->rna_path = BLI_strdupn(rna_path, strlen(rna_path));
182                 fcu->array_index = array_index;
183                 
184                 /* if a group name has been provided, try to add or find a group, then add F-Curve to it */
185                 if (group) {
186                         /* try to find group */
187                         agrp = BKE_action_group_find_name(act, group);
188                         
189                         /* no matching groups, so add one */
190                         if (agrp == NULL) {
191                                 agrp = action_groups_add_new(act, group);
192                                 
193                                 /* sync bone group colors if applicable */
194                                 if (ptr && (ptr->type == &RNA_PoseBone)) {
195                                         Object *ob = (Object *)ptr->id.data;
196                                         bPoseChannel *pchan = (bPoseChannel *)ptr->data;
197                                         bPose *pose = ob->pose;
198                                         bActionGroup *grp;
199                                         
200                                         /* find bone group (if present), and use the color from that */
201                                         grp = (bActionGroup *)BLI_findlink(&pose->agroups, (pchan->agrp_index - 1));
202                                         if (grp) {
203                                                 agrp->customCol = grp->customCol;
204                                                 action_group_colors_sync(agrp, grp);
205                                         }
206                                 }
207                         }
208                         
209                         /* add F-Curve to group */
210                         action_groups_add_channel(act, agrp, fcu);
211                 }
212                 else {
213                         /* just add F-Curve to end of Action's list */
214                         BLI_addtail(&act->curves, fcu);
215                 }
216         }
217         
218         /* return the F-Curve */
219         return fcu;
220 }
221
222 /* ************************************************** */
223 /* KEYFRAME INSERTION */
224
225 /* -------------- BezTriple Insertion -------------------- */
226
227 /* This function adds a given BezTriple to an F-Curve. It will allocate 
228  * memory for the array if needed, and will insert the BezTriple into a
229  * suitable place in chronological order.
230  * 
231  * NOTE: any recalculate of the F-Curve that needs to be done will need to 
232  *      be done by the caller.
233  */
234 int insert_bezt_fcurve(FCurve *fcu, BezTriple *bezt, short flag)
235 {
236         int i = 0;
237         
238         /* are there already keyframes? */
239         if (fcu->bezt) {
240                 short replace = -1;
241                 i = binarysearch_bezt_index(fcu->bezt, bezt->vec[1][0], fcu->totvert, &replace);
242                 
243                 /* replace an existing keyframe? */
244                 if (replace) {
245                         /* sanity check: 'i' may in rare cases exceed arraylen */
246                         if ((i >= 0) && (i < fcu->totvert)) {
247                                 /* just change the values when replacing, so as to not overwrite handles */
248                                 BezTriple *dst = (fcu->bezt + i);
249                                 float dy = bezt->vec[1][1] - dst->vec[1][1];
250                                 
251                                 /* just apply delta value change to the handle values */
252                                 dst->vec[0][1] += dy;
253                                 dst->vec[1][1] += dy;
254                                 dst->vec[2][1] += dy;
255                                 
256                                 dst->f1 = bezt->f1;
257                                 dst->f2 = bezt->f2;
258                                 dst->f3 = bezt->f3;
259
260                                 /* TODO: perform some other operations? */
261                         }
262                 }
263                 /* keyframing modes allow to not replace keyframe */
264                 else if ((flag & INSERTKEY_REPLACE) == 0) {
265                         /* insert new - if we're not restricted to replacing keyframes only */
266                         BezTriple *newb = MEM_callocN((fcu->totvert + 1) * sizeof(BezTriple), "beztriple");
267                         
268                         /* add the beztriples that should occur before the beztriple to be pasted (originally in fcu) */
269                         if (i > 0)
270                                 memcpy(newb, fcu->bezt, i * sizeof(BezTriple));
271                         
272                         /* add beztriple to paste at index i */
273                         *(newb + i) = *bezt;
274                         
275                         /* add the beztriples that occur after the beztriple to be pasted (originally in fcu) */
276                         if (i < fcu->totvert) 
277                                 memcpy(newb + i + 1, fcu->bezt + i, (fcu->totvert - i) * sizeof(BezTriple));
278                         
279                         /* replace (+ free) old with new, only if necessary to do so */
280                         MEM_freeN(fcu->bezt);
281                         fcu->bezt = newb;
282                         
283                         fcu->totvert++;
284                 }
285         }
286         /* no keyframes already, but can only add if...
287          *      1) keyframing modes say that keyframes can only be replaced, so adding new ones won't know
288          *      2) there are no samples on the curve
289          *              // NOTE: maybe we may want to allow this later when doing samples -> bezt conversions, 
290          *              // but for now, having both is asking for trouble
291          */
292         else if ((flag & INSERTKEY_REPLACE) == 0 && (fcu->fpt == NULL)) {
293                 /* create new keyframes array */
294                 fcu->bezt = MEM_callocN(sizeof(BezTriple), "beztriple");
295                 *(fcu->bezt) = *bezt;
296                 fcu->totvert = 1;
297         }
298         /* cannot add anything */
299         else {
300                 /* return error code -1 to prevent any misunderstandings */
301                 return -1;
302         }
303         
304         
305         /* we need to return the index, so that some tools which do post-processing can 
306          * detect where we added the BezTriple in the array
307          */
308         return i;
309 }
310
311 /* This function is a wrapper for insert_bezt_fcurve_internal(), and should be used when
312  * adding a new keyframe to a curve, when the keyframe doesn't exist anywhere else yet. 
313  * It returns the index at which the keyframe was added.
314  */
315 int insert_vert_fcurve(FCurve *fcu, float x, float y, short flag)
316 {
317         BezTriple beztr = {{{0}}};
318         unsigned int oldTot = fcu->totvert;
319         int a;
320         
321         /* set all three points, for nicer start position 
322          * NOTE: +/- 1 on vec.x for left and right handles is so that 'free' handles work ok...
323          */
324         beztr.vec[0][0] = x - 1.0f;
325         beztr.vec[0][1] = y;
326         beztr.vec[1][0] = x;
327         beztr.vec[1][1] = y;
328         beztr.vec[2][0] = x + 1.0f;
329         beztr.vec[2][1] = y;
330         beztr.f1 = beztr.f2 = beztr.f3 = SELECT;
331         beztr.h1 = beztr.h2 = U.keyhandles_new; /* use default handle type here */
332         //BEZKEYTYPE(&beztr)= scene->keytype; /* default keyframe type */
333
334         /* use default interpolation mode, with exceptions for int/discrete values */
335         beztr.ipo = U.ipo_new;
336
337         if (fcu->flag & FCURVE_DISCRETE_VALUES)
338                 beztr.ipo = BEZT_IPO_CONST;
339         else if (beztr.ipo == BEZT_IPO_BEZ && (fcu->flag & FCURVE_INT_VALUES))
340                 beztr.ipo = BEZT_IPO_LIN;
341         
342         /* add temp beztriple to keyframes */
343         a = insert_bezt_fcurve(fcu, &beztr, flag);
344         
345         /* what if 'a' is a negative index? 
346          * for now, just exit to prevent any segfaults
347          */
348         if (a < 0) return -1;
349         
350         /* don't recalculate handles if fast is set
351          *      - this is a hack to make importers faster
352          *      - we may calculate twice (due to autohandle needing to be calculated twice)
353          */
354         if ((flag & INSERTKEY_FAST) == 0) 
355                 calchandles_fcurve(fcu);
356         
357         /* set handletype and interpolation */
358         if ((fcu->totvert > 2) && (flag & INSERTKEY_REPLACE) == 0) {
359                 BezTriple *bezt = (fcu->bezt + a);
360                 
361                 /* set interpolation from previous (if available), but only if we didn't just replace some keyframe 
362                  *  - replacement is indicated by no-change in number of verts
363                  *      - when replacing, the user may have specified some interpolation that should be kept
364                  */
365                 if (fcu->totvert > oldTot) {
366                         if (a > 0) 
367                                 bezt->ipo = (bezt - 1)->ipo;
368                         else if (a < fcu->totvert - 1)
369                                 bezt->ipo = (bezt + 1)->ipo;
370                 }
371                         
372                 /* don't recalculate handles if fast is set
373                  *      - this is a hack to make importers faster
374                  *      - we may calculate twice (due to autohandle needing to be calculated twice)
375                  */
376                 if ((flag & INSERTKEY_FAST) == 0) 
377                         calchandles_fcurve(fcu);
378         }
379         
380         /* return the index at which the keyframe was added */
381         return a;
382 }
383
384 /* -------------- 'Smarter' Keyframing Functions -------------------- */
385 /* return codes for new_key_needed */
386 enum {
387         KEYNEEDED_DONTADD = 0,
388         KEYNEEDED_JUSTADD,
389         KEYNEEDED_DELPREV,
390         KEYNEEDED_DELNEXT
391 } /*eKeyNeededStatus*/;
392
393 /* This helper function determines whether a new keyframe is needed */
394 /* Cases where keyframes should not be added:
395  *      1. Keyframe to be added between two keyframes with similar values
396  *      2. Keyframe to be added on frame where two keyframes are already situated
397  *      3. Keyframe lies at point that intersects the linear line between two keyframes
398  */
399 static short new_key_needed(FCurve *fcu, float cFrame, float nValue)
400 {
401         BezTriple *bezt = NULL, *prev = NULL;
402         int totCount, i;
403         float valA = 0.0f, valB = 0.0f;
404         
405         /* safety checking */
406         if (fcu == NULL) return KEYNEEDED_JUSTADD;
407         totCount = fcu->totvert;
408         if (totCount == 0) return KEYNEEDED_JUSTADD;
409         
410         /* loop through checking if any are the same */
411         bezt = fcu->bezt;
412         for (i = 0; i < totCount; i++) {
413                 float prevPosi = 0.0f, prevVal = 0.0f;
414                 float beztPosi = 0.0f, beztVal = 0.0f;
415                         
416                 /* get current time+value */
417                 beztPosi = bezt->vec[1][0];
418                 beztVal = bezt->vec[1][1];
419                         
420                 if (prev) {
421                         /* there is a keyframe before the one currently being examined */
422                         
423                         /* get previous time+value */
424                         prevPosi = prev->vec[1][0];
425                         prevVal = prev->vec[1][1];
426                         
427                         /* keyframe to be added at point where there are already two similar points? */
428                         if (IS_EQF(prevPosi, cFrame) && IS_EQF(beztPosi, cFrame) && IS_EQF(beztPosi, prevPosi)) {
429                                 return KEYNEEDED_DONTADD;
430                         }
431                         
432                         /* keyframe between prev+current points ? */
433                         if ((prevPosi <= cFrame) && (cFrame <= beztPosi)) {
434                                 /* is the value of keyframe to be added the same as keyframes on either side ? */
435                                 if (IS_EQF(prevVal, nValue) && IS_EQF(beztVal, nValue) && IS_EQF(prevVal, beztVal)) {
436                                         return KEYNEEDED_DONTADD;
437                                 }
438                                 else {
439                                         float realVal;
440                                         
441                                         /* get real value of curve at that point */
442                                         realVal = evaluate_fcurve(fcu, cFrame);
443                                         
444                                         /* compare whether it's the same as proposed */
445                                         if (IS_EQF(realVal, nValue))
446                                                 return KEYNEEDED_DONTADD;
447                                         else 
448                                                 return KEYNEEDED_JUSTADD;
449                                 }
450                         }
451                         
452                         /* new keyframe before prev beztriple? */
453                         if (cFrame < prevPosi) {
454                                 /* A new keyframe will be added. However, whether the previous beztriple
455                                  * stays around or not depends on whether the values of previous/current
456                                  * beztriples and new keyframe are the same.
457                                  */
458                                 if (IS_EQF(prevVal, nValue) && IS_EQF(beztVal, nValue) && IS_EQF(prevVal, beztVal))
459                                         return KEYNEEDED_DELNEXT;
460                                 else 
461                                         return KEYNEEDED_JUSTADD;
462                         }
463                 }
464                 else {
465                         /* just add a keyframe if there's only one keyframe 
466                          * and the new one occurs before the existing one does.
467                          */
468                         if ((cFrame < beztPosi) && (totCount == 1))
469                                 return KEYNEEDED_JUSTADD;
470                 }
471                 
472                 /* continue. frame to do not yet passed (or other conditions not met) */
473                 if (i < (totCount - 1)) {
474                         prev = bezt;
475                         bezt++;
476                 }
477                 else
478                         break;
479         }
480         
481         /* Frame in which to add a new-keyframe occurs after all other keys
482          * -> If there are at least two existing keyframes, then if the values of the
483          *    last two keyframes and the new-keyframe match, the last existing keyframe
484          *    gets deleted as it is no longer required.
485          * -> Otherwise, a keyframe is just added. 1.0 is added so that fake-2nd-to-last
486          *    keyframe is not equal to last keyframe.
487          */
488         bezt = (fcu->bezt + (fcu->totvert - 1));
489         valA = bezt->vec[1][1];
490         
491         if (prev)
492                 valB = prev->vec[1][1];
493         else 
494                 valB = bezt->vec[1][1] + 1.0f;
495                 
496         if (IS_EQF(valA, nValue) && IS_EQF(valA, valB))
497                 return KEYNEEDED_DELPREV;
498         else 
499                 return KEYNEEDED_JUSTADD;
500 }
501
502 /* ------------------ RNA Data-Access Functions ------------------ */
503
504 /* Try to read value using RNA-properties obtained already */
505 static float setting_get_rna_value(PointerRNA *ptr, PropertyRNA *prop, int index)
506 {
507         float value = 0.0f;
508         
509         switch (RNA_property_type(prop)) {
510                 case PROP_BOOLEAN:
511                         if (RNA_property_array_length(ptr, prop))
512                                 value = (float)RNA_property_boolean_get_index(ptr, prop, index);
513                         else
514                                 value = (float)RNA_property_boolean_get(ptr, prop);
515                         break;
516                 case PROP_INT:
517                         if (RNA_property_array_length(ptr, prop))
518                                 value = (float)RNA_property_int_get_index(ptr, prop, index);
519                         else
520                                 value = (float)RNA_property_int_get(ptr, prop);
521                         break;
522                 case PROP_FLOAT:
523                         if (RNA_property_array_length(ptr, prop))
524                                 value = RNA_property_float_get_index(ptr, prop, index);
525                         else
526                                 value = RNA_property_float_get(ptr, prop);
527                         break;
528                 case PROP_ENUM:
529                         value = (float)RNA_property_enum_get(ptr, prop);
530                         break;
531                 default:
532                         break;
533         }
534         
535         return value;
536 }
537
538 /* ------------------ 'Visual' Keyframing Functions ------------------ */
539
540 /* internal status codes for visualkey_can_use */
541 enum {
542         VISUALKEY_NONE = 0,
543         VISUALKEY_LOC,
544         VISUALKEY_ROT,
545         VISUALKEY_SCA,
546 };
547
548 /* This helper function determines if visual-keyframing should be used when  
549  * inserting keyframes for the given channel. As visual-keyframing only works
550  * on Object and Pose-Channel blocks, this should only get called for those 
551  * blocktypes, when using "standard" keying but 'Visual Keying' option in Auto-Keying 
552  * settings is on.
553  */
554 static bool visualkey_can_use(PointerRNA *ptr, PropertyRNA *prop)
555 {
556         bConstraint *con = NULL;
557         short searchtype = VISUALKEY_NONE;
558         bool has_rigidbody = false;
559         bool has_parent = false;
560         const char *identifier = NULL;
561         
562         /* validate data */
563         if (ELEM3(NULL, ptr, ptr->data, prop))
564                 return 0;
565         
566         /* get first constraint and determine type of keyframe constraints to check for 
567          *  - constraints can be on either Objects or PoseChannels, so we only check if the
568          *    ptr->type is RNA_Object or RNA_PoseBone, which are the RNA wrapping-info for
569          *    those structs, allowing us to identify the owner of the data
570          */
571         if (ptr->type == &RNA_Object) {
572                 /* Object */
573                 Object *ob = (Object *)ptr->data;
574                 RigidBodyOb *rbo = ob->rigidbody_object;
575                 
576                 con = ob->constraints.first;
577                 identifier = RNA_property_identifier(prop);
578                 has_parent = (ob->parent != NULL);
579                 
580                 /* active rigidbody objects only, as only those are affected by sim */
581                 has_rigidbody = ((rbo) && (rbo->type == RBO_TYPE_ACTIVE));
582         }
583         else if (ptr->type == &RNA_PoseBone) {
584                 /* Pose Channel */
585                 bPoseChannel *pchan = (bPoseChannel *)ptr->data;
586                 
587                 con = pchan->constraints.first;
588                 identifier = RNA_property_identifier(prop);
589                 has_parent = (pchan->parent != NULL);
590         }
591         
592         /* check if any data to search using */
593         if (ELEM(NULL, con, identifier) && (has_parent == false) && (has_rigidbody == false))
594                 return false;
595         
596         /* location or rotation identifiers only... */
597         if (identifier == NULL) {
598                 printf("%s failed: NULL identifier\n", __func__);
599                 return false;
600         }
601         else if (strstr(identifier, "location")) {
602                 searchtype = VISUALKEY_LOC;
603         }
604         else if (strstr(identifier, "rotation")) {
605                 searchtype = VISUALKEY_ROT;
606         }
607         else if (strstr(identifier, "scale")) {
608                 searchtype = VISUALKEY_SCA;
609         }
610         else {
611                 printf("%s failed: identifier - '%s'\n", __func__, identifier);
612                 return false;
613         }
614         
615         
616         /* only search if a searchtype and initial constraint are available */
617         if (searchtype) {
618                 /* parent or rigidbody are always matching */
619                 if (has_parent || has_rigidbody)
620                         return true;
621                 
622                 /* constraints */
623                 for (; con; con = con->next) {
624                         /* only consider constraint if it is not disabled, and has influence */
625                         if (con->flag & CONSTRAINT_DISABLE) continue;
626                         if (con->enforce == 0.0f) continue;
627                         
628                         /* some constraints may alter these transforms */
629                         switch (con->type) {
630                                 /* multi-transform constraints */
631                                 case CONSTRAINT_TYPE_CHILDOF:
632                                         return true;
633                                 case CONSTRAINT_TYPE_TRANSFORM:
634                                 case CONSTRAINT_TYPE_TRANSLIKE:
635                                         return true;
636                                 case CONSTRAINT_TYPE_FOLLOWPATH:
637                                         return true;
638                                 case CONSTRAINT_TYPE_KINEMATIC:
639                                         return true;
640                                 
641                                 /* single-transform constraits  */
642                                 case CONSTRAINT_TYPE_TRACKTO:
643                                         if (searchtype == VISUALKEY_ROT) return true;
644                                         break;
645                                 case CONSTRAINT_TYPE_DAMPTRACK:
646                                         if (searchtype == VISUALKEY_ROT) return true;
647                                         break;
648                                 case CONSTRAINT_TYPE_ROTLIMIT:
649                                         if (searchtype == VISUALKEY_ROT) return true;
650                                         break;
651                                 case CONSTRAINT_TYPE_LOCLIMIT:
652                                         if (searchtype == VISUALKEY_LOC) return true;
653                                         break;
654                                 case CONSTRAINT_TYPE_SIZELIMIT:
655                                         if (searchtype == VISUALKEY_SCA) return true;
656                                         break;
657                                 case CONSTRAINT_TYPE_DISTLIMIT:
658                                         if (searchtype == VISUALKEY_LOC) return true;
659                                         break;
660                                 case CONSTRAINT_TYPE_ROTLIKE:
661                                         if (searchtype == VISUALKEY_ROT) return true;
662                                         break;
663                                 case CONSTRAINT_TYPE_LOCLIKE:
664                                         if (searchtype == VISUALKEY_LOC) return true;
665                                         break;
666                                 case CONSTRAINT_TYPE_SIZELIKE:
667                                         if (searchtype == VISUALKEY_SCA) return true;
668                                         break;
669                                 case CONSTRAINT_TYPE_LOCKTRACK:
670                                         if (searchtype == VISUALKEY_ROT) return true;
671                                         break;
672                                 case CONSTRAINT_TYPE_MINMAX:
673                                         if (searchtype == VISUALKEY_LOC) return true;
674                                         break;
675                                 
676                                 default:
677                                         break;
678                         }
679                 }
680         }
681         
682         /* when some condition is met, this function returns, so that means we've got nothing */
683         return false;
684 }
685
686 /* This helper function extracts the value to use for visual-keyframing 
687  * In the event that it is not possible to perform visual keying, try to fall-back
688  * to using the default method. Assumes that all data it has been passed is valid.
689  */
690 static float visualkey_get_value(PointerRNA *ptr, PropertyRNA *prop, int array_index)
691 {
692         const char *identifier = RNA_property_identifier(prop);
693         float tmat[4][4];
694         int rotmode;
695         
696         /* handle for Objects or PoseChannels only 
697          *  - only Location, Rotation or Scale keyframes are supported curently
698          *  - constraints can be on either Objects or PoseChannels, so we only check if the
699          *    ptr->type is RNA_Object or RNA_PoseBone, which are the RNA wrapping-info for
700          *        those structs, allowing us to identify the owner of the data
701          *  - assume that array_index will be sane
702          */
703         if (ptr->type == &RNA_Object) {
704                 Object *ob = (Object *)ptr->data;
705                 
706                 /* Loc code is specific... */
707                 if (strstr(identifier, "location")) {
708                         return ob->obmat[3][array_index];
709                 }
710                 
711                 copy_m4_m4(tmat, ob->obmat);
712                 rotmode = ob->rotmode;
713         }
714         else if (ptr->type == &RNA_PoseBone) {
715                 Object *ob = (Object *)ptr->id.data; /* we assume that this is always set, and is an object */
716                 bPoseChannel *pchan = (bPoseChannel *)ptr->data;
717                 float tmat[4][4];
718                 
719                 /* Although it is not strictly required for this particular space conversion, 
720                  * arg1 must not be null, as there is a null check for the other conversions to
721                  * be safe. Therefore, the active object is passed here, and in many cases, this
722                  * will be what owns the pose-channel that is getting this anyway.
723                  */
724                 copy_m4_m4(tmat, pchan->pose_mat);
725                 BKE_constraint_mat_convertspace(ob, pchan, tmat, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_LOCAL);
726                 rotmode = pchan->rotmode;
727                 
728                 /* Loc code is specific... */
729                 if (strstr(identifier, "location")) {
730                         /* only use for non-connected bones */
731                         if ((pchan->bone->parent == NULL) || !(pchan->bone->flag & BONE_CONNECTED))
732                                 return tmat[3][array_index];
733                 }
734         }
735         else {
736                 return setting_get_rna_value(ptr, prop, array_index);
737         }
738         
739         /* Rot/Scale code are common! */
740         if (strstr(identifier, "rotation_euler")) {
741                 float eul[3];
742                 
743                 mat4_to_eulO(eul, rotmode, tmat);
744                 return eul[array_index];
745         }
746         else if (strstr(identifier, "rotation_quaternion")) {
747                 float mat3[3][3], quat[4];
748                 
749                 copy_m3_m4(mat3, tmat);
750                 mat3_to_quat_is_ok(quat, mat3);
751                 
752                 return quat[array_index];
753         }
754         else if (strstr(identifier, "rotation_axis_angle")) {
755                 float axis[3], angle;
756                 
757                 mat4_to_axis_angle(axis, &angle, tmat);
758                 
759                 /* w = 0, x,y,z = 1,2,3 */
760                 if (array_index == 0)
761                         return angle;
762                 else
763                         return axis[array_index - 1];
764         }
765         else if (strstr(identifier, "scale")) {
766                 float scale[3];
767                 
768                 mat4_to_size(scale, tmat);
769                 
770                 return scale[array_index];
771         }
772         
773         /* as the function hasn't returned yet, read value from system in the default way */
774         return setting_get_rna_value(ptr, prop, array_index);
775 }
776
777 /* ------------------------- Insert Key API ------------------------- */
778
779 /* Secondary Keyframing API call: 
780  *  Use this when validation of necessary animation data is not necessary, since an RNA-pointer to the necessary
781  *      data being keyframed, and a pointer to the F-Curve to use have both been provided.
782  *
783  *      The flag argument is used for special settings that alter the behavior of
784  *      the keyframe insertion. These include the 'visual' keyframing modes, quick refresh,
785  *      and extra keyframe filtering.
786  */
787 short insert_keyframe_direct(ReportList *reports, PointerRNA ptr, PropertyRNA *prop, FCurve *fcu, float cfra, short flag)
788 {
789         float curval = 0.0f;
790         
791         /* no F-Curve to add keyframe to? */
792         if (fcu == NULL) {
793                 BKE_report(reports, RPT_ERROR, "No F-Curve to add keyframes to");
794                 return 0;
795         }
796         /* F-Curve not editable? */
797         if (fcurve_is_keyframable(fcu) == 0) {
798                 BKE_reportf(reports, RPT_ERROR, 
799                             "F-Curve with path '%s[%d]' cannot be keyframed, ensure that it is not locked or sampled, "
800                             "and try removing F-Modifiers",
801                             fcu->rna_path, fcu->array_index);
802                 return 0;
803         }
804         
805         /* if no property given yet, try to validate from F-Curve info */
806         if ((ptr.id.data == NULL) && (ptr.data == NULL)) {
807                 BKE_report(reports, RPT_ERROR, "No RNA pointer available to retrieve values for keyframing from");
808                 return 0;
809         }
810         if (prop == NULL) {
811                 PointerRNA tmp_ptr;
812                 
813                 /* try to get property we should be affecting */
814                 if ((RNA_path_resolve(&ptr, fcu->rna_path, &tmp_ptr, &prop) == 0) || (prop == NULL)) {
815                         /* property not found... */
816                         const char *idname = (ptr.id.data) ? ((ID *)ptr.id.data)->name : TIP_("<No ID pointer>");
817                         
818                         BKE_reportf(reports, RPT_ERROR,
819                                     "Could not insert keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
820                                     idname, fcu->rna_path);
821                         return 0;
822                 }
823                 else {
824                         /* property found, so overwrite 'ptr' to make later code easier */
825                         ptr = tmp_ptr;
826                 }
827         }
828         
829         /* set additional flags for the F-Curve (i.e. only integer values) */
830         fcu->flag &= ~(FCURVE_INT_VALUES | FCURVE_DISCRETE_VALUES);
831         switch (RNA_property_type(prop)) {
832                 case PROP_FLOAT:
833                         /* do nothing */
834                         break;
835                 case PROP_INT:
836                         /* do integer (only 'whole' numbers) interpolation between all points */
837                         fcu->flag |= FCURVE_INT_VALUES;
838                         break;
839                 default:
840                         /* do 'discrete' (i.e. enum, boolean values which cannot take any intermediate
841                          * values at all) interpolation between all points
842                          *      - however, we must also ensure that evaluated values are only integers still
843                          */
844                         fcu->flag |= (FCURVE_DISCRETE_VALUES | FCURVE_INT_VALUES);
845                         break;
846         }
847         
848         /* obtain value to give keyframe */
849         if ( (flag & INSERTKEY_MATRIX) && 
850              (visualkey_can_use(&ptr, prop)) )
851         {
852                 /* visual-keying is only available for object and pchan datablocks, as 
853                  * it works by keyframing using a value extracted from the final matrix 
854                  * instead of using the kt system to extract a value.
855                  */
856                 curval = visualkey_get_value(&ptr, prop, fcu->array_index);
857         }
858         else {
859                 /* read value from system */
860                 curval = setting_get_rna_value(&ptr, prop, fcu->array_index);
861         }
862         
863         /* only insert keyframes where they are needed */
864         if (flag & INSERTKEY_NEEDED) {
865                 short insert_mode;
866                 
867                 /* check whether this curve really needs a new keyframe */
868                 insert_mode = new_key_needed(fcu, cfra, curval);
869                 
870                 /* insert new keyframe at current frame */
871                 if (insert_mode)
872                         insert_vert_fcurve(fcu, cfra, curval, flag);
873                 
874                 /* delete keyframe immediately before/after newly added */
875                 switch (insert_mode) {
876                         case KEYNEEDED_DELPREV:
877                                 delete_fcurve_key(fcu, fcu->totvert - 2, 1);
878                                 break;
879                         case KEYNEEDED_DELNEXT:
880                                 delete_fcurve_key(fcu, 1, 1);
881                                 break;
882                 }
883                 
884                 /* only return success if keyframe added */
885                 if (insert_mode)
886                         return 1;
887         }
888         else {
889                 /* just insert keyframe */
890                 insert_vert_fcurve(fcu, cfra, curval, flag);
891                 
892                 /* return success */
893                 return 1;
894         }
895         
896         /* failed */
897         return 0;
898 }
899
900 /* Main Keyframing API call:
901  *      Use this when validation of necessary animation data is necessary, since it may not exist yet.
902  *      
903  *      The flag argument is used for special settings that alter the behavior of
904  *      the keyframe insertion. These include the 'visual' keyframing modes, quick refresh,
905  *      and extra keyframe filtering.
906  *
907  *      index of -1 keys all array indices
908  */
909 short insert_keyframe(ReportList *reports, ID *id, bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag)
910 {       
911         PointerRNA id_ptr, ptr;
912         PropertyRNA *prop = NULL;
913         FCurve *fcu;
914         int array_index_max = array_index + 1;
915         int ret = 0;
916         
917         /* validate pointer first - exit if failure */
918         if (id == NULL) {
919                 BKE_reportf(reports, RPT_ERROR, "No ID block to insert keyframe in (path = %s)", rna_path);
920                 return 0;
921         }
922         
923         RNA_id_pointer_create(id, &id_ptr);
924         if ((RNA_path_resolve(&id_ptr, rna_path, &ptr, &prop) == 0) || (prop == NULL)) {
925                 BKE_reportf(reports, RPT_ERROR,
926                             "Could not insert keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
927                             (id) ? id->name : TIP_("<Missing ID block>"), rna_path);
928                 return 0;
929         }
930         
931         /* if no action is provided, keyframe to the default one attached to this ID-block */
932         if (act == NULL) {
933                 AnimData *adt = BKE_animdata_from_id(id);
934                 
935                 /* get action to add F-Curve+keyframe to */
936                 act = verify_adt_action(id, 1);
937                 
938                 if (act == NULL) {
939                         BKE_reportf(reports, RPT_ERROR, 
940                                     "Could not insert keyframe, as this type does not support animation data (ID = %s, path = %s)",
941                                     id->name, rna_path);
942                         return 0;
943                 }
944                 
945                 /* apply NLA-mapping to frame to use (if applicable) */
946                 cfra = BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
947         }
948         
949         /* key entire array convenience method */
950         if (array_index == -1) {
951                 array_index = 0;
952                 array_index_max = RNA_property_array_length(&ptr, prop);
953                 
954                 /* for single properties, increase max_index so that the property itself gets included,
955                  * but don't do this for standard arrays since that can cause corruption issues 
956                  * (extra unused curves)
957                  */
958                 if (array_index_max == array_index)
959                         array_index_max++;
960         }
961         
962         /* will only loop once unless the array index was -1 */
963         for (; array_index < array_index_max; array_index++) {
964                 /* make sure the F-Curve exists 
965                  *      - if we're replacing keyframes only, DO NOT create new F-Curves if they do not exist yet
966                  *        but still try to get the F-Curve if it exists...
967                  */
968                 fcu = verify_fcurve(act, group, &ptr, rna_path, array_index, (flag & INSERTKEY_REPLACE) == 0);
969                 
970                 /* we may not have a F-Curve when we're replacing only... */
971                 if (fcu) {
972                         /* set color mode if the F-Curve is new (i.e. without any keyframes) */
973                         if ((fcu->totvert == 0) && (flag & INSERTKEY_XYZ2RGB)) {
974                                 /* for Loc/Rot/Scale and also Color F-Curves, the color of the F-Curve in the Graph Editor,
975                                  * is determined by the array index for the F-Curve
976                                  */
977                                 if (ELEM5(RNA_property_subtype(prop), PROP_TRANSLATION, PROP_XYZ, PROP_EULER, PROP_COLOR, PROP_COORDS)) {
978                                         fcu->color_mode = FCURVE_COLOR_AUTO_RGB;
979                                 }
980                         }
981                         
982                         /* insert keyframe */
983                         ret += insert_keyframe_direct(reports, ptr, prop, fcu, cfra, flag);
984                 }
985         }
986         
987         return ret;
988 }
989
990 /* ************************************************** */
991 /* KEYFRAME DELETION */
992
993 /* Main Keyframing API call:
994  *      Use this when validation of necessary animation data isn't necessary as it
995  *      already exists. It will delete a keyframe at the current frame.
996  *      
997  *      The flag argument is used for special settings that alter the behavior of
998  *      the keyframe deletion. These include the quick refresh options.
999  */
1000 short delete_keyframe(ReportList *reports, ID *id, bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short UNUSED(flag))
1001 {
1002         AnimData *adt = BKE_animdata_from_id(id);
1003         PointerRNA id_ptr, ptr;
1004         PropertyRNA *prop;
1005         int array_index_max = array_index + 1;
1006         int ret = 0;
1007         
1008         /* sanity checks */
1009         if (ELEM(NULL, id, adt)) {
1010                 BKE_report(reports, RPT_ERROR, "No ID block and/or AnimData to delete keyframe from");
1011                 return 0;
1012         }
1013         
1014         /* validate pointer first - exit if failure */
1015         RNA_id_pointer_create(id, &id_ptr);
1016         if ((RNA_path_resolve(&id_ptr, rna_path, &ptr, &prop) == 0) || (prop == NULL)) {
1017                 BKE_reportf(reports, RPT_ERROR,
1018                             "Could not delete keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
1019                             id->name, rna_path);
1020                 return 0;
1021         }
1022         
1023         /* get F-Curve
1024          * Note: here is one of the places where we don't want new Action + F-Curve added!
1025          *      so 'add' var must be 0
1026          */
1027         if (act == NULL) {
1028                 /* if no action is provided, use the default one attached to this ID-block 
1029                  *  - if it doesn't exist, then we're out of options...
1030                  */
1031                 if (adt->action) {
1032                         act = adt->action;
1033                         
1034                         /* apply NLA-mapping to frame to use (if applicable) */
1035                         cfra = BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
1036                 }
1037                 else {
1038                         BKE_reportf(reports, RPT_ERROR, "No action to delete keyframes from for ID = %s", id->name);
1039                         return 0;
1040                 }
1041         }
1042         
1043         /* key entire array convenience method */
1044         if (array_index == -1) {
1045                 array_index = 0;
1046                 array_index_max = RNA_property_array_length(&ptr, prop);
1047                 
1048                 /* for single properties, increase max_index so that the property itself gets included,
1049                  * but don't do this for standard arrays since that can cause corruption issues 
1050                  * (extra unused curves)
1051                  */
1052                 if (array_index_max == array_index)
1053                         array_index_max++;
1054         }
1055         
1056         /* will only loop once unless the array index was -1 */
1057         for (; array_index < array_index_max; array_index++) {
1058                 FCurve *fcu = verify_fcurve(act, group, &ptr, rna_path, array_index, 0);
1059                 short found = -1;
1060                 int i;
1061                 
1062                 /* check if F-Curve exists and/or whether it can be edited */
1063                 if (fcu == NULL)
1064                         continue;
1065                         
1066                 if ( (fcu->flag & FCURVE_PROTECTED) || ((fcu->grp) && (fcu->grp->flag & AGRP_PROTECTED)) ) {
1067                         if (G.debug & G_DEBUG)
1068                                 printf("WARNING: not deleting keyframe for locked F-Curve\n");
1069                         continue;
1070                 }
1071                 
1072                 /* try to find index of beztriple to get rid of */
1073                 i = binarysearch_bezt_index(fcu->bezt, cfra, fcu->totvert, &found);
1074                 if (found) {
1075                         /* delete the key at the index (will sanity check + do recalc afterwards) */
1076                         delete_fcurve_key(fcu, i, 1);
1077                         
1078                         /* Only delete curve too if it won't be doing anything anymore */
1079                         if ((fcu->totvert == 0) && (list_has_suitable_fmodifier(&fcu->modifiers, 0, FMI_TYPE_GENERATE_CURVE) == 0))
1080                                 ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
1081                         
1082                         /* return success */
1083                         ret++;
1084                 }
1085         }
1086         
1087         /* return success/failure */
1088         return ret;
1089 }
1090
1091 /* ************************************************** */
1092 /* KEYFRAME CLEAR */
1093
1094 /* Main Keyframing API call:
1095  *      Use this when validation of necessary animation data isn't necessary as it
1096  *      already exists. It will clear the current buttons fcurve(s).
1097  *
1098  *      The flag argument is used for special settings that alter the behavior of
1099  *      the keyframe deletion. These include the quick refresh options.
1100  */
1101 static short clear_keyframe(ReportList *reports, ID *id, bAction *act, const char group[], const char rna_path[], int array_index, short UNUSED(flag))
1102 {
1103         AnimData *adt = BKE_animdata_from_id(id);
1104         PointerRNA id_ptr, ptr;
1105         PropertyRNA *prop;
1106         int array_index_max = array_index + 1;
1107         int ret = 0;
1108
1109         /* sanity checks */
1110         if (ELEM(NULL, id, adt)) {
1111                 BKE_report(reports, RPT_ERROR, "No ID block and/or AnimData to delete keyframe from");
1112                 return 0;
1113         }
1114
1115         /* validate pointer first - exit if failure */
1116         RNA_id_pointer_create(id, &id_ptr);
1117         if ((RNA_path_resolve(&id_ptr, rna_path, &ptr, &prop) == 0) || (prop == NULL)) {
1118                 BKE_reportf(reports, RPT_ERROR,
1119                             "Could not clear keyframe, as RNA path is invalid for the given ID (ID = %s, path = %s)",
1120                             id->name, rna_path);
1121                 return 0;
1122         }
1123
1124         /* get F-Curve
1125          * Note: here is one of the places where we don't want new Action + F-Curve added!
1126          *      so 'add' var must be 0
1127          */
1128         if (act == NULL) {
1129                 /* if no action is provided, use the default one attached to this ID-block
1130                  *  - if it doesn't exist, then we're out of options...
1131                  */
1132                 if (adt->action) {
1133                         act = adt->action;
1134                 }
1135                 else {
1136                         BKE_reportf(reports, RPT_ERROR, "No action to delete keyframes from for ID = %s", id->name);
1137                         return 0;
1138                 }
1139         }
1140
1141         /* key entire array convenience method */
1142         if (array_index == -1) {
1143                 array_index = 0;
1144                 array_index_max = RNA_property_array_length(&ptr, prop);
1145
1146                 /* for single properties, increase max_index so that the property itself gets included,
1147                  * but don't do this for standard arrays since that can cause corruption issues
1148                  * (extra unused curves)
1149                  */
1150                 if (array_index_max == array_index)
1151                         array_index_max++;
1152         }
1153
1154         /* will only loop once unless the array index was -1 */
1155         for (; array_index < array_index_max; array_index++) {
1156                 FCurve *fcu = verify_fcurve(act, group, &ptr, rna_path, array_index, 0);
1157
1158                 /* check if F-Curve exists and/or whether it can be edited */
1159                 if (fcu == NULL)
1160                         continue;
1161
1162                 if ( (fcu->flag & FCURVE_PROTECTED) || ((fcu->grp) && (fcu->grp->flag & AGRP_PROTECTED)) ) {
1163                         if (G.debug & G_DEBUG)
1164                                 printf("WARNING: not deleting keyframe for locked F-Curve\n");
1165                         continue;
1166                 }
1167
1168                 ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
1169
1170                 /* return success */
1171                 ret++;
1172         }
1173
1174         /* return success/failure */
1175         return ret;
1176 }
1177
1178 /* ******************************************* */
1179 /* KEYFRAME MODIFICATION */
1180
1181 /* mode for commonkey_modifykey */
1182 enum {
1183         COMMONKEY_MODE_INSERT = 0,
1184         COMMONKEY_MODE_DELETE,
1185 } /*eCommonModifyKey_Modes*/;
1186
1187 /* Polling callback for use with ANIM_*_keyframe() operators
1188  * This is based on the standard ED_operator_areaactive callback,
1189  * except that it does special checks for a few spacetypes too...
1190  */
1191 static int modify_key_op_poll(bContext *C)
1192 {
1193         ScrArea *sa = CTX_wm_area(C);
1194         Scene *scene = CTX_data_scene(C);
1195         SpaceOops *so = CTX_wm_space_outliner(C);
1196         
1197         /* if no area or active scene */
1198         if (ELEM(NULL, sa, scene)) 
1199                 return 0;
1200         
1201         /* if Outliner, don't allow in some views */
1202         if (so) {
1203                 if (ELEM5(so->outlinevis, SO_GROUPS, SO_LIBRARIES, SO_SEQUENCE, SO_USERDEF, SO_KEYMAP)) {
1204                         return 0;
1205                 }
1206         }
1207         
1208         /* TODO: checks for other space types can be added here */
1209         
1210         /* should be fine */
1211         return 1;
1212 }
1213
1214 /* Insert Key Operator ------------------------ */
1215
1216 static int insert_key_exec(bContext *C, wmOperator *op)
1217 {
1218         Main *bmain = CTX_data_main(C);
1219         Scene *scene = CTX_data_scene(C);
1220         KeyingSet *ks = NULL;
1221         int type = RNA_enum_get(op->ptr, "type");
1222         float cfra = (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1223         short success;
1224         
1225         /* type is the Keying Set the user specified to use when calling the operator:
1226          *      - type == 0: use scene's active Keying Set
1227          *      - type > 0: use a user-defined Keying Set from the active scene
1228          *      - type < 0: use a builtin Keying Set
1229          */
1230         if (type == 0) 
1231                 type = scene->active_keyingset;
1232         if (type > 0)
1233                 ks = BLI_findlink(&scene->keyingsets, type - 1);
1234         else
1235                 ks = BLI_findlink(&builtin_keyingsets, -type - 1);
1236                 
1237         /* report failures */
1238         if (ks == NULL) {
1239                 BKE_report(op->reports, RPT_ERROR, "No active keying set");
1240                 return OPERATOR_CANCELLED;
1241         }
1242         
1243         /* try to insert keyframes for the channels specified by KeyingSet */
1244         success = ANIM_apply_keyingset(C, NULL, NULL, ks, MODIFYKEY_MODE_INSERT, cfra);
1245         if (G.debug & G_DEBUG)
1246                 BKE_reportf(op->reports, RPT_INFO, "Keying set '%s' - successfully added %d keyframes", ks->name, success);
1247         
1248         /* report failure or do updates? */
1249         if (success == MODIFYKEY_INVALID_CONTEXT) {
1250                 BKE_report(op->reports, RPT_ERROR, "No suitable context info for active keying set");
1251                 return OPERATOR_CANCELLED;
1252         }
1253         else if (success) {
1254                 /* if the appropriate properties have been set, make a note that we've inserted something */
1255                 if (RNA_boolean_get(op->ptr, "confirm_success"))
1256                         BKE_reportf(op->reports, RPT_INFO, "Successfully added %d keyframes for keying set '%s'", success, ks->name);
1257                 
1258                 /* send notifiers that keyframes have been changed */
1259                 WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1260         }
1261         else
1262                 BKE_report(op->reports, RPT_WARNING, "Keying set failed to insert any keyframes");
1263         
1264         /* send updates */
1265         DAG_ids_flush_update(bmain, 0);
1266         
1267         return OPERATOR_FINISHED;
1268 }
1269
1270 void ANIM_OT_keyframe_insert(wmOperatorType *ot)
1271 {
1272         PropertyRNA *prop;
1273         
1274         /* identifiers */
1275         ot->name = "Insert Keyframe";
1276         ot->idname = "ANIM_OT_keyframe_insert";
1277         ot->description = "Insert keyframes on the current frame for all properties in the specified Keying Set";
1278         
1279         /* callbacks */
1280         ot->exec = insert_key_exec; 
1281         ot->poll = modify_key_op_poll;
1282         
1283         /* flags */
1284         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1285         
1286         /* keyingset to use (dynamic enum) */
1287         prop = RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1288         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1289         RNA_def_property_flag(prop, PROP_HIDDEN);
1290         ot->prop = prop;
1291         
1292         /* confirm whether a keyframe was added by showing a popup 
1293          *      - by default, this is enabled, since this operator is assumed to be called independently
1294          */
1295         prop = RNA_def_boolean(ot->srna, "confirm_success", 1, "Confirm Successful Insert",
1296                                "Show a popup when the keyframes get successfully added");
1297         RNA_def_property_flag(prop, PROP_HIDDEN);
1298 }
1299
1300 /* Insert Key Operator (With Menu) ------------------------ */
1301 /* This operator checks if a menu should be shown for choosing the KeyingSet to use, 
1302  * then calls the menu if necessary before 
1303  */
1304
1305 static int insert_key_menu_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(event))
1306 {
1307         Scene *scene = CTX_data_scene(C);
1308         
1309         /* if prompting or no active Keying Set, show the menu */
1310         if ((scene->active_keyingset == 0) || RNA_boolean_get(op->ptr, "always_prompt")) {
1311                 uiPopupMenu *pup;
1312                 uiLayout *layout;
1313                 
1314                 /* call the menu, which will call this operator again, hence the canceled */
1315                 pup = uiPupMenuBegin(C, op->type->name, ICON_NONE);
1316                 layout = uiPupMenuLayout(pup);
1317                 uiItemsEnumO(layout, "ANIM_OT_keyframe_insert_menu", "type");
1318                 uiPupMenuEnd(C, pup);
1319                 
1320                 return OPERATOR_CANCELLED;
1321         }
1322         else {
1323                 /* just call the exec() on the active keyingset */
1324                 RNA_enum_set(op->ptr, "type", 0);
1325                 RNA_boolean_set(op->ptr, "confirm_success", TRUE);
1326                 
1327                 return op->type->exec(C, op);
1328         }
1329 }
1330  
1331 void ANIM_OT_keyframe_insert_menu(wmOperatorType *ot)
1332 {
1333         PropertyRNA *prop;
1334         
1335         /* identifiers */
1336         ot->name = "Insert Keyframe Menu";
1337         ot->idname = "ANIM_OT_keyframe_insert_menu";
1338         ot->description = "Insert Keyframes for specified Keying Set, with menu of available Keying Sets if undefined";
1339         
1340         /* callbacks */
1341         ot->invoke = insert_key_menu_invoke;
1342         ot->exec = insert_key_exec; 
1343         ot->poll = ED_operator_areaactive;
1344         
1345         /* flags */
1346         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1347         
1348         /* keyingset to use (dynamic enum) */
1349         prop = RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1350         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1351         RNA_def_property_flag(prop, PROP_HIDDEN);
1352         ot->prop = prop;
1353         
1354         /* confirm whether a keyframe was added by showing a popup 
1355          *      - by default, this is disabled so that if a menu is shown, this doesn't come up too
1356          */
1357         // XXX should this just be always on?
1358         prop = RNA_def_boolean(ot->srna, "confirm_success", 0, "Confirm Successful Insert",
1359                                "Show a popup when the keyframes get successfully added");
1360         RNA_def_property_flag(prop, PROP_HIDDEN);
1361         
1362         /* whether the menu should always be shown 
1363          *      - by default, the menu should only be shown when there is no active Keying Set (2.5 behavior),
1364          *        although in some cases it might be useful to always shown (pre 2.5 behavior)
1365          */
1366         prop = RNA_def_boolean(ot->srna, "always_prompt", 0, "Always Show Menu", "");
1367         RNA_def_property_flag(prop, PROP_HIDDEN);
1368 }
1369
1370 /* Delete Key Operator ------------------------ */
1371
1372 static int delete_key_exec(bContext *C, wmOperator *op)
1373 {
1374         Main *bmain = CTX_data_main(C);
1375         Scene *scene = CTX_data_scene(C);
1376         KeyingSet *ks = NULL;
1377         int type = RNA_enum_get(op->ptr, "type");
1378         float cfra = (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1379         short success;
1380         
1381         /* type is the Keying Set the user specified to use when calling the operator:
1382          *      - type == 0: use scene's active Keying Set
1383          *      - type > 0: use a user-defined Keying Set from the active scene
1384          *      - type < 0: use a builtin Keying Set
1385          */
1386         if (type == 0) 
1387                 type = scene->active_keyingset;
1388         if (type > 0)
1389                 ks = BLI_findlink(&scene->keyingsets, type - 1);
1390         else
1391                 ks = BLI_findlink(&builtin_keyingsets, -type - 1);
1392         
1393         /* report failure */
1394         if (ks == NULL) {
1395                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set");
1396                 return OPERATOR_CANCELLED;
1397         }
1398         
1399         /* try to delete keyframes for the channels specified by KeyingSet */
1400         success = ANIM_apply_keyingset(C, NULL, NULL, ks, MODIFYKEY_MODE_DELETE, cfra);
1401         if (G.debug & G_DEBUG)
1402                 printf("KeyingSet '%s' - Successfully removed %d Keyframes\n", ks->name, success);
1403         
1404         /* report failure or do updates? */
1405         if (success == MODIFYKEY_INVALID_CONTEXT) {
1406                 BKE_report(op->reports, RPT_ERROR, "No suitable context info for active keying set");
1407                 return OPERATOR_CANCELLED;
1408         }
1409         else if (success) {
1410                 /* if the appropriate properties have been set, make a note that we've inserted something */
1411                 if (RNA_boolean_get(op->ptr, "confirm_success"))
1412                         BKE_reportf(op->reports, RPT_INFO, "Successfully removed %d keyframes for keying set '%s'", success, ks->name);
1413                 
1414                 /* send notifiers that keyframes have been changed */
1415                 WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1416         }
1417         else
1418                 BKE_report(op->reports, RPT_WARNING, "Keying set failed to remove any keyframes");
1419         
1420         /* send updates */
1421         DAG_ids_flush_update(bmain, 0);
1422         
1423         return OPERATOR_FINISHED;
1424 }
1425
1426 void ANIM_OT_keyframe_delete(wmOperatorType *ot)
1427 {
1428         PropertyRNA *prop;
1429         
1430         /* identifiers */
1431         ot->name = "Delete Keying-Set Keyframe";
1432         ot->idname = "ANIM_OT_keyframe_delete";
1433         ot->description = "Delete keyframes on the current frame for all properties in the specified Keying Set";
1434         
1435         /* callbacks */
1436         ot->exec = delete_key_exec; 
1437         ot->poll = modify_key_op_poll;
1438         
1439         /* flags */
1440         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1441         
1442         /* keyingset to use (dynamic enum) */
1443         prop = RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1444         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1445         RNA_def_property_flag(prop, PROP_HIDDEN);
1446         ot->prop = prop;
1447         
1448         /* confirm whether a keyframe was added by showing a popup 
1449          *      - by default, this is enabled, since this operator is assumed to be called independently
1450          */
1451         RNA_def_boolean(ot->srna, "confirm_success", 1, "Confirm Successful Delete",
1452                         "Show a popup when the keyframes get successfully removed");
1453 }
1454
1455 /* Delete Key Operator ------------------------ */
1456 /* NOTE: Although this version is simpler than the more generic version for KeyingSets,
1457  * it is more useful for animators working in the 3D view.
1458  */
1459  
1460 static int clear_anim_v3d_exec(bContext *C, wmOperator *UNUSED(op))
1461 {
1462         Main *bmain = CTX_data_main(C);
1463         
1464         CTX_DATA_BEGIN (C, Object *, ob, selected_objects)
1465         {
1466                 /* just those in active action... */
1467                 if ((ob->adt) && (ob->adt->action)) {
1468                         AnimData *adt = ob->adt;
1469                         bAction *act = adt->action;
1470                         FCurve *fcu, *fcn;
1471                         
1472                         for (fcu = act->curves.first; fcu; fcu = fcn) {
1473                                 short can_delete = FALSE;
1474                                 
1475                                 fcn = fcu->next;
1476                                 
1477                                 /* in pose mode, only delete the F-Curve if it belongs to a selected bone */
1478                                 if (ob->mode & OB_MODE_POSE) {
1479                                         if ((fcu->rna_path) && strstr(fcu->rna_path, "pose.bones[")) {
1480                                                 bPoseChannel *pchan;
1481                                                 char *bone_name;
1482                                                 
1483                                                 /* get bone-name, and check if this bone is selected */
1484                                                 bone_name = BLI_str_quoted_substrN(fcu->rna_path, "pose.bones[");
1485                                                 pchan = BKE_pose_channel_find_name(ob->pose, bone_name);
1486                                                 if (bone_name) MEM_freeN(bone_name);
1487                                                 
1488                                                 /* delete if bone is selected*/
1489                                                 if ((pchan) && (pchan->bone)) {
1490                                                         if (pchan->bone->flag & BONE_SELECTED)
1491                                                                 can_delete = TRUE;
1492                                                 }
1493                                         }
1494                                 }
1495                                 else {
1496                                         /* object mode - all of Object's F-Curves are affected */
1497                                         can_delete = TRUE;
1498                                 }
1499                                 
1500                                 /* delete F-Curve completely */
1501                                 if (can_delete) {
1502                                         ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
1503                                 }
1504                         }
1505                 }
1506                 
1507                 /* update... */
1508                 ob->recalc |= OB_RECALC_OB;
1509         }
1510         CTX_DATA_END;
1511         
1512         /* send updates */
1513         DAG_ids_flush_update(bmain, 0);
1514         WM_event_add_notifier(C, NC_OBJECT | ND_KEYS, NULL);
1515         
1516         return OPERATOR_FINISHED;
1517 }
1518
1519 void ANIM_OT_keyframe_clear_v3d(wmOperatorType *ot)
1520 {
1521         /* identifiers */
1522         ot->name = "Remove Animation";
1523         ot->description = "Remove all keyframe animation for selected objects";
1524         ot->idname = "ANIM_OT_keyframe_clear_v3d";
1525         
1526         /* callbacks */
1527         ot->invoke = WM_operator_confirm;
1528         ot->exec = clear_anim_v3d_exec; 
1529         
1530         ot->poll = ED_operator_areaactive;
1531         
1532         /* flags */
1533         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1534 }
1535
1536
1537 static int delete_key_v3d_exec(bContext *C, wmOperator *op)
1538 {
1539         Main *bmain = CTX_data_main(C);
1540         Scene *scene = CTX_data_scene(C);
1541         float cfra = (float)CFRA;
1542         
1543         CTX_DATA_BEGIN (C, Object *, ob, selected_objects)
1544         {
1545                 ID *id = &ob->id;
1546                 int success = 0;
1547                 
1548                 /* just those in active action... */
1549                 if ((ob->adt) && (ob->adt->action)) {
1550                         AnimData *adt = ob->adt;
1551                         bAction *act = adt->action;
1552                         FCurve *fcu, *fcn;
1553                         
1554                         for (fcu = act->curves.first; fcu; fcu = fcn) {
1555                                 fcn = fcu->next;
1556                                 
1557                                 /* delete keyframes on current frame 
1558                                  * WARNING: this can delete the next F-Curve, hence the "fcn" copying
1559                                  */
1560                                 success += delete_keyframe(op->reports, id, NULL, NULL, fcu->rna_path, fcu->array_index, cfra, 0);
1561                         }
1562                 }
1563                 
1564                 /* report success (or failure) */
1565                 BKE_reportf(op->reports, RPT_INFO, "Object '%s' successfully had %d keyframes removed", id->name + 2, success);
1566                 ob->recalc |= OB_RECALC_OB;
1567         }
1568         CTX_DATA_END;
1569         
1570         /* send updates */
1571         DAG_ids_flush_update(bmain, 0);
1572         WM_event_add_notifier(C, NC_OBJECT | ND_KEYS, NULL);
1573         
1574         return OPERATOR_FINISHED;
1575 }
1576
1577 void ANIM_OT_keyframe_delete_v3d(wmOperatorType *ot)
1578 {
1579         /* identifiers */
1580         ot->name = "Delete Keyframe";
1581         ot->description = "Remove keyframes on current frame for selected objects";
1582         ot->idname = "ANIM_OT_keyframe_delete_v3d";
1583         
1584         /* callbacks */
1585         ot->invoke = WM_operator_confirm;
1586         ot->exec = delete_key_v3d_exec; 
1587         
1588         ot->poll = ED_operator_areaactive;
1589         
1590         /* flags */
1591         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
1592 }
1593
1594
1595 /* Insert Key Button Operator ------------------------ */
1596
1597 static int insert_key_button_exec(bContext *C, wmOperator *op)
1598 {
1599         Main *bmain = CTX_data_main(C);
1600         Scene *scene = CTX_data_scene(C);
1601         PointerRNA ptr = {{NULL}};
1602         PropertyRNA *prop = NULL;
1603         char *path;
1604         float cfra = (float)CFRA;
1605         short success = 0;
1606         int a, index, length, all = RNA_boolean_get(op->ptr, "all");
1607         short flag = 0;
1608         
1609         /* flags for inserting keyframes */
1610         flag = ANIM_get_keyframing_flags(scene, 1);
1611         
1612         /* try to insert keyframe using property retrieved from UI */
1613         uiContextActiveProperty(C, &ptr, &prop, &index);
1614         
1615         if ((ptr.id.data && ptr.data && prop) && RNA_property_animateable(&ptr, prop)) {
1616                 path = RNA_path_from_ID_to_property(&ptr, prop);
1617                 
1618                 if (path) {
1619                         if (all) {
1620                                 length = RNA_property_array_length(&ptr, prop);
1621                                 
1622                                 if (length) index = 0;
1623                                 else length = 1;
1624                         }
1625                         else
1626                                 length = 1;
1627                         
1628                         for (a = 0; a < length; a++)
1629                                 success += insert_keyframe(op->reports, ptr.id.data, NULL, NULL, path, index + a, cfra, flag);
1630                         
1631                         MEM_freeN(path);
1632                 }
1633                 else if (ptr.type == &RNA_NlaStrip) {
1634                         /* handle special vars for NLA-strips */
1635                         NlaStrip *strip = (NlaStrip *)ptr.data;
1636                         FCurve *fcu = list_find_fcurve(&strip->fcurves, RNA_property_identifier(prop), flag);
1637                         
1638                         success += insert_keyframe_direct(op->reports, ptr, prop, fcu, cfra, 0);
1639                 }
1640                 else {
1641                         if (G.debug & G_DEBUG)
1642                                 printf("Button Insert-Key: no path to property\n");
1643                         BKE_report(op->reports, RPT_WARNING, "Failed to resolve path to property, try using a keying set instead");
1644                 }
1645         }
1646         else if (G.debug & G_DEBUG) {
1647                 printf("ptr.data = %p, prop = %p,", (void *)ptr.data, (void *)prop);
1648                 if (prop)
1649                         printf("animatable = %d\n", RNA_property_animateable(&ptr, prop));
1650                 else
1651                         printf("animatable = NULL\n");
1652         }
1653         
1654         if (success) {
1655                 /* send updates */
1656                 uiContextAnimUpdate(C);
1657                 
1658                 DAG_ids_flush_update(bmain, 0);
1659                 
1660                 /* send notifiers that keyframes have been changed */
1661                 WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1662         }
1663         
1664         return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
1665 }
1666
1667 void ANIM_OT_keyframe_insert_button(wmOperatorType *ot)
1668 {
1669         /* identifiers */
1670         ot->name = "Insert Keyframe (Buttons)";
1671         ot->idname = "ANIM_OT_keyframe_insert_button";
1672         ot->description = "Insert a keyframe for current UI-active property";
1673         
1674         /* callbacks */
1675         ot->exec = insert_key_button_exec; 
1676         ot->poll = modify_key_op_poll;
1677         
1678         /* flags */
1679         ot->flag = OPTYPE_UNDO;
1680
1681         /* properties */
1682         RNA_def_boolean(ot->srna, "all", 1, "All", "Insert a keyframe for all element of the array");
1683 }
1684
1685 /* Delete Key Button Operator ------------------------ */
1686
1687 static int delete_key_button_exec(bContext *C, wmOperator *op)
1688 {
1689         Main *bmain = CTX_data_main(C);
1690         Scene *scene = CTX_data_scene(C);
1691         PointerRNA ptr = {{NULL}};
1692         PropertyRNA *prop = NULL;
1693         char *path;
1694         float cfra = (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1695         short success = 0;
1696         int a, index, length, all = RNA_boolean_get(op->ptr, "all");
1697         
1698         /* try to insert keyframe using property retrieved from UI */
1699         uiContextActiveProperty(C, &ptr, &prop, &index);
1700
1701         if (ptr.id.data && ptr.data && prop) {
1702                 path = RNA_path_from_ID_to_property(&ptr, prop);
1703                 
1704                 if (path) {
1705                         if (all) {
1706                                 length = RNA_property_array_length(&ptr, prop);
1707                                 
1708                                 if (length) index = 0;
1709                                 else length = 1;
1710                         }
1711                         else
1712                                 length = 1;
1713                         
1714                         for (a = 0; a < length; a++)
1715                                 success += delete_keyframe(op->reports, ptr.id.data, NULL, NULL, path, index + a, cfra, 0);
1716                         
1717                         MEM_freeN(path);
1718                 }
1719                 else if (G.debug & G_DEBUG)
1720                         printf("Button Delete-Key: no path to property\n");
1721         }
1722         else if (G.debug & G_DEBUG) {
1723                 printf("ptr.data = %p, prop = %p\n", (void *)ptr.data, (void *)prop);
1724         }
1725         
1726         
1727         if (success) {
1728                 /* send updates */
1729                 uiContextAnimUpdate(C);
1730                 
1731                 DAG_ids_flush_update(bmain, 0);
1732                 
1733                 /* send notifiers that keyframes have been changed */
1734                 WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1735         }
1736         
1737         return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
1738 }
1739
1740 void ANIM_OT_keyframe_delete_button(wmOperatorType *ot)
1741 {
1742         /* identifiers */
1743         ot->name = "Delete Keyframe (Buttons)";
1744         ot->idname = "ANIM_OT_keyframe_delete_button";
1745         ot->description = "Delete current keyframe of current UI-active property";
1746         
1747         /* callbacks */
1748         ot->exec = delete_key_button_exec; 
1749         ot->poll = modify_key_op_poll;
1750         
1751         /* flags */
1752         ot->flag = OPTYPE_UNDO;
1753
1754         /* properties */
1755         RNA_def_boolean(ot->srna, "all", 1, "All", "Delete keyframes from all elements of the array");
1756 }
1757
1758
1759 /* Clear Key Button Operator ------------------------ */
1760
1761 static int clear_key_button_exec(bContext *C, wmOperator *op)
1762 {
1763         Main *bmain = CTX_data_main(C);
1764         PointerRNA ptr = {{NULL}};
1765         PropertyRNA *prop = NULL;
1766         char *path;
1767         short success = 0;
1768         int a, index, length, all = RNA_boolean_get(op->ptr, "all");
1769
1770         /* try to insert keyframe using property retrieved from UI */
1771         uiContextActiveProperty(C, &ptr, &prop, &index);
1772
1773         if (ptr.id.data && ptr.data && prop) {
1774                 path = RNA_path_from_ID_to_property(&ptr, prop);
1775                 
1776                 if (path) {
1777                         if (all) {
1778                                 length = RNA_property_array_length(&ptr, prop);
1779                                 
1780                                 if (length) index = 0;
1781                                 else length = 1;
1782                         }
1783                         else
1784                                 length = 1;
1785                         
1786                         for (a = 0; a < length; a++)
1787                                 success += clear_keyframe(op->reports, ptr.id.data, NULL, NULL, path, index + a, 0);
1788                         
1789                         MEM_freeN(path);
1790                 }
1791                 else if (G.debug & G_DEBUG)
1792                         printf("Button Clear-Key: no path to property\n");
1793         }
1794         else if (G.debug & G_DEBUG) {
1795                 printf("ptr.data = %p, prop = %p\n", (void *)ptr.data, (void *)prop);
1796         }
1797
1798
1799         if (success) {
1800                 /* send updates */
1801                 uiContextAnimUpdate(C);
1802                 
1803                 DAG_ids_flush_update(bmain, 0);
1804                 
1805                 /* send notifiers that keyframes have been changed */
1806                 WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
1807         }
1808
1809         return (success) ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
1810 }
1811
1812 void ANIM_OT_keyframe_clear_button(wmOperatorType *ot)
1813 {
1814         /* identifiers */
1815         ot->name = "Clear Keyframe (Buttons)";
1816         ot->idname = "ANIM_OT_keyframe_clear_button";
1817         ot->description = "Clear all keyframes on the currently active property";
1818
1819         /* callbacks */
1820         ot->exec = clear_key_button_exec;
1821         ot->poll = modify_key_op_poll;
1822
1823         /* flags */
1824         ot->flag = OPTYPE_UNDO;
1825
1826         /* properties */
1827         RNA_def_boolean(ot->srna, "all", 1, "All", "Clear keyframes from all elements of the array");
1828 }
1829
1830 /* ******************************************* */
1831 /* AUTO KEYFRAME */
1832
1833 int autokeyframe_cfra_can_key(Scene *scene, ID *id)
1834 {
1835         float cfra = (float)CFRA; // XXX for now, this will do
1836         
1837         /* only filter if auto-key mode requires this */
1838         if (IS_AUTOKEY_ON(scene) == 0)
1839                 return 0;
1840                 
1841         if (IS_AUTOKEY_MODE(scene, NORMAL)) {
1842                 /* can insert anytime we like... */
1843                 return 1;
1844         }
1845         else { /* REPLACE */
1846                 /* for whole block - only key if there's a keyframe on that frame already
1847                  *      this is a valid assumption when we're blocking + tweaking
1848                  */
1849                 return id_frame_has_keyframe(id, cfra, ANIMFILTER_KEYS_LOCAL);
1850         }
1851 }
1852
1853 /* ******************************************* */
1854 /* KEYFRAME DETECTION */
1855
1856 /* --------------- API/Per-Datablock Handling ------------------- */
1857
1858 /* Checks if some F-Curve has a keyframe for a given frame */
1859 short fcurve_frame_has_keyframe(FCurve *fcu, float frame, short filter)
1860 {
1861         /* quick sanity check */
1862         if (ELEM(NULL, fcu, fcu->bezt))
1863                 return 0;
1864         
1865         /* we either include all regardless of muting, or only non-muted  */
1866         if ((filter & ANIMFILTER_KEYS_MUTED) || (fcu->flag & FCURVE_MUTED) == 0) {
1867                 short replace = -1;
1868                 int i = binarysearch_bezt_index(fcu->bezt, frame, fcu->totvert, &replace);
1869                 
1870                 /* binarysearch_bezt_index will set replace to be 0 or 1
1871                  * - obviously, 1 represents a match
1872                  */
1873                 if (replace) {
1874                         /* sanity check: 'i' may in rare cases exceed arraylen */
1875                         if ((i >= 0) && (i < fcu->totvert))
1876                                 return 1;
1877                 }
1878         }
1879         
1880         return 0;
1881 }
1882
1883 /* Checks whether an Action has a keyframe for a given frame 
1884  * Since we're only concerned whether a keyframe exists, we can simply loop until a match is found...
1885  */
1886 static short action_frame_has_keyframe(bAction *act, float frame, short filter)
1887 {
1888         FCurve *fcu;
1889         
1890         /* can only find if there is data */
1891         if (act == NULL)
1892                 return 0;
1893                 
1894         /* if only check non-muted, check if muted */
1895         if ((filter & ANIMFILTER_KEYS_MUTED) || (act->flag & ACT_MUTED))
1896                 return 0;
1897         
1898         /* loop over F-Curves, using binary-search to try to find matches 
1899          *      - this assumes that keyframes are only beztriples
1900          */
1901         for (fcu = act->curves.first; fcu; fcu = fcu->next) {
1902                 /* only check if there are keyframes (currently only of type BezTriple) */
1903                 if (fcu->bezt && fcu->totvert) {
1904                         if (fcurve_frame_has_keyframe(fcu, frame, filter))
1905                                 return 1;
1906                 }
1907         }
1908         
1909         /* nothing found */
1910         return 0;
1911 }
1912
1913 /* Checks whether an Object has a keyframe for a given frame */
1914 static short object_frame_has_keyframe(Object *ob, float frame, short filter)
1915 {
1916         /* error checking */
1917         if (ob == NULL)
1918                 return 0;
1919         
1920         /* check own animation data - specifically, the action it contains */
1921         if ((ob->adt) && (ob->adt->action)) {
1922                 if (action_frame_has_keyframe(ob->adt->action, frame, filter))
1923                         return 1;
1924         }
1925         
1926         /* try shapekey keyframes (if available, and allowed by filter) */
1927         if (!(filter & ANIMFILTER_KEYS_LOCAL) && !(filter & ANIMFILTER_KEYS_NOSKEY) ) {
1928                 Key *key = BKE_key_from_object(ob);
1929                 
1930                 /* shapekeys can have keyframes ('Relative Shape Keys') 
1931                  * or depend on time (old 'Absolute Shape Keys') 
1932                  */
1933                  
1934                 /* 1. test for relative (with keyframes) */
1935                 if (id_frame_has_keyframe((ID *)key, frame, filter))
1936                         return 1;
1937
1938                 /* 2. test for time */
1939                 /* TODO... yet to be implemented (this feature may evolve before then anyway) */
1940         }
1941
1942         /* try materials */
1943         if (!(filter & ANIMFILTER_KEYS_LOCAL) && !(filter & ANIMFILTER_KEYS_NOMAT) ) {
1944                 /* if only active, then we can skip a lot of looping */
1945                 if (filter & ANIMFILTER_KEYS_ACTIVE) {
1946                         Material *ma = give_current_material(ob, (ob->actcol + 1));
1947                         
1948                         /* we only retrieve the active material... */
1949                         if (id_frame_has_keyframe((ID *)ma, frame, filter))
1950                                 return 1;
1951                 }
1952                 else {
1953                         int a;
1954                         
1955                         /* loop over materials */
1956                         for (a = 0; a < ob->totcol; a++) {
1957                                 Material *ma = give_current_material(ob, a + 1);
1958                                 
1959                                 if (id_frame_has_keyframe((ID *)ma, frame, filter))
1960                                         return 1;
1961                         }
1962                 }
1963         }
1964         
1965         /* nothing found */
1966         return 0;
1967 }
1968
1969 /* --------------- API ------------------- */
1970
1971 /* Checks whether a keyframe exists for the given ID-block one the given frame */
1972 short id_frame_has_keyframe(ID *id, float frame, short filter)
1973 {
1974         /* sanity checks */
1975         if (id == NULL)
1976                 return 0;
1977         
1978         /* perform special checks for 'macro' types */
1979         switch (GS(id->name)) {
1980                 case ID_OB: /* object */
1981                         return object_frame_has_keyframe((Object *)id, frame, filter);
1982                         break;
1983                         
1984                 case ID_SCE: /* scene */
1985                 // XXX TODO... for now, just use 'normal' behavior
1986                 //      break;
1987                 
1988                 default:  /* 'normal type' */
1989                 {
1990                         AnimData *adt = BKE_animdata_from_id(id);
1991                         
1992                         /* only check keyframes in active action */
1993                         if (adt)
1994                                 return action_frame_has_keyframe(adt->action, frame, filter);
1995                 }
1996                 break;
1997         }
1998         
1999         
2000         /* no keyframe found */
2001         return 0;
2002 }
2003
2004 /* ************************************************** */
2005
2006 int ED_autokeyframe_object(bContext *C, Scene *scene, Object *ob, KeyingSet *ks)
2007 {
2008         /* auto keyframing */
2009         if (autokeyframe_cfra_can_key(scene, &ob->id)) {
2010                 ListBase dsources = {NULL, NULL};
2011
2012                 /* now insert the keyframe(s) using the Keying Set
2013                  *      1) add datasource override for the Object
2014                  *      2) insert keyframes
2015                  *      3) free the extra info
2016                  */
2017                 ANIM_relative_keyingset_add_source(&dsources, &ob->id, NULL, NULL);
2018                 ANIM_apply_keyingset(C, &dsources, NULL, ks, MODIFYKEY_MODE_INSERT, (float)CFRA);
2019                 BLI_freelistN(&dsources);
2020
2021                 return TRUE;
2022         }
2023         else {
2024                 return FALSE;
2025         }
2026 }
2027
2028 int ED_autokeyframe_pchan(bContext *C, Scene *scene, Object *ob, bPoseChannel *pchan, KeyingSet *ks)
2029 {
2030         if (autokeyframe_cfra_can_key(scene, &ob->id)) {
2031                 ListBase dsources = {NULL, NULL};
2032
2033                 /* now insert the keyframe(s) using the Keying Set
2034                  *      1) add datasource override for the PoseChannel
2035                  *      2) insert keyframes
2036                  *      3) free the extra info
2037                  */
2038                 ANIM_relative_keyingset_add_source(&dsources, &ob->id, &RNA_PoseBone, pchan);
2039                 ANIM_apply_keyingset(C, &dsources, NULL, ks, MODIFYKEY_MODE_INSERT, (float)CFRA);
2040                 BLI_freelistN(&dsources);
2041
2042                 /* clear any unkeyed tags */
2043                 if (pchan->bone) {
2044                         pchan->bone->flag &= ~BONE_UNKEYED;
2045                 }
2046
2047                 return TRUE;
2048         }
2049         else {
2050                 /* add unkeyed tags */
2051                 if (pchan->bone) {
2052                         pchan->bone->flag |= BONE_UNKEYED;
2053                 }
2054
2055                 return FALSE;
2056         }
2057 }