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