minor speedup for bmesh - add CustomData_bmesh_free_block_data(), use
[blender.git] / source / blender / blenkernel / BKE_customdata.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) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Ben Batt <benbatt@gmail.com>
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file BKE_customdata.h
29  *  \ingroup bke
30  *  \author Ben Batt
31  *  \brief CustomData interface, see also DNA_customdata_types.h.
32  */
33
34 #ifndef __BKE_CUSTOMDATA_H__
35 #define __BKE_CUSTOMDATA_H__
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 #include "../blenloader/BLO_sys_types.h" /* XXX, should have a more generic include for this */
42 #include "BLI_utildefines.h"
43
44 struct BMesh;
45 struct ID;
46 struct CustomData;
47 struct CustomDataLayer;
48 typedef uint64_t CustomDataMask;
49
50 /*a data type large enough to hold 1 element from any customdata layer type*/
51 typedef struct {unsigned char data[64]; } CDBlockBytes;
52
53 extern const CustomDataMask CD_MASK_BAREMESH;
54 extern const CustomDataMask CD_MASK_MESH;
55 extern const CustomDataMask CD_MASK_EDITMESH;
56 extern const CustomDataMask CD_MASK_DERIVEDMESH;
57 extern const CustomDataMask CD_MASK_BMESH;
58 extern const CustomDataMask CD_MASK_FACECORNERS;
59
60 /* for ORIGINDEX layer type, indicates no original index for this element */
61 #define ORIGINDEX_NONE -1
62
63 /* initializes a CustomData object with the same layer setup as source and
64  * memory space for totelem elements. mask must be an array of length
65  * CD_NUMTYPES elements, that indicate if a layer can be copied. */
66
67 /* add/copy/merge allocation types */
68 #define CD_ASSIGN    0  /* use the data pointer */
69 #define CD_CALLOC    1  /* allocate blank memory */
70 #define CD_DEFAULT   2  /* allocate and set to default */
71 #define CD_REFERENCE 3  /* use data pointers, set layer flag NOFREE */
72 #define CD_DUPLICATE 4  /* do a full copy of all layers, only allowed if source
73                          * has same number of elements */
74
75 #define CD_TYPE_AS_MASK(_type) (CustomDataMask)((CustomDataMask)1 << (CustomDataMask)(_type))
76
77 void customData_mask_layers__print(CustomDataMask mask);
78
79 /**
80  * Checks if the layer at physical offset \a layer_n (in data->layers) support math
81  * the below operations.
82  */
83 bool CustomData_layer_has_math(struct CustomData *data, int layer_n);
84 bool CustomData_layer_has_interp(struct CustomData *data, int layer_n);
85
86 /**
87  * Checks if any of the customdata layers has math.
88  */
89 bool CustomData_has_math(struct CustomData *data);
90 bool CustomData_has_interp(struct CustomData *data);
91 bool CustomData_bmesh_has_free(struct CustomData *data);
92
93 /* copies the "value" (e.g. mloopuv uv or mloopcol colors) from one block to
94  * another, while not overwriting anything else (e.g. flags).  probably only
95  * implemented for mloopuv/mloopcol, for now.*/
96 void CustomData_data_copy_value(int type, void *source, void *dest);
97
98 /* compares if data1 is equal to data2.  type is a valid CustomData type
99  * enum (e.g. CD_MLOOPUV). the layer type's equal function is used to compare
100  * the data, if it exists, otherwise memcmp is used.*/
101 bool CustomData_data_equals(int type, void *data1, void *data2);
102 void CustomData_data_initminmax(int type, void *min, void *max);
103 void CustomData_data_dominmax(int type, void *data, void *min, void *max);
104 void CustomData_data_multiply(int type, void *data, float fac);
105 void CustomData_data_add(int type, void *data1, void *data2);
106
107 /* initializes a CustomData object with the same layer setup as source.
108  * mask is a bitfield where (mask & (1 << (layer type))) indicates
109  * if a layer should be copied or not. alloctype must be one of the above. */
110 void CustomData_copy(const struct CustomData *source, struct CustomData *dest,
111                      CustomDataMask mask, int alloctype, int totelem);
112
113 /* BMESH_TODO, not really a public function but readfile.c needs it */
114 void CustomData_update_typemap(struct CustomData *data);
115
116 /* same as the above, except that this will preserve existing layers, and only
117  * add the layers that were not there yet */
118 void CustomData_merge(const struct CustomData *source, struct CustomData *dest,
119                       CustomDataMask mask, int alloctype, int totelem);
120
121 /* bmesh version of CustomData_merge; merges the layouts of source and dest,
122  * then goes through the mesh and makes sure all the customdata blocks are
123  * consistent with the new layout.*/
124 void CustomData_bmesh_merge(struct CustomData *source, struct CustomData *dest, 
125                             CustomDataMask mask, int alloctype, struct BMesh *bm, const char htype);
126
127 /** NULL's all members and resets the typemap. */
128 void CustomData_reset(struct CustomData *data);
129
130 /** frees data associated with a CustomData object (doesn't free the object
131  * itself, though)
132  */
133 void CustomData_free(struct CustomData *data, int totelem);
134
135 /* frees all layers with CD_FLAG_TEMPORARY */
136 void CustomData_free_temporary(struct CustomData *data, int totelem);
137
138 /* adds a data layer of the given type to the CustomData object, optionally
139  * backed by an external data array. the different allocation types are
140  * defined above. returns the data of the layer.
141  */
142 void *CustomData_add_layer(struct CustomData *data, int type, int alloctype,
143                            void *layer, int totelem);
144 /*same as above but accepts a name */
145 void *CustomData_add_layer_named(struct CustomData *data, int type, int alloctype,
146                                  void *layer, int totelem, const char *name);
147
148 /* frees the active or first data layer with the give type.
149  * returns 1 on succes, 0 if no layer with the given type is found
150  *
151  * in editmode, use EDBM_data_layer_free instead of this function
152  */
153 bool CustomData_free_layer(struct CustomData *data, int type, int totelem, int index);
154
155 /* frees the layer index with the give type.
156  * returns 1 on succes, 0 if no layer with the given type is found
157  *
158  * in editmode, use EDBM_data_layer_free instead of this function
159  */
160 bool CustomData_free_layer_active(struct CustomData *data, int type, int totelem);
161
162 /* same as above, but free all layers with type */
163 void CustomData_free_layers(struct CustomData *data, int type, int totelem);
164
165 /* returns 1 if a layer with the specified type exists */
166 bool CustomData_has_layer(const struct CustomData *data, int type);
167
168 /* returns the number of layers with this type */
169 int CustomData_number_of_layers(const struct CustomData *data, int type);
170
171 /* duplicate data of a layer with flag NOFREE, and remove that flag.
172  * returns the layer data */
173 void *CustomData_duplicate_referenced_layer(struct CustomData *data, const int type, const int totelem);
174 void *CustomData_duplicate_referenced_layer_named(struct CustomData *data,
175                                                   const int type, const char *name, const int totelem);
176 bool CustomData_is_referenced_layer(struct CustomData *data, int type);
177
178 /* set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
179  * zero for the layer type, so only layer types specified by the mask
180  * will be copied
181  */
182 void CustomData_set_only_copy(const struct CustomData *data,
183                               CustomDataMask mask);
184
185 /* copies data from one CustomData object to another
186  * objects need not be compatible, each source layer is copied to the
187  * first dest layer of correct type (if there is none, the layer is skipped)
188  * return 1 on success, 0 on failure
189  */
190 void CustomData_copy_data(const struct CustomData *source,
191                           struct CustomData *dest, int source_index,
192                           int dest_index, int count);
193 void CustomData_copy_elements(int type, void *source, void *dest, int count);
194 void CustomData_bmesh_copy_data(const struct CustomData *source, 
195                                 struct CustomData *dest, void *src_block, 
196                                 void **dest_block);
197
198 /* frees data in a CustomData object
199  * return 1 on success, 0 on failure
200  */
201 void CustomData_free_elem(struct CustomData *data, int index, int count);
202
203 /* interpolates data from one CustomData object to another
204  * objects need not be compatible, each source layer is interpolated to the
205  * first dest layer of correct type (if there is none, the layer is skipped)
206  * if weights == NULL or sub_weights == NULL, they default to all 1's
207  *
208  * src_indices gives the source elements to interpolate from
209  * weights gives the weight for each source element
210  * sub_weights is an array of matrices of weights for sub-elements (matrices
211  *     should be source->subElems * source->subElems in size)
212  * count gives the number of source elements to interpolate from
213  * dest_index gives the dest element to write the interpolated value to
214  *
215  * returns 1 on success, 0 on failure
216  */
217 void CustomData_interp(const struct CustomData *source, struct CustomData *dest,
218                        int *src_indices, float *weights, float *sub_weights,
219                        int count, int dest_index);
220 void CustomData_bmesh_interp_n(struct CustomData *data, void **src_blocks, const float *weights,
221                                const float *sub_weights, int count, void *dest_block, int n);
222 void CustomData_bmesh_interp(struct CustomData *data, void **src_blocks,
223                              const float *weights, const float *sub_weights, int count,
224                              void *dest_block);
225
226
227 /* swaps the data in the element corners, to new corners with indices as
228  * specified in corner_indices. for edges this is an array of length 2, for
229  * faces an array of length 4 */
230 void CustomData_swap(struct CustomData *data, int index, const int *corner_indices);
231
232 /* gets a pointer to the data element at index from the first layer of type
233  * returns NULL if there is no layer of type
234  */
235 void *CustomData_get(const struct CustomData *data, int index, int type);
236 void *CustomData_get_n(const struct CustomData *data, int type, int index, int n);
237 void *CustomData_bmesh_get(const struct CustomData *data, void *block, int type);
238 void *CustomData_bmesh_get_n(const struct CustomData *data, void *block, int type, int n);
239
240 /* gets the layer at physical index n, with no type checking.
241  */
242 void *CustomData_bmesh_get_layer_n(const struct CustomData *data, void *block, int n);
243
244 bool CustomData_set_layer_name(const struct CustomData *data, int type, int n, const char *name);
245
246 /* gets a pointer to the active or first layer of type
247  * returns NULL if there is no layer of type
248  */
249 void *CustomData_get_layer(const struct CustomData *data, int type);
250 void *CustomData_get_layer_n(const struct CustomData *data, int type, int n);
251 void *CustomData_get_layer_named(const struct CustomData *data, int type,
252                                  const char *name);
253 int CustomData_get_offset(const struct CustomData *data, int type);
254 int CustomData_get_n_offset(const struct CustomData *data, int type, int n);
255
256 int CustomData_get_layer_index(const struct CustomData *data, int type);
257 int CustomData_get_layer_index_n(const struct CustomData *data, int type, int n);
258 int CustomData_get_named_layer_index(const struct CustomData *data, int type, const char *name);
259 int CustomData_get_active_layer_index(const struct CustomData *data, int type);
260 int CustomData_get_render_layer_index(const struct CustomData *data, int type);
261 int CustomData_get_clone_layer_index(const struct CustomData *data, int type);
262 int CustomData_get_stencil_layer_index(const struct CustomData *data, int type);
263 int CustomData_get_named_layer(const struct CustomData *data, int type, const char *name);
264 int CustomData_get_active_layer(const struct CustomData *data, int type);
265 int CustomData_get_render_layer(const struct CustomData *data, int type);
266 int CustomData_get_clone_layer(const struct CustomData *data, int type);
267 int CustomData_get_stencil_layer(const struct CustomData *data, int type);
268
269 /* copies the data from source to the data element at index in the first
270  * layer of type
271  * no effect if there is no layer of type
272  */
273 void CustomData_set(const struct CustomData *data, int index, int type,
274                     void *source);
275
276 void CustomData_bmesh_set(const struct CustomData *data, void *block, int type, 
277                           void *source);
278
279 void CustomData_bmesh_set_n(struct CustomData *data, void *block, int type, int n, 
280                             void *source);
281 /* sets the data of the block at physical layer n.  no real type checking
282  * is performed.
283  */
284 void CustomData_bmesh_set_layer_n(struct CustomData *data, void *block, int n,
285                                   void *source);
286
287 /* set the pointer of to the first layer of type. the old data is not freed.
288  * returns the value of ptr if the layer is found, NULL otherwise
289  */
290 void *CustomData_set_layer(const struct CustomData *data, int type, void *ptr);
291 void *CustomData_set_layer_n(const struct CustomData *data, int type, int n, void *ptr);
292
293 /* sets the nth layer of type as active */
294 void CustomData_set_layer_active(struct CustomData *data, int type, int n);
295 void CustomData_set_layer_render(struct CustomData *data, int type, int n);
296 void CustomData_set_layer_clone(struct CustomData *data, int type, int n);
297 void CustomData_set_layer_stencil(struct CustomData *data, int type, int n);
298
299 /* same as above but works with an index from CustomData_get_layer_index */
300 void CustomData_set_layer_active_index(struct CustomData *data, int type, int n);
301 void CustomData_set_layer_render_index(struct CustomData *data, int type, int n);
302 void CustomData_set_layer_clone_index(struct CustomData *data, int type, int n);
303 void CustomData_set_layer_stencil_index(struct CustomData *data, int type, int n);
304
305 /* adds flag to the layer flags */
306 void CustomData_set_layer_flag(struct CustomData *data, int type, int flag);
307
308 void CustomData_bmesh_set_default(struct CustomData *data, void **block);
309 void CustomData_bmesh_free_block(struct CustomData *data, void **block);
310 void CustomData_bmesh_free_block_data(struct CustomData *data, void **block);
311
312 /* copy custom data to/from layers as in mesh/derivedmesh, to editmesh
313  * blocks of data. the CustomData's must not be compatible */
314 void CustomData_to_bmesh_block(const struct CustomData *source, 
315                                struct CustomData *dest, int src_index, void **dest_block, bool use_default_init);
316 void CustomData_from_bmesh_block(const struct CustomData *source, 
317                                  struct CustomData *dest, void *src_block, int dest_index);
318
319
320 /* query info over types */
321 void CustomData_file_write_info(int type, const char **structname, int *structnum);
322 int CustomData_sizeof(int type);
323
324 /* get the name of a layer type */
325 const char *CustomData_layertype_name(int type);
326 bool        CustomData_layertype_is_singleton(int type);
327
328 /* make sure the name of layer at index is unique */
329 void CustomData_set_layer_unique_name(struct CustomData *data, int index);
330
331 void CustomData_validate_layer_name(const struct CustomData *data, int type, const char *name, char *outname);
332
333 /* for file reading compatibility, returns false if the layer was freed,
334  * only after this test passes, layer->data should be assigned */
335 bool CustomData_verify_versions(struct CustomData *data, int index);
336
337 /*BMesh specific customdata stuff*/
338 void CustomData_to_bmeshpoly(struct CustomData *fdata, struct CustomData *pdata,
339                              struct CustomData *ldata, int totloop, int totpoly);
340 void CustomData_from_bmeshpoly(struct CustomData *fdata, struct CustomData *pdata, struct CustomData *ldata, int total);
341 void CustomData_bmesh_update_active_layers(struct CustomData *fdata, struct CustomData *pdata, struct CustomData *ldata);
342 void CustomData_bmesh_do_versions_update_active_layers(struct CustomData *fdata, struct CustomData *pdata, struct CustomData *ldata);
343 void CustomData_bmesh_init_pool(struct CustomData *data, int totelem, const char htype);
344
345 /* External file storage */
346
347 void CustomData_external_add(struct CustomData *data,
348                              struct ID *id, int type, int totelem, const char *filename);
349 void CustomData_external_remove(struct CustomData *data,
350                                 struct ID *id, int type, int totelem);
351 bool CustomData_external_test(struct CustomData *data, int type);
352
353 void CustomData_external_write(struct CustomData *data,
354                                struct ID *id, CustomDataMask mask, int totelem, int free);
355 void CustomData_external_read(struct CustomData *data,
356                               struct ID *id, CustomDataMask mask, int totelem);
357 void CustomData_external_reload(struct CustomData *data,
358                                 struct ID *id, CustomDataMask mask, int totelem);
359
360 #ifdef __cplusplus
361 }
362 #endif
363
364 #endif
365