- added DerivedMesh.drawUVEdges function & implementations
[blender.git] / source / blender / blenkernel / BKE_DerivedMesh.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33 #ifndef BKE_DERIVEDMESH_H
34 #define BKE_DERIVEDMESH_H
35
36 /* TODO (Probably)
37  *
38  *  o Make drawMapped* functions take a predicate function that
39  *    determines whether to draw the edge (this predicate can
40  *    also set color, etc). This will be slightly more general 
41  *    and allow some of the functions to be collapsed.
42  *  o Once accessor functions are added then single element draw
43  *    functions can be implemented using primitive accessors.
44  *  o Add function to dispatch to renderer instead of using
45  *    conversion to DLM.
46  */
47
48 struct MVert;
49 struct Object;
50 struct EditMesh;
51 struct EditVert;
52 struct EditEdge;
53 struct EditFace;
54 struct DispListMesh;
55 struct ModifierData;
56
57 typedef struct DerivedMesh DerivedMesh;
58 struct DerivedMesh {
59         /* Misc. Queries */
60
61                 /* Also called in Editmode */
62         int (*getNumVerts)(DerivedMesh *dm);
63                 /* Also called in Editmode */
64         int (*getNumFaces)(DerivedMesh *dm);
65
66                 /* Iterate over each mapped vertex in the derived mesh, calling the
67                  * given function with the original vert and the mapped vert's new
68                  * coordinate and normal. For historical reasons the normal can be
69                  * passed as a float or short array, only one should be non-NULL.
70                  */
71         void (*foreachMappedVertEM)(DerivedMesh *dm, void (*func)(void *userData, struct EditVert *vert, float *co, float *no_f, short *no_s), void *userData);
72
73                 /* Iterate over each mapped vertex in the derived mesh, calling the
74                  * given function with the original vert and the mapped edge's new
75                  * coordinates.
76                  */
77         void (*foreachMappedEdgeEM)(DerivedMesh *dm, void (*func)(void *userData, struct EditEdge *edge, float *v0co, float *v1co), void *userData);
78
79                 /* Iterate over each mapped face in the derived mesh, calling the
80                  * given function with the original face and the mapped face's (or
81                  * faces') center and normal.
82                  */
83         void (*foreachMappedFaceCenterEM)(DerivedMesh *dm, void (*func)(void *userData, struct EditFace *face, float *cent, float *no), void *userData);
84
85                 /* Convert to new DispListMesh, should be free'd by caller.
86                  *
87                  * If allowShared is true then the caller is committing to not free'ng
88                  * the DerivedMesh before free'ng the DispListMesh, which means that
89                  * certain fields of the returned DispListMesh can safely be share with
90                  * the DerivedMesh's internal data.
91                  */
92         struct DispListMesh* (*convertToDispListMesh)(DerivedMesh *dm, int allowShared);
93
94                 /* Convert to new DispListMesh, should be free'd by caller.
95                  *
96                  * Additionally, allocate and return map arrays. Each map array should be
97                  * have a length corresponding to the returned DLMs totvert, totedge, and 
98                  * totface fields respectively.
99                  *
100                  * Each index in the array should give the EditMesh element from which the
101                  * element at the same index in the DLMs vert, edge, or face array was
102                  * derived (which may be null).
103                  */
104          struct DispListMesh* (*convertToDispListMeshMapped)(DerivedMesh *dm, int allowShared, struct EditVert ***vertMap_r, struct EditEdge ***edgeMap_r, struct EditFace ***faceMap_r);
105
106                 /* Iterate over all vertex points, calling DO_MINMAX with given args.
107                  *
108                  * Also called in Editmode
109                  */
110         void (*getMinMax)(DerivedMesh *dm, float min_r[3], float max_r[3]);
111
112         /* Direct Access Operations */
113         /*  o Can be undefined */
114         /*  o Must be defined for modifiers that only deform however */
115                         
116                 /* Get vertex location, undefined if index is not valid */
117         void (*getVertCo)(DerivedMesh *dm, int index, float co_r[3]);
118
119                 /* Fill the array (of length .getNumVerts()) with all vertex locations  */
120         void (*getVertCos)(DerivedMesh *dm, float (*cos_r)[3]);
121
122                 /* Get vertex normal, undefined if index is not valid */
123         void (*getVertNo)(DerivedMesh *dm, int index, float no_r[3]);
124
125         /* Drawing Operations */
126
127                         /* Draw all vertices as bgl points (no options) */
128         void (*drawVerts)(DerivedMesh *dm);
129
130                         /* Draw edges in the UV mesh (if exists) */
131         void (*drawUVEdges)(DerivedMesh *dm);
132
133                         /* Draw all edges as lines (no options) 
134                          *
135                          * Also called for *final* editmode DerivedMeshes
136                          */
137         void (*drawEdges)(DerivedMesh *dm, int drawLooseEdges);
138         
139                         /* Draw all edges for which (med->flag&mask)==value */
140         void (*drawEdgesFlag)(DerivedMesh *dm, unsigned int mask, unsigned int value);
141
142                         /* Draw all faces
143                          *  o Set face normal or vertex normal based on inherited face flag
144                          *  o Use inherited face material index to call setMaterial
145                          *  o Only if setMaterial returns true
146                          *
147                          * Also called for *final* editmode DerivedMeshes
148                          */
149         void (*drawFacesSolid)(DerivedMesh *dm, int (*setMaterial)(int));
150
151                         /* Draw all faces
152                          *  o If useTwoSided, draw front and back using col arrays
153                          *  o col1,col2 are arrays of length numFace*4 of 4 component colors
154                          *    in ABGR format, and should be passed as per-face vertex color.
155                          */
156         void (*drawFacesColored)(DerivedMesh *dm, int useTwoSided, unsigned char *col1, unsigned char *col2);
157
158                         /* Draw all faces uses TFace 
159                          *  o Drawing options too complicated to enumerate, look at code.
160                          */
161         void (*drawFacesTex)(DerivedMesh *dm, int (*setDrawParams)(TFace *tf, int matnr));
162
163                         /* Draw mapped edges as lines
164                          *  o Only if !setDrawOptions or setDrawOptions(userData, mapped-edge) returns true
165                          */
166         void (*drawMappedEdgesEM)(DerivedMesh *dm, int (*setDrawOptions)(void *userData, struct EditEdge *eed), void *userData);
167
168                         /* Draw mapped edges as lines with interpolation values
169                          *  o Only if !setDrawOptions or setDrawOptions(userData, mapped-edge, mapped-v0, mapped-v1, t) returns true
170                          *
171                          * NOTE: This routine is optional!
172                          */
173         void (*drawMappedEdgesInterpEM)(DerivedMesh *dm, 
174                                                                         int (*setDrawOptions)(void *userData, struct EditEdge *eed), 
175                                                                         void (*setDrawInterpOptions)(void *userData, struct EditEdge *eed, float t),
176                                                                         void *userData);
177
178                         /* Draw all faces
179                          *  o Only if !setDrawOptions or setDrawOptions(userData, mapped-face) returns true
180                          */
181         void (*drawMappedFacesEM)(DerivedMesh *dm, int (*setDrawOptions)(void *userData, struct EditFace *efa), void *userData);
182
183         void (*release)(DerivedMesh *dm);
184 };
185
186         /* Internal function, just temporarily exposed */
187 DerivedMesh *derivedmesh_from_displistmesh(struct DispListMesh *dlm, float (*vertexCos)[3], struct EditVert **vertMap, struct EditEdge **edgeMap, struct EditFace **faceMap);
188
189 DerivedMesh *mesh_get_derived_final(struct Object *ob, int *needsFree_r);
190 DerivedMesh *mesh_get_derived_deform(struct Object *ob, int *needsFree_r);
191
192 DerivedMesh *mesh_create_derived_for_modifier(struct Object *ob, struct ModifierData *md);
193
194 DerivedMesh *mesh_create_derived_render(struct Object *ob);
195 DerivedMesh *mesh_create_derived_no_deform(struct Object *ob, float (*vertCos)[3]);
196 DerivedMesh *mesh_create_derived_no_deform_render(struct Object *ob, float (*vertCos)[3]);
197
198 DerivedMesh *editmesh_get_derived_base(void);
199 DerivedMesh *editmesh_get_derived_cage(int *needsFree_r);
200 DerivedMesh *editmesh_get_derived_cage_and_final(DerivedMesh **final_r, int *cageNeedsFree_r, int *finalNeedsFree_r);
201
202 #endif
203