Add Custom Loop 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 struct Mesh *BKE_mesh_new_from_object(struct Main *bmain, struct Scene *sce, struct Object *ob,
134                                       int apply_modifiers, int settings, int calc_tessface, int calc_undeformed);
135
136 /* vertex level transformations & checks (no derived mesh) */
137
138 bool BKE_mesh_minmax(struct Mesh *me, float r_min[3], float r_max[3]);
139 void BKE_mesh_transform(struct Mesh *me, float mat[4][4], bool do_keys);
140 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
141
142 void BKE_mesh_ensure_navmesh(struct Mesh *me);
143
144 void BKE_mesh_tessface_calc(struct Mesh *mesh);
145 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
146 void BKE_mesh_tessface_clear(struct Mesh *mesh);
147
148 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
149
150
151 void BKE_mesh_mselect_clear(struct Mesh *me);
152 void BKE_mesh_mselect_validate(struct Mesh *me);
153 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
154 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
155 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
156
157
158
159 /* *** mesh_evaluate.c *** */
160
161 void BKE_mesh_calc_normals_mapping(
162         struct MVert *mverts, int numVerts,
163         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
164         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3]);
165 void BKE_mesh_calc_normals_mapping_ex(
166         struct MVert *mverts, int numVerts,
167         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*r_polyNors)[3],
168         struct MFace *mfaces, int numFaces, const int *origIndexFace, float (*r_faceNors)[3],
169         const bool only_face_normals);
170 void BKE_mesh_calc_normals_poly(
171         struct MVert *mverts, int numVerts,
172         struct MLoop *mloop, struct MPoly *mpolys,
173         int numLoops, int numPolys, float (*r_polyNors)[3],
174         const bool only_face_normals);
175 void BKE_mesh_calc_normals(struct Mesh *me);
176 void BKE_mesh_calc_normals_tessface(
177         struct MVert *mverts, int numVerts,
178         struct MFace *mfaces, int numFaces,
179         float (*r_faceNors)[3]);
180 void BKE_mesh_loop_tangents_ex(
181         struct MVert *mverts, const int numVerts, struct MLoop *mloops, float (*r_looptangent)[4], float (*loopnors)[3],
182         struct MLoopUV *loopuv, const int numLoops, struct MPoly *mpolys, const int numPolys,
183         struct ReportList *reports);
184 void BKE_mesh_loop_tangents(
185         struct Mesh *mesh, const char *uvmap, float (*r_looptangents)[4], struct ReportList *reports);
186
187 /**
188  * References a contiguous loop-fan with normal offset vars.
189  */
190 typedef struct MLoopNorSpace {
191         float vec_lnor[3];      /* Automatically computed loop normal. */
192         float vec_ref[3];       /* Reference vector, orthogonal to vec_lnor. */
193         float vec_ortho[3];     /* Third vector, orthogonal to vec_lnor and vec_ref. */
194         float ref_alpha;        /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
195         float ref_beta;         /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
196         struct LinkNode *loops; /* All indices (uint_in_ptr) of loops using this lnor space (i.e. smooth fan of loops). */
197 } MLoopNorSpace;
198 /**
199  * Collection of #MLoopNorSpace basic storage & pre-allocation.
200  */
201 typedef struct MLoopNorSpaceArray {
202         MLoopNorSpace **lspacearr;    /* MLoop aligned array */
203         struct LinkNode *loops_pool;  /* Allocated once, avoids to call BLI_linklist_prepend_arena() for each loop! */
204         struct MemArena *mem;
205 } MLoopNorSpaceArray;
206 void BKE_lnor_spacearr_init(MLoopNorSpaceArray *lnors_spacearr, const int numLoops);
207 void BKE_lnor_spacearr_clear(MLoopNorSpaceArray *lnors_spacearr);
208 void BKE_lnor_spacearr_free(MLoopNorSpaceArray *lnors_spacearr);
209 MLoopNorSpace *BKE_lnor_space_create(MLoopNorSpaceArray *lnors_spacearr);
210 void BKE_lnor_space_define(
211         MLoopNorSpace *lnor_space, const float lnor[3], float vec_ref[3], float vec_other[3],
212         struct BLI_Stack *edge_vectors);
213 void BKE_lnor_space_add_loop(
214         MLoopNorSpaceArray *lnors_spacearr, MLoopNorSpace *lnor_space, const int ml_index, const bool add_to_list);
215 void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, const short clnor_data[2], float r_custom_lnor[3]);
216 void BKE_lnor_space_custom_normal_to_data(MLoopNorSpace *lnor_space, const float custom_lnor[3], short r_clnor_data[2]);
217
218 bool BKE_mesh_has_custom_loop_normals(struct Mesh *me);
219
220 void BKE_mesh_normals_loop_split(struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
221         struct MLoop *mloops, float (*r_loopnors)[3], const int numLoops,
222         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
223         const bool use_split_normals, float split_angle,
224         MLoopNorSpaceArray *r_lnors_spacearr, short (*clnors_data)[2], int *r_loop_to_poly);
225
226 void BKE_mesh_normals_loop_custom_set(
227         struct MVert *mverts, const int numVerts, struct MEdge *medges, const int numEdges,
228         struct MLoop *mloops, float (*custom_loopnors)[3], const int numLoops,
229         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
230         short (*r_clnors_data)[2]);
231 void BKE_mesh_normals_loop_custom_from_vertices_set(
232         struct MVert *mverts, float (*custom_vertnors)[3], const int numVerts,
233         struct MEdge *medges, const int numEdges, struct MLoop *mloops, const int numLoops,
234         struct MPoly *mpolys, const float (*polynors)[3], const int numPolys,
235         short (*r_clnors_data)[2]);
236
237 void BKE_mesh_calc_poly_normal(
238         struct MPoly *mpoly, struct MLoop *loopstart,
239         struct MVert *mvarray, float no[3]);
240 void BKE_mesh_calc_poly_normal_coords(
241         struct MPoly *mpoly, struct MLoop *loopstart,
242         const float (*vertex_coords)[3], float no[3]);
243 void BKE_mesh_calc_poly_center(
244         struct MPoly *mpoly, struct MLoop *loopstart,
245         struct MVert *mvarray, float cent[3]);
246 float BKE_mesh_calc_poly_area(
247         struct MPoly *mpoly, struct MLoop *loopstart,
248         struct MVert *mvarray);
249 void BKE_mesh_calc_poly_angles(
250         struct MPoly *mpoly, struct MLoop *loopstart,
251         struct MVert *mvarray, float angles[]);
252
253 void BKE_mesh_poly_edgehash_insert(
254         struct EdgeHash *ehash,
255         const struct MPoly *mp, const struct MLoop *mloop);
256 void BKE_mesh_poly_edgebitmap_insert(
257         unsigned int *edge_bitmap,
258         const struct MPoly *mp, const struct MLoop *mloop);
259
260
261 bool BKE_mesh_center_median(struct Mesh *me, float cent[3]);
262 bool BKE_mesh_center_bounds(struct Mesh *me, float cent[3]);
263 bool BKE_mesh_center_centroid(struct Mesh *me, float cent[3]);
264
265 void BKE_mesh_calc_volume(struct MVert *mverts, int numVerts,
266                           struct MFace *mfaces, int numFaces,
267                           float *r_vol, float *r_com);
268
269 /* tessface */
270 void BKE_mesh_loops_to_mface_corners(
271         struct CustomData *fdata, struct CustomData *ldata,
272         struct CustomData *pdata, unsigned int lindex[4], int findex,
273         const int polyindex, const int mf_len,
274         const int numTex, const int numCol,
275         const bool hasPCol, const bool hasOrigSpace, const bool hasLNor);
276 void BKE_mesh_loops_to_tessdata(
277         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata, struct MFace *mface,
278         int *polyindices, unsigned int (*loopindices)[4], const int num_faces);
279 int BKE_mesh_recalc_tessellation(
280         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
281         struct MVert *mvert,
282         int totface, int totloop, int totpoly,
283         const bool do_face_normals);
284 int BKE_mesh_mpoly_to_mface(
285         struct CustomData *fdata, struct CustomData *ldata,
286         struct CustomData *pdata, int totface, int totloop, int totpoly);
287 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
288 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
289 void BKE_mesh_convert_mfaces_to_mpolys_ex(
290         struct ID *id,
291         struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
292         int totedge_i, int totface_i, int totloop_i, int totpoly_i,
293         struct MEdge *medge, struct MFace *mface,
294         int *r_totloop, int *r_totpoly,
295         struct MLoop **r_mloop, struct MPoly **r_mpoly);
296
297 /* flush flags */
298 void BKE_mesh_flush_hidden_from_verts_ex(
299         const struct MVert *mvert,
300         const struct MLoop *mloop,
301         struct MEdge *medge, const int totedge,
302         struct MPoly *mpoly, const int totpoly);
303 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
304 void BKE_mesh_flush_hidden_from_polys_ex(
305         struct MVert *mvert,
306         const struct MLoop *mloop,
307         struct MEdge *medge, const int totedge,
308         const struct MPoly *mpoly, const int totpoly);
309 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
310 void BKE_mesh_flush_select_from_polys_ex(
311         struct MVert *mvert,       const int totvert,
312         const struct MLoop *mloop,
313         struct MEdge *medge,       const int totedge,
314         const struct MPoly *mpoly, const int totpoly);
315 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
316 void BKE_mesh_flush_select_from_verts_ex(
317         const struct MVert *mvert, const int totvert,
318         const struct MLoop *mloop,
319         struct MEdge *medge,       const int totedge,
320         struct MPoly *mpoly,       const int totpoly);
321 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
322
323 /* spatial evaluation */
324 void BKE_mesh_calc_relative_deform(
325         const struct MPoly *mpoly, const int totpoly,
326         const struct MLoop *mloop, const int totvert,
327
328         const float (*vert_cos_src)[3],
329         const float (*vert_cos_dst)[3],
330
331         const float (*vert_cos_org)[3],
332               float (*vert_cos_new)[3]);
333
334
335
336 /* *** mesh_validate.c *** */
337
338 int BKE_mesh_validate(struct Mesh *me, const int do_verbose, const int cddata_check_mask);
339 void BKE_mesh_cd_validate(struct Mesh *me);
340 int BKE_mesh_validate_material_indices(struct Mesh *me);
341
342 bool BKE_mesh_validate_arrays(
343         struct Mesh *me,
344         struct MVert *mverts, unsigned int totvert,
345         struct MEdge *medges, unsigned int totedge,
346         struct MFace *mfaces, unsigned int totface,
347         struct MLoop *mloops, unsigned int totloop,
348         struct MPoly *mpolys, unsigned int totpoly,
349         struct MDeformVert *dverts, /* assume totvert length */
350         const bool do_verbose, const bool do_fixes,
351         bool *r_change);
352
353 bool BKE_mesh_validate_all_customdata(
354         struct CustomData *vdata, struct CustomData *edata,
355         struct CustomData *ldata, struct CustomData *pdata,
356         const bool check_meshmask,
357         const bool do_verbose, const bool do_fixes,
358         bool *r_change);
359
360 void BKE_mesh_strip_loose_faces(struct Mesh *me);
361 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
362 void BKE_mesh_strip_loose_edges(struct Mesh *me);
363
364 void BKE_mesh_calc_edges_legacy(struct Mesh *me, const bool use_old);
365 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
366
367 #ifdef __cplusplus
368 }
369 #endif
370
371 #endif /* __BKE_MESH_H__ */