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