svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r20855:20928
[blender.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, (float)PSFRA, v2d->cur.ymax);
97                 glRectf((float)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((float)PSFRA, v2d->cur.ymin, (float)PSFRA, v2d->cur.ymax);
106         fdrawline((float)PEFRA, v2d->cur.ymin, (float)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->category) {
168                 
169                 case NC_SCENE:
170                         /* any scene change for now */
171                         ED_region_tag_redraw(ar);
172                         break;
173         }
174 }
175
176 /* ************************ header time area region *********************** */
177
178 /* add handlers, stuff you only do once or on area/region changes */
179 static void time_header_area_init(wmWindowManager *wm, ARegion *ar)
180 {
181         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
182 }
183
184 static void time_header_area_draw(const bContext *C, ARegion *ar)
185 {
186         float col[3];
187
188         /* clear */
189         if(ED_screen_area_active(C))
190                 UI_GetThemeColor3fv(TH_HEADER, col);
191         else
192                 UI_GetThemeColor3fv(TH_HEADERDESEL, col);
193                 
194         glClearColor(col[0], col[1], col[2], 0.0);
195         glClear(GL_COLOR_BUFFER_BIT);
196         
197         /* set view2d view matrix for scrolling (without scrollers) */
198         UI_view2d_view_ortho(C, &ar->v2d);
199         
200         time_header_buttons(C, ar);
201         
202         /* restore view matrix? */
203         UI_view2d_view_restore(C);
204 }
205
206 static void time_header_area_listener(ARegion *ar, wmNotifier *wmn)
207 {
208         /* context changes */
209         switch(wmn->category) {
210                 case NC_SCREEN:
211                         if(wmn->data==ND_ANIMPLAY)
212                                 ED_region_tag_redraw(ar);
213                         break;
214                 case NC_SCENE:
215                         switch (wmn->data) {
216                                 case ND_FRAME:
217                                 case ND_KEYINGSET:
218                                         ED_region_tag_redraw(ar);
219                                 break;
220                         }
221         }
222 }
223
224 /* ******************** default callbacks for time space ***************** */
225
226 static SpaceLink *time_new(const bContext *C)
227 {
228         Scene *scene= CTX_data_scene(C);
229         ARegion *ar;
230         SpaceTime *stime;
231
232         stime= MEM_callocN(sizeof(SpaceTime), "inittime");
233
234         stime->spacetype= SPACE_TIME;
235         stime->redraws= TIME_ALL_3D_WIN|TIME_ALL_ANIM_WIN;
236         stime->flag |= TIME_DRAWFRAMES;
237
238         /* header */
239         ar= MEM_callocN(sizeof(ARegion), "header for time");
240         
241         BLI_addtail(&stime->regionbase, ar);
242         ar->regiontype= RGN_TYPE_HEADER;
243         ar->alignment= RGN_ALIGN_BOTTOM;
244         
245         /* main area */
246         ar= MEM_callocN(sizeof(ARegion), "main area for time");
247         
248         BLI_addtail(&stime->regionbase, ar);
249         ar->regiontype= RGN_TYPE_WINDOW;
250         
251         ar->v2d.tot.xmin= (float)(SFRA - 4);
252         ar->v2d.tot.ymin= 0.0f;
253         ar->v2d.tot.xmax= (float)(EFRA + 4);
254         ar->v2d.tot.ymax= 50.0f;
255         
256         ar->v2d.cur= ar->v2d.tot;
257
258         ar->v2d.min[0]= 1.0f;
259         ar->v2d.min[1]= 50.0f;
260
261         ar->v2d.max[0]= MAXFRAMEF;
262         ar->v2d.max[1]= 50.0; 
263
264         ar->v2d.minzoom= 0.1f;
265         ar->v2d.maxzoom= 10.0;
266
267         ar->v2d.scroll |= (V2D_SCROLL_BOTTOM|V2D_SCROLL_SCALE_HORIZONTAL);
268         ar->v2d.align |= V2D_ALIGN_NO_NEG_Y;
269         ar->v2d.keepofs |= V2D_LOCKOFS_Y;
270         ar->v2d.keepzoom |= V2D_LOCKZOOM_Y;
271
272
273         return (SpaceLink*)stime;
274 }
275
276 /* not spacelink itself */
277 static void time_free(SpaceLink *sl)
278 {
279 }
280
281
282 /* spacetype; init callback in ED_area_initialize() */
283 /* init is called to (re)initialize an existing editor (file read, screen changes) */
284 /* validate spacedata, add own area level handlers */
285 static void time_init(wmWindowManager *wm, ScrArea *sa)
286 {
287         
288 }
289
290 static SpaceLink *time_duplicate(SpaceLink *sl)
291 {
292         SpaceTime *stime= (SpaceTime *)sl;
293         SpaceTime *stimen= MEM_dupallocN(stime);
294         
295         return (SpaceLink *)stimen;
296 }
297
298 /* only called once, from space_api/spacetypes.c */
299 /* it defines all callbacks to maintain spaces */
300 void ED_spacetype_time(void)
301 {
302         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype time");
303         ARegionType *art;
304         
305         st->spaceid= SPACE_TIME;
306         strncpy(st->name, "Timeline", BKE_ST_MAXNAME);
307         
308         st->new= time_new;
309         st->free= time_free;
310         st->init= time_init;
311         st->duplicate= time_duplicate;
312         st->operatortypes= time_operatortypes;
313         st->keymap= NULL;
314         
315         /* regions: main window */
316         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
317         art->regionid = RGN_TYPE_WINDOW;
318         art->keymapflag= ED_KEYMAP_VIEW2D|ED_KEYMAP_MARKERS|ED_KEYMAP_ANIMATION|ED_KEYMAP_FRAMES;
319         
320         art->init= time_main_area_init;
321         art->draw= time_main_area_draw;
322         art->listener= time_main_area_listener;
323         art->keymap= time_keymap;
324         BLI_addhead(&st->regiontypes, art);
325         
326         /* regions: header */
327         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
328         art->regionid = RGN_TYPE_HEADER;
329         art->minsizey= HEADERY;
330         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
331         
332         art->init= time_header_area_init;
333         art->draw= time_header_area_draw;
334         art->listener= time_header_area_listener;
335         BLI_addhead(&st->regiontypes, art);
336                 
337         BKE_spacetype_register(st);
338 }
339