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