4595bf3f64fd0d0917e8462406eb7db769c9463f
[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 bewteen 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 exisiting 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 };
529
530 /* This helper function determines if visual-keyframing should be used when  
531  * inserting keyframes for the given channel. As visual-keyframing only works
532  * on Object and Pose-Channel blocks, this should only get called for those 
533  * blocktypes, when using "standard" keying but 'Visual Keying' option in Auto-Keying 
534  * settings is on.
535  */
536 static short visualkey_can_use (PointerRNA *ptr, PropertyRNA *prop)
537 {
538         bConstraint *con= NULL;
539         short searchtype= VISUALKEY_NONE;
540         short has_parent = FALSE;
541         const char *identifier= NULL;
542         
543         /* validate data */
544         // TODO: this check is probably not needed, but it won't hurt
545         if (ELEM3(NULL, ptr, ptr->data, prop))
546                 return 0;
547                 
548         /* get first constraint and determine type of keyframe constraints to check for 
549          *      - constraints can be on either Objects or PoseChannels, so we only check if the
550          *    ptr->type is RNA_Object or RNA_PoseBone, which are the RNA wrapping-info for
551          *    those structs, allowing us to identify the owner of the data
552          */
553         if (ptr->type == &RNA_Object) {
554                 /* Object */
555                 Object *ob= (Object *)ptr->data;
556                 
557                 con= ob->constraints.first;
558                 identifier= RNA_property_identifier(prop);
559                 has_parent= (ob->parent != NULL);
560         }
561         else if (ptr->type == &RNA_PoseBone) {
562                 /* Pose Channel */
563                 bPoseChannel *pchan= (bPoseChannel *)ptr->data;
564                 
565                 con= pchan->constraints.first;
566                 identifier= RNA_property_identifier(prop);
567                 has_parent= (pchan->parent != NULL);
568         }
569         
570         /* check if any data to search using */
571         if (ELEM(NULL, con, identifier) && (has_parent == FALSE))
572                 return 0;
573                 
574         /* location or rotation identifiers only... */
575         if(identifier == NULL) {
576                 printf("%s failed: NULL identifier\n", __func__);
577                 return 0;
578         }
579         else if (strstr(identifier, "location")) {
580                 searchtype= VISUALKEY_LOC;
581         }
582         else if (strstr(identifier, "rotation")) {
583                 searchtype= VISUALKEY_ROT;
584         }
585         else {
586                 printf("%s failed: identifier - '%s' \n", __func__, identifier);
587                 return 0;
588         }
589         
590         
591         /* only search if a searchtype and initial constraint are available */
592         if (searchtype) {
593                 /* parent is always matching */
594                 if (has_parent)
595                         return 1;
596                 
597                 /* constraints */
598                 for (; con; con= con->next) {
599                         /* only consider constraint if it is not disabled, and has influence */
600                         if (con->flag & CONSTRAINT_DISABLE) continue;
601                         if (con->enforce == 0.0f) continue;
602                         
603                         /* some constraints may alter these transforms */
604                         switch (con->type) {
605                                 /* multi-transform constraints */
606                                 case CONSTRAINT_TYPE_CHILDOF:
607                                         return 1;
608                                 case CONSTRAINT_TYPE_TRANSFORM:
609                                 case CONSTRAINT_TYPE_TRANSLIKE:
610                                         return 1;
611                                 case CONSTRAINT_TYPE_FOLLOWPATH:
612                                         return 1;
613                                 case CONSTRAINT_TYPE_KINEMATIC:
614                                         return 1;
615                                         
616                                 /* single-transform constraits  */
617                                 case CONSTRAINT_TYPE_TRACKTO:
618                                         if (searchtype==VISUALKEY_ROT) return 1;
619                                         break;
620                                 case CONSTRAINT_TYPE_ROTLIMIT:
621                                         if (searchtype==VISUALKEY_ROT) return 1;
622                                         break;
623                                 case CONSTRAINT_TYPE_LOCLIMIT:
624                                         if (searchtype==VISUALKEY_LOC) return 1;
625                                         break;
626                                 case CONSTRAINT_TYPE_ROTLIKE:
627                                         if (searchtype==VISUALKEY_ROT) return 1;
628                                         break;
629                                 case CONSTRAINT_TYPE_DISTLIMIT:
630                                         if (searchtype==VISUALKEY_LOC) return 1;
631                                         break;
632                                 case CONSTRAINT_TYPE_LOCLIKE:
633                                         if (searchtype==VISUALKEY_LOC) return 1;
634                                         break;
635                                 case CONSTRAINT_TYPE_LOCKTRACK:
636                                         if (searchtype==VISUALKEY_ROT) return 1;
637                                         break;
638                                 case CONSTRAINT_TYPE_MINMAX:
639                                         if (searchtype==VISUALKEY_LOC) return 1;
640                                         break;
641                                 
642                                 default:
643                                         break;
644                         }
645                 }
646         }
647         
648         /* when some condition is met, this function returns, so here it can be 0 */
649         return 0;
650 }
651
652 /* This helper function extracts the value to use for visual-keyframing 
653  * In the event that it is not possible to perform visual keying, try to fall-back
654  * to using the default method. Assumes that all data it has been passed is valid.
655  */
656 static float visualkey_get_value (PointerRNA *ptr, PropertyRNA *prop, int array_index)
657 {
658         char *identifier= (char *)RNA_property_identifier(prop);
659         
660         /* handle for Objects or PoseChannels only 
661          *      - constraints can be on either Objects or PoseChannels, so we only check if the
662          *        ptr->type is RNA_Object or RNA_PoseBone, which are the RNA wrapping-info for
663          *        those structs, allowing us to identify the owner of the data 
664          *      - assume that array_index will be sane
665          */
666         if (ptr->type == &RNA_Object) {
667                 Object *ob= (Object *)ptr->data;
668                 
669                 /* only Location or Rotation keyframes are supported now */
670                 if (strstr(identifier, "location")) {
671                         return ob->obmat[3][array_index];
672                 }
673                 else if (strstr(identifier, "rotation_euler")) {
674                         float eul[3];
675                         
676                         mat4_to_eulO(eul, ob->rotmode, ob->obmat);
677                         return eul[array_index];
678                 }
679                 else if (strstr(identifier, "rotation_quaternion")) {
680                         float trimat[3][3], quat[4];
681                         
682                         copy_m3_m4(trimat, ob->obmat);
683                         mat3_to_quat_is_ok(quat, trimat);
684                         
685                         return quat[array_index];
686                 }
687                 else if (strstr(identifier, "rotation_axis_angle")) {
688                         float axis[3], angle;
689                         
690                         mat4_to_axis_angle(axis, &angle, ob->obmat);
691                         
692                         /* w = 0, x,y,z = 1,2,3 */
693                         if (array_index == 0)
694                                 return angle;
695                         else
696                                 return axis[array_index - 1];
697                 }
698         }
699         else if (ptr->type == &RNA_PoseBone) {
700                 Object *ob = (Object *)ptr->id.data; /* we assume that this is always set, and is an object */
701                 bPoseChannel *pchan= (bPoseChannel *)ptr->data;
702                 float tmat[4][4];
703                 
704                 /* Although it is not strictly required for this particular space conversion, 
705                  * arg1 must not be null, as there is a null check for the other conversions to
706                  * be safe. Therefore, the active object is passed here, and in many cases, this
707                  * will be what owns the pose-channel that is getting this anyway.
708                  */
709                 copy_m4_m4(tmat, pchan->pose_mat);
710                 constraint_mat_convertspace(ob, pchan, tmat, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_LOCAL);
711                 
712                 /* Loc, Rot/Quat keyframes are supported... */
713                 if (strstr(identifier, "location")) {
714                         /* only use for non-connected bones */
715                         if ((pchan->bone->parent) && !(pchan->bone->flag & BONE_CONNECTED))
716                                 return tmat[3][array_index];
717                         else if (pchan->bone->parent == NULL)
718                                 return tmat[3][array_index];
719                 }
720                 else if (strstr(identifier, "rotation_euler")) {
721                         float eul[3];
722                         
723                         mat4_to_eulO(eul, pchan->rotmode, tmat);
724                         return eul[array_index];
725                 }
726                 else if (strstr(identifier, "rotation_quaternion")) {
727                         float trimat[3][3], quat[4];
728                         
729                         copy_m3_m4(trimat, tmat);
730                         mat3_to_quat_is_ok(quat, trimat);
731                         
732                         return quat[array_index];
733                 }
734                 else if (strstr(identifier, "rotation_axis_angle")) {
735                         float axis[3], angle;
736                         
737                         mat4_to_axis_angle(axis, &angle, tmat);
738                         
739                         /* w = 0, x,y,z = 1,2,3 */
740                         if (array_index == 0)
741                                 return angle;
742                         else
743                                 return axis[array_index - 1];
744                 }
745         }
746         
747         /* as the function hasn't returned yet, read value from system in the default way */
748         return setting_get_rna_value(ptr, prop, array_index);
749 }
750
751 /* ------------------------- Insert Key API ------------------------- */
752
753 /* Secondary Keyframing API call: 
754  *      Use this when validation of necessary animation data is not necessary, since an RNA-pointer to the necessary
755  *      data being keyframed, and a pointer to the F-Curve to use have both been provided.
756  *
757  *      The flag argument is used for special settings that alter the behaviour of
758  *      the keyframe insertion. These include the 'visual' keyframing modes, quick refresh,
759  *      and extra keyframe filtering.
760  */
761 short insert_keyframe_direct (ReportList *reports, PointerRNA ptr, PropertyRNA *prop, FCurve *fcu, float cfra, short flag)
762 {
763         float curval= 0.0f;
764         
765         /* no F-Curve to add keyframe to? */
766         if (fcu == NULL) {
767                 BKE_report(reports, RPT_ERROR, "No F-Curve to add keyframes to");
768                 return 0;
769         }
770         /* F-Curve not editable? */
771         if (fcurve_is_keyframable(fcu) == 0) {
772                 BKE_reportf(reports, RPT_ERROR, 
773                         "F-Curve with path = '%s' [%d] cannot be keyframed. Ensure that it is not locked or sampled. Also, try removing F-Modifiers",
774                         fcu->rna_path, fcu->array_index);
775                 return 0;
776         }
777         
778         /* if no property given yet, try to validate from F-Curve info */
779         if ((ptr.id.data == NULL) && (ptr.data==NULL)) {
780                 BKE_report(reports, RPT_ERROR, "No RNA-pointer available to retrieve values for keyframing from");
781                 return 0;
782         }
783         if (prop == NULL) {
784                 PointerRNA tmp_ptr;
785                 
786                 /* try to get property we should be affecting */
787                 if ((RNA_path_resolve(&ptr, fcu->rna_path, &tmp_ptr, &prop) == 0) || (prop == NULL)) {
788                         /* property not found... */
789                         const char *idname= (ptr.id.data) ? ((ID *)ptr.id.data)->name : "<No ID-Pointer>";
790                         
791                         BKE_reportf(reports, RPT_ERROR,
792                                 "Could not insert keyframe, as RNA Path is invalid for the given ID (ID = %s, Path = %s)", 
793                                 idname, fcu->rna_path);
794                         return 0;
795                 }
796                 else {
797                         /* property found, so overwrite 'ptr' to make later code easier */
798                         ptr= tmp_ptr;
799                 }
800         }
801         
802         /* set additional flags for the F-Curve (i.e. only integer values) */
803         fcu->flag &= ~(FCURVE_INT_VALUES|FCURVE_DISCRETE_VALUES);
804         switch (RNA_property_type(prop)) {
805                 case PROP_FLOAT:
806                         /* do nothing */
807                         break;
808                 case PROP_INT:
809                         /* do integer (only 'whole' numbers) interpolation between all points */
810                         fcu->flag |= FCURVE_INT_VALUES;
811                         break;
812                 default:
813                         /* do 'discrete' (i.e. enum, boolean values which cannot take any intermediate
814                          * values at all) interpolation between all points
815                          *      - however, we must also ensure that evaluated values are only integers still
816                          */
817                         fcu->flag |= (FCURVE_DISCRETE_VALUES|FCURVE_INT_VALUES);
818                         break;
819         }
820         
821         /* obtain value to give keyframe */
822         if ( (flag & INSERTKEY_MATRIX) && 
823                  (visualkey_can_use(&ptr, prop)) ) 
824         {
825                 /* visual-keying is only available for object and pchan datablocks, as 
826                  * it works by keyframing using a value extracted from the final matrix 
827                  * instead of using the kt system to extract a value.
828                  */
829                 curval= visualkey_get_value(&ptr, prop, fcu->array_index);
830         }
831         else {
832                 /* read value from system */
833                 curval= setting_get_rna_value(&ptr, prop, fcu->array_index);
834         }
835         
836         /* only insert keyframes where they are needed */
837         if (flag & INSERTKEY_NEEDED) {
838                 short insert_mode;
839                 
840                 /* check whether this curve really needs a new keyframe */
841                 insert_mode= new_key_needed(fcu, cfra, curval);
842                 
843                 /* insert new keyframe at current frame */
844                 if (insert_mode)
845                         insert_vert_fcurve(fcu, cfra, curval, flag);
846                 
847                 /* delete keyframe immediately before/after newly added */
848                 switch (insert_mode) {
849                         case KEYNEEDED_DELPREV:
850                                 delete_fcurve_key(fcu, fcu->totvert-2, 1);
851                                 break;
852                         case KEYNEEDED_DELNEXT:
853                                 delete_fcurve_key(fcu, 1, 1);
854                                 break;
855                 }
856                 
857                 /* only return success if keyframe added */
858                 if (insert_mode)
859                         return 1;
860         }
861         else {
862                 /* just insert keyframe */
863                 insert_vert_fcurve(fcu, cfra, curval, flag);
864                 
865                 /* return success */
866                 return 1;
867         }
868         
869         /* failed */
870         return 0;
871 }
872
873 /* Main Keyframing API call:
874  *      Use this when validation of necessary animation data is necessary, since it may not exist yet.
875  *      
876  *      The flag argument is used for special settings that alter the behaviour of
877  *      the keyframe insertion. These include the 'visual' keyframing modes, quick refresh,
878  *      and extra keyframe filtering.
879  *
880  *      index of -1 keys all array indices
881  */
882 short insert_keyframe (ReportList *reports, ID *id, bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag)
883 {       
884         PointerRNA id_ptr, ptr;
885         PropertyRNA *prop = NULL;
886         FCurve *fcu;
887         int array_index_max= array_index+1;
888         int ret= 0;
889         
890         /* validate pointer first - exit if failure */
891         if (id == NULL) {
892                 BKE_reportf(reports, RPT_ERROR, "No ID-block to insert keyframe in (Path = %s)", rna_path);
893                 return 0;
894         }
895         
896         RNA_id_pointer_create(id, &id_ptr);
897         if ((RNA_path_resolve(&id_ptr, rna_path, &ptr, &prop) == 0) || (prop == NULL)) {
898                 BKE_reportf(reports, RPT_ERROR,
899                         "Could not insert keyframe, as RNA Path is invalid for the given ID (ID = %s, Path = %s)", 
900                         (id)? id->name : "<Missing ID-Block>", rna_path);
901                 return 0;
902         }
903         
904         /* if no action is provided, keyframe to the default one attached to this ID-block */
905         if (act == NULL) {
906                 AnimData *adt= BKE_animdata_from_id(id);
907                 
908                 /* get action to add F-Curve+keyframe to */
909                 act= verify_adt_action(id, 1);
910                 
911                 if (act == NULL) {
912                         BKE_reportf(reports, RPT_ERROR, 
913                                 "Could not insert keyframe, as this type does not support animation data (ID = %s, Path = %s)", 
914                                 id->name, rna_path);
915                         return 0;
916                 }
917                 
918                 /* apply NLA-mapping to frame to use (if applicable) */
919                 cfra= BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
920         }
921         
922         /* key entire array convenience method */
923         if (array_index == -1) { 
924                 array_index= 0;
925                 array_index_max= RNA_property_array_length(&ptr, prop);
926                 
927                 /* for single properties, increase max_index so that the property itself gets included,
928                  * but don't do this for standard arrays since that can cause corruption issues 
929                  * (extra unused curves)
930                  */
931                 if (array_index_max == array_index)
932                         array_index_max++;
933         }
934         
935         /* will only loop once unless the array index was -1 */
936         for (; array_index < array_index_max; array_index++) {
937                 /* make sure the F-Curve exists 
938                  *      - if we're replacing keyframes only, DO NOT create new F-Curves if they do not exist yet
939                  *        but still try to get the F-Curve if it exists...
940                  */
941                 fcu= verify_fcurve(act, group, rna_path, array_index, (flag & INSERTKEY_REPLACE)==0);
942                 
943                 /* we may not have a F-Curve when we're replacing only... */
944                 if (fcu) {
945                         /* set color mode if the F-Curve is new (i.e. without any keyframes) */
946                         if ((fcu->totvert == 0) && (flag & INSERTKEY_XYZ2RGB)) {
947                                 /* for Loc/Rot/Scale and also Color F-Curves, the color of the F-Curve in the Graph Editor,
948                                  * is determined by the array index for the F-Curve
949                                  */
950                                 if (ELEM5(RNA_property_subtype(prop), PROP_TRANSLATION, PROP_XYZ, PROP_EULER, PROP_COLOR, PROP_COORDS)) {
951                                         fcu->color_mode= FCURVE_COLOR_AUTO_RGB;
952                                 }
953                         }
954                         
955                         /* insert keyframe */
956                         ret += insert_keyframe_direct(reports, ptr, prop, fcu, cfra, flag);
957                 }
958         }
959         
960         return ret;
961 }
962
963 /* ************************************************** */
964 /* KEYFRAME DELETION */
965
966 /* Main Keyframing API call:
967  *      Use this when validation of necessary animation data isn't necessary as it
968  *      already exists. It will delete a keyframe at the current frame.
969  *      
970  *      The flag argument is used for special settings that alter the behaviour of
971  *      the keyframe deletion. These include the quick refresh options.
972  */
973 short delete_keyframe (ReportList *reports, ID *id, bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short UNUSED(flag))
974 {
975         AnimData *adt= BKE_animdata_from_id(id);
976         PointerRNA id_ptr, ptr;
977         PropertyRNA *prop;
978         int array_index_max= array_index+1;
979         int ret= 0;
980         
981         /* sanity checks */
982         if ELEM(NULL, id, adt) {
983                 BKE_report(reports, RPT_ERROR, "No ID-Block and/Or AnimData to delete keyframe from");
984                 return 0;
985         }
986         
987         /* validate pointer first - exit if failure */
988         RNA_id_pointer_create(id, &id_ptr);
989         if ((RNA_path_resolve(&id_ptr, rna_path, &ptr, &prop) == 0) || (prop == NULL)) {
990                 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);
991                 return 0;
992         }
993         
994         /* get F-Curve
995          * Note: here is one of the places where we don't want new Action + F-Curve added!
996          *              so 'add' var must be 0
997          */
998         if (act == NULL) {
999                 /* if no action is provided, use the default one attached to this ID-block 
1000                  *      - if it doesn't exist, then we're out of options...
1001                  */
1002                 if (adt->action) {
1003                         act= adt->action;
1004                         
1005                         /* apply NLA-mapping to frame to use (if applicable) */
1006                         cfra= BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP); 
1007                 }
1008                 else {
1009                         BKE_reportf(reports, RPT_ERROR, "No Action to delete keyframes from for ID = %s \n", id->name);
1010                         return 0;
1011                 }
1012         }
1013         
1014         /* key entire array convenience method */
1015         if (array_index == -1) { 
1016                 array_index= 0;
1017                 array_index_max= RNA_property_array_length(&ptr, prop);
1018                 
1019                 /* for single properties, increase max_index so that the property itself gets included,
1020                  * but don't do this for standard arrays since that can cause corruption issues 
1021                  * (extra unused curves)
1022                  */
1023                 if (array_index_max == array_index)
1024                         array_index_max++;
1025         }
1026         
1027         /* will only loop once unless the array index was -1 */
1028         for (; array_index < array_index_max; array_index++) {
1029                 FCurve *fcu= verify_fcurve(act, group, rna_path, array_index, 0);
1030                 short found = -1;
1031                 int i;
1032                 
1033                 /* check if F-Curve exists and/or whether it can be edited */
1034                 if (fcu == NULL)
1035                         continue;
1036                         
1037                 if ( (fcu->flag & FCURVE_PROTECTED) || ((fcu->grp) && (fcu->grp->flag & AGRP_PROTECTED)) ) {
1038                         if (G.f & G_DEBUG)
1039                                 printf("WARNING: not deleting keyframe for locked F-Curve \n");
1040                         continue;
1041                 }
1042                 
1043                 /* try to find index of beztriple to get rid of */
1044                 i = binarysearch_bezt_index(fcu->bezt, cfra, fcu->totvert, &found);
1045                 if (found) {                    
1046                         /* delete the key at the index (will sanity check + do recalc afterwards) */
1047                         delete_fcurve_key(fcu, i, 1);
1048                         
1049                         /* Only delete curve too if it won't be doing anything anymore */
1050                         if ((fcu->totvert == 0) && (list_has_suitable_fmodifier(&fcu->modifiers, 0, FMI_TYPE_GENERATE_CURVE) == 0))
1051                                 ANIM_fcurve_delete_from_animdata(NULL, adt, fcu);
1052                         
1053                         /* return success */
1054                         ret++;
1055                 }
1056         }
1057         
1058         /* return success/failure */
1059         return ret;
1060 }
1061
1062 /* ******************************************* */
1063 /* KEYFRAME MODIFICATION */
1064
1065 /* mode for commonkey_modifykey */
1066 enum {
1067         COMMONKEY_MODE_INSERT = 0,
1068         COMMONKEY_MODE_DELETE,
1069 } /*eCommonModifyKey_Modes*/;
1070
1071 /* Polling callback for use with ANIM_*_keyframe() operators
1072  * This is based on the standard ED_operator_areaactive callback,
1073  * except that it does special checks for a few spacetypes too...
1074  */
1075 static int modify_key_op_poll(bContext *C)
1076 {
1077         ScrArea *sa= CTX_wm_area(C);
1078         Scene *scene= CTX_data_scene(C);
1079         SpaceOops *so= CTX_wm_space_outliner(C);
1080         
1081         /* if no area or active scene */
1082         if (ELEM(NULL, sa, scene)) 
1083                 return 0;
1084         
1085         /* if Outliner, don't allow in some views */
1086         if (so) {
1087                 if (ELEM4(so->outlinevis, SO_GROUPS, SO_LIBRARIES, SO_VERSE_SESSION, SO_VERSE_SESSION))
1088                         return 0;
1089                 if (ELEM3(so->outlinevis, SO_SEQUENCE, SO_USERDEF, SO_KEYMAP))
1090                         return 0;
1091         }
1092         
1093         /* TODO: checks for other space types can be added here */
1094         
1095         /* should be fine */
1096         return 1;
1097 }
1098
1099 /* Insert Key Operator ------------------------ */
1100
1101 static int insert_key_exec (bContext *C, wmOperator *op)
1102 {
1103         Main *bmain= CTX_data_main(C);
1104         Scene *scene= CTX_data_scene(C);
1105         KeyingSet *ks= NULL;
1106         int type= RNA_enum_get(op->ptr, "type");
1107         float cfra= (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1108         short success;
1109         
1110         /* type is the Keying Set the user specified to use when calling the operator:
1111          *      - type == 0: use scene's active Keying Set
1112          *      - type > 0: use a user-defined Keying Set from the active scene
1113          *      - type < 0: use a builtin Keying Set
1114          */
1115         if (type == 0) 
1116                 type= scene->active_keyingset;
1117         if (type > 0)
1118                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
1119         else
1120                 ks= BLI_findlink(&builtin_keyingsets, -type-1);
1121                 
1122         /* report failures */
1123         if (ks == NULL) {
1124                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set");
1125                 return OPERATOR_CANCELLED;
1126         }
1127         
1128         /* try to insert keyframes for the channels specified by KeyingSet */
1129         success= ANIM_apply_keyingset(C, NULL, NULL, ks, MODIFYKEY_MODE_INSERT, cfra);
1130         if (G.f & G_DEBUG)
1131                 BKE_reportf(op->reports, RPT_INFO, "KeyingSet '%s' - Successfully added %d Keyframes \n", ks->name, success);
1132         
1133         /* report failure or do updates? */
1134         if (success == MODIFYKEY_INVALID_CONTEXT) {
1135                 BKE_report(op->reports, RPT_ERROR, "No suitable context info for active Keying Set");
1136                 return OPERATOR_CANCELLED;
1137         }
1138         else if (success) {
1139                 /* if the appropriate properties have been set, make a note that we've inserted something */
1140                 if (RNA_boolean_get(op->ptr, "confirm_success"))
1141                         BKE_reportf(op->reports, RPT_INFO, "Successfully added %d Keyframes for KeyingSet '%s'", success, ks->name);
1142                 
1143                 /* send notifiers that keyframes have been changed */
1144                 WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_EDITED, NULL);
1145         }
1146         else
1147                 BKE_report(op->reports, RPT_WARNING, "Keying Set failed to insert any keyframes");
1148         
1149         /* send updates */
1150         DAG_ids_flush_update(bmain, 0);
1151         
1152         return OPERATOR_FINISHED;
1153 }
1154
1155 void ANIM_OT_keyframe_insert (wmOperatorType *ot)
1156 {
1157         PropertyRNA *prop;
1158         
1159         /* identifiers */
1160         ot->name= "Insert Keyframe";
1161         ot->idname= "ANIM_OT_keyframe_insert";
1162         ot->description= "Insert keyframes on the current frame for all properties in the specified Keying Set";
1163         
1164         /* callbacks */
1165         ot->exec= insert_key_exec; 
1166         ot->poll= modify_key_op_poll;
1167         
1168         /* flags */
1169         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1170         
1171         /* keyingset to use (dynamic enum) */
1172         prop= RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1173         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1174         RNA_def_property_flag(prop, PROP_HIDDEN);
1175         ot->prop= prop;
1176         
1177         /* confirm whether a keyframe was added by showing a popup 
1178          *      - by default, this is enabled, since this operator is assumed to be called independently
1179          */
1180         prop= RNA_def_boolean(ot->srna, "confirm_success", 1, "Confirm Successful Insert", "Show a popup when the keyframes get successfully added");
1181         RNA_def_property_flag(prop, PROP_HIDDEN);
1182 }
1183
1184 /* Insert Key Operator (With Menu) ------------------------ */
1185 /* This operator checks if a menu should be shown for choosing the KeyingSet to use, 
1186  * then calls the menu if necessary before 
1187  */
1188
1189 static int insert_key_menu_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED(event))
1190 {
1191         Scene *scene= CTX_data_scene(C);
1192         
1193         /* if prompting or no active Keying Set, show the menu */
1194         if ((scene->active_keyingset == 0) || RNA_boolean_get(op->ptr, "always_prompt")) {
1195                 /* call the menu, which will call this operator again, hence the cancelled */
1196                 ANIM_keying_sets_menu_setup(C, op->type->name, "ANIM_OT_keyframe_insert_menu");
1197                 return OPERATOR_CANCELLED;
1198         }
1199         else {
1200                 /* just call the exec() on the active keyingset */
1201                 RNA_enum_set(op->ptr, "type", 0);
1202                 RNA_boolean_set(op->ptr, "confirm_success", 1);
1203                 
1204                 return op->type->exec(C, op);
1205         }
1206 }
1207  
1208 void ANIM_OT_keyframe_insert_menu (wmOperatorType *ot)
1209 {
1210         PropertyRNA *prop;
1211         
1212         /* identifiers */
1213         ot->name= "Insert Keyframe Menu";
1214         ot->idname= "ANIM_OT_keyframe_insert_menu";
1215         ot->description= "Insert Keyframes for specified Keying Set, with menu of available Keying Sets if undefined";
1216         
1217         /* callbacks */
1218         ot->invoke= insert_key_menu_invoke;
1219         ot->exec= insert_key_exec; 
1220         ot->poll= ED_operator_areaactive;
1221         
1222         /* flags */
1223         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1224         
1225         /* keyingset to use (dynamic enum) */
1226         prop= RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1227         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1228         RNA_def_property_flag(prop, PROP_HIDDEN);
1229         ot->prop= prop;
1230         
1231         /* confirm whether a keyframe was added by showing a popup 
1232          *      - by default, this is disabled so that if a menu is shown, this doesn't come up too
1233          */
1234         // XXX should this just be always on?
1235         prop= RNA_def_boolean(ot->srna, "confirm_success", 0, "Confirm Successful Insert", "Show a popup when the keyframes get successfully added");
1236         RNA_def_property_flag(prop, PROP_HIDDEN);
1237         
1238         /* whether the menu should always be shown 
1239          *      - by default, the menu should only be shown when there is no active Keying Set (2.5 behaviour),
1240          *        although in some cases it might be useful to always shown (pre 2.5 behaviour)
1241          */
1242         prop= RNA_def_boolean(ot->srna, "always_prompt", 0, "Always Show Menu", "");
1243         RNA_def_property_flag(prop, PROP_HIDDEN);
1244 }
1245
1246 /* Delete Key Operator ------------------------ */
1247
1248 static int delete_key_exec (bContext *C, wmOperator *op)
1249 {
1250         Main *bmain= CTX_data_main(C);
1251         Scene *scene= CTX_data_scene(C);
1252         KeyingSet *ks= NULL;    
1253         int type= RNA_enum_get(op->ptr, "type");
1254         float cfra= (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1255         short success;
1256         
1257         /* type is the Keying Set the user specified to use when calling the operator:
1258          *      - type == 0: use scene's active Keying Set
1259          *      - type > 0: use a user-defined Keying Set from the active scene
1260          *      - type < 0: use a builtin Keying Set
1261          */
1262         if (type == 0) 
1263                 type= scene->active_keyingset;
1264         if (type > 0)
1265                 ks= BLI_findlink(&scene->keyingsets, scene->active_keyingset-1);
1266         else
1267                 ks= BLI_findlink(&builtin_keyingsets, -type-1);
1268         
1269         /* report failure */
1270         if (ks == NULL) {
1271                 BKE_report(op->reports, RPT_ERROR, "No active Keying Set");
1272                 return OPERATOR_CANCELLED;
1273         }
1274         
1275         /* try to insert keyframes for the channels specified by KeyingSet */
1276         success= ANIM_apply_keyingset(C, NULL, NULL, ks, MODIFYKEY_MODE_DELETE, cfra);
1277         if (G.f & G_DEBUG)
1278                 printf("KeyingSet '%s' - Successfully removed %d Keyframes \n", ks->name, success);
1279         
1280         /* report failure or do updates? */
1281         if (success == MODIFYKEY_INVALID_CONTEXT) {
1282                 BKE_report(op->reports, RPT_ERROR, "No suitable context info for active Keying Set");
1283                 return OPERATOR_CANCELLED;
1284         }
1285         else if (success) {
1286                 /* if the appropriate properties have been set, make a note that we've inserted something */
1287                 if (RNA_boolean_get(op->ptr, "confirm_success"))
1288                         BKE_reportf(op->reports, RPT_INFO, "Successfully removed %d Keyframes for KeyingSet '%s'", success, ks->name);
1289                 
1290                 /* send notifiers that keyframes have been changed */
1291                 WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_EDITED, NULL);
1292         }
1293         else
1294                 BKE_report(op->reports, RPT_WARNING, "Keying Set failed to remove any keyframes");
1295         
1296         /* send updates */
1297         DAG_ids_flush_update(bmain, 0);
1298         
1299         return OPERATOR_FINISHED;
1300 }
1301
1302 void ANIM_OT_keyframe_delete (wmOperatorType *ot)
1303 {
1304         PropertyRNA *prop;
1305         
1306         /* identifiers */
1307         ot->name= "Delete Keying-Set Keyframe";
1308         ot->idname= "ANIM_OT_keyframe_delete";
1309         ot->description= "Delete keyframes on the current frame for all properties in the specified Keying Set";
1310         
1311         /* callbacks */
1312         ot->exec= delete_key_exec; 
1313         ot->poll= modify_key_op_poll;
1314         
1315         /* flags */
1316         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1317         
1318         /* keyingset to use (dynamic enum) */
1319         prop= RNA_def_enum(ot->srna, "type", DummyRNA_DEFAULT_items, 0, "Keying Set", "The Keying Set to use");
1320         RNA_def_enum_funcs(prop, ANIM_keying_sets_enum_itemf);
1321         RNA_def_property_flag(prop, PROP_HIDDEN);
1322         ot->prop= prop;
1323         
1324         /* confirm whether a keyframe was added by showing a popup 
1325          *      - by default, this is enabled, since this operator is assumed to be called independently
1326          */
1327         RNA_def_boolean(ot->srna, "confirm_success", 1, "Confirm Successful Insert", "Show a popup when the keyframes get successfully added");
1328 }
1329
1330 /* Delete Key Operator ------------------------ */
1331
1332 /* XXX WARNING:
1333  * This is currently just a basic operator, which work in 3d-view context on objects only. 
1334  * Should this be kept? It does have advantages over a version which requires selecting a keyingset to use...
1335  * -- Joshua Leung, Jan 2009
1336  */
1337  
1338 static int delete_key_v3d_exec (bContext *C, wmOperator *op)
1339 {
1340         Main *bmain= CTX_data_main(C);
1341         Scene *scene= CTX_data_scene(C);
1342         float cfra= (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1343         
1344         // XXX more comprehensive tests will be needed
1345         CTX_DATA_BEGIN(C, Object*, ob, selected_objects) 
1346         {
1347                 ID *id= (ID *)ob;
1348                 FCurve *fcu, *fcn;
1349                 short success= 0;
1350                 
1351                 /* loop through all curves in animdata and delete keys on this frame */
1352                 if ((ob->adt) && (ob->adt->action)) {
1353                         AnimData *adt= ob->adt;
1354                         bAction *act= adt->action;
1355                         
1356                         for (fcu= act->curves.first; fcu; fcu= fcn) {
1357                                 fcn= fcu->next;
1358                                 success+= delete_keyframe(op->reports, id, NULL, NULL, fcu->rna_path, fcu->array_index, cfra, 0);
1359                         }
1360                 }
1361                 
1362                 BKE_reportf(op->reports, RPT_INFO, "Ob '%s' - Successfully had %d keyframes removed", id->name+2, success);
1363                 
1364                 ob->recalc |= OB_RECALC_OB;
1365         }
1366         CTX_DATA_END;
1367         
1368         /* send updates */
1369         DAG_ids_flush_update(bmain, 0);
1370         
1371         WM_event_add_notifier(C, NC_OBJECT|ND_KEYS, NULL);
1372         
1373         return OPERATOR_FINISHED;
1374 }
1375
1376 void ANIM_OT_keyframe_delete_v3d (wmOperatorType *ot)
1377 {
1378         /* identifiers */
1379         ot->name= "Delete Keyframe";
1380         ot->description= "Remove keyframes on current frame for selected object";
1381         ot->idname= "ANIM_OT_keyframe_delete_v3d";
1382         
1383         /* callbacks */
1384         ot->invoke= WM_operator_confirm;
1385         ot->exec= delete_key_v3d_exec; 
1386         
1387         ot->poll= ED_operator_areaactive;
1388         
1389         /* flags */
1390         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1391 }
1392
1393
1394 /* Insert Key Button Operator ------------------------ */
1395
1396 static int insert_key_button_exec (bContext *C, wmOperator *op)
1397 {
1398         Main *bmain= CTX_data_main(C);
1399         Scene *scene= CTX_data_scene(C);
1400         PointerRNA ptr= {{NULL}};
1401         PropertyRNA *prop= NULL;
1402         char *path;
1403         float cfra= (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1404         short success= 0;
1405         int a, index, length, all= RNA_boolean_get(op->ptr, "all");
1406         short flag = 0;
1407         
1408         /* flags for inserting keyframes */
1409         flag = ANIM_get_keyframing_flags(scene, 1);
1410         
1411         /* try to insert keyframe using property retrieved from UI */
1412         uiContextActiveProperty(C, &ptr, &prop, &index);
1413         
1414         if ((ptr.id.data && ptr.data && prop) && RNA_property_animateable(&ptr, prop)) {
1415                 path= RNA_path_from_ID_to_property(&ptr, prop);
1416                 
1417                 if (path) {
1418                         if (all) {
1419                                 length= RNA_property_array_length(&ptr, prop);
1420                                 
1421                                 if(length) index= 0;
1422                                 else length= 1;
1423                         }
1424                         else
1425                                 length= 1;
1426                         
1427                         for (a=0; a<length; a++)
1428                                 success+= insert_keyframe(op->reports, ptr.id.data, NULL, NULL, path, index+a, cfra, flag);
1429                         
1430                         MEM_freeN(path);
1431                 }
1432                 else if (ptr.type == &RNA_NlaStrip) {
1433                         /* handle special vars for NLA-strips */
1434                         NlaStrip *strip= (NlaStrip *)ptr.data;
1435                         FCurve *fcu= list_find_fcurve(&strip->fcurves, RNA_property_identifier(prop), flag);
1436                         
1437                         success+= insert_keyframe_direct(op->reports, ptr, prop, fcu, cfra, 0);
1438                 }
1439                 else {
1440                         if (G.f & G_DEBUG)
1441                                 printf("Button Insert-Key: no path to property \n");
1442                         BKE_report(op->reports, RPT_WARNING, "Failed to resolve path to property. Try using a Keying Set instead");
1443                 }
1444         }
1445         else if (G.f & G_DEBUG) {
1446                 printf("ptr.data = %p, prop = %p,", (void *)ptr.data, (void *)prop);
1447                 if (prop)
1448                         printf("animateable = %d \n", RNA_property_animateable(&ptr, prop));
1449                 else
1450                         printf("animateable = NULL \n");
1451         }
1452         
1453         if (success) {
1454                 /* send updates */
1455                 uiContextAnimUpdate(C);
1456                 
1457                 DAG_ids_flush_update(bmain, 0);
1458                 
1459                 /* send notifiers that keyframes have been changed */
1460                 WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_EDITED, NULL);
1461         }
1462         
1463         return (success)? OPERATOR_FINISHED: OPERATOR_CANCELLED;
1464 }
1465
1466 void ANIM_OT_keyframe_insert_button (wmOperatorType *ot)
1467 {
1468         /* identifiers */
1469         ot->name= "Insert Keyframe (Buttons)";
1470         ot->idname= "ANIM_OT_keyframe_insert_button";
1471         
1472         /* callbacks */
1473         ot->exec= insert_key_button_exec; 
1474         ot->poll= modify_key_op_poll;
1475         
1476         /* flags */
1477         ot->flag= OPTYPE_UNDO;
1478
1479         /* properties */
1480         RNA_def_boolean(ot->srna, "all", 1, "All", "Insert a keyframe for all element of the array");
1481 }
1482
1483 /* Delete Key Button Operator ------------------------ */
1484
1485 static int delete_key_button_exec (bContext *C, wmOperator *op)
1486 {
1487         Main *bmain= CTX_data_main(C);
1488         Scene *scene= CTX_data_scene(C);
1489         PointerRNA ptr= {{NULL}};
1490         PropertyRNA *prop= NULL;
1491         char *path;
1492         float cfra= (float)CFRA; // XXX for now, don't bother about all the yucky offset crap
1493         short success= 0;
1494         int a, index, length, all= RNA_boolean_get(op->ptr, "all");
1495         
1496         /* try to insert keyframe using property retrieved from UI */
1497         uiContextActiveProperty(C, &ptr, &prop, &index);
1498
1499         if (ptr.id.data && ptr.data && prop) {
1500                 path= RNA_path_from_ID_to_property(&ptr, prop);
1501                 
1502                 if (path) {
1503                         if (all) {
1504                                 length= RNA_property_array_length(&ptr, prop);
1505                                 
1506                                 if (length) index= 0;
1507                                 else length= 1;
1508                         }
1509                         else
1510                                 length= 1;
1511                         
1512                         for (a=0; a<length; a++)
1513                                 success+= delete_keyframe(op->reports, ptr.id.data, NULL, NULL, path, index+a, cfra, 0);
1514                         
1515                         MEM_freeN(path);
1516                 }
1517                 else if (G.f & G_DEBUG)
1518                         printf("Button Delete-Key: no path to property \n");
1519         }
1520         else if (G.f & G_DEBUG) {
1521                 printf("ptr.data = %p, prop = %p \n", (void *)ptr.data, (void *)prop);
1522         }
1523         
1524         
1525         if (success) {
1526                 /* send updates */
1527                 uiContextAnimUpdate(C);
1528                 
1529                 DAG_ids_flush_update(bmain, 0);
1530                 
1531                 /* send notifiers that keyframes have been changed */
1532                 WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_EDITED, NULL);
1533         }
1534         
1535         return (success)? OPERATOR_FINISHED: OPERATOR_CANCELLED;
1536 }
1537
1538 void ANIM_OT_keyframe_delete_button (wmOperatorType *ot)
1539 {
1540         /* identifiers */
1541         ot->name= "Delete Keyframe (Buttons)";
1542         ot->idname= "ANIM_OT_keyframe_delete_button";
1543         
1544         /* callbacks */
1545         ot->exec= delete_key_button_exec; 
1546         ot->poll= modify_key_op_poll;
1547         
1548         /* flags */
1549         ot->flag= OPTYPE_UNDO;
1550
1551         /* properties */
1552         RNA_def_boolean(ot->srna, "all", 1, "All", "Delete keyfames from all elements of the array");
1553 }
1554
1555 /* ******************************************* */
1556 /* AUTO KEYFRAME */
1557
1558 int autokeyframe_cfra_can_key(Scene *scene, ID *id)
1559 {
1560         float cfra= (float)CFRA; // XXX for now, this will do
1561         
1562         /* only filter if auto-key mode requires this */
1563         if (IS_AUTOKEY_ON(scene) == 0)
1564                 return 0;
1565                 
1566         if (IS_AUTOKEY_MODE(scene, NORMAL)) {
1567                 /* can insert anytime we like... */
1568                 return 1;
1569         }
1570         else /* REPLACE */ {
1571                 /* for whole block - only key if there's a keyframe on that frame already
1572                  *      this is a valid assumption when we're blocking + tweaking
1573                  */
1574                 return id_frame_has_keyframe(id, cfra, ANIMFILTER_KEYS_LOCAL);
1575         }
1576 }
1577
1578 /* ******************************************* */
1579 /* KEYFRAME DETECTION */
1580
1581 /* --------------- API/Per-Datablock Handling ------------------- */
1582
1583 /* Checks if some F-Curve has a keyframe for a given frame */
1584 short fcurve_frame_has_keyframe (FCurve *fcu, float frame, short filter)
1585 {
1586         /* quick sanity check */
1587         if (ELEM(NULL, fcu, fcu->bezt))
1588                 return 0;
1589         
1590         /* we either include all regardless of muting, or only non-muted  */
1591         if ((filter & ANIMFILTER_KEYS_MUTED) || (fcu->flag & FCURVE_MUTED)==0) {
1592                 short replace = -1;
1593                 int i = binarysearch_bezt_index(fcu->bezt, frame, fcu->totvert, &replace);
1594                 
1595                 /* binarysearch_bezt_index will set replace to be 0 or 1
1596                  *      - obviously, 1 represents a match
1597                  */
1598                 if (replace) {                  
1599                         /* sanity check: 'i' may in rare cases exceed arraylen */
1600                         if ((i >= 0) && (i < fcu->totvert))
1601                                 return 1;
1602                 }
1603         }
1604         
1605         return 0;
1606 }
1607
1608 /* Checks whether an Action has a keyframe for a given frame 
1609  * Since we're only concerned whether a keyframe exists, we can simply loop until a match is found...
1610  */
1611 static short action_frame_has_keyframe (bAction *act, float frame, short filter)
1612 {
1613         FCurve *fcu;
1614         
1615         /* can only find if there is data */
1616         if (act == NULL)
1617                 return 0;
1618                 
1619         /* if only check non-muted, check if muted */
1620         if ((filter & ANIMFILTER_KEYS_MUTED) || (act->flag & ACT_MUTED))
1621                 return 0;
1622         
1623         /* loop over F-Curves, using binary-search to try to find matches 
1624          *      - this assumes that keyframes are only beztriples
1625          */
1626         for (fcu= act->curves.first; fcu; fcu= fcu->next) {
1627                 /* only check if there are keyframes (currently only of type BezTriple) */
1628                 if (fcu->bezt && fcu->totvert) {
1629                         if (fcurve_frame_has_keyframe(fcu, frame, filter))
1630                                 return 1;
1631                 }
1632         }
1633         
1634         /* nothing found */
1635         return 0;
1636 }
1637
1638 /* Checks whether an Object has a keyframe for a given frame */
1639 static short object_frame_has_keyframe (Object *ob, float frame, short filter)
1640 {
1641         /* error checking */
1642         if (ob == NULL)
1643                 return 0;
1644         
1645         /* check own animation data - specifically, the action it contains */
1646         if ((ob->adt) && (ob->adt->action)) {
1647                 if (action_frame_has_keyframe(ob->adt->action, frame, filter))
1648                         return 1;
1649         }
1650         
1651         /* try shapekey keyframes (if available, and allowed by filter) */
1652         if ( !(filter & ANIMFILTER_KEYS_LOCAL) && !(filter & ANIMFILTER_KEYS_NOSKEY) ) {
1653                 Key *key= ob_get_key(ob);
1654                 
1655                 /* shapekeys can have keyframes ('Relative Shape Keys') 
1656                  * or depend on time (old 'Absolute Shape Keys') 
1657                  */
1658                  
1659                         /* 1. test for relative (with keyframes) */
1660                 if (id_frame_has_keyframe((ID *)key, frame, filter))
1661                         return 1;
1662                         
1663                         /* 2. test for time */
1664                 // TODO... yet to be implemented (this feature may evolve before then anyway)
1665         }
1666         
1667         /* try materials */
1668         if ( !(filter & ANIMFILTER_KEYS_LOCAL) && !(filter & ANIMFILTER_KEYS_NOMAT) ) {
1669                 /* if only active, then we can skip a lot of looping */
1670                 if (filter & ANIMFILTER_KEYS_ACTIVE) {
1671                         Material *ma= give_current_material(ob, (ob->actcol + 1));
1672                         
1673                         /* we only retrieve the active material... */
1674                         if (id_frame_has_keyframe((ID *)ma, frame, filter))
1675                                 return 1;
1676                 }
1677                 else {
1678                         int a;
1679                         
1680                         /* loop over materials */
1681                         for (a=0; a<ob->totcol; a++) {
1682                                 Material *ma= give_current_material(ob, a+1);
1683                                 
1684                                 if (id_frame_has_keyframe((ID *)ma, frame, filter))
1685                                         return 1;
1686                         }
1687                 }
1688         }
1689         
1690         /* nothing found */
1691         return 0;
1692 }
1693
1694 /* --------------- API ------------------- */
1695
1696 /* Checks whether a keyframe exists for the given ID-block one the given frame */
1697 short id_frame_has_keyframe (ID *id, float frame, short filter)
1698 {
1699         /* sanity checks */
1700         if (id == NULL)
1701                 return 0;
1702         
1703         /* perform special checks for 'macro' types */
1704         switch (GS(id->name)) {
1705                 case ID_OB: /* object */
1706                         return object_frame_has_keyframe((Object *)id, frame, filter);
1707                         break;
1708                         
1709                 case ID_SCE: /* scene */
1710                 // XXX TODO... for now, just use 'normal' behaviour
1711                 //      break;
1712                 
1713                 default:        /* 'normal type' */
1714                 {
1715                         AnimData *adt= BKE_animdata_from_id(id);
1716                         
1717                         /* only check keyframes in active action */
1718                         if (adt)
1719                                 return action_frame_has_keyframe(adt->action, frame, filter);
1720                 }
1721                         break;
1722         }
1723         
1724         
1725         /* no keyframe found */
1726         return 0;
1727 }
1728
1729 /* ************************************************** */
1730
1731 int ED_autokeyframe_object(bContext *C, Scene *scene, Object *ob, KeyingSet *ks)
1732 {
1733         /* auto keyframing */
1734         if (autokeyframe_cfra_can_key(scene, &ob->id)) {
1735                 ListBase dsources = {NULL, NULL};
1736
1737                 /* now insert the keyframe(s) using the Keying Set
1738                  *      1) add datasource override for the Object
1739                  *      2) insert keyframes
1740                  *      3) free the extra info
1741                  */
1742                 ANIM_relative_keyingset_add_source(&dsources, &ob->id, NULL, NULL);
1743                 ANIM_apply_keyingset(C, &dsources, NULL, ks, MODIFYKEY_MODE_INSERT, (float)CFRA);
1744                 BLI_freelistN(&dsources);
1745
1746                 return TRUE;
1747         }
1748         else {
1749                 return FALSE;
1750         }
1751 }
1752
1753 int ED_autokeyframe_pchan(bContext *C, Scene *scene, Object *ob, bPoseChannel *pchan, KeyingSet *ks)
1754 {
1755         if (autokeyframe_cfra_can_key(scene, &ob->id)) {
1756                 ListBase dsources = {NULL, NULL};
1757
1758                 /* now insert the keyframe(s) using the Keying Set
1759                  *      1) add datasource override for the PoseChannel
1760                  *      2) insert keyframes
1761                  *      3) free the extra info
1762                  */
1763                 ANIM_relative_keyingset_add_source(&dsources, &ob->id, &RNA_PoseBone, pchan);
1764                 ANIM_apply_keyingset(C, &dsources, NULL, ks, MODIFYKEY_MODE_INSERT, (float)CFRA);
1765                 BLI_freelistN(&dsources);
1766
1767                 /* clear any unkeyed tags */
1768                 if (pchan->bone) {
1769                         pchan->bone->flag &= ~BONE_UNKEYED;
1770                 }
1771
1772                 return TRUE;
1773         }
1774         else {
1775                 /* add unkeyed tags */
1776                 if (pchan->bone) {
1777                         pchan->bone->flag |= BONE_UNKEYED;
1778                 }
1779
1780                 return FALSE;
1781         }
1782 }