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