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