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