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