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