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