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