Cleanup: pass selectmode directly
[blender.git] / source / blender / editors / include / ED_mesh.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ED_mesh.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_MESH_H__
32 #define __ED_MESH_H__
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 struct ID;
39 struct View3D;
40 struct ARegion;
41 struct bContext;
42 struct wmOperator;
43 struct wmKeyConfig;
44 struct ReportList;
45 struct ViewContext;
46 struct bDeformGroup;
47 struct MDeformVert;
48 struct Scene;
49 struct Mesh;
50 struct MTexPoly;
51 struct UvVertMap;
52 struct UvMapVert;
53 struct BMEditMesh;
54 struct BMesh;
55 struct BMVert;
56 struct BMLoop;
57 struct BMBVHTree;
58 struct BMEdge;
59 struct BMFace;
60 struct UvVertMap;
61 struct UvMapVert;
62 struct ToolSettings;
63 struct Object;
64 struct rcti;
65
66 /* editmesh_utils.c */
67 void           EDBM_verts_mirror_cache_begin_ex(struct BMEditMesh *em, const int axis,
68                                                 const bool use_self, const bool use_select,
69                                                 const bool use_topology, float maxdist, int *r_index);
70 void           EDBM_verts_mirror_cache_begin(struct BMEditMesh *em, const int axis,
71                                              const bool use_self, const bool use_select, const bool use_toplogy);
72 void           EDBM_verts_mirror_apply(struct BMEditMesh *em, const int sel_from, const int sel_to);
73 struct BMVert *EDBM_verts_mirror_get(struct BMEditMesh *em, struct BMVert *v);
74 struct BMEdge *EDBM_verts_mirror_get_edge(struct BMEditMesh *em, struct BMEdge *e);
75 struct BMFace *EDBM_verts_mirror_get_face(struct BMEditMesh *em, struct BMFace *f);
76 void           EDBM_verts_mirror_cache_clear(struct BMEditMesh *em, struct BMVert *v);
77 void           EDBM_verts_mirror_cache_end(struct BMEditMesh *em);
78
79 void EDBM_mesh_normals_update(struct BMEditMesh *em);
80 void EDBM_mesh_clear(struct BMEditMesh *em);
81
82 void EDBM_selectmode_to_scene(struct bContext *C);
83 void EDBM_mesh_make(struct Object *ob, const int select_mode, const bool add_key_index);
84 void EDBM_mesh_free(struct BMEditMesh *em);
85 void EDBM_mesh_load(struct Object *ob);
86 struct DerivedMesh *EDBM_mesh_deform_dm_get(struct BMEditMesh *em);
87
88 /* flushes based on the current select mode.  if in vertex select mode,
89  * verts select/deselect edges and faces, if in edge select mode,
90  * edges select/deselect faces and vertices, and in face select mode faces select/deselect
91  * edges and vertices.*/
92 void EDBM_select_more(struct BMEditMesh *em, const bool use_face_step);
93 void EDBM_select_less(struct BMEditMesh *em, const bool use_face_step);
94
95 void EDBM_selectmode_flush_ex(struct BMEditMesh *em, const short selectmode);
96 void EDBM_selectmode_flush(struct BMEditMesh *em);
97
98 void EDBM_deselect_flush(struct BMEditMesh *em);
99 void EDBM_select_flush(struct BMEditMesh *em);
100
101 void undo_push_mesh(struct bContext *C, const char *name);
102
103 bool EDBM_vert_color_check(struct BMEditMesh *em);
104
105 void EDBM_mesh_hide(struct BMEditMesh *em, bool swap);
106 void EDBM_mesh_reveal(struct BMEditMesh *em, bool select);
107
108 void EDBM_update_generic(struct BMEditMesh *em, const bool do_tessface, const bool is_destructive);
109
110 struct UvElementMap *BM_uv_element_map_create(
111         struct BMesh *bm,
112         const bool selected, const bool use_winding, const bool do_islands);
113 void                 BM_uv_element_map_free(struct UvElementMap *vmap);
114 struct UvElement    *BM_uv_element_get(struct UvElementMap *map, struct BMFace *efa, struct BMLoop *l);
115
116 bool           EDBM_uv_check(struct BMEditMesh *em);
117 struct BMFace *EDBM_uv_active_face_get(
118         struct BMEditMesh *em, const bool sloppy, const bool selected,
119         struct MTexPoly **r_tf);
120
121 void              BM_uv_vert_map_free(struct UvVertMap *vmap);
122 struct UvMapVert *BM_uv_vert_map_at_index(struct UvVertMap *vmap, unsigned int v);
123 struct UvVertMap *BM_uv_vert_map_create(
124         struct BMesh *bm,
125         const float limit[2], const bool use_select, const bool use_winding);
126
127 void EDBM_flag_enable_all(struct BMEditMesh *em, const char hflag);
128 void EDBM_flag_disable_all(struct BMEditMesh *em, const char hflag);
129
130 bool BMBVH_EdgeVisible(struct BMBVHTree *tree, struct BMEdge *e,
131                        struct ARegion *ar, struct View3D *v3d, struct Object *obedit);
132
133 /* editmesh_select.c */
134 void EDBM_select_mirrored(
135         struct BMEditMesh *em, const int axis, const bool extend,
136         int *r_totmirr, int *r_totfail);
137 void EDBM_automerge(struct Scene *scene, struct Object *ob, bool update, const char hflag);
138
139 bool EDBM_backbuf_border_init(struct ViewContext *vc, short xmin, short ymin, short xmax, short ymax);
140 bool EDBM_backbuf_check(unsigned int index);
141 void EDBM_backbuf_free(void);
142
143 bool EDBM_backbuf_border_mask_init(
144         struct ViewContext *vc, const int mcords[][2], short tot,
145         short xmin, short ymin, short xmax, short ymax);
146 bool EDBM_backbuf_circle_init(struct ViewContext *vc, short xs, short ys, short rads);
147
148 struct BMVert *EDBM_vert_find_nearest_ex(
149         struct ViewContext *vc, float *r_dist,
150         const bool use_select_bias, bool use_cycle);
151 struct BMVert *EDBM_vert_find_nearest(
152         struct ViewContext *vc, float *r_dist);
153
154 struct BMEdge *EDBM_edge_find_nearest_ex(
155         struct ViewContext *vc, float *r_dist,
156         float *r_dist_center,
157         const bool use_select_bias, const bool use_cycle,
158         struct BMEdge **r_eed_zbuf);
159 struct BMEdge *EDBM_edge_find_nearest(
160         struct ViewContext *vc, float *r_dist);
161
162 struct BMFace *EDBM_face_find_nearest_ex(
163         struct ViewContext *vc, float *r_dist,
164         float *r_dist_center,
165         const bool use_select_bias, const bool use_cycle,
166         struct BMFace **r_efa_zbuf);
167 struct BMFace *EDBM_face_find_nearest(
168         struct ViewContext *vc, float *r_dist);
169
170 bool EDBM_select_pick(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
171
172 void EDBM_selectmode_set(struct BMEditMesh *em);
173 void EDBM_selectmode_convert(struct BMEditMesh *em, const short selectmode_old, const short selectmode_new);
174
175 /* user access this */
176 bool EDBM_selectmode_toggle(struct bContext *C, const short selectmode_new,
177                             const int action, const bool use_extend, const bool use_expand);
178
179 bool EDBM_selectmode_disable(struct Scene *scene, struct BMEditMesh *em,
180                              const short selectmode_disable,
181                              const short selectmode_fallback);
182
183 void EDBM_deselect_by_material(struct BMEditMesh *em, const short index, const bool select);
184
185 void EDBM_select_toggle_all(struct BMEditMesh *em);
186
187 void EDBM_select_swap(struct BMEditMesh *em); /* exported for UV */
188 bool EDBM_select_interior_faces(struct BMEditMesh *em);
189 void em_setup_viewcontext(struct bContext *C, struct ViewContext *vc);  /* rename? */
190
191 extern unsigned int bm_vertoffs, bm_solidoffs, bm_wireoffs;
192
193 /* mesh_ops.c */
194 void        ED_operatortypes_mesh(void);
195 void        ED_operatormacros_mesh(void);
196 void        ED_keymap_mesh(struct wmKeyConfig *keyconf);
197
198 /* editmesh_tools.c (could be moved) */
199 void EMBM_project_snap_verts(struct bContext *C, struct ARegion *ar, struct BMEditMesh *em);
200
201
202 /* editface.c */
203 void paintface_flush_flags(struct Object *ob, short flag);
204 bool paintface_mouse_select(struct bContext *C, struct Object *ob, const int mval[2], bool extend, bool deselect, bool toggle);
205 int  do_paintface_box_select(struct ViewContext *vc, struct rcti *rect, bool select, bool extend);
206 void paintface_deselect_all_visible(struct Object *ob, int action, bool flush_flags);
207 void paintface_select_linked(struct bContext *C, struct Object *ob, const int mval[2], const bool select);
208 bool paintface_minmax(struct Object *ob, float r_min[3], float r_max[3]);
209
210 void paintface_hide(struct Object *ob, const bool unselected);
211 void paintface_reveal(struct Object *ob, const bool select);
212
213 void paintvert_deselect_all_visible(struct Object *ob, int action, bool flush_flags);
214 void paintvert_select_ungrouped(struct Object *ob, bool extend, bool flush_flags);
215 void paintvert_flush_flags(struct Object *ob);
216
217 /* mirrtopo */
218 typedef struct MirrTopoStore_t {
219         intptr_t *index_lookup;
220         int prev_vert_tot;
221         int prev_edge_tot;
222         int prev_ob_mode;
223 } MirrTopoStore_t;
224
225 bool ED_mesh_mirrtopo_recalc_check(
226         struct Mesh *me, struct DerivedMesh *dm, const int ob_mode, MirrTopoStore_t *mesh_topo_store);
227 void ED_mesh_mirrtopo_init(
228         struct Mesh *me, struct DerivedMesh *dm, const int ob_mode, MirrTopoStore_t *mesh_topo_store,
229         const bool skip_em_vert_array_init);
230 void ED_mesh_mirrtopo_free(MirrTopoStore_t *mesh_topo_store);
231
232
233 /* object_vgroup.c */
234 #define WEIGHT_REPLACE 1
235 #define WEIGHT_ADD 2
236 #define WEIGHT_SUBTRACT 3
237
238 bool                 ED_vgroup_sync_from_pose(struct Object *ob);
239 void                 ED_vgroup_select_by_name(struct Object *ob, const char *name);
240 void                 ED_vgroup_data_clamp_range(struct ID *id, const int total);
241 bool                 ED_vgroup_array_copy(struct Object *ob, struct Object *ob_from);
242 bool                 ED_vgroup_parray_alloc(struct ID *id, struct MDeformVert ***dvert_arr, int *dvert_tot,
243                                             const bool use_vert_sel);
244 void                 ED_vgroup_parray_mirror_sync(struct Object *ob,
245                                                   struct MDeformVert **dvert_array, const int dvert_tot,
246                                                   const bool *vgroup_validmap, const int vgroup_tot);
247 void                 ED_vgroup_parray_mirror_assign(struct Object *ob,
248                                                     struct MDeformVert **dvert_array, const int dvert_tot);
249 void                 ED_vgroup_parray_remove_zero(struct MDeformVert **dvert_array, const int dvert_tot,
250                                                   const bool *vgroup_validmap, const int vgroup_tot,
251                                                   const float epsilon, const bool keep_single);
252 void                 ED_vgroup_parray_to_weight_array(const struct MDeformVert **dvert_array, const int dvert_tot,
253                                                       float *dvert_weights, const int def_nr);
254 void                 ED_vgroup_parray_from_weight_array(struct MDeformVert **dvert_array, const int dvert_tot,
255                                                         const float *dvert_weights, const int def_nr,
256                                                         const bool remove_zero);
257 void                 ED_vgroup_mirror(struct Object *ob,
258                                       const bool mirror_weights, const bool flip_vgroups,
259                                       const bool all_vgroups, const bool use_topology,
260                                       int *r_totmirr, int *r_totfail);
261
262 void                 ED_vgroup_vert_add(struct Object *ob, struct bDeformGroup *dg, int vertnum,  float weight, int assignmode);
263 void                 ED_vgroup_vert_remove(struct Object *ob, struct bDeformGroup *dg, int vertnum);
264 float                ED_vgroup_vert_weight(struct Object *ob, struct bDeformGroup *dg, int vertnum);
265 void                 ED_vgroup_vert_active_mirror(struct Object *ob, int def_nr);
266
267
268 /* mesh_data.c */
269 // void ED_mesh_geometry_add(struct Mesh *mesh, struct ReportList *reports, int verts, int edges, int faces);
270 void ED_mesh_polys_add(struct Mesh *mesh, struct ReportList *reports, int count);
271 void ED_mesh_tessfaces_add(struct Mesh *mesh, struct ReportList *reports, int count);
272 void ED_mesh_edges_add(struct Mesh *mesh, struct ReportList *reports, int count);
273 void ED_mesh_loops_add(struct Mesh *mesh, struct ReportList *reports, int count);
274 void ED_mesh_vertices_add(struct Mesh *mesh, struct ReportList *reports, int count);
275
276 void ED_mesh_faces_remove(struct Mesh *mesh, struct ReportList *reports, int count);
277 void ED_mesh_edges_remove(struct Mesh *mesh, struct ReportList *reports, int count);
278 void ED_mesh_vertices_remove(struct Mesh *mesh, struct ReportList *reports, int count);
279
280 void ED_mesh_calc_tessface(struct Mesh *mesh, bool free_mpoly);
281 void ED_mesh_update(struct Mesh *mesh, struct bContext *C, int calc_edges, int calc_tessface);
282
283 void ED_mesh_uv_texture_ensure(struct Mesh *me, const char *name);
284 int  ED_mesh_uv_texture_add(struct Mesh *me, const char *name, const bool active_set);
285 bool ED_mesh_uv_texture_remove_index(struct Mesh *me, const int n);
286 bool ED_mesh_uv_texture_remove_active(struct Mesh *me);
287 bool ED_mesh_uv_texture_remove_named(struct Mesh *me, const char *name);
288 void ED_mesh_uv_loop_reset(struct bContext *C, struct Mesh *me);
289 void ED_mesh_uv_loop_reset_ex(struct Mesh *me, const int layernum);
290 bool ED_mesh_color_ensure(struct Mesh *me, const char *name);
291 int  ED_mesh_color_add(struct Mesh *me, const char *name, const bool active_set);
292 bool ED_mesh_color_remove_index(struct Mesh *me, const int n);
293 bool ED_mesh_color_remove_active(struct Mesh *me);
294 bool ED_mesh_color_remove_named(struct Mesh *me, const char *name);
295
296 void ED_mesh_report_mirror(struct wmOperator *op, int totmirr, int totfail);
297 void ED_mesh_report_mirror_ex(struct wmOperator *op, int totmirr, int totfail,
298                               char selectmode);
299
300 /* mesh backup */
301 typedef struct BMBackup {
302         struct BMesh *bmcopy;
303 } BMBackup;
304
305 /* save a copy of the bmesh for restoring later */
306 struct BMBackup EDBM_redo_state_store(struct BMEditMesh *em);
307 /* restore a bmesh from backup */
308 void EDBM_redo_state_restore(struct BMBackup, struct BMEditMesh *em, int recalctess);
309 /* delete the backup, optionally flushing it to an editmesh */
310 void EDBM_redo_state_free(struct BMBackup *, struct BMEditMesh *em, int recalctess);
311
312
313 /* *** meshtools.c *** */
314 int         join_mesh_exec(struct bContext *C, struct wmOperator *op);
315 int         join_mesh_shapes_exec(struct bContext *C, struct wmOperator *op);
316
317 /* mirror lookup api */
318 int ED_mesh_mirror_spatial_table(
319         struct Object *ob, struct BMEditMesh *em, struct DerivedMesh *dm, const float co[3], char mode);
320 int  ED_mesh_mirror_topo_table(struct Object *ob, struct DerivedMesh *dm, char mode);
321
322 /* retrieves mirrored cache vert, or NULL if there isn't one.
323  * note: calling this without ensuring the mirror cache state
324  * is bad.*/
325 int            mesh_get_x_mirror_vert(struct Object *ob, struct DerivedMesh *dm, int index, const bool use_topology);
326 struct BMVert *editbmesh_get_x_mirror_vert(struct Object *ob, struct BMEditMesh *em,
327                                            struct BMVert *eve, const float co[3],
328                                            int index, const bool use_topology);
329 int           *mesh_get_x_mirror_faces(struct Object *ob, struct BMEditMesh *em, struct DerivedMesh *dm);
330
331 int ED_mesh_mirror_get_vert(struct Object *ob, int index);
332
333 bool ED_mesh_pick_vert(struct bContext *C,      struct Object *ob, const int mval[2], unsigned int *index, int size, bool use_zbuf);
334 bool ED_mesh_pick_face(struct bContext *C,      struct Object *ob, const int mval[2], unsigned int *index, int size);
335 bool ED_mesh_pick_face_vert(struct bContext *C, struct Object *ob, const int mval[2], unsigned int *index, int size);
336
337
338 struct MDeformVert *ED_mesh_active_dvert_get_em(struct Object *ob, struct BMVert **r_eve);
339 struct MDeformVert *ED_mesh_active_dvert_get_ob(struct Object *ob, int *r_index);
340 struct MDeformVert *ED_mesh_active_dvert_get_only(struct Object *ob);
341
342 #define ED_MESH_PICK_DEFAULT_VERT_SIZE 50
343 #define ED_MESH_PICK_DEFAULT_FACE_SIZE 3
344
345 #define USE_LOOPSLIDE_HACK
346
347 #ifdef __cplusplus
348 }
349 #endif
350
351 #endif /* __ED_MESH_H__ */