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