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