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