7a74dde165abde80146b3213f52cdcea23e86244
[blender.git] / intern / decimation / extern / LOD_decimation.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * @author Laurence Bourn
35  * @date 6/7/2001
36  *
37  * This is the external interface for the decimation module.
38  */
39
40 #ifndef NAN_INCLUDED_LOD_decimation_h
41 #define NAN_INCLUDED_LOD_decimation_h
42
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 /** 
49  * External decimation structure
50  */
51
52 typedef struct LOD_Decimation_Info {
53         float * vertex_buffer;
54         float * vertex_normal_buffer;
55         int * triangle_index_buffer;
56         int vertex_num;
57         int face_num;
58         void * intern;
59 } LOD_Decimation_Info; 
60
61 typedef LOD_Decimation_Info* LOD_Decimation_InfoPtr;
62
63 /** 
64  * Create internal mesh representation from 
65  * LOD_Decimation_Info structure.
66  * @return 1 on successful loading
67  * @return 0 on failure
68  * @warning This should be changed to return an enumeration
69  * detailing the error encountered
70  */
71
72 extern int LOD_LoadMesh(LOD_Decimation_InfoPtr info);
73
74 /**
75  * Allocate and Compute internal data strucures required for
76  * decimation.
77  * @return 1 on successful computation of data
78  * @return 0 on failure
79  * @warning This should be changed to return an enumeration
80  * detailing the error encountered
81  */
82
83 extern int LOD_PreprocessMesh(LOD_Decimation_InfoPtr info);
84
85 /** 
86  * Once both the stages above have been completed
87  * this function collapses a single edge in the mesh.
88  * The LOD_Decimation_Info structure is updated
89  * to represent the new mesh.
90  * @return 1 if an edge was collapsed.
91  * @return 0 if no suitable edge was found to be collapsable
92  * You should stop calling this method in this case
93  * @warning Do not expect that the order of polygons, vertices or
94  * vertex normals will be preserved by this operation. This function
95  * returns a packed array of polygons and vertices and so necessarily
96  * the order will be different. This means you should not expect to
97  * find the same polygon in the same place in the polygon array after 
98  * this function has been called.
99  */
100
101 extern int LOD_CollapseEdge(LOD_Decimation_InfoPtr info);
102
103 /** 
104  * Free any memory the decimation process used 
105  * during the decimation process
106  * @return 1 if internal data successfully freed
107  * @return 0 if no data was freed
108  */
109
110 extern int LOD_FreeDecimationData(LOD_Decimation_InfoPtr);
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116 #endif // NAN_INCLUDED_LOD_decimation_h
117
118
119