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