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