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