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