own fix r34446, was incorrect, fixed properly now.
[blender.git] / source / blender / makesdna / DNA_customdata_types.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef DNA_CUSTOMDATA_TYPES_H
31 #define DNA_CUSTOMDATA_TYPES_H
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /* descriptor and storage for a custom data layer */
38 typedef struct CustomDataLayer {
39         int type;       /* type of data in layer */
40         int offset;     /* in editmode, offset of layer in block */
41         int flag;       /* general purpose flag */
42         int active;     /* number of the active layer of this type */
43         int active_rnd; /* number of the layer to render*/
44         int active_clone; /* number of the layer to render*/
45         int active_mask; /* number of the layer to render*/
46         char pad[4];
47         char name[32];  /* layer name */
48         void *data;     /* layer data */
49 } CustomDataLayer;
50
51 typedef struct CustomDataExternal {
52         char filename[240]; /* FILE_MAX */
53 } CustomDataExternal;
54
55 /* structure which stores custom element data associated with mesh elements
56  * (vertices, edges or faces). The custom data is organised into a series of
57  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
58 typedef struct CustomData {
59         CustomDataLayer *layers;      /* CustomDataLayers, ordered by type */
60         int totlayer, maxlayer;       /* number of layers, size of layers array */
61         int totsize, pad;             /* in editmode, total size of all data layers */
62         void *pool;                   /* Bmesh: Memory pool for allocation of blocks */
63         CustomDataExternal *external; /* external file storing customdata layers */
64 } CustomData;
65
66 /* CustomData.type */
67 #define CD_MVERT                0
68 #define CD_MSTICKY              1
69 #define CD_MDEFORMVERT  2
70 #define CD_MEDGE                3
71 #define CD_MFACE                4
72 #define CD_MTFACE               5
73 #define CD_MCOL                 6
74 #define CD_ORIGINDEX    7
75 #define CD_NORMAL               8
76 #define CD_FLAGS                9
77 #define CD_PROP_FLT             10
78 #define CD_PROP_INT             11
79 #define CD_PROP_STR             12
80 #define CD_ORIGSPACE    13 /* for modifier stack face location mapping */
81 #define CD_ORCO                 14
82 #define CD_MTEXPOLY             15
83 #define CD_MLOOPUV              16
84 #define CD_MLOOPCOL             17
85 #define CD_TANGENT              18
86 #define CD_MDISPS               19
87 #define CD_WEIGHT_MCOL  20 /* for displaying weightpaint colors */
88 #define CD_ID_MCOL              21
89 #define CD_TEXTURE_MCOL 22
90 #define CD_CLOTH_ORCO   23
91 #define CD_NUMTYPES             24
92
93 /* Bits for CustomDataMask */
94 #define CD_MASK_MVERT           (1 << CD_MVERT)
95 #define CD_MASK_MSTICKY         (1 << CD_MSTICKY)
96 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
97 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
98 #define CD_MASK_MFACE           (1 << CD_MFACE)
99 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
100 #define CD_MASK_MCOL            (1 << CD_MCOL)
101 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
102 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
103 #define CD_MASK_FLAGS           (1 << CD_FLAGS)
104 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
105 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
106 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
107 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
108 #define CD_MASK_ORCO            (1 << CD_ORCO)
109 #define CD_MASK_MTEXPOLY        (1 << CD_MTEXPOLY)
110 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
111 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
112 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
113 #define CD_MASK_MDISPS          (1 << CD_MDISPS)
114 #define CD_MASK_WEIGHT_MCOL     (1 << CD_WEIGHT_MCOL)
115 #define CD_MASK_CLOTH_ORCO      (1 << CD_CLOTH_ORCO)
116
117 /* CustomData.flag */
118
119 /* indicates layer should not be copied by CustomData_from_template or
120  * CustomData_copy_data */
121 #define CD_FLAG_NOCOPY    (1<<0)
122 /* indicates layer should not be freed (for layers backed by external data) */
123 #define CD_FLAG_NOFREE    (1<<1)
124 /* indicates the layer is only temporary, also implies no copy */
125 #define CD_FLAG_TEMPORARY ((1<<2)|CD_FLAG_NOCOPY)
126 /* indicates the layer is stored in an external file */
127 #define CD_FLAG_EXTERNAL  (1<<3)
128 /* indicates external data is read into memory */
129 #define CD_FLAG_IN_MEMORY (1<<4)
130
131 /* Limits */
132 #define MAX_MTFACE 8
133 #define MAX_MCOL   8
134
135 #ifdef __cplusplus
136 }
137 #endif
138
139 #endif