Merged changes in the trunk up to revision 43404.
[blender-staging.git] / source / blender / makesdna / DNA_meshdata_types.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): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_meshdata_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef DNA_MESHDATA_TYPES_H
33 #define DNA_MESHDATA_TYPES_H
34
35 #include "DNA_customdata_types.h"
36 #include "DNA_listBase.h"
37
38 struct Bone;
39 struct Image;
40
41 typedef struct MFace {
42         unsigned int v1, v2, v3, v4;
43         short mat_nr;
44         char edcode, flag;      /* we keep edcode, for conversion to edges draw flags in old files */
45 } MFace;
46
47 typedef struct MEdge {
48         unsigned int v1, v2;
49         char crease, bweight;
50         short flag;
51 } MEdge;
52
53 typedef struct MDeformWeight {
54         int                             def_nr;
55         float                   weight;
56 } MDeformWeight;
57
58 typedef struct MDeformVert {
59         struct MDeformWeight *dw;
60         int totweight;
61         int flag;       /* flag only in use for weightpaint now */
62 } MDeformVert;
63
64 typedef struct MVert {
65         float   co[3];
66         short   no[3];
67         char flag, bweight;
68 } MVert;
69
70 /* at the moment alpha is abused for vertex painting
71  * and not used for transperency, note that red and blue are swapped */
72 typedef struct MCol {
73         char a, r, g, b;        
74 } MCol;
75
76 #ifdef USE_BMESH_FORWARD_COMPAT
77
78 /*new face structure, replaces MFace, which is now
79   only used for storing tesselations.*/
80 typedef struct MPoly {
81         /* offset into loop array and number of loops in the face */
82         int loopstart;
83         int totloop; /* keep signed since we need to subtract when getting the previous loop */
84         short mat_nr;
85         char flag, pad;
86 } MPoly;
87
88 /*the e here is because we want to move away from
89   relying on edge hashes.*/
90 typedef struct MLoop {
91         unsigned int v; /*vertex index*/
92         unsigned int e; /*edge index*/
93 } MLoop;
94
95 #endif /* USE_BMESH_FORWARD_COMPAT */
96
97 /*bmesh custom data stuff*/
98 typedef struct MTexPoly {
99         struct Image *tpage;
100         char flag, transp;
101         short mode,tile,unwrap;
102 } MTexPoly;
103
104 typedef struct MLoopUV {
105         float uv[2];
106 } MLoopUV;
107
108 typedef struct MLoopCol {
109         char a, r, g, b;
110 } MLoopCol;
111
112 typedef struct MSticky {
113         float co[2];
114 } MSticky;
115
116 typedef struct MSelect {
117         int index;
118         int type; /* EDITVERT/EDITEDGE/EDITFACE */
119 } MSelect;
120
121 typedef struct MTFace {
122         float uv[4][2];
123         struct Image *tpage;
124         char flag, transp;
125         short mode, tile, unwrap;
126 } MTFace;
127
128 /*Custom Data Properties*/
129 typedef struct MFloatProperty {
130         float   f;
131 } MFloatProperty;
132 typedef struct MIntProperty {
133         int             i;
134 } MIntProperty;
135 typedef struct MStringProperty {
136         char    s[256];
137 } MStringProperty;
138
139 typedef struct OrigSpaceFace {
140         float uv[4][2];
141 } OrigSpaceFace;
142
143 typedef struct MDisps {
144         /* Strange bug in SDNA: if disps pointer comes first, it fails to see totdisp */
145         int totdisp;
146         char pad[4];
147         float (*disps)[3];
148 } MDisps;
149
150 /** Multires structs kept for compatibility with old files **/
151 typedef struct MultiresCol {
152         float a, r, g, b;
153 } MultiresCol;
154 typedef struct MultiresColFace {
155         /* vertex colors */
156         MultiresCol col[4];
157 } MultiresColFace;
158 typedef struct MultiresFace {
159         unsigned int v[4];
160         unsigned int mid;
161         char flag, mat_nr, pad[2];
162 } MultiresFace;
163 typedef struct MultiresEdge {
164         unsigned int v[2];
165         unsigned int mid;
166 } MultiresEdge;
167
168 struct MultiresMapNode;
169 typedef struct MultiresLevel {
170         struct MultiresLevel *next, *prev;
171
172         MultiresFace *faces;
173         MultiresColFace *colfaces;
174         MultiresEdge *edges;
175
176         unsigned int totvert, totface, totedge, pad;
177
178         /* Kept for compatibility with even older files */
179         MVert *verts;
180 } MultiresLevel;
181
182 typedef struct Multires {
183         ListBase levels;
184         MVert *verts;
185
186         unsigned char level_count, current, newlvl, edgelvl, pinlvl, renderlvl;
187         unsigned char use_col, flag;
188
189         /* Special level 1 data that cannot be modified from other levels */
190         CustomData vdata;
191         CustomData fdata;
192         short *edge_flags;
193         char *edge_creases;
194 } Multires;
195
196 /** End Multires **/
197
198 typedef struct MRecast {
199         int             i;
200 } MRecast;
201
202 /* mvert->flag (1=SELECT) */
203 #define ME_SPHERETEST           2
204 #define ME_VERT_TMP_TAG         4
205 #define ME_HIDE                         16
206 #define ME_VERT_MERGED          (1<<6)
207 #define ME_VERT_PBVH_UPDATE     (1<<7)
208
209 /* medge->flag (1=SELECT)*/
210 #define ME_EDGEDRAW                     (1<<1)
211 #define ME_SEAM                         (1<<2)
212 #define ME_FGON                         (1<<3)
213                                                 /* reserve 16 for ME_HIDE */
214 #define ME_EDGERENDER           (1<<5)
215 #define ME_LOOSEEDGE            (1<<7)
216 /* #define ME_SEAM_LAST         (1<<8) */ /* UNUSED */
217 #define ME_SHARP                        (1<<9)    /* only reason this flag remains a 'short' */
218 #define ME_FREESTYLE_EDGE       (1<<10)
219
220 /* puno = vertexnormal (mface) */
221 #define ME_PROJXY               16
222 #define ME_PROJXZ               32
223 #define ME_PROJYZ               64
224
225 /* edcode (mface) */
226 #define ME_V1V2                 1
227 #define ME_V2V3                 2
228 #define ME_V3V1                 4
229 #define ME_V3V4                 4
230 #define ME_V4V1                 8
231
232 /* flag (mface) */
233 #define ME_SMOOTH                       1
234 #define ME_FACE_SEL                     2
235 #define ME_FREESTYLE_FACE       4
236                                                 /* flag ME_HIDE==16 is used here too */ 
237 /* mtface->flag */
238 #define TF_SELECT       1 /* use MFace hide flag (after 2.43), should be able to reuse after 2.44 */
239 #define TF_ACTIVE       2 /* deprecated! */
240 #define TF_SEL1         4
241 #define TF_SEL2         8
242 #define TF_SEL3         16
243 #define TF_SEL4         32
244 #define TF_HIDE         64 /* unused, same as TF_SELECT */
245
246 /* mtface->mode */
247 #define TF_DYNAMIC              1
248 #define TF_ALPHASORT    2
249 #define TF_TEX                  4
250 #define TF_SHAREDVERT   8
251 #define TF_LIGHT                16
252
253 #define TF_CONVERTED 32 /* tface converted to material */
254
255 #define TF_SHAREDCOL    64
256 #define TF_TILES                128             /* deprecated */
257 #define TF_BILLBOARD    256
258 #define TF_TWOSIDE              512
259 #define TF_INVISIBLE    1024
260
261 #define TF_OBCOL                2048
262 #define TF_BILLBOARD2   4096    /* with Z axis constraint */
263 #define TF_SHADOW               8192
264 #define TF_BMFONT               16384
265
266 /* mtface->transp, values 1-4 are used as flags in the GL, WARNING, TF_SUB cant work with this */
267 #define TF_SOLID        0
268 #define TF_ADD          1
269 #define TF_ALPHA        2
270 #define TF_CLIP         4 /* clipmap alpha/binary alpha all or nothing! */
271
272 /* sub is not available in the user interface anymore */
273 #define TF_SUB          3
274
275
276 /* mtface->unwrap */
277 #define TF_DEPRECATED1  1
278 #define TF_DEPRECATED2  2
279 #define TF_DEPRECATED3  4
280 #define TF_DEPRECATED4  8
281 #define TF_PIN1             16
282 #define TF_PIN2             32
283 #define TF_PIN3                 64
284 #define TF_PIN4         128
285
286 #endif