style cleanup / comment formatting for bli/bke/bmesh
[blender.git] / source / blender / blenkernel / BKE_cdderivedmesh.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  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Ben Batt <benbatt@gmail.com>
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file BKE_cdderivedmesh.h
29  *  \ingroup bke
30  *  \section aboutcdderivedmesh CDDerivedMesh interface
31  *   CDDerivedMesh (CD = Custom Data) is a DerivedMesh backend which stores
32  *   mesh elements (vertices, edges and faces) as layers of custom element data.
33  */
34
35 #ifndef __BKE_CDDERIVEDMESH_H__
36 #define __BKE_CDDERIVEDMESH_H__
37
38 #include "BKE_DerivedMesh.h"
39
40 struct DerivedMesh;
41 struct BMEditMesh;
42 struct Mesh;
43 struct Object;
44
45 /* creates a new CDDerivedMesh */
46 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces,
47                              int numLoops, int numPolys);
48
49 /*tests if a given DerivedMesh is a CDDM*/
50 int CDDM_Check(struct DerivedMesh *dm);
51
52 /* creates a CDDerivedMesh from the given Mesh, this will reference the
53  * original data in Mesh, but it is safe to apply vertex coordinates or
54  * calculate normals as those functions will automtically create new
55  * data to not overwrite the original */
56 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh, struct Object *ob);
57
58 /* creates a CDDerivedMesh from the given BMEditMesh */
59 DerivedMesh *CDDM_from_BMEditMesh(struct BMEditMesh *em, struct Mesh *me, int use_mdisps, int use_tessface);
60
61 /* merge verts  */
62 DerivedMesh *CDDM_merge_verts(DerivedMesh *dm, const int *vtargetmap);
63
64 /* creates a CDDerivedMesh from the given curve object */
65 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
66
67 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
68 /* useful for OrcoDM creation for curves with constructive modifiers */
69 DerivedMesh *CDDM_from_curve_customDB(struct Object *ob, struct ListBase *dispbase);
70
71 /* Copies the given DerivedMesh with verts, faces & edges stored as
72  * custom element data.
73  */
74 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm);
75 struct DerivedMesh *CDDM_copy_from_tessface(struct DerivedMesh *dm);
76
77 /* creates a CDDerivedMesh with the same layer stack configuration as the
78  * given DerivedMesh and containing the requested numbers of elements.
79  * elements are initialised to all zeros
80  */
81 struct DerivedMesh *CDDM_from_template(struct DerivedMesh *source,
82                                   int numVerts, int numEdges, int numFaces,
83                                   int numLoops, int numPolys);
84
85 /*converts mfaces to mpolys.  note things may break if there are not valid
86  *medges surrounding each mface.
87  */
88 void CDDM_tessfaces_to_faces(struct DerivedMesh *dm);
89
90 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
91  * layer is a referenced layer, it will be duplicate to not overwrite the
92  * original
93  */
94 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
95 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
96
97 /* recalculates vertex and face normals for a CDDerivedMesh
98  */
99 void CDDM_calc_normals_mapping(struct DerivedMesh *dm);
100 void CDDM_calc_normals(struct DerivedMesh *dm);
101 void CDDM_calc_normals_tessface(struct DerivedMesh *dm);
102
103 /* calculates edges for a CDDerivedMesh (from face data)
104  * this completely replaces the current edge data in the DerivedMesh
105  * builds edges from the tesselated face data.
106  */
107 void CDDM_calc_edges_tessface(struct DerivedMesh *dm);
108
109 /* same as CDDM_calc_edges_tessface only makes edges from ngon faces instead of tessellation
110  * faces*/
111 void CDDM_calc_edges(struct DerivedMesh *dm);
112
113 /* reconstitute face triangulation */
114 void CDDM_recalc_tessellation(struct DerivedMesh *dm);
115 void CDDM_recalc_tessellation_ex(struct DerivedMesh *dm, const int do_face_nor_cpy);
116
117 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
118  * the layer data stays the same size
119  */
120 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
121 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
122 void CDDM_lower_num_polys(struct DerivedMesh *dm, int numPolys);
123 void CDDM_lower_num_tessfaces(DerivedMesh *dm, int numTessFaces);
124
125 /* vertex/edge/face access functions
126  * should always succeed if index is within bounds
127  * note these return pointers - any change modifies the internals of the mesh
128  */
129 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
130 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
131 struct MFace *CDDM_get_tessface(struct DerivedMesh *dm, int index);
132 struct MLoop *CDDM_get_loop(struct DerivedMesh *dm, int index);
133 struct MPoly *CDDM_get_poly(struct DerivedMesh *dm, int index);
134
135 /* vertex/edge/face array access functions - return the array holding the
136  * desired data
137  * should always succeed
138  * note these return pointers - any change modifies the internals of the mesh
139  */
140 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
141 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
142 struct MFace *CDDM_get_tessfaces(struct DerivedMesh *dm);
143 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
144 struct MPoly *CDDM_get_polys(struct DerivedMesh *dm);
145
146 /* Assigns news m*** layers to the cddm.  Note that you must handle
147  * freeing the old ones yourself.  Also you must ensure dm->num****Data
148  * is correct.*/
149 void CDDM_set_mvert(struct DerivedMesh *dm, struct MVert *mvert);
150 void CDDM_set_medge(struct DerivedMesh *dm, struct MEdge *medge);
151 void CDDM_set_mface(struct DerivedMesh *dm, struct MFace *mface);
152 void CDDM_set_mloop(struct DerivedMesh *dm, struct MLoop *mloop);
153 void CDDM_set_mpoly(struct DerivedMesh *dm, struct MPoly *mpoly);
154
155 #endif
156