Add option to id_make_local to force localization of datablock, even if not used...
[blender-staging.git] / source / blender / blenkernel / BKE_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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): (mar-2001 nzc)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_MESH_H__
28 #define __BKE_MESH_H__
29
30 /** \file BKE_mesh.h
31  *  \ingroup bke
32  */
33
34 struct ID;
35 struct BMeshCreateParams;
36 struct BoundBox;
37 struct EdgeHash;
38 struct ListBase;
39 struct LinkNode;
40 struct BLI_Stack;
41 struct MemArena;
42 struct BMesh;
43 struct MLoopTri;
44 struct Main;
45 struct Mesh;
46 struct MPoly;
47 struct MLoop;
48 struct MFace;
49 struct MEdge;
50 struct MVert;
51 struct MDeformVert;
52 struct MDisps;
53 struct Object;
54 struct CustomData;
55 struct DerivedMesh;
56 struct Scene;
57 struct MLoopUV;
58 struct ReportList;
59
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63
64 /* setting zero so we can catch bugs in OpenMP/BMesh */
65 #ifdef DEBUG
66 #  define BKE_MESH_OMP_LIMIT 0
67 #else
68 #  define BKE_MESH_OMP_LIMIT 10000
69 #endif
70
71 /* *** mesh.c *** */
72
73 struct BMesh *BKE_mesh_to_bmesh(
74         struct Mesh *me, struct Object *ob,
75         const bool add_key_index, const struct BMeshCreateParams *params);
76
77 int poly_find_loop_from_vert(
78         const struct MPoly *poly,
79         const struct MLoop *loopstart, unsigned vert);
80 int poly_get_adj_loops_from_vert(
81         const struct MPoly *poly,
82         const struct MLoop *mloop, unsigned int vert,
83         unsigned int r_adj[2]);
84
85 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
86
87 void BKE_mesh_free(struct Mesh *me);
88 void BKE_mesh_init(struct Mesh *me);
89 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
90 struct Mesh *BKE_mesh_copy(struct Main *bmain, struct Mesh *me);
91 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
92 void BKE_mesh_ensure_skin_customdata(struct Mesh *me);
93
94 void BKE_mesh_make_local(struct Main *bmain, struct Mesh *me, const bool force_local);
95 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
96 void BKE_mesh_texspace_calc(struct Mesh *me);
97 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
98 void   BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
99 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
100 struct Mesh *BKE_mesh_from_object(struct Object *ob);
101 void BKE_mesh_assign_object(struct Object *ob, struct Mesh *me);
102 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
103 int  BKE_mesh_nurbs_to_mdata(
104         struct Object *ob, struct MVert **r_allvert, int *r_totvert,
105         struct MEdge **r_alledge, int *r_totedge, struct MLoop **r_allloop, struct MPoly **r_allpoly,
106         int *r_totloop, int *r_totpoly);
107 int BKE_mesh_nurbs_displist_to_mdata(
108         struct Object *ob, const struct ListBase *dispbase,
109         struct MVert **r_allvert, int *r_totvert,
110         struct MEdge **r_alledge, int *r_totedge,
111         struct MLoop **r_allloop, struct MPoly **r_allpoly,
112         struct MLoopUV **r_alluv, int *r_totloop, int *r_totpoly);
113 void BKE_mesh_from_nurbs_displist(struct Object *ob, struct ListBase *dispbase, const bool use_orco_uv);
114 void BKE_mesh_from_nurbs(struct Object *ob);
115 void BKE_mesh_to_curve_nurblist(struct DerivedMesh *dm, struct ListBase *nurblist, const int edge_users_test);
116 void BKE_mesh_to_curve(struct Scene *scene, struct Object *ob);
117 void BKE_mesh_material_index_remove(struct Mesh *me, short index);
118 void BKE_mesh_material_index_clear(struct Mesh *me);
119 void BKE_mesh_material_remap(struct Mesh *me, const unsigned int *remap, unsigned int remap_len);
120 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
121
122 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
123
124 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
125 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
126 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
127
128 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me, const int poly_index, const int loop_index, const int face_index,
129                                       const char *new_name, const bool do_tessface);
130 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me, const char *old_name, const char *new_name, bool do_tessface);
131
132 float (*BKE_mesh_vertexCos_get(const struct Mesh *me, int *r_numVerts))[3];
133
134 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
135 void BKE_mesh_split_faces(struct Mesh *mesh);
136
137 struct Mesh *BKE_mesh_new_from_object(struct Main *bmain, struct Scene *sce, struct Object *ob,
138                                       int apply_modifiers, int settings, int calc_tessface, int calc_undeformed);
139
140 /* vertex level transformations & checks (no derived mesh) */
141
142 bool BKE_mesh_minmax(const struct Mesh *me, float r_min[3], float r_max[3]);
143 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
144 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
145
146 void BKE_mesh_ensure_navmesh(struct Mesh *me);
147
148 void BKE_mesh_tessface_calc(struct Mesh *mesh);
149 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
150 void BKE_mesh_tessface_clear(struct Mesh *mesh);
151
152 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
153
154
155 void BKE_mesh_mselect_clear(struct Mesh *me);
156 void BKE_mesh_mselect_validate(struct Mesh *me);
157 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
158 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
159 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
160
161
162
163 /* *** mesh_evaluate.c *** */
164
165 void BKE_mesh_calc_normals_mapping(
166         struct MVert *mverts, int numVerts,
167         const struct MLoop *mloop, const struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
168         const struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3]);
169 void BKE_mesh_calc_normals_mapping_ex(
170         struct MVert *mverts, int numVerts,
171         const struct MLoop *mloop, const struct MPoly *mpolys,
172         int numLoops, int numPolys, float (*r_polyNors)[3],
173         const struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
174         const bool only_face_normals);
175 void BKE_mesh_calc_normals_poly(
176         struct MVert *mverts, float (*r_vertnors)[3], int numVerts,
177         const struct MLoop *mloop, const struct MPoly *mpolys,
178         int numLoops, int numPolys, float (*r_polyNors)[3],
179         const bool only_face_normals);
180 void BKE_mesh_calc_normals(struct Mesh *me);
181 void BKE_mesh_calc_normals_tessface(
182         struct MVert *mverts, int numVerts,
183         const struct MFace *mfaces, int numFaces,
184         float (*r_faceNors)[3]);
185 void BKE_mesh_calc_normals_looptri(
186         struct MVert *mverts, int numVerts,
187         const struct MLoop *mloop,
188         const struct MLoopTri *looptri, int looptri_num,
189         float (*r_tri_nors)[3]);
190 void BKE_mesh_loop_tangents_ex(
191         const struct MVert *mverts, const int numVerts, const struct MLoop *mloops,
192         float (*r_looptangent)[4], float (*loopnors)[3], const struct MLoopUV *loopuv,
193         const int numLoops, const struct MPoly *mpolys, const int numPolys,
194         struct ReportList *reports);
195 void BKE_mesh_loop_tangents(
196         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
197
198 /**
199  * References a contiguous loop-fan with normal offset vars.
200  */
201 typedef struct MLoopNorSpace {
202         float vec_lnor[3];      /* Automatically computed loop normal. */
203         float vec_ref[3];       /* Reference vector, orthogonal to vec_lnor. */
204         float vec_ortho[3];     /* Third vector, orthogonal to vec_lnor and vec_ref. */
205         float ref_alpha;        /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
206         float ref_beta;         /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
207         struct LinkNode *loops; /* All indices (uint_in_ptr) of loops using this lnor space (i.e. smooth fan of loops). */
208 } MLoopNorSpace;
209 /**
210  * Collection of #MLoopNorSpace basic storage & pre-allocation.
211  */
212 typedef struct MLoopNorSpaceArray {
213         MLoopNorSpace **lspacearr;    /* MLoop aligned array */
214         struct LinkNode *loops_pool;  /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
215         struct MemArena *mem;
216 } MLoopNorSpaceArray;
217 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr, const int numLoops);
218 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
219 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
220 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
221 void BKE_lnor_space_define(
222         MLoopNorSpace *lnor_space, const float lnor[3], float vec_ref[3], float vec_other[3],
223         struct BLI_Stack *edge_vectors);
224 void BKE_lnor_space_add_loop(
225         MLoopNorSpaceArray *lnors_spacearr, MLoopNorSpace *lnor_space, const int ml_index, const bool add_to_list);
226 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, const short clnor_data[2], float r_custom_lnor[3]);
227 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space, const float custom_lnor[3], short r_clnor_data[2]);
228
229 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
230
231 void BKE_mesh_normals_loop_split(
232         const struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
233         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
234         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
235         const bool use_split_normals, float split_angle,
236         MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], int *r_loop_to_poly);
237
238 void BKE_mesh_normals_loop_custom_set(
239         const struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
240         struct MLoop *mloops, float (*r_custom_loopnors)[3], const int numLoops,
241         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
242         short (*r_clnors_data)[2]);
243 void BKE_mesh_normals_loop_custom_from_vertices_set(
244         const struct MVert *mverts, float (*r_custom_vertnors)[3], const int numVerts,
245         struct MEdge *medges, const int numEdges, struct MLoop *mloops, const int numLoops,
246         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
247         short (*r_clnors_data)[2]);
248
249 void BKE_mesh_normals_loop_to_vertex(
250         const int numVerts, const struct MLoop *mloops, const int numLoops,
251         const float (*clnors)[3], float (*r_vert_clnors)[3]);
252
253 void BKE_mesh_calc_poly_normal(
254         const struct MPoly *mpoly, const struct MLoop *loopstart,
255         const struct MVert *mvarray, float r_no[3]);
256 void BKE_mesh_calc_poly_normal_coords(
257         const struct MPoly *mpoly, const struct MLoop *loopstart,
258         const float (*vertex_coords)[3], float r_no[3]);
259 void BKE_mesh_calc_poly_center(
260         const struct MPoly *mpoly, const struct MLoop *loopstart,
261         const struct MVert *mvarray, float r_cent[3]);
262 float BKE_mesh_calc_poly_area(
263         const struct MPoly *mpoly, const struct MLoop *loopstart,
264         const struct MVert *mvarray);
265 void BKE_mesh_calc_poly_angles(
266         const struct MPoly *mpoly, const struct MLoop *loopstart,
267         const struct MVert *mvarray, float angles[]);
268
269 void BKE_mesh_poly_edgehash_insert(
270         struct EdgeHash *ehash,
271         const struct MPoly *mp, const struct MLoop *mloop);
272 void BKE_mesh_poly_edgebitmap_insert(
273         unsigned int *edge_bitmap,
274         const struct MPoly *mp, const struct MLoop *mloop);
275
276
277 bool BKE_mesh_center_median(const struct Mesh *me, float r_cent[3]);
278 bool BKE_mesh_center_bounds(const struct Mesh *me, float r_cent[3]);
279 bool BKE_mesh_center_centroid(const struct Mesh *me, float r_cent[3]);
280
281 void BKE_mesh_calc_volume(
282         const struct MVert *mverts, const int mverts_num,
283         const struct MLoopTri *mlooptri, const int looptri_num,
284         const struct MLoop *mloop,
285         float *r_volume, float r_center[3]);
286
287 /* tessface */
288 void BKE_mesh_loops_to_mface_corners(
289         struct CustomData *fdata, struct CustomData *ldata,
290         struct CustomData *pdata, unsigned int lindex[4], int findex,
291         const int polyindex, const int mf_len,
292         const int numTex, const int numCol,
293         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
294 void BKE_mesh_loops_to_tessdata(
295         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MFace *mface,
296         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
297 void BKE_mesh_tangent_loops_to_tessdata(
298         struct CustomData *fdata, struct CustomData *ldata, struct MFace *mface,
299         int *polyindices, unsigned int (*loopindices)[4], const int num_faces, const char *layer_name);
300 int BKE_mesh_recalc_tessellation(
301         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
302         struct MVert *mvert,
303         int totface, int totloop, int totpoly,
304         const bool do_face_nor_copy);
305 void BKE_mesh_recalc_looptri(
306         const struct MLoop *mloop, const struct MPoly *mpoly,
307         const struct MVert *mvert,
308         int totloop, int totpoly,
309         struct MLoopTri *mlooptri);
310 int BKE_mesh_mpoly_to_mface(
311         struct CustomData *fdata, struct CustomData *ldata,
312         struct CustomData *pdata, int totface, int totloop, int totpoly);
313 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
314 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
315 void BKE_mesh_convert_mfaces_to_mpolys_ex(
316         struct ID *id,
317         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
318         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
319         struct MEdge *medge, struct MFace *mface,
320         int *r_totloop, int *r_totpoly,
321         struct MLoop **r_mloop, struct MPoly **r_mpoly);
322
323 void BKE_mesh_mdisp_flip(struct MDisps *md, const bool use_loop_mdisp_flip);
324
325 void BKE_mesh_polygon_flip_ex(
326         struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata,
327         float (*lnors)[3], struct MDisps *mdisp, const bool use_loop_mdisp_flip);
328 void BKE_mesh_polygon_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata);
329 void BKE_mesh_polygons_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata, int totpoly);
330
331 /* flush flags */
332 void BKE_mesh_flush_hidden_from_verts_ex(
333         const struct MVert *mvert,
334         const struct MLoop *mloop,
335         struct MEdge *medge, const int totedge,
336         struct MPoly *mpoly, const int totpoly);
337 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
338 void BKE_mesh_flush_hidden_from_polys_ex(
339         struct MVert *mvert,
340         const struct MLoop *mloop,
341         struct MEdge *medge, const int totedge,
342         const struct MPoly *mpoly, const int totpoly);
343 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
344 void BKE_mesh_flush_select_from_polys_ex(
345         struct MVert *mvert,       const int totvert,
346         const struct MLoop *mloop,
347         struct MEdge *medge,       const int totedge,
348         const struct MPoly *mpoly, const int totpoly);
349 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
350 void BKE_mesh_flush_select_from_verts_ex(
351         const struct MVert *mvert, const int totvert,
352         const struct MLoop *mloop,
353         struct MEdge *medge,       const int totedge,
354         struct MPoly *mpoly,       const int totpoly);
355 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
356
357 /* spatial evaluation */
358 void BKE_mesh_calc_relative_deform(
359         const struct MPoly *mpoly, const int totpoly,
360         const struct MLoop *mloop, const int totvert,
361
362         const float (*vert_cos_src)[3],
363         const float (*vert_cos_dst)[3],
364
365         const float (*vert_cos_org)[3],
366               float (*vert_cos_new)[3]);
367
368
369
370 /* *** mesh_validate.c *** */
371
372 int BKE_mesh_validate(struct Mesh *me, const int do_verbose, const int cddata_check_mask);
373 void BKE_mesh_cd_validate(struct Mesh *me);
374 int BKE_mesh_validate_material_indices(struct Mesh *me);
375
376 bool BKE_mesh_validate_arrays(
377         struct Mesh *me,
378         struct MVert *mverts, unsigned int totvert,
379         struct MEdge *medges, unsigned int totedge,
380         struct MFace *mfaces, unsigned int totface,
381         struct MLoop *mloops, unsigned int totloop,
382         struct MPoly *mpolys, unsigned int totpoly,
383         struct MDeformVert *dverts, /* assume totvert length */
384         const bool do_verbose, const bool do_fixes,
385         bool *r_change);
386
387 bool BKE_mesh_validate_all_customdata(
388         struct CustomData *vdata, struct CustomData *edata,
389         struct CustomData *ldata, struct CustomData *pdata,
390         const bool check_meshmask,
391         const bool do_verbose, const bool do_fixes,
392         bool *r_change);
393
394 void BKE_mesh_strip_loose_faces(struct Mesh *me);
395 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
396 void BKE_mesh_strip_loose_edges(struct Mesh *me);
397
398 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
399 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
400
401 /* **** Depsgraph evaluation **** */
402
403 struct EvaluationContext;
404
405 void BKE_mesh_eval_geometry(struct EvaluationContext *eval_ctx,
406                             struct Mesh *mesh);
407
408 #ifdef __cplusplus
409 }
410 #endif
411
412 #endif /* __BKE_MESH_H__ */