Merge branch 'blender2.7' of git.blender.org:blender
[blender.git] / source / blender / blenkernel / BKE_DerivedMesh.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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_DERIVEDMESH_H__
21 #define __BKE_DERIVEDMESH_H__
22
23 /** \file
24  * \ingroup bke
25  *
26  * Basic design of the DerivedMesh system:
27  *
28  * DerivedMesh is a common set of interfaces for mesh systems.
29  *
30  * There are three main mesh data structures in Blender:
31  * #Mesh, #CDDerivedMesh and #BMesh.
32  *
33  * These, and a few others, all implement DerivedMesh interfaces,
34  * which contains unified drawing interfaces, a few utility interfaces,
35  * and a bunch of read-only interfaces intended mostly for conversion from
36  * one format to another.
37  *
38  * All Mesh structures in blender make use of CustomData, which is used to store
39  * per-element attributes and interpolate them (e.g. uvs, vcols, vgroups, etc).
40  *
41  * Mesh is the "serialized" structure, used for storing object-mode mesh data
42  * and also for saving stuff to disk.  It's interfaces are also what DerivedMesh
43  * uses to communicate with.
44  *
45  * CDDM is a little mesh library, that uses Mesh data structures in the backend.
46  * It's mostly used for modifiers, and has the advantages of not taking much
47  * resources.
48  *
49  * BMesh is a full-on brep, used for editmode, some modifiers, etc.  It's much
50  * more capable (if memory-intensive) then CDDM.
51  *
52  * DerivedMesh is somewhat hackish.  Many places assumes that a DerivedMesh is
53  * a CDDM (most of the time by simply copying it and converting it to one).
54  * CDDM is the original structure for modifiers, but has since been superseded
55  * by BMesh, at least for the foreseeable future.
56  */
57
58 /*
59  * Note: This structure is read-only, for all practical purposes.
60  *       At some point in the future, we may want to consider
61  *       creating a replacement structure that implements a proper
62  *       abstract mesh kernel interface.  Or, we can leave this
63  *       as it is and stick with using BMesh and CDDM.
64  */
65
66 #include "DNA_defs.h"
67 #include "DNA_customdata_types.h"
68 #include "DNA_meshdata_types.h"
69
70 #include "BLI_compiler_attrs.h"
71
72 #include "BKE_customdata.h"
73 #include "BKE_bvhutils.h"
74
75 struct BMEditMesh;
76 struct CCGElem;
77 struct CCGKey;
78 struct CustomData_MeshMasks;
79 struct Depsgraph;
80 struct MEdge;
81 struct MFace;
82 struct MLoopNorSpaceArray;
83 struct MVert;
84 struct Mesh;
85 struct ModifierData;
86 struct Object;
87 struct PBVH;
88 struct Scene;
89
90 /* number of sub-elements each mesh element has (for interpolation) */
91 // #define SUB_ELEMS_VERT 0 /* UNUSED */
92 #define SUB_ELEMS_EDGE 2
93 #define SUB_ELEMS_FACE 50
94
95 /*
96  * Note: all mface interfaces now officially operate on tessellated data.
97  *       Also, the mface origindex layer indexes mpolys, not mfaces.
98  */
99
100 typedef struct DMCoNo {
101         float co[3];
102         float no[3];
103 } DMCoNo;
104
105 /* keep in sync with MFace/MPoly types */
106 typedef struct DMFlagMat {
107         short mat_nr;
108         char flag;
109 } DMFlagMat;
110
111 typedef enum DerivedMeshType {
112         DM_TYPE_CDDM,
113         DM_TYPE_CCGDM
114 } DerivedMeshType;
115
116 typedef enum DMForeachFlag {
117         DM_FOREACH_NOP = 0,
118         DM_FOREACH_USE_NORMAL = (1 << 0),  /* foreachMappedVert, foreachMappedLoop, foreachMappedFaceCenter */
119 } DMForeachFlag;
120
121 typedef enum DMDirtyFlag {
122         /* dm has valid tessellated faces, but tessellated CDDATA need to be updated. */
123         DM_DIRTY_TESS_CDLAYERS = 1 << 0,
124
125         /* check this with modifier dependsOnNormals callback to see if normals need recalculation */
126         DM_DIRTY_NORMALS = 1 << 1,
127 }  DMDirtyFlag;
128
129 typedef struct DerivedMesh DerivedMesh;
130 struct DerivedMesh {
131         /** Private DerivedMesh data, only for internal DerivedMesh use */
132         CustomData vertData, edgeData, faceData, loopData, polyData;
133         int numVertData, numEdgeData, numTessFaceData, numLoopData, numPolyData;
134         int needsFree; /* checked on ->release, is set to 0 for cached results */
135         int deformedOnly; /* set by modifier stack if only deformed from original */
136         BVHCache *bvhCache;
137         DerivedMeshType type;
138         DMDirtyFlag dirty;
139         int totmat; /* total materials. Will be valid only before object drawing. */
140         struct Material **mat; /* material array. Will be valid only before object drawing */
141
142         /**
143          * \warning Typical access is done via #getLoopTriArray, #getNumLoopTri.
144          */
145         struct {
146                 /* WARNING! swapping between array (ready-to-be-used data) and array_wip (where data is actually computed)
147                  *          shall always be protected by same lock as one used for looptris computing. */
148                 struct MLoopTri *array, *array_wip;
149                 int num;
150                 int num_alloc;
151         } looptris;
152
153         /* use for converting to BMesh which doesn't store bevel weight and edge crease by default */
154         char cd_flag;
155
156         short tangent_mask; /* which tangent layers are calculated */
157
158         /** Calculate vert and face normals */
159         void (*calcNormals)(DerivedMesh *dm);
160
161         /** Calculate loop (split) normals */
162         void (*calcLoopNormals)(DerivedMesh *dm, const bool use_split_normals, const float split_angle);
163
164         /** Calculate loop (split) normals, and returns split loop normal spacearr. */
165         void (*calcLoopNormalsSpaceArray)(DerivedMesh *dm, const bool use_split_normals, const float split_angle,
166                                           struct MLoopNorSpaceArray *r_lnors_spacearr);
167
168         void (*calcLoopTangents)(
169                 DerivedMesh *dm, bool calc_active_tangent,
170                 const char (*tangent_names)[MAX_NAME], int tangent_names_count);
171
172         /** Recalculates mesh tessellation */
173         void (*recalcTessellation)(DerivedMesh *dm);
174
175         /** Loop tessellation cache (WARNING! Only call inside threading-protected code!) */
176         void (*recalcLoopTri)(DerivedMesh *dm);
177         /** accessor functions */
178         const struct MLoopTri *(*getLoopTriArray)(DerivedMesh * dm);
179         int (*getNumLoopTri)(DerivedMesh *dm);
180
181         /* Misc. Queries */
182
183         /* Also called in Editmode */
184         int (*getNumVerts)(DerivedMesh *dm);
185         int (*getNumEdges)(DerivedMesh *dm);
186         int (*getNumTessFaces)(DerivedMesh *dm);
187         int (*getNumLoops)(DerivedMesh *dm);
188         int (*getNumPolys)(DerivedMesh *dm);
189
190         /** Copy a single vert/edge/tessellated face from the derived mesh into
191          * ``*r_{vert/edge/face}``. note that the current implementation
192          * of this function can be quite slow, iterating over all
193          * elements (editmesh)
194          */
195         void (*getVert)(DerivedMesh *dm, int index, struct MVert *r_vert);
196         void (*getEdge)(DerivedMesh *dm, int index, struct MEdge *r_edge);
197         void (*getTessFace)(DerivedMesh *dm, int index, struct MFace *r_face);
198
199         /** Return a pointer to the entire array of verts/edges/face from the
200          * derived mesh. if such an array does not exist yet, it will be created,
201          * and freed on the next ->release(). consider using getVert/Edge/Face if
202          * you are only interested in a few verts/edges/faces.
203          */
204         struct MVert *(*getVertArray)(DerivedMesh * dm);
205         struct MEdge *(*getEdgeArray)(DerivedMesh * dm);
206         struct MFace *(*getTessFaceArray)(DerivedMesh * dm);
207         struct MLoop *(*getLoopArray)(DerivedMesh * dm);
208         struct MPoly *(*getPolyArray)(DerivedMesh * dm);
209
210         /** Copy all verts/edges/faces from the derived mesh into
211          * *{vert/edge/face}_r (must point to a buffer large enough)
212          */
213         void (*copyVertArray)(DerivedMesh *dm, struct MVert *r_vert);
214         void (*copyEdgeArray)(DerivedMesh *dm, struct MEdge *r_edge);
215         void (*copyTessFaceArray)(DerivedMesh *dm, struct MFace *r_face);
216         void (*copyLoopArray)(DerivedMesh *dm, struct MLoop *r_loop);
217         void (*copyPolyArray)(DerivedMesh *dm, struct MPoly *r_poly);
218
219         /** Return a copy of all verts/edges/faces from the derived mesh
220          * it is the caller's responsibility to free the returned pointer
221          */
222         struct MVert *(*dupVertArray)(DerivedMesh * dm);
223         struct MEdge *(*dupEdgeArray)(DerivedMesh * dm);
224         struct MFace *(*dupTessFaceArray)(DerivedMesh * dm);
225         struct MLoop *(*dupLoopArray)(DerivedMesh * dm);
226         struct MPoly *(*dupPolyArray)(DerivedMesh * dm);
227
228         /** Return a pointer to a single element of vert/edge/face custom data
229          * from the derived mesh (this gives a pointer to the actual data, not
230          * a copy)
231          */
232         void *(*getVertData)(DerivedMesh *dm, int index, int type);
233         void *(*getEdgeData)(DerivedMesh *dm, int index, int type);
234         void *(*getTessFaceData)(DerivedMesh *dm, int index, int type);
235         void *(*getPolyData)(DerivedMesh *dm, int index, int type);
236
237         /** Return a pointer to the entire array of vert/edge/face custom data
238          * from the derived mesh (this gives a pointer to the actual data, not
239          * a copy)
240          */
241         void *(*getVertDataArray)(DerivedMesh *dm, int type);
242         void *(*getEdgeDataArray)(DerivedMesh *dm, int type);
243         void *(*getTessFaceDataArray)(DerivedMesh *dm, int type);
244         void *(*getLoopDataArray)(DerivedMesh *dm, int type);
245         void *(*getPolyDataArray)(DerivedMesh *dm, int type);
246
247         /** Retrieves the base CustomData structures for
248          * verts/edges/tessfaces/loops/facdes*/
249         CustomData *(*getVertDataLayout)(DerivedMesh * dm);
250         CustomData *(*getEdgeDataLayout)(DerivedMesh * dm);
251         CustomData *(*getTessFaceDataLayout)(DerivedMesh * dm);
252         CustomData *(*getLoopDataLayout)(DerivedMesh * dm);
253         CustomData *(*getPolyDataLayout)(DerivedMesh * dm);
254
255         /** Copies all customdata for an element source into dst at index dest */
256         void (*copyFromVertCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
257         void (*copyFromEdgeCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
258         void (*copyFromFaceCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
259
260         /** Optional grid access for subsurf */
261         int (*getNumGrids)(DerivedMesh *dm);
262         int (*getGridSize)(DerivedMesh *dm);
263         struct CCGElem **(*getGridData)(DerivedMesh * dm);
264         int *(*getGridOffset)(DerivedMesh * dm);
265         void (*getGridKey)(DerivedMesh *dm, struct CCGKey *key);
266         DMFlagMat *(*getGridFlagMats)(DerivedMesh * dm);
267         unsigned int **(*getGridHidden)(DerivedMesh * dm);
268
269
270         /** Iterate over each mapped vertex in the derived mesh, calling the
271          * given function with the original vert and the mapped vert's new
272          * coordinate and normal. For historical reasons the normal can be
273          * passed as a float or short array, only one should be non-NULL.
274          */
275         void (*foreachMappedVert)(DerivedMesh *dm,
276                                   void (*func)(void *userData, int index, const float co[3],
277                                                const float no_f[3], const short no_s[3]),
278                                   void *userData,
279                                   DMForeachFlag flag);
280
281         /** Iterate over each mapped edge in the derived mesh, calling the
282          * given function with the original edge and the mapped edge's new
283          * coordinates.
284          */
285         void (*foreachMappedEdge)(DerivedMesh *dm,
286                                   void (*func)(void *userData, int index,
287                                                const float v0co[3], const float v1co[3]),
288                                   void *userData);
289
290         /** Iterate over each mapped loop in the derived mesh, calling the given function
291          * with the original loop index and the mapped loops's new coordinate and normal.
292          */
293         void (*foreachMappedLoop)(DerivedMesh *dm,
294                                   void (*func)(void *userData, int vertex_index, int face_index,
295                                                const float co[3], const float no[3]),
296                                   void *userData,
297                                   DMForeachFlag flag);
298
299         /** Iterate over each mapped face in the derived mesh, calling the
300          * given function with the original face and the mapped face's (or
301          * faces') center and normal.
302          */
303         void (*foreachMappedFaceCenter)(DerivedMesh *dm,
304                                         void (*func)(void *userData, int index,
305                                                      const float cent[3], const float no[3]),
306                                         void *userData,
307                                         DMForeachFlag flag);
308
309         /** Iterate over all vertex points, calling DO_MINMAX with given args.
310          *
311          * Also called in Editmode
312          */
313         void (*getMinMax)(DerivedMesh *dm, float r_min[3], float r_max[3]);
314
315         /** Direct Access Operations
316          * - Can be undefined
317          * - Must be defined for modifiers that only deform however */
318
319         /** Get vertex location, undefined if index is not valid */
320         void (*getVertCo)(DerivedMesh *dm, int index, float r_co[3]);
321
322         /** Fill the array (of length .getNumVerts()) with all vertex locations */
323         void (*getVertCos)(DerivedMesh *dm, float (*r_cos)[3]);
324
325         /** Get smooth vertex normal, undefined if index is not valid */
326         void (*getVertNo)(DerivedMesh *dm, int index, float r_no[3]);
327         void (*getPolyNo)(DerivedMesh *dm, int index, float r_no[3]);
328
329         /** Get a map of vertices to faces
330          */
331         const struct MeshElemMap *(*getPolyMap)(struct Object *ob, DerivedMesh *dm);
332
333         /** Get the BVH used for paint modes
334          */
335         struct PBVH *(*getPBVH)(struct Object *ob, DerivedMesh *dm);
336
337         /** Release reference to the DerivedMesh. This function decides internally
338          * if the DerivedMesh will be freed, or cached for later use. */
339         void (*release)(DerivedMesh *dm);
340 };
341
342 void DM_init_funcs(DerivedMesh *dm);
343
344 void DM_init(
345         DerivedMesh *dm, DerivedMeshType type, int numVerts, int numEdges,
346         int numFaces, int numLoops, int numPolys);
347
348 void DM_from_template_ex(
349         DerivedMesh *dm, DerivedMesh *source, DerivedMeshType type,
350         int numVerts, int numEdges, int numTessFaces,
351         int numLoops, int numPolys,
352         const struct CustomData_MeshMasks *mask);
353 void DM_from_template(
354         DerivedMesh *dm, DerivedMesh *source,
355         DerivedMeshType type,
356         int numVerts, int numEdges, int numFaces,
357         int numLoops, int numPolys);
358
359 /** utility function to release a DerivedMesh's layers
360  * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
361  */
362 int DM_release(DerivedMesh *dm);
363
364 /** utility function to convert a DerivedMesh to a Mesh
365  */
366 void DM_to_mesh(DerivedMesh *dm, struct Mesh *me, struct Object *ob,
367                 const struct CustomData_MeshMasks *mask, bool take_ownership);
368
369
370 void DM_set_only_copy(DerivedMesh *dm, const struct CustomData_MeshMasks *mask);
371
372 /* adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
373  * backed by an external data array
374  * alloctype defines how the layer is allocated or copied, and how it is
375  * freed, see BKE_customdata.h for the different options
376  */
377 void DM_add_vert_layer(
378         struct DerivedMesh *dm, int type, eCDAllocType alloctype,
379         void *layer);
380 void DM_add_edge_layer(
381         struct DerivedMesh *dm, int type, eCDAllocType alloctype,
382         void *layer);
383 void DM_add_tessface_layer(
384         struct DerivedMesh *dm, int type, eCDAllocType alloctype,
385         void *layer);
386 void DM_add_loop_layer(
387         DerivedMesh *dm, int type, eCDAllocType alloctype,
388         void *layer);
389 void DM_add_poly_layer(
390         struct DerivedMesh *dm, int type, eCDAllocType alloctype,
391         void *layer);
392
393 /* custom data access functions
394  * return pointer to data from first layer which matches type
395  * if they return NULL for valid indices, data doesn't exist
396  * note these return pointers - any change modifies the internals of the mesh
397  */
398 void *DM_get_vert_data(struct DerivedMesh *dm, int index, int type);
399 void *DM_get_edge_data(struct DerivedMesh *dm, int index, int type);
400 void *DM_get_tessface_data(struct DerivedMesh *dm, int index, int type);
401 void *DM_get_poly_data(struct DerivedMesh *dm, int index, int type);
402
403 /* custom data layer access functions
404  * return pointer to first data layer which matches type (a flat array)
405  * if they return NULL, data doesn't exist
406  * note these return pointers - any change modifies the internals of the mesh
407  */
408 void *DM_get_vert_data_layer(struct DerivedMesh *dm, int type);
409 void *DM_get_edge_data_layer(struct DerivedMesh *dm, int type);
410 void *DM_get_tessface_data_layer(struct DerivedMesh *dm, int type);
411 void *DM_get_poly_data_layer(struct DerivedMesh *dm, int type);
412 void *DM_get_loop_data_layer(struct DerivedMesh *dm, int type);
413
414 /* custom data setting functions
415  * copy supplied data into first layer of type using layer's copy function
416  * (deep copy if appropriate)
417  */
418 void DM_set_vert_data(struct DerivedMesh *dm, int index, int type, void *data);
419 void DM_set_edge_data(struct DerivedMesh *dm, int index, int type, void *data);
420 void DM_set_tessface_data(struct DerivedMesh *dm, int index, int type, void *data);
421
422 /* custom data copy functions
423  * copy count elements from source_index in source to dest_index in dest
424  * these copy all layers for which the CD_FLAG_NOCOPY flag is not set
425  */
426 void DM_copy_vert_data(
427         struct DerivedMesh *source, struct DerivedMesh *dest,
428         int source_index, int dest_index, int count);
429 void DM_copy_edge_data(
430         struct DerivedMesh *source, struct DerivedMesh *dest,
431         int source_index, int dest_index, int count);
432 void DM_copy_tessface_data(
433         struct DerivedMesh *source, struct DerivedMesh *dest,
434         int source_index, int dest_index, int count);
435 void DM_copy_loop_data(
436         struct DerivedMesh *source, struct DerivedMesh *dest,
437         int source_index, int dest_index, int count);
438 void DM_copy_poly_data(
439         struct DerivedMesh *source, struct DerivedMesh *dest,
440         int source_index, int dest_index, int count);
441
442 /* custom data free functions
443  * free count elements, starting at index
444  * they free all layers for which the CD_FLAG_NOCOPY flag is not set
445  */
446 void DM_free_vert_data(struct DerivedMesh *dm, int index, int count);
447 void DM_free_edge_data(struct DerivedMesh *dm, int index, int count);
448 void DM_free_tessface_data(struct DerivedMesh *dm, int index, int count);
449 void DM_free_loop_data(struct DerivedMesh *dm, int index, int count);
450 void DM_free_poly_data(struct DerivedMesh *dm, int index, int count);
451
452 /*sets up mpolys for a DM based on face iterators in source*/
453 void DM_DupPolys(DerivedMesh *source, DerivedMesh *target);
454
455 void DM_ensure_normals(DerivedMesh *dm);
456
457 void DM_ensure_looptri_data(DerivedMesh *dm);
458
459 void DM_interp_vert_data(
460         struct DerivedMesh *source, struct DerivedMesh *dest,
461         int *src_indices, float *weights,
462         int count, int dest_index);
463
464 typedef float EdgeVertWeight[SUB_ELEMS_EDGE][SUB_ELEMS_EDGE];
465 void DM_interp_edge_data(
466         struct DerivedMesh *source, struct DerivedMesh *dest,
467         int *src_indices,
468         float *weights, EdgeVertWeight *vert_weights,
469         int count, int dest_index);
470
471 typedef float FaceVertWeight[SUB_ELEMS_FACE][SUB_ELEMS_FACE];
472 void DM_interp_tessface_data(
473         struct DerivedMesh *source, struct DerivedMesh *dest,
474         int *src_indices,
475         float *weights, FaceVertWeight *vert_weights,
476         int count, int dest_index);
477
478 void DM_interp_loop_data(
479         struct DerivedMesh *source, struct DerivedMesh *dest,
480         int *src_indices,
481         float *weights, int count, int dest_index);
482
483 void DM_interp_poly_data(
484         struct DerivedMesh *source, struct DerivedMesh *dest,
485         int *src_indices,
486         float *weights, int count, int dest_index);
487
488
489 void mesh_get_mapped_verts_coords(struct Mesh *me_eval, float (*r_cos)[3], const int totcos);
490
491 DerivedMesh *mesh_create_derived_render(
492         struct Depsgraph *depsgraph, struct Scene *scene,
493         struct Object *ob, const struct CustomData_MeshMasks *dataMask);
494
495 /* same as above but wont use render settings */
496 DerivedMesh *mesh_create_derived(struct Mesh *me, float (*vertCos)[3]);
497
498 struct Mesh *editbmesh_get_eval_cage(
499         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *,
500         struct BMEditMesh *em, const struct CustomData_MeshMasks *dataMask);
501 struct Mesh *editbmesh_get_eval_cage_from_orig(
502         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *,
503         struct BMEditMesh *em, const struct CustomData_MeshMasks *dataMask);
504 struct Mesh *editbmesh_get_eval_cage_and_final(
505         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *,
506         struct BMEditMesh *em, const struct CustomData_MeshMasks *dataMask,
507         struct Mesh **r_final);
508
509 float (*editbmesh_get_vertex_cos(struct BMEditMesh *em, int *r_numVerts))[3];
510 bool editbmesh_modifier_is_enabled(struct Scene *scene, struct ModifierData *md, bool has_prev_mesh);
511 void makeDerivedMesh(
512         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, struct BMEditMesh *em,
513         const struct CustomData_MeshMasks *dataMask, const bool build_shapekey_layers);
514
515 void DM_add_named_tangent_layer_for_uv(
516         CustomData *uv_data, CustomData *tan_data, int numLoopData,
517         const char *layer_name);
518
519 void DM_calc_loop_tangents(
520         DerivedMesh *dm, bool calc_active_tangent, const char (*tangent_names)[MAX_NAME],
521         int tangent_names_count);
522
523 void DM_init_origspace(DerivedMesh *dm);
524
525 /* debug only */
526 #ifndef NDEBUG
527 char *DM_debug_info(DerivedMesh *dm);
528 void DM_debug_print(DerivedMesh *dm);
529 void DM_debug_print_cdlayers(CustomData *cdata);
530
531 bool DM_is_valid(DerivedMesh *dm);
532 #endif
533
534 #endif  /* __BKE_DERIVEDMESH_H__ */