bmesh py api:
[blender.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 /*tessellation face, see MLoop/MPoly for the real face data*/
42 typedef struct MFace {
43         unsigned int v1, v2, v3, v4;
44         short mat_nr;
45         char edcode, flag;      /* we keep edcode, for conversion to edges draw flags in old files */
46 } MFace;
47
48 typedef struct MEdge {
49         unsigned int v1, v2;
50         char crease, bweight;
51         short flag;
52 } MEdge;
53
54 typedef struct MDeformWeight {
55         int                             def_nr;
56         float                   weight;
57 } MDeformWeight;
58
59 typedef struct MDeformVert {
60         struct MDeformWeight *dw;
61         int totweight;
62         int flag;       /* flag only in use for weightpaint now */
63 } MDeformVert;
64
65 typedef struct MVert {
66         float   co[3];
67         short   no[3];
68         char flag, bweight;
69 } MVert;
70
71 /* tessellation vertex color data.
72  * at the moment alpha is abused for vertex painting
73  * and not used for transparency, note that red and blue are swapped */
74 typedef struct MCol {
75         char a, r, g, b;        
76 } MCol;
77
78 /* new face structure, replaces MFace, which is now
79  * only used for storing tessellations.*/
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 typedef struct MTexPoly {
96         struct Image *tpage;
97         char flag, transp;
98         short mode,tile,unwrap;
99 } MTexPoly;
100
101 /* can copy from/to MTexPoly/MTFace */
102 #define ME_MTEXFACE_CPY(dst, src)   \
103 {                                   \
104         (dst)->tpage  = (src)->tpage;   \
105         (dst)->flag   = (src)->flag;    \
106         (dst)->transp = (src)->transp;  \
107         (dst)->mode   = (src)->mode;    \
108         (dst)->tile   = (src)->tile;    \
109         (dst)->unwrap = (src)->unwrap;  \
110 }
111
112 typedef struct MLoopUV {
113         float uv[2];
114         int flag;
115 } MLoopUV;
116
117 /*mloopuv->flag*/
118 #define MLOOPUV_EDGESEL 1
119 #define MLOOPUV_VERTSEL 2
120 #define MLOOPUV_PINNED  4
121
122 /* at the moment alpha is abused for vertex painting
123  * and not used for transparency, note that red and blue are swapped */
124 typedef struct MLoopCol {
125         char a, r, g, b;
126 } MLoopCol;
127
128 typedef struct MSticky {
129         float co[2];
130 } MSticky;
131
132 typedef struct MSelect {
133         int index;
134         int type; /* EDITVERT/EDITEDGE/EDITFACE */
135 } MSelect;
136
137 /*tessellation uv face data*/
138 typedef struct MTFace {
139         float uv[4][2];
140         struct Image *tpage;
141         char flag, transp;
142         short mode, tile, unwrap;
143 } MTFace;
144
145 /*Custom Data Properties*/
146 typedef struct MFloatProperty {
147         float   f;
148 } MFloatProperty;
149 typedef struct MIntProperty {
150         int             i;
151 } MIntProperty;
152 typedef struct MStringProperty {
153         char    s[256];
154 } MStringProperty;
155
156 typedef struct OrigSpaceFace {
157         float uv[4][2];
158 } OrigSpaceFace;
159
160 typedef struct OrigSpaceLoop {
161         float uv[2];
162 } OrigSpaceLoop;
163
164 typedef struct MDisps {
165         /* Strange bug in SDNA: if disps pointer comes first, it fails to see totdisp */
166         int totdisp;
167         int level;
168         float (*disps)[3];
169         
170         /* Used for hiding parts of a multires mesh. Essentially the multires
171            equivalent of MVert.flag's ME_HIDE bit.
172         
173            This is a bitmap, keep in sync with type used in BLI_bitmap.h */
174         unsigned int *hidden;
175 } MDisps;
176
177 /** Multires structs kept for compatibility with old files **/
178 typedef struct MultiresCol {
179         float a, r, g, b;
180 } MultiresCol;
181 typedef struct MultiresColFace {
182         /* vertex colors */
183         MultiresCol col[4];
184 } MultiresColFace;
185 typedef struct MultiresFace {
186         unsigned int v[4];
187         unsigned int mid;
188         char flag, mat_nr, pad[2];
189 } MultiresFace;
190 typedef struct MultiresEdge {
191         unsigned int v[2];
192         unsigned int mid;
193 } MultiresEdge;
194
195 struct MultiresMapNode;
196 typedef struct MultiresLevel {
197         struct MultiresLevel *next, *prev;
198
199         MultiresFace *faces;
200         MultiresColFace *colfaces;
201         MultiresEdge *edges;
202
203         unsigned int totvert, totface, totedge, pad;
204
205         /* Kept for compatibility with even older files */
206         MVert *verts;
207 } MultiresLevel;
208
209 typedef struct Multires {
210         ListBase levels;
211         MVert *verts;
212
213         unsigned char level_count, current, newlvl, edgelvl, pinlvl, renderlvl;
214         unsigned char use_col, flag;
215
216         /* Special level 1 data that cannot be modified from other levels */
217         CustomData vdata;
218         CustomData fdata;
219         short *edge_flags;
220         char *edge_creases;
221 } Multires;
222
223 /** End Multires **/
224
225 typedef struct MRecast {
226         int             i;
227 } MRecast;
228
229 /* mvert->flag (1=SELECT) */
230 #define ME_SPHERETEST           2
231 #define ME_VERT_TMP_TAG         4
232 #define ME_HIDE                         16
233 #define ME_VERT_MERGED          (1<<6)
234 #define ME_VERT_PBVH_UPDATE     (1<<7)
235
236 /* medge->flag (1=SELECT)*/
237 #define ME_EDGEDRAW                     (1<<1)
238 #define ME_SEAM                         (1<<2)
239 #define ME_FGON                         (1<<3)
240                                                 /* reserve 16 for ME_HIDE */
241 #define ME_EDGERENDER           (1<<5)
242 #define ME_LOOSEEDGE            (1<<7)
243 /* #define ME_SEAM_LAST         (1<<8) */ /* UNUSED */
244 #define ME_SHARP                        (1<<9)    /* only reason this flag remains a 'short' */
245
246 /* puno = vertexnormal (mface) */
247 #define ME_PROJXY               16
248 #define ME_PROJXZ               32
249 #define ME_PROJYZ               64
250
251 /* edcode (mface) */
252 #define ME_V1V2                 1
253 #define ME_V2V3                 2
254 #define ME_V3V1                 4
255 #define ME_V3V4                 4
256 #define ME_V4V1                 8
257
258 /* flag (mface) */
259 #define ME_SMOOTH                       1
260 #define ME_FACE_SEL                     2
261 /* flag ME_HIDE==16 is used here too */ 
262
263 #define ME_POLY_LOOP_PREV(mloop, mp, i)  (&(mloop)[(mp)->loopstart + (((i) + (mp)->totloop - 1) % (mp)->totloop)])
264 #define ME_POLY_LOOP_NEXT(mloop, mp, i)  (&(mloop)[(mp)->loopstart + (((i) + 1) % (mp)->totloop)])
265
266 /* mselect->type */
267 #define ME_VSEL 0
268 #define ME_ESEL 1
269 #define ME_FSEL 2
270
271 /* mtface->flag */
272 #define TF_SELECT       1 /* use MFace hide flag (after 2.43), should be able to reuse after 2.44 */
273 #define TF_ACTIVE       2 /* deprecated! */
274 #define TF_SEL1         4
275 #define TF_SEL2         8
276 #define TF_SEL3         16
277 #define TF_SEL4         32
278 #define TF_HIDE         64 /* unused, same as TF_SELECT */
279
280 /* mtface->mode */
281 #define TF_DYNAMIC              1
282 #define TF_ALPHASORT    2
283 #define TF_TEX                  4
284 #define TF_SHAREDVERT   8
285 #define TF_LIGHT                16
286
287 #define TF_CONVERTED 32 /* tface converted to material */
288
289 #define TF_SHAREDCOL    64
290 #define TF_TILES                128             /* deprecated */
291 #define TF_BILLBOARD    256
292 #define TF_TWOSIDE              512
293 #define TF_INVISIBLE    1024
294
295 #define TF_OBCOL                2048
296 #define TF_BILLBOARD2   4096    /* with Z axis constraint */
297 #define TF_SHADOW               8192
298 #define TF_BMFONT               16384
299
300 /* mtface->transp, values 1-4 are used as flags in the GL, WARNING, TF_SUB cant work with this */
301 #define TF_SOLID        0
302 #define TF_ADD          1
303 #define TF_ALPHA        2
304 #define TF_CLIP         4 /* clipmap alpha/binary alpha all or nothing! */
305
306 /* sub is not available in the user interface anymore */
307 #define TF_SUB          3
308
309
310 /* mtface->unwrap */
311 #define TF_DEPRECATED1  1
312 #define TF_DEPRECATED2  2
313 #define TF_DEPRECATED3  4
314 #define TF_DEPRECATED4  8
315 #define TF_PIN1             16
316 #define TF_PIN2             32
317 #define TF_PIN3                 64
318 #define TF_PIN4         128
319
320 #endif