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