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