Merge remote-tracking branch 'origin/master' into blender2.8
[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  * Used for custom mesh data types (stored per vert/edge/loop/face)
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         int uid;        /* shape keyblock unique id reference*/
51         char name[64];  /* layer name, MAX_CUSTOMDATA_LAYER_NAME */
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 organized 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[42];              /* 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 pad_i1;
70         int totlayer, maxlayer;       /* number of layers, size of layers array */
71         int totsize;                  /* in editmode, total size of all data layers */
72         struct BLI_mempool *pool;     /* (BMesh Only): Memory pool for allocation of blocks */
73         CustomDataExternal *external; /* external file storing customdata layers */
74 } CustomData;
75
76 /* CustomData.type */
77 typedef enum CustomDataType {
78         /* Used by GLSL attributes in the cases when we need a delayed CD type
79          * assignment (in the cases when we don't know in advance which layer
80          * we are addressing).
81          */
82         CD_AUTO_FROM_NAME   = -1,
83
84         CD_MVERT            = 0,
85 #ifdef DNA_DEPRECATED
86         CD_MSTICKY          = 1,  /* DEPRECATED */
87 #endif
88         CD_MDEFORMVERT      = 2,
89         CD_MEDGE            = 3,
90         CD_MFACE            = 4,
91         CD_MTFACE           = 5,
92         CD_MCOL             = 6,
93         CD_ORIGINDEX        = 7,
94         CD_NORMAL           = 8,
95         CD_FACEMAP          = 9, /* exclusive face group, each face can only be part of one */
96         CD_PROP_FLT         = 10,
97         CD_PROP_INT         = 11,
98         CD_PROP_STR         = 12,
99         CD_ORIGSPACE        = 13,  /* for modifier stack face location mapping */
100         CD_ORCO             = 14,
101 /*      CD_MTEXPOLY         = 15, */  /* deprecated */
102         CD_MLOOPUV          = 16,
103         CD_MLOOPCOL         = 17,
104         CD_TANGENT          = 18,
105         CD_MDISPS           = 19,
106         CD_PREVIEW_MCOL     = 20,  /* for displaying weightpaint colors */
107 /*      CD_ID_MCOL          = 21, */
108         CD_TEXTURE_MLOOPCOL = 22,
109         CD_CLOTH_ORCO       = 23,
110         CD_RECAST           = 24,
111
112 /* BMESH ONLY START */
113         CD_MPOLY            = 25,
114         CD_MLOOP            = 26,
115         CD_SHAPE_KEYINDEX   = 27,
116         CD_SHAPEKEY         = 28,
117         CD_BWEIGHT          = 29,
118         CD_CREASE           = 30,
119         CD_ORIGSPACE_MLOOP  = 31,
120         CD_PREVIEW_MLOOPCOL = 32,
121         CD_BM_ELEM_PYPTR    = 33,
122 /* BMESH ONLY END */
123
124         CD_PAINT_MASK       = 34,
125         CD_GRID_PAINT_MASK  = 35,
126         CD_MVERT_SKIN       = 36,
127         CD_FREESTYLE_EDGE   = 37,
128         CD_FREESTYLE_FACE   = 38,
129         CD_MLOOPTANGENT     = 39,
130         CD_TESSLOOPNORMAL   = 40,
131         CD_CUSTOMLOOPNORMAL = 41,
132
133         CD_NUMTYPES         = 42
134 } CustomDataType;
135
136 /* Bits for CustomDataMask */
137 #define CD_MASK_MVERT           (1 << CD_MVERT)
138 // #define CD_MASK_MSTICKY              (1 << CD_MSTICKY)  /* DEPRECATED */
139 #define CD_MASK_MDEFORMVERT     (1 << CD_MDEFORMVERT)
140 #define CD_MASK_MEDGE           (1 << CD_MEDGE)
141 #define CD_MASK_MFACE           (1 << CD_MFACE)
142 #define CD_MASK_MTFACE          (1 << CD_MTFACE)
143 #define CD_MASK_MCOL            (1 << CD_MCOL)
144 #define CD_MASK_ORIGINDEX       (1 << CD_ORIGINDEX)
145 #define CD_MASK_NORMAL          (1 << CD_NORMAL)
146 #define CD_MASK_FACEMAP         (1 << CD_FACEMAP)
147 #define CD_MASK_PROP_FLT        (1 << CD_PROP_FLT)
148 #define CD_MASK_PROP_INT        (1 << CD_PROP_INT)
149 #define CD_MASK_PROP_STR        (1 << CD_PROP_STR)
150 #define CD_MASK_ORIGSPACE       (1 << CD_ORIGSPACE)
151 #define CD_MASK_ORCO            (1 << CD_ORCO)
152 // #define CD_MASK_MTEXPOLY     (1 << CD_MTEXPOLY)  /* DEPRECATED */
153 #define CD_MASK_MLOOPUV         (1 << CD_MLOOPUV)
154 #define CD_MASK_MLOOPCOL        (1 << CD_MLOOPCOL)
155 #define CD_MASK_TANGENT         (1 << CD_TANGENT)
156 #define CD_MASK_MDISPS          (1 << CD_MDISPS)
157 #define CD_MASK_PREVIEW_MCOL    (1 << CD_PREVIEW_MCOL)
158 #define CD_MASK_CLOTH_ORCO      (1 << CD_CLOTH_ORCO)
159 #define CD_MASK_RECAST          (1 << CD_RECAST)
160
161 /* BMESH ONLY START */
162 #define CD_MASK_MPOLY           (1 << CD_MPOLY)
163 #define CD_MASK_MLOOP           (1 << CD_MLOOP)
164 #define CD_MASK_SHAPE_KEYINDEX  (1 << CD_SHAPE_KEYINDEX)
165 #define CD_MASK_SHAPEKEY        (1 << CD_SHAPEKEY)
166 #define CD_MASK_BWEIGHT         (1 << CD_BWEIGHT)
167 #define CD_MASK_CREASE          (1 << CD_CREASE)
168 #define CD_MASK_ORIGSPACE_MLOOP (1LL << CD_ORIGSPACE_MLOOP)
169 #define CD_MASK_PREVIEW_MLOOPCOL (1LL << CD_PREVIEW_MLOOPCOL)
170 #define CD_MASK_BM_ELEM_PYPTR (1LL << CD_BM_ELEM_PYPTR)
171 /* BMESH ONLY END */
172
173 #define CD_MASK_PAINT_MASK              (1LL << CD_PAINT_MASK)
174 #define CD_MASK_GRID_PAINT_MASK (1LL << CD_GRID_PAINT_MASK)
175 #define CD_MASK_MVERT_SKIN              (1LL << CD_MVERT_SKIN)
176 #define CD_MASK_FREESTYLE_EDGE  (1LL << CD_FREESTYLE_EDGE)
177 #define CD_MASK_FREESTYLE_FACE  (1LL << CD_FREESTYLE_FACE)
178 #define CD_MASK_MLOOPTANGENT    (1LL << CD_MLOOPTANGENT)
179 #define CD_MASK_TESSLOOPNORMAL  (1LL << CD_TESSLOOPNORMAL)
180 #define CD_MASK_CUSTOMLOOPNORMAL (1LL << CD_CUSTOMLOOPNORMAL)
181
182 /* CustomData.flag */
183 enum {
184         /* Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data */
185         CD_FLAG_NOCOPY    = (1 << 0),
186         /* Indicates layer should not be freed (for layers backed by external data) */
187         CD_FLAG_NOFREE    = (1 << 1),
188         /* Indicates the layer is only temporary, also implies no copy */
189         CD_FLAG_TEMPORARY = ((1 << 2) | CD_FLAG_NOCOPY),
190         /* Indicates the layer is stored in an external file */
191         CD_FLAG_EXTERNAL  = (1 << 3),
192         /* Indicates external data is read into memory */
193         CD_FLAG_IN_MEMORY = (1 << 4),
194 };
195
196 /* Limits */
197 #define MAX_MTFACE  8
198 #define MAX_MCOL    8
199
200 #define DYNTOPO_NODE_NONE -1
201
202 #define CD_TEMP_CHUNK_SIZE 128
203
204 #ifdef __cplusplus
205 }
206 #endif
207
208 #endif  /* __DNA_CUSTOMDATA_TYPES_H__ */