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