Graph editor: Add channel option to make it persistent on display
[blender.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 CacheFile;
38 struct FCurve;
39 struct bDopeSheet;
40 struct bAction;
41 struct bActionGroup;
42 struct Object;
43 struct ListBase;
44 struct bGPDlayer;
45 struct MaskLayer;
46 struct Scene;
47 struct View2D;
48 struct DLRBT_Tree;
49
50 /* ****************************** Base Structs ****************************** */
51
52 /* Keyframe Column Struct */
53 typedef struct ActKeyColumn {
54         /* ListBase linkage */
55         struct ActKeyColumn *next, *prev;
56         
57         /* sorting-tree linkage */
58         struct ActKeyColumn *left, *right;  /* 'children' of this node, less than and greater than it (respectively) */
59         struct ActKeyColumn *parent;        /* parent of this node in the tree */
60         char tree_col;                      /* DLRB_BLACK or DLRB_RED */
61         
62         /* keyframe info */
63         char key_type;                      /* eBezTripe_KeyframeType */
64         short sel;
65         float cfra;
66         
67         /* only while drawing - used to determine if long-keyframe needs to be drawn */
68         short modified;
69         short totcurve;
70 } ActKeyColumn;
71
72 /* 'Long Keyframe' Struct */
73 typedef struct ActKeyBlock {
74         /* ListBase linkage */
75         struct ActKeyBlock *next, *prev;
76         
77         /* sorting-tree linkage */
78         struct ActKeyBlock *left, *right;   /* 'children' of this node, less than and greater than it (respectively) */
79         struct ActKeyBlock *parent;         /* parent of this node in the tree */
80         char tree_col;                      /* DLRB_BLACK or DLRB_RED */
81         
82         /* key-block info */
83         char sel;
84         short flag;
85         float val;
86         float start, end;
87         
88         /* only while drawing - used to determine if block needs to be drawn */
89         short modified;
90         short totcurve; 
91 } ActKeyBlock;
92
93 /* ActKeyBlock - Flag */
94 typedef enum eActKeyBlock_Flag {
95         /* Key block represents a moving hold */
96         ACTKEYBLOCK_FLAG_MOVING_HOLD     = (1 << 0),
97 } eActKeyBlock_Flag;
98
99 /* *********************** Keyframe Drawing ****************************** */
100
101 /* options for keyframe shape drawing */
102 typedef enum eKeyframeShapeDrawOpts {
103         /* only the border */
104         KEYFRAME_SHAPE_FRAME = 0,
105         /* only the inside filling */
106         KEYFRAME_SHAPE_INSIDE,
107         /* the whole thing */
108         KEYFRAME_SHAPE_BOTH
109 } eKeyframeShapeDrawOpts;
110
111 /* draw simple diamond-shape keyframe (with OpenGL) */
112 void draw_keyframe_shape(float x, float y, float xscale, float hsize, short sel, short key_type, short mode, float alpha);
113
114 /* ******************************* Methods ****************************** */
115
116 /* Channel Drawing ------------------ */
117 /* F-Curve */
118 void draw_fcurve_channel(struct View2D *v2d, struct AnimData *adt, struct FCurve *fcu, float ypos, float yscale_fac);
119 /* Action Group Summary */
120 void draw_agroup_channel(struct View2D *v2d, struct AnimData *adt, struct bActionGroup *agrp, float ypos, float yscale_fac);
121 /* Action Summary */
122 void draw_action_channel(struct View2D *v2d, struct AnimData *adt, struct bAction *act, float ypos, float yscale_fac);
123 /* Object Summary */
124 void draw_object_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Object *ob, float ypos, float yscale_fac);
125 /* Scene Summary */
126 void draw_scene_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Scene *sce, float ypos, float yscale_fac);
127 /* DopeSheet Summary */
128 void draw_summary_channel(struct View2D *v2d, struct bAnimContext *ac, float ypos, float yscale_fac);
129 /* Grease Pencil datablock summary */
130 void draw_gpencil_channel(struct View2D *v2d, struct bDopeSheet *ads, struct bGPdata *gpd, float ypos, float yscale_fac);
131 /* Grease Pencil Layer */
132 void draw_gpl_channel(struct View2D *v2d, struct bDopeSheet *ads, struct bGPDlayer *gpl, float ypos, float yscale_fac);
133 /* Mask Layer */
134 void draw_masklay_channel(struct View2D *v2d, struct bDopeSheet *ads, struct MaskLayer *masklay, float ypos, float yscale_fac);
135
136 /* Keydata Generation --------------- */
137 /* F-Curve */
138 void fcurve_to_keylist(struct AnimData *adt, struct FCurve *fcu, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
139 /* Action Group */
140 void agroup_to_keylist(struct AnimData *adt, struct bActionGroup *agrp, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
141 /* Action */
142 void action_to_keylist(struct AnimData *adt, struct bAction *act, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
143 /* Object */
144 void ob_to_keylist(struct bDopeSheet *ads, struct Object *ob, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
145 /* Cache File */
146 void cachefile_to_keylist(struct bDopeSheet *ads, struct CacheFile *cache_file, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
147 /* Scene */
148 void scene_to_keylist(struct bDopeSheet *ads, struct Scene *sce, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
149 /* DopeSheet Summary */
150 void summary_to_keylist(struct bAnimContext *ac, struct DLRBT_Tree *keys, struct DLRBT_Tree *blocks);
151 /* Grease Pencil datablock summary */
152 void gpencil_to_keylist(struct bDopeSheet *ads, struct bGPdata *gpd, struct DLRBT_Tree *keys);
153 /* Grease Pencil Layer */
154 void gpl_to_keylist(struct bDopeSheet *ads, struct bGPDlayer *gpl, struct DLRBT_Tree *keys);
155 /* Mask */
156 void mask_to_keylist(struct bDopeSheet *UNUSED(ads), struct MaskLayer *masklay, struct DLRBT_Tree *keys);
157
158 /* ActKeyColumn API ---------------- */
159 /* Comparator callback used for ActKeyColumns and cframe float-value pointer */
160 short compare_ak_cfraPtr(void *node, void *data);
161
162 /* Comparator callback used for ActKeyBlocks and cframe float-value pointer */
163 short compare_ab_cfraPtr(void *node, void *data);
164
165 /* Checks if ActKeyBlock can be used (i.e. drawn/used to detect "holds") */
166 bool actkeyblock_is_valid(ActKeyBlock *ab, struct DLRBT_Tree *keys);
167
168 #endif  /*  __ED_KEYFRAMES_DRAW_H__ */