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