svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22205:22290
[blender.git] / source / blender / editors / space_action / action_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 #include "BLI_dlrbTree.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_action_types.h"
44 #include "DNA_armature_types.h"
45 #include "DNA_camera_types.h"
46 #include "DNA_curve_types.h"
47 #include "DNA_object_types.h"
48 #include "DNA_screen_types.h"
49 #include "DNA_scene_types.h"
50 #include "DNA_space_types.h"
51 #include "DNA_constraint_types.h"
52 #include "DNA_key_types.h"
53 #include "DNA_lamp_types.h"
54 #include "DNA_material_types.h"
55 #include "DNA_userdef_types.h"
56 #include "DNA_gpencil_types.h"
57 #include "DNA_windowmanager_types.h"
58 #include "DNA_world_types.h"
59
60 #include "RNA_access.h"
61 #include "RNA_define.h"
62
63 #include "BKE_action.h"
64 #include "BKE_depsgraph.h"
65 #include "BKE_fcurve.h"
66 #include "BKE_key.h"
67 #include "BKE_material.h"
68 #include "BKE_nla.h"
69 #include "BKE_object.h"
70 #include "BKE_context.h"
71 #include "BKE_utildefines.h"
72
73 #include "UI_view2d.h"
74
75 #include "ED_anim_api.h"
76 #include "ED_keyframing.h"
77 #include "ED_keyframes_draw.h"
78 #include "ED_keyframes_edit.h"
79 #include "ED_markers.h"
80 #include "ED_screen.h"
81 #include "ED_space_api.h"
82
83 #include "WM_api.h"
84 #include "WM_types.h"
85
86 #include "action_intern.h"
87
88 /* ************************************************************************** */
89 /* KEYFRAMES STUFF */
90
91 /* ******************** Deselect All Operator ***************************** */
92 /* This operator works in one of three ways:
93  *      1) (de)select all (AKEY) - test if select all or deselect all
94  *      2) invert all (CTRL-IKEY) - invert selection of all keyframes
95  *      3) (de)select all - no testing is done; only for use internal tools as normal function...
96  */
97
98 /* Deselects keyframes in the action editor
99  *      - This is called by the deselect all operator, as well as other ones!
100  *
101  *      - test: check if select or deselect all
102  *      - sel: how to select keyframes 
103  *              0 = deselect
104  *              1 = select
105  *              2 = invert
106  */
107 static void deselect_action_keys (bAnimContext *ac, short test, short sel)
108 {
109         ListBase anim_data = {NULL, NULL};
110         bAnimListElem *ale;
111         int filter;
112         
113         BeztEditData bed;
114         BeztEditFunc test_cb, sel_cb;
115         
116         /* determine type-based settings */
117         if (ac->datatype == ANIMCONT_GPENCIL)
118                 filter= (ANIMFILTER_VISIBLE);
119         else
120                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
121         
122         /* filter data */
123         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
124         
125         /* init BezTriple looping data */
126         memset(&bed, 0, sizeof(BeztEditData));
127         test_cb= ANIM_editkeyframes_ok(BEZT_OK_SELECTED);
128         
129         /* See if we should be selecting or deselecting */
130         if (test) {
131                 for (ale= anim_data.first; ale; ale= ale->next) {
132                         if (ale->type == ANIMTYPE_GPLAYER) {
133                                 //if (is_gplayer_frame_selected(ale->data)) {
134                                 //      sel= 0;
135                                 //      break;
136                                 //}
137                         }
138                         else {
139                                 if (ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, test_cb, NULL)) {
140                                         sel= SELECT_SUBTRACT;
141                                         break;
142                                 }
143                         }
144                 }
145         }
146         
147         /* convert sel to selectmode, and use that to get editor */
148         sel_cb= ANIM_editkeyframes_select(sel);
149         
150         /* Now set the flags */
151         for (ale= anim_data.first; ale; ale= ale->next) {
152                 //if (ale->type == ACTTYPE_GPLAYER)
153                 //      set_gplayer_frame_selection(ale->data, sel);
154                 //else
155                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, sel_cb, NULL);
156         }
157         
158         /* Cleanup */
159         BLI_freelistN(&anim_data);
160 }
161
162 /* ------------------- */
163
164 static int actkeys_deselectall_exec(bContext *C, wmOperator *op)
165 {
166         bAnimContext ac;
167         
168         /* get editor data */
169         if (ANIM_animdata_get_context(C, &ac) == 0)
170                 return OPERATOR_CANCELLED;
171                 
172         /* 'standard' behaviour - check if selected, then apply relevant selection */
173         if (RNA_boolean_get(op->ptr, "invert"))
174                 deselect_action_keys(&ac, 0, SELECT_INVERT);
175         else
176                 deselect_action_keys(&ac, 1, SELECT_ADD);
177         
178         /* set notifier that keyframe selection have changed */
179         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
180         
181         return OPERATOR_FINISHED;
182 }
183  
184 void ACT_OT_select_all_toggle (wmOperatorType *ot)
185 {
186         /* identifiers */
187         ot->name= "Select All";
188         ot->idname= "ACT_OT_select_all_toggle";
189         ot->description= "Toggle selection of all keyframes.";
190         
191         /* api callbacks */
192         ot->exec= actkeys_deselectall_exec;
193         ot->poll= ED_operator_action_active;
194         
195         /* flags */
196         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
197         
198         /* props */
199         RNA_def_boolean(ot->srna, "invert", 0, "Invert", "");
200 }
201
202 /* ******************** Border Select Operator **************************** */
203 /* This operator currently works in one of three ways:
204  *      -> BKEY         - 1) all keyframes within region are selected (ACTKEYS_BORDERSEL_ALLKEYS)
205  *      -> ALT-BKEY - depending on which axis of the region was larger...
206  *              -> 2) x-axis, so select all frames within frame range (ACTKEYS_BORDERSEL_FRAMERANGE)
207  *              -> 3) y-axis, so select all frames within channels that region included (ACTKEYS_BORDERSEL_CHANNELS)
208  */
209
210 /* defines for borderselect mode */
211 enum {
212         ACTKEYS_BORDERSEL_ALLKEYS       = 0,
213         ACTKEYS_BORDERSEL_FRAMERANGE,
214         ACTKEYS_BORDERSEL_CHANNELS,
215 } eActKeys_BorderSelect_Mode;
216
217
218 static void borderselect_action (bAnimContext *ac, rcti rect, short mode, short selectmode)
219 {
220         ListBase anim_data = {NULL, NULL};
221         bAnimListElem *ale;
222         int filter;
223         
224         BeztEditData bed;
225         BeztEditFunc ok_cb, select_cb;
226         View2D *v2d= &ac->ar->v2d;
227         rctf rectf;
228         float ymin=0, ymax=(float)(-ACHANNEL_HEIGHT_HALF);
229         
230         /* convert mouse coordinates to frame ranges and channel coordinates corrected for view pan/zoom */
231         UI_view2d_region_to_view(v2d, rect.xmin, rect.ymin+2, &rectf.xmin, &rectf.ymin);
232         UI_view2d_region_to_view(v2d, rect.xmax, rect.ymax-2, &rectf.xmax, &rectf.ymax);
233         
234         /* filter data */
235         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CHANNELS);
236         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
237         
238         /* get beztriple editing/validation funcs  */
239         select_cb= ANIM_editkeyframes_select(selectmode);
240         
241         if (ELEM(mode, ACTKEYS_BORDERSEL_FRAMERANGE, ACTKEYS_BORDERSEL_ALLKEYS))
242                 ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
243         else
244                 ok_cb= NULL;
245                 
246         /* init editing data */
247         memset(&bed, 0, sizeof(BeztEditData));
248         
249         /* loop over data, doing border select */
250         for (ale= anim_data.first; ale; ale= ale->next) {
251                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
252                 
253                 /* get new vertical minimum extent of channel */
254                 ymin= ymax - ACHANNEL_STEP;
255                 
256                 /* set horizontal range (if applicable) */
257                 if (ELEM(mode, ACTKEYS_BORDERSEL_FRAMERANGE, ACTKEYS_BORDERSEL_ALLKEYS)) {
258                         /* if channel is mapped in NLA, apply correction */
259                         if (adt) {
260                                 bed.f1= BKE_nla_tweakedit_remap(adt, rectf.xmin, NLATIME_CONVERT_UNMAP);
261                                 bed.f2= BKE_nla_tweakedit_remap(adt, rectf.xmax, NLATIME_CONVERT_UNMAP);
262                         }
263                         else {
264                                 bed.f1= rectf.xmin;
265                                 bed.f2= rectf.xmax;
266                         }
267                 }
268                 
269                 /* perform vertical suitability check (if applicable) */
270                 if ( (mode == ACTKEYS_BORDERSEL_FRAMERANGE) || 
271                         !((ymax < rectf.ymin) || (ymin > rectf.ymax)) )
272                 {
273                         /* loop over data selecting */
274                         if (ale->key_data) {
275                                 if (ale->datatype == ALE_FCURVE)
276                                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
277                         }
278                         else if (ale->type == ANIMTYPE_GROUP) {
279                                 bActionGroup *agrp= ale->data;
280                                 FCurve *fcu;
281                                 
282                                 for (fcu= agrp->channels.first; fcu && fcu->grp==agrp; fcu= fcu->next) 
283                                         ANIM_fcurve_keys_bezier_loop(&bed, fcu, ok_cb, select_cb, NULL);
284                         }
285                         //else if (ale->type == ANIMTYPE_GPLAYER) {
286                         //      borderselect_gplayer_frames(ale->data, rectf.xmin, rectf.xmax, selectmode);
287                         //}
288                 }
289                 
290                 /* set minimum extent to be the maximum of the next channel */
291                 ymax=ymin;
292         }
293         
294         /* cleanup */
295         BLI_freelistN(&anim_data);
296 }
297
298 /* ------------------- */
299
300 static int actkeys_borderselect_exec(bContext *C, wmOperator *op)
301 {
302         bAnimContext ac;
303         rcti rect;
304         short mode=0, selectmode=0;
305         int event;
306         
307         /* get editor data */
308         if (ANIM_animdata_get_context(C, &ac) == 0)
309                 return OPERATOR_CANCELLED;
310         
311         /* get settings from operator */
312         rect.xmin= RNA_int_get(op->ptr, "xmin");
313         rect.ymin= RNA_int_get(op->ptr, "ymin");
314         rect.xmax= RNA_int_get(op->ptr, "xmax");
315         rect.ymax= RNA_int_get(op->ptr, "ymax");
316                 
317         event= RNA_int_get(op->ptr, "event_type");
318         if (event == LEFTMOUSE) // FIXME... hardcoded
319                 selectmode = SELECT_ADD;
320         else
321                 selectmode = SELECT_SUBTRACT;
322         
323         /* selection 'mode' depends on whether borderselect region only matters on one axis */
324         if (RNA_boolean_get(op->ptr, "axis_range")) {
325                 /* mode depends on which axis of the range is larger to determine which axis to use 
326                  *      - checking this in region-space is fine, as it's fundamentally still going to be a different rect size
327                  *      - the frame-range select option is favoured over the channel one (x over y), as frame-range one is often
328                  *        used for tweaking timing when "blocking", while channels is not that useful...
329                  */
330                 if ((rect.xmax - rect.xmin) >= (rect.ymax - rect.ymin))
331                         mode= ACTKEYS_BORDERSEL_FRAMERANGE;
332                 else
333                         mode= ACTKEYS_BORDERSEL_CHANNELS;
334         }
335         else 
336                 mode= ACTKEYS_BORDERSEL_ALLKEYS;
337         
338         /* apply borderselect action */
339         borderselect_action(&ac, rect, mode, selectmode);
340         
341         /* set notifier that keyframe selection have changed */
342         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
343         
344         return OPERATOR_FINISHED;
345
346
347 void ACT_OT_select_border(wmOperatorType *ot)
348 {
349         /* identifiers */
350         ot->name= "Border Select";
351         ot->idname= "ACT_OT_select_border";
352         ot->description= "Select all keyframes within the specified region.";
353         
354         /* api callbacks */
355         ot->invoke= WM_border_select_invoke;
356         ot->exec= actkeys_borderselect_exec;
357         ot->modal= WM_border_select_modal;
358         
359         ot->poll= ED_operator_action_active;
360         
361         /* flags */
362         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
363         
364         /* rna */
365         RNA_def_int(ot->srna, "event_type", 0, INT_MIN, INT_MAX, "Event Type", "", INT_MIN, INT_MAX);
366         RNA_def_int(ot->srna, "xmin", 0, INT_MIN, INT_MAX, "X Min", "", INT_MIN, INT_MAX);
367         RNA_def_int(ot->srna, "xmax", 0, INT_MIN, INT_MAX, "X Max", "", INT_MIN, INT_MAX);
368         RNA_def_int(ot->srna, "ymin", 0, INT_MIN, INT_MAX, "Y Min", "", INT_MIN, INT_MAX);
369         RNA_def_int(ot->srna, "ymax", 0, INT_MIN, INT_MAX, "Y Max", "", INT_MIN, INT_MAX);
370         
371         RNA_def_boolean(ot->srna, "axis_range", 0, "Axis Range", "");
372 }
373
374 /* ******************** Column Select Operator **************************** */
375 /* This operator works in one of four ways:
376  *      - 1) select all keyframes in the same frame as a selected one  (KKEY)
377  *      - 2) select all keyframes in the same frame as the current frame marker (CTRL-KKEY)
378  *      - 3) select all keyframes in the same frame as a selected markers (SHIFT-KKEY)
379  *      - 4) select all keyframes that occur between selected markers (ALT-KKEY)
380  */
381
382 /* defines for column-select mode */
383 static EnumPropertyItem prop_column_select_types[] = {
384         {ACTKEYS_COLUMNSEL_KEYS, "KEYS", 0, "On Selected Keyframes", ""},
385         {ACTKEYS_COLUMNSEL_CFRA, "CFRA", 0, "On Current Frame", ""},
386         {ACTKEYS_COLUMNSEL_MARKERS_COLUMN, "MARKERS_COLUMN", 0, "On Selected Markers", ""},
387         {ACTKEYS_COLUMNSEL_MARKERS_BETWEEN, "MARKERS_BETWEEN", 0, "Between Min/Max Selected Markers", ""},
388         {0, NULL, 0, NULL, NULL}
389 };
390
391 /* ------------------- */ 
392
393 /* Selects all visible keyframes between the specified markers */
394 static void markers_selectkeys_between (bAnimContext *ac)
395 {
396         ListBase anim_data = {NULL, NULL};
397         bAnimListElem *ale;
398         int filter;
399         
400         BeztEditFunc ok_cb, select_cb;
401         BeztEditData bed;
402         float min, max;
403         
404         /* get extreme markers */
405         ED_markers_get_minmax(ac->markers, 1, &min, &max);
406         min -= 0.5f;
407         max += 0.5f;
408         
409         /* get editing funcs + data */
410         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
411         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
412         
413         memset(&bed, 0, sizeof(BeztEditData));
414         bed.f1= min; 
415         bed.f2= max;
416         
417         /* filter data */
418         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
419         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
420         
421         /* select keys in-between */
422         for (ale= anim_data.first; ale; ale= ale->next) {
423                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
424                 
425                 if (adt) {      
426                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
427                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
428                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
429                 }
430                 else {
431                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
432                 }
433         }
434         
435         /* Cleanup */
436         BLI_freelistN(&anim_data);
437 }
438
439
440 /* Selects all visible keyframes in the same frames as the specified elements */
441 static void columnselect_action_keys (bAnimContext *ac, short mode)
442 {
443         ListBase anim_data= {NULL, NULL};
444         bAnimListElem *ale;
445         int filter;
446         
447         Scene *scene= ac->scene;
448         CfraElem *ce;
449         BeztEditFunc select_cb, ok_cb;
450         BeztEditData bed;
451         
452         /* initialise keyframe editing data */
453         memset(&bed, 0, sizeof(BeztEditData));
454         
455         /* build list of columns */
456         switch (mode) {
457                 case ACTKEYS_COLUMNSEL_KEYS: /* list of selected keys */
458                         if (ac->datatype == ANIMCONT_GPENCIL) {
459                                 filter= (ANIMFILTER_VISIBLE);
460                                 ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
461                                 
462                                 //for (ale= anim_data.first; ale; ale= ale->next)
463                                 //      gplayer_make_cfra_list(ale->data, &elems, 1);
464                         }
465                         else {
466                                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
467                                 ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
468                                 
469                                 for (ale= anim_data.first; ale; ale= ale->next)
470                                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, bezt_to_cfraelem, NULL);
471                         }
472                         BLI_freelistN(&anim_data);
473                         break;
474                         
475                 case ACTKEYS_COLUMNSEL_CFRA: /* current frame */
476                         /* make a single CfraElem for storing this */
477                         ce= MEM_callocN(sizeof(CfraElem), "cfraElem");
478                         BLI_addtail(&bed.list, ce);
479                         
480                         ce->cfra= (float)CFRA;
481                         break;
482                         
483                 case ACTKEYS_COLUMNSEL_MARKERS_COLUMN: /* list of selected markers */
484                         ED_markers_make_cfra_list(ac->markers, &bed.list, 1);
485                         break;
486                         
487                 default: /* invalid option */
488                         return;
489         }
490         
491         /* set up BezTriple edit callbacks */
492         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
493         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
494         
495         /* loop through all of the keys and select additional keyframes
496          * based on the keys found to be selected above
497          */
498         if (ac->datatype == ANIMCONT_GPENCIL)
499                 filter= (ANIMFILTER_VISIBLE);
500         else
501                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
502         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
503         
504         for (ale= anim_data.first; ale; ale= ale->next) {
505                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
506                 
507                 /* loop over cfraelems (stored in the BeztEditData->list)
508                  *      - we need to do this here, as we can apply fewer NLA-mapping conversions
509                  */
510                 for (ce= bed.list.first; ce; ce= ce->next) {
511                         /* set frame for validation callback to refer to */
512                         if (adt)
513                                 bed.f1= BKE_nla_tweakedit_remap(adt, ce->cfra, NLATIME_CONVERT_UNMAP);
514                         else
515                                 bed.f1= ce->cfra;
516                         
517                         /* select elements with frame number matching cfraelem */
518                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
519                         
520 #if 0 // XXX reenable when Grease Pencil stuff is back
521                         if (ale->type == ANIMTYPE_GPLAYER) {
522                                 bGPDlayer *gpl= (bGPDlayer *)ale->data;
523                                 bGPDframe *gpf;
524                                 
525                                 for (gpf= gpl->frames.first; gpf; gpf= gpf->next) {
526                                         if (ecfra == gpf->framenum) 
527                                                 gpf->flag |= GP_FRAME_SELECT;
528                                 }
529                         }
530                         //else... 
531 #endif // XXX reenable when Grease Pencil stuff is back
532                 }
533         }
534         
535         /* free elements */
536         BLI_freelistN(&bed.list);
537         BLI_freelistN(&anim_data);
538 }
539
540 /* ------------------- */
541
542 static int actkeys_columnselect_exec(bContext *C, wmOperator *op)
543 {
544         bAnimContext ac;
545         short mode;
546         
547         /* get editor data */
548         if (ANIM_animdata_get_context(C, &ac) == 0)
549                 return OPERATOR_CANCELLED;
550                 
551         /* action to take depends on the mode */
552         mode= RNA_enum_get(op->ptr, "mode");
553         
554         if (mode == ACTKEYS_COLUMNSEL_MARKERS_BETWEEN)
555                 markers_selectkeys_between(&ac);
556         else
557                 columnselect_action_keys(&ac, mode);
558         
559         /* set notifier that keyframe selection have changed */
560         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
561         
562         return OPERATOR_FINISHED;
563 }
564  
565 void ACT_OT_select_column (wmOperatorType *ot)
566 {
567         /* identifiers */
568         ot->name= "Select All";
569         ot->idname= "ACT_OT_select_column";
570         ot->description= "Select all keyframes on the specified frame(s).";
571         
572         /* api callbacks */
573         ot->exec= actkeys_columnselect_exec;
574         ot->poll= ED_operator_action_active;
575         
576         /* flags */
577         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
578         
579         /* props */
580         RNA_def_enum(ot->srna, "mode", prop_column_select_types, 0, "Mode", "");
581 }
582
583 /* ******************** Mouse-Click Select Operator *********************** */
584 /* This operator works in one of three ways:
585  *      - 1) keyframe under mouse - no special modifiers
586  *      - 2) all keyframes on the same side of current frame indicator as mouse - ALT modifier
587  *      - 3) column select all keyframes in frame under mouse - CTRL modifier
588  *
589  * In addition to these basic options, the SHIFT modifier can be used to toggle the 
590  * selection mode between replacing the selection (without) and inverting the selection (with).
591  */
592
593 /* defines for left-right select tool */
594 static EnumPropertyItem prop_actkeys_leftright_select_types[] = {
595         {ACTKEYS_LRSEL_TEST, "CHECK", 0, "Check if Select Left or Right", ""},
596         {ACTKEYS_LRSEL_NONE, "OFF", 0, "Don't select", ""},
597         {ACTKEYS_LRSEL_LEFT, "LEFT", 0, "Before current frame", ""},
598         {ACTKEYS_LRSEL_RIGHT, "RIGHT", 0, "After current frame", ""},
599         {0, NULL, 0, NULL, NULL}
600 };
601
602 /* sensitivity factor for frame-selections */
603 #define FRAME_CLICK_THRESH              0.1f
604
605 /* ------------------- */
606  
607 /* option 1) select keyframe directly under mouse */
608 static void actkeys_mselect_single (bAnimContext *ac, bAnimListElem *ale, short select_mode, float selx)
609 {
610         bDopeSheet *ads= (ac->datatype == ANIMCONT_DOPESHEET) ? ac->data : NULL;
611         int ds_filter = ((ads) ? (ads->filterflag) : (0));
612         
613         BeztEditData bed;
614         BeztEditFunc select_cb, ok_cb;
615         
616         /* get functions for selecting keyframes */
617         select_cb= ANIM_editkeyframes_select(select_mode);
618         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
619         memset(&bed, 0, sizeof(BeztEditData)); 
620         bed.f1= selx;
621         
622         /* select the nominated keyframe on the given frame */
623         ANIM_animchannel_keys_bezier_loop(&bed, ale, ok_cb, select_cb, NULL, ds_filter);
624 }
625
626 /* Option 2) Selects all the keyframes on either side of the current frame (depends on which side the mouse is on) */
627 static void actkeys_mselect_leftright (bAnimContext *ac, short leftright, short select_mode)
628 {
629         ListBase anim_data = {NULL, NULL};
630         bAnimListElem *ale;
631         int filter;
632         
633         BeztEditFunc ok_cb, select_cb;
634         BeztEditData bed;
635         Scene *scene= ac->scene;
636         
637         /* if select mode is replace, deselect all keyframes (and channels) first */
638         if (select_mode==SELECT_REPLACE) {
639                 select_mode= SELECT_ADD;
640                 
641                 /* deselect all other channels and keyframes */
642                 ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
643                 deselect_action_keys(ac, 0, SELECT_SUBTRACT);
644         }
645         
646         /* set callbacks and editing data */
647         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
648         select_cb= ANIM_editkeyframes_select(select_mode);
649         
650         memset(&bed, 0, sizeof(BeztEditFunc));
651         if (leftright == ACTKEYS_LRSEL_LEFT) {
652                 bed.f1 = MINAFRAMEF;
653                 bed.f2 = (float)(CFRA + FRAME_CLICK_THRESH);
654         } 
655         else {
656                 bed.f1 = (float)(CFRA - FRAME_CLICK_THRESH);
657                 bed.f2 = MAXFRAMEF;
658         }
659         
660         /* filter data */
661         if (ac->datatype == ANIMCONT_GPENCIL)
662                 filter= (ANIMFILTER_VISIBLE);
663         else
664                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
665         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
666                 
667         /* select keys on the side where most data occurs */
668         for (ale= anim_data.first; ale; ale= ale->next) {
669                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
670                 
671                 if (adt) {
672                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
673                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
674                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
675                 }
676                 //else if (ale->type == ANIMTYPE_GPLAYER)
677                 //      borderselect_gplayer_frames(ale->data, min, max, SELECT_ADD);
678                 else
679                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
680         }
681         
682         /* Cleanup */
683         BLI_freelistN(&anim_data);
684 }
685
686 /* Option 3) Selects all visible keyframes in the same frame as the mouse click */
687 static void actkeys_mselect_column(bAnimContext *ac, short select_mode, float selx)
688 {
689         ListBase anim_data= {NULL, NULL};
690         bAnimListElem *ale;
691         int filter;
692         
693         BeztEditFunc select_cb, ok_cb;
694         BeztEditData bed;
695         
696         /* initialise keyframe editing data */
697         memset(&bed, 0, sizeof(BeztEditData));
698         
699         /* set up BezTriple edit callbacks */
700         select_cb= ANIM_editkeyframes_select(select_mode);
701         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
702         
703         /* loop through all of the keys and select additional keyframes
704          * based on the keys found to be selected above
705          */
706         if (ac->datatype == ANIMCONT_GPENCIL)
707                 filter= (ANIMFILTER_VISIBLE);
708         else
709                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
710         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
711         
712         for (ale= anim_data.first; ale; ale= ale->next) {
713                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
714                 
715                 /* set frame for validation callback to refer to */
716                 if (adt)
717                         bed.f1= BKE_nla_tweakedit_remap(adt, selx, NLATIME_CONVERT_UNMAP);
718                 else
719                         bed.f1= selx;
720                 
721                 /* select elements with frame number matching cfra */
722                 ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
723                         
724 #if 0 // XXX reenable when Grease Pencil stuff is back
725                         if (ale->type == ANIMTYPE_GPLAYER) {
726                                 bGPDlayer *gpl= (bGPDlayer *)ale->data;
727                                 bGPDframe *gpf;
728                                 
729                                 for (gpf= gpl->frames.first; gpf; gpf= gpf->next) {
730                                         if (ecfra == gpf->framenum) 
731                                                 gpf->flag |= GP_FRAME_SELECT;
732                                 }
733                         }
734                         //else... 
735 #endif // XXX reenable when Grease Pencil stuff is back
736         }
737         
738         /* free elements */
739         BLI_freelistN(&bed.list);
740         BLI_freelistN(&anim_data);
741 }
742  
743 /* ------------------- */
744
745 static void mouse_action_keys (bAnimContext *ac, int mval[2], short select_mode, short column)
746 {
747         ListBase anim_data = {NULL, NULL};
748         DLRBT_Tree anim_keys;
749         bAnimListElem *ale;
750         int filter;
751         
752         View2D *v2d= &ac->ar->v2d;
753         bDopeSheet *ads = NULL;
754         int channel_index;
755         short found = 0;
756         float selx = 0.0f;
757         float x, y;
758         rctf rectf;
759         
760         /* get dopesheet info */
761         if (ac->datatype == ANIMCONT_DOPESHEET)
762                 ads= ac->data;
763         
764         /* use View2D to determine the index of the channel (i.e a row in the list) where keyframe was */
765         UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, &y);
766         UI_view2d_listview_view_to_cell(v2d, 0, ACHANNEL_STEP, 0, (float)ACHANNEL_HEIGHT_HALF, x, y, NULL, &channel_index);
767         
768         /* x-range to check is +/- 7 (in screen/region-space) on either side of mouse click (size of keyframe icon) */
769         UI_view2d_region_to_view(v2d, mval[0]-7, mval[1], &rectf.xmin, &rectf.ymin);
770         UI_view2d_region_to_view(v2d, mval[0]+7, mval[1], &rectf.xmax, &rectf.ymax);
771         
772         /* filter data */
773         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CHANNELS);
774         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
775         
776         /* try to get channel */
777         ale= BLI_findlink(&anim_data, channel_index);
778         if (ale == NULL) {
779                 /* channel not found */
780                 printf("Error: animation channel (index = %d) not found in mouse_action_keys() \n", channel_index);
781                 BLI_freelistN(&anim_data);
782                 return;
783         }
784         else {
785                 /* found match - must return here... */
786                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
787                 ActKeyColumn *ak, *akn=NULL;
788                 
789                 /* make list of keyframes */
790                 // TODO: it would be great if we didn't have to apply this to all the keyframes to do this...
791                 BLI_dlrbTree_init(&anim_keys);
792                 
793                 if (ale->key_data) {
794                         switch (ale->datatype) {
795                                 case ALE_OB:
796                                 {
797                                         Object *ob= (Object *)ale->key_data;
798                                         ob_to_keylist(ads, ob, &anim_keys, NULL);
799                                 }
800                                         break;
801                                 case ALE_ACT:
802                                 {
803                                         bAction *act= (bAction *)ale->key_data;
804                                         action_to_keylist(adt, act, &anim_keys, NULL);
805                                 }
806                                         break;
807                                 case ALE_FCURVE:
808                                 {
809                                         FCurve *fcu= (FCurve *)ale->key_data;
810                                         fcurve_to_keylist(adt, fcu, &anim_keys, NULL);
811                                 }
812                                         break;
813                         }
814                 }
815                 else if (ale->type == ANIMTYPE_GROUP) {
816                         bActionGroup *agrp= (bActionGroup *)ale->data;
817                         agroup_to_keylist(adt, agrp, &anim_keys, NULL);
818                 }
819                 else if (ale->type == ANIMTYPE_GPDATABLOCK) {
820                         /* cleanup */
821                         // FIXME:...
822                         BLI_freelistN(&anim_data);
823                         return;
824                 }
825                 else if (ale->type == ANIMTYPE_GPLAYER) {
826                         bGPDlayer *gpl= (bGPDlayer *)ale->data;
827                         gpl_to_keylist(ads, gpl, &anim_keys, NULL);
828                 }
829                 
830                 // the call below is not strictly necessary, since we have adjacency info anyway
831                 //BLI_dlrbTree_linkedlist_sync(&anim_keys);
832                 
833                 /* loop through keyframes, finding one that was within the range clicked on */
834                 for (ak= anim_keys.root; ak; ak= akn) {
835                         if (IN_RANGE(ak->cfra, rectf.xmin, rectf.xmax)) {
836                                 /* set the frame to use, and apply inverse-correction for NLA-mapping 
837                                  * so that the frame will get selected by the selection functiosn without
838                                  * requiring to map each frame once again...
839                                  */
840                                 selx= BKE_nla_tweakedit_remap(adt, ak->cfra, NLATIME_CONVERT_UNMAP);
841                                 found= 1;
842                                 break;
843                         }
844                         else if (ak->cfra < rectf.xmin)
845                                 akn= ak->right;
846                         else
847                                 akn= ak->left;
848                 }
849                 
850                 /* remove active channel from list of channels for separate treatment (since it's needed later on) */
851                 BLI_remlink(&anim_data, ale);
852                 
853                 /* cleanup temporary lists */
854                 BLI_dlrbTree_free(&anim_keys);
855                 
856                 /* free list of channels, since it's not used anymore */
857                 BLI_freelistN(&anim_data);
858         }
859         
860         /* for replacing selection, firstly need to clear existing selection */
861         if (select_mode == SELECT_REPLACE) {
862                 /* reset selection mode for next steps */
863                 select_mode = SELECT_ADD;
864                 
865                 /* deselect all keyframes */
866                 deselect_action_keys(ac, 0, SELECT_SUBTRACT);
867                 
868                 /* highlight channel clicked on */
869                 if (ELEM(ac->datatype, ANIMCONT_ACTION, ANIMCONT_DOPESHEET)) {
870                         /* deselect all other channels first */
871                         ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
872                         
873                         /* Highlight Action-Group or F-Curve? */
874                         if (ale && ale->data) {
875                                 if (ale->type == ANIMTYPE_GROUP) {
876                                         bActionGroup *agrp= ale->data;
877                                         
878                                         agrp->flag |= AGRP_SELECTED;
879                                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, agrp, ANIMTYPE_GROUP);
880                                 }       
881                                 else if (ale->type == ANIMTYPE_FCURVE) {
882                                         FCurve *fcu= ale->data;
883                                         
884                                         fcu->flag |= FCURVE_SELECTED;
885                                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, fcu, ANIMTYPE_FCURVE);
886                                 }
887                         }
888                 }
889                 else if (ac->datatype == ANIMCONT_GPENCIL) {
890                         ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
891                         
892                         /* Highlight gpencil layer */
893                         //gpl->flag |= GP_LAYER_SELECT;
894                         //gpencil_layer_setactive(gpd, gpl);
895                 }
896         }
897         
898         /* only select keyframes if we clicked on a valid channel and hit something */
899         if (ale) {
900                 if (found) {
901                         /* apply selection to keyframes */
902                         if (/*gpl*/0) {
903                                 /* grease pencil */
904                                 //select_gpencil_frame(gpl, (int)selx, selectmode);
905                         }
906                         else if (column) {
907                                 /* select all keyframes in the same frame as the one we hit on the active channel */
908                                 actkeys_mselect_column(ac, select_mode, selx);
909                         }
910                         else {
911                                 /* select the nominated keyframe on the given frame */
912                                 actkeys_mselect_single(ac, ale, select_mode, selx);
913                         }
914                 }
915                 
916                 /* free this channel */
917                 MEM_freeN(ale);
918         }
919 }
920
921 /* handle clicking */
922 static int actkeys_clickselect_invoke(bContext *C, wmOperator *op, wmEvent *event)
923 {
924         bAnimContext ac;
925         Scene *scene;
926         ARegion *ar;
927         View2D *v2d;
928         short selectmode, column;
929         int mval[2];
930         
931         /* get editor data */
932         if (ANIM_animdata_get_context(C, &ac) == 0)
933                 return OPERATOR_CANCELLED;
934                 
935         /* get useful pointers from animation context data */
936         scene= ac.scene;
937         ar= ac.ar;
938         v2d= &ar->v2d;
939         
940         /* get mouse coordinates (in region coordinates) */
941         mval[0]= (event->x - ar->winrct.xmin);
942         mval[1]= (event->y - ar->winrct.ymin);
943         
944         /* select mode is either replace (deselect all, then add) or add/extend */
945         if (RNA_boolean_get(op->ptr, "extend"))
946                 selectmode= SELECT_INVERT;
947         else
948                 selectmode= SELECT_REPLACE;
949                 
950         /* column selection */
951         column= RNA_boolean_get(op->ptr, "column");
952         
953         /* figure out action to take */
954         if (RNA_enum_get(op->ptr, "left_right")) {
955                 /* select all keys on same side of current frame as mouse */
956                 float x;
957                 
958                 UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, NULL);
959                 if (x < CFRA)
960                         RNA_int_set(op->ptr, "left_right", ACTKEYS_LRSEL_LEFT);
961                 else    
962                         RNA_int_set(op->ptr, "left_right", ACTKEYS_LRSEL_RIGHT);
963                 
964                 actkeys_mselect_leftright(&ac, RNA_enum_get(op->ptr, "left_right"), selectmode);
965         }
966         else {
967                 /* select keyframe(s) based upon mouse position*/
968                 mouse_action_keys(&ac, mval, selectmode, column);
969         }
970         
971         /* set notifier that keyframe selection (and channels too) have changed */
972         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT|ND_ANIMCHAN_SELECT, NULL);
973         
974         /* for tweak grab to work */
975         return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
976 }
977  
978 void ACT_OT_clickselect (wmOperatorType *ot)
979 {
980         /* identifiers */
981         ot->name= "Mouse Select Keys";
982         ot->idname= "ACT_OT_clickselect";
983         ot->description= "Select keyframes by clicking on them.";
984         
985         /* api callbacks - absolutely no exec() this yet... */
986         ot->invoke= actkeys_clickselect_invoke;
987         ot->poll= ED_operator_action_active;
988         
989         /* flags */
990         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
991         
992         /* id-props */
993         // XXX should we make this into separate operators?
994         RNA_def_enum(ot->srna, "left_right", prop_actkeys_leftright_select_types, 0, "Left Right", ""); // CTRLKEY
995         RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", ""); // SHIFTKEY
996         RNA_def_boolean(ot->srna, "column", 0, "Column Select", ""); // ALTKEY
997 }
998
999 /* ************************************************************************** */