Cleanup: unused code
[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 #include "BKE_customdata.h"
40
41 struct DerivedMesh;
42 struct BMEditMesh;
43 struct Mesh;
44 struct MLoopNorSpaceArray;
45 struct Object;
46
47 /* creates a new CDDerivedMesh */
48 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces,
49                              int numLoops, int numPolys);
50
51 /* creates a CDDerivedMesh from the given Mesh, this will reference the
52  * original data in Mesh, but it is safe to apply vertex coordinates or
53  * calculate normals as those functions will automatically create new
54  * data to not overwrite the original */
55 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh);
56
57 /* creates a CDDerivedMesh from the given Mesh with custom allocation type. */
58 struct DerivedMesh *CDDM_from_mesh_ex(struct Mesh *mesh, eCDAllocType alloctype, CustomDataMask mask);
59
60
61 struct DerivedMesh *CDDM_from_bmesh(struct BMesh *bm, const bool use_mdisps);
62
63 /* creates a CDDerivedMesh from the given BMEditMesh */
64 DerivedMesh *CDDM_from_editbmesh(struct BMEditMesh *em, const bool use_mdisps, const bool use_tessface);
65
66 /* creates a CDDerivedMesh from the given curve object */
67 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
68
69 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
70 /* useful for OrcoDM creation for curves with constructive modifiers */
71 DerivedMesh *CDDM_from_curve_displist(struct Object *ob, struct ListBase *dispbase);
72
73 /* Copies the given DerivedMesh with verts, faces & edges stored as
74  * custom element data.
75  */
76 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm);
77
78 /* creates a CDDerivedMesh with the same layer stack configuration as the
79  * given DerivedMesh and containing the requested numbers of elements.
80  * elements are initialized to all zeros
81  */
82 struct DerivedMesh *CDDM_from_template_ex(
83         struct DerivedMesh *source,
84         int numVerts, int numEdges, int numFaces,
85         int numLoops, int numPolys,
86         CustomDataMask mask);
87 struct DerivedMesh *CDDM_from_template(
88         struct DerivedMesh *source,
89         int numVerts, int numEdges, int numFaces,
90         int numLoops, int numPolys);
91
92 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
93  * layer is a referenced layer, it will be duplicate to not overwrite the
94  * original
95  */
96 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
97 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
98
99 /* recalculates vertex and face normals for a CDDerivedMesh
100  */
101 void CDDM_calc_normals_mapping_ex(struct DerivedMesh *dm, const bool only_face_normals);
102 void CDDM_calc_normals_mapping(struct DerivedMesh *dm);
103 void CDDM_calc_normals(struct DerivedMesh *dm);
104
105 void CDDM_calc_loop_normals(struct DerivedMesh *dm, const bool use_split_normals, const float split_angle);
106 void CDDM_calc_loop_normals_spacearr(struct DerivedMesh *dm, const bool use_split_normals, const float split_angle,
107                                      struct MLoopNorSpaceArray *r_lnors_spacearr);
108
109 /* reconstitute face triangulation */
110 void CDDM_recalc_tessellation(struct DerivedMesh *dm);
111 void CDDM_recalc_tessellation_ex(struct DerivedMesh *dm, const bool do_face_nor_cpy);
112
113 void CDDM_recalc_looptri(struct DerivedMesh *dm);
114
115 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
116  * the layer data stays the same size
117  */
118 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
119 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
120 void CDDM_lower_num_loops(struct DerivedMesh *dm, int numLoops);
121 void CDDM_lower_num_polys(struct DerivedMesh *dm, int numPolys);
122 void CDDM_lower_num_tessfaces(DerivedMesh *dm, int numTessFaces);
123
124 /* vertex/edge/face access functions
125  * should always succeed if index is within bounds
126  * note these return pointers - any change modifies the internals of the mesh
127  */
128 struct MVert *CDDM_get_vert(struct DerivedMesh *dm, int index);
129 struct MEdge *CDDM_get_edge(struct DerivedMesh *dm, int index);
130 struct MFace *CDDM_get_tessface(struct DerivedMesh *dm, int index);
131 struct MLoop *CDDM_get_loop(struct DerivedMesh *dm, int index);
132 struct MPoly *CDDM_get_poly(struct DerivedMesh *dm, int index);
133
134 /* vertex/edge/face array access functions - return the array holding the
135  * desired data
136  * should always succeed
137  * note these return pointers - any change modifies the internals of the mesh
138  */
139 struct MVert *CDDM_get_verts(struct DerivedMesh *dm);
140 struct MEdge *CDDM_get_edges(struct DerivedMesh *dm);
141 struct MFace *CDDM_get_tessfaces(struct DerivedMesh *dm);
142 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
143 struct MPoly *CDDM_get_polys(struct DerivedMesh *dm);
144
145 /* Assigns news m*** layers to the cddm.  Note that you must handle
146  * freeing the old ones yourself.  Also you must ensure dm->num****Data
147  * is correct.*/
148 void CDDM_set_mvert(struct DerivedMesh *dm, struct MVert *mvert);
149 void CDDM_set_medge(struct DerivedMesh *dm, struct MEdge *medge);
150 void CDDM_set_mface(struct DerivedMesh *dm, struct MFace *mface);
151 void CDDM_set_mloop(struct DerivedMesh *dm, struct MLoop *mloop);
152 void CDDM_set_mpoly(struct DerivedMesh *dm, struct MPoly *mpoly);
153
154 #endif