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