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