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