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