doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_cdderivedmesh.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) 2006 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  * \section aboutcdderivedmesh CDDerivedMesh interface
23  *   CDDerivedMesh (CD = Custom Data) is a DerivedMesh backend which stores
24  *   mesh elements (vertices, edges and faces) as layers of custom element data.
25  */
26
27 #ifndef __BKE_CDDERIVEDMESH_H__
28 #define __BKE_CDDERIVEDMESH_H__
29
30 #include "BKE_DerivedMesh.h"
31 #include "BKE_customdata.h"
32
33 struct BMEditMesh;
34 struct DerivedMesh;
35 struct MLoopNorSpaceArray;
36 struct Mesh;
37 struct Object;
38
39 /* creates a new CDDerivedMesh */
40 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces,
41                              int numLoops, int numPolys);
42
43 /* creates a CDDerivedMesh from the given Mesh, this will reference the
44  * original data in Mesh, but it is safe to apply vertex coordinates or
45  * calculate normals as those functions will automatically create new
46  * data to not overwrite the original */
47 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh);
48
49 /* creates a CDDerivedMesh from the given Mesh with custom allocation type. */
50 struct DerivedMesh *CDDM_from_mesh_ex(struct Mesh *mesh, eCDAllocType alloctype, CustomDataMask mask);
51
52
53 struct DerivedMesh *CDDM_from_bmesh(struct BMesh *bm, const bool use_mdisps);
54
55 /* creates a CDDerivedMesh from the given BMEditMesh */
56 DerivedMesh *CDDM_from_editbmesh(struct BMEditMesh *em, const bool use_mdisps, const bool use_tessface);
57
58 /* creates a CDDerivedMesh from the given curve object */
59 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
60
61 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
62 /* useful for OrcoDM creation for curves with constructive modifiers */
63 DerivedMesh *CDDM_from_curve_displist(struct Object *ob, struct ListBase *dispbase);
64
65 /* Copies the given DerivedMesh with verts, faces & edges stored as
66  * custom element data.
67  */
68 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm);
69
70 /* creates a CDDerivedMesh with the same layer stack configuration as the
71  * given DerivedMesh and containing the requested numbers of elements.
72  * elements are initialized to all zeros
73  */
74 struct DerivedMesh *CDDM_from_template_ex(
75         struct DerivedMesh *source,
76         int numVerts, int numEdges, int numFaces,
77         int numLoops, int numPolys,
78         CustomDataMask mask);
79 struct DerivedMesh *CDDM_from_template(
80         struct DerivedMesh *source,
81         int numVerts, int numEdges, int numFaces,
82         int numLoops, int numPolys);
83
84 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
85  * layer is a referenced layer, it will be duplicate to not overwrite the
86  * original
87  */
88 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
89 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
90
91 /* recalculates vertex and face normals for a CDDerivedMesh
92  */
93 void CDDM_calc_normals_mapping_ex(struct DerivedMesh *dm, const bool only_face_normals);
94 void CDDM_calc_normals_mapping(struct DerivedMesh *dm);
95 void CDDM_calc_normals(struct DerivedMesh *dm);
96
97 void CDDM_calc_loop_normals(struct DerivedMesh *dm, const bool use_split_normals, const float split_angle);
98 void CDDM_calc_loop_normals_spacearr(struct DerivedMesh *dm, const bool use_split_normals, const float split_angle,
99                                      struct MLoopNorSpaceArray *r_lnors_spacearr);
100
101 /* reconstitute face triangulation */
102 void CDDM_recalc_tessellation(struct DerivedMesh *dm);
103 void CDDM_recalc_tessellation_ex(struct DerivedMesh *dm, const bool do_face_nor_cpy);
104
105 void CDDM_recalc_looptri(struct DerivedMesh *dm);
106
107 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
108  * the layer data stays the same size
109  */
110 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
111 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
112 void CDDM_lower_num_loops(struct DerivedMesh *dm, int numLoops);
113 void CDDM_lower_num_polys(struct DerivedMesh *dm, int numPolys);
114 void CDDM_lower_num_tessfaces(DerivedMesh *dm, int numTessFaces);
115
116 /* vertex/edge/face access functions
117  * should always succeed if index is within bounds
118  * note these return pointers - any change modifies the internals of the mesh
119  */
120 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
121 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
122 struct MFace *CDDM_get_tessface(struct DerivedMesh *dm, int index);
123 struct MLoop *CDDM_get_loop(struct DerivedMesh *dm, int index);
124 struct MPoly *CDDM_get_poly(struct DerivedMesh *dm, int index);
125
126 /* vertex/edge/face array access functions - return the array holding the
127  * desired data
128  * should always succeed
129  * note these return pointers - any change modifies the internals of the mesh
130  */
131 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
132 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
133 struct MFace *CDDM_get_tessfaces(struct DerivedMesh *dm);
134 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
135 struct MPoly *CDDM_get_polys(struct DerivedMesh *dm);
136
137 /* Assigns news m*** layers to the cddm.  Note that you must handle
138  * freeing the old ones yourself.  Also you must ensure dm->num****Data
139  * is correct.*/
140 void CDDM_set_mvert(struct DerivedMesh *dm, struct MVert *mvert);
141 void CDDM_set_medge(struct DerivedMesh *dm, struct MEdge *medge);
142 void CDDM_set_mface(struct DerivedMesh *dm, struct MFace *mface);
143 void CDDM_set_mloop(struct DerivedMesh *dm, struct MLoop *mloop);
144 void CDDM_set_mpoly(struct DerivedMesh *dm, struct MPoly *mpoly);
145
146 #endif