doxygen: add newline after \file
[blender.git] / source / blender / editors / mask / mask_intern.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) 2011 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spclip
22  */
23
24 #ifndef __MASK_INTERN_H__
25 #define __MASK_INTERN_H__
26
27 struct Mask;
28 struct bContext;
29 struct wmOperatorType;
30
31 /* internal exports only */
32
33 /* mask_add.c */
34 bool ED_mask_find_nearest_diff_point(const struct bContext *C,
35                                      struct Mask *mask,
36                                      const float normal_co[2],
37                                      int threshold, bool feather,
38                                      float tangent[2],
39                                      const bool use_deform,
40                                      const bool use_project,
41                                      struct MaskLayer **masklay_r,
42                                      struct MaskSpline **spline_r,
43                                      struct MaskSplinePoint **point_r,
44                                      float *u_r,
45                                      float *score_r);
46
47 void MASK_OT_add_vertex(struct wmOperatorType *ot);
48 void MASK_OT_add_feather_vertex(struct wmOperatorType *ot);
49 void MASK_OT_primitive_circle_add(struct wmOperatorType *ot);
50 void MASK_OT_primitive_square_add(struct wmOperatorType *ot);
51
52 /* mask_ops.c */
53 struct Mask *ED_mask_new(struct bContext *C, const char *name);
54 struct MaskLayer *ED_mask_layer_ensure(struct bContext *C, bool *r_added_mask);
55
56 void MASK_OT_new(struct wmOperatorType *ot);
57 void MASK_OT_layer_new(struct wmOperatorType *ot);
58 void MASK_OT_layer_remove(struct wmOperatorType *ot);
59 void MASK_OT_cyclic_toggle(struct wmOperatorType *ot);
60
61 void MASK_OT_slide_point(struct wmOperatorType *ot);
62 void MASK_OT_slide_spline_curvature(struct wmOperatorType *ot);
63
64 void MASK_OT_delete(struct wmOperatorType *ot);
65
66 void MASK_OT_hide_view_clear(struct wmOperatorType *ot);
67 void MASK_OT_hide_view_set(struct wmOperatorType *ot);
68 void MASK_OT_feather_weight_clear(struct wmOperatorType *ot);
69 void MASK_OT_switch_direction(struct wmOperatorType *ot);
70 void MASK_OT_normals_make_consistent(struct wmOperatorType *ot);
71
72 void MASK_OT_handle_type_set(struct wmOperatorType *ot);
73
74 bool ED_mask_feather_find_nearest(
75         const struct bContext *C, struct Mask *mask, const float normal_co[2], const float threshold,
76         struct MaskLayer **masklay_r, struct MaskSpline **spline_r, struct MaskSplinePoint **point_r,
77         struct MaskSplinePointUW **uw_r, float *score);
78
79 struct MaskSplinePoint *ED_mask_point_find_nearest(
80         const struct bContext *C, struct Mask *mask, const float normal_co[2], const float threshold,
81         struct MaskLayer **masklay_r, struct MaskSpline **spline_r, eMaskWhichHandle *which_handle_r,
82         float *score);
83
84 void MASK_OT_layer_move(struct wmOperatorType *ot);
85
86 void MASK_OT_duplicate(struct wmOperatorType *ot);
87 void MASK_OT_copy_splines(struct wmOperatorType *ot);
88 void MASK_OT_paste_splines(struct wmOperatorType *ot);
89
90 /* mask_relationships.c */
91 void MASK_OT_parent_set(struct wmOperatorType *ot);
92 void MASK_OT_parent_clear(struct wmOperatorType *ot);
93
94 /* mask_select.c */
95 void MASK_OT_select(struct wmOperatorType *ot);
96 void MASK_OT_select_all(struct wmOperatorType *ot);
97
98 void MASK_OT_select_box(struct wmOperatorType *ot);
99 void MASK_OT_select_lasso(struct wmOperatorType *ot);
100 void MASK_OT_select_circle(struct wmOperatorType *ot);
101 void MASK_OT_select_linked_pick(struct wmOperatorType *ot);
102 void MASK_OT_select_linked(struct wmOperatorType *ot);
103 void MASK_OT_select_more(struct wmOperatorType *ot);
104 void MASK_OT_select_less(struct wmOperatorType *ot);
105
106 bool ED_mask_spline_select_check(struct MaskSpline *spline);
107 bool ED_mask_layer_select_check(struct MaskLayer *masklay);
108 bool ED_mask_select_check(struct Mask *mask);
109
110 void ED_mask_spline_select_set(struct MaskSpline *spline, const bool do_select);
111 void ED_mask_layer_select_set(struct MaskLayer *masklay, const bool do_select);
112 void ED_mask_select_toggle_all(struct Mask *mask, int action);
113 void ED_mask_select_flush_all(struct Mask *mask);
114
115 /* mask_editor.c */
116 bool ED_maskedit_poll(struct bContext *C);
117 bool ED_maskedit_mask_poll(struct bContext *C);
118
119 /* mask_shapekey.c */
120 void MASK_OT_shape_key_insert(struct wmOperatorType *ot);
121 void MASK_OT_shape_key_clear(struct wmOperatorType *ot);
122 void MASK_OT_shape_key_feather_reset(struct wmOperatorType *ot);
123 void MASK_OT_shape_key_rekey(struct wmOperatorType *ot);
124
125 #endif /* __MASK_INTERN_H__ */