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