merge from trunk - r17500 to HEAD
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* descriptor and storage for a custom data layer */
34 typedef struct CustomDataLayer {
35         int type;       /* type of data in layer */
36         int offset;     /* in editmode, offset of layer in block */
37         int flag;       /* general purpose flag */
38         int active;     /* number of the active layer of this type */
39         int active_rnd; /* number of the layer to render*/
40         int active_clone; /* number of the layer to render*/
41         int active_mask; /* number of the layer to render*/
42         char pad[4];
43         char name[32];  /* layer name */
44         void *data;     /* layer data */
45 } CustomDataLayer;
46
47 /* structure which stores custom element data associated with mesh elements
48  * (vertices, edges or faces). The custom data is organised into a series of
49  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
50 typedef struct CustomData {
51         CustomDataLayer *layers;  /* CustomDataLayers, ordered by type */
52         int totlayer, maxlayer;   /* number of layers, size of layers array */
53         int totsize, pad;         /* in editmode, total size of all data layers */
54         void *pool;               /* for Bmesh: Memory pool for allocation of blocks*/
55 } CustomData;
56
57 /* CustomData.type */
58 #define CD_MVERT                0
59 #define CD_MSTICKY              1
60 #define CD_MDEFORMVERT  2
61 #define CD_MEDGE                3
62 #define CD_MFACE                4
63 #define CD_MTFACE               5
64 #define CD_MCOL                 6
65 #define CD_ORIGINDEX    7
66 #define CD_NORMAL               8
67 #define CD_FLAGS                9
68 #define CD_PROP_FLT             10
69 #define CD_PROP_INT             11
70 #define CD_PROP_STR             12
71 #define CD_ORIGSPACE    13 /* for modifier stack face location mapping */
72 #define CD_ORCO                 14
73 #define CD_MTEXPOLY             15
74 #define CD_MLOOPUV              16
75 #define CD_MLOOPCOL             17
76 #define CD_TANGENT              18
77 #define CD_NUMTYPES             19
78
79 /* Bits for CustomDataMask */
80 #define CD_MASK_MVERT           (1 << CD_MVERT)
81 #define CD_MASK_MSTICKY         (1 << CD_MSTICKY)
82 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
83 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
84 #define CD_MASK_MFACE           (1 << CD_MFACE)
85 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
86 #define CD_MASK_MCOL            (1 << CD_MCOL)
87 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
88 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
89 #define CD_MASK_FLAGS           (1 << CD_FLAGS)
90 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
91 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
92 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
93 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
94 #define CD_MASK_ORCO            (1 << CD_ORCO)
95 #define CD_MASK_MTEXPOLY        (1 << CD_MTEXPOLY)
96 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
97 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
98 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
99
100
101 /* CustomData.flag */
102
103 /* indicates layer should not be copied by CustomData_from_template or
104  * CustomData_copy_data */
105 #define CD_FLAG_NOCOPY    (1<<0)
106 /* indicates layer should not be freed (for layers backed by external data) */
107 #define CD_FLAG_NOFREE    (1<<1)
108 /* indicates the layer is only temporary, also implies no copy */
109 #define CD_FLAG_TEMPORARY ((1<<2)|CD_FLAG_NOCOPY)
110
111 /* Limits */
112 #define MAX_MTFACE 8
113 #define MAX_MCOL   8
114
115 #endif