svn merge ^/trunk/blender -r41226:41227 .
[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
32 #ifndef DNA_CUSTOMDATA_TYPES_H
33 #define DNA_CUSTOMDATA_TYPES_H
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /** descriptor and storage for a custom data layer */
40 typedef struct CustomDataLayer {
41         int type;       /* type of data in layer */
42         int offset;     /* in editmode, offset of layer in block */
43         int flag;       /* general purpose flag */
44         int active;     /* number of the active layer of this type */
45         int active_rnd; /* number of the layer to render*/
46         int active_clone; /* number of the layer to render*/
47         int active_mask; /* number of the layer to render*/
48         int uid; /*shape keyblock unique id reference*/
49         char name[32];  /* layer name */
50         void *data;     /* layer data */
51 } CustomDataLayer;
52
53 typedef struct CustomDataExternal {
54         char filename[240]; /* FILE_MAX */
55 } CustomDataExternal;
56
57 /** structure which stores custom element data associated with mesh elements
58  * (vertices, edges or faces). The custom data is organised into a series of
59  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
60 typedef struct CustomData {
61         CustomDataLayer *layers;      /* CustomDataLayers, ordered by type */
62         int typemap[100];             /* maps types to indices of first layer of that type */
63         int totlayer, maxlayer;       /* number of layers, size of layers array */
64         int totsize, pad;             /* in editmode, total size of all data layers */
65         void *pool;                   /* Bmesh: Memory pool for allocation of blocks */
66         CustomDataExternal *external; /* external file storing customdata layers */
67 } CustomData;
68
69 /* CustomData.type */
70 #define CD_MVERT                0
71 #define CD_MSTICKY              1
72 #define CD_MDEFORMVERT  2
73 #define CD_MEDGE                3
74 #define CD_MFACE                4
75 #define CD_MTFACE               5
76 #define CD_MCOL                 6
77 #define CD_ORIGINDEX    7
78 #define CD_NORMAL               8
79 #define CD_FLAGS                9
80 #define CD_PROP_FLT             10
81 #define CD_PROP_INT             11
82 #define CD_PROP_STR             12
83 #define CD_ORIGSPACE    13 /* for modifier stack face location mapping */
84 #define CD_ORCO                 14
85 #define CD_MTEXPOLY             15
86 #define CD_MLOOPUV              16
87 #define CD_MLOOPCOL             17
88 #define CD_TANGENT              18
89 #define CD_MDISPS               19
90 #define CD_WEIGHT_MCOL  20 /* for displaying weightpaint colors */
91 #define CD_MPOLY                21
92 #define CD_MLOOP                22
93 #define CD_CLOTH_ORCO   23
94 #define CD_ID_MCOL              24
95 #define CD_TEXTURE_MCOL         25
96 #define CD_SHAPE_KEYINDEX       26
97 #define CD_SHAPEKEY             27
98 #define CD_BWEIGHT              28
99 #define CD_CREASE               29
100 #define CD_WEIGHT_MLOOPCOL      30
101 #define CD_RECAST               31
102 #define CD_NUMTYPES             32
103
104 /* Bits for CustomDataMask */
105 #define CD_MASK_MVERT           (1 << CD_MVERT)
106 #define CD_MASK_MSTICKY         (1 << CD_MSTICKY)
107 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
108 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
109 #define CD_MASK_MFACE           (1 << CD_MFACE)
110 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
111 #define CD_MASK_MCOL            (1 << CD_MCOL)
112 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
113 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
114 #define CD_MASK_FLAGS           (1 << CD_FLAGS)
115 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
116 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
117 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
118 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
119 #define CD_MASK_ORCO            (1 << CD_ORCO)
120 #define CD_MASK_MTEXPOLY        (1 << CD_MTEXPOLY)
121 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
122 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
123 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
124 #define CD_MASK_MDISPS          (1 << CD_MDISPS)
125 #define CD_MASK_WEIGHT_MCOL     (1 << CD_WEIGHT_MCOL)
126 #define CD_MASK_MPOLY           (1 << CD_MPOLY)
127 #define CD_MASK_MLOOP           (1 << CD_MLOOP)
128 #define CD_MASK_WEIGHT_MLOOPCOL (1 << CD_WEIGHT_MLOOPCOL)
129 #define CD_MASK_SHAPE_KEYINDEX  (1 << CD_SHAPE_KEYINDEX)
130 #define CD_MASK_SHAPEKEY        (1 << CD_SHAPEKEY)
131 #define CD_MASK_CLOTH_ORCO      (1 << CD_CLOTH_ORCO)
132 #define CD_MASK_RECAST          (1 << CD_RECAST)
133
134 /* derivedmesh wants CustomDataMask for weightpaint too, is not customdata though */
135 #define CD_MASK_WEIGHTPAINT     (1 << CD_WEIGHTPAINT)
136 #define CD_MASK_BWEIGHT         (1 << CD_BWEIGHT)
137 #define CD_MASK_CREASE          (1 << CD_CREASE)
138
139 /* CustomData.flag */
140
141 /* indicates layer should not be copied by CustomData_from_template or
142  * CustomData_copy_data */
143 #define CD_FLAG_NOCOPY    (1<<0)
144 /* indicates layer should not be freed (for layers backed by external data) */
145 #define CD_FLAG_NOFREE    (1<<1)
146 /* indicates the layer is only temporary, also implies no copy */
147 #define CD_FLAG_TEMPORARY ((1<<2)|CD_FLAG_NOCOPY)
148 /* indicates the layer is stored in an external file */
149 #define CD_FLAG_EXTERNAL  (1<<3)
150 /* indicates external data is read into memory */
151 #define CD_FLAG_IN_MEMORY (1<<4)
152
153 /* Limits */
154 #define MAX_MTFACE 8
155 #define MAX_MCOL   8
156
157 #ifdef __cplusplus
158 }
159 #endif
160
161 #endif