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