Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / animation / anim_ops.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation, Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/animation/anim_ops.c
28  *  \ingroup edanimation
29  */
30
31
32 #include <stdlib.h>
33 #include <math.h>
34
35 #include "BLI_sys_types.h"
36
37 #include "BLI_utildefines.h"
38 #include "BLI_math_base.h"
39
40 #include "DNA_anim_types.h"
41 #include "DNA_scene_types.h"
42
43 #include "BKE_context.h"
44 #include "BKE_sequencer.h"
45 #include "BKE_global.h"
46 #include "BKE_main.h"
47 #include "BKE_sound.h"
48
49 #include "UI_view2d.h"
50
51 #include "RNA_access.h"
52 #include "RNA_define.h"
53
54 #include "WM_api.h"
55 #include "WM_types.h"
56
57 #include "ED_anim_api.h"
58 #include "ED_screen.h"
59 #include "ED_sequencer.h"
60 #include "ED_util.h"
61
62 #include "anim_intern.h"
63
64 /* ********************** frame change operator ***************************/
65
66 /* Check if the operator can be run from the current context */
67 static int change_frame_poll(bContext *C)
68 {
69         ScrArea *sa = CTX_wm_area(C);
70
71         /* XXX temp? prevent changes during render */
72         if (G.is_rendering) return false;
73
74         /* although it's only included in keymaps for regions using ED_KEYMAP_ANIMATION,
75          * this shouldn't show up in 3D editor (or others without 2D timeline view) via search
76          */
77         if (sa) {
78                 if (ELEM(sa->spacetype, SPACE_ACTION, SPACE_NLA, SPACE_SEQ, SPACE_CLIP)) {
79                         return true;
80                 }
81                 else if (sa->spacetype == SPACE_IPO) {
82                         /* NOTE: Graph Editor has special version which does some extra stuff.
83                          * No need to show the generic error message for that case though!
84                          */
85                         return false;
86                 }
87         }
88
89         CTX_wm_operator_poll_msg_set(C, "Expected an animation area to be active");
90         return false;
91 }
92
93 /* Set the new frame number */
94 static void change_frame_apply(bContext *C, wmOperator *op)
95 {
96         Main *bmain = CTX_data_main(C);
97         Scene *scene = CTX_data_scene(C);
98         float frame = RNA_float_get(op->ptr, "frame");
99         bool do_snap = RNA_boolean_get(op->ptr, "snap");
100
101         if (do_snap && CTX_wm_space_seq(C)) {
102                 frame = BKE_sequencer_find_next_prev_edit(scene, frame, SEQ_SIDE_BOTH, true, false, false);
103         }
104
105         /* set the new frame number */
106         if (scene->r.flag & SCER_SHOW_SUBFRAME) {
107                 CFRA = (int)frame;
108                 SUBFRA = frame - (int)frame;
109         }
110         else {
111                 CFRA = round_fl_to_int(frame);
112                 SUBFRA = 0.0f;
113         }
114         FRAMENUMBER_MIN_CLAMP(CFRA);
115
116         /* do updates */
117         BKE_sound_seek_scene(bmain, scene);
118         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
119 }
120
121 /* ---- */
122
123 /* Non-modal callback for running operator without user input */
124 static int change_frame_exec(bContext *C, wmOperator *op)
125 {
126         change_frame_apply(C, op);
127
128         return OPERATOR_FINISHED;
129 }
130
131 /* ---- */
132
133 /* Get frame from mouse coordinates */
134 static float frame_from_event(bContext *C, const wmEvent *event)
135 {
136         ARegion *region = CTX_wm_region(C);
137         Scene *scene = CTX_data_scene(C);
138         float frame;
139
140         /* convert from region coordinates to View2D 'tot' space */
141         frame = UI_view2d_region_to_view_x(&region->v2d, event->mval[0]);
142
143         /* respect preview range restrictions (if only allowed to move around within that range) */
144         if (scene->r.flag & SCER_LOCK_FRAME_SELECTION) {
145                 CLAMP(frame, PSFRA, PEFRA);
146         }
147
148         return frame;
149 }
150
151 static void change_frame_seq_preview_begin(bContext *C, const wmEvent *event)
152 {
153         ScrArea *sa = CTX_wm_area(C);
154         bScreen *screen = CTX_wm_screen(C);
155         if (sa && sa->spacetype == SPACE_SEQ) {
156                 SpaceSeq *sseq = sa->spacedata.first;
157                 if (ED_space_sequencer_check_show_strip(sseq)) {
158                         ED_sequencer_special_preview_set(C, event->mval);
159                 }
160         }
161         if (screen)
162                 screen->scrubbing = true;
163 }
164
165 static void change_frame_seq_preview_end(bContext *C)
166 {
167         bScreen *screen = CTX_wm_screen(C);
168         bool notify = false;
169
170         if (screen->scrubbing) {
171                 screen->scrubbing = false;
172                 notify = true;
173         }
174
175         if (ED_sequencer_special_preview_get() != NULL) {
176                 ED_sequencer_special_preview_clear();
177                 notify = true;
178         }
179
180         if (notify) {
181                 Scene *scene = CTX_data_scene(C);
182                 WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
183         }
184 }
185
186 /* Modal Operator init */
187 static int change_frame_invoke(bContext *C, wmOperator *op, const wmEvent *event)
188 {
189         /* Change to frame that mouse is over before adding modal handler,
190          * as user could click on a single frame (jump to frame) as well as
191          * click-dragging over a range (modal scrubbing).
192          */
193         RNA_float_set(op->ptr, "frame", frame_from_event(C, event));
194
195         change_frame_seq_preview_begin(C, event);
196
197         change_frame_apply(C, op);
198
199         /* add temp handler */
200         WM_event_add_modal_handler(C, op);
201
202         return OPERATOR_RUNNING_MODAL;
203 }
204
205 static void change_frame_cancel(bContext *C, wmOperator *UNUSED(op))
206 {
207         change_frame_seq_preview_end(C);
208 }
209
210 /* Modal event handling of frame changing */
211 static int change_frame_modal(bContext *C, wmOperator *op, const wmEvent *event)
212 {
213         int ret = OPERATOR_RUNNING_MODAL;
214         /* execute the events */
215         switch (event->type) {
216                 case ESCKEY:
217                         ret = OPERATOR_FINISHED;
218                         break;
219
220                 case MOUSEMOVE:
221                         RNA_float_set(op->ptr, "frame", frame_from_event(C, event));
222                         change_frame_apply(C, op);
223                         break;
224
225                 case LEFTMOUSE:
226                 case RIGHTMOUSE:
227                 case MIDDLEMOUSE:
228                         /* we check for either mouse-button to end, as checking for ACTIONMOUSE (which is used to init
229                          * the modal op) doesn't work for some reason
230                          */
231                         if (event->val == KM_RELEASE)
232                                 ret = OPERATOR_FINISHED;
233                         break;
234
235                 case LEFTCTRLKEY:
236                 case RIGHTCTRLKEY:
237                         if (event->val == KM_RELEASE) {
238                                 RNA_boolean_set(op->ptr, "snap", false);
239                         }
240                         else if (event->val == KM_PRESS) {
241                                 RNA_boolean_set(op->ptr, "snap", true);
242                         }
243                         break;
244         }
245
246         if (ret != OPERATOR_RUNNING_MODAL) {
247                 change_frame_seq_preview_end(C);
248         }
249
250         return ret;
251 }
252
253 static void ANIM_OT_change_frame(wmOperatorType *ot)
254 {
255         PropertyRNA *prop;
256
257         /* identifiers */
258         ot->name = "Change Frame";
259         ot->idname = "ANIM_OT_change_frame";
260         ot->description = "Interactively change the current frame number";
261
262         /* api callbacks */
263         ot->exec = change_frame_exec;
264         ot->invoke = change_frame_invoke;
265         ot->cancel = change_frame_cancel;
266         ot->modal = change_frame_modal;
267         ot->poll = change_frame_poll;
268
269         /* flags */
270         ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_CURSOR | OPTYPE_UNDO_GROUPED;
271         ot->undo_group = "FRAME_CHANGE";
272
273         /* rna */
274         ot->prop = RNA_def_float(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
275         prop = RNA_def_boolean(ot->srna, "snap", false, "Snap", "");
276         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
277 }
278
279
280 /* ****************** Start/End Frame Operators *******************************/
281
282 static int anim_set_end_frames_poll(bContext *C)
283 {
284         ScrArea *sa = CTX_wm_area(C);
285
286         /* XXX temp? prevent changes during render */
287         if (G.is_rendering) return false;
288
289         /* although it's only included in keymaps for regions using ED_KEYMAP_ANIMATION,
290          * this shouldn't show up in 3D editor (or others without 2D timeline view) via search
291          */
292         if (sa) {
293                 if (ELEM(sa->spacetype, SPACE_ACTION, SPACE_IPO, SPACE_NLA, SPACE_SEQ, SPACE_CLIP)) {
294                         return true;
295                 }
296         }
297
298         CTX_wm_operator_poll_msg_set(C, "Expected an animation area to be active");
299         return false;
300 }
301
302 static int anim_set_sfra_exec(bContext *C, wmOperator *UNUSED(op))
303 {
304         Scene *scene = CTX_data_scene(C);
305         int frame;
306
307         if (scene == NULL)
308                 return OPERATOR_CANCELLED;
309
310         frame = CFRA;
311
312         /* if Preview Range is defined, set the 'start' frame for that */
313         if (PRVRANGEON)
314                 scene->r.psfra = frame;
315         else
316                 scene->r.sfra = frame;
317
318         if (PEFRA < frame) {
319                 if (PRVRANGEON)
320                         scene->r.pefra = frame;
321                 else
322                         scene->r.efra = frame;
323         }
324
325         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
326
327         return OPERATOR_FINISHED;
328 }
329
330 static void ANIM_OT_start_frame_set(wmOperatorType *ot)
331 {
332         /* identifiers */
333         ot->name = "Set Start Frame";
334         ot->idname = "ANIM_OT_start_frame_set";
335         ot->description = "Set the start frame";
336
337         /* api callbacks */
338         ot->exec = anim_set_sfra_exec;
339         ot->poll = anim_set_end_frames_poll;
340
341         /* flags */
342         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
343 }
344
345
346 static int anim_set_efra_exec(bContext *C, wmOperator *UNUSED(op))
347 {
348         Scene *scene = CTX_data_scene(C);
349         int frame;
350
351         if (scene == NULL)
352                 return OPERATOR_CANCELLED;
353
354         frame = CFRA;
355
356         /* if Preview Range is defined, set the 'end' frame for that */
357         if (PRVRANGEON)
358                 scene->r.pefra = frame;
359         else
360                 scene->r.efra = frame;
361
362         if (PSFRA > frame) {
363                 if (PRVRANGEON)
364                         scene->r.psfra = frame;
365                 else
366                         scene->r.sfra = frame;
367         }
368
369         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
370
371         return OPERATOR_FINISHED;
372 }
373
374 static void ANIM_OT_end_frame_set(wmOperatorType *ot)
375 {
376         /* identifiers */
377         ot->name = "Set End Frame";
378         ot->idname = "ANIM_OT_end_frame_set";
379         ot->description = "Set the end frame";
380
381         /* api callbacks */
382         ot->exec = anim_set_efra_exec;
383         ot->poll = anim_set_end_frames_poll;
384
385         /* flags */
386         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
387 }
388
389 /* ****************** set preview range operator ****************************/
390
391 static int previewrange_define_exec(bContext *C, wmOperator *op)
392 {
393         Scene *scene = CTX_data_scene(C);
394         ARegion *ar = CTX_wm_region(C);
395         float sfra, efra;
396         rcti rect;
397
398         /* get min/max values from border select rect (already in region coordinates, not screen) */
399         WM_operator_properties_border_to_rcti(op, &rect);
400
401         /* convert min/max values to frames (i.e. region to 'tot' rect) */
402         sfra = UI_view2d_region_to_view_x(&ar->v2d, rect.xmin);
403         efra = UI_view2d_region_to_view_x(&ar->v2d, rect.xmax);
404
405         /* set start/end frames for preview-range
406          *      - must clamp within allowable limits
407          *      - end must not be before start (though this won't occur most of the time)
408          */
409         FRAMENUMBER_MIN_CLAMP(sfra);
410         FRAMENUMBER_MIN_CLAMP(efra);
411         if (efra < sfra) efra = sfra;
412
413         scene->r.flag |= SCER_PRV_RANGE;
414         scene->r.psfra = round_fl_to_int(sfra);
415         scene->r.pefra = round_fl_to_int(efra);
416
417         /* send notifiers */
418         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
419
420         return OPERATOR_FINISHED;
421 }
422
423 static void ANIM_OT_previewrange_set(wmOperatorType *ot)
424 {
425         /* identifiers */
426         ot->name = "Set Preview Range";
427         ot->idname = "ANIM_OT_previewrange_set";
428         ot->description = "Interactively define frame range used for playback";
429
430         /* api callbacks */
431         ot->invoke = WM_gesture_border_invoke;
432         ot->exec = previewrange_define_exec;
433         ot->modal = WM_gesture_border_modal;
434         ot->cancel = WM_gesture_border_cancel;
435
436         ot->poll = ED_operator_animview_active;
437
438         /* flags */
439         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
440
441         /* rna */
442         /* used to define frame range.
443          *
444          * note: border Y values are not used,
445          * but are needed by borderselect gesture operator stuff */
446         WM_operator_properties_border(ot);
447 }
448
449 /* ****************** clear preview range operator ****************************/
450
451 static int previewrange_clear_exec(bContext *C, wmOperator *UNUSED(op))
452 {
453         Scene *scene = CTX_data_scene(C);
454         ScrArea *curarea = CTX_wm_area(C);
455
456         /* sanity checks */
457         if (ELEM(NULL, scene, curarea))
458                 return OPERATOR_CANCELLED;
459
460         /* simply clear values */
461         scene->r.flag &= ~SCER_PRV_RANGE;
462         scene->r.psfra = 0;
463         scene->r.pefra = 0;
464
465         ED_area_tag_redraw(curarea);
466
467         /* send notifiers */
468         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
469
470         return OPERATOR_FINISHED;
471 }
472
473 static void ANIM_OT_previewrange_clear(wmOperatorType *ot)
474 {
475         /* identifiers */
476         ot->name = "Clear Preview Range";
477         ot->idname = "ANIM_OT_previewrange_clear";
478         ot->description = "Clear Preview Range";
479
480         /* api callbacks */
481         ot->exec = previewrange_clear_exec;
482
483         ot->poll = ED_operator_animview_active;
484
485         /* flags */
486         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
487 }
488
489 /* ************************** registration **********************************/
490
491 void ED_operatortypes_anim(void)
492 {
493         /* Animation Editors only -------------------------- */
494         WM_operatortype_append(ANIM_OT_change_frame);
495
496         WM_operatortype_append(ANIM_OT_start_frame_set);
497         WM_operatortype_append(ANIM_OT_end_frame_set);
498
499         WM_operatortype_append(ANIM_OT_previewrange_set);
500         WM_operatortype_append(ANIM_OT_previewrange_clear);
501
502         /* Entire UI --------------------------------------- */
503         WM_operatortype_append(ANIM_OT_keyframe_insert);
504         WM_operatortype_append(ANIM_OT_keyframe_delete);
505         WM_operatortype_append(ANIM_OT_keyframe_insert_menu);
506         WM_operatortype_append(ANIM_OT_keyframe_delete_v3d);
507         WM_operatortype_append(ANIM_OT_keyframe_clear_v3d);
508         WM_operatortype_append(ANIM_OT_keyframe_insert_button);
509         WM_operatortype_append(ANIM_OT_keyframe_delete_button);
510         WM_operatortype_append(ANIM_OT_keyframe_clear_button);
511
512
513         WM_operatortype_append(ANIM_OT_driver_button_add);
514         WM_operatortype_append(ANIM_OT_driver_button_remove);
515         WM_operatortype_append(ANIM_OT_driver_button_edit);
516         WM_operatortype_append(ANIM_OT_copy_driver_button);
517         WM_operatortype_append(ANIM_OT_paste_driver_button);
518
519
520         WM_operatortype_append(ANIM_OT_keyingset_button_add);
521         WM_operatortype_append(ANIM_OT_keyingset_button_remove);
522
523         WM_operatortype_append(ANIM_OT_keying_set_add);
524         WM_operatortype_append(ANIM_OT_keying_set_remove);
525         WM_operatortype_append(ANIM_OT_keying_set_path_add);
526         WM_operatortype_append(ANIM_OT_keying_set_path_remove);
527
528         WM_operatortype_append(ANIM_OT_keying_set_active_set);
529 }
530
531 void ED_keymap_anim(wmKeyConfig *keyconf)
532 {
533         wmKeyMap *keymap = WM_keymap_find(keyconf, "Animation", 0, 0);
534         wmKeyMapItem *kmi;
535
536         /* frame management */
537         /* NOTE: 'ACTIONMOUSE' not 'LEFTMOUSE', as user may have swapped mouse-buttons */
538         WM_keymap_add_item(keymap, "ANIM_OT_change_frame", ACTIONMOUSE, KM_PRESS, 0, 0);
539
540         kmi = WM_keymap_add_item(keymap, "WM_OT_context_toggle", TKEY, KM_PRESS, KM_CTRL, 0);
541         RNA_string_set(kmi->ptr, "data_path", "space_data.show_seconds");
542
543         /* preview range */
544         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_set", PKEY, KM_PRESS, 0, 0);
545         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_clear", PKEY, KM_PRESS, KM_ALT, 0);
546 }