doxygen: blender/blenkernel tagged.
[blender-staging.git] / source / blender / blenkernel / intern / bmesh_private.h
1 /*
2  * BME_private.h    jan 2007
3  *
4  *      low level, 'private' function prototypes for bmesh kernel.
5  *
6  * $Id$
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file blender/blenkernel/intern/bmesh_private.h
38  *  \ingroup bke
39  */
40
41
42 #ifndef BMESH_PRIVATE
43 #define BMESH_PRIVATE
44
45 #include "BKE_bmesh.h"
46
47 /*ALLOCATION/DEALLOCATION*/
48 struct BME_Vert *BME_addvertlist(struct BME_Mesh *bm, struct BME_Vert *example);
49 struct BME_Edge *BME_addedgelist(struct BME_Mesh *bm, struct BME_Vert *v1, struct BME_Vert *v2, struct BME_Edge *example);
50 struct BME_Poly *BME_addpolylist(struct BME_Mesh *bm, struct BME_Poly *example); 
51 struct BME_Loop *BME_create_loop(struct BME_Mesh *bm, struct BME_Vert *v, struct BME_Edge *e, struct BME_Poly *f, struct BME_Loop *example);
52
53 void BME_free_vert(struct BME_Mesh *bm, struct BME_Vert *v);
54 void BME_free_edge(struct BME_Mesh *bm, struct BME_Edge *e);
55 void BME_free_poly(struct BME_Mesh *bm, struct BME_Poly *f);
56 void BME_free_loop(struct BME_Mesh *bm, struct BME_Loop *l);
57
58 /*DOUBLE CIRCULAR LINKED LIST FUNCTIONS*/
59 void BME_cycle_append(void *h, void *nt);
60 int BME_cycle_remove(void *h, void *remn);
61 int BME_cycle_validate(int len, void *h);
62 /*DISK CYCLE MANAGMENT*/
63 int BME_disk_append_edge(struct BME_Edge *e, struct BME_Vert *v);
64 void BME_disk_remove_edge(struct BME_Edge *e, struct BME_Vert *v);
65 /*RADIAL CYCLE MANAGMENT*/
66 void BME_radial_append(struct BME_Edge *e, struct BME_Loop *l);
67 void BME_radial_remove_loop(struct BME_Loop *l, struct BME_Edge *e);
68
69 /*MISC FUNCTIONS*/
70 int BME_edge_swapverts(struct BME_Edge *e, struct BME_Vert *orig, struct BME_Vert *new); /*relink edge*/
71 int BME_disk_hasedge(struct BME_Vert *v, struct BME_Edge *e);
72
73 /*Error reporting. Shouldnt be called by tools ever.*/
74 void BME_error(void);
75 #endif