Cycles: Fix shading with autosmooth and custom 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 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 lib_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_split_faces(struct Mesh *mesh, bool free_loop_normals);
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(const 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         const struct MLoop *mloop, const struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
167         const 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         const struct MLoop *mloop, const struct MPoly *mpolys,
171         int numLoops, int numPolys, float (*r_polyNors)[3],
172         const struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
173         const bool only_face_normals);
174 void BKE_mesh_calc_normals_poly(
175         struct MVert *mverts, float (*r_vertnors)[3], int numVerts,
176         const struct MLoop *mloop, const struct MPoly *mpolys,
177         int numLoops, int numPolys, float (*r_polyNors)[3],
178         const bool only_face_normals);
179 void BKE_mesh_calc_normals(struct Mesh *me);
180 void BKE_mesh_calc_normals_tessface(
181         struct MVert *mverts, int numVerts,
182         const struct MFace *mfaces, int numFaces,
183         float (*r_faceNors)[3]);
184 void BKE_mesh_calc_normals_looptri(
185         struct MVert *mverts, int numVerts,
186         const struct MLoop *mloop,
187         const struct MLoopTri *looptri, int looptri_num,
188         float (*r_tri_nors)[3]);
189 void BKE_mesh_loop_tangents_ex(
190         const struct MVert *mverts, const int numVerts, const struct MLoop *mloops,
191         float (*r_looptangent)[4], float (*loopnors)[3], const struct MLoopUV *loopuv,
192         const int numLoops, const struct MPoly *mpolys, const int numPolys,
193         struct ReportList *reports);
194 void BKE_mesh_loop_tangents(
195         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
196
197 /**
198  * References a contiguous loop-fan with normal offset vars.
199  */
200 typedef struct MLoopNorSpace {
201         float vec_lnor[3];      /* Automatically computed loop normal. */
202         float vec_ref[3];       /* Reference vector, orthogonal to vec_lnor. */
203         float vec_ortho[3];     /* Third vector, orthogonal to vec_lnor and vec_ref. */
204         float ref_alpha;        /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
205         float ref_beta;         /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
206         struct LinkNode *loops; /* All indices (uint_in_ptr) of loops using this lnor space (i.e. smooth fan of loops). */
207 } MLoopNorSpace;
208 /**
209  * Collection of #MLoopNorSpace basic storage & pre-allocation.
210  */
211 typedef struct MLoopNorSpaceArray {
212         MLoopNorSpace **lspacearr;    /* MLoop aligned array */
213         struct LinkNode *loops_pool;  /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
214         struct MemArena *mem;
215 } MLoopNorSpaceArray;
216 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr, const int numLoops);
217 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
218 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
219 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
220 void BKE_lnor_space_define(
221         MLoopNorSpace *lnor_space, const float lnor[3], float vec_ref[3], float vec_other[3],
222         struct BLI_Stack *edge_vectors);
223 void BKE_lnor_space_add_loop(
224         MLoopNorSpaceArray *lnors_spacearr, MLoopNorSpace *lnor_space, const int ml_index, const bool add_to_list);
225 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, const short clnor_data[2], float r_custom_lnor[3]);
226 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space, const float custom_lnor[3], short r_clnor_data[2]);
227
228 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
229
230 void BKE_mesh_calc_normals_split(struct Mesh *mesh);
231 void BKE_mesh_calc_normals_split_ex(struct Mesh *mesh, struct MLoopNorSpaceArray *r_lnors_spacearr);
232
233 void BKE_mesh_normals_loop_split(
234         const struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
235         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
236         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
237         const bool use_split_normals, float split_angle,
238         MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], int *r_loop_to_poly);
239
240 void BKE_mesh_normals_loop_custom_set(
241         const struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
242         struct MLoop *mloops, float (*r_custom_loopnors)[3], const int numLoops,
243         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
244         short (*r_clnors_data)[2]);
245 void BKE_mesh_normals_loop_custom_from_vertices_set(
246         const struct MVert *mverts, float (*r_custom_vertnors)[3], const int numVerts,
247         struct MEdge *medges, const int numEdges, struct MLoop *mloops, const int numLoops,
248         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
249         short (*r_clnors_data)[2]);
250
251 void BKE_mesh_normals_loop_to_vertex(
252         const int numVerts, const struct MLoop *mloops, const int numLoops,
253         const float (*clnors)[3], float (*r_vert_clnors)[3]);
254
255 void BKE_mesh_calc_poly_normal(
256         const struct MPoly *mpoly, const struct MLoop *loopstart,
257         const struct MVert *mvarray, float r_no[3]);
258 void BKE_mesh_calc_poly_normal_coords(
259         const struct MPoly *mpoly, const struct MLoop *loopstart,
260         const float (*vertex_coords)[3], float r_no[3]);
261 void BKE_mesh_calc_poly_center(
262         const struct MPoly *mpoly, const struct MLoop *loopstart,
263         const struct MVert *mvarray, float r_cent[3]);
264 float BKE_mesh_calc_poly_area(
265         const struct MPoly *mpoly, const struct MLoop *loopstart,
266         const struct MVert *mvarray);
267 void BKE_mesh_calc_poly_angles(
268         const struct MPoly *mpoly, const struct MLoop *loopstart,
269         const struct MVert *mvarray, float angles[]);
270
271 void BKE_mesh_poly_edgehash_insert(
272         struct EdgeHash *ehash,
273         const struct MPoly *mp, const struct MLoop *mloop);
274 void BKE_mesh_poly_edgebitmap_insert(
275         unsigned int *edge_bitmap,
276         const struct MPoly *mp, const struct MLoop *mloop);
277
278
279 bool BKE_mesh_center_median(const struct Mesh *me, float r_cent[3]);
280 bool BKE_mesh_center_bounds(const struct Mesh *me, float r_cent[3]);
281 bool BKE_mesh_center_centroid(const struct Mesh *me, float r_cent[3]);
282
283 void BKE_mesh_calc_volume(
284         const struct MVert *mverts, const int mverts_num,
285         const struct MLoopTri *mlooptri, const int looptri_num,
286         const struct MLoop *mloop,
287         float *r_volume, float r_center[3]);
288
289 /* tessface */
290 void BKE_mesh_loops_to_mface_corners(
291         struct CustomData *fdata, struct CustomData *ldata,
292         struct CustomData *pdata, unsigned int lindex[4], int findex,
293         const int polyindex, const int mf_len,
294         const int numTex, const int numCol,
295         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
296 void BKE_mesh_loops_to_tessdata(
297         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MFace *mface,
298         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
299 void BKE_mesh_tangent_loops_to_tessdata(
300         struct CustomData *fdata, struct CustomData *ldata, struct MFace *mface,
301         int *polyindices, unsigned int (*loopindices)[4], const int num_faces, const char *layer_name);
302 int BKE_mesh_recalc_tessellation(
303         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
304         struct MVert *mvert,
305         int totface, int totloop, int totpoly,
306         const bool do_face_nor_copy);
307 void BKE_mesh_recalc_looptri(
308         const struct MLoop *mloop, const struct MPoly *mpoly,
309         const struct MVert *mvert,
310         int totloop, int totpoly,
311         struct MLoopTri *mlooptri);
312 int BKE_mesh_mpoly_to_mface(
313         struct CustomData *fdata, struct CustomData *ldata,
314         struct CustomData *pdata, int totface, int totloop, int totpoly);
315 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
316 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
317 void BKE_mesh_convert_mfaces_to_mpolys_ex(
318         struct ID *id,
319         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
320         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
321         struct MEdge *medge, struct MFace *mface,
322         int *r_totloop, int *r_totpoly,
323         struct MLoop **r_mloop, struct MPoly **r_mpoly);
324
325 void BKE_mesh_mdisp_flip(struct MDisps *md, const bool use_loop_mdisp_flip);
326
327 void BKE_mesh_polygon_flip_ex(
328         struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata,
329         float (*lnors)[3], struct MDisps *mdisp, const bool use_loop_mdisp_flip);
330 void BKE_mesh_polygon_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata);
331 void BKE_mesh_polygons_flip(struct MPoly *mpoly, struct MLoop *mloop, struct CustomData *ldata, int totpoly);
332
333 /* flush flags */
334 void BKE_mesh_flush_hidden_from_verts_ex(
335         const struct MVert *mvert,
336         const struct MLoop *mloop,
337         struct MEdge *medge, const int totedge,
338         struct MPoly *mpoly, const int totpoly);
339 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
340 void BKE_mesh_flush_hidden_from_polys_ex(
341         struct MVert *mvert,
342         const struct MLoop *mloop,
343         struct MEdge *medge, const int totedge,
344         const struct MPoly *mpoly, const int totpoly);
345 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
346 void BKE_mesh_flush_select_from_polys_ex(
347         struct MVert *mvert,       const int totvert,
348         const struct MLoop *mloop,
349         struct MEdge *medge,       const int totedge,
350         const struct MPoly *mpoly, const int totpoly);
351 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
352 void BKE_mesh_flush_select_from_verts_ex(
353         const struct MVert *mvert, const int totvert,
354         const struct MLoop *mloop,
355         struct MEdge *medge,       const int totedge,
356         struct MPoly *mpoly,       const int totpoly);
357 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
358
359 /* spatial evaluation */
360 void BKE_mesh_calc_relative_deform(
361         const struct MPoly *mpoly, const int totpoly,
362         const struct MLoop *mloop, const int totvert,
363
364         const float (*vert_cos_src)[3],
365         const float (*vert_cos_dst)[3],
366
367         const float (*vert_cos_org)[3],
368               float (*vert_cos_new)[3]);
369
370
371
372 /* *** mesh_validate.c *** */
373
374 int BKE_mesh_validate(struct Mesh *me, const int do_verbose, const int cddata_check_mask);
375 void BKE_mesh_cd_validate(struct Mesh *me);
376 int BKE_mesh_validate_material_indices(struct Mesh *me);
377
378 bool BKE_mesh_validate_arrays(
379         struct Mesh *me,
380         struct MVert *mverts, unsigned int totvert,
381         struct MEdge *medges, unsigned int totedge,
382         struct MFace *mfaces, unsigned int totface,
383         struct MLoop *mloops, unsigned int totloop,
384         struct MPoly *mpolys, unsigned int totpoly,
385         struct MDeformVert *dverts, /* assume totvert length */
386         const bool do_verbose, const bool do_fixes,
387         bool *r_change);
388
389 bool BKE_mesh_validate_all_customdata(
390         struct CustomData *vdata, struct CustomData *edata,
391         struct CustomData *ldata, struct CustomData *pdata,
392         const bool check_meshmask,
393         const bool do_verbose, const bool do_fixes,
394         bool *r_change);
395
396 void BKE_mesh_strip_loose_faces(struct Mesh *me);
397 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
398 void BKE_mesh_strip_loose_edges(struct Mesh *me);
399
400 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
401 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
402
403 /* **** Depsgraph evaluation **** */
404
405 struct EvaluationContext;
406
407 void BKE_mesh_eval_geometry(struct EvaluationContext *eval_ctx,
408                             struct Mesh *mesh);
409
410 #ifdef __cplusplus
411 }
412 #endif
413
414 #endif /* __BKE_MESH_H__ */