doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / editors / space_graph / graph_intern.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) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef ED_GRAPH_INTERN_H
29 #define ED_GRAPH_INTERN_H
30
31 struct bContext;
32 struct wmWindowManager;
33 struct bAnimContext;
34 struct bAnimListElem;
35 struct FCurve;
36 struct FModifier;
37 struct SpaceIpo;
38 struct ScrArea;
39 struct ARegion;
40 struct ARegionType;
41 struct View2DGrid;
42
43 /* internal exports only */
44
45 /* ***************************************** */
46 /* space_graph.c */
47 struct ARegion *graph_has_buttons_region(struct ScrArea *sa);
48
49 /* ***************************************** */
50 /* graph_draw.c */
51 void graph_draw_channel_names(struct bContext *C, struct bAnimContext *ac, struct ARegion *ar);
52
53 void graph_draw_curves(struct bAnimContext *ac, struct SpaceIpo *sipo, struct ARegion *ar, struct View2DGrid *grid, short sel);
54 void graph_draw_ghost_curves(struct bAnimContext *ac, struct SpaceIpo *sipo, struct ARegion *ar);
55
56 /* ***************************************** */
57 /* graph_header.c */
58 void graph_header_buttons(const bContext *C, struct ARegion *ar);
59
60 /* ***************************************** */
61 /* graph_select.c */
62
63 void GRAPH_OT_select_all_toggle(struct wmOperatorType *ot);
64 void GRAPH_OT_select_border(struct wmOperatorType *ot);
65 void GRAPH_OT_select_column(struct wmOperatorType *ot);
66 void GRAPH_OT_select_linked(struct wmOperatorType *ot);
67 void GRAPH_OT_select_more(struct wmOperatorType *ot);
68 void GRAPH_OT_select_less(struct wmOperatorType *ot);
69 void GRAPH_OT_select_leftright(struct wmOperatorType *ot);
70 void GRAPH_OT_clickselect(struct wmOperatorType *ot);
71
72 /* defines for left-right select tool */
73 enum {
74         GRAPHKEYS_LRSEL_TEST    = 0,
75         GRAPHKEYS_LRSEL_LEFT,
76         GRAPHKEYS_LRSEL_RIGHT
77 } eGraphKeys_LeftRightSelect_Mode;
78
79 /* defines for column-select mode */
80 enum {
81         GRAPHKEYS_COLUMNSEL_KEYS        = 0,
82         GRAPHKEYS_COLUMNSEL_CFRA,
83         GRAPHKEYS_COLUMNSEL_MARKERS_COLUMN,
84         GRAPHKEYS_COLUMNSEL_MARKERS_BETWEEN,
85 } eGraphKeys_ColumnSelect_Mode;
86
87 /* ***************************************** */
88 /* graph_edit.c */
89
90 void get_graph_keyframe_extents (struct bAnimContext *ac, float *xmin, float *xmax, float *ymin, float *ymax);
91
92 void GRAPH_OT_previewrange_set(struct wmOperatorType *ot);
93 void GRAPH_OT_view_all(struct wmOperatorType *ot);
94
95 void GRAPH_OT_click_insert(struct wmOperatorType *ot);
96 void GRAPH_OT_keyframe_insert(struct wmOperatorType *ot);
97
98 void GRAPH_OT_copy(struct wmOperatorType *ot);
99 void GRAPH_OT_paste(struct wmOperatorType *ot);
100
101 void GRAPH_OT_duplicate(struct wmOperatorType *ot);
102 void GRAPH_OT_delete(struct wmOperatorType *ot);
103 void GRAPH_OT_clean(struct wmOperatorType *ot);
104 void GRAPH_OT_sample(struct wmOperatorType *ot);
105 void GRAPH_OT_bake(struct wmOperatorType *ot);
106 void GRAPH_OT_sound_bake(struct wmOperatorType *ot);
107 void GRAPH_OT_smooth(struct wmOperatorType *ot);
108
109 void GRAPH_OT_handle_type(struct wmOperatorType *ot);
110 void GRAPH_OT_interpolation_type(struct wmOperatorType *ot);
111 void GRAPH_OT_extrapolation_type(struct wmOperatorType *ot);
112
113 void GRAPH_OT_frame_jump(struct wmOperatorType *ot);
114 void GRAPH_OT_snap(struct wmOperatorType *ot);
115 void GRAPH_OT_mirror(struct wmOperatorType *ot);
116
117 /* defines for snap keyframes 
118  * NOTE: keep in sync with eEditKeyframes_Snap (in ED_keyframes_edit.h)
119  */
120 enum {
121         GRAPHKEYS_SNAP_CFRA = 1,
122         GRAPHKEYS_SNAP_NEAREST_FRAME,
123         GRAPHKEYS_SNAP_NEAREST_SECOND,
124         GRAPHKEYS_SNAP_NEAREST_MARKER,  
125         GRAPHKEYS_SNAP_HORIZONTAL,
126         GRAPHKEYS_SNAP_VALUE,
127 } eGraphKeys_Snap_Mode;
128
129 /* defines for mirror keyframes 
130  * NOTE: keep in sync with eEditKeyframes_Mirror (in ED_keyframes_edit.h)
131  */
132 enum {
133         GRAPHKEYS_MIRROR_CFRA = 1,
134         GRAPHKEYS_MIRROR_YAXIS,
135         GRAPHKEYS_MIRROR_XAXIS,
136         GRAPHKEYS_MIRROR_MARKER,
137         GRAPHKEYS_MIRROR_VALUE,
138 } eGraphKeys_Mirror_Mode;
139
140 /* ----------- */
141
142 void GRAPH_OT_fmodifier_add(struct wmOperatorType *ot);
143 void GRAPH_OT_fmodifier_copy(struct wmOperatorType *ot);
144 void GRAPH_OT_fmodifier_paste(struct wmOperatorType *ot);
145
146 /* ----------- */
147
148 void GRAPH_OT_ghost_curves_create(struct wmOperatorType *ot);
149 void GRAPH_OT_ghost_curves_clear(struct wmOperatorType *ot);
150
151 /* ***************************************** */
152 /* graph_buttons.c */
153
154 void GRAPH_OT_properties(struct wmOperatorType *ot);
155 void graph_buttons_register(struct ARegionType *art);
156
157 /* ***************************************** */
158 /* graph_utils.c */
159
160 struct bAnimListElem *get_active_fcurve_channel(struct bAnimContext *ac);
161
162 short fcurve_needs_draw_fmodifier_controls(struct FCurve *fcu, struct FModifier *fcm);
163
164 int graphop_visible_keyframes_poll(struct bContext *C);
165 int graphop_editable_keyframes_poll(struct bContext *C);
166 int graphop_active_fcurve_poll(struct bContext *C);
167 int graphop_selected_fcurve_poll(struct bContext *C);
168
169 /* ***************************************** */
170 /* graph_ops.c */
171 void graphedit_keymap(struct wmKeyConfig *keyconf);
172 void graphedit_operatortypes(void);
173
174
175 #endif /* ED_GRAPH_INTERN_H */
176