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