Merged revision(s) 57979-58058 from trunk/blender into soc-2013-dingto
[blender.git] / source / blender / blenkernel / BKE_deform.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_DEFORM_H__
29 #define __BKE_DEFORM_H__
30
31 /** \file BKE_deform.h
32  *  \ingroup bke
33  *  \since June 2001
34  *  \author Reevan McKay et al
35  *  \brief support for deformation groups and hooks.
36  */
37
38 struct Object;
39 struct ListBase;
40 struct bDeformGroup;
41 struct MDeformVert;
42
43 struct bDeformGroup *BKE_defgroup_new(struct Object *ob, const char *name);
44 void                 defgroup_copy_list(struct ListBase *lb1, struct ListBase *lb2);
45 struct bDeformGroup *defgroup_duplicate(struct bDeformGroup *ingroup);
46 struct bDeformGroup *defgroup_find_name(struct Object *ob, const char *name);
47 int                 *defgroup_flip_map(struct Object *ob, int *flip_map_len, const bool use_default);
48 int                 *defgroup_flip_map_single(struct Object *ob, int *flip_map_len, const bool use_default, int defgroup);
49 int                  defgroup_flip_index(struct Object *ob, int index, const bool use_default);
50 int                  defgroup_name_index(struct Object *ob, const char *name);
51 void                 defgroup_unique_name(struct bDeformGroup *dg, struct Object *ob);
52
53 struct MDeformWeight    *defvert_find_index(const struct MDeformVert *dv, const int defgroup);
54 struct MDeformWeight    *defvert_verify_index(struct MDeformVert *dv, const int defgroup);
55 void                     defvert_add_index_notest(struct MDeformVert *dv, int defgroup, const float weight);
56 void                     defvert_remove_group(struct MDeformVert *dvert, struct MDeformWeight *dw);
57 void                     defvert_clear(struct MDeformVert *dvert);
58 int                      defvert_find_shared(const struct MDeformVert *dvert_a, const struct MDeformVert *dvert_b);
59 bool                     defvert_is_weight_zero(const struct MDeformVert *dvert, const int defgroup_tot);
60
61 void BKE_defvert_array_free_elems(struct MDeformVert *dvert, int totvert);
62 void BKE_defvert_array_free(struct MDeformVert *dvert, int totvert);
63 void BKE_defvert_array_copy(struct MDeformVert *dst, const struct MDeformVert *src, int totvert);
64
65 float  defvert_find_weight(const struct MDeformVert *dvert, const int defgroup);
66 float  defvert_array_find_weight_safe(const struct MDeformVert *dvert, const int index, const int defgroup);
67
68 void defvert_copy(struct MDeformVert *dvert_dst, const struct MDeformVert *dvert_src);
69 void defvert_copy_subset(struct MDeformVert *dvert_dst, const struct MDeformVert *dvert_src,
70                          const bool *vgroup_subset, const int vgroup_tot);
71 void defvert_copy_index(struct MDeformVert *dvert_dst, const struct MDeformVert *dvert_src, const int defgroup);
72 void defvert_sync(struct MDeformVert *dvert_dst, const struct MDeformVert *dvert_src, const bool use_verify);
73 void defvert_sync_mapped(struct MDeformVert *dvert_dst, const struct MDeformVert *dvert_src,
74                          const int *flip_map, const int flip_map_len, const bool use_verify);
75 void defvert_remap(struct MDeformVert *dvert, int *map, const int map_len);
76 void defvert_flip(struct MDeformVert *dvert, const int *flip_map, const int flip_map_len);
77 void defvert_flip_merged(struct MDeformVert *dvert, const int *flip_map, const int flip_map_len);
78 void defvert_normalize(struct MDeformVert *dvert);
79 void defvert_normalize_subset(struct MDeformVert *dvert,
80                               const bool *vgroup_subset, const int vgroup_tot);
81 void defvert_normalize_lock_single(struct MDeformVert *dvert, const int def_nr_lock);
82 void defvert_normalize_lock_map(struct MDeformVert *dvert, const bool *lock_flags, const int defbase_tot);
83
84 /* utility function, note that MAX_VGROUP_NAME chars is the maximum string length since its only
85  * used with defgroups currently */
86
87 void BKE_deform_split_suffix(const char string[MAX_VGROUP_NAME], char base[MAX_VGROUP_NAME], char ext[MAX_VGROUP_NAME]);
88 void BKE_deform_split_prefix(const char string[MAX_VGROUP_NAME], char base[MAX_VGROUP_NAME], char ext[MAX_VGROUP_NAME]);
89
90 void flip_side_name(char name[MAX_VGROUP_NAME], const char from_name[MAX_VGROUP_NAME], int strip_number);
91
92 #endif  /* __BKE_DEFORM_H__ */