doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_object_facemap.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BKE_OBJECT_FACEMAP_H__
18 #define __BKE_OBJECT_FACEMAP_H__
19
20 /** \file
21  * \ingroup bke
22  * \brief Functions for dealing with object face-maps.
23  */
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 struct ListBase;
30 struct Object;
31 struct bFaceMap;
32
33 struct bFaceMap *BKE_object_facemap_add(struct Object *ob);
34 struct bFaceMap *BKE_object_facemap_add_name(struct Object *ob, const char *name);
35 void             BKE_object_facemap_remove(struct Object *ob, struct bFaceMap *fmap);
36 void             BKE_object_facemap_clear(struct Object *ob);
37
38 int              BKE_object_facemap_name_index(struct Object *ob, const char *name);
39 void             BKE_object_facemap_unique_name(struct Object *ob, struct bFaceMap *fmap);
40 struct bFaceMap *BKE_object_facemap_find_name(struct Object *ob, const char *name);
41 void             BKE_object_facemap_copy_list(struct ListBase *outbase, const struct ListBase *inbase);
42
43 #ifdef __cplusplus
44 }
45 #endif
46
47 #endif /* __BKE_OBJECT_FACEMAP_H__ */