241cd700c2096ddc120c48654d3989dce65113ce
[blender.git] / source / blender / editors / include / ED_markers.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ED_markers.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_MARKERS_H__
32 #define __ED_MARKERS_H__
33
34 struct wmKeyConfig;
35 struct wmKeyMap;
36 struct bContext;
37 struct bAnimContext;
38 struct Scene;
39 struct TimeMarker;
40
41 /* Drawing API ------------------------------ */
42
43 /* flags for drawing markers */
44 enum {
45         DRAW_MARKERS_LINES  = (1 << 0),
46         DRAW_MARKERS_LOCAL  = (1 << 1),
47         DRAW_MARKERS_MARGIN = (1 << 2),
48 };
49
50 void draw_markers_time(const struct bContext *C, int flag);
51
52 /* Backend API ----------------------------- */
53
54 ListBase *ED_context_get_markers(const struct bContext *C);
55 ListBase *ED_animcontext_get_markers(const struct bAnimContext *ac);
56
57 int ED_markers_post_apply_transform(ListBase *markers, struct Scene *scene, int mode, float value, char side);
58
59 struct TimeMarker *ED_markers_find_nearest_marker(ListBase *markers, float x);
60 int ED_markers_find_nearest_marker_time(ListBase *markers, float x);
61
62 void ED_markers_get_minmax(ListBase *markers, short sel, float *first, float *last);
63
64 void ED_markers_make_cfra_list(ListBase *markers, ListBase *lb, short sel);
65
66 struct TimeMarker *ED_markers_get_first_selected(ListBase *markers);
67
68 /* Operators ------------------------------ */
69
70 /* called in screen_ops.c:ED_operatortypes_screen() */
71 void ED_operatortypes_marker(void); 
72 /* called in screen_ops.c:ED_keymap_screen() */
73 void ED_keymap_marker(struct wmKeyConfig *keyconf);
74
75 /* called in animation editors - keymap defines */
76 void ED_marker_keymap_animedit_conflictfree(struct wmKeyMap *keymap);
77
78 /* debugging only */
79 void debug_markers_print_list(struct ListBase *markers);
80
81 #endif /* __ED_MARKERS_H__ */