Armature drawing: custom shape scale options
[blender-staging.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         DM_DRAW_SELECT_USE_EDITMODE = (1 << 6)
155 } DMDrawFlag;
156
157 typedef enum DMForeachFlag {
158         DM_FOREACH_NOP = 0,
159         DM_FOREACH_USE_NORMAL = (1 << 0),  /* foreachMappedVert, foreachMappedLoop, foreachMappedFaceCenter */
160 } DMForeachFlag;
161
162 typedef enum DMDirtyFlag {
163         /* dm has valid tessellated faces, but tessellated CDDATA need to be updated. */
164         DM_DIRTY_TESS_CDLAYERS = 1 << 0,
165         /* One of the MCOL layers have been updated, force updating of GPUDrawObject's colors buffer.
166          * This is necessary with modern, VBO draw code, as e.g. in vpaint mode me->mcol may be updated
167          * without actually rebuilding dm (hence by defautl keeping same GPUDrawObject, and same colors
168          * buffer, which prevents update during a stroke!). */
169         DM_DIRTY_MCOL_UPDATE_DRAW = 1 << 1,
170
171         /* check this with modifier dependsOnNormals callback to see if normals need recalculation */
172         DM_DIRTY_NORMALS = 1 << 2,
173 }  DMDirtyFlag;
174
175 typedef struct DerivedMesh DerivedMesh;
176 struct DerivedMesh {
177         /** Private DerivedMesh data, only for internal DerivedMesh use */
178         CustomData vertData, edgeData, faceData, loopData, polyData;
179         int numVertData, numEdgeData, numTessFaceData, numLoopData, numPolyData;
180         int needsFree; /* checked on ->release, is set to 0 for cached results */
181         int deformedOnly; /* set by modifier stack if only deformed from original */
182         BVHCache bvhCache;
183         struct GPUDrawObject *drawObject;
184         DerivedMeshType type;
185         float auto_bump_scale;
186         DMDirtyFlag dirty;
187         int totmat; /* total materials. Will be valid only before object drawing. */
188         struct Material **mat; /* material array. Will be valid only before object drawing */
189
190         /**
191          * \warning Typical access is done via #getLoopTriArray, #getNumLoopTri.
192          */
193         struct {
194                 struct MLoopTri *array;
195                 int num;
196                 int num_alloc;
197         } looptris;
198
199         /* use for converting to BMesh which doesn't store bevel weight and edge crease by default */
200         char cd_flag;
201
202         /** Calculate vert and face normals */
203         void (*calcNormals)(DerivedMesh *dm);
204
205         /** Calculate loop (split) normals */
206         void (*calcLoopNormals)(DerivedMesh *dm, const bool use_split_normals, const float split_angle);
207
208         /** Calculate loop (split) normals, and returns split loop normal spacearr. */
209         void (*calcLoopNormalsSpaceArray)(DerivedMesh *dm, const bool use_split_normals, const float split_angle,
210                                           struct MLoopNorSpaceArray *r_lnors_spacearr);
211
212         void (*calcLoopTangents)(DerivedMesh *dm);
213
214         /** Recalculates mesh tessellation */
215         void (*recalcTessellation)(DerivedMesh *dm);
216
217         /** Loop tessellation cache */
218         void (*recalcLoopTri)(DerivedMesh *dm);
219         /** accessor functions */
220         const struct MLoopTri *(*getLoopTriArray)(DerivedMesh * dm);
221         int (*getNumLoopTri)(DerivedMesh *dm);
222
223         /* Misc. Queries */
224
225         /* Also called in Editmode */
226         int (*getNumVerts)(DerivedMesh *dm);
227         int (*getNumEdges)(DerivedMesh *dm);
228         int (*getNumTessFaces)(DerivedMesh *dm);
229         int (*getNumLoops)(DerivedMesh *dm);
230         int (*getNumPolys)(DerivedMesh *dm);
231
232         /** Copy a single vert/edge/tessellated face from the derived mesh into
233          * ``*r_{vert/edge/face}``. note that the current implementation
234          * of this function can be quite slow, iterating over all
235          * elements (editmesh)
236          */
237         void (*getVert)(DerivedMesh *dm, int index, struct MVert *r_vert);
238         void (*getEdge)(DerivedMesh *dm, int index, struct MEdge *r_edge);
239         void (*getTessFace)(DerivedMesh *dm, int index, struct MFace *r_face);
240
241         /** Return a pointer to the entire array of verts/edges/face from the
242          * derived mesh. if such an array does not exist yet, it will be created,
243          * and freed on the next ->release(). consider using getVert/Edge/Face if
244          * you are only interested in a few verts/edges/faces.
245          */
246         struct MVert *(*getVertArray)(DerivedMesh * dm);
247         struct MEdge *(*getEdgeArray)(DerivedMesh * dm);
248         struct MFace *(*getTessFaceArray)(DerivedMesh * dm);
249         struct MLoop *(*getLoopArray)(DerivedMesh * dm);
250         struct MPoly *(*getPolyArray)(DerivedMesh * dm);
251
252         /** Copy all verts/edges/faces from the derived mesh into
253          * *{vert/edge/face}_r (must point to a buffer large enough)
254          */
255         void (*copyVertArray)(DerivedMesh *dm, struct MVert *r_vert);
256         void (*copyEdgeArray)(DerivedMesh *dm, struct MEdge *r_edge);
257         void (*copyTessFaceArray)(DerivedMesh *dm, struct MFace *r_face);
258         void (*copyLoopArray)(DerivedMesh *dm, struct MLoop *r_loop);
259         void (*copyPolyArray)(DerivedMesh *dm, struct MPoly *r_poly);
260
261         /** Return a copy of all verts/edges/faces from the derived mesh
262          * it is the caller's responsibility to free the returned pointer
263          */
264         struct MVert *(*dupVertArray)(DerivedMesh * dm);
265         struct MEdge *(*dupEdgeArray)(DerivedMesh * dm);
266         struct MFace *(*dupTessFaceArray)(DerivedMesh * dm);
267         struct MLoop *(*dupLoopArray)(DerivedMesh * dm);
268         struct MPoly *(*dupPolyArray)(DerivedMesh * dm);
269
270         /** Return a pointer to a single element of vert/edge/face custom data
271          * from the derived mesh (this gives a pointer to the actual data, not
272          * a copy)
273          */
274         void *(*getVertData)(DerivedMesh *dm, int index, int type);
275         void *(*getEdgeData)(DerivedMesh *dm, int index, int type);
276         void *(*getTessFaceData)(DerivedMesh *dm, int index, int type);
277         void *(*getPolyData)(DerivedMesh *dm, int index, int type);
278
279         /** Return a pointer to the entire array of vert/edge/face custom data
280          * from the derived mesh (this gives a pointer to the actual data, not
281          * a copy)
282          */
283         void *(*getVertDataArray)(DerivedMesh *dm, int type);
284         void *(*getEdgeDataArray)(DerivedMesh *dm, int type);
285         void *(*getTessFaceDataArray)(DerivedMesh *dm, int type);
286         void *(*getLoopDataArray)(DerivedMesh *dm, int type);
287         void *(*getPolyDataArray)(DerivedMesh *dm, int type);
288
289         /** Retrieves the base CustomData structures for
290          * verts/edges/tessfaces/loops/facdes*/
291         CustomData *(*getVertDataLayout)(DerivedMesh * dm);
292         CustomData *(*getEdgeDataLayout)(DerivedMesh * dm);
293         CustomData *(*getTessFaceDataLayout)(DerivedMesh * dm);
294         CustomData *(*getLoopDataLayout)(DerivedMesh * dm);
295         CustomData *(*getPolyDataLayout)(DerivedMesh * dm);
296         
297         /** Copies all customdata for an element source into dst at index dest */
298         void (*copyFromVertCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
299         void (*copyFromEdgeCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
300         void (*copyFromFaceCData)(DerivedMesh *dm, int source, CustomData *dst, int dest);
301         
302         /** Optional grid access for subsurf */
303         int (*getNumGrids)(DerivedMesh *dm);
304         int (*getGridSize)(DerivedMesh *dm);
305         struct CCGElem **(*getGridData)(DerivedMesh * dm);
306         int *(*getGridOffset)(DerivedMesh * dm);
307         void (*getGridKey)(DerivedMesh *dm, struct CCGKey *key);
308         DMFlagMat *(*getGridFlagMats)(DerivedMesh * dm);
309         unsigned int **(*getGridHidden)(DerivedMesh * dm);
310         
311
312         /** Iterate over each mapped vertex in the derived mesh, calling the
313          * given function with the original vert and the mapped vert's new
314          * coordinate and normal. For historical reasons the normal can be
315          * passed as a float or short array, only one should be non-NULL.
316          */
317         void (*foreachMappedVert)(DerivedMesh *dm,
318                                   void (*func)(void *userData, int index, const float co[3],
319                                                const float no_f[3], const short no_s[3]),
320                                   void *userData,
321                                   DMForeachFlag flag);
322
323         /** Iterate over each mapped edge in the derived mesh, calling the
324          * given function with the original edge and the mapped edge's new
325          * coordinates.
326          */
327         void (*foreachMappedEdge)(DerivedMesh *dm,
328                                   void (*func)(void *userData, int index,
329                                                const float v0co[3], const float v1co[3]),
330                                   void *userData);
331
332         /** Iterate over each mapped loop in the derived mesh, calling the given function
333          * with the original loop index and the mapped loops's new coordinate and normal.
334          */
335         void (*foreachMappedLoop)(DerivedMesh *dm,
336                                   void (*func)(void *userData, int vertex_index, int face_index,
337                                                const float co[3], const float no[3]),
338                                   void *userData,
339                                   DMForeachFlag flag);
340
341         /** Iterate over each mapped face in the derived mesh, calling the
342          * given function with the original face and the mapped face's (or
343          * faces') center and normal.
344          */
345         void (*foreachMappedFaceCenter)(DerivedMesh *dm,
346                                         void (*func)(void *userData, int index,
347                                                      const float cent[3], const float no[3]),
348                                         void *userData,
349                                         DMForeachFlag flag);
350
351         /** Iterate over all vertex points, calling DO_MINMAX with given args.
352          *
353          * Also called in Editmode
354          */
355         void (*getMinMax)(DerivedMesh *dm, float r_min[3], float r_max[3]);
356
357         /** Direct Access Operations
358          * - Can be undefined
359          * - Must be defined for modifiers that only deform however */
360
361         /** Get vertex location, undefined if index is not valid */
362         void (*getVertCo)(DerivedMesh *dm, int index, float r_co[3]);
363
364         /** Fill the array (of length .getNumVerts()) with all vertex locations */
365         void (*getVertCos)(DerivedMesh *dm, float (*r_cos)[3]);
366
367         /** Get smooth vertex normal, undefined if index is not valid */
368         void (*getVertNo)(DerivedMesh *dm, int index, float r_no[3]);
369         void (*getPolyNo)(DerivedMesh *dm, int index, float r_no[3]);
370
371         /** Get a map of vertices to faces
372          */
373         const struct MeshElemMap *(*getPolyMap)(struct Object *ob, DerivedMesh *dm);
374
375         /** Get the BVH used for paint modes
376          */
377         struct PBVH *(*getPBVH)(struct Object *ob, DerivedMesh *dm);
378
379         /* Drawing Operations */
380
381         /** Draw all vertices as bgl points (no options) */
382         void (*drawVerts)(DerivedMesh *dm);
383
384         /** Draw edges in the UV mesh (if exists) */
385         void (*drawUVEdges)(DerivedMesh *dm);
386
387         /** Draw all edges as lines (no options)
388          *
389          * Also called for *final* editmode DerivedMeshes
390          */
391         void (*drawEdges)(DerivedMesh *dm, bool drawLooseEdges, bool drawAllEdges);
392         
393         /** Draw all loose edges (edges w/ no adjoining faces) */
394         void (*drawLooseEdges)(DerivedMesh *dm);
395
396         /** Draw all faces
397          *  o Set face normal or vertex normal based on inherited face flag
398          *  o Use inherited face material index to call setMaterial
399          *  o Only if setMaterial returns true
400          *
401          * Also called for *final* editmode DerivedMeshes
402          */
403         void (*drawFacesSolid)(DerivedMesh *dm, float (*partial_redraw_planes)[4],
404                                bool fast, DMSetMaterial setMaterial);
405
406         /** Draw all faces using MTFace
407          * - Drawing options too complicated to enumerate, look at code.
408          */
409         void (*drawFacesTex)(DerivedMesh *dm,
410                              DMSetDrawOptionsTex setDrawOptions,
411                              DMCompareDrawOptions compareDrawOptions,
412                              void *userData, DMDrawFlag uvflag);
413
414         /** Draw all faces with GLSL materials
415          *  o setMaterial is called for every different material nr
416          *  o Only if setMaterial returns true
417          */
418         void (*drawFacesGLSL)(DerivedMesh *dm, DMSetMaterial setMaterial);
419
420         /** Draw mapped faces (no color, or texture)
421          * - Only if !setDrawOptions or
422          *   setDrawOptions(userData, mapped-face-index, r_drawSmooth)
423          *   returns true
424          *
425          * If drawSmooth is set to true then vertex normals should be set and
426          * glShadeModel called with GL_SMOOTH. Otherwise the face normal should
427          * be set and glShadeModel called with GL_FLAT.
428          *
429          * The setDrawOptions is allowed to not set drawSmooth (for example, when
430          * lighting is disabled), in which case the implementation should draw as
431          * smooth shaded.
432          */
433         void (*drawMappedFaces)(DerivedMesh *dm,
434                                 DMSetDrawOptions setDrawOptions,
435                                 DMSetMaterial setMaterial,
436                                 DMCompareDrawOptions compareDrawOptions,
437                                 void *userData,
438                                 DMDrawFlag flag);
439
440         /** Draw mapped faces using MTFace
441          * - Drawing options too complicated to enumerate, look at code.
442          */
443         void (*drawMappedFacesTex)(DerivedMesh *dm,
444                                    DMSetDrawOptionsMappedTex setDrawOptions,
445                                    DMCompareDrawOptions compareDrawOptions,
446                                    void *userData, DMDrawFlag uvflag);
447
448         /** Draw mapped faces with GLSL materials
449          * - setMaterial is called for every different material nr
450          * - setDrawOptions is called for every face
451          * - Only if setMaterial and setDrawOptions return true
452          */
453         void (*drawMappedFacesGLSL)(DerivedMesh *dm,
454                                     DMSetMaterial setMaterial,
455                                     DMSetDrawOptions setDrawOptions,
456                                     void *userData);
457
458         /** Draw mapped edges as lines
459          * - Only if !setDrawOptions or setDrawOptions(userData, mapped-edge)
460          *   returns true
461          */
462         void (*drawMappedEdges)(DerivedMesh *dm,
463                                 DMSetDrawOptions setDrawOptions,
464                                 void *userData);
465
466         /** Draw mapped edges as lines with interpolation values
467          * - Only if !setDrawOptions or
468          *   setDrawOptions(userData, mapped-edge, mapped-v0, mapped-v1, t)
469          *   returns true
470          *
471          * NOTE: This routine is optional!
472          */
473         void (*drawMappedEdgesInterp)(DerivedMesh *dm, 
474                                       DMSetDrawOptions setDrawOptions,
475                                       DMSetDrawInterpOptions setDrawInterpOptions,
476                                       void *userData);
477
478         /** Draw all faces with materials
479          * - setMaterial is called for every different material nr
480          * - setFace is called to verify if a face must be hidden
481          */
482         void (*drawMappedFacesMat)(DerivedMesh *dm,
483                                    void (*setMaterial)(void *userData, int matnr, void *attribs),
484                                    bool (*setFace)(void *userData, int index), void *userData);
485
486         struct GPUDrawObject *(*gpuObjectNew)(DerivedMesh *dm);
487         void (*copy_gpu_data)(DerivedMesh *dm, int type, void *varray_p,
488                               const int *mat_orig_to_new, const void *user_data);
489
490         /** Release reference to the DerivedMesh. This function decides internally
491          * if the DerivedMesh will be freed, or cached for later use. */
492         void (*release)(DerivedMesh *dm);
493 };
494
495 void DM_init_funcs(DerivedMesh *dm);
496
497 void DM_init(
498         DerivedMesh *dm, DerivedMeshType type, int numVerts, int numEdges,
499         int numFaces, int numLoops, int numPolys);
500
501 void DM_from_template(
502         DerivedMesh *dm, DerivedMesh *source,
503         DerivedMeshType type,
504         int numVerts, int numEdges, int numFaces,
505         int numLoops, int numPolys);
506
507 /** utility function to release a DerivedMesh's layers
508  * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
509  */
510 int DM_release(DerivedMesh *dm);
511
512 /** utility function to convert a DerivedMesh to a Mesh
513  */
514 void DM_to_mesh(DerivedMesh *dm, struct Mesh *me, struct Object *ob, CustomDataMask mask, bool take_ownership);
515
516 struct BMEditMesh *DM_to_editbmesh(
517         struct DerivedMesh *dm,
518         struct BMEditMesh *existing, const bool do_tessellate);
519
520 /* conversion to bmesh only */
521 void          DM_to_bmesh_ex(struct DerivedMesh *dm, struct BMesh *bm, const bool calc_face_normal);
522 struct BMesh *DM_to_bmesh(struct DerivedMesh *dm, const bool calc_face_normal);
523
524
525 /** Utility function to convert a DerivedMesh to a shape key block */
526 void DM_to_meshkey(DerivedMesh *dm, struct Mesh *me, struct KeyBlock *kb);
527
528 void DM_set_only_copy(DerivedMesh *dm, CustomDataMask mask);
529
530 /* adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
531  * backed by an external data array
532  * alloctype defines how the layer is allocated or copied, and how it is
533  * freed, see BKE_customdata.h for the different options
534  */
535 void DM_add_vert_layer(
536         struct DerivedMesh *dm, int type, int alloctype,
537         void *layer);
538 void DM_add_edge_layer(
539         struct DerivedMesh *dm, int type, int alloctype,
540         void *layer);
541 void DM_add_tessface_layer(
542         struct DerivedMesh *dm, int type, int alloctype,
543         void *layer);
544 void DM_add_loop_layer(
545         DerivedMesh *dm, int type, int alloctype,
546         void *layer);
547 void DM_add_poly_layer(
548         struct DerivedMesh *dm, int type, int alloctype,
549         void *layer);
550
551 /* custom data access functions
552  * return pointer to data from first layer which matches type
553  * if they return NULL for valid indices, data doesn't exist
554  * note these return pointers - any change modifies the internals of the mesh
555  */
556 void *DM_get_vert_data(struct DerivedMesh *dm, int index, int type);
557 void *DM_get_edge_data(struct DerivedMesh *dm, int index, int type);
558 void *DM_get_tessface_data(struct DerivedMesh *dm, int index, int type);
559 void *DM_get_poly_data(struct DerivedMesh *dm, int index, int type);
560
561 /* custom data layer access functions
562  * return pointer to first data layer which matches type (a flat array)
563  * if they return NULL, data doesn't exist
564  * note these return pointers - any change modifies the internals of the mesh
565  */
566 void *DM_get_vert_data_layer(struct DerivedMesh *dm, int type);
567 void *DM_get_edge_data_layer(struct DerivedMesh *dm, int type);
568 void *DM_get_tessface_data_layer(struct DerivedMesh *dm, int type);
569 void *DM_get_poly_data_layer(struct DerivedMesh *dm, int type);
570 void *DM_get_loop_data_layer(struct DerivedMesh *dm, int type);
571
572 /* custom data setting functions
573  * copy supplied data into first layer of type using layer's copy function
574  * (deep copy if appropriate)
575  */
576 void DM_set_vert_data(struct DerivedMesh *dm, int index, int type, void *data);
577 void DM_set_edge_data(struct DerivedMesh *dm, int index, int type, void *data);
578 void DM_set_tessface_data(struct DerivedMesh *dm, int index, int type, void *data);
579
580 /* custom data copy functions
581  * copy count elements from source_index in source to dest_index in dest
582  * these copy all layers for which the CD_FLAG_NOCOPY flag is not set
583  */
584 void DM_copy_vert_data(
585         struct DerivedMesh *source, struct DerivedMesh *dest,
586         int source_index, int dest_index, int count);
587 void DM_copy_edge_data(
588         struct DerivedMesh *source, struct DerivedMesh *dest,
589         int source_index, int dest_index, int count);
590 void DM_copy_tessface_data(
591         struct DerivedMesh *source, struct DerivedMesh *dest,
592         int source_index, int dest_index, int count);
593 void DM_copy_loop_data(
594         struct DerivedMesh *source, struct DerivedMesh *dest,
595         int source_index, int dest_index, int count);
596 void DM_copy_poly_data(
597         struct DerivedMesh *source, struct DerivedMesh *dest,
598         int source_index, int dest_index, int count);
599
600 /* custom data free functions
601  * free count elements, starting at index
602  * they free all layers for which the CD_FLAG_NOCOPY flag is not set
603  */
604 void DM_free_vert_data(struct DerivedMesh *dm, int index, int count);
605 void DM_free_edge_data(struct DerivedMesh *dm, int index, int count);
606 void DM_free_tessface_data(struct DerivedMesh *dm, int index, int count);
607 void DM_free_loop_data(struct DerivedMesh *dm, int index, int count);
608 void DM_free_poly_data(struct DerivedMesh *dm, int index, int count);
609
610 /*sets up mpolys for a DM based on face iterators in source*/
611 void DM_DupPolys(DerivedMesh *source, DerivedMesh *target);
612
613 void DM_ensure_normals(DerivedMesh *dm);
614 void DM_ensure_tessface(DerivedMesh *dm);
615
616 void DM_ensure_looptri_data(DerivedMesh *dm);
617 void DM_ensure_looptri(DerivedMesh *dm);
618 void DM_verttri_from_looptri(MVertTri *verttri, const MLoop *mloop, const MLoopTri *looptri, int looptri_num);
619
620 void DM_update_tessface_data(DerivedMesh *dm);
621 void DM_generate_tangent_tessface_data(DerivedMesh *dm, bool generate);
622
623 void DM_update_materials(DerivedMesh *dm, struct Object *ob);
624 struct MLoopUV *DM_paint_uvlayer_active_get(DerivedMesh *dm, int mat_nr);
625
626 void DM_interp_vert_data(
627         struct DerivedMesh *source, struct DerivedMesh *dest,
628         int *src_indices, float *weights,
629         int count, int dest_index);
630
631 typedef float EdgeVertWeight[SUB_ELEMS_EDGE][SUB_ELEMS_EDGE];
632 void DM_interp_edge_data(
633         struct DerivedMesh *source, struct DerivedMesh *dest,
634         int *src_indices,
635         float *weights, EdgeVertWeight *vert_weights,
636         int count, int dest_index);
637
638 typedef float FaceVertWeight[SUB_ELEMS_FACE][SUB_ELEMS_FACE];
639 void DM_interp_tessface_data(
640         struct DerivedMesh *source, struct DerivedMesh *dest,
641         int *src_indices,
642         float *weights, FaceVertWeight *vert_weights,
643         int count, int dest_index);
644
645 void DM_swap_tessface_data(struct DerivedMesh *dm, int index, const int *corner_indices);
646
647 void DM_interp_loop_data(
648         struct DerivedMesh *source, struct DerivedMesh *dest,
649         int *src_indices,
650         float *weights, int count, int dest_index);
651
652 void DM_interp_poly_data(
653         struct DerivedMesh *source, struct DerivedMesh *dest,
654         int *src_indices,
655         float *weights, int count, int dest_index);
656
657 /* Temporary? A function to give a colorband to derivedmesh for vertexcolor ranges */
658 void vDM_ColorBand_store(const struct ColorBand *coba, const char alert_color[4]);
659
660 /* UNUSED */
661 #if 0
662 /** Simple function to get me->totvert amount of vertices/normals,
663  * correctly deformed and subsurfered. Needed especially when vertexgroups are involved.
664  * In use now by vertex/weight paint and particles */
665 DMCoNo *mesh_get_mapped_verts_nors(struct Scene *scene, struct Object *ob);
666 #endif
667 void mesh_get_mapped_verts_coords(DerivedMesh *dm, float (*r_cos)[3], const int totcos);
668
669 /* */
670 DerivedMesh *mesh_get_derived_final(
671         struct Scene *scene, struct Object *ob,
672         CustomDataMask dataMask);
673 DerivedMesh *mesh_get_derived_deform(
674         struct Scene *scene, struct Object *ob,
675         CustomDataMask dataMask);
676
677 DerivedMesh *mesh_create_derived_for_modifier(
678         struct Scene *scene, struct Object *ob,
679         struct ModifierData *md, int build_shapekey_layers);
680
681 DerivedMesh *mesh_create_derived_render(
682         struct Scene *scene, struct Object *ob,
683         CustomDataMask dataMask);
684
685 DerivedMesh *getEditDerivedBMesh(
686         struct BMEditMesh *em, struct Object *ob,
687         float (*vertexCos)[3]);
688
689 DerivedMesh *mesh_create_derived_index_render(
690         struct Scene *scene, struct Object *ob,
691         CustomDataMask dataMask, int index);
692
693 /* same as above but wont use render settings */
694 DerivedMesh *mesh_create_derived(struct Mesh *me, float (*vertCos)[3]);
695 DerivedMesh *mesh_create_derived_view(
696         struct Scene *scene, struct Object *ob,
697         CustomDataMask dataMask);
698 DerivedMesh *mesh_create_derived_no_deform(
699         struct Scene *scene, struct Object *ob,
700         float (*vertCos)[3],
701         CustomDataMask dataMask);
702 DerivedMesh *mesh_create_derived_no_deform_render(
703         struct Scene *scene, struct Object *ob,
704         float (*vertCos)[3],
705         CustomDataMask dataMask);
706 /* for gameengine */
707 DerivedMesh *mesh_create_derived_no_virtual(
708         struct Scene *scene, struct Object *ob, float (*vertCos)[3],
709         CustomDataMask dataMask);
710 DerivedMesh *mesh_create_derived_physics(
711         struct Scene *scene, struct Object *ob, float (*vertCos)[3],
712         CustomDataMask dataMask);
713
714 DerivedMesh *editbmesh_get_derived_base(
715         struct Object *, struct BMEditMesh *em);
716 DerivedMesh *editbmesh_get_derived_cage(
717         struct Scene *scene, struct Object *,
718         struct BMEditMesh *em, CustomDataMask dataMask);
719 DerivedMesh *editbmesh_get_derived_cage_and_final(
720         struct Scene *scene, struct Object *,
721         struct BMEditMesh *em, CustomDataMask dataMask,
722         DerivedMesh **r_final);
723
724 DerivedMesh *object_get_derived_final(struct Object *ob, const bool for_render);
725
726 float (*editbmesh_get_vertex_cos(struct BMEditMesh *em, int *r_numVerts))[3];
727 bool editbmesh_modifier_is_enabled(struct Scene *scene, struct ModifierData *md, DerivedMesh *dm);
728 void makeDerivedMesh(
729         struct Scene *scene, struct Object *ob, struct BMEditMesh *em,
730         CustomDataMask dataMask, const bool build_shapekey_layers);
731
732 void weight_to_rgb(float r_rgb[3], const float weight);
733 /** Update the weight MCOL preview layer.
734  * If weights are NULL, use object's active vgroup(s).
735  * Else, weights must be an array of weight float values.
736  *     If indices is NULL, it must be of numVerts length.
737  *     Else, it must be of num length, as indices, which contains vertices' idx to apply weights to.
738  *         (other vertices are assumed zero weight).
739  */
740 void DM_update_weight_mcol(
741         struct Object *ob, struct DerivedMesh *dm, int const draw_flag,
742         float *weights, int num, const int *indices);
743
744 /** convert layers requested by a GLSL material to actually available layers in
745  * the DerivedMesh, with both a pointer for arrays and an offset for editmesh */
746 typedef struct DMVertexAttribs {
747         struct {
748                 struct MLoopUV *array;
749                 int em_offset, gl_index, gl_texco;
750         } tface[MAX_MTFACE];
751
752         struct {
753                 struct MLoopCol *array;
754                 int em_offset, gl_index;
755         } mcol[MAX_MCOL];
756
757         struct {
758                 float (*array)[4];
759                 int em_offset, gl_index;
760         } tang;
761
762         struct {
763                 float (*array)[3];
764                 int em_offset, gl_index, gl_texco;
765         } orco;
766
767         int tottface, totmcol, tottang, totorco;
768 } DMVertexAttribs;
769
770 void DM_vertex_attributes_from_gpu(
771         DerivedMesh *dm,
772         struct GPUVertexAttribs *gattribs, DMVertexAttribs *attribs);
773
774 void DM_draw_attrib_vertex(DMVertexAttribs *attribs, int a, int index, int vert, int loop);
775
776 void DM_calc_loop_tangents(DerivedMesh *dm);
777 void DM_calc_auto_bump_scale(DerivedMesh *dm);
778
779 /** Set object's bounding box based on DerivedMesh min/max data */
780 void DM_set_object_boundbox(struct Object *ob, DerivedMesh *dm);
781
782 void DM_init_origspace(DerivedMesh *dm);
783
784 /* debug only */
785 #ifndef NDEBUG
786 char *DM_debug_info(DerivedMesh *dm);
787 void DM_debug_print(DerivedMesh *dm);
788 void DM_debug_print_cdlayers(CustomData *cdata);
789
790 bool DM_is_valid(DerivedMesh *dm);
791 #endif
792
793 BLI_INLINE int DM_origindex_mface_mpoly(
794         const int *index_mf_to_mpoly, const int *index_mp_to_orig, const int i) ATTR_NONNULL(1);
795
796 BLI_INLINE int DM_origindex_mface_mpoly(
797         const int *index_mf_to_mpoly, const int *index_mp_to_orig, const int i)
798 {
799         const int j = index_mf_to_mpoly[i];
800         return (j != ORIGINDEX_NONE) ? (index_mp_to_orig ? index_mp_to_orig[j] : j) : ORIGINDEX_NONE;
801 }
802
803 struct MVert *DM_get_vert_array(struct DerivedMesh *dm, bool *r_allocated);
804 struct MEdge *DM_get_edge_array(struct DerivedMesh *dm, bool *r_allocated);
805 struct MLoop *DM_get_loop_array(struct DerivedMesh *dm, bool *r_allocated);
806 struct MPoly *DM_get_poly_array(struct DerivedMesh *dm, bool *r_allocated);
807 struct MFace *DM_get_tessface_array(struct DerivedMesh *dm, bool *r_allocated);
808 const MLoopTri *DM_get_looptri_array(
809         DerivedMesh *dm,
810         const MVert *mvert,
811         const MPoly *mpoly, int mpoly_len,
812         const MLoop *mloop, int mloop_len,
813         bool *r_allocated);
814
815 #endif  /* __BKE_DERIVEDMESH_H__ */