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