Revert "Build script: Don't use external Pugi for OSL"
[blender.git] / source / blender / makesdna / DNA_customdata_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  *
23  * Used for custom mesh data types (stored per vert/edge/loop/face)
24  */
25
26 #ifndef __DNA_CUSTOMDATA_TYPES_H__
27 #define __DNA_CUSTOMDATA_TYPES_H__
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 /** descriptor and storage for a custom data layer */
34 typedef struct CustomDataLayer {
35   /** Type of data in layer. */
36   int type;
37   /** In editmode, offset of layer in block. */
38   int offset;
39   /** General purpose flag. */
40   int flag;
41   /** Number of the active layer of this type. */
42   int active;
43   /** Number of the layer to rende.r*/
44   int active_rnd;
45   /** Number of the layer to rende.r*/
46   int active_clone;
47   /** Number of the layer to rende.r*/
48   int active_mask;
49   /** Shape keyblock unique id referenc.e*/
50   int uid;
51   /** Layer name, MAX_CUSTOMDATA_LAYER_NAME. */
52   char name[64];
53   /** Layer data. */
54   void *data;
55 } CustomDataLayer;
56
57 #define MAX_CUSTOMDATA_LAYER_NAME 64
58
59 typedef struct CustomDataExternal {
60   /** FILE_MAX. */
61   char filename[1024];
62 } CustomDataExternal;
63
64 /** structure which stores custom element data associated with mesh elements
65  * (vertices, edges or faces). The custom data is organized into a series of
66  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
67 typedef struct CustomData {
68   /** CustomDataLayers, ordered by type. */
69   CustomDataLayer *layers;
70   /**
71    * runtime only! - maps types to indices of first layer of that type,
72    * MUST be >= CD_NUMTYPES, but we cant use a define here.
73    * Correct size is ensured in CustomData_update_typemap assert().
74    */
75   int typemap[42];
76   char _pad0[4];
77   /** Number of layers, size of layers array. */
78   int totlayer, maxlayer;
79   /** In editmode, total size of all data layers. */
80   int totsize;
81   /** (BMesh Only): Memory pool for allocation of blocks. */
82   struct BLI_mempool *pool;
83   /** External file storing customdata layers. */
84   CustomDataExternal *external;
85 } CustomData;
86
87 /* CustomData.type */
88 typedef enum CustomDataType {
89   /* Used by GLSL attributes in the cases when we need a delayed CD type
90    * assignment (in the cases when we don't know in advance which layer
91    * we are addressing).
92    */
93   CD_AUTO_FROM_NAME = -1,
94
95   CD_MVERT = 0,
96 #ifdef DNA_DEPRECATED
97   CD_MSTICKY = 1, /* DEPRECATED */
98 #endif
99   CD_MDEFORMVERT = 2,
100   CD_MEDGE = 3,
101   CD_MFACE = 4,
102   CD_MTFACE = 5,
103   CD_MCOL = 6,
104   CD_ORIGINDEX = 7,
105   CD_NORMAL = 8,
106   CD_FACEMAP = 9, /* exclusive face group, each face can only be part of one */
107   CD_PROP_FLT = 10,
108   CD_PROP_INT = 11,
109   CD_PROP_STR = 12,
110   CD_ORIGSPACE = 13,               /* for modifier stack face location mapping */
111   CD_ORCO = 14,                    /* undeformed vertex coordinates, normalized to 0..1 range */
112   /*  CD_MTEXPOLY         = 15, */ /* deprecated */
113   CD_MLOOPUV = 16,
114   CD_MLOOPCOL = 17,
115   CD_TANGENT = 18,
116   CD_MDISPS = 19,
117   CD_PREVIEW_MCOL = 20, /* for displaying weightpaint colors */
118                         /*  CD_ID_MCOL          = 21, */
119   CD_TEXTURE_MLOOPCOL = 22,
120   CD_CLOTH_ORCO = 23,
121   CD_RECAST = 24,
122
123   /* BMESH ONLY START */
124   CD_MPOLY = 25,
125   CD_MLOOP = 26,
126   CD_SHAPE_KEYINDEX = 27,
127   CD_SHAPEKEY = 28,
128   CD_BWEIGHT = 29,
129   CD_CREASE = 30,
130   CD_ORIGSPACE_MLOOP = 31,
131   CD_PREVIEW_MLOOPCOL = 32,
132   CD_BM_ELEM_PYPTR = 33,
133   /* BMESH ONLY END */
134
135   CD_PAINT_MASK = 34,
136   CD_GRID_PAINT_MASK = 35,
137   CD_MVERT_SKIN = 36,
138   CD_FREESTYLE_EDGE = 37,
139   CD_FREESTYLE_FACE = 38,
140   CD_MLOOPTANGENT = 39,
141   CD_TESSLOOPNORMAL = 40,
142   CD_CUSTOMLOOPNORMAL = 41,
143
144   CD_NUMTYPES = 42,
145 } CustomDataType;
146
147 /* Bits for CustomDataMask */
148 #define CD_MASK_MVERT (1 << CD_MVERT)
149 // #define CD_MASK_MSTICKY      (1 << CD_MSTICKY)  /* DEPRECATED */
150 #define CD_MASK_MDEFORMVERT (1 << CD_MDEFORMVERT)
151 #define CD_MASK_MEDGE (1 << CD_MEDGE)
152 #define CD_MASK_MFACE (1 << CD_MFACE)
153 #define CD_MASK_MTFACE (1 << CD_MTFACE)
154 #define CD_MASK_MCOL (1 << CD_MCOL)
155 #define CD_MASK_ORIGINDEX (1 << CD_ORIGINDEX)
156 #define CD_MASK_NORMAL (1 << CD_NORMAL)
157 #define CD_MASK_FACEMAP (1 << CD_FACEMAP)
158 #define CD_MASK_PROP_FLT (1 << CD_PROP_FLT)
159 #define CD_MASK_PROP_INT (1 << CD_PROP_INT)
160 #define CD_MASK_PROP_STR (1 << CD_PROP_STR)
161 #define CD_MASK_ORIGSPACE (1 << CD_ORIGSPACE)
162 #define CD_MASK_ORCO (1 << CD_ORCO)
163 // #define CD_MASK_MTEXPOLY (1 << CD_MTEXPOLY)  /* DEPRECATED */
164 #define CD_MASK_MLOOPUV (1 << CD_MLOOPUV)
165 #define CD_MASK_MLOOPCOL (1 << CD_MLOOPCOL)
166 #define CD_MASK_TANGENT (1 << CD_TANGENT)
167 #define CD_MASK_MDISPS (1 << CD_MDISPS)
168 #define CD_MASK_PREVIEW_MCOL (1 << CD_PREVIEW_MCOL)
169 #define CD_MASK_CLOTH_ORCO (1 << CD_CLOTH_ORCO)
170 #define CD_MASK_RECAST (1 << CD_RECAST)
171
172 /* BMESH ONLY START */
173 #define CD_MASK_MPOLY (1 << CD_MPOLY)
174 #define CD_MASK_MLOOP (1 << CD_MLOOP)
175 #define CD_MASK_SHAPE_KEYINDEX (1 << CD_SHAPE_KEYINDEX)
176 #define CD_MASK_SHAPEKEY (1 << CD_SHAPEKEY)
177 #define CD_MASK_BWEIGHT (1 << CD_BWEIGHT)
178 #define CD_MASK_CREASE (1 << CD_CREASE)
179 #define CD_MASK_ORIGSPACE_MLOOP (1LL << CD_ORIGSPACE_MLOOP)
180 #define CD_MASK_PREVIEW_MLOOPCOL (1LL << CD_PREVIEW_MLOOPCOL)
181 #define CD_MASK_BM_ELEM_PYPTR (1LL << CD_BM_ELEM_PYPTR)
182 /* BMESH ONLY END */
183
184 #define CD_MASK_PAINT_MASK (1LL << CD_PAINT_MASK)
185 #define CD_MASK_GRID_PAINT_MASK (1LL << CD_GRID_PAINT_MASK)
186 #define CD_MASK_MVERT_SKIN (1LL << CD_MVERT_SKIN)
187 #define CD_MASK_FREESTYLE_EDGE (1LL << CD_FREESTYLE_EDGE)
188 #define CD_MASK_FREESTYLE_FACE (1LL << CD_FREESTYLE_FACE)
189 #define CD_MASK_MLOOPTANGENT (1LL << CD_MLOOPTANGENT)
190 #define CD_MASK_TESSLOOPNORMAL (1LL << CD_TESSLOOPNORMAL)
191 #define CD_MASK_CUSTOMLOOPNORMAL (1LL << CD_CUSTOMLOOPNORMAL)
192
193 /** Data types that may be defined for all mesh elements types. */
194 #define CD_MASK_GENERIC_DATA (CD_MASK_PROP_FLT | CD_MASK_PROP_INT | CD_MASK_PROP_STR)
195
196 typedef struct CustomData_MeshMasks {
197   uint64_t vmask;
198   uint64_t emask;
199   uint64_t fmask;
200   uint64_t pmask;
201   uint64_t lmask;
202 } CustomData_MeshMasks;
203
204 /* CustomData.flag */
205 enum {
206   /* Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data */
207   CD_FLAG_NOCOPY = (1 << 0),
208   /* Indicates layer should not be freed (for layers backed by external data) */
209   CD_FLAG_NOFREE = (1 << 1),
210   /* Indicates the layer is only temporary, also implies no copy */
211   CD_FLAG_TEMPORARY = ((1 << 2) | CD_FLAG_NOCOPY),
212   /* Indicates the layer is stored in an external file */
213   CD_FLAG_EXTERNAL = (1 << 3),
214   /* Indicates external data is read into memory */
215   CD_FLAG_IN_MEMORY = (1 << 4),
216 };
217
218 /* Limits */
219 #define MAX_MTFACE 8
220 #define MAX_MCOL 8
221
222 #define DYNTOPO_NODE_NONE -1
223
224 #define CD_TEMP_CHUNK_SIZE 128
225
226 #ifdef __cplusplus
227 }
228 #endif
229
230 #endif /* __DNA_CUSTOMDATA_TYPES_H__ */