== file browser ==
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file DNA_customdata_types.h
31  *  \ingroup DNA
32  */
33
34 #ifndef DNA_CUSTOMDATA_TYPES_H
35 #define DNA_CUSTOMDATA_TYPES_H
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
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         char pad[4];
51         char name[32];  /* layer name */
52         void *data;     /* layer data */
53 } CustomDataLayer;
54
55 typedef struct CustomDataExternal {
56         char filename[240]; /* FILE_MAX */
57 } CustomDataExternal;
58
59 /** structure which stores custom element data associated with mesh elements
60  * (vertices, edges or faces). The custom data is organised into a series of
61  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
62 typedef struct CustomData {
63         CustomDataLayer *layers;      /* CustomDataLayers, ordered by type */
64         int totlayer, maxlayer;       /* number of layers, size of layers array */
65         int totsize, pad;             /* in editmode, total size of all data layers */
66         void *pool;                   /* Bmesh: Memory pool for allocation of blocks */
67         CustomDataExternal *external; /* external file storing customdata layers */
68 } CustomData;
69
70 /* CustomData.type */
71 #define CD_MVERT                0
72 #define CD_MSTICKY              1
73 #define CD_MDEFORMVERT  2
74 #define CD_MEDGE                3
75 #define CD_MFACE                4
76 #define CD_MTFACE               5
77 #define CD_MCOL                 6
78 #define CD_ORIGINDEX    7
79 #define CD_NORMAL               8
80 #define CD_FLAGS                9
81 #define CD_PROP_FLT             10
82 #define CD_PROP_INT             11
83 #define CD_PROP_STR             12
84 #define CD_ORIGSPACE    13 /* for modifier stack face location mapping */
85 #define CD_ORCO                 14
86 #define CD_MTEXPOLY             15
87 #define CD_MLOOPUV              16
88 #define CD_MLOOPCOL             17
89 #define CD_TANGENT              18
90 #define CD_MDISPS               19
91 #define CD_WEIGHT_MCOL  20 /* for displaying weightpaint colors */
92 #define CD_ID_MCOL              21
93 #define CD_TEXTURE_MCOL 22
94 #define CD_CLOTH_ORCO   23
95 #define CD_NUMTYPES             24
96
97 /* Bits for CustomDataMask */
98 #define CD_MASK_MVERT           (1 << CD_MVERT)
99 #define CD_MASK_MSTICKY         (1 << CD_MSTICKY)
100 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
101 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
102 #define CD_MASK_MFACE           (1 << CD_MFACE)
103 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
104 #define CD_MASK_MCOL            (1 << CD_MCOL)
105 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
106 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
107 #define CD_MASK_FLAGS           (1 << CD_FLAGS)
108 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
109 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
110 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
111 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
112 #define CD_MASK_ORCO            (1 << CD_ORCO)
113 #define CD_MASK_MTEXPOLY        (1 << CD_MTEXPOLY)
114 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
115 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
116 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
117 #define CD_MASK_MDISPS          (1 << CD_MDISPS)
118 #define CD_MASK_WEIGHT_MCOL     (1 << CD_WEIGHT_MCOL)
119 #define CD_MASK_CLOTH_ORCO      (1 << CD_CLOTH_ORCO)
120
121 /* CustomData.flag */
122
123 /* indicates layer should not be copied by CustomData_from_template or
124  * CustomData_copy_data */
125 #define CD_FLAG_NOCOPY    (1<<0)
126 /* indicates layer should not be freed (for layers backed by external data) */
127 #define CD_FLAG_NOFREE    (1<<1)
128 /* indicates the layer is only temporary, also implies no copy */
129 #define CD_FLAG_TEMPORARY ((1<<2)|CD_FLAG_NOCOPY)
130 /* indicates the layer is stored in an external file */
131 #define CD_FLAG_EXTERNAL  (1<<3)
132 /* indicates external data is read into memory */
133 #define CD_FLAG_IN_MEMORY (1<<4)
134
135 /* Limits */
136 #define MAX_MTFACE 8
137 #define MAX_MCOL   8
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143 #endif