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