doxygen: add newline after \file
[blender.git] / source / blender / editors / include / ED_clip.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup editors
22  */
23
24 #ifndef __ED_CLIP_H__
25 #define __ED_CLIP_H__
26
27 struct ARegion;
28 struct ImBuf;
29 struct Main;
30 struct Mask;
31 struct MovieClip;
32 struct Scene;
33 struct SpaceClip;
34 struct bContext;
35 struct bScreen;
36
37 /*  ** clip_editor.c ** */
38
39 /* common poll functions */
40 bool ED_space_clip_poll(struct bContext *C);
41
42 bool ED_space_clip_view_clip_poll(struct bContext *C);
43
44 bool ED_space_clip_tracking_poll(struct bContext *C);
45 bool ED_space_clip_maskedit_poll(struct bContext *C);
46 bool ED_space_clip_maskedit_mask_poll(struct bContext *C);
47
48 void ED_space_clip_get_size(struct SpaceClip *sc, int *width, int *height);
49 void ED_space_clip_get_size_fl(struct SpaceClip *sc, float size[2]);
50 void ED_space_clip_get_zoom(struct SpaceClip *sc, struct ARegion *ar, float *zoomx, float *zoomy);
51 void ED_space_clip_get_aspect(struct SpaceClip *sc, float *aspx, float *aspy);
52 void ED_space_clip_get_aspect_dimension_aware(struct SpaceClip *sc, float *aspx, float *aspy);
53
54 int ED_space_clip_get_clip_frame_number(struct SpaceClip *sc);
55
56 struct ImBuf *ED_space_clip_get_buffer(struct SpaceClip *sc);
57 struct ImBuf *ED_space_clip_get_stable_buffer(struct SpaceClip *sc, float loc[2], float *scale, float *angle);
58
59 bool ED_space_clip_color_sample(struct SpaceClip *sc, struct ARegion *ar, int mval[2], float r_col[3]);
60
61 void ED_clip_update_frame(const struct Main *mainp, int cfra);
62 bool ED_clip_view_selection(const struct bContext *C, struct ARegion *ar, bool fit);
63
64 void ED_clip_point_undistorted_pos(struct SpaceClip *sc, const float co[2], float r_co[2]);
65 void ED_clip_point_stable_pos(struct SpaceClip *sc, struct ARegion *ar, float x, float y, float *xr, float *yr);
66 void ED_clip_point_stable_pos__reverse(struct SpaceClip *sc, struct ARegion *ar, const float co[2], float r_co[2]);
67 void ED_clip_mouse_pos(struct SpaceClip *sc, struct ARegion *ar, const int mval[2], float co[2]);
68
69 bool ED_space_clip_check_show_trackedit(struct SpaceClip *sc);
70 bool ED_space_clip_check_show_maskedit(struct SpaceClip *sc);
71
72 struct MovieClip *ED_space_clip_get_clip(struct SpaceClip *sc);
73 void ED_space_clip_set_clip(struct bContext *C, struct bScreen *screen, struct SpaceClip *sc, struct MovieClip *clip);
74
75 struct Mask *ED_space_clip_get_mask(struct SpaceClip *sc);
76 void ED_space_clip_set_mask(struct bContext *C, struct SpaceClip *sc, struct Mask *mask);
77
78 /* ** clip_ops.c ** */
79 void ED_operatormacros_clip(void);
80
81 #endif /* __ED_CLIP_H__ */