Fix T64842: crash rendering files with bevel curves
[blender.git] / source / blender / blenkernel / BKE_cdderivedmesh.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software  Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2006 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  * \section aboutcdderivedmesh CDDerivedMesh interface
23  *   CDDerivedMesh (CD = Custom Data) is a DerivedMesh backend which stores
24  *   mesh elements (vertices, edges and faces) as layers of custom element data.
25  */
26
27 #ifndef __BKE_CDDERIVEDMESH_H__
28 #define __BKE_CDDERIVEDMESH_H__
29
30 #include "BKE_DerivedMesh.h"
31 #include "BKE_customdata.h"
32
33 struct BMEditMesh;
34 struct CustomData_MeshMasks;
35 struct DerivedMesh;
36 struct MLoopNorSpaceArray;
37 struct Mesh;
38 struct Object;
39
40 /* creates a new CDDerivedMesh */
41 struct DerivedMesh *CDDM_new(int numVerts, int numEdges, int numFaces, int numLoops, int numPolys);
42
43 /* creates a CDDerivedMesh from the given Mesh, this will reference the
44  * original data in Mesh, but it is safe to apply vertex coordinates or
45  * calculate normals as those functions will automatically create new
46  * data to not overwrite the original */
47 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh);
48
49 /* creates a CDDerivedMesh from the given Mesh with custom allocation type. */
50 struct DerivedMesh *CDDM_from_mesh_ex(struct Mesh *mesh,
51                                       eCDAllocType alloctype,
52                                       const struct CustomData_MeshMasks *mask);
53
54 struct DerivedMesh *CDDM_from_bmesh(struct BMesh *bm, const bool use_mdisps);
55
56 /* creates a CDDerivedMesh from the given BMEditMesh */
57 DerivedMesh *CDDM_from_editbmesh(struct BMEditMesh *em,
58                                  const bool use_mdisps,
59                                  const bool use_tessface);
60
61 /* creates a CDDerivedMesh from the given curve object */
62 struct DerivedMesh *CDDM_from_curve(struct Object *ob);
63
64 /* creates a CDDerivedMesh from the given curve object and specified dispbase */
65 /* useful for OrcoDM creation for curves with constructive modifiers */
66 DerivedMesh *CDDM_from_curve_displist(struct Object *ob, struct ListBase *dispbase);
67
68 /* Copies the given DerivedMesh with verts, faces & edges stored as
69  * custom element data.
70  */
71 struct DerivedMesh *CDDM_copy(struct DerivedMesh *dm);
72
73 /* creates a CDDerivedMesh with the same layer stack configuration as the
74  * given DerivedMesh and containing the requested numbers of elements.
75  * elements are initialized to all zeros
76  */
77 struct DerivedMesh *CDDM_from_template_ex(struct DerivedMesh *source,
78                                           int numVerts,
79                                           int numEdges,
80                                           int numFaces,
81                                           int numLoops,
82                                           int numPolys,
83                                           const struct CustomData_MeshMasks *mask);
84 struct DerivedMesh *CDDM_from_template(struct DerivedMesh *source,
85                                        int numVerts,
86                                        int numEdges,
87                                        int numFaces,
88                                        int numLoops,
89                                        int numPolys);
90
91 /* applies vertex coordinates or normals to a CDDerivedMesh. if the MVert
92  * layer is a referenced layer, it will be duplicate to not overwrite the
93  * original
94  */
95 void CDDM_apply_vert_coords(struct DerivedMesh *cddm, float (*vertCoords)[3]);
96 void CDDM_apply_vert_normals(struct DerivedMesh *cddm, short (*vertNormals)[3]);
97
98 /* recalculates vertex and face normals for a CDDerivedMesh
99  */
100 void CDDM_calc_normals_mapping_ex(struct DerivedMesh *dm, const bool only_face_normals);
101 void CDDM_calc_normals_mapping(struct DerivedMesh *dm);
102 void CDDM_calc_normals(struct DerivedMesh *dm);
103
104 void CDDM_calc_loop_normals(struct DerivedMesh *dm,
105                             const bool use_split_normals,
106                             const float split_angle);
107 void CDDM_calc_loop_normals_spacearr(struct DerivedMesh *dm,
108                                      const bool use_split_normals,
109                                      const float split_angle,
110                                      struct MLoopNorSpaceArray *r_lnors_spacearr);
111
112 /* reconstitute face triangulation */
113 void CDDM_recalc_tessellation(struct DerivedMesh *dm);
114 void CDDM_recalc_tessellation_ex(struct DerivedMesh *dm, const bool do_face_nor_cpy);
115
116 void CDDM_recalc_looptri(struct DerivedMesh *dm);
117
118 /* lowers the number of vertices/edges/faces in a CDDerivedMesh
119  * the layer data stays the same size
120  */
121 void CDDM_lower_num_verts(struct DerivedMesh *dm, int numVerts);
122 void CDDM_lower_num_edges(struct DerivedMesh *dm, int numEdges);
123 void CDDM_lower_num_loops(struct DerivedMesh *dm, int numLoops);
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_poly(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