Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_object_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  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BKE_OBJECT_DEFORM_H__
24 #define __BKE_OBJECT_DEFORM_H__
25
26 /** \file BKE_object_deform.h
27  * \ingroup bke
28  * \brief Functions for dealing with objects and deform verts,
29  *        used by painting and tools.
30  */
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 struct Object;
37 struct ID;
38 struct MDeformVert;
39 struct bDeformGroup;
40
41 /* General vgroup operations */
42 void BKE_object_defgroup_remap_update_users(struct Object *ob, int *map);
43
44 bool BKE_object_defgroup_array_get(struct ID *id, struct MDeformVert **dvert_arr, int *dvert_tot);
45
46 struct bDeformGroup *BKE_object_defgroup_add(struct Object *ob);
47 struct bDeformGroup *BKE_object_defgroup_add_name(struct Object *ob, const char *name);
48 struct MDeformVert  *BKE_object_defgroup_data_create(struct ID *id);
49
50 bool BKE_object_defgroup_clear(struct Object *ob, struct bDeformGroup *dg, const bool use_selection);
51 bool BKE_object_defgroup_clear_all(struct Object *ob, const bool use_selection);
52
53 void BKE_object_defgroup_remove(struct Object *ob, struct bDeformGroup *defgroup);
54 void BKE_object_defgroup_remove_all_ex(struct Object *ob, bool only_unlocked);
55 void BKE_object_defgroup_remove_all(struct Object *ob);
56
57 int *BKE_object_defgroup_index_map_create(struct Object *ob_src, struct Object *ob_dst, int *r_map_len);
58 void BKE_object_defgroup_index_map_apply(struct MDeformVert *dvert, int dvert_len, const int *map, int map_len);
59
60 /* Select helpers */
61 enum eVGroupSelect;
62 bool *BKE_object_defgroup_subset_from_select_type(
63         struct Object *ob, enum eVGroupSelect subset_type, int *r_defgroup_tot, int *r_subset_count);
64 void BKE_object_defgroup_subset_to_index_array(
65         const bool *defgroup_validmap, const int defgroup_tot, int *r_defgroup_subset_map);
66
67
68 /* ********** */
69
70 bool *BKE_object_defgroup_lock_flags_get(struct Object *ob, const int defbase_tot);
71 bool *BKE_object_defgroup_validmap_get(struct Object *ob, const int defbase_tot);
72 bool *BKE_object_defgroup_selected_get(struct Object *ob, int defbase_tot, int *r_dg_flags_sel_tot);
73
74 void BKE_object_defgroup_mirror_selection(
75         struct Object *ob, int defbase_tot, const bool *selection,
76         bool *dg_flags_sel, int *r_dg_flags_sel_tot);
77
78 #ifdef __cplusplus
79 }
80 #endif
81
82 /* Select helpers */
83 bool *BKE_objdef_vgroup_subset_from_select_type(
84         struct Object *ob, enum eVGroupSelect subset_type, int *r_vgroup_tot, int *r_subset_count);
85 void BKE_objdef_vgroup_subset_to_index_array(
86         const bool *vgroup_validmap, const int vgroup_tot, int *r_vgroup_subset_map);
87
88
89 #endif  /* __BKE_OBJECT_DEFORM_H__ */