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