Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / BKE_mesh_runtime.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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_MESH_RUNTIME_H__
20 #define __BKE_MESH_RUNTIME_H__
21
22 /** \file \ingroup bke
23  *
24  * This file contains access functions for the Mesh.runtime struct.
25  */
26
27 #include "BKE_customdata.h"  /* for CustomDataMask */
28
29 struct ColorBand;
30 struct CustomData;
31 struct Depsgraph;
32 struct KeyBlock;
33 struct MLoop;
34 struct MLoopTri;
35 struct MVertTri;
36 struct Mesh;
37 struct Object;
38 struct Scene;
39
40 /* Undefine to hide DerivedMesh-based function declarations */
41 #undef USE_DERIVEDMESH
42
43 #ifdef USE_DERIVEDMESH
44 struct DerivedMesh;
45 #endif
46
47 void BKE_mesh_runtime_reset(struct Mesh *mesh);
48 void BKE_mesh_runtime_reset_on_copy(struct Mesh *mesh);
49 int BKE_mesh_runtime_looptri_len(const struct Mesh *mesh);
50 void BKE_mesh_runtime_looptri_recalc(struct Mesh *mesh);
51 const struct MLoopTri *BKE_mesh_runtime_looptri_ensure(struct Mesh *mesh);
52 bool BKE_mesh_runtime_ensure_edit_data(struct Mesh *mesh);
53 bool BKE_mesh_runtime_clear_edit_data(struct Mesh *mesh);
54 void BKE_mesh_runtime_clear_geometry(struct Mesh *mesh);
55 void BKE_mesh_runtime_clear_cache(struct Mesh *mesh);
56
57 void BKE_mesh_runtime_verttri_from_looptri(
58         struct MVertTri *r_verttri,
59         const struct MLoop *mloop, const struct MLoopTri *looptri, int looptri_num);
60
61 /* NOTE: the functions below are defined in DerivedMesh.c, and are intended to be moved
62  * to a more suitable location when that file is removed.
63  * They should also be renamed to use conventions from BKE, not old DerivedMesh.c.
64  * For now keep the names similar to avoid confusion. */
65 #ifdef USE_DERIVEDMESH
66 struct DerivedMesh *mesh_get_derived_final(
67         struct Depsgraph *depsgraph, struct Scene *scene,
68         struct Object *ob, CustomDataMask dataMask);
69 #endif
70 struct Mesh *mesh_get_eval_final(
71         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, CustomDataMask dataMask);
72
73 #ifdef USE_DERIVEDMESH
74 struct DerivedMesh *mesh_get_derived_deform(
75         struct Depsgraph *depsgraph, struct Scene *scene,
76         struct Object *ob, CustomDataMask dataMask);
77 #endif
78 struct Mesh *mesh_get_eval_deform(
79         struct Depsgraph *depsgraph, struct Scene *scene,
80         struct Object *ob, CustomDataMask dataMask);
81
82 struct Mesh *mesh_create_eval_final_render(
83         struct Depsgraph *depsgraph, struct Scene *scene,
84         struct Object *ob, CustomDataMask dataMask);
85
86 #ifdef USE_DERIVEDMESH
87 struct DerivedMesh *mesh_create_derived_index_render(
88         struct Depsgraph *depsgraph, struct Scene *scene,
89         struct Object *ob, CustomDataMask dataMask, int index);
90 #endif
91 struct Mesh *mesh_create_eval_final_index_render(
92         struct Depsgraph *depsgraph, struct Scene *scene,
93         struct Object *ob, CustomDataMask dataMask, int index);
94
95 #ifdef USE_DERIVEDMESH
96 struct DerivedMesh *mesh_create_derived_view(
97         struct Depsgraph *depsgraph, struct Scene *scene,
98         struct Object *ob, CustomDataMask dataMask);
99 #endif
100 struct Mesh *mesh_create_eval_final_view(
101         struct Depsgraph *depsgraph, struct Scene *scene,
102         struct Object *ob, CustomDataMask dataMask);
103
104 struct Mesh *mesh_create_eval_no_deform(
105         struct Depsgraph *depsgraph, struct Scene *scene,
106         struct Object *ob, float (*vertCos)[3],
107         CustomDataMask dataMask);
108 struct Mesh *mesh_create_eval_no_deform_render(
109         struct Depsgraph *depsgraph, struct Scene *scene,
110         struct Object *ob, float (*vertCos)[3],
111         CustomDataMask dataMask);
112
113
114 void BKE_mesh_runtime_eval_to_meshkey(struct Mesh *me_deformed, struct Mesh *me, struct KeyBlock *kb);
115
116
117 #ifndef NDEBUG
118 char *BKE_mesh_runtime_debug_info(struct Mesh *me_eval);
119 void BKE_mesh_runtime_debug_print(struct Mesh *me_eval);
120 void BKE_mesh_runtime_debug_print_cdlayers(struct CustomData *data);
121 bool BKE_mesh_runtime_is_valid(struct Mesh *me_eval);
122 #endif  /* NDEBUG */
123
124 #endif /* __BKE_MESH_RUNTIME_H__ */