small merge needed for testing new animsys in 2.5 BGE, mixing own changes with merge...
[blender-staging.git] / source / blender / blenkernel / BKE_DerivedMesh.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BKE_DERIVEDMESH_H
31 #define BKE_DERIVEDMESH_H
32
33 /* TODO (Probably)
34  *
35  *  o Make drawMapped* functions take a predicate function that
36  *    determines whether to draw the edge (this predicate can
37  *    also set color, etc). This will be slightly more general 
38  *    and allow some of the functions to be collapsed.
39  *  o Once accessor functions are added then single element draw
40  *    functions can be implemented using primitive accessors.
41  *  o Add function to dispatch to renderer instead of using
42  *    conversion to DLM.
43  */
44
45 #include "DNA_customdata_types.h"
46 #include "BKE_customdata.h"
47 #include "BKE_bvhutils.h"
48
49 struct MVert;
50 struct MEdge;
51 struct MFace;
52 struct MTFace;
53 struct Object;
54 struct Scene;
55 struct Mesh;
56 struct EditMesh;
57 struct ModifierData;
58 struct MCol;
59 struct ColorBand;
60 struct GPUVertexAttribs;
61
62 /* number of sub-elements each mesh element has (for interpolation) */
63 #define SUB_ELEMS_VERT 0
64 #define SUB_ELEMS_EDGE 2
65 #define SUB_ELEMS_FACE 4
66
67 typedef struct DerivedMesh DerivedMesh;
68 struct DerivedMesh {
69         /* Private DerivedMesh data, only for internal DerivedMesh use */
70         CustomData vertData, edgeData, faceData;
71         int numVertData, numEdgeData, numFaceData;
72         int needsFree; /* checked on ->release, is set to 0 for cached results */
73         int deformedOnly; /* set by modifier stack if only deformed from original */
74         BVHCache bvhCache;
75
76         /* Misc. Queries */
77
78         /* Also called in Editmode */
79         int (*getNumVerts)(DerivedMesh *dm);
80         /* Also called in Editmode */
81         int (*getNumFaces)(DerivedMesh *dm);
82
83         int (*getNumEdges)(DerivedMesh *dm);
84
85         /* copy a single vert/edge/face from the derived mesh into
86          * *{vert/edge/face}_r. note that the current implementation
87          * of this function can be quite slow, iterating over all
88          * elements (editmesh)
89          */
90         void (*getVert)(DerivedMesh *dm, int index, struct MVert *vert_r);
91         void (*getEdge)(DerivedMesh *dm, int index, struct MEdge *edge_r);
92         void (*getFace)(DerivedMesh *dm, int index, struct MFace *face_r);
93
94         /* return a pointer to the entire array of verts/edges/face from the
95          * derived mesh. if such an array does not exist yet, it will be created,
96          * and freed on the next ->release(). consider using getVert/Edge/Face if
97          * you are only interested in a few verts/edges/faces.
98          */
99         struct MVert *(*getVertArray)(DerivedMesh *dm);
100         struct MEdge *(*getEdgeArray)(DerivedMesh *dm);
101         struct MFace *(*getFaceArray)(DerivedMesh *dm);
102
103         /* copy all verts/edges/faces from the derived mesh into
104          * *{vert/edge/face}_r (must point to a buffer large enough)
105          */
106         void (*copyVertArray)(DerivedMesh *dm, struct MVert *vert_r);
107         void (*copyEdgeArray)(DerivedMesh *dm, struct MEdge *edge_r);
108         void (*copyFaceArray)(DerivedMesh *dm, struct MFace *face_r);
109
110         /* return a copy of all verts/edges/faces from the derived mesh
111          * it is the caller's responsibility to free the returned pointer
112          */
113         struct MVert *(*dupVertArray)(DerivedMesh *dm);
114         struct MEdge *(*dupEdgeArray)(DerivedMesh *dm);
115         struct MFace *(*dupFaceArray)(DerivedMesh *dm);
116
117         /* return a pointer to a single element of vert/edge/face custom data
118          * from the derived mesh (this gives a pointer to the actual data, not
119          * a copy)
120          */
121         void *(*getVertData)(DerivedMesh *dm, int index, int type);
122         void *(*getEdgeData)(DerivedMesh *dm, int index, int type);
123         void *(*getFaceData)(DerivedMesh *dm, int index, int type);
124
125         /* return a pointer to the entire array of vert/edge/face custom data
126          * from the derived mesh (this gives a pointer to the actual data, not
127          * a copy)
128          */
129         void *(*getVertDataArray)(DerivedMesh *dm, int type);
130         void *(*getEdgeDataArray)(DerivedMesh *dm, int type);
131         void *(*getFaceDataArray)(DerivedMesh *dm, int type);
132
133         /* Iterate over each mapped vertex in the derived mesh, calling the
134          * given function with the original vert and the mapped vert's new
135          * coordinate and normal. For historical reasons the normal can be
136          * passed as a float or short array, only one should be non-NULL.
137          */
138         void (*foreachMappedVert)(
139                               DerivedMesh *dm,
140                               void (*func)(void *userData, int index, float *co,
141                                            float *no_f, short *no_s),
142                               void *userData);
143
144         /* Iterate over each mapped edge in the derived mesh, calling the
145          * given function with the original edge and the mapped edge's new
146          * coordinates.
147          */
148         void (*foreachMappedEdge)(DerivedMesh *dm,
149                                   void (*func)(void *userData, int index,
150                                                float *v0co, float *v1co),
151                                   void *userData);
152
153         /* Iterate over each mapped face in the derived mesh, calling the
154          * given function with the original face and the mapped face's (or
155          * faces') center and normal.
156          */
157         void (*foreachMappedFaceCenter)(DerivedMesh *dm,
158                                         void (*func)(void *userData, int index,
159                                                      float *cent, float *no),
160                                         void *userData);
161
162         /* Iterate over all vertex points, calling DO_MINMAX with given args.
163          *
164          * Also called in Editmode
165          */
166         void (*getMinMax)(DerivedMesh *dm, float min_r[3], float max_r[3]);
167
168         /* Direct Access Operations */
169         /*  o Can be undefined */
170         /*  o Must be defined for modifiers that only deform however */
171
172         /* Get vertex location, undefined if index is not valid */
173         void (*getVertCo)(DerivedMesh *dm, int index, float co_r[3]);
174
175         /* Fill the array (of length .getNumVerts()) with all vertex locations */
176         void (*getVertCos)(DerivedMesh *dm, float (*cos_r)[3]);
177
178         /* Get vertex normal, undefined if index is not valid */
179         void (*getVertNo)(DerivedMesh *dm, int index, float no_r[3]);
180
181         /* Drawing Operations */
182
183         /* Draw all vertices as bgl points (no options) */
184         void (*drawVerts)(DerivedMesh *dm);
185
186         /* Draw edges in the UV mesh (if exists) */
187         void (*drawUVEdges)(DerivedMesh *dm);
188
189         /* Draw all edges as lines (no options) 
190          *
191          * Also called for *final* editmode DerivedMeshes
192          */
193         void (*drawEdges)(DerivedMesh *dm, int drawLooseEdges);
194         
195         /* Draw all loose edges (edges w/ no adjoining faces) */
196         void (*drawLooseEdges)(DerivedMesh *dm);
197
198         /* Draw all faces
199          *  o Set face normal or vertex normal based on inherited face flag
200          *  o Use inherited face material index to call setMaterial
201          *  o Only if setMaterial returns true
202          *
203          * Also called for *final* editmode DerivedMeshes
204          */
205         void (*drawFacesSolid)(DerivedMesh *dm,
206                                int (*setMaterial)(int, void *attribs));
207
208         /* Draw all faces
209          *  o If useTwoSided, draw front and back using col arrays
210          *  o col1,col2 are arrays of length numFace*4 of 4 component colors
211          *    in ABGR format, and should be passed as per-face vertex color.
212          */
213         void (*drawFacesColored)(DerivedMesh *dm, int useTwoSided,
214                                  unsigned char *col1, unsigned char *col2);
215
216         /* Draw all faces using MTFace 
217          *  o Drawing options too complicated to enumerate, look at code.
218          */
219         void (*drawFacesTex)(DerivedMesh *dm,
220                              int (*setDrawOptions)(struct MTFace *tface,
221                              struct MCol *mcol, int matnr));
222
223         /* Draw all faces with GLSL materials
224          *  o setMaterial is called for every different material nr
225          *  o Only if setMaterial returns true
226          */
227         void (*drawFacesGLSL)(DerivedMesh *dm,
228                 int (*setMaterial)(int, void *attribs));
229
230         /* Draw mapped faces (no color, or texture)
231          *  o Only if !setDrawOptions or
232          *    setDrawOptions(userData, mapped-face-index, drawSmooth_r)
233          *    returns true
234          *
235          * If drawSmooth is set to true then vertex normals should be set and
236          * glShadeModel called with GL_SMOOTH. Otherwise the face normal should
237          * be set and glShadeModel called with GL_FLAT.
238          *
239          * The setDrawOptions is allowed to not set drawSmooth (for example, when
240          * lighting is disabled), in which case the implementation should draw as
241          * smooth shaded.
242          */
243         void (*drawMappedFaces)(DerivedMesh *dm,
244                                 int (*setDrawOptions)(void *userData, int index,
245                                                       int *drawSmooth_r),
246                                 void *userData, int useColors);
247
248         /* Draw mapped faces using MTFace 
249          *  o Drawing options too complicated to enumerate, look at code.
250          */
251         void (*drawMappedFacesTex)(DerivedMesh *dm,
252                                    int (*setDrawOptions)(void *userData,
253                                                          int index),
254                                    void *userData);
255
256         /* Draw mapped faces with GLSL materials
257          *  o setMaterial is called for every different material nr
258          *  o setDrawOptions is called for every face
259          *  o Only if setMaterial and setDrawOptions return true
260          */
261         void (*drawMappedFacesGLSL)(DerivedMesh *dm,
262                 int (*setMaterial)(int, void *attribs),
263                 int (*setDrawOptions)(void *userData, int index), void *userData);
264
265         /* Draw mapped edges as lines
266          *  o Only if !setDrawOptions or setDrawOptions(userData, mapped-edge)
267          *    returns true
268          */
269         void (*drawMappedEdges)(DerivedMesh *dm,
270                                 int (*setDrawOptions)(void *userData, int index),
271                                 void *userData);
272
273         /* Draw mapped edges as lines with interpolation values
274          *  o Only if !setDrawOptions or
275          *    setDrawOptions(userData, mapped-edge, mapped-v0, mapped-v1, t)
276          *    returns true
277          *
278          * NOTE: This routine is optional!
279          */
280         void (*drawMappedEdgesInterp)(DerivedMesh *dm, 
281                                       int (*setDrawOptions)(void *userData,
282                                                             int index), 
283                                       void (*setDrawInterpOptions)(void *userData,
284                                                                    int index,
285                                                                    float t),
286                                       void *userData);
287
288         /* Release reference to the DerivedMesh. This function decides internally
289          * if the DerivedMesh will be freed, or cached for later use. */
290         void (*release)(DerivedMesh *dm);
291 };
292
293 /* utility function to initialise a DerivedMesh's function pointers to
294  * the default implementation (for those functions which have a default)
295  */
296 void DM_init_funcs(DerivedMesh *dm);
297
298 /* utility function to initialise a DerivedMesh for the desired number
299  * of vertices, edges and faces (doesn't allocate memory for them, just
300  * sets up the custom data layers)
301  */
302 void DM_init(DerivedMesh *dm, int numVerts, int numEdges, int numFaces);
303
304 /* utility function to initialise a DerivedMesh for the desired number
305  * of vertices, edges and faces, with a layer setup copied from source
306  */
307 void DM_from_template(DerivedMesh *dm, DerivedMesh *source,
308                       int numVerts, int numEdges, int numFaces);
309
310 /* utility function to release a DerivedMesh's layers
311  * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
312  */
313 int DM_release(DerivedMesh *dm);
314
315 /* utility function to convert a DerivedMesh to a Mesh
316  */
317 void DM_to_mesh(DerivedMesh *dm, struct Mesh *me);
318
319 /* set the CD_FLAG_NOCOPY flag in custom data layers where the mask is
320  * zero for the layer type, so only layer types specified by the mask
321  * will be copied
322  */
323 void DM_set_only_copy(DerivedMesh *dm, CustomDataMask mask);
324
325 /* adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
326  * backed by an external data array
327  * alloctype defines how the layer is allocated or copied, and how it is
328  * freed, see BKE_customdata.h for the different options
329  */
330 void DM_add_vert_layer(struct DerivedMesh *dm, int type, int alloctype,
331                        void *layer);
332 void DM_add_edge_layer(struct DerivedMesh *dm, int type, int alloctype,
333                        void *layer);
334 void DM_add_face_layer(struct DerivedMesh *dm, int type, int alloctype,
335                        void *layer);
336
337 /* custom data access functions
338  * return pointer to data from first layer which matches type
339  * if they return NULL for valid indices, data doesn't exist
340  * note these return pointers - any change modifies the internals of the mesh
341  */
342 void *DM_get_vert_data(struct DerivedMesh *dm, int index, int type);
343 void *DM_get_edge_data(struct DerivedMesh *dm, int index, int type);
344 void *DM_get_face_data(struct DerivedMesh *dm, int index, int type);
345
346 /* custom data layer access functions
347  * return pointer to first data layer which matches type (a flat array)
348  * if they return NULL, data doesn't exist
349  * note these return pointers - any change modifies the internals of the mesh
350  */
351 void *DM_get_vert_data_layer(struct DerivedMesh *dm, int type);
352 void *DM_get_edge_data_layer(struct DerivedMesh *dm, int type);
353 void *DM_get_face_data_layer(struct DerivedMesh *dm, int type);
354
355 /* custom data setting functions
356  * copy supplied data into first layer of type using layer's copy function
357  * (deep copy if appropriate)
358  */
359 void DM_set_vert_data(struct DerivedMesh *dm, int index, int type, void *data);
360 void DM_set_edge_data(struct DerivedMesh *dm, int index, int type, void *data);
361 void DM_set_face_data(struct DerivedMesh *dm, int index, int type, void *data);
362
363 /* custom data copy functions
364  * copy count elements from source_index in source to dest_index in dest
365  * these copy all layers for which the CD_FLAG_NOCOPY flag is not set
366  */
367 void DM_copy_vert_data(struct DerivedMesh *source, struct DerivedMesh *dest,
368                        int source_index, int dest_index, int count);
369 void DM_copy_edge_data(struct DerivedMesh *source, struct DerivedMesh *dest,
370                        int source_index, int dest_index, int count);
371 void DM_copy_face_data(struct DerivedMesh *source, struct DerivedMesh *dest,
372                        int source_index, int dest_index, int count);
373
374 /* custom data free functions
375  * free count elements, starting at index
376  * they free all layers for which the CD_FLAG_NOCOPY flag is not set
377  */
378 void DM_free_vert_data(struct DerivedMesh *dm, int index, int count);
379 void DM_free_edge_data(struct DerivedMesh *dm, int index, int count);
380 void DM_free_face_data(struct DerivedMesh *dm, int index, int count);
381
382 /* interpolates vertex data from the vertices indexed by src_indices in the
383  * source mesh using the given weights and stores the result in the vertex
384  * indexed by dest_index in the dest mesh
385  */
386 void DM_interp_vert_data(struct DerivedMesh *source, struct DerivedMesh *dest,
387                          int *src_indices, float *weights,
388                          int count, int dest_index);
389
390 /* interpolates edge data from the edges indexed by src_indices in the
391  * source mesh using the given weights and stores the result in the edge indexed
392  * by dest_index in the dest mesh.
393  * if weights is NULL, all weights default to 1.
394  * if vert_weights is non-NULL, any per-vertex edge data is interpolated using
395  * vert_weights[i] multiplied by weights[i].
396  */
397 typedef float EdgeVertWeight[SUB_ELEMS_EDGE][SUB_ELEMS_EDGE];
398 void DM_interp_edge_data(struct DerivedMesh *source, struct DerivedMesh *dest,
399                          int *src_indices,
400                          float *weights, EdgeVertWeight *vert_weights,
401                          int count, int dest_index);
402
403 /* interpolates face data from the faces indexed by src_indices in the
404  * source mesh using the given weights and stores the result in the face indexed
405  * by dest_index in the dest mesh.
406  * if weights is NULL, all weights default to 1.
407  * if vert_weights is non-NULL, any per-vertex face data is interpolated using
408  * vert_weights[i] multiplied by weights[i].
409  */
410 typedef float FaceVertWeight[SUB_ELEMS_FACE][SUB_ELEMS_FACE];
411 void DM_interp_face_data(struct DerivedMesh *source, struct DerivedMesh *dest,
412                          int *src_indices,
413                          float *weights, FaceVertWeight *vert_weights,
414                          int count, int dest_index);
415
416 void DM_swap_face_data(struct DerivedMesh *dm, int index, int *corner_indices);
417
418 /* Temporary? A function to give a colorband to derivedmesh for vertexcolor ranges */
419 void vDM_ColorBand_store(struct ColorBand *coba);
420
421 /* Simple function to get me->totvert amount of vertices/normals,
422    correctly deformed and subsurfered. Needed especially when vertexgroups are involved.
423    In use now by vertex/weigt paint and particles */
424 float *mesh_get_mapped_verts_nors(struct Scene *scene, struct Object *ob);
425
426         /* */
427 DerivedMesh *mesh_get_derived_final(struct Scene *scene, struct Object *ob,
428                                     CustomDataMask dataMask);
429 DerivedMesh *mesh_get_derived_deform(struct Scene *scene, struct Object *ob,
430                                      CustomDataMask dataMask);
431
432 DerivedMesh *mesh_create_derived_for_modifier(struct Scene *scene, struct Object *ob, struct ModifierData *md);
433
434 DerivedMesh *mesh_create_derived_render(struct Scene *scene, struct Object *ob,
435                                         CustomDataMask dataMask);
436
437 DerivedMesh *mesh_create_derived_index_render(struct Scene *scene, struct Object *ob, CustomDataMask dataMask, int index);
438
439                 /* same as above but wont use render settings */
440 DerivedMesh *mesh_create_derived_view(struct Scene *scene, struct Object *ob,
441                                       CustomDataMask dataMask);
442 DerivedMesh *mesh_create_derived_no_deform(struct Scene *scene, struct Object *ob,
443                                            float (*vertCos)[3],
444                                            CustomDataMask dataMask);
445 DerivedMesh *mesh_create_derived_no_deform_render(struct Scene *scene, struct Object *ob,
446                                                   float (*vertCos)[3],
447                                                   CustomDataMask dataMask);
448 /* for gameengine */
449 DerivedMesh *mesh_create_derived_no_virtual(struct Scene *scene, struct Object *ob, float (*vertCos)[3],
450                                             CustomDataMask dataMask);
451
452 DerivedMesh *editmesh_get_derived_base(struct Object *, struct EditMesh *em);
453 DerivedMesh *editmesh_get_derived_cage(struct Scene *scene, struct Object *, 
454                                                                            struct EditMesh *em, CustomDataMask dataMask);
455 DerivedMesh *editmesh_get_derived_cage_and_final(struct Scene *scene, struct Object *, 
456                                                                                                  struct EditMesh *em, DerivedMesh **final_r,
457                                                  CustomDataMask dataMask);
458 void makeDerivedMesh(struct Scene *scene, struct Object *ob, struct EditMesh *em, CustomDataMask dataMask);
459
460 /* returns an array of deform matrices for crazyspace correction, and the
461    number of modifiers left */
462 int editmesh_get_first_deform_matrices(struct Object *, struct EditMesh *em, float (**deformmats)[3][3],
463                                        float (**deformcos)[3]);
464
465 void weight_to_rgb(float input, float *fr, float *fg, float *fb);
466
467 /* convert layers requested by a GLSL material to actually available layers in
468  * the DerivedMesh, with both a pointer for arrays and an offset for editmesh */
469 typedef struct DMVertexAttribs {
470         struct {
471                 struct MTFace *array;
472                 int emOffset, glIndex;
473         } tface[MAX_MTFACE];
474
475         struct {
476                 struct MCol *array;
477                 int emOffset, glIndex;
478         } mcol[MAX_MCOL];
479
480         struct {
481                 float (*array)[3];
482                 int emOffset, glIndex;
483         } tang;
484
485         struct {
486                 float (*array)[3];
487                 int emOffset, glIndex;
488         } orco;
489
490         int tottface, totmcol, tottang, totorco;
491 } DMVertexAttribs;
492
493 void DM_vertex_attributes_from_gpu(DerivedMesh *dm,
494         struct GPUVertexAttribs *gattribs, DMVertexAttribs *attribs);
495
496 void DM_add_tangent_layer(DerivedMesh *dm);
497
498 #endif
499