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