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