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