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