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