batch remove .'s used with RNA_def_struct_ui_text
[blender.git] / source / blender / editors / space_time / time_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
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_scene_types.h"
35 #include "DNA_screen_types.h"
36 #include "DNA_space_types.h"
37 #include "DNA_windowmanager_types.h"
38
39 #include "BLI_blenlib.h"
40
41 #include "BKE_context.h"
42 #include "BKE_utildefines.h"
43
44 #include "UI_interface.h"
45 #include "UI_view2d.h"
46
47 #include "ED_screen.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
56 /* ****************** Start/End Frame Operators *******************************/
57
58 static int time_set_sfra_exec (bContext *C, wmOperator *op)
59 {
60         Scene *scene= CTX_data_scene(C);
61         int frame= CFRA;
62         
63         if (scene == NULL)
64                 return OPERATOR_CANCELLED;
65                 
66         /* if 'end frame' (Preview Range or Actual) is less than 'frame', 
67          * clamp 'frame' to 'end frame'
68          */
69         if (PEFRA < frame) frame= PEFRA;
70                 
71         /* if Preview Range is defined, set the 'start' frame for that */
72         if (PRVRANGEON)
73                 scene->r.psfra= frame;
74         else
75                 scene->r.sfra= frame;
76         
77         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
78         
79         return OPERATOR_FINISHED;
80 }
81
82 void TIME_OT_start_frame_set (wmOperatorType *ot)
83 {
84         /* identifiers */
85         ot->name= "Set Start Frame";
86         ot->idname= "TIME_OT_start_frame_set";
87         ot->description="Set the start frame";
88         
89         /* api callbacks */
90         ot->exec= time_set_sfra_exec;
91         ot->poll= ED_operator_timeline_active;
92         
93         /* flags */
94         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
95 }       
96
97
98 static int time_set_efra_exec (bContext *C, wmOperator *op)
99 {
100         Scene *scene= CTX_data_scene(C);
101         int frame= CFRA;
102         
103         if (scene == NULL)
104                 return OPERATOR_CANCELLED;
105                 
106         /* if 'start frame' (Preview Range or Actual) is greater than 'frame', 
107          * clamp 'frame' to 'end frame'
108          */
109         if (PSFRA > frame) frame= PSFRA;
110                 
111         /* if Preview Range is defined, set the 'end' frame for that */
112         if (PRVRANGEON)
113                 scene->r.pefra= frame;
114         else
115                 scene->r.efra= frame;
116         
117         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
118         
119         return OPERATOR_FINISHED;
120 }
121
122 void TIME_OT_end_frame_set (wmOperatorType *ot)
123 {
124         /* identifiers */
125         ot->name= "Set End Frame";
126         ot->idname= "TIME_OT_end_frame_set";
127         ot->description="Set the end frame";
128         
129         /* api callbacks */
130         ot->exec= time_set_efra_exec;
131         ot->poll= ED_operator_timeline_active;
132         
133         /* flags */
134         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
135 }
136
137 /* ************************ View All Operator *******************************/
138
139 static int time_view_all_exec (bContext *C, wmOperator *op)
140 {
141         Scene *scene= CTX_data_scene(C);
142         ARegion *ar= CTX_wm_region(C);
143         View2D *v2d= (ar) ? &ar->v2d : NULL;
144         float extra;
145         
146         if ELEM(NULL, scene, ar)
147                 return OPERATOR_CANCELLED;
148                 
149         /* set extents of view to start/end frames (Preview Range too) */
150         v2d->cur.xmin= (float)PSFRA;
151         v2d->cur.xmax= (float)PEFRA;
152         
153         /* we need an extra "buffer" factor on either side so that the endpoints are visible */
154         extra= 0.01f * (v2d->cur.xmax - v2d->cur.xmin);
155         v2d->cur.xmin -= extra;
156         v2d->cur.xmax += extra;
157         
158         /* this only affects this TimeLine instance, so just force redraw of this region */
159         ED_region_tag_redraw(ar);
160         
161         return OPERATOR_FINISHED;
162 }
163
164 void TIME_OT_view_all (wmOperatorType *ot)
165 {
166         /* identifiers */
167         ot->name= "View All";
168         ot->idname= "TIME_OT_view_all";
169         ot->description= "Show the entire playable frame range";
170         
171         /* api callbacks */
172         ot->exec= time_view_all_exec;
173         ot->poll= ED_operator_timeline_active;
174         
175         /* flags */
176         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
177 }
178
179 /* ************************** registration **********************************/
180
181 void time_operatortypes(void)
182 {
183         WM_operatortype_append(TIME_OT_start_frame_set);
184         WM_operatortype_append(TIME_OT_end_frame_set);
185         WM_operatortype_append(TIME_OT_view_all);
186 }
187
188 void time_keymap(wmKeyConfig *keyconf)
189 {
190         wmKeyMap *keymap= WM_keymap_find(keyconf, "Timeline", SPACE_TIME, 0);
191         
192         WM_keymap_add_item(keymap, "TIME_OT_start_frame_set", SKEY, KM_PRESS, 0, 0);
193         WM_keymap_add_item(keymap, "TIME_OT_end_frame_set", EKEY, KM_PRESS, 0, 0);
194         WM_keymap_add_item(keymap, "TIME_OT_view_all", HOMEKEY, KM_PRESS, 0, 0);
195 }
196