2.5
[blender-staging.git] / source / blender / editors / space_time / space_time.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 <string.h>
30 #include <stdio.h>
31
32 #include "DNA_space_types.h"
33 #include "DNA_scene_types.h"
34 #include "DNA_screen_types.h"
35 #include "DNA_windowmanager_types.h"
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BLI_blenlib.h"
40
41 #include "BKE_context.h"
42 #include "BKE_global.h"
43 #include "BKE_screen.h"
44
45 #include "ED_space_api.h"
46 #include "ED_screen.h"
47 #include "ED_util.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 #include "BIF_gl.h"
53 #include "BIF_glutil.h"
54
55 #include "UI_interface.h"
56 #include "UI_resources.h"
57 #include "UI_view2d.h"
58
59 #include "ED_markers.h"
60
61 #include "time_intern.h"
62
63 /* ************************ main time area region *********************** */
64
65 /* draws a current frame indicator for the TimeLine */
66 static void time_draw_cfra_time(const bContext *C, SpaceTime *stime, ARegion *ar)
67 {
68         Scene *scene= CTX_data_scene(C);
69         float vec[2];
70         
71         vec[0]= scene->r.cfra*scene->r.framelen;
72
73         UI_ThemeColor(TH_CFRAME);       // no theme, should be global color once...
74         glLineWidth(3.0);
75
76         glBegin(GL_LINES);
77                 vec[1]= ar->v2d.cur.ymin;
78                 glVertex2fv(vec);
79                 vec[1]= ar->v2d.cur.ymax;
80                 glVertex2fv(vec);
81         glEnd();
82         
83         glLineWidth(1.0);
84 }
85
86 static void time_draw_sfra_efra(const bContext *C, SpaceTime *stime, ARegion *ar)
87 {
88         View2D *v2d= UI_view2d_fromcontext(C);
89         Scene *scene= CTX_data_scene(C);
90         
91         /* draw darkened area outside of active timeline 
92          * frame range used is preview range or scene range */
93         UI_ThemeColorShade(TH_BACK, -25);
94
95         if (PSFRA < PEFRA) {
96                 glRectf(v2d->cur.xmin, v2d->cur.ymin, PSFRA, v2d->cur.ymax);
97                 glRectf(PEFRA, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
98         }
99         else {
100                 glRectf(v2d->cur.xmin, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
101         }
102
103         UI_ThemeColorShade(TH_BACK, -60);
104         /* thin lines where the actual frames are */
105         fdrawline(PSFRA, v2d->cur.ymin, PSFRA, v2d->cur.ymax);
106         fdrawline(PEFRA, v2d->cur.ymin, PEFRA, v2d->cur.ymax);
107 }
108
109 /* add handlers, stuff you only do once or on area/region changes */
110 static void time_main_area_init(wmWindowManager *wm, ARegion *ar)
111 {
112         ListBase *keymap;
113         
114         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);
115         
116         /* own keymap */
117         keymap= WM_keymap_listbase(wm, "TimeLine", SPACE_TIME, 0);      /* XXX weak? */
118         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
119 }
120
121
122 static void time_main_area_draw(const bContext *C, ARegion *ar)
123 {
124         /* draw entirely, view changes should be handled here */
125         SpaceTime *stime= (SpaceTime*)CTX_wm_space_data(C);
126         View2D *v2d= &ar->v2d;
127         View2DGrid *grid;
128         View2DScrollers *scrollers;
129         float col[3];
130         int unit;
131         
132         /* clear and setup matrix */
133         UI_GetThemeColor3fv(TH_BACK, col);
134         glClearColor(col[0], col[1], col[2], 0.0);
135         glClear(GL_COLOR_BUFFER_BIT);
136         
137         UI_view2d_view_ortho(C, v2d);
138
139         /* start and end frame */
140         time_draw_sfra_efra(C, stime, ar);
141
142         /* grid */
143         unit= (stime->flag & TIME_DRAWFRAMES)? V2D_UNIT_FRAMES: V2D_UNIT_SECONDS;
144         grid= UI_view2d_grid_calc(C, v2d, unit, V2D_GRID_CLAMP, V2D_ARG_DUMMY, V2D_ARG_DUMMY, ar->winx, ar->winy);
145         UI_view2d_grid_draw(C, v2d, grid, (V2D_VERTICAL_LINES|V2D_VERTICAL_AXIS));
146         UI_view2d_grid_free(grid);
147
148         /* current frame */
149         time_draw_cfra_time(C, stime, ar);
150         
151         /* markers */
152         UI_view2d_view_orthoSpecial(C, v2d, 1);
153         draw_markers_time(C, 0);
154         
155         /* reset view matrix */
156         UI_view2d_view_restore(C);
157         
158         /* scrollers */
159         scrollers= UI_view2d_scrollers_calc(C, v2d, unit, V2D_GRID_CLAMP, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
160         UI_view2d_scrollers_draw(C, v2d, scrollers);
161         UI_view2d_scrollers_free(scrollers);
162 }
163
164 static void time_main_area_listener(ARegion *ar, wmNotifier *wmn)
165 {
166         /* context changes */
167         switch(wmn->type) {
168                 
169                 case WM_NOTE_MARKERS_CHANGED:
170                         ED_region_tag_redraw(ar);
171                         break;
172         }
173 }
174
175 /* ************************ header time area region *********************** */
176
177 /* add handlers, stuff you only do once or on area/region changes */
178 static void time_header_area_init(wmWindowManager *wm, ARegion *ar)
179 {
180         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
181 }
182
183 static void time_header_area_draw(const bContext *C, ARegion *ar)
184 {
185         float col[3];
186
187         /* clear */
188         if(ED_screen_area_active(C))
189                 UI_GetThemeColor3fv(TH_HEADER, col);
190         else
191                 UI_GetThemeColor3fv(TH_HEADERDESEL, col);
192                 
193         glClearColor(col[0], col[1], col[2], 0.0);
194         glClear(GL_COLOR_BUFFER_BIT);
195         
196         /* set view2d view matrix for scrolling (without scrollers) */
197         UI_view2d_view_ortho(C, &ar->v2d);
198         
199         time_header_buttons(C, ar);
200         
201         /* restore view matrix? */
202         UI_view2d_view_restore(C);
203 }
204
205
206 /* ******************** default callbacks for time space ***************** */
207
208 static SpaceLink *time_new(const bContext *C)
209 {
210         Scene *scene= CTX_data_scene(C);
211         ARegion *ar;
212         SpaceTime *stime;
213
214         stime= MEM_callocN(sizeof(SpaceTime), "inittime");
215
216         stime->spacetype= SPACE_TIME;
217         stime->redraws= TIME_ALL_3D_WIN|TIME_ALL_ANIM_WIN;
218         stime->flag |= TIME_DRAWFRAMES;
219
220         /* header */
221         ar= MEM_callocN(sizeof(ARegion), "header for time");
222         
223         BLI_addtail(&stime->regionbase, ar);
224         ar->regiontype= RGN_TYPE_HEADER;
225         ar->alignment= RGN_ALIGN_BOTTOM;
226         
227         /* main area */
228         ar= MEM_callocN(sizeof(ARegion), "main area for time");
229         
230         BLI_addtail(&stime->regionbase, ar);
231         ar->regiontype= RGN_TYPE_WINDOW;
232         
233         ar->v2d.tot.xmin= (float)(SFRA - 4);
234         ar->v2d.tot.ymin= 0.0f;
235         ar->v2d.tot.xmax= (float)(EFRA + 4);
236         ar->v2d.tot.ymax= 50.0f;
237         
238         ar->v2d.cur= ar->v2d.tot;
239
240         ar->v2d.min[0]= 1.0f;
241         ar->v2d.min[1]= 50.0f;
242
243         ar->v2d.max[0]= MAXFRAMEF;
244         ar->v2d.max[1]= 50.0; 
245
246         ar->v2d.minzoom= 0.1f;
247         ar->v2d.maxzoom= 10.0;
248
249         ar->v2d.scroll |= (V2D_SCROLL_BOTTOM|V2D_SCROLL_SCALE_HORIZONTAL);
250         ar->v2d.align |= V2D_ALIGN_NO_NEG_Y;
251         ar->v2d.keepofs |= V2D_LOCKOFS_Y;
252         ar->v2d.keepzoom |= V2D_LOCKZOOM_Y;
253
254
255         return (SpaceLink*)stime;
256 }
257
258 /* not spacelink itself */
259 static void time_free(SpaceLink *sl)
260 {
261 }
262
263
264 /* spacetype; init callback in ED_area_initialize() */
265 /* init is called to (re)initialize an existing editor (file read, screen changes) */
266 /* validate spacedata, add own area level handlers */
267 static void time_init(wmWindowManager *wm, ScrArea *sa)
268 {
269         
270 }
271
272 static SpaceLink *time_duplicate(SpaceLink *sl)
273 {
274         SpaceTime *stime= (SpaceTime *)sl;
275         SpaceTime *stimen= MEM_dupallocN(stime);
276         
277         return (SpaceLink *)stimen;
278 }
279
280 /* only called once, from space_api/spacetypes.c */
281 /* it defines all callbacks to maintain spaces */
282 void ED_spacetype_time(void)
283 {
284         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype time");
285         ARegionType *art;
286         
287         st->spaceid= SPACE_TIME;
288         strncpy(st->name, "Timeline", BKE_ST_MAXNAME);
289         
290         st->new= time_new;
291         st->free= time_free;
292         st->init= time_init;
293         st->duplicate= time_duplicate;
294         st->operatortypes= time_operatortypes;
295         st->keymap= NULL;
296         
297         /* regions: main window */
298         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
299         art->regionid = RGN_TYPE_WINDOW;
300         art->keymapflag= ED_KEYMAP_VIEW2D|ED_KEYMAP_MARKERS|ED_KEYMAP_ANIMATION;
301         
302         art->init= time_main_area_init;
303         art->draw= time_main_area_draw;
304         art->listener= time_main_area_listener;
305         //art->keymap= time_keymap;
306         BLI_addhead(&st->regiontypes, art);
307         
308         /* regions: header */
309         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
310         art->regionid = RGN_TYPE_HEADER;
311         art->minsizey= HEADERY;
312         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
313         
314         art->init= time_header_area_init;
315         art->draw= time_header_area_draw;
316         BLI_addhead(&st->regiontypes, art);
317                 
318         BKE_spacetype_register(st);
319 }
320