support for 'origspace' data layer - used for hair on subsurf mesh.
[blender-staging.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[33];              /* 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 pad1;
70
71         int totlayer, maxlayer;       /* number of layers, size of layers array */
72         int totsize, pad2;             /* in editmode, total size of all data layers */
73         void *pool;                   /* Bmesh: Memory pool for allocation of blocks */
74         CustomDataExternal *external; /* external file storing customdata layers */
75 } CustomData;
76
77 /* CustomData.type */
78 #define CD_MVERT                0
79 #define CD_MSTICKY              1
80 #define CD_MDEFORMVERT  2
81 #define CD_MEDGE                3
82 #define CD_MFACE                4
83 #define CD_MTFACE               5
84 #define CD_MCOL                 6
85 #define CD_ORIGINDEX    7
86 #define CD_NORMAL               8
87 #define CD_POLYINDEX    9
88 #define CD_PROP_FLT             10
89 #define CD_PROP_INT             11
90 #define CD_PROP_STR             12
91 #define CD_ORIGSPACE    13 /* for modifier stack face location mapping */
92 #define CD_ORCO                 14
93 #define CD_MTEXPOLY             15
94 #define CD_MLOOPUV              16
95 #define CD_MLOOPCOL             17
96 #define CD_TANGENT              18
97 #define CD_MDISPS               19
98 #define CD_WEIGHT_MCOL  20 /* for displaying weightpaint colors */
99 #define CD_ID_MCOL              21
100 #define CD_TEXTURE_MCOL 22
101 #define CD_CLOTH_ORCO   23
102 #define CD_RECAST               24
103
104 /* BMESH ONLY START */
105 #define CD_MPOLY                25
106 #define CD_MLOOP                26
107 #define CD_SHAPE_KEYINDEX       27
108 #define CD_SHAPEKEY             28
109 #define CD_BWEIGHT              29
110 #define CD_CREASE               30
111 #define CD_ORIGSPACE_MLOOP      31
112 #define CD_WEIGHT_MLOOPCOL      32
113 /* BMESH ONLY END */
114
115 #define CD_NUMTYPES             33
116
117 /* Bits for CustomDataMask */
118 #define CD_MASK_MVERT           (1 << CD_MVERT)
119 #define CD_MASK_MSTICKY         (1 << CD_MSTICKY)
120 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
121 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
122 #define CD_MASK_MFACE           (1 << CD_MFACE)
123 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
124 #define CD_MASK_MCOL            (1 << CD_MCOL)
125 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
126 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
127 #define CD_MASK_POLYINDEX       (1 << CD_POLYINDEX)
128 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
129 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
130 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
131 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
132 #define CD_MASK_ORCO            (1 << CD_ORCO)
133 #define CD_MASK_MTEXPOLY        (1 << CD_MTEXPOLY)
134 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
135 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
136 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
137 #define CD_MASK_MDISPS          (1 << CD_MDISPS)
138 #define CD_MASK_WEIGHT_MCOL     (1 << CD_WEIGHT_MCOL)
139 #define CD_MASK_CLOTH_ORCO      (1 << CD_CLOTH_ORCO)
140 #define CD_MASK_RECAST          (1 << CD_RECAST)
141
142 /* BMESH ONLY START */
143 #define CD_MASK_MPOLY           (1 << CD_MPOLY)
144 #define CD_MASK_MLOOP           (1 << CD_MLOOP)
145 #define CD_MASK_SHAPE_KEYINDEX  (1 << CD_SHAPE_KEYINDEX)
146 #define CD_MASK_SHAPEKEY        (1 << CD_SHAPEKEY)
147 #define CD_MASK_BWEIGHT         (1 << CD_BWEIGHT)
148 #define CD_MASK_CREASE          (1 << CD_CREASE)
149 #define CD_MASK_ORIGSPACE_MLOOP (1 << CD_ORIGSPACE_MLOOP)
150 #define CD_MASK_WEIGHT_MLOOPCOL (1L << CD_WEIGHT_MLOOPCOL)
151 /* BMESH ONLY END */
152
153 /* CustomData.flag */
154
155 /* indicates layer should not be copied by CustomData_from_template or
156  * CustomData_copy_data */
157 #define CD_FLAG_NOCOPY    (1<<0)
158 /* indicates layer should not be freed (for layers backed by external data) */
159 #define CD_FLAG_NOFREE    (1<<1)
160 /* indicates the layer is only temporary, also implies no copy */
161 #define CD_FLAG_TEMPORARY ((1<<2)|CD_FLAG_NOCOPY)
162 /* indicates the layer is stored in an external file */
163 #define CD_FLAG_EXTERNAL  (1<<3)
164 /* indicates external data is read into memory */
165 #define CD_FLAG_IN_MEMORY (1<<4)
166
167 /* Limits */
168 #define MAX_MTFACE 8
169 #define MAX_MCOL   8
170
171 #ifdef __cplusplus
172 }
173 #endif
174
175 #endif