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