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