svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.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_sound.h"
45
46 #include "UI_view2d.h"
47
48 #include "RNA_access.h"
49 #include "RNA_define.h"
50
51 #include "WM_api.h"
52 #include "WM_types.h"
53
54 #include "ED_anim_api.h"
55 #include "ED_screen.h"
56
57 #include "anim_intern.h"
58
59 /* ********************** frame change operator ***************************/
60
61 /* Check if the operator can be run from the current context */
62 static int change_frame_poll(bContext *C)
63 {
64         ScrArea *curarea= CTX_wm_area(C);
65         
66         /* XXX temp? prevent changes during render */
67         if(G.rendering) return 0;
68         
69         /* as long as there is an active area, and it isn't a Graph Editor 
70          * (since the Graph Editor has its own version which does extra stuff),
71          * we're fine
72          */
73         return ((curarea) && (curarea->spacetype != SPACE_IPO));
74 }
75
76 /* Set the new frame number */
77 static void change_frame_apply(bContext *C, wmOperator *op)
78 {
79         Scene *scene= CTX_data_scene(C);
80         
81         /* set the new frame number */
82         CFRA= RNA_int_get(op->ptr, "frame");
83         FRAMENUMBER_MIN_CLAMP(CFRA);
84         SUBFRA = 0.f;
85         
86         /* do updates */
87         sound_seek_scene(C);
88         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
89 }
90
91 /* ---- */
92
93 /* Non-modal callback for running operator without user input */
94 static int change_frame_exec(bContext *C, wmOperator *op)
95 {
96         change_frame_apply(C, op);
97
98         return OPERATOR_FINISHED;
99 }
100
101 /* ---- */
102
103 /* Get frame from mouse coordinates */
104 static int frame_from_event(bContext *C, wmEvent *event)
105 {
106         ARegion *region= CTX_wm_region(C);
107         float viewx;
108
109         /* convert from region coordinates to View2D 'tot' space */
110         UI_view2d_region_to_view(&region->v2d, event->mval[0], event->mval[1], &viewx, NULL);
111         
112         /* round result to nearest int (frames are ints!) */
113         return (int)floor(viewx+0.5f);
114 }
115
116 /* Modal Operator init */
117 static int change_frame_invoke(bContext *C, wmOperator *op, wmEvent *event)
118 {
119         /* Change to frame that mouse is over before adding modal handler,
120          * as user could click on a single frame (jump to frame) as well as
121          * click-dragging over a range (modal scrubbing).
122          */
123         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
124         
125         change_frame_apply(C, op);
126         
127         /* add temp handler */
128         WM_event_add_modal_handler(C, op);
129
130         return OPERATOR_RUNNING_MODAL;
131 }
132
133 /* Modal event handling of frame changing */
134 static int change_frame_modal(bContext *C, wmOperator *op, wmEvent *event)
135 {
136         /* execute the events */
137         switch (event->type) {
138                 case ESCKEY:
139                         return OPERATOR_FINISHED;
140                 
141                 case MOUSEMOVE:
142                         RNA_int_set(op->ptr, "frame", frame_from_event(C, event));
143                         change_frame_apply(C, op);
144                         break;
145                 
146                 case LEFTMOUSE: 
147                 case RIGHTMOUSE:
148                         /* we check for either mouse-button to end, as checking for ACTIONMOUSE (which is used to init 
149                          * the modal op) doesn't work for some reason
150                          */
151                         if (event->val==KM_RELEASE)
152                                 return OPERATOR_FINISHED;
153                         break;
154         }
155
156         return OPERATOR_RUNNING_MODAL;
157 }
158
159 static void ANIM_OT_change_frame(wmOperatorType *ot)
160 {
161         /* identifiers */
162         ot->name= "Change frame";
163         ot->idname= "ANIM_OT_change_frame";
164         ot->description= "Interactively change the current frame number";
165         
166         /* api callbacks */
167         ot->exec= change_frame_exec;
168         ot->invoke= change_frame_invoke;
169         ot->modal= change_frame_modal;
170         ot->poll= change_frame_poll;
171         
172         /* flags */
173         ot->flag= OPTYPE_BLOCKING|OPTYPE_UNDO;
174
175         /* rna */
176         RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
177 }
178
179 /* ****************** set preview range operator ****************************/
180
181 static int previewrange_define_exec(bContext *C, wmOperator *op)
182 {
183         Scene *scene= CTX_data_scene(C);
184         ARegion *ar= CTX_wm_region(C);
185         float sfra, efra;
186         int xmin, xmax;
187         
188         /* get min/max values from border select rect (already in region coordinates, not screen) */
189         xmin= RNA_int_get(op->ptr, "xmin");
190         xmax= RNA_int_get(op->ptr, "xmax");
191         
192         /* convert min/max values to frames (i.e. region to 'tot' rect) */
193         UI_view2d_region_to_view(&ar->v2d, xmin, 0, &sfra, NULL);
194         UI_view2d_region_to_view(&ar->v2d, xmax, 0, &efra, NULL);
195         
196         /* set start/end frames for preview-range 
197          *      - must clamp within allowable limits
198          *      - end must not be before start (though this won't occur most of the time)
199          */
200         FRAMENUMBER_MIN_CLAMP(sfra);
201         FRAMENUMBER_MIN_CLAMP(efra);
202         if (efra < sfra) efra= sfra;
203         
204         scene->r.flag |= SCER_PRV_RANGE;
205         scene->r.psfra= (int)floor(sfra + 0.5f);
206         scene->r.pefra= (int)floor(efra + 0.5f);
207         
208         /* send notifiers */
209         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
210         
211         return OPERATOR_FINISHED;
212
213
214 static void ANIM_OT_previewrange_set(wmOperatorType *ot)
215 {
216         /* identifiers */
217         ot->name= "Set Preview Range";
218         ot->idname= "ANIM_OT_previewrange_set";
219         ot->description= "Interactively define frame range used for playback";
220         
221         /* api callbacks */
222         ot->invoke= WM_border_select_invoke;
223         ot->exec= previewrange_define_exec;
224         ot->modal= WM_border_select_modal;
225         ot->cancel= WM_border_select_cancel;
226         
227         ot->poll= ED_operator_animview_active;
228         
229         /* flags */
230         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
231         
232         /* rna */
233                 /* used to define frame range */
234         RNA_def_int(ot->srna, "xmin", 0, INT_MIN, INT_MAX, "X Min", "", INT_MIN, INT_MAX);
235         RNA_def_int(ot->srna, "xmax", 0, INT_MIN, INT_MAX, "X Max", "", INT_MIN, INT_MAX);
236                 /* these are not used, but are needed by borderselect gesture operator stuff */
237         RNA_def_int(ot->srna, "ymin", 0, INT_MIN, INT_MAX, "Y Min", "", INT_MIN, INT_MAX);
238         RNA_def_int(ot->srna, "ymax", 0, INT_MIN, INT_MAX, "Y Max", "", INT_MIN, INT_MAX);
239 }
240
241 /* ****************** clear preview range operator ****************************/
242
243 static int previewrange_clear_exec(bContext *C, wmOperator *UNUSED(op))
244 {
245         Scene *scene= CTX_data_scene(C);
246         ScrArea *curarea= CTX_wm_area(C);
247         
248         /* sanity checks */
249         if (ELEM(NULL, scene, curarea))
250                 return OPERATOR_CANCELLED;
251         
252         /* simply clear values */
253         scene->r.flag &= ~SCER_PRV_RANGE;
254         scene->r.psfra= 0;
255         scene->r.pefra= 0;
256         
257         ED_area_tag_redraw(curarea);
258         
259         return OPERATOR_FINISHED;
260
261
262 static void ANIM_OT_previewrange_clear(wmOperatorType *ot)
263 {
264         /* identifiers */
265         ot->name= "Clear Preview Range";
266         ot->idname= "ANIM_OT_previewrange_clear";
267         ot->description= "Clear Preview Range";
268         
269         /* api callbacks */
270         ot->exec= previewrange_clear_exec;
271         
272         ot->poll= ED_operator_animview_active;
273         
274         /* flags */
275         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
276 }
277
278 /* ****************** time display toggle operator ****************************/
279
280 static int toggle_time_exec(bContext *C, wmOperator *UNUSED(op))
281 {
282         ScrArea *curarea= CTX_wm_area(C);
283         
284         if (curarea == NULL)
285                 return OPERATOR_CANCELLED;
286         
287         /* simply toggle draw frames flag in applicable spaces */
288         // XXX or should relevant spaces define their own version of this?
289         switch (curarea->spacetype) {
290                 case SPACE_TIME: /* TimeLine */
291                 {
292                         SpaceTime *stime= CTX_wm_space_time(C);
293                         stime->flag ^= TIME_DRAWFRAMES;
294                 }
295                         break;
296                 case SPACE_ACTION: /* Action Editor */
297                 {
298                         SpaceAction *saction= CTX_wm_space_action(C);
299                         saction->flag ^= SACTION_DRAWTIME;
300                 }
301                         break;
302                 case SPACE_IPO: /* Graph Editor */
303                 {
304                         SpaceIpo *sipo= CTX_wm_space_graph(C);
305                         sipo->flag ^= SIPO_DRAWTIME;
306                 }
307                         break;
308                 case SPACE_NLA: /* NLA Editor */
309                 {
310                         SpaceNla *snla= CTX_wm_space_nla(C);
311                         snla->flag ^= SNLA_DRAWTIME;
312                 }
313                         break;
314                 case SPACE_SEQ: /* Sequencer */
315                 {
316                         SpaceSeq *sseq= CTX_wm_space_seq(C);
317                         sseq->flag ^= SEQ_DRAWFRAMES;
318                 }
319                         break;
320                         
321                 default: /* editor doesn't show frames */
322                         return OPERATOR_CANCELLED; // XXX or should we pass through instead?
323         }
324         
325         ED_area_tag_redraw(curarea);
326         
327         return OPERATOR_FINISHED;
328 }
329
330 static void ANIM_OT_time_toggle(wmOperatorType *ot)
331 {
332         /* identifiers */
333         ot->name= "Toggle Frames/Seconds";
334         ot->idname= "ANIM_OT_time_toggle";
335         ot->description= "Toggle whether timing is displayed in frames or seconds for active timeline view";
336         
337         /* api callbacks */
338         ot->exec= toggle_time_exec;
339         
340         ot->poll= ED_operator_animview_active;
341 }
342
343 /* ************************** registration **********************************/
344
345 void ED_operatortypes_anim(void)
346 {
347         /* Animation Editors only -------------------------- */
348         WM_operatortype_append(ANIM_OT_change_frame);
349         WM_operatortype_append(ANIM_OT_time_toggle);
350         
351         WM_operatortype_append(ANIM_OT_previewrange_set);
352         WM_operatortype_append(ANIM_OT_previewrange_clear);
353         
354         /* Entire UI --------------------------------------- */
355         WM_operatortype_append(ANIM_OT_keyframe_insert);
356         WM_operatortype_append(ANIM_OT_keyframe_delete);
357         WM_operatortype_append(ANIM_OT_keyframe_insert_menu);
358         WM_operatortype_append(ANIM_OT_keyframe_delete_v3d);
359         WM_operatortype_append(ANIM_OT_keyframe_insert_button);
360         WM_operatortype_append(ANIM_OT_keyframe_delete_button);
361         
362         
363         WM_operatortype_append(ANIM_OT_driver_button_add);
364         WM_operatortype_append(ANIM_OT_driver_button_remove);
365         WM_operatortype_append(ANIM_OT_copy_driver_button);
366         WM_operatortype_append(ANIM_OT_paste_driver_button);
367
368         
369         WM_operatortype_append(ANIM_OT_keyingset_button_add);
370         WM_operatortype_append(ANIM_OT_keyingset_button_remove);
371         
372         WM_operatortype_append(ANIM_OT_keying_set_add);
373         WM_operatortype_append(ANIM_OT_keying_set_remove);
374         WM_operatortype_append(ANIM_OT_keying_set_path_add);
375         WM_operatortype_append(ANIM_OT_keying_set_path_remove);
376         
377         WM_operatortype_append(ANIM_OT_keying_set_active_set);
378 }
379
380 void ED_keymap_anim(wmKeyConfig *keyconf)
381 {
382         wmKeyMap *keymap= WM_keymap_find(keyconf, "Animation", 0, 0);
383         
384         /* frame management */
385                 /* NOTE: 'ACTIONMOUSE' not 'LEFTMOUSE', as user may have swapped mouse-buttons */
386         WM_keymap_add_item(keymap, "ANIM_OT_change_frame", ACTIONMOUSE, KM_PRESS, 0, 0);
387         WM_keymap_verify_item(keymap, "ANIM_OT_time_toggle", TKEY, KM_PRESS, KM_CTRL, 0);
388         
389         /* preview range */
390         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_set", PKEY, KM_PRESS, 0, 0);
391         WM_keymap_verify_item(keymap, "ANIM_OT_previewrange_clear", PKEY, KM_PRESS, KM_ALT, 0);
392 }