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