added
[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 EditMesh;
43 struct Mesh;
44 struct Object;
45
46 /* creates a new CDDerivedMesh */
47 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces,
48                              int numLoops, int numPolys);
49
50 /*tests if a given DerivedMesh is a CDDM*/
51 int CDDM_Check(struct DerivedMesh *dm);
52
53 /* creates a CDDerivedMesh from the given Mesh, this will reference the
54    original data in Mesh, but it is safe to apply vertex coordinates or
55    calculate normals as those functions will automtically create new
56    data to not overwrite the original */
57 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh, struct Object *ob);
58
59 /* creates a CDDerivedMesh from the given BMEditMesh */
60 DerivedMesh *CDDM_from_BMEditMesh(struct BMEditMesh *em, struct Mesh *me, int use_mdisps);
61
62 /* merge verts  */
63 DerivedMesh *CDDM_merge_verts(DerivedMesh *dm, const int *vtargetmap);
64
65 /* creates a CDDerivedMesh from the given curve object */
66 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
67
68 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
69 /* useful for OrcoDM creation for curves with constructive modifiers */
70 DerivedMesh *CDDM_from_curve_customDB(struct Object *ob, struct ListBase *dispbase);
71
72 struct BMEditMesh *CDDM_To_BMesh(struct Object *ob, struct DerivedMesh *dm, struct BMEditMesh *existing);
73
74
75 /* Copies the given DerivedMesh with verts, faces & edges stored as
76  * custom element data.
77  */
78 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm, int faces_from_tessfaces);
79
80 /* creates a CDDerivedMesh with the same layer stack configuration as the
81  * given DerivedMesh and containing the requested numbers of elements.
82  * elements are initialised to all zeros
83  */
84 struct DerivedMesh *CDDM_from_template(struct DerivedMesh *source,
85                                   int numVerts, int numEdges, int numFaces,
86                                   int numLoops, int numPolys);
87
88 /*converts mfaces to mpolys.  note things may break if there are not valid
89  *medges surrounding each mface.
90  */
91 void CDDM_tessfaces_to_faces(struct DerivedMesh *dm);
92
93 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
94  * layer is a referenced layer, it will be duplicate to not overwrite the
95  * original
96  */
97 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
98 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
99
100 /* recalculates vertex and face normals for a CDDerivedMesh
101  */
102 void CDDM_calc_normals_mapping(struct DerivedMesh *dm);
103 void CDDM_calc_normals(struct DerivedMesh *dm);
104 void CDDM_calc_normals_tessface(struct DerivedMesh *dm);
105
106 /* calculates edges for a CDDerivedMesh (from face data)
107  * this completely replaces the current edge data in the DerivedMesh
108  * builds edges from the tesselated face data.
109  */
110 void CDDM_calc_edges(struct DerivedMesh *dm);
111
112 /* same as CDDM_calc_edges only makes edges from ngon faces instead of tesselation
113    faces*/
114 void CDDM_calc_edges_poly(struct DerivedMesh *dm);
115
116 /* reconstitute face triangulation */
117 void CDDM_recalc_tesselation(struct DerivedMesh *dm);
118
119 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
120  * the layer data stays the same size
121  */
122 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
123 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
124 void CDDM_lower_num_polys(struct DerivedMesh *dm, int numPolys);
125 void CDDM_lower_num_tessfaces(DerivedMesh *dm, int numTessFaces);
126
127 /* vertex/edge/face access functions
128  * should always succeed if index is within bounds
129  * note these return pointers - any change modifies the internals of the mesh
130  */
131 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
132 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
133 struct MFace *CDDM_get_tessface(struct DerivedMesh *dm, int index);
134 struct MLoop *CDDM_get_loop(struct DerivedMesh *dm, int index);
135 struct MPoly *CDDM_get_face(struct DerivedMesh *dm, int index);
136
137 /* vertex/edge/face array access functions - return the array holding the
138  * desired data
139  * should always succeed
140  * note these return pointers - any change modifies the internals of the mesh
141  */
142 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
143 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
144 struct MFace *CDDM_get_tessfaces(struct DerivedMesh *dm);
145 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
146 struct MPoly *CDDM_get_polys(struct DerivedMesh *dm);
147
148 /*Assigns news m*** layers to the cddm.  Note that you must handle
149   freeing the old ones yourself.  Also you must ensure dm->num****Data
150   is correct.*/
151 void CDDM_set_mvert(struct DerivedMesh *dm, struct MVert *mvert);
152 void CDDM_set_medge(struct DerivedMesh *dm, struct MEdge *medge);
153 void CDDM_set_mface(struct DerivedMesh *dm, struct MFace *mface);
154 void CDDM_set_mloop(struct DerivedMesh *dm, struct MLoop *mloop);
155 void CDDM_set_mpoly(struct DerivedMesh *dm, struct MPoly *mpoly);
156
157 #endif
158