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