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