=bmesh= merge from trunk at r36529
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file BKE_cdderivedmesh.h
31  *  \ingroup bke
32  *  \section aboutcdderivedmesh CDDerivedMesh interface
33  *   CDDerivedMesh (CD = Custom Data) is a DerivedMesh backend which stores
34  *   mesh elements (vertices, edges and faces) as layers of custom element data.
35  */
36
37 #ifndef BKE_CDDERIVEDMESH_H
38 #define BKE_CDDERIVEDMESH_H
39
40 #include "BKE_DerivedMesh.h"
41
42 struct DerivedMesh;
43 struct BMEditMesh;
44 struct EditMesh;
45 struct Mesh;
46 struct Object;
47
48 /* creates a new CDDerivedMesh */
49 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces,
50                              int numLoops, int numPolys);
51
52 /*tests if a given DerivedMesh is a CDDM*/
53 int CDDM_Check(struct DerivedMesh *dm);
54
55 /* creates a CDDerivedMesh from the given Mesh, this will reference the
56    original data in Mesh, but it is safe to apply vertex coordinates or
57    calculate normals as those functions will automtically create new
58    data to not overwrite the original */
59 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh, struct Object *ob);
60
61 /* creates a CDDerivedMesh from the given BMEditMesh */
62 DerivedMesh *CDDM_from_BMEditMesh(struct BMEditMesh *em, struct Mesh *me, int use_mdisps);
63
64 /* merge verts  */
65 DerivedMesh *CDDM_merge_verts(DerivedMesh *dm, int *vtargetmap);
66
67 /* creates a CDDerivedMesh from the given curve object */
68 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
69
70 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
71 /* useful for OrcoDM creation for curves with constructive modifiers */
72 DerivedMesh *CDDM_from_curve_customDB(struct Object *ob, struct ListBase *dispbase);
73
74 struct BMEditMesh *CDDM_To_BMesh(struct Object *ob, struct DerivedMesh *dm, struct BMEditMesh *existing);
75
76
77 /* Copies the given DerivedMesh with verts, faces & edges stored as
78  * custom element data.
79  */
80 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm, int faces_from_tessfaces);
81
82 /* creates a CDDerivedMesh with the same layer stack configuration as the
83  * given DerivedMesh and containing the requested numbers of elements.
84  * elements are initialised to all zeros
85  */
86 struct DerivedMesh *CDDM_from_template(struct DerivedMesh *source,
87                                   int numVerts, int numEdges, int numFaces,
88                                   int numLoops, int numPolys);
89
90 /*converts mfaces to mpolys.  note things may break if there are not valid
91  *medges surrounding each mface.
92  */
93 void CDDM_tessfaces_to_faces(struct DerivedMesh *dm);
94
95 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
96  * layer is a referenced layer, it will be duplicate to not overwrite the
97  * original
98  */
99 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
100 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
101
102 /* recalculates vertex and face normals for a CDDerivedMesh
103  */
104 void CDDM_calc_normals(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.  if orig_use_polyorig is nonzero, sets
117   the mface origindex layer to copy to the origindex values of the 
118   parent mpolys; otherwise the mface origindex will point to the index of
119   the parent mpoly*/
120 void CDDM_recalc_tesselation(struct DerivedMesh *dm, int orig_use_polyorig);
121
122 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
123  * the layer data stays the same size
124  */
125 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
126 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
127 void CDDM_lower_num_faces(struct DerivedMesh *dm, int numFaces);
128
129 /* vertex/edge/face access functions
130  * should always succeed if index is within bounds
131  * note these return pointers - any change modifies the internals of the mesh
132  */
133 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
134 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
135 struct MFace *CDDM_get_tessface(struct DerivedMesh *dm, int index);
136 struct MLoop *CDDM_get_loop(struct DerivedMesh *dm, int index);
137 struct MPoly *CDDM_get_face(struct DerivedMesh *dm, int index);
138
139 /* vertex/edge/face array access functions - return the array holding the
140  * desired data
141  * should always succeed
142  * note these return pointers - any change modifies the internals of the mesh
143  */
144 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
145 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
146 struct MFace *CDDM_get_tessfaces(struct DerivedMesh *dm);
147 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
148 struct MPoly *CDDM_get_polys(struct DerivedMesh *dm);
149
150 /*Assigns news m*** layers to the cddm.  Note that you must handle
151   freeing the old ones yourself.  Also you must ensure dm->num****Data
152   is correct.*/
153 void CDDM_set_mvert(struct DerivedMesh *dm, struct MVert *mvert);
154 void CDDM_set_medge(struct DerivedMesh *dm, struct MEdge *medge);
155 void CDDM_set_mface(struct DerivedMesh *dm, struct MFace *mface);
156 void CDDM_set_mloop(struct DerivedMesh *dm, struct MLoop *mloop);
157 void CDDM_set_mpoly(struct DerivedMesh *dm, struct MPoly *mpoly);
158
159 #endif
160