Fix #34625: duplivert/face rendering with modifier could crash accessing UV and
[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 /**
32  * Basic design of the DerivedMesh system:
33  *
34  * DerivedMesh is a common set of interfaces for mesh systems.
35  *
36  * There are three main mesh data structures in Blender:
37  * #Mesh, #CDDerivedMesh and #BMesh.
38  *
39  * These, and a few others, all implement DerivedMesh interfaces, 
40  * which contains unified drawing interfaces, a few utility interfaces, 
41  * and a bunch of read-only interfaces intended mostly for conversion from 
42  * one format to another.
43  *
44  * All Mesh structures in blender make use of CustomData, which is used to store
45  * per-element attributes and interpolate them (e.g. uvs, vcols, vgroups, etc).
46  * 
47  * Mesh is the "serialized" structure, used for storing object-mode mesh data
48  * and also for saving stuff to disk.  It's interfaces are also what DerivedMesh
49  * uses to communicate with.
50  * 
51  * CDDM is a little mesh library, that uses Mesh data structures in the backend.
52  * It's mostly used for modifiers, and has the advantages of not taking much
53  * resources.
54  *
55  * BMesh is a full-on brep, used for editmode, some modifiers, etc.  It's much
56  * more capable (if memory-intensive) then CDDM.
57  *
58  * DerivedMesh is somewhat hackish.  Many places assumes that a DerivedMesh is
59  * a CDDM (most of the time by simply copying it and converting it to one).
60  * CDDM is the original structure for modifiers, but has since been superseded
61  * by BMesh, at least for the foreseeable future.
62  */
63
64 /*
65  * Note: This structure is read-only, for all practical purposes.
66  *       At some point in the future, we may want to consider
67  *       creating a replacement structure that implements a proper
68  *       abstract mesh kernel interface.  Or, we can leave this
69  *       as it is and stick with using BMesh and CDDM.
70  */
71
72 #include "DNA_customdata_types.h"
73 #include "DNA_meshdata_types.h"
74
75 #include "BKE_customdata.h"
76 #include "BKE_bvhutils.h"
77
78 struct CCGElem;
79 struct CCGKey;
80 struct MVert;
81 struct MEdge;
82 struct MFace;
83 struct MTFace;
84 struct Object;
85 struct Scene;
86 struct Mesh;
87 struct BMEditMesh;
88 struct KeyBlock;
89 struct ModifierData;
90 struct MCol;
91 struct ColorBand;
92 struct GPUVertexAttribs;
93 struct GPUDrawObject;
94 struct BMEditMesh;
95 struct ListBase;
96 struct PBVH;
97
98 #define DM_OMP_LIMIT 10000  /* setting zero so we can catch bugs in OpenMP/BMesh */
99
100 /* number of sub-elements each mesh element has (for interpolation) */
101 #define SUB_ELEMS_VERT 0
102 #define SUB_ELEMS_EDGE 2
103 #define SUB_ELEMS_FACE 50
104
105 /*
106  * Note: all mface interfaces now officially operate on tessellated data.
107  *       Also, the mface origindex layer indexes mpolys, not mfaces.
108  */
109
110 typedef struct DMCoNo {
111         float co[3];
112         float no[3];
113 } DMCoNo;
114
115 typedef struct DMGridAdjacency {
116         int index[4];
117         int rotation[4];
118 } DMGridAdjacency;
119
120 /* keep in sync with MFace/MPoly types */
121 typedef struct DMFlagMat {
122         short mat_nr;
123         char flag;
124 } DMFlagMat;
125
126 typedef enum DerivedMeshType {
127         DM_TYPE_CDDM,
128         DM_TYPE_EDITBMESH,
129         DM_TYPE_CCGDM
130 } DerivedMeshType;
131
132 typedef enum DMDrawOption {
133         /* the element is hidden or otherwise non-drawable */
134         DM_DRAW_OPTION_SKIP = 0,
135         /* normal drawing */
136         DM_DRAW_OPTION_NORMAL = 1,
137         /* draw, but don't set the color from mcol */
138         DM_DRAW_OPTION_NO_MCOL = 2,
139         /* used in drawMappedFaces, use GL stipple for the face */
140         DM_DRAW_OPTION_STIPPLE = 3,
141 } DMDrawOption;
142
143 /* Drawing callback types */
144 typedef int (*DMSetMaterial)(int mat_nr, void *attribs);
145 typedef int (*DMCompareDrawOptions)(void *userData, int cur_index, int next_index);
146 typedef void (*DMSetDrawInterpOptions)(void *userData, int index, float t);
147 typedef DMDrawOption (*DMSetDrawOptions)(void *userData, int index);
148 typedef DMDrawOption (*DMSetDrawOptionsTex)(struct MTFace *tface, int has_vcol, int matnr);
149
150 typedef enum DMDrawFlag {
151         DM_DRAW_USE_COLORS = 1,
152         DM_DRAW_ALWAYS_SMOOTH = 2
153 } DMDrawFlag;
154
155 typedef enum DMDirtyFlag {
156         /* dm has valid tessellated faces, but tessellated CDDATA need to be updated. */
157         DM_DIRTY_TESS_CDLAYERS = 1 << 0,
158         /* One of the MCOL layers have been updated, force updating of GPUDrawObject's colors buffer.
159          * This is necessary with modern, VBO draw code, as e.g. in vpaint mode me->mcol may be updated
160          * without actually rebuilding dm (hence by defautl keeping same GPUDrawObject, and same colors
161          * buffer, which prevents update during a stroke!). */
162         DM_DIRTY_MCOL_UPDATE_DRAW = 1 << 1,
163 } DMDirtyFlag;
164
165 typedef struct DerivedMesh DerivedMesh;
166 struct DerivedMesh {
167         /** Private DerivedMesh data, only for internal DerivedMesh use */
168         CustomData vertData, edgeData, faceData, loopData, polyData;
169         int numVertData, numEdgeData, numTessFaceData, numLoopData, numPolyData;
170         int needsFree; /* checked on ->release, is set to 0 for cached results */
171         int deformedOnly; /* set by modifier stack if only deformed from original */
172         BVHCache bvhCache;
173         struct GPUDrawObject *drawObject;
174         DerivedMeshType type;
175         float auto_bump_scale;
176         DMDirtyFlag dirty;
177
178         /* use for converting to BMesh which doesn't store bevel weight and edge crease by default */
179         char cd_flag;
180
181         /** Calculate vert and face normals */
182         void (*calcNormals)(DerivedMesh *dm);
183
184         /** Recalculates mesh tessellation */
185         void (*recalcTessellation)(DerivedMesh *dm);
186
187         /* Misc. Queries */
188
189         /* Also called in Editmode */
190         int (*getNumVerts)(DerivedMesh *dm);
191         int (*getNumEdges)(DerivedMesh *dm);
192         int (*getNumTessFaces)(DerivedMesh *dm);
193         int (*getNumLoops)(DerivedMesh *dm);
194         int (*getNumPolys)(DerivedMesh *dm);
195
196         /** Copy a single vert/edge/tessellated face from the derived mesh into
197          * *{vert/edge/face}_r. note that the current implementation
198          * of this function can be quite slow, iterating over all
199          * elements (editmesh)
200          */
201         void (*getVert)(DerivedMesh *dm, int index, struct MVert *vert_r);
202         void (*getEdge)(DerivedMesh *dm, int index, struct MEdge *edge_r);
203         void (*getTessFace)(DerivedMesh *dm, int index, struct MFace *face_r);
204
205         /** Return a pointer to the entire array of verts/edges/face from the
206          * derived mesh. if such an array does not exist yet, it will be created,
207          * and freed on the next ->release(). consider using getVert/Edge/Face if
208          * you are only interested in a few verts/edges/faces.
209          */
210         struct MVert *(*getVertArray)(DerivedMesh * dm);
211         struct MEdge *(*getEdgeArray)(DerivedMesh * dm);
212         struct MFace *(*getTessFaceArray)(DerivedMesh * dm);
213         struct MLoop *(*getLoopArray)(DerivedMesh * dm);
214         struct MPoly *(*getPolyArray)(DerivedMesh * dm);
215
216         /** Copy all verts/edges/faces from the derived mesh into
217          * *{vert/edge/face}_r (must point to a buffer large enough)
218          */
219         void (*copyVertArray)(DerivedMesh *dm, struct MVert *vert_r);
220         void (*copyEdgeArray)(DerivedMesh *dm, struct MEdge *edge_r);
221         void (*copyTessFaceArray)(DerivedMesh *dm, struct MFace *face_r);
222         void (*copyLoopArray)(DerivedMesh *dm, struct MLoop *loop_r);
223         void (*copyPolyArray)(DerivedMesh *dm, struct MPoly *poly_r);
224
225         /** Return a copy of all verts/edges/faces from the derived mesh
226          * it is the caller's responsibility to free the returned pointer
227          */
228         struct MVert *(*dupVertArray)(DerivedMesh * dm);
229         struct MEdge *(*dupEdgeArray)(DerivedMesh * dm);
230         struct MFace *(*dupTessFaceArray)(DerivedMesh * dm);
231         struct MLoop *(*dupLoopArray)(DerivedMesh * dm);
232         struct MPoly *(*dupPolyArray)(DerivedMesh * dm);
233
234         /** Return a pointer to a single element of vert/edge/face custom data
235          * from the derived mesh (this gives a pointer to the actual data, not
236          * a copy)
237          */
238         void *(*getVertData)(DerivedMesh *dm, int index, int type);
239         void *(*getEdgeData)(DerivedMesh *dm, int index, int type);
240         void *(*getTessFaceData)(DerivedMesh *dm, int index, int type);
241         void *(*getPolyData)(DerivedMesh *dm, int index, int type);
242
243         /** Return a pointer to the entire array of vert/edge/face custom data
244          * from the derived mesh (this gives a pointer to the actual data, not
245          * a copy)
246          */
247         void *(*getVertDataArray)(DerivedMesh *dm, int type);
248         void *(*getEdgeDataArray)(DerivedMesh *dm, int type);
249         void *(*getTessFaceDataArray)(DerivedMesh *dm, int type);
250         void *(*getLoopDataArray)(DerivedMesh *dm, int type);
251         void *(*getPolyDataArray)(DerivedMesh *dm, int type);
252
253         /** Retrieves the base CustomData structures for
254          * verts/edges/tessfaces/loops/facdes*/
255         CustomData *(*getVertDataLayout)(DerivedMesh * dm);
256         CustomData *(*getEdgeDataLayout)(DerivedMesh * dm);
257         CustomData *(*getTessFaceDataLayout)(DerivedMesh * dm);
258         CustomData *(*getLoopDataLayout)(DerivedMesh * dm);
259         CustomData *(*getPolyDataLayout)(DerivedMesh * dm);
260         
261         /** Copies all customdata for an element source into dst at index dest */
262         void (*copyFromVertCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
263         void (*copyFromEdgeCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
264         void (*copyFromFaceCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
265         
266         /** Optional grid access for subsurf */
267         int (*getNumGrids)(DerivedMesh *dm);
268         int (*getGridSize)(DerivedMesh *dm);
269         struct CCGElem **(*getGridData)(DerivedMesh * dm);
270         DMGridAdjacency *(*getGridAdjacency)(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
287         /** Iterate over each mapped edge in the derived mesh, calling the
288          * given function with the original edge and the mapped edge's new
289          * coordinates.
290          */
291         void (*foreachMappedEdge)(DerivedMesh *dm,
292                                   void (*func)(void *userData, int index,
293                                                const float v0co[3], const float v1co[3]),
294                                   void *userData);
295
296         /** Iterate over each mapped face in the derived mesh, calling the
297          * given function with the original face and the mapped face's (or
298          * faces') center and normal.
299          */
300         void (*foreachMappedFaceCenter)(DerivedMesh *dm,
301                                         void (*func)(void *userData, int index,
302                                                      const float cent[3], const float no[3]),
303                                         void *userData);
304
305         /** Iterate over all vertex points, calling DO_MINMAX with given args.
306          *
307          * Also called in Editmode
308          */
309         void (*getMinMax)(DerivedMesh *dm, float min_r[3], float max_r[3]);
310
311         /** Direct Access Operations
312          * - Can be undefined
313          * - Must be defined for modifiers that only deform however */
314
315         /** Get vertex location, undefined if index is not valid */
316         void (*getVertCo)(DerivedMesh *dm, int index, float co_r[3]);
317
318         /** Fill the array (of length .getNumVerts()) with all vertex locations */
319         void (*getVertCos)(DerivedMesh *dm, float (*cos_r)[3]);
320
321         /** Get smooth vertex normal, undefined if index is not valid */
322         void (*getVertNo)(DerivedMesh *dm, int index, float no_r[3]);
323
324         /** Get a map of vertices to faces
325          */
326         const struct MeshElemMap *(*getPolyMap)(struct Object *ob, DerivedMesh *dm);
327
328         /** Get the BVH used for paint modes
329          */
330         struct PBVH *(*getPBVH)(struct Object *ob, DerivedMesh *dm);
331
332         /* Drawing Operations */
333
334         /** Draw all vertices as bgl points (no options) */
335         void (*drawVerts)(DerivedMesh *dm);
336
337         /** Draw edges in the UV mesh (if exists) */
338         void (*drawUVEdges)(DerivedMesh *dm);
339
340         /** Draw all edges as lines (no options)
341          *
342          * Also called for *final* editmode DerivedMeshes
343          */
344         void (*drawEdges)(DerivedMesh *dm, int drawLooseEdges, int drawAllEdges);
345         
346         /** Draw all loose edges (edges w/ no adjoining faces) */
347         void (*drawLooseEdges)(DerivedMesh *dm);
348
349         /** Draw all faces
350          *  o Set face normal or vertex normal based on inherited face flag
351          *  o Use inherited face material index to call setMaterial
352          *  o Only if setMaterial returns true
353          *
354          * Also called for *final* editmode DerivedMeshes
355          */
356         void (*drawFacesSolid)(DerivedMesh *dm, float (*partial_redraw_planes)[4],
357                                int fast, DMSetMaterial setMaterial);
358
359         /** Draw all faces using MTFace
360          * - Drawing options too complicated to enumerate, look at code.
361          */
362         void (*drawFacesTex)(DerivedMesh *dm,
363                              DMSetDrawOptionsTex setDrawOptions,
364                              DMCompareDrawOptions compareDrawOptions,
365                              void *userData);
366
367         /** Draw all faces with GLSL materials
368          *  o setMaterial is called for every different material nr
369          *  o Only if setMaterial returns true
370          */
371         void (*drawFacesGLSL)(DerivedMesh *dm, DMSetMaterial setMaterial);
372
373         /** Draw mapped faces (no color, or texture)
374          * - Only if !setDrawOptions or
375          *   setDrawOptions(userData, mapped-face-index, drawSmooth_r)
376          *   returns true
377          *
378          * If drawSmooth is set to true then vertex normals should be set and
379          * glShadeModel called with GL_SMOOTH. Otherwise the face normal should
380          * be set and glShadeModel called with GL_FLAT.
381          *
382          * The setDrawOptions is allowed to not set drawSmooth (for example, when
383          * lighting is disabled), in which case the implementation should draw as
384          * smooth shaded.
385          */
386         void (*drawMappedFaces)(DerivedMesh *dm,
387                                 DMSetDrawOptions setDrawOptions,
388                                 DMSetMaterial setMaterial,
389                                 DMCompareDrawOptions compareDrawOptions,
390                                 void *userData,
391                                 DMDrawFlag flag);
392
393         /** Draw mapped faces using MTFace
394          * - Drawing options too complicated to enumerate, look at code.
395          */
396         void (*drawMappedFacesTex)(DerivedMesh *dm,
397                                    DMSetDrawOptions setDrawOptions,
398                                    DMCompareDrawOptions compareDrawOptions,
399                                    void *userData);
400
401         /** Draw mapped faces with GLSL materials
402          * - setMaterial is called for every different material nr
403          * - setDrawOptions is called for every face
404          * - Only if setMaterial and setDrawOptions return true
405          */
406         void (*drawMappedFacesGLSL)(DerivedMesh *dm,
407                                     DMSetMaterial setMaterial,
408                                     DMSetDrawOptions setDrawOptions,
409                                     void *userData);
410
411         /** Draw mapped edges as lines
412          * - Only if !setDrawOptions or setDrawOptions(userData, mapped-edge)
413          *   returns true
414          */
415         void (*drawMappedEdges)(DerivedMesh *dm,
416                                 DMSetDrawOptions setDrawOptions,
417                                 void *userData);
418
419         /** Draw mapped edges as lines with interpolation values
420          * - Only if !setDrawOptions or
421          *   setDrawOptions(userData, mapped-edge, mapped-v0, mapped-v1, t)
422          *   returns true
423          *
424          * NOTE: This routine is optional!
425          */
426         void (*drawMappedEdgesInterp)(DerivedMesh *dm, 
427                                       DMSetDrawOptions setDrawOptions,
428                                       DMSetDrawInterpOptions setDrawInterpOptions,
429                                       void *userData);
430
431         /** Draw all faces with materials
432          * - setMaterial is called for every different material nr
433          * - setFace is called to verify if a face must be hidden
434          */
435         void (*drawMappedFacesMat)(DerivedMesh *dm,
436                                    void (*setMaterial)(void *userData, int, void *attribs),
437                                    int (*setFace)(void *userData, int index), void *userData);
438
439         /** Release reference to the DerivedMesh. This function decides internally
440          * if the DerivedMesh will be freed, or cached for later use. */
441         void (*release)(DerivedMesh *dm);
442 };
443
444 /** utility function to initialize a DerivedMesh's function pointers to
445  * the default implementation (for those functions which have a default)
446  */
447 void DM_init_funcs(DerivedMesh *dm);
448
449 /** utility function to initialize a DerivedMesh for the desired number
450  * of vertices, edges and faces (doesn't allocate memory for them, just
451  * sets up the custom data layers)
452  */
453 void DM_init(DerivedMesh *dm, DerivedMeshType type, int numVerts, int numEdges, 
454              int numFaces, int numLoops, int numPolys);
455
456 /** utility function to initialize a DerivedMesh for the desired number
457  * of vertices, edges and faces, with a layer setup copied from source
458  */
459 void DM_from_template(DerivedMesh *dm, DerivedMesh *source,
460                       DerivedMeshType type,
461                       int numVerts, int numEdges, int numFaces,
462                       int numLoops, int numPolys);
463
464 /** utility function to release a DerivedMesh's layers
465  * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
466  */
467 int DM_release(DerivedMesh *dm);
468
469 /** utility function to convert a DerivedMesh to a Mesh
470  */
471 void DM_to_mesh(DerivedMesh *dm, struct Mesh *me, struct Object *ob);
472
473 struct BMEditMesh *DM_to_editbmesh(struct DerivedMesh *dm,
474                                    struct BMEditMesh *existing, int do_tessellate);
475
476 /* conversion to bmesh only */
477 void          DM_to_bmesh_ex(struct DerivedMesh *dm, struct BMesh *bm);
478 struct BMesh *DM_to_bmesh(struct DerivedMesh *dm);
479
480
481 /** Utility function to convert a DerivedMesh to a shape key block */
482 void DM_to_meshkey(DerivedMesh *dm, struct Mesh *me, struct KeyBlock *kb);
483
484 /** set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
485  * zero for the layer type, so only layer types specified by the mask
486  * will be copied
487  */
488 void DM_set_only_copy(DerivedMesh *dm, CustomDataMask mask);
489
490 /* adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
491  * backed by an external data array
492  * alloctype defines how the layer is allocated or copied, and how it is
493  * freed, see BKE_customdata.h for the different options
494  */
495 void DM_add_vert_layer(struct DerivedMesh *dm, int type, int alloctype,
496                        void *layer);
497 void DM_add_edge_layer(struct DerivedMesh *dm, int type, int alloctype,
498                        void *layer);
499 void DM_add_tessface_layer(struct DerivedMesh *dm, int type, int alloctype,
500                            void *layer);
501 void DM_add_loop_layer(DerivedMesh *dm, int type, int alloctype,
502                        void *layer);
503 void DM_add_poly_layer(struct DerivedMesh *dm, int type, int alloctype,
504                        void *layer);
505
506 /* custom data access functions
507  * return pointer to data from first layer which matches type
508  * if they return NULL for valid indices, data doesn't exist
509  * note these return pointers - any change modifies the internals of the mesh
510  */
511 void *DM_get_vert_data(struct DerivedMesh *dm, int index, int type);
512 void *DM_get_edge_data(struct DerivedMesh *dm, int index, int type);
513 void *DM_get_tessface_data(struct DerivedMesh *dm, int index, int type);
514 void *DM_get_poly_data(struct DerivedMesh *dm, int index, int type);
515
516 /* custom data layer access functions
517  * return pointer to first data layer which matches type (a flat array)
518  * if they return NULL, data doesn't exist
519  * note these return pointers - any change modifies the internals of the mesh
520  */
521 void *DM_get_vert_data_layer(struct DerivedMesh *dm, int type);
522 void *DM_get_edge_data_layer(struct DerivedMesh *dm, int type);
523 void *DM_get_tessface_data_layer(struct DerivedMesh *dm, int type);
524 void *DM_get_poly_data_layer(struct DerivedMesh *dm, int type);
525 void *DM_get_loop_data_layer(struct DerivedMesh *dm, int type);
526
527 /* custom data setting functions
528  * copy supplied data into first layer of type using layer's copy function
529  * (deep copy if appropriate)
530  */
531 void DM_set_vert_data(struct DerivedMesh *dm, int index, int type, void *data);
532 void DM_set_edge_data(struct DerivedMesh *dm, int index, int type, void *data);
533 void DM_set_tessface_data(struct DerivedMesh *dm, int index, int type, void *data);
534
535 /* custom data copy functions
536  * copy count elements from source_index in source to dest_index in dest
537  * these copy all layers for which the CD_FLAG_NOCOPY flag is not set
538  */
539 void DM_copy_vert_data(struct DerivedMesh *source, struct DerivedMesh *dest,
540                        int source_index, int dest_index, int count);
541 void DM_copy_edge_data(struct DerivedMesh *source, struct DerivedMesh *dest,
542                        int source_index, int dest_index, int count);
543 void DM_copy_tessface_data(struct DerivedMesh *source, struct DerivedMesh *dest,
544                            int source_index, int dest_index, int count);
545 void DM_copy_loop_data(struct DerivedMesh *source, struct DerivedMesh *dest,
546                        int source_index, int dest_index, int count);
547 void DM_copy_poly_data(struct DerivedMesh *source, struct DerivedMesh *dest,
548                        int source_index, int dest_index, int count);
549
550 /* custom data free functions
551  * free count elements, starting at index
552  * they free all layers for which the CD_FLAG_NOCOPY flag is not set
553  */
554 void DM_free_vert_data(struct DerivedMesh *dm, int index, int count);
555 void DM_free_edge_data(struct DerivedMesh *dm, int index, int count);
556 void DM_free_tessface_data(struct DerivedMesh *dm, int index, int count);
557 void DM_free_loop_data(struct DerivedMesh *dm, int index, int count);
558 void DM_free_poly_data(struct DerivedMesh *dm, int index, int count);
559
560 /*sets up mpolys for a DM based on face iterators in source*/
561 void DM_DupPolys(DerivedMesh *source, DerivedMesh *target);
562
563 void DM_ensure_tessface(DerivedMesh *dm);
564
565 void DM_update_tessface_data(DerivedMesh *dm);
566
567 /** interpolates vertex data from the vertices indexed by src_indices in the
568  * source mesh using the given weights and stores the result in the vertex
569  * indexed by dest_index in the dest mesh
570  */
571 void DM_interp_vert_data(struct DerivedMesh *source, struct DerivedMesh *dest,
572                          int *src_indices, float *weights,
573                          int count, int dest_index);
574
575 /** interpolates edge data from the edges indexed by src_indices in the
576  * source mesh using the given weights and stores the result in the edge indexed
577  * by dest_index in the dest mesh.
578  * if weights is NULL, all weights default to 1.
579  * if vert_weights is non-NULL, any per-vertex edge data is interpolated using
580  * vert_weights[i] multiplied by weights[i].
581  */
582 typedef float EdgeVertWeight[SUB_ELEMS_EDGE][SUB_ELEMS_EDGE];
583 void DM_interp_edge_data(struct DerivedMesh *source, struct DerivedMesh *dest,
584                          int *src_indices,
585                          float *weights, EdgeVertWeight *vert_weights,
586                          int count, int dest_index);
587
588 /** interpolates face data from the faces indexed by src_indices in the
589  * source mesh using the given weights and stores the result in the face indexed
590  * by dest_index in the dest mesh.
591  * if weights is NULL, all weights default to 1.
592  * if vert_weights is non-NULL, any per-vertex face data is interpolated using
593  * vert_weights[i] multiplied by weights[i].
594  */
595 typedef float FaceVertWeight[SUB_ELEMS_FACE][SUB_ELEMS_FACE];
596 void DM_interp_tessface_data(struct DerivedMesh *source, struct DerivedMesh *dest,
597                              int *src_indices,
598                              float *weights, FaceVertWeight *vert_weights,
599                              int count, int dest_index);
600
601 void DM_swap_tessface_data(struct DerivedMesh *dm, int index, const int *corner_indices);
602
603 void DM_interp_loop_data(struct DerivedMesh *source, struct DerivedMesh *dest,
604                          int *src_indices,
605                          float *weights, int count, int dest_index);
606
607 void DM_interp_poly_data(struct DerivedMesh *source, struct DerivedMesh *dest,
608                          int *src_indices,
609                          float *weights, int count, int dest_index);
610
611 /* Temporary? A function to give a colorband to derivedmesh for vertexcolor ranges */
612 void vDM_ColorBand_store(const struct ColorBand *coba, const char alert_color[4]);
613
614 /** Simple function to get me->totvert amount of vertices/normals,
615  * correctly deformed and subsurfered. Needed especially when vertexgroups are involved.
616  * In use now by vertex/weight paint and particles */
617 DMCoNo *mesh_get_mapped_verts_nors(struct Scene *scene, struct Object *ob);
618
619 /* */
620 DerivedMesh *mesh_get_derived_final(struct Scene *scene, struct Object *ob,
621                                     CustomDataMask dataMask);
622 DerivedMesh *mesh_get_derived_deform(struct Scene *scene, struct Object *ob,
623                                      CustomDataMask dataMask);
624
625 DerivedMesh *mesh_create_derived_for_modifier(struct Scene *scene, struct Object *ob,
626                                               struct ModifierData *md, int build_shapekey_layers);
627
628 DerivedMesh *mesh_create_derived_render(struct Scene *scene, struct Object *ob,
629                                         CustomDataMask dataMask);
630
631 DerivedMesh *getEditDerivedBMesh(struct BMEditMesh *em, struct Object *ob,
632                                  float (*vertexCos)[3]);
633
634 DerivedMesh *mesh_create_derived_index_render(struct Scene *scene, struct Object *ob, CustomDataMask dataMask, int index);
635
636 /* same as above but wont use render settings */
637 DerivedMesh *mesh_create_derived(struct Mesh *me, struct Object *ob, float (*vertCos)[3]);
638 DerivedMesh *mesh_create_derived_view(struct Scene *scene, struct Object *ob,
639                                       CustomDataMask dataMask);
640 DerivedMesh *mesh_create_derived_no_deform(struct Scene *scene, struct Object *ob,
641                                            float (*vertCos)[3],
642                                            CustomDataMask dataMask);
643 DerivedMesh *mesh_create_derived_no_deform_render(struct Scene *scene, struct Object *ob,
644                                                   float (*vertCos)[3],
645                                                   CustomDataMask dataMask);
646 /* for gameengine */
647 DerivedMesh *mesh_create_derived_no_virtual(struct Scene *scene, struct Object *ob, float (*vertCos)[3],
648                                             CustomDataMask dataMask);
649 DerivedMesh *mesh_create_derived_physics(struct Scene *scene, struct Object *ob, float (*vertCos)[3],
650                                          CustomDataMask dataMask);
651
652 DerivedMesh *editbmesh_get_derived_base(struct Object *, struct BMEditMesh *em);
653 DerivedMesh *editbmesh_get_derived_cage(struct Scene *scene, struct Object *, 
654                                         struct BMEditMesh *em, CustomDataMask dataMask);
655 DerivedMesh *editbmesh_get_derived_cage_and_final(struct Scene *scene, struct Object *, 
656                                                   struct BMEditMesh *em, DerivedMesh **final_r,
657                                                   CustomDataMask dataMask);
658 float (*editbmesh_get_vertex_cos(struct BMEditMesh *em, int *numVerts_r))[3];
659 int editbmesh_modifier_is_enabled(struct Scene *scene, struct ModifierData *md, DerivedMesh *dm);
660 void makeDerivedMesh(struct Scene *scene, struct Object *ob, struct BMEditMesh *em, 
661                      CustomDataMask dataMask, int build_shapekey_layers);
662
663 /** returns an array of deform matrices for crazyspace correction, and the
664  * number of modifiers left */
665 int editbmesh_get_first_deform_matrices(struct Scene *, struct Object *, struct BMEditMesh *em,
666                                         float (**deformmats)[3][3], float (**deformcos)[3]);
667
668 void weight_to_rgb(float r_rgb[3], const float weight);
669 /** Update the weight MCOL preview layer.
670  * If weights are NULL, use object's active vgroup(s).
671  * Else, weights must be an array of weight float values.
672  *     If indices is NULL, it must be of numVerts length.
673  *     Else, it must be of num length, as indices, which contains vertices' idx to apply weights to.
674  *         (other vertices are assumed zero weight).
675  */
676 void DM_update_weight_mcol(struct Object *ob, struct DerivedMesh *dm, int const draw_flag,
677                            float *weights, int num, const int *indices);
678
679 /** convert layers requested by a GLSL material to actually available layers in
680  * the DerivedMesh, with both a pointer for arrays and an offset for editmesh */
681 typedef struct DMVertexAttribs {
682         struct {
683                 struct MTFace *array;
684                 int em_offset, gl_index, gl_texco;
685         } tface[MAX_MTFACE];
686
687         struct {
688                 struct MCol *array;
689                 int em_offset, gl_index;
690         } mcol[MAX_MCOL];
691
692         struct {
693                 float (*array)[4];
694                 int em_offset, gl_index;
695         } tang;
696
697         struct {
698                 float (*array)[3];
699                 int em_offset, gl_index, gl_texco;
700         } orco;
701
702         int tottface, totmcol, tottang, totorco;
703 } DMVertexAttribs;
704
705 void DM_vertex_attributes_from_gpu(DerivedMesh *dm,
706                                    struct GPUVertexAttribs *gattribs, DMVertexAttribs *attribs);
707
708 void DM_add_tangent_layer(DerivedMesh *dm);
709 void DM_calc_auto_bump_scale(DerivedMesh *dm);
710
711 /** Set object's bounding box based on DerivedMesh min/max data */
712 void DM_set_object_boundbox(struct Object *ob, DerivedMesh *dm);
713
714 void DM_init_origspace(DerivedMesh *dm);
715
716 /* debug only */
717 #ifndef NDEBUG
718 char *DM_debug_info(DerivedMesh *dm);
719 void DM_debug_print(DerivedMesh *dm);
720 void DM_debug_print_cdlayers(CustomData *cdata);
721 #endif
722
723 #ifdef __GNUC__
724 BLI_INLINE int DM_origindex_mface_mpoly(const int *index_mf_to_mpoly, const int *index_mp_to_orig, const int i)
725         __attribute__((nonnull(1)))
726 ;
727 #endif
728
729 BLI_INLINE int DM_origindex_mface_mpoly(const int *index_mf_to_mpoly, const int *index_mp_to_orig, const int i)
730 {
731         const int j = index_mf_to_mpoly[i];
732         return (j != ORIGINDEX_NONE) ? (index_mp_to_orig ? index_mp_to_orig[j] : j) : ORIGINDEX_NONE;
733 }
734
735 #endif  /* __BKE_DERIVEDMESH_H__ */