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