Merging r58464 through r58474 from trunk into soc-2013-depsgraph_mt
[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
164         /* check this with modifier dependsOnNormals callback to see if normals need recalculation */
165         DM_DIRTY_NORMALS = 1 << 2,
166 }  DMDirtyFlag;
167
168 typedef struct DerivedMesh DerivedMesh;
169 struct DerivedMesh {
170         /** Private DerivedMesh data, only for internal DerivedMesh use */
171         CustomData vertData, edgeData, faceData, loopData, polyData;
172         int numVertData, numEdgeData, numTessFaceData, numLoopData, numPolyData;
173         int needsFree; /* checked on ->release, is set to 0 for cached results */
174         int deformedOnly; /* set by modifier stack if only deformed from original */
175         BVHCache bvhCache;
176         struct GPUDrawObject *drawObject;
177         DerivedMeshType type;
178         float auto_bump_scale;
179         DMDirtyFlag dirty;
180
181         /* use for converting to BMesh which doesn't store bevel weight and edge crease by default */
182         char cd_flag;
183
184         /** Calculate vert and face normals */
185         void (*calcNormals)(DerivedMesh *dm);
186
187         /** Recalculates mesh tessellation */
188         void (*recalcTessellation)(DerivedMesh *dm);
189
190         /* Misc. Queries */
191
192         /* Also called in Editmode */
193         int (*getNumVerts)(DerivedMesh *dm);
194         int (*getNumEdges)(DerivedMesh *dm);
195         int (*getNumTessFaces)(DerivedMesh *dm);
196         int (*getNumLoops)(DerivedMesh *dm);
197         int (*getNumPolys)(DerivedMesh *dm);
198
199         /** Copy a single vert/edge/tessellated face from the derived mesh into
200          * *{vert/edge/face}_r. note that the current implementation
201          * of this function can be quite slow, iterating over all
202          * elements (editmesh)
203          */
204         void (*getVert)(DerivedMesh *dm, int index, struct MVert *vert_r);
205         void (*getEdge)(DerivedMesh *dm, int index, struct MEdge *edge_r);
206         void (*getTessFace)(DerivedMesh *dm, int index, struct MFace *face_r);
207
208         /** Return a pointer to the entire array of verts/edges/face from the
209          * derived mesh. if such an array does not exist yet, it will be created,
210          * and freed on the next ->release(). consider using getVert/Edge/Face if
211          * you are only interested in a few verts/edges/faces.
212          */
213         struct MVert *(*getVertArray)(DerivedMesh * dm);
214         struct MEdge *(*getEdgeArray)(DerivedMesh * dm);
215         struct MFace *(*getTessFaceArray)(DerivedMesh * dm);
216         struct MLoop *(*getLoopArray)(DerivedMesh * dm);
217         struct MPoly *(*getPolyArray)(DerivedMesh * dm);
218
219         /** Copy all verts/edges/faces from the derived mesh into
220          * *{vert/edge/face}_r (must point to a buffer large enough)
221          */
222         void (*copyVertArray)(DerivedMesh *dm, struct MVert *vert_r);
223         void (*copyEdgeArray)(DerivedMesh *dm, struct MEdge *edge_r);
224         void (*copyTessFaceArray)(DerivedMesh *dm, struct MFace *face_r);
225         void (*copyLoopArray)(DerivedMesh *dm, struct MLoop *loop_r);
226         void (*copyPolyArray)(DerivedMesh *dm, struct MPoly *poly_r);
227
228         /** Return a copy of all verts/edges/faces from the derived mesh
229          * it is the caller's responsibility to free the returned pointer
230          */
231         struct MVert *(*dupVertArray)(DerivedMesh * dm);
232         struct MEdge *(*dupEdgeArray)(DerivedMesh * dm);
233         struct MFace *(*dupTessFaceArray)(DerivedMesh * dm);
234         struct MLoop *(*dupLoopArray)(DerivedMesh * dm);
235         struct MPoly *(*dupPolyArray)(DerivedMesh * dm);
236
237         /** Return a pointer to a single element 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 *(*getVertData)(DerivedMesh *dm, int index, int type);
242         void *(*getEdgeData)(DerivedMesh *dm, int index, int type);
243         void *(*getTessFaceData)(DerivedMesh *dm, int index, int type);
244         void *(*getPolyData)(DerivedMesh *dm, int index, int type);
245
246         /** Return a pointer to the entire array of vert/edge/face custom data
247          * from the derived mesh (this gives a pointer to the actual data, not
248          * a copy)
249          */
250         void *(*getVertDataArray)(DerivedMesh *dm, int type);
251         void *(*getEdgeDataArray)(DerivedMesh *dm, int type);
252         void *(*getTessFaceDataArray)(DerivedMesh *dm, int type);
253         void *(*getLoopDataArray)(DerivedMesh *dm, int type);
254         void *(*getPolyDataArray)(DerivedMesh *dm, int type);
255
256         /** Retrieves the base CustomData structures for
257          * verts/edges/tessfaces/loops/facdes*/
258         CustomData *(*getVertDataLayout)(DerivedMesh * dm);
259         CustomData *(*getEdgeDataLayout)(DerivedMesh * dm);
260         CustomData *(*getTessFaceDataLayout)(DerivedMesh * dm);
261         CustomData *(*getLoopDataLayout)(DerivedMesh * dm);
262         CustomData *(*getPolyDataLayout)(DerivedMesh * dm);
263         
264         /** Copies all customdata for an element source into dst at index dest */
265         void (*copyFromVertCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
266         void (*copyFromEdgeCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
267         void (*copyFromFaceCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
268         
269         /** Optional grid access for subsurf */
270         int (*getNumGrids)(DerivedMesh *dm);
271         int (*getGridSize)(DerivedMesh *dm);
272         struct CCGElem **(*getGridData)(DerivedMesh * dm);
273         DMGridAdjacency *(*getGridAdjacency)(DerivedMesh * dm);
274         int *(*getGridOffset)(DerivedMesh * dm);
275         void (*getGridKey)(DerivedMesh *dm, struct CCGKey *key);
276         DMFlagMat *(*getGridFlagMats)(DerivedMesh * dm);
277         unsigned int **(*getGridHidden)(DerivedMesh * dm);
278         
279
280         /** Iterate over each mapped vertex in the derived mesh, calling the
281          * given function with the original vert and the mapped vert's new
282          * coordinate and normal. For historical reasons the normal can be
283          * passed as a float or short array, only one should be non-NULL.
284          */
285         void (*foreachMappedVert)(DerivedMesh *dm,
286                                   void (*func)(void *userData, int index, const float co[3],
287                                                const float no_f[3], const short no_s[3]),
288                                   void *userData);
289
290         /** Iterate over each mapped edge in the derived mesh, calling the
291          * given function with the original edge and the mapped edge's new
292          * coordinates.
293          */
294         void (*foreachMappedEdge)(DerivedMesh *dm,
295                                   void (*func)(void *userData, int index,
296                                                const float v0co[3], const float v1co[3]),
297                                   void *userData);
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
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 min_r[3], float max_r[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 co_r[3]);
320
321         /** Fill the array (of length .getNumVerts()) with all vertex locations */
322         void (*getVertCos)(DerivedMesh *dm, float (*cos_r)[3]);
323
324         /** Get smooth vertex normal, undefined if index is not valid */
325         void (*getVertNo)(DerivedMesh *dm, int index, float no_r[3]);
326         void (*getPolyNo)(DerivedMesh *dm, int index, float no_r[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         /* Drawing Operations */
337
338         /** Draw all vertices as bgl points (no options) */
339         void (*drawVerts)(DerivedMesh *dm);
340
341         /** Draw edges in the UV mesh (if exists) */
342         void (*drawUVEdges)(DerivedMesh *dm);
343
344         /** Draw all edges as lines (no options)
345          *
346          * Also called for *final* editmode DerivedMeshes
347          */
348         void (*drawEdges)(DerivedMesh *dm, int drawLooseEdges, int drawAllEdges);
349         
350         /** Draw all loose edges (edges w/ no adjoining faces) */
351         void (*drawLooseEdges)(DerivedMesh *dm);
352
353         /** Draw all faces
354          *  o Set face normal or vertex normal based on inherited face flag
355          *  o Use inherited face material index to call setMaterial
356          *  o Only if setMaterial returns true
357          *
358          * Also called for *final* editmode DerivedMeshes
359          */
360         void (*drawFacesSolid)(DerivedMesh *dm, float (*partial_redraw_planes)[4],
361                                int fast, DMSetMaterial setMaterial);
362
363         /** Draw all faces using MTFace
364          * - Drawing options too complicated to enumerate, look at code.
365          */
366         void (*drawFacesTex)(DerivedMesh *dm,
367                              DMSetDrawOptionsTex setDrawOptions,
368                              DMCompareDrawOptions compareDrawOptions,
369                              void *userData);
370
371         /** Draw all faces with GLSL materials
372          *  o setMaterial is called for every different material nr
373          *  o Only if setMaterial returns true
374          */
375         void (*drawFacesGLSL)(DerivedMesh *dm, DMSetMaterial setMaterial);
376
377         /** Draw mapped faces (no color, or texture)
378          * - Only if !setDrawOptions or
379          *   setDrawOptions(userData, mapped-face-index, drawSmooth_r)
380          *   returns true
381          *
382          * If drawSmooth is set to true then vertex normals should be set and
383          * glShadeModel called with GL_SMOOTH. Otherwise the face normal should
384          * be set and glShadeModel called with GL_FLAT.
385          *
386          * The setDrawOptions is allowed to not set drawSmooth (for example, when
387          * lighting is disabled), in which case the implementation should draw as
388          * smooth shaded.
389          */
390         void (*drawMappedFaces)(DerivedMesh *dm,
391                                 DMSetDrawOptions setDrawOptions,
392                                 DMSetMaterial setMaterial,
393                                 DMCompareDrawOptions compareDrawOptions,
394                                 void *userData,
395                                 DMDrawFlag flag);
396
397         /** Draw mapped faces using MTFace
398          * - Drawing options too complicated to enumerate, look at code.
399          */
400         void (*drawMappedFacesTex)(DerivedMesh *dm,
401                                    DMSetDrawOptions setDrawOptions,
402                                    DMCompareDrawOptions compareDrawOptions,
403                                    void *userData);
404
405         /** Draw mapped faces with GLSL materials
406          * - setMaterial is called for every different material nr
407          * - setDrawOptions is called for every face
408          * - Only if setMaterial and setDrawOptions return true
409          */
410         void (*drawMappedFacesGLSL)(DerivedMesh *dm,
411                                     DMSetMaterial setMaterial,
412                                     DMSetDrawOptions setDrawOptions,
413                                     void *userData);
414
415         /** Draw mapped edges as lines
416          * - Only if !setDrawOptions or setDrawOptions(userData, mapped-edge)
417          *   returns true
418          */
419         void (*drawMappedEdges)(DerivedMesh *dm,
420                                 DMSetDrawOptions setDrawOptions,
421                                 void *userData);
422
423         /** Draw mapped edges as lines with interpolation values
424          * - Only if !setDrawOptions or
425          *   setDrawOptions(userData, mapped-edge, mapped-v0, mapped-v1, t)
426          *   returns true
427          *
428          * NOTE: This routine is optional!
429          */
430         void (*drawMappedEdgesInterp)(DerivedMesh *dm, 
431                                       DMSetDrawOptions setDrawOptions,
432                                       DMSetDrawInterpOptions setDrawInterpOptions,
433                                       void *userData);
434
435         /** Draw all faces with materials
436          * - setMaterial is called for every different material nr
437          * - setFace is called to verify if a face must be hidden
438          */
439         void (*drawMappedFacesMat)(DerivedMesh *dm,
440                                    void (*setMaterial)(void *userData, int, void *attribs),
441                                    bool (*setFace)(void *userData, int index), void *userData);
442
443         /** Release reference to the DerivedMesh. This function decides internally
444          * if the DerivedMesh will be freed, or cached for later use. */
445         void (*release)(DerivedMesh *dm);
446 };
447
448 /** utility function to initialize a DerivedMesh's function pointers to
449  * the default implementation (for those functions which have a default)
450  */
451 void DM_init_funcs(DerivedMesh *dm);
452
453 /** utility function to initialize a DerivedMesh for the desired number
454  * of vertices, edges and faces (doesn't allocate memory for them, just
455  * sets up the custom data layers)
456  */
457 void DM_init(DerivedMesh *dm, DerivedMeshType type, int numVerts, int numEdges, 
458              int numFaces, int numLoops, int numPolys);
459
460 /** utility function to initialize a DerivedMesh for the desired number
461  * of vertices, edges and faces, with a layer setup copied from source
462  */
463 void DM_from_template(DerivedMesh *dm, DerivedMesh *source,
464                       DerivedMeshType type,
465                       int numVerts, int numEdges, int numFaces,
466                       int numLoops, int numPolys);
467
468 /** utility function to release a DerivedMesh's layers
469  * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
470  */
471 int DM_release(DerivedMesh *dm);
472
473 /** utility function to convert a DerivedMesh to a Mesh
474  */
475 void DM_to_mesh(DerivedMesh *dm, struct Mesh *me, struct Object *ob, CustomDataMask mask);
476
477 struct BMEditMesh *DM_to_editbmesh(struct DerivedMesh *dm,
478                                    struct BMEditMesh *existing, const bool do_tessellate);
479
480 /* conversion to bmesh only */
481 void          DM_to_bmesh_ex(struct DerivedMesh *dm, struct BMesh *bm, const bool calc_face_normal);
482 struct BMesh *DM_to_bmesh(struct DerivedMesh *dm, const bool calc_face_normal);
483
484
485 /** Utility function to convert a DerivedMesh to a shape key block */
486 void DM_to_meshkey(DerivedMesh *dm, struct Mesh *me, struct KeyBlock *kb);
487
488 /** set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
489  * zero for the layer type, so only layer types specified by the mask
490  * will be copied
491  */
492 void DM_set_only_copy(DerivedMesh *dm, CustomDataMask mask);
493
494 /* adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
495  * backed by an external data array
496  * alloctype defines how the layer is allocated or copied, and how it is
497  * freed, see BKE_customdata.h for the different options
498  */
499 void DM_add_vert_layer(struct DerivedMesh *dm, int type, int alloctype,
500                        void *layer);
501 void DM_add_edge_layer(struct DerivedMesh *dm, int type, int alloctype,
502                        void *layer);
503 void DM_add_tessface_layer(struct DerivedMesh *dm, int type, int alloctype,
504                            void *layer);
505 void DM_add_loop_layer(DerivedMesh *dm, int type, int alloctype,
506                        void *layer);
507 void DM_add_poly_layer(struct DerivedMesh *dm, int type, int alloctype,
508                        void *layer);
509
510 /* custom data access functions
511  * return pointer to data from first layer which matches type
512  * if they return NULL for valid indices, data doesn't exist
513  * note these return pointers - any change modifies the internals of the mesh
514  */
515 void *DM_get_vert_data(struct DerivedMesh *dm, int index, int type);
516 void *DM_get_edge_data(struct DerivedMesh *dm, int index, int type);
517 void *DM_get_tessface_data(struct DerivedMesh *dm, int index, int type);
518 void *DM_get_poly_data(struct DerivedMesh *dm, int index, int type);
519
520 /* custom data layer access functions
521  * return pointer to first data layer which matches type (a flat array)
522  * if they return NULL, data doesn't exist
523  * note these return pointers - any change modifies the internals of the mesh
524  */
525 void *DM_get_vert_data_layer(struct DerivedMesh *dm, int type);
526 void *DM_get_edge_data_layer(struct DerivedMesh *dm, int type);
527 void *DM_get_tessface_data_layer(struct DerivedMesh *dm, int type);
528 void *DM_get_poly_data_layer(struct DerivedMesh *dm, int type);
529 void *DM_get_loop_data_layer(struct DerivedMesh *dm, int type);
530
531 /* custom data setting functions
532  * copy supplied data into first layer of type using layer's copy function
533  * (deep copy if appropriate)
534  */
535 void DM_set_vert_data(struct DerivedMesh *dm, int index, int type, void *data);
536 void DM_set_edge_data(struct DerivedMesh *dm, int index, int type, void *data);
537 void DM_set_tessface_data(struct DerivedMesh *dm, int index, int type, void *data);
538
539 /* custom data copy functions
540  * copy count elements from source_index in source to dest_index in dest
541  * these copy all layers for which the CD_FLAG_NOCOPY flag is not set
542  */
543 void DM_copy_vert_data(struct DerivedMesh *source, struct DerivedMesh *dest,
544                        int source_index, int dest_index, int count);
545 void DM_copy_edge_data(struct DerivedMesh *source, struct DerivedMesh *dest,
546                        int source_index, int dest_index, int count);
547 void DM_copy_tessface_data(struct DerivedMesh *source, struct DerivedMesh *dest,
548                            int source_index, int dest_index, int count);
549 void DM_copy_loop_data(struct DerivedMesh *source, struct DerivedMesh *dest,
550                        int source_index, int dest_index, int count);
551 void DM_copy_poly_data(struct DerivedMesh *source, struct DerivedMesh *dest,
552                        int source_index, int dest_index, int count);
553
554 /* custom data free functions
555  * free count elements, starting at index
556  * they free all layers for which the CD_FLAG_NOCOPY flag is not set
557  */
558 void DM_free_vert_data(struct DerivedMesh *dm, int index, int count);
559 void DM_free_edge_data(struct DerivedMesh *dm, int index, int count);
560 void DM_free_tessface_data(struct DerivedMesh *dm, int index, int count);
561 void DM_free_loop_data(struct DerivedMesh *dm, int index, int count);
562 void DM_free_poly_data(struct DerivedMesh *dm, int index, int count);
563
564 /*sets up mpolys for a DM based on face iterators in source*/
565 void DM_DupPolys(DerivedMesh *source, DerivedMesh *target);
566
567 void DM_ensure_normals(DerivedMesh *dm);
568 void DM_ensure_tessface(DerivedMesh *dm);
569
570 void DM_update_tessface_data(DerivedMesh *dm);
571
572 /** interpolates vertex data from the vertices indexed by src_indices in the
573  * source mesh using the given weights and stores the result in the vertex
574  * indexed by dest_index in the dest mesh
575  */
576 void DM_interp_vert_data(struct DerivedMesh *source, struct DerivedMesh *dest,
577                          int *src_indices, float *weights,
578                          int count, int dest_index);
579
580 /** interpolates edge data from the edges indexed by src_indices in the
581  * source mesh using the given weights and stores the result in the edge indexed
582  * by dest_index in the dest mesh.
583  * if weights is NULL, all weights default to 1.
584  * if vert_weights is non-NULL, any per-vertex edge data is interpolated using
585  * vert_weights[i] multiplied by weights[i].
586  */
587 typedef float EdgeVertWeight[SUB_ELEMS_EDGE][SUB_ELEMS_EDGE];
588 void DM_interp_edge_data(struct DerivedMesh *source, struct DerivedMesh *dest,
589                          int *src_indices,
590                          float *weights, EdgeVertWeight *vert_weights,
591                          int count, int dest_index);
592
593 /** interpolates face data from the faces indexed by src_indices in the
594  * source mesh using the given weights and stores the result in the face indexed
595  * by dest_index in the dest mesh.
596  * if weights is NULL, all weights default to 1.
597  * if vert_weights is non-NULL, any per-vertex face data is interpolated using
598  * vert_weights[i] multiplied by weights[i].
599  */
600 typedef float FaceVertWeight[SUB_ELEMS_FACE][SUB_ELEMS_FACE];
601 void DM_interp_tessface_data(struct DerivedMesh *source, struct DerivedMesh *dest,
602                              int *src_indices,
603                              float *weights, FaceVertWeight *vert_weights,
604                              int count, int dest_index);
605
606 void DM_swap_tessface_data(struct DerivedMesh *dm, int index, const int *corner_indices);
607
608 void DM_interp_loop_data(struct DerivedMesh *source, struct DerivedMesh *dest,
609                          int *src_indices,
610                          float *weights, int count, int dest_index);
611
612 void DM_interp_poly_data(struct DerivedMesh *source, struct DerivedMesh *dest,
613                          int *src_indices,
614                          float *weights, int count, int dest_index);
615
616 /* Temporary? A function to give a colorband to derivedmesh for vertexcolor ranges */
617 void vDM_ColorBand_store(const struct ColorBand *coba, const char alert_color[4]);
618
619 /* UNUSED */
620 #if 0
621 /** Simple function to get me->totvert amount of vertices/normals,
622  * correctly deformed and subsurfered. Needed especially when vertexgroups are involved.
623  * In use now by vertex/weight paint and particles */
624 DMCoNo *mesh_get_mapped_verts_nors(struct Scene *scene, struct Object *ob);
625 #endif
626
627 /* */
628 DerivedMesh *mesh_get_derived_final(struct Scene *scene, struct Object *ob,
629                                     CustomDataMask dataMask);
630 DerivedMesh *mesh_get_derived_deform(struct Scene *scene, struct Object *ob,
631                                      CustomDataMask dataMask);
632
633 DerivedMesh *mesh_create_derived_for_modifier(struct Scene *scene, struct Object *ob,
634                                               struct ModifierData *md, int build_shapekey_layers);
635
636 DerivedMesh *mesh_create_derived_render(struct Scene *scene, struct Object *ob,
637                                         CustomDataMask dataMask);
638
639 DerivedMesh *getEditDerivedBMesh(struct BMEditMesh *em, struct Object *ob,
640                                  float (*vertexCos)[3]);
641
642 DerivedMesh *mesh_create_derived_index_render(struct Scene *scene, struct Object *ob, CustomDataMask dataMask, int index);
643
644 /* same as above but wont use render settings */
645 DerivedMesh *mesh_create_derived(struct Mesh *me, struct Object *ob, float (*vertCos)[3]);
646 DerivedMesh *mesh_create_derived_view(struct Scene *scene, struct Object *ob,
647                                       CustomDataMask dataMask);
648 DerivedMesh *mesh_create_derived_no_deform(struct Scene *scene, struct Object *ob,
649                                            float (*vertCos)[3],
650                                            CustomDataMask dataMask);
651 DerivedMesh *mesh_create_derived_no_deform_render(struct Scene *scene, struct Object *ob,
652                                                   float (*vertCos)[3],
653                                                   CustomDataMask dataMask);
654 /* for gameengine */
655 DerivedMesh *mesh_create_derived_no_virtual(struct Scene *scene, struct Object *ob, float (*vertCos)[3],
656                                             CustomDataMask dataMask);
657 DerivedMesh *mesh_create_derived_physics(struct Scene *scene, struct Object *ob, float (*vertCos)[3],
658                                          CustomDataMask dataMask);
659
660 DerivedMesh *editbmesh_get_derived_base(struct Object *, struct BMEditMesh *em);
661 DerivedMesh *editbmesh_get_derived_cage(struct Scene *scene, struct Object *, 
662                                         struct BMEditMesh *em, CustomDataMask dataMask);
663 DerivedMesh *editbmesh_get_derived_cage_and_final(struct Scene *scene, struct Object *, 
664                                                   struct BMEditMesh *em, DerivedMesh **final_r,
665                                                   CustomDataMask dataMask);
666 float (*editbmesh_get_vertex_cos(struct BMEditMesh *em, int *numVerts_r))[3];
667 int editbmesh_modifier_is_enabled(struct Scene *scene, struct ModifierData *md, DerivedMesh *dm);
668 void makeDerivedMesh(struct Scene *scene, struct Object *ob, struct BMEditMesh *em, 
669                      CustomDataMask dataMask, int build_shapekey_layers);
670
671 /** returns an array of deform matrices for crazyspace correction, and the
672  * number of modifiers left */
673 int editbmesh_get_first_deform_matrices(struct Scene *, struct Object *, struct BMEditMesh *em,
674                                         float (**deformmats)[3][3], float (**deformcos)[3]);
675
676 void weight_to_rgb(float r_rgb[3], const float weight);
677 /** Update the weight MCOL preview layer.
678  * If weights are NULL, use object's active vgroup(s).
679  * Else, weights must be an array of weight float values.
680  *     If indices is NULL, it must be of numVerts length.
681  *     Else, it must be of num length, as indices, which contains vertices' idx to apply weights to.
682  *         (other vertices are assumed zero weight).
683  */
684 void DM_update_weight_mcol(struct Object *ob, struct DerivedMesh *dm, int const draw_flag,
685                            float *weights, int num, const int *indices);
686
687 /** convert layers requested by a GLSL material to actually available layers in
688  * the DerivedMesh, with both a pointer for arrays and an offset for editmesh */
689 typedef struct DMVertexAttribs {
690         struct {
691                 struct MTFace *array;
692                 int em_offset, gl_index, gl_texco;
693         } tface[MAX_MTFACE];
694
695         struct {
696                 struct MCol *array;
697                 int em_offset, gl_index;
698         } mcol[MAX_MCOL];
699
700         struct {
701                 float (*array)[4];
702                 int em_offset, gl_index;
703         } tang;
704
705         struct {
706                 float (*array)[3];
707                 int em_offset, gl_index, gl_texco;
708         } orco;
709
710         int tottface, totmcol, tottang, totorco;
711 } DMVertexAttribs;
712
713 void DM_vertex_attributes_from_gpu(DerivedMesh *dm,
714                                    struct GPUVertexAttribs *gattribs, DMVertexAttribs *attribs);
715
716 void DM_add_tangent_layer(DerivedMesh *dm);
717 void DM_calc_auto_bump_scale(DerivedMesh *dm);
718
719 /** Set object's bounding box based on DerivedMesh min/max data */
720 void DM_set_object_boundbox(struct Object *ob, DerivedMesh *dm);
721
722 void DM_init_origspace(DerivedMesh *dm);
723
724 /* debug only */
725 #ifndef NDEBUG
726 char *DM_debug_info(DerivedMesh *dm);
727 void DM_debug_print(DerivedMesh *dm);
728 void DM_debug_print_cdlayers(CustomData *cdata);
729 #endif
730
731 #ifdef __GNUC__
732 BLI_INLINE int DM_origindex_mface_mpoly(const int *index_mf_to_mpoly, const int *index_mp_to_orig, const int i)
733         __attribute__((nonnull(1)))
734 ;
735 #endif
736
737 BLI_INLINE int DM_origindex_mface_mpoly(const int *index_mf_to_mpoly, const int *index_mp_to_orig, const int i)
738 {
739         const int j = index_mf_to_mpoly[i];
740         return (j != ORIGINDEX_NONE) ? (index_mp_to_orig ? index_mp_to_orig[j] : j) : ORIGINDEX_NONE;
741 }
742
743 #endif  /* __BKE_DERIVEDMESH_H__ */