doxygen: add newline after \file
[blender.git] / source / blender / editors / mesh / mesh_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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edmesh
22  */
23
24 /* Internal for editmesh_xxxx.c functions */
25
26 #ifndef __MESH_INTERN_H__
27 #define __MESH_INTERN_H__
28
29 struct BMEditMesh;
30 struct BMElem;
31 struct BMOperator;
32 struct EnumPropertyItem;
33 struct LinkNode;
34 struct bContext;
35 struct wmKeyConfig;
36 struct wmKeyMap;
37 struct wmOperator;
38 struct wmOperatorType;
39
40 /* *** editmesh_utils.c *** */
41
42 /*
43  * ok: the EDBM module is for editmode bmesh stuff.  in contrast, the
44  * BMEdit module is for code shared with blenkernel that concerns
45  * the BMEditMesh structure. */
46
47 /* Calls a bmesh op, reporting errors to the user, etc */
48 bool EDBM_op_callf(struct BMEditMesh *em, struct wmOperator *op, const char *fmt, ...);
49 bool EDBM_op_call_and_selectf(struct BMEditMesh *em, struct wmOperator *op,
50                               const char *select_slot, const bool select_replace,
51                               const char *fmt, ...);
52 /* Same as above, but doesn't report errors.*/
53 bool EDBM_op_call_silentf(struct BMEditMesh *em, const char *fmt, ...);
54
55 /* these next two functions are the split version of EDBM_op_callf, so you can
56  * do stuff with a bmesh operator, after initializing it but before executing
57  * it.
58  *
59  * execute the operator with BM_Exec_Op */
60 bool EDBM_op_init(struct BMEditMesh *em, struct BMOperator *bmop,
61                   struct wmOperator *op, const char *fmt, ...);
62 /* Cleans up after a bmesh operator */
63 bool EDBM_op_finish(struct BMEditMesh *em, struct BMOperator *bmop,
64                     struct wmOperator *op, const bool do_report);
65
66 void EDBM_stats_update(struct BMEditMesh *em);
67
68 bool EDBM_view3d_poll(struct bContext *C);
69
70 struct BMElem *EDBM_elem_from_selectmode(
71         struct BMEditMesh *em,
72         struct BMVert *eve, struct BMEdge *eed, struct BMFace *efa);
73 int            EDBM_elem_to_index_any(struct BMEditMesh *em, struct BMElem *ele);
74 struct BMElem *EDBM_elem_from_index_any(struct BMEditMesh *em, int index);
75
76 /* *** editmesh_add.c *** */
77 void MESH_OT_primitive_plane_add(struct wmOperatorType *ot);
78 void MESH_OT_primitive_cube_add(struct wmOperatorType *ot);
79 void MESH_OT_primitive_circle_add(struct wmOperatorType *ot);
80 void MESH_OT_primitive_cylinder_add(struct wmOperatorType *ot);
81 void MESH_OT_primitive_cone_add(struct wmOperatorType *ot);
82 void MESH_OT_primitive_grid_add(struct wmOperatorType *ot);
83 void MESH_OT_primitive_monkey_add(struct wmOperatorType *ot);
84 void MESH_OT_primitive_uv_sphere_add(struct wmOperatorType *ot);
85 void MESH_OT_primitive_ico_sphere_add(struct wmOperatorType *ot);
86
87 /* *** editmesh_add_gizmo.c *** */
88 void MESH_OT_primitive_cube_add_gizmo(struct wmOperatorType *ot);
89
90 /* *** editmesh_bevel.c *** */
91 void MESH_OT_bevel(struct wmOperatorType *ot);
92 struct wmKeyMap *bevel_modal_keymap(struct wmKeyConfig *keyconf);
93
94 /* *** editmesh_bisect.c *** */
95 void MESH_OT_bisect(struct wmOperatorType *ot);
96
97 /* *** editmesh_extrude.c *** */
98 void MESH_OT_extrude_repeat(struct wmOperatorType *ot);
99 void MESH_OT_extrude_region(struct wmOperatorType *ot);
100 void MESH_OT_extrude_context(struct wmOperatorType *ot);
101 void MESH_OT_extrude_verts_indiv(struct wmOperatorType *ot);
102 void MESH_OT_extrude_edges_indiv(struct wmOperatorType *ot);
103 void MESH_OT_extrude_faces_indiv(struct wmOperatorType *ot);
104 void MESH_OT_dupli_extrude_cursor(struct wmOperatorType *ot);
105
106 /* *** editmesh_extrude_screw.c *** */
107 void MESH_OT_screw(struct wmOperatorType *ot);
108
109 /* *** editmesh_extrude_spin.c *** */
110 void MESH_OT_spin(struct wmOperatorType *ot);
111 /* *** editmesh_extrude_spin_gizmo.c *** */
112 void MESH_GGT_spin(struct wmGizmoGroupType *gzgt);
113 void MESH_GGT_spin_redo(struct wmGizmoGroupType *gzgt);
114
115 /* *** editmesh_polybuild.c *** */
116 void MESH_OT_polybuild_face_at_cursor(struct wmOperatorType *ot);
117 void MESH_OT_polybuild_split_at_cursor(struct wmOperatorType *ot);
118 void MESH_OT_polybuild_dissolve_at_cursor(struct wmOperatorType *ot);
119
120 /* *** editmesh_inset.c *** */
121 void MESH_OT_inset(struct wmOperatorType *ot);
122
123 /* *** editmesh_intersect.c *** */
124 void MESH_OT_intersect(struct wmOperatorType *ot);
125 void MESH_OT_intersect_boolean(struct wmOperatorType *ot);
126 void MESH_OT_face_split_by_edges(struct wmOperatorType *ot);
127
128
129 /* *** editmesh_knife.c *** */
130 void MESH_OT_knife_tool(struct wmOperatorType *ot);
131 void MESH_OT_knife_project(struct wmOperatorType *ot);
132 void EDBM_mesh_knife(struct bContext *C, struct LinkNode *polys,
133                      bool use_tag, bool cut_through);
134
135 struct wmKeyMap *knifetool_modal_keymap(struct wmKeyConfig *keyconf);
136
137
138 /* *** editmesh_loopcut.c *** */
139 void MESH_OT_loopcut(struct wmOperatorType *ot);
140
141
142 /* *** editmesh_rip.c *** */
143 void MESH_OT_rip(struct wmOperatorType *ot);
144 void MESH_OT_rip_edge(struct wmOperatorType *ot);
145
146
147 /* *** editmesh_select.c *** */
148 void MESH_OT_select_similar(struct wmOperatorType *ot);
149 void MESH_OT_select_similar_region(struct wmOperatorType *ot);
150 void MESH_OT_select_mode(struct wmOperatorType *ot);
151 void MESH_OT_loop_multi_select(struct wmOperatorType *ot);
152 void MESH_OT_loop_select(struct wmOperatorType *ot);
153 void MESH_OT_edgering_select(struct wmOperatorType *ot);
154 void MESH_OT_select_all(struct wmOperatorType *ot);
155 void MESH_OT_select_interior_faces(struct wmOperatorType *ot);
156 void MESH_OT_shortest_path_pick(struct wmOperatorType *ot);
157 void MESH_OT_select_linked(struct wmOperatorType *ot);
158 void MESH_OT_select_linked_pick(struct wmOperatorType *ot);
159 void MESH_OT_select_face_by_sides(struct wmOperatorType *ot);
160 void MESH_OT_select_loose(struct wmOperatorType *ot);
161 void MESH_OT_select_mirror(struct wmOperatorType *ot);
162 void MESH_OT_select_more(struct wmOperatorType *ot);
163 void MESH_OT_select_less(struct wmOperatorType *ot);
164 void MESH_OT_select_nth(struct wmOperatorType *ot);
165 void MESH_OT_edges_select_sharp(struct wmOperatorType *ot);
166 void MESH_OT_faces_select_linked_flat(struct wmOperatorType *ot);
167 void MESH_OT_select_non_manifold(struct wmOperatorType *ot);
168 void MESH_OT_select_random(struct wmOperatorType *ot);
169 void MESH_OT_select_ungrouped(struct wmOperatorType *ot);
170 void MESH_OT_select_axis(struct wmOperatorType *ot);
171 void MESH_OT_region_to_loop(struct wmOperatorType *ot);
172 void MESH_OT_loop_to_region(struct wmOperatorType *ot);
173 void MESH_OT_shortest_path_select(struct wmOperatorType *ot);
174
175 extern struct EnumPropertyItem *corner_type_items;
176
177
178 /* *** editmesh_tools.c *** */
179 void MESH_OT_subdivide(struct wmOperatorType *ot);
180 void MESH_OT_subdivide_edgering(struct wmOperatorType *ot);
181 void MESH_OT_unsubdivide(struct wmOperatorType *ot);
182 void MESH_OT_normals_make_consistent(struct wmOperatorType *ot);
183 void MESH_OT_vertices_smooth(struct wmOperatorType *ot);
184 void MESH_OT_vertices_smooth_laplacian(struct wmOperatorType *ot);
185 void MESH_OT_vert_connect(struct wmOperatorType *ot);
186 void MESH_OT_vert_connect_path(struct wmOperatorType *ot);
187 void MESH_OT_vert_connect_concave(struct wmOperatorType *ot);
188 void MESH_OT_vert_connect_nonplanar(struct wmOperatorType *ot);
189 void MESH_OT_face_make_planar(struct wmOperatorType *ot);
190 void MESH_OT_edge_split(struct wmOperatorType *ot);
191 void MESH_OT_bridge_edge_loops(struct wmOperatorType *ot);
192 void MESH_OT_offset_edge_loops(struct wmOperatorType *ot);
193 void MESH_OT_wireframe(struct wmOperatorType *ot);
194 void MESH_OT_convex_hull(struct wmOperatorType *ot);
195 void MESH_OT_symmetrize(struct wmOperatorType *ot);
196 void MESH_OT_symmetry_snap(struct wmOperatorType *ot);
197 void MESH_OT_shape_propagate_to_all(struct wmOperatorType *ot);
198 void MESH_OT_blend_from_shape(struct wmOperatorType *ot);
199 void MESH_OT_sort_elements(struct wmOperatorType *ot);
200 void MESH_OT_uvs_rotate(struct wmOperatorType *ot);
201 void MESH_OT_uvs_reverse(struct wmOperatorType *ot);
202 void MESH_OT_colors_rotate(struct wmOperatorType *ot);
203 void MESH_OT_colors_reverse(struct wmOperatorType *ot);
204 void MESH_OT_delete(struct wmOperatorType *ot);
205 void MESH_OT_delete_loose(struct wmOperatorType *ot);
206 void MESH_OT_edge_collapse(struct wmOperatorType *ot);
207 void MESH_OT_faces_shade_smooth(struct wmOperatorType *ot);
208 void MESH_OT_faces_shade_flat(struct wmOperatorType *ot);
209 void MESH_OT_split(struct wmOperatorType *ot);
210 void MESH_OT_edge_rotate(struct wmOperatorType *ot);
211 void MESH_OT_hide(struct wmOperatorType *ot);
212 void MESH_OT_reveal(struct wmOperatorType *ot);
213 void MESH_OT_mark_seam(struct wmOperatorType *ot);
214 void MESH_OT_mark_sharp(struct wmOperatorType *ot);
215 void MESH_OT_flip_normals(struct wmOperatorType *ot);
216 void MESH_OT_solidify(struct wmOperatorType *ot);
217 void MESH_OT_knife_cut(struct wmOperatorType *ot);
218 void MESH_OT_separate(struct wmOperatorType *ot);
219 void MESH_OT_fill(struct wmOperatorType *ot);
220 void MESH_OT_fill_grid(struct wmOperatorType *ot);
221 void MESH_OT_fill_holes(struct wmOperatorType *ot);
222 void MESH_OT_beautify_fill(struct wmOperatorType *ot);
223 void MESH_OT_quads_convert_to_tris(struct wmOperatorType *ot);
224 void MESH_OT_tris_convert_to_quads(struct wmOperatorType *ot);
225 void MESH_OT_decimate(struct wmOperatorType *ot);
226 void MESH_OT_dissolve_verts(struct wmOperatorType *ot);
227 void MESH_OT_dissolve_edges(struct wmOperatorType *ot);
228 void MESH_OT_dissolve_faces(struct wmOperatorType *ot);
229 void MESH_OT_dissolve_mode(struct wmOperatorType *ot);
230 void MESH_OT_dissolve_limited(struct wmOperatorType *ot);
231 void MESH_OT_dissolve_degenerate(struct wmOperatorType *ot);
232 void MESH_OT_delete_edgeloop(struct wmOperatorType *ot);
233 void MESH_OT_edge_face_add(struct wmOperatorType *ot);
234 void MESH_OT_duplicate(struct wmOperatorType *ot);
235 void MESH_OT_merge(struct wmOperatorType *ot);
236 void MESH_OT_remove_doubles(struct wmOperatorType *ot);
237 void MESH_OT_poke(struct wmOperatorType *ot);
238 void MESH_OT_point_normals(struct wmOperatorType *ot);
239 void MESH_OT_merge_normals(struct wmOperatorType *ot);
240 void MESH_OT_split_normals(struct wmOperatorType *ot);
241 void MESH_OT_normals_tools(struct wmOperatorType *ot);
242 void MESH_OT_set_normals_from_faces(struct wmOperatorType *ot);
243 void MESH_OT_average_normals(struct wmOperatorType *ot);
244 void MESH_OT_smoothen_normals(struct wmOperatorType *ot);
245 void MESH_OT_mod_weighted_strength(struct wmOperatorType *ot);
246
247 struct wmKeyMap *point_normals_modal_keymap(wmKeyConfig *keyconf);
248
249 #ifdef WITH_FREESTYLE
250 void MESH_OT_mark_freestyle_edge(struct wmOperatorType *ot);
251 void MESH_OT_mark_freestyle_face(struct wmOperatorType *ot);
252 #endif
253
254 /* *** mesh_data.c *** */
255 void MESH_OT_uv_texture_add(struct wmOperatorType *ot);
256 void MESH_OT_uv_texture_remove(struct wmOperatorType *ot);
257 void MESH_OT_vertex_color_add(struct wmOperatorType *ot);
258 void MESH_OT_vertex_color_remove(struct wmOperatorType *ot);
259 /* no create_mask yet */
260 void MESH_OT_customdata_mask_clear(struct wmOperatorType *ot);
261 void MESH_OT_customdata_skin_add(struct wmOperatorType *ot);
262 void MESH_OT_customdata_skin_clear(struct wmOperatorType *ot);
263 void MESH_OT_customdata_custom_splitnormals_add(struct wmOperatorType *ot);
264 void MESH_OT_customdata_custom_splitnormals_clear(struct wmOperatorType *ot);
265
266
267 #endif  /* __MESH_INTERN_H__ */