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