Ctrl+RMB select in the dope-sheet wasnt working, this nlabackup stuff isnt being...
[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_math.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 ACTION_OT_select_all_toggle (wmOperatorType *ot)
185 {
186         /* identifiers */
187         ot->name= "Select All";
188         ot->idname= "ACTION_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, filterflag;
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 filtering flag for dopesheet data (if applicable) */
239         if (ac->datatype == ANIMCONT_DOPESHEET) {
240                 bDopeSheet *ads= (bDopeSheet *)ac->data;
241                 filterflag= ads->filterflag;
242         }
243         else
244                 filterflag= 0;
245         
246         /* get beztriple editing/validation funcs  */
247         select_cb= ANIM_editkeyframes_select(selectmode);
248         
249         if (ELEM(mode, ACTKEYS_BORDERSEL_FRAMERANGE, ACTKEYS_BORDERSEL_ALLKEYS))
250                 ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
251         else
252                 ok_cb= NULL;
253                 
254         /* init editing data */
255         memset(&bed, 0, sizeof(BeztEditData));
256         
257         /* loop over data, doing border select */
258         for (ale= anim_data.first; ale; ale= ale->next) {
259                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
260                 
261                 /* get new vertical minimum extent of channel */
262                 ymin= ymax - ACHANNEL_STEP;
263                 
264                 /* set horizontal range (if applicable) */
265                 if (ELEM(mode, ACTKEYS_BORDERSEL_FRAMERANGE, ACTKEYS_BORDERSEL_ALLKEYS)) {
266                         /* if channel is mapped in NLA, apply correction */
267                         if (adt) {
268                                 bed.f1= BKE_nla_tweakedit_remap(adt, rectf.xmin, NLATIME_CONVERT_UNMAP);
269                                 bed.f2= BKE_nla_tweakedit_remap(adt, rectf.xmax, NLATIME_CONVERT_UNMAP);
270                         }
271                         else {
272                                 bed.f1= rectf.xmin;
273                                 bed.f2= rectf.xmax;
274                         }
275                 }
276                 
277                 /* perform vertical suitability check (if applicable) */
278                 if ( (mode == ACTKEYS_BORDERSEL_FRAMERANGE) || 
279                         !((ymax < rectf.ymin) || (ymin > rectf.ymax)) )
280                 {
281                         /* loop over data selecting */
282                         //if (ale->type == ANIMTYPE_GPLAYER)
283                         //      borderselect_gplayer_frames(ale->data, rectf.xmin, rectf.xmax, selectmode);
284                         //else
285                                 ANIM_animchannel_keys_bezier_loop(&bed, ale, ok_cb, select_cb, NULL, filterflag);
286                 }
287                 
288                 /* set minimum extent to be the maximum of the next channel */
289                 ymax=ymin;
290         }
291         
292         /* cleanup */
293         BLI_freelistN(&anim_data);
294 }
295
296 /* ------------------- */
297
298 static int actkeys_borderselect_exec(bContext *C, wmOperator *op)
299 {
300         bAnimContext ac;
301         rcti rect;
302         short mode=0, selectmode=0;
303         int gesture_mode;
304         
305         /* get editor data */
306         if (ANIM_animdata_get_context(C, &ac) == 0)
307                 return OPERATOR_CANCELLED;
308         
309         /* get settings from operator */
310         rect.xmin= RNA_int_get(op->ptr, "xmin");
311         rect.ymin= RNA_int_get(op->ptr, "ymin");
312         rect.xmax= RNA_int_get(op->ptr, "xmax");
313         rect.ymax= RNA_int_get(op->ptr, "ymax");
314                 
315         gesture_mode= RNA_int_get(op->ptr, "gesture_mode");
316         if (gesture_mode == GESTURE_MODAL_SELECT)
317                 selectmode = SELECT_ADD;
318         else
319                 selectmode = SELECT_SUBTRACT;
320         
321         /* selection 'mode' depends on whether borderselect region only matters on one axis */
322         if (RNA_boolean_get(op->ptr, "axis_range")) {
323                 /* mode depends on which axis of the range is larger to determine which axis to use 
324                  *      - checking this in region-space is fine, as it's fundamentally still going to be a different rect size
325                  *      - the frame-range select option is favoured over the channel one (x over y), as frame-range one is often
326                  *        used for tweaking timing when "blocking", while channels is not that useful...
327                  */
328                 if ((rect.xmax - rect.xmin) >= (rect.ymax - rect.ymin))
329                         mode= ACTKEYS_BORDERSEL_FRAMERANGE;
330                 else
331                         mode= ACTKEYS_BORDERSEL_CHANNELS;
332         }
333         else 
334                 mode= ACTKEYS_BORDERSEL_ALLKEYS;
335         
336         /* apply borderselect action */
337         borderselect_action(&ac, rect, mode, selectmode);
338         
339         /* set notifier that keyframe selection have changed */
340         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
341         
342         return OPERATOR_FINISHED;
343
344
345 void ACTION_OT_select_border(wmOperatorType *ot)
346 {
347         /* identifiers */
348         ot->name= "Border Select";
349         ot->idname= "ACTION_OT_select_border";
350         ot->description= "Select all keyframes within the specified region.";
351         
352         /* api callbacks */
353         ot->invoke= WM_border_select_invoke;
354         ot->exec= actkeys_borderselect_exec;
355         ot->modal= WM_border_select_modal;
356         
357         ot->poll= ED_operator_action_active;
358         
359         /* flags */
360         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
361         
362         /* rna */
363         WM_operator_properties_gesture_border(ot, FALSE);
364         
365         RNA_def_boolean(ot->srna, "axis_range", 0, "Axis Range", "");
366 }
367
368 /* ******************** Column Select Operator **************************** */
369 /* This operator works in one of four ways:
370  *      - 1) select all keyframes in the same frame as a selected one  (KKEY)
371  *      - 2) select all keyframes in the same frame as the current frame marker (CTRL-KKEY)
372  *      - 3) select all keyframes in the same frame as a selected markers (SHIFT-KKEY)
373  *      - 4) select all keyframes that occur between selected markers (ALT-KKEY)
374  */
375
376 /* defines for column-select mode */
377 static EnumPropertyItem prop_column_select_types[] = {
378         {ACTKEYS_COLUMNSEL_KEYS, "KEYS", 0, "On Selected Keyframes", ""},
379         {ACTKEYS_COLUMNSEL_CFRA, "CFRA", 0, "On Current Frame", ""},
380         {ACTKEYS_COLUMNSEL_MARKERS_COLUMN, "MARKERS_COLUMN", 0, "On Selected Markers", ""},
381         {ACTKEYS_COLUMNSEL_MARKERS_BETWEEN, "MARKERS_BETWEEN", 0, "Between Min/Max Selected Markers", ""},
382         {0, NULL, 0, NULL, NULL}
383 };
384
385 /* ------------------- */ 
386
387 /* Selects all visible keyframes between the specified markers */
388 static void markers_selectkeys_between (bAnimContext *ac)
389 {
390         ListBase anim_data = {NULL, NULL};
391         bAnimListElem *ale;
392         int filter;
393         
394         BeztEditFunc ok_cb, select_cb;
395         BeztEditData bed;
396         float min, max;
397         
398         /* get extreme markers */
399         ED_markers_get_minmax(ac->markers, 1, &min, &max);
400         min -= 0.5f;
401         max += 0.5f;
402         
403         /* get editing funcs + data */
404         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
405         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
406         
407         memset(&bed, 0, sizeof(BeztEditData));
408         bed.f1= min; 
409         bed.f2= max;
410         
411         /* filter data */
412         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
413         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
414         
415         /* select keys in-between */
416         for (ale= anim_data.first; ale; ale= ale->next) {
417                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
418                 
419                 if (adt) {      
420                         ListBase nlabackup;
421
422                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1, &nlabackup);
423                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
424                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1, &nlabackup);
425                 }
426                 else {
427                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
428                 }
429         }
430         
431         /* Cleanup */
432         BLI_freelistN(&anim_data);
433 }
434
435
436 /* Selects all visible keyframes in the same frames as the specified elements */
437 static void columnselect_action_keys (bAnimContext *ac, short mode)
438 {
439         ListBase anim_data= {NULL, NULL};
440         bAnimListElem *ale;
441         int filter;
442         
443         Scene *scene= ac->scene;
444         CfraElem *ce;
445         BeztEditFunc select_cb, ok_cb;
446         BeztEditData bed;
447         
448         /* initialise keyframe editing data */
449         memset(&bed, 0, sizeof(BeztEditData));
450         
451         /* build list of columns */
452         switch (mode) {
453                 case ACTKEYS_COLUMNSEL_KEYS: /* list of selected keys */
454                         if (ac->datatype == ANIMCONT_GPENCIL) {
455                                 filter= (ANIMFILTER_VISIBLE);
456                                 ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
457                                 
458                                 //for (ale= anim_data.first; ale; ale= ale->next)
459                                 //      gplayer_make_cfra_list(ale->data, &elems, 1);
460                         }
461                         else {
462                                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
463                                 ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
464                                 
465                                 for (ale= anim_data.first; ale; ale= ale->next)
466                                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, bezt_to_cfraelem, NULL);
467                         }
468                         BLI_freelistN(&anim_data);
469                         break;
470                         
471                 case ACTKEYS_COLUMNSEL_CFRA: /* current frame */
472                         /* make a single CfraElem for storing this */
473                         ce= MEM_callocN(sizeof(CfraElem), "cfraElem");
474                         BLI_addtail(&bed.list, ce);
475                         
476                         ce->cfra= (float)CFRA;
477                         break;
478                         
479                 case ACTKEYS_COLUMNSEL_MARKERS_COLUMN: /* list of selected markers */
480                         ED_markers_make_cfra_list(ac->markers, &bed.list, 1);
481                         break;
482                         
483                 default: /* invalid option */
484                         return;
485         }
486         
487         /* set up BezTriple edit callbacks */
488         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
489         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
490         
491         /* loop through all of the keys and select additional keyframes
492          * based on the keys found to be selected above
493          */
494         if (ac->datatype == ANIMCONT_GPENCIL)
495                 filter= (ANIMFILTER_VISIBLE);
496         else
497                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
498         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
499         
500         for (ale= anim_data.first; ale; ale= ale->next) {
501                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
502                 
503                 /* loop over cfraelems (stored in the BeztEditData->list)
504                  *      - we need to do this here, as we can apply fewer NLA-mapping conversions
505                  */
506                 for (ce= bed.list.first; ce; ce= ce->next) {
507                         /* set frame for validation callback to refer to */
508                         if (adt)
509                                 bed.f1= BKE_nla_tweakedit_remap(adt, ce->cfra, NLATIME_CONVERT_UNMAP);
510                         else
511                                 bed.f1= ce->cfra;
512                         
513                         /* select elements with frame number matching cfraelem */
514                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
515                         
516 #if 0 // XXX reenable when Grease Pencil stuff is back
517                         if (ale->type == ANIMTYPE_GPLAYER) {
518                                 bGPDlayer *gpl= (bGPDlayer *)ale->data;
519                                 bGPDframe *gpf;
520                                 
521                                 for (gpf= gpl->frames.first; gpf; gpf= gpf->next) {
522                                         if (ecfra == gpf->framenum) 
523                                                 gpf->flag |= GP_FRAME_SELECT;
524                                 }
525                         }
526                         //else... 
527 #endif // XXX reenable when Grease Pencil stuff is back
528                 }
529         }
530         
531         /* free elements */
532         BLI_freelistN(&bed.list);
533         BLI_freelistN(&anim_data);
534 }
535
536 /* ------------------- */
537
538 static int actkeys_columnselect_exec(bContext *C, wmOperator *op)
539 {
540         bAnimContext ac;
541         short mode;
542         
543         /* get editor data */
544         if (ANIM_animdata_get_context(C, &ac) == 0)
545                 return OPERATOR_CANCELLED;
546                 
547         /* action to take depends on the mode */
548         mode= RNA_enum_get(op->ptr, "mode");
549         
550         if (mode == ACTKEYS_COLUMNSEL_MARKERS_BETWEEN)
551                 markers_selectkeys_between(&ac);
552         else
553                 columnselect_action_keys(&ac, mode);
554         
555         /* set notifier that keyframe selection have changed */
556         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
557         
558         return OPERATOR_FINISHED;
559 }
560  
561 void ACTION_OT_select_column (wmOperatorType *ot)
562 {
563         /* identifiers */
564         ot->name= "Select All";
565         ot->idname= "ACTION_OT_select_column";
566         ot->description= "Select all keyframes on the specified frame(s).";
567         
568         /* api callbacks */
569         ot->exec= actkeys_columnselect_exec;
570         ot->poll= ED_operator_action_active;
571         
572         /* flags */
573         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
574         
575         /* props */
576         RNA_def_enum(ot->srna, "mode", prop_column_select_types, 0, "Mode", "");
577 }
578
579 /* ******************** Mouse-Click Select Operator *********************** */
580 /* This operator works in one of three ways:
581  *      - 1) keyframe under mouse - no special modifiers
582  *      - 2) all keyframes on the same side of current frame indicator as mouse - ALT modifier
583  *      - 3) column select all keyframes in frame under mouse - CTRL modifier
584  *
585  * In addition to these basic options, the SHIFT modifier can be used to toggle the 
586  * selection mode between replacing the selection (without) and inverting the selection (with).
587  */
588
589 /* defines for left-right select tool */
590 static EnumPropertyItem prop_actkeys_leftright_select_types[] = {
591         {ACTKEYS_LRSEL_TEST, "CHECK", 0, "Check if Select Left or Right", ""},
592         {ACTKEYS_LRSEL_NONE, "OFF", 0, "Don't select", ""},
593         {ACTKEYS_LRSEL_LEFT, "LEFT", 0, "Before current frame", ""},
594         {ACTKEYS_LRSEL_RIGHT, "RIGHT", 0, "After current frame", ""},
595         {0, NULL, 0, NULL, NULL}
596 };
597
598 /* sensitivity factor for frame-selections */
599 #define FRAME_CLICK_THRESH              0.1f
600
601 /* ------------------- */
602  
603 /* option 1) select keyframe directly under mouse */
604 static void actkeys_mselect_single (bAnimContext *ac, bAnimListElem *ale, short select_mode, float selx)
605 {
606         bDopeSheet *ads= (ac->datatype == ANIMCONT_DOPESHEET) ? ac->data : NULL;
607         int ds_filter = ((ads) ? (ads->filterflag) : (0));
608         
609         BeztEditData bed;
610         BeztEditFunc select_cb, ok_cb;
611         
612         /* get functions for selecting keyframes */
613         select_cb= ANIM_editkeyframes_select(select_mode);
614         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
615         memset(&bed, 0, sizeof(BeztEditData)); 
616         bed.f1= selx;
617         
618         /* select the nominated keyframe on the given frame */
619         ANIM_animchannel_keys_bezier_loop(&bed, ale, ok_cb, select_cb, NULL, ds_filter);
620 }
621
622 /* Option 2) Selects all the keyframes on either side of the current frame (depends on which side the mouse is on) */
623 static void actkeys_mselect_leftright (bAnimContext *ac, short leftright, short select_mode)
624 {
625         ListBase anim_data = {NULL, NULL};
626         bAnimListElem *ale;
627         int filter;
628         
629         BeztEditFunc ok_cb, select_cb;
630         BeztEditData bed;
631         Scene *scene= ac->scene;
632         
633         /* if select mode is replace, deselect all keyframes (and channels) first */
634         if (select_mode==SELECT_REPLACE) {
635                 select_mode= SELECT_ADD;
636                 
637                 /* deselect all other channels and keyframes */
638                 ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
639                 deselect_action_keys(ac, 0, SELECT_SUBTRACT);
640         }
641         
642         /* set callbacks and editing data */
643         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
644         select_cb= ANIM_editkeyframes_select(select_mode);
645         
646         memset(&bed, 0, sizeof(BeztEditFunc));
647         if (leftright == ACTKEYS_LRSEL_LEFT) {
648                 bed.f1 = MINAFRAMEF;
649                 bed.f2 = (float)(CFRA + FRAME_CLICK_THRESH);
650         } 
651         else {
652                 bed.f1 = (float)(CFRA - FRAME_CLICK_THRESH);
653                 bed.f2 = MAXFRAMEF;
654         }
655         
656         /* filter data */
657         if (ac->datatype == ANIMCONT_GPENCIL)
658                 filter= (ANIMFILTER_VISIBLE);
659         else
660                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
661         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
662                 
663         /* select keys on the side where most data occurs */
664         for (ale= anim_data.first; ale; ale= ale->next) {
665                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
666
667 #if 0   // This does not work even in simple cases I tested - campbell
668                 if (adt) {
669                         ListBase nlabackup;
670
671                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1, &nlabackup);
672                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
673                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1, &nlabackup);
674                 }
675                 //else if (ale->type == ANIMTYPE_GPLAYER)
676                 //      borderselect_gplayer_frames(ale->data, min, max, SELECT_ADD);
677                 else
678 #endif
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_SCE:
796                                 {
797                                         Scene *scene= (Scene *)ale->key_data;
798                                         scene_to_keylist(ads, scene, &anim_keys, NULL);
799                                 }
800                                         break;
801                                 case ALE_OB:
802                                 {
803                                         Object *ob= (Object *)ale->key_data;
804                                         ob_to_keylist(ads, ob, &anim_keys, NULL);
805                                 }
806                                         break;
807                                 case ALE_ACT:
808                                 {
809                                         bAction *act= (bAction *)ale->key_data;
810                                         action_to_keylist(adt, act, &anim_keys, NULL);
811                                 }
812                                         break;
813                                 case ALE_FCURVE:
814                                 {
815                                         FCurve *fcu= (FCurve *)ale->key_data;
816                                         fcurve_to_keylist(adt, fcu, &anim_keys, NULL);
817                                 }
818                                         break;
819                         }
820                 }
821                 else if (ale->type == ANIMTYPE_SUMMARY) {
822                         /* dopesheet summary covers everything */
823                         summary_to_keylist(ac, &anim_keys, NULL);
824                 }
825                 else if (ale->type == ANIMTYPE_GROUP) {
826                         bActionGroup *agrp= (bActionGroup *)ale->data;
827                         agroup_to_keylist(adt, agrp, &anim_keys, NULL);
828                 }
829                 else if (ale->type == ANIMTYPE_GPDATABLOCK) {
830                         /* cleanup */
831                         // FIXME:...
832                         BLI_freelistN(&anim_data);
833                         return;
834                 }
835                 else if (ale->type == ANIMTYPE_GPLAYER) {
836                         bGPDlayer *gpl= (bGPDlayer *)ale->data;
837                         gpl_to_keylist(ads, gpl, &anim_keys, NULL);
838                 }
839                 
840                 // the call below is not strictly necessary, since we have adjacency info anyway
841                 //BLI_dlrbTree_linkedlist_sync(&anim_keys);
842                 
843                 /* loop through keyframes, finding one that was within the range clicked on */
844                 for (ak= anim_keys.root; ak; ak= akn) {
845                         if (IN_RANGE(ak->cfra, rectf.xmin, rectf.xmax)) {
846                                 /* set the frame to use, and apply inverse-correction for NLA-mapping 
847                                  * so that the frame will get selected by the selection functiosn without
848                                  * requiring to map each frame once again...
849                                  */
850                                 selx= BKE_nla_tweakedit_remap(adt, ak->cfra, NLATIME_CONVERT_UNMAP);
851                                 found= 1;
852                                 break;
853                         }
854                         else if (ak->cfra < rectf.xmin)
855                                 akn= ak->right;
856                         else
857                                 akn= ak->left;
858                 }
859                 
860                 /* remove active channel from list of channels for separate treatment (since it's needed later on) */
861                 BLI_remlink(&anim_data, ale);
862                 
863                 /* cleanup temporary lists */
864                 BLI_dlrbTree_free(&anim_keys);
865                 
866                 /* free list of channels, since it's not used anymore */
867                 BLI_freelistN(&anim_data);
868         }
869         
870         /* for replacing selection, firstly need to clear existing selection */
871         if (select_mode == SELECT_REPLACE) {
872                 /* reset selection mode for next steps */
873                 select_mode = SELECT_ADD;
874                 
875                 /* deselect all keyframes */
876                 deselect_action_keys(ac, 0, SELECT_SUBTRACT);
877                 
878                 /* highlight channel clicked on */
879                 if (ELEM(ac->datatype, ANIMCONT_ACTION, ANIMCONT_DOPESHEET)) {
880                         /* deselect all other channels first */
881                         ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
882                         
883                         /* Highlight Action-Group or F-Curve? */
884                         if (ale && ale->data) {
885                                 if (ale->type == ANIMTYPE_GROUP) {
886                                         bActionGroup *agrp= ale->data;
887                                         
888                                         agrp->flag |= AGRP_SELECTED;
889                                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, agrp, ANIMTYPE_GROUP);
890                                 }       
891                                 else if (ale->type == ANIMTYPE_FCURVE) {
892                                         FCurve *fcu= ale->data;
893                                         
894                                         fcu->flag |= FCURVE_SELECTED;
895                                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, fcu, ANIMTYPE_FCURVE);
896                                 }
897                         }
898                 }
899                 else if (ac->datatype == ANIMCONT_GPENCIL) {
900                         ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
901                         
902                         /* Highlight gpencil layer */
903                         //gpl->flag |= GP_LAYER_SELECT;
904                         //gpencil_layer_setactive(gpd, gpl);
905                 }
906         }
907         
908         /* only select keyframes if we clicked on a valid channel and hit something */
909         if (ale) {
910                 if (found) {
911                         /* apply selection to keyframes */
912                         if (/*gpl*/0) {
913                                 /* grease pencil */
914                                 //select_gpencil_frame(gpl, (int)selx, selectmode);
915                         }
916                         else if (column) {
917                                 /* select all keyframes in the same frame as the one we hit on the active channel */
918                                 actkeys_mselect_column(ac, select_mode, selx);
919                         }
920                         else {
921                                 /* select the nominated keyframe on the given frame */
922                                 actkeys_mselect_single(ac, ale, select_mode, selx);
923                         }
924                 }
925                 
926                 /* free this channel */
927                 MEM_freeN(ale);
928         }
929 }
930
931 /* handle clicking */
932 static int actkeys_clickselect_invoke(bContext *C, wmOperator *op, wmEvent *event)
933 {
934         bAnimContext ac;
935         Scene *scene;
936         ARegion *ar;
937         View2D *v2d;
938         short selectmode, column;
939         int mval[2];
940         
941         /* get editor data */
942         if (ANIM_animdata_get_context(C, &ac) == 0)
943                 return OPERATOR_CANCELLED;
944                 
945         /* get useful pointers from animation context data */
946         scene= ac.scene;
947         ar= ac.ar;
948         v2d= &ar->v2d;
949         
950         /* get mouse coordinates (in region coordinates) */
951         mval[0]= (event->x - ar->winrct.xmin);
952         mval[1]= (event->y - ar->winrct.ymin);
953         
954         /* select mode is either replace (deselect all, then add) or add/extend */
955         if (RNA_boolean_get(op->ptr, "extend"))
956                 selectmode= SELECT_INVERT;
957         else
958                 selectmode= SELECT_REPLACE;
959                 
960         /* column selection */
961         column= RNA_boolean_get(op->ptr, "column");
962         
963         /* figure out action to take */
964         if (RNA_enum_get(op->ptr, "left_right")) {
965                 /* select all keys on same side of current frame as mouse */
966                 float x;
967                 
968                 UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, NULL);
969                 if (x < CFRA)
970                         RNA_int_set(op->ptr, "left_right", ACTKEYS_LRSEL_LEFT);
971                 else    
972                         RNA_int_set(op->ptr, "left_right", ACTKEYS_LRSEL_RIGHT);
973                 
974                 actkeys_mselect_leftright(&ac, RNA_enum_get(op->ptr, "left_right"), selectmode);
975         }
976         else {
977                 /* select keyframe(s) based upon mouse position*/
978                 mouse_action_keys(&ac, mval, selectmode, column);
979         }
980         
981         /* set notifier that keyframe selection (and channels too) have changed */
982         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT|ND_ANIMCHAN_SELECT, NULL);
983         
984         /* for tweak grab to work */
985         return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
986 }
987  
988 void ACTION_OT_clickselect (wmOperatorType *ot)
989 {
990         /* identifiers */
991         ot->name= "Mouse Select Keys";
992         ot->idname= "ACTION_OT_clickselect";
993         ot->description= "Select keyframes by clicking on them.";
994         
995         /* api callbacks - absolutely no exec() this yet... */
996         ot->invoke= actkeys_clickselect_invoke;
997         ot->poll= ED_operator_action_active;
998         
999         /* flags */
1000         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1001         
1002         /* id-props */
1003         // XXX should we make this into separate operators?
1004         RNA_def_enum(ot->srna, "left_right", prop_actkeys_leftright_select_types, 0, "Left Right", ""); // CTRLKEY
1005         RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", ""); // SHIFTKEY
1006         RNA_def_boolean(ot->srna, "column", 0, "Column Select", ""); // ALTKEY
1007 }
1008
1009 /* ************************************************************************** */