Dopesheet: Keyframe size can be adjusted as part of theme settings
[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
61 #include "anim_intern.h"
62
63 /* ********************** frame change operator ***************************/
64
65 /* Check if the operator can be run from the current context */
66 static int change_frame_poll(bContext *C)
67 {
68         ScrArea *sa = CTX_wm_area(C);
69         
70         /* XXX temp? prevent changes during render */
71         if (G.is_rendering) return false;
72         
73         /* although it's only included in keymaps for regions using ED_KEYMAP_ANIMATION,
74          * this shouldn't show up in 3D editor (or others without 2D timeline view) via search
75          */
76         if (sa) {
77                 if (ELEM(sa->spacetype, SPACE_TIME, SPACE_ACTION, SPACE_NLA, SPACE_SEQ, SPACE_CLIP)) {
78                         return true;
79                 }
80                 else if (sa->spacetype == SPACE_IPO) {
81                         /* NOTE: Graph Editor has special version which does some extra stuff.
82                          * No need to show the generic error message for that case though!
83                          */
84                         return false;
85                 }
86         }
87         
88         CTX_wm_operator_poll_msg_set(C, "Expected an timeline/animation area to be active");
89         return false;
90 }
91
92 /* Set the new frame number */
93 static void change_frame_apply(bContext *C, wmOperator *op)
94 {
95         Main *bmain = CTX_data_main(C);
96         Scene *scene = CTX_data_scene(C);
97         int frame = RNA_int_get(op->ptr, "frame");
98         bool do_snap = RNA_boolean_get(op->ptr, "snap");
99
100         if (do_snap && CTX_wm_space_seq(C)) {
101                 frame = BKE_sequencer_find_next_prev_edit(scene, frame, SEQ_SIDE_BOTH, true, false, false);
102         }
103
104         /* set the new frame number */
105         CFRA = frame;
106         FRAMENUMBER_MIN_CLAMP(CFRA);
107         SUBFRA = 0.0f;
108         
109         /* do updates */
110         BKE_sound_seek_scene(bmain, scene);
111         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
112 }
113
114 /* ---- */
115
116 /* Non-modal callback for running operator without user input */
117 static int change_frame_exec(bContext *C, wmOperator *op)
118 {
119         change_frame_apply(C, op);
120
121         return OPERATOR_FINISHED;
122 }
123
124 /* ---- */
125
126 /* Get frame from mouse coordinates */
127 static int frame_from_event(bContext *C, const wmEvent *event)
128 {
129         ARegion *region = CTX_wm_region(C);
130         Scene *scene = CTX_data_scene(C);
131         float viewx;
132         int frame;
133
134         /* convert from region coordinates to View2D 'tot' space */
135         viewx = UI_view2d_region_to_view_x(&region->v2d, event->mval[0]);
136         
137         /* round result to nearest int (frames are ints!) */
138         frame = iroundf(viewx);
139         
140         if (scene->r.flag & SCER_LOCK_FRAME_SELECTION) {
141                 CLAMP(frame, PSFRA, PEFRA);
142         }
143         
144         return frame;
145 }
146
147 static void change_frame_seq_preview_begin(bContext *C, const wmEvent *event)
148 {
149         ScrArea *sa = CTX_wm_area(C);
150         bScreen *screen = CTX_wm_screen(C);
151         if (sa && sa->spacetype == SPACE_SEQ) {
152                 SpaceSeq *sseq = sa->spacedata.first;
153                 if (ED_space_sequencer_check_show_strip(sseq)) {
154                         ED_sequencer_special_preview_set(C, event->mval);
155                 }
156         }
157         if (screen)
158                 screen->scrubbing = true;
159 }
160
161 static void change_frame_seq_preview_end(bContext *C)
162 {
163         bScreen *screen = CTX_wm_screen(C);
164         bool notify = false;
165
166         if (screen->scrubbing) {
167                 screen->scrubbing = false;
168                 notify = true;
169         }
170
171         if (ED_sequencer_special_preview_get() != NULL) {
172                 ED_sequencer_special_preview_clear();
173                 notify = true;
174         }
175
176         if (notify) {
177                 Scene *scene = CTX_data_scene(C);
178                 WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
179         }
180 }
181
182 /* Modal Operator init */
183 static int change_frame_invoke(bContext *C, wmOperator *op, const wmEvent *event)
184 {
185         /* Change to frame that mouse is over before adding modal handler,
186          * as user could click on a single frame (jump to frame) as well as
187          * click-dragging over a range (modal scrubbing).
188          */
189         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
190
191         change_frame_seq_preview_begin(C, event);
192
193         change_frame_apply(C, op);
194         
195         /* add temp handler */
196         WM_event_add_modal_handler(C, op);
197
198         return OPERATOR_RUNNING_MODAL;
199 }
200
201 static void change_frame_cancel(bContext *C, wmOperator *UNUSED(op))
202 {
203         change_frame_seq_preview_end(C);
204 }
205
206 /* Modal event handling of frame changing */
207 static int change_frame_modal(bContext *C, wmOperator *op, const wmEvent *event)
208 {
209         int ret = OPERATOR_RUNNING_MODAL;
210         /* execute the events */
211         switch (event->type) {
212                 case ESCKEY:
213                         ret = OPERATOR_FINISHED;
214                         break;
215
216                 case MOUSEMOVE:
217                         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
218                         change_frame_apply(C, op);
219                         break;
220                 
221                 case LEFTMOUSE: 
222                 case RIGHTMOUSE:
223                 case MIDDLEMOUSE:
224                         /* we check for either mouse-button to end, as checking for ACTIONMOUSE (which is used to init 
225                          * the modal op) doesn't work for some reason
226                          */
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_UNDO | OPTYPE_GRAB_CURSOR;
267
268         /* rna */
269         ot->prop = RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
270         prop = RNA_def_boolean(ot->srna, "snap", false, "Snap", "");
271         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
272 }
273
274 /* ****************** set preview range operator ****************************/
275
276 static int previewrange_define_exec(bContext *C, wmOperator *op)
277 {
278         Scene *scene = CTX_data_scene(C);
279         ARegion *ar = CTX_wm_region(C);
280         float sfra, efra;
281         rcti rect;
282         
283         /* get min/max values from border select rect (already in region coordinates, not screen) */
284         WM_operator_properties_border_to_rcti(op, &rect);
285         
286         /* convert min/max values to frames (i.e. region to 'tot' rect) */
287         sfra = UI_view2d_region_to_view_x(&ar->v2d, rect.xmin);
288         efra = UI_view2d_region_to_view_x(&ar->v2d, rect.xmax);
289         
290         /* set start/end frames for preview-range 
291          *      - must clamp within allowable limits
292          *      - end must not be before start (though this won't occur most of the time)
293          */
294         FRAMENUMBER_MIN_CLAMP(sfra);
295         FRAMENUMBER_MIN_CLAMP(efra);
296         if (efra < sfra) efra = sfra;
297         
298         scene->r.flag |= SCER_PRV_RANGE;
299         scene->r.psfra = iroundf(sfra);
300         scene->r.pefra = iroundf(efra);
301         
302         /* send notifiers */
303         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
304         
305         return OPERATOR_FINISHED;
306
307
308 static void ANIM_OT_previewrange_set(wmOperatorType *ot)
309 {
310         /* identifiers */
311         ot->name = "Set Preview Range";
312         ot->idname = "ANIM_OT_previewrange_set";
313         ot->description = "Interactively define frame range used for playback";
314         
315         /* api callbacks */
316         ot->invoke = WM_border_select_invoke;
317         ot->exec = previewrange_define_exec;
318         ot->modal = WM_border_select_modal;
319         ot->cancel = WM_border_select_cancel;
320         
321         ot->poll = ED_operator_animview_active;
322         
323         /* flags */
324         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
325         
326         /* rna */
327         /* used to define frame range.
328          *
329          * note: border Y values are not used,
330          * but are needed by borderselect gesture operator stuff */
331         WM_operator_properties_border(ot);
332 }
333
334 /* ****************** clear preview range operator ****************************/
335
336 static int previewrange_clear_exec(bContext *C, wmOperator *UNUSED(op))
337 {
338         Scene *scene = CTX_data_scene(C);
339         ScrArea *curarea = CTX_wm_area(C);
340         
341         /* sanity checks */
342         if (ELEM(NULL, scene, curarea))
343                 return OPERATOR_CANCELLED;
344         
345         /* simply clear values */
346         scene->r.flag &= ~SCER_PRV_RANGE;
347         scene->r.psfra = 0;
348         scene->r.pefra = 0;
349         
350         ED_area_tag_redraw(curarea);
351         
352         /* send notifiers */
353         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
354         
355         return OPERATOR_FINISHED;
356
357
358 static void ANIM_OT_previewrange_clear(wmOperatorType *ot)
359 {
360         /* identifiers */
361         ot->name = "Clear Preview Range";
362         ot->idname = "ANIM_OT_previewrange_clear";
363         ot->description = "Clear Preview Range";
364         
365         /* api callbacks */
366         ot->exec = previewrange_clear_exec;
367         
368         ot->poll = ED_operator_animview_active;
369         
370         /* flags */
371         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
372 }
373
374 /* ************************** registration **********************************/
375
376 void ED_operatortypes_anim(void)
377 {
378         /* Animation Editors only -------------------------- */
379         WM_operatortype_append(ANIM_OT_change_frame);
380         
381         WM_operatortype_append(ANIM_OT_previewrange_set);
382         WM_operatortype_append(ANIM_OT_previewrange_clear);
383         
384         /* Entire UI --------------------------------------- */
385         WM_operatortype_append(ANIM_OT_keyframe_insert);
386         WM_operatortype_append(ANIM_OT_keyframe_delete);
387         WM_operatortype_append(ANIM_OT_keyframe_insert_menu);
388         WM_operatortype_append(ANIM_OT_keyframe_delete_v3d);
389         WM_operatortype_append(ANIM_OT_keyframe_clear_v3d);
390         WM_operatortype_append(ANIM_OT_keyframe_insert_button);
391         WM_operatortype_append(ANIM_OT_keyframe_delete_button);
392         WM_operatortype_append(ANIM_OT_keyframe_clear_button);
393         
394         
395         WM_operatortype_append(ANIM_OT_driver_button_add);
396         WM_operatortype_append(ANIM_OT_driver_button_remove);
397         WM_operatortype_append(ANIM_OT_copy_driver_button);
398         WM_operatortype_append(ANIM_OT_paste_driver_button);
399
400         
401         WM_operatortype_append(ANIM_OT_keyingset_button_add);
402         WM_operatortype_append(ANIM_OT_keyingset_button_remove);
403         
404         WM_operatortype_append(ANIM_OT_keying_set_add);
405         WM_operatortype_append(ANIM_OT_keying_set_remove);
406         WM_operatortype_append(ANIM_OT_keying_set_path_add);
407         WM_operatortype_append(ANIM_OT_keying_set_path_remove);
408         
409         WM_operatortype_append(ANIM_OT_keying_set_active_set);
410 }
411
412 void ED_keymap_anim(wmKeyConfig *keyconf)
413 {
414         wmKeyMap *keymap = WM_keymap_find(keyconf, "Animation", 0, 0);
415         wmKeyMapItem *kmi;
416         
417         /* frame management */
418         /* NOTE: 'ACTIONMOUSE' not 'LEFTMOUSE', as user may have swapped mouse-buttons */
419         WM_keymap_add_item(keymap, "ANIM_OT_change_frame", ACTIONMOUSE, KM_PRESS, 0, 0);
420
421         kmi = WM_keymap_add_item(keymap, "WM_OT_context_toggle", TKEY, KM_PRESS, KM_CTRL, 0);
422         RNA_string_set(kmi->ptr, "data_path", "space_data.show_seconds");
423         
424         /* preview range */
425         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_set", PKEY, KM_PRESS, 0, 0);
426         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_clear", PKEY, KM_PRESS, KM_ALT, 0);
427 }