Merge branch 'master' into blender2.8
[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 "BLI_sys_types.h"
42 #include "BLI_utildefines.h"
43
44 #include "DNA_customdata_types.h"
45
46 struct BMesh;
47 struct ID;
48 struct CustomData;
49 typedef uint64_t CustomDataMask;
50
51 /*a data type large enough to hold 1 element from any customdata layer type*/
52 typedef struct {unsigned char data[64]; } CDBlockBytes;
53
54 extern const CustomDataMask CD_MASK_BAREMESH;
55 extern const CustomDataMask CD_MASK_MESH;
56 extern const CustomDataMask CD_MASK_EDITMESH;
57 extern const CustomDataMask CD_MASK_DERIVEDMESH;
58 extern const CustomDataMask CD_MASK_BMESH;
59 extern const CustomDataMask CD_MASK_FACECORNERS;
60 extern const CustomDataMask CD_MASK_EVERYTHING;
61
62 /* for ORIGINDEX layer type, indicates no original index for this element */
63 #define ORIGINDEX_NONE -1
64
65 /* initializes a CustomData object with the same layer setup as source and
66  * memory space for totelem elements. mask must be an array of length
67  * CD_NUMTYPES elements, that indicate if a layer can be copied. */
68
69 /* add/copy/merge allocation types */
70 #define CD_ASSIGN    0  /* use the data pointer */
71 #define CD_CALLOC    1  /* allocate blank memory */
72 #define CD_DEFAULT   2  /* allocate and set to default */
73 #define CD_REFERENCE 3  /* use data pointers, set layer flag NOFREE */
74 #define CD_DUPLICATE 4  /* do a full copy of all layers, only allowed if source
75                          * has same number of elements */
76
77 #define CD_TYPE_AS_MASK(_type) (CustomDataMask)((CustomDataMask)1 << (CustomDataMask)(_type))
78
79 void customData_mask_layers__print(CustomDataMask mask);
80
81 typedef void (*cd_interp)(const void **sources, const float *weights, const float *sub_weights, int count, void *dest);
82 typedef void (*cd_copy)(const void *source, void *dest, int count);
83
84 /**
85  * Checks if the layer at physical offset \a layer_n (in data->layers) support math
86  * the below operations.
87  */
88 bool CustomData_layer_has_math(const struct CustomData *data, int layer_n);
89 bool CustomData_layer_has_interp(const struct CustomData *data, int layer_n);
90
91 /**
92  * Checks if any of the customdata layers has math.
93  */
94 bool CustomData_has_math(const struct CustomData *data);
95 bool CustomData_has_interp(const struct CustomData *data);
96 bool CustomData_bmesh_has_free(const struct CustomData *data);
97
98 /**
99  * Checks if any of the customdata layers is referenced.
100  */
101 bool CustomData_has_referenced(const struct CustomData *data);
102
103 /* copies the "value" (e.g. mloopuv uv or mloopcol colors) from one block to
104  * another, while not overwriting anything else (e.g. flags).  probably only
105  * implemented for mloopuv/mloopcol, for now.*/
106 void CustomData_data_copy_value(int type, const void *source, void *dest);
107
108 /* Same as above, but doing advanced mixing. Only available for a few types of data (like colors...). */
109 void CustomData_data_mix_value(int type, const void *source, void *dest, const int mixmode, const float mixfactor);
110
111 /* compares if data1 is equal to data2.  type is a valid CustomData type
112  * enum (e.g. CD_MLOOPUV). the layer type's equal function is used to compare
113  * the data, if it exists, otherwise memcmp is used.*/
114 bool CustomData_data_equals(int type, const void *data1, const void *data2);
115 void CustomData_data_initminmax(int type, void *min, void *max);
116 void CustomData_data_dominmax(int type, const void *data, void *min, void *max);
117 void CustomData_data_multiply(int type, void *data, float fac);
118 void CustomData_data_add(int type, void *data1, const void *data2);
119
120 /* initializes a CustomData object with the same layer setup as source.
121  * mask is a bitfield where (mask & (1 << (layer type))) indicates
122  * if a layer should be copied or not. alloctype must be one of the above. */
123 void CustomData_copy(const struct CustomData *source, struct CustomData *dest,
124                      CustomDataMask mask, int alloctype, int totelem);
125
126 /* BMESH_TODO, not really a public function but readfile.c needs it */
127 void CustomData_update_typemap(struct CustomData *data);
128
129 /* same as the above, except that this will preserve existing layers, and only
130  * add the layers that were not there yet */
131 bool CustomData_merge(const struct CustomData *source, struct CustomData *dest,
132                       CustomDataMask mask, int alloctype, int totelem);
133
134 /* Reallocate custom data to a new element count.
135  * Only affects on data layers which are owned by the CustomData itself,
136  * referenced data is kept unchanged,
137  *
138  * NOTE: Take care of referenced layers by yourself!
139  */
140 void CustomData_realloc(struct CustomData *data, int totelem);
141
142 /* bmesh version of CustomData_merge; merges the layouts of source and dest,
143  * then goes through the mesh and makes sure all the customdata blocks are
144  * consistent with the new layout.*/
145 bool CustomData_bmesh_merge(
146         const struct CustomData *source, struct CustomData *dest,
147         CustomDataMask mask, int alloctype, struct BMesh *bm, const char htype);
148
149 /** NULL's all members and resets the typemap. */
150 void CustomData_reset(struct CustomData *data);
151
152 /** frees data associated with a CustomData object (doesn't free the object
153  * itself, though)
154  */
155 void CustomData_free(struct CustomData *data, int totelem);
156
157 /* same as above, but only frees layers which matches the given mask. */
158 void CustomData_free_typemask(struct CustomData *data, int totelem, CustomDataMask mask);
159
160 /* frees all layers with CD_FLAG_TEMPORARY */
161 void CustomData_free_temporary(struct CustomData *data, int totelem);
162
163 /* adds a data layer of the given type to the CustomData object, optionally
164  * backed by an external data array. the different allocation types are
165  * defined above. returns the data of the layer.
166  */
167 void *CustomData_add_layer(struct CustomData *data, int type, int alloctype,
168                            void *layer, int totelem);
169 /*same as above but accepts a name */
170 void *CustomData_add_layer_named(struct CustomData *data, int type, int alloctype,
171                                  void *layer, int totelem, const char *name);
172
173 /* frees the active or first data layer with the give type.
174  * returns 1 on success, 0 if no layer with the given type is found
175  *
176  * in editmode, use EDBM_data_layer_free instead of this function
177  */
178 bool CustomData_free_layer(struct CustomData *data, int type, int totelem, int index);
179
180 /* frees the layer index with the give type.
181  * returns 1 on success, 0 if no layer with the given type is found
182  *
183  * in editmode, use EDBM_data_layer_free instead of this function
184  */
185 bool CustomData_free_layer_active(struct CustomData *data, int type, int totelem);
186
187 /* same as above, but free all layers with type */
188 void CustomData_free_layers(struct CustomData *data, int type, int totelem);
189
190 /* returns 1 if a layer with the specified type exists */
191 bool CustomData_has_layer(const struct CustomData *data, int type);
192
193 /* returns the number of layers with this type */
194 int CustomData_number_of_layers(const struct CustomData *data, int type);
195 int CustomData_number_of_layers_typemask(const struct CustomData *data, CustomDataMask mask);
196
197 /* duplicate data of a layer with flag NOFREE, and remove that flag.
198  * returns the layer data */
199 void *CustomData_duplicate_referenced_layer(struct CustomData *data, const int type, const int totelem);
200 void *CustomData_duplicate_referenced_layer_n(struct CustomData *data, const int type, const int n, const int totelem);
201 void *CustomData_duplicate_referenced_layer_named(struct CustomData *data,
202                                                   const int type, const char *name, const int totelem);
203 bool CustomData_is_referenced_layer(struct CustomData *data, int type);
204
205 /* set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
206  * zero for the layer type, so only layer types specified by the mask
207  * will be copied
208  */
209 void CustomData_set_only_copy(const struct CustomData *data,
210                               CustomDataMask mask);
211
212 /* copies data from one CustomData object to another
213  * objects need not be compatible, each source layer is copied to the
214  * first dest layer of correct type (if there is none, the layer is skipped)
215  * return 1 on success, 0 on failure
216  */
217 void CustomData_copy_data(const struct CustomData *source,
218                           struct CustomData *dest, int source_index,
219                           int dest_index, int count);
220 void CustomData_copy_data_named(const struct CustomData *source,
221                           struct CustomData *dest, int source_index,
222                           int dest_index, int count);
223 void CustomData_copy_elements(int type, void *src_data_ofs, void *dst_data_ofs, int count);
224 void CustomData_bmesh_copy_data(const struct CustomData *source, 
225                                 struct CustomData *dest, void *src_block, 
226                                 void **dest_block);
227
228 /* frees data in a CustomData object
229  * return 1 on success, 0 on failure
230  */
231 void CustomData_free_elem(struct CustomData *data, int index, int count);
232
233 /* interpolates data from one CustomData object to another
234  * objects need not be compatible, each source layer is interpolated to the
235  * first dest layer of correct type (if there is none, the layer is skipped)
236  * if weights == NULL or sub_weights == NULL, they default to all 1's
237  *
238  * src_indices gives the source elements to interpolate from
239  * weights gives the weight for each source element
240  * sub_weights is an array of matrices of weights for sub-elements (matrices
241  *     should be source->subElems * source->subElems in size)
242  * count gives the number of source elements to interpolate from
243  * dest_index gives the dest element to write the interpolated value to
244  */
245 void CustomData_interp(
246         const struct CustomData *source, struct CustomData *dest,
247         const int *src_indices, const float *weights, const float *sub_weights,
248         int count, int dest_index);
249 void CustomData_bmesh_interp_n(
250         struct CustomData *data, const void **src_blocks, const float *weights,
251         const float *sub_weights, int count, void *dst_block_ofs, int n);
252 void CustomData_bmesh_interp(
253         struct CustomData *data, const void **src_blocks,
254         const float *weights, const float *sub_weights, int count,
255         void *dst_block);
256
257
258 /* swaps the data in the element corners, to new corners with indices as
259  * specified in corner_indices. for edges this is an array of length 2, for
260  * faces an array of length 4 */
261 void CustomData_swap_corners(struct CustomData *data, int index, const int *corner_indices);
262
263 void CustomData_swap(struct CustomData *data, const int index_a, const int index_b);
264
265 /* gets a pointer to the data element at index from the first layer of type
266  * returns NULL if there is no layer of type
267  */
268 void *CustomData_get(const struct CustomData *data, int index, int type);
269 void *CustomData_get_n(const struct CustomData *data, int type, int index, int n);
270 void *CustomData_bmesh_get(const struct CustomData *data, void *block, int type);
271 void *CustomData_bmesh_get_n(const struct CustomData *data, void *block, int type, int n);
272
273 /* gets the layer at physical index n, with no type checking.
274  */
275 void *CustomData_bmesh_get_layer_n(const struct CustomData *data, void *block, int n);
276
277 bool CustomData_set_layer_name(const struct CustomData *data, int type, int n, const char *name);
278 const char *CustomData_get_layer_name(const struct CustomData *data, int type, int n);
279
280 /* gets a pointer to the active or first layer of type
281  * returns NULL if there is no layer of type
282  */
283 void *CustomData_get_layer(const struct CustomData *data, int type);
284 void *CustomData_get_layer_n(const struct CustomData *data, int type, int n);
285 void *CustomData_get_layer_named(const struct CustomData *data, int type, const char *name);
286 int CustomData_get_offset(const struct CustomData *data, int type);
287 int CustomData_get_n_offset(const struct CustomData *data, int type, int n);
288
289 int CustomData_get_layer_index(const struct CustomData *data, int type);
290 int CustomData_get_layer_index_n(const struct CustomData *data, int type, int n);
291 int CustomData_get_named_layer_index(const struct CustomData *data, int type, const char *name);
292 int CustomData_get_active_layer_index(const struct CustomData *data, int type);
293 int CustomData_get_render_layer_index(const struct CustomData *data, int type);
294 int CustomData_get_clone_layer_index(const struct CustomData *data, int type);
295 int CustomData_get_stencil_layer_index(const struct CustomData *data, int type);
296 int CustomData_get_named_layer(const struct CustomData *data, int type, const char *name);
297 int CustomData_get_active_layer(const struct CustomData *data, int type);
298 int CustomData_get_render_layer(const struct CustomData *data, int type);
299 int CustomData_get_clone_layer(const struct CustomData *data, int type);
300 int CustomData_get_stencil_layer(const struct CustomData *data, int type);
301
302 /* copies the data from source to the data element at index in the first
303  * layer of type
304  * no effect if there is no layer of type
305  */
306 void CustomData_set(
307         const struct CustomData *data, int index, int type,
308         const void *source);
309
310 void CustomData_bmesh_set(
311         const struct CustomData *data, void *block, int type,
312         const void *source);
313
314 void CustomData_bmesh_set_n(
315         struct CustomData *data, void *block, int type, int n,
316         const void *source);
317 /* sets the data of the block at physical layer n.  no real type checking
318  * is performed.
319  */
320 void CustomData_bmesh_set_layer_n(
321         struct CustomData *data, void *block, int n,
322         const void *source);
323
324 /* set the pointer of to the first layer of type. the old data is not freed.
325  * returns the value of ptr if the layer is found, NULL otherwise
326  */
327 void *CustomData_set_layer(const struct CustomData *data, int type, void *ptr);
328 void *CustomData_set_layer_n(const struct CustomData *data, int type, int n, void *ptr);
329
330 /* sets the nth layer of type as active */
331 void CustomData_set_layer_active(struct CustomData *data, int type, int n);
332 void CustomData_set_layer_render(struct CustomData *data, int type, int n);
333 void CustomData_set_layer_clone(struct CustomData *data, int type, int n);
334 void CustomData_set_layer_stencil(struct CustomData *data, int type, int n);
335
336 /* same as above but works with an index from CustomData_get_layer_index */
337 void CustomData_set_layer_active_index(struct CustomData *data, int type, int n);
338 void CustomData_set_layer_render_index(struct CustomData *data, int type, int n);
339 void CustomData_set_layer_clone_index(struct CustomData *data, int type, int n);
340 void CustomData_set_layer_stencil_index(struct CustomData *data, int type, int n);
341
342 /* adds flag to the layer flags */
343 void CustomData_set_layer_flag(struct CustomData *data, int type, int flag);
344
345 void CustomData_bmesh_set_default(struct CustomData *data, void **block);
346 void CustomData_bmesh_free_block(struct CustomData *data, void **block);
347 void CustomData_bmesh_free_block_data(struct CustomData *data, void *block);
348
349 /* copy custom data to/from layers as in mesh/derivedmesh, to editmesh
350  * blocks of data. the CustomData's must not be compatible */
351 void CustomData_to_bmesh_block(const struct CustomData *source, 
352                                struct CustomData *dest, int src_index, void **dest_block, bool use_default_init);
353 void CustomData_from_bmesh_block(const struct CustomData *source, 
354                                  struct CustomData *dest, void *src_block, int dest_index);
355
356 void CustomData_file_write_prepare(
357         struct CustomData *data,
358         struct CustomDataLayer **r_write_layers, struct CustomDataLayer *write_layers_buff, size_t write_layers_size);
359
360 /* query info over types */
361 void CustomData_file_write_info(int type, const char **r_struct_name, int *r_struct_num);
362 int CustomData_sizeof(int type);
363
364 /* get the name of a layer type */
365 const char *CustomData_layertype_name(int type);
366 bool        CustomData_layertype_is_singleton(int type);
367 int         CustomData_layertype_layers_max(const int type);
368
369 /* make sure the name of layer at index is unique */
370 void CustomData_set_layer_unique_name(struct CustomData *data, int index);
371
372 void CustomData_validate_layer_name(const struct CustomData *data, int type, const char *name, char *outname);
373
374 /* for file reading compatibility, returns false if the layer was freed,
375  * only after this test passes, layer->data should be assigned */
376 bool CustomData_verify_versions(struct CustomData *data, int index);
377
378 /*BMesh specific customdata stuff*/
379 void CustomData_to_bmeshpoly(struct CustomData *fdata, struct CustomData *ldata, int totloop);
380 void CustomData_from_bmeshpoly(struct CustomData *fdata, struct CustomData *ldata, int total);
381 void CustomData_bmesh_update_active_layers(struct CustomData *fdata, struct CustomData *ldata);
382 void CustomData_bmesh_do_versions_update_active_layers(struct CustomData *fdata, struct CustomData *ldata);
383 void CustomData_bmesh_init_pool(struct CustomData *data, int totelem, const char htype);
384
385 #ifndef NDEBUG
386 bool CustomData_from_bmeshpoly_test(CustomData *fdata, CustomData *ldata, bool fallback);
387 #endif
388
389 /* External file storage */
390
391 void CustomData_external_add(struct CustomData *data,
392                              struct ID *id, int type, int totelem, const char *filename);
393 void CustomData_external_remove(struct CustomData *data,
394                                 struct ID *id, int type, int totelem);
395 bool CustomData_external_test(struct CustomData *data, int type);
396
397 void CustomData_external_write(struct CustomData *data,
398                                struct ID *id, CustomDataMask mask, int totelem, int free);
399 void CustomData_external_read(struct CustomData *data,
400                               struct ID *id, CustomDataMask mask, int totelem);
401 void CustomData_external_reload(struct CustomData *data,
402                                 struct ID *id, CustomDataMask mask, int totelem);
403
404 /* Mesh-to-mesh transfer data. */
405
406 struct MeshPairRemap;
407 struct CustomDataTransferLayerMap;
408
409 typedef void (*cd_datatransfer_interp)(
410         const struct CustomDataTransferLayerMap *laymap, void *dest,
411         const void **sources, const float *weights, const int count, const float mix_factor);
412
413 /**
414  * Fake CD_LAYERS (those are actually 'real' data stored directly into elements' structs, or otherwise not (directly)
415  * accessible to usual CDLayer system). */
416 enum {
417         CD_FAKE             = 1 << 8,
418
419         /* Vertices. */
420         CD_FAKE_MDEFORMVERT = CD_FAKE | CD_MDEFORMVERT,  /* *sigh* due to how vgroups are stored :( . */
421         CD_FAKE_SHAPEKEY    = CD_FAKE | CD_SHAPEKEY,  /* Not available as real CD layer in non-bmesh context. */
422
423         /* Edges. */
424         CD_FAKE_SEAM        = CD_FAKE | 100,  /* UV seam flag for edges. */
425         CD_FAKE_CREASE      = CD_FAKE | CD_CREASE,  /* *sigh*. */
426
427         /* Multiple types of mesh elements... */
428         CD_FAKE_BWEIGHT     = CD_FAKE | CD_BWEIGHT,  /* *sigh*. */
429         CD_FAKE_UV          = CD_FAKE | CD_MLOOPUV,  /* UV flag, because we handle both loop's UVs and poly's textures. */
430
431         CD_FAKE_LNOR        = CD_FAKE | CD_CUSTOMLOOPNORMAL,  /* Because we play with clnor and temp lnor layers here. */
432
433         CD_FAKE_SHARP       = CD_FAKE | 200,  /* Sharp flag for edges, smooth flag for faces. */
434 };
435
436 enum {
437         ME_VERT = 1 << 0,
438         ME_EDGE = 1 << 1,
439         ME_POLY = 1 << 2,
440         ME_LOOP = 1 << 3,
441 };
442
443 /**
444  * How to filter out some elements (to leave untouched).
445  * Note those options are highly dependent on type of transferred data! */
446 enum {
447         CDT_MIX_NOMIX                   = -1,  /* Special case, only used because we abuse 'copy' CD callback. */
448         CDT_MIX_TRANSFER                = 0,
449         CDT_MIX_REPLACE_ABOVE_THRESHOLD = 1,
450         CDT_MIX_REPLACE_BELOW_THRESHOLD = 2,
451         CDT_MIX_MIX                     = 16,
452         CDT_MIX_ADD                     = 17,
453         CDT_MIX_SUB                     = 18,
454         CDT_MIX_MUL                     = 19,
455         /* etc. etc. */
456 };
457
458 typedef struct CustomDataTransferLayerMap {
459         struct CustomDataTransferLayerMap *next, *prev;
460
461         int data_type;
462         int mix_mode;
463         float mix_factor;
464         const float *mix_weights;  /* If non-NULL, array of weights, one for each dest item, replaces mix_factor. */
465
466         const void *data_src;  /* Data source array (can be regular CD data, vertices/edges/etc., keyblocks...). */
467         void *data_dst;      /* Data dest array (same type as dat_src). */
468         int   data_src_n;    /* Index to affect in data_src (used e.g. for vgroups). */
469         int   data_dst_n;    /* Index to affect in data_dst (used e.g. for vgroups). */
470         size_t elem_size;    /* Size of one element of data_src/data_dst. */
471
472         size_t data_size;    /* Size of actual data we transfer. */
473         size_t data_offset;  /* Offset of actual data we transfer (in element contained in data_src/dst). */
474         uint64_t data_flag;  /* For bitflag transfer, flag(s) to affect in transfered data. */
475
476         void *interp_data;   /* Opaque pointer, to be used by specific interp callback (e.g. transformspace for normals). */
477
478         cd_datatransfer_interp interp;
479 } CustomDataTransferLayerMap;
480
481 /* Those functions assume src_n and dst_n layers of given type exist in resp. src and dst. */
482 void CustomData_data_transfer(const struct MeshPairRemap *me_remap, const CustomDataTransferLayerMap *laymap);
483
484 #ifdef __cplusplus
485 }
486 #endif
487
488 #endif
489