Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / include / ED_mask.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) 2012 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup editors
21  */
22
23 #ifndef __ED_MASK_H__
24 #define __ED_MASK_H__
25
26 struct KeyframeEditData;
27 struct MaskLayer;
28 struct MaskLayerShape;
29 struct bContext;
30 struct wmKeyConfig;
31
32 /* mask_edit.c */
33 void ED_mask_get_size(struct ScrArea *sa, int *width, int *height);
34 void ED_mask_zoom(struct ScrArea *sa, struct ARegion *ar, float *zoomx, float *zoomy);
35 void ED_mask_get_aspect(struct ScrArea *sa, struct ARegion *ar, float *aspx, float *aspy);
36
37 void ED_mask_pixelspace_factor(struct ScrArea *sa, struct ARegion *ar, float *scalex, float *scaley);
38 void ED_mask_mouse_pos(struct ScrArea *sa, struct ARegion *ar, const int mval[2], float co[2]);
39
40 void ED_mask_point_pos(struct ScrArea *sa, struct ARegion *ar, float x, float y, float *xr, float *yr);
41 void ED_mask_point_pos__reverse(struct ScrArea *sa, struct ARegion *ar,
42                                 float x, float y, float *xr, float *yr);
43
44 void ED_mask_cursor_location_get(struct ScrArea *sa, float cursor[2]);
45 bool ED_mask_selected_minmax(const struct bContext *C, float min[2], float max[2]);
46
47 void ED_operatortypes_mask(void);
48 void ED_keymap_mask(struct wmKeyConfig *keyconf);
49 void ED_operatormacros_mask(void);
50
51 /* mask_draw.c */
52 void ED_mask_draw(const struct bContext *C, const char draw_flag, const char draw_type);
53 void ED_mask_draw_region(struct Mask *mask, struct ARegion *ar,
54                          const char draw_flag, const char draw_type, const char overlay_mode,
55                          const int width_i, const int height_i,
56                          const float aspx, const float aspy,
57                          const bool do_scale_applied, const bool do_draw_cb,
58                          float stabmat[4][4],
59                          const struct bContext *C);
60
61 void ED_mask_draw_frames(struct Mask *mask, struct ARegion *ar, const int cfra, const int sfra, const int efra);
62
63 /* mask_shapekey.c */
64 void ED_mask_layer_shape_auto_key(struct MaskLayer *masklay, const int frame);
65 bool ED_mask_layer_shape_auto_key_all(struct Mask *mask, const int frame);
66 bool ED_mask_layer_shape_auto_key_select(struct Mask *mask, const int frame);
67
68 /* ----------- Mask AnimEdit API ------------------ */
69 bool ED_masklayer_frames_looper(struct MaskLayer *masklay, struct Scene *scene,
70                                 short (*masklay_shape_cb)(struct MaskLayerShape *, struct Scene *));
71 void ED_masklayer_make_cfra_list(struct MaskLayer *masklay, ListBase *elems, bool onlysel);
72
73 bool  ED_masklayer_frame_select_check(struct MaskLayer *masklay);
74 void  ED_masklayer_frame_select_set(struct MaskLayer *masklay, short mode);
75 void  ED_masklayer_frames_select_box(struct MaskLayer *masklay, float min, float max, short select_mode);
76 void  ED_masklayer_frames_select_region(struct KeyframeEditData *ked, struct MaskLayer *masklay, short tool, short select_mode);
77 void  ED_mask_select_frames(struct MaskLayer *masklay, short select_mode);
78 void  ED_mask_select_frame(struct MaskLayer *masklay, int selx, short select_mode);
79
80 bool ED_masklayer_frames_delete(struct MaskLayer *masklay);
81 void ED_masklayer_frames_duplicate(struct MaskLayer *masklay);
82
83 void ED_masklayer_snap_frames(struct MaskLayer *masklay, struct Scene *scene, short mode);
84
85 #if 0
86 void free_gpcopybuf(void);
87 void copy_gpdata(void);
88 void paste_gpdata(void);
89
90 void mirror_masklayer_frames(struct MaskLayer *masklay, short mode);
91 #endif
92
93 #endif /* __ED_MASK_H__ */