Merge branch 'blender2.7'
[blender.git] / source / blender / editors / animation / keyframes_edit.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) 2008 Blender Foundation
19  *
20  * Contributor(s): Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/editors/animation/keyframes_edit.c
26  *  \ingroup edanimation
27  */
28
29
30 #include <stdlib.h>
31 #include <string.h>
32 #include <math.h>
33 #include <float.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "BLI_blenlib.h"
38 #include "BLI_utildefines.h"
39 #include "BLI_lasso_2d.h"
40 #include "BLI_math.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "BKE_fcurve.h"
47 #include "BKE_nla.h"
48
49 #include "ED_anim_api.h"
50 #include "ED_keyframes_edit.h"
51 #include "ED_markers.h"
52
53 /* This file defines an API and set of callback-operators for non-destructive editing of keyframe data.
54  *
55  * Two API functions are defined for actually performing the operations on the data:
56  * ANIM_fcurve_keyframes_loop()
57  * which take the data they operate on, a few callbacks defining what operations to perform.
58  *
59  * As operators which work on keyframes usually apply the same operation on all BezTriples in
60  * every channel, the code has been optimized providing a set of functions which will get the
61  * appropriate bezier-modify function to set. These functions (ANIM_editkeyframes_*) will need
62  * to be called before getting any channels.
63  *
64  * A set of 'validation' callbacks are provided for checking if a BezTriple should be operated on.
65  * These should only be used when using a 'general' BezTriple editor (i.e. selection setters which
66  * don't check existing selection status).
67  *
68  * - Joshua Leung, Dec 2008
69  */
70
71 /* ************************************************************************** */
72 /* Keyframe Editing Loops - Exposed API */
73
74 /* --------------------------- Base Functions ------------------------------------ */
75
76 /* This function is used to loop over BezTriples in the given F-Curve, applying a given
77  * operation on them, and optionally applies an F-Curve validation function afterwards.
78  */
79 // TODO: make this function work on samples too...
80 short ANIM_fcurve_keyframes_loop(KeyframeEditData *ked, FCurve *fcu, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
81 {
82         BezTriple *bezt;
83         short ok = 0;
84         unsigned int i;
85
86         /* sanity check */
87         if (ELEM(NULL, fcu, fcu->bezt))
88                 return 0;
89
90         /* set the F-Curve into the editdata so that it can be accessed */
91         if (ked) {
92                 ked->fcu = fcu;
93                 ked->curIndex = 0;
94                 ked->curflags = ok;
95         }
96
97         /* if function to apply to bezier curves is set, then loop through executing it on beztriples */
98         if (key_cb) {
99                 /* if there's a validation func, include that check in the loop
100                  * (this is should be more efficient than checking for it in every loop)
101                  */
102                 if (key_ok) {
103                         for (bezt = fcu->bezt, i = 0; i < fcu->totvert; bezt++, i++) {
104                                 if (ked) {
105                                         /* advance the index, and reset the ok flags (to not influence the result) */
106                                         ked->curIndex = i;
107                                         ked->curflags = 0;
108                                 }
109
110                                 /* Only operate on this BezTriple if it fulfills the criteria of the validation func */
111                                 if ((ok = key_ok(ked, bezt))) {
112                                         if (ked) ked->curflags = ok;
113
114                                         /* Exit with return-code '1' if function returns positive
115                                          * This is useful if finding if some BezTriple satisfies a condition.
116                                          */
117                                         if (key_cb(ked, bezt)) return 1;
118                                 }
119                         }
120                 }
121                 else {
122                         for (bezt = fcu->bezt, i = 0; i < fcu->totvert; bezt++, i++) {
123                                 if (ked) ked->curIndex = i;
124
125                                 /* Exit with return-code '1' if function returns positive
126                                  * This is useful if finding if some BezTriple satisfies a condition.
127                                  */
128                                 if (key_cb(ked, bezt)) return 1;
129                         }
130                 }
131         }
132
133         /* unset the F-Curve from the editdata now that it's done */
134         if (ked) {
135                 ked->fcu = NULL;
136                 ked->curIndex = 0;
137                 ked->curflags = 0;
138         }
139
140         /* if fcu_cb (F-Curve post-editing callback) has been specified then execute it */
141         if (fcu_cb)
142                 fcu_cb(fcu);
143
144         /* done */
145         return 0;
146 }
147
148 /* -------------------------------- Further Abstracted (Not Exposed Directly) ----------------------------- */
149
150 /* This function is used to loop over the keyframe data in an Action Group */
151 static short agrp_keyframes_loop(KeyframeEditData *ked, bActionGroup *agrp, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
152 {
153         FCurve *fcu;
154
155         /* sanity check */
156         if (agrp == NULL)
157                 return 0;
158
159         /* only iterate over the F-Curves that are in this group */
160         for (fcu = agrp->channels.first; fcu && fcu->grp == agrp; fcu = fcu->next) {
161                 if (ANIM_fcurve_keyframes_loop(ked, fcu, key_ok, key_cb, fcu_cb))
162                         return 1;
163         }
164
165         return 0;
166 }
167
168 /* This function is used to loop over the keyframe data in an Action */
169 static short act_keyframes_loop(KeyframeEditData *ked, bAction *act, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
170 {
171         FCurve *fcu;
172
173         /* sanity check */
174         if (act == NULL)
175                 return 0;
176
177         /* just loop through all F-Curves */
178         for (fcu = act->curves.first; fcu; fcu = fcu->next) {
179                 if (ANIM_fcurve_keyframes_loop(ked, fcu, key_ok, key_cb, fcu_cb))
180                         return 1;
181         }
182
183         return 0;
184 }
185
186 /* This function is used to loop over the keyframe data in an Object */
187 static short ob_keyframes_loop(KeyframeEditData *ked, bDopeSheet *ads, Object *ob, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
188 {
189         bAnimContext ac = {NULL};
190         ListBase anim_data = {NULL, NULL};
191         bAnimListElem *ale;
192         int filter;
193         int ret = 0;
194
195         bAnimListElem dummychan = {NULL};
196         Base dummybase = {NULL};
197
198         if (ob == NULL)
199                 return 0;
200
201         /* create a dummy wrapper data to work with */
202         dummybase.object = ob;
203
204         dummychan.type = ANIMTYPE_OBJECT;
205         dummychan.data = &dummybase;
206         dummychan.id = &ob->id;
207         dummychan.adt = ob->adt;
208
209         ac.ads = ads;
210         ac.data = &dummychan;
211         ac.datatype = ANIMCONT_CHANNEL;
212
213         /* get F-Curves to take keyframes from */
214         filter = ANIMFILTER_DATA_VISIBLE; // curves only
215         ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
216
217         /* loop through each F-Curve, applying the operation as required, but stopping on the first one */
218         for (ale = anim_data.first; ale; ale = ale->next) {
219                 if (ANIM_fcurve_keyframes_loop(ked, (FCurve *)ale->data, key_ok, key_cb, fcu_cb)) {
220                         ret = 1;
221                         break;
222                 }
223         }
224
225         ANIM_animdata_freelist(&anim_data);
226
227         /* return return code - defaults to zero if nothing happened */
228         return ret;
229 }
230
231 /* This function is used to loop over the keyframe data in a Scene */
232 static short scene_keyframes_loop(KeyframeEditData *ked, bDopeSheet *ads, Scene *sce, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
233 {
234         bAnimContext ac = {NULL};
235         ListBase anim_data = {NULL, NULL};
236         bAnimListElem *ale;
237         int filter;
238         int ret = 0;
239
240         bAnimListElem dummychan = {NULL};
241
242         if (sce == NULL)
243                 return 0;
244
245         /* create a dummy wrapper data to work with */
246         dummychan.type = ANIMTYPE_SCENE;
247         dummychan.data = sce;
248         dummychan.id = &sce->id;
249         dummychan.adt = sce->adt;
250
251         ac.ads = ads;
252         ac.data = &dummychan;
253         ac.datatype = ANIMCONT_CHANNEL;
254
255         /* get F-Curves to take keyframes from */
256         filter = ANIMFILTER_DATA_VISIBLE; // curves only
257         ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
258
259         /* loop through each F-Curve, applying the operation as required, but stopping on the first one */
260         for (ale = anim_data.first; ale; ale = ale->next) {
261                 if (ANIM_fcurve_keyframes_loop(ked, (FCurve *)ale->data, key_ok, key_cb, fcu_cb)) {
262                         ret = 1;
263                         break;
264                 }
265         }
266
267         ANIM_animdata_freelist(&anim_data);
268
269         /* return return code - defaults to zero if nothing happened */
270         return ret;
271 }
272
273 /* This function is used to loop over the keyframe data in a DopeSheet summary */
274 static short summary_keyframes_loop(KeyframeEditData *ked, bAnimContext *ac, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
275 {
276         ListBase anim_data = {NULL, NULL};
277         bAnimListElem *ale;
278         int filter, ret_code = 0;
279
280         /* sanity check */
281         if (ac == NULL)
282                 return 0;
283
284         /* get F-Curves to take keyframes from */
285         filter = ANIMFILTER_DATA_VISIBLE;
286         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
287
288         /* loop through each F-Curve, working on the keyframes until the first curve aborts */
289         for (ale = anim_data.first; ale; ale = ale->next) {
290                 switch (ale->datatype) {
291                         case ALE_MASKLAY:
292                         case ALE_GPFRAME:
293                                 break;
294
295                         case ALE_FCURVE:
296                         default:
297                         {
298                                 if (ked && ked->iterflags) {
299                                         /* make backups of the current values, so that a localised fix
300                                          * (e.g. NLA time remapping) can be applied to these values
301                                          */
302                                         float f1 = ked->f1;
303                                         float f2 = ked->f2;
304
305                                         if (ked->iterflags & (KED_F1_NLA_UNMAP | KED_F2_NLA_UNMAP)) {
306                                                 AnimData *adt = ANIM_nla_mapping_get(ac, ale);
307
308                                                 if (ked->iterflags & KED_F1_NLA_UNMAP)
309                                                         ked->f1 = BKE_nla_tweakedit_remap(adt, f1, NLATIME_CONVERT_UNMAP);
310                                                 if (ked->iterflags & KED_F2_NLA_UNMAP)
311                                                         ked->f2 = BKE_nla_tweakedit_remap(adt, f2, NLATIME_CONVERT_UNMAP);
312                                         }
313
314                                         /* now operate on the channel as per normal */
315                                         ret_code = ANIM_fcurve_keyframes_loop(ked, ale->data, key_ok, key_cb, fcu_cb);
316
317                                         /* reset */
318                                         ked->f1 = f1;
319                                         ked->f2 = f2;
320                                 }
321                                 else {
322                                         /* no special handling required... */
323                                         ret_code = ANIM_fcurve_keyframes_loop(ked, ale->data, key_ok, key_cb, fcu_cb);
324                                 }
325                                 break;
326                         }
327                 }
328
329                 if (ret_code)
330                         break;
331         }
332
333         ANIM_animdata_freelist(&anim_data);
334
335         return ret_code;
336 }
337
338 /* --- */
339
340 /* This function is used to apply operation to all keyframes, regardless of the type */
341 short ANIM_animchannel_keyframes_loop(KeyframeEditData *ked, bDopeSheet *ads, bAnimListElem *ale, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
342 {
343         /* sanity checks */
344         if (ale == NULL)
345                 return 0;
346
347         /* method to use depends on the type of keyframe data */
348         switch (ale->datatype) {
349                 /* direct keyframe data (these loops are exposed) */
350                 case ALE_FCURVE: /* F-Curve */
351                         return ANIM_fcurve_keyframes_loop(ked, ale->key_data, key_ok, key_cb, fcu_cb);
352
353                 /* indirect 'summaries' (these are not exposed directly)
354                  * NOTE: must keep this code in sync with the drawing code and also the filtering code!
355                  */
356                 case ALE_GROUP: /* action group */
357                         return agrp_keyframes_loop(ked, (bActionGroup *)ale->data, key_ok, key_cb, fcu_cb);
358                 case ALE_ACT: /* action */
359                         return act_keyframes_loop(ked, (bAction *)ale->key_data, key_ok, key_cb, fcu_cb);
360
361                 case ALE_OB: /* object */
362                         return ob_keyframes_loop(ked, ads, (Object *)ale->key_data, key_ok, key_cb, fcu_cb);
363                 case ALE_SCE: /* scene */
364                         return scene_keyframes_loop(ked, ads, (Scene *)ale->data, key_ok, key_cb, fcu_cb);
365                 case ALE_ALL: /* 'all' (DopeSheet summary) */
366                         return summary_keyframes_loop(ked, (bAnimContext *)ale->data, key_ok, key_cb, fcu_cb);
367         }
368
369         return 0;
370 }
371
372 /* This function is used to apply operation to all keyframes, regardless of the type without needed an AnimListElem wrapper */
373 short ANIM_animchanneldata_keyframes_loop(KeyframeEditData *ked, bDopeSheet *ads, void *data, int keytype, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
374 {
375         /* sanity checks */
376         if (data == NULL)
377                 return 0;
378
379         /* method to use depends on the type of keyframe data */
380         switch (keytype) {
381                 /* direct keyframe data (these loops are exposed) */
382                 case ALE_FCURVE: /* F-Curve */
383                         return ANIM_fcurve_keyframes_loop(ked, data, key_ok, key_cb, fcu_cb);
384
385                 /* indirect 'summaries' (these are not exposed directly)
386                  * NOTE: must keep this code in sync with the drawing code and also the filtering code!
387                  */
388                 case ALE_GROUP: /* action group */
389                         return agrp_keyframes_loop(ked, (bActionGroup *)data, key_ok, key_cb, fcu_cb);
390                 case ALE_ACT: /* action */
391                         return act_keyframes_loop(ked, (bAction *)data, key_ok, key_cb, fcu_cb);
392
393                 case ALE_OB: /* object */
394                         return ob_keyframes_loop(ked, ads, (Object *)data, key_ok, key_cb, fcu_cb);
395                 case ALE_SCE: /* scene */
396                         return scene_keyframes_loop(ked, ads, (Scene *)data, key_ok, key_cb, fcu_cb);
397                 case ALE_ALL: /* 'all' (DopeSheet summary) */
398                         return summary_keyframes_loop(ked, (bAnimContext *)data, key_ok, key_cb, fcu_cb);
399         }
400
401         return 0;
402 }
403
404 /* ************************************************************************** */
405 /* Keyframe Integrity Tools */
406
407 /* Rearrange keyframes if some are out of order */
408 // used to be recalc_*_ipos() where * was object or action
409 void ANIM_editkeyframes_refresh(bAnimContext *ac)
410 {
411         ListBase anim_data = {NULL, NULL};
412         bAnimListElem *ale;
413         int filter;
414
415         /* filter animation data */
416         filter = ANIMFILTER_DATA_VISIBLE;
417         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
418
419         /* Loop over F-Curves that are likely to have been edited, and tag them to
420          * ensure the keyframes are in order and handles are in a valid position. */
421         for (ale = anim_data.first; ale; ale = ale->next) {
422                 ale->update |= ANIM_UPDATE_DEPS | ANIM_UPDATE_HANDLES | ANIM_UPDATE_ORDER;
423         }
424
425         /* free temp data */
426         ANIM_animdata_update(ac, &anim_data);
427         ANIM_animdata_freelist(&anim_data);
428 }
429
430 /* ************************************************************************** */
431 /* BezTriple Validation Callbacks */
432
433 /* ------------------------ */
434 /* Some macros to make this easier... */
435
436 /* run the given check on the 3 handles
437  * - check should be a macro, which takes the handle index as its single arg, which it substitutes later
438  * - requires that a var, of type short, is named 'ok', and has been initialized to 0
439  */
440 #define KEYFRAME_OK_CHECKS(check) \
441         { \
442                 CHECK_TYPE(ok, short); \
443                 if (check(1)) \
444                         ok |= KEYFRAME_OK_KEY; \
445                  \
446                 if (ked && (ked->iterflags & KEYFRAME_ITER_INCL_HANDLES)) { \
447                         if (check(0)) \
448                                 ok |= KEYFRAME_OK_H1; \
449                         if (check(2)) \
450                                 ok |= KEYFRAME_OK_H2; \
451                 } \
452         } (void)0
453
454 /* ------------------------ */
455
456 static short ok_bezier_frame(KeyframeEditData *ked, BezTriple *bezt)
457 {
458         short ok = 0;
459
460         /* frame is stored in f1 property (this float accuracy check may need to be dropped?) */
461 #define KEY_CHECK_OK(_index) IS_EQF(bezt->vec[_index][0], ked->f1)
462         KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
463 #undef KEY_CHECK_OK
464
465         /* return ok flags */
466         return ok;
467 }
468
469 static short ok_bezier_framerange(KeyframeEditData *ked, BezTriple *bezt)
470 {
471         short ok = 0;
472
473         /* frame range is stored in float properties */
474 #define KEY_CHECK_OK(_index) ((bezt->vec[_index][0] > ked->f1) && (bezt->vec[_index][0] < ked->f2))
475         KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
476 #undef KEY_CHECK_OK
477
478         /* return ok flags */
479         return ok;
480 }
481
482 static short ok_bezier_selected(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
483 {
484         /* this macro checks all beztriple handles for selection...
485          * only one of the verts has to be selected for this to be ok...
486          */
487         if (BEZT_ISSEL_ANY(bezt))
488                 return KEYFRAME_OK_ALL;
489         else
490                 return 0;
491 }
492
493 static short ok_bezier_value(KeyframeEditData *ked, BezTriple *bezt)
494 {
495         short ok = 0;
496
497         /* value is stored in f1 property
498          * - this float accuracy check may need to be dropped?
499          * - should value be stored in f2 instead so that we won't have conflicts when using f1 for frames too?
500          */
501 #define KEY_CHECK_OK(_index) IS_EQF(bezt->vec[_index][1], ked->f1)
502         KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
503 #undef KEY_CHECK_OK
504
505         /* return ok flags */
506         return ok;
507 }
508
509 static short ok_bezier_valuerange(KeyframeEditData *ked, BezTriple *bezt)
510 {
511         short ok = 0;
512
513         /* value range is stored in float properties */
514 #define KEY_CHECK_OK(_index) ((bezt->vec[_index][1] > ked->f1) && (bezt->vec[_index][1] < ked->f2))
515         KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
516 #undef KEY_CHECK_OK
517
518         /* return ok flags */
519         return ok;
520 }
521
522 static short ok_bezier_region(KeyframeEditData *ked, BezTriple *bezt)
523 {
524         /* rect is stored in data property (it's of type rectf, but may not be set) */
525         if (ked->data) {
526                 short ok = 0;
527
528 #define KEY_CHECK_OK(_index) BLI_rctf_isect_pt_v(ked->data, bezt->vec[_index])
529                 KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
530 #undef KEY_CHECK_OK
531
532                 /* return ok flags */
533                 return ok;
534         }
535         else
536                 return 0;
537 }
538
539 /**
540  * Called from #ok_bezier_region_lasso and #ok_bezier_channel_lasso
541  */
542 bool keyframe_region_lasso_test(
543         const KeyframeEdit_LassoData *data_lasso,
544         const float xy[2])
545 {
546         if (BLI_rctf_isect_pt_v(data_lasso->rectf_scaled, xy)) {
547                 float xy_view[2];
548
549                 BLI_rctf_transform_pt_v(data_lasso->rectf_view, data_lasso->rectf_scaled, xy_view, xy);
550
551                 if (BLI_lasso_is_point_inside(data_lasso->mcords, data_lasso->mcords_tot, xy_view[0], xy_view[1], INT_MAX)) {
552                         return true;
553                 }
554         }
555
556         return false;
557 }
558
559 static short ok_bezier_region_lasso(KeyframeEditData *ked, BezTriple *bezt)
560 {
561         /* check for lasso customdata (KeyframeEdit_LassoData) */
562         if (ked->data) {
563                 short ok = 0;
564
565 #define KEY_CHECK_OK(_index) keyframe_region_lasso_test(ked->data, bezt->vec[_index])
566                 KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
567 #undef KEY_CHECK_OK
568
569                 /* return ok flags */
570                 return ok;
571         }
572         else
573                 return 0;
574 }
575
576 static short ok_bezier_channel_lasso(KeyframeEditData *ked, BezTriple *bezt)
577 {
578         /* check for lasso customdata (KeyframeEdit_LassoData) */
579         if (ked->data) {
580                 KeyframeEdit_LassoData *data = ked->data;
581                 float pt[2];
582
583                 /* late-binding remap of the x values (for summary channels) */
584                 /* XXX: Ideally we reset, but it should be fine just leaving it as-is
585                  * as the next channel will reset it properly, while the next summary-channel
586                  * curve will also reset by itself...
587                  */
588                 if (ked->iterflags & (KED_F1_NLA_UNMAP | KED_F2_NLA_UNMAP)) {
589                         data->rectf_scaled->xmin = ked->f1;
590                         data->rectf_scaled->xmax = ked->f2;
591                 }
592
593                 /* only use the x-coordinate of the point; the y is the channel range... */
594                 pt[0] = bezt->vec[1][0];
595                 pt[1] = ked->channel_y;
596
597                 if (keyframe_region_lasso_test(data, pt))
598                         return KEYFRAME_OK_KEY;
599         }
600         return 0;
601 }
602
603 /**
604  * Called from #ok_bezier_region_circle and #ok_bezier_channel_circle
605  */
606 bool keyframe_region_circle_test(
607         const KeyframeEdit_CircleData *data_circle,
608         const float xy[2])
609 {
610         if (BLI_rctf_isect_pt_v(data_circle->rectf_scaled, xy)) {
611                 float xy_view[2];
612
613                 BLI_rctf_transform_pt_v(data_circle->rectf_view, data_circle->rectf_scaled, xy_view, xy);
614
615                 xy_view[0] = xy_view[0] - data_circle->mval[0];
616                 xy_view[1] = xy_view[1] - data_circle->mval[1];
617                 return len_squared_v2(xy_view) < data_circle->radius_squared;
618         }
619
620         return false;
621 }
622
623
624 static short ok_bezier_region_circle(KeyframeEditData *ked, BezTriple *bezt)
625 {
626         /* check for circle select customdata (KeyframeEdit_CircleData) */
627         if (ked->data) {
628                 short ok = 0;
629
630 #define KEY_CHECK_OK(_index) keyframe_region_circle_test(ked->data, bezt->vec[_index])
631                 KEYFRAME_OK_CHECKS(KEY_CHECK_OK);
632 #undef KEY_CHECK_OK
633
634                 /* return ok flags */
635                 return ok;
636         }
637         else
638                 return 0;
639 }
640
641 static short ok_bezier_channel_circle(KeyframeEditData *ked, BezTriple *bezt)
642 {
643         /* check for circle select customdata (KeyframeEdit_CircleData) */
644         if (ked->data) {
645                 KeyframeEdit_CircleData *data = ked->data;
646                 float pt[2];
647
648                 /* late-binding remap of the x values (for summary channels) */
649                 /* XXX: Ideally we reset, but it should be fine just leaving it as-is
650                  * as the next channel will reset it properly, while the next summary-channel
651                  * curve will also reset by itself...
652                  */
653                 if (ked->iterflags & (KED_F1_NLA_UNMAP | KED_F2_NLA_UNMAP)) {
654                         data->rectf_scaled->xmin = ked->f1;
655                         data->rectf_scaled->xmax = ked->f2;
656                 }
657
658                 /* only use the x-coordinate of the point; the y is the channel range... */
659                 pt[0] = bezt->vec[1][0];
660                 pt[1] = ked->channel_y;
661
662                 if (keyframe_region_circle_test(data, pt))
663                         return KEYFRAME_OK_KEY;
664         }
665         return 0;
666 }
667
668
669 KeyframeEditFunc ANIM_editkeyframes_ok(short mode)
670 {
671         /* eEditKeyframes_Validate */
672         switch (mode) {
673                 case BEZT_OK_FRAME: /* only if bezt falls on the right frame (float) */
674                         return ok_bezier_frame;
675                 case BEZT_OK_FRAMERANGE: /* only if bezt falls within the specified frame range (floats) */
676                         return ok_bezier_framerange;
677                 case BEZT_OK_SELECTED:  /* only if bezt is selected (self) */
678                         return ok_bezier_selected;
679                 case BEZT_OK_VALUE: /* only if bezt value matches (float) */
680                         return ok_bezier_value;
681                 case BEZT_OK_VALUERANGE: /* only if bezier falls within the specified value range (floats) */
682                         return ok_bezier_valuerange;
683                 case BEZT_OK_REGION: /* only if bezier falls within the specified rect (data -> rectf) */
684                         return ok_bezier_region;
685                 case BEZT_OK_REGION_LASSO: /* only if the point falls within KeyframeEdit_LassoData defined data */
686                         return ok_bezier_region_lasso;
687                 case BEZT_OK_REGION_CIRCLE: /* only if the point falls within KeyframeEdit_CircleData defined data */
688                         return ok_bezier_region_circle;
689                 case BEZT_OK_CHANNEL_LASSO: /* same as BEZT_OK_REGION_LASSO, but we're only using the x-value of the points */
690                         return ok_bezier_channel_lasso;
691                 case BEZT_OK_CHANNEL_CIRCLE: /* same as BEZT_OK_REGION_CIRCLE, but we're only using the x-value of the points */
692                         return ok_bezier_channel_circle;
693                 default: /* nothing was ok */
694                         return NULL;
695         }
696 }
697
698 /* ******************************************* */
699 /* Assorted Utility Functions */
700
701 /* helper callback for <animeditor>_cfrasnap_exec() -> used to help get the average time of all selected beztriples */
702 short bezt_calc_average(KeyframeEditData *ked, BezTriple *bezt)
703 {
704         /* only if selected */
705         if (bezt->f2 & SELECT) {
706                 /* store average time in float 1 (only do rounding at last step) */
707                 ked->f1 += bezt->vec[1][0];
708
709                 /* store average value in float 2 (only do rounding at last step)
710                  * - this isn't always needed, but some operators may also require this
711                  */
712                 ked->f2 += bezt->vec[1][1];
713
714                 /* increment number of items */
715                 ked->i1++;
716         }
717
718         return 0;
719 }
720
721 /* helper callback for columnselect_<animeditor>_keys() -> populate list CfraElems with frame numbers from selected beztriples */
722 short bezt_to_cfraelem(KeyframeEditData *ked, BezTriple *bezt)
723 {
724         /* only if selected */
725         if (bezt->f2 & SELECT) {
726                 CfraElem *ce = MEM_callocN(sizeof(CfraElem), "cfraElem");
727                 BLI_addtail(&ked->list, ce);
728
729                 ce->cfra = bezt->vec[1][0];
730         }
731
732         return 0;
733 }
734
735 /* used to remap times from one range to another
736  * requires:  ked->data = KeyframeEditCD_Remap
737  */
738 void bezt_remap_times(KeyframeEditData *ked, BezTriple *bezt)
739 {
740         KeyframeEditCD_Remap *rmap = (KeyframeEditCD_Remap *)ked->data;
741         const float scale = (rmap->newMax - rmap->newMin) / (rmap->oldMax - rmap->oldMin);
742
743         /* perform transform on all three handles unless indicated otherwise */
744         // TODO: need to include some checks for that
745
746         bezt->vec[0][0] = scale * (bezt->vec[0][0] - rmap->oldMin) + rmap->newMin;
747         bezt->vec[1][0] = scale * (bezt->vec[1][0] - rmap->oldMin) + rmap->newMin;
748         bezt->vec[2][0] = scale * (bezt->vec[2][0] - rmap->oldMin) + rmap->newMin;
749 }
750
751 /* ******************************************* */
752 /* Transform */
753
754 /* snaps the keyframe to the nearest frame */
755 static short snap_bezier_nearest(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
756 {
757         if (bezt->f2 & SELECT)
758                 bezt->vec[1][0] = (float)(floorf(bezt->vec[1][0] + 0.5f));
759         return 0;
760 }
761
762 /* snaps the keyframe to the nearest second */
763 static short snap_bezier_nearestsec(KeyframeEditData *ked, BezTriple *bezt)
764 {
765         const Scene *scene = ked->scene;
766         const float secf = (float)FPS;
767
768         if (bezt->f2 & SELECT)
769                 bezt->vec[1][0] = (floorf(bezt->vec[1][0] / secf + 0.5f) * secf);
770         return 0;
771 }
772
773 /* snaps the keyframe to the current frame */
774 static short snap_bezier_cframe(KeyframeEditData *ked, BezTriple *bezt)
775 {
776         const Scene *scene = ked->scene;
777         if (bezt->f2 & SELECT)
778                 bezt->vec[1][0] = (float)CFRA;
779         return 0;
780 }
781
782 /* snaps the keyframe time to the nearest marker's frame */
783 static short snap_bezier_nearmarker(KeyframeEditData *ked, BezTriple *bezt)
784 {
785         if (bezt->f2 & SELECT)
786                 bezt->vec[1][0] = (float)ED_markers_find_nearest_marker_time(&ked->list, bezt->vec[1][0]);
787         return 0;
788 }
789
790 /* make the handles have the same value as the key */
791 static short snap_bezier_horizontal(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
792 {
793         if (bezt->f2 & SELECT) {
794                 bezt->vec[0][1] = bezt->vec[2][1] = bezt->vec[1][1];
795
796                 if (ELEM(bezt->h1, HD_AUTO, HD_AUTO_ANIM, HD_VECT)) bezt->h1 = HD_ALIGN;
797                 if (ELEM(bezt->h2, HD_AUTO, HD_AUTO_ANIM, HD_VECT)) bezt->h2 = HD_ALIGN;
798         }
799         return 0;
800 }
801
802 /* frame to snap to is stored in the custom data -> first float value slot */
803 static short snap_bezier_time(KeyframeEditData *ked, BezTriple *bezt)
804 {
805         if (bezt->f2 & SELECT)
806                 bezt->vec[1][0] = ked->f1;
807         return 0;
808 }
809
810 /* value to snap to is stored in the custom data -> first float value slot */
811 static short snap_bezier_value(KeyframeEditData *ked, BezTriple *bezt)
812 {
813         if (bezt->f2 & SELECT)
814                 bezt->vec[1][1] = ked->f1;
815         return 0;
816 }
817
818 KeyframeEditFunc ANIM_editkeyframes_snap(short type)
819 {
820         /* eEditKeyframes_Snap */
821         switch (type) {
822                 case SNAP_KEYS_NEARFRAME: /* snap to nearest frame */
823                         return snap_bezier_nearest;
824                 case SNAP_KEYS_CURFRAME: /* snap to current frame */
825                         return snap_bezier_cframe;
826                 case SNAP_KEYS_NEARMARKER: /* snap to nearest marker */
827                         return snap_bezier_nearmarker;
828                 case SNAP_KEYS_NEARSEC: /* snap to nearest second */
829                         return snap_bezier_nearestsec;
830                 case SNAP_KEYS_HORIZONTAL: /* snap handles to same value */
831                         return snap_bezier_horizontal;
832                 case SNAP_KEYS_TIME: /* snap to given frame/time */
833                         return snap_bezier_time;
834                 case SNAP_KEYS_VALUE: /* snap to given value */
835                         return snap_bezier_value;
836                 default: /* just in case */
837                         return snap_bezier_nearest;
838         }
839 }
840
841 /* --------- */
842
843 static void mirror_bezier_xaxis_ex(BezTriple *bezt, const float center)
844 {
845         float diff;
846         int i;
847
848         for (i = 0; i < 3; i++) {
849                 diff = (center - bezt->vec[i][0]);
850                 bezt->vec[i][0] = (center + diff);
851         }
852         swap_v3_v3(bezt->vec[0], bezt->vec[2]);
853
854         SWAP(char, bezt->h1, bezt->h2);
855         SWAP(char, bezt->f1, bezt->f3);
856 }
857
858 static void mirror_bezier_yaxis_ex(BezTriple *bezt, const float center)
859 {
860         float diff;
861         int i;
862
863         for (i = 0; i < 3; i++) {
864                 diff = (center - bezt->vec[i][1]);
865                 bezt->vec[i][1] = (center + diff);
866         }
867 }
868
869 static short mirror_bezier_cframe(KeyframeEditData *ked, BezTriple *bezt)
870 {
871         const Scene *scene = ked->scene;
872
873         if (bezt->f2 & SELECT) {
874                 mirror_bezier_xaxis_ex(bezt, CFRA);
875         }
876
877         return 0;
878 }
879
880 static short mirror_bezier_yaxis(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
881 {
882         if (bezt->f2 & SELECT) {
883                 /* Yes, names are inverted, we are mirroring across y axis, hence along x axis... */
884                 mirror_bezier_xaxis_ex(bezt, 0.0f);
885         }
886
887         return 0;
888 }
889
890 static short mirror_bezier_xaxis(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
891 {
892         if (bezt->f2 & SELECT) {
893                 /* Yes, names are inverted, we are mirroring across x axis, hence along y axis... */
894                 mirror_bezier_yaxis_ex(bezt, 0.0f);
895         }
896
897         return 0;
898 }
899
900 static short mirror_bezier_marker(KeyframeEditData *ked, BezTriple *bezt)
901 {
902         /* mirroring time stored in f1 */
903         if (bezt->f2 & SELECT) {
904                 mirror_bezier_xaxis_ex(bezt, ked->f1);
905         }
906
907         return 0;
908 }
909
910 static short mirror_bezier_time(KeyframeEditData *ked, BezTriple *bezt)
911 {
912         /* value to mirror over is stored in f1 */
913         if (bezt->f2 & SELECT) {
914                 mirror_bezier_xaxis_ex(bezt, ked->f1);
915         }
916
917         return 0;
918 }
919
920 static short mirror_bezier_value(KeyframeEditData *ked, BezTriple *bezt)
921 {
922         /* value to mirror over is stored in the custom data -> first float value slot */
923         if (bezt->f2 & SELECT) {
924                 mirror_bezier_yaxis_ex(bezt, ked->f1);
925         }
926
927         return 0;
928 }
929
930 /* Note: for markers and 'value', the values to use must be supplied as the first float value */
931 // calchandles_fcurve
932 KeyframeEditFunc ANIM_editkeyframes_mirror(short type)
933 {
934         switch (type) {
935                 case MIRROR_KEYS_CURFRAME: /* mirror over current frame */
936                         return mirror_bezier_cframe;
937                 case MIRROR_KEYS_YAXIS: /* mirror over frame 0 */
938                         return mirror_bezier_yaxis;
939                 case MIRROR_KEYS_XAXIS: /* mirror over value 0 */
940                         return mirror_bezier_xaxis;
941                 case MIRROR_KEYS_MARKER: /* mirror over marker */
942                         return mirror_bezier_marker;
943                 case MIRROR_KEYS_TIME: /* mirror over frame/time */
944                         return mirror_bezier_time;
945                 case MIRROR_KEYS_VALUE: /* mirror over given value */
946                         return mirror_bezier_value;
947                 default: /* just in case */
948                         return mirror_bezier_yaxis;
949         }
950 }
951
952 /* ******************************************* */
953 /* Settings */
954
955 /* standard validation step for a few of these (implemented as macro for inlining without fn-call overhead):
956  * "if the handles are not of the same type, set them to type free"
957  */
958 #define ENSURE_HANDLES_MATCH(bezt)                                            \
959         if (bezt->h1 != bezt->h2) {                                               \
960                 if (ELEM(bezt->h1, HD_ALIGN, HD_AUTO, HD_AUTO_ANIM))                  \
961                         bezt->h1 = HD_FREE;                                               \
962                 if (ELEM(bezt->h2, HD_ALIGN, HD_AUTO, HD_AUTO_ANIM))                  \
963                         bezt->h2 = HD_FREE;                                               \
964         } (void)0
965
966 /* Sets the selected bezier handles to type 'auto' */
967 static short set_bezier_auto(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
968 {
969         if ((bezt->f1 & SELECT) || (bezt->f3 & SELECT)) {
970                 if (bezt->f1 & SELECT) bezt->h1 = HD_AUTO;
971                 if (bezt->f3 & SELECT) bezt->h2 = HD_AUTO;
972
973                 ENSURE_HANDLES_MATCH(bezt);
974         }
975         return 0;
976 }
977
978 /* Sets the selected bezier handles to type 'auto-clamped'
979  * NOTE: this is like auto above, but they're handled a bit different
980  */
981 static short set_bezier_auto_clamped(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
982 {
983         if ((bezt->f1 & SELECT) || (bezt->f3 & SELECT)) {
984                 if (bezt->f1 & SELECT) bezt->h1 = HD_AUTO_ANIM;
985                 if (bezt->f3 & SELECT) bezt->h2 = HD_AUTO_ANIM;
986
987                 ENSURE_HANDLES_MATCH(bezt);
988         }
989         return 0;
990 }
991
992 /* Sets the selected bezier handles to type 'vector'  */
993 static short set_bezier_vector(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
994 {
995         if (bezt->f1 & SELECT) bezt->h1 = HD_VECT;
996         if (bezt->f3 & SELECT) bezt->h2 = HD_VECT;
997         return 0;
998 }
999
1000 /* Queries if the handle should be set to 'free' or 'align' */
1001 // NOTE: this was used for the 'toggle free/align' option
1002 //              currently this isn't used, but may be restored later
1003 static short bezier_isfree(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1004 {
1005         if ((bezt->f1 & SELECT) && (bezt->h1)) return 1;
1006         if ((bezt->f3 & SELECT) && (bezt->h2)) return 1;
1007         return 0;
1008 }
1009
1010 /* Sets selected bezier handles to type 'align' */
1011 static short set_bezier_align(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1012 {
1013         if (bezt->f1 & SELECT) bezt->h1 = HD_ALIGN;
1014         if (bezt->f3 & SELECT) bezt->h2 = HD_ALIGN;
1015         return 0;
1016 }
1017
1018 /* Sets selected bezier handles to type 'free'  */
1019 static short set_bezier_free(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1020 {
1021         if (bezt->f1 & SELECT) bezt->h1 = HD_FREE;
1022         if (bezt->f3 & SELECT) bezt->h2 = HD_FREE;
1023         return 0;
1024 }
1025
1026 /* Set all selected Bezier Handles to a single type */
1027 // calchandles_fcurve
1028 KeyframeEditFunc ANIM_editkeyframes_handles(short code)
1029 {
1030         switch (code) {
1031                 case HD_AUTO: /* auto */
1032                         return set_bezier_auto;
1033                 case HD_AUTO_ANIM: /* auto clamped */
1034                         return set_bezier_auto_clamped;
1035
1036                 case HD_VECT: /* vector */
1037                         return set_bezier_vector;
1038                 case HD_FREE: /* free */
1039                         return set_bezier_free;
1040                 case HD_ALIGN: /* align */
1041                         return set_bezier_align;
1042
1043                 default: /* check for toggle free or align? */
1044                         return bezier_isfree;
1045         }
1046 }
1047
1048 /* ------- */
1049
1050 static short set_bezt_constant(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1051 {
1052         if (bezt->f2 & SELECT)
1053                 bezt->ipo = BEZT_IPO_CONST;
1054         return 0;
1055 }
1056
1057 static short set_bezt_linear(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1058 {
1059         if (bezt->f2 & SELECT)
1060                 bezt->ipo = BEZT_IPO_LIN;
1061         return 0;
1062 }
1063
1064 static short set_bezt_bezier(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1065 {
1066         if (bezt->f2 & SELECT)
1067                 bezt->ipo = BEZT_IPO_BEZ;
1068         return 0;
1069 }
1070
1071 static short set_bezt_back(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1072 {
1073         if (bezt->f2 & SELECT)
1074                 bezt->ipo = BEZT_IPO_BACK;
1075         return 0;
1076 }
1077
1078 static short set_bezt_bounce(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1079 {
1080         if (bezt->f2 & SELECT)
1081                 bezt->ipo = BEZT_IPO_BOUNCE;
1082         return 0;
1083 }
1084
1085 static short set_bezt_circle(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1086 {
1087         if (bezt->f2 & SELECT)
1088                 bezt->ipo = BEZT_IPO_CIRC;
1089         return 0;
1090 }
1091
1092 static short set_bezt_cubic(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1093 {
1094         if (bezt->f2 & SELECT)
1095                 bezt->ipo = BEZT_IPO_CUBIC;
1096         return 0;
1097 }
1098
1099 static short set_bezt_elastic(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1100 {
1101         if (bezt->f2 & SELECT)
1102                 bezt->ipo = BEZT_IPO_ELASTIC;
1103         return 0;
1104 }
1105
1106 static short set_bezt_expo(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1107 {
1108         if (bezt->f2 & SELECT)
1109                 bezt->ipo = BEZT_IPO_EXPO;
1110         return 0;
1111 }
1112
1113 static short set_bezt_quad(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1114 {
1115         if (bezt->f2 & SELECT)
1116                 bezt->ipo = BEZT_IPO_QUAD;
1117         return 0;
1118 }
1119
1120 static short set_bezt_quart(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1121 {
1122         if (bezt->f2 & SELECT)
1123                 bezt->ipo = BEZT_IPO_QUART;
1124         return 0;
1125 }
1126
1127 static short set_bezt_quint(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1128 {
1129         if (bezt->f2 & SELECT)
1130                 bezt->ipo = BEZT_IPO_QUINT;
1131         return 0;
1132 }
1133
1134 static short set_bezt_sine(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1135 {
1136         if (bezt->f2 & SELECT)
1137                 bezt->ipo = BEZT_IPO_SINE;
1138         return 0;
1139 }
1140
1141 /* Set the interpolation type of the selected BezTriples in each F-Curve to the specified one */
1142 // ANIM_editkeyframes_ipocurve_ipotype() !
1143 KeyframeEditFunc ANIM_editkeyframes_ipo(short code)
1144 {
1145         switch (code) {
1146                 /* interpolation */
1147                 case BEZT_IPO_CONST: /* constant */
1148                         return set_bezt_constant;
1149                 case BEZT_IPO_LIN: /* linear */
1150                         return set_bezt_linear;
1151
1152                 /* easing */
1153                 case BEZT_IPO_BACK:
1154                         return set_bezt_back;
1155                 case BEZT_IPO_BOUNCE:
1156                         return set_bezt_bounce;
1157                 case BEZT_IPO_CIRC:
1158                         return set_bezt_circle;
1159                 case BEZT_IPO_CUBIC:
1160                         return set_bezt_cubic;
1161                 case BEZT_IPO_ELASTIC:
1162                         return set_bezt_elastic;
1163                 case BEZT_IPO_EXPO:
1164                         return set_bezt_expo;
1165                 case BEZT_IPO_QUAD:
1166                         return set_bezt_quad;
1167                 case BEZT_IPO_QUART:
1168                         return set_bezt_quart;
1169                 case BEZT_IPO_QUINT:
1170                         return set_bezt_quint;
1171                 case BEZT_IPO_SINE:
1172                         return set_bezt_sine;
1173
1174                 default: /* bezier */
1175                         return set_bezt_bezier;
1176         }
1177 }
1178
1179 /* ------- */
1180
1181 static short set_keytype_keyframe(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1182 {
1183         if (bezt->f2 & SELECT)
1184                 BEZKEYTYPE(bezt) = BEZT_KEYTYPE_KEYFRAME;
1185         return 0;
1186 }
1187
1188 static short set_keytype_breakdown(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1189 {
1190         if (bezt->f2 & SELECT)
1191                 BEZKEYTYPE(bezt) = BEZT_KEYTYPE_BREAKDOWN;
1192         return 0;
1193 }
1194
1195 static short set_keytype_extreme(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1196 {
1197         if (bezt->f2 & SELECT)
1198                 BEZKEYTYPE(bezt) = BEZT_KEYTYPE_EXTREME;
1199         return 0;
1200 }
1201
1202 static short set_keytype_jitter(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1203 {
1204         if (bezt->f2 & SELECT)
1205                 BEZKEYTYPE(bezt) = BEZT_KEYTYPE_JITTER;
1206         return 0;
1207 }
1208
1209 static short set_keytype_moving_hold(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1210 {
1211         if (bezt->f2 & SELECT)
1212                 BEZKEYTYPE(bezt) = BEZT_KEYTYPE_MOVEHOLD;
1213         return 0;
1214 }
1215
1216 /* Set the interpolation type of the selected BezTriples in each F-Curve to the specified one */
1217 KeyframeEditFunc ANIM_editkeyframes_keytype(short code)
1218 {
1219         switch (code) {
1220                 case BEZT_KEYTYPE_BREAKDOWN: /* breakdown */
1221                         return set_keytype_breakdown;
1222
1223                 case BEZT_KEYTYPE_EXTREME: /* extreme keyframe */
1224                         return set_keytype_extreme;
1225
1226                 case BEZT_KEYTYPE_JITTER: /* jitter keyframe */
1227                         return set_keytype_jitter;
1228
1229                 case BEZT_KEYTYPE_MOVEHOLD: /* moving hold */
1230                         return set_keytype_moving_hold;
1231
1232                 case BEZT_KEYTYPE_KEYFRAME: /* proper keyframe */
1233                 default:
1234                         return set_keytype_keyframe;
1235         }
1236 }
1237
1238 /* ------- */
1239
1240 static short set_easingtype_easein(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1241 {
1242         if (bezt->f2 & SELECT)
1243                 bezt->easing = BEZT_IPO_EASE_IN;
1244         return 0;
1245 }
1246
1247 static short set_easingtype_easeout(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1248 {
1249         if (bezt->f2 & SELECT)
1250                 bezt->easing = BEZT_IPO_EASE_OUT;
1251         return 0;
1252 }
1253
1254 static short set_easingtype_easeinout(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1255 {
1256         if (bezt->f2 & SELECT)
1257                 bezt->easing = BEZT_IPO_EASE_IN_OUT;
1258         return 0;
1259 }
1260
1261 static short set_easingtype_easeauto(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1262 {
1263         if (bezt->f2 & SELECT)
1264                 bezt->easing = BEZT_IPO_EASE_AUTO;
1265         return 0;
1266 }
1267
1268 /* Set the easing type of the selected BezTriples in each F-Curve to the specified one */
1269 KeyframeEditFunc ANIM_editkeyframes_easing(short mode)
1270 {
1271         switch (mode) {
1272                 case BEZT_IPO_EASE_IN: /* ease in */
1273                         return set_easingtype_easein;
1274
1275                 case BEZT_IPO_EASE_OUT: /* ease out */
1276                         return set_easingtype_easeout;
1277
1278                 case BEZT_IPO_EASE_IN_OUT: /* both */
1279                         return set_easingtype_easeinout;
1280
1281                 default: /* auto */
1282                         return set_easingtype_easeauto;
1283         }
1284 }
1285
1286 /* ******************************************* */
1287 /* Selection */
1288
1289 static short select_bezier_add(KeyframeEditData *ked, BezTriple *bezt)
1290 {
1291         /* if we've got info on what to select, use it, otherwise select all */
1292         if ((ked) && (ked->iterflags & KEYFRAME_ITER_INCL_HANDLES)) {
1293                 if (ked->curflags & KEYFRAME_OK_KEY)
1294                         bezt->f2 |= SELECT;
1295                 if (ked->curflags & KEYFRAME_OK_H1)
1296                         bezt->f1 |= SELECT;
1297                 if (ked->curflags & KEYFRAME_OK_H2)
1298                         bezt->f3 |= SELECT;
1299         }
1300         else {
1301                 BEZT_SEL_ALL(bezt);
1302         }
1303
1304         return 0;
1305 }
1306
1307 static short select_bezier_subtract(KeyframeEditData *ked, BezTriple *bezt)
1308 {
1309         /* if we've got info on what to deselect, use it, otherwise deselect all */
1310         if ((ked) && (ked->iterflags & KEYFRAME_ITER_INCL_HANDLES)) {
1311                 if (ked->curflags & KEYFRAME_OK_KEY)
1312                         bezt->f2 &= ~SELECT;
1313                 if (ked->curflags & KEYFRAME_OK_H1)
1314                         bezt->f1 &= ~SELECT;
1315                 if (ked->curflags & KEYFRAME_OK_H2)
1316                         bezt->f3 &= ~SELECT;
1317         }
1318         else {
1319                 BEZT_DESEL_ALL(bezt);
1320         }
1321
1322         return 0;
1323 }
1324
1325 static short select_bezier_invert(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
1326 {
1327         /* Invert the selection for the whole bezier triple */
1328         bezt->f2 ^= SELECT;
1329         if (bezt->f2 & SELECT) {
1330                 bezt->f1 |= SELECT;
1331                 bezt->f3 |= SELECT;
1332         }
1333         else {
1334                 bezt->f1 &= ~SELECT;
1335                 bezt->f3 &= ~SELECT;
1336         }
1337         return 0;
1338 }
1339
1340 KeyframeEditFunc ANIM_editkeyframes_select(short selectmode)
1341 {
1342         switch (selectmode) {
1343                 case SELECT_ADD: /* add */
1344                         return select_bezier_add;
1345                 case SELECT_SUBTRACT: /* subtract */
1346                         return select_bezier_subtract;
1347                 case SELECT_INVERT: /* invert */
1348                         return select_bezier_invert;
1349                 default: /* replace (need to clear all, then add) */
1350                         return select_bezier_add;
1351         }
1352 }
1353
1354 /* ******************************************* */
1355 /* Selection Maps */
1356
1357 /* Selection maps are simply fancy names for char arrays that store on/off
1358  * info for whether the selection status. The main purpose for these is to
1359  * allow extra info to be tagged to the keyframes without influencing their
1360  * values or having to be removed later.
1361  */
1362
1363 /* ----------- */
1364
1365 static short selmap_build_bezier_more(KeyframeEditData *ked, BezTriple *bezt)
1366 {
1367         FCurve *fcu = ked->fcu;
1368         char *map = ked->data;
1369         int i = ked->curIndex;
1370
1371         /* if current is selected, just make sure it stays this way */
1372         if (BEZT_ISSEL_ANY(bezt)) {
1373                 map[i] = 1;
1374                 return 0;
1375         }
1376
1377         /* if previous is selected, that means that selection should extend across */
1378         if (i > 0) {
1379                 BezTriple *prev = bezt - 1;
1380
1381                 if (BEZT_ISSEL_ANY(prev)) {
1382                         map[i] = 1;
1383                         return 0;
1384                 }
1385         }
1386
1387         /* if next is selected, that means that selection should extend across */
1388         if (i < (fcu->totvert - 1)) {
1389                 BezTriple *next = bezt + 1;
1390
1391                 if (BEZT_ISSEL_ANY(next)) {
1392                         map[i] = 1;
1393                         return 0;
1394                 }
1395         }
1396
1397         return 0;
1398 }
1399
1400 static short selmap_build_bezier_less(KeyframeEditData *ked, BezTriple *bezt)
1401 {
1402         FCurve *fcu = ked->fcu;
1403         char *map = ked->data;
1404         int i = ked->curIndex;
1405
1406         /* if current is selected, check the left/right keyframes
1407          * since it might need to be deselected (but otherwise no)
1408          */
1409         if (BEZT_ISSEL_ANY(bezt)) {
1410                 /* if previous is not selected, we're on the tip of an iceberg */
1411                 if (i > 0) {
1412                         BezTriple *prev = bezt - 1;
1413
1414                         if (BEZT_ISSEL_ANY(prev) == 0)
1415                                 return 0;
1416                 }
1417                 else if (i == 0) {
1418                         /* current keyframe is selected at an endpoint, so should get deselected */
1419                         return 0;
1420                 }
1421
1422                 /* if next is not selected, we're on the tip of an iceberg */
1423                 if (i < (fcu->totvert - 1)) {
1424                         BezTriple *next = bezt + 1;
1425
1426                         if (BEZT_ISSEL_ANY(next) == 0)
1427                                 return 0;
1428                 }
1429                 else if (i == (fcu->totvert - 1)) {
1430                         /* current keyframe is selected at an endpoint, so should get deselected */
1431                         return 0;
1432                 }
1433
1434                 /* if we're still here, that means that keyframe should remain untouched */
1435                 map[i] = 1;
1436         }
1437
1438         return 0;
1439 }
1440
1441 /* Get callback for building selection map */
1442 KeyframeEditFunc ANIM_editkeyframes_buildselmap(short mode)
1443 {
1444         switch (mode) {
1445                 case SELMAP_LESS: /* less */
1446                         return selmap_build_bezier_less;
1447
1448                 case SELMAP_MORE: /* more */
1449                 default:
1450                         return selmap_build_bezier_more;
1451         }
1452 }
1453
1454 /* ----------- */
1455
1456 /* flush selection map values to the given beztriple */
1457 short bezt_selmap_flush(KeyframeEditData *ked, BezTriple *bezt)
1458 {
1459         const char *map = ked->data;
1460         short on = map[ked->curIndex];
1461
1462         /* select or deselect based on whether the map allows it or not */
1463         if (on) {
1464                 BEZT_SEL_ALL(bezt);
1465         }
1466         else {
1467                 BEZT_DESEL_ALL(bezt);
1468         }
1469
1470         return 0;
1471 }