(NOTE: DO NOT TEST)
[blender.git] / source / blender / blenkernel / BKE_cdderivedmesh.h
1 /*
2 * $Id$
3 *
4 * ***** BEGIN GPL LICENSE BLOCK *****
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software  Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19 *
20 * The Original Code is Copyright (C) 2006 Blender Foundation.
21 * All rights reserved.
22 *
23 * The Original Code is: all of this file.
24 *
25 * Contributor(s): Ben Batt <benbatt@gmail.com>
26 *
27 * ***** END GPL LICENSE BLOCK *****
28 */ 
29
30 /* 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 /* creates a CDDerivedMesh from the given Mesh, this will reference the
51    original data in Mesh, but it is safe to apply vertex coordinates or
52    calculate normals as those functions will automtically create new
53    data to not overwrite the original */
54 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh, struct Object *ob);
55
56 /* creates a CDDerivedMesh from the given EditMesh */
57 struct DerivedMesh *CDDM_from_editmesh(struct EditMesh *em, struct Mesh *me);
58
59 /* creates a CDDerivedMesh from the given BMEditMesh */
60 DerivedMesh *CDDM_from_BMEditMesh(struct BMEditMesh *em, struct Mesh *me);
61
62 /* Copies the given DerivedMesh with verts, faces & edges stored as
63  * custom element data.
64  */
65 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm);
66
67 /* creates a CDDerivedMesh with the same layer stack configuration as the
68  * given DerivedMesh and containing the requested numbers of elements.
69  * elements are initialised to all zeros
70  */
71 struct DerivedMesh *CDDM_from_template(struct DerivedMesh *source,
72                                   int numVerts, int numEdges, int numFaces,
73                                   int numLoops, int numPolys);
74
75 /*converts mfaces to mpolys.  note things may break if there are not valid
76  *medges surrounding each mface.
77  */
78 void CDDM_tessfaces_to_faces(struct DerivedMesh *dm);
79
80 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
81  * layer is a referenced layer, it will be duplicate to not overwrite the
82  * original
83  */
84 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
85 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
86
87 /* recalculates vertex and face normals for a CDDerivedMesh
88  */
89 void CDDM_calc_normals(struct DerivedMesh *dm);
90
91 /* calculates edges for a CDDerivedMesh (from face data)
92  * this completely replaces the current edge data in the DerivedMesh
93  */
94 void CDDM_calc_edges(struct DerivedMesh *dm);
95
96 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
97  * the layer data stays the same size
98  */
99 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
100 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
101 void CDDM_lower_num_faces(struct DerivedMesh *dm, int numFaces);
102
103 /* vertex/edge/face access functions
104  * should always succeed if index is within bounds
105  * note these return pointers - any change modifies the internals of the mesh
106  */
107 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
108 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
109 struct MFace *CDDM_get_tessface(struct DerivedMesh *dm, int index);
110 struct MLoop *CDDM_get_loop(struct DerivedMesh *dm, int index);
111 struct MPoly *CDDM_get_face(struct DerivedMesh *dm, int index);
112
113 /* vertex/edge/face array access functions - return the array holding the
114  * desired data
115  * should always succeed
116  * note these return pointers - any change modifies the internals of the mesh
117  */
118 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
119 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
120 struct MFace *CDDM_get_tessfaces(struct DerivedMesh *dm);
121 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
122 struct MPoly *CDDM_get_faces(struct DerivedMesh *dm);
123
124 #endif
125