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