Cleanup: remove redundant doxygen \file argument
[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 \ingroup edanimation
21  */
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) return false;
66
67         /* although it's only included in keymaps for regions using ED_KEYMAP_ANIMATION,
68          * this shouldn't show up in 3D editor (or others without 2D timeline view) via search
69          */
70         if (sa) {
71                 if (ELEM(sa->spacetype, SPACE_ACTION, SPACE_NLA, SPACE_SEQ, SPACE_CLIP)) {
72                         return true;
73                 }
74                 else if (sa->spacetype == SPACE_IPO) {
75                         /* NOTE: Graph Editor has special version which does some extra stuff.
76                          * No need to show the generic error message for that case though!
77                          */
78                         return false;
79                 }
80         }
81
82         CTX_wm_operator_poll_msg_set(C, "Expected an animation area to be active");
83         return false;
84 }
85
86 /* Set the new frame number */
87 static void change_frame_apply(bContext *C, wmOperator *op)
88 {
89         Main *bmain = CTX_data_main(C);
90         Scene *scene = CTX_data_scene(C);
91         float frame = RNA_float_get(op->ptr, "frame");
92         bool do_snap = RNA_boolean_get(op->ptr, "snap");
93
94         if (do_snap) {
95                 if (CTX_wm_space_seq(C)) {
96                         frame = BKE_sequencer_find_next_prev_edit(scene, frame, SEQ_SIDE_BOTH, true, false, false);
97                 }
98                 else {
99                         frame = BKE_scene_frame_snap_by_seconds(scene, 1.0, frame);
100                 }
101         }
102
103         /* set the new frame number */
104         if (scene->r.flag & SCER_SHOW_SUBFRAME) {
105                 CFRA = (int)frame;
106                 SUBFRA = frame - (int)frame;
107         }
108         else {
109                 CFRA = round_fl_to_int(frame);
110                 SUBFRA = 0.0f;
111         }
112         FRAMENUMBER_MIN_CLAMP(CFRA);
113
114         /* do updates */
115         BKE_sound_seek_scene(bmain, scene);
116         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
117 }
118
119 /* ---- */
120
121 /* Non-modal callback for running operator without user input */
122 static int change_frame_exec(bContext *C, wmOperator *op)
123 {
124         change_frame_apply(C, op);
125
126         return OPERATOR_FINISHED;
127 }
128
129 /* ---- */
130
131 /* Get frame from mouse coordinates */
132 static float frame_from_event(bContext *C, const wmEvent *event)
133 {
134         ARegion *region = CTX_wm_region(C);
135         Scene *scene = CTX_data_scene(C);
136         float frame;
137
138         /* convert from region coordinates to View2D 'tot' space */
139         frame = UI_view2d_region_to_view_x(&region->v2d, event->mval[0]);
140
141         /* respect preview range restrictions (if only allowed to move around within that range) */
142         if (scene->r.flag & SCER_LOCK_FRAME_SELECTION) {
143                 CLAMP(frame, PSFRA, PEFRA);
144         }
145
146         return frame;
147 }
148
149 static void change_frame_seq_preview_begin(bContext *C, const wmEvent *event)
150 {
151         ScrArea *sa = CTX_wm_area(C);
152         bScreen *screen = CTX_wm_screen(C);
153         if (sa && sa->spacetype == SPACE_SEQ) {
154                 SpaceSeq *sseq = sa->spacedata.first;
155                 if (ED_space_sequencer_check_show_strip(sseq)) {
156                         ED_sequencer_special_preview_set(C, event->mval);
157                 }
158         }
159         if (screen)
160                 screen->scrubbing = true;
161 }
162
163 static void change_frame_seq_preview_end(bContext *C)
164 {
165         bScreen *screen = CTX_wm_screen(C);
166         bool notify = false;
167
168         if (screen->scrubbing) {
169                 screen->scrubbing = false;
170                 notify = true;
171         }
172
173         if (ED_sequencer_special_preview_get() != NULL) {
174                 ED_sequencer_special_preview_clear();
175                 notify = true;
176         }
177
178         if (notify) {
179                 Scene *scene = CTX_data_scene(C);
180                 WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
181         }
182 }
183
184 /* Modal Operator init */
185 static int change_frame_invoke(bContext *C, wmOperator *op, const wmEvent *event)
186 {
187         /* Change to frame that mouse is over before adding modal handler,
188          * as user could click on a single frame (jump to frame) as well as
189          * click-dragging over a range (modal scrubbing).
190          */
191         RNA_float_set(op->ptr, "frame", frame_from_event(C, event));
192
193         change_frame_seq_preview_begin(C, event);
194
195         change_frame_apply(C, op);
196
197         /* add temp handler */
198         WM_event_add_modal_handler(C, op);
199
200         return OPERATOR_RUNNING_MODAL;
201 }
202
203 static void change_frame_cancel(bContext *C, wmOperator *UNUSED(op))
204 {
205         change_frame_seq_preview_end(C);
206 }
207
208 /* Modal event handling of frame changing */
209 static int change_frame_modal(bContext *C, wmOperator *op, const wmEvent *event)
210 {
211         int ret = OPERATOR_RUNNING_MODAL;
212         /* execute the events */
213         switch (event->type) {
214                 case ESCKEY:
215                         ret = OPERATOR_FINISHED;
216                         break;
217
218                 case MOUSEMOVE:
219                         RNA_float_set(op->ptr, "frame", frame_from_event(C, event));
220                         change_frame_apply(C, op);
221                         break;
222
223                 case LEFTMOUSE:
224                 case RIGHTMOUSE:
225                 case MIDDLEMOUSE:
226                         /* We check for either mouse-button to end, to work with all user keymaps. */
227                         if (event->val == KM_RELEASE)
228                                 ret = OPERATOR_FINISHED;
229                         break;
230
231                 case LEFTCTRLKEY:
232                 case RIGHTCTRLKEY:
233                         if (event->val == KM_RELEASE) {
234                                 RNA_boolean_set(op->ptr, "snap", false);
235                         }
236                         else if (event->val == KM_PRESS) {
237                                 RNA_boolean_set(op->ptr, "snap", true);
238                         }
239                         break;
240         }
241
242         if (ret != OPERATOR_RUNNING_MODAL) {
243                 change_frame_seq_preview_end(C);
244         }
245
246         return ret;
247 }
248
249 static void ANIM_OT_change_frame(wmOperatorType *ot)
250 {
251         PropertyRNA *prop;
252
253         /* identifiers */
254         ot->name = "Change Frame";
255         ot->idname = "ANIM_OT_change_frame";
256         ot->description = "Interactively change the current frame number";
257
258         /* api callbacks */
259         ot->exec = change_frame_exec;
260         ot->invoke = change_frame_invoke;
261         ot->cancel = change_frame_cancel;
262         ot->modal = change_frame_modal;
263         ot->poll = change_frame_poll;
264
265         /* flags */
266         ot->flag = OPTYPE_BLOCKING | OPTYPE_GRAB_CURSOR | OPTYPE_UNDO_GROUPED;
267         ot->undo_group = "Frame Change";
268
269         /* rna */
270         ot->prop = RNA_def_float(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
271         prop = RNA_def_boolean(ot->srna, "snap", false, "Snap", "");
272         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
273 }
274
275
276 /* ****************** Start/End Frame Operators *******************************/
277
278 static bool anim_set_end_frames_poll(bContext *C)
279 {
280         ScrArea *sa = CTX_wm_area(C);
281
282         /* XXX temp? prevent changes during render */
283         if (G.is_rendering) return false;
284
285         /* although it's only included in keymaps for regions using ED_KEYMAP_ANIMATION,
286          * this shouldn't show up in 3D editor (or others without 2D timeline view) via search
287          */
288         if (sa) {
289                 if (ELEM(sa->spacetype, SPACE_ACTION, SPACE_IPO, SPACE_NLA, SPACE_SEQ, SPACE_CLIP)) {
290                         return true;
291                 }
292         }
293
294         CTX_wm_operator_poll_msg_set(C, "Expected an animation area to be active");
295         return false;
296 }
297
298 static int anim_set_sfra_exec(bContext *C, wmOperator *UNUSED(op))
299 {
300         Scene *scene = CTX_data_scene(C);
301         int frame;
302
303         if (scene == NULL)
304                 return OPERATOR_CANCELLED;
305
306         frame = CFRA;
307
308         /* if Preview Range is defined, set the 'start' frame for that */
309         if (PRVRANGEON)
310                 scene->r.psfra = frame;
311         else
312                 scene->r.sfra = frame;
313
314         if (PEFRA < frame) {
315                 if (PRVRANGEON)
316                         scene->r.pefra = frame;
317                 else
318                         scene->r.efra = frame;
319         }
320
321         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
322
323         return OPERATOR_FINISHED;
324 }
325
326 static void ANIM_OT_start_frame_set(wmOperatorType *ot)
327 {
328         /* identifiers */
329         ot->name = "Set Start Frame";
330         ot->idname = "ANIM_OT_start_frame_set";
331         ot->description = "Set the current frame as the preview or scene start frame";
332
333         /* api callbacks */
334         ot->exec = anim_set_sfra_exec;
335         ot->poll = anim_set_end_frames_poll;
336
337         /* flags */
338         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
339 }
340
341
342 static int anim_set_efra_exec(bContext *C, wmOperator *UNUSED(op))
343 {
344         Scene *scene = CTX_data_scene(C);
345         int frame;
346
347         if (scene == NULL)
348                 return OPERATOR_CANCELLED;
349
350         frame = CFRA;
351
352         /* if Preview Range is defined, set the 'end' frame for that */
353         if (PRVRANGEON)
354                 scene->r.pefra = frame;
355         else
356                 scene->r.efra = frame;
357
358         if (PSFRA > frame) {
359                 if (PRVRANGEON)
360                         scene->r.psfra = frame;
361                 else
362                         scene->r.sfra = frame;
363         }
364
365         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
366
367         return OPERATOR_FINISHED;
368 }
369
370 static void ANIM_OT_end_frame_set(wmOperatorType *ot)
371 {
372         /* identifiers */
373         ot->name = "Set End Frame";
374         ot->idname = "ANIM_OT_end_frame_set";
375         ot->description = "Set the current frame as the preview or scene end frame";
376
377         /* api callbacks */
378         ot->exec = anim_set_efra_exec;
379         ot->poll = anim_set_end_frames_poll;
380
381         /* flags */
382         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
383 }
384
385 /* ****************** set preview range operator ****************************/
386
387 static int previewrange_define_exec(bContext *C, wmOperator *op)
388 {
389         Scene *scene = CTX_data_scene(C);
390         ARegion *ar = CTX_wm_region(C);
391         float sfra, efra;
392         rcti rect;
393
394         /* get min/max values from box select rect (already in region coordinates, not screen) */
395         WM_operator_properties_border_to_rcti(op, &rect);
396
397         /* convert min/max values to frames (i.e. region to 'tot' rect) */
398         sfra = UI_view2d_region_to_view_x(&ar->v2d, rect.xmin);
399         efra = UI_view2d_region_to_view_x(&ar->v2d, rect.xmax);
400
401         /* set start/end frames for preview-range
402          * - must clamp within allowable limits
403          * - end must not be before start (though this won't occur most of the time)
404          */
405         FRAMENUMBER_MIN_CLAMP(sfra);
406         FRAMENUMBER_MIN_CLAMP(efra);
407         if (efra < sfra) efra = sfra;
408
409         scene->r.flag |= SCER_PRV_RANGE;
410         scene->r.psfra = round_fl_to_int(sfra);
411         scene->r.pefra = round_fl_to_int(efra);
412
413         /* send notifiers */
414         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
415
416         return OPERATOR_FINISHED;
417 }
418
419 static void ANIM_OT_previewrange_set(wmOperatorType *ot)
420 {
421         /* identifiers */
422         ot->name = "Set Preview Range";
423         ot->idname = "ANIM_OT_previewrange_set";
424         ot->description = "Interactively define frame range used for playback";
425
426         /* api callbacks */
427         ot->invoke = WM_gesture_box_invoke;
428         ot->exec = previewrange_define_exec;
429         ot->modal = WM_gesture_box_modal;
430         ot->cancel = WM_gesture_box_cancel;
431
432         ot->poll = ED_operator_animview_active;
433
434         /* flags */
435         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
436
437         /* rna */
438         /* used to define frame range.
439          *
440          * note: border Y values are not used,
441          * but are needed by box_select gesture operator stuff */
442         WM_operator_properties_border(ot);
443 }
444
445 /* ****************** clear preview range operator ****************************/
446
447 static int previewrange_clear_exec(bContext *C, wmOperator *UNUSED(op))
448 {
449         Scene *scene = CTX_data_scene(C);
450         ScrArea *curarea = CTX_wm_area(C);
451
452         /* sanity checks */
453         if (ELEM(NULL, scene, curarea))
454                 return OPERATOR_CANCELLED;
455
456         /* simply clear values */
457         scene->r.flag &= ~SCER_PRV_RANGE;
458         scene->r.psfra = 0;
459         scene->r.pefra = 0;
460
461         ED_area_tag_redraw(curarea);
462
463         /* send notifiers */
464         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
465
466         return OPERATOR_FINISHED;
467 }
468
469 static void ANIM_OT_previewrange_clear(wmOperatorType *ot)
470 {
471         /* identifiers */
472         ot->name = "Clear Preview Range";
473         ot->idname = "ANIM_OT_previewrange_clear";
474         ot->description = "Clear Preview Range";
475
476         /* api callbacks */
477         ot->exec = previewrange_clear_exec;
478
479         ot->poll = ED_operator_animview_active;
480
481         /* flags */
482         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
483 }
484
485 /* ************************** registration **********************************/
486
487 void ED_operatortypes_anim(void)
488 {
489         /* Animation Editors only -------------------------- */
490         WM_operatortype_append(ANIM_OT_change_frame);
491
492         WM_operatortype_append(ANIM_OT_start_frame_set);
493         WM_operatortype_append(ANIM_OT_end_frame_set);
494
495         WM_operatortype_append(ANIM_OT_previewrange_set);
496         WM_operatortype_append(ANIM_OT_previewrange_clear);
497
498         /* Entire UI --------------------------------------- */
499         WM_operatortype_append(ANIM_OT_keyframe_insert);
500         WM_operatortype_append(ANIM_OT_keyframe_delete);
501         WM_operatortype_append(ANIM_OT_keyframe_insert_menu);
502         WM_operatortype_append(ANIM_OT_keyframe_delete_v3d);
503         WM_operatortype_append(ANIM_OT_keyframe_clear_v3d);
504         WM_operatortype_append(ANIM_OT_keyframe_insert_button);
505         WM_operatortype_append(ANIM_OT_keyframe_delete_button);
506         WM_operatortype_append(ANIM_OT_keyframe_clear_button);
507
508
509         WM_operatortype_append(ANIM_OT_driver_button_add);
510         WM_operatortype_append(ANIM_OT_driver_button_remove);
511         WM_operatortype_append(ANIM_OT_driver_button_edit);
512         WM_operatortype_append(ANIM_OT_copy_driver_button);
513         WM_operatortype_append(ANIM_OT_paste_driver_button);
514
515
516         WM_operatortype_append(ANIM_OT_keyingset_button_add);
517         WM_operatortype_append(ANIM_OT_keyingset_button_remove);
518
519         WM_operatortype_append(ANIM_OT_keying_set_add);
520         WM_operatortype_append(ANIM_OT_keying_set_remove);
521         WM_operatortype_append(ANIM_OT_keying_set_path_add);
522         WM_operatortype_append(ANIM_OT_keying_set_path_remove);
523
524         WM_operatortype_append(ANIM_OT_keying_set_active_set);
525 }
526
527 void ED_keymap_anim(wmKeyConfig *keyconf)
528 {
529         WM_keymap_ensure(keyconf, "Animation", 0, 0);
530 }