svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / source / blender / editors / include / ED_keyframes_draw.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joshua Leung (full recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ED_keyframes_draw.h
29  *  \ingroup editors
30  */
31
32 #ifndef ED_KEYFRAMES_DRAW_H
33 #define ED_KEYFRAMES_DRAW_H
34
35 struct bAnimContext;
36 struct AnimData;
37 struct BezTriple;
38 struct FCurve;
39 struct bDopeSheet;
40 struct bAction;
41 struct bActionGroup;
42 struct Object;
43 struct ListBase;
44 struct bGPDlayer;
45 struct Scene;
46 struct View2D;
47 struct DLRBT_Tree;
48
49 /* ****************************** Base Structs ****************************** */
50
51 /* Keyframe Column Struct */
52 typedef struct ActKeyColumn {
53                 /* ListBase linkage */
54         struct ActKeyColumn *next, *prev;
55         
56                 /* sorting-tree linkage */
57         struct ActKeyColumn *left, *right;      /* 'children' of this node, less than and greater than it (respectively) */
58         struct ActKeyColumn *parent;            /* parent of this node in the tree */
59         char tree_col;                                          /* DLRB_BLACK or DLRB_RED */
60         
61                 /* keyframe info */
62         char key_type;                                          /* eBezTripe_KeyframeType */
63         short sel;
64         float cfra;
65         
66         /* only while drawing - used to determine if long-keyframe needs to be drawn */
67         short modified;
68         short totcurve;
69 } ActKeyColumn;
70
71 /* 'Long Keyframe' Struct */
72 typedef struct ActKeyBlock {
73                 /* ListBase linkage */
74         struct ActKeyBlock *next, *prev;
75         
76                 /* sorting-tree linkage */
77         struct ActKeyBlock *left, *right;       /* 'children' of this node, less than and greater than it (respectively) */
78         struct ActKeyBlock *parent;                     /* parent of this node in the tree */
79         char tree_col;                                          /* DLRB_BLACK or DLRB_RED */
80         
81                 /* key-block info */
82         char sel;
83         short handle_type;
84         float val;
85         float start, end;
86         
87         /* only while drawing - used to determine if block needs to be drawn */
88         short modified;
89         short totcurve; 
90 } ActKeyBlock;
91
92 /* *********************** Keyframe Drawing ****************************** */
93
94 /* options for keyframe shape drawing */
95 typedef enum eKeyframeShapeDrawOpts {
96                 /* only the border */
97         KEYFRAME_SHAPE_FRAME    = 0,
98                 /* only the inside filling */
99         KEYFRAME_SHAPE_INSIDE,
100                 /* the whole thing */
101         KEYFRAME_SHAPE_BOTH
102 } eKeyframeShapeDrawOpts;
103
104 /* draw simple diamond-shape keyframe (with OpenGL) */
105 void draw_keyframe_shape(float x, float y, float xscale, float hsize, short sel, short key_type, short mode, float alpha);
106
107 /* ******************************* Methods ****************************** */
108
109 /* Channel Drawing ------------------ */
110 /* F-Curve */
111 void draw_fcurve_channel(struct View2D *v2d, struct AnimData *adt, struct FCurve *fcu, float ypos);
112 /* Action Group Summary */
113 void draw_agroup_channel(struct View2D *v2d, struct AnimData *adt, struct bActionGroup *agrp, float ypos);
114 /* Action Summary */
115 void draw_action_channel(struct View2D *v2d, struct AnimData *adt, struct bAction *act, float ypos);
116 /* Object Summary */
117 void draw_object_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Object *ob, float ypos);
118 /* Scene Summary */
119 void draw_scene_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Scene *sce, float ypos);
120 /* DopeSheet Summary */
121 void draw_summary_channel(struct View2D *v2d, struct bAnimContext *ac, float ypos);
122 /* Grease Pencil Layer */ 
123 // XXX not restored 
124 void draw_gpl_channel(struct View2D *v2d, struct bDopeSheet *ads, struct bGPDlayer *gpl, float ypos);
125
126 /* Keydata Generation --------------- */
127 /* F-Curve */
128 void fcurve_to_keylist(struct AnimData *adt, struct FCurve *fcu, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
129 /* Action Group */
130 void agroup_to_keylist(struct AnimData *adt, struct bActionGroup *agrp, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
131 /* Action */
132 void action_to_keylist(struct AnimData *adt, struct bAction *act, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
133 /* Object */
134 void ob_to_keylist(struct bDopeSheet *ads, struct Object *ob, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
135 /* Scene */
136 void scene_to_keylist(struct bDopeSheet *ads, struct Scene *sce, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
137 /* DopeSheet Summary */
138 void summary_to_keylist(struct bAnimContext *ac, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
139 /* Grease Pencil Layer */
140 // XXX not restored
141 void gpl_to_keylist(struct bDopeSheet *ads, struct bGPDlayer *gpl, struct DLRBT_Tree *keys);
142
143 /* ActKeyColumn API ---------------- */
144 /* Comparator callback used for ActKeyColumns and cframe float-value pointer */
145 short compare_ak_cfraPtr(void *node, void *data);
146
147 /* Comparator callback used for ActKeyBlocks and cframe float-value pointer */
148 short compare_ab_cfraPtr(void *node, void *data);
149
150 /* Checks if ActKeyBlock can be used (i.e. drawn/used to detect "holds") */
151 short actkeyblock_is_valid(ActKeyBlock *ab, struct DLRBT_Tree *keys);
152
153 #endif  /*  ED_KEYFRAMES_DRAW_H */
154