Fix T43786: Cycles bake disregards Auto Smooth (vertex per-face normals)
[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 BoundBox;
36 struct DispList;
37 struct EdgeHash;
38 struct ListBase;
39 struct LinkNode;
40 struct BLI_Stack;
41 struct MemArena;
42 struct BMEditMesh;
43 struct BMesh;
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 MCol;
53 struct Object;
54 struct MTFace;
55 struct VecNor;
56 struct CustomData;
57 struct DerivedMesh;
58 struct Scene;
59 struct MLoopUV;
60 struct UvVertMap;
61 struct UvMapVert;
62 struct UvElementMap;
63 struct UvElement;
64 struct ReportList;
65
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69
70 /* setting zero so we can catch bugs in OpenMP/BMesh */
71 #ifdef DEBUG
72 #  define BKE_MESH_OMP_LIMIT 0
73 #else
74 #  define BKE_MESH_OMP_LIMIT 10000
75 #endif
76
77 /* *** mesh.c *** */
78
79 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
80
81 int poly_find_loop_from_vert(const struct MPoly *poly,
82                              const struct MLoop *loopstart,
83                              unsigned vert);
84
85 int poly_get_adj_loops_from_vert(unsigned r_adj[3], const struct MPoly *poly,
86                                  const struct MLoop *mloop, unsigned vert);
87
88 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
89
90 void BKE_mesh_unlink(struct Mesh *me);
91 void BKE_mesh_free(struct Mesh *me, int unlink);
92 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
93 struct Mesh *BKE_mesh_copy_ex(struct Main *bmain, struct Mesh *me);
94 struct Mesh *BKE_mesh_copy(struct Mesh *me);
95 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
96 void BKE_mesh_ensure_skin_customdata(struct Mesh *me);
97
98 void BKE_mesh_make_local(struct Mesh *me);
99 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
100 void BKE_mesh_texspace_calc(struct Mesh *me);
101 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
102 void   BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
103 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
104 struct Mesh *BKE_mesh_from_object(struct Object *ob);
105 void BKE_mesh_assign_object(struct Object *ob, struct Mesh *me);
106 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
107 int  BKE_mesh_nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *totvert,
108                              struct MEdge **alledge, int *totedge, struct MLoop **allloop, struct MPoly **allpoly,
109                              int *totloop, int *totpoly);
110 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
111                                      struct MEdge **alledge, int *_totedge, struct MLoop **allloop, struct MPoly **allpoly,
112                                      struct MLoopUV **alluv, int *_totloop, int *_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_smooth_flag_set(struct Object *meshOb, int enableSmooth);
120
121 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
122
123 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
124 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
125 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
126
127 bool BKE_mesh_uv_cdlayer_rename_index(struct Mesh *me, const int poly_index, const int loop_index, const int face_index,
128                                       const char *new_name, const bool do_tessface);
129 bool BKE_mesh_uv_cdlayer_rename(struct Mesh *me, const char *old_name, const char *new_name, bool do_tessface);
130
131 float (*BKE_mesh_vertexCos_get(struct Mesh *me, int *r_numVerts))[3];
132
133 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
134 void BKE_mesh_split_faces(struct Mesh *mesh);
135
136 struct Mesh *BKE_mesh_new_from_object(struct Main *bmain, struct Scene *sce, struct Object *ob,
137                                       int apply_modifiers, int settings, int calc_tessface, int calc_undeformed);
138
139 /* vertex level transformations & checks (no derived mesh) */
140
141 bool BKE_mesh_minmax(struct Mesh *me, float r_min[3], float r_max[3]);
142 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
143 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
144
145 void BKE_mesh_ensure_navmesh(struct Mesh *me);
146
147 void BKE_mesh_tessface_calc(struct Mesh *mesh);
148 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
149 void BKE_mesh_tessface_clear(struct Mesh *mesh);
150
151 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
152
153
154 void BKE_mesh_mselect_clear(struct Mesh *me);
155 void BKE_mesh_mselect_validate(struct Mesh *me);
156 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
157 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
158 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
159
160
161
162 /* *** mesh_evaluate.c *** */
163
164 void BKE_mesh_calc_normals_mapping(
165         struct MVert *mverts, int numVerts,
166         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
167         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3]);
168 void BKE_mesh_calc_normals_mapping_ex(
169         struct MVert *mverts, int numVerts,
170         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
171         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
172         const bool only_face_normals);
173 void BKE_mesh_calc_normals_poly(
174         struct MVert *mverts, int numVerts,
175         struct MLoop *mloop, struct MPoly *mpolys,
176         int numLoops, int numPolys, float (*r_polyNors)[3],
177         const bool only_face_normals);
178 void BKE_mesh_calc_normals(struct Mesh *me);
179 void BKE_mesh_calc_normals_tessface(
180         struct MVert *mverts, int numVerts,
181         struct MFace *mfaces, int numFaces,
182         float (*r_faceNors)[3]);
183 void BKE_mesh_loop_tangents_ex(
184         struct MVert *mverts, const int numVerts, struct MLoop *mloops, float (*r_looptangent)[4], float (*loopnors)[3],
185         struct MLoopUV *loopuv, const int numLoops, struct MPoly *mpolys, const int numPolys,
186         struct ReportList *reports);
187 void BKE_mesh_loop_tangents(
188         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
189
190 /**
191  * References a contiguous loop-fan with normal offset vars.
192  */
193 typedef struct MLoopNorSpace {
194         float vec_lnor[3];      /* Automatically computed loop normal. */
195         float vec_ref[3];       /* Reference vector, orthogonal to vec_lnor. */
196         float vec_ortho[3];     /* Third vector, orthogonal to vec_lnor and vec_ref. */
197         float ref_alpha;        /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
198         float ref_beta;         /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
199         struct LinkNode *loops; /* All indices (uint_in_ptr) of loops using this lnor space (i.e. smooth fan of loops). */
200 } MLoopNorSpace;
201 /**
202  * Collection of #MLoopNorSpace basic storage & pre-allocation.
203  */
204 typedef struct MLoopNorSpaceArray {
205         MLoopNorSpace **lspacearr;    /* MLoop aligned array */
206         struct LinkNode *loops_pool;  /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
207         struct MemArena *mem;
208 } MLoopNorSpaceArray;
209 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr, const int numLoops);
210 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
211 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
212 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
213 void BKE_lnor_space_define(
214         MLoopNorSpace *lnor_space, const float lnor[3], float vec_ref[3], float vec_other[3],
215         struct BLI_Stack *edge_vectors);
216 void BKE_lnor_space_add_loop(
217         MLoopNorSpaceArray *lnors_spacearr, MLoopNorSpace *lnor_space, const int ml_index, const bool add_to_list);
218 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, const short clnor_data[2], float r_custom_lnor[3]);
219 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space, const float custom_lnor[3], short r_clnor_data[2]);
220
221 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
222
223 void BKE_mesh_normals_loop_split(struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
224         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
225         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
226         const bool use_split_normals, float split_angle,
227         MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], int *r_loop_to_poly);
228
229 void BKE_mesh_normals_loop_custom_set(
230         struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
231         struct MLoop *mloops, float (*custom_loopnors)[3], const int numLoops,
232         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
233         short (*r_clnors_data)[2]);
234 void BKE_mesh_normals_loop_custom_from_vertices_set(
235         struct MVert *mverts, float (*custom_vertnors)[3], const int numVerts,
236         struct MEdge *medges, const int numEdges, struct MLoop *mloops, const int numLoops,
237         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
238         short (*r_clnors_data)[2]);
239
240 void BKE_mesh_calc_poly_normal(
241         struct MPoly *mpoly, struct MLoop *loopstart,
242         struct MVert *mvarray, float no[3]);
243 void BKE_mesh_calc_poly_normal_coords(
244         struct MPoly *mpoly, struct MLoop *loopstart,
245         const float (*vertex_coords)[3], float no[3]);
246 void BKE_mesh_calc_poly_center(
247         struct MPoly *mpoly, struct MLoop *loopstart,
248         struct MVert *mvarray, float cent[3]);
249 float BKE_mesh_calc_poly_area(
250         struct MPoly *mpoly, struct MLoop *loopstart,
251         struct MVert *mvarray);
252 void BKE_mesh_calc_poly_angles(
253         struct MPoly *mpoly, struct MLoop *loopstart,
254         struct MVert *mvarray, float angles[]);
255
256 void BKE_mesh_poly_edgehash_insert(
257         struct EdgeHash *ehash,
258         const struct MPoly *mp, const struct MLoop *mloop);
259 void BKE_mesh_poly_edgebitmap_insert(
260         unsigned int *edge_bitmap,
261         const struct MPoly *mp, const struct MLoop *mloop);
262
263
264 bool BKE_mesh_center_median(struct Mesh *me, float cent[3]);
265 bool BKE_mesh_center_bounds(struct Mesh *me, float cent[3]);
266 bool BKE_mesh_center_centroid(struct Mesh *me, float cent[3]);
267
268 void BKE_mesh_calc_volume(struct MVert *mverts, int numVerts,
269                           struct MFace *mfaces, int numFaces,
270                           float *r_vol, float *r_com);
271
272 /* tessface */
273 void BKE_mesh_loops_to_mface_corners(
274         struct CustomData *fdata, struct CustomData *ldata,
275         struct CustomData *pdata, unsigned int lindex[4], int findex,
276         const int polyindex, const int mf_len,
277         const int numTex, const int numCol,
278         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
279 void BKE_mesh_loops_to_tessdata(
280         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MFace *mface,
281         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
282 int BKE_mesh_recalc_tessellation(
283         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
284         struct MVert *mvert,
285         int totface, int totloop, int totpoly,
286         const bool do_face_normals);
287 int BKE_mesh_mpoly_to_mface(
288         struct CustomData *fdata, struct CustomData *ldata,
289         struct CustomData *pdata, int totface, int totloop, int totpoly);
290 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
291 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
292 void BKE_mesh_convert_mfaces_to_mpolys_ex(
293         struct ID *id,
294         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
295         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
296         struct MEdge *medge, struct MFace *mface,
297         int *r_totloop, int *r_totpoly,
298         struct MLoop **r_mloop, struct MPoly **r_mpoly);
299
300 /* flush flags */
301 void BKE_mesh_flush_hidden_from_verts_ex(
302         const struct MVert *mvert,
303         const struct MLoop *mloop,
304         struct MEdge *medge, const int totedge,
305         struct MPoly *mpoly, const int totpoly);
306 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
307 void BKE_mesh_flush_hidden_from_polys_ex(
308         struct MVert *mvert,
309         const struct MLoop *mloop,
310         struct MEdge *medge, const int totedge,
311         const struct MPoly *mpoly, const int totpoly);
312 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
313 void BKE_mesh_flush_select_from_polys_ex(
314         struct MVert *mvert,       const int totvert,
315         const struct MLoop *mloop,
316         struct MEdge *medge,       const int totedge,
317         const struct MPoly *mpoly, const int totpoly);
318 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
319 void BKE_mesh_flush_select_from_verts_ex(
320         const struct MVert *mvert, const int totvert,
321         const struct MLoop *mloop,
322         struct MEdge *medge,       const int totedge,
323         struct MPoly *mpoly,       const int totpoly);
324 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
325
326 /* spatial evaluation */
327 void BKE_mesh_calc_relative_deform(
328         const struct MPoly *mpoly, const int totpoly,
329         const struct MLoop *mloop, const int totvert,
330
331         const float (*vert_cos_src)[3],
332         const float (*vert_cos_dst)[3],
333
334         const float (*vert_cos_org)[3],
335               float (*vert_cos_new)[3]);
336
337
338
339 /* *** mesh_validate.c *** */
340
341 int BKE_mesh_validate(struct Mesh *me, const int do_verbose, const int cddata_check_mask);
342 void BKE_mesh_cd_validate(struct Mesh *me);
343 int BKE_mesh_validate_material_indices(struct Mesh *me);
344
345 bool BKE_mesh_validate_arrays(
346         struct Mesh *me,
347         struct MVert *mverts, unsigned int totvert,
348         struct MEdge *medges, unsigned int totedge,
349         struct MFace *mfaces, unsigned int totface,
350         struct MLoop *mloops, unsigned int totloop,
351         struct MPoly *mpolys, unsigned int totpoly,
352         struct MDeformVert *dverts, /* assume totvert length */
353         const bool do_verbose, const bool do_fixes,
354         bool *r_change);
355
356 bool BKE_mesh_validate_all_customdata(
357         struct CustomData *vdata, struct CustomData *edata,
358         struct CustomData *ldata, struct CustomData *pdata,
359         const bool check_meshmask,
360         const bool do_verbose, const bool do_fixes,
361         bool *r_change);
362
363 void BKE_mesh_strip_loose_faces(struct Mesh *me);
364 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
365 void BKE_mesh_strip_loose_edges(struct Mesh *me);
366
367 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
368 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
369
370 #ifdef __cplusplus
371 }
372 #endif
373
374 #endif /* __BKE_MESH_H__ */