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