unify include guard defines, __$FILENAME__
[blender-staging.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 EditMesh;
42 struct Mesh;
43 struct Object;
44
45 /* creates a new CDDerivedMesh */
46 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces);
47
48 /* creates a CDDerivedMesh from the given Mesh, this will reference the
49    original data in Mesh, but it is safe to apply vertex coordinates or
50    calculate normals as those functions will automtically create new
51    data to not overwrite the original */
52 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh, struct Object *ob);
53
54 /* creates a CDDerivedMesh from the given EditMesh */
55 struct DerivedMesh *CDDM_from_editmesh(struct EditMesh *em, struct Mesh *me);
56
57 /* creates a CDDerivedMesh from the given curve object */
58 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
59
60 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
61 /* useful for OrcoDM creation for curves with constructive modifiers */
62 DerivedMesh *CDDM_from_curve_customDB(struct Object *ob, struct ListBase *dispbase);
63
64 /* Copies the given DerivedMesh with verts, faces & edges stored as
65  * custom element data.
66  */
67 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm);
68
69 /* creates a CDDerivedMesh with the same layer stack configuration as the
70  * given DerivedMesh and containing the requested numbers of elements.
71  * elements are initialised to all zeros
72  */
73 struct DerivedMesh *CDDM_from_template(struct DerivedMesh *source,
74                                                                   int numVerts, int numEdges, int numFaces);
75
76 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
77  * layer is a referenced layer, it will be duplicate to not overwrite the
78  * original
79  */
80 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
81 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
82
83 /* recalculates vertex and face normals for a CDDerivedMesh
84  */
85 void CDDM_calc_normals(struct DerivedMesh *dm);
86
87 /* calculates edges for a CDDerivedMesh (from face data)
88  * this completely replaces the current edge data in the DerivedMesh
89  */
90 void CDDM_calc_edges(struct DerivedMesh *dm);
91
92 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
93  * the layer data stays the same size
94  */
95 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
96 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
97 void CDDM_lower_num_faces(struct DerivedMesh *dm, int numFaces);
98
99 /* vertex/edge/face access functions
100  * should always succeed if index is within bounds
101  * note these return pointers - any change modifies the internals of the mesh
102  */
103 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
104 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
105 struct MFace *CDDM_get_face(struct DerivedMesh *dm, int index);
106
107 /* vertex/edge/face array access functions - return the array holding the
108  * desired data
109  * should always succeed
110  * note these return pointers - any change modifies the internals of the mesh
111  */
112 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
113 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
114 struct MFace *CDDM_get_faces(struct DerivedMesh *dm);
115 #endif
116