Filling in branch from trunk
[blender.git] / source / blender / makesdna / DNA_customdata_types.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef DNA_CUSTOMDATA_TYPES_H
33 #define DNA_CUSTOMDATA_TYPES_H
34
35 /* descriptor and storage for a custom data layer */
36 typedef struct CustomDataLayer {
37         int type;       /* type of data in layer */
38         int offset;     /* in editmode, offset of layer in block */
39         int flag;       /* general purpose flag */
40         int active;     /* number of the active layer of this type */
41         int active_rnd; /* 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 } CustomData;
55
56 /* CustomData.type */
57 #define CD_MVERT                0
58 #define CD_MSTICKY              1
59 #define CD_MDEFORMVERT  2
60 #define CD_MEDGE                3
61 #define CD_MFACE                4
62 #define CD_MTFACE               5
63 #define CD_MCOL                 6
64 #define CD_ORIGINDEX    7
65 #define CD_NORMAL               8
66 #define CD_FLAGS                9
67 #define CD_PROP_FLT             10
68 #define CD_PROP_INT             11
69 #define CD_PROP_STR             12
70 #define CD_NUMTYPES             13
71
72 /* Bits for CustomDataMask */
73 #define CD_MASK_MVERT           (1 << CD_MVERT)
74 #define CD_MASK_MSTICKY         (1 << CD_MSTICKY)
75 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
76 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
77 #define CD_MASK_MFACE           (1 << CD_MFACE)
78 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
79 #define CD_MASK_MCOL            (1 << CD_MCOL)
80 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
81 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
82 #define CD_MASK_FLAGS           (1 << CD_FLAGS)
83 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
84 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
85 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
86
87
88 /* CustomData.flag */
89
90 /* indicates layer should not be copied by CustomData_from_template or
91  * CustomData_copy_data */
92 #define CD_FLAG_NOCOPY    (1<<0)
93 /* indicates layer should not be freed (for layers backed by external data) */
94 #define CD_FLAG_NOFREE    (1<<1)
95 /* indicates the layer is only temporary, also implies no copy */
96 #define CD_FLAG_TEMPORARY ((1<<2)|CD_FLAG_NOCOPY)
97
98 /* Limits */
99 #define MAX_MTFACE 8
100 #define MAX_MCOL   8
101
102 #endif