operator renaming for more consistent word ordering (_add/_remmove shold be last...
[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                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
421                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
422                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
423                 }
424                 else {
425                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
426                 }
427         }
428         
429         /* Cleanup */
430         BLI_freelistN(&anim_data);
431 }
432
433
434 /* Selects all visible keyframes in the same frames as the specified elements */
435 static void columnselect_action_keys (bAnimContext *ac, short mode)
436 {
437         ListBase anim_data= {NULL, NULL};
438         bAnimListElem *ale;
439         int filter;
440         
441         Scene *scene= ac->scene;
442         CfraElem *ce;
443         BeztEditFunc select_cb, ok_cb;
444         BeztEditData bed;
445         
446         /* initialise keyframe editing data */
447         memset(&bed, 0, sizeof(BeztEditData));
448         
449         /* build list of columns */
450         switch (mode) {
451                 case ACTKEYS_COLUMNSEL_KEYS: /* list of selected keys */
452                         if (ac->datatype == ANIMCONT_GPENCIL) {
453                                 filter= (ANIMFILTER_VISIBLE);
454                                 ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
455                                 
456                                 //for (ale= anim_data.first; ale; ale= ale->next)
457                                 //      gplayer_make_cfra_list(ale->data, &elems, 1);
458                         }
459                         else {
460                                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
461                                 ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
462                                 
463                                 for (ale= anim_data.first; ale; ale= ale->next)
464                                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, NULL, bezt_to_cfraelem, NULL);
465                         }
466                         BLI_freelistN(&anim_data);
467                         break;
468                         
469                 case ACTKEYS_COLUMNSEL_CFRA: /* current frame */
470                         /* make a single CfraElem for storing this */
471                         ce= MEM_callocN(sizeof(CfraElem), "cfraElem");
472                         BLI_addtail(&bed.list, ce);
473                         
474                         ce->cfra= (float)CFRA;
475                         break;
476                         
477                 case ACTKEYS_COLUMNSEL_MARKERS_COLUMN: /* list of selected markers */
478                         ED_markers_make_cfra_list(ac->markers, &bed.list, 1);
479                         break;
480                         
481                 default: /* invalid option */
482                         return;
483         }
484         
485         /* set up BezTriple edit callbacks */
486         select_cb= ANIM_editkeyframes_select(SELECT_ADD);
487         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
488         
489         /* loop through all of the keys and select additional keyframes
490          * based on the keys found to be selected above
491          */
492         if (ac->datatype == ANIMCONT_GPENCIL)
493                 filter= (ANIMFILTER_VISIBLE);
494         else
495                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
496         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
497         
498         for (ale= anim_data.first; ale; ale= ale->next) {
499                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
500                 
501                 /* loop over cfraelems (stored in the BeztEditData->list)
502                  *      - we need to do this here, as we can apply fewer NLA-mapping conversions
503                  */
504                 for (ce= bed.list.first; ce; ce= ce->next) {
505                         /* set frame for validation callback to refer to */
506                         if (adt)
507                                 bed.f1= BKE_nla_tweakedit_remap(adt, ce->cfra, NLATIME_CONVERT_UNMAP);
508                         else
509                                 bed.f1= ce->cfra;
510                         
511                         /* select elements with frame number matching cfraelem */
512                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
513                         
514 #if 0 // XXX reenable when Grease Pencil stuff is back
515                         if (ale->type == ANIMTYPE_GPLAYER) {
516                                 bGPDlayer *gpl= (bGPDlayer *)ale->data;
517                                 bGPDframe *gpf;
518                                 
519                                 for (gpf= gpl->frames.first; gpf; gpf= gpf->next) {
520                                         if (ecfra == gpf->framenum) 
521                                                 gpf->flag |= GP_FRAME_SELECT;
522                                 }
523                         }
524                         //else... 
525 #endif // XXX reenable when Grease Pencil stuff is back
526                 }
527         }
528         
529         /* free elements */
530         BLI_freelistN(&bed.list);
531         BLI_freelistN(&anim_data);
532 }
533
534 /* ------------------- */
535
536 static int actkeys_columnselect_exec(bContext *C, wmOperator *op)
537 {
538         bAnimContext ac;
539         short mode;
540         
541         /* get editor data */
542         if (ANIM_animdata_get_context(C, &ac) == 0)
543                 return OPERATOR_CANCELLED;
544                 
545         /* action to take depends on the mode */
546         mode= RNA_enum_get(op->ptr, "mode");
547         
548         if (mode == ACTKEYS_COLUMNSEL_MARKERS_BETWEEN)
549                 markers_selectkeys_between(&ac);
550         else
551                 columnselect_action_keys(&ac, mode);
552         
553         /* set notifier that keyframe selection have changed */
554         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT, NULL);
555         
556         return OPERATOR_FINISHED;
557 }
558  
559 void ACTION_OT_select_column (wmOperatorType *ot)
560 {
561         /* identifiers */
562         ot->name= "Select All";
563         ot->idname= "ACTION_OT_select_column";
564         ot->description= "Select all keyframes on the specified frame(s).";
565         
566         /* api callbacks */
567         ot->exec= actkeys_columnselect_exec;
568         ot->poll= ED_operator_action_active;
569         
570         /* flags */
571         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
572         
573         /* props */
574         RNA_def_enum(ot->srna, "mode", prop_column_select_types, 0, "Mode", "");
575 }
576
577 /* ******************** Mouse-Click Select Operator *********************** */
578 /* This operator works in one of three ways:
579  *      - 1) keyframe under mouse - no special modifiers
580  *      - 2) all keyframes on the same side of current frame indicator as mouse - ALT modifier
581  *      - 3) column select all keyframes in frame under mouse - CTRL modifier
582  *
583  * In addition to these basic options, the SHIFT modifier can be used to toggle the 
584  * selection mode between replacing the selection (without) and inverting the selection (with).
585  */
586
587 /* defines for left-right select tool */
588 static EnumPropertyItem prop_actkeys_leftright_select_types[] = {
589         {ACTKEYS_LRSEL_TEST, "CHECK", 0, "Check if Select Left or Right", ""},
590         {ACTKEYS_LRSEL_NONE, "OFF", 0, "Don't select", ""},
591         {ACTKEYS_LRSEL_LEFT, "LEFT", 0, "Before current frame", ""},
592         {ACTKEYS_LRSEL_RIGHT, "RIGHT", 0, "After current frame", ""},
593         {0, NULL, 0, NULL, NULL}
594 };
595
596 /* sensitivity factor for frame-selections */
597 #define FRAME_CLICK_THRESH              0.1f
598
599 /* ------------------- */
600  
601 /* option 1) select keyframe directly under mouse */
602 static void actkeys_mselect_single (bAnimContext *ac, bAnimListElem *ale, short select_mode, float selx)
603 {
604         bDopeSheet *ads= (ac->datatype == ANIMCONT_DOPESHEET) ? ac->data : NULL;
605         int ds_filter = ((ads) ? (ads->filterflag) : (0));
606         
607         BeztEditData bed;
608         BeztEditFunc select_cb, ok_cb;
609         
610         /* get functions for selecting keyframes */
611         select_cb= ANIM_editkeyframes_select(select_mode);
612         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
613         memset(&bed, 0, sizeof(BeztEditData)); 
614         bed.f1= selx;
615         
616         /* select the nominated keyframe on the given frame */
617         ANIM_animchannel_keys_bezier_loop(&bed, ale, ok_cb, select_cb, NULL, ds_filter);
618 }
619
620 /* Option 2) Selects all the keyframes on either side of the current frame (depends on which side the mouse is on) */
621 static void actkeys_mselect_leftright (bAnimContext *ac, short leftright, short select_mode)
622 {
623         ListBase anim_data = {NULL, NULL};
624         bAnimListElem *ale;
625         int filter;
626         
627         BeztEditFunc ok_cb, select_cb;
628         BeztEditData bed;
629         Scene *scene= ac->scene;
630         
631         /* if select mode is replace, deselect all keyframes (and channels) first */
632         if (select_mode==SELECT_REPLACE) {
633                 select_mode= SELECT_ADD;
634                 
635                 /* deselect all other channels and keyframes */
636                 ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
637                 deselect_action_keys(ac, 0, SELECT_SUBTRACT);
638         }
639         
640         /* set callbacks and editing data */
641         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAMERANGE);
642         select_cb= ANIM_editkeyframes_select(select_mode);
643         
644         memset(&bed, 0, sizeof(BeztEditFunc));
645         if (leftright == ACTKEYS_LRSEL_LEFT) {
646                 bed.f1 = MINAFRAMEF;
647                 bed.f2 = (float)(CFRA + FRAME_CLICK_THRESH);
648         } 
649         else {
650                 bed.f1 = (float)(CFRA - FRAME_CLICK_THRESH);
651                 bed.f2 = MAXFRAMEF;
652         }
653         
654         /* filter data */
655         if (ac->datatype == ANIMCONT_GPENCIL)
656                 filter= (ANIMFILTER_VISIBLE);
657         else
658                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
659         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
660                 
661         /* select keys on the side where most data occurs */
662         for (ale= anim_data.first; ale; ale= ale->next) {
663                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
664                 
665                 if (adt) {
666                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 1);
667                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
668                         ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 1, 1);
669                 }
670                 //else if (ale->type == ANIMTYPE_GPLAYER)
671                 //      borderselect_gplayer_frames(ale->data, min, max, SELECT_ADD);
672                 else
673                         ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
674         }
675         
676         /* Cleanup */
677         BLI_freelistN(&anim_data);
678 }
679
680 /* Option 3) Selects all visible keyframes in the same frame as the mouse click */
681 static void actkeys_mselect_column(bAnimContext *ac, short select_mode, float selx)
682 {
683         ListBase anim_data= {NULL, NULL};
684         bAnimListElem *ale;
685         int filter;
686         
687         BeztEditFunc select_cb, ok_cb;
688         BeztEditData bed;
689         
690         /* initialise keyframe editing data */
691         memset(&bed, 0, sizeof(BeztEditData));
692         
693         /* set up BezTriple edit callbacks */
694         select_cb= ANIM_editkeyframes_select(select_mode);
695         ok_cb= ANIM_editkeyframes_ok(BEZT_OK_FRAME);
696         
697         /* loop through all of the keys and select additional keyframes
698          * based on the keys found to be selected above
699          */
700         if (ac->datatype == ANIMCONT_GPENCIL)
701                 filter= (ANIMFILTER_VISIBLE);
702         else
703                 filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
704         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
705         
706         for (ale= anim_data.first; ale; ale= ale->next) {
707                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
708                 
709                 /* set frame for validation callback to refer to */
710                 if (adt)
711                         bed.f1= BKE_nla_tweakedit_remap(adt, selx, NLATIME_CONVERT_UNMAP);
712                 else
713                         bed.f1= selx;
714                 
715                 /* select elements with frame number matching cfra */
716                 ANIM_fcurve_keys_bezier_loop(&bed, ale->key_data, ok_cb, select_cb, NULL);
717                         
718 #if 0 // XXX reenable when Grease Pencil stuff is back
719                         if (ale->type == ANIMTYPE_GPLAYER) {
720                                 bGPDlayer *gpl= (bGPDlayer *)ale->data;
721                                 bGPDframe *gpf;
722                                 
723                                 for (gpf= gpl->frames.first; gpf; gpf= gpf->next) {
724                                         if (ecfra == gpf->framenum) 
725                                                 gpf->flag |= GP_FRAME_SELECT;
726                                 }
727                         }
728                         //else... 
729 #endif // XXX reenable when Grease Pencil stuff is back
730         }
731         
732         /* free elements */
733         BLI_freelistN(&bed.list);
734         BLI_freelistN(&anim_data);
735 }
736  
737 /* ------------------- */
738
739 static void mouse_action_keys (bAnimContext *ac, int mval[2], short select_mode, short column)
740 {
741         ListBase anim_data = {NULL, NULL};
742         DLRBT_Tree anim_keys;
743         bAnimListElem *ale;
744         int filter;
745         
746         View2D *v2d= &ac->ar->v2d;
747         bDopeSheet *ads = NULL;
748         int channel_index;
749         short found = 0;
750         float selx = 0.0f;
751         float x, y;
752         rctf rectf;
753         
754         /* get dopesheet info */
755         if (ac->datatype == ANIMCONT_DOPESHEET)
756                 ads= ac->data;
757         
758         /* use View2D to determine the index of the channel (i.e a row in the list) where keyframe was */
759         UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, &y);
760         UI_view2d_listview_view_to_cell(v2d, 0, ACHANNEL_STEP, 0, (float)ACHANNEL_HEIGHT_HALF, x, y, NULL, &channel_index);
761         
762         /* x-range to check is +/- 7 (in screen/region-space) on either side of mouse click (size of keyframe icon) */
763         UI_view2d_region_to_view(v2d, mval[0]-7, mval[1], &rectf.xmin, &rectf.ymin);
764         UI_view2d_region_to_view(v2d, mval[0]+7, mval[1], &rectf.xmax, &rectf.ymax);
765         
766         /* filter data */
767         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CHANNELS);
768         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
769         
770         /* try to get channel */
771         ale= BLI_findlink(&anim_data, channel_index);
772         if (ale == NULL) {
773                 /* channel not found */
774                 printf("Error: animation channel (index = %d) not found in mouse_action_keys() \n", channel_index);
775                 BLI_freelistN(&anim_data);
776                 return;
777         }
778         else {
779                 /* found match - must return here... */
780                 AnimData *adt= ANIM_nla_mapping_get(ac, ale);
781                 ActKeyColumn *ak, *akn=NULL;
782                 
783                 /* make list of keyframes */
784                 // TODO: it would be great if we didn't have to apply this to all the keyframes to do this...
785                 BLI_dlrbTree_init(&anim_keys);
786                 
787                 if (ale->key_data) {
788                         switch (ale->datatype) {
789                                 case ALE_SCE:
790                                 {
791                                         Scene *scene= (Scene *)ale->key_data;
792                                         scene_to_keylist(ads, scene, &anim_keys, NULL);
793                                 }
794                                         break;
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_SUMMARY) {
816                         /* dopesheet summary covers everything */
817                         summary_to_keylist(ac, &anim_keys, NULL);
818                 }
819                 else if (ale->type == ANIMTYPE_GROUP) {
820                         bActionGroup *agrp= (bActionGroup *)ale->data;
821                         agroup_to_keylist(adt, agrp, &anim_keys, NULL);
822                 }
823                 else if (ale->type == ANIMTYPE_GPDATABLOCK) {
824                         /* cleanup */
825                         // FIXME:...
826                         BLI_freelistN(&anim_data);
827                         return;
828                 }
829                 else if (ale->type == ANIMTYPE_GPLAYER) {
830                         bGPDlayer *gpl= (bGPDlayer *)ale->data;
831                         gpl_to_keylist(ads, gpl, &anim_keys, NULL);
832                 }
833                 
834                 // the call below is not strictly necessary, since we have adjacency info anyway
835                 //BLI_dlrbTree_linkedlist_sync(&anim_keys);
836                 
837                 /* loop through keyframes, finding one that was within the range clicked on */
838                 for (ak= anim_keys.root; ak; ak= akn) {
839                         if (IN_RANGE(ak->cfra, rectf.xmin, rectf.xmax)) {
840                                 /* set the frame to use, and apply inverse-correction for NLA-mapping 
841                                  * so that the frame will get selected by the selection functiosn without
842                                  * requiring to map each frame once again...
843                                  */
844                                 selx= BKE_nla_tweakedit_remap(adt, ak->cfra, NLATIME_CONVERT_UNMAP);
845                                 found= 1;
846                                 break;
847                         }
848                         else if (ak->cfra < rectf.xmin)
849                                 akn= ak->right;
850                         else
851                                 akn= ak->left;
852                 }
853                 
854                 /* remove active channel from list of channels for separate treatment (since it's needed later on) */
855                 BLI_remlink(&anim_data, ale);
856                 
857                 /* cleanup temporary lists */
858                 BLI_dlrbTree_free(&anim_keys);
859                 
860                 /* free list of channels, since it's not used anymore */
861                 BLI_freelistN(&anim_data);
862         }
863         
864         /* for replacing selection, firstly need to clear existing selection */
865         if (select_mode == SELECT_REPLACE) {
866                 /* reset selection mode for next steps */
867                 select_mode = SELECT_ADD;
868                 
869                 /* deselect all keyframes */
870                 deselect_action_keys(ac, 0, SELECT_SUBTRACT);
871                 
872                 /* highlight channel clicked on */
873                 if (ELEM(ac->datatype, ANIMCONT_ACTION, ANIMCONT_DOPESHEET)) {
874                         /* deselect all other channels first */
875                         ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
876                         
877                         /* Highlight Action-Group or F-Curve? */
878                         if (ale && ale->data) {
879                                 if (ale->type == ANIMTYPE_GROUP) {
880                                         bActionGroup *agrp= ale->data;
881                                         
882                                         agrp->flag |= AGRP_SELECTED;
883                                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, agrp, ANIMTYPE_GROUP);
884                                 }       
885                                 else if (ale->type == ANIMTYPE_FCURVE) {
886                                         FCurve *fcu= ale->data;
887                                         
888                                         fcu->flag |= FCURVE_SELECTED;
889                                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, fcu, ANIMTYPE_FCURVE);
890                                 }
891                         }
892                 }
893                 else if (ac->datatype == ANIMCONT_GPENCIL) {
894                         ANIM_deselect_anim_channels(ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
895                         
896                         /* Highlight gpencil layer */
897                         //gpl->flag |= GP_LAYER_SELECT;
898                         //gpencil_layer_setactive(gpd, gpl);
899                 }
900         }
901         
902         /* only select keyframes if we clicked on a valid channel and hit something */
903         if (ale) {
904                 if (found) {
905                         /* apply selection to keyframes */
906                         if (/*gpl*/0) {
907                                 /* grease pencil */
908                                 //select_gpencil_frame(gpl, (int)selx, selectmode);
909                         }
910                         else if (column) {
911                                 /* select all keyframes in the same frame as the one we hit on the active channel */
912                                 actkeys_mselect_column(ac, select_mode, selx);
913                         }
914                         else {
915                                 /* select the nominated keyframe on the given frame */
916                                 actkeys_mselect_single(ac, ale, select_mode, selx);
917                         }
918                 }
919                 
920                 /* free this channel */
921                 MEM_freeN(ale);
922         }
923 }
924
925 /* handle clicking */
926 static int actkeys_clickselect_invoke(bContext *C, wmOperator *op, wmEvent *event)
927 {
928         bAnimContext ac;
929         Scene *scene;
930         ARegion *ar;
931         View2D *v2d;
932         short selectmode, column;
933         int mval[2];
934         
935         /* get editor data */
936         if (ANIM_animdata_get_context(C, &ac) == 0)
937                 return OPERATOR_CANCELLED;
938                 
939         /* get useful pointers from animation context data */
940         scene= ac.scene;
941         ar= ac.ar;
942         v2d= &ar->v2d;
943         
944         /* get mouse coordinates (in region coordinates) */
945         mval[0]= (event->x - ar->winrct.xmin);
946         mval[1]= (event->y - ar->winrct.ymin);
947         
948         /* select mode is either replace (deselect all, then add) or add/extend */
949         if (RNA_boolean_get(op->ptr, "extend"))
950                 selectmode= SELECT_INVERT;
951         else
952                 selectmode= SELECT_REPLACE;
953                 
954         /* column selection */
955         column= RNA_boolean_get(op->ptr, "column");
956         
957         /* figure out action to take */
958         if (RNA_enum_get(op->ptr, "left_right")) {
959                 /* select all keys on same side of current frame as mouse */
960                 float x;
961                 
962                 UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, NULL);
963                 if (x < CFRA)
964                         RNA_int_set(op->ptr, "left_right", ACTKEYS_LRSEL_LEFT);
965                 else    
966                         RNA_int_set(op->ptr, "left_right", ACTKEYS_LRSEL_RIGHT);
967                 
968                 actkeys_mselect_leftright(&ac, RNA_enum_get(op->ptr, "left_right"), selectmode);
969         }
970         else {
971                 /* select keyframe(s) based upon mouse position*/
972                 mouse_action_keys(&ac, mval, selectmode, column);
973         }
974         
975         /* set notifier that keyframe selection (and channels too) have changed */
976         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME_SELECT|ND_ANIMCHAN_SELECT, NULL);
977         
978         /* for tweak grab to work */
979         return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
980 }
981  
982 void ACTION_OT_clickselect (wmOperatorType *ot)
983 {
984         /* identifiers */
985         ot->name= "Mouse Select Keys";
986         ot->idname= "ACTION_OT_clickselect";
987         ot->description= "Select keyframes by clicking on them.";
988         
989         /* api callbacks - absolutely no exec() this yet... */
990         ot->invoke= actkeys_clickselect_invoke;
991         ot->poll= ED_operator_action_active;
992         
993         /* flags */
994         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
995         
996         /* id-props */
997         // XXX should we make this into separate operators?
998         RNA_def_enum(ot->srna, "left_right", prop_actkeys_leftright_select_types, 0, "Left Right", ""); // CTRLKEY
999         RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", ""); // SHIFTKEY
1000         RNA_def_boolean(ot->srna, "column", 0, "Column Select", ""); // ALTKEY
1001 }
1002
1003 /* ************************************************************************** */