51a5d29dbb74a338263581257df56f7ba8ae54e9
[blender.git] / source / blender / blenkernel / BKE_bmesh.h
1 /**
2  * BKE_bmesh.h    jan 2007
3  *
4  *      BMesh modeler structure and functions.
5  *
6  * $Id: BKE_bmesh.h,v 1.00 2007/01/17 17:42:01 Briggs Exp $
7  *
8  * ***** BEGIN GPL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version. The Blender
14  * Foundation also sells licenses for use in proprietary software under
15  * the Blender License.  See http://www.blender.org/BL/ for information
16  * about this.  
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  *
27  * The Original Code is Copyright (C) 2004 Blender Foundation.
28  * All rights reserved.
29  *
30  * The Original Code is: all of this file.
31  *
32  * Contributor(s): Geoffrey Bantle.
33  *
34  * ***** END GPL LICENSE BLOCK *****
35  */
36
37 #ifndef BKE_BMESH_H
38 #define BKE_BMESH_H
39
40 #include "DNA_listBase.h"
41 #include "BLI_ghash.h"
42 #include "BLI_memarena.h"
43 #include "DNA_image_types.h"
44 #include "BLI_editVert.h"
45 #include "BKE_DerivedMesh.h"
46 #include "transform.h"
47 #include "BKE_bmeshCustomData.h"
48
49 /*forward declerations*/
50 struct BME_Vert;
51 struct BME_Edge;
52 struct BME_Poly;
53 struct BME_Loop;
54
55
56 /*structure for fast memory allocation/frees*/
57 typedef struct BME_mempool{
58         struct ListBase chunks;
59         int esize, csize, pchunk;               /*size of elements and chunks in bytes and number of elements per chunk*/
60         struct BME_freenode     *free;          /*free element list. Interleaved into chunk datas.*/
61 }BME_mempool;
62
63 /*Notes on further structure Cleanup:
64         -Remove the tflags, they belong in custom data layers
65         -Remove the eflags completely, they are mostly not used
66         -Remove the selection/vis/bevel weight flag/values ect and move them to custom data
67         -Remove EID member and move to custom data
68         -Add a radial cycle length, disk cycle length and loop cycle lenght attributes to custom data and have eulers maintain/use them if present.
69         -Move data such as vertex coordinates/normals to custom data and leave pointers in structures to active layer data.
70         -Remove BME_CycleNode structure?
71 */
72 typedef struct BME_CycleNode{
73         struct BME_CycleNode *next, *prev;
74         void *data;
75 } BME_CycleNode;
76
77 typedef struct BME_Mesh
78 {
79         ListBase verts, edges, polys;
80         /*memory pools used for storing mesh elements*/
81         struct BME_mempool *vpool;
82         struct BME_mempool *epool;
83         struct BME_mempool *ppool;
84         struct BME_mempool *lpool;
85         /*some scratch arrays used by eulers*/
86         struct BME_Vert **vtar;
87         struct BME_Edge **edar;
88         struct BME_Loop **lpar;
89         struct BME_Poly **plar;
90         int vtarlen, edarlen, lparlen, plarlen;
91         int totvert, totedge, totpoly, totloop;                         /*record keeping*/
92         int nextv, nexte, nextp, nextl;                                         /*Next element ID for verts/edges/faces/loops. Never reused*/
93         struct BME_CustomData vdata, edata, pdata, ldata;       /*Custom Data Layer information*/
94 } BME_Mesh;
95
96 typedef struct BME_Vert
97 {
98         struct BME_Vert *next, *prev;
99         int     EID;
100         float co[3];                                                                    
101         float no[3];                                                                    
102         struct BME_Edge *edge;                                                  /*first edge in the disk cycle for this vertex*/
103         void *data;                                                                             /*custom vertex data*/
104         int eflag1, eflag2;                                                             /*reserved for use by eulers*/
105         int tflag1, tflag2;                                                             /*reserved for use by tools*/
106         unsigned short flag, h;
107         float bweight;
108 } BME_Vert;
109
110 typedef struct BME_Edge
111 {
112         struct BME_Edge *next, *prev;
113         int EID;
114         struct BME_Vert *v1, *v2;                                               /*note that order of vertex pointers means nothing to eulers*/
115         struct BME_CycleNode d1, d2;                                    /*disk cycle nodes for v1 and v2 respectivley*/
116         struct BME_Loop *loop;                                                  /*first BME_Loop in the radial cycle around this edge*/
117         void *data;                                                                             /*custom edge data*/
118         int eflag1, eflag2;                                                             /*reserved for use by eulers*/
119         int tflag1, tflag2;                                                             /*reserved for use by tools*/
120         unsigned short flag, h;
121         float crease, bweight;
122 } BME_Edge;
123
124 typedef struct BME_Loop 
125 {       
126         struct BME_Loop *next, *prev;                                   /*circularly linked list around face*/
127         int EID;
128         struct BME_CycleNode radial;                                    /*circularly linked list used to find faces around an edge*/
129         struct BME_Vert *v;                                                             /*vertex that this loop starts at.*/
130         struct BME_Edge *e;                                                             /*edge this loop belongs to*/
131         struct BME_Poly *f;                                                             /*face this loop belongs to*/   
132         void *data;                                                                             /*custom per face vertex data*/
133         int eflag1, eflag2;                                                             /*reserved for use by eulers*/
134         int tflag1, tflag2;                                                             /*reserved for use by tools*/
135         unsigned short flag, h;
136 } BME_Loop;
137
138 typedef struct BME_Poly
139 {
140         struct BME_Poly *next, *prev;
141         int EID;
142         struct BME_Loop *loopbase;                                              /*First editloop around Polygon.*/
143         unsigned int len;                                                               /*total length of the face. Eulers should preserve this data*/
144         void *data;                                                                             /*custom face data*/
145         int eflag1, eflag2;                                                             /*reserved for use by eulers*/
146         int tflag1, tflag2;                                                             /*reserved for use by tools*/
147         unsigned short flag, h, mat_nr;
148 } BME_Poly;
149
150 /*EDGE UTILITIES*/
151 int BME_verts_in_edge(struct BME_Vert *v1, struct BME_Vert *v2, struct BME_Edge *e);
152 int BME_vert_in_edge(struct BME_Edge *e, BME_Vert *v);
153 struct BME_Vert *BME_edge_getothervert(struct BME_Edge *e, struct BME_Vert *v);
154
155 /*GENERAL CYCLE*/
156 int BME_cycle_length(void *h);
157
158 /*DISK CYCLE*/
159 struct BME_Edge *BME_disk_nextedge(struct BME_Edge *e, struct BME_Vert *v); 
160 struct BME_CycleNode *BME_disk_getpointer(struct BME_Edge *e, struct BME_Vert *v);
161 struct BME_Edge *BME_disk_next_edgeflag(struct BME_Edge *e, struct BME_Vert *v, int eflag, int tflag);
162 int BME_disk_count_edgeflag(struct BME_Vert *v, int eflag, int tflag);
163
164 /*RADIAL CYCLE*/
165 struct BME_Loop *BME_radial_nextloop(struct BME_Loop *l);
166 int BME_radial_find_face(struct BME_Edge *e,struct BME_Poly *f);
167
168 /*LOOP CYCLE*/
169 struct BME_Loop *BME_loop_find_loop(struct BME_Poly *f, struct BME_Vert *v);
170
171 /*MESH CREATION/DESTRUCTION*/
172 struct BME_Mesh *BME_make_mesh(int allocsize[4], struct BME_CustomDataInit init[4]);
173 void BME_free_mesh(struct BME_Mesh *bm);
174 /*FULL MESH VALIDATION*/
175 int BME_validate_mesh(struct BME_Mesh *bm, int halt);
176 /*ENTER/EXIT MODELLING LOOP*/
177 int BME_model_begin(struct BME_Mesh *bm);
178 void BME_model_end(struct BME_Mesh *bm);
179
180 /*MESH CONSTRUCTION API.*/
181 /*MAKE*/
182 struct BME_Vert *BME_MV(struct BME_Mesh *bm, float *vec);
183 struct BME_Edge *BME_ME(struct BME_Mesh *bm, struct BME_Vert *v1, struct BME_Vert *v2);
184 struct BME_Poly *BME_MF(struct BME_Mesh *bm, struct BME_Vert *v1, struct BME_Vert *v2, struct BME_Edge **elist, int len);
185 /*KILL*/
186 int BME_KV(struct BME_Mesh *bm, struct BME_Vert *v);
187 int BME_KE(struct BME_Mesh *bm, struct BME_Edge *e);
188 int BME_KF(struct BME_Mesh *bm, struct BME_Poly *bply);
189 /*SPLIT*/
190 struct BME_Vert *BME_SEMV(struct BME_Mesh *bm, struct BME_Vert *tv, struct BME_Edge *e, struct BME_Edge **re);
191 struct BME_Poly *BME_SFME(struct BME_Mesh *bm, struct BME_Poly *f, struct BME_Vert *v1, struct BME_Vert *v2, struct BME_Loop **rl);
192 /*JOIN*/
193 int BME_JEKV(struct BME_Mesh *bm, struct BME_Edge *ke, struct BME_Vert *kv);
194 struct BME_Poly *BME_JFKE(struct BME_Mesh *bm, struct BME_Poly *f1, struct BME_Poly *f2,struct BME_Edge *e); /*no reason to return BME_Poly pointer?*/
195 /*NORMAL FLIP(Is its own inverse)*/
196 int BME_loop_reverse(struct BME_Mesh *bm, struct BME_Poly *f);
197
198 /* bevel tool defines */
199 /* element flags */
200 #define BME_BEVEL_ORIG                  1
201 #define BME_BEVEL_BEVEL                 (1<<1)
202 #define BME_BEVEL_NONMAN                (1<<2)
203 #define BME_BEVEL_WIRE                  (1<<3)
204
205 /* tool options */
206 #define BME_BEVEL_SELECT                1
207 #define BME_BEVEL_VERT                  (1<<1)
208 #define BME_BEVEL_RADIUS                (1<<2)
209 #define BME_BEVEL_ANGLE                 (1<<3)
210 #define BME_BEVEL_WEIGHT                (1<<4)
211 //~ #define BME_BEVEL_EWEIGHT           (1<<4)
212 //~ #define BME_BEVEL_VWEIGHT           (1<<5)
213 #define BME_BEVEL_PERCENT               (1<<6)
214 #define BME_BEVEL_EMIN                  (1<<7)
215 #define BME_BEVEL_EMAX                  (1<<8)
216 #define BME_BEVEL_RUNNING               (1<<9)
217 #define BME_BEVEL_RES                   (1<<10)
218
219 typedef struct BME_TransData {
220         BME_Mesh *bm; /* the bmesh the vert belongs to */
221         BME_Vert *v;  /* pointer to the vert this tdata applies to */
222         float co[3];  /* the original coordinate */
223         float org[3]; /* the origin */
224         float vec[3]; /* a directional vector; always, always normalize! */
225         void *loc;    /* a pointer to the data to transform (likely the vert's cos) */
226         float factor; /* primary scaling factor; also accumulates number of weighted edges for beveling tool */
227         float weight; /* another scaling factor; used primarily for propogating vertex weights to transforms; */
228                       /* weight is also used across recursive bevels to help with the math */
229         float maxfactor; /* the unscaled, original factor (used only by "edge verts" in recursive beveling) */
230         float *max;   /* the maximum distance this vert can be transformed; negative is infinite
231                        * it points to the "parent" maxfactor (where maxfactor makes little sense)
232                        * where the max limit is stored (limits are stored per-corner) */
233 } BME_TransData;
234
235 typedef struct BME_TransData_Head {
236         GHash *gh;       /* the hash structure for element lookup */
237         MemArena *ma;    /* the memory "pool" we will be drawing individual elements from */
238         int len;
239 } BME_TransData_Head;
240
241 typedef struct BME_Glob { /* stored in Global G for Transform() purposes */
242         BME_Mesh *bm;
243         BME_TransData_Head *td;
244         struct TransInfo *Trans; /* a pointer to the global Trans struct */
245         int imval[2]; /* for restoring original mouse co when initTransform() is called multiple times */
246         int options;
247         int res;
248 } BME_Glob;
249
250 struct BME_TransData *BME_get_transdata(struct BME_TransData_Head *td, struct BME_Vert *v);
251 void BME_free_transdata(struct BME_TransData_Head *td);
252 float *BME_bevel_calc_polynormal(struct BME_Poly *f, struct BME_TransData_Head *td);
253 struct BME_Mesh *BME_bevel(struct BME_Mesh *bm, float value, int res, int options, int defgrp_index, float angle, BME_TransData_Head **rtd);
254
255 /*CONVERSION FUNCTIONS*/
256 struct BME_Mesh *BME_editmesh_to_bmesh(EditMesh *em);
257 struct EditMesh *BME_bmesh_to_editmesh(struct BME_Mesh *bm, BME_TransData_Head *td);
258 struct BME_Mesh *BME_derivedmesh_to_bmesh(struct DerivedMesh *dm);
259 struct DerivedMesh *BME_bmesh_to_derivedmesh(struct BME_Mesh *bm, struct DerivedMesh *dm);
260 #endif