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