Mesh API: add BKE_mesh_vert_edge_vert_map_create
[blender.git] / source / blender / blenkernel / BKE_mesh_mapping.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_MAPPING_H__
28 #define __BKE_MESH_MAPPING_H__
29
30 /** \file BKE_mesh_mapping.h
31  *  \ingroup bke
32  */
33
34 struct MVert;
35 struct MEdge;
36 struct MPoly;
37 struct MLoop;
38 struct MLoopUV;
39 struct MLoopTri;
40
41 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
42
43 /* UvVertMap */
44 #define STD_UV_CONNECT_LIMIT  0.0001f
45
46 typedef struct UvVertMap {
47         struct UvMapVert **vert;
48         struct UvMapVert *buf;
49 } UvVertMap;
50
51 typedef struct UvMapVert {
52         struct UvMapVert *next;
53         unsigned int f;
54         unsigned char tfindex, separate, flag;
55 } UvMapVert;
56
57 /* UvElement stores per uv information so that we can quickly access information for a uv.
58  * it is actually an improved UvMapVert, including an island and a direct pointer to the face
59  * to avoid initializing face arrays */
60 typedef struct UvElement {
61         /* Next UvElement corresponding to same vertex */
62         struct UvElement *next;
63         /* Face the element belongs to */
64         struct BMLoop *l;
65         /* index in loop. */
66         unsigned short tfindex;
67         /* Whether this element is the first of coincident elements */
68         unsigned char separate;
69         /* general use flag */
70         unsigned char flag;
71         /* If generating element map with island sorting, this stores the island index */
72         unsigned short island;
73 } UvElement;
74
75
76 /* UvElementMap is a container for UvElements of a mesh. It stores some UvElements belonging to the
77  * same uv island in sequence and the number of uvs per island so it is possible to access all uvs
78  * belonging to an island directly by iterating through the buffer.
79  */
80 typedef struct UvElementMap {
81         /* address UvElements by their vertex */
82         struct UvElement **vert;
83         /* UvElement Store */
84         struct UvElement *buf;
85         /* Total number of UVs in the layer. Useful to know */
86         int totalUVs;
87         /* Number of Islands in the mesh */
88         int totalIslands;
89         /* Stores the starting index in buf where each island begins */
90         int *islandIndices;
91 } UvElementMap;
92
93 /* invalid island index is max short. If any one has the patience
94  * to make that many islands, he can bite me :p */
95 #define INVALID_ISLAND 0xFFFF
96
97 /* Connectivity data */
98 typedef struct MeshElemMap {
99         int *indices;
100         int count;
101 } MeshElemMap;
102
103 /* mapping */
104 UvVertMap *BKE_mesh_uv_vert_map_create(
105         struct MPoly *mpoly, struct MLoop *mloop, struct MLoopUV *mloopuv,
106         unsigned int totpoly, unsigned int totvert,
107         const float limit[2], const bool selected, const bool use_winding);
108 UvMapVert *BKE_mesh_uv_vert_map_get_vert(UvVertMap *vmap, unsigned int v);
109 void       BKE_mesh_uv_vert_map_free(UvVertMap *vmap);
110
111 void BKE_mesh_vert_poly_map_create(
112         MeshElemMap **r_map, int **r_mem,
113         const struct MPoly *mface, const struct MLoop *mloop,
114         int totvert, int totface, int totloop);
115 void BKE_mesh_vert_loop_map_create(
116         MeshElemMap **r_map, int **r_mem,
117         const struct MPoly *mface, const struct MLoop *mloop,
118         int totvert, int totface, int totloop);
119 void BKE_mesh_vert_edge_map_create(
120         MeshElemMap **r_map, int **r_mem,
121         const struct MEdge *medge, int totvert, int totedge);
122 void BKE_mesh_vert_edge_vert_map_create(
123         MeshElemMap **r_map, int **r_mem,
124         const struct MEdge *medge, int totvert, int totedge);
125 void BKE_mesh_edge_poly_map_create(
126         MeshElemMap **r_map, int **r_mem,
127         const struct MEdge *medge, const int totedge,
128         const struct MPoly *mpoly, const int totpoly,
129         const struct MLoop *mloop, const int totloop);
130 void BKE_mesh_origindex_map_create(
131         MeshElemMap **r_map, int **r_mem,
132         const int totorig,
133         const int *final_origindex, const int totfinal);
134 void BKE_mesh_origindex_map_create_looptri(
135         MeshElemMap **r_map, int **r_mem,
136         const struct MPoly *mpoly, const int mpoly_num,
137         const struct MLoopTri *looptri, const int looptri_num);
138
139 /* islands */
140
141 /* Loop islands data helpers. */
142 enum {
143         MISLAND_TYPE_NONE = 0,
144         MISLAND_TYPE_VERT = 1,
145         MISLAND_TYPE_EDGE = 2,
146         MISLAND_TYPE_POLY = 3,
147         MISLAND_TYPE_LOOP = 4,
148 };
149
150 typedef struct MeshIslandStore {
151         short item_type;      /* MISLAND_TYPE_... */
152         short island_type;    /* MISLAND_TYPE_... */
153         short innercut_type;  /* MISLAND_TYPE_... */
154
155         int  items_to_islands_num;
156         int *items_to_islands;  /* map the item to the island index */
157
158         int                  islands_num;
159         size_t               islands_num_alloc;
160         struct MeshElemMap **islands;    /* Array of pointers, one item per island. */
161         struct MeshElemMap **innercuts;  /* Array of pointers, one item per island. */
162
163         struct MemArena *mem;  /* Memory arena, internal use only. */
164 } MeshIslandStore;
165
166 void BKE_mesh_loop_islands_init(
167         MeshIslandStore *island_store,
168         const short item_type, const int item_num, const short island_type, const short innercut_type);
169 void BKE_mesh_loop_islands_clear(MeshIslandStore *island_store);
170 void BKE_mesh_loop_islands_free(MeshIslandStore *island_store);
171 void BKE_mesh_loop_islands_add(
172         MeshIslandStore *islands, const int item_num, int *item_indices,
173         const int num_island_items, int *island_item_indices,
174         const int num_innercut_items, int *innercut_item_indices);
175
176 typedef bool (*MeshRemapIslandsCalc)(
177         struct MVert *verts, const int totvert,
178         struct MEdge *edges, const int totedge,
179         struct MPoly *polys, const int totpoly,
180         struct MLoop *loops, const int totloop,
181         struct MeshIslandStore *r_island_store);
182
183 /* Above vert/UV mapping stuff does not do what we need here, but does things we do not need here.
184  * So better keep them separated for now, I think.
185  */
186 bool BKE_mesh_calc_islands_loop_poly_uv(
187         struct MVert *verts, const int totvert,
188         struct MEdge *edges, const int totedge,
189         struct MPoly *polys, const int totpoly,
190         struct MLoop *loops, const int totloop,
191         MeshIslandStore *r_island_store);
192
193 int *BKE_mesh_calc_smoothgroups(
194         const struct MEdge *medge, const int totedge,
195         const struct MPoly *mpoly, const int totpoly,
196         const struct MLoop *mloop, const int totloop,
197         int *r_totgroup, const bool use_bitflags);
198
199 /* No good (portable) way to have exported inlined functions... */
200 #define BKE_MESH_TESSFACE_VINDEX_ORDER(_mf, _v)  (                          \
201     (CHECK_TYPE_INLINE(_mf, MFace *),                                       \
202      CHECK_TYPE_INLINE(&(_v), unsigned int *)),                             \
203     ((_mf->v1 == _v) ? 0 :                                                  \
204      (_mf->v2 == _v) ? 1 :                                                  \
205      (_mf->v3 == _v) ? 2 :                                                  \
206      (_mf->v4 && _mf->v4 == _v) ? 3 : -1)                                   \
207     )
208
209 /* use on looptri vertex values */
210 #define BKE_MESH_TESSTRI_VINDEX_ORDER(_tri, _v)  (                          \
211     (CHECK_TYPE_ANY(_tri, unsigned int *, int *, int[3],                    \
212                           const unsigned int *, const int *, const int[3]), \
213      CHECK_TYPE_ANY(_v, unsigned int, const unsigned int, int, const int)), \
214     (((_tri)[0] == _v) ? 0 :                                                \
215      ((_tri)[1] == _v) ? 1 :                                                \
216      ((_tri)[2] == _v) ? 2 : -1)                                            \
217     )
218
219 #endif  /* __BKE_MESH_MAPPING_H__ */