Cleanup: commas at the end of enums
[blender.git] / source / blender / makesdna / DNA_customdata_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_customdata_types.h
29  *  \ingroup DNA
30  *
31  * Used for custom mesh data types (stored per vert/edge/loop/face)
32  */
33
34 #ifndef __DNA_CUSTOMDATA_TYPES_H__
35 #define __DNA_CUSTOMDATA_TYPES_H__
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /** descriptor and storage for a custom data layer */
42 typedef struct CustomDataLayer {
43         /** Type of data in layer. */
44         int type;
45         /** In editmode, offset of layer in block. */
46         int offset;
47         /** General purpose flag. */
48         int flag;
49         /** Number of the active layer of this type. */
50         int active;
51         /** Number of the layer to rende.r*/
52         int active_rnd;
53         /** Number of the layer to rende.r*/
54         int active_clone;
55         /** Number of the layer to rende.r*/
56         int active_mask;
57         /** Shape keyblock unique id referenc.e*/
58         int uid;
59         /** Layer name, MAX_CUSTOMDATA_LAYER_NAME. */
60         char name[64];
61         /** Layer data. */
62         void *data;
63 } CustomDataLayer;
64
65 #define MAX_CUSTOMDATA_LAYER_NAME 64
66
67 typedef struct CustomDataExternal {
68         /** FILE_MAX. */
69         char filename[1024];
70 } CustomDataExternal;
71
72 /** structure which stores custom element data associated with mesh elements
73  * (vertices, edges or faces). The custom data is organized into a series of
74  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
75 typedef struct CustomData {
76         /** CustomDataLayers, ordered by type. */
77         CustomDataLayer *layers;
78         /**
79          * runtime only! - maps types to indices of first layer of that type,
80          * MUST be >= CD_NUMTYPES, but we cant use a define here.
81          * Correct size is ensured in CustomData_update_typemap assert().
82          */
83         int typemap[42];
84         int pad_i1;
85         /** Number of layers, size of layers array. */
86         int totlayer, maxlayer;
87         /** In editmode, total size of all data layers. */
88         int totsize;
89         /** (BMesh Only): Memory pool for allocation of blocks. */
90         struct BLI_mempool *pool;
91         /** External file storing customdata layers. */
92         CustomDataExternal *external;
93 } CustomData;
94
95 /* CustomData.type */
96 typedef enum CustomDataType {
97         /* Used by GLSL attributes in the cases when we need a delayed CD type
98          * assignment (in the cases when we don't know in advance which layer
99          * we are addressing).
100          */
101         CD_AUTO_FROM_NAME   = -1,
102
103         CD_MVERT            = 0,
104 #ifdef DNA_DEPRECATED
105         CD_MSTICKY          = 1,  /* DEPRECATED */
106 #endif
107         CD_MDEFORMVERT      = 2,
108         CD_MEDGE            = 3,
109         CD_MFACE            = 4,
110         CD_MTFACE           = 5,
111         CD_MCOL             = 6,
112         CD_ORIGINDEX        = 7,
113         CD_NORMAL           = 8,
114         CD_FACEMAP          = 9, /* exclusive face group, each face can only be part of one */
115         CD_PROP_FLT         = 10,
116         CD_PROP_INT         = 11,
117         CD_PROP_STR         = 12,
118         CD_ORIGSPACE        = 13,  /* for modifier stack face location mapping */
119         CD_ORCO             = 14,
120 /*      CD_MTEXPOLY         = 15, */  /* deprecated */
121         CD_MLOOPUV          = 16,
122         CD_MLOOPCOL         = 17,
123         CD_TANGENT          = 18,
124         CD_MDISPS           = 19,
125         CD_PREVIEW_MCOL     = 20,  /* for displaying weightpaint colors */
126 /*      CD_ID_MCOL          = 21, */
127         CD_TEXTURE_MLOOPCOL = 22,
128         CD_CLOTH_ORCO       = 23,
129         CD_RECAST           = 24,
130
131 /* BMESH ONLY START */
132         CD_MPOLY            = 25,
133         CD_MLOOP            = 26,
134         CD_SHAPE_KEYINDEX   = 27,
135         CD_SHAPEKEY         = 28,
136         CD_BWEIGHT          = 29,
137         CD_CREASE           = 30,
138         CD_ORIGSPACE_MLOOP  = 31,
139         CD_PREVIEW_MLOOPCOL = 32,
140         CD_BM_ELEM_PYPTR    = 33,
141 /* BMESH ONLY END */
142
143         CD_PAINT_MASK       = 34,
144         CD_GRID_PAINT_MASK  = 35,
145         CD_MVERT_SKIN       = 36,
146         CD_FREESTYLE_EDGE   = 37,
147         CD_FREESTYLE_FACE   = 38,
148         CD_MLOOPTANGENT     = 39,
149         CD_TESSLOOPNORMAL   = 40,
150         CD_CUSTOMLOOPNORMAL = 41,
151
152         CD_NUMTYPES         = 42,
153 } CustomDataType;
154
155 /* Bits for CustomDataMask */
156 #define CD_MASK_MVERT           (1 << CD_MVERT)
157 // #define CD_MASK_MSTICKY              (1 << CD_MSTICKY)  /* DEPRECATED */
158 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
159 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
160 #define CD_MASK_MFACE           (1 << CD_MFACE)
161 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
162 #define CD_MASK_MCOL            (1 << CD_MCOL)
163 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
164 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
165 #define CD_MASK_FACEMAP         (1 << CD_FACEMAP)
166 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
167 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
168 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
169 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
170 #define CD_MASK_ORCO            (1 << CD_ORCO)
171 // #define CD_MASK_MTEXPOLY     (1 << CD_MTEXPOLY)  /* DEPRECATED */
172 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
173 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
174 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
175 #define CD_MASK_MDISPS          (1 << CD_MDISPS)
176 #define CD_MASK_PREVIEW_MCOL    (1 << CD_PREVIEW_MCOL)
177 #define CD_MASK_CLOTH_ORCO      (1 << CD_CLOTH_ORCO)
178 #define CD_MASK_RECAST          (1 << CD_RECAST)
179
180 /* BMESH ONLY START */
181 #define CD_MASK_MPOLY           (1 << CD_MPOLY)
182 #define CD_MASK_MLOOP           (1 << CD_MLOOP)
183 #define CD_MASK_SHAPE_KEYINDEX  (1 << CD_SHAPE_KEYINDEX)
184 #define CD_MASK_SHAPEKEY        (1 << CD_SHAPEKEY)
185 #define CD_MASK_BWEIGHT         (1 << CD_BWEIGHT)
186 #define CD_MASK_CREASE          (1 << CD_CREASE)
187 #define CD_MASK_ORIGSPACE_MLOOP (1LL << CD_ORIGSPACE_MLOOP)
188 #define CD_MASK_PREVIEW_MLOOPCOL (1LL << CD_PREVIEW_MLOOPCOL)
189 #define CD_MASK_BM_ELEM_PYPTR (1LL << CD_BM_ELEM_PYPTR)
190 /* BMESH ONLY END */
191
192 #define CD_MASK_PAINT_MASK              (1LL << CD_PAINT_MASK)
193 #define CD_MASK_GRID_PAINT_MASK (1LL << CD_GRID_PAINT_MASK)
194 #define CD_MASK_MVERT_SKIN              (1LL << CD_MVERT_SKIN)
195 #define CD_MASK_FREESTYLE_EDGE  (1LL << CD_FREESTYLE_EDGE)
196 #define CD_MASK_FREESTYLE_FACE  (1LL << CD_FREESTYLE_FACE)
197 #define CD_MASK_MLOOPTANGENT    (1LL << CD_MLOOPTANGENT)
198 #define CD_MASK_TESSLOOPNORMAL  (1LL << CD_TESSLOOPNORMAL)
199 #define CD_MASK_CUSTOMLOOPNORMAL (1LL << CD_CUSTOMLOOPNORMAL)
200
201 /* CustomData.flag */
202 enum {
203         /* Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data */
204         CD_FLAG_NOCOPY    = (1 << 0),
205         /* Indicates layer should not be freed (for layers backed by external data) */
206         CD_FLAG_NOFREE    = (1 << 1),
207         /* Indicates the layer is only temporary, also implies no copy */
208         CD_FLAG_TEMPORARY = ((1 << 2) | CD_FLAG_NOCOPY),
209         /* Indicates the layer is stored in an external file */
210         CD_FLAG_EXTERNAL  = (1 << 3),
211         /* Indicates external data is read into memory */
212         CD_FLAG_IN_MEMORY = (1 << 4),
213 };
214
215 /* Limits */
216 #define MAX_MTFACE  8
217 #define MAX_MCOL    8
218
219 #define DYNTOPO_NODE_NONE -1
220
221 #define CD_TEMP_CHUNK_SIZE 128
222
223 #ifdef __cplusplus
224 }
225 #endif
226
227 #endif  /* __DNA_CUSTOMDATA_TYPES_H__ */