2.5 - Added descriptions to all Animation Editor operators
[blender.git] / source / blender / editors / space_graph / graph_select.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation
21  *
22  * Contributor(s): Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #include <math.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <float.h>
31
32 #ifdef HAVE_CONFIG_H
33 #include <config.h>
34 #endif
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_arithb.h"
40
41 #include "DNA_anim_types.h"
42 #include "DNA_action_types.h"
43 #include "DNA_armature_types.h"
44 #include "DNA_camera_types.h"
45 #include "DNA_curve_types.h"
46 #include "DNA_object_types.h"
47 #include "DNA_screen_types.h"
48 #include "DNA_scene_types.h"
49 #include "DNA_space_types.h"
50 #include "DNA_constraint_types.h"
51 #include "DNA_key_types.h"
52 #include "DNA_lamp_types.h"
53 #include "DNA_material_types.h"
54 #include "DNA_userdef_types.h"
55 #include "DNA_gpencil_types.h"
56 #include "DNA_windowmanager_types.h"
57
58 #include "RNA_access.h"
59 #include "RNA_define.h"
60
61 #include "BKE_action.h"
62 #include "BKE_depsgraph.h"
63 #include "BKE_fcurve.h"
64 #include "BKE_key.h"
65 #include "BKE_material.h"
66 #include "BKE_nla.h"
67 #include "BKE_object.h"
68 #include "BKE_context.h"
69 #include "BKE_utildefines.h"
70
71 #include "UI_view2d.h"
72
73 #include "ED_anim_api.h"
74 #include "ED_keyframing.h"
75 #include "ED_keyframes_draw.h"
76 #include "ED_keyframes_edit.h"
77 #include "ED_markers.h"
78 #include "ED_screen.h"
79 #include "ED_space_api.h"
80
81 #include "WM_api.h"
82 #include "WM_types.h"
83
84 #include "graph_intern.h"
85
86
87 /* ************************************************************************** */
88 /* KEYFRAMES STUFF */
89
90 /* ******************** Deselect All Operator ***************************** */
91 /* This operator works in one of three ways:
92  *      1) (de)select all (AKEY) - test if select all or deselect all
93  *      2) invert all (CTRL-IKEY) - invert selection of all keyframes
94  *      3) (de)select all - no testing is done; only for use internal tools as normal function...
95  */
96
97 /* Deselects keyframes in the Graph Editor
98  *      - This is called by the deselect all operator, as well as other ones!
99  *
100  *      - test: check if select or deselect all
101  *      - sel: how to select keyframes 
102  *              0 = deselect
103  *              1 = select
104  *              2 = invert
105  */
106 static void deselect_graph_keys (bAnimContext *ac, short test, short sel)
107 {
108         ListBase anim_data = {NULL, NULL};
109         bAnimListElem *ale;
110         int filter;
111         
112         BeztEditData bed;
113         BeztEditFunc test_cb, sel_cb;
114         
115         /* determine type-based settings */
116         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
117         
118         /* filter data */
119         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
120         
121         /* init BezTriple looping data */
122         memset(&bed, 0, sizeof(BeztEditData));
123         test_cb= ANIM_editkeyframes_ok(BEZT_OK_SELECTED);
124         
125         /* See if we should be selecting or deselecting */
126         if (test) {
127                 for (ale= anim_data.first; ale; ale= ale->next) {
128                         if (ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, test_cb, NULL)) {
129                                 sel= SELECT_SUBTRACT;
130                                 break;
131                         }
132                 }
133         }
134         
135         /* convert sel to selectmode, and use that to get editor */
136         sel_cb= ANIM_editkeyframes_select(sel);
137         
138         /* Now set the flags */
139         for (ale= anim_data.first; ale; ale= ale->next) {
140                 FCurve *fcu= (FCurve *)ale->key_data;
141                 
142                 /* Keyframes First */
143                 ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, sel_cb, NULL);
144                 
145                 /* deactivate the F-Curve, and deselect if deselecting keyframes */
146                 if (sel == SELECT_SUBTRACT) 
147                         fcu->flag &= ~FCURVE_SELECTED;
148                 fcu->flag &= ~FCURVE_ACTIVE;
149         }
150         
151         /* Cleanup */
152         BLI_freelistN(&anim_data);
153 }
154
155 /* ------------------- */
156
157 static int graphkeys_deselectall_exec(bContext *C, wmOperator *op)
158 {
159         bAnimContext ac;
160         
161         /* get editor data */
162         if (ANIM_animdata_get_context(C, &ac) == 0)
163                 return OPERATOR_CANCELLED;
164                 
165         /* 'standard' behaviour - check if selected, then apply relevant selection */
166         if (RNA_boolean_get(op->ptr, "invert"))
167                 deselect_graph_keys(&ac, 0, SELECT_INVERT);
168         else
169                 deselect_graph_keys(&ac, 1, SELECT_ADD);
170         
171         /* set notifier that things have changed */
172         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
173         
174         return OPERATOR_FINISHED;
175 }
176  
177 void GRAPH_OT_select_all_toggle (wmOperatorType *ot)
178 {
179         /* identifiers */
180         ot->name= "Select All";
181         ot->idname= "GRAPH_OT_select_all_toggle";
182         ot->description= "Toggle selection of all keyframes.";
183         
184         /* api callbacks */
185         ot->exec= graphkeys_deselectall_exec;
186         ot->poll= graphop_visible_keyframes_poll;
187         
188         /* flags */
189         ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
190         
191         /* props */
192         RNA_def_boolean(ot->srna, "invert", 0, "Invert", "");
193 }
194
195 /* ******************** Border Select Operator **************************** */
196 /* This operator currently works in one of three ways:
197  *      -> BKEY         - 1) all keyframes within region are selected (validation with BEZT_OK_REGION)
198  *      -> ALT-BKEY - depending on which axis of the region was larger...
199  *              -> 2) x-axis, so select all frames within frame range (validation with BEZT_OK_FRAMERANGE)
200  *              -> 3) y-axis, so select all frames within channels that region included (validation with BEZT_OK_VALUERANGE)
201  */
202
203 /* Borderselect only selects keyframes now, as overshooting handles often get caught too,
204  * which means that they may be inadvertantly moved as well.
205  * Also, for convenience, handles should get same status as keyframe (if it was within bounds)
206  */
207 static void borderselect_graphkeys (bAnimContext *ac, rcti rect, short mode, short selectmode)
208 {
209         ListBase anim_data = {NULL, NULL};
210         bAnimListElem *ale;
211         int filter;
212         
213         BeztEditData bed;
214         BeztEditFunc ok_cb, select_cb;
215         View2D *v2d= &ac->ar->v2d;
216         rctf rectf;
217         
218         /* convert mouse coordinates to frame ranges and channel coordinates corrected for view pan/zoom */
219         UI_view2d_region_to_view(v2d, rect.xmin, rect.ymin, &rectf.xmin, &rectf.ymin);
220         UI_view2d_region_to_view(v2d, rect.xmax, rect.ymax, &rectf.xmax, &rectf.ymax);
221         
222         /* filter data */
223         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY | ANIMFILTER_CURVEVISIBLE);
224         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
225         
226         /* get beztriple editing/validation funcs  */
227         select_cb= ANIM_editkeyframes_select(selectmode);
228         ok_cb= ANIM_editkeyframes_ok(mode);
229         
230         /* init editing data */
231         memset(&bed, 0, sizeof(BeztEditData));
232         bed.data= &rectf;
233         
234         /* loop over data, doing border select */
235         for (ale= anim_data.first; ale; ale= ale->next) {
236                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
237                 
238                 /* set horizontal range (if applicable) */
239                 if (mode != BEZT_OK_VALUERANGE) {
240                         /* if channel is mapped in NLA, apply correction */
241                         if (adt) {
242                                 bed.f1= BKE_nla_tweakedit_remap(adt, rectf.xmin, NLATIME_CONVERT_UNMAP);
243                                 bed.f2= BKE_nla_tweakedit_remap(adt, rectf.xmax, NLATIME_CONVERT_UNMAP);
244                         }
245                         else {
246                                 bed.f1= rectf.xmin;
247                                 bed.f2= rectf.xmax;
248                         }
249                 }
250                 else {
251                         bed.f1= rectf.ymin;
252                         bed.f2= rectf.ymax;
253                 }
254                 
255                 /* select keyframes that are in the appropriate places */
256                 ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
257         }
258         
259         /* cleanup */
260         BLI_freelistN(&anim_data);
261 }
262
263 /* ------------------- */
264
265 static int graphkeys_borderselect_exec(bContext *C, wmOperator *op)
266 {
267         bAnimContext ac;
268         rcti rect;
269         short mode=0, selectmode=0;
270         int event;
271         
272         /* get editor data */
273         if (ANIM_animdata_get_context(C, &ac) == 0)
274                 return OPERATOR_CANCELLED;
275         
276         /* get settings from operator */
277         rect.xmin= RNA_int_get(op->ptr, "xmin");
278         rect.ymin= RNA_int_get(op->ptr, "ymin");
279         rect.xmax= RNA_int_get(op->ptr, "xmax");
280         rect.ymax= RNA_int_get(op->ptr, "ymax");
281                 
282         event= RNA_int_get(op->ptr, "event_type");
283         if (event == LEFTMOUSE) // FIXME... hardcoded
284                 selectmode = SELECT_ADD;
285         else
286                 selectmode = SELECT_SUBTRACT;
287         
288         /* selection 'mode' depends on whether borderselect region only matters on one axis */
289         if (RNA_boolean_get(op->ptr, "axis_range")) {
290                 /* mode depends on which axis of the range is larger to determine which axis to use 
291                  *      - checking this in region-space is fine, as it's fundamentally still going to be a different rect size
292                  *      - the frame-range select option is favoured over the channel one (x over y), as frame-range one is often
293                  *        used for tweaking timing when "blocking", while channels is not that useful...
294                  */
295                 if ((rect.xmax - rect.xmin) >= (rect.ymax - rect.ymin))
296                         mode= BEZT_OK_FRAMERANGE;
297                 else
298                         mode= BEZT_OK_VALUERANGE;
299         }
300         else 
301                 mode= BEZT_OK_REGION;
302         
303         /* apply borderselect action */
304         borderselect_graphkeys(&ac, rect, mode, selectmode);
305         
306         /* send notifier that keyframe selection has changed */
307         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
308         
309         return OPERATOR_FINISHED;
310
311
312 void GRAPH_OT_select_border(wmOperatorType *ot)
313 {
314         /* identifiers */
315         ot->name= "Border Select";
316         ot->idname= "GRAPH_OT_select_border";
317         ot->description= "Select all keyframes within the specified region.";
318         
319         /* api callbacks */
320         ot->invoke= WM_border_select_invoke;
321         ot->exec= graphkeys_borderselect_exec;
322         ot->modal= WM_border_select_modal;
323         
324         ot->poll= graphop_visible_keyframes_poll;
325         
326         /* flags */
327         ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
328         
329         /* rna */
330         RNA_def_int(ot->srna, "event_type", 0, INT_MIN, INT_MAX, "Event Type", "", INT_MIN, INT_MAX);
331         RNA_def_int(ot->srna, "xmin", 0, INT_MIN, INT_MAX, "X Min", "", INT_MIN, INT_MAX);
332         RNA_def_int(ot->srna, "xmax", 0, INT_MIN, INT_MAX, "X Max", "", INT_MIN, INT_MAX);
333         RNA_def_int(ot->srna, "ymin", 0, INT_MIN, INT_MAX, "Y Min", "", INT_MIN, INT_MAX);
334         RNA_def_int(ot->srna, "ymax", 0, INT_MIN, INT_MAX, "Y Max", "", INT_MIN, INT_MAX);
335         
336         RNA_def_boolean(ot->srna, "axis_range", 0, "Axis Range", "");
337 }
338
339 /* ******************** Column Select Operator **************************** */
340 /* This operator works in one of four ways:
341  *      - 1) select all keyframes in the same frame as a selected one  (KKEY)
342  *      - 2) select all keyframes in the same frame as the current frame marker (CTRL-KKEY)
343  *      - 3) select all keyframes in the same frame as a selected markers (SHIFT-KKEY)
344  *      - 4) select all keyframes that occur between selected markers (ALT-KKEY)
345  */
346
347 /* defines for column-select mode */
348 static EnumPropertyItem prop_column_select_types[] = {
349         {GRAPHKEYS_COLUMNSEL_KEYS, "KEYS", 0, "On Selected Keyframes", ""},
350         {GRAPHKEYS_COLUMNSEL_CFRA, "CFRA", 0, "On Current Frame", ""},
351         {GRAPHKEYS_COLUMNSEL_MARKERS_COLUMN, "MARKERS_COLUMN", 0, "On Selected Markers", ""},
352         {GRAPHKEYS_COLUMNSEL_MARKERS_BETWEEN, "MARKERS_BETWEEN", 0, "Between Min/Max Selected Markers", ""},
353         {0, NULL, 0, NULL, NULL}
354 };
355
356 /* ------------------- */ 
357
358 /* Selects all visible keyframes between the specified markers */
359 static void markers_selectkeys_between (bAnimContext *ac)
360 {
361         ListBase anim_data = {NULL, NULL};
362         bAnimListElem *ale;
363         int filter;
364         
365         BeztEditFunc ok_cb, select_cb;
366         BeztEditData bed;
367         float min, max;
368         
369         /* get extreme markers */
370         ED_markers_get_minmax(ac->markers, 1, &min, &max);
371         min -= 0.5f;
372         max += 0.5f;
373         
374         /* get editing funcs + data */
375         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
376         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
377         
378         memset(&bed, 0, sizeof(BeztEditData));
379         bed.f1= min; 
380         bed.f2= max;
381         
382         /* filter data */
383         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
384         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
385         
386         /* select keys in-between */
387         for (ale= anim_data.first; ale; ale= ale->next) {
388                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
389                 
390                 if (adt) {      
391                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
392                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
393                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
394                 }
395                 else {
396                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
397                 }
398         }
399         
400         /* Cleanup */
401         BLI_freelistN(&anim_data);
402 }
403
404
405 /* Selects all visible keyframes in the same frames as the specified elements */
406 static void columnselect_graph_keys (bAnimContext *ac, short mode)
407 {
408         ListBase anim_data= {NULL, NULL};
409         bAnimListElem *ale;
410         int filter;
411         
412         Scene *scene= ac->scene;
413         CfraElem *ce;
414         BeztEditFunc select_cb, ok_cb;
415         BeztEditData bed;
416         
417         /* initialise keyframe editing data */
418         memset(&bed, 0, sizeof(BeztEditData));
419         
420         /* build list of columns */
421         switch (mode) {
422                 case GRAPHKEYS_COLUMNSEL_KEYS: /* list of selected keys */
423                         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
424                         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
425                         
426                         for (ale= anim_data.first; ale; ale= ale->next)
427                                 ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, bezt_to_cfraelem, NULL);
428                         
429                         BLI_freelistN(&anim_data);
430                         break;
431                         
432                 case GRAPHKEYS_COLUMNSEL_CFRA: /* current frame */
433                         /* make a single CfraElem for storing this */
434                         ce= MEM_callocN(sizeof(CfraElem), "cfraElem");
435                         BLI_addtail(&bed.list, ce);
436                         
437                         ce->cfra= (float)CFRA;
438                         break;
439                         
440                 case GRAPHKEYS_COLUMNSEL_MARKERS_COLUMN: /* list of selected markers */
441                         ED_markers_make_cfra_list(ac->markers, &bed.list, 1);
442                         break;
443                         
444                 default: /* invalid option */
445                         return;
446         }
447         
448         /* set up BezTriple edit callbacks */
449         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
450         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
451         
452         /* loop through all of the keys and select additional keyframes
453          * based on the keys found to be selected above
454          */
455         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
456         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
457         
458         for (ale= anim_data.first; ale; ale= ale->next) {
459                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
460                 
461                 /* loop over cfraelems (stored in the BeztEditData->list)
462                  *      - we need to do this here, as we can apply fewer NLA-mapping conversions
463                  */
464                 for (ce= bed.list.first; ce; ce= ce->next) {
465                         /* set frame for validation callback to refer to */
466                         if (ale)
467                                 bed.f1= BKE_nla_tweakedit_remap(adt, ce->cfra, NLATIME_CONVERT_UNMAP);
468                         else
469                                 bed.f1= ce->cfra;
470                         
471                         /* select elements with frame number matching cfraelem */
472                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
473                 }
474         }
475         
476         /* free elements */
477         BLI_freelistN(&bed.list);
478         BLI_freelistN(&anim_data);
479 }
480
481 /* ------------------- */
482
483 static int graphkeys_columnselect_exec(bContext *C, wmOperator *op)
484 {
485         bAnimContext ac;
486         short mode;
487         
488         /* get editor data */
489         if (ANIM_animdata_get_context(C, &ac) == 0)
490                 return OPERATOR_CANCELLED;
491                 
492         /* action to take depends on the mode */
493         mode= RNA_enum_get(op->ptr, "mode");
494         
495         if (mode == GRAPHKEYS_COLUMNSEL_MARKERS_BETWEEN)
496                 markers_selectkeys_between(&ac);
497         else
498                 columnselect_graph_keys(&ac, mode);
499         
500         /* set notifier that keyframe selection has changed */
501         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
502         
503         return OPERATOR_FINISHED;
504 }
505  
506 void GRAPH_OT_select_column (wmOperatorType *ot)
507 {
508         /* identifiers */
509         ot->name= "Select All";
510         ot->idname= "GRAPH_OT_select_column";
511         ot->description= "Select all keyframes on the specified frame(s).";
512         
513         /* api callbacks */
514         ot->exec= graphkeys_columnselect_exec;
515         ot->poll= graphop_visible_keyframes_poll;
516         
517         /* flags */
518         ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
519         
520         /* props */
521         RNA_def_enum(ot->srna, "mode", prop_column_select_types, 0, "Mode", "");
522 }
523
524 /* ******************** Mouse-Click Select Operator *********************** */
525 /* This operator works in one of three ways:
526  *      - 1) keyframe under mouse - no special modifiers
527  *      - 2) all keyframes on the same side of current frame indicator as mouse - ALT modifier
528  *      - 3) column select all keyframes in frame under mouse - CTRL modifier
529  *
530  * In addition to these basic options, the SHIFT modifier can be used to toggle the 
531  * selection mode between replacing the selection (without) and inverting the selection (with).
532  */
533
534 /* defines for left-right select tool */
535 static EnumPropertyItem prop_graphkeys_leftright_select_types[] = {
536         {GRAPHKEYS_LRSEL_TEST, "CHECK", 0, "Check if Select Left or Right", ""},
537         {GRAPHKEYS_LRSEL_NONE, "OFF", 0, "Don't select", ""},
538         {GRAPHKEYS_LRSEL_LEFT, "LEFT", 0, "Before current frame", ""},
539         {GRAPHKEYS_LRSEL_RIGHT, "RIGHT", 0, "After current frame", ""},
540         {0, NULL, 0, NULL, NULL}
541 };
542
543 /* ------------------- */
544
545 enum {
546         NEAREST_HANDLE_LEFT     = 0,
547         NEAREST_HANDLE_KEY,
548         NEAREST_HANDLE_RIGHT
549 } eHandleIndex; 
550  
551 /* Find the vertex (either handle (0/2) or the keyframe (1)) that is nearest to the mouse cursor (in area coordinates)  
552  * Selected verts get a disadvantage, to make it easier to select handles behind.
553  * Returns eHandleIndex
554  */
555 static short findnearest_fcurve_vert (bAnimContext *ac, int mval[2], FCurve **fcurve, BezTriple **bezt)
556 {
557         ListBase anim_data = {NULL, NULL};
558         bAnimListElem *ale;
559         int filter;
560         
561         SpaceIpo *sipo= (SpaceIpo *)ac->sa->spacedata.first;
562         View2D *v2d= &ac->ar->v2d;
563         int hpoint=0, sco[3][2];
564         int dist= 100, temp, i;
565         
566         /* clear pointers first */
567         *fcurve= 0;
568         *bezt= 0;
569         
570         /* get curves to search through */
571         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
572         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
573         
574         for (ale= anim_data.first; ale; ale= ale->next) {
575                 FCurve *fcu= (FCurve *)ale->key_data;
576                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
577                 
578                 /* try to progressively get closer to the right point... */
579                 if (fcu->bezt) {
580                         BezTriple *bezt1=fcu->bezt, *prevbezt=NULL;
581                         
582                         /* apply NLA mapping to all the keyframes */
583                         if (adt)
584                                 ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
585                         
586                         for (i=0; i < fcu->totvert; i++, prevbezt=bezt1, bezt1++) {
587                                 /* convert beztriple points to screen-space */
588                                 UI_view2d_to_region_no_clip(v2d, bezt1->vec[0][0], bezt1->vec[0][1], &sco[0][0], &sco[0][1]);
589                                 UI_view2d_to_region_no_clip(v2d, bezt1->vec[1][0], bezt1->vec[1][1], &sco[1][0], &sco[1][1]);
590                                 UI_view2d_to_region_no_clip(v2d, bezt1->vec[2][0], bezt1->vec[2][1], &sco[2][0], &sco[2][1]);
591                                 
592                                 /* keyframe - do select? */
593                                 temp= abs(mval[0] - sco[1][0]) + abs(mval[1] - sco[1][1]);
594                                 
595                                 if (bezt1->f2 & SELECT) 
596                                         temp += 5;
597                                 
598                                 if (temp < dist) { 
599                                         hpoint= NEAREST_HANDLE_KEY; 
600                                         *bezt= bezt1; 
601                                         dist= temp; 
602                                         *fcurve= fcu; 
603                                 }
604                                 
605                                 /* handles - only do them if they're visible */
606                                 // XXX also need to check for int-values only?
607                                 if ((sipo->flag & SIPO_NOHANDLES)==0) {
608                                         /* first handle only visible if previous segment had handles */
609                                         if ( (!prevbezt && (bezt1->ipo==BEZT_IPO_BEZ)) || (prevbezt && (prevbezt->ipo==BEZT_IPO_BEZ)) )
610                                         {
611                                                 temp= -3 + abs(mval[0] - sco[0][0]) + abs(mval[1] - sco[0][1]);
612                                                 if (bezt1->f1 & SELECT) 
613                                                         temp += 5;
614                                                         
615                                                 if (temp < dist) { 
616                                                         hpoint= NEAREST_HANDLE_LEFT; 
617                                                         *bezt= bezt1; 
618                                                         dist= temp; 
619                                                         *fcurve= fcu; 
620                                                 }
621                                         }
622                                         
623                                         /* second handle only visible if this segment is bezier */
624                                         if (bezt1->ipo == BEZT_IPO_BEZ) 
625                                         {
626                                                 temp= abs(mval[0] - sco[2][0]) + abs(mval[1] - sco[2][1]);
627                                                 if (bezt1->f3 & SELECT) 
628                                                         temp += 5;
629                                                 
630                                                 if (temp < dist) { 
631                                                         hpoint= NEAREST_HANDLE_RIGHT; 
632                                                         *bezt=bezt1; 
633                                                         dist= temp; 
634                                                         *fcurve= fcu; 
635                                                 }
636                                         }
637                                 }
638                         }
639                         
640                         /* un-apply NLA mapping from all the keyframes */
641                         if (adt)
642                                 ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
643                 }
644         }
645         
646         /* free channels */
647         BLI_freelistN(&anim_data);
648         
649         /* return handle */
650         return hpoint;
651 }
652  
653 /* option 1) select keyframe directly under mouse */
654 static void mouse_graph_keys (bAnimContext *ac, int mval[], short select_mode, short curves_only)
655 {
656         FCurve *fcu;
657         BezTriple *bezt;
658         short handle;
659         int filter;
660         
661         /* find the beztriple that we're selecting, and the handle that was clicked on */
662         handle= findnearest_fcurve_vert(ac, mval, &fcu, &bezt);
663         
664         /* check if anything to select */
665         if (fcu == NULL)        
666                 return;
667         
668         /* deselect all other curves? */
669         if (select_mode == SELECT_REPLACE) {
670                 /* reset selection mode */
671                 select_mode= SELECT_ADD;
672                 
673                 /* deselect all other channels and keyframes */
674                 //ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
675                 deselect_graph_keys(ac, 0, SELECT_SUBTRACT);
676         }
677         
678         /* if points can be selected on this F-Curve */
679         // TODO: what about those with no keyframes?
680         if ((curves_only == 0) && ((fcu->flag & FCURVE_PROTECTED)==0)) {
681                 /* only if there's keyframe */
682                 if (bezt) {
683                         /* depends on selection mode */
684                         if (select_mode == SELECT_INVERT) {
685                                 /* keyframe - invert select of all */
686                                 if (handle == NEAREST_HANDLE_KEY) {
687                                         if (BEZSELECTED(bezt)) {
688                                                 BEZ_DESEL(bezt);
689                                         }
690                                         else {
691                                                 BEZ_SEL(bezt);
692                                         }
693                                 }
694                                 
695                                 /* handles - toggle selection of relevant handle */
696                                 else if (handle == NEAREST_HANDLE_LEFT) {
697                                         /* toggle selection */
698                                         bezt->f1 ^= SELECT;
699                                 }
700                                 else {
701                                         /* toggle selection */
702                                         bezt->f3 ^= SELECT;
703                                 }
704                         }
705                         else {
706                                 /* if the keyframe was clicked on, select all verts of given beztriple */
707                                 if (handle == NEAREST_HANDLE_KEY) {
708                                         BEZ_SEL(bezt);
709                                 }
710                                 /* otherwise, select the handle that applied */
711                                 else if (handle == NEAREST_HANDLE_LEFT) 
712                                         bezt->f1 |= SELECT;
713                                 else 
714                                         bezt->f3 |= SELECT;
715                         }
716                 }
717         }
718         else {
719                 BeztEditFunc select_cb;
720                 BeztEditData bed;
721         
722                 /* initialise keyframe editing data */
723                 memset(&bed, 0, sizeof(BeztEditData));
724                 
725                 /* set up BezTriple edit callbacks */
726                 select_cb= ANIM_editkeyframes_select(select_mode);
727                 
728                 /* select all keyframes */
729                 ANIM_fcurve_keys_bezier_loop(&bed, fcu, NULL, select_cb, NULL);
730         }
731         
732         /* select or deselect curve? */
733         if (select_mode == SELECT_INVERT)
734                 fcu->flag ^= FCURVE_SELECTED;
735         else if (select_mode == SELECT_ADD)
736                 fcu->flag |= FCURVE_SELECTED;
737                 
738         /* set active F-Curve (NOTE: sync the filter flags with findnearest_fcurve_vert) */
739         if (fcu->flag & FCURVE_SELECTED) {
740                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
741                 ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, fcu, ANIMTYPE_FCURVE);
742         }
743 }
744
745 /* Option 2) Selects all the keyframes on either side of the current frame (depends on which side the mouse is on) */
746 static void graphkeys_mselect_leftright (bAnimContext *ac, short leftright, short select_mode)
747 {
748         ListBase anim_data = {NULL, NULL};
749         bAnimListElem *ale;
750         int filter;
751         
752         BeztEditFunc ok_cb, select_cb;
753         BeztEditData bed;
754         Scene *scene= ac->scene;
755         
756         /* if select mode is replace, deselect all keyframes (and channels) first */
757         if (select_mode==SELECT_REPLACE) {
758                 /* reset selection mode to add to selection */
759                 select_mode= SELECT_ADD;
760                 
761                 /* deselect all other channels and keyframes */
762                 ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
763                 deselect_graph_keys(ac, 0, SELECT_SUBTRACT);
764         }
765         
766         /* set callbacks and editing data */
767         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
768         select_cb= ANIM_editkeyframes_select(select_mode);
769         
770         memset(&bed, 0, sizeof(BeztEditFunc));
771         if (leftright == GRAPHKEYS_LRSEL_LEFT) {
772                 bed.f1 = MINAFRAMEF;
773                 bed.f2 = (float)(CFRA + 0.1f);
774         } 
775         else {
776                 bed.f1 = (float)(CFRA - 0.1f);
777                 bed.f2 = MAXFRAMEF;
778         }
779         
780         /* filter data */
781         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
782         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
783                 
784         /* select keys on the side where most data occurs */
785         for (ale= anim_data.first; ale; ale= ale->next) {
786                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
787                 
788                 if (adt) {
789                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
790                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
791                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
792                 }
793                 else
794                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
795         }
796         
797         /* Cleanup */
798         BLI_freelistN(&anim_data);
799 }
800
801 /* Option 3) Selects all visible keyframes in the same frame as the mouse click */
802 static void graphkeys_mselect_column (bAnimContext *ac, int mval[2], short select_mode)
803 {
804         ListBase anim_data= {NULL, NULL};
805         bAnimListElem *ale;
806         int filter;
807         
808         BeztEditFunc select_cb, ok_cb;
809         BeztEditData bed;
810         FCurve *fcu;
811         BezTriple *bezt;
812         float selx = (float)ac->scene->r.cfra;
813         
814         /* find the beztriple that occurs on this frame, and use his as the frame number we're using */
815         findnearest_fcurve_vert(ac, mval, &fcu, &bezt);
816         
817         /* check if anything to select */
818         if (ELEM(NULL, fcu, bezt))      
819                 return;
820         selx= bezt->vec[1][0];
821         
822         /* if select mode is replace, deselect all keyframes (and channels) first */
823         if (select_mode==SELECT_REPLACE) {
824                 /* reset selection mode to add to selection */
825                 select_mode= SELECT_ADD;
826                 
827                 /* deselect all other channels and keyframes */
828                 ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
829                 deselect_graph_keys(ac, 0, SELECT_SUBTRACT);
830         }
831         
832         /* initialise keyframe editing data */
833         memset(&bed, 0, sizeof(BeztEditData));
834         
835         /* set up BezTriple edit callbacks */
836         select_cb= ANIM_editkeyframes_select(select_mode);
837         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
838         
839         /* loop through all of the keys and select additional keyframes
840          * based on the keys found to be selected above
841          */
842         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
843         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
844         
845         for (ale= anim_data.first; ale; ale= ale->next) {
846                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
847                 
848                 /* set frame for validation callback to refer to */
849                 if (adt)
850                         bed.f1= BKE_nla_tweakedit_remap(adt, selx, NLATIME_CONVERT_UNMAP);
851                 else
852                         bed.f1= selx;
853                 
854                 /* select elements with frame number matching cfra */
855                 ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
856         }
857         
858         /* free elements */
859         BLI_freelistN(&bed.list);
860         BLI_freelistN(&anim_data);
861 }
862  
863 /* ------------------- */
864
865 /* handle clicking */
866 static int graphkeys_clickselect_invoke(bContext *C, wmOperator *op, wmEvent *event)
867 {
868         bAnimContext ac;
869         Scene *scene;
870         ARegion *ar;
871         View2D *v2d;
872         short selectmode;
873         int mval[2];
874         
875         /* get editor data */
876         if (ANIM_animdata_get_context(C, &ac) == 0)
877                 return OPERATOR_CANCELLED;
878         
879         /* get useful pointers from animation context data */
880         scene= ac.scene;
881         ar= ac.ar;
882         v2d= &ar->v2d;
883         
884         /* get mouse coordinates (in region coordinates) */
885         mval[0]= (event->x - ar->winrct.xmin);
886         mval[1]= (event->y - ar->winrct.ymin);
887         
888         /* select mode is either replace (deselect all, then add) or add/extend */
889         if (RNA_boolean_get(op->ptr, "extend"))
890                 selectmode= SELECT_INVERT;
891         else
892                 selectmode= SELECT_REPLACE;
893         
894         /* figure out action to take */
895         if (RNA_enum_get(op->ptr, "left_right")) {
896                 /* select all keys on same side of current frame as mouse */
897                 float x;
898                 
899                 UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, NULL);
900                 if (x < CFRA)
901                         RNA_int_set(op->ptr, "left_right", GRAPHKEYS_LRSEL_LEFT);
902                 else    
903                         RNA_int_set(op->ptr, "left_right", GRAPHKEYS_LRSEL_RIGHT);
904                 
905                 graphkeys_mselect_leftright(&ac, RNA_enum_get(op->ptr, "left_right"), selectmode);
906         }
907         else if (RNA_boolean_get(op->ptr, "column")) {
908                 /* select all keyframes in the same frame as the one that was under the mouse */
909                 graphkeys_mselect_column(&ac, mval, selectmode);
910         }
911         else if (RNA_boolean_get(op->ptr, "curves")) {
912                 /* select all keyframes in F-Curve under mouse */
913                 mouse_graph_keys(&ac, mval, selectmode, 1);
914         }
915         else {
916                 /* select keyframe under mouse */
917                 mouse_graph_keys(&ac, mval, selectmode, 0);
918         }
919         
920         /* set notifier that keyframe selection (and also channel selection in some cases) has changed */
921         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT|ND_ANIMCHAN_SELECT, NULL);
922         
923         /* for tweak grab to work */
924         return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
925 }
926  
927 void GRAPH_OT_clickselect (wmOperatorType *ot)
928 {
929         /* identifiers */
930         ot->name= "Mouse Select Keys";
931         ot->idname= "GRAPH_OT_clickselect";
932         ot->description= "Select keyframes by clicking on them.";
933         
934         /* api callbacks */
935         ot->invoke= graphkeys_clickselect_invoke;
936         ot->poll= graphop_visible_keyframes_poll;
937         
938         /* id-props */
939         // XXX should we make this into separate operators?
940         RNA_def_enum(ot->srna, "left_right", prop_graphkeys_leftright_select_types, 0, "Left Right", ""); // CTRLKEY
941         RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", ""); // SHIFTKEY
942         RNA_def_boolean(ot->srna, "column", 0, "Column Select", "Select all keyframes that occur on the same frame as the one under the mouse"); // ALTKEY
943         RNA_def_boolean(ot->srna, "curves", 0, "Only Curves", "Select all the keyframes in the curve"); // CTRLKEY + ALTKEY
944 }
945
946 /* ************************************************************************** */