7729573070defa1867934acc570fb66e5d7bb11c
[blender-staging.git] / source / blender / editors / space_nla / nla_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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Joshua Leung (major recode)
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "DNA_anim_types.h"
33 #include "DNA_action_types.h"
34 #include "DNA_nla_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_space_types.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_screen_types.h"
39 #include "DNA_windowmanager_types.h"
40
41 #include "MEM_guardedalloc.h"
42
43 #include "BLI_blenlib.h"
44 #include "BLI_math.h"
45 #include "BLI_rand.h"
46
47 #include "BKE_animsys.h"
48 #include "BKE_nla.h"
49 #include "BKE_context.h"
50 #include "BKE_report.h"
51 #include "BKE_screen.h"
52
53 #include "ED_anim_api.h"
54 #include "ED_keyframes_edit.h"
55 #include "ED_markers.h"
56 #include "ED_space_api.h"
57 #include "ED_screen.h"
58
59 #include "RNA_access.h"
60 #include "RNA_define.h"
61
62 #include "WM_api.h"
63 #include "WM_types.h"
64
65 #include "UI_interface.h"
66 #include "UI_resources.h"
67 #include "UI_view2d.h"
68
69 #include "nla_intern.h" // own include
70
71 /* ******************** Utilities ***************************************** */
72
73 /* Convert SELECT_* flags to ACHANNEL_SETFLAG_* flags */
74 static short selmodes_to_flagmodes (short sel)
75 {
76         /* convert selection modes to selection modes */
77         switch (sel) {
78                 case SELECT_SUBTRACT:
79                         return ACHANNEL_SETFLAG_CLEAR;
80                         break;
81                         
82                 case SELECT_INVERT:
83                         return ACHANNEL_SETFLAG_TOGGLE;
84                         break;
85                         
86                 case SELECT_ADD:
87                 default:
88                         return ACHANNEL_SETFLAG_ADD;
89                         break;
90         }
91 }
92
93
94 /* ******************** Deselect All Operator ***************************** */
95 /* This operator works in one of three ways:
96  *      1) (de)select all (AKEY) - test if select all or deselect all
97  *      2) invert all (CTRL-IKEY) - invert selection of all keyframes
98  *      3) (de)select all - no testing is done; only for use internal tools as normal function...
99  */
100
101 enum {
102         DESELECT_STRIPS_NOTEST = 0,
103         DESELECT_STRIPS_TEST,
104         DESELECT_STRIPS_CLEARACTIVE,
105 } eDeselectNlaStrips;
106  
107 /* Deselects strips in the NLA Editor
108  *      - This is called by the deselect all operator, as well as other ones!
109  *
110  *      - test: check if select or deselect all (1) or clear all active (2)
111  *      - sel: how to select keyframes 
112  *              0 = deselect
113  *              1 = select
114  *              2 = invert
115  */
116 static void deselect_nla_strips (bAnimContext *ac, short test, short sel)
117 {
118         ListBase anim_data = {NULL, NULL};
119         bAnimListElem *ale;
120         int filter;
121         short smode;
122         
123         /* determine type-based settings */
124         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_NLATRACKS);
125         
126         /* filter data */
127         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
128         
129         /* See if we should be selecting or deselecting */
130         if (test == DESELECT_STRIPS_TEST) {
131                 for (ale= anim_data.first; ale; ale= ale->next) {
132                         NlaTrack *nlt= (NlaTrack *)ale->data;
133                         NlaStrip *strip;
134                         
135                         /* if any strip is selected, break out, since we should now be deselecting */
136                         for (strip= nlt->strips.first; strip; strip= strip->next) {
137                                 if (strip->flag & NLASTRIP_FLAG_SELECT) {
138                                         sel= SELECT_SUBTRACT;
139                                         break;
140                                 }
141                         }
142                         
143                         if (sel == SELECT_SUBTRACT)
144                                 break;
145                 }
146         }
147         
148         /* convert selection modes to selection modes */
149         smode= selmodes_to_flagmodes(sel);
150         
151         /* Now set the flags */
152         for (ale= anim_data.first; ale; ale= ale->next) {
153                 NlaTrack *nlt= (NlaTrack *)ale->data;
154                 NlaStrip *strip;
155                 
156                 /* apply same selection to all strips */
157                 for (strip= nlt->strips.first; strip; strip= strip->next) {
158                         /* set selection */
159                         if (test != DESELECT_STRIPS_CLEARACTIVE)
160                                 ACHANNEL_SET_FLAG(strip, smode, NLASTRIP_FLAG_SELECT);
161                         
162                         /* clear active flag */
163                         // TODO: for clear active, do we want to limit this to only doing this on a certain set of tracks though?
164                         strip->flag &= ~NLASTRIP_FLAG_ACTIVE;
165                 }
166         }
167         
168         /* Cleanup */
169         BLI_freelistN(&anim_data);
170 }
171
172 /* ------------------- */
173
174 static int nlaedit_deselectall_exec(bContext *C, wmOperator *op)
175 {
176         bAnimContext ac;
177         
178         /* get editor data */
179         if (ANIM_animdata_get_context(C, &ac) == 0)
180                 return OPERATOR_CANCELLED;
181                 
182         /* 'standard' behaviour - check if selected, then apply relevant selection */
183         if (RNA_boolean_get(op->ptr, "invert"))
184                 deselect_nla_strips(&ac, DESELECT_STRIPS_NOTEST, SELECT_INVERT);
185         else
186                 deselect_nla_strips(&ac, DESELECT_STRIPS_TEST, SELECT_ADD);
187         
188         /* set notifier that things have changed */
189         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA_SELECT, NULL);
190         
191         return OPERATOR_FINISHED;
192 }
193  
194 void NLA_OT_select_all_toggle (wmOperatorType *ot)
195 {
196         /* identifiers */
197         ot->name= "Select All";
198         ot->idname= "NLA_OT_select_all_toggle";
199         
200         /* api callbacks */
201         ot->exec= nlaedit_deselectall_exec;
202         ot->poll= nlaop_poll_tweakmode_off;
203         
204         /* flags */
205         ot->flag= OPTYPE_REGISTER/*|OPTYPE_UNDO*/;
206         
207         /* props */
208         RNA_def_boolean(ot->srna, "invert", 0, "Invert", "");
209 }
210
211 /* ******************** Border Select Operator **************************** */
212 /* This operator currently works in one of three ways:
213  *      -> BKEY         - 1) all strips within region are selected (ACTKEYS_BORDERSEL_ALLSTRIPS)
214  *      -> ALT-BKEY - depending on which axis of the region was larger...
215  *              -> 2) x-axis, so select all frames within frame range (ACTKEYS_BORDERSEL_FRAMERANGE)
216  *              -> 3) y-axis, so select all frames within channels that region included (ACTKEYS_BORDERSEL_CHANNELS)
217  */
218
219 /* defines for borderselect mode */
220 enum {
221         NLA_BORDERSEL_ALLSTRIPS = 0,
222         NLA_BORDERSEL_FRAMERANGE,
223         NLA_BORDERSEL_CHANNELS,
224 } eActKeys_BorderSelect_Mode;
225
226
227 static void borderselect_nla_strips (bAnimContext *ac, rcti rect, short mode, short selectmode)
228 {
229         ListBase anim_data = {NULL, NULL};
230         bAnimListElem *ale;
231         int filter;
232         
233         View2D *v2d= &ac->ar->v2d;
234         rctf rectf;
235         float ymin=(float)(-NLACHANNEL_HEIGHT), ymax=0;
236         
237         /* convert border-region to view coordinates */
238         UI_view2d_region_to_view(v2d, rect.xmin, rect.ymin+2, &rectf.xmin, &rectf.ymin);
239         UI_view2d_region_to_view(v2d, rect.xmax, rect.ymax-2, &rectf.xmax, &rectf.ymax);
240         
241         /* filter data */
242         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CHANNELS);
243         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
244         
245         /* convert selection modes to selection modes */
246         selectmode= selmodes_to_flagmodes(selectmode);
247         
248         /* loop over data, doing border select */
249         for (ale= anim_data.first; ale; ale= ale->next) {
250                 ymin= ymax - NLACHANNEL_STEP;
251                 
252                 /* perform vertical suitability check (if applicable) */
253                 if ( (mode == NLA_BORDERSEL_FRAMERANGE) ||
254                         !((ymax < rectf.ymin) || (ymin > rectf.ymax)) ) 
255                 {
256                         /* loop over data selecting (only if NLA-Track) */
257                         if (ale->type == ANIMTYPE_NLATRACK) {
258                                 NlaTrack *nlt= (NlaTrack *)ale->data;
259                                 NlaStrip *strip;
260                                 
261                                 /* only select strips if they fall within the required ranges (if applicable) */
262                                 for (strip= nlt->strips.first; strip; strip= strip->next) {
263                                         if ( (mode == NLA_BORDERSEL_CHANNELS) || 
264                                                   BKE_nlastrip_within_bounds(strip, rectf.xmin, rectf.xmax) ) 
265                                         {
266                                                 /* set selection */
267                                                 ACHANNEL_SET_FLAG(strip, selectmode, NLASTRIP_FLAG_SELECT);
268                                                 
269                                                 /* clear active flag */
270                                                 strip->flag &= ~NLASTRIP_FLAG_ACTIVE;
271                                         }
272                                 }
273                         }
274                 }
275                 
276                 /* set minimum extent to be the maximum of the next channel */
277                 ymax= ymin;
278         }
279         
280         /* cleanup */
281         BLI_freelistN(&anim_data);
282 }
283
284 /* ------------------- */
285
286 static int nlaedit_borderselect_exec(bContext *C, wmOperator *op)
287 {
288         bAnimContext ac;
289         rcti rect;
290         short mode=0, selectmode=0;
291         
292         /* get editor data */
293         if (ANIM_animdata_get_context(C, &ac) == 0)
294                 return OPERATOR_CANCELLED;
295         
296         /* get settings from operator */
297         rect.xmin= RNA_int_get(op->ptr, "xmin");
298         rect.ymin= RNA_int_get(op->ptr, "ymin");
299         rect.xmax= RNA_int_get(op->ptr, "xmax");
300         rect.ymax= RNA_int_get(op->ptr, "ymax");
301                 
302         if (RNA_int_get(op->ptr, "gesture_mode") == GESTURE_MODAL_SELECT)
303                 selectmode = SELECT_ADD;
304         else
305                 selectmode = SELECT_SUBTRACT;
306         
307         /* selection 'mode' depends on whether borderselect region only matters on one axis */
308         if (RNA_boolean_get(op->ptr, "axis_range")) {
309                 /* mode depends on which axis of the range is larger to determine which axis to use 
310                  *      - checking this in region-space is fine, as it's fundamentally still going to be a different rect size
311                  *      - the frame-range select option is favoured over the channel one (x over y), as frame-range one is often
312                  *        used for tweaking timing when "blocking", while channels is not that useful...
313                  */
314                 if ((rect.xmax - rect.xmin) >= (rect.ymax - rect.ymin))
315                         mode= NLA_BORDERSEL_FRAMERANGE;
316                 else
317                         mode= NLA_BORDERSEL_CHANNELS;
318         }
319         else 
320                 mode= NLA_BORDERSEL_ALLSTRIPS;
321         
322         /* apply borderselect action */
323         borderselect_nla_strips(&ac, rect, mode, selectmode);
324         
325         /* set notifier that things have changed */
326         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA_SELECT, NULL);
327         
328         return OPERATOR_FINISHED;
329
330
331 void NLA_OT_select_border(wmOperatorType *ot)
332 {
333         /* identifiers */
334         ot->name= "Border Select";
335         ot->idname= "NLA_OT_select_border";
336         
337         /* api callbacks */
338         ot->invoke= WM_border_select_invoke;
339         ot->exec= nlaedit_borderselect_exec;
340         ot->modal= WM_border_select_modal;
341         
342         ot->poll= nlaop_poll_tweakmode_off;
343         
344         /* flags */
345         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
346         
347         /* rna */
348         WM_operator_properties_gesture_border(ot, 0);
349         
350         RNA_def_boolean(ot->srna, "axis_range", 0, "Axis Range", "");
351 }
352
353 /* ******************** Mouse-Click Select Operator *********************** */
354 /* This operator works in one of 2 ways:
355  *      1) Select the strip directly under the mouse
356  *      2) Select all the strips to one side of the mouse
357  */
358
359 /* defines for left-right select tool */
360 static EnumPropertyItem prop_nlaedit_leftright_select_types[] = {
361         {NLAEDIT_LRSEL_TEST, "CHECK", 0, "Check if Select Left or Right", ""},
362         {NLAEDIT_LRSEL_NONE, "OFF", 0, "Don't select", ""},
363         {NLAEDIT_LRSEL_LEFT, "LEFT", 0, "Before current frame", ""},
364         {NLAEDIT_LRSEL_RIGHT, "RIGHT", 0, "After current frame", ""},
365         {0, NULL, 0, NULL, NULL}
366 };
367
368 /* sensitivity factor for frame-selections */
369 #define FRAME_CLICK_THRESH              0.1f
370
371
372 /* ------------------- */
373
374 /* option 1) select strip directly under mouse */
375 static void mouse_nla_strips (bContext *C, bAnimContext *ac, int mval[2], short select_mode)
376 {
377         ListBase anim_data = {NULL, NULL};
378         bAnimListElem *ale = NULL;
379         int filter;
380         
381         View2D *v2d= &ac->ar->v2d;
382         Scene *scene= ac->scene;
383         NlaStrip *strip = NULL;
384         int channel_index;
385         float xmin, xmax, dummy;
386         float x, y;
387         
388         
389         /* use View2D to determine the index of the channel (i.e a row in the list) where keyframe was */
390         UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, &y);
391         UI_view2d_listview_view_to_cell(v2d, 0, NLACHANNEL_STEP, 0, (float)NLACHANNEL_HEIGHT_HALF, x, y, NULL, &channel_index);
392         
393         /* x-range to check is +/- 7 (in screen/region-space) on either side of mouse click 
394          * (that is the size of keyframe icons, so user should be expecting similar tolerances) 
395          */
396         UI_view2d_region_to_view(v2d, mval[0]-7, mval[1], &xmin, &dummy);
397         UI_view2d_region_to_view(v2d, mval[0]+7, mval[1], &xmax, &dummy);
398         
399         /* filter data */
400         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CHANNELS);
401         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
402         
403         /* try to get channel */
404         ale= BLI_findlink(&anim_data, channel_index);
405         if (ale == NULL) {
406                 /* channel not found */
407                 printf("Error: animation channel (index = %d) not found in mouse_nla_strips() \n", channel_index);
408                 BLI_freelistN(&anim_data);
409                 return;
410         }
411         else {
412                 /* found some channel - we only really should do somethign when its an Nla-Track */
413                 if (ale->type == ANIMTYPE_NLATRACK) {
414                         NlaTrack *nlt= (NlaTrack *)ale->data;
415                         
416                         /* loop over NLA-strips in this track, trying to find one which occurs in the necessary bounds */
417                         for (strip= nlt->strips.first; strip; strip= strip->next) {
418                                 if (BKE_nlastrip_within_bounds(strip, xmin, xmax))
419                                         break;
420                         }
421                 }
422                 
423                 /* remove active channel from list of channels for separate treatment (since it's needed later on) */
424                 BLI_remlink(&anim_data, ale);
425                 
426                 /* free list of channels, since it's not used anymore */
427                 BLI_freelistN(&anim_data);
428         }
429         
430         /* if currently in tweakmode, exit tweakmode before changing selection states
431          * now that we've found our target...
432          */
433         if (scene->flag & SCE_NLA_EDIT_ON)
434                 WM_operator_name_call(C, "NLA_OT_tweakmode_exit", WM_OP_EXEC_DEFAULT, NULL);
435         
436         /* for replacing selection, firstly need to clear existing selection */
437         if (select_mode == SELECT_REPLACE) {
438                 /* reset selection mode for next steps */
439                 select_mode = SELECT_ADD;
440                 
441                 /* deselect all strips */
442                 deselect_nla_strips(ac, 0, SELECT_SUBTRACT);
443                 
444                 /* deselect all other channels first */
445                 ANIM_deselect_anim_channels(ac, ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
446                 
447                 /* Highlight NLA-Track */
448                 if (ale->type == ANIMTYPE_NLATRACK) {   
449                         NlaTrack *nlt= (NlaTrack *)ale->data;
450                         
451                         nlt->flag |= NLATRACK_SELECTED;
452                         ANIM_set_active_channel(ac, ac->data, ac->datatype, filter, nlt, ANIMTYPE_NLATRACK);
453                 }
454         }
455         
456         /* only select strip if we clicked on a valid channel and hit something */
457         if (ale) {
458                 /* select the strip accordingly (if a matching one was found) */
459                 if (strip) {
460                         select_mode= selmodes_to_flagmodes(select_mode);
461                         ACHANNEL_SET_FLAG(strip, select_mode, NLASTRIP_FLAG_SELECT);
462                         
463                         /* if we selected it, we can make it active too
464                          *      - we always need to clear the active strip flag though... 
465                          */
466                         deselect_nla_strips(ac, DESELECT_STRIPS_CLEARACTIVE, 0);
467                         if (strip->flag & NLASTRIP_FLAG_SELECT)
468                                 strip->flag |= NLASTRIP_FLAG_ACTIVE;
469                 }
470                 
471                 /* free this channel */
472                 MEM_freeN(ale);
473         }
474 }
475
476 /* Option 2) Selects all the strips on either side of the current frame (depends on which side the mouse is on) */
477 static void nlaedit_mselect_leftright (bContext *C, bAnimContext *ac, short leftright, short select_mode)
478 {
479         ListBase anim_data = {NULL, NULL};
480         bAnimListElem *ale;
481         int filter;
482         
483         Scene *scene= ac->scene;
484         float xmin, xmax;
485         
486         /* if currently in tweakmode, exit tweakmode first */
487         if (scene->flag & SCE_NLA_EDIT_ON)
488                 WM_operator_name_call(C, "NLA_OT_tweakmode_exit", WM_OP_EXEC_DEFAULT, NULL);
489         
490         /* if select mode is replace, deselect all keyframes (and channels) first */
491         if (select_mode==SELECT_REPLACE) {
492                 select_mode= SELECT_ADD;
493                 
494                 /* deselect all other channels and keyframes */
495                 ANIM_deselect_anim_channels(ac, ac->data, ac->datatype, 0, ACHANNEL_SETFLAG_CLEAR);
496                 deselect_nla_strips(ac, 0, SELECT_SUBTRACT);
497         }
498         
499         /* get range, and get the right flag-setting mode */
500         if (leftright == NLAEDIT_LRSEL_LEFT) {
501                 xmin = MINAFRAMEF;
502                 xmax = (float)(CFRA + FRAME_CLICK_THRESH);
503         } 
504         else {
505                 xmin = (float)(CFRA - FRAME_CLICK_THRESH);
506                 xmax = MAXFRAMEF;
507         }
508         
509         select_mode= selmodes_to_flagmodes(select_mode);
510         
511         
512         /* filter data */
513         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_NLATRACKS);
514         ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
515         
516         /* select strips on the side where most data occurs */
517         for (ale= anim_data.first; ale; ale= ale->next) {
518                 NlaTrack *nlt= (NlaTrack *)ale->data;
519                 NlaStrip *strip;
520                 
521                 /* check each strip to see if it is appropriate */
522                 for (strip= nlt->strips.first; strip; strip= strip->next) {
523                         if (BKE_nlastrip_within_bounds(strip, xmin, xmax)) {
524                                 ACHANNEL_SET_FLAG(strip, select_mode, NLASTRIP_FLAG_SELECT);
525                         }
526                 }
527         }
528         
529         /* Cleanup */
530         BLI_freelistN(&anim_data);
531 }
532
533 /* ------------------- */
534
535 /* handle clicking */
536 static int nlaedit_clickselect_invoke(bContext *C, wmOperator *op, wmEvent *event)
537 {
538         bAnimContext ac;
539         Scene *scene;
540         ARegion *ar;
541         View2D *v2d;
542         short selectmode;
543         int mval[2];
544         
545         /* get editor data */
546         if (ANIM_animdata_get_context(C, &ac) == 0)
547                 return OPERATOR_CANCELLED;
548                 
549         /* get useful pointers from animation context data */
550         scene= ac.scene;
551         ar= ac.ar;
552         v2d= &ar->v2d;
553         
554         /* get mouse coordinates (in region coordinates) */
555         mval[0]= (event->x - ar->winrct.xmin);
556         mval[1]= (event->y - ar->winrct.ymin);
557         
558         /* select mode is either replace (deselect all, then add) or add/extend */
559         if (RNA_boolean_get(op->ptr, "extend"))
560                 selectmode= SELECT_INVERT;
561         else
562                 selectmode= SELECT_REPLACE;
563         
564         /* figure out action to take */
565         if (RNA_enum_get(op->ptr, "left_right")) {
566                 /* select all keys on same side of current frame as mouse */
567                 float x;
568                 
569                 UI_view2d_region_to_view(v2d, mval[0], mval[1], &x, NULL);
570                 if (x < CFRA)
571                         RNA_int_set(op->ptr, "left_right", NLAEDIT_LRSEL_LEFT);
572                 else    
573                         RNA_int_set(op->ptr, "left_right", NLAEDIT_LRSEL_RIGHT);
574                 
575                 nlaedit_mselect_leftright(C, &ac, RNA_enum_get(op->ptr, "left_right"), selectmode);
576         }
577         else {
578                 /* select strips based upon mouse position */
579                 mouse_nla_strips(C, &ac, mval, selectmode);
580         }
581         
582         /* set notifier that things have changed */
583         WM_event_add_notifier(C, NC_ANIMATION|ND_NLA_SELECT, NULL);
584         
585         /* for tweak grab to work */
586         return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
587 }
588  
589 void NLA_OT_click_select (wmOperatorType *ot)
590 {
591         /* identifiers */
592         ot->name= "Mouse Select";
593         ot->idname= "NLA_OT_click_select";
594         
595         /* api callbacks - absolutely no exec() this yet... */
596         ot->invoke= nlaedit_clickselect_invoke;
597         ot->poll= ED_operator_nla_active;
598         
599         /* flags */
600         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
601         
602         /* id-props */
603         // XXX should we make this into separate operators?
604         RNA_def_enum(ot->srna, "left_right", prop_nlaedit_leftright_select_types, 0, "Left Right", ""); // CTRLKEY
605         RNA_def_boolean(ot->srna, "extend", 0, "Extend Select", ""); // SHIFTKEY
606 }
607
608 /* *********************************************** */