SVN maintenance.
[blender.git] / source / blender / editors / include / ED_keyframes_draw.h
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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef ED_KEYFRAMES_DRAW_H
31 #define ED_KEYFRAMES_DRAW_H
32
33 struct BezTriple;
34 struct FCurve;
35 struct gla2DDrawInfo;
36 struct bAction;
37 struct bActionGroup;
38 struct Object;
39 struct ListBase;
40 struct bGPDlayer;
41 struct Scene;
42
43 /* ****************************** Base Structs ****************************** */
44
45 /* Keyframe Column Struct */
46 typedef struct ActKeyColumn {
47         struct ActKeyColumn *next, *prev;
48         short sel, handle_type;
49         float cfra;
50         
51         /* only while drawing - used to determine if long-keyframe needs to be drawn */
52         short modified;
53         short totcurve;
54 } ActKeyColumn;
55
56 /* 'Long Keyframe' Struct */
57 typedef struct ActKeyBlock {
58         struct ActKeyBlock *next, *prev;
59         short sel, handle_type;
60         float val;
61         float start, end;
62         
63         /* only while drawing - used to determine if block needs to be drawn */
64         short modified;
65         short totcurve; 
66 } ActKeyBlock;
67
68
69 /* Inclusion-Range Limiting Struct (optional) */
70 typedef struct ActKeysInc {
71         struct bDopeSheet *ads;                 /* dopesheet data (for dopesheet mode) */
72         struct Object *ob;                              /* owner object for NLA-scaling info (if Object channels, is just Object) */
73         short actmode;                                  /* mode of the Action Editor (-1 is for NLA) */
74         
75         float start, end;                               /* frames (global-time) to only consider keys between */  // XXX not used anymore!
76 } ActKeysInc;
77
78 /* ******************************* Methods ****************************** */
79
80 /* Channel Drawing */
81 void draw_fcurve_channel(struct gla2DDrawInfo *di, ActKeysInc *aki, struct FCurve *fcu, float ypos);
82 void draw_agroup_channel(struct gla2DDrawInfo *di, ActKeysInc *aki, struct bActionGroup *agrp, float ypos);
83 void draw_action_channel(struct gla2DDrawInfo *di, ActKeysInc *aki, struct bAction *act, float ypos);
84 void draw_object_channel(struct gla2DDrawInfo *di, ActKeysInc *aki, struct Object *ob, float ypos);
85 void draw_scene_channel(struct gla2DDrawInfo *di, ActKeysInc *aki, struct Scene *sce, float ypos);
86 void draw_gpl_channel(struct gla2DDrawInfo *di, ActKeysInc *aki, struct bGPDlayer *gpl, float ypos);
87
88 /* Keydata Generation */
89 void fcurve_to_keylist(struct FCurve *fcu, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
90 void agroup_to_keylist(struct bActionGroup *agrp, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
91 void action_to_keylist(struct bAction *act, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
92 void action_nlascaled_to_keylist(struct Object *ob, struct bAction *act, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
93 void ob_to_keylist(struct Object *ob, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
94 void scene_to_keylist(struct Scene *sce, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
95 void gpl_to_keylist(struct bGPDlayer *gpl, ListBase *keys, ListBase *blocks, ActKeysInc *aki);
96
97 #endif  /*  ED_KEYFRAMES_DRAW_H */
98