code cleanup: use const events for modal and invoke operators.
[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 "BLO_sys_types.h"
36
37 #include "BLI_utildefines.h"
38
39 #include "DNA_anim_types.h"
40 #include "DNA_scene_types.h"
41
42 #include "BKE_context.h"
43 #include "BKE_global.h"
44 #include "BKE_main.h"
45 #include "BKE_sound.h"
46
47 #include "UI_view2d.h"
48
49 #include "RNA_access.h"
50 #include "RNA_define.h"
51
52 #include "WM_api.h"
53 #include "WM_types.h"
54
55 #include "ED_anim_api.h"
56 #include "ED_screen.h"
57
58 #include "anim_intern.h"
59
60 /* ********************** frame change operator ***************************/
61
62 /* Check if the operator can be run from the current context */
63 static int change_frame_poll(bContext *C)
64 {
65         ScrArea *sa = CTX_wm_area(C);
66         
67         /* XXX temp? prevent changes during render */
68         if (G.is_rendering) return FALSE;
69         
70         /* although it's only included in keymaps for regions using ED_KEYMAP_ANIMATION,
71          * this shouldn't show up in 3D editor (or others without 2D timeline view) via search
72          */
73         if (sa) {
74                 if (ELEM5(sa->spacetype, SPACE_TIME, SPACE_ACTION, SPACE_NLA, SPACE_SEQ, SPACE_CLIP)) {
75                         return TRUE;
76                 }
77                 else if (sa->spacetype == SPACE_IPO) {
78                         /* NOTE: Graph Editor has special version which does some extra stuff.
79                          * No need to show the generic error message for that case though!
80                          */
81                         return FALSE;
82                 }
83         }
84         
85         CTX_wm_operator_poll_msg_set(C, "Expected an timeline/animation area to be active");
86         return FALSE;
87 }
88
89 /* Set the new frame number */
90 static void change_frame_apply(bContext *C, wmOperator *op)
91 {
92         Main *bmain = CTX_data_main(C);
93         Scene *scene = CTX_data_scene(C);
94         
95         /* set the new frame number */
96         CFRA = RNA_int_get(op->ptr, "frame");
97         FRAMENUMBER_MIN_CLAMP(CFRA);
98         SUBFRA = 0.0f;
99         
100         /* do updates */
101         sound_seek_scene(bmain, scene);
102         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
103 }
104
105 /* ---- */
106
107 /* Non-modal callback for running operator without user input */
108 static int change_frame_exec(bContext *C, wmOperator *op)
109 {
110         change_frame_apply(C, op);
111
112         return OPERATOR_FINISHED;
113 }
114
115 /* ---- */
116
117 /* Get frame from mouse coordinates */
118 static int frame_from_event(bContext *C, const wmEvent *event)
119 {
120         ARegion *region = CTX_wm_region(C);
121         float viewx;
122
123         /* convert from region coordinates to View2D 'tot' space */
124         UI_view2d_region_to_view(&region->v2d, event->mval[0], event->mval[1], &viewx, NULL);
125         
126         /* round result to nearest int (frames are ints!) */
127         return (int)floor(viewx + 0.5f);
128 }
129
130 /* Modal Operator init */
131 static int change_frame_invoke(bContext *C, wmOperator *op, const wmEvent *event)
132 {
133         /* Change to frame that mouse is over before adding modal handler,
134          * as user could click on a single frame (jump to frame) as well as
135          * click-dragging over a range (modal scrubbing).
136          */
137         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
138         
139         change_frame_apply(C, op);
140         
141         /* add temp handler */
142         WM_event_add_modal_handler(C, op);
143
144         return OPERATOR_RUNNING_MODAL;
145 }
146
147 /* Modal event handling of frame changing */
148 static int change_frame_modal(bContext *C, wmOperator *op, const wmEvent *event)
149 {
150         /* execute the events */
151         switch (event->type) {
152                 case ESCKEY:
153                         return OPERATOR_FINISHED;
154                 
155                 case MOUSEMOVE:
156                         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
157                         change_frame_apply(C, op);
158                         break;
159                 
160                 case LEFTMOUSE: 
161                 case RIGHTMOUSE:
162                         /* we check for either mouse-button to end, as checking for ACTIONMOUSE (which is used to init 
163                          * the modal op) doesn't work for some reason
164                          */
165                         if (event->val == KM_RELEASE)
166                                 return OPERATOR_FINISHED;
167                         break;
168         }
169
170         return OPERATOR_RUNNING_MODAL;
171 }
172
173 static void ANIM_OT_change_frame(wmOperatorType *ot)
174 {
175         /* identifiers */
176         ot->name = "Change Frame";
177         ot->idname = "ANIM_OT_change_frame";
178         ot->description = "Interactively change the current frame number";
179         
180         /* api callbacks */
181         ot->exec = change_frame_exec;
182         ot->invoke = change_frame_invoke;
183         ot->modal = change_frame_modal;
184         ot->poll = change_frame_poll;
185         
186         /* flags */
187         ot->flag = OPTYPE_BLOCKING | OPTYPE_UNDO | OPTYPE_GRAB_POINTER;
188
189         /* rna */
190         ot->prop = RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
191 }
192
193 /* ****************** set preview range operator ****************************/
194
195 static int previewrange_define_exec(bContext *C, wmOperator *op)
196 {
197         Scene *scene = CTX_data_scene(C);
198         ARegion *ar = CTX_wm_region(C);
199         float sfra, efra;
200         rcti rect;
201         
202         /* get min/max values from border select rect (already in region coordinates, not screen) */
203         WM_operator_properties_border_to_rcti(op, &rect);
204         
205         /* convert min/max values to frames (i.e. region to 'tot' rect) */
206         UI_view2d_region_to_view(&ar->v2d, rect.xmin, 0, &sfra, NULL);
207         UI_view2d_region_to_view(&ar->v2d, rect.xmax, 0, &efra, NULL);
208         
209         /* set start/end frames for preview-range 
210          *      - must clamp within allowable limits
211          *      - end must not be before start (though this won't occur most of the time)
212          */
213         FRAMENUMBER_MIN_CLAMP(sfra);
214         FRAMENUMBER_MIN_CLAMP(efra);
215         if (efra < sfra) efra = sfra;
216         
217         scene->r.flag |= SCER_PRV_RANGE;
218         scene->r.psfra = (int)floor(sfra + 0.5f);
219         scene->r.pefra = (int)floor(efra + 0.5f);
220         
221         /* send notifiers */
222         WM_event_add_notifier(C, NC_SCENE | ND_FRAME, scene);
223         
224         return OPERATOR_FINISHED;
225
226
227 static void ANIM_OT_previewrange_set(wmOperatorType *ot)
228 {
229         /* identifiers */
230         ot->name = "Set Preview Range";
231         ot->idname = "ANIM_OT_previewrange_set";
232         ot->description = "Interactively define frame range used for playback";
233         
234         /* api callbacks */
235         ot->invoke = WM_border_select_invoke;
236         ot->exec = previewrange_define_exec;
237         ot->modal = WM_border_select_modal;
238         ot->cancel = WM_border_select_cancel;
239         
240         ot->poll = ED_operator_animview_active;
241         
242         /* flags */
243         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
244         
245         /* rna */
246         /* used to define frame range.
247          *
248          * note: border Y values are not used,
249          * but are needed by borderselect gesture operator stuff */
250         WM_operator_properties_border(ot);
251 }
252
253 /* ****************** clear preview range operator ****************************/
254
255 static int previewrange_clear_exec(bContext *C, wmOperator *UNUSED(op))
256 {
257         Scene *scene = CTX_data_scene(C);
258         ScrArea *curarea = CTX_wm_area(C);
259         
260         /* sanity checks */
261         if (ELEM(NULL, scene, curarea))
262                 return OPERATOR_CANCELLED;
263         
264         /* simply clear values */
265         scene->r.flag &= ~SCER_PRV_RANGE;
266         scene->r.psfra = 0;
267         scene->r.pefra = 0;
268         
269         ED_area_tag_redraw(curarea);
270         
271         return OPERATOR_FINISHED;
272
273
274 static void ANIM_OT_previewrange_clear(wmOperatorType *ot)
275 {
276         /* identifiers */
277         ot->name = "Clear Preview Range";
278         ot->idname = "ANIM_OT_previewrange_clear";
279         ot->description = "Clear Preview Range";
280         
281         /* api callbacks */
282         ot->exec = previewrange_clear_exec;
283         
284         ot->poll = ED_operator_animview_active;
285         
286         /* flags */
287         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
288 }
289
290 /* ************************** registration **********************************/
291
292 void ED_operatortypes_anim(void)
293 {
294         /* Animation Editors only -------------------------- */
295         WM_operatortype_append(ANIM_OT_change_frame);
296         
297         WM_operatortype_append(ANIM_OT_previewrange_set);
298         WM_operatortype_append(ANIM_OT_previewrange_clear);
299         
300         /* Entire UI --------------------------------------- */
301         WM_operatortype_append(ANIM_OT_keyframe_insert);
302         WM_operatortype_append(ANIM_OT_keyframe_delete);
303         WM_operatortype_append(ANIM_OT_keyframe_insert_menu);
304         WM_operatortype_append(ANIM_OT_keyframe_delete_v3d);
305         WM_operatortype_append(ANIM_OT_keyframe_clear_v3d);
306         WM_operatortype_append(ANIM_OT_keyframe_insert_button);
307         WM_operatortype_append(ANIM_OT_keyframe_delete_button);
308         WM_operatortype_append(ANIM_OT_keyframe_clear_button);
309         
310         
311         WM_operatortype_append(ANIM_OT_driver_button_add);
312         WM_operatortype_append(ANIM_OT_driver_button_remove);
313         WM_operatortype_append(ANIM_OT_copy_driver_button);
314         WM_operatortype_append(ANIM_OT_paste_driver_button);
315
316         
317         WM_operatortype_append(ANIM_OT_keyingset_button_add);
318         WM_operatortype_append(ANIM_OT_keyingset_button_remove);
319         
320         WM_operatortype_append(ANIM_OT_keying_set_add);
321         WM_operatortype_append(ANIM_OT_keying_set_remove);
322         WM_operatortype_append(ANIM_OT_keying_set_path_add);
323         WM_operatortype_append(ANIM_OT_keying_set_path_remove);
324         
325         WM_operatortype_append(ANIM_OT_keying_set_active_set);
326 }
327
328 void ED_keymap_anim(wmKeyConfig *keyconf)
329 {
330         wmKeyMap *keymap = WM_keymap_find(keyconf, "Animation", 0, 0);
331         wmKeyMapItem *kmi;
332         
333         /* frame management */
334         /* NOTE: 'ACTIONMOUSE' not 'LEFTMOUSE', as user may have swapped mouse-buttons */
335         WM_keymap_add_item(keymap, "ANIM_OT_change_frame", ACTIONMOUSE, KM_PRESS, 0, 0);
336
337         kmi = WM_keymap_add_item(keymap, "WM_OT_context_toggle", TKEY, KM_PRESS, KM_CTRL, 0);
338         RNA_string_set(kmi->ptr, "data_path", "space_data.show_seconds");
339         
340         /* preview range */
341         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_set", PKEY, KM_PRESS, 0, 0);
342         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_clear", PKEY, KM_PRESS, KM_ALT, 0);
343 }