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