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