Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / bmesh / intern / bmesh_mesh_conv.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  * The Original Code is Copyright (C) 2004 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BMESH_MESH_CONV_H__
21 #define __BMESH_MESH_CONV_H__
22
23 /** \file \ingroup bmesh
24  */
25
26 struct Main;
27 struct Mesh;
28
29 void BM_mesh_cd_flag_ensure(BMesh *bm, struct Mesh *mesh, const char cd_flag);
30 void BM_mesh_cd_flag_apply(BMesh *bm, const char cd_flag);
31 char BM_mesh_cd_flag_from_bmesh(BMesh *bm);
32
33 struct BMeshFromMeshParams {
34         uint calc_face_normal : 1;
35         /* add a vertex CD_SHAPE_KEYINDEX layer */
36         uint add_key_index : 1;
37         /* set vertex coordinates from the shapekey */
38         uint use_shapekey : 1;
39         /* define the active shape key (index + 1) */
40         int active_shapekey;
41         int64_t cd_mask_extra;
42 };
43 void BM_mesh_bm_from_me(
44         BMesh *bm, const struct Mesh *me,
45         const struct BMeshFromMeshParams *params)
46 ATTR_NONNULL(1, 3);
47
48 struct BMeshToMeshParams {
49         /** Update object hook indices & vertex parents. */
50         uint calc_object_remap : 1;
51         int64_t cd_mask_extra;
52 };
53 void BM_mesh_bm_to_me(
54         struct Main *bmain, BMesh *bm, struct Mesh *me,
55         const struct BMeshToMeshParams *params)
56 ATTR_NONNULL(2, 3, 4);
57
58 void BM_mesh_bm_to_me_for_eval(
59         BMesh *bm, struct Mesh *me, const int64_t cd_mask_extra)
60 ATTR_NONNULL(1, 2);
61
62
63 #endif /* __BMESH_MESH_CONV_H__ */