made BLI_edgefill returns the list length since some callers count directly after...
[blender.git] / source / blender / blenkernel / BKE_customdata.h
1 /*
2 * $Id$
3 *
4 * ***** BEGIN GPL LICENSE BLOCK *****
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software  Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 *
20 * The Original Code is Copyright (C) 2006 Blender Foundation.
21 * All rights reserved.
22 *
23 * The Original Code is: all of this file.
24 *
25 * Contributor(s): Ben Batt <benbatt@gmail.com>
26 *
27 * ***** END GPL LICENSE BLOCK *****
28 */ 
29
30 /** \file BKE_customdata.h
31  *  \ingroup bke
32  *  \author Ben Batt
33  *  \brief CustomData interface, see also DNA_customdata_types.h.
34  */
35
36 #ifndef BKE_CUSTOMDATA_H
37 #define BKE_CUSTOMDATA_H
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 struct ID;
44 struct CustomData;
45 struct CustomDataLayer;
46 typedef unsigned int 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 /* initialises a CustomData object with the same layer setup as source.
71  * mask is a bitfield where (mask & (1 << (layer type))) indicates
72  * if a layer should be copied or not. alloctype must be one of the above. */
73 void CustomData_copy(const struct CustomData *source, struct CustomData *dest,
74                                          CustomDataMask mask, int alloctype, int totelem);
75
76 /* same as the above, except that this will preserve existing layers, and only
77  * add the layers that were not there yet */
78 void CustomData_merge(const struct CustomData *source, struct CustomData *dest,
79                                           CustomDataMask mask, int alloctype, int totelem);
80
81 /* frees data associated with a CustomData object (doesn't free the object
82  * itself, though)
83  */
84 void CustomData_free(struct CustomData *data, int totelem);
85
86 /* frees all layers with CD_FLAG_TEMPORARY */
87 void CustomData_free_temporary(struct CustomData *data, int totelem);
88
89 /* adds a data layer of the given type to the CustomData object, optionally
90  * backed by an external data array. the different allocation types are
91  * defined above. returns the data of the layer.
92  *
93  * in editmode, use EM_add_data_layer instead of this function
94  */
95 void *CustomData_add_layer(struct CustomData *data, int type, int alloctype,
96                                                    void *layer, int totelem);
97 /*same as above but accepts a name */
98 void *CustomData_add_layer_named(struct CustomData *data, int type, int alloctype,
99                                                    void *layer, int totelem, const char *name);
100
101 /* frees the active or first data layer with the give type.
102  * returns 1 on succes, 0 if no layer with the given type is found
103  *
104  * in editmode, use EM_free_data_layer instead of this function
105  */
106 int CustomData_free_layer(struct CustomData *data, int type, int totelem, int index);
107
108 /* frees the layer index with the give type.
109  * returns 1 on succes, 0 if no layer with the given type is found
110  *
111  * in editmode, use EM_free_data_layer instead of this function
112  */
113 int CustomData_free_layer_active(struct CustomData *data, int type, int totelem);
114
115 /* same as above, but free all layers with type */
116 void CustomData_free_layers(struct CustomData *data, int type, int totelem);
117
118 /* returns 1 if a layer with the specified type exists */
119 int CustomData_has_layer(const struct CustomData *data, int type);
120
121 /* returns the number of layers with this type */
122 int CustomData_number_of_layers(const struct CustomData *data, int type);
123
124 /* duplicate data of a layer with flag NOFREE, and remove that flag.
125  * returns the layer data */
126 void *CustomData_duplicate_referenced_layer(struct CustomData *data, int type);
127 void *CustomData_duplicate_referenced_layer_named(struct CustomData *data,
128                                                                                                   int type, const char *name);
129
130 /* set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
131  * zero for the layer type, so only layer types specified by the mask
132  * will be copied
133  */
134 void CustomData_set_only_copy(const struct CustomData *data,
135                                                           CustomDataMask mask);
136
137 /* copies data from one CustomData object to another
138  * objects need not be compatible, each source layer is copied to the
139  * first dest layer of correct type (if there is none, the layer is skipped)
140  * return 1 on success, 0 on failure
141  */
142 void CustomData_copy_data(const struct CustomData *source,
143                                                   struct CustomData *dest, int source_index,
144                                                   int dest_index, int count);
145 void CustomData_em_copy_data(const struct CustomData *source,
146                                                         struct CustomData *dest, void *src_block,
147                                                         void **dest_block);
148 void CustomData_bmesh_copy_data(const struct CustomData *source, 
149                                                         struct CustomData *dest,void *src_block, 
150                                                         void **dest_block);
151 void CustomData_em_validate_data(struct CustomData *data, void *block, int sub_elements);
152
153 /* frees data in a CustomData object
154  * return 1 on success, 0 on failure
155  */
156 void CustomData_free_elem(struct CustomData *data, int index, int count);
157
158 /* interpolates data from one CustomData object to another
159  * objects need not be compatible, each source layer is interpolated to the
160  * first dest layer of correct type (if there is none, the layer is skipped)
161  * if weights == NULL or sub_weights == NULL, they default to all 1's
162  *
163  * src_indices gives the source elements to interpolate from
164  * weights gives the weight for each source element
165  * sub_weights is an array of matrices of weights for sub-elements (matrices
166  *     should be source->subElems * source->subElems in size)
167  * count gives the number of source elements to interpolate from
168  * dest_index gives the dest element to write the interpolated value to
169  *
170  * returns 1 on success, 0 on failure
171  */
172 void CustomData_interp(const struct CustomData *source, struct CustomData *dest,
173                                            int *src_indices, float *weights, float *sub_weights,
174                                            int count, int dest_index);
175 void CustomData_em_interp(struct CustomData *data,  void **src_blocks,
176                                                   float *weights, float *sub_weights, int count,
177                                                   void *dest_block);
178 void CustomData_bmesh_interp(struct CustomData *data, void **src_blocks, 
179                                                          float *weights, float *sub_weights, int count, 
180                                                          void *dest_block);
181
182
183 /* swaps the data in the element corners, to new corners with indices as
184    specified in corner_indices. for edges this is an array of length 2, for
185    faces an array of length 4 */
186 void CustomData_swap(struct CustomData *data, int index, const int *corner_indices);
187
188 /* gets a pointer to the data element at index from the first layer of type
189  * returns NULL if there is no layer of type
190  */
191 void *CustomData_get(const struct CustomData *data, int index, int type);
192 void *CustomData_em_get(const struct CustomData *data, void *block, int type);
193 void *CustomData_em_get_n(const struct CustomData *data, void *block, int type, int n);
194 void *CustomData_bmesh_get(const struct CustomData *data, void *block, int type);
195 void *CustomData_bmesh_get_n(const struct CustomData *data, void *block, int type, int n);
196
197 /* gets a pointer to the active or first layer of type
198  * returns NULL if there is no layer of type
199  */
200 void *CustomData_get_layer(const struct CustomData *data, int type);
201 void *CustomData_get_layer_n(const struct CustomData *data, int type, int n);
202 void *CustomData_get_layer_named(const struct CustomData *data, int type,
203                                                                  const char *name);
204
205 int CustomData_get_layer_index(const struct CustomData *data, int type);
206 int CustomData_get_named_layer_index(const struct CustomData *data, int type, const char *name);
207 int CustomData_get_active_layer_index(const struct CustomData *data, int type);
208 int CustomData_get_render_layer_index(const struct CustomData *data, int type);
209 int CustomData_get_clone_layer_index(const struct CustomData *data, int type);
210 int CustomData_get_stencil_layer_index(const struct CustomData *data, int type);
211 int CustomData_get_active_layer(const struct CustomData *data, int type);
212 int CustomData_get_render_layer(const struct CustomData *data, int type);
213 int CustomData_get_clone_layer(const struct CustomData *data, int type);
214 int CustomData_get_stencil_layer(const struct CustomData *data, int type);
215
216 /* copies the data from source to the data element at index in the first
217  * layer of type
218  * no effect if there is no layer of type
219  */
220 void CustomData_set(const struct CustomData *data, int index, int type,
221                                         void *source);
222 void CustomData_em_set(struct CustomData *data, void *block, int type,
223                                            void *source);
224 void CustomData_em_set_n(struct CustomData *data, void *block, int type, int n,
225                                                  void *source);
226
227 void CustomData_bmesh_set(const struct CustomData *data, void *block, int type, 
228                                                   void *source);
229
230 void CustomData_bmesh_set_n(struct CustomData *data, void *block, int type, int n, 
231                                                         void *source);
232
233 /* set the pointer of to the first layer of type. the old data is not freed.
234  * returns the value of ptr if the layer is found, NULL otherwise
235  */
236 void *CustomData_set_layer(const struct CustomData *data, int type, void *ptr);
237 void *CustomData_set_layer_n(const struct CustomData *data, int type, int n, void *ptr);
238
239 /* sets the nth layer of type as active */
240 void CustomData_set_layer_active(struct CustomData *data, int type, int n);
241 void CustomData_set_layer_render(struct CustomData *data, int type, int n);
242 void CustomData_set_layer_clone(struct CustomData *data, int type, int n);
243 void CustomData_set_layer_stencil(struct CustomData *data, int type, int n);
244
245 /* same as above but works with an index from CustomData_get_layer_index */
246 void CustomData_set_layer_active_index(struct CustomData *data, int type, int n);
247 void CustomData_set_layer_render_index(struct CustomData *data, int type, int n);
248 void CustomData_set_layer_clone_index(struct CustomData *data, int type, int n);
249 void CustomData_set_layer_stencil_index(struct CustomData *data, int type, int n);
250
251 /* adds flag to the layer flags */
252 void CustomData_set_layer_flag(struct CustomData *data, int type, int flag);
253
254 /* alloc/free a block of custom data attached to one element in editmode */
255 void CustomData_em_set_default(struct CustomData *data, void **block);
256 void CustomData_em_free_block(struct CustomData *data, void **block);
257
258 void CustomData_bmesh_set_default(struct CustomData *data, void **block);
259 void CustomData_bmesh_free_block(struct CustomData *data, void **block);
260
261 /* copy custom data to/from layers as in mesh/derivedmesh, to editmesh
262    blocks of data. the CustomData's must not be compatible  */
263 void CustomData_to_em_block(const struct CustomData *source,
264                                                         struct CustomData *dest, int index, void **block);
265 void CustomData_from_em_block(const struct CustomData *source,
266                                                           struct CustomData *dest, void *block, int index);
267 void CustomData_to_bmesh_block(const struct CustomData *source, 
268                                                         struct CustomData *dest, int src_index, void **dest_block);
269 void CustomData_from_bmesh_block(const struct CustomData *source, 
270                                                         struct CustomData *dest, void *src_block, int dest_index);
271
272
273 /* query info over types */
274 void CustomData_file_write_info(int type, const char **structname, int *structnum);
275 int CustomData_sizeof(int type);
276
277 /* get the name of a layer type */
278 const char *CustomData_layertype_name(int type);
279
280 /* make sure the name of layer at index is unique */
281 void CustomData_set_layer_unique_name(struct CustomData *data, int index);
282
283 /* for file reading compatibility, returns false if the layer was freed,
284    only after this test passes, layer->data should be assigned */
285 int CustomData_verify_versions(struct CustomData *data, int index);
286
287 /*BMesh specific customdata stuff*/
288 void CustomData_to_bmeshpoly(struct CustomData *fdata, struct CustomData *pdata, struct CustomData *ldata);
289 void CustomData_from_bmeshpoly(struct CustomData *fdata, struct CustomData *pdata, struct CustomData *ldata, int total);
290 void CustomData_bmesh_init_pool(struct CustomData *data, int allocsize);
291
292 /* External file storage */
293
294 void CustomData_external_add(struct CustomData *data,
295         struct ID *id, int type, int totelem, const char *filename);
296 void CustomData_external_remove(struct CustomData *data,
297         struct ID *id, int type, int totelem);
298 int CustomData_external_test(struct CustomData *data, int type);
299
300 void CustomData_external_write(struct CustomData *data,
301         struct ID *id, CustomDataMask mask, int totelem, int free);
302 void CustomData_external_read(struct CustomData *data,
303         struct ID *id, CustomDataMask mask, int totelem);
304 void CustomData_external_reload(struct CustomData *data,
305         struct ID *id, CustomDataMask mask, int totelem);
306
307 #ifdef __cplusplus
308 }
309 #endif
310
311 #endif
312