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