Cycles / HSV Separator and Combine node:
[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 /***/
35
36 struct ID;
37 struct BoundBox;
38 struct DispList;
39 struct EdgeHash;
40 struct ListBase;
41 struct BMEditMesh;
42 struct BMesh;
43 struct Main;
44 struct Mesh;
45 struct MPoly;
46 struct MLoop;
47 struct MFace;
48 struct MEdge;
49 struct MVert;
50 struct MDeformVert;
51 struct MCol;
52 struct Object;
53 struct MTFace;
54 struct VecNor;
55 struct CustomData;
56 struct DerivedMesh;
57 struct Scene;
58 struct MLoopUV;
59 struct UvVertMap;
60 struct UvMapVert;
61 struct UvElementMap;
62 struct UvElement;
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66
67 struct BMesh *BKE_mesh_to_bmesh(struct Mesh *me, struct Object *ob);
68
69 /*
70  * this function recreates a tessellation.
71  * returns number of tessellation faces.
72  *
73  * use_poly_origindex sets whether or not the tessellation faces' origindex
74  * layer should point to original poly indices or real poly indices.
75  *
76  * use_face_origindex sets the tessellation faces' origindex layer
77  * to point to the tessellation faces themselves, not the polys.
78  *
79  * if both of the above are 0, it'll use the indices of the mpolys of the MPoly
80  * data in pdata, and ignore the origindex layer altogether.
81  */
82 int BKE_mesh_recalc_tessellation(struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
83                                  struct MVert *mvert,
84                                  int totface, int totloop, int totpoly,
85                                  const bool do_face_normals);
86
87 /* for forwards compat only quad->tri polys to mface, skip ngons.
88  */
89 int BKE_mesh_mpoly_to_mface(struct CustomData *fdata, struct CustomData *ldata,
90                             struct CustomData *pdata, int totface, int totloop, int totpoly);
91
92 /*calculates a face normal.*/
93 void BKE_mesh_calc_poly_normal(struct MPoly *mpoly, struct MLoop *loopstart,
94                                struct MVert *mvarray, float no[3]);
95
96 void BKE_mesh_calc_poly_normal_coords(struct MPoly *mpoly, struct MLoop *loopstart,
97                                       const float (*vertex_coords)[3], float no[3]);
98
99 void BKE_mesh_calc_poly_center(struct MPoly *mpoly, struct MLoop *loopstart,
100                                struct MVert *mvarray, float cent[3]);
101
102 float BKE_mesh_calc_poly_area(struct MPoly *mpoly, struct MLoop *loopstart,
103                               struct MVert *mvarray, const float polynormal[3]);
104
105 void BKE_mesh_calc_poly_angles(struct MPoly *mpoly, struct MLoop *loopstart,
106                                struct MVert *mvarray, float angles[]);
107
108 int *BKE_mesh_calc_smoothgroups(const struct MEdge *medge, const int totedge,
109                                 const struct MPoly *mpoly, const int totpoly,
110                                 const struct MLoop *mloop, const int totloop,
111                                 int *r_totgroup);
112
113 void BKE_mesh_calc_relative_deform(
114         const struct MPoly *mpoly, const int totpoly,
115         const struct MLoop *mloop, const int totvert,
116
117         const float (*vert_cos_src)[3],
118         const float (*vert_cos_dst)[3],
119
120         const float (*vert_cos_org)[3],
121               float (*vert_cos_new)[3]);
122
123 /* Find the index of the loop in 'poly' which references vertex,
124  * returns -1 if not found */
125 int poly_find_loop_from_vert(const struct MPoly *poly,
126                              const struct MLoop *loopstart,
127                              unsigned vert);
128
129 /* Fill 'adj_r' with the loop indices in 'poly' adjacent to the
130  * vertex. Returns the index of the loop matching vertex, or -1 if the
131  * vertex is not in 'poly' */
132 int poly_get_adj_loops_from_vert(unsigned adj_r[3], const struct MPoly *poly,
133                                  const struct MLoop *mloop, unsigned vert);
134
135 /* Return the index of the edge vert that is not equal to 'v'. If
136  * neither edge vertex is equal to 'v', returns -1. */
137 int BKE_mesh_edge_other_vert(const struct MEdge *e, int v);
138
139 /* update the hide flag for edges and polys from the corresponding
140  * flag in verts */
141 void BKE_mesh_flush_hidden_from_verts_ex(const struct MVert *mvert,
142                                          const struct MLoop *mloop,
143                                          struct MEdge *medge, const int totedge,
144                                          struct MPoly *mpoly, const int totpoly);
145 void BKE_mesh_flush_hidden_from_verts(struct Mesh *me);
146
147 void BKE_mesh_flush_hidden_from_polys_ex(struct MVert *mvert,
148                                          const struct MLoop *mloop,
149                                          struct MEdge *medge, const int totedge,
150                                          const struct MPoly *mpoly, const int totpoly);
151 void BKE_mesh_flush_hidden_from_polys(struct Mesh *me);
152
153
154 void BKE_mesh_flush_select_from_polys_ex(struct MVert *mvert,       const int totvert,
155                                          const struct MLoop *mloop,
156                                          struct MEdge *medge,       const int totedge,
157                                          const struct MPoly *mpoly, const int totpoly);
158 void BKE_mesh_flush_select_from_polys(struct Mesh *me);
159 void BKE_mesh_flush_select_from_verts_ex(const struct MVert *mvert, const int totvert,
160                                          const struct MLoop *mloop,
161                                          struct MEdge *medge,       const int totedge,
162                                          struct MPoly *mpoly,       const int totpoly);
163 void BKE_mesh_flush_select_from_verts(struct Mesh *me);
164
165 void BKE_mesh_unlink(struct Mesh *me);
166 void BKE_mesh_free(struct Mesh *me, int unlink);
167 struct Mesh *BKE_mesh_add(struct Main *bmain, const char *name);
168 struct Mesh *BKE_mesh_copy_ex(struct Main *bmain, struct Mesh *me);
169 struct Mesh *BKE_mesh_copy(struct Mesh *me);
170 void BKE_mesh_update_customdata_pointers(struct Mesh *me, const bool do_ensure_tess_cd);
171
172 void BKE_mesh_make_local(struct Mesh *me);
173 void BKE_mesh_boundbox_calc(struct Mesh *me, float r_loc[3], float r_size[3]);
174 void BKE_mesh_texspace_calc(struct Mesh *me);
175 float (*BKE_mesh_orco_verts_get(struct Object *ob))[3];
176 void   BKE_mesh_orco_verts_transform(struct Mesh *me, float (*orco)[3], int totvert, int invert);
177 int test_index_face(struct MFace *mface, struct CustomData *mfdata, int mfindex, int nr);
178 struct Mesh *BKE_mesh_from_object(struct Object *ob);
179 void BKE_mesh_assign_object(struct Object *ob, struct Mesh *me);
180 void BKE_mesh_from_metaball(struct ListBase *lb, struct Mesh *me);
181 int  BKE_mesh_nurbs_to_mdata(struct Object *ob, struct MVert **allvert, int *totvert,
182                              struct MEdge **alledge, int *totedge, struct MLoop **allloop, struct MPoly **allpoly,
183                              int *totloop, int *totpoly);
184 int BKE_mesh_nurbs_displist_to_mdata(struct Object *ob, struct ListBase *dispbase, struct MVert **allvert, int *_totvert,
185                                      struct MEdge **alledge, int *_totedge, struct MLoop **allloop, struct MPoly **allpoly,
186                                      struct MLoopUV **alluv, int *_totloop, int *_totpoly);
187 void BKE_mesh_from_nurbs_displist(struct Object *ob, struct ListBase *dispbase, const bool use_orco_uv);
188 void BKE_mesh_from_nurbs(struct Object *ob);
189 void BKE_mesh_to_curve_nurblist(struct DerivedMesh *dm, struct ListBase *nurblist, const int edge_users_test);
190 void BKE_mesh_to_curve(struct Scene *scene, struct Object *ob);
191 void BKE_mesh_delete_material_index(struct Mesh *me, short index);
192 void BKE_mesh_smooth_flag_set(struct Object *meshOb, int enableSmooth);
193 void BKE_mesh_convert_mfaces_to_mpolys(struct Mesh *mesh);
194 void BKE_mesh_do_versions_convert_mfaces_to_mpolys(struct Mesh *mesh);
195 void BKE_mesh_convert_mfaces_to_mpolys_ex(struct ID *id,
196                                           struct CustomData *fdata, struct CustomData *ldata, struct CustomData *pdata,
197                                           int totedge_i, int totface_i, int totloop_i, int totpoly_i,
198                                           struct MEdge *medge, struct MFace *mface,
199                                           int *totloop_r, int *totpoly_r,
200                                           struct MLoop **mloop_r, struct MPoly **mpoly_r);
201
202 void BKE_mesh_calc_normals_tessface(struct MVert *mverts, int numVerts, struct MFace *mfaces, int numFaces, float (*faceNors_r)[3]);
203
204 /* used for unit testing; compares two meshes, checking only
205  * differences we care about.  should be usable with leaf's
206  * testing framework I get RNA work done, will use hackish
207  * testing code for now.*/
208 const char *BKE_mesh_cmp(struct Mesh *me1, struct Mesh *me2, float thresh);
209
210 struct BoundBox *BKE_mesh_boundbox_get(struct Object *ob);
211 void BKE_mesh_texspace_get(struct Mesh *me, float r_loc[3], float r_rot[3], float r_size[3]);
212 void BKE_mesh_texspace_copy_from_object(struct Mesh *me, struct Object *ob);
213
214 /* if old, it converts mface->edcode to edge drawflags */
215 void BKE_mesh_make_edges(struct Mesh *me, const bool use_old);
216
217 void BKE_mesh_strip_loose_faces(struct Mesh *me); /* Needed for compatibility (some old read code). */
218 void BKE_mesh_strip_loose_polysloops(struct Mesh *me);
219 void BKE_mesh_strip_loose_edges(struct Mesh *me);
220
221 /* Calculate vertex and face normals, face normals are returned in *faceNors_r if non-NULL
222  * and vertex normals are stored in actual mverts.
223  */
224 void BKE_mesh_calc_normals_mapping(
225         struct MVert *mverts, int numVerts,
226         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*polyNors_r)[3],
227         struct MFace *mfaces, int numFaces, int *origIndexFace, float (*faceNors_r)[3]);
228 /* extended version of 'BKE_mesh_calc_normals_poly' with option not to calc vertex normals */
229 void BKE_mesh_calc_normals_mapping_ex(
230         struct MVert *mverts, int numVerts,
231         struct MLoop *mloop, struct MPoly *mpolys, int numLoops, int numPolys, float (*polyNors_r)[3],
232         struct MFace *mfaces, int numFaces, int *origIndexFace, float (*faceNors_r)[3],
233         const bool only_face_normals);
234
235 void BKE_mesh_calc_normals_poly(
236         struct MVert *mverts, int numVerts,
237         struct MLoop *mloop, struct MPoly *mpolys,
238         int numLoops, int numPolys, float (*polyNors_r)[3],
239         const bool only_face_normals);
240
241 void BKE_mesh_calc_normals(struct Mesh *me);
242
243 /* Return a newly MEM_malloc'd array of all the mesh vertex locations
244  * (_numVerts_r_ may be NULL) */
245 float (*BKE_mesh_vertexCos_get(struct Mesh *me, int *r_numVerts))[3];
246
247 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
248
249 /* UvVertMap */
250
251 #define STD_UV_CONNECT_LIMIT  0.0001f
252
253 typedef struct UvVertMap {
254         struct UvMapVert **vert;
255         struct UvMapVert *buf;
256 } UvVertMap;
257
258 typedef struct UvMapVert {
259         struct UvMapVert *next;
260         unsigned int f;
261         unsigned char tfindex, separate, flag;
262 } UvMapVert;
263
264 /* UvElement stores per uv information so that we can quickly access information for a uv.
265  * it is actually an improved UvMapVert, including an island and a direct pointer to the face
266  * to avoid initializing face arrays */
267 typedef struct UvElement {
268         /* Next UvElement corresponding to same vertex */
269         struct UvElement *next;
270         /* Face the element belongs to */
271         struct BMLoop *l;
272         /* index in loop. */
273         unsigned short tfindex;
274         /* Whether this element is the first of coincident elements */
275         unsigned char separate;
276         /* general use flag */
277         unsigned char flag;
278         /* If generating element map with island sorting, this stores the island index */
279         unsigned short island;
280 } UvElement;
281
282
283 /* UvElementMap is a container for UvElements of a mesh. It stores some UvElements belonging to the
284  * same uv island in sequence and the number of uvs per island so it is possible to access all uvs
285  * belonging to an island directly by iterating through the buffer.
286  */
287 typedef struct UvElementMap {
288         /* address UvElements by their vertex */
289         struct UvElement **vert;
290         /* UvElement Store */
291         struct UvElement *buf;
292         /* Total number of UVs in the layer. Useful to know */
293         int totalUVs;
294         /* Number of Islands in the mesh */
295         int totalIslands;
296         /* Stores the starting index in buf where each island begins */
297         int *islandIndices;
298 } UvElementMap;
299
300 /* invalid island index is max short. If any one has the patience
301  * to make that many islands, he can bite me :p */
302 #define INVALID_ISLAND 0xFFFF
303
304 UvVertMap *BKE_mesh_uv_vert_map_create(struct MPoly *mpoly, struct MLoop *mloop, struct MLoopUV *mloopuv,
305                                      unsigned int totpoly, unsigned int totvert, int selected, float *limit);
306 UvMapVert *BKE_mesh_uv_vert_map_get_vert(UvVertMap *vmap, unsigned int v);
307 void       BKE_mesh_uv_vert_map_free(UvVertMap *vmap);
308
309 /* Connectivity data */
310 typedef struct MeshElemMap {
311         int *indices;
312         int count;
313 } MeshElemMap;
314         
315 typedef struct IndexNode {
316         struct IndexNode *next, *prev;
317         int index;
318 } IndexNode;
319
320 void BKE_mesh_vert_poly_map_create(MeshElemMap **r_map, int **r_mem,
321                                    const struct MPoly *mface, const struct MLoop *mloop,
322                                    int totvert, int totface, int totloop);
323
324 void BKE_mesh_vert_edge_map_create(MeshElemMap **r_map, int **r_mem,
325                                    const struct MEdge *medge, int totvert, int totedge);
326
327 void BKE_mesh_edge_poly_map_create(MeshElemMap **r_map, int **r_mem,
328                                    const struct MEdge *medge, const int totedge,
329                                    const struct MPoly *mpoly, const int totpoly,
330                                    const struct MLoop *mloop, const int totloop);
331
332 /* vertex level transformations & checks (no derived mesh) */
333
334 int BKE_mesh_minmax(struct Mesh *me, float r_min[3], float r_max[3]);
335 int BKE_mesh_center_median(struct Mesh *me, float cent[3]);
336 int BKE_mesh_center_bounds(struct Mesh *me, float cent[3]);
337 int BKE_mesh_center_centroid(struct Mesh *me, float cent[3]);
338 void BKE_mesh_translate(struct Mesh *me, const float offset[3], const bool do_keys);
339
340 /* mesh_validate.c */
341 /* XXX Loop v/e are unsigned, so using max uint_32 value as invalid marker... */
342 #define INVALID_LOOP_EDGE_MARKER 4294967295u
343 int BKE_mesh_validate_arrays(
344         struct Mesh *me,
345         struct MVert *mverts, unsigned int totvert,
346         struct MEdge *medges, unsigned int totedge,
347         struct MFace *mfaces, unsigned int totface,
348         struct MLoop *mloops, unsigned int totloop,
349         struct MPoly *mpolys, unsigned int totpoly,
350         struct MDeformVert *dverts, /* assume totvert length */
351         const bool do_verbose, const bool do_fixes);
352 int BKE_mesh_validate(struct Mesh *me, const int do_verbose);
353 int BKE_mesh_validate_dm(struct DerivedMesh *dm);
354
355 void BKE_mesh_calc_edges(struct Mesh *mesh, bool update, const bool select);
356
357 void BKE_mesh_ensure_navmesh(struct Mesh *me);
358
359 void BKE_mesh_tessface_calc(struct Mesh *mesh);
360 void BKE_mesh_tessface_ensure(struct Mesh *mesh);
361 void BKE_mesh_tessface_clear(struct Mesh *mesh);
362
363 /* Convert a triangle or quadrangle of loop/poly data to tessface data */
364 void BKE_mesh_loops_to_mface_corners(struct CustomData *fdata, struct CustomData *ldata,
365                                      struct CustomData *pdata, int lindex[4], int findex,
366                                      const int polyindex, const int mf_len,
367                                      const int numTex, const int numCol, const int hasPCol, const int hasOrigSpace);
368
369 void BKE_mesh_poly_edgehash_insert(struct EdgeHash *ehash, const struct MPoly *mp, const struct MLoop *mloop);
370 void BKE_mesh_poly_edgebitmap_insert(unsigned int *edge_bitmap, const struct MPoly *mp, const struct MLoop *mloop);
371
372 void BKE_mesh_do_versions_cd_flag_init(struct Mesh *mesh);
373
374
375 void BKE_mesh_mselect_clear(struct Mesh *me);
376 void BKE_mesh_mselect_validate(struct Mesh *me);
377 int  BKE_mesh_mselect_find(struct Mesh *me, int index, int type);
378 int  BKE_mesh_mselect_active_get(struct Mesh *me, int type);
379 void BKE_mesh_mselect_active_set(struct Mesh *me, int index, int type);
380
381 #ifdef __cplusplus
382 }
383 #endif
384
385 #endif /* __BKE_MESH_H__ */