670a92e664b93eae0068442ad1a71047a4e4b936
[blender-staging.git] / source / blender / editors / animation / anim_ops.c
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation, Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <math.h>
31
32 #include "DNA_anim_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "BKE_context.h"
36 #include "BKE_sound.h"
37
38 #include "UI_view2d.h"
39
40 #include "RNA_access.h"
41 #include "RNA_define.h"
42
43 #include "WM_api.h"
44 #include "WM_types.h"
45
46 #include "ED_screen.h"
47
48 #include "anim_intern.h"
49
50 /* ********************** frame change operator ***************************/
51
52 /* Check if the operator can be run from the current context */
53 static int change_frame_poll(bContext *C)
54 {
55         ScrArea *curarea= CTX_wm_area(C);
56         
57         /* as long as there is an active area, and it isn't a Graph Editor 
58          * (since the Graph Editor has its own version which does extra stuff),
59          * we're fine
60          */
61         return ((curarea) && (curarea->spacetype != SPACE_IPO));
62 }
63
64 /* Set the new frame number */
65 static void change_frame_apply(bContext *C, wmOperator *op)
66 {
67         Scene *scene= CTX_data_scene(C);
68         
69         /* set the new frame number */
70         CFRA= RNA_int_get(op->ptr, "frame");
71         FRAMENUMBER_MIN_CLAMP(CFRA);
72         
73         /* do updates */
74         sound_seek_scene(C);
75         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
76 }
77
78 /* ---- */
79
80 /* Non-modal callback for running operator without user input */
81 static int change_frame_exec(bContext *C, wmOperator *op)
82 {
83         change_frame_apply(C, op);
84
85         return OPERATOR_FINISHED;
86 }
87
88 /* ---- */
89
90 /* Get frame from mouse coordinates */
91 static int frame_from_event(bContext *C, wmEvent *event)
92 {
93         ARegion *region= CTX_wm_region(C);
94         float viewx;
95         int x, y;
96         
97         /* convert screen coordinates to region coordinates */
98         x= event->x - region->winrct.xmin;
99         y= event->y - region->winrct.ymin;
100         
101         /* convert from region coordinates to View2D 'tot' space */
102         UI_view2d_region_to_view(&region->v2d, x, y, &viewx, NULL);
103         
104         /* round result to nearest int (frames are ints!) */
105         return (int)floor(viewx+0.5f);
106 }
107
108 /* Modal Operator init */
109 static int change_frame_invoke(bContext *C, wmOperator *op, wmEvent *event)
110 {
111         /* Change to frame that mouse is over before adding modal handler,
112          * as user could click on a single frame (jump to frame) as well as
113          * click-dragging over a range (modal scrubbing).
114          */
115         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
116         
117         change_frame_apply(C, op);
118         
119         /* add temp handler */
120         WM_event_add_modal_handler(C, op);
121
122         return OPERATOR_RUNNING_MODAL;
123 }
124
125 /* Modal event handling of frame changing */
126 static int change_frame_modal(bContext *C, wmOperator *op, wmEvent *event)
127 {
128         /* execute the events */
129         switch (event->type) {
130                 case ESCKEY:
131                         return OPERATOR_FINISHED;
132                 
133                 case MOUSEMOVE:
134                         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
135                         change_frame_apply(C, op);
136                         break;
137                 
138                 case LEFTMOUSE: 
139                 case RIGHTMOUSE:
140                         /* we check for either mouse-button to end, as checking for ACTIONMOUSE (which is used to init 
141                          * the modal op) doesn't work for some reason
142                          */
143                         if (event->val==KM_RELEASE)
144                                 return OPERATOR_FINISHED;
145                         break;
146         }
147
148         return OPERATOR_RUNNING_MODAL;
149 }
150
151 void ANIM_OT_change_frame(wmOperatorType *ot)
152 {
153         /* identifiers */
154         ot->name= "Change frame";
155         ot->idname= "ANIM_OT_change_frame";
156         ot->description= "Interactively change the current frame number";
157         
158         /* api callbacks */
159         ot->exec= change_frame_exec;
160         ot->invoke= change_frame_invoke;
161         ot->modal= change_frame_modal;
162         ot->poll= change_frame_poll;
163         
164         /* flags */
165         ot->flag= OPTYPE_BLOCKING;
166
167         /* rna */
168         RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
169 }
170
171 /* ****************** set preview range operator ****************************/
172
173 static int previewrange_define_exec(bContext *C, wmOperator *op)
174 {
175         Scene *scene= CTX_data_scene(C);
176         ARegion *ar= CTX_wm_region(C);
177         float sfra, efra;
178         int xmin, xmax;
179         
180         /* get min/max values from border select rect (already in region coordinates, not screen) */
181         xmin= RNA_int_get(op->ptr, "xmin");
182         xmax= RNA_int_get(op->ptr, "xmax");
183         
184         /* convert min/max values to frames (i.e. region to 'tot' rect) */
185         UI_view2d_region_to_view(&ar->v2d, xmin, 0, &sfra, NULL);
186         UI_view2d_region_to_view(&ar->v2d, xmax, 0, &efra, NULL);
187         
188         /* set start/end frames for preview-range 
189          *      - must clamp within allowable limits
190          *      - end must not be before start (though this won't occur most of the time)
191          */
192         if (sfra < 1) sfra = 1.0f;
193         if (efra < 1) efra = 1.0f;
194         if (efra < sfra) efra= sfra;
195         
196         scene->r.flag |= SCER_PRV_RANGE;
197         scene->r.psfra= (int)floor(sfra + 0.5f);
198         scene->r.pefra= (int)floor(efra + 0.5f);
199         
200         /* send notifiers */
201         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
202         
203         return OPERATOR_FINISHED;
204
205
206 void ANIM_OT_previewrange_set(wmOperatorType *ot)
207 {
208         /* identifiers */
209         ot->name= "Set Preview Range";
210         ot->idname= "ANIM_OT_previewrange_set";
211         
212         /* api callbacks */
213         ot->invoke= WM_border_select_invoke;
214         ot->exec= previewrange_define_exec;
215         ot->modal= WM_border_select_modal;
216         
217         ot->poll= ED_operator_areaactive;
218         
219         /* flags */
220         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
221         
222         /* rna */
223                 /* used to define frame range */
224         RNA_def_int(ot->srna, "xmin", 0, INT_MIN, INT_MAX, "X Min", "", INT_MIN, INT_MAX);
225         RNA_def_int(ot->srna, "xmax", 0, INT_MIN, INT_MAX, "X Max", "", INT_MIN, INT_MAX);
226                 /* these are not used, but are needed by borderselect gesture operator stuff */
227         RNA_def_int(ot->srna, "ymin", 0, INT_MIN, INT_MAX, "Y Min", "", INT_MIN, INT_MAX);
228         RNA_def_int(ot->srna, "ymax", 0, INT_MIN, INT_MAX, "Y Max", "", INT_MIN, INT_MAX);
229 }
230
231 /* ****************** clear preview range operator ****************************/
232
233 static int previewrange_clear_exec(bContext *C, wmOperator *op)
234 {
235         Scene *scene= CTX_data_scene(C);
236         ScrArea *curarea= CTX_wm_area(C);
237         
238         /* sanity checks */
239         if (ELEM(NULL, scene, curarea))
240                 return OPERATOR_CANCELLED;
241         
242         /* simply clear values */
243         scene->r.flag &= ~SCER_PRV_RANGE;
244         scene->r.psfra= 0;
245         scene->r.pefra= 0;
246         
247         ED_area_tag_redraw(curarea);
248         
249         return OPERATOR_FINISHED;
250
251
252 void ANIM_OT_previewrange_clear(wmOperatorType *ot)
253 {
254         /* identifiers */
255         ot->name= "Clear Preview Range";
256         ot->idname= "ANIM_OT_previewrange_clear";
257         
258         /* api callbacks */
259         ot->exec= previewrange_clear_exec;
260         
261         ot->poll= ED_operator_areaactive;
262         
263         /* flags */
264         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
265 }
266
267 /* ****************** time display toggle operator ****************************/
268
269 static int toggle_time_exec(bContext *C, wmOperator *op)
270 {
271         ScrArea *curarea= CTX_wm_area(C);
272         
273         if (curarea == NULL)
274                 return OPERATOR_CANCELLED;
275         
276         /* simply toggle draw frames flag in applicable spaces */
277         // XXX or should relevant spaces define their own version of this?
278         switch (curarea->spacetype) {
279                 case SPACE_TIME: /* TimeLine */
280                 {
281                         SpaceTime *stime= CTX_wm_space_time(C);
282                         stime->flag ^= TIME_DRAWFRAMES;
283                 }
284                         break;
285                 case SPACE_ACTION: /* Action Editor */
286                 {
287                         SpaceAction *saction= CTX_wm_space_action(C);
288                         saction->flag ^= SACTION_DRAWTIME;
289                 }
290                         break;
291                 case SPACE_IPO: /* Graph Editor */
292                 {
293                         SpaceIpo *sipo= CTX_wm_space_graph(C);
294                         sipo->flag ^= SIPO_DRAWTIME;
295                 }
296                         break;
297                 case SPACE_NLA: /* NLA Editor */
298                 {
299                         SpaceNla *snla= CTX_wm_space_nla(C);
300                         snla->flag ^= SNLA_DRAWTIME;
301                 }
302                         break;
303                 case SPACE_SEQ: /* Sequencer */
304                 {
305                         SpaceSeq *sseq= CTX_wm_space_seq(C);
306                         sseq->flag ^= SEQ_DRAWFRAMES;
307                 }
308                         break;
309                         
310                 default: /* editor doesn't show frames */
311                         return OPERATOR_CANCELLED; // XXX or should we pass through instead?
312         }
313         
314         ED_area_tag_redraw(curarea);
315         
316         return OPERATOR_FINISHED;
317 }
318
319 void ANIM_OT_time_toggle(wmOperatorType *ot)
320 {
321         /* identifiers */
322         ot->name= "Toggle Frames/Seconds";
323         ot->idname= "ANIM_OT_time_toggle";
324         
325         /* api callbacks */
326         ot->exec= toggle_time_exec;
327         
328         ot->poll= ED_operator_areaactive;
329 }
330
331 /* ************************** registration **********************************/
332
333 void ED_operatortypes_anim(void)
334 {
335         /* Animation Editors only -------------------------- */
336         WM_operatortype_append(ANIM_OT_change_frame);
337         WM_operatortype_append(ANIM_OT_time_toggle);
338         
339         WM_operatortype_append(ANIM_OT_previewrange_set);
340         WM_operatortype_append(ANIM_OT_previewrange_clear);
341         
342         /* Entire UI --------------------------------------- */
343         WM_operatortype_append(ANIM_OT_keyframe_insert);
344         WM_operatortype_append(ANIM_OT_keyframe_delete);
345         WM_operatortype_append(ANIM_OT_keyframe_insert_menu);
346         WM_operatortype_append(ANIM_OT_keyframe_delete_v3d);
347         WM_operatortype_append(ANIM_OT_keyframe_insert_button);
348         WM_operatortype_append(ANIM_OT_keyframe_delete_button);
349         
350         
351         WM_operatortype_append(ANIM_OT_driver_button_add);
352         WM_operatortype_append(ANIM_OT_driver_button_remove);
353         WM_operatortype_append(ANIM_OT_copy_driver_button);
354         WM_operatortype_append(ANIM_OT_paste_driver_button);
355
356         
357         WM_operatortype_append(ANIM_OT_keyingset_button_add);
358         WM_operatortype_append(ANIM_OT_keyingset_button_remove);
359         
360         WM_operatortype_append(ANIM_OT_keying_set_add);
361         WM_operatortype_append(ANIM_OT_keying_set_remove);
362         WM_operatortype_append(ANIM_OT_keying_set_path_add);
363         WM_operatortype_append(ANIM_OT_keying_set_path_remove);
364 }
365
366 void ED_keymap_anim(wmKeyConfig *keyconf)
367 {
368         wmKeyMap *keymap= WM_keymap_find(keyconf, "Animation", 0, 0);
369         
370         /* frame management */
371                 /* NOTE: 'ACTIONMOUSE' not 'LEFTMOUSE', as user may have swapped mouse-buttons */
372         WM_keymap_add_item(keymap, "ANIM_OT_change_frame", ACTIONMOUSE, KM_PRESS, 0, 0);
373         WM_keymap_verify_item(keymap, "ANIM_OT_time_toggle", TKEY, KM_PRESS, KM_CTRL, 0);
374         
375         /* preview range */
376         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_set", PKEY, KM_PRESS, 0, 0);
377         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_clear", PKEY, KM_PRESS, KM_ALT, 0);
378 }