Cleanup: remove redundant, invalid info from headers
[blender.git] / source / blender / blenkernel / BKE_mesh_mapping.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_MESH_MAPPING_H__
20 #define __BKE_MESH_MAPPING_H__
21
22 /** \file BKE_mesh_mapping.h
23  *  \ingroup bke
24  */
25
26 struct MEdge;
27 struct MLoop;
28 struct MLoopTri;
29 struct MLoopUV;
30 struct MPoly;
31 struct MVert;
32
33 /* map from uv vertex to face (for select linked, stitch, uv suburf) */
34
35 /* UvVertMap */
36 #define STD_UV_CONNECT_LIMIT  0.0001f
37
38 typedef struct UvVertMap {
39         struct UvMapVert **vert;
40         struct UvMapVert *buf;
41 } UvVertMap;
42
43 typedef struct UvMapVert {
44         struct UvMapVert *next;
45         unsigned int poly_index;
46         unsigned short loop_of_poly_index;
47         bool separate;
48         /* Zero-ed by map creation, left for use by specific areas. Is not
49          * initialized to anything. */
50         unsigned char flag;
51 } UvMapVert;
52
53 /* UvElement stores per uv information so that we can quickly access information for a uv.
54  * it is actually an improved UvMapVert, including an island and a direct pointer to the face
55  * to avoid initializing face arrays */
56 typedef struct UvElement {
57         /* Next UvElement corresponding to same vertex */
58         struct UvElement *next;
59         /* Face the element belongs to */
60         struct BMLoop *l;
61         /* index in loop. */
62         unsigned short loop_of_poly_index;
63         /* Whether this element is the first of coincident elements */
64         bool separate;
65         /* general use flag */
66         unsigned char flag;
67         /* If generating element map with island sorting, this stores the island index */
68         unsigned int island;
69 } UvElement;
70
71
72 /* UvElementMap is a container for UvElements of a mesh. It stores some UvElements belonging to the
73  * same uv island in sequence and the number of uvs per island so it is possible to access all uvs
74  * belonging to an island directly by iterating through the buffer.
75  */
76 typedef struct UvElementMap {
77         /* address UvElements by their vertex */
78         struct UvElement **vert;
79         /* UvElement Store */
80         struct UvElement *buf;
81         /* Total number of UVs in the layer. Useful to know */
82         int totalUVs;
83         /* Number of Islands in the mesh */
84         int totalIslands;
85         /* Stores the starting index in buf where each island begins */
86         int *islandIndices;
87 } UvElementMap;
88
89 #define INVALID_ISLAND ((unsigned int)-1)
90
91 /* Connectivity data */
92 typedef struct MeshElemMap {
93         int *indices;
94         int count;
95 } MeshElemMap;
96
97 /* mapping */
98 UvVertMap *BKE_mesh_uv_vert_map_create(
99         const struct MPoly *mpoly, const struct MLoop *mloop, const struct MLoopUV *mloopuv,
100         unsigned int totpoly, unsigned int totvert, const float limit[2],
101         const bool selected, const bool use_winding);
102 UvMapVert *BKE_mesh_uv_vert_map_get_vert(UvVertMap *vmap, unsigned int v);
103 void       BKE_mesh_uv_vert_map_free(UvVertMap *vmap);
104
105 void BKE_mesh_vert_poly_map_create(
106         MeshElemMap **r_map, int **r_mem,
107         const struct MPoly *mface, const struct MLoop *mloop,
108         int totvert, int totface, int totloop);
109 void BKE_mesh_vert_loop_map_create(
110         MeshElemMap **r_map, int **r_mem,
111         const struct MPoly *mface, const struct MLoop *mloop,
112         int totvert, int totface, int totloop);
113 void BKE_mesh_vert_looptri_map_create(
114         MeshElemMap **r_map, int **r_mem,
115         const struct MVert *mvert, const int totvert,
116         const struct MLoopTri *mlooptri, const int totlooptri,
117         const struct MLoop *mloop, const int totloop);
118 void BKE_mesh_vert_edge_map_create(
119         MeshElemMap **r_map, int **r_mem,
120         const struct MEdge *medge, int totvert, int totedge);
121 void BKE_mesh_vert_edge_vert_map_create(
122         MeshElemMap **r_map, int **r_mem,
123         const struct MEdge *medge, int totvert, int totedge);
124 void BKE_mesh_edge_loop_map_create(
125         MeshElemMap **r_map, int **r_mem,
126         const struct MEdge *medge, const int totedge,
127         const struct MPoly *mpoly, const int totpoly,
128         const struct MLoop *mloop, const int totloop);
129 void BKE_mesh_edge_poly_map_create(
130         MeshElemMap **r_map, int **r_mem,
131         const struct MEdge *medge, const int totedge,
132         const struct MPoly *mpoly, const int totpoly,
133         const struct MLoop *mloop, const int totloop);
134 void BKE_mesh_origindex_map_create(
135         MeshElemMap **r_map, int **r_mem,
136         const int totorig,
137         const int *final_origindex, const int totfinal);
138 void BKE_mesh_origindex_map_create_looptri(
139         MeshElemMap **r_map, int **r_mem,
140         const struct MPoly *mpoly, const int mpoly_num,
141         const struct MLoopTri *looptri, const int looptri_num);
142
143 /* islands */
144
145 /* Loop islands data helpers. */
146 enum {
147         MISLAND_TYPE_NONE = 0,
148         MISLAND_TYPE_VERT = 1,
149         MISLAND_TYPE_EDGE = 2,
150         MISLAND_TYPE_POLY = 3,
151         MISLAND_TYPE_LOOP = 4,
152 };
153
154 typedef struct MeshIslandStore {
155         short item_type;      /* MISLAND_TYPE_... */
156         short island_type;    /* MISLAND_TYPE_... */
157         short innercut_type;  /* MISLAND_TYPE_... */
158
159         int  items_to_islands_num;
160         int *items_to_islands;  /* map the item to the island index */
161
162         int                  islands_num;
163         size_t               islands_num_alloc;
164         struct MeshElemMap **islands;    /* Array of pointers, one item per island. */
165         struct MeshElemMap **innercuts;  /* Array of pointers, one item per island. */
166
167         struct MemArena *mem;  /* Memory arena, internal use only. */
168 } MeshIslandStore;
169
170 void BKE_mesh_loop_islands_init(
171         MeshIslandStore *island_store,
172         const short item_type, const int item_num, const short island_type, const short innercut_type);
173 void BKE_mesh_loop_islands_clear(MeshIslandStore *island_store);
174 void BKE_mesh_loop_islands_free(MeshIslandStore *island_store);
175 void BKE_mesh_loop_islands_add(
176         MeshIslandStore *islands, const int item_num, int *item_indices,
177         const int num_island_items, int *island_item_indices,
178         const int num_innercut_items, int *innercut_item_indices);
179
180 typedef bool (*MeshRemapIslandsCalc)(
181         struct MVert *verts, const int totvert,
182         struct MEdge *edges, const int totedge,
183         struct MPoly *polys, const int totpoly,
184         struct MLoop *loops, const int totloop,
185         struct MeshIslandStore *r_island_store);
186
187 /* Above vert/UV mapping stuff does not do what we need here, but does things we do not need here.
188  * So better keep them separated for now, I think.
189  */
190 bool BKE_mesh_calc_islands_loop_poly_edgeseam(
191         struct MVert *verts, const int totvert,
192         struct MEdge *edges, const int totedge,
193         struct MPoly *polys, const int totpoly,
194         struct MLoop *loops, const int totloop,
195         MeshIslandStore *r_island_store);
196
197 bool BKE_mesh_calc_islands_loop_poly_uvmap(
198         struct MVert *verts, const int totvert,
199         struct MEdge *edges, const int totedge,
200         struct MPoly *polys, const int totpoly,
201         struct MLoop *loops, const int totloop,
202         const struct MLoopUV *luvs,
203         MeshIslandStore *r_island_store);
204
205 int *BKE_mesh_calc_smoothgroups(
206         const struct MEdge *medge, const int totedge,
207         const struct MPoly *mpoly, const int totpoly,
208         const struct MLoop *mloop, const int totloop,
209         int *r_totgroup, const bool use_bitflags);
210
211 /* No good (portable) way to have exported inlined functions... */
212 #define BKE_MESH_TESSFACE_VINDEX_ORDER(_mf, _v)  (                          \
213     (CHECK_TYPE_INLINE(_mf, MFace *),                                       \
214      CHECK_TYPE_INLINE(&(_v), unsigned int *)),                             \
215     ((_mf->v1 == _v) ? 0 :                                                  \
216      (_mf->v2 == _v) ? 1 :                                                  \
217      (_mf->v3 == _v) ? 2 :                                                  \
218      (_mf->v4 && _mf->v4 == _v) ? 3 : -1)                                   \
219     )
220
221 /* use on looptri vertex values */
222 #define BKE_MESH_TESSTRI_VINDEX_ORDER(_tri, _v)  (                          \
223     (CHECK_TYPE_ANY(_tri, unsigned int *, int *, int[3],                    \
224                           const unsigned int *, const int *, const int[3]), \
225      CHECK_TYPE_ANY(_v, unsigned int, const unsigned int, int, const int)), \
226     (((_tri)[0] == _v) ? 0 :                                                \
227      ((_tri)[1] == _v) ? 1 :                                                \
228      ((_tri)[2] == _v) ? 2 : -1)                                            \
229     )
230
231 #endif  /* __BKE_MESH_MAPPING_H__ */