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