10ddf6baaeb4c53cb299318be6272d73ac96b6f9
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Joshua Leung (full recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef ED_KEYFRAMES_DRAW_H
31 #define ED_KEYFRAMES_DRAW_H
32
33 struct bAnimContext;
34 struct AnimData;
35 struct BezTriple;
36 struct FCurve;
37 struct bDopeSheet;
38 struct bAction;
39 struct bActionGroup;
40 struct Object;
41 struct ListBase;
42 struct bGPDlayer;
43 struct Scene;
44 struct View2D;
45 struct DLRBT_Tree;
46
47 /* ****************************** Base Structs ****************************** */
48
49 /* Keyframe Column Struct */
50 typedef struct ActKeyColumn {
51                 /* ListBase linkage */
52         struct ActKeyColumn *next, *prev;
53         
54                 /* sorting-tree linkage */
55         struct ActKeyColumn *left, *right;      /* 'children' of this node, less than and greater than it (respectively) */
56         struct ActKeyColumn *parent;            /* parent of this node in the tree */
57         char tree_col;                                          /* DLRB_BLACK or DLRB_RED */
58         
59                 /* keyframe info */
60         char key_type;                                          /* eBezTripe_KeyframeType */
61         short sel;
62         float cfra;
63         
64         /* only while drawing - used to determine if long-keyframe needs to be drawn */
65         short modified;
66         short totcurve;
67 } ActKeyColumn;
68
69 /* 'Long Keyframe' Struct */
70 typedef struct ActKeyBlock {
71                 /* ListBase linkage */
72         struct ActKeyBlock *next, *prev;
73         
74                 /* sorting-tree linkage */
75         struct ActKeyBlock *left, *right;       /* 'children' of this node, less than and greater than it (respectively) */
76         struct ActKeyBlock *parent;                     /* parent of this node in the tree */
77         char tree_col;                                          /* DLRB_BLACK or DLRB_RED */
78         
79                 /* key-block info */
80         char sel;
81         short handle_type;
82         float val;
83         float start, end;
84         
85         /* only while drawing - used to determine if block needs to be drawn */
86         short modified;
87         short totcurve; 
88 } ActKeyBlock;
89
90 /* *********************** Keyframe Drawing ****************************** */
91
92 /* options for keyframe shape drawing */
93 typedef enum eKeyframeShapeDrawOpts {
94                 /* only the border */
95         KEYFRAME_SHAPE_FRAME    = 0,
96                 /* only the inside filling */
97         KEYFRAME_SHAPE_INSIDE,
98                 /* the whole thing */
99         KEYFRAME_SHAPE_BOTH
100 } eKeyframeShapeDrawOpts;
101
102 /* draw simple diamond-shape keyframe (with OpenGL) */
103 void draw_keyframe_shape(float x, float y, float xscale, float hsize, short sel, short key_type, short mode, float alpha);
104
105 /* ******************************* Methods ****************************** */
106
107 /* Channel Drawing ------------------ */
108 /* F-Curve */
109 void draw_fcurve_channel(struct View2D *v2d, struct AnimData *adt, struct FCurve *fcu, float ypos);
110 /* Action Group Summary */
111 void draw_agroup_channel(struct View2D *v2d, struct AnimData *adt, struct bActionGroup *agrp, float ypos);
112 /* Action Summary */
113 void draw_action_channel(struct View2D *v2d, struct AnimData *adt, struct bAction *act, float ypos);
114 /* Object Summary */
115 void draw_object_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Object *ob, float ypos);
116 /* Scene Summary */
117 void draw_scene_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Scene *sce, float ypos);
118 /* DopeSheet Summary */
119 void draw_summary_channel(struct View2D *v2d, struct bAnimContext *ac, float ypos);
120 /* Grease Pencil Layer */ 
121 // XXX not restored 
122 void draw_gpl_channel(struct View2D *v2d, struct bDopeSheet *ads, struct bGPDlayer *gpl, float ypos);
123
124 /* Keydata Generation --------------- */
125 /* F-Curve */
126 void fcurve_to_keylist(struct AnimData *adt, struct FCurve *fcu, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
127 /* Action Group */
128 void agroup_to_keylist(struct AnimData *adt, struct bActionGroup *agrp, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
129 /* Action */
130 void action_to_keylist(struct AnimData *adt, struct bAction *act, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
131 /* Object */
132 void ob_to_keylist(struct bDopeSheet *ads, struct Object *ob, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
133 /* Scene */
134 void scene_to_keylist(struct bDopeSheet *ads, struct Scene *sce, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
135 /* DopeSheet Summary */
136 void summary_to_keylist(struct bAnimContext *ac, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
137 /* Grease Pencil Layer */
138 // XXX not restored
139 void gpl_to_keylist(struct bDopeSheet *ads, struct bGPDlayer *gpl, struct DLRBT_Tree *keys);
140
141 /* ActKeyColumn API ---------------- */
142 /* Comparator callback used for ActKeyColumns and cframe float-value pointer */
143 short compare_ak_cfraPtr(void *node, void *data);
144
145 #endif  /*  ED_KEYFRAMES_DRAW_H */
146