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